Inheritance diagram for scripts.idlnode.IDLNode:

Public Member Functions
	__init__ (self, ast, id=None)

	__repr__ (self)

	__eq__ (self, other)

	__hash__ (self)

	reset_id (self, newId)

	all (self, type_filter=None)

	to_dict (self)

	to_hash (self)

Public Attributes
	id

	ext_attrs

	annotations

	members

Protected Member Functions
	_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

Base class for all IDL elements.
IDLNode may contain various child nodes, and have properties. Examples
of IDLNode are interfaces, interface members, function arguments,
etc.

Definition at line 59 of file idlnode.py.

Constructor & Destructor Documentation

◆ init()

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

Initializes an IDLNode from a PegParser AST output.

Definition at line 66 of file idlnode.py.

    def __init__(self, ast, id=None):
        """Initializes an IDLNode from a PegParser AST output."""
        if ast:
            self.id = self._find_first(ast, 'Id') if ast is not None else None
        else:
            # Support synthesized IDLNode created w/o an AST (e.g., setlike support).
            self.id = id
 

Member Function Documentation

◆ eq()

scripts.idlnode.IDLNode.__eq__	(	self,
		other
	)

Override default equals operation.
IDLNodes are equal if all their properties are equal.

Definition at line 92 of file idlnode.py.

    def __eq__(self, other):
        """Override default equals operation.
    IDLNodes are equal if all their properties are equal."""
        if other is None or not isinstance(other, IDLNode):
            return 1
        return self.__dict__.__eq__(other.__dict__)
 

◆ hash()

scripts.idlnode.IDLNode.__hash__ ( self )

Define default hashing behavior.
In order to comply with a == b => hash(a) == hash(b), we recursively iterate
self.__dict__ and convert all objects to hashable objects.

Definition at line 99 of file idlnode.py.

    def __hash__(self):
        """Define default hashing behavior.
    In order to comply with a == b => hash(a) == hash(b), we recursively iterate
    self.__dict__ and convert all objects to hashable objects."""
        return self.to_hash()
 

◆ repr()

scripts.idlnode.IDLNode.__repr__ ( self )

Generates string of the form <class id extra extra ... 0x12345678>.

Reimplemented in scripts.idlnode.IDLOperation, and scripts.idlnode.IDLArgument.

Definition at line 74 of file idlnode.py.

    def __repr__(self):
        """Generates string of the form <class id extra extra ... 0x12345678>."""
        extras = self._extra_repr()
        if isinstance(extras, list):
            extras = ' '.join([str(e) for e in extras])
        try:
            if self.id:
                return '<%s %s 0x%x>' % (type(self).__name__,
                                         ('%s %s' % (self.id, extras)).strip(),
                                         hash(self))
            return '<%s %s 0x%x>' % (type(self).__name__, extras, hash(self))
        except Exception as e:
            return "can't convert to string: %s" % e
 

◆ _all_subnodes()

scripts.idlnode.IDLNode._all_subnodes ( self )

protected

Accessor used by all() to find subnodes.

Reimplemented in scripts.idlnode.IDLDictNode, and scripts.idlnode.IDLExtAttrs.

Definition at line 130 of file idlnode.py.

    def _all_subnodes(self):
        """Accessor used by all() to find subnodes."""
        return self.__dict__.values()
 

◆ _convert_all()

scripts.idlnode.IDLNode._convert_all	(	self,
		ast,
		label,
		idlnode_ctor
	)

protected

Converts AST elements into IDLNode elements.
Uses _find_all to find elements with a given label and converts
them into IDLNodes with a given constructor.
Returns:
A list of the converted nodes.
Args:
ast -- the ast element to start a search at.
label -- the element label to look for.
idlnode_ctor -- a constructor function of one of the IDLNode
sub-classes.

Definition at line 306 of file idlnode.py.

    def _convert_all(self, ast, label, idlnode_ctor):
        """Converts AST elements into IDLNode elements.
    Uses _find_all to find elements with a given label and converts
    them into IDLNodes with a given constructor.
    Returns:
      A list of the converted nodes.
    Args:
      ast -- the ast element to start a search at.
      label -- the element label to look for.
      idlnode_ctor -- a constructor function of one of the IDLNode
        sub-classes.
    """
        res = []
        found = self._find_all(ast, label)
        if not found:
            return res
        if not isinstance(found, list):
            raise RuntimeError("Expected list but %s found" % type(found))
        for childAst in found:
            converted = idlnode_ctor(childAst)
            res.append(converted)
        return res
 

◆ _convert_annotations()

scripts.idlnode.IDLNode._convert_annotations	(	self,
		ast
	)

protected

Helper method for uniform conversion of annotations.

Definition at line 340 of file idlnode.py.

    def _convert_annotations(self, ast):
        """Helper method for uniform conversion of annotations."""
        self.annotations = IDLAnnotations(ast)
 

◆ _convert_constants()

scripts.idlnode.IDLNode._convert_constants	(	self,
		ast,
		js_name
	)

protected

Helper method for uniform conversion of dictionary members.

Definition at line 344 of file idlnode.py.

    def _convert_constants(self, ast, js_name):
        """Helper method for uniform conversion of dictionary members."""
        self.members = IDLDictionaryMembers(ast, js_name)
 
 

◆ _convert_ext_attrs()

scripts.idlnode.IDLNode._convert_ext_attrs	(	self,
		ast
	)

protected

Helper method for uniform conversion of extended attributes.

Definition at line 336 of file idlnode.py.

    def _convert_ext_attrs(self, ast):
        """Helper method for uniform conversion of extended attributes."""
        self.ext_attrs = IDLExtAttrs(ast)
 

◆ _convert_first()

scripts.idlnode.IDLNode._convert_first	(	self,
		ast,
		label,
		idlnode_ctor
	)

protected

Like _convert_all, but only converts the first found results.

Definition at line 329 of file idlnode.py.

    def _convert_first(self, ast, label, idlnode_ctor):
        """Like _convert_all, but only converts the first found results."""
        childAst = self._find_first(ast, label)
        if not childAst:
            return None
        return idlnode_ctor(childAst)
 

◆ _convert_label_to_field()

scripts.idlnode.IDLNode._convert_label_to_field	(	self,
		label
	)

protected

Definition at line 270 of file idlnode.py.

    def _convert_label_to_field(self, label):
        label_field = {
            # Keys old AST names, Values Blink IdlInterface names.
            'ParentInterface': 'parent',
            'Id': 'name',
            'Interface': 'interfaces',
            'Callback_Function': 'callback_functions',
            'Callback': 'is_callback',
            'Partial': 'is_partial',
            'Operation': 'operations',
            'Attribute': 'attributes',
            'Const': 'constants',
            'Type': 'idl_type',
            'ExtAttrs': 'extended_attributes',
            'Special': 'specials',
            'ReturnType': 'idl_type',
            'Argument': 'arguments',
            'InterfaceType': 'name',
            'ConstExpr': 'value',
            'Static': 'is_static',
            'ReadOnly': 'is_read_only',
            'Optional': 'is_optional',
            'Nullable': 'is_nullable',
            'Enum': 'enumerations',
            'Annotation':
            '',  # TODO(terry): Ignore annotation used for database cache.
            'TypeDef': '',  # typedef in an IDL are already resolved.
            'Dictionary': 'dictionaries',
            'Member': 'members',
            'Default': 'default_value',  # Dictionary member default value
        }
        result = label_field.get(label)
        if result != '' and not (result):
            print('FATAL ERROR: AST mapping name not found %s.' % label)
        return result if result else ''
 

◆ _extra_repr()

scripts.idlnode.IDLNode._extra_repr ( self )

protected

Returns string of extra info for __repr__().

Reimplemented in scripts.idlnode.IDLOperation, and scripts.idlnode.IDLAttribute.

Definition at line 88 of file idlnode.py.

    def _extra_repr(self):
        """Returns string of extra info for __repr__()."""
        return ''
 

◆ _find_all()

scripts.idlnode.IDLNode._find_all	(	self,
		ast,
		label,
		max_results = `sys.maxsize`
	)

protected

Searches the AST for tuples with a given label. The PegParser
output is composed of lists and tuples, where the tuple 1st argument
is a label. If ast root is a list, will search recursively inside each
member in the list.

Args:
ast -- the AST to search.
label -- the label to look for.
res -- results are put into this list.
max_results -- maximum number of results.

Definition at line 191 of file idlnode.py.

    def _find_all(self, ast, label, max_results=sys.maxsize):
        """Searches the AST for tuples with a given label. The PegParser
    output is composed of lists and tuples, where the tuple 1st argument
    is a label. If ast root is a list, will search recursively inside each
    member in the list.
 
    Args:
      ast -- the AST to search.
      label -- the label to look for.
      res -- results are put into this list.
      max_results -- maximum number of results.
    """
        res = []
        if max_results <= 0:
            return res
 
        if isinstance(ast, list):
            for childAst in ast:
                if childAst and \
                   not(isinstance(childAst, dict)) and \
                   not(isinstance(childAst, str)) and \
                   not(isinstance(childAst, tuple)) and \
                   childAst.__module__ == "idl_definitions":
                    field_name = self._convert_label_to_field(label)
                    if hasattr(childAst, field_name):
                        field_value = getattr(childAst, field_name)
                        # It's an IdlType we need the string name of the type.
                        if field_name == 'idl_type':
                            field_value = getattr(field_value, 'base_type')
                        res.append(field_value)
                else:
                    sub_res = self._find_all(childAst, label,
                                             max_results - len(res))
                    res.extend(sub_res)
        elif isinstance(ast, tuple):
            (nodeLabel, value) = ast
            if nodeLabel == label:
                res.append(value)
        # TODO(terry): Seems bogus to check for so many things probably better to just
        #              pass in blink_compile and drive it off from that...
        elif (ast and not (isinstance(ast, dict)) and
              not (isinstance(ast, str)) and
              (ast.__module__ == "idl_definitions" or
               ast.__module__ == "idl_types")):
            field_name = self._convert_label_to_field(label)
            if hasattr(ast, field_name):
                field_value = getattr(ast, field_name)
                if field_value:
                    if label == 'Interface' or label == 'Enum' or label == "Dictionary":
                        for key in field_value:
                            value = field_value[key]
                            res.append(value)
                    elif isinstance(field_value, list):
                        for item in field_value:
                            res.append(item)
                    elif label == 'ParentInterface' or label == 'InterfaceType':
                        # Fetch the AST for the parent interface.
                        parent_idlnode = new_asts[field_value]
                        res.append(parent_idlnode.interfaces[field_value])
                    else:
                        res.append(field_value)
 
        return res
 

◆ _find_first()

scripts.idlnode.IDLNode._find_first	(	self,
		ast,
		label
	)

protected

Convenience method for _find_all(..., max_results=1).
Returns a single element instead of a list, or None if nothing
is found.

Definition at line 255 of file idlnode.py.

    def _find_first(self, ast, label):
        """Convenience method for _find_all(..., max_results=1).
    Returns a single element instead of a list, or None if nothing
    is found."""
        res = self._find_all(ast, label, max_results=1)
        if len(res):
            return res[0]
        return None
 

◆ _has()

scripts.idlnode.IDLNode._has	(	self,
		ast,
		label
	)

protected

Returns true if an element with the given label is
in the AST by searching for it.

Definition at line 264 of file idlnode.py.

    def _has(self, ast, label):
        """Returns true if an element with the given label is
    in the AST by searching for it."""
        return len(self._find_all(ast, label, max_results=1)) == 1
 

◆ _to_hashable()

scripts.idlnode.IDLNode._to_hashable	(	self,
		obj
	)

protected

Definition at line 165 of file idlnode.py.

    def _to_hashable(self, obj):
        # By default, lists and dicts are not hashable, and user-defined objects
        # are unordered. In order to make a consistent hash for a given object,
        # this converts unhashable types and sorts properties.
        if isinstance(obj, list):
            # Convert lists to tuples.
            new_obj = []
            for item in obj:
                new_obj.append(self._to_hashable(item))
            return tuple(new_obj)
        elif isinstance(obj, dict):
            # Convert dicts to frozensets of tuples.
            new_obj = set()
            # Sort to ensure fixed order.
            for (k2, v2) in sorted(obj.items(), key=MultitypeSortKey):
                new_obj.add((self._to_hashable(k2), self._to_hashable(v2)))
            return frozenset(new_obj)
        elif hasattr(obj, '__dict__'):
            items = []
            # Sort properties to ensure fixed order.
            for (k, v) in sorted(obj.__dict__.items(), key=MultitypeSortKey):
                items.append((k, self._to_hashable(v)))
            return tuple(items)
        else:
            return obj
 

◆ all()

scripts.idlnode.IDLNode.all	(	self,
		type_filter = `None`
	)

Returns a list containing this node and all it child nodes
(recursive).

Args:
type_filter -- can be used to limit the results to a specific
node type (e.g. IDLOperation).

Definition at line 110 of file idlnode.py.

    def all(self, type_filter=None):
        """Returns a list containing this node and all it child nodes
    (recursive).
 
    Args:
      type_filter -- can be used to limit the results to a specific
        node type (e.g. IDLOperation).
    """
        res = []
        if type_filter is None or isinstance(self, type_filter):
            res.append(self)
        for v in self._all_subnodes():
            if isinstance(v, IDLNode):
                res.extend(v.all(type_filter))
            elif isinstance(v, list):
                for item in v:
                    if isinstance(item, IDLNode):
                        res.extend(item.all(type_filter))
        return res
 

◆ reset_id()

scripts.idlnode.IDLNode.reset_id	(	self,
		newId
	)

Reset the id of the Node.  This is typically done during a normalization
phase (e.g., "DOMWindow" -> "Window").

Reimplemented in scripts.idlnode.IDLInterface.

Definition at line 105 of file idlnode.py.

    def reset_id(self, newId):
        """Reset the id of the Node.  This is typically done during a normalization
    phase (e.g., "DOMWindow" -> "Window")."""
        self.id = newId
 

◆ to_dict()

scripts.idlnode.IDLNode.to_dict ( self )

Converts the IDLNode and its children into a dictionary.
This method is useful mostly for debugging and pretty printing.

Reimplemented in scripts.idlnode.IDLDictNode.

Definition at line 134 of file idlnode.py.

    def to_dict(self):
        """Converts the IDLNode and its children into a dictionary.
    This method is useful mostly for debugging and pretty printing.
    """
        res = {}
        for (k, v) in self.__dict__.items():
            if v == None or v == False or v == [] or v == {}:
                # Skip empty/false members.
                continue
            elif isinstance(v, IDLDictNode) and not len(v):
                # Skip empty dict sub-nodes.
                continue
            elif isinstance(v, list):
                # Convert lists:
                new_v = []
                for sub_node in v:
                    if isinstance(sub_node, IDLNode):
                        # Convert sub-node:
                        new_v.append(sub_node.to_dict())
                    else:
                        new_v.append(sub_node)
                v = new_v
            elif isinstance(v, IDLNode):
                # Convert sub-node:
                v = v.to_dict()
            res[k] = v
        return res
 

◆ to_hash()

scripts.idlnode.IDLNode.to_hash ( self )

Definition at line 162 of file idlnode.py.

    def to_hash(self):
        return hash(self._to_hashable(self))
 

Member Data Documentation

◆ annotations

scripts.idlnode.IDLNode.annotations

Definition at line 342 of file idlnode.py.

◆ ext_attrs

scripts.idlnode.IDLNode.ext_attrs

Definition at line 338 of file idlnode.py.

◆ id

scripts.idlnode.IDLNode.id

Definition at line 69 of file idlnode.py.

◆ members

scripts.idlnode.IDLNode.members

Definition at line 346 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

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __eq__()

◆ __hash__()

◆ __repr__()

◆ _all_subnodes()

◆ _convert_all()

◆ _convert_annotations()

◆ _convert_constants()

◆ _convert_ext_attrs()

◆ _convert_first()

◆ _convert_label_to_field()

◆ _extra_repr()

◆ _find_all()

◆ _find_first()

◆ _has()

◆ _to_hashable()

◆ all()

◆ reset_id()

◆ to_dict()

◆ to_hash()

Member Data Documentation

◆ annotations

◆ ext_attrs

◆ id

◆ members

◆ init()

◆ eq()

◆ hash()

◆ repr()