Apply html renames to native wrappers.

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 235 matching lines @@
     "Node.get:prefix",
     "Node.set:prefix",
     "Node.get:DOCUMENT_POSITION_PRECEDING",
     "Node.get:nodeValue",
     "Node.set:nodeValue",
     "Node.get:CDATA_SECTION_NODE",
     "Node.get:nodeName",
     "Node.lookupPrefix",
     "Node.get:PROCESSING_INSTRUCTION_NODE",
     "IFrameElement.get:contentDocument",
-    "IFrameElement.get:contentWindow",
     "Window.get:frameElement",
     ])
 
 _html_library_custom = set([
     'Document.querySelector',
+    'IFrameElement.get:contentWindow',

[Anton Muhin, 2012/05/24 17:16:58]

why this move?

[podivilov, 2012/05/25 12:00:35]

contentWindow is not removed from dart:html, it just has custom implementation.

     'Window.get:document',
     'Window.get:top',
     ])
 
 # Events without onEventName attributes in the  IDL we want to support.
 # We can automatically extract most event event names by checking for
 # onEventName methods in the IDL but some events aren't listed so we need
 # to manually add them here so that they are easy for users to find.
 _html_manual_events = {
   'Element': ['touchleave', 'touchenter', 'webkitTransitionEnd'],
@@ skipping 270 matching lines @@
 
 # ------------------------------------------------------------------------------
 class HtmlSystemShared(object):
 
   def __init__(self, database):
     self._event_classes = set()
     self._seen_event_names = {}
     self._database = database
     self._inheritance_closure = _ComputeInheritanceClosure(database)
 
-  def _AllowInHtmlLibrary(self, interface, member, member_prefix):
-    return not self._Matches(interface, member, member_prefix,
-        _html_library_remove)
-
-  def _Matches(self, interface, member, member_prefix, candidates):
-    for interface_name in self._AllAncestorInterfaces(interface):
-      if (DartType(interface_name) + '.' + member in candidates or
-          DartType(interface_name) + '.' + member_prefix + member in candidates):
+  def _Matches(self, interface_name, member, member_prefix, candidates):
+    for ancestor_name in self._AllAncestorInterfaces(interface_name):
+      if (DartType(ancestor_name) + '.' + member in candidates or
+          DartType(ancestor_name) + '.' + member_prefix + member in candidates):
         return True
     return False
 
-  def _AllAncestorInterfaces(self, interface):
-    return [interface.id] + self._inheritance_closure[interface.id]
+  def _AllAncestorInterfaces(self, interface_name):
+    return [interface_name] + self._inheritance_closure[interface_name]
 
-  def RenameInHtmlLibrary(self, interface, member, member_prefix='',
+  def RenameInHtmlLibrary(self, interface_name, member, member_prefix='',
                           implementation_class=False):
     """
     Returns the name of the member in the HTML library or None if the member is
     suppressed in the HTML library
     """
-    if not self._AllowInHtmlLibrary(interface, member, member_prefix):
+    if self._Matches(interface_name, member, member_prefix,
+                     _html_library_remove):
       return None
 
     target_name = member
-    for interface_name in self._AllAncestorInterfaces(interface):
-      name = interface_name + '.' + member
+    for ancestor_name in self._AllAncestorInterfaces(interface_name):

[Anton Muhin, 2012/05/24 17:16:58]

it looks like now you can merge this logic into _Matches, correct?

[podivilov, 2012/05/25 12:00:35]

Could you please clarify? I don't see how it can be done...

[Anton Muhin, 2012/05/25 12:04:29]

Sorry.

It looks like the loop below is almost _Matches method above.  The only
difference is _Mathces returns bool, while this loop looks for new name.

So if _Matches could return a string iff there is a match or None, you would be
able to use it right here.

On 2012/05/25 12:00:35, podivilov wrote:

[podivilov, 2012/05/25 12:16:32]

_Matches works with sets, while _html_library_renames is a map. Still it could
be merged, but I'm not sure if it worth doing.

[Anton Muhin, 2012/05/25 12:17:45]

I think it's worth it, but up to you.

On 2012/05/25 12:16:32, podivilov wrote:

[podivilov, 2012/05/25 12:37:54]

Done.

[Anton Muhin, 2012/05/25 12:39:16]

Thanks a lot!  Still LGTM

On 2012/05/25 12:37:54, podivilov wrote:

+      name = ancestor_name + '.' + member
       if name in _html_library_renames:
         target_name = _html_library_renames[name]
-      name = interface.id + '.' + member_prefix + member
+      name = interface_name + '.' + member_prefix + member
       if name in _html_library_renames:
         target_name = _html_library_renames[name]
 
     if not target_name.startswith('_'):
-      if self._PrivateInHtmlLibrary(interface, member, member_prefix):
+      if self._Matches(interface_name, member, member_prefix,
+                       _private_html_members):
         if not target_name.startswith('$dom_'):  # e.g. $dom_svgClassName
           target_name = '$dom_' + target_name

[Anton Muhin, 2012/05/24 17:16:58]

this works by a chance as you don't account for member_prefix?

[podivilov, 2012/05/25 12:00:35]

member_prefix is passed to self._Matches above. Am I missing something?

[Anton Muhin, 2012/05/25 12:04:29]

Yes, sorry, I was wrong.

On 2012/05/25 12:00:35, podivilov wrote:

 
-    # No rename required
     return target_name
 
-  def _PrivateInHtmlLibrary(self, interface, member, member_prefix):
-    return self._Matches(interface, member, member_prefix,
-        _private_html_members)
-
   def IsCustomInHtmlLibrary(self, interface, member, member_prefix=''):
-    return self._Matches(interface, member, member_prefix,
+    return self._Matches(interface.id, member, member_prefix,
         _html_library_custom)
 
   # TODO(jacobr): this already exists
   def _TraverseParents(self, interface, callback):
     for parent in interface.parents:
       parent_id = parent.type.id
       if self._database.HasInterface(parent_id):
         parent_interface = self._database.GetInterface(parent_id)
         callback(parent_interface)
         self._TraverseParents(parent_interface, callback)
@@ skipping 222 matching lines @@
         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, dom_name, 'get:')
+      self._interface.id, dom_name, 'get:')
     html_setter_name = self._shared.RenameInHtmlLibrary(
-      self._interface, dom_name, 'set:')
+      self._interface.id, dom_name, 'set:')
 
     if not html_getter_name or self._shared.IsPrivate(html_getter_name):
       getter = None
     if not html_setter_name or self._shared.IsPrivate(html_setter_name):
       setter = None
     if not getter and not setter:
       return
 
     # We don't yet handle inconsistent renames of the getter and setter yet.
     if html_getter_name and html_setter_name:
@@ skipping 16 matching lines @@
     raise Exception('Unexpected getter/setter combination %s %s' %
                     (getter, setter))
 
   def AddOperation(self, info):
     """
     Arguments:
       operations - contains the overloads, one or more operations with the same
         name.
     """
     html_name = self._shared.RenameInHtmlLibrary(
-        self._interface, info.name)
+        self._interface.id, info.name)
     if html_name and not self._shared.IsPrivate(html_name):
       self._members_emitter.Emit('\n  /** @domName $DOMINTERFACE.$DOMNAME */',
           DOMINTERFACE=info.overloads[0].doc_js_interface_name,
           DOMNAME=info.name)
 
       self._members_emitter.Emit('\n'
                                  '  $TYPE $NAME($PARAMS);\n',
                                  TYPE=info.type_name,
                                  NAME=html_name,
                                  PARAMS=info.ParametersInterfaceDeclaration())
@@ skipping 165 matching lines @@
       template_file = 'immutable_list_mixin.darttemplate'
       template = self._system._templates.Load(template_file)
       self._members_emitter.Emit(template, E=DartType(element_type))
 
   def AddAttribute(self, getter, setter):
     dom_name = DartDomNameOfAttribute(getter or setter)
     html_getter_name = None
     if not self._shared.IsCustomInHtmlLibrary(
         self._interface, dom_name, 'get:'):
       html_getter_name = self._shared.RenameInHtmlLibrary(
-          self._interface, dom_name, 'get:',
+          self._interface.id, dom_name, 'get:',
           implementation_class=True)
     html_setter_name = None
     if not self._shared.IsCustomInHtmlLibrary(
         self._interface, dom_name, 'set:'):
       html_setter_name = self._shared.RenameInHtmlLibrary(
-          self._interface, dom_name, 'set:',
+          self._interface.id, dom_name, 'set:',
           implementation_class=True)
 
     if not html_getter_name:
       getter = None
     if not html_setter_name:
       setter = None
 
     if not getter and not setter:
       return
 
@@ skipping 74 matching lines @@
 
   def AddOperation(self, info):
     """
     Arguments:
       info: An OperationInfo object.
     """
     if self._shared.IsCustomInHtmlLibrary(self._interface, info.name):
       return
 
     html_name = self._shared.RenameInHtmlLibrary(
-        self._interface, info.name, implementation_class=True)
+        self._interface.id, info.name, implementation_class=True)
     if not html_name:
       return
 
     # 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',
           TYPE=return_type,
           HTML_NAME=html_name,
@@ skipping 339 matching lines @@
     if name in self._base_members:  # Avoid illegal Dart 'static override'.
       method_name = method_name + '_' + self._interface.id
     return method_name
 
   def AddAttribute(self, getter, setter):
     dom_name = DartDomNameOfAttribute(getter or setter)
     html_getter_name = None
     if not self._shared.IsCustomInHtmlLibrary(
         self._interface, dom_name, 'get:'):
       html_getter_name = self._shared.RenameInHtmlLibrary(
-          self._interface, dom_name, 'get:',
+          self._interface.id, dom_name, 'get:',
           implementation_class=True)
     html_setter_name = None
     if not self._shared.IsCustomInHtmlLibrary(
         self._interface, dom_name, 'set:'):
       html_setter_name = self._shared.RenameInHtmlLibrary(
-          self._interface, dom_name, 'set:',
+          self._interface.id, dom_name, 'set:',
           implementation_class=True)
 
     if getter and html_getter_name:
       self._AddGetter(getter, html_getter_name)
     if setter and html_setter_name:
       self._AddSetter(setter, html_setter_name)
 
   def _AddGetter(self, attr, html_name):
     self._members_emitter.Emit(
       '\n'
-      '  $TYPE get $(HTML_NAME)() => _wrap($(THIS).$DOM_NAME);\n',
+      '  $TYPE get $(HTML_NAME)() => _wrap($(THIS).$HTML_NAME);\n',
       HTML_NAME=html_name,
-      DOM_NAME=DartDomNameOfAttribute(attr),
       TYPE=DartType(attr.type.id),
       THIS=self.DomObjectName())
 
   def _AddSetter(self, attr, html_name):
     self._members_emitter.Emit(
         '\n'
         '  void set $(HTML_NAME)($TYPE value) { '
-        '$(THIS).$DOM_NAME = _unwrap(value); }\n',
+        '$(THIS).$HTML_NAME = _unwrap(value); }\n',
         HTML_NAME=html_name,
-        DOM_NAME=DartDomNameOfAttribute(attr),
         TYPE=DartType(attr.type.id),
         THIS=self.DomObjectName())
 
   def AddSecondaryAttribute(self, interface, getter, setter):
     self._SecondaryContext(interface)
     self.AddAttribute(getter, setter)
 
   def AddSecondaryOperation(self, interface, info):
     self._SecondaryContext(interface)
     self.AddOperation(info)
@@ skipping 88 matching lines @@
 
   def AddOperation(self, info):
     """
     Arguments:
       info: An OperationInfo object.
     """
     if self._shared.IsCustomInHtmlLibrary(self._interface, info.name):
       return
 
     html_name = self._shared.RenameInHtmlLibrary(
-        self._interface, info.name, implementation_class=True)
+        self._interface.id, info.name, implementation_class=True)
 
     if not html_name:
       return
 
     arguments = self._UnwrappedParameters(info, len(info.param_infos))
-    function_call = '%s.%s(%s)' % (self.DomObjectName(), info.name, arguments)
+    function_call = '%s.%s(%s)' % (self.DomObjectName(), html_name, arguments)
     if info.type_name != 'void':
       # We could place the logic for handling Document directly in _wrap
       # but we chose to place it here so that bugs in the wrapper and
       # wrapperless implementations are more consistent.
       function_call = '_wrap(%s)' % function_call
 
     self._members_emitter.Emit(
         '\n'
         '  $TYPE $HTML_NAME($PARAMS) => $FUNCTION_CALL;\n',
         TYPE=info.type_name,
@@ skipping 20 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