Work-around for FireFox: patch non-leaf types statically if possible.

client/dom/scripts/dartgenerator.py

 #!/usr/bin/python
 # Copyright (c) 2011, 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 83 matching lines @@
     ])
 
 #
 # Custom getters that must be implemented by hand.
 #
 _custom_getters = set([
     ('DOMWindow', 'localStorage'),
     ])
 
 #
+# Publically visible types common across all supported browsers.
+#
+_BROWSER_SHARED_TYPES = [
+        'Attr',
+        'CDATASection',
+        'CSSFontFaceRule',
+        'CSSImportRule',
+        'CSSMediaRule',
+        'CSSPageRule',
+        'CSSRule',
+        'CSSRuleList',
+        'CSSStyleDeclaration',
+        'CSSStyleRule',
+        'CSSStyleSheet',
+        'CanvasRenderingContext2D',
+        'CharacterData',
+        'ClientRect',
+        'ClientRectList',
+        'Comment',
+        'DOMException',
+        'DOMImplementation',
+        'DOMParser',
+        'Document',
+        'DocumentFragment',
+        'DocumentType',
+        'Element',
+        'Event',
+        'EventException',
+        'HTMLAnchorElement',
+        'HTMLAppletElement',
+        'HTMLAreaElement',
+        'HTMLAudioElement',
+        'HTMLBRElement',
+        'HTMLBaseElement',
+        'HTMLBodyElement',
+        'HTMLButtonElement',
+        'HTMLCanvasElement',
+        'HTMLCollection',
+        'HTMLDListElement',
+        'HTMLDirectoryElement',
+        'HTMLDivElement',
+        'HTMLElement',
+        'HTMLEmbedElement',
+        'HTMLFieldSetElement',
+        'HTMLFontElement',
+        'HTMLFormElement',
+        'HTMLFrameElement',
+        'HTMLFrameSetElement',
+        'HTMLHRElement',
+        'HTMLHeadElement',
+        'HTMLHeadingElement',
+        'HTMLHtmlElement',
+        'HTMLIFrameElement',
+        'HTMLImageElement',
+        'HTMLInputElement',
+        'HTMLLIElement',
+        'HTMLLabelElement',
+        'HTMLLegendElement',
+        'HTMLLinkElement',
+        'HTMLMapElement',
+        'HTMLMediaElement',
+        'HTMLMenuElement',
+        'HTMLMetaElement',
+        'HTMLModElement',
+        'HTMLOListElement',
+        'HTMLObjectElement',
+        'HTMLOptGroupElement',
+        'HTMLOptionElement',
+        'HTMLParagraphElement',
+        'HTMLParamElement',
+        'HTMLPreElement',
+        'HTMLQuoteElement',
+        'HTMLScriptElement',
+        'HTMLSelectElement',
+        'HTMLStyleElement',
+        'HTMLTableCaptionElement',
+        'HTMLTableCellElement',
+        'HTMLTableColElement',
+        'HTMLTableElement',
+        'HTMLTableRowElement',
+        'HTMLTableSectionElement',
+        'HTMLTextAreaElement',
+        'HTMLTitleElement',
+        'HTMLUListElement',
+        'HTMLVideoElement',
+        'KeyboardEvent',
+        'MediaError',
+        'MediaList',
+        'MessageEvent',
+        'MouseEvent',
+        'MutationEvent',
+        'NamedNodeMap',
+        'Node',
+        'NodeFilter',
+        'NodeList',
+        'ProcessingInstruction',
+        'Range',
+        'RangeException',
+        'SVGAElement',
+        'SVGAngle',
+        'SVGAnimatedAngle',
+        'SVGAnimatedBoolean',
+        'SVGAnimatedEnumeration',
+        'SVGAnimatedInteger',
+        'SVGAnimatedLength',
+        'SVGAnimatedLengthList',
+        'SVGAnimatedNumber',
+        'SVGAnimatedNumberList',
+        'SVGAnimatedPreserveAspectRatio',
+        'SVGAnimatedRect',
+        'SVGAnimatedString',
+        'SVGAnimatedTransformList',
+        'SVGCircleElement',
+        'SVGClipPathElement',
+        'SVGDefsElement',
+        'SVGDescElement',
+        'SVGElement',
+        'SVGEllipseElement',
+        'SVGException',
+        'SVGGElement',
+        'SVGGradientElement',
+        'SVGImageElement',
+        'SVGLength',
+        'SVGLengthList',
+        'SVGLineElement',
+        'SVGLinearGradientElement',
+        'SVGMarkerElement',
+        'SVGMaskElement',
+        'SVGMatrix',
+        'SVGMetadataElement',
+        'SVGNumber',
+        'SVGNumberList',
+        'SVGPathElement',
+        'SVGPathSeg',
+        'SVGPathSegArcAbs',
+        'SVGPathSegArcRel',
+        'SVGPathSegClosePath',
+        'SVGPathSegCurvetoCubicAbs',
+        'SVGPathSegCurvetoCubicRel',
+        'SVGPathSegCurvetoCubicSmoothAbs',
+        'SVGPathSegCurvetoCubicSmoothRel',
+        'SVGPathSegCurvetoQuadraticAbs',
+        'SVGPathSegCurvetoQuadraticRel',
+        'SVGPathSegCurvetoQuadraticSmoothAbs',
+        'SVGPathSegCurvetoQuadraticSmoothRel',
+        'SVGPathSegLinetoAbs',
+        'SVGPathSegLinetoHorizontalAbs',
+        'SVGPathSegLinetoHorizontalRel',
+        'SVGPathSegLinetoRel',
+        'SVGPathSegLinetoVerticalAbs',
+        'SVGPathSegLinetoVerticalRel',
+        'SVGPathSegList',
+        'SVGPathSegMovetoAbs',
+        'SVGPathSegMovetoRel',
+        'SVGPatternElement',
+        'SVGPoint',
+        'SVGPointList',
+        'SVGPolygonElement',
+        'SVGPolylineElement',
+        'SVGPreserveAspectRatio',
+        'SVGRadialGradientElement',
+        'SVGRect',
+        'SVGRectElement',
+        'SVGSVGElement',
+        'SVGScriptElement',
+        'SVGStopElement',
+        'SVGStyleElement',
+        'SVGSwitchElement',
+        'SVGSymbolElement',
+        'SVGTSpanElement',
+        'SVGTextContentElement',
+        'SVGTextElement',
+        'SVGTextPathElement',
+        'SVGTextPositioningElement',
+        'SVGTitleElement',
+        'SVGTransform',
+        'SVGTransformList',
+        'SVGUnitTypes',
+        'SVGUseElement',
+        'SVGZoomEvent',
+        'Storage',
+        'StorageEvent',
+        'StyleSheet',
+        'StyleSheetList',
+        'Text',
+        'TextMetrics',
+        'UIEvent',
+        'XMLHttpRequest',
+        'XMLSerializer',
+]
+
+#
 # Simple method substitution when one method had different names on different
 # browsers, but are otherwise identical.  The alternates are tried in order and
 # the first one defined is used.
 #
 # This can be probably be removed when Chrome renames initWebKitWheelEvent to
 # initWheelEvent.
 #
 _alternate_methods = {
     ('WheelEvent', 'initWheelEvent'): ['initWebKitWheelEvent', 'initWheelEvent']
 }
@@ skipping 242 matching lines @@
     """
 
     self._emitters = multiemitter.MultiEmitter()
     self._database = database
     self._output_dir = output_dir
     self._dart_callback_file_paths = []
 
     self._StartGenerateInterfaceLibrary()
     self._StartGenerateJavaScriptMonkeyImpl(database, output_dir)
     self._StartGenerateWrappingImpl(output_dir)
-    self._StartGenerateFrogImpl(output_dir)
+    self._StartGenerateFrogImpl(database, output_dir)
 
     # Render all interfaces into Dart and save them in files.
     dart_file_paths = []
     processed_interfaces = []
     for interface in database.GetInterfaces():
 
       super_interface = None
       super_name = interface.id
 
       if not _MatchSourceFilter(source_filter, interface):
@@ skipping 435 matching lines @@
             result.add(attr.id)
           for op in parent_interface.operations:
             result.add(op.id)
           WalkParentChain(parent_interface)
 
     result = set()
     WalkParentChain(interface)
     return result;
 
 
-  def _StartGenerateFrogImpl(self, output_dir):
+  def _StartGenerateFrogImpl(self, database, output_dir):

[Emily Fortuna, 2011/12/06 18:19:35]

Why pass database around if we can access it as self._database?

[sra1, 2011/12/06 19:25:30]

Good point.  Other code does this, so I'm copying that pattern.
I can fix this when I do subsequent work.

     """Prepared for generating frog implementation.
-
-    - Creates emitter for Dart code.
     """
-    pass
-
+    self._interface_names_with_subtypes = set()
+    for interface in database.GetInterfaces():
+      for parent in interface.parents:
+        self._interface_names_with_subtypes.add(parent.type.id)
 
   def _MakeFrogImplInterfaceGenerator(self,
-                                          interface,
-                                          common_prefix,
-                                          super_interface_name,
-                                          source_filter):
+                                      interface,
+                                      common_prefix,
+                                      super_interface_name,
+                                      source_filter):
     """."""
     interface_name = interface.id
     dart_frog_file_path = self.FilePathForFrogImpl(interface_name)
 
     self._dart_frog_file_paths.append(dart_frog_file_path)
 
     dart_code = self._emitters.FileEmitter(dart_frog_file_path)
     dart_code.Emit(
         ''.join(open('template_frog_impl.darttemplate').readlines()))
     return FrogInterfaceGenerator(interface, super_interface_name,
+                                  self._interface_names_with_subtypes,
                                   dart_code)
 
 
   def _StartGenerateJavaScriptMonkeyImpl(self, database, output_dir):
     """Generate a JavaScript implementation that is coherent with
     generated Dart APIs.
     """
     self._ComputeInheritanceClosure(database)
     js_file_name = os.path.join(output_dir, 'monkey_dom.js')
     code = self._emitters.FileEmitter(js_file_name)
@@ skipping 1150 matching lines @@
     self.AddSetter(attr)
 
   def AddSecondaryOperation(self, interface, info):
     self.AddOperation(info)
 
 # ------------------------------------------------------------------------------
 
 class FrogInterfaceGenerator(object):
   """Generates a Frog class for a DOM IDL interface."""
 
-  def __init__(self, interface, super_interface, dart_code):
+  def __init__(self, interface, super_interface, interfaces_with_subtypes,
+               dart_code):
     """Generates Dart code for the given interface.
 
     Args:
 
       interface: an IDLInterface instance. It is assumed that all types have
           been converted to Dart types (e.g. int, String), unless they are in
           the same package as the interface.
       super_interface: A string or None, the name of the common interface that
-         this interface implements, if any.
+          this interface implements, if any.
+      interfaces_with_subtypes: A set of strings names of interfaces that have
+          at least one subtype.
       dart_code: an Emitter for the file containing the Dart implementation
           class.
     """
     self._interface = interface
     self._super_interface = super_interface
+    self._interfaces_with_subtypes = interfaces_with_subtypes
     self._dart_code = dart_code
     self._current_secondary_parent = None
 
 
   def StartInterface(self):
     interface = self._interface
     interface_name = interface.id
 
     self._class_name = self._ImplClassName(interface_name)
 
@@ skipping 25 matching lines @@
       extends = " extends " + base
     else:
       extends = ""
 
     if interface_name in _constructable_types.keys():
       parameters = _constructable_types[interface_name]
       constructor = '  %s(%s) native;\n\n' % (interface_name, parameters)
     else:
       constructor = ''
 
+    # Is the type's constructor accessible from the global scope? If so, we can
+    # directly patch the prototype.  We don't really want to do this yet because
+    # the dynamic patching mechanism is tricky and we want to test it a lot.
+    # But patching is currently broken on FireFox for non-leaf types, so 'hide'
+    # only the leaf types.
+    is_hidden = interface_name not in _BROWSER_SHARED_TYPES
+    if interface_name not in self._interfaces_with_subtypes:
+      is_hidden = True
+
     # Compiler needs to know window is aliased with global scope.
     global_marker = '@' if interface_name == 'DOMWindow' else ''
 
     (self._members_emitter, self._base_emitter) = self._dart_code.Emit(
         '\n'
-        'class $CLASS$BASE native "$SPLAT*$CLASS" {\n'
+        'class $CLASS$BASE native "$SPLAT$HIDDEN$CLASS" {\n'
         '$CONSTRUCTOR$!MEMBERS'
         '$!ADDITIONS'
         '}\n',
         CLASS=self._class_name, BASE=extends,
         INTERFACE=interface_name, CONSTRUCTOR=constructor,
-        SPLAT=global_marker)
+        SPLAT=global_marker,
+        HIDDEN='*' if is_hidden else '')
 
     if not base:
       # Emit shared base functionality here as we have no common base type.
       self._base_emitter.Emit(
           '\n'
           '  var dartObjectLocalStorage;\n'
           '\n'
           '  String get typeName() native;\n')
 
   def _ImplClassName(self, type_name):
@@ skipping 72 matching lines @@
     Arguments:
       info: An OperationInfo object.
     """
     # TODO(vsm): Handle overloads.
     self._members_emitter.Emit(
         '\n'
         '  $TYPE $NAME($ARGS) native;\n',
         TYPE=info.type_name,
         NAME=info.name,
         ARGS=info.arg_implementation_declaration)