Frog DOM changes to support OLS on Storage objects

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 119 matching lines @@
 # 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']
 }
 
+#
+# Unexpandable types require special support for
+# dartObjectLocalStorage.  Normally, in the overlay dom, it is
+# implemented as an expando field.  For these types, we cannot use an
+# expando.  Instead, we define a specialized getter and setter.

[sra1, 2012/01/09 22:20:06]

Do you think this approach will work if we make all dom impl types extend
DOMType and have the method on DOMType?

DOMType.dartObjectLocalStorage would be the expando, and it would be overridded
by Storage.dartObjectLocalStorage.

[vsm, 2012/01/10 00:42:00]

It feels like it should.  It's legal dart to override a field with a getter /
setter.  And, as the compiler is patching the Storage proto with the getter and
setter, it may already do the right thing.

On 2012/01/09 22:20:06, sra1 wrote:

+#
+_unexpandable_types = {
+    # (type name, ols getter, ols setter)
+    'Storage': (
+'''
+    if (this === window.localStorage)
+      return window._dartLocalStorageLocalStorage;
+    else if (this === window.sessionStorage)
+      return window._dartSessionStorageLocalStorage;
+    else
+      throw new UnsupportedOperationException('Cannot dartObjectLocalStorage for unknown Storage object.');
+''',
+'''
+    if (this === window.localStorage)
+      window._dartLocalStorageLocalStorage = value;
+    else if (this === window.sessionStorage)
+      window._dartSessionStorageLocalStorage = value;
+    else
+      throw new UnsupportedOperationException('Cannot dartObjectLocalStorage for unknown Storage object.');
+'''),
+}
+
 def _MatchSourceFilter(filter, thing):
   if not filter:
     return True
   else:
     return any(token in thing.annotations for token in filter)
 
 def _IsDartListType(type):
   return type == 'List' or type.startswith('List<')
 
 def _IsDartCollectionType(type):
@@ skipping 1709 matching lines @@
           '  $NAME($PARAMS) native;\n\n',
           NAME=interface_name,
           PARAMS=_constructable_types[interface_name])
 
     element_type = MaybeTypedArrayElementType(interface)
     if element_type:
       self.AddTypedArrayConstructors(element_type)
 
     if not base:
       # Emit shared base functionality here as we have no common base type.
+      if interface_name in _unexpandable_types.keys():

[sra1, 2012/01/09 22:20:06]

I believe 'in' just works on the keys of a dict()

[vsm, 2012/01/10 00:42:00]

Done.

+        (getter, setter) = _unexpandable_types[interface_name]
+        self._base_emitter.Emit(
+            '\n'
+            '  var get dartObjectLocalStorage() native """')
+        self._base_emitter.Emit(getter)
+        self._base_emitter.Emit(
+            '""";\n'
+            '\n'
+            '  void set dartObjectLocalStorage(var value) native """')
+        self._base_emitter.Emit(setter)
+        self._base_emitter.Emit(
+            '""";\n')
+      else:
+        self._base_emitter.Emit(
+            '\n'
+            '  var dartObjectLocalStorage;\n')
       self._base_emitter.Emit(
           '\n'
-          '  var dartObjectLocalStorage;\n'
-          '\n'
           '  String get typeName() native;\n')
 
   def _ImplClassName(self, type_name):
     return type_name
 
   def FinishInterface(self):
     """."""
     pass
 
   def AddConstant(self, constant):
@@ skipping 93 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)