.. # Template modified by Patrick Lehmann * removed automodule on top, because private members are activated for autodoc (no doubled documentation). * Made sections like 'submodules' bold text, but no headlines to reduce number of ToC levels. ================= pyGHDL.dom.Symbol ================= .. automodule:: pyGHDL.dom.Symbol .. currentmodule:: pyGHDL.dom.Symbol **Classes** - :py:class:`Symbol`: Generic reference (name) to a language entity where no single, fixed - :py:class:`LibraryReferenceSymbol`: Represents a reference (name) to a library. - :py:class:`PackageReferenceSymbol`: Represents a reference (name) to a package. - :py:class:`ModeViewSymbol`: Represents a reference (name) to a mode view declaration. - :py:class:`SubprogramReferenceSymbol`: Represents a reference (name) to a subprogram (procedure or function). - :py:class:`ConfigurationSymbol`: Represents a reference (name) to a configuration declaration, e.g. in an entity aspect of a - :py:class:`SignalSymbol`: Represents a reference (name) to a signal, e.g. the target of a signal assignment. - :py:class:`VariableSymbol`: Represents a reference (name) to a variable, e.g. the target of a variable assignment. - :py:class:`ContextReferenceSymbol`: Represents a reference (name) to a context. - :py:class:`PackageMemberReferenceSymbol`: Represents a reference (name) to a package member. - :py:class:`AllPackageMembersReferenceSymbol`: Represents a reference (name) to all members in a package. - :py:class:`EntityInstantiationSymbol`: Represents a reference (name) to an entity in a direct entity instantiation. - :py:class:`ComponentInstantiationSymbol`: Represents a reference (name) to a component in a component instantiation. - :py:class:`ConfigurationInstantiationSymbol`: Represents a reference (name) to a configuration in a configuration instantiation. - :py:class:`EntitySymbol`: Represents a reference (name) to an entity in an architecture declaration. - :py:class:`ArchitectureSymbol`: An entity reference in an entity instantiation with architecture name. - :py:class:`PackageSymbol`: Represents a reference (name) to a package in a package body declaration. - :py:class:`SimpleSubtypeSymbol`: Represents a reference to a type or subtype by its type mark. - :py:class:`ConstrainedScalarSubtypeSymbol`: Represents a reference to a scalar subtype narrowed by a range. - :py:class:`ConstrainedArraySubtypeSymbol`: Represents a reference to an array subtype narrowed by index ranges. - :py:class:`ConstrainedRecordSubtypeSymbol`: Represents a reference to a record subtype with constrained elements. - :py:class:`RecordElementSymbol`: Represents a reference to a record element. - :py:class:`RangeAttributeSymbol`: A symbol referencing a range attribute, e.g. ``vector'range``. - :py:class:`SimpleObjectOrFunctionCallSymbol`: Represents a reference that is either an object or a parameterless function call. - :py:class:`IndexedObjectOrFunctionCallSymbol`: Represents a reference that is either an indexed object, a function call or a type conversion. --------------------- **Classes** .. autoclass:: Symbol :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__, __init_subclass__, __class_getitem__ .. rubric:: Inheritance .. inheritance-diagram:: Symbol :parts: 1 .. autoclass:: LibraryReferenceSymbol :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__, __init_subclass__, __class_getitem__ .. rubric:: Inheritance .. inheritance-diagram:: LibraryReferenceSymbol :parts: 1 .. autoclass:: PackageReferenceSymbol :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__, __init_subclass__, __class_getitem__ .. rubric:: Inheritance .. inheritance-diagram:: PackageReferenceSymbol :parts: 1 .. autoclass:: ModeViewSymbol :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__, __init_subclass__, __class_getitem__ .. rubric:: Inheritance .. inheritance-diagram:: ModeViewSymbol :parts: 1 .. autoclass:: SubprogramReferenceSymbol :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__, __init_subclass__, __class_getitem__ .. rubric:: Inheritance .. inheritance-diagram:: SubprogramReferenceSymbol :parts: 1 .. autoclass:: ConfigurationSymbol :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__, __init_subclass__, __class_getitem__ .. rubric:: Inheritance .. inheritance-diagram:: ConfigurationSymbol :parts: 1 .. autoclass:: SignalSymbol :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__, __init_subclass__, __class_getitem__ .. rubric:: Inheritance .. inheritance-diagram:: SignalSymbol :parts: 1 .. autoclass:: VariableSymbol :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__, __init_subclass__, __class_getitem__ .. rubric:: Inheritance .. inheritance-diagram:: VariableSymbol :parts: 1 .. autoclass:: ContextReferenceSymbol :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__, __init_subclass__, __class_getitem__ .. rubric:: Inheritance .. inheritance-diagram:: ContextReferenceSymbol :parts: 1 .. autoclass:: PackageMemberReferenceSymbol :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__, __init_subclass__, __class_getitem__ .. rubric:: Inheritance .. inheritance-diagram:: PackageMemberReferenceSymbol :parts: 1 .. autoclass:: AllPackageMembersReferenceSymbol :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__, __init_subclass__, __class_getitem__ .. rubric:: Inheritance .. inheritance-diagram:: AllPackageMembersReferenceSymbol :parts: 1 .. autoclass:: EntityInstantiationSymbol :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__, __init_subclass__, __class_getitem__ .. rubric:: Inheritance .. inheritance-diagram:: EntityInstantiationSymbol :parts: 1 .. autoclass:: ComponentInstantiationSymbol :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__, __init_subclass__, __class_getitem__ .. rubric:: Inheritance .. inheritance-diagram:: ComponentInstantiationSymbol :parts: 1 .. autoclass:: ConfigurationInstantiationSymbol :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__, __init_subclass__, __class_getitem__ .. rubric:: Inheritance .. inheritance-diagram:: ConfigurationInstantiationSymbol :parts: 1 .. autoclass:: EntitySymbol :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__, __init_subclass__, __class_getitem__ .. rubric:: Inheritance .. inheritance-diagram:: EntitySymbol :parts: 1 .. autoclass:: ArchitectureSymbol :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__, __init_subclass__, __class_getitem__ .. rubric:: Inheritance .. inheritance-diagram:: ArchitectureSymbol :parts: 1 .. autoclass:: PackageSymbol :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__, __init_subclass__, __class_getitem__ .. rubric:: Inheritance .. inheritance-diagram:: PackageSymbol :parts: 1 .. autoclass:: SimpleSubtypeSymbol :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__, __init_subclass__, __class_getitem__ .. rubric:: Inheritance .. inheritance-diagram:: SimpleSubtypeSymbol :parts: 1 .. autoclass:: ConstrainedScalarSubtypeSymbol :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__, __init_subclass__, __class_getitem__ .. rubric:: Inheritance .. inheritance-diagram:: ConstrainedScalarSubtypeSymbol :parts: 1 .. autoclass:: ConstrainedArraySubtypeSymbol :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__, __init_subclass__, __class_getitem__ .. rubric:: Inheritance .. inheritance-diagram:: ConstrainedArraySubtypeSymbol :parts: 1 .. autoclass:: ConstrainedRecordSubtypeSymbol :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__, __init_subclass__, __class_getitem__ .. rubric:: Inheritance .. inheritance-diagram:: ConstrainedRecordSubtypeSymbol :parts: 1 .. autoclass:: RecordElementSymbol :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__, __init_subclass__, __class_getitem__ .. rubric:: Inheritance .. inheritance-diagram:: RecordElementSymbol :parts: 1 .. autoclass:: RangeAttributeSymbol :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__, __init_subclass__, __class_getitem__ .. rubric:: Inheritance .. inheritance-diagram:: RangeAttributeSymbol :parts: 1 .. autoclass:: SimpleObjectOrFunctionCallSymbol :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__, __init_subclass__, __class_getitem__ .. rubric:: Inheritance .. inheritance-diagram:: SimpleObjectOrFunctionCallSymbol :parts: 1 .. autoclass:: IndexedObjectOrFunctionCallSymbol :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__, __init_subclass__, __class_getitem__ .. rubric:: Inheritance .. inheritance-diagram:: IndexedObjectOrFunctionCallSymbol :parts: 1