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 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
|
import ctypes
import logging
import os
import pyGHDL.libghdl.name_table as name_table
import pyGHDL.libghdl.files_map as files_map
import pyGHDL.libghdl.files_map_editor as files_map_editor
import pyGHDL.libghdl.libraries as libraries
import pyGHDL.libghdl.vhdl.nodes as nodes
import pyGHDL.libghdl.vhdl.sem_lib as sem_lib
import pyGHDL.libghdl.vhdl.sem as sem
import pyGHDL.libghdl.vhdl.formatters as formatters
import pyGHDL.libghdl.vhdl.prints as prints
import pyGHDL.libghdl.file_comments as file_comments
from . import symbols, references
log = logging.getLogger(__name__)
class Document(object):
# The encoding used for the files.
# Unfortunately this is not fully reliable. The client can read the
# file using its own view of the encoding. It then pass the document
# to the server using unicode(utf-8). Then the document is converted
# back to bytes using this encoding. And we hope the result would be
# the same as the file. Because VHDL uses the iso 8859-1 character
# set, we use the same encoding. The client should also use 8859-1.
encoding = "iso-8859-1"
initial_gap_size = 4096
def __init__(self, uri, sfe=None, lib=None, version=None):
self.uri = uri
self.version = version
self._fe = sfe
self.library = lib
self.gap_size = Document.initial_gap_size
self._tree = nodes.Null_Iir
@staticmethod
def load(src_bytes, dirname, filename):
# Write text to file buffer.
src_len = len(src_bytes)
buf_len = src_len + Document.initial_gap_size
fileid = name_table.Get_Identifier(filename)
if os.path.isabs(filename):
dirid = name_table.Null_Identifier
else:
dirid = name_table.Get_Identifier(dirname)
sfe = files_map.Reserve_Source_File(dirid, fileid, buf_len)
files_map_editor.Fill_Text(sfe, ctypes.c_char_p(src_bytes), src_len)
return sfe
def __extend_source_buffer(self, new_size):
self.gap_size *= 2
fileid = files_map.Get_File_Name(self._fe)
dirid = files_map.Get_Directory_Name(self._fe)
buf_len = files_map.Get_File_Length(self._fe) + new_size + self.gap_size
files_map.Discard_Source_File(self._fe)
new_sfe = files_map.Reserve_Source_File(dirid, fileid, buf_len)
files_map_editor.Copy_Source_File(new_sfe, self._fe)
files_map.Free_Source_File(self._fe)
self._fe = new_sfe
def reload(self, source):
"""Reload the source of a document."""
src_bytes = source.encode(Document.encoding, "replace")
l = len(src_bytes)
if l >= files_map.Get_Buffer_Length(self._fe):
self.__extend_source_buffer(l)
files_map_editor.Fill_Text(self._fe, ctypes.c_char_p(src_bytes), l)
def __str__(self):
return str(self.uri)
def apply_change(self, change):
"""Apply a change to the document."""
text = change["text"]
change_range = change.get("range")
text_bytes = text.encode(Document.encoding, "replace")
if not change_range:
# The whole file has changed
raise AssertionError
# if len(text_bytes) < libghdl.Files_Map.Get_Buffer_Length(self._fe):
# xxxx_replace
# else:
# xxxx_free
# xxxx_allocate
# return
start_line = change_range["start"]["line"]
start_col = change_range["start"]["character"]
end_line = change_range["end"]["line"]
end_col = change_range["end"]["character"]
status = files_map_editor._Replace_Text(
self._fe,
start_line + 1,
start_col,
end_line + 1,
end_col,
ctypes.c_char_p(text_bytes),
len(text_bytes),
)
if status:
return
# Failed to replace text.
# Increase size
self.__extend_source_buffer(len(text_bytes))
status = files_map_editor._Replace_Text(
self._fe,
start_line + 1,
start_col,
end_line + 1,
end_col,
ctypes.c_char_p(text_bytes),
len(text_bytes),
)
assert status
def check_document(self, text):
log.debug("Checking document: %s", self.uri)
text_bytes = text.encode(Document.encoding, "replace")
files_map_editor.Check_Buffer_Content(self._fe, ctypes.c_char_p(text_bytes), len(text_bytes))
@staticmethod
def add_to_library(tree, library):
# Set the target library
if library is None:
library = "work"
libraries.Work_Library_Name.value = name_table.Get_Identifier(library)
libraries.Load_Work_Library(False)
# Detach the chain of units.
unit = nodes.Get_First_Design_Unit(tree)
nodes.Set_First_Design_Unit(tree, nodes.Null_Iir)
# FIXME: free the design file ?
tree = nodes.Null_Iir
# Analyze unit after unit.
while unit != nodes.Null_Iir:
# Pop the first unit.
next_unit = nodes.Get_Chain(unit)
nodes.Set_Chain(unit, nodes.Null_Iir)
lib_unit = nodes.Get_Library_Unit(unit)
if lib_unit != nodes.Null_Iir and nodes.Get_Identifier(unit) != name_table.Null_Identifier:
# Put the unit (only if it has a library unit) in the library.
libraries.Add_Design_Unit_Into_Library(unit, False)
tree = nodes.Get_Design_File(unit)
unit = next_unit
return tree
def parse_document(self):
"""Parse a document and put the units in the library."""
assert self._tree == nodes.Null_Iir
tree = sem_lib.Load_File(self._fe)
if tree == nodes.Null_Iir:
return
self._tree = Document.add_to_library(tree, self.library)
log.debug("add_to_library(%u, '%s') -> %u", tree, self.library, self._tree)
if self._tree == nodes.Null_Iir:
return
nodes.Set_Design_File_Source(self._tree, self._fe)
def compute_diags(self):
log.debug("parse doc %d %s", self._fe, self.uri)
self.parse_document()
if self._tree == nodes.Null_Iir:
# No units, nothing to add.
return
# Semantic analysis.
unit = nodes.Get_First_Design_Unit(self._tree)
while unit != nodes.Null_Iir:
sem.Semantic(unit)
nodes.Set_Date_State(unit, nodes.DateStateType.Analyze)
unit = nodes.Get_Chain(unit)
def flatten_symbols(self, syms, parent):
res = []
for s in syms:
s["location"] = {"uri": self.uri, "range": s["range"]}
del s["range"]
s.pop("detail", None)
if parent is not None:
s["containerName"] = parent
res.append(s)
children = s.pop("children", None)
if children is not None:
res.extend(self.flatten_symbols(children, s))
return res
def document_symbols(self):
log.debug("document_symbols")
if self._tree == nodes.Null_Iir:
return []
syms = symbols.get_symbols_chain(self._fe, nodes.Get_First_Design_Unit(self._tree))
return self.flatten_symbols(syms, None)
def position_to_location(self, position):
pos = files_map.File_Line_To_Position(self._fe, position["line"] + 1)
return files_map.File_Pos_To_Location(self._fe, pos) + position["character"]
def find_definition(self, position):
loc = self.position_to_location(position)
return references.find_definition_by_loc(self._tree, loc)
def hover(self, position):
loc = self.position_to_location(position)
t = references.find_definition_by_loc(self._tree, loc)
if t is None:
# At least vscode sends an hover request even on spaces.
log.debug("hover: definition not found at {}.{}".format(position["line"], position["character"]))
return None
# Regenerate the declaration
hand = prints.Allocate_Handle()
prints.Print_String(t, hand)
buffer = prints.Get_C_String(hand)
buf_len = prints.Get_Length(hand)
if buf_len == 0:
# Not expected.
log.info("hover: no string")
res = None
else:
txt = ""
# Extract comments
t_loc = nodes.Get_Location(t)
t_fe = files_map.Location_To_File(t_loc)
comm = file_comments.Find_First_Comment(t_fe, t)
while comm != file_comments.No_Comment_Index:
# Add a comment in 'preformatted' mode
txt += " " + file_comments.Get_Comment(t_fe, comm) + "\n"
comm = file_comments.Get_Next_Comment(t_fe, comm)
if txt:
# Add a separation line between comments and declaration.
txt += "---\n"
newtext = buffer[:buf_len].decode(Document.encoding)
txt += "```vhdl\n" + newtext + "\n```"
res = {"contents": {"kind": "markdown", "value": txt}}
prints.Free_Handle(hand)
return res
def format_range(self, rng):
first_line = rng["start"]["line"] + 1
last_line = rng["end"]["line"] + (1 if rng["end"]["character"] != 0 else 0)
if last_line < first_line:
return None
if self._tree == nodes.Null_Iir:
return None
hand = prints.Allocate_Handle()
formatters.Indent_String(self._tree, hand, first_line, last_line)
buffer = prints.Get_C_String(hand)
buf_len = prints.Get_Length(hand)
newtext = buffer[:buf_len].decode(Document.encoding)
res = [
{
"range": {
"start": {"line": first_line - 1, "character": 0},
"end": {"line": last_line, "character": 0},
},
"newText": newtext,
}
]
prints.Free_Handle(hand)
return res
|