third_party/WebKit/Source/build/scripts/make_names.py

   1 #!/usr/bin/env python
   2 # Copyright (C) 2013 Google Inc. All rights reserved.
   3 #
   4 # Redistribution and use in source and binary forms, with or without
   5 # modification, are permitted provided that the following conditions are
   6 # met:
   7 #
   8 #     * Redistributions of source code must retain the above copyright
   9 # notice, this list of conditions and the following disclaimer.
  10 #     * Redistributions in binary form must reproduce the above
  11 # copyright notice, this list of conditions and the following disclaimer
  12 # in the documentation and/or other materials provided with the
  13 # distribution.
  14 #     * Neither the name of Google Inc. nor the names of its
  15 # contributors may be used to endorse or promote products derived from
  16 # this software without specific prior written permission.
  17 #
  18 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29
  30 import sys
  31
  32 import hasher
  33 import in_generator
  34 import template_expander
  35 import name_utilities
  36
  37 def _symbol(entry):
  38     if entry['Symbol'] is not None:
  39         return entry['Symbol']
  40     # FIXME: Remove this special case for the ugly x-webkit-foo attributes.
  41     if entry['name'].startswith('-webkit-'):
  42         return entry['name'].replace('-', '_')[1:]
  43     return name_utilities.cpp_name(entry).replace('-', '_')
  44
  45
  46 class MakeNamesWriter(in_generator.Writer):
  47     defaults = {
  48         'Conditional': None,  # FIXME: Add support for Conditional.
  49         'ImplementedAs': None,
  50         'RuntimeEnabled': None,  # What should we do for runtime-enabled features?
  51         'Symbol': None,
  52     }
  53     default_parameters = {
  54         'export': '',
  55         'namespace': '',
  56         'suffix': '',
  57     }
  58     filters = {
  59         'cpp_name': name_utilities.cpp_name,
  60         'enable_conditional': name_utilities.enable_conditional_if_endif,
  61         'hash': hasher.hash,
  62         'script_name': name_utilities.script_name,
  63         'symbol': _symbol,
  64         'to_macro_style': name_utilities.to_macro_style,
  65     }
  66
  67     def __init__(self, in_file_path):
  68         super(MakeNamesWriter, self).__init__(in_file_path)
  69
  70         namespace = self.in_file.parameters['namespace'].strip('"')
  71         suffix = self.in_file.parameters['suffix'].strip('"')
  72         export = self.in_file.parameters['export'].strip('"')
  73
  74         assert namespace, 'A namespace is required.'
  75
  76         self._outputs = {
  77             (namespace + suffix + 'Names.h'): self.generate_header,
  78             (namespace + suffix + 'Names.cpp'): self.generate_implementation,
  79         }
  80         self._template_context = {
  81             'namespace': namespace,
  82             'suffix': suffix,
  83             'export': export,
  84             'entries': self.in_file.name_dictionaries,
  85             'in_files': self.in_file.file_paths,
  86         }
  87
  88     @template_expander.use_jinja("MakeNames.h.tmpl", filters=filters)
  89     def generate_header(self):
  90         return self._template_context
  91
  92     @template_expander.use_jinja("MakeNames.cpp.tmpl", filters=filters)
  93     def generate_implementation(self):
  94         return self._template_context
  95
  96
  97 if __name__ == "__main__":
  98     in_generator.Maker(MakeNamesWriter).main(sys.argv)