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
|
-- Loading of source files.
-- Copyright (C) 2002, 2003, 2004, 2005 Tristan Gingold
--
-- GHDL 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, or (at your option) any later
-- version.
--
-- GHDL 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 GHDL; see the file COPYING. If not, write to the Free
-- Software Foundation, 59 Temple Place - Suite 330, Boston, MA
-- 02111-1307, USA.
with Types; use Types;
with Nodes;
-- Source file handling
package Files_Map is
-- Create the path from DIRECTORY and NAME:
-- If NAME is an absolute pathname, then return NAME.
-- Otherwise, return the concatenation of DIRECTORY and NAME.
-- If ADD_NUL is TRUE, then a trailing '\0' is appended.
function Get_Pathname
(Directory : Name_Id; Name : Name_Id; Add_Nul : Boolean) return String;
-- If NAME contains a directory separator, move it to the DIRECTORY name.
-- At the return point, NAME has no directory components.
procedure Normalize_Pathname
(Directory : in out Name_Id; Name : in out Name_Id);
-- Return an entry for a filename. Null_Identifier for DIRECTORY means
-- current directory.
-- Load the filename if necessary.
-- Return No_Source_File_Entry if the file does not exist.
function Load_Source_File (Directory : Name_Id; Name : Name_Id)
return Source_File_Entry;
-- Each file in memory has two terminal EOT.
EOT : constant Character := Character'Val (4);
-- Create an empty Source_File for a virtual file name. Used for implicit,
-- command-line and std.standard library.
function Create_Virtual_Source_File (Name : Name_Id)
return Source_File_Entry;
-- Create a Source_File for a possible virtual file NAME using CONTENT
-- as content of the file. The file must not already exist.
function Create_Source_File_From_String (Name : Name_Id; Content : String)
return Source_File_Entry;
-- Create a pseudo source file from REF for instance INST (created at
-- location LOC). The content of this file is the same as REF, but with
-- new locations so that it is possible to retrieve the instance from
-- the new locations.
function Create_Instance_Source_File
(Ref : Source_File_Entry; Loc : Location_Type; Inst : Nodes.Node_Type)
return Source_File_Entry;
-- Relocate location LOC (which must be in the reference of INST_FILE)
-- for instrnace INST_FILE.
function Instance_Relocate
(Inst_File : Source_File_Entry; Loc : Location_Type)
return Location_Type;
-- If LOC is a location of an instance (in a file created by
-- create_instance_source_file), return the location where the instance
-- has been created. Otherwise, return No_Location.
function Location_Instance_To_Location
(Loc : Location_Type) return Location_Type;
-- Return a buffer (access to the contents of the file) for a file entry.
function Get_File_Source (File : Source_File_Entry) return File_Buffer_Acc;
-- Return the length of the file (which is the size of the file buffer).
function Get_File_Length (File : Source_File_Entry) return Source_Ptr;
-- Return the name of the file.
function Get_File_Name (File : Source_File_Entry) return Name_Id;
-- Return the directory of the file.
function Get_Source_File_Directory (File : Source_File_Entry)
return Name_Id;
-- Return the entry of the last known file.
-- This allow the user to create a table of Source_File_Entry.
function Get_Last_Source_File_Entry return Source_File_Entry;
-- Time stamp handling.
function Is_Eq (L : Time_Stamp_Id; R : Time_Stamp_Id) return Boolean;
function Is_Gt (L : Time_Stamp_Id; R : Time_Stamp_Id) return Boolean;
function Get_Time_Stamp_String (Ts : Time_Stamp_Id) return String;
-- Return the checksum of the content of FILE.
function Get_File_Checksum (File : Source_File_Entry)
return File_Checksum_Id;
-- True if two file checksums are identical.
function Is_Eq (L, R : File_Checksum_Id) return Boolean;
-- String image of CHECKSUM.
function Get_File_Checksum_String (Checksum : File_Checksum_Id)
return String;
-- Return the current date of the system.
function Get_Os_Time_Stamp return Time_Stamp_Id;
-- Return the home directory (current directory).
function Get_Home_Directory return Name_Id;
-- Add a new entry in the lines_table.
-- The new entry must be the next one after the last entry.
procedure File_Add_Line_Number
(File : Source_File_Entry; Line : Natural; Pos : Source_Ptr);
-- Convert LOCATION into a source file FILE and an offset POS in the
-- file.
procedure Location_To_File_Pos (Location : Location_Type;
File : out Source_File_Entry;
Pos : out Source_Ptr);
-- Convert a FILE and an offset POS in the file into a location.
function File_Pos_To_Location (File : Source_File_Entry; Pos : Source_Ptr)
return Location_Type;
-- Convert a FILE into a location.
function Source_File_To_Location (File : Source_File_Entry)
return Location_Type;
-- Convert a FILE+LINE into a position.
-- Return Source_Ptr_Bad in case of error (LINE out of bounds).
function Line_To_Position (File : Source_File_Entry; Line : Natural)
return Source_Ptr;
-- Translate LOCATION into coordinate (physical position).
-- FILE identifies the filename.
-- LINE_POS is the offset in the file of the first character of the line,
-- LINE is the line number (first line is 1),
-- OFFSET is the offset of the location in the line (first character is 0,
-- a tabulation is one character),
procedure Location_To_Coord (Location : Location_Type;
File : out Source_File_Entry;
Line_Pos : out Source_Ptr;
Line : out Natural;
Offset : out Natural);
-- Translate coordinate into logical position.
-- NAME is the name of the file,
-- COL is the column (first character is 1, tabulation are at every 8
-- positions).
procedure Coord_To_Position (File : Source_File_Entry;
Line_Pos : Source_Ptr;
Offset : Natural;
Name : out Name_Id;
Col : out Natural);
-- Translate LOCATION to NAME, LINE and COL.
-- It is like to two procedures above.
procedure Location_To_Position (Location : Location_Type;
Name : out Name_Id;
Line : out Natural;
Col : out Natural);
-- Return the image of LOC using the "FILENAME:LINE:COL" format or
-- "LINE:COL" format if FILENAME is false;
function Image (Loc : Location_Type; Filename : Boolean := True)
return String;
-- Free all memory and reinitialize.
procedure Initialize;
end Files_Map;
|
