scripts.idlnode.IDLNode Class Reference

Inheritance diagram for scripts.idlnode.IDLNode:

Public Member Functions
def	__init__ (self, ast, id=None)
def	__repr__ (self)
def	__eq__ (self, other)
def	__hash__ (self)
def	reset_id (self, newId)
def	all (self, type_filter=None)
def	to_dict (self)
def	to_hash (self)

Public Attributes
	id
	ext_attrs
	annotations
	members

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__()

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

Initializes an IDLNode from a PegParser AST output.

Reimplemented in scripts.idlnode.IDLDictNode, scripts.idlnode.IDLModule, scripts.idlnode.IDLEnum, scripts.idlnode.IDLCallbackFunction, scripts.idlnode.IDLTypeDef, scripts.idlnode.IDLParentInterface, scripts.idlnode.IDLImplementsStatement, scripts.idlnode.IDLAttribute, scripts.idlnode.IDLConstant, scripts.idlnode.IDLDictionaryMember, scripts.idlnode.IDLOperation, scripts.idlnode.IDLMember, scripts.idlnode.IDLFile, scripts.idlnode.IDLType, scripts.idlnode.IDLInterface, scripts.idlnode.IDLArgument, scripts.idlnode.IDLDictionary, scripts.idlnode.IDLExtAttrs, scripts.idlnode.IDLAnnotations, scripts.idlnode.IDLAnnotation, scripts.idlnode.IDLDictionaryMembers, and scripts.idlnode.IDLExtAttrFunctionValue.

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__()

def 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__()

def 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__()

def 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()

def 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()

def 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()

def 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()

def 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