Make per-interface generators an implementation detail of a system.

lib/dom/scripts/systemhtml.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 system to generate
 Dart:html APIs from the IDL database."""
 
 from systemfrog import *
 from systeminterface import *
@@ skipping 755 matching lines @@
     self._shared = HtmlSystemShared(database)
 
 class HtmlInterfacesSystem(HtmlSystem):
 
   def __init__(self, templates, database, emitters, output_dir):
     super(HtmlInterfacesSystem, self).__init__(
         templates, database, emitters, output_dir)
     self._dart_interface_file_paths = []
     self._factory_provider_emitters = {}
 
-  def InterfaceGenerator(self,
-                         interface,
-                         common_prefix,
-                         super_interface_name,
-                         source_filter):
+  def ProcessInterface(self, interface):
     """."""
     if interface.id in _merged_html_interfaces:
-      return None
+      return
 
     html_interface_name = self._shared._HTMLInterfaceName(interface.id)
     dart_interface_file_path = self._FilePathForDartInterface(
         html_interface_name)
 
     self._dart_interface_file_paths.append(dart_interface_file_path)
 
     dart_interface_code = self._emitters.FileEmitter(dart_interface_file_path)
 
     template_file = 'interface_%s.darttemplate' % html_interface_name
     template = self._templates.TryLoad(template_file)
     if not template:
       template = self._templates.Load('interface.darttemplate')
 
-    return HtmlDartInterfaceGenerator(
+    generator = HtmlDartInterfaceGenerator(

[Anton Muhin, 2012/06/27 18:13:55]

ditto, overall, should be henerators a classes, or functions on its own (maybe
hiding a class behind)

[podivilov, 2012/06/27 18:48:07]

There should be a class to keep per-interface state. Hiding it behind a function
is possible, but I don't see much benefit in it.

         self, interface, dart_interface_code,
-        template,
-        common_prefix, super_interface_name,
-        source_filter, self._shared)
+        template, self._shared)
+    generator.Generate()
 
   def ProcessCallback(self, interface, info):
     """Generates a typedef for the callback interface."""
     interface_name = interface.id
     file_path = self._FilePathForDartInterface(interface_name)
     self._ProcessCallback(interface, info, file_path)
 
   def GenerateLibraries(self):
     pass
 
 
   def _FilePathForDartInterface(self, interface_name):
     """Returns the file path of the Dart interface definition."""
     # TODO(jmesserly): is this the right path
     return os.path.join(self._output_dir, 'html', 'interface',
                         '%s.dart' % interface_name)
 
 # ------------------------------------------------------------------------------
 
 # TODO(jmesserly): inheritance is probably not the right way to factor this long
 # term, but it makes merging better for now.
 class HtmlDartInterfaceGenerator(DartInterfaceGenerator):
   """Generates Dart Interface definition for one DOM IDL interface."""
 
-  def __init__(self, system, interface, emitter, template,
-               common_prefix, super_interface, source_filter, shared):
+  def __init__(self, system, interface, emitter, template, shared):
     super(HtmlDartInterfaceGenerator, self).__init__(system, interface,
-      emitter, template, common_prefix, super_interface, source_filter)
+      emitter, template)
     self._shared = shared
     self._html_interface_name = self._shared._HTMLInterfaceName(
         self._interface.id)
 
   def StartInterface(self):
     typename = self._html_interface_name
 
     extends = []
     suppressed_extends = []
 
     for parent in self._interface.parents:
       # TODO(vsm): Remove source_filter.
-      if MatchSourceFilter(self._source_filter, parent):
+      if MatchSourceFilter(parent):
         # Parent is a DOM type.
         extends.append(self._shared.DartType(parent.type.id))
       elif '<' in parent.type.id:
         # Parent is a Dart collection type.
         # TODO(vsm): Make this check more robust.
         extends.append(self._shared.DartType(parent.type.id))
       else:
         suppressed_extends.append('%s.%s' %
             (self._common_prefix, self._shared.DartType(parent.type.id)))
 
@@ skipping 162 matching lines @@
 
 # ------------------------------------------------------------------------------
 
 # TODO(jmesserly): inheritance is probably not the right way to factor this long
 # term, but it makes merging better for now.
 class HtmlFrogClassGenerator(FrogInterfaceGenerator):
   """Generates a Frog class for the dart:html library from a DOM IDL
   interface.
   """
 
-  def __init__(self, system, interface, template, super_interface, dart_code,
+  def __init__(self, system, interface, template, dart_code,
       shared):
     super(HtmlFrogClassGenerator, self).__init__(
-        system, interface, template, super_interface, dart_code)
+        system, interface, template, dart_code)
     self._shared = shared
     self._html_interface_name = self._shared._HTMLInterfaceName(
         self._interface.id)
 
   def _ImplClassName(self, type_name):
     return self._shared._ImplClassName(type_name)
 
   def _NarrowToImplementationType(self, type_name):
     if self._ShouldNarrowToImplementationType(type_name):
       return self._ImplClassName(self._shared.DartType(type_name))
@@ skipping 306 matching lines @@
 # ------------------------------------------------------------------------------
 
 class HtmlFrogSystem(HtmlSystem):
 
   def __init__(self, templates, database, emitters, output_dir):
     super(HtmlFrogSystem, self).__init__(
         templates, database, emitters, output_dir)
     self._dart_frog_file_paths = []
     self._factory_provider_emitters = {}
 
-  def InterfaceGenerator(self,
-                         interface,
-                         common_prefix,
-                         super_interface_name,
-                         source_filter):
+  def ProcessInterface(self, interface):
     """."""
     if interface.id in _merged_html_interfaces:
       return None
 
     if IsPureInterface(interface.id):
       return
 
     html_interface_name = self._shared._HTMLInterfaceName(interface.id)
     template_file = 'impl_%s.darttemplate' % html_interface_name
     template = self._templates.TryLoad(template_file)
     if not template:
       template = self._templates.Load('frog_impl.darttemplate')
 
     dart_code = self._ImplFileEmitter(html_interface_name)
-    return HtmlFrogClassGenerator(self, interface, template,
-                                  super_interface_name, dart_code, self._shared)
+    generator = HtmlFrogClassGenerator(self, interface, template,
+                                       dart_code, self._shared)
+    generator.Generate()
 
   def GenerateLibraries(self):
     self._GenerateLibFile(
         'html_frog.darttemplate',
         os.path.join(self._output_dir, 'html_frog.dart'),
         (self._interface_system._dart_interface_file_paths +
          self._interface_system._dart_callback_file_paths +
          self._dart_frog_file_paths))
 
   def Finish(self):
@@ skipping 20 matching lines @@
                dom_implementation_classes, output_dir):
     """Prepared for generating wrapping implementation.
 
     - Creates emitter for Dart code.
     """
     super(HtmlDartiumSystem, self).__init__(
         templates, database, emitters, output_dir)
     self._auxiliary_dir = auxiliary_dir
     self._dom_implementation_classes = dom_implementation_classes
 
-  def InterfaceGenerator(self,
-                         interface,
-                         common_prefix,
-                         super_interface_name,
-                         source_filter):
+  def ProcessInterface(self, interface):
     # Implementation classes are generated by NativeImplementationSystem.
     # FIXME: merge HtmlDartiumSystem into NativeImplementationSystem.
-    return None
+    pass
 
   def ProcessCallback(self, interface, info):
     pass
 
   def GenerateLibraries(self):
     # Library generated for implementation.
     auxiliary_dir = os.path.relpath(self._auxiliary_dir, self._output_dir)
 
     self._GenerateLibFile(
         'html_dartium.darttemplate',
@@ skipping 23 matching lines @@
             Collect(database.GetInterface(parent.type.id),
                     seen, collected)
 
   inheritance_closure = {}
   for interface in database.GetInterfaces():
     seen = set()
     collected = []
     Collect(interface, seen, collected)
     inheritance_closure[interface.id] = collected
   return inheritance_closure