aboutsummaryrefslogtreecommitdiffstats
path: root/pyGHDL/dom/_Utils.py
blob: 1c109c9dc65650e634094e7647c2c9aa4b786a61 (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
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
# =============================================================================
#               ____ _   _ ____  _          _
#  _ __  _   _ / ___| | | |  _ \| |      __| | ___  _ __ ___
# | '_ \| | | | |  _| |_| | | | | |     / _` |/ _ \| '_ ` _ \
# | |_) | |_| | |_| |  _  | |_| | |___ | (_| | (_) | | | | | |
# | .__/ \__, |\____|_| |_|____/|_____(_)__,_|\___/|_| |_| |_|
# |_|    |___/
# =============================================================================
# Authors:
#   Patrick Lehmann
#
# Package module:   DOM: Interface items (e.g. generic or port)
#
# 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 pydecor import export

from pyGHDL.dom.Common import DOMException
from pyVHDLModel.VHDLModel import Mode

from pyGHDL.libghdl import LibGHDLException, name_table, files_map, errorout_memory
from pyGHDL.libghdl.vhdl import nodes
from pyGHDL.libghdl.vhdl.nodes import Null_Iir
from pyGHDL.libghdl._types import Iir
from pyGHDL.dom.Misc import Position


__all__ = []

__MODE_TRANSLATION = {
    nodes.Iir_Mode.In_Mode: Mode.In,
    nodes.Iir_Mode.Out_Mode: Mode.Out,
    nodes.Iir_Mode.Inout_Mode: Mode.InOut,
    nodes.Iir_Mode.Buffer_Mode: Mode.Buffer,
    nodes.Iir_Mode.Linkage_Mode: Mode.Linkage,
}


@export
def CheckForErrors() -> None:
    errorCount = errorout_memory.Get_Nbr_Messages()
    errors = []
    if errorCount != 0:
        for i in range(errorCount):
            rec = errorout_memory.Get_Error_Record(i + 1)
            fileName = name_table.Get_Name_Ptr(files_map.Get_File_Name(rec.file))
            message = errorout_memory.Get_Error_Message(i + 1)

            errors.append(
                "{file}:{line}:{column}: {msg}".format(
                    file=fileName, line=rec.line, column=rec.offset, msg=message
                )
            )

        raise DOMException("Error raised in libghdl.") from LibGHDLException(
            "libghdl: Internal error.", errors
        )


@export
def GetIirKindOfNode(node: Iir) -> nodes.Iir_Kind:
    """Return the kind of a node in the IIR tree."""

    if node == Null_Iir:
        raise ValueError("Parameter 'node' must not be 'Null_iir'.")

    kind: int = nodes.Get_Kind(node)
    return nodes.Iir_Kind(kind)


@export
def GetNameOfNode(node: Iir) -> str:
    """Return the python string from node :obj:`node` identifier."""

    if node == Null_Iir:
        raise ValueError("Parameter 'node' must not be 'Null_iir'.")

    identifier = nodes.Get_Identifier(node)
    return name_table.Get_Name_Ptr(identifier)


@export
def GetSelectedName(node: Iir):
    names = []
    kind = GetIirKindOfNode(node)
    if kind == nodes.Iir_Kind.Simple_Name:
        return GetNameOfNode(node)

    while kind != nodes.Iir_Kind.Simple_Name:
        names.append(GetNameOfNode(node))
        node = nodes.Get_Prefix(node)
        kind = GetIirKindOfNode(node)

    names.append(GetNameOfNode(node))

    return reversed(names)


@export
def GetModeOfNode(node: Iir) -> Mode:
    """Return the mode of a :obj:`node`."""

    if node == Null_Iir:
        raise ValueError("Parameter 'node' must not be 'Null_iir'.")

    try:
        return __MODE_TRANSLATION[nodes.Get_Mode(node)]
    except KeyError:
        raise LibGHDLException("Unknown mode.")


@export
def GetPositionOfNode(node: Iir) -> Position:
    """Return the source code position of a IIR node."""

    if node == Null_Iir:
        raise ValueError("Parameter 'node' must not be 'Null_iir'.")

    location = nodes.Get_Location(node)
    file = files_map.Location_To_File(location)
    fileName = name_table.Get_Name_Ptr(files_map.Get_File_Name(file))
    #    position = files_map.Location_File_To_Pos(location, file)
    line = files_map.Location_File_To_Line(location, file)
    column = files_map.Location_File_Line_To_Offset(location, file, line)

    return Position(fileName, line, column)