1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
# =============================================================================
# ____ _ _ ____ _ _ _ _ _ _ _
# _ __ _ _ / ___| | | | _ \| | | (_) |__ __ _| |__ __| | |
# | '_ \| | | | | _| |_| | | | | | | | | '_ \ / _` | '_ \ / _` | |
# | |_) | |_| | |_| | _ | |_| | |___ _| | | |_) | (_| | | | | (_| | |
# | .__/ \__, |\____|_| |_|____/|_____(_)_|_|_.__/ \__, |_| |_|\__,_|_|
# |_| |___/ |___/
# =============================================================================
# Authors: Tristan Gingold
# Patrick Lehmann
#
# Package module: Python binding and low-level API for shared library 'libghdl'.
#
# License:
# ============================================================================
# Copyright (C) 2019-2021 Tristan Gingold
#
# GHDL is free software; you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free
# Software Foundation; either version 2, or (at your option) any later
# version.
#
# GHDL is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
# for more details.
#
# You should have received a copy of the GNU General Public License
# along with GHDL; see the file COPYING. If not, write to the Free
# Software Foundation, 59 Temple Place - Suite 330, Boston, MA
# 02111-1307, USA.
#
# SPDX-License-Identifier: GPL-2.0-or-later
# ============================================================================
#
from ctypes import c_int32
from pydecor import export
from pyGHDL.libghdl import libghdl
__all__ = [
'Library_Location',
'Work_Library'
]
from pyGHDL.libghdl._types import NameId
Library_Location = c_int32.in_dll(libghdl, "libraries__library_location") #: A location for library declarations (such as library WORK). Type ``Location_Type``. Use ``.value`` to access this variable inside libghdl
Work_Library = c_int32.in_dll(libghdl, "libraries__work_library") #: Library declaration for the work library. Note: the identifier of the work_library is ``work_library_name``, which may be different from 'WORK'. Type: ``Iir_Library_Declaration``. Use ``.value`` to access this variable inside libghdl
@export
def Get_Libraries_Chain():
"""
Get the chain of libraries. Can be used only to read (it mustn't be modified).
:return: Type ``Iir_Library_Declaration``
"""
return libghdl.libraries__get_libraries_chain()
@export
def Add_Design_Unit_Into_Library(Unit, Keep_Obsolete: bool = False) -> None:
"""
Add or replace an design unit in the work library. DECL must not have a chain
(because it may be modified).
If the design_file of UNIT is not already in the library, a new one is created.
Units are always appended to the design_file. Therefore, the order is kept.
:param Unit: Type: ``Iir_Design_Unit``
:param Keep_Obsolete: If :obj:`Keep_Obsolete` is True, obsoleted units are
kept in the library.
This is used when a whole design file has to be added
in the library and then processed (without that feature,
redefined units would disappear).
"""
libghdl.libraries__add_design_unit_into_library(Unit, Keep_Obsolete)
@export
def Purge_Design_File(Design_File) -> None:
"""
Remove the same file as DESIGN_FILE from work library and all of its units.
:param Design_File: Type: ``Iir_Design_File``
"""
libghdl.libraries__purge_design_file(Design_File)
@export
def Find_Entity_For_Component(Name: NameId):
"""
Find an entity whose name is :obj:`Name` in any library. |br|
If there is no such entity, return :attr:`~pyGHDL.libghdl.vhdl.nodes.Null_Iir`. |br|
If there are several entities, return :attr:`~pyGHDL.libghdl.vhdl.nodes.Null_Iir`;
:param Name: Entity name to search for.
:return: Type: ``Iir_Design_Unit``
"""
return libghdl.libraries__find_entity_for_component(Name)
@export
def Get_Library_No_Create(Ident: NameId):
"""
Get the library named :obj:`Ident`.
:param Ident: Libryr to look for.
:return: Return :attr:`~pyGHDL.libghdl.vhdl.nodes.Null_Iir` if it doesn't exist. Type ``Iir_Library_Declaration``
"""
return libghdl.libraries__get_library_no_create(Ident)
@export
def Find_Primary_Unit(Library, Name: NameId):
"""
Just return the design_unit for :obj:`Name`, or ``NULL`` if not found.
:param Library: Library to look in. Type: ``Iir_Library_Declaration``
:param Name: Primary unit to search for.
:return: Type: ``Iir_Design_Unit``
"""
return libghdl.libraries__find_primary_unit(Library, Name)
|
