Initial commit of the Dart Chrome Extension APIs generators

tools/json_schema_compiler/cpp_bundle_generator.py

 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 import code
 import cpp_util
 from model import Platforms
 from schema_util import CapitalizeFirstLetter
 from schema_util import JsFunctionNameToClassName
 
@@ skipping 13 matching lines @@
       # Some schemas actually have properties called "description", so only
       # remove descriptions that have string values.
       if key == 'description' and isinstance(value, basestring):
         continue
       result[key] = _RemoveDescriptions(value)
     return result
   if isinstance(node, list):
     return [_RemoveDescriptions(v) for v in node]
   return node
 
-class SchemaBundleGenerator(object):
+class CppBundleGenerator(object):
   """This class contains methods to generate code based on multiple schemas.
   """
 
   def __init__(self, root, model, api_defs, cpp_type_generator):
     self._root = root;
     self._model = model
     self._api_defs = api_defs
     self._cpp_type_generator = cpp_type_generator
 
+    self.api_h_generator = GenerateAPIHeader(self)
+    self.schemas_cc_generator = GenerateSchemasCC(self)
+    self.schemas_h_generator = GenerateSchemasHeader(self)
+
   def GenerateHeader(self, file_base, body_code):
     """Generates a code.Code object for a header file
 
     Parameters:
     - |file_base| - the base of the filename, e.g. 'foo' (for 'foo.h')
     - |body_code| - the code to put in between the multiple inclusion guards"""
     c = code.Code()
     c.Append(cpp_util.CHROMIUM_LICENSE)
     c.Append()
     c.Append(cpp_util.GENERATED_BUNDLE_FILE_MESSAGE % SOURCE_BASE_PATH)
@@ skipping 15 matching lines @@
     if model_object.platforms is None:
       return None
     ifdefs = []
     for platform in model_object.platforms:
       if platform == Platforms.CHROMEOS:
         ifdefs.append('defined(OS_CHROMEOS)')
       else:
         raise ValueError("Unsupported platform ifdef: %s" % platform.name)
     return ' and '.join(ifdefs)
 
-  def GenerateAPIHeader(self):
-    """Generates the header for API registration / declaration"""
-    c = code.Code()
-
-    c.Append('#include <string>')
-    c.Append()
-    c.Append('#include "base/basictypes.h"')
-
-    for namespace in self._model.namespaces.values():
-      namespace_name = namespace.unix_name.replace("experimental_", "")
-      implementation_header = namespace.compiler_options.get(
-          "implemented_in",
-          "chrome/browser/extensions/api/%s/%s_api.h" % (namespace_name,
-                                                         namespace_name))
-      if not os.path.exists(
-          os.path.join(self._root, os.path.normpath(implementation_header))):
-        if "implemented_in" in namespace.compiler_options:
-          raise ValueError('Header file for namespace "%s" specified in '
-                          'compiler_options not found: %s' %
-                          (namespace.unix_name, implementation_header))
-        continue
-      ifdefs = self._GetPlatformIfdefs(namespace)
-      if ifdefs is not None:
-        c.Append("#if %s" % ifdefs, indent_level=0)
-
-      c.Append('#include "%s"' % implementation_header)
-
-      if ifdefs is not None:
-        c.Append("#endif  // %s" % ifdefs, indent_level=0)
-
-    c.Append()
-    c.Append("class ExtensionFunctionRegistry;")
-    c.Append()
-
-    c.Concat(self._cpp_type_generator.GetRootNamespaceStart())
-    for namespace in self._model.namespaces.values():
-      c.Append("// TODO(miket): emit code for %s" % (namespace.unix_name))
-    c.Append()
-    c.Concat(self.GenerateFunctionRegistry())
-    c.Concat(self._cpp_type_generator.GetRootNamespaceEnd())
-    c.Append()
-    return self.GenerateHeader('generated_api', c)
-
   def _GetNamespaceFunctions(self, namespace):
     functions = list(namespace.functions.values())
     if namespace.compiler_options.get("generate_type_functions", False):
       for type_ in namespace.types.values():
         functions += list(type_.functions.values())
     return functions
 
   def GenerateFunctionRegistry(self):
     c = code.Code()
     c.Sblock("class GeneratedFunctionRegistry {")
@@ skipping 20 matching lines @@
         if function_ifdefs is not None:
           c.Append("#endif  // %s" % function_ifdefs, indent_level=0)
 
       if namespace_ifdefs is not None:
         c.Append("#endif  // %s" % namespace_ifdefs, indent_level=0)
     c.Eblock("}")
     c.Eblock("};")
     c.Append()
     return c
 
-  def GenerateSchemasHeader(self):
-    """Generates a code.Code object for the generated schemas .h file"""
+class GenerateAPIHeader(object):

[not at google - send to devlin, 2013/02/02 00:45:48]

_APIHGenerator would be more consistent with naming throughout the compiler.

[sashab, 2013/02/04 05:09:27]

Done.

+  """Generates the header for API registration / declaration"""
+  def __init__(self, cpp_bundle):
+    self._bundle = cpp_bundle
+
+  def Generate(self, namespace):
+    c = code.Code()
+
+    c.Append('#include <string>')
+    c.Append()
+    c.Append('#include "base/basictypes.h"')
+
+    for namespace in self._bundle._model.namespaces.values():
+      namespace_name = namespace.unix_name.replace("experimental_", "")
+      implementation_header = namespace.compiler_options.get(
+          "implemented_in",
+          "chrome/browser/extensions/api/%s/%s_api.h" % (namespace_name,
+                                                         namespace_name))
+      if not os.path.exists(
+          os.path.join(self._bundle._root,
+                       os.path.normpath(implementation_header))):
+        if "implemented_in" in namespace.compiler_options:
+          raise ValueError('Header file for namespace "%s" specified in '
+                          'compiler_options not found: %s' %
+                          (namespace.unix_name, implementation_header))
+        continue
+      ifdefs = self._bundle._GetPlatformIfdefs(namespace)
+      if ifdefs is not None:
+        c.Append("#if %s" % ifdefs, indent_level=0)
+
+      c.Append('#include "%s"' % implementation_header)
+
+      if ifdefs is not None:
+        c.Append("#endif  // %s" % ifdefs, indent_level=0)
+
+    c.Append()
+    c.Append("class ExtensionFunctionRegistry;")
+    c.Append()
+
+    c.Concat(self._bundle._cpp_type_generator.GetRootNamespaceStart())
+    for namespace in self._bundle._model.namespaces.values():
+      c.Append("// TODO(miket): emit code for %s" % (namespace.unix_name))
+    c.Append()
+    c.Concat(self._bundle.GenerateFunctionRegistry())
+    c.Concat(self._bundle._cpp_type_generator.GetRootNamespaceEnd())
+    c.Append()
+    return self._bundle.GenerateHeader('generated_api', c)
+
+class GenerateSchemasHeader(object):

[not at google - send to devlin, 2013/02/02 00:45:48]

_SchemasHGenerator

[sashab, 2013/02/04 05:09:27]

Done.

+  """Generates a code.Code object for the generated schemas .h file"""
+  def __init__(self, cpp_bundle):
+    self._bundle = cpp_bundle
+
+  def Generate(self, namespace):
     c = code.Code()
     c.Append('#include <map>')
     c.Append('#include <string>')
     c.Append();
     c.Append('#include "base/string_piece.h"')
     c.Append()
-    c.Concat(self._cpp_type_generator.GetRootNamespaceStart())
+    c.Concat(self._bundle._cpp_type_generator.GetRootNamespaceStart())
     c.Append()
     c.Sblock('class GeneratedSchemas {')
     c.Append(' public:')
     c.Append('// Puts all API schemas in |schemas|.')
     c.Append('static void Get('
                  'std::map<std::string, base::StringPiece>* schemas);')
     c.Eblock('};');
     c.Append()
-    c.Concat(self._cpp_type_generator.GetRootNamespaceEnd())
+    c.Concat(self._bundle._cpp_type_generator.GetRootNamespaceEnd())
     c.Append()
-    return self.GenerateHeader('generated_schemas', c)
+    return self._bundle.GenerateHeader('generated_schemas', c)
 
-  def GenerateSchemasCC(self):
-    """Generates a code.Code object for the generated schemas .cc file"""
+class GenerateSchemasCC(object):

[not at google - send to devlin, 2013/02/02 00:45:48]

_SchemasCCGenerator

[sashab, 2013/02/04 05:09:27]

Done.

+  """Generates a code.Code object for the generated schemas .cc file"""
+
+  def __init__(self, cpp_bundle):
+    self._bundle = cpp_bundle
+
+  def Generate(self, namespace):
     c = code.Code()
     c.Append(cpp_util.CHROMIUM_LICENSE)
     c.Append()
     c.Append('#include "%s"' % (os.path.join(SOURCE_BASE_PATH,
                                              'generated_schemas.h')))
     c.Append()
-    c.Concat(self._cpp_type_generator.GetRootNamespaceStart())
+    c.Concat(self._bundle._cpp_type_generator.GetRootNamespaceStart())
     c.Append()
     c.Append('// static')
     c.Sblock('void GeneratedSchemas::Get('
                  'std::map<std::string, base::StringPiece>* schemas) {')
-    for api in self._api_defs:
-      namespace = self._model.namespaces[api.get('namespace')]
+    for api in self._bundle._api_defs:
+      namespace = self._bundle._model.namespaces[api.get('namespace')]
       # JSON parsing code expects lists of schemas, so dump a singleton list.
       json_content = json.dumps([_RemoveDescriptions(api)],
                                 separators=(',', ':'))
       # Escape all double-quotes and backslashes. For this to output a valid
       # JSON C string, we need to escape \ and ".
       json_content = json_content.replace('\\', '\\\\').replace('"', '\\"')
       c.Append('(*schemas)["%s"] = "%s";' % (namespace.name, json_content))
     c.Eblock('}')
     c.Append()
-    c.Concat(self._cpp_type_generator.GetRootNamespaceEnd())
+    c.Concat(self._bundle._cpp_type_generator.GetRootNamespaceEnd())
     c.Append()
     return c