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
|
# =============================================================================
# ____ _ _ ____ _ _ _ _ _ _ _
# _ __ _ _ / ___| | | | _ \| | | (_) |__ __ _| |__ __| | |
# | '_ \| | | | | _| |_| | | | | | | | | '_ \ / _` | '_ \ / _` | |
# | |_) | |_| | |_| | _ | |_| | |___ _| | | |_) | (_| | | | | (_| | |
# | .__/ \__, |\____|_| |_|____/|_____(_)_|_|_.__/ \__, |_| |_|\__,_|_|
# |_| |___/ |___/
# =============================================================================
# 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_int, c_bool
from pydecor import export
from pyGHDL.libghdl import libghdl
from pyGHDL.libghdl._types import SourceFileEntry, NameId
from pyGHDL.libghdl._decorator import BindToLibGHDL
__all__ = ["Current_Token", "Flag_Comment"]
# This is a c_int, so you want to use its .value
Current_Token = c_int.in_dll(libghdl, "vhdl__scanner__current_token")
Flag_Comment = c_bool.in_dll(libghdl, "vhdl__scanner__flag_comment")
@export
@BindToLibGHDL("vhdl__scanner__set_file")
def Set_File(SourceFile: SourceFileEntry) -> None:
"""
Initialize the scanner with file :obj:`SourceFile`.
:param SourceFile: File to scan.
"""
@export
@BindToLibGHDL("vhdl__scanner__close_file")
def Close_File() -> None:
"""Finalize the scanner."""
@export
@BindToLibGHDL("vhdl__scanner__scan")
def Scan() -> None:
"""Get a new token."""
@export
@BindToLibGHDL("vhdl__scanner__get_current_line")
def Get_Current_Line() -> int:
"""
Get the current location, or the location of the current token.
Since a token cannot spread over lines, file and line of the current token are
the same as those of the current position. The offset is the offset in the current line.
:return: Current token's line.
"""
@export
@BindToLibGHDL("vhdl__scanner__get_token_offset")
def Get_Token_Offset() -> int:
"""
Get the current token's offset in the current line.
:return: Current token's offset.
"""
@export
@BindToLibGHDL("vhdl__scanner__get_token_position")
def Get_Token_Position():
"""
Get the current token's position.
:return: Current token's position. Type: ``Source_Ptr``
"""
@export
@BindToLibGHDL("vhdl__scanner__get_position")
def Get_Position():
"""
Get the current position.
:return: Current position. Type: ``Source_Ptr``
"""
@export
@BindToLibGHDL("vhdl__scanner__current_identifier")
def Current_Identifier() -> NameId:
"""
When :attr:`~pyGHDL.libghdl.vhdl.scanner.Current_Token` is an
``tok_identifier``, ``tok_char`` or ``tok_string``, its name_id can be
retrieved via this function.
:return: NameId of the current token.
"""
|
