Get rid of System classes for backend generators.

lib/html/scripts/systemnative.py

 #!/usr/bin/python
 # Copyright (c) 2012, the Dart project authors.  Please see the AUTHORS file
 # for details. All rights reserved. Use of this source code is governed by a
 # BSD-style license that can be found in the LICENSE file.
 
 """This module provides shared functionality for the systems to generate
 native binding from the IDL database."""
 
 import emitter
 import os
-import systembase
 from generator import *
+from systembase import BaseGenerator
 
 
-class NativeImplementationSystem(systembase.System):
+class DartiumGeneratorBackend(BaseGenerator):

[Anton Muhin, 2012/09/26 14:20:36]

NativeGeneratorBackend or even NativeGenerator?

[podivilov, 2012/09/26 15:02:04]

"native" is confusing. Renamed to DartiumBackend.

+  """Generates Dart implementation for one DOM IDL interface."""
 
-  def __init__(self, options, cpp_library_emitter):
-    super(NativeImplementationSystem, self).__init__(options)
+  def __init__(self, interface, cpp_library_emitter, options):
+    super(DartiumGeneratorBackend, self).__init__(
+        options.database, options.type_registry, interface)
     self._cpp_library_emitter = cpp_library_emitter
+    self._template_loader = options.templates
+    self._html_interface_name = options.renamer.RenameInterface(self._interface)
 
-  def ImplementationGenerator(self, interface):
-    return NativeImplementationGenerator(self, interface)
+  def HasImplementation(self):
+    return not IsPureInterface(self._interface.id)
 
-  def ProcessCallback(self, interface, info):
-    self._interface = interface
+  def ImplementationClassName(self):
+    return self._ImplClassName(self._interface.id)
 
+  def SetImplementationEmitter(self, implementation_emitter):
+    self._dart_impl_emitter = implementation_emitter
+
+  def ImplementsMergedMembers(self):
+    # We could not add merged functions to implementation class because
+    # underlying c++ object doesn't implement them. Merged functions are
+    # generated on merged interface implementation instead.
+    return False
+
+  def GenerateCallback(self, info):
     if IsPureInterface(self._interface.id):
-      return None
+      return
 
     cpp_impl_includes = set()
     cpp_header_handlers_emitter = emitter.Emitter()
     cpp_impl_handlers_emitter = emitter.Emitter()
     class_name = 'Dart%s' % self._interface.id
-    for operation in interface.operations:
+    for operation in self._interface.operations:
       parameters = []
       arguments = []
       conversion_includes = []
       for argument in operation.arguments:
-        argument_type_info = self._type_registry.TypeInfo(argument.type.id)
+        argument_type_info = self._TypeInfo(argument.type.id)
         parameters.append('%s %s' % (argument_type_info.parameter_type(),
                                      argument.id))
         arguments.append(argument_type_info.to_dart_conversion(argument.id))
         conversion_includes.extend(argument_type_info.conversion_includes())
 
       cpp_header_handlers_emitter.Emit(
           '\n'
           '    virtual bool handleEvent($PARAMETERS);\n',
           PARAMETERS=', '.join(parameters))
 
@@ skipping 15 matching lines @@
           '    $ARGUMENTS_DECLARATION;\n'
           '    return m_callback.handleEvent($ARGUMENT_COUNT, arguments);\n'
           '}\n',
           CLASS_NAME=class_name,
           PARAMETERS=', '.join(parameters),
           ARGUMENTS_DECLARATION=arguments_declaration,
           ARGUMENT_COUNT=len(arguments))
 
     cpp_header_emitter = self._cpp_library_emitter.CreateHeaderEmitter(self._interface.id, True)
     cpp_header_emitter.Emit(
-        self._templates.Load('cpp_callback_header.template'),
+        self._template_loader.Load('cpp_callback_header.template'),
         INTERFACE=self._interface.id,
         HANDLERS=cpp_header_handlers_emitter.Fragments())
 
     cpp_impl_emitter = self._cpp_library_emitter.CreateSourceEmitter(self._interface.id)
     cpp_impl_emitter.Emit(
-        self._templates.Load('cpp_callback_implementation.template'),
-        INCLUDES=_GenerateCPPIncludes(cpp_impl_includes),
+        self._template_loader.Load('cpp_callback_implementation.template'),
+        INCLUDES=self._GenerateCPPIncludes(cpp_impl_includes),
         INTERFACE=self._interface.id,
         HANDLERS=cpp_impl_handlers_emitter.Fragments())
 
-
-class NativeImplementationGenerator(systembase.BaseGenerator):
-  """Generates Dart implementation for one DOM IDL interface."""
-
-  def __init__(self, system, interface):
-    """Generates Dart and C++ code for the given interface.
-
-    Args:
-      system: The NativeImplementationSystem.
-      interface: an IDLInterface instance. It is assumed that all types have
-          been converted to Dart types (e.g. int, String), unless they are in
-          the same package as the interface.
-    """
-    super(NativeImplementationGenerator, self).__init__(
-        system._database, interface)
-    self._system = system
-    self._current_secondary_parent = None
-    self._html_interface_name = system._renamer.RenameInterface(self._interface)
-
-  def HasImplementation(self):
-    return not IsPureInterface(self._interface.id)
-
-  def ImplementationClassName(self):
-    return self._ImplClassName(self._interface.id)
-
-  def SetImplementationEmitter(self, implementation_emitter):
-    self._dart_impl_emitter = implementation_emitter
-
-  def ImplementsMergedMembers(self):
-    # We could not add merged functions to implementation class because
-    # underlying c++ object doesn't implement them. Merged functions are
-    # generated on merged interface implementation instead.
-    return False
-
   def StartInterface(self):
     # Create emitters for c++ implementation.
     if self.HasImplementation():
-      self._cpp_header_emitter = self._system._cpp_library_emitter.CreateHeaderEmitter(self._interface.id)
-      self._cpp_impl_emitter = self._system._cpp_library_emitter.CreateSourceEmitter(self._interface.id)
+      self._cpp_header_emitter = self._cpp_library_emitter.CreateHeaderEmitter(self._interface.id)
+      self._cpp_impl_emitter = self._cpp_library_emitter.CreateSourceEmitter(self._interface.id)
     else:
       self._cpp_header_emitter = emitter.Emitter()
       self._cpp_impl_emitter = emitter.Emitter()
 
     self._interface_type_info = self._TypeInfo(self._interface.id)
     self._members_emitter = emitter.Emitter()
     self._cpp_declarations_emitter = emitter.Emitter()
     self._cpp_impl_includes = set()
     self._cpp_definitions_emitter = emitter.Emitter()
     self._cpp_resolver_emitter = emitter.Emitter()
@@ skipping 85 matching lines @@
       return True
 
     # FIXME: support other types of ConstructorTemplate.
     if ext_attrs.get('ConstructorTemplate') == 'TypedArray':
       return True
 
     return False
 
   def EmitFactoryProvider(self, constructor_info, factory_provider, emitter):
     template_file = 'factoryprovider_%s.darttemplate' % self._html_interface_name
-    template = self._system._templates.TryLoad(template_file)
+    template = self._template_loader.TryLoad(template_file)
     if not template:
-      template = self._system._templates.Load('factoryprovider.darttemplate')
+      template = self._template_loader.Load('factoryprovider.darttemplate')
 
     native_binding = '%s_constructor_Callback' % self._interface.id
     emitter.Emit(
         template,
         FACTORYPROVIDER=factory_provider,
         INTERFACE=self._html_interface_name,
         PARAMETERS=constructor_info.ParametersImplementationDeclaration(self._DartType),
         ARGUMENTS=constructor_info.ParametersAsArgumentList(),
         NATIVE_NAME=native_binding)
 
   def FinishInterface(self):
     template = None
     if self._html_interface_name == self._interface.id or not self._database.HasInterface(self._html_interface_name):
       template_file = 'impl_%s.darttemplate' % self._html_interface_name
-      template = self._system._templates.TryLoad(template_file)
+      template = self._template_loader.TryLoad(template_file)
     if not template:
-      template = self._system._templates.Load('dart_implementation.darttemplate')
+      template = self._template_loader.Load('dart_implementation.darttemplate')
 
     class_name = self._ImplClassName(self._interface.id)
     members_emitter = self._dart_impl_emitter.Emit(
         template,
         CLASSNAME=class_name,
         EXTENDS=' extends ' + self._BaseClassName(),
         IMPLEMENTS=' implements ' + self._html_interface_name,
         NATIVESPEC='')
     members_emitter.Emit(''.join(self._members_emitter.Fragments()))
 
     self._GenerateCPPHeader()
 
     self._cpp_impl_emitter.Emit(
-        self._system._templates.Load('cpp_implementation.template'),
+        self._template_loader.Load('cpp_implementation.template'),
         INTERFACE=self._interface.id,
-        INCLUDES=_GenerateCPPIncludes(self._cpp_impl_includes),
+        INCLUDES=self._GenerateCPPIncludes(self._cpp_impl_includes),
         CALLBACKS=self._cpp_definitions_emitter.Fragments(),
         RESOLVER=self._cpp_resolver_emitter.Fragments(),
         DART_IMPLEMENTATION_CLASS=class_name)
 
   def _GenerateCPPHeader(self):
     to_native_emitter = emitter.Emitter()
     if self._interface_type_info.custom_to_native():
       to_native_emitter.Emit(
           '    static PassRefPtr<NativeType> toNative(Dart_Handle handle, Dart_Handle& exception);\n')
     else:
@@ skipping 16 matching lines @@
       to_dart_emitter.Emit(
           '    static Dart_Handle toDart(NativeType* value);\n')
     else:
       to_dart_emitter.Emit(
           '    static Dart_Handle toDart(NativeType* value)\n'
           '    {\n'
           '        return DartDOMWrapper::toDart<Dart$(INTERFACE)>(value);\n'
           '    }\n',
           INTERFACE=self._interface.id)
 
-    webcore_includes = _GenerateCPPIncludes(self._interface_type_info.webcore_includes())
+    webcore_includes = self._GenerateCPPIncludes(
+        self._interface_type_info.webcore_includes())
 
     is_node_test = lambda interface: interface.id == 'Node'
     is_active_test = lambda interface: 'ActiveDOMObject' in interface.ext_attrs
     is_event_target_test = lambda interface: 'EventTarget' in interface.ext_attrs
     def TypeCheckHelper(test):
       return 'true' if any(map(test, self._database.Hierarchy(self._interface))) else 'false'
 
     self._cpp_header_emitter.Emit(
-        self._system._templates.Load('cpp_header.template'),
+        self._template_loader.Load('cpp_header.template'),
         INTERFACE=self._interface.id,
         WEBCORE_INCLUDES=webcore_includes,
         WEBCORE_CLASS_NAME=self._interface_type_info.native_type(),
         DECLARATIONS=self._cpp_declarations_emitter.Fragments(),
         IS_NODE=TypeCheckHelper(is_node_test),
         IS_ACTIVE=TypeCheckHelper(is_active_test),
         IS_EVENT_TARGET=TypeCheckHelper(is_event_target_test),
         TO_NATIVE=to_native_emitter.Fragments(),
         TO_DART=to_dart_emitter.Fragments())
 
@@ skipping 23 matching lines @@
         else:
           webcore_function_name = 'getURLAttribute'
     elif 'ImplementedAs' in attr.ext_attrs:
       webcore_function_name = attr.ext_attrs['ImplementedAs']
     else:
       if attr.id == 'operator':
         webcore_function_name = '_operator'
       elif attr.id == 'target' and attr.type.id == 'SVGAnimatedString':
         webcore_function_name = 'svgTarget'
       else:
-        webcore_function_name = _ToWebKitName(attr.id)
+        webcore_function_name = self._ToWebKitName(attr.id)
       if attr.type.id.startswith('SVGAnimated'):
         webcore_function_name += 'Animated'
 
     function_expression = self._GenerateWebCoreFunctionExpression(webcore_function_name, attr)
     self._GenerateNativeCallback(
         cpp_callback_name,
         True,
         function_expression,
         attr,
         [],
@@ skipping 71 matching lines @@
             '  }\n',
             TYPE=dart_element_type)
 
     # The list interface for this class is manually generated.
     if self._interface.id == 'NodeList':
       return
 
     # TODO(sra): Use separate mixins for mutable implementations of List<T>.
     # TODO(sra): Use separate mixins for typed array implementations of List<T>.
     template_file = 'immutable_list_mixin.darttemplate'
-    template = self._system._templates.Load(template_file)
+    template = self._template_loader.Load(template_file)
     self._members_emitter.Emit(template, E=dart_element_type)
 
   def AmendIndexer(self, element_type):
     # If interface is marked as having native indexed
     # getter or setter, we must emit overrides as it's not
     # guaranteed that the corresponding methods in C++ would be
     # virtual.  For example, as of time of writing, even though
     # Uint8ClampedArray inherits from Uint8Array, ::set method
     # is not virtual and accessing it through Uint8Array pointer
     # would lead to wrong semantics (modulo vs. clamping.)
@@ skipping 199 matching lines @@
           FEATURE=v8EnabledPerContext)
 
     if v8EnabledAtRuntime:
       raises_exceptions = True
       self._cpp_impl_includes.add('"RuntimeEnabledFeatures.h"')
       runtime_check = emitter.Format(
           '        if (!RuntimeEnabledFeatures::$(FEATURE)Enabled()) {\n'
           '            exception = Dart_NewString("Feature $FEATURE is not enabled");\n'
           '            goto fail;\n'
           '        }',
-          FEATURE=_ToWebKitName(v8EnabledAtRuntime))
+          FEATURE=self._ToWebKitName(v8EnabledAtRuntime))
 
     body_emitter = self._cpp_definitions_emitter.Emit(
         '\n'
         'static void $CALLBACK_NAME(Dart_NativeArguments args)\n'
         '{\n'
         '    DartApiScope dartApiScope;\n'
         '$!BODY'
         '}\n',
         CALLBACK_NAME=callback_name)
 
@@ skipping 160 matching lines @@
     attribute_name = attr.ext_attrs['Reflect'] or attr.id.lower()
     return 'WebCore::%s::%sAttr' % (namespace, attribute_name)
 
   def _GenerateWebCoreFunctionExpression(self, function_name, idl_node):
     if 'ImplementedBy' in idl_node.ext_attrs:
       return '%s::%s' % (idl_node.ext_attrs['ImplementedBy'], function_name)
     if idl_node.is_static:
       return '%s::%s' % (self._interface_type_info.idl_type(), function_name)
     return '%s%s' % (self._interface_type_info.receiver(), function_name)
 
-  def _TypeInfo(self, type_name):
-    return self._system._type_registry.TypeInfo(type_name)
-
   def _IsArgumentOptionalInWebCore(self, operation, argument):
     if not IsOptional(argument):
       return False
     if 'Callback' in argument.ext_attrs:
       return False
     if operation.id in ['addEventListener', 'removeEventListener'] and argument.id == 'useCapture':
       return False
     # Another option would be to adjust in IDLs, but let's keep it here for now
     # as it's a single instance.
     if self._interface.id == 'CSSStyleDeclaration' and operation.id == 'setProperty' and argument.id == 'priority':
       return False
     return True
 
+  def _GenerateCPPIncludes(self, includes):

[Anton Muhin, 2012/09/26 14:20:36]

why it is method now, not a free function?

[podivilov, 2012/09/26 15:02:04]

It's only used in DartiumBackend class.

[Anton Muhin, 2012/09/26 15:17:25]

Up to you.  I'd vote for keeping it free function or making static to make it
explicit it doesn't depend on state.

On 2012/09/26 15:02:04, podivilov wrote:

+    return ''.join(['#include %s\n' % include for include in sorted(includes)])
+
+  def _ToWebKitName(self, name):

[Anton Muhin, 2012/09/26 14:20:36]

ditto

+    name = name[0].lower() + name[1:]
+    name = re.sub(r'^(hTML|uRL|jS|xML|xSLT)', lambda s: s.group(1).lower(),
+                  name)
+    return re.sub(r'^(create|exclusive)',
+                  lambda s: 'is' + s.group(1).capitalize(),
+                  name)
+
 
 class CPPLibraryEmitter():
   def __init__(self, emitters, cpp_sources_dir):
     self._emitters = emitters
     self._cpp_sources_dir = cpp_sources_dir
     self._headers_list = []
     self._sources_list = []
 
   def CreateHeaderEmitter(self, interface_name, is_callback=False):
     path = os.path.join(self._cpp_sources_dir, 'Dart%s.h' % interface_name)
@@ skipping 19 matching lines @@
   def EmitResolver(self, template, output_dir):
     file_path = os.path.join(output_dir, 'DartResolver.cpp')
     includes_emitter, body_emitter = self._emitters.FileEmitter(file_path).Emit(template)
     for header_file in self._headers_list:
       path = os.path.relpath(header_file, output_dir)
       includes_emitter.Emit('#include "$PATH"\n', PATH=path)
       body_emitter.Emit(
           '    if (Dart_NativeFunction func = $CLASS_NAME::resolver(name, argumentCount))\n'
           '        return func;\n',
           CLASS_NAME=os.path.splitext(os.path.basename(path))[0])
-
-
-def _GenerateCPPIncludes(includes):
-  return ''.join(['#include %s\n' % include for include in sorted(includes)])
-
-def _FindInHierarchy(database, interface, test):
-  if test(interface):
-    return interface
-  for parent in interface.parents:
-    parent_name = parent.type.id
-    if not database.HasInterface(parent.type.id):
-      continue
-    parent_interface = database.GetInterface(parent.type.id)
-    parent_interface = _FindInHierarchy(database, parent_interface, test)
-    if parent_interface:
-      return parent_interface
-
-def _ToWebKitName(name):
-  name = name[0].lower() + name[1:]
-  name = re.sub(r'^(hTML|uRL|jS|xML|xSLT)', lambda s: s.group(1).lower(),
-                name)
-  return re.sub(r'^(create|exclusive)', lambda s: 'is' + s.group(1).capitalize(),
-                name)