aboutsummaryrefslogtreecommitdiffstats
path: root/pyGHDL/libghdl/vhdl/flists.py
blob: 9cb3e211da1640c8b6b0a65f882cac41873f94e9 (plain)
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
# =============================================================================
#               ____ _   _ ____  _       _ _ _           _         _ _
#  _ __  _   _ / ___| | | |  _ \| |     | (_) |__   __ _| |__   __| | |
# | '_ \| | | | |  _| |_| | | | | |     | | | '_ \ / _` | '_ \ / _` | |
# | |_) | |_| | |_| |  _  | |_| | |___ _| | | |_) | (_| | | | | (_| | |
# | .__/ \__, |\____|_| |_|____/|_____(_)_|_|_.__/ \__, |_| |_|\__,_|_|
# |_|    |___/                                     |___/
# =============================================================================
#  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

from pydecor import export

from pyGHDL.libghdl import libghdl

__all__ = [
	'Flist_Type',
	'Ffirst'
]

Flist_Type = c_int32  #: First index of a ``FList``.

Ffirst = 0

@export
def Flast(FList) -> int:
	"""
	Last index of :obj:`FList`.

	.. hint:: Could be used to iterate.

	:param FList: List to query.
	:return:      Index of the last element in the list.
	"""
	return libghdl.vhdl__flists__flast(FList)


@export
def Length(FList) -> int:
	"""
	Get the length of :obj:`FList`.

	:param FList: List to query.
	:return:      Number of elements in the list.
	"""
	return libghdl.vhdl__flists__length(FList)


@export
def Get_Nth_Element(FList, N: int):
	"""
	Get the N-th element of :obj:`FList`.

	First element has index 0.

	:param FList: List to query.
	:return:      Type: ``El_Type``
	"""
	return libghdl.vhdl__flists__get_nth_element(FList, N)