start of code to generate dart:html using dart:dom scripts

client/dom/scripts/dartgenerator.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 generates Dart APIs from the IDL database."""
 
 import emitter
 import idlnode
 import logging
@@ skipping 358 matching lines @@
     """
 
     self._emitters = multiemitter.MultiEmitter()
     self._database = database
     self._output_dir = output_dir
 
     self._ComputeInheritanceClosure()
 
     self._systems = []
 
+    # TODO(jmesserly): only create these if needed
     interface_system = InterfacesSystem(
         TemplateLoader(self._template_dir, ['dom/interface', 'dom', '']),
         self._database, self._emitters, self._output_dir)
     self._systems.append(interface_system)
 
+    html_interface_system = HtmlInterfacesSystem(
+        TemplateLoader(self._template_dir, ['html/interface', 'html', '']),
+        self._database, self._emitters, self._output_dir)
+    self._systems.append(html_interface_system)
+
     if 'native' in systems:
         native_system = NativeImplementationSystem(
             TemplateLoader(self._template_dir, ['dom/native', 'dom', '']),
             self._database, self._emitters, self._auxiliary_dir,
             self._output_dir)
 
         self._systems.append(native_system)
 
     if 'wrapping' in systems:
       wrapping_system = WrappingImplementationSystem(
           TemplateLoader(self._template_dir, ['dom/wrapping', 'dom', '']),
           self._database, self._emitters, self._output_dir)
 
       # Makes interface files available for listing in the library for the
       # wrapping implementation.
       wrapping_system._interface_system = interface_system
       self._systems.append(wrapping_system)
 
     if 'frog' in systems:
       frog_system = FrogSystem(
           TemplateLoader(self._template_dir, ['dom/frog', 'dom', '']),
           self._database, self._emitters, self._output_dir)
 
       frog_system._interface_system = interface_system
       self._systems.append(frog_system)
 
+    if 'htmlfrog' in systems:
+      html_system = HtmlFrogSystem(
+          TemplateLoader(self._template_dir, ['html/frog', 'html', '']),
+          self._database, self._emitters, self._output_dir)
+
+      html_system._interface_system = html_interface_system
+      self._systems.append(html_system)
+
+    if 'htmldartium' in systems:
+      html_system = HtmlDartiumSystem(
+          TemplateLoader(self._template_dir, ['html/dartium', 'html', '']),
+          self._database, self._emitters, self._output_dir)
+
+      html_system._interface_system = html_interface_system
+      self._systems.append(html_system)
 
     # Render all interfaces into Dart and save them in files.
     for interface in database.GetInterfaces():
 
       super_interface = None
       super_name = interface.id
 
       if not _MatchSourceFilter(source_filter, interface):
         # Skip this interface since it's not present in the required source
         _logger.info('Omitting interface - %s' % interface.id)
@@ skipping 46 matching lines @@
                   for system in self._systems]
 
     for generator in generators:
       generator.StartInterface()
 
     for const in sorted(interface.constants, ConstantOutputOrder):
       for generator in generators:
         generator.AddConstant(const)
 
     attributes = [attr for attr in interface.attributes
-                  if not self._OmitAttribute(interface, attr)]
+                  if not self._IsEventAttribute(interface, attr)]
     for (getter, setter) in  _PairUpAttributes(attributes):
       for generator in generators:
         generator.AddAttribute(getter, setter)
 
+    events = _PairUpAttributes([attr for attr in interface.attributes
+                  if self._IsEventAttribute(interface, attr)])
+    if events:
+      for generator in generators:
+        generator.AddEvents(events)

[sra1, 2012/02/07 05:06:16]

AddEventAttributes would be a better name.

[Jennifer Messerly, 2012/02/07 21:05:14]

Done.

+
     # The implementation should define an indexer if the interface directly
     # extends List.
     element_type = MaybeListElementType(interface)
     if element_type:
       for generator in generators:
         generator.AddIndexer(element_type)
 
     # Group overloaded operations by id
     operationsById = {}
     for operation in interface.operations:
@@ skipping 34 matching lines @@
         if not any(op.id == id for op in interface.operations):
           operations = operationsById[id]
           info = _AnalyzeOperation(interface, operations)
           for generator in generators:
             generator.AddSecondaryOperation(parent_interface, info)
 
     for generator in generators:
       generator.FinishInterface()
     return
 
-  def _OmitAttribute(self, interface, attr):
+  def _IsEventAttribute(self, interface, attr):
     # Remove EventListener attributes like 'onclick' when addEventListener
     # is available.
     if attr.type.id == 'EventListener':
       if 'EventTarget' in self._AllImplementedInterfaces(interface):
         return True
     return False
 
   def _DefinesSameAttribute(self, interface, attr1):
     return any(attr1.id == attr2.id
                and attr1.is_fc_getter == attr2.is_fc_getter
@@ skipping 415 matching lines @@
 
 
   def _FilePathForDartInterface(self, interface_name):
     """Returns the file path of the Dart interface definition."""
     return os.path.join(self._output_dir, 'src', 'interface',
                         '%s.dart' % interface_name)
 
 
 # ------------------------------------------------------------------------------
 
+class HtmlInterfacesSystem(System):
+
+  def __init__(self, templates, database, emitters, output_dir):
+    super(HtmlInterfacesSystem, self).__init__(
+        templates, database, emitters, output_dir)
+    self._dart_interface_file_paths = []
+
+
+  def InterfaceGenerator(self,
+                         interface,
+                         common_prefix,
+                         super_interface_name,
+                         source_filter):
+    """."""
+    interface_name = interface.id
+    dart_interface_file_path = self._FilePathForDartInterface(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' % interface_name
+    template = self._templates.TryLoad(template_file)
+    if not template:
+      template = self._templates.Load('interface.darttemplate')
+
+    return HtmlDartInterfaceGenerator(
+        interface, dart_interface_code,
+        template,
+        common_prefix, super_interface_name,
+        source_filter)
+
+  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, lib_dir):
+    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)
+
+
+# ------------------------------------------------------------------------------
+
 class WrappingImplementationSystem(System):
 
   def __init__(self, templates, database, emitters, output_dir):
     """Prepared for generating wrapping implementation.
 
     - Creates emitter for JS code.
     - Creates emitter for Dart code.
     """
     super(WrappingImplementationSystem, self).__init__(
         templates, database, emitters, output_dir)
@@ skipping 136 matching lines @@
          self._dart_frog_file_paths))
 
   def Finish(self):
     pass
 
   def _FilePathForFrogImpl(self, interface_name):
     """Returns the file path of the Frog implementation."""
     return os.path.join(self._output_dir, 'src', 'frog',
                         '%s.dart' % interface_name)
 
+
+# ------------------------------------------------------------------------------
+
+class HtmlFrogSystem(System):
+
+  def __init__(self, templates, database, emitters, output_dir):
+    super(HtmlFrogSystem, self).__init__(
+        templates, database, emitters, output_dir)
+    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.Emit(self._templates.Load('frog_impl.darttemplate'))
+    return HtmlFrogInterfaceGenerator(self, interface, template,
+                                  super_interface_name, dart_code)
+
+  #def ProcessCallback(self, interface, info):
+  #  """Generates a typedef for the callback interface."""
+  #  file_path = self._FilePathForFrogImpl(interface.id)
+  #  self._ProcessCallback(interface, info, file_path)

[sra1, 2012/02/07 05:06:16]

remove commented out code

[Jennifer Messerly, 2012/02/07 21:05:14]

This was also commented out in FrogSystem, so I presume I should remove it there
too?

Did this in the updated code.

+
+  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."""
+    # TODO(jmesserly): is this the right path
+    return os.path.join(self._output_dir, 'html', 'frog',
+                        '%s.dart' % interface_name)
+
 # ------------------------------------------------------------------------------
 
 class DartInterfaceGenerator(object):
   """Generates Dart Interface definition for one DOM IDL interface."""
 
   def __init__(self, interface, emitter, template,
                common_prefix, super_interface, source_filter):
     """Generates Dart code for the given interface.
 
     Args:
@@ skipping 121 matching lines @@
                                TYPE=info.type_name,
                                NAME=info.name,
                                PARAMS=info.ParametersInterfaceDeclaration())
 
   # Interfaces get secondary members directly via the superinterfaces.
   def AddSecondaryAttribute(self, interface, getter, setter):
     pass
 
   def AddSecondaryOperation(self, interface, attr):
     pass
-
+  def AddEvents(self, event_attrs):
+    pass
 
 # Given a sorted sequence of type identifiers, return an appropriate type
 # name
 def TypeName(typeIds, interface):
   # Dynamically type this field for now.
   return 'var'
 
+# ------------------------------------------------------------------------------
+
+# 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, interface, emitter, template,
+               common_prefix, super_interface, source_filter):
+    super(HtmlDartInterfaceGenerator, self).__init__(interface,
+      emitter, template, common_prefix, super_interface, source_filter)
+
+  def AddEvents(self, event_attrs):
+    events_interface = self._interface.id + 'Events'
+    self._members_emitter.Emit('\n  $TYPE get on();\n',
+                               TYPE=events_interface)
+    events_members = self._emitter.Emit(
+        '\ninterface $INTERFACE {\n$!MEMBERS}\n',
+        INTERFACE=events_interface)
+
+    for getter, setter in event_attrs:
+      event = getter or setter
+      events_members.Emit('\n  EventListenerList get $NAME();\n', NAME=event.id)
+
 
 # ------------------------------------------------------------------------------
 
 class WrappingInterfaceGenerator(object):
   """Generates Dart and JS implementation for one DOM IDL interface."""
 
   def __init__(self, interface, super_interface, dart_code, js_code, type_map,
                externs, base_members):
     """Generates Dart and JS code for the given interface.
 
@@ skipping 142 matching lines @@
     self._externs.add((self._interface.id, attr.id, 'attribute'))
 
   def AddSecondaryAttribute(self, interface, getter, setter):
     self._SecondaryContext(interface)
     self.AddAttribute(getter, setter)
 
   def AddSecondaryOperation(self, interface, info):
     self._SecondaryContext(interface)
     self.AddOperation(info)
 
+  def AddEvents(self, event_attrs):
+    pass
+
   def _SecondaryContext(self, interface):
     if interface is not self._current_secondary_parent:
       self._current_secondary_parent = interface
       self._members_emitter.Emit('\n  // From $WHERE\n', WHERE=interface.id)
 
   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
@@ skipping 540 matching lines @@
         NAME=attr.id, TYPE=self._NarrowInputType(attr.type.id))
 
   def AddSecondaryAttribute(self, interface, getter, setter):
     self._SecondaryContext(interface)
     self.AddAttribute(getter, setter)
 
   def AddSecondaryOperation(self, interface, info):
     self._SecondaryContext(interface)
     self.AddOperation(info)
 
+  def AddEvents(self, event_attrs):
+    pass
+
   def _SecondaryContext(self, interface):
     if interface is not self._current_secondary_parent:
       self._current_secondary_parent = interface
       self._members_emitter.Emit('\n  // From $WHERE\n', WHERE=interface.id)
 
   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
@@ skipping 60 matching lines @@
         '\n'
         '  $TYPE $NAME($PARAMS) native;\n',
         TYPE=self._NarrowOutputType(info.type_name),
         NAME=info.name,
         PARAMS=info.ParametersImplementationDeclaration(
             lambda type_name: self._NarrowInputType(type_name)))
 
 
 # ------------------------------------------------------------------------------
 
+# TODO(jmesserly): inheritance is probably not the right way to factor this long
+# term, but it makes merging better for now.
+class HtmlFrogInterfaceGenerator(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):
+    super(HtmlFrogInterfaceGenerator, self).__init__(
+        system, interface, template, super_interface, dart_code)
+
+  def AddEvents(self, event_attrs):
+    events_class = self._interface.id + 'EventsImpl'
+    events_interface = self._interface.id + 'Events'
+    self._members_emitter.Emit('\n  $TYPE get on() =>\n    new $TYPE(this);\n',

[sra1, 2012/02/07 05:06:16]

I find this kind of string easier to read if you always break the string at \n:

     '\n'
     '  $TYPE get on() =>\n'
     '    new $TYPE(this);\n'

[Jennifer Messerly, 2012/02/07 21:05:14]

Done.

+                               TYPE=events_class)
+
+    events_members = self._dart_code.Emit(
+        '\nclass $CLASSNAME extends EventsImplementation '
+        'implements $INTERFACE {\n'
+        '  $CLASSNAME(_ptr) : super._wrap(_ptr);\n$!MEMBERS}\n',
+        CLASSNAME=events_class,
+        INTERFACE=events_interface)
+
+    for getter, setter in event_attrs:
+      event = getter or setter
+      events_members.Emit(
+          "\n  EventListenerList get $NAME() => _get('$NAME');\n",
+          NAME=event.id)
+
+
+# ------------------------------------------------------------------------------
+
 class NativeImplementationSystem(System):
 
   def __init__(self, templates, database, emitters, auxiliary_dir, output_dir):
     super(NativeImplementationSystem, self).__init__(
         templates, database, emitters, output_dir)
 
     self._auxiliary_dir = auxiliary_dir
     self._dom_public_files = []
     self._dom_impl_files = []
 
@@ skipping 202 matching lines @@
                    INDENT=indent,
                    NATIVENAME=native_name,
                    ARGS=argument_expressions)
 
     self._members_emitter.Emit('  $TYPE $NATIVE_NAME($PARAMS) native '
                                '"$(INTERFACE)$(NATIVE_NAME)_Callback";\n',
                                NATIVE_NAME=native_name,
                                TYPE=info.type_name,
                                PARAMS=', '.join(arg_names),
                                INTERFACE=self._interface.id)