IDL: Use IdlArrayOrSequenceType for array/sequence IDL types

Source/bindings/scripts/idl_types.py

 # Copyright 2014 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 """IDL type handling.
 
 Classes:
 IdlTypeBase
  IdlType
  IdlUnionType
+ IdlArrayOrSequenceType
 """
 
 from collections import defaultdict
 
 
 ################################################################################
 # IDL types
 ################################################################################
 
 INTEGER_TYPES = frozenset([
@@ skipping 69 matching lines @@
 def inherits_interface(interface_name, ancestor_name):
     return (interface_name == ancestor_name or
             ancestor_name in ancestors[interface_name])
 
 
 def set_ancestors(new_ancestors):
     ancestors.update(new_ancestors)
 
 
 class IdlTypeBase(object):
-    """Base class for IdlType and IdlUnionType."""
+    """Base class for IdlType, IdlUnionType and IdlArrayOrSequenceType."""
 
-    def __init__(self, is_array=False, is_sequence=False, is_nullable=False):
+    def __init__(self, is_nullable):
         self.base_type = None
-        self.is_array = is_array
-        self.is_sequence = is_sequence
+        self.is_array = False
         self.is_nullable = is_nullable
+        self.is_sequence = False
+
+    def __str__(self):
+        inner_string = self.inner_string
+        if self.is_nullable:
+            # FIXME: Dictionary::ConversionContext::setConversionType can't
+            # handle the '?' in nullable types (passes nullability separately).
+            # Update that function to handle nullability from the type name,
+            # simplifying its signature.
+            # return inner_string + '?'
+            return inner_string
+        return inner_string
 
     @property
-    def native_array_element_type(self):
-        return None
+    def inner_string(self):
+        raise NotImplementedError(
+            'inner_string property should be defined in subclasses')
 
     @property
     def array_element_type(self):
         return None
 
     @property
     def is_basic_type(self):
         return False
 
     @property
     def is_callback_function(self):
         return False
 
     @property
+    def is_callback_interface(self):
+        return False
+
+    @property
     def is_dictionary(self):
         return False
 
     @property
     def is_enum(self):
         return False
 
     @property
     def is_integer_type(self):
         return False
 
     @property
     def is_numeric_type(self):
         return False
 
     @property
-    def is_primitivee_type(self):
+    def is_primitive_type(self):
         return False
 
     @property
+    def is_interface_type(self):
+        return False
+
+    @property
     def is_string_type(self):
         return False
 
     @property
     def is_union_type(self):
         return False
 
     @property
     def may_raise_exception_on_conversion(self):
         return False
 
     @property
     def name(self):
+        if self.is_nullable:
+            return self.inner_name + 'OrNull'
+        return self.inner_name
+
+    @property
+    def inner_name(self):
         raise NotImplementedError(
-            'name property should be defined in subclasses')
+            'inner_name property should be defined in subclasses')
 
     def resolve_typedefs(self, typedefs):
         raise NotImplementedError(
             'resolve_typedefs should be defined in subclasses')
 
 
 ################################################################################
 # IdlType
 ################################################################################
 
 class IdlType(IdlTypeBase):
     # FIXME: incorporate Nullable, etc.
-    # FIXME: use nested types: IdlArrayType, IdlNullableType, IdlSequenceType
     # to support types like short?[] vs. short[]?, instead of treating these
     # as orthogonal properties (via flags).
     callback_functions = set()
     callback_interfaces = set()
     dictionaries = set()
     enums = {}  # name -> values
 
-    def __init__(self, base_type, is_array=False, is_sequence=False, is_nullable=False, is_unrestricted=False):
-        super(IdlType, self).__init__(is_array=is_array, is_sequence=is_sequence, is_nullable=is_nullable)
-        if is_array and is_sequence:
-            raise ValueError('Array of Sequences are not allowed.')
+    def __init__(self, base_type, is_nullable=False, is_unrestricted=False):
+        super(IdlType, self).__init__(is_nullable)
         if is_unrestricted:
             self.base_type = 'unrestricted %s' % base_type
         else:
             self.base_type = base_type
 
-    def __str__(self):
-        type_string = self.base_type
-        if self.is_array:
-            return type_string + '[]'
-        if self.is_sequence:
-            return 'sequence<%s>' % type_string
-        if self.is_nullable:
-            # FIXME: Dictionary::ConversionContext::setConversionType can't
-            # handle the '?' in nullable types (passes nullability separately).
-            # Update that function to handle nullability from the type name,
-            # simplifying its signature.
-            # return type_string + '?'
-            return type_string
-        return type_string
-
-    # FIXME: move to v8_types.py
     @property
-    def native_array_element_type(self):
-        return self.array_element_type or self.sequence_element_type
+    def inner_string(self):
+        return self.base_type
 
     @property
     def array_element_type(self):
         return self.is_array and IdlType(self.base_type)
 
     @property
     def sequence_element_type(self):
         return self.is_sequence and IdlType(self.base_type)
 
     @property
     def is_basic_type(self):
-        return self.base_type in BASIC_TYPES and not self.native_array_element_type
+        return self.base_type in BASIC_TYPES
 
     @property
     def is_callback_function(self):
         return self.base_type in IdlType.callback_functions
 
     @property
     def is_callback_interface(self):
         return self.base_type in IdlType.callback_interfaces
 
     @property
     def is_dictionary(self):
         return self.base_type in IdlType.dictionaries
 
     @property
-    def is_composite_type(self):
-        return (self.name == 'Any' or
-                self.array_element_type or
-                self.sequence_element_type or
-                self.is_union_type)
-
-    @property
     def is_enum(self):
         # FIXME: add an IdlEnumType class and a resolve_enums step at end of
         # IdlDefinitions constructor
         return self.name in IdlType.enums
 
     @property
     def enum_values(self):
         return IdlType.enums[self.name]
 
     @property
     def is_integer_type(self):
-        return self.base_type in INTEGER_TYPES and not self.native_array_element_type
+        return self.base_type in INTEGER_TYPES
 
     @property
     def is_numeric_type(self):
-        return self.base_type in NUMERIC_TYPES and not self.native_array_element_type
+        return self.base_type in NUMERIC_TYPES
 
     @property
     def is_primitive_type(self):
-        return self.base_type in PRIMITIVE_TYPES and not self.native_array_element_type
+        return self.base_type in PRIMITIVE_TYPES
 
     @property
     def is_interface_type(self):
         # Anything that is not another type is an interface type.
         # http://www.w3.org/TR/WebIDL/#idl-types
         # http://www.w3.org/TR/WebIDL/#idl-interface
         # In C++ these are RefPtr or PassRefPtr types.
         return not(self.is_basic_type or
-                   self.is_composite_type or
                    self.is_callback_function or
                    self.is_dictionary or
                    self.is_enum or
+                   self.name == 'Any' or
                    self.name == 'Object' or
                    self.name == 'Promise')  # Promise will be basic in future
 
     @property
     def is_string_type(self):
-        return self.base_type_name in STRING_TYPES
+        return self.inner_name in STRING_TYPES
 
     @property
     def may_raise_exception_on_conversion(self):
         return (self.is_integer_type or
                 self.name in ('ByteString', 'ScalarValueString'))
 
     @property
     def is_union_type(self):
         return isinstance(self, IdlUnionType)
 
     @property
-    def base_type_name(self):
+    def inner_name(self):
+        """Return type name (or inner type name if nullable)
+
+        http://heycam.github.io/webidl/#dfn-type-name
+        """
         base_type = self.base_type
         return TYPE_NAMES.get(base_type, base_type)
 
-    @property
-    def name(self):
-        """Return type name.
-
-        http://heycam.github.io/webidl/#dfn-type-name
-        """
-        base_type_name = self.base_type_name
-        if self.is_array:
-            return base_type_name + 'Array'
-        if self.is_sequence:
-            return base_type_name + 'Sequence'
-        if self.is_nullable:
-            return base_type_name + 'OrNull'
-        return base_type_name
-
     @classmethod
     def set_callback_functions(cls, new_callback_functions):
         cls.callback_functions.update(new_callback_functions)
 
     @classmethod
     def set_callback_interfaces(cls, new_callback_interfaces):
         cls.callback_interfaces.update(new_callback_interfaces)
 
     @classmethod
     def set_dictionaries(cls, new_dictionaries):
         cls.dictionaries.update(new_dictionaries)
 
     @classmethod
     def set_enums(cls, new_enums):
         cls.enums.update(new_enums)
 
     def resolve_typedefs(self, typedefs):
+        # This function either returns |self|, possibly mutated, or leaves this
+        # object unmodified and returns a different object.
         if self.base_type not in typedefs:
             return self
         new_type = typedefs[self.base_type]
         if type(new_type) != type(self):
             # If type changes, need to return a different object,
             # since can't change type(self)
             return new_type
         # If type doesn't change, just mutate self to avoid a new object
-        # FIXME: a bit ugly; use __init__ instead of setting flags
-        self.base_type = new_type.base_type
-        # handle array both in use and in typedef itself:
-        # typedef Type TypeDef;
-        # TypeDef[] ...
-        # and:
-        # typedef Type[] TypeArray
-        # TypeArray ...
-        self.is_array |= new_type.is_array
-        self.is_sequence |= new_type.is_sequence
+        self.__init__(new_type.base_type, self.is_nullable or new_type.is_nullable)
         return self
 
 
 ################################################################################
 # IdlUnionType
 ################################################################################
 
 class IdlUnionType(IdlTypeBase):
     # http://heycam.github.io/webidl/#idl-union
     def __init__(self, member_types, is_nullable=False):
         super(IdlUnionType, self).__init__(is_nullable=is_nullable)
         self.member_types = member_types
 
     @property
     def is_union_type(self):
         return True
 
     @property
-    def name(self):
+    def inner_name(self):
+        """Return type name (or inner type name if nullable)
+
+        http://heycam.github.io/webidl/#dfn-type-name
+        """
         return 'Or'.join(member_type.name for member_type in self.member_types)
 
     def resolve_typedefs(self, typedefs):
         self.member_types = [
             typedefs.get(member_type, member_type)
             for member_type in self.member_types]
         return self
+
+
+################################################################################
+# IdlArrayOrSequenceType, IdlArrayType, IdlSequenceType
+################################################################################
+
+class IdlArrayOrSequenceType(IdlTypeBase):
+    """Base class for IdlArrayType and IdlSequenceType."""
+
+    def __init__(self, element_type, is_nullable=False):
+        super(IdlArrayOrSequenceType, self).__init__(is_nullable)
+        self.element_type = element_type
+
+    def resolve_typedefs(self, typedefs):
+        self.element_type = self.element_type.resolve_typedefs(typedefs)
+        return self
+
+
+class IdlArrayType(IdlArrayOrSequenceType):
+    def __init__(self, element_type, is_nullable=False):
+        super(IdlArrayType, self).__init__(element_type, is_nullable)
+        self.is_array = True
+
+    @property
+    def inner_string(self):
+        return '%s[]' % self.element_type
+
+    @property
+    def inner_name(self):
+        return self.element_type.name + 'Array'
+
+
+class IdlSequenceType(IdlArrayOrSequenceType):
+    def __init__(self, element_type, is_nullable=False):
+        super(IdlSequenceType, self).__init__(element_type, is_nullable)
+        self.is_array = True

[haraken, 2014/08/14 15:51:34]

This should be:

  self.is_sequence = True

[Jens Widell, 2014/08/14 16:03:18]

Oups! Fixed.

That had no effect on code generation, evidently. Good to know. :-)

[Nils Barth (inactive), 2014/08/14 16:18:55]

Actually, could you try removing is_array and is_sequence?
Now that you have separate classes and have patched the necessary methods,
you may not need these flags!

+
+    @property
+    def inner_string(self):
+        return 'sequence<%s>' % self.element_type
+
+    @property
+    def inner_name(self):
+        return self.element_type.name + 'Sequence'