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

   1 # Copyright (C) 2013 Google Inc. All rights reserved.
   2 #
   3 # Redistribution and use in source and binary forms, with or without
   4 # modification, are permitted provided that the following conditions are
   5 # met:
   6 #
   7 #     * Redistributions of source code must retain the above copyright
   8 # notice, this list of conditions and the following disclaimer.
   9 #     * Redistributions in binary form must reproduce the above
  10 # copyright notice, this list of conditions and the following disclaimer
  11 # in the documentation and/or other materials provided with the
  12 # distribution.
  13 #     * Neither the name of Google Inc. nor the names of its
  14 # contributors may be used to endorse or promote products derived from
  15 # this software without specific prior written permission.
  16 #
  17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28
  29 import os.path
  30 import re
  31
  32
  33 ACRONYMS = [
  34     'CSSOM',
  35     'CSS',
  36     'DNS',
  37     'FE',
  38     'FTP',
  39     'HTML',
  40     'JS',
  41     'SVG',
  42     'URL',
  43     'WOFF',
  44     'XML',
  45     'XSLT',
  46     'XSS',
  47 ]
  48
  49
  50 def lower_first(name):
  51     """Return name with first letter or initial acronym lowercased.
  52
  53     E.g., 'SetURL' becomes 'setURL', but 'URLFoo' becomes 'urlFoo'.
  54     """
  55     for acronym in ACRONYMS:
  56         if name.startswith(acronym):
  57             return name.replace(acronym, acronym.lower(), 1)
  58     return name[0].lower() + name[1:]
  59
  60
  61 def upper_first(name):
  62     """Return name with first letter or initial acronym uppercased."""
  63     for acronym in ACRONYMS:
  64         if name.startswith(acronym.lower()):
  65             return name.replace(acronym.lower(), acronym, 1)
  66     return upper_first_letter(name)
  67
  68
  69 def upper_first_letter(name):
  70     """Return name with first letter uppercased."""
  71     if not name:
  72         return ''
  73     return name[0].upper() + name[1:]
  74
  75
  76 def to_macro_style(name):
  77     s1 = re.sub('(.)([A-Z][a-z]+)', r'\1_\2', name)
  78     return re.sub('([a-z0-9])([A-Z])', r'\1_\2', s1).upper()
  79
  80
  81 def script_name(entry):
  82     return os.path.basename(entry['name'])
  83
  84
  85 def cpp_name(entry):
  86     return entry['ImplementedAs'] or script_name(entry)
  87
  88
  89 def enable_conditional_if_endif(code, feature):
  90     # Jinja2 filter to generate if/endif directive blocks based on a feature
  91     if not feature:
  92         return code
  93     condition = 'ENABLE(%s)' % feature
  94     return ('#if %s\n' % condition +
  95             code +
  96             '#endif // %s\n' % condition)