Changeset 177825 in webkit

Timestamp:

Dec 30, 2014 12:43:00 PM (9 years ago)

Author:

mitz@apple.com

Message:

[Cocoa] Enable the compiler to check format strings specified with UI_STRING and UI_STRING_KEY
​https://bugs.webkit.org/show_bug.cgi?id=140003

Reviewed by Darin Adler.

• Misc/WebLocalizableStrings.h: Made UI_STRING and UI_STRING_KEY call a new helper function

that takes their "string" parameter as a "value" "parameter and has an attribute telling
the compiler that if the "value" parameter is a format string then the function returns a
modified version of it. The result is that if UI_STRING is used as a format string parameter
to some function or method, the compiler will check the format specifiers in the string
against the other parameters.

Location:

trunk/Source/WebKit/mac

Files:

• ChangeLog (modified) (1 diff)
• Misc/WebLocalizableStrings.h (modified) (4 diffs)

trunk/Source/WebKit/mac/ChangeLog

@@ +1 @@
+2014-12-30  Dan Bernstein  <mitz@apple.com>
+
+        [Cocoa] Enable the compiler to check format strings specified with UI_STRING and UI_STRING_KEY
+        https://bugs.webkit.org/show_bug.cgi?id=140003
+
+        Reviewed by Darin Adler.
+
+        * Misc/WebLocalizableStrings.h: Made UI_STRING and UI_STRING_KEY call a new helper function
+        that takes their "string" parameter as a "value" "parameter and has an attribute telling
+        the compiler that if the "value" parameter is a format string then the function returns a
+        modified version of it. The result is that if UI_STRING is used as a format string parameter
+        to some function or method, the compiler will check the format specifiers in the string
+        against the other parameters.
+
 2014-12-29  Dan Bernstein  <mitz@apple.com>
 

trunk/Source/WebKit/mac/Misc/WebLocalizableStrings.h

@@ -29 +29 @@
 #if __OBJC__
 @class NSBundle;
-#elif __cplusplus
+typedef NSString *WebLocalizedStringType;
+#else
+#if __cplusplus
 class NSBundle;
 #else
 typedef struct NSBundle NSBundle;
+#endif
+typedef CFStringRef WebLocalizedStringType;
 #endif
 
@@ -44 +48 @@
 #endif
 
-#if __OBJC__
-NSString *WebLocalizedString(WebLocalizableStringsBundle *bundle, const char *key);
-#else
-CFStringRef WebLocalizedString(WebLocalizableStringsBundle *bundle, const char *key);
-#endif
+WebLocalizedStringType WebLocalizedString(WebLocalizableStringsBundle* bundle, const char* key);
 
 #if TARGET_OS_IPHONE
@@ -58 +58 @@
 #endif
 
+static inline __attribute__((format_arg(3))) WebLocalizedStringType WebLocalizedStringWithValue(WebLocalizableStringsBundle* bundle, const char* key, const char* value)
+{
+    return WebLocalizedString(bundle, key);
+}
+
 #ifdef FRAMEWORK_NAME
 
@@ -64 +69 @@
 extern WebLocalizableStringsBundle LOCALIZABLE_STRINGS_BUNDLE(FRAMEWORK_NAME);
 
-#define UI_STRING(string, comment) WebLocalizedString(&LOCALIZABLE_STRINGS_BUNDLE(FRAMEWORK_NAME), string)
-#define UI_STRING_KEY(string, key, comment) WebLocalizedString(&LOCALIZABLE_STRINGS_BUNDLE(FRAMEWORK_NAME), key)
+#define UI_STRING(string, comment) WebLocalizedStringWithValue(&LOCALIZABLE_STRINGS_BUNDLE(FRAMEWORK_NAME), string, string)
+#define UI_STRING_KEY(string, key, comment) WebLocalizedStringWithValue(&LOCALIZABLE_STRINGS_BUNDLE(FRAMEWORK_NAME), key, string)
 
 #else
 
-#define UI_STRING(string, comment) WebLocalizedString(0, string)
-#define UI_STRING_KEY(string, key, comment) WebLocalizedString(0, key)
+#define UI_STRING(string, comment) WebLocalizedStringWithValue(0, string, string)
+#define UI_STRING_KEY(string, key, comment) WebLocalizedStringWithValue(0, key, string)
 
 #endif