grit_info.py 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  1. #!/usr/bin/env python3
  2. # Copyright (c) 2012 The Chromium Authors. All rights reserved.
  3. # Use of this source code is governed by a BSD-style license that can be
  4. # found in the LICENSE file.
  5. '''Tool to determine inputs and outputs of a grit file.
  6. '''
  7. from __future__ import print_function
  8. import optparse
  9. import os
  10. import posixpath
  11. import sys
  12. from grit import grd_reader
  13. from grit import util
  14. class WrongNumberOfArguments(Exception):
  15. pass
  16. def Outputs(filename, defines, ids_file, target_platform=None):
  17. grd = grd_reader.Parse(
  18. filename, defines=defines, tags_to_ignore=set(['messages']),
  19. first_ids_file=ids_file, target_platform=target_platform)
  20. target = []
  21. lang_folders = {}
  22. # Add all explicitly-specified output files
  23. for output in grd.GetOutputFiles():
  24. path = output.GetFilename()
  25. target.append(path)
  26. if path.endswith('.h'):
  27. path, filename = os.path.split(path)
  28. if output.attrs['lang']:
  29. lang_folders[output.attrs['lang']] = os.path.dirname(path)
  30. return [t.replace('\\', '/') for t in target]
  31. def GritSourceFiles():
  32. files = []
  33. grit_root_dir = os.path.relpath(os.path.dirname(__file__), os.getcwd())
  34. for root, dirs, filenames in os.walk(grit_root_dir):
  35. grit_src = [os.path.join(root, f) for f in filenames
  36. if f.endswith('.py') and not f.endswith('_unittest.py')]
  37. files.extend(grit_src)
  38. return sorted(files)
  39. def Inputs(filename, defines, ids_file, target_platform=None):
  40. grd = grd_reader.Parse(
  41. filename, debug=False, defines=defines, tags_to_ignore=set(['message']),
  42. first_ids_file=ids_file, target_platform=target_platform)
  43. files = set()
  44. for lang, ctx, fallback in grd.GetConfigurations():
  45. # TODO(tdanderson): Refactor all places which perform the action of setting
  46. # output attributes on the root. See crbug.com/503637.
  47. grd.SetOutputLanguage(lang or grd.GetSourceLanguage())
  48. grd.SetOutputContext(ctx)
  49. grd.SetFallbackToDefaultLayout(fallback)
  50. for node in grd.ActiveDescendants():
  51. with node:
  52. if (node.name == 'structure' or node.name == 'skeleton' or
  53. (node.name == 'file' and node.parent and
  54. node.parent.name == 'translations')):
  55. path = node.GetInputPath()
  56. if path is not None:
  57. files.add(grd.ToRealPath(path))
  58. # If it's a flattened node, grab inlined resources too.
  59. if node.name == 'structure' and node.attrs['flattenhtml'] == 'true':
  60. node.RunPreSubstitutionGatherer()
  61. files.update(node.GetHtmlResourceFilenames())
  62. elif node.name == 'grit':
  63. first_ids_file = node.GetFirstIdsFile()
  64. if first_ids_file:
  65. files.add(first_ids_file)
  66. elif node.name == 'include':
  67. files.add(grd.ToRealPath(node.GetInputPath()))
  68. # If it's a flattened node, grab inlined resources too.
  69. if node.attrs['flattenhtml'] == 'true':
  70. files.update(node.GetHtmlResourceFilenames())
  71. elif node.name == 'part':
  72. files.add(util.normpath(os.path.join(os.path.dirname(filename),
  73. node.GetInputPath())))
  74. cwd = os.getcwd()
  75. return [os.path.relpath(f, cwd) for f in sorted(files)]
  76. def PrintUsage():
  77. print('USAGE: ./grit_info.py --inputs [-D foo] [-f resource_ids] <grd-file>')
  78. print(' ./grit_info.py --outputs [-D foo] [-f resource_ids] ' +
  79. '<out-prefix> <grd-file>')
  80. def DoMain(argv):
  81. os.environ['cwd'] = os.getcwd()
  82. parser = optparse.OptionParser()
  83. parser.add_option("--inputs", action="store_true", dest="inputs")
  84. parser.add_option("--outputs", action="store_true", dest="outputs")
  85. parser.add_option("-D", action="append", dest="defines", default=[])
  86. # grit build also supports '-E KEY=VALUE', support that to share command
  87. # line flags.
  88. parser.add_option("-E", action="append", dest="build_env", default=[])
  89. parser.add_option("-p", action="store", dest="predetermined_ids_file")
  90. parser.add_option("-w", action="append", dest="allowlist_files", default=[])
  91. parser.add_option("-f", dest="ids_file", default="")
  92. parser.add_option("-t", dest="target_platform", default=None)
  93. options, args = parser.parse_args(argv)
  94. defines = {}
  95. for define in options.defines:
  96. name, val = util.ParseDefine(define)
  97. defines[name] = val
  98. for env_pair in options.build_env:
  99. (env_name, env_value) = env_pair.split('=', 1)
  100. os.environ[env_name] = env_value
  101. if options.inputs:
  102. if len(args) > 1:
  103. raise WrongNumberOfArguments("Expected 0 or 1 arguments for --inputs.")
  104. inputs = []
  105. if len(args) == 1:
  106. filename = args[0]
  107. inputs = Inputs(filename, defines, options.ids_file,
  108. options.target_platform)
  109. # Add in the grit source files. If one of these change, we want to re-run
  110. # grit.
  111. inputs.extend(GritSourceFiles())
  112. inputs = [f.replace('\\', '/') for f in inputs]
  113. if len(args) == 1:
  114. # Include grd file as second input (works around gyp expecting it).
  115. inputs.insert(1, args[0])
  116. if options.allowlist_files:
  117. inputs.extend(options.allowlist_files)
  118. return '\n'.join(inputs)
  119. elif options.outputs:
  120. if len(args) != 2:
  121. raise WrongNumberOfArguments(
  122. "Expected exactly 2 arguments for --outputs.")
  123. prefix, filename = args
  124. outputs = [posixpath.join(prefix, f)
  125. for f in Outputs(filename, defines,
  126. options.ids_file, options.target_platform)]
  127. return '\n'.join(outputs)
  128. else:
  129. raise WrongNumberOfArguments("Expected --inputs or --outputs.")
  130. def main(argv):
  131. try:
  132. result = DoMain(argv[1:])
  133. except WrongNumberOfArguments as e:
  134. PrintUsage()
  135. print(e)
  136. return 1
  137. print(result)
  138. return 0
  139. if __name__ == '__main__':
  140. sys.exit(main(sys.argv))