scripts.idlnode.IDLInterface Class Reference

Inheritance diagram for scripts.idlnode.IDLInterface:

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

Public Attributes
	id
	parents
	javascript_binding_name
	doc_js_name
	is_supplemental
	isMaplike
	isMaplike_ro
	maplike_key_value
	operations
	attributes
	constants
	is_no_interface_object
	is_fc_suppressed
Public Attributes inherited from scripts.idlnode.IDLNode
	id
	ext_attrs
	annotations
	members

Additional Inherited Members
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

IDLInterface node contains operations, attributes, constants,
as well as parent references.

Definition at line 916 of file idlnode.py.

Constructor & Destructor Documentation

__init__()

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

Initializes an IDLNode from a PegParser AST output.

Reimplemented from scripts.idlnode.IDLNode.

Definition at line 920 of file idlnode.py.

    def __init__(self, ast, id=None):
        IDLNode.__init__(self, ast)
 
        if id:
            self.id = id
 
        self._convert_ext_attrs(ast)
        self._convert_annotations(ast)
 
        self.parents = self._convert_all(ast, 'ParentInterface',
                                         IDLParentInterface)
 
        javascript_interface_name = self.ext_attrs.get('InterfaceName', self.id)
        self.javascript_binding_name = javascript_interface_name
        self.doc_js_name = javascript_interface_name
 
        if not (self._find_first(ast, 'Callback') is None):
            self.ext_attrs['Callback'] = None
        if not (self._find_first(ast, 'Partial') is None):
            self.is_supplemental = True
            self.ext_attrs['DartSupplemental'] = None
        self.isMaplike = False
        self.isMaplike_ro = False
        self.maplike_key_value = [None, None]
        if ast is not None and ast.maplike is not None:
            self.isMaplike = True
            self.isMaplike_ro = ast.maplike.is_read_only
            self.maplike_key_value = [
                IDLType(ast.maplike.key_type),
                IDLType(ast.maplike.value_type)
            ]
 
        self.operations = self._convert_all(
            ast, 'Operation', lambda ast: IDLOperation(ast, self.doc_js_name))
 
        if not (id) and ast.setlike:
            setlike_ops = generate_setLike_operations_properties(
                self, ast.setlike)
            for op in setlike_ops:
                self.operations.append(op)
 
        self.attributes = self._convert_all(
            ast, 'Attribute', lambda ast: IDLAttribute(ast, self.doc_js_name))
        self.constants = self._convert_all(
            ast, 'Const', lambda ast: IDLConstant(ast, self.doc_js_name))
        self.is_supplemental = 'DartSupplemental' in self.ext_attrs
        self.is_no_interface_object = 'NoInterfaceObject' in self.ext_attrs
        # TODO(terry): Can eliminate Suppressed when we're only using blink parser.
        self.is_fc_suppressed = 'Suppressed' in self.ext_attrs or \
                                'DartSuppress' in self.ext_attrs
 

Member Function Documentation

has_attribute()

scripts.idlnode.IDLInterface.has_attribute	(		self,
			candidate
	)

Definition at line 984 of file idlnode.py.

    def has_attribute(self, candidate):
        for attribute in self.attributes:
            if (attribute.id == candidate.id and
                    attribute.is_read_only == candidate.is_read_only):
                return True
        return False
 
 

reset_id()

scripts.idlnode.IDLInterface.reset_id	(		self,
			new_id
	)

Reset the id of the Interface and corresponding the JS names.

Reimplemented from scripts.idlnode.IDLNode.

Definition at line 971 of file idlnode.py.

    def reset_id(self, new_id):
        """Reset the id of the Interface and corresponding the JS names."""
        if self.id != new_id:
            self.id = new_id
            self.doc_js_name = new_id
            self.javascript_binding_name = new_id
            for member in self.operations:
                member.doc_js_interface_name = new_id
            for member in self.attributes:
                member.doc_js_interface_name = new_id
            for member in self.constants:
                member.doc_js_interface_name = new_id
 

Member Data Documentation

attributes

scripts.idlnode.IDLInterface.attributes

Definition at line 961 of file idlnode.py.

constants

scripts.idlnode.IDLInterface.constants

Definition at line 963 of file idlnode.py.

doc_js_name

scripts.idlnode.IDLInterface.doc_js_name

Definition at line 934 of file idlnode.py.

id

scripts.idlnode.IDLInterface.id

Definition at line 924 of file idlnode.py.

is_fc_suppressed

scripts.idlnode.IDLInterface.is_fc_suppressed

Definition at line 968 of file idlnode.py.

is_no_interface_object

scripts.idlnode.IDLInterface.is_no_interface_object

Definition at line 966 of file idlnode.py.

is_supplemental

scripts.idlnode.IDLInterface.is_supplemental

Definition at line 939 of file idlnode.py.

isMaplike

scripts.idlnode.IDLInterface.isMaplike

Definition at line 941 of file idlnode.py.

isMaplike_ro

scripts.idlnode.IDLInterface.isMaplike_ro

Definition at line 942 of file idlnode.py.

javascript_binding_name

scripts.idlnode.IDLInterface.javascript_binding_name

Definition at line 933 of file idlnode.py.

maplike_key_value

scripts.idlnode.IDLInterface.maplike_key_value

Definition at line 943 of file idlnode.py.

operations

scripts.idlnode.IDLInterface.operations

Definition at line 952 of file idlnode.py.

parents

scripts.idlnode.IDLInterface.parents

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