tools/generate_shim_headers/generate_shim_headers.py

   1 #!/usr/bin/env python
   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
   6 """
   7 Generates shim headers that mirror the directory structure of bundled headers,
   8 but just forward to the system ones.
   9
  10 This allows seamless compilation against system headers with no changes
  11 to our source code.
  12 """
  13
  14
  15 import optparse
  16 import os.path
  17 import sys
  18
  19
  20 SHIM_TEMPLATE = """
  21 #if defined(OFFICIAL_BUILD)
  22 #error shim headers must not be used in official builds!
  23 #endif
  24 """
  25
  26
  27 def GeneratorMain(argv):
  28   parser = optparse.OptionParser()
  29   parser.add_option('--headers-root', action='append')
  30   parser.add_option('--define', action='append')
  31   parser.add_option('--output-directory')
  32   parser.add_option('--use-include-next', action='store_true')
  33   parser.add_option('--outputs', action='store_true')
  34   parser.add_option('--generate', action='store_true')
  35
  36   options, args = parser.parse_args(argv)
  37
  38   if not options.headers_root:
  39     parser.error('Missing --headers-root parameter.')
  40   if not options.output_directory:
  41     parser.error('Missing --output-directory parameter.')
  42   if not args:
  43     parser.error('Missing arguments - header file names.')
  44
  45   source_tree_root = os.path.abspath(
  46     os.path.join(os.path.dirname(__file__), '..', '..'))
  47
  48   for root in options.headers_root:
  49     target_directory = os.path.join(
  50       options.output_directory,
  51       os.path.relpath(root, source_tree_root))
  52     if options.generate and not os.path.exists(target_directory):
  53       os.makedirs(target_directory)
  54
  55     for header_spec in args:
  56       if ';' in header_spec:
  57         (header_filename,
  58          include_before,
  59          include_after) = header_spec.split(';', 2)
  60       else:
  61         header_filename = header_spec
  62         include_before = ''
  63         include_after = ''
  64       if options.outputs:
  65         yield os.path.join(target_directory, header_filename)
  66       if options.generate:
  67         with open(os.path.join(target_directory, header_filename), 'w') as f:
  68           f.write(SHIM_TEMPLATE)
  69
  70           if options.define:
  71             for define in options.define:
  72               key, value = define.split('=', 1)
  73               # This non-standard push_macro extension is supported
  74               # by compilers we support (GCC, clang).
  75               f.write('#pragma push_macro("%s")\n' % key)
  76               f.write('#undef %s\n' % key)
  77               f.write('#define %s %s\n' % (key, value))
  78
  79           if include_before:
  80             for header in include_before.split(':'):
  81               f.write('#include %s\n' % header)
  82
  83           if options.use_include_next:
  84             f.write('#include_next <%s>\n' % header_filename)
  85           else:
  86             f.write('#include <%s>\n' % header_filename)
  87
  88           if include_after:
  89             for header in include_after.split(':'):
  90               f.write('#include %s\n' % header)
  91
  92           if options.define:
  93             for define in options.define:
  94               key, value = define.split('=', 1)
  95               # This non-standard pop_macro extension is supported
  96               # by compilers we support (GCC, clang).
  97               f.write('#pragma pop_macro("%s")\n' % key)
  98
  99
 100 def DoMain(argv):
 101   return '\n'.join(GeneratorMain(argv))
 102
 103
 104 if __name__ == '__main__':
 105   DoMain(sys.argv[1:])