Implement automatically generated constructors for frog and dartium dart:html

client/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 573 matching lines @@
             (self._common_prefix, DartType(parent.type.id)))
 
     comment = ' extends'
     extends_str = ''
     if extends:
       extends_str += ' extends ' + ', '.join(extends)
       comment = ','
     if suppressed_extends:
       extends_str += ' /*%s %s */' % (comment, ', '.join(suppressed_extends))
 
+    factory_provider = None
+    constructor_info = AnalyzeConstructor(self._interface)
+    if constructor_info:
+      factory_provider = '_' + typename + 'FactoryProvider';
+
     if typename in interface_factories:
-      extends_str += ' default ' + interface_factories[typename]
+      factory_provider = interface_factories[typename]
+
+    if factory_provider:
+      extends_str += ' default ' + factory_provider
 
     # TODO(vsm): Add appropriate package / namespace syntax.
     (self._members_emitter,
      self._top_level_emitter) = self._emitter.Emit(
          self._template + '$!TOP_LEVEL',
          ID=typename,
          EXTENDS=extends_str)
 
+    if constructor_info:
+      self._members_emitter.Emit(
+          '\n'
+          '  $CTOR($PARAMS);\n',
+          CTOR=typename,
+          PARAMS=constructor_info.ParametersInterfaceDeclaration());
+
     element_type = MaybeTypedArrayElementType(self._interface)
     if element_type:
       self._members_emitter.Emit(
           '\n'
           '  $CTOR(int length);\n'
           '\n'
           '  $CTOR.fromList(List<$TYPE> list);\n'
           '\n'
           '  $CTOR.fromBuffer(ArrayBuffer buffer);\n',
         CTOR=self._interface.id,
@@ skipping 117 matching lines @@
         #$!MEMBERS
         #}
         CLASSNAME=self._class_name,
         EXTENDS=extends,
         IMPLEMENTS=' implements ' + ', '.join(implements),
         NATIVESPEC=' native "' + native_spec + '"')
 
     if element_type:
       self.AddTypedArrayConstructors(element_type)
 
+    # Emit a factory provider class for the constructor.
+    constructor_info = AnalyzeConstructor(interface)
+    if constructor_info:
+      self._EmitFactoryProvider(interface_name, constructor_info)
+
+  def _EmitFactoryProvider(self, interface_name, constructor_info):
+    template_file = 'factoryprovider_%s.darttemplate' % interface_name
+    template = self._system._templates.TryLoad(template_file)
+    if not template:
+      template = self._system._templates.Load('factoryprovider.darttemplate')
+
+    factory_provider = '_' + interface_name + 'FactoryProvider'
+    emitter = self._system._ImplFileEmitter(factory_provider)
+    emitter.Emit(
+        template,
+        FACTORYPROVIDER=factory_provider,
+        CONSTRUCTOR=interface_name,
+        PARAMETERS=constructor_info.ParametersImplementationDeclaration(),
+        NAMED_CONSTRUCTOR=constructor_info.name or interface_name,
+        ARGUMENTS=constructor_info.ParametersAsArgumentList())
+
   def AddIndexer(self, element_type):
     """Adds all the methods required to complete implementation of List."""
     # We would like to simply inherit the implementation of everything except
     # get length(), [], and maybe []=.  It is possible to extend from a base
     # array implementation class only when there is no other implementation
     # inheritance.  There might be no implementation inheritance other than
     # DOMBaseWrapper for many classes, but there might be some where the
     # array-ness is introduced by a non-root interface:
     #
     #   interface Y extends X, List<T> ...
@@ skipping 242 matching lines @@
         templates, database, emitters, output_dir, generator)
     self._dart_frog_file_paths = []
 
 
   def InterfaceGenerator(self,
                          interface,
                          common_prefix,
                          super_interface_name,
                          source_filter):
     """."""
-    dart_frog_file_path = self._FilePathForFrogImpl(interface.id)
-    self._dart_frog_file_paths.append(dart_frog_file_path)
-
     template_file = 'impl_%s.darttemplate' % interface.id
     template = self._templates.TryLoad(template_file)
     if not template:
       template = self._templates.Load('frog_impl.darttemplate')
 
-    dart_code = self._emitters.FileEmitter(dart_frog_file_path)
+    dart_code = self._ImplFileEmitter(interface.id)
     return HtmlFrogClassGenerator(self, interface, template,
                                   super_interface_name, dart_code, self._shared)
 
   def GenerateLibraries(self, lib_dir):
     self._GenerateLibFile(
         'html_frog.darttemplate',
         os.path.join(lib_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):
     pass
 
-  def _FilePathForFrogImpl(self, interface_name):
-    """Returns the file path of the Frog implementation."""
+  def _ImplFileEmitter(self, name):
+    """Returns the file emitter of the Frog implementation file."""
     # TODO(jmesserly): is this the right path
-    return os.path.join(self._output_dir, 'html', 'frog',
-                        '%s.dart' % interface_name)
+    path = os.path.join(self._output_dir, 'html', 'frog', '%s.dart' % name)
+    self._dart_frog_file_paths.append(path)
+    return self._emitters.FileEmitter(path)
 
 # -----------------------------------------------------------------------------
 
 class HtmlDartiumSystem(HtmlSystem):
 
   def __init__(self, templates, database, emitters, output_dir, generator):
     """Prepared for generating wrapping implementation.
 
     - Creates emitter for Dart code.
     """
     super(HtmlDartiumSystem, self).__init__(
         templates, database, emitters, output_dir, generator)
     self._shared = HtmlSystemShared(database, generator)
     self._dart_dartium_file_paths = []
     self._wrap_cases = []
 
   def InterfaceGenerator(self,
                          interface,
                          common_prefix,
                          super_interface_name,
                          source_filter):
     """."""
-    dart_dartium_file_path = self._FilePathForImpl(interface.id)
-    self._dart_dartium_file_paths.append(dart_dartium_file_path)
-
     template_file = 'impl_%s.darttemplate' % interface.id
     template = self._templates.TryLoad(template_file)
     # TODO(jacobr): change this name as it is confusing.
     if not template:
       template = self._templates.Load('frog_impl.darttemplate')
 
-    dart_code = self._emitters.FileEmitter(dart_dartium_file_path)
+    dart_code = self._ImplFileEmitter(interface.id)
     return HtmlDartiumInterfaceGenerator(self, interface, template,
         super_interface_name, dart_code, self._BaseDefines(interface),
         self._shared)
 
-  def _FilePathForImpl(self, interface_name):
-    """Returns the file path of the Frog implementation."""
-    # TODO(jmesserly): is this the right path
-    return os.path.join(self._output_dir, 'html', 'dartium',
-                        '%s.dart' % interface_name)
+  def _ImplFileEmitter(self, name):
+    """Returns the file emitter of the Dartium implementation file."""
+    path = os.path.join(self._output_dir, 'html', 'dartium', '%s.dart' % name)
+    self._dart_dartium_file_paths.append(path)
+    return self._emitters.FileEmitter(path);
 
   def ProcessCallback(self, interface, info):
     pass
 
   def GenerateLibraries(self, lib_dir):
     # Library generated for implementation.
     self._GenerateLibFile(
         'html_dartium.darttemplate',
         os.path.join(lib_dir, 'html_dartium.dart'),
         (self._interface_system._dart_interface_file_paths +
          self._interface_system._dart_callback_file_paths +
-         # FIXME: Move the implementation to a separate library.
          self._dart_dartium_file_paths
          ),
         WRAPCASES='\n'.join(self._wrap_cases))
 
   def Finish(self):
     pass
 
 # ------------------------------------------------------------------------------
 
 # TODO(jacobr): there is far too much duplicated code between these bindings
@@ skipping 101 matching lines @@
         CLASSNAME=self._class_name,
         EXTENDS=extends,
         IMPLEMENTS=' implements ' + implements_str)
 
     # Document requires a custom wrapper.
     if dom_name != 'Document':
       self._members_emitter.Emit(
           '  $(CLASSNAME)._wrap(ptr) : super._wrap(ptr);\n',
           CLASSNAME=self._class_name)
 
+    # Emit a factory provider class for the constructor.
+    constructor_info = AnalyzeConstructor(interface)
+    if constructor_info:
+      self._EmitFactoryProvider(interface_name, constructor_info)
+
+  def _EmitFactoryProvider(self, interface_name, constructor_info):
+    template_file = 'factoryprovider_%s.darttemplate' % interface_name
+    template = self._system._templates.TryLoad(template_file)
+    if not template:
+      template = self._system._templates.Load('factoryprovider.darttemplate')
+
+    factory_provider = '_' + interface_name + 'FactoryProvider'
+    emitter = self._system._ImplFileEmitter(factory_provider)
+    emitter.Emit(
+        template,
+        FACTORYPROVIDER=factory_provider,
+        CONSTRUCTOR=interface_name,
+        PARAMETERS=constructor_info.ParametersImplementationDeclaration(),
+        NAMED_CONSTRUCTOR=constructor_info.name or interface_name,
+        ARGUMENTS=constructor_info.ParametersAsArgumentList())
+
   def _BaseClassName(self, interface):
     if not interface.parents:
       return '_DOMTypeBase'
 
     supertype = DartType(interface.parents[0].type.id)
 
     if IsDartListType(supertype) or IsDartCollectionType(supertype):
       return 'DOMWrapperBase'
 
     if supertype == 'EventTarget':
@@ skipping 450 matching lines @@
     # dispatch has removed f(X), leaving only f(Y), but there is no guarantee
     # that Y = Z-X, so we need to check for Y.
     true_code = emitter.Emit(
         '$(INDENT)if ($COND) {\n'
         '$!TRUE'
         '$(INDENT)}\n',
         COND=test, INDENT=indent)
     self.GenerateDispatch(
         true_code, info, indent + '  ', position + 1, positive)
     return True