Merging dart:html interfaces and implementations

lib/html/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."""
 
 import emitter
 import os
 from generator import *
+from htmldartgenerator import *
 
 _js_custom_members = set([
     'AudioBufferSourceNode.start',
     'AudioBufferSourceNode.stop',
     'CSSStyleDeclaration.setProperty',
     'Element.insertAdjacentElement',
     'Element.insertAdjacentHTML',
     'Element.insertAdjacentText',
     'Element.remove',
     'ElementEvents.mouseWheel',
@@ skipping 151 matching lines @@
   return infos
 
 def EmitHtmlElementFactoryConstructors(emitter, infos, typename, class_name,
                                        rename_type):
   for info in infos:
     constructor_info = info.ConstructorInfo(typename)
 
     inits = emitter.Emit(
         '\n'
         '  static $RETURN_TYPE $CONSTRUCTOR($PARAMS) {\n'
-        '    $CLASS _e = _document.$dom_createElement("$TAG");\n'
+        '    $CLASS _e = document.$dom_createElement("$TAG");\n'
         '$!INITS'
         '    return _e;\n'
         '  }\n',
         RETURN_TYPE=rename_type(constructor_info.type_name),
         CONSTRUCTOR=constructor_info.ConstructorFactoryName(rename_type),
         CLASS=class_name,
         TAG=info.tag,
         PARAMS=constructor_info.ParametersDeclaration(
             rename_type, force_optional=True))
     for param in constructor_info.param_infos:
@@ skipping 30 matching lines @@
     code = self._library_emitter.FileEmitter(self._interface.id)
     code.Emit(self._template_loader.Load('callback.darttemplate'))
     code.Emit('typedef void $NAME($PARAMS);\n',
               NAME=self._interface.id,
               PARAMS=info.ParametersDeclaration(self._DartType))
     self._backend.GenerateCallback(info)
 
   def GenerateInterface(self):
     interface_name = self._interface_type_info.interface_name()
 
-    if (self._interface_type_info.has_generated_interface() and
-        not self._interface_type_info.merged_into()):
-      interface_emitter = self._library_emitter.FileEmitter(interface_name)
-    else:
-      interface_emitter = emitter.Emitter()
+    # TODO: this is just tossing the interface, need to skip it completely.
+    interface_emitter = emitter.Emitter()
 
     template_file = 'interface_%s.darttemplate' % interface_name
     interface_template = (self._template_loader.TryLoad(template_file) or
                           self._template_loader.Load('interface.darttemplate'))
 
     implements = []
     for parent in self._interface.parents:
       parent_type_info = self._type_registry.TypeInfo(parent.type.id)
       implements.append(parent_type_info.interface_name())
 
@@ skipping 41 matching lines @@
       if factory_provider:
         assert factory_provider == info.factory_provider_name
       else:
         factory_provider = info.factory_provider_name
 
     # TODO(vsm): Add appropriate package / namespace syntax.
     (self._type_comment_emitter,
      self._members_emitter,
      self._top_level_emitter) = interface_emitter.Emit(
          interface_template + '$!TOP_LEVEL',
-         ID=interface_name,
+         ID='_I%s' % interface_name,
          EXTENDS=implements_str)
 
-    self._type_comment_emitter.Emit("/// @domName $DOMNAME",
-        DOMNAME=self._interface.doc_js_name)
-
     implementation_emitter = self._ImplementationEmitter()
 
     base_class = self._backend.RootClassName()
+    base_type_info = None
+
     if self._interface.parents:
       supertype = self._interface.parents[0].type.id
       if not IsDartCollectionType(supertype) and not IsPureInterface(supertype):
-        type_info = self._type_registry.TypeInfo(supertype)
-        if type_info.merged_into() and self._backend.ImplementsMergedMembers():
-          type_info = self._type_registry.TypeInfo(type_info.merged_into())
-        base_class = type_info.implementation_name()
+        base_type_info = self._type_registry.TypeInfo(supertype)
+        if base_type_info.merged_into() \
+            and self._backend.ImplementsMergedMembers():
+          base_type_info = self._type_registry.TypeInfo(
+              base_type_info.merged_into())
+        base_class = base_type_info.implementation_name()

[Anton Muhin, 2012/11/02 12:55:47]

looks like base_class initialization should be moved out of the loop now and
look like base_class = self._backendRootClassName9) if base_type_info is None
else base_type_info.implementation_name(), or maybe with if.

[blois, 2012/11/02 19:25:28]

Done.

 
-    implemented_interfaces = [interface_name] +\
-                             self._backend.AdditionalImplementedInterfaces()
+    implements = self._backend.AdditionalImplementedInterfaces()
+

[Anton Muhin, 2012/11/02 12:55:47]

nit: no blank line

[blois, 2012/11/02 19:25:28]

Done.

+    for parent in self._interface.parents:
+      parent_type_info = self._type_registry.TypeInfo(parent.type.id)
+      if parent_type_info != base_type_info:
+        implements.append(parent_type_info.interface_name())
+
+    if interface_name in _secure_base_types:
+      implements.append(_secure_base_types[interface_name])
+
+    implements_str = ''
+    if implements:
+      implements_str += ' implements ' + ', '.join(set(implements))

[Anton Muhin, 2012/11/02 12:55:47]

nit: no need in +=

[blois, 2012/11/02 19:25:28]

Done.

+
     self._implementation_members_emitter = implementation_emitter.Emit(
         self._backend.ImplementationTemplate(),
         CLASSNAME=self._interface_type_info.implementation_name(),
         EXTENDS=' extends %s' % base_class if base_class else '',
-        IMPLEMENTS=' implements ' + ', '.join(implemented_interfaces),
+        IMPLEMENTS=implements_str,
+        DOMNAME=self._interface.doc_js_name,
         NATIVESPEC=self._backend.NativeSpec())
     self._backend.StartInterface(self._implementation_members_emitter)
 
     for constructor_info in constructors:
       constructor_info.GenerateFactoryInvocation(
           self._DartType, self._members_emitter, factory_provider)
 
-    element_type = None
+    self._backend.AddConstructors(constructors, factory_provider,
+        self._interface_type_info.implementation_name(),
+        base_class)
+
+    typed_array_type = None
     for interface in self._database.Hierarchy(self._interface):
       type_info = self._type_registry.TypeInfo(interface.id)
       if type_info.is_typed_array():
-        element_type = type_info.list_item_type()
+        typed_array_type = type_info.list_item_type()
         break
-    if element_type:
+    if typed_array_type:
       self._members_emitter.Emit(
           '\n'
           '  factory $CTOR(int length) =>\n'
           '    $FACTORY.create$(CTOR)(length);\n'
           '\n'
           '  factory $CTOR.fromList(List<$TYPE> list) =>\n'
           '    $FACTORY.create$(CTOR)_fromList(list);\n'
           '\n'
           '  factory $CTOR.fromBuffer(ArrayBuffer buffer, [int byteOffset, int length]) => \n'
           '    $FACTORY.create$(CTOR)_fromBuffer(buffer, byteOffset, length);\n',
         CTOR=self._interface.id,
-        TYPE=self._DartType(element_type),
+        TYPE=self._DartType(typed_array_type),
         FACTORY=factory_provider)
 
     events_interface = self._event_generator.ProcessInterface(
         self._interface, interface_name,
         self._backend.CustomJSMembers(),
         interface_emitter, implementation_emitter)
     if events_interface:
-      self._EmitEventGetter(events_interface, '_%sImpl' % events_interface)
+      self._EmitEventGetter(events_interface, events_interface)
 
     old_backend = self._backend
     if not self._backend.ImplementsMergedMembers():
       self._backend = HtmlGeneratorDummyBackend()
     merged_interface = self._interface_type_info.merged_interface()
     if merged_interface:
       self.AddMembers(self._database.GetInterface(merged_interface))
     self._backend = old_backend
 
     self.AddMembers(self._interface)
@@ skipping 148 matching lines @@
     self._backend.SecondaryContext(interface)
     self.AddOperation(info, True)
 
   def AddConstant(self, constant):
     type = TypeOrNothing(self._DartType(constant.type.id), constant.type.id)
     self._members_emitter.Emit('\n  static const $TYPE$NAME = $VALUE;\n',
                                NAME=constant.id,
                                TYPE=type,
                                VALUE=constant.value)
 
+    self._backend.AddConstant(constant)
+
   def _ImplementationEmitter(self):
-    if IsPureInterface(self._interface.id):
-      return emitter.Emitter()
     basename = self._interface_type_info.implementation_name()
     if (self._interface_type_info.merged_into() and
         self._backend.ImplementsMergedMembers()):
       # Merged members are implemented in target interface implementation.
       return emitter.Emitter()
-    return self._library_emitter.FileEmitter(basename.lstrip('_'))
+    return self._library_emitter.FileEmitter(basename)
 
   def _EmitEventGetter(self, events_interface, events_class):
     self._members_emitter.Emit(
         '\n  /**'
         '\n   * @domName EventTarget.addEventListener, '
         'EventTarget.removeEventListener, EventTarget.dispatchEvent'
         '\n   */'
         '\n  $TYPE get on;\n',
         TYPE=events_interface)
 
     self._implementation_members_emitter.Emit(
+        '\n  /**'

[Anton Muhin, 2012/11/02 12:55:47]

debugging?

[blois, 2012/11/02 19:25:28]

The dartdoc comment? I believe this used for doc generation, with this the
implementation should match the comments of the interface.

+        '\n   * @domName EventTarget.addEventListener, '
+        'EventTarget.removeEventListener, EventTarget.dispatchEvent'
+        '\n   */'
         '\n  $TYPE get on =>\n    new $TYPE(this);\n',
         TYPE=events_class)
 
   def _TransitiveSecondaryParents(self, interface):
     """Returns a list of all non-primary parents.
 
     The list contains the interface objects for interfaces defined in the
     database, and the name for undefined interfaces.
     """
     def walk(parents):
@@ skipping 30 matching lines @@
 class HtmlGeneratorDummyBackend(object):
   def AddAttribute(self, attribute, html_name, read_only):
     pass
 
   def AddOperation(self, info, html_name):
     pass
 
 
 # ------------------------------------------------------------------------------
 
-class Dart2JSBackend(object):
+class Dart2JSBackend(HtmlDartGenerator):
   """Generates a dart2js class for the dart:html library from a DOM IDL
   interface.
   """
 
   def __init__(self, interface, options):
-    self._interface = interface
+    super(Dart2JSBackend, self).__init__(interface, options)
+
     self._database = options.database
     self._template_loader = options.templates
     self._type_registry = options.type_registry
+    self._renamer = options.renamer
     self._interface_type_info = self._type_registry.TypeInfo(self._interface.id)
     self._current_secondary_parent = None
 
   def ImplementsMergedMembers(self):
     return True
 
   def GenerateCallback(self, info):
     pass
 
   def RootClassName(self):
     return None
 
   def AdditionalImplementedInterfaces(self):
-    # TODO: Include all implemented interfaces, including other Lists.
-    implements = []
-    if self._interface_type_info.is_typed_array():
-      element_type = self._interface_type_info.list_item_type()
-      implements.append('List<%s>' % self._DartType(element_type))
+    implements = super(Dart2JSBackend, self).AdditionalImplementedInterfaces()
     if self._interface_type_info.list_item_type():
       implements.append('JavaScriptIndexingBehavior')
     return implements
 
   def NativeSpec(self):
     native_spec = MakeNativeSpec(self._interface.javascript_binding_name)
     return ' native "%s"' % native_spec
 
   def ImplementationTemplate(self):
+    if IsPureInterface(self._interface.id):
+      return self._template_loader.Load('pure_interface.darttemplate')
+
     template_file = ('impl_%s.darttemplate' %
                      self._interface_type_info.interface_name())
     return (self._template_loader.TryLoad(template_file) or
             self._template_loader.Load('dart2js_impl.darttemplate'))
 
   def StartInterface(self, emitter):
     self._members_emitter = emitter
 
   def FinishInterface(self):
     pass
@@ skipping 72 matching lines @@
       has_contains = any(op.id == 'contains' for op in self._interface.operations)
       template = self._template_loader.Load(
           template_file,
           {'DEFINE_CONTAINS': not has_contains})
       self._members_emitter.Emit(template, E=self._DartType(element_type))
 
   def AddAttribute(self, attribute, html_name, read_only):
     if self._HasCustomImplementation(attribute.id):
       return
 
+    if IsPureInterface(self._interface.id):
+      self._AddInterfaceAttribute(attribute)
+      return
+
     if attribute.id != html_name:
       self._AddAttributeUsingProperties(attribute, html_name, read_only)
       return
 
     # If the attribute is shadowing, we can't generate a shadowing
     # field (Issue 1633).
     # TODO(sra): _FindShadowedAttribute does not take into account the html
     #  renaming.  we should be looking for another attribute that has the same
     #  html_name.  Two attributes with the same IDL name might not match if one
     #  is renamed.
@@ skipping 18 matching lines @@
 
     # If the type has a conversion we need a getter or setter to contain the
     # conversion code.
     if (self._OutputConversion(attribute.type.id, attribute.id) or
         self._InputConversion(attribute.type.id, attribute.id)):
       self._AddAttributeUsingProperties(attribute, html_name, read_only)
       return
 
     output_type = self._NarrowOutputType(attribute.type.id)
     input_type = self._NarrowInputType(attribute.type.id)
+    self.EmitAttributeDocumentation(attribute)
     if not read_only:
       self._members_emitter.Emit(
           '\n  $TYPE $NAME;'
           '\n',
           NAME=DartDomNameOfAttribute(attribute),
           TYPE=output_type)
     else:
       self._members_emitter.Emit(
           '\n  final $TYPE $NAME;'
           '\n',
           NAME=DartDomNameOfAttribute(attribute),
           TYPE=output_type)
 
   def _AddAttributeUsingProperties(self, attribute, html_name, read_only):
     self._AddRenamingGetter(attribute, html_name)
     if not read_only:
       self._AddRenamingSetter(attribute, html_name)
 
+  def _AddInterfaceAttribute(self, attribute):
+    self._members_emitter.Emit(
+        '\n  $TYPE $NAME;'
+        '\n',
+        NAME=DartDomNameOfAttribute(attribute),
+        TYPE=self._NarrowOutputType(attribute.type.id))
+
   def _AddRenamingGetter(self, attr, html_name):
+    self.EmitAttributeDocumentation(attr)
+
     conversion = self._OutputConversion(attr.type.id, attr.id)
     if conversion:
       return self._AddConvertingGetter(attr, html_name, conversion)
     return_type = self._NarrowOutputType(attr.type.id)
     self._members_emitter.Emit(
         # TODO(sra): Use metadata to provide native name.
         '\n  $TYPE get $HTML_NAME => JS("$TYPE", "#.$NAME", this);'
         '\n',
         HTML_NAME=html_name,
         NAME=attr.id,
         TYPE=return_type)
 
   def _AddRenamingSetter(self, attr, html_name):
+    self.EmitAttributeDocumentation(attr)
+
     conversion = self._InputConversion(attr.type.id, attr.id)
     if conversion:
       return self._AddConvertingSetter(attr, html_name, conversion)
     self._members_emitter.Emit(
         # TODO(sra): Use metadata to provide native name.
         '\n  void set $HTML_NAME($TYPE value) {'
         '\n    JS("void", "#.$NAME = #", this, value);'
         '\n  }'
         '\n',
         HTML_NAME=html_name,
@@ skipping 33 matching lines @@
     pass
 
   def AddOperation(self, info, html_name):
     """
     Arguments:
       info: An OperationInfo object.
     """
     if self._HasCustomImplementation(info.name):
       return
 
-    # Any conversions needed?
-    if any(self._OperationRequiresConversions(op) for op in info.overloads):
+    self._members_emitter.Emit('\n  /** @domName $DOMINTERFACE.$DOMNAME */',

[Anton Muhin, 2012/11/02 12:55:47]

a helper like EmitAttributeDocumentation?

[blois, 2012/11/02 19:25:28]

Done, but because of how the dartium code is currently factored it's not
straightforward to use there.

+          DOMINTERFACE=info.overloads[0].doc_js_interface_name,
+          DOMNAME=info.name)
+
+    if IsPureInterface(self._interface.id):
+      self._AddInterfaceOperation(info, html_name)
+    elif any(self._OperationRequiresConversions(op) for op in info.overloads):
+      # Any conversions needed?
       self._AddOperationWithConversions(info, html_name)
     else:
       self._AddDirectNativeOperation(info, html_name)
 
   def _AddDirectNativeOperation(self, info, html_name):
     # Do we need a native body?
     if html_name != info.declared_name:
       return_type = self._NarrowOutputType(info.type_name)
 
       operation_emitter = self._members_emitter.Emit('$!SCOPE',
@@ skipping 148 matching lines @@
     else:
       operation = operations[0]
       argument_count = len(operation.arguments)
       for position, argument in list(enumerate(operation.arguments))[::-1]:
         if self._IsOptional(operation, argument):
           check = '?%s' % parameter_names[position]
           GenerateCall(operation, position + 1, [check])
           argument_count = position
       GenerateCall(operation, argument_count, [])
 
+  def _AddInterfaceOperation(self, info, html_name):
+    self._members_emitter.Emit(
+        '\n'
+        '  $TYPE $NAME($PARAMS);\n',
+        TYPE=self._NarrowOutputType(info.type_name),
+        NAME=info.name,
+        PARAMS=info.ParametersDeclaration(self._NarrowInputType))
+
+  def AddConstant(self, constant):
+    type = TypeOrNothing(self._DartType(constant.type.id), constant.type.id)
+    self._members_emitter.Emit('\n  static const $TYPE$NAME = $VALUE;\n',
+        NAME=constant.id,
+        TYPE=type,
+        VALUE=constant.value)
 
   def _IsOptional(self, operation, argument):
     return IsOptional(argument)
 
 
   def _OperationRequiresConversions(self, operation):
     return (self._OperationRequiresOutputConversion(operation) or
             self._OperationRequiresInputConversions(operation))
 
   def _OperationRequiresOutputConversion(self, operation):
@@ skipping 17 matching lines @@
   def CustomJSMembers(self):
     return _js_custom_members
 
   def _NarrowToImplementationType(self, type_name):
     return self._type_registry.TypeInfo(type_name).narrow_dart_type()
 
   def _NarrowInputType(self, type_name):
     return self._NarrowToImplementationType(type_name)
 
   def _NarrowOutputType(self, type_name):
-    secure_name = SecureOutputType(self, type_name, True)
-    return self._NarrowToImplementationType(secure_name)
+    return SecureOutputType(self, type_name)
 
   def _FindShadowedAttribute(self, attr):
     """Returns (attribute, superinterface) or (None, None)."""
     def FindInParent(interface):
       """Returns matching attribute in parent, or None."""
       if interface.parents:
         parent = interface.parents[0]
         if IsDartCollectionType(parent.type.id):
           return (None, None)
         if IsPureInterface(parent.type.id):
@@ skipping 52 matching lines @@
 
     library_emitter = self._multiemitter.FileEmitter(library_file_path)
     library_file_dir = os.path.dirname(library_file_path)
     auxiliary_dir = os.path.relpath(auxiliary_dir, library_file_dir)
     imports_emitter = library_emitter.Emit(
         self._template, AUXILIARY_DIR=massage_path(auxiliary_dir))
     for path in sorted(self._path_to_emitter.keys()):
       relpath = os.path.relpath(path, library_file_dir)
       imports_emitter.Emit(
           "part '$PATH';\n", PATH=massage_path(relpath))