Dartifying SVG library class names.

sdk/lib/html/scripts/htmlrenamer.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.
+import re
 
 html_interface_renames = {
     'DOMCoreException': 'DOMException',
     'DOMFormData': 'FormData',
     'DOMURL': 'Url',
     'DOMWindow': 'LocalWindow',
     'History': 'LocalHistory',
     'Location': 'LocalLocation',
+    'SVGDocument': 'SvgDocument', # Manual to avoid name conflicts.
+    'SVGElement': 'SvgElement', # Manual to avoid name conflicts.
+    'SVGSVGElement': 'SvgSvgElement', # Manual to avoid name conflicts.
     'WebKitAnimation': 'Animation',
     'WebKitAnimationEvent': 'AnimationEvent',
     'WebKitBlobBuilder': 'BlobBuilder',
     'WebKitCSSKeyframeRule': 'CSSKeyframeRule',
     'WebKitCSSKeyframesRule': 'CSSKeyframesRule',
     'WebKitCSSMatrix': 'CSSMatrix',
     'WebKitCSSTransformValue': 'CSSTransformValue',
     'WebKitFlags': 'Flags',
     'WebKitLoseContext': 'LoseContext',
     'WebKitPoint': 'Point',
@@ skipping 67 matching lines @@
 _renamed_html_members = {
     'Document.defaultView': 'window',
     'Element.webkitMatchesSelector' : 'matchesSelector',
     'Element.scrollIntoViewIfNeeded': 'scrollIntoView',
     'Node.cloneNode': 'clone',
     'Node.nextSibling': 'nextNode',
     'Node.ownerDocument': 'document',
     'Node.parentNode': 'parent',
     'Node.previousSibling': 'previousNode',
     'Node.textContent': 'text',
-    'SVGElement.className': '$dom_svgClassName',
-    'SVGAnimatedString.className': '$dom_svgClassName',
-    'SVGStylable.className': '$dom_svgClassName',
+    'SvgElement.className': '$dom_svgClassName',
+    'AnimatedString.className': '$dom_svgClassName',
+    'Stylable.className': '$dom_svgClassName',
     'Url.createObjectURL': 'createObjectUrl',
     'Url.revokeObjectURL': 'revokeObjectUrl',
 }
 
 # Members and classes from the dom that should be removed completely from
 # dart:html.  These could be expressed in the IDL instead but expressing this
 # as a simple table instead is more concise.
 # Syntax is: ClassName.(get\.|set\.)?MemberName
 # Using get: and set: is optional and should only be used when a getter needs
 # to be suppressed but not the setter, etc.
@@ skipping 157 matching lines @@
   def __init__(self, database):
     self._database = database
 
   def RenameInterface(self, interface):
     if interface.id.startswith('HTML'):
       if any(interface.id in ['Element', 'Document']
              for interface in self._database.Hierarchy(interface)):
         return interface.id[len('HTML'):]
     elif interface.id in html_interface_renames:
       return html_interface_renames[interface.id]
-    return interface.id
+    return self._DartifyInterface(interface)
+
+  def RenameIDLName(self, name):

[Anton Muhin, 2012/11/13 11:37:19]

why this indirection?

[blois, 2012/11/14 17:21:50]

I wanted to be explicit that normally RenameInterface should be used.

[Anton Muhin, 2012/11/15 12:11:47]

I am not sure it is worth the complication.  DartifyTypeName looks like very
clean semantics to me

+    """ Renames an IDL type name which does not have an interface. """
+    return self._DartifyTypeName(name)
 
   def RenameMember(self, interface_name, member_node, member, member_prefix=''):
     """
     Returns the name of the member in the HTML library or None if the member is
     suppressed in the HTML library
     """
     interface = self._database.GetInterface(interface_name)
 
     if self._FindMatch(interface, member, member_prefix, _removed_html_members):
       return None
@@ skipping 13 matching lines @@
     for interface in self._database.Hierarchy(interface):
       html_interface_name = self.RenameInterface(interface)
       member_name = html_interface_name + '.' + member
       if member_name in candidates:
         return member_name
       member_name = html_interface_name + '.' + member_prefix + member
       if member_name in candidates:
         return member_name
 
   def GetLibraryName(self, interface):
-    if interface.id.startswith('SVG'):
+    return self._GetLibraryName(interface.id)
+
+  def _GetLibraryName(self, idl_type_name):
+    """
+    Gets the name of the library this type should live in.
+    This is private because this should use interfaces to resolve the library.
+    """
+
+    if idl_type_name.startswith('SVG'):
       return 'svg'
     return 'html'
+
+  def _DartifyInterface(self, interface):
+    """Gets the Dart-friend class name for an IDL interface. """
+    return self._DartifyTypeName(interface.id)
+
+  def _DartifyTypeName(self, type_name):
+    """Converts a DOM name to a Dart-friendly class name. """
+    library_name = self._GetLibraryName(type_name)
+    # Only renaming SVG for now.
+    if library_name != 'svg':
+      return type_name
+
+    # Strip off the SVG prefix.
+    name = type_name[3:]
+
+    def toLower(match):
+      inner = match.group(2).lower()
+      prefix = match.group(0)[0 : 1]
+      suffix = match.group(0)[len(inner) + 1 : ]
+      return prefix + inner + suffix
+
+    return re.sub(r"([A-Z]|[0-9])([A-Z]*)([A-Z]+|$)", toLower, name)

[Anton Muhin, 2012/11/13 11:37:19]

do you really need [0-9] here?

[Anton Muhin, 2012/11/13 11:37:19]

this mix of [A-Z]* and [A-Z], how does it work?

[Anton Muhin, 2012/11/13 11:37:19]

if all you want is to change a sequence of caps into Cc...cC, there are
apparently simpler approaches like

def toLower(match):
  s = match.group(0)
  return s[0] + s[1:-2].lower() + s[-1]

return re.sub(r"[A-Z]+", toLower, name)

[blois, 2012/11/14 17:21:50]

This catches cases such as 2D and 3D which should become 2d.

[blois, 2012/11/14 17:21:50]

Added comments to the code.

[blois, 2012/11/14 17:21:50]

I cleaned up the toLower code, makes it a bit more clear what it's doing.

Your sample doesn't work on cases like IFrameElement which should be unchanged.

[Anton Muhin, 2012/11/15 12:11:47]

Thanks for explanation

On 2012/11/14 17:21:50, blois wrote: