Introduce ListLikeIDLTypeInfo as a replacement for nativified_classes table.

lib/html/scripts/generator.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 systems to generate
 Dart APIs from the IDL database."""
 
 import copy
 import re
@@ skipping 603 matching lines @@
 
   def narrow_dart_type(self):
     return self.dart_type()
 
   def interface_name(self):
     raise NotImplementedError()
 
   def implementation_name(self):
     raise NotImplementedError()
 
+  def has_generated_interface(self):
+    raise NotImplementedError()
+
   def native_type(self):
     return self._data.native_type or self._idl_type
 
   def bindings_class(self):
     return 'Dart%s' % self.idl_type()
 
   def vector_to_dart_template_parameter(self):
     return self.bindings_class()
 
   def requires_v8_scope(self):
@@ skipping 69 matching lines @@
 
 class InterfaceIDLTypeInfo(IDLTypeInfo):
   def __init__(self, idl_type, data, dart_interface_name):
     super(InterfaceIDLTypeInfo, self).__init__(idl_type, data)
     self._dart_interface_name = dart_interface_name
 
   def dart_type(self):
     return self._data.dart_type or self._dart_interface_name
 
   def narrow_dart_type(self):
-    # TODO(podivilov): introduce ListLikeIDLTypeInfo and remove this hack.
-    if self._data.suppress_public_interface:
-      return ImplementationClassNameForInterfaceName(self.idl_type())
     # TODO(podivilov): only primitive and collection types should override
     # dart_type.
     if self._data.dart_type != None:
       return self.dart_type()
     if IsPureInterface(self.idl_type()):
       return self.idl_type()
     return self.implementation_name()
 
   def interface_name(self):
     return self._dart_interface_name
 
   def implementation_name(self):
-    # TODO(podivilov): introduce ListLikeIDLTypeInfo and remove this hack.
-    if self._data.suppress_public_interface:
-      return ImplementationClassNameForInterfaceName(self.idl_type())
     return ImplementationClassNameForInterfaceName(self._dart_interface_name)
 
+  def has_generated_interface(self):
+    return True
+
 
 class CallbackIDLTypeInfo(IDLTypeInfo):
   def __init__(self, idl_type, data):
     super(CallbackIDLTypeInfo, self).__init__(idl_type, data)
 
 
+# Type info for DOM types that are converted to built-in dart types

[Anton Muhin, 2012/10/10 07:44:00]

comment is somewhat at odds with the name of the class: you promise here
built-in dart type, but class name is ListLike.

[podivilov, 2012/10/10 13:24:06]

Done.

+# (like Lists) and therefore whose actual interface generation should be
+# suppressed. (For type information, we still generate the implementations
+# though, so these types should not be suppressed entirely.)
+class ListLikeIDLTypeInfo(IDLTypeInfo):
+  def __init__(self, idl_type, data, item_info):
+    super(ListLikeIDLTypeInfo, self).__init__(idl_type, data)
+    self._item_info = item_info
+
+  def dart_type(self):
+    return 'List<%s>' % self._item_info.dart_type()
+
+  def narrow_dart_type(self):
+    return ImplementationClassNameForInterfaceName(self.idl_type())
+
+  def interface_name(self):
+    # TODO(podivilov): why NodeList is special? Is it indeed a list-like type

[Emily Fortuna, 2012/10/05 18:26:08]

NodeList is special because it is fully list-like and used just as a list, but
also RadioNodeList extends from it and adds additional methods, so it can't
completely go away. 

[podivilov, 2012/10/05 19:59:19]

Here's what I see in generated files:
  abstract class RadioNodeList implements List<Node>
and
  class _RadioNodeListImpl extends _NodeListImpl implements RadioNodeList
So NodeList interface seems not to be used at all. Is it a bug?

Also NodeList only declares filter, getRange, get:first and get:length members
so it probably adds nothing to List<Node> interface.

+    # or should just implement sequence<Node>?
+    if self.idl_type() == 'NodeList':

[Anton Muhin, 2012/10/10 07:44:00]

if not has_generated_interface(): return self.idl_type()?

[podivilov, 2012/10/10 13:24:06]

Done.

+      return self.idl_type()
+    return self.dart_type()
+
+  def implementation_name(self):
+    return ImplementationClassNameForInterfaceName(self.idl_type())
+
+  def has_generated_interface(self):
+    # Don't generate interfaces for list-like types.
+    # TODO(podivilov): why NodeList is special? Is it indeed a list-like type
+    # or should just implement sequence<Node>?
+    return self.idl_type() == 'NodeList'
+
+
 class SequenceIDLTypeInfo(IDLTypeInfo):
   def __init__(self, idl_type, data, item_info):
     super(SequenceIDLTypeInfo, self).__init__(idl_type, data)
     self._item_info = item_info
 
   def dart_type(self):
     return 'List<%s>' % self._item_info.dart_type()
 
   def interface_name(self):
     return self.dart_type()
@@ skipping 108 matching lines @@
   def argument_expression(self, name, interface_name):
     return name if interface_name.endswith('List') else '%s->propertyReference()' % name
 
 
 class TypeData(object):
   def __init__(self, clazz, dart_type=None, native_type=None,
                custom_to_dart=None, custom_to_native=None,
                conversion_includes=None,
                webcore_getter_name='getAttribute',
                webcore_setter_name='setAttribute',
-               requires_v8_scope=False, suppress_public_interface=False):
-    """Constructor.
-    Arguments:
-    - suppress_public_interface is True if we are converting a DOM type to a
-        built-in Dart type in which case we do not want to generate the new
-        interface in the library (FooList -> List<Foo> for example) but we still
-        generate the underlying implementation classes."""
+               requires_v8_scope=False,
+               item_type=None):
     self.clazz = clazz
     self.dart_type = dart_type
     self.native_type = native_type
     self.custom_to_dart = custom_to_dart
     self.custom_to_native = custom_to_native
     self.conversion_includes = conversion_includes
     self.webcore_getter_name = webcore_getter_name
     self.webcore_setter_name = webcore_setter_name
     self.requires_v8_scope = requires_v8_scope
-    self.suppress_public_interface = suppress_public_interface
+    self.item_type = item_type
 
 
 _idl_type_registry = {
     'boolean': TypeData(clazz='Primitive', dart_type='bool', native_type='bool',
                         webcore_getter_name='hasAttribute',
                         webcore_setter_name='setBooleanAttribute'),
     'byte': TypeData(clazz='Primitive', dart_type='int', native_type='int'),
     'octet': TypeData(clazz='Primitive', dart_type='int', native_type='int'),
     'short': TypeData(clazz='Primitive', dart_type='int', native_type='int'),
     'unsigned short': TypeData(clazz='Primitive', dart_type='int',
@@ skipping 33 matching lines @@
     # the documentation, the user is made aware that only a limited subset of
     # serializable types are actually permitted.
     'SerializedScriptValue': TypeData(clazz='Primitive', dart_type='Dynamic'),
     # TODO(sra): Flags is really a dictionary: {create:bool, exclusive:bool}
     # http://dev.w3.org/2009/dap/file-system/file-dir-sys.html#the-flags-interface
     'WebKitFlags': TypeData(clazz='Primitive', dart_type='Object'),
 
     'sequence': TypeData(clazz='Primitive', dart_type='List'),
     'void': TypeData(clazz='Primitive', dart_type='void'),
 
-    'WebKitAnimationList': TypeData(clazz='Interface',
-        dart_type='List<Animation>', suppress_public_interface=True),
-    'ClientRectList': TypeData(clazz='Interface', dart_type='List<ClientRect>',
-        suppress_public_interface=True),
-    'CSSRuleList': TypeData(clazz='Interface', dart_type='List<CSSRule>',
-        suppress_public_interface=True),
-    'CSSValueList': TypeData(clazz='Interface', dart_type='List<CSSValue>',
-        suppress_public_interface=True),
     'CSSRule': TypeData(clazz='Interface', conversion_includes=['CSSImportRule']),
     'DOMException': TypeData(clazz='Interface', native_type='DOMCoreException'),
     'DOMStringList': TypeData(clazz='Interface', dart_type='List<String>', custom_to_native=True),
     'DOMStringMap': TypeData(clazz='Interface', dart_type='Map<String, String>'),
     'DOMWindow': TypeData(clazz='Interface', custom_to_dart=True),
     'Element': TypeData(clazz='Interface', custom_to_dart=True),
-    'EntryArray': TypeData(clazz='Interface', dart_type='List<Entry>',
-        suppress_public_interface=True),
-    'EntryArraySync': TypeData(clazz='Interface',
-        dart_type='List<EntrySync>', suppress_public_interface=True),
     'EventListener': TypeData(clazz='Interface', custom_to_native=True),
     'EventTarget': TypeData(clazz='Interface', custom_to_native=True),
-    'FileList': TypeData(clazz='Interface', dart_type='List<File>',
-       suppress_public_interface=True),
-    'GamepadList': TypeData(clazz='Interface', dart_type='List<Gamepad>',
-        suppress_public_interface=True),
     'HTMLElement': TypeData(clazz='Interface', custom_to_dart=True),
     'IDBAny': TypeData(clazz='Interface', dart_type='Dynamic', custom_to_native=True),
     'IDBKey': TypeData(clazz='Interface', dart_type='Dynamic', custom_to_native=True),
-    'MediaStreamList': TypeData(clazz='Interface',
-        dart_type='List<MediaStream>', suppress_public_interface=True),
     'MutationRecordArray': TypeData(clazz='Interface',  # C++ pass by pointer.
         native_type='MutationRecordArray', dart_type='List<MutationRecord>'),
-    'NodeList': TypeData(clazz='Interface', dart_type='List<Node>',
-        suppress_public_interface=False),
     'StyleSheet': TypeData(clazz='Interface', conversion_includes=['CSSStyleSheet']),
     'SVGElement': TypeData(clazz='Interface', custom_to_dart=True),
-    'SVGElementInstanceList': TypeData(clazz='Interface',
-        dart_type='List<SVGElementInstance>', suppress_public_interface=True),
-    'SpeechInputResultList': TypeData(clazz='Interface',
-        dart_type='List<SpeechInputResult>', suppress_public_interface=True),
-    'SpeechRecognitionResultList': TypeData(clazz='Interface',
-        dart_type='List<SpeechRecognitionResult>',
-        suppress_public_interface=True),
-    'StyleSheetList': TypeData(clazz='Interface',
-        dart_type='List<StyleSheet>', suppress_public_interface=True),
+
+    'ClientRectList': TypeData(clazz='ListLike', item_type='ClientRect'),
+    'CSSRuleList': TypeData(clazz='ListLike', item_type='CSSRule'),
+    'CSSValueList': TypeData(clazz='ListLike', item_type='CSSValue'),
+    'EntryArray': TypeData(clazz='ListLike', item_type='Entry'),
+    'EntryArraySync': TypeData(clazz='ListLike', item_type='EntrySync'),
+    'FileList': TypeData(clazz='ListLike', item_type='File'),
+    'GamepadList': TypeData(clazz='ListLike', item_type='Gamepad'),
+    'MediaStreamList': TypeData(clazz='ListLike', item_type='MediaStream'),
+    'NodeList': TypeData(clazz='ListLike', item_type='Node'),
+    'SVGElementInstanceList': TypeData(clazz='ListLike',
+        item_type='SVGElementInstance'),
+    'SpeechInputResultList': TypeData(clazz='ListLike',
+        item_type='SpeechInputResult'),
+    'SpeechRecognitionResultList': TypeData(clazz='ListLike',
+        item_type='SpeechRecognitionResult'),
+    'StyleSheetList': TypeData(clazz='ListLike', item_type='StyleSheet'),
+    'WebKitAnimationList': TypeData(clazz='ListLike', item_type='WebKitAnimation'),

[Emily Fortuna, 2012/10/05 18:26:08]

80 char here and at 1065 if you guys are paying attention to that.

[podivilov, 2012/10/05 19:59:19]

Yes, we do. Thanks for spotting!

 
     'SVGAngle': TypeData(clazz='SVGTearOff'),
     'SVGLength': TypeData(clazz='SVGTearOff'),
     'SVGLengthList': TypeData(clazz='SVGTearOff'),
     'SVGMatrix': TypeData(clazz='SVGTearOff'),
     'SVGNumber': TypeData(clazz='SVGTearOff', native_type='SVGPropertyTearOff<float>'),
     'SVGNumberList': TypeData(clazz='SVGTearOff'),
     'SVGPathSegList': TypeData(clazz='SVGTearOff', native_type='SVGPathSegListPropertyTearOff'),
     'SVGPoint': TypeData(clazz='SVGTearOff', native_type='SVGPropertyTearOff<FloatPoint>'),
     'SVGPointList': TypeData(clazz='SVGTearOff'),
     'SVGPreserveAspectRatio': TypeData(clazz='SVGTearOff'),
     'SVGRect': TypeData(clazz='SVGTearOff', native_type='SVGPropertyTearOff<FloatRect>'),
     'SVGStringList': TypeData(clazz='SVGTearOff', native_type='SVGStaticListPropertyTearOff<SVGStringList>'),
     'SVGTransform': TypeData(clazz='SVGTearOff'),
     'SVGTransformList': TypeData(clazz='SVGTearOff', native_type='SVGTransformListPropertyTearOff'),
 }
 
-# A list constructed of DOM types that are converted to built-in dart types
-# (like Lists) and therefore whose actual interface generation should be
-# suppressed. (For type information, we still generate the implementations
-# though, so these types should not be suppressed entirely.)
-nativified_classes = {}
-for key in _idl_type_registry:
-  value = _idl_type_registry[key]
-  if value.suppress_public_interface:
-    nativified_classes[value.dart_type] = key
-    html_interface_renames[key] = value.dart_type
-
 _svg_supplemental_includes = [
     '"SVGAnimatedPropertyTearOff.h"',
     '"SVGAnimatedListPropertyTearOff.h"',
     '"SVGStaticListPropertyTearOff.h"',
     '"SVGAnimatedListPropertyTearOff.h"',
     '"SVGTransformListPropertyTearOff.h"',
     '"SVGPathSegListPropertyTearOff.h"',
 ]
 
 class TypeRegistry(object):
@@ skipping 21 matching lines @@
     if not type_name in _idl_type_registry:
       interface = self._database.GetInterface(type_name)
       if 'Callback' in interface.ext_attrs:
         return CallbackIDLTypeInfo(type_name, TypeData('Callback'))
       return InterfaceIDLTypeInfo(
           type_name,
           TypeData('Interface'),
           self._renamer.RenameInterface(interface))
 
     type_data = _idl_type_registry.get(type_name)
+
     if type_data.clazz == 'Interface':
       if self._database.HasInterface(type_name):
         dart_interface_name = self._renamer.RenameInterface(
             self._database.GetInterface(type_name))
       else:
         dart_interface_name = type_name
       return InterfaceIDLTypeInfo(type_name, type_data, dart_interface_name)
 
+    if type_data.clazz == 'ListLike':
+      return ListLikeIDLTypeInfo(type_name, type_data, self.TypeInfo(type_data.item_type))
+
     class_name = '%sIDLTypeInfo' % type_data.clazz
     return globals()[class_name](type_name, type_data)