1 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 // Helper tool that is built and run during a build to pull strings from
6 // the GRD files and generate the InfoPlist.strings files needed for
7 // Mac OS X app bundles.
9 #import <Foundation/Foundation.h>
14 #include "base/file_path.h"
15 #include "base/mac/scoped_nsautorelease_pool.h"
16 #include "base/memory/scoped_ptr.h"
17 #include "base/string_piece.h"
18 #include "base/string_util.h"
19 #include "grit/chromium_strings.h"
20 #include "ui/base/resource/data_pack.h"
24 NSString* ApplicationVersionString(const char* version_file_path) {
26 NSString* path_string = [NSString stringWithUTF8String:version_file_path];
27 NSString* version_file =
28 [NSString stringWithContentsOfFile:path_string
29 encoding:NSUTF8StringEncoding
31 if (!version_file || error) {
32 fprintf(stderr, "Failed to load version file: %s\n",
33 [[error description] UTF8String]);
37 int major = 0, minor = 0, build = 0, patch = 0;
38 NSScanner* scanner = [NSScanner scannerWithString:version_file];
39 if ([scanner scanString:@"MAJOR=" intoString:nil] &&
40 [scanner scanInt:&major] &&
41 [scanner scanString:@"MINOR=" intoString:nil] &&
42 [scanner scanInt:&minor] &&
43 [scanner scanString:@"BUILD=" intoString:nil] &&
44 [scanner scanInt:&build] &&
45 [scanner scanString:@"PATCH=" intoString:nil] &&
46 [scanner scanInt:&patch]) {
47 return [NSString stringWithFormat:@"%d.%d.%d.%d",
48 major, minor, build, patch];
50 fprintf(stderr, "Failed to parse version file\n");
54 ui::DataPack* LoadResourceDataPack(const char* dir_path,
55 const char* branding_strings_name,
56 const char* locale_name) {
57 ui::DataPack* resource_pack = NULL;
59 NSString* resource_path = [NSString stringWithFormat:@"%s/%s_%s.pak",
60 dir_path, branding_strings_name, locale_name];
62 FilePath resources_pak_path([resource_path fileSystemRepresentation]);
63 resource_pack = new ui::DataPack;
64 bool success = resource_pack->Load(resources_pak_path);
74 NSString* LoadStringFromDataPack(ui::DataPack* data_pack,
75 const char* data_pack_lang,
77 const char* resource_id_str) {
78 NSString* result = nil;
79 base::StringPiece data;
80 if (data_pack->GetStringPiece(resource_id, &data)) {
81 // Data pack encodes strings as UTF16.
83 [[[NSString alloc] initWithBytes:data.data()
85 encoding:NSUTF16LittleEndianStringEncoding]
89 fprintf(stderr, "ERROR: failed to load string %s for lang %s\n",
90 resource_id_str, data_pack_lang);
96 // Escape quotes, newlines, etc so there are no errors when the strings file
98 NSString* EscapeForStringsFileValue(NSString* str) {
99 NSMutableString* worker = [NSMutableString stringWithString:str];
101 // Since this is a build tool, we don't really worry about making this
102 // the most efficient code.
104 // Backslash first since we need to do it before we put in all the others
105 [worker replaceOccurrencesOfString:@"\\"
107 options:NSLiteralSearch
108 range:NSMakeRange(0, [worker length])];
109 // Now the rest of them.
110 [worker replaceOccurrencesOfString:@"\n"
112 options:NSLiteralSearch
113 range:NSMakeRange(0, [worker length])];
114 [worker replaceOccurrencesOfString:@"\r"
116 options:NSLiteralSearch
117 range:NSMakeRange(0, [worker length])];
118 [worker replaceOccurrencesOfString:@"\t"
120 options:NSLiteralSearch
121 range:NSMakeRange(0, [worker length])];
122 [worker replaceOccurrencesOfString:@"\""
124 options:NSLiteralSearch
125 range:NSMakeRange(0, [worker length])];
127 return [[worker copy] autorelease];
130 // The valid types for the -t arg
131 const char* kAppType_Main = "main"; // Main app
132 const char* kAppType_Helper = "helper"; // Helper app
136 int main(int argc, char* const argv[]) {
137 base::mac::ScopedNSAutoreleasePool autorelease_pool;
139 const char* version_file_path = NULL;
140 const char* grit_output_dir = NULL;
141 const char* branding_strings_name = NULL;
142 const char* output_dir = NULL;
143 const char* app_type = kAppType_Main;
147 while ((ch = getopt(argc, argv, "t:v:g:b:o:")) != -1) {
153 version_file_path = optarg;
156 grit_output_dir = optarg;
159 branding_strings_name = optarg;
165 fprintf(stderr, "ERROR: bad command line arg\n");
173 #define CHECK_ARG(a, b) \
176 fprintf(stderr, "ERROR: " b "\n"); \
182 CHECK_ARG(!version_file_path, "Missing VERSION file path");
183 CHECK_ARG(!grit_output_dir, "Missing grit output dir path");
184 CHECK_ARG(!output_dir, "Missing path to write InfoPlist.strings files");
185 CHECK_ARG(!branding_strings_name, "Missing branding strings file name");
186 CHECK_ARG(argc == 0, "Missing language list");
187 CHECK_ARG((strcmp(app_type, kAppType_Main) != 0 &&
188 strcmp(app_type, kAppType_Helper) != 0),
191 char* const* lang_list = argv;
192 int lang_list_count = argc;
194 // Parse the version file and build our string
195 NSString* version_string = ApplicationVersionString(version_file_path);
196 if (!version_string) {
197 fprintf(stderr, "ERROR: failed to get a version string");
201 NSFileManager* fm = [NSFileManager defaultManager];
203 for (int loop = 0; loop < lang_list_count; ++loop) {
204 const char* cur_lang = lang_list[loop];
206 // Open the branded string pak file
207 scoped_ptr<ui::DataPack> branded_data_pack(
208 LoadResourceDataPack(grit_output_dir,
209 branding_strings_name,
211 if (branded_data_pack.get() == NULL) {
212 fprintf(stderr, "ERROR: Failed to load branded pak for language: %s\n",
217 uint32_t name_id = IDS_PRODUCT_NAME;
218 const char* name_id_str = "IDS_PRODUCT_NAME";
219 uint32_t short_name_id = IDS_APP_MENU_PRODUCT_NAME;
220 const char* short_name_id_str = "IDS_APP_MENU_PRODUCT_NAME";
221 if (strcmp(app_type, kAppType_Helper) == 0) {
222 name_id = IDS_HELPER_NAME;
223 name_id_str = "IDS_HELPER_NAME";
224 short_name_id = IDS_SHORT_HELPER_NAME;
225 short_name_id_str = "IDS_SHORT_HELPER_NAME";
230 LoadStringFromDataPack(branded_data_pack.get(), cur_lang,
231 name_id, name_id_str);
232 NSString* short_name =
233 LoadStringFromDataPack(branded_data_pack.get(), cur_lang,
234 short_name_id, short_name_id_str);
235 NSString* copyright =
236 LoadStringFromDataPack(branded_data_pack.get(), cur_lang,
237 IDS_ABOUT_VERSION_COPYRIGHT,
238 "IDS_ABOUT_VERSION_COPYRIGHT");
240 // For now, assume this is ok for all languages. If we need to, this could
241 // be moved into generated_resources.grd and fetched.
242 NSString *get_info = [NSString stringWithFormat:@"%@ %@, %@",
243 name, version_string, copyright];
245 // Generate the InfoPlist.strings file contents
246 NSString* strings_file_contents_string =
247 [NSString stringWithFormat:
248 @"CFBundleDisplayName = \"%@\";\n"
249 @"CFBundleGetInfoString = \"%@\";\n"
250 @"CFBundleName = \"%@\";\n"
251 @"NSHumanReadableCopyright = \"%@\";\n",
252 EscapeForStringsFileValue(name),
253 EscapeForStringsFileValue(get_info),
254 EscapeForStringsFileValue(short_name),
255 EscapeForStringsFileValue(copyright)];
257 // We set up Xcode projects expecting strings files to be UTF8, so make
258 // sure we write the data in that form. When Xcode copies them it will
259 // put them final runtime encoding.
260 NSData* strings_file_contents_utf8 =
261 [strings_file_contents_string dataUsingEncoding:NSUTF8StringEncoding];
263 if ([strings_file_contents_utf8 length] == 0) {
264 fprintf(stderr, "ERROR: failed to get the utf8 encoding of the strings "
265 "file for language: %s\n", cur_lang);
269 // For Cocoa to find the locale at runtime, it needs to use '_' instead of
270 // '-' (http://crbug.com/20441). Also, 'en-US' should be represented
271 // simply as 'en' (http://crbug.com/19165, http://crbug.com/25578).
272 NSString* cur_lang_ns = [NSString stringWithUTF8String:cur_lang];
273 if ([cur_lang_ns isEqualToString:@"en-US"]) {
276 cur_lang_ns = [cur_lang_ns stringByReplacingOccurrencesOfString:@"-"
278 // Make sure the lproj we write to exists
279 NSString *lproj_name = [NSString stringWithFormat:@"%@.lproj", cur_lang_ns];
280 NSString *output_path =
281 [[NSString stringWithUTF8String:output_dir]
282 stringByAppendingPathComponent:lproj_name];
283 NSError* error = nil;
284 if (![fm fileExistsAtPath:output_path] &&
285 ![fm createDirectoryAtPath:output_path
286 withIntermediateDirectories:YES
289 fprintf(stderr, "ERROR: '%s' didn't exist or we failed to create it\n",
290 [output_path UTF8String]);
294 // Write out the file
296 [output_path stringByAppendingPathComponent:@"InfoPlist.strings"];
297 if (![strings_file_contents_utf8 writeToFile:output_path
299 fprintf(stderr, "ERROR: Failed to write out '%s'\n",
300 [output_path UTF8String]);