aboutsummaryrefslogtreecommitdiffstats
path: root/pyGHDL/libghdl
diff options
context:
space:
mode:
Diffstat (limited to 'pyGHDL/libghdl')
-rw-r--r--pyGHDL/libghdl/__init__.py27
-rw-r--r--pyGHDL/libghdl/flags.py30
-rw-r--r--pyGHDL/libghdl/libraries.py13
-rw-r--r--pyGHDL/libghdl/vhdl/nodes.py12
-rw-r--r--pyGHDL/libghdl/vhdl/std_package.py18
5 files changed, 83 insertions, 17 deletions
diff --git a/pyGHDL/libghdl/__init__.py b/pyGHDL/libghdl/__init__.py
index 2cf9cff70..2be39d1d6 100644
--- a/pyGHDL/libghdl/__init__.py
+++ b/pyGHDL/libghdl/__init__.py
@@ -10,11 +10,9 @@
# Tristan Gingold
# Patrick Lehmann
#
-# Package package: Python binding and low-level API for shared library 'libghdl'.
-#
# License:
# ============================================================================
-# Copyright (C) 2019-2021 Tristan Gingold
+# Copyright (C) 2019-2022 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
@@ -31,6 +29,11 @@
#
# SPDX-License-Identifier: GPL-2.0-or-later
# ============================================================================
+"""
+Python binding and low-level API for shared library ``libghdl``.
+
+In case of an error, a :exc:`LibGHDLException` is raised.
+"""
from ctypes import c_char_p, CDLL
from sys import platform as sys_platform, version_info as sys_version_info
from os import environ as os_environ
@@ -48,9 +51,12 @@ from pyGHDL import __version__ as ghdlVersion
Nullable = Optional
+__all__ = ["ENCODING"]
+
ENCODING = "latin-1"
+@export
class LibGHDLException(GHDLBaseException):
_internalErrors: Nullable[List[str]]
@@ -63,6 +69,7 @@ class LibGHDLException(GHDLBaseException):
return self._internalErrors
+@export
def _get_libghdl_name() -> Path:
"""Get the name of the libghdl library (with version and extension)."""
version = ghdlVersion.replace("-", "_").replace(".", "_")
@@ -70,6 +77,7 @@ def _get_libghdl_name() -> Path:
return Path(f"libghdl-{version}.{ext}")
+@export
def _check_libghdl_libdir(libdir: Path, basename: Path) -> Path:
"""Returns libghdl path in :obj:`libdir`, if found."""
if libdir is None:
@@ -82,6 +90,7 @@ def _check_libghdl_libdir(libdir: Path, basename: Path) -> Path:
raise FileNotFoundError(str(res))
+@export
def _check_libghdl_bindir(bindir: Path, basename: Path) -> Path:
if bindir is None:
raise ValueError("Parameter 'bindir' is None.")
@@ -89,11 +98,12 @@ def _check_libghdl_bindir(bindir: Path, basename: Path) -> Path:
return _check_libghdl_libdir((bindir / "../lib").resolve(), basename)
+@export
def _get_libghdl_path():
"""\
Locate the directory where the shared library is installed.
- Search order:
+ **Search order:**
1. `GHDL_PREFIX` - directory (prefix) of the vhdl libraries.
2. `VUNIT_GHDL_PATH` - path of the `ghdl` binary when using VUnit.
@@ -145,6 +155,7 @@ def _get_libghdl_path():
raise Exception(f"Cannot find libghdl {basename}")
+@export
def _initialize():
# Load the shared library
_libghdl_path = _get_libghdl_path()
@@ -192,15 +203,15 @@ def initialize() -> None:
@export
# @BindToLibGHDL("libghdl__set_option")
-def set_option(Opt: str) -> bool:
+def set_option(opt: str) -> bool:
"""\
Set option :obj:`opt`.
- :param Opt: Option to set.
+ :param opt: Option to set.
:return: Return ``True``, if the option is known and handled.
"""
- Opt = Opt.encode(ENCODING)
- return libghdl.libghdl__set_option(c_char_p(Opt), len(Opt)) == 0
+ opt = opt.encode(ENCODING)
+ return libghdl.libghdl__set_option(c_char_p(opt), len(opt)) == 0
@export
diff --git a/pyGHDL/libghdl/flags.py b/pyGHDL/libghdl/flags.py
index fadd3bb52..dc5da6d60 100644
--- a/pyGHDL/libghdl/flags.py
+++ b/pyGHDL/libghdl/flags.py
@@ -33,25 +33,53 @@
# ============================================================================
from ctypes import c_bool, sizeof
+from enum import unique, IntEnum
+
+from pyTooling.Decorators import export
from pyGHDL.libghdl import libghdl
__all__ = [
"Flag_Elocations",
"Verbose",
+ "MB_Comment",
+ "Explicit",
+ "Relaxed",
"Flag_Elaborate_With_Outdated",
"Flag_Force_Analysis",
+ "AMS_Vhdl",
"Flag_Gather_Comments",
]
assert sizeof(c_bool) == 1
+
+@export
+@unique
+class VhdlStandard(IntEnum):
+ """An enumeration representing libghdl's internal ``Vhdl_Std_Type`` enumeration type."""
+
+ Vhdl_87 = 0 #: VHDL'87
+ Vhdl_93 = 1 #: VHDL'93
+ Vhdl_00 = 2 #: VHDL'2000
+ Vhdl_02 = 3 #: VHDL'2002
+ Vhdl_08 = 4 #: VHDL'2008
+ Vhdl_19 = 5 #: VHDL'2019
+
+
Flag_Elocations = c_bool.in_dll(libghdl, "flags__flag_elocations")
-Verbose = c_bool.in_dll(libghdl, "flags__verbose")
+Verbose = c_bool.in_dll(libghdl, "flags__verbose") #: Internal boolean flag representing :option:`-v`.
+MB_Comment = c_bool.in_dll(libghdl, "flags__mb_comment") #: Internal boolean flag representing :option:`--mb-comment`.
+Explicit = c_bool.in_dll(libghdl, "flags__flag_explicit") #: Internal boolean flag representing :option:`-fexplicit`.
+Relaxed = c_bool.in_dll(
+ libghdl, "flags__flag_relaxed_rules"
+) #: Internal boolean flag representing :option:`-frelaxed`.
Flag_Elaborate_With_Outdated = c_bool.in_dll(libghdl, "flags__flag_elaborate_with_outdated")
Flag_Force_Analysis = c_bool.in_dll(libghdl, "flags__flag_force_analysis")
+AMS_Vhdl = c_bool.in_dll(libghdl, "flags__ams_vhdl") #: Internal boolean flag representing :option:`-ams`.
+
Flag_Gather_Comments = c_bool.in_dll(libghdl, "flags__flag_gather_comments")
diff --git a/pyGHDL/libghdl/libraries.py b/pyGHDL/libghdl/libraries.py
index fe09fa920..f31d3ec5f 100644
--- a/pyGHDL/libghdl/libraries.py
+++ b/pyGHDL/libghdl/libraries.py
@@ -50,15 +50,18 @@ __all__ = ["Library_Location", "Work_Library"]
Library_Location: LocationType = c_int32.in_dll(libghdl, "libraries__library_location")
"""
-A location for library declarations (such as library WORK). Use ``.value`` to
-access this variable inside libghdl.
+A location for library declarations (such as library WORK).
+
+Use the property ``.value`` to access the variable's value.
"""
Work_Library: Iir_Library_Declaration = 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'. Use ``.value`` to
-access this variable inside libghdl.
+Library declaration for the work library.
+
+.. note:: The identifier of the work_library is ``work_library_name``, which may be different from 'WORK'.
+
+Use the property ``.value`` to access the variable's value.
"""
diff --git a/pyGHDL/libghdl/vhdl/nodes.py b/pyGHDL/libghdl/vhdl/nodes.py
index f662ad6a7..d5a8d8e80 100644
--- a/pyGHDL/libghdl/vhdl/nodes.py
+++ b/pyGHDL/libghdl/vhdl/nodes.py
@@ -29,7 +29,19 @@ from pyGHDL.libghdl._types import (
)
from pyGHDL.libghdl.vhdl.tokens import Tok
+__all__ = [
+ "Null_Iir",
+ "Null_Iir_List",
+ "Iir_List_All",
+ "Null_Iir_Flist",
+ "Iir_Flist_Others",
+ "Iir_Flist_All",
+]
+
Null_Iir = 0
+"""
+Null element for an IIR node reference.
+"""
Null_Iir_List = 0
Iir_List_All = 1
diff --git a/pyGHDL/libghdl/vhdl/std_package.py b/pyGHDL/libghdl/vhdl/std_package.py
index f2c46385a..d9035779c 100644
--- a/pyGHDL/libghdl/vhdl/std_package.py
+++ b/pyGHDL/libghdl/vhdl/std_package.py
@@ -46,12 +46,24 @@ __all__ = ["Std_Location", "Standard_Package", "Character_Type_Definition"]
Std_Location: LocationType = c_int32.in_dll(libghdl, "vhdl__std_package__std_location")
-"""Virtual location for the ``std.standard`` package. Use ``.value`` to access this variable inside libghdl."""
+"""
+Virtual location for the ``std.standard`` package.
+
+Use the property ``.value`` to access the variable's value.
+"""
Standard_Package: Iir_Package_Declaration = c_int32.in_dll(libghdl, "vhdl__std_package__standard_package")
-"""Virtual package ``std.package``. Use ``.value`` to access this variable inside libghdl."""
+"""
+Virtual package ``std.package``.
+
+Use the property ``.value`` to access the variable's value.
+"""
Character_Type_Definition: Iir_Enumeration_Type_Definition = c_int32.in_dll(
libghdl, "vhdl__std_package__character_type_definition"
)
-"""Predefined character. Use ``.value`` to access this variable inside libghdl."""
+"""
+Predefined character.
+
+Use the property ``.value`` to access the variable's value.
+"""
generated by cgit v1.2.3 (git 2.25.1) at 2025-04-05 21:48:19 +0000