Pyvhdlmodel

**Release created on: 02.04.2023 - 16:39:38**

New Features

* Added method, so Synopsys packages can be loaded into the `ieee` library.
(see 68 contributed by c-thaler)

Changes

* Bumped dependencies.

----------
Related PRs:

* 68

**Release created on: 27.03.2023 - 21:58:46**

New Features

* Added more properties to class `Package`.
* Distribute `py.typed` file.

Changes

* Adjusted to `pyTooling` v4.0+.
* Renamed `SubType`/`subType` to `Subtype`/`subtype`.
* Renamed `SubProgram` to `Subprogram`.
* Bumped dependencies.

Bug Fixes

*None*

----------
Related PRs:

*None*

**Release created on: 05.02.2023 - 22:29:12**

New Features

* Added property `Name` to `Design`.
* Improved calculation of property `Toplevel`.
* HierarchyGraph has now a `toplevel` attribute.
* Added instructions on how to use `pyVHDLModel` with `pyGHDL` as a parser.

Changes

* Improved and added more documentation.
* Started to document analysis procedure.
* Added empty sections to document the 3 internal graph data structures.
* Bumped dependencies.

Bug Fixes

* Restricted Sphinx to <6.0, so navigation is not broken due to docutils vs. RTD theme mismatch.
* Fixes to the pyGHDL setup instructions.
* Fixed some broken tables in ReST.

**Release created on: 11.01.2023 - 17:09:20**

Bug Fixes

* Fixed `pyTooling` dependency to be v2.11.0.

**Release created on: 11.01.2023 - 11:52:07**

New Features

* Restructured `SyntaxModel.py` into 18 files and removed it:
* `Association.py`
* `Base.py`
* `Common.py`
* `Concurrent.py`
* `Declaration.py`
* `DesignUnit.py`
* `Exception.py`
* `Expression.py`
* `Instantiation.py`
* `Interface.py`
* `Name.py`
* `Object.py`
* `PSLModel.py`
* `Scope.py`
* `Sequential.py`
* `Subprogram.py`
* `Symbol.py`
* `Type.py`
* Added base exception class `VHDLModelException`.
* Added case specific exceptions with context information:
* `LibraryExistsInDesignError`
* `LibraryRegisteredToForeignDesignError`
* `LibraryNotRegisteredError`
* `EntityExistsInLibraryError`
* `ArchitectureExistsInLibraryError`
* `PackageExistsInLibraryError`
* `PackageBodyExistsError`
* `ConfigurationExistsInLibraryError`
* `ContextExistsInLibraryError`
* `ReferencedLibraryNotExistingError`
* Added namespaces to VHDL entities with concurrent declaration regions.
* Added property `Entity` to `Component`.
* Handle component instantiations.
* Component declarations are indexed.
* Reference components via use clauses.
* Instantiation dependencies are now listed in the dependency graph.
* Implemented `ComputeHierarchy`:
* Derive the hierarchy graph from dependency graph.
* Implemented property `TopLevel`.
(Former method `GetTopLevel)`.)
* Added `CreateCompileOrderGraph` and `ComputeCompileOrder`:
* Derive the compile order graph from dependency graph.
* Implemented `IterateDocumentsInCompileOrder` to return a generator of documents in correct order.
* Added vertex attribute `"predefined"` to vertices in the dependency graph if it's a design unit from `std` or `ieee`.

Changes

* Removed old `Symbol` class and renamed the new symbol class `NewSymbol` to `Symbol`.
Thus there is again just one symbol class call `Symbol`.
* Changed `raise Exception(...)` to `raise VHDLModelException(...)`.
* Added doc-strings for names.
* Updated copyright to year 2023.

Bug Fixes

* Fixed `Name` when `prefix` parameter is None.
* Fixed Property name `Has_Prefix` to `HasPrefix` on `Name`.

----------
Related PRs:

* 61


**Release created on: 05.01.2023 - 17:25:55**

New Features

* Added method `GetAncestor` to `ModelEntity`.
* Added property `DependencyGraph` to `Design`.
* Added `_compileOrderGraph` and `_hierarchyGraph` fields as well as matching properties `CompileOrderGraph` and `HierarchyGraph` to `Design`.
* Added method `AddLibrary` to register a VHDL library in the design.
* Added method `CreateCompilerOrderGraph` on `Design`.
* Added key-value-pair `"kind" : DependencyGraphEdgeKind` on edges in the dependency graph.
* Implemented referencing library, package and context references in topological order to design units referencing a context.
* Added method `LinkInstanziations` on `Design`:
* Handle `EntityInstantiation` statements.
* Added dummy methods for:
* `ComputeHierarchy`
* `GetCompileOrder`
* `GetTopLevel`
* `GetUnusedDesignUnits`
* Added field `_compileOrderVertex` and property `CompileOrderVertex` to `Document`.
* Added property `DependencyVertex` to `Library`.
* Added generator `IterateDesignUnits` to `Document`.
* Added `__repr__` for design units.
* Added field `_blocks` to `ConcurrentStatements`.
* Added generator `IterateInstantiations` to `ConcurrentStatements`, `IfGenerateStatement` and `CaseGenerateStatement`.
* Added field `_hierarchyVertex` and property `HierarchyVertex` to `DesignUnit`.
* Added new "analyze" test cases to unit tests.

Changes

* Moved implementation of `DesignUnitWithContextMixin` to `DesignUnit`.
The fields `_contextItems`, `_libraryReferences`, `_packageReferences` and `_contextReferences` as well as matching properties and initializer codes are now in `DesignUnit`.
* `LoadStdLibrary` and `LoadIeeeLibrary` now return the created VHDL library object.
* When calling `AddDocument` on `Design`, check if used library is part of the design.
* Bumped dependencies.
* Updated shield URL for GitHub Actions.
* Removed fields `_declaredItems` and `_statements` from `Entity`.
(This is covered by `ConcurrentDeclarations` and `ConcurrentStatements`.)
* Change list of architectures for an entity to a dictionary for named lookups.
* Reworked `ComponentInstantiation`, `ConfigurationInstantiation` and `EntityInstantiation`.
* Extended flag members of `DependencyGraphEdgeKind` by references, instances and implementations.
* Improved instantiation test cases.

Bug Fixes

* Added missing "backward pointers" by setting `_parent` to appropriate values.
This was missing in the entire model.
(As this was a complete code walk-through, TODO and FIXME comments for potential problematic regions were added.)
* Fixed parameter names `_leftOperand` and `_rightOperand`, by removing the `_`.
* Added missing `Nullable` to type hints.
* Implemented missing field initialization code for `Package`.
* Fixed super call in `PackageBody.__init__`, `Configuration.__init__`, `Entity.__init__` and `Architecture.__init__`.
* Fixed `Package.Index`, now using `NormalizedLabel`.
* Removed property `DeclaredItems` from `Architecture`.
(This is covered by `ConcurrentDeclarations`.)
* Renamed parameters using `range` to `rng` to avoid overlap with Python builtins.