|
111
|
1 ------------------------------------------------------------------------------
|
|
|
2 -- --
|
|
|
3 -- GNAT COMPILER COMPONENTS --
|
|
|
4 -- --
|
|
|
5 -- S I N P U T --
|
|
|
6 -- --
|
|
|
7 -- S p e c --
|
|
|
8 -- --
|
|
145
|
9 -- Copyright (C) 1992-2019, Free Software Foundation, Inc. --
|
|
111
|
10 -- --
|
|
|
11 -- GNAT is free software; you can redistribute it and/or modify it under --
|
|
|
12 -- terms of the GNU General Public License as published by the Free Soft- --
|
|
|
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
|
|
|
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
|
|
|
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
|
|
|
16 -- or FITNESS FOR A PARTICULAR PURPOSE. --
|
|
|
17 -- --
|
|
|
18 -- As a special exception under Section 7 of GPL version 3, you are granted --
|
|
|
19 -- additional permissions described in the GCC Runtime Library Exception, --
|
|
|
20 -- version 3.1, as published by the Free Software Foundation. --
|
|
|
21 -- --
|
|
|
22 -- You should have received a copy of the GNU General Public License and --
|
|
|
23 -- a copy of the GCC Runtime Library Exception along with this program; --
|
|
|
24 -- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
|
|
|
25 -- <http://www.gnu.org/licenses/>. --
|
|
|
26 -- --
|
|
|
27 -- GNAT was originally developed by the GNAT team at New York University. --
|
|
|
28 -- Extensive contributions were provided by Ada Core Technologies Inc. --
|
|
|
29 -- --
|
|
|
30 ------------------------------------------------------------------------------
|
|
|
31
|
|
|
32 -- This package contains the input routines used for reading the
|
|
|
33 -- input source file. The actual I/O routines are in OS_Interface,
|
|
|
34 -- with this module containing only the system independent processing.
|
|
|
35
|
|
|
36 -- General Note: throughout the compiler, we use the term line or source
|
|
|
37 -- line to refer to a physical line in the source, terminated by the end of
|
|
|
38 -- physical line sequence.
|
|
|
39
|
|
|
40 -- There are two distinct concepts of line terminator in GNAT
|
|
|
41
|
|
|
42 -- A logical line terminator is what corresponds to the "end of a line" as
|
|
|
43 -- described in RM 2.2 (13). Any of the characters FF, LF, CR or VT or any
|
|
|
44 -- wide character that is a Line or Paragraph Separator acts as an end of
|
|
|
45 -- logical line in this sense, and it is essentially irrelevant whether one
|
|
|
46 -- or more appears in sequence (since if a sequence of such characters is
|
|
|
47 -- regarded as separate ends of line, then the intervening logical lines
|
|
|
48 -- are null in any case).
|
|
|
49
|
|
|
50 -- A physical line terminator is a sequence of format effectors that is
|
|
|
51 -- treated as ending a physical line. Physical lines have no Ada semantic
|
|
|
52 -- significance, but they are significant for error reporting purposes,
|
|
|
53 -- since errors are identified by line and column location.
|
|
|
54
|
|
|
55 -- In GNAT, a physical line is ended by any of the sequences LF, CR/LF, or
|
|
|
56 -- CR. LF is used in typical Unix systems, CR/LF in DOS systems, and CR
|
|
|
57 -- alone in System 7. In addition, we recognize any of these sequences in
|
|
|
58 -- any of the operating systems, for better behavior in treating foreign
|
|
|
59 -- files (e.g. a Unix file with LF terminators transferred to a DOS system).
|
|
|
60 -- Finally, wide character codes in categories Separator, Line and Separator,
|
|
|
61 -- Paragraph are considered to be physical line terminators.
|
|
|
62
|
|
|
63 with Alloc;
|
|
|
64 with Casing; use Casing;
|
|
|
65 with Namet; use Namet;
|
|
|
66 with System;
|
|
|
67 with Table;
|
|
|
68 with Types; use Types;
|
|
|
69
|
|
|
70 package Sinput is
|
|
|
71
|
|
|
72 type Type_Of_File is (
|
|
|
73 -- Indicates type of file being read
|
|
|
74
|
|
|
75 Src,
|
|
|
76 -- Normal Ada source file
|
|
|
77
|
|
|
78 Config,
|
|
|
79 -- Configuration pragma file
|
|
|
80
|
|
|
81 Def,
|
|
|
82 -- Preprocessing definition file
|
|
|
83
|
|
|
84 Preproc);
|
|
|
85 -- Source file with preprocessing commands to be preprocessed
|
|
|
86
|
|
|
87 type Instance_Id is new Nat;
|
|
|
88 No_Instance_Id : constant Instance_Id;
|
|
|
89
|
|
|
90 ----------------------------
|
|
|
91 -- Source License Control --
|
|
|
92 ----------------------------
|
|
|
93
|
|
|
94 -- The following type indicates the license state of a source if it
|
|
|
95 -- is known.
|
|
|
96
|
|
|
97 type License_Type is
|
|
|
98 (Unknown,
|
|
|
99 -- Licensing status of this source unit is unknown
|
|
|
100
|
|
|
101 Restricted,
|
|
|
102 -- This is a non-GPL'ed unit that is restricted from depending
|
|
|
103 -- on GPL'ed units (e.g. proprietary code is in this category)
|
|
|
104
|
|
|
105 GPL,
|
|
|
106 -- This file is licensed under the unmodified GPL. It is not allowed
|
|
|
107 -- to depend on Non_GPL units, and Non_GPL units may not depend on
|
|
|
108 -- this source unit.
|
|
|
109
|
|
|
110 Modified_GPL,
|
|
|
111 -- This file is licensed under the GNAT modified GPL (see header of
|
|
|
112 -- This file for wording of the modification). It may depend on other
|
|
|
113 -- Modified_GPL units or on unrestricted units.
|
|
|
114
|
|
|
115 Unrestricted);
|
|
|
116 -- The license on this file is permitted to depend on any other
|
|
|
117 -- units, or have other units depend on it, without violating the
|
|
|
118 -- license of this unit. Examples are public domain units, and
|
|
|
119 -- units defined in the RM).
|
|
|
120
|
|
|
121 -- The above license status is checked when the appropriate check is
|
|
|
122 -- activated and one source depends on another, and the licensing state
|
|
|
123 -- of both files is known:
|
|
|
124
|
|
|
125 -- The prohibited combinations are:
|
|
|
126
|
|
|
127 -- Restricted file may not depend on GPL file
|
|
|
128
|
|
|
129 -- GPL file may not depend on Restricted file
|
|
|
130
|
|
|
131 -- Modified GPL file may not depend on Restricted file
|
|
|
132 -- Modified_GPL file may not depend on GPL file
|
|
|
133
|
|
|
134 -- The reason for the last restriction here is that a client depending
|
|
|
135 -- on a modified GPL file must be sure that the license condition is
|
|
|
136 -- correct considered transitively.
|
|
|
137
|
|
|
138 -- The licensing status is determined either by the presence of a
|
|
|
139 -- specific pragma License, or by scanning the header for a predefined
|
|
|
140 -- statement, or any file if compiling in -gnatg mode.
|
|
|
141
|
|
|
142 -----------------------
|
|
|
143 -- Source File Table --
|
|
|
144 -----------------------
|
|
|
145
|
|
|
146 -- The source file table has an entry for each source file read in for
|
|
|
147 -- this run of the compiler. This table is (default) initialized when
|
|
|
148 -- the compiler is loaded, and simply accumulates entries as compilation
|
|
|
149 -- proceeds and various routines in Sinput and its child packages are
|
|
|
150 -- called to load required source files.
|
|
|
151
|
|
|
152 -- Virtual entries are also created for generic templates when they are
|
|
|
153 -- instantiated, as described in a separate section later on.
|
|
|
154
|
|
|
155 -- In the case where there are multiple main units (e.g. in the case of
|
|
|
156 -- the cross-reference tool), this table is not reset between these units,
|
|
|
157 -- so that a given source file is only read once if it is used by two
|
|
|
158 -- separate main units.
|
|
|
159
|
|
|
160 -- The entries in the table are accessed using a Source_File_Index that
|
|
|
161 -- ranges from 1 to Last_Source_File. Each entry has the following fields.
|
|
|
162
|
|
|
163 -- Note: fields marked read-only are set by Sinput or one of its child
|
|
|
164 -- packages when a source file table entry is created, and cannot be
|
|
|
165 -- subsequently modified, or alternatively are set only by very special
|
|
|
166 -- circumstances, documented in the comments.
|
|
|
167
|
|
|
168 -- File_Name : File_Name_Type (read-only)
|
|
|
169 -- Name of the source file (simple name with no directory information)
|
|
|
170
|
|
|
171 -- Full_File_Name : File_Name_Type (read-only)
|
|
|
172 -- Full file name (full name with directory info), used for generation
|
|
|
173 -- of error messages, etc.
|
|
|
174
|
|
|
175 -- File_Type : Type_Of_File (read-only)
|
|
|
176 -- Indicates type of file (source file, configuration pragmas file,
|
|
|
177 -- preprocessor definition file, preprocessor input file).
|
|
|
178
|
|
|
179 -- Reference_Name : File_Name_Type (read-only)
|
|
|
180 -- Name to be used for source file references in error messages where
|
|
|
181 -- only the simple name of the file is required. Identical to File_Name
|
|
|
182 -- unless pragma Source_Reference is used to change it. Only processing
|
|
|
183 -- for the Source_Reference pragma circuit may set this field.
|
|
|
184
|
|
|
185 -- Full_Ref_Name : File_Name_Type (read-only)
|
|
|
186 -- Name to be used for source file references in error messages where
|
|
|
187 -- the full name of the file is required. Identical to Full_File_Name
|
|
|
188 -- unless pragma Source_Reference is used to change it. Only processing
|
|
|
189 -- for the Source_Reference pragma may set this field.
|
|
|
190
|
|
|
191 -- Debug_Source_Name : File_Name_Type (read-only)
|
|
|
192 -- Name to be used for source file references in debugging information
|
|
|
193 -- where only the simple name of the file is required. Identical to
|
|
|
194 -- Reference_Name unless the -gnatD (debug source file) switch is used.
|
|
|
195 -- Only processing in Sprint that generates this file is permitted to
|
|
|
196 -- set this field.
|
|
|
197
|
|
|
198 -- Full_Debug_Name : File_Name_Type (read-only)
|
|
|
199 -- Name to be used for source file references in debugging information
|
|
|
200 -- where the full name of the file is required. This is identical to
|
|
|
201 -- Full_Ref_Name unless the -gnatD (debug source file) switch is used.
|
|
|
202 -- Only processing in Sprint that generates this file is permitted to
|
|
|
203 -- set this field.
|
|
|
204
|
|
|
205 -- Instance : Instance_Id (read-only)
|
|
|
206 -- For entries corresponding to a generic instantiation, unique
|
|
|
207 -- identifier denoting the full chain of nested instantiations. Set to
|
|
|
208 -- No_Instance_Id for the case of a normal, non-instantiation entry.
|
|
|
209 -- See below for details on the handling of generic instantiations.
|
|
|
210
|
|
|
211 -- License : License_Type;
|
|
|
212 -- License status of source file
|
|
|
213
|
|
|
214 -- Num_SRef_Pragmas : Nat;
|
|
|
215 -- Number of source reference pragmas present in source file
|
|
|
216
|
|
|
217 -- First_Mapped_Line : Logical_Line_Number;
|
|
|
218 -- This field stores logical line number of the first line in the
|
|
|
219 -- file that is not a Source_Reference pragma. If no source reference
|
|
|
220 -- pragmas are used, then the value is set to No_Line_Number.
|
|
|
221
|
|
|
222 -- Source_Text : Source_Buffer_Ptr (read-only)
|
|
|
223 -- Text of source file. Every source file has a distinct set of
|
|
|
224 -- nonoverlapping bounds, so it is possible to determine which
|
|
|
225 -- file is referenced from a given subscript (Source_Ptr) value.
|
|
|
226
|
|
|
227 -- Source_First : Source_Ptr; (read-only)
|
|
|
228 -- This is always equal to Source_Text'First, except during
|
|
|
229 -- construction of a debug output file (*.dg), when Source_Text = null,
|
|
|
230 -- and Source_First is the size so far. Likewise for Last.
|
|
|
231
|
|
|
232 -- Source_Last : Source_Ptr; (read-only)
|
|
|
233 -- Same idea as Source_Last, but for Last
|
|
|
234
|
|
|
235 -- Time_Stamp : Time_Stamp_Type; (read-only)
|
|
|
236 -- Time stamp of the source file
|
|
|
237
|
|
|
238 -- Source_Checksum : Word;
|
|
|
239 -- Computed checksum for contents of source file. See separate section
|
|
|
240 -- later on in this spec for a description of the checksum algorithm.
|
|
|
241
|
|
|
242 -- Last_Source_Line : Physical_Line_Number;
|
|
|
243 -- Physical line number of last source line. While a file is being
|
|
|
244 -- read, this refers to the last line scanned. Once a file has been
|
|
|
245 -- completely scanned, it is the number of the last line in the file,
|
|
|
246 -- and hence also gives the number of source lines in the file.
|
|
|
247
|
|
|
248 -- Keyword_Casing : Casing_Type;
|
|
|
249 -- Casing style used in file for keyword casing. This is initialized
|
|
|
250 -- to Unknown, and then set from the first occurrence of a keyword.
|
|
|
251 -- This value is used only for formatting of error messages.
|
|
|
252
|
|
|
253 -- Identifier_Casing : Casing_Type;
|
|
|
254 -- Casing style used in file for identifier casing. This is initialized
|
|
|
255 -- to Unknown, and then set from an identifier in the program as soon as
|
|
|
256 -- one is found whose casing is sufficiently clear to make a decision.
|
|
|
257 -- This value is used for formatting of error messages, and also is used
|
|
|
258 -- in the detection of keywords misused as identifiers.
|
|
|
259
|
|
|
260 -- Inlined_Call : Source_Ptr;
|
|
|
261 -- Source file location of the subprogram call if this source file entry
|
|
|
262 -- represents an inlined body or an inherited pragma. Set to No_Location
|
|
|
263 -- otherwise. This field is read-only for clients.
|
|
|
264
|
|
|
265 -- Inlined_Body : Boolean;
|
|
|
266 -- This can only be set True if Instantiation has a value other than
|
|
|
267 -- No_Location. If true it indicates that the instantiation is actually
|
|
|
268 -- an instance of an inlined body.
|
|
|
269
|
|
|
270 -- Inherited_Pragma : Boolean;
|
|
|
271 -- This can only be set True if Instantiation has a value other than
|
|
|
272 -- No_Location. If true it indicates that the instantiation is actually
|
|
|
273 -- an inherited class-wide pre- or postcondition.
|
|
|
274
|
|
|
275 -- Template : Source_File_Index; (read-only)
|
|
|
276 -- Source file index of the source file containing the template if this
|
|
|
277 -- is a generic instantiation. Set to No_Source_File for the normal case
|
|
|
278 -- of a non-instantiation entry. See Sinput-L for details.
|
|
|
279
|
|
|
280 -- Unit : Unit_Number_Type;
|
|
|
281 -- Identifies the unit contained in this source file. Set by
|
|
|
282 -- Initialize_Scanner, must not be subsequently altered.
|
|
|
283
|
|
|
284 -- The source file table is accessed by clients using the following
|
|
|
285 -- subprogram interface:
|
|
|
286
|
|
|
287 subtype SFI is Source_File_Index;
|
|
|
288
|
|
|
289 System_Source_File_Index : SFI;
|
|
|
290 -- The file system.ads is always read by the compiler to determine the
|
|
|
291 -- settings of the target parameters in the private part of System. This
|
|
|
292 -- variable records the source file index of system.ads. Typically this
|
|
|
293 -- will be 1 since system.ads is read first.
|
|
|
294
|
|
|
295 function Debug_Source_Name (S : SFI) return File_Name_Type;
|
|
145
|
296 -- WARNING: There is a matching C declaration of this subprogram in fe.h
|
|
|
297
|
|
111
|
298 function File_Name (S : SFI) return File_Name_Type;
|
|
|
299 function File_Type (S : SFI) return Type_Of_File;
|
|
|
300 function First_Mapped_Line (S : SFI) return Logical_Line_Number;
|
|
|
301 function Full_Debug_Name (S : SFI) return File_Name_Type;
|
|
|
302 function Full_File_Name (S : SFI) return File_Name_Type;
|
|
|
303 function Full_Ref_Name (S : SFI) return File_Name_Type;
|
|
|
304 function Identifier_Casing (S : SFI) return Casing_Type;
|
|
|
305 function Inlined_Body (S : SFI) return Boolean;
|
|
|
306 function Inherited_Pragma (S : SFI) return Boolean;
|
|
|
307 function Inlined_Call (S : SFI) return Source_Ptr;
|
|
|
308 function Instance (S : SFI) return Instance_Id;
|
|
|
309 function Keyword_Casing (S : SFI) return Casing_Type;
|
|
|
310 function Last_Source_Line (S : SFI) return Physical_Line_Number;
|
|
|
311 function License (S : SFI) return License_Type;
|
|
|
312 function Num_SRef_Pragmas (S : SFI) return Nat;
|
|
|
313 function Reference_Name (S : SFI) return File_Name_Type;
|
|
|
314 function Source_Checksum (S : SFI) return Word;
|
|
|
315 function Source_First (S : SFI) return Source_Ptr;
|
|
|
316 function Source_Last (S : SFI) return Source_Ptr;
|
|
|
317 function Source_Text (S : SFI) return Source_Buffer_Ptr;
|
|
|
318 function Template (S : SFI) return Source_File_Index;
|
|
|
319 function Unit (S : SFI) return Unit_Number_Type;
|
|
|
320 function Time_Stamp (S : SFI) return Time_Stamp_Type;
|
|
|
321
|
|
|
322 procedure Set_Keyword_Casing (S : SFI; C : Casing_Type);
|
|
|
323 procedure Set_Identifier_Casing (S : SFI; C : Casing_Type);
|
|
|
324 procedure Set_License (S : SFI; L : License_Type);
|
|
|
325 procedure Set_Unit (S : SFI; U : Unit_Number_Type);
|
|
|
326
|
|
|
327 function Last_Source_File return Source_File_Index;
|
|
|
328 -- Index of last source file table entry
|
|
|
329
|
|
|
330 function Num_Source_Files return Nat;
|
|
|
331 -- Number of source file table entries
|
|
|
332
|
|
|
333 procedure Initialize;
|
|
|
334 -- Initialize internal tables
|
|
|
335
|
|
|
336 procedure Lock;
|
|
|
337 -- Lock internal tables
|
|
|
338
|
|
|
339 procedure Unlock;
|
|
|
340 -- Unlock internal tables
|
|
|
341
|
|
|
342 Main_Source_File : Source_File_Index := No_Source_File;
|
|
|
343 -- This is set to the source file index of the main unit
|
|
|
344
|
|
|
345 -----------------------
|
|
|
346 -- Checksum Handling --
|
|
|
347 -----------------------
|
|
|
348
|
|
|
349 -- As a source file is scanned, a checksum is computed by taking all the
|
|
|
350 -- non-blank characters in the file, excluding comment characters, the
|
|
|
351 -- minus-minus sequence starting a comment, and all control characters
|
|
|
352 -- except ESC.
|
|
|
353
|
|
|
354 -- The checksum algorithm used is the standard CRC-32 algorithm, as
|
|
|
355 -- implemented by System.CRC32, except that we do not bother with the
|
|
|
356 -- final XOR with all 1 bits.
|
|
|
357
|
|
|
358 -- This algorithm ensures that the checksum includes all semantically
|
|
|
359 -- significant aspects of the program represented by the source file,
|
|
|
360 -- but is insensitive to layout, presence or contents of comments, wide
|
|
|
361 -- character representation method, or casing conventions outside strings.
|
|
|
362
|
|
|
363 -- Scans.Checksum is initialized appropriately at the start of scanning
|
|
|
364 -- a file, and copied into the Source_Checksum field of the file table
|
|
|
365 -- entry when the end of file is encountered.
|
|
|
366
|
|
|
367 -------------------------------------
|
|
|
368 -- Handling Generic Instantiations --
|
|
|
369 -------------------------------------
|
|
|
370
|
|
|
371 -- As described in Sem_Ch12, a generic instantiation involves making a
|
|
|
372 -- copy of the tree of the generic template. The source locations in
|
|
|
373 -- this tree directly reference the source of the template. However, it
|
|
|
374 -- is also possible to find the location of the instantiation.
|
|
|
375
|
|
|
376 -- This is achieved as follows. When an instantiation occurs, a new entry
|
|
|
377 -- is made in the source file table. The Source_Text of the instantiation
|
|
|
378 -- points to the same Source_Buffer as the Source_Text of the template, but
|
|
|
379 -- with different bounds. The separate range of Sloc values avoids
|
|
|
380 -- confusion, and means that the Sloc values can still be used to uniquely
|
|
|
381 -- identify the source file table entry. See Set_Dope below for the
|
|
|
382 -- low-level trickery that allows two different pointers to point at the
|
|
|
383 -- same array, but with different bounds.
|
|
|
384
|
|
|
385 -- The Instantiation_Id field of this source file index entry, set
|
|
|
386 -- to No_Instance_Id for normal entries, instead contains a value that
|
|
|
387 -- uniquely identifies a particular instantiation, and the associated
|
|
|
388 -- entry in the Instances table. The source location of the instantiation
|
|
|
389 -- can be retrieved using function Instantiation below. In the case of
|
|
|
390 -- nested instantiations, the Instances table can be used to trace the
|
|
|
391 -- complete chain of nested instantiations.
|
|
|
392
|
|
|
393 -- Two routines are used to build the special instance entries in the
|
|
|
394 -- source file table. Create_Instantiation_Source is first called to build
|
|
|
395 -- the virtual source table entry for the instantiation, and then the
|
|
|
396 -- Sloc values in the copy are adjusted using Adjust_Instantiation_Sloc.
|
|
|
397 -- See child unit Sinput.L for details on these two routines.
|
|
|
398
|
|
|
399 generic
|
|
|
400 with procedure Process (Id : Instance_Id; Inst_Sloc : Source_Ptr);
|
|
|
401 procedure Iterate_On_Instances;
|
|
|
402 -- Execute Process for each entry in the instance table
|
|
|
403
|
|
|
404 function Instantiation (S : SFI) return Source_Ptr;
|
|
|
405 -- For a source file entry that represents an inlined body, source location
|
|
|
406 -- of the inlined call. For a source file entry that represents an
|
|
|
407 -- inherited pragma, source location of the declaration to which the
|
|
|
408 -- overriding subprogram for the inherited pragma is attached. Otherwise,
|
|
|
409 -- for a source file entry that represents a generic instantiation, source
|
|
|
410 -- location of the instantiation. Returns No_Location in all other cases.
|
|
|
411
|
|
|
412 -----------------
|
|
|
413 -- Global Data --
|
|
|
414 -----------------
|
|
|
415
|
|
|
416 Current_Source_File : Source_File_Index := No_Source_File;
|
|
|
417 -- Source_File table index of source file currently being scanned.
|
|
|
418 -- Initialized so that some tools (such as gprbuild) can be built with
|
|
|
419 -- -gnatVa and pragma Initialize_Scalars without problems.
|
|
|
420
|
|
|
421 Current_Source_Unit : Unit_Number_Type;
|
|
|
422 -- Unit number of source file currently being scanned. The special value
|
|
|
423 -- of No_Unit indicates that the configuration pragma file is currently
|
|
|
424 -- being scanned (this has no entry in the unit table).
|
|
|
425
|
|
|
426 Source_gnat_adc : Source_File_Index := No_Source_File;
|
|
|
427 -- This is set if a gnat.adc file is present to reference this file
|
|
|
428
|
|
|
429 Source : Source_Buffer_Ptr;
|
|
|
430 -- Current source (copy of Source_File.Table (Current_Source_Unit).Source)
|
|
|
431
|
|
|
432 -----------------------------------------
|
|
|
433 -- Handling of Source Line Terminators --
|
|
|
434 -----------------------------------------
|
|
|
435
|
|
|
436 -- In this section we discuss in detail the issue of terminators used to
|
|
|
437 -- terminate source lines. The RM says that one or more format effectors
|
|
|
438 -- (other than horizontal tab) end a source line, and defines the set of
|
|
|
439 -- such format effectors, but does not talk about exactly how they are
|
|
|
440 -- represented in the source program (since in general the RM is not in
|
|
|
441 -- the business of specifying source program formats).
|
|
|
442
|
|
|
443 -- The type Types.Line_Terminator is defined as a subtype of Character
|
|
|
444 -- that includes CR/LF/VT/FF. The most common line enders in practice
|
|
|
445 -- are CR (some MAC systems), LF (Unix systems), and CR/LF (DOS/Windows
|
|
|
446 -- systems). Any of these sequences is recognized as ending a physical
|
|
|
447 -- source line, and if multiple such terminators appear (e.g. LF/LF),
|
|
|
448 -- then we consider we have an extra blank line.
|
|
|
449
|
|
|
450 -- VT and FF are recognized as terminating source lines, but they are
|
|
|
451 -- considered to end a logical line instead of a physical line, so that
|
|
|
452 -- the line numbering ignores such terminators. The use of VT and FF is
|
|
|
453 -- mandated by the standard, and correctly handled in a conforming manner
|
|
|
454 -- by GNAT, but their use is not recommended.
|
|
|
455
|
|
|
456 -- In addition to the set of characters defined by the type in Types, in
|
|
|
457 -- wide character encoding, then the codes returning True for a call to
|
|
|
458 -- System.UTF_32.Is_UTF_32_Line_Terminator are also recognized as ending a
|
|
|
459 -- source line. This includes the standard codes defined above in addition
|
|
|
460 -- to NEL (NEXT LINE), LINE SEPARATOR and PARAGRAPH SEPARATOR. Again, as in
|
|
|
461 -- the case of VT and FF, the standard requires we recognize these as line
|
|
|
462 -- terminators, but we consider them to be logical line terminators. The
|
|
|
463 -- only physical line terminators recognized are the standard ones (CR,
|
|
|
464 -- LF, or CR/LF).
|
|
|
465
|
|
|
466 -- However, we do not recognize the NEL (16#85#) character as having the
|
|
|
467 -- significance of an end of line character when operating in normal 8-bit
|
|
|
468 -- Latin-n input mode for the compiler. Instead the rule in this mode is
|
|
|
469 -- that all upper half control codes (16#80# .. 16#9F#) are illegal if they
|
|
|
470 -- occur in program text, and are ignored if they appear in comments.
|
|
|
471
|
|
|
472 -- First, note that this behavior is fully conforming with the standard.
|
|
|
473 -- The standard has nothing whatever to say about source representation
|
|
|
474 -- and implementations are completely free to make there own rules. In
|
|
|
475 -- this case, in 8-bit mode, GNAT decides that the 16#0085# character is
|
|
|
476 -- not a representation of the NEL character, even though it looks like it.
|
|
|
477 -- If you have NEL's in your program, which you expect to be treated as
|
|
|
478 -- end of line characters, you must use a wide character encoding such as
|
|
|
479 -- UTF-8 for this code to be recognized.
|
|
|
480
|
|
|
481 -- Second, an explanation of why we take this slightly surprising choice.
|
|
|
482 -- We have never encountered anyone actually using the NEL character to
|
|
|
483 -- end lines. One user raised the issue as a result of some experiments,
|
|
|
484 -- but no one has ever submitted a program encoded this way, in any of
|
|
|
485 -- the possible encodings. It seems that even when using wide character
|
|
|
486 -- codes extensively, the normal approach is to use standard line enders
|
|
|
487 -- (LF or CR/LF). So the failure to recognize NEL in this mode seems to
|
|
|
488 -- have no practical downside.
|
|
|
489
|
|
|
490 -- Moreover, what we have seen in a significant number of programs from
|
|
|
491 -- multiple sources is the practice of writing all program text in lower
|
|
|
492 -- half (ASCII) form, but using UTF-8 encoded wide characters freely in
|
|
|
493 -- comments, where the comments are terminated by normal line endings
|
|
|
494 -- (LF or CR/LF). The comments do not contain NEL codes, but they can and
|
|
|
495 -- do contain other UTF-8 encoding sequences where one of the bytes is the
|
|
|
496 -- NEL code. Now such programs can of course be compiled in UTF-8 mode,
|
|
|
497 -- but in practice they also compile fine in standard 8-bit mode without
|
|
|
498 -- specifying a character encoding. Since this is common practice, it would
|
|
|
499 -- be a significant upwards incompatibility to recognize NEL in 8-bit mode.
|
|
|
500
|
|
|
501 -----------------
|
|
|
502 -- Subprograms --
|
|
|
503 -----------------
|
|
|
504
|
|
|
505 procedure Backup_Line (P : in out Source_Ptr);
|
|
|
506 -- Back up the argument pointer to the start of the previous line. On
|
|
|
507 -- entry, P points to the start of a physical line in the source buffer.
|
|
|
508 -- On return, P is updated to point to the start of the previous line.
|
|
|
509 -- The caller has checked that a Line_Terminator character precedes P so
|
|
|
510 -- that there definitely is a previous line in the source buffer.
|
|
|
511
|
|
|
512 procedure Build_Location_String
|
|
|
513 (Buf : in out Bounded_String;
|
|
|
514 Loc : Source_Ptr);
|
|
|
515 -- This function builds a string literal of the form "name:line", where
|
|
|
516 -- name is the file name corresponding to Loc, and line is the line number.
|
|
|
517 -- If instantiations are involved, additional suffixes of the same form are
|
|
|
518 -- appended after the separating string " instantiated at ". The returned
|
|
|
519 -- string is appended to Buf.
|
|
|
520
|
|
|
521 function Build_Location_String (Loc : Source_Ptr) return String;
|
|
|
522 -- Functional form returning a String
|
|
|
523
|
|
|
524 procedure Check_For_BOM;
|
|
|
525 -- Check if the current source starts with a BOM. Scan_Ptr needs to be at
|
|
|
526 -- the start of the current source. If the current source starts with a
|
|
|
527 -- recognized BOM, then some flags such as Wide_Character_Encoding_Method
|
|
|
528 -- are set accordingly, and the Scan_Ptr on return points past this BOM.
|
|
|
529 -- An error message is output and Unrecoverable_Error raised if an
|
|
|
530 -- unrecognized BOM is detected. The call has no effect if no BOM is found.
|
|
|
531
|
|
|
532 function Get_Column_Number (P : Source_Ptr) return Column_Number;
|
|
|
533 -- The ones-origin column number of the specified Source_Ptr value is
|
|
|
534 -- determined and returned. Tab characters if present are assumed to
|
|
|
535 -- represent the standard 1,9,17.. spacing pattern.
|
|
|
536
|
|
145
|
537 -- WARNING: There is a matching C declaration of this subprogram in fe.h
|
|
|
538
|
|
111
|
539 function Get_Logical_Line_Number
|
|
|
540 (P : Source_Ptr) return Logical_Line_Number;
|
|
|
541 -- The line number of the specified source position is obtained by
|
|
|
542 -- doing a binary search on the source positions in the lines table
|
|
|
543 -- for the unit containing the given source position. The returned
|
|
|
544 -- value is the logical line number, already adjusted for the effect
|
|
|
545 -- of source reference pragmas. If P refers to the line of a source
|
|
|
546 -- reference pragma itself, then No_Line is returned. If no source
|
|
|
547 -- reference pragmas have been encountered, the value returned is
|
|
|
548 -- the same as the physical line number.
|
|
|
549
|
|
145
|
550 -- WARNING: There is a matching C declaration of this subprogram in fe.h
|
|
|
551
|
|
111
|
552 function Get_Logical_Line_Number_Img
|
|
|
553 (P : Source_Ptr) return String;
|
|
|
554 -- Same as above function, but returns the line number as a string of
|
|
|
555 -- decimal digits, with no leading space. Destroys Name_Buffer.
|
|
|
556
|
|
|
557 function Get_Physical_Line_Number
|
|
|
558 (P : Source_Ptr) return Physical_Line_Number;
|
|
|
559 -- The line number of the specified source position is obtained by
|
|
|
560 -- doing a binary search on the source positions in the lines table
|
|
|
561 -- for the unit containing the given source position. The returned
|
|
|
562 -- value is the physical line number in the source being compiled.
|
|
|
563
|
|
|
564 function Get_Source_File_Index (S : Source_Ptr) return Source_File_Index;
|
|
|
565 pragma Inline (Get_Source_File_Index);
|
|
|
566 -- Return file table index of file identified by given source pointer
|
|
|
567 -- value. This call must always succeed, since any valid source pointer
|
|
|
568 -- value belongs to some previously loaded source file.
|
|
|
569
|
|
145
|
570 -- WARNING: There is a matching C declaration of this subprogram in fe.h
|
|
|
571
|
|
111
|
572 function Instantiation_Depth (S : Source_Ptr) return Nat;
|
|
|
573 -- Determine instantiation depth for given Sloc value. A value of
|
|
|
574 -- zero means that the given Sloc is not in an instantiation.
|
|
|
575
|
|
|
576 function Line_Start (P : Source_Ptr) return Source_Ptr;
|
|
|
577 -- Finds the source position of the start of the line containing the
|
|
|
578 -- given source location.
|
|
|
579
|
|
|
580 function Line_Start
|
|
|
581 (L : Physical_Line_Number;
|
|
|
582 S : Source_File_Index) return Source_Ptr;
|
|
|
583 -- Finds the source position of the start of the given line in the
|
|
|
584 -- given source file, using a physical line number to identify the line.
|
|
|
585
|
|
|
586 function Num_Source_Lines (S : Source_File_Index) return Nat;
|
|
|
587 -- Returns the number of source lines (this is equivalent to reading
|
|
|
588 -- the value of Last_Source_Line, but returns Nat rather than a
|
|
|
589 -- physical line number).
|
|
|
590
|
|
|
591 procedure Register_Source_Ref_Pragma
|
|
|
592 (File_Name : File_Name_Type;
|
|
|
593 Stripped_File_Name : File_Name_Type;
|
|
|
594 Mapped_Line : Nat;
|
|
|
595 Line_After_Pragma : Physical_Line_Number);
|
|
|
596 -- Register a source reference pragma, the parameter File_Name is the
|
|
|
597 -- file name from the pragma, and Stripped_File_Name is this name with
|
|
|
598 -- the directory information stripped. Both these parameters are set
|
|
|
599 -- to No_Name if no file name parameter was given in the pragma.
|
|
|
600 -- (which can only happen for the second and subsequent pragmas).
|
|
|
601 -- Mapped_Line is the line number parameter from the pragma, and
|
|
|
602 -- Line_After_Pragma is the physical line number of the line that
|
|
|
603 -- follows the line containing the Source_Reference pragma.
|
|
|
604
|
|
|
605 function Original_Location (S : Source_Ptr) return Source_Ptr;
|
|
|
606 -- Given a source pointer S, returns the corresponding source pointer
|
|
|
607 -- value ignoring instantiation copies. For locations that do not
|
|
|
608 -- correspond to instantiation copies of templates, the argument is
|
|
|
609 -- returned unchanged. For locations that do correspond to copies of
|
|
|
610 -- templates from instantiations, the location within the original
|
|
|
611 -- template is returned. This is useful in canonicalizing locations.
|
|
|
612
|
|
|
613 function Instantiation_Location (S : Source_Ptr) return Source_Ptr;
|
|
|
614 pragma Inline (Instantiation_Location);
|
|
|
615 -- Given a source pointer S, returns the corresponding source pointer
|
|
|
616 -- value of the instantiation if this location is within an instance.
|
|
|
617 -- If S is not within an instance, then this returns No_Location.
|
|
|
618
|
|
|
619 function Comes_From_Inlined_Body (S : Source_Ptr) return Boolean;
|
|
|
620 pragma Inline (Comes_From_Inlined_Body);
|
|
|
621 -- Given a source pointer S, returns whether it comes from an inlined body.
|
|
|
622 -- This allows distinguishing these source pointers from those that come
|
|
|
623 -- from instantiation of generics, since Instantiation_Location returns a
|
|
|
624 -- valid location in both cases.
|
|
|
625
|
|
|
626 function Comes_From_Inherited_Pragma (S : Source_Ptr) return Boolean;
|
|
|
627 pragma Inline (Comes_From_Inherited_Pragma);
|
|
|
628 -- Given a source pointer S, returns whether it comes from an inherited
|
|
|
629 -- pragma. This allows distinguishing these source pointers from those
|
|
|
630 -- that come from instantiation of generics, since Instantiation_Location
|
|
|
631 -- returns a valid location in both cases.
|
|
|
632
|
|
|
633 function Top_Level_Location (S : Source_Ptr) return Source_Ptr;
|
|
|
634 -- Given a source pointer S, returns the argument unchanged if it is
|
|
|
635 -- not in an instantiation. If S is in an instantiation, then it returns
|
|
|
636 -- the location of the top level instantiation, i.e. the outer level
|
|
|
637 -- instantiation in the nested case.
|
|
|
638
|
|
|
639 function Physical_To_Logical
|
|
|
640 (Line : Physical_Line_Number;
|
|
|
641 S : Source_File_Index) return Logical_Line_Number;
|
|
|
642 -- Given a physical line number in source file whose source index is S,
|
|
|
643 -- return the corresponding logical line number. If the physical line
|
|
|
644 -- number is one containing a Source_Reference pragma, the result will
|
|
|
645 -- be No_Line_Number.
|
|
|
646
|
|
|
647 procedure Skip_Line_Terminators
|
|
|
648 (P : in out Source_Ptr;
|
|
|
649 Physical : out Boolean);
|
|
|
650 -- On entry, P points to a line terminator that has been encountered,
|
|
|
651 -- which is one of FF,LF,VT,CR or a wide character sequence whose value is
|
|
|
652 -- in category Separator,Line or Separator,Paragraph. P points just past
|
|
|
653 -- the character that was scanned. The purpose of this routine is to
|
|
|
654 -- distinguish physical and logical line endings. A physical line ending
|
|
|
655 -- is one of:
|
|
|
656 --
|
|
|
657 -- CR on its own (MAC System 7)
|
|
|
658 -- LF on its own (Unix and unix-like systems)
|
|
|
659 -- CR/LF (DOS, Windows)
|
|
|
660 -- Wide character in Separator,Line or Separator,Paragraph category
|
|
|
661 --
|
|
|
662 -- Note: we no longer recognize LF/CR (which we did in some earlier
|
|
|
663 -- versions of GNAT. The reason for this is that this sequence is not
|
|
|
664 -- used and recognizing it generated confusion. For example given the
|
|
|
665 -- sequence LF/CR/LF we were interpreting that as (LF/CR) ending the
|
|
|
666 -- first line and a blank line ending with CR following, but it is
|
|
|
667 -- clearly better to interpret this as LF, with a blank line terminated
|
|
|
668 -- by CR/LF, given that LF and CR/LF are both in common use, but no
|
|
|
669 -- system we know of uses LF/CR.
|
|
|
670 --
|
|
|
671 -- A logical line ending (that is not a physical line ending) is one of:
|
|
|
672 --
|
|
|
673 -- VT on its own
|
|
|
674 -- FF on its own
|
|
|
675 --
|
|
|
676 -- On return, P is bumped past the line ending sequence (one of the above
|
|
|
677 -- seven possibilities). Physical is set to True to indicate that a
|
|
|
678 -- physical end of line was encountered, in which case this routine also
|
|
|
679 -- makes sure that the lines table for the current source file has an
|
|
|
680 -- appropriate entry for the start of the new physical line.
|
|
|
681
|
|
|
682 procedure Sloc_Range (N : Node_Id; Min, Max : out Source_Ptr);
|
|
|
683 -- Given a node, returns the minimum and maximum source locations of any
|
|
|
684 -- node in the syntactic subtree for the node. This is not quite the same
|
|
|
685 -- as the locations of the first and last token in the node construct
|
|
|
686 -- because parentheses at the outer level do not have a recorded Sloc.
|
|
|
687 --
|
|
|
688 -- Note: At each step of the tree traversal, we make sure to go back to
|
|
|
689 -- the Original_Node, since this function is concerned about original
|
|
|
690 -- (source) locations.
|
|
|
691 --
|
|
|
692 -- Note: if the tree for the expression contains no "real" Sloc values,
|
|
|
693 -- i.e. values > No_Location, then both Min and Max are set to
|
|
|
694 -- Sloc (Original_Node (N)).
|
|
|
695
|
|
|
696 function Source_Offset (S : Source_Ptr) return Nat;
|
|
|
697 -- Returns the zero-origin offset of the given source location from the
|
|
|
698 -- start of its corresponding unit. This is used for creating canonical
|
|
|
699 -- names in some situations.
|
|
|
700
|
|
|
701 procedure Write_Location (P : Source_Ptr);
|
|
|
702 -- Writes out a string of the form fff:nn:cc, where fff, nn, cc are the
|
|
|
703 -- file name, line number and column corresponding to the given source
|
|
|
704 -- location. No_Location and Standard_Location appear as the strings
|
|
|
705 -- <no location> and <standard location>. If the location is within an
|
|
|
706 -- instantiation, then the instance location is appended, enclosed in
|
|
|
707 -- square brackets (which can nest if necessary). Note that this routine
|
|
|
708 -- is used only for internal compiler debugging output purposes (which
|
|
|
709 -- is why the somewhat cryptic use of brackets is acceptable).
|
|
|
710
|
|
|
711 procedure wl (P : Source_Ptr);
|
|
|
712 pragma Export (Ada, wl);
|
|
|
713 -- Equivalent to Write_Location (P); Write_Eol; for calls from GDB
|
|
|
714
|
|
|
715 procedure Write_Time_Stamp (S : Source_File_Index);
|
|
|
716 -- Writes time stamp of specified file in YY-MM-DD HH:MM.SS format
|
|
|
717
|
|
|
718 procedure Tree_Read;
|
|
|
719 -- Initializes internal tables from current tree file using the relevant
|
|
|
720 -- Table.Tree_Read routines.
|
|
|
721
|
|
|
722 procedure Tree_Write;
|
|
|
723 -- Writes out internal tables to current tree file using the relevant
|
|
|
724 -- Table.Tree_Write routines.
|
|
|
725
|
|
|
726 procedure Clear_Source_File_Table;
|
|
|
727 -- This procedure frees memory allocated in the Source_File table (in the
|
|
|
728 -- private). It should only be used when it is guaranteed that all source
|
|
|
729 -- files that have been loaded so far will not be accessed before being
|
|
|
730 -- reloaded. It is intended for tools that parse several times sources,
|
|
|
731 -- to avoid memory leaks.
|
|
|
732
|
|
|
733 private
|
|
|
734 pragma Inline (File_Name);
|
|
|
735 pragma Inline (Full_File_Name);
|
|
|
736 pragma Inline (File_Type);
|
|
|
737 pragma Inline (Reference_Name);
|
|
|
738 pragma Inline (Full_Ref_Name);
|
|
|
739 pragma Inline (Debug_Source_Name);
|
|
|
740 pragma Inline (Full_Debug_Name);
|
|
|
741 pragma Inline (Instance);
|
|
|
742 pragma Inline (License);
|
|
|
743 pragma Inline (Num_SRef_Pragmas);
|
|
|
744 pragma Inline (First_Mapped_Line);
|
|
|
745 pragma Inline (Source_Text);
|
|
|
746 pragma Inline (Source_First);
|
|
|
747 pragma Inline (Source_Last);
|
|
|
748 pragma Inline (Time_Stamp);
|
|
|
749 pragma Inline (Source_Checksum);
|
|
|
750 pragma Inline (Last_Source_Line);
|
|
|
751 pragma Inline (Keyword_Casing);
|
|
|
752 pragma Inline (Identifier_Casing);
|
|
|
753 pragma Inline (Inlined_Call);
|
|
|
754 pragma Inline (Inlined_Body);
|
|
|
755 pragma Inline (Inherited_Pragma);
|
|
|
756 pragma Inline (Template);
|
|
|
757 pragma Inline (Unit);
|
|
|
758
|
|
|
759 pragma Inline (Set_Keyword_Casing);
|
|
|
760 pragma Inline (Set_Identifier_Casing);
|
|
|
761
|
|
|
762 pragma Inline (Last_Source_File);
|
|
|
763 pragma Inline (Num_Source_Files);
|
|
|
764 pragma Inline (Num_Source_Lines);
|
|
|
765
|
|
|
766 pragma Inline (Line_Start);
|
|
|
767
|
|
|
768 No_Instance_Id : constant Instance_Id := 0;
|
|
|
769
|
|
|
770 -------------------------
|
|
|
771 -- Source_Lines Tables --
|
|
|
772 -------------------------
|
|
|
773
|
|
|
774 type Lines_Table_Type is
|
|
|
775 array (Physical_Line_Number) of Source_Ptr;
|
|
|
776 -- Type used for lines table. The entries are indexed by physical line
|
|
|
777 -- numbers. The values are the starting Source_Ptr values for the start
|
|
|
778 -- of the corresponding physical line. Note that we make this a bogus
|
|
|
779 -- big array, sized as required, so that we avoid the use of fat pointers.
|
|
|
780
|
|
|
781 type Lines_Table_Ptr is access all Lines_Table_Type;
|
|
|
782 -- Type used for pointers to line tables
|
|
|
783
|
|
|
784 type Logical_Lines_Table_Type is
|
|
|
785 array (Physical_Line_Number) of Logical_Line_Number;
|
|
|
786 -- Type used for logical lines table. This table is used if a source
|
|
|
787 -- reference pragma is present. It is indexed by physical line numbers,
|
|
|
788 -- and contains the corresponding logical line numbers. An entry that
|
|
|
789 -- corresponds to a source reference pragma is set to No_Line_Number.
|
|
|
790 -- Note that we make this a bogus big array, sized as required, so that
|
|
|
791 -- we avoid the use of fat pointers.
|
|
|
792
|
|
|
793 type Logical_Lines_Table_Ptr is access all Logical_Lines_Table_Type;
|
|
|
794 -- Type used for pointers to logical line tables
|
|
|
795
|
|
|
796 -----------------------
|
|
|
797 -- Source_File Table --
|
|
|
798 -----------------------
|
|
|
799
|
|
|
800 -- See earlier descriptions for meanings of public fields
|
|
|
801
|
|
|
802 type Source_File_Record is record
|
|
|
803 File_Name : File_Name_Type;
|
|
|
804 Reference_Name : File_Name_Type;
|
|
|
805 Debug_Source_Name : File_Name_Type;
|
|
|
806 Full_Debug_Name : File_Name_Type;
|
|
|
807 Full_File_Name : File_Name_Type;
|
|
|
808 Full_Ref_Name : File_Name_Type;
|
|
|
809 Instance : Instance_Id;
|
|
|
810 Num_SRef_Pragmas : Nat;
|
|
|
811 First_Mapped_Line : Logical_Line_Number;
|
|
|
812 Source_Text : Source_Buffer_Ptr;
|
|
|
813 Source_First : Source_Ptr;
|
|
|
814 Source_Last : Source_Ptr;
|
|
|
815 Source_Checksum : Word;
|
|
|
816 Last_Source_Line : Physical_Line_Number;
|
|
|
817 Template : Source_File_Index;
|
|
|
818 Unit : Unit_Number_Type;
|
|
|
819 Time_Stamp : Time_Stamp_Type;
|
|
|
820 File_Type : Type_Of_File;
|
|
|
821 Inlined_Call : Source_Ptr;
|
|
|
822 Inlined_Body : Boolean;
|
|
|
823 Inherited_Pragma : Boolean;
|
|
|
824 License : License_Type;
|
|
|
825 Keyword_Casing : Casing_Type;
|
|
|
826 Identifier_Casing : Casing_Type;
|
|
|
827
|
|
|
828 -- The following fields are for internal use only (i.e. only in the
|
|
|
829 -- body of Sinput or its children, with no direct access by clients).
|
|
|
830
|
|
|
831 Sloc_Adjust : Source_Ptr;
|
|
|
832 -- A value to be added to Sloc values for this file to reference the
|
|
|
833 -- corresponding lines table. This is zero for the non-instantiation
|
|
|
834 -- case, and set so that the addition references the ultimate template
|
|
|
835 -- for the instantiation case. See Sinput-L for further details.
|
|
|
836
|
|
|
837 Lines_Table : Lines_Table_Ptr;
|
|
|
838 -- Pointer to lines table for this source. Updated as additional
|
|
|
839 -- lines are accessed using the Skip_Line_Terminators procedure.
|
|
|
840 -- Note: the lines table for an instantiation entry refers to the
|
|
|
841 -- original line numbers of the template see Sinput-L for details.
|
|
|
842
|
|
|
843 Logical_Lines_Table : Logical_Lines_Table_Ptr;
|
|
|
844 -- Pointer to logical lines table for this source. Non-null only if
|
|
|
845 -- a source reference pragma has been processed. Updated as lines
|
|
|
846 -- are accessed using the Skip_Line_Terminators procedure.
|
|
|
847
|
|
|
848 Lines_Table_Max : Physical_Line_Number;
|
|
|
849 -- Maximum subscript values for currently allocated Lines_Table
|
|
|
850 -- and (if present) the allocated Logical_Lines_Table. The value
|
|
|
851 -- Max_Source_Line gives the maximum used value, this gives the
|
|
|
852 -- maximum allocated value.
|
|
|
853
|
|
|
854 Index : Source_File_Index := 123456789; -- for debugging
|
|
|
855 end record;
|
|
|
856
|
|
|
857 -- The following representation clause ensures that the above record
|
|
|
858 -- has no holes. We do this so that when instances of this record are
|
|
|
859 -- written by Tree_Gen, we do not write uninitialized values to the file.
|
|
|
860
|
|
|
861 AS : constant Pos := Standard'Address_Size;
|
|
|
862
|
|
|
863 for Source_File_Record use record
|
|
|
864 File_Name at 0 range 0 .. 31;
|
|
|
865 Reference_Name at 4 range 0 .. 31;
|
|
|
866 Debug_Source_Name at 8 range 0 .. 31;
|
|
|
867 Full_Debug_Name at 12 range 0 .. 31;
|
|
|
868 Full_File_Name at 16 range 0 .. 31;
|
|
|
869 Full_Ref_Name at 20 range 0 .. 31;
|
|
|
870 Instance at 48 range 0 .. 31;
|
|
|
871 Num_SRef_Pragmas at 24 range 0 .. 31;
|
|
|
872 First_Mapped_Line at 28 range 0 .. 31;
|
|
|
873 Source_First at 32 range 0 .. 31;
|
|
|
874 Source_Last at 36 range 0 .. 31;
|
|
|
875 Source_Checksum at 40 range 0 .. 31;
|
|
|
876 Last_Source_Line at 44 range 0 .. 31;
|
|
|
877 Template at 52 range 0 .. 31;
|
|
|
878 Unit at 56 range 0 .. 31;
|
|
|
879 Time_Stamp at 60 range 0 .. 8 * Time_Stamp_Length - 1;
|
|
|
880 File_Type at 74 range 0 .. 7;
|
|
|
881 Inlined_Call at 88 range 0 .. 31;
|
|
|
882 Inlined_Body at 75 range 0 .. 0;
|
|
|
883 Inherited_Pragma at 75 range 1 .. 1;
|
|
|
884 License at 76 range 0 .. 7;
|
|
|
885 Keyword_Casing at 77 range 0 .. 7;
|
|
|
886 Identifier_Casing at 78 range 0 .. 15;
|
|
|
887 Sloc_Adjust at 80 range 0 .. 31;
|
|
|
888 Lines_Table_Max at 84 range 0 .. 31;
|
|
|
889 Index at 92 range 0 .. 31;
|
|
|
890
|
|
|
891 -- The following fields are pointers, so we have to specialize their
|
|
|
892 -- lengths using pointer size, obtained above as Standard'Address_Size.
|
|
|
893 -- Note that Source_Text is a fat pointer, so it has size = AS*2.
|
|
|
894
|
|
|
895 Source_Text at 96 range 0 .. AS * 2 - 1;
|
|
|
896 Lines_Table at 96 range AS * 2 .. AS * 3 - 1;
|
|
|
897 Logical_Lines_Table at 96 range AS * 3 .. AS * 4 - 1;
|
|
|
898 end record; -- Source_File_Record
|
|
|
899
|
|
|
900 for Source_File_Record'Size use 96 * 8 + AS * 4;
|
|
|
901 -- This ensures that we did not leave out any fields
|
|
|
902
|
|
|
903 package Source_File is new Table.Table
|
|
|
904 (Table_Component_Type => Source_File_Record,
|
|
|
905 Table_Index_Type => Source_File_Index,
|
|
|
906 Table_Low_Bound => 1,
|
|
|
907 Table_Initial => Alloc.Source_File_Initial,
|
|
|
908 Table_Increment => Alloc.Source_File_Increment,
|
|
|
909 Table_Name => "Source_File");
|
|
|
910
|
|
|
911 -- Auxiliary table containing source location of instantiations. Index 0
|
|
|
912 -- is used for code that does not come from an instance.
|
|
|
913
|
|
|
914 package Instances is new Table.Table
|
|
|
915 (Table_Component_Type => Source_Ptr,
|
|
|
916 Table_Index_Type => Instance_Id,
|
|
|
917 Table_Low_Bound => 0,
|
|
|
918 Table_Initial => Alloc.Source_File_Initial,
|
|
|
919 Table_Increment => Alloc.Source_File_Increment,
|
|
|
920 Table_Name => "Instances");
|
|
|
921
|
|
|
922 -----------------
|
|
|
923 -- Subprograms --
|
|
|
924 -----------------
|
|
|
925
|
|
|
926 procedure Alloc_Line_Tables
|
|
|
927 (S : in out Source_File_Record;
|
|
|
928 New_Max : Nat);
|
|
|
929 -- Allocate or reallocate the lines table for the given source file so
|
|
|
930 -- that it can accommodate at least New_Max lines. Also allocates or
|
|
|
931 -- reallocates logical lines table if source ref pragmas are present.
|
|
|
932
|
|
|
933 procedure Add_Line_Tables_Entry
|
|
|
934 (S : in out Source_File_Record;
|
|
|
935 P : Source_Ptr);
|
|
|
936 -- Increment line table size by one (reallocating the lines table if
|
|
|
937 -- needed) and set the new entry to contain the value P. Also bumps
|
|
|
938 -- the Source_Line_Count field. If source reference pragmas are
|
|
|
939 -- present, also increments logical lines table size by one, and
|
|
|
940 -- sets new entry.
|
|
|
941
|
|
|
942 procedure Trim_Lines_Table (S : Source_File_Index);
|
|
|
943 -- Set lines table size for entry S in the source file table to
|
|
|
944 -- correspond to the current value of Num_Source_Lines, releasing
|
|
|
945 -- any unused storage. This is used by Sinput.L and Sinput.D.
|
|
|
946
|
|
|
947 procedure Set_Source_File_Index_Table (Xnew : Source_File_Index);
|
|
|
948 -- Sets entries in the Source_File_Index_Table for the newly created
|
|
|
949 -- Source_File table entry whose index is Xnew. The Source_First and
|
|
|
950 -- Source_Last fields of this entry must be set before the call.
|
|
|
951 -- See package body for details.
|
|
|
952
|
|
|
953 type Dope_Rec is record
|
|
|
954 First, Last : Source_Ptr'Base;
|
|
|
955 end record;
|
|
|
956 Dope_Rec_Size : constant := 2 * Source_Ptr'Base'Size;
|
|
|
957 for Dope_Rec'Size use Dope_Rec_Size;
|
|
|
958 for Dope_Rec'Alignment use Dope_Rec_Size / 8;
|
|
|
959 type Dope_Ptr is access all Dope_Rec;
|
|
|
960
|
|
|
961 procedure Set_Dope
|
|
|
962 (Src : System.Address; New_Dope : Dope_Ptr);
|
|
|
963 -- Src is the address of a variable of type Source_Buffer_Ptr, which is a
|
|
|
964 -- fat pointer. This sets the dope part of the fat pointer to point to the
|
|
|
965 -- specified New_Dope. This low-level processing is used to make the
|
|
|
966 -- Source_Text of an instance point to the same text as the template, but
|
|
|
967 -- with different bounds.
|
|
|
968
|
|
|
969 procedure Free_Dope (Src : System.Address);
|
|
|
970 -- Calls Unchecked_Deallocation on the dope part of the fat pointer Src
|
|
|
971
|
|
|
972 procedure Free_Source_Buffer (Src : in out Source_Buffer_Ptr);
|
|
|
973 -- Deallocates the source buffer
|
|
|
974
|
|
|
975 end Sinput;
|
