Rework Element constructors

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 418 matching lines @@
 
 
 
 # Information for generating element constructors.
 #
 # TODO(sra): maybe remove all the argument complexity and use cascades.
 #
 #   var c = new CanvasElement(width: 100, height: 70);
 #   var c = new CanvasElement()..width = 100..height = 70;
 #
 class ElementCtorInfo(object):

[vsm, 2012/06/01 01:45:25]

Consistency nit: you use both "CtorInfo" and "ConstructorInfo" in various places
in this file.  Pick one.

-  def __init__(self, tag=None, params=[], opt_params=[],
+  def __init__(self, name=None, tag=None,
+               params=[], opt_params=[],
                factory_provider_name='_Elements'):
-    self.tag = tag
+    self.name = name          # The constructor name 'h1' in 'HeadingElement.h1'
+    self.tag = tag or name

[vsm, 2012/06/01 01:45:25]

What is the difference between "tag" and "name"?  Comment on that would be
helpful.

     self.params = params
     self.opt_params = opt_params
     self.factory_provider_name = factory_provider_name
 
-  def ConstructorInfo(self, interface):
+  def ConstructorInfo(self, interface_name):
     info = OperationInfo()
     info.overloads = None
-    info.declared_name = interface.id
-    info.name = interface.id
+    info.declared_name = interface_name
+    info.name = interface_name
+    info.constructor_name = self.name
     info.js_name = None
-    info.type_name = interface.id
+    info.type_name = interface_name
     info.param_infos = map(lambda tXn: ParamInfo(tXn[1], None, tXn[0], 'null'),
                            self.opt_params)
     return info
 
 _html_element_constructors = {
   'AnchorElement' : ElementCtorInfo(tag='a', opt_params=[('String', 'href')]),
   'AreaElement': 'area',
   'ButtonElement': 'button',
   'BRElement': 'br',
   'BaseElement': 'base',
   'BodyElement': 'body',
   'ButtonElement': 'button',
   'CanvasElement':
     ElementCtorInfo(tag='canvas',
                     opt_params=[('int', 'height'), ('int', 'width')]),
   'DListElement': 'dl',
   'DetailsElement': 'details',
   'DivElement': 'div',
   'EmbedElement': 'embed',
   'FieldSetElement': 'fieldset',
   'Form': 'form',
   'HRElement': 'hr',
   'HeadElement': 'head',
+  'HeadingElement': [ElementCtorInfo('h1'),
+                     ElementCtorInfo('h2'),
+                     ElementCtorInfo('h3'),
+                     ElementCtorInfo('h4'),
+                     ElementCtorInfo('h5'),
+                     ElementCtorInfo('h6')],
   'HtmlElement': 'html',
   'IFrameElement': 'iframe',
   'ImageElement':
     ElementCtorInfo(tag='img',
                     opt_params=[('String', 'src'),
                                 ('int', 'height'), ('int', 'width')]),
   'InputElement':
     ElementCtorInfo(tag='input', opt_params=[('String', 'type')]),
   'KeygenElement': 'keygen',
   'LIElement': 'li',
@@ skipping 21 matching lines @@
   'TableElement': 'table',
   'TableRowElement': 'tr',
   #'TableSectionElement'  <thead> <tbody> <tfoot>
   'TextAreaElement': 'textarea',
   'TitleElement': 'title',
   'TrackElement': 'track',
   'UListElement': 'ul',
   'VideoElement': 'video'
 }
 
+def HtmlElementConstructorInfos(typename):
+  """Returns list of ElementCtorInfos about the convenience constructors for an
+  Element."""
+  # TODO(sra): Handle multiple and named constructors.
+  if typename not in _html_element_constructors:
+    return []
+  infos = _html_element_constructors[typename]
+  if isinstance(infos, str):
+    infos = ElementCtorInfo(tag=infos)
+  if not isinstance(infos, list):
+    infos = [infos]
+  return infos
+
+def EmitHtmlElementFactoryConstructors(emitter, infos, typename, class_name):
+  for info in infos:
+    constructor_info = info.ConstructorInfo(typename)
+    inits = emitter.Emit(
+        '\n'
+        '  factory $CONSTRUCTOR($PARAMS) {\n'
+        '    $CLASS _e = _document.$dom_createElement("$TAG");\n'
+        '$!INITS'
+        '    return _e;\n'
+        '  }\n',
+        CONSTRUCTOR=constructor_info.ConstructorFullName(),
+        CLASS=class_name,
+        TAG=info.tag,
+        PARAMS=constructor_info.ParametersInterfaceDeclaration())
+    for param in constructor_info.param_infos:
+      inits.Emit('    if ($E != null) _e.$E = $E;\n', E=param.name)
+
+
 # These classes require an explicit declaration for the "on" method even though
 # they don't declare any unique events, because the concrete class hierarchy
 # doesn't match the interface hierarchy.
 _html_explicit_event_classes = set(['DocumentFragment'])
 
 def _OnAttributeToEventName(on_method):
   event_name = on_method.id[2:]
   if event_name in _on_attribute_to_event_name_mapping:
     return _on_attribute_to_event_name_mapping[event_name]
   else:
@@ skipping 162 matching lines @@
   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)
 
-  def _EmitterForFactoryProviderBody(self, name):
-    if name not in self._factory_provider_emitters:
-      path = self._FilePathForDartInterface(name)
-      self._dart_interface_file_paths.append(path)
-      template = self._templates.Load('factoryprovider_%s.darttemplate' % name)
-      file_emitter = self._emitters.FileEmitter(path)
-      self._factory_provider_emitters[name] = file_emitter.Emit(template)
-    return self._factory_provider_emitters[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):
     super(HtmlDartInterfaceGenerator, self).__init__(system, interface,
@@ skipping 21 matching lines @@
 
     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 not constructor_info:
-      (constructor_info, factory_provider) = self._EmitElementFactory(typename)
-
     if typename in interface_factories:
       factory_provider = interface_factories[typename]
 
+    constructors = []
+    constructor_info = AnalyzeConstructor(self._interface)
+    if constructor_info:
+      constructors.append(constructor_info)
+      factory_provider = '_' + typename + 'FactoryProvider';
+
+    infos = HtmlElementConstructorInfos(typename)
+    for info in infos:
+      constructors.append(info.ConstructorInfo(typename))
+      if factory_provider:
+        assert factory_provider == info.factory_provider_name
+      else:
+        factory_provider = info.factory_provider_name
+
     if factory_provider:
       extends_str += ' default ' + factory_provider
 
     # TODO(vsm): Add appropriate package / namespace syntax.
     (self._type_comment_emitter,
      self._members_emitter,
      self._top_level_emitter) = self._emitter.Emit(
          self._template + '$!TOP_LEVEL',
          ID=typename,
          EXTENDS=extends_str)
 
     self._type_comment_emitter.Emit("/// @domName $DOMNAME",
         DOMNAME=self._interface.doc_js_name)
 
-    if constructor_info:
+    for constructor_info in constructors:
       self._members_emitter.Emit(
           '\n'
           '  $CTOR($PARAMS);\n',
-          CTOR=typename,
+          CTOR=constructor_info.ConstructorFullName(),
           PARAMS=constructor_info.ParametersInterfaceDeclaration());
 
     element_type = MaybeTypedArrayElementTypeInHierarchy(
         self._interface, self._system._database)
     if element_type:
       self._members_emitter.Emit(
           '\n'
           '  $CTOR(int length);\n'
           '\n'
           '  $CTOR.fromList(List<$TYPE> list);\n'
           '\n'
           '  $CTOR.fromBuffer(ArrayBuffer buffer,'
                             ' [int byteOffset, int length]);\n',
         CTOR=self._interface.id,
         TYPE=DartType(element_type))
 
     emit_events, events = self._shared.GetEventAttributes(self._interface)
     if not emit_events:
       return
     elif events:
       self.AddEventAttributes(events)
     else:
       self._EmitEventGetter(self._shared.GetParentEventsClass(self._interface))
 
-  def _EmitElementFactory(self, typename):
-    """Returns pair (constructor_info, factory_provider_name)."""
-    if typename not in _html_element_constructors:
-      return (None, None)
-    info = _html_element_constructors[typename]
-    if isinstance(info, str): info = ElementCtorInfo(tag=info)
-    constructor_info = info.ConstructorInfo(self._interface)
-    em = self._system._EmitterForFactoryProviderBody(info.factory_provider_name)
-    inits = em.Emit(
-        '\n'
-        '  factory $INTERFACE($PARAMS) {\n'
-        '    $INTERFACE _e = _document.$dom_createElement("$TAG");\n'
-        '$!INITS'
-        '    return _e;\n'
-        '  }\n',
-        INTERFACE=typename,
-        TAG=info.tag,
-        PARAMS=constructor_info.ParametersInterfaceDeclaration())
-    for param in constructor_info.param_infos:
-      inits.Emit('    if ($E != null) _e.$E = $E;\n', E=param.name)
-
-    return (constructor_info, info.factory_provider_name)
-
 
   def AddAttribute(self, getter, setter):
     dom_name = DartDomNameOfAttribute(getter)
     html_getter_name = self._shared.RenameInHtmlLibrary(
       self._interface.id, dom_name, 'get:')
     html_setter_name = self._shared.RenameInHtmlLibrary(
       self._interface.id, dom_name, 'set:')
 
     if not html_getter_name or self._shared.IsPrivate(html_getter_name):
       getter = None
@@ skipping 130 matching lines @@
         NATIVESPEC=' native "' + native_spec + '"')
     if self._members_emitter == None:
       raise Exception("Class %s doesn't use the $!MEMBERS variable" %
                       self._class_name)
 
     # Emit a factory provider class for the constructor.
     constructor_info = AnalyzeConstructor(interface)
     if constructor_info:
       self._EmitFactoryProvider(interface_name, constructor_info)
 
+    infos = HtmlElementConstructorInfos(interface_name)
+    if infos:
+      self._EmitHtmlElementFactoryConstructors(infos)
+
     emit_events, events = self._shared.GetEventAttributes(self._interface)
     if not emit_events:
       return
     elif events:
       self.AddEventAttributes(events)
     else:
       parent_events_class = self._shared.GetParentEventsClass(self._interface)
       self._EmitEventGetter('_' + parent_events_class + 'Impl')
 
   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 _EmitHtmlElementFactoryConstructors(self, infos):
+    EmitHtmlElementFactoryConstructors(
+        self._system._EmitterForFactoryProviderBody(
+            infos[0].factory_provider_name),
+        infos,
+        self._interface.id, self._class_name)
+
   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 205 matching lines @@
         TYPE=events_class)
 
 # ------------------------------------------------------------------------------
 
 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):
     """."""
     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._ImplFileEmitter(interface.id)
     return HtmlFrogClassGenerator(self, interface, template,
                                   super_interface_name, dart_code, self._shared)
 
   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):
     pass
 
   def _ImplFileEmitter(self, name):
     """Returns the file emitter of the Frog implementation file."""
-    # TODO(jmesserly): is this the right path
     path = os.path.join(self._output_dir, 'html', 'frog', '%s.dart' % name)
     self._dart_frog_file_paths.append(path)
     return self._emitters.FileEmitter(path)
 
+  def _EmitterForFactoryProviderBody(self, name):
+    if name not in self._factory_provider_emitters:
+      template = self._templates.Load('factoryprovider_%s.darttemplate' % name)
+      file_emitter = self._ImplFileEmitter(name)
+      self._factory_provider_emitters[name] = file_emitter.Emit(template)
+    return self._factory_provider_emitters[name]
+
 # -----------------------------------------------------------------------------
 
 class HtmlDartiumSystem(HtmlSystem):
 
   def __init__(self, templates, database, emitters, auxiliary_dir,
                dom_implementation_classes, output_dir):
     """Prepared for generating wrapping implementation.
 
     - Creates emitter for Dart code.
     """
@@ skipping 46 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