Add ICU message format support
[chromium-blink-merge.git] / build / secondary / tools / grit / grit_rule.gni
blobbaf168e7692087417e6336f5c0b4b8c119fb6524
1 # Copyright 2014 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 # Instantiate grit. This will produce a script target to run grit, and a
6 # static library that compiles the .cc files.
8 # Parameters
10 #   source (required)
11 #       Path to .grd file.
13 #   outputs (required)
14 #       List of outputs from grit, relative to the target_gen_dir. Grit will
15 #       verify at build time that this list is correct and will fail if there
16 #       is a mismatch between the outputs specified by the .grd file and the
17 #       outputs list here.
19 #       To get this list, you can look in the .grd file for
20 #       <output filename="..." and put those filename here. The base directory
21 #       of the list in Grit and the output list specified in the GN grit target
22 #       are the same (the target_gen_dir) so you can generally copy the names
23 #       exactly.
25 #       To get the list of outputs programatically, run:
26 #           python tools/grit/grit_info.py --outputs . path/to/your.grd
27 #       And strip the leading "./" from the output files.
29 #   defines (optional)
30 #       Extra defines to pass to grit (on top of the global grit_defines list).
32 #   grit_flags (optional)
33 #       List of strings containing extra command-line flags to pass to Grit.
35 #   resource_ids (optional)
36 #       Path to a grit "firstidsfile". Default is
37 #       //tools/gritsettings/resource_ids. Set to "" to use the value specified
38 #       in the <grit> nodes of the processed files.
40 #   output_dir (optional)
41 #       Directory for generated files. If you specify this, you will often
42 #       want to specify output_name if the target name is not particularly
43 #       unique, since this can cause files from multiple grit targets to
44 #       overwrite each other.
46 #   output_name (optiona)
47 #       Provide an alternate base name for the generated files, like the .d
48 #       files. Normally these are based on the target name and go in the
49 #       output_dir, but if multiple targets with the same name end up in
50 #       the same output_dir, they can collide.
52 #   depfile_dir (optional)
53 #       If set, used to store the depfile and corresponding stamp file.
54 #       Defaults to output_dir
56 #   use_qualified_include (optional)
57 #       If set, output_dir is not added to include_dirs.
59 #   configs (optional)
60 #       List of additional configs to be applied to the generated target.
61 #   deps  (optional)
62 #   inputs  (optional)
63 #       List of additional files, required for grit to process source file.
64 #   visibility  (optional)
65 #       Normal meaning.
67 # Example
69 #   grit("my_resources") {
70 #     # Source and outputs are required.
71 #     source = "myfile.grd"
72 #     outputs = [
73 #       "foo_strings.h",
74 #       "foo_strings.pak",
75 #     ]
77 #     grit_flags = [ "-E", "foo=bar" ]  # Optional extra flags.
78 #     # You can also put deps here if the grit source depends on generated
79 #     # files.
80 #   }
81 import("//build/config/chrome_build.gni")
82 import("//build/config/crypto.gni")
83 import("//build/config/features.gni")
84 import("//build/config/ui.gni")
86 grit_defines = []
88 # Mac and iOS want Title Case strings.
89 use_titlecase_in_grd_files = is_mac || is_ios
90 if (use_titlecase_in_grd_files) {
91   grit_defines += [
92     "-D",
93     "use_titlecase",
94   ]
97 if (is_chrome_branded) {
98   grit_defines += [
99     "-D",
100     "_google_chrome",
101     "-E",
102     "CHROMIUM_BUILD=google_chrome",
103   ]
104 } else {
105   grit_defines += [
106     "-D",
107     "_chromium",
108     "-E",
109     "CHROMIUM_BUILD=chromium",
110   ]
113 if (is_chromeos) {
114   grit_defines += [
115     "-D",
116     "chromeos",
117     "-D",
118     "scale_factors=2x",
119   ]
122 if (is_desktop_linux) {
123   grit_defines += [
124     "-D",
125     "desktop_linux",
126   ]
129 if (toolkit_views) {
130   grit_defines += [
131     "-D",
132     "toolkit_views",
133   ]
136 if (use_aura) {
137   grit_defines += [
138     "-D",
139     "use_aura",
140   ]
143 if (use_ash) {
144   grit_defines += [
145     "-D",
146     "use_ash",
147   ]
150 if (use_nss_certs) {
151   grit_defines += [
152     "-D",
153     "use_nss_certs",
154   ]
157 if (use_ozone) {
158   grit_defines += [
159     "-D",
160     "use_ozone",
161   ]
164 if (enable_image_loader_extension) {
165   grit_defines += [
166     "-D",
167     "image_loader_extension",
168   ]
171 if (is_android) {
172   grit_defines += [
173     "-t",
174     "android",
175     "-E",
176     "ANDROID_JAVA_TAGGED_ONLY=true",
177   ]
180 if (is_mac || is_ios) {
181   grit_defines += [
182     "-D",
183     "scale_factors=2x",
184   ]
187 if (is_ios) {
188   grit_defines += [
189     "-t",
190     "ios",
192     # iOS uses a whitelist to filter resources.
193     "-w",
194     rebase_path("//build/ios/grit_whitelist.txt", root_build_dir),
195   ]
198 if (enable_extensions) {
199   grit_defines += [
200     "-D",
201     "enable_extensions",
202   ]
204 if (enable_media_router) {
205   grit_defines += [
206     "-D",
207     "enable_media_router",
208   ]
210 if (enable_plugins) {
211   grit_defines += [
212     "-D",
213     "enable_plugins",
214   ]
216 if (enable_basic_printing || enable_print_preview) {
217   grit_defines += [
218     "-D",
219     "enable_printing",
220   ]
221   if (enable_print_preview) {
222     grit_defines += [
223       "-D",
224       "enable_print_preview",
225     ]
226   }
228 if (enable_themes) {
229   grit_defines += [
230     "-D",
231     "enable_themes",
232   ]
234 if (enable_app_list) {
235   grit_defines += [
236     "-D",
237     "enable_app_list",
238   ]
240 if (enable_settings_app) {
241   grit_defines += [
242     "-D",
243     "enable_settings_app",
244   ]
246 if (enable_google_now) {
247   grit_defines += [
248     "-D",
249     "enable_google_now",
250   ]
253 # Note: use_concatenated_impulse_responses is omitted. It is never used and
254 # should probably be removed from GYP build.
255 if (enable_webrtc) {
256   grit_defines += [
257     "-D",
258     "enable_webrtc",
259   ]
261 if (enable_hangout_services_extension) {
262   grit_defines += [
263     "-D",
264     "enable_hangout_services_extension",
265   ]
267 if (enable_task_manager) {
268   grit_defines += [
269     "-D",
270     "enable_task_manager",
271   ]
273 if (enable_notifications) {
274   grit_defines += [
275     "-D",
276     "enable_notifications",
277   ]
279 if (enable_wifi_bootstrapping) {
280   grit_defines += [
281     "-D",
282     "enable_wifi_bootstrapping",
283   ]
285 if (enable_service_discovery) {
286   grit_defines += [
287     "-D",
288     "enable_service_discovery",
289   ]
291 if (mac_views_browser) {
292   grit_defines += [
293     "-D",
294     "mac_views_browser",
295   ]
298 grit_resource_id_file = "//tools/gritsettings/resource_ids"
299 grit_info_script = "//tools/grit/grit_info.py"
301 template("grit") {
302   assert(defined(invoker.source),
303          "\"source\" must be defined for the grit template $target_name")
305   grit_inputs = [ invoker.source ]
307   if (defined(invoker.resource_ids)) {
308     resource_ids = invoker.resource_ids
309   } else {
310     resource_ids = grit_resource_id_file
311   }
312   if (resource_ids != "") {
313     # The script depends on the ID file. Only add this dependency if the ID
314     # file is specified.
315     grit_inputs += [ resource_ids ]
316   }
318   if (defined(invoker.output_dir)) {
319     output_dir = invoker.output_dir
320   } else {
321     output_dir = target_gen_dir
322   }
324   if (defined(invoker.output_name)) {
325     grit_output_name = invoker.output_name
326   } else {
327     grit_output_name = target_name
328   }
330   if (defined(invoker.depfile_dir)) {
331     depfile_dir = invoker.depfile_dir
332   } else {
333     depfile_dir = output_dir
334   }
336   # These are all passed as arguments to the script so have to be relative to
337   # the build directory.
338   if (resource_ids != "") {
339     resource_ids = rebase_path(resource_ids, root_build_dir)
340   }
341   rebased_output_dir = rebase_path(output_dir, root_build_dir)
342   source_path = rebase_path(invoker.source, root_build_dir)
344   if (defined(invoker.grit_flags)) {
345     grit_flags = invoker.grit_flags
346   } else {
347     grit_flags = []  # These are optional so default to empty list.
348   }
350   assert_files_flags = []
352   # We want to make sure the declared outputs actually match what Grit is
353   # writing. We write the list to a file (some of the output lists are long
354   # enough to not fit on a Windows command line) and ask Grit to verify those
355   # are the actual outputs at runtime.
356   asserted_list_file =
357       "$target_out_dir/${grit_output_name}_expected_outputs.txt"
358   write_file(asserted_list_file,
359              rebase_path(invoker.outputs, root_build_dir, output_dir))
360   assert_files_flags += [ "--assert-file-list=" +
361                           rebase_path(asserted_list_file, root_build_dir) ]
362   grit_outputs =
363       get_path_info(rebase_path(invoker.outputs, ".", output_dir), "abspath")
365   # The config and the action below get this visibility son only the generated
366   # source set can depend on them. The variable "target_name" will get
367   # overwritten inside the inner classes so we need to compute it here.
368   target_visibility = [ ":$target_name" ]
370   # The current grit setup makes an file in $output_dir/grit/foo.h that
371   # the source code expects to include via "grit/foo.h". It would be nice to
372   # change this to including absolute paths relative to the root gen directory
373   # (like "mycomponent/foo.h"). This config sets up the include path.
374   grit_config = target_name + "_grit_config"
375   config(grit_config) {
376     if (!defined(invoker.use_qualified_include) ||
377         !invoker.use_qualified_include) {
378       include_dirs = [ output_dir ]
379     }
380     visibility = target_visibility
381   }
383   grit_custom_target = target_name + "_grit"
384   action(grit_custom_target) {
385     script = "//tools/grit/grit.py"
386     inputs = grit_inputs
388     depfile = "$depfile_dir/${grit_output_name}_stamp.d"
389     outputs = [ "${depfile}.stamp" ] + grit_outputs
391     args = [
392       "-i",
393       source_path,
394       "build",
395     ]
396     if (resource_ids != "") {
397       args += [
398         "-f",
399         resource_ids,
400       ]
401     }
402     args += [
403               "-o",
404               rebased_output_dir,
405               "--depdir",
406               ".",
407               "--depfile",
408               rebase_path(depfile, root_build_dir),
409               "--write-only-new=1",
410               "--depend-on-stamp",
411             ] + grit_defines
413     # Add extra defines with -D flags.
414     if (defined(invoker.defines)) {
415       foreach(i, invoker.defines) {
416         args += [
417           "-D",
418           i,
419         ]
420       }
421     }
423     args += grit_flags + assert_files_flags
425     if (defined(invoker.visibility)) {
426       # This needs to include both what the invoker specified (since they
427       # probably include generated headers from this target), as well as the
428       # generated source set (since there's no guarantee that the visibility
429       # specified by the invoker includes our target).
430       #
431       # Only define visibility at all if the invoker specified it. Otherwise,
432       # we want to keep the public "no visibility specified" default.
433       visibility = target_visibility + invoker.visibility
434     }
436     deps = [
437       "//tools/grit:grit_sources",
438     ]
439     if (defined(invoker.deps)) {
440       deps += invoker.deps
441     }
442     if (defined(invoker.inputs)) {
443       inputs += invoker.inputs
444     }
445   }
447   # This is the thing that people actually link with, it must be named the
448   # same as the argument the template was invoked with.
449   source_set(target_name) {
450     # Since we generate a file, we need to be run before the targets that
451     # depend on us.
452     sources = grit_outputs
454     # Deps set on the template invocation will go on the action that runs
455     # grit above rather than this library. This target needs to depend on the
456     # action publicly so other scripts can take the outputs from the grit
457     # script as inputs.
458     public_deps = [
459       ":$grit_custom_target",
460     ]
461     public_configs = [ ":$grit_config" ]
463     if (defined(invoker.public_configs)) {
464       public_configs += invoker.public_configs
465     }
467     if (defined(invoker.configs)) {
468       configs += invoker.configs
469     }
471     if (defined(invoker.visibility)) {
472       visibility = invoker.visibility
473     }
474     output_name = grit_output_name
475   }