Create implementation file emitter in HtmlDartInterfaceGenerator.

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."""
 
+import emitter
+
 from systemfrog import *
 from systeminterface import *
 
 _html_strip_webkit_prefix_classes = [
     'Animation',
     'AnimationEvent',
     'AnimationList',
     'BlobBuilder',
     'CSSKeyframeRule',
     'CSSKeyframesRule',
@@ skipping 749 matching lines @@
 class HtmlInterfacesSystem(HtmlSystem):
 
   def __init__(self, templates, database, emitters, output_dir, backend):
     super(HtmlInterfacesSystem, self).__init__(
         templates, database, emitters, output_dir)
     self._backend = backend
     self._dart_interface_file_paths = []
     self._factory_provider_emitters = {}
 
   def ProcessInterface(self, interface):
-    """."""
-
-    self._backend.ProcessInterface(interface)
-
-    if interface.id in _merged_html_interfaces:
-      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')
-
-    generator = HtmlDartInterfaceGenerator(
-        self, interface, dart_interface_code,
-        template, self._shared)
-    generator.Generate()
+    """Generates dart interface and implementation for the DOM IDL interface."""
+    HtmlDartInterfaceGenerator(self, interface).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)
     self._backend.ProcessCallback(interface, info)
 
   def GenerateLibraries(self):
     self._backend.GenerateLibraries(self._dart_interface_file_paths)
 
   def _FilePathForDartInterface(self, interface_name):

[Anton Muhin, 2012/06/28 13:20:19]

does it still belong to HtmlInterfaceSystem, shouldn't it go to backends now?

[podivilov, 2012/06/29 12:59:28]

Dart interfaces are common in dartium and dart2js, so it shouldn't.

     """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."""
+class HtmlDartInterfaceGenerator(BaseGenerator):
+  """Generates dart interface and implementation for the DOM IDL interface."""
 
-  def __init__(self, system, interface, emitter, template, shared):
-    super(HtmlDartInterfaceGenerator, self).__init__(system, interface,
-      emitter, template)
-    self._shared = shared
+  def __init__(self, system, interface):
+    super(HtmlDartInterfaceGenerator, self).__init__(
+        system._database, interface)
+    self._system = system

[Anton Muhin, 2012/06/28 13:20:19]

do you need to store system here too (it's passed into super ctor?)

[podivilov, 2012/06/29 12:59:28]

No, it's not passed.

[Anton Muhin, 2012/06/29 13:34:57]

Maybe you should pass it, but I am not insisting on it, and definitely not now.

On 2012/06/29 12:59:28, podivilov wrote:

+    self._backend = system._backend
+    self._emitters = system._emitters
+    self._shared = system._shared
+    self._templates = system._templates

[Anton Muhin, 2012/06/28 13:20:19]

why are you caching _backend, _emitters, _shared and _templates?

[podivilov, 2012/06/29 12:59:28]

Done.

     self._html_interface_name = self._shared._HTMLInterfaceName(
         self._interface.id)
 
+    interface_path = self._system._FilePathForDartInterface(

[Anton Muhin, 2012/06/28 13:20:19]

it looks like interface_path is only used in then clause of conditional below,
may it go in there?

[podivilov, 2012/06/29 12:59:28]

Done.

+        self._html_interface_name)
+    if not interface.id in _merged_html_interfaces:
+      self._system._dart_interface_file_paths.append(interface_path)

[Anton Muhin, 2012/06/28 13:20:19]

again, why you need _system here, or are you going to move things around bit by
bit?

[podivilov, 2012/06/29 12:59:28]

_dart_interface_file_paths is per-library state, let's keep it in system for
now.

+      self._interface_emitter = self._emitters.FileEmitter(interface_path)
+    else:
+      self._interface_emitter = emitter.Emitter()
+
+    template_file = 'interface_%s.darttemplate' % self._html_interface_name
+    self._interface_template = (self._templates.TryLoad(template_file) or
+                                self._templates.Load('interface.darttemplate'))
+
+    implementation_path = self._backend.FilePathForDartImplementation(

[Anton Muhin, 2012/06/28 13:20:19]

ditto for implementation_path and if below.

[podivilov, 2012/06/29 12:59:28]

Done.

+        self._interface.id)
+    if self._backend.HasImplementation(self._interface.id):
+      self._system._dart_interface_file_paths.append(implementation_path)

[Anton Muhin, 2012/06/28 13:20:19]

that looks slightly odd that you add implementation path into interface file
paths' list.

[podivilov, 2012/06/29 12:59:28]

This is slightly complicated to refactor right now, because
_dart_interface_file_paths is used by SystemBase and shared with dom systems.
Let's keep for now.

+      self._implementation_emitter = self._emitters.FileEmitter(
+          implementation_path)
+    else:
+      self._implementation_emitter = emitter.Emitter()
+
   def StartInterface(self):
+    if not IsPureInterface(self._interface.id):

[Anton Muhin, 2012/06/28 13:20:19]

that might be stupid, but it feels more natural to me to generate interface
first and then implementation.

[Anton Muhin, 2012/06/28 13:20:19]

should you call into backend if it's not pure or if it
_backend.HasImplementation()?

[podivilov, 2012/06/29 12:59:28]

Done.

[podivilov, 2012/06/29 12:59:28]

Done.

+      self._backend.ProcessInterface(
+          self._interface, self._implementation_emitter)
+
     typename = self._html_interface_name
 
     extends = []
     suppressed_extends = []
 
     for parent in self._interface.parents:
       # TODO(vsm): Remove source_filter.
       if MatchSourceFilter(parent):
         # Parent is a DOM type.
         extends.append(self._shared.DartType(parent.type.id))
@@ skipping 30 matching lines @@
         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',
+     self._top_level_emitter) = self._interface_emitter.Emit(
+         self._interface_template + '$!TOP_LEVEL',
          ID=typename,
          EXTENDS=extends_str)
 
     self._type_comment_emitter.Emit("/// @domName $DOMNAME",
         DOMNAME=self._interface.doc_js_name)
 
     for constructor_info in constructors:
       self._members_emitter.Emit(
           '\n'
           '  $CTOR($PARAMS);\n',
@@ skipping 79 matching lines @@
                                  '  $TYPE $NAME($PARAMS);\n',
                                  TYPE=self._shared.DartType(info.type_name),
                                  NAME=html_name,
                                  PARAMS=info.ParametersInterfaceDeclaration(
                                         self._shared.DartType))
 
   def FinishInterface(self):
     pass
 
   def AddConstant(self, constant):
-    self._EmitConstant(self._members_emitter, constant)
+    type = TypeOrNothing(DartType(constant.type.id), constant.type.id)
+    self._members_emitter.Emit('\n  static final $TYPE$NAME = $VALUE;\n',
+                               NAME=constant.id,
+                               TYPE=type,
+                               VALUE=constant.value)
 
   def AddEventAttributes(self, event_attrs):
     event_attrs = DomToHtmlEvents(self._html_interface_name, event_attrs)
     self._shared._event_classes.add(self._interface.id)
     events_interface = self._html_interface_name + 'Events'
     self._EmitEventGetter(events_interface)
 
-    events_members = self._emitter.Emit(
+    events_members = self._interface_emitter.Emit(
         '\ninterface $INTERFACE extends $PARENTS {\n$!MEMBERS}\n',
         INTERFACE=events_interface,
         PARENTS=', '.join(
             self._shared.GetParentsEventsClasses(self._interface)))
 
     for event_name in event_attrs:
       if event_name in _html_event_names:
         events_members.Emit('\n  EventListenerList get $NAME();\n',
           NAME=_html_event_names[event_name])
       else:
@@ skipping 340 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 ProcessInterface(self, interface):
+  def ProcessInterface(self, interface, implementation_emitter):
     """."""
-    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)
     generator = HtmlFrogClassGenerator(self, interface, template,
-                                       dart_code, self._shared)
+                                       implementation_emitter, self._shared)
     generator.Generate()
 
   def GenerateLibraries(self, interface_files):
     self._GenerateLibFile(
         'html_frog.darttemplate',
         os.path.join(self._output_dir, 'html_frog.dart'),
         interface_files + self._dart_frog_file_paths)
 
   def Finish(self):
     pass
 
+  def HasImplementation(self, interface):
+    return not (IsPureInterface(interface) or
+                interface in _merged_html_interfaces)
+
   def _ImplFileEmitter(self, name):
     """Returns the file emitter of the Frog implementation file."""
-    path = os.path.join(self._output_dir, 'html', 'frog', '%s.dart' % name)
+    path = self.FilePathForDartImplementation(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]
 
+  def FilePathForDartImplementation(self, name):
+    name = self._shared._HTMLInterfaceName(name)
+    return os.path.join(self._output_dir, 'html', 'frog', '%s.dart' % name)
+
 # -----------------------------------------------------------------------------
 
 def _ComputeInheritanceClosure(database):
   def Collect(interface, seen, collected):
     name = interface.id
     if '<' in name:
       # TODO(sra): Handle parameterized types.
       return
     if not name in seen:
       seen.add(name)
       collected.append(name)
       for parent in interface.parents:
         # TODO(sra): Handle parameterized types.
         if not '<' in parent.type.id:
           if database.HasInterface(parent.type.id):
             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