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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
# =============================================================================
# ____ _ _ ____ _ _ _ _ _ _ _
# _ __ _ _ / ___| | | | _ \| | | (_) |__ __ _| |__ __| | |
# | '_ \| | | | | _| |_| | | | | | | | | '_ \ / _` | '_ \ / _` | |
# | |_) | |_| | |_| | _ | |_| | |___ _| | | |_) | (_| | | | | (_| | |
# | .__/ \__, |\____|_| |_|____/|_____(_)_|_|_.__/ \__, |_| |_|\__,_|_|
# |_| |___/ |___/
# =============================================================================
# Authors:
# Tristan Gingold
# Patrick Lehmann
#
# Package module: Python binding and low-level API for shared library 'libghdl'.
#
# License:
# ============================================================================
# Copyright (C) 2019-2021 Tristan Gingold
#
# This program 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 of the License, or
# (at your option) any later version.
#
# This program 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 this program. If not, see <gnu.org/licenses>.
#
# SPDX-License-Identifier: GPL-2.0-or-later
# ============================================================================
from ctypes import c_int32, c_bool, POINTER, Structure
from pydecor import export
from pyGHDL.libghdl import libghdl
from pyGHDL.libghdl._decorator import BindToLibGHDL
@export
class Iterator(Structure):
_fields_ = [("chunk", c_int32), ("chunk_idx", c_int32), ("remain", c_int32)]
@export
@BindToLibGHDL("vhdl__lists__iterate")
def Iterate(List: int) -> Iterator:
"""
Create an iterator for a given list.
The idiomatic way to iterate is:
.. code-block:: Python
It = Iterate(List)
while Is_Valid(It):
El = Get_Element(It)
# ...
Next(It)
:param List: List to create an iterator from.
:return: Iterator structure.
"""
@export
# @BindToLibGHDL("vhdl__lists__is_valid")
def Is_Valid(it: Iterator) -> bool:
"""
Check if iterator reached the end.
:param it: Iterator to check.
:return: ``False``, if iterator has reached the end.
"""
func = libghdl.vhdl__lists__is_valid
func.argstype = [POINTER(Iterator)]
func.restype = c_bool
return func(it)
@export
# @BindToLibGHDL("vhdl__lists__next")
def Next(it: Iterator) -> bool:
"""
Move iterator to the next element.
:param it: Iterator to increment.
:return: ``False``, if iterator has reached the end.
"""
func = libghdl.vhdl__lists__next
func.argstype = [POINTER(Iterator)]
func.restype = None
return func(it)
@export
# @BindToLibGHDL("vhdl__lists__get_element")
def Get_Element(it: Iterator) -> int:
"""
Get the current element from iterator.
:param it: Iterator the get the element from.
:return: The current element the iterator points to. Type: ``El_Type``
"""
func = libghdl.vhdl__lists__get_element
func.argstype = [POINTER(Iterator)]
func.restype = c_int32
return func(it)
@export
@BindToLibGHDL("vhdl__lists__get_nbr_elements")
def Get_Nbr_Elements(List: int) -> int:
"""
Return the number of elements in the list.
.. hint:: This is also 1 + the position of the last element.
:param List: The list to use.
:return: Number of list elements.
"""
@export
@BindToLibGHDL("vhdl__lists__create_list")
def Create_Iir_List() -> int:
"""
Create a list.
:return: undocumented; Type: ``List_Type``
"""
@export
@BindToLibGHDL("vhdl__lists__destroy_list")
def Destroy_Iir_List(List: int) -> None:
"""
Destroy a list.
:param List: List to destroy.
"""
|
