scripts.idlnode.IDLType Class Reference

Inheritance diagram for scripts.idlnode.IDLType:

Public Member Functions
	__init__ (self, ast, id=None)
Public Member Functions inherited from scripts.idlnode.IDLNode
	__repr__ (self)
	__eq__ (self, other)
	__hash__ (self)
	reset_id (self, newId)
	all (self, type_filter=None)
	to_dict (self)
	to_hash (self)

Public Attributes
	nullable
	id
Public Attributes inherited from scripts.idlnode.IDLNode
	id
	ext_attrs
	annotations
	members

Protected Member Functions
	_label_to_type (self, label, ast)
Protected Member Functions inherited from scripts.idlnode.IDLNode
	_extra_repr (self)
	_all_subnodes (self)
	_to_hashable (self, obj)
	_find_all (self, ast, label, max_results=sys.maxsize)
	_find_first (self, ast, label)
	_has (self, ast, label)
	_convert_label_to_field (self, label)
	_convert_all (self, ast, label, idlnode_ctor)
	_convert_first (self, ast, label, idlnode_ctor)
	_convert_ext_attrs (self, ast)
	_convert_annotations (self, ast)
	_convert_constants (self, ast, js_name)

Detailed Description

IDLType is used to describe constants, attributes and operations'
return and input types. IDLType matches AST labels such as ScopedName,
StringType, VoidType, IntegerType, etc.
NOTE: AST of None implies synthesize IDLType the id is passed in used by
    setlike.

Definition at line 654 of file idlnode.py.

Constructor & Destructor Documentation

__init__()

scripts.idlnode.IDLType.__init__	(		self,
			ast,
			id = None
	)

Initializes an IDLNode from a PegParser AST output.

Reimplemented from scripts.idlnode.IDLNode.

Definition at line 661 of file idlnode.py.

    def __init__(self, ast, id=None):
        global _unions_to_any
 
        IDLNode.__init__(self, ast, id)
 
        if not ast:
            # Support synthesized IDLType with no AST (e.g., setlike support).
            return
 
        self.nullable = self._has(ast, 'Nullable')
        # Search for a 'ScopedName' or any label ending with 'Type'.
        if isinstance(ast, list):
            self.id = self._find_first(ast, 'ScopedName')
            if not self.id:
                # FIXME: use regexp search instead
                def findType(ast):
                    for label, childAst in ast:
                        if label.endswith('Type'):
                            type = self._label_to_type(label, ast)
                            if type != 'sequence':
                                return type
                            type_ast = self._find_first(childAst, 'Type')
                            if not type_ast:
                                return type
                            return 'sequence<%s>' % findType(type_ast)
                    raise Exception('No type declaration found in %s' % ast)
 
                self.id = findType(ast)
            # TODO(terry): Remove array_modifiers id has [] appended, keep for old
            #              parsing.
            array_modifiers = self._find_first(ast, 'ArrayModifiers')
            if array_modifiers:
                self.id += array_modifiers
        elif isinstance(ast, tuple):
            (label, value) = ast
            if label == 'ScopedName':
                self.id = value
            else:
                self.id = self._label_to_type(label, ast)
        elif isinstance(ast, str):
            self.id = ast
        # New blink handling.
        elif ast.__module__ == "idl_types":
            if isinstance(ast, IdlType) or isinstance(ast, IdlArrayOrSequenceType) or \
               isinstance(ast, IdlNullableType):
                if isinstance(ast,
                              IdlNullableType) and ast.inner_type.is_union_type:
                    # Report of union types mapped to any.
                    if not (self.id in _unions_to_any):
                        _unions_to_any.append(self.id)
                    # TODO(terry): For union types use any otherwise type is unionType is
                    #              not found and is removed during merging.
                    self.id = 'any'
                else:
                    type_name = str(ast)
                    # TODO(terry): For now don't handle unrestricted types see
                    #              https://code.google.com/p/chromium/issues/detail?id=354298
                    type_name = type_name.replace('unrestricted ', '', 1)
 
                    # TODO(terry): Handled USVString as a DOMString.
                    type_name = type_name.replace('USVString', 'DOMString', 1)
                    type_name = type_name.replace('HTMLString', 'DOMString', 1)
 
                    # TODO(terry); WindowTimers setInterval/setTimeout overloads with a
                    #              Function type - map to any until the IDL uses union.
                    type_name = type_name.replace('Function', 'any', 1)
 
                    self.id = type_name
            else:
                # IdlUnionType
                if ast.is_union_type:
                    if not (self.id in _unions_to_any):
                        _unions_to_any.append(self.id)
                    # TODO(terry): For union types use any otherwise type is unionType is
                    #              not found and is removed during merging.
                    self.id = 'any'
                    # TODO(terry): Any union type e.g. 'type1 or type2 or type2',
                    #                            'typedef (Type1 or Type2) UnionType'
                    # Is a problem we need to extend IDLType and IDLTypeDef to handle more
                    # than one type.
                    #
                    # Also for typedef's e.g.,
                    #                 typedef (Type1 or Type2) UnionType
                    # should consider synthesizing a new interface (e.g., UnionType) that's
                    # both Type1 and Type2.
        if not self.id:
            print('>>>> __module__ %s' % ast.__module__)
            raise SyntaxError('Could not parse type %s' % (ast))
 

Member Function Documentation

_label_to_type()

scripts.idlnode.IDLType._label_to_type (   self,   label,   ast  )

protected

Definition at line 750 of file idlnode.py.

    def _label_to_type(self, label, ast):
        if label == 'LongLongType':
            label = 'long long'
        elif label.endswith('Type'):
            # Omit 'Type' suffix and lowercase the rest.
            label = '%s%s' % (label[0].lower(), label[1:-4])
 
        # Add unsigned qualifier.
        if self._has(ast, 'Unsigned'):
            label = 'unsigned %s' % label
        return label
 
 

Member Data Documentation

id

scripts.idlnode.IDLType.id

Definition at line 673 of file idlnode.py.

nullable

scripts.idlnode.IDLType.nullable

Definition at line 670 of file idlnode.py.

---

The documentation for this class was generated from the following file:

• third_party/dart-lang/sdk/tools/dom/scripts/idlnode.py