eric6.Utilities.ClassBrowsers.idlclbr

Parse a CORBA IDL file and retrieve modules, interfaces, methods and attributes.

Parse enough of a CORBA IDL file to recognize module, interface and method definitions and to find out the superclasses of an interface as well as its attributes.

It is based on the Python class browser found in this package.

Global Attributes

SUPPORTED_TYPES

_commentsub

_getnext

_modules

_normalize

Classes

Attribute	Class to represent a CORBA IDL attribute.
Function	Class to represent a CORBA IDL function.
Interface	Class to represent a CORBA IDL interface.
Module	Class to represent a CORBA IDL module.
VisibilityMixin	Mixin class implementing the notion of visibility.

Functions

readmodule_ex

Read a CORBA IDL file and return a dictionary of classes, functions and modules.

Attribute

Class to represent a CORBA IDL attribute.

Derived from

ClbrBaseClasses.Attribute, VisibilityMixin

Class Attributes

None

Class Methods

None

Methods

Attribute

Constructor

Static Methods

None

Attribute (Constructor)

Attribute(module, name, file, lineno)

Constructor

module (str): name of the module containing this attribute
name (str): name of this attribute
file (str): filename containing this attribute
lineno (int): line number of the attribute definition

Function

Class to represent a CORBA IDL function.

Derived from

ClbrBaseClasses.Function, VisibilityMixin

Class Attributes

None

Class Methods

None

Methods

Function

Constructor

Static Methods

None

Function (Constructor)

Function(module, name, file, lineno, signature='', separator=', ')

Constructor

module (str): name of the module containing this function
name (str): name of this function
file (str): filename containing this function
lineno (int): line number of the function definition
signature (str): parameter list of the function
separator (str): string separating the parameters

Interface

Class to represent a CORBA IDL interface.

Derived from

ClbrBaseClasses.Class, VisibilityMixin

Class Attributes

None

Class Methods

None

Methods

Interface

Constructor

Static Methods

None

Interface (Constructor)

Interface(module, name, superClasses, file, lineno)

Constructor

module (str): name of the module containing this interface
name (str): name of this interface
superClasses (list of str): list of interface names this interface is inherited from
file (str): filename containing this interface
lineno (int): line number of the interface definition

Module

Class to represent a CORBA IDL module.

Derived from

ClbrBaseClasses.Module, VisibilityMixin

Class Attributes

None

Class Methods

None

Methods

Module

Constructor

Static Methods

None

Module (Constructor)

Module(module, name, file, lineno)

Constructor

module (str): name of the module containing this module
name (str): name of this module
file (str): filename containing this module
lineno (int): line number of the module definition

VisibilityMixin

Mixin class implementing the notion of visibility.

Derived from

ClbrBaseClasses.ClbrVisibilityMixinBase

Class Attributes

None

Class Methods

None

Methods

VisibilityMixin

Constructor

Static Methods

None

VisibilityMixin (Constructor)

VisibilityMixin()

Constructor

readmodule_ex

readmodule_ex(module, path=None)

Read a CORBA IDL file and return a dictionary of classes, functions and modules.

module (str): name of the CORBA IDL file
path (list of str): path the file should be searched in

Returns:: the resulting dictionary

Return Type:: dict

Home ⌂Doc Index ◂Up ▴