Build: Fix typo ac_cv_search_pthread_crate
[official-gcc.git] / gcc / ada / namet.ads
blobd3990cb9d4c4e14f87f4174ba05ad7b44b0d6f44
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- N A M E T --
6 -- --
7 -- S p e c --
8 -- --
9 -- Copyright (C) 1992-2024, Free Software Foundation, Inc. --
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. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
20 -- --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
23 -- --
24 ------------------------------------------------------------------------------
26 with Alloc;
27 with Hostparm; use Hostparm;
28 with Table;
29 with Types; use Types;
31 package Namet is
33 -- WARNING: There is a C version of this package. Any changes to this
34 -- source file must be properly reflected in the C header file namet.h
36 -- This package contains routines for handling the names table. The table
37 -- is used to store character strings for identifiers and operator symbols,
38 -- as well as other string values such as unit names and file names.
40 -- The forms of the entries are as follows:
42 -- Identifiers Stored with upper case letters folded to lower case.
43 -- Upper half (16#80# bit set) and wide characters are
44 -- stored in an encoded form (Uhh for upper half char,
45 -- Whhhh for wide characters, WWhhhhhhhh as provided by
46 -- the routine Append_Encoded, where hh are hex
47 -- digits for the character code using lower case a-f).
48 -- Normally the use of U or W in other internal names is
49 -- avoided, but these letters may be used in internal
50 -- names (without this special meaning), if they appear
51 -- as the last character of the name, or they are
52 -- followed by an upper case letter (other than the WW
53 -- sequence), or an underscore.
55 -- Operator symbols Stored with an initial letter O, and the remainder
56 -- of the name is the lower case characters XXX where
57 -- the name is Name_Op_XXX, see Snames spec for a full
58 -- list of the operator names. Normally the use of O
59 -- in other internal names is avoided, but it may be
60 -- used in internal names (without this special meaning)
61 -- if it is the last character of the name, or if it is
62 -- followed by an upper case letter or an underscore.
64 -- Character literals Character literals have names that are used only for
65 -- debugging and error message purposes. The form is an
66 -- upper case Q followed by a single lower case letter,
67 -- or by a Uxx/Wxxxx/WWxxxxxxx encoding as described for
68 -- identifiers. The Set_Character_Literal_Name procedure
69 -- should be used to construct these encodings. Normally
70 -- the use of O in other internal names is avoided, but
71 -- it may be used in internal names (without this special
72 -- meaning) if it is the last character of the name, or
73 -- if it is followed by an upper case letter or an
74 -- underscore.
76 -- Unit names Stored with upper case letters folded to lower case,
77 -- using Uhh/Whhhh/WWhhhhhhhh encoding as described for
78 -- identifiers, and a %s or %b suffix for specs/bodies.
79 -- See package Uname for further details.
81 -- File names Are stored in the form provided by Osint. Typically
82 -- they may include wide character escape sequences and
83 -- upper case characters (in non-encoded form). Casing
84 -- is also derived from the external environment. Note
85 -- that file names provided by Osint must generally be
86 -- consistent with the names from Fname.Get_File_Name.
88 -- Other strings The names table is also used as a convenient storage
89 -- location for other variable length strings such as
90 -- error messages etc. There are no restrictions on what
91 -- characters may appear for such entries.
93 -- Note: the encodings Uhh (upper half characters), Whhhh (wide characters),
94 -- WWhhhhhhhh (wide wide characters) and Qx (character literal names) are
95 -- described in the spec, since they are visible throughout the system (e.g.
96 -- in debugging output). However, no code should depend on these particular
97 -- encodings, so it should be possible to change the encodings by making
98 -- changes only to the Namet specification (to change these comments) and the
99 -- body (which actually implements the encodings).
101 -- The names are hashed so that a given name appears only once in the table,
102 -- except that names entered with Name_Enter as opposed to Name_Find are
103 -- omitted from the hash table.
105 -- The first 26 entries in the names table (with Name_Id values in the range
106 -- First_Name_Id .. First_Name_Id + 25) represent names which are the one
107 -- character lower case letters in the range a-z, and these names are created
108 -- and initialized by the Initialize procedure.
110 -- Five values, one of type Int, one of type Byte, and three of type Boolean,
111 -- are stored with each names table entry and subprograms are provided for
112 -- setting and retrieving these associated values. The usage of these values
113 -- is up to the client:
115 -- In the compiler we have the following uses:
117 -- The Int field is used to point to a chain of potentially visible
118 -- entities (see Sem.Ch8 for details).
120 -- The Byte field is used to hold the Token_Type value for reserved words
121 -- (see Sem for details).
123 -- The Boolean1 field is used to mark address clauses to optimize the
124 -- performance of the Exp_Util.Following_Address_Clause function.
126 -- The Boolean2 field is used to mark simple names that appear in
127 -- Restriction[_Warning]s pragmas for No_Use_Of_Entity. This avoids most
128 -- unnecessary searches of the No_Use_Of_Entity table.
130 -- The Boolean3 field is set for names of pragmas that are to be ignored
131 -- because of the occurrence of a corresponding pragma Ignore_Pragma.
133 -- In the binder, we have the following uses:
135 -- The Int field is used in various ways depending on the name involved,
136 -- see binder documentation for details.
138 -- The Byte and Boolean fields are unused.
140 -- Note that the value of the Int and Byte fields are initialized to zero,
141 -- and the Boolean field is initialized to False, when a new Name table entry
142 -- is created.
144 type Bounded_String (Max_Length : Natural := 2**12) is limited
145 -- It's unlikely to have names longer than this. But we don't want to make
146 -- it too big, because we declare these on the stack in recursive routines.
147 record
148 Length : Natural := 0;
149 Chars : String (1 .. Max_Length);
150 end record;
152 -- To create a Name_Id, you can declare a Bounded_String as a local
153 -- variable, and Append things onto it, and finally call Name_Find.
154 -- You can also use a String, as in:
155 -- X := Name_Find (Some_String & "_some_suffix");
157 -- For historical reasons, we also have the Global_Name_Buffer below,
158 -- which is used by most of the code via the renamings. New code ought
159 -- to avoid the global.
161 Global_Name_Buffer : Bounded_String (Max_Length => 4 * Max_Line_Length);
162 Name_Buffer : String renames Global_Name_Buffer.Chars;
163 Name_Len : Natural renames Global_Name_Buffer.Length;
165 -- Note that there is some circuitry (e.g. Osint.Write_Program_Name) that
166 -- does a save/restore on Name_Len and Name_Buffer (1 .. Name_Len). This
167 -- works in part because Name_Len is default-initialized to 0.
169 procedure Destroy_Global_Name_Buffer with Inline;
170 -- Overwrites Global_Name_Buffer with meaningless data. This can be used in
171 -- the transition away from Global_Name_Buffer, in order to detect cases
172 -- where we incorrectly rely on the global.
174 -----------------------------
175 -- Types for Namet Package --
176 -----------------------------
178 -- Name_Id values are used to identify entries in the names table. Except
179 -- for the special values No_Name and Error_Name, they are subscript values
180 -- for the Names table defined in this package.
182 -- Note that with only a few exceptions, which are clearly documented, the
183 -- type Name_Id should be regarded as a private type. In particular it is
184 -- never appropriate to perform arithmetic operations using this type.
186 type Name_Id is range Names_Low_Bound .. Names_High_Bound;
187 for Name_Id'Size use 32;
188 -- Type used to identify entries in the names table
190 No_Name : constant Name_Id := Names_Low_Bound;
191 -- The special Name_Id value No_Name is used in the parser to indicate
192 -- a situation where no name is present (e.g. on a loop or block).
194 Error_Name : constant Name_Id := Names_Low_Bound + 1;
195 -- The special Name_Id value Error_Name is used in the parser to
196 -- indicate that some kind of error was encountered in scanning out
197 -- the relevant name, so it does not have a representable label.
199 First_Name_Id : constant Name_Id := Names_Low_Bound + 2;
200 -- Subscript of first entry in names table
202 subtype Valid_Name_Id is Name_Id range First_Name_Id .. Name_Id'Last;
203 -- All but No_Name and Error_Name
205 function Present (Nam : Name_Id) return Boolean;
206 pragma Inline (Present);
207 -- Determine whether name Nam exists
209 -----------------
210 -- Subprograms --
211 -----------------
213 function To_String (Buf : Bounded_String) return String;
214 pragma Inline (To_String);
215 function "+" (Buf : Bounded_String) return String renames To_String;
217 function Name_Find
218 (Buf : Bounded_String := Global_Name_Buffer) return Valid_Name_Id;
219 function Name_Find (S : String) return Valid_Name_Id;
220 -- Name_Find searches the names table to see if the string has already been
221 -- stored. If so, the Id of the existing entry is returned. Otherwise a new
222 -- entry is created with its Name_Table_Int fields set to zero/false. Note
223 -- that it is permissible for Buf.Length to be zero to lookup the empty
224 -- name string.
226 function Name_Enter
227 (Buf : Bounded_String := Global_Name_Buffer) return Valid_Name_Id;
228 function Name_Enter (S : String) return Valid_Name_Id;
229 -- Name_Enter is similar to Name_Find. The difference is that it does not
230 -- search the table for an existing match, and also subsequent Name_Find
231 -- calls using the same name will not locate the entry created by this
232 -- call. Thus multiple calls to Name_Enter with the same name will create
233 -- multiple entries in the name table with different Name_Id values. This
234 -- is useful in the case of created names, which are never expected to be
235 -- looked up. Note: Name_Enter should never be used for one character
236 -- names, since these are efficiently located without hashing by Name_Find
237 -- in any case.
239 function Name_Equals
240 (N1 : Valid_Name_Id;
241 N2 : Valid_Name_Id) return Boolean;
242 -- Return whether N1 and N2 denote the same character sequence
244 function Get_Name_String (Id : Valid_Name_Id) return String;
245 -- Returns the characters of Id as a String. The lower bound is 1.
247 -- The following Append procedures ignore any characters that don't fit in
248 -- Buf.
250 procedure Append (Buf : in out Bounded_String; C : Character);
251 -- Append C onto Buf
252 pragma Inline (Append);
254 procedure Append (Buf : in out Bounded_String; V : Nat);
255 -- Append decimal representation of V onto Buf
257 procedure Append (Buf : in out Bounded_String; S : String);
258 -- Append S onto Buf
260 procedure Append (Buf : in out Bounded_String; Buf2 : Bounded_String);
261 -- Append Buf2 onto Buf
263 procedure Append (Buf : in out Bounded_String; Id : Valid_Name_Id);
264 -- Append the characters of Id onto Buf. It is an error to call this with
265 -- one of the special name Id values (No_Name or Error_Name).
267 procedure Append_Decoded (Buf : in out Bounded_String; Id : Valid_Name_Id);
268 -- Same as Append, except that the result is decoded, so that upper half
269 -- characters and wide characters appear as originally found in the source
270 -- program text, operators have their source forms (special characters and
271 -- enclosed in quotes), and character literals appear surrounded by
272 -- apostrophes.
274 procedure Append_Decoded_With_Brackets
275 (Buf : in out Bounded_String;
276 Id : Valid_Name_Id);
277 -- Same as Append_Decoded, except that the brackets notation (Uhh
278 -- replaced by ["hh"], Whhhh replaced by ["hhhh"], WWhhhhhhhh replaced by
279 -- ["hhhhhhhh"]) is used for all non-lower half characters, regardless of
280 -- how Opt.Wide_Character_Encoding_Method is set, and also in that
281 -- characters in the range 16#80# .. 16#FF# are converted to brackets
282 -- notation in all cases. This routine can be used when there is a
283 -- requirement for a canonical representation not affected by the
284 -- character set options (e.g. in the binder generation of symbols).
286 procedure Append_Unqualified
287 (Buf : in out Bounded_String; Id : Valid_Name_Id);
288 -- Same as Append, except that qualification (as defined in unit
289 -- Exp_Dbug) is removed (including both preceding __ delimited names, and
290 -- also the suffixes used to indicate package body entities and to
291 -- distinguish between overloaded entities). Note that names are not
292 -- qualified until just before the call to gigi, so this routine is only
293 -- needed by processing that occurs after gigi has been called.
295 procedure Append_Unqualified_Decoded
296 (Buf : in out Bounded_String;
297 Id : Valid_Name_Id);
298 -- Same as Append_Unqualified, but decoded as for Append_Decoded
300 procedure Append_Encoded (Buf : in out Bounded_String; C : Char_Code);
301 -- Appends given character code at the end of Buf. Lower case letters and
302 -- digits are stored unchanged. Other 8-bit characters are stored using the
303 -- Uhh encoding (hh = hex code), other 16-bit wide character values are
304 -- stored using the Whhhh (hhhh = hex code) encoding, and other 32-bit wide
305 -- wide character values are stored using the WWhhhhhhhh (hhhhhhhh = hex
306 -- code). Note that this procedure does not fold upper case letters (they
307 -- are stored using the Uhh encoding).
309 procedure Set_Character_Literal_Name
310 (Buf : in out Bounded_String;
311 C : Char_Code);
312 -- This procedure sets the proper encoded name for the character literal
313 -- for the given character code.
315 procedure Insert_Str
316 (Buf : in out Bounded_String;
317 S : String;
318 Index : Positive);
319 -- Inserts S in Buf, starting at Index. Any existing characters at or past
320 -- this location get moved beyond the inserted string.
322 function Is_Internal_Name (Buf : Bounded_String) return Boolean;
324 procedure Get_Last_Two_Chars
325 (N : Valid_Name_Id;
326 C1 : out Character;
327 C2 : out Character);
328 -- Obtains last two characters of a name. C1 is last but one character and
329 -- C2 is last character. If name is less than two characters long then both
330 -- C1 and C2 are set to ASCII.NUL on return.
332 function Get_Name_Table_Boolean1 (Id : Valid_Name_Id) return Boolean;
333 function Get_Name_Table_Boolean2 (Id : Valid_Name_Id) return Boolean;
334 function Get_Name_Table_Boolean3 (Id : Valid_Name_Id) return Boolean;
335 -- Fetches the Boolean values associated with the given name
337 function Get_Name_Table_Byte (Id : Valid_Name_Id) return Byte;
338 pragma Inline (Get_Name_Table_Byte);
339 -- Fetches the Byte value associated with the given name
341 function Get_Name_Table_Int (Id : Valid_Name_Id) return Int;
342 pragma Inline (Get_Name_Table_Int);
343 -- Fetches the Int value associated with the given name
345 procedure Set_Name_Table_Boolean1 (Id : Valid_Name_Id; Val : Boolean);
346 procedure Set_Name_Table_Boolean2 (Id : Valid_Name_Id; Val : Boolean);
347 procedure Set_Name_Table_Boolean3 (Id : Valid_Name_Id; Val : Boolean);
348 -- Sets the Boolean value associated with the given name
350 procedure Set_Name_Table_Byte (Id : Valid_Name_Id; Val : Byte);
351 pragma Inline (Set_Name_Table_Byte);
352 -- Sets the Byte value associated with the given name
354 procedure Set_Name_Table_Int (Id : Valid_Name_Id; Val : Int);
355 pragma Inline (Set_Name_Table_Int);
356 -- Sets the Int value associated with the given name
358 function Is_Internal_Name (Id : Valid_Name_Id) return Boolean;
359 -- Returns True if the name is an internal name, i.e. contains a character
360 -- for which Is_OK_Internal_Letter is true, or if the name starts or ends
361 -- with an underscore.
363 -- Note: if the name is qualified (has a double underscore), then only the
364 -- final entity name is considered, not the qualifying names. Consider for
365 -- example that the name:
367 -- pkg__B_1__xyz
369 -- is not an internal name, because the B comes from the internal name of
370 -- a qualifying block, but the xyz means that this was indeed a declared
371 -- identifier called "xyz" within this block and there is nothing internal
372 -- about that name.
374 function Is_OK_Internal_Letter (C : Character) return Boolean;
375 pragma Inline (Is_OK_Internal_Letter);
376 -- Returns true if C is a suitable character for using as a prefix or a
377 -- suffix of an internally generated name, i.e. it is an upper case letter
378 -- other than one of the ones used for encoding source names (currently the
379 -- set of reserved letters is O, Q, U, W) and also returns False for the
380 -- letter X, which is reserved for debug output (see Exp_Dbug).
382 function Is_Operator_Name (Id : Valid_Name_Id) return Boolean;
383 -- Returns True if name given is of the form of an operator (that is, it
384 -- starts with an upper case O).
386 function Is_Valid_Name (Id : Name_Id) return Boolean;
387 -- True if Id is a valid name - points to a valid entry in the Name_Entries
388 -- table.
390 function Length_Of_Name (Id : Valid_Name_Id) return Nat;
391 pragma Inline (Length_Of_Name);
392 -- Returns length of given name in characters. This is the length of the
393 -- encoded name, as stored in the names table.
395 procedure Initialize;
396 -- This is a dummy procedure. It is retained for easy compatibility with
397 -- clients who used to call Initialize when this call was required. Now
398 -- initialization is performed automatically during package elaboration.
399 -- Note that this change fixes problems which existed prior to the change
400 -- of Initialize being called more than once. See also Reinitialize which
401 -- allows reinitialization of the tables.
403 procedure Reinitialize;
404 -- Clears the name tables and removes all existing entries from the table.
406 procedure Reset_Name_Table;
407 -- This procedure is used when there are multiple source files to reset the
408 -- name table info entries associated with current entries in the names
409 -- table. There is no harm in keeping the names entries themselves from one
410 -- compilation to another, but we can't keep the entity info, since this
411 -- refers to tree nodes, which are destroyed between each main source file.
413 procedure Finalize;
414 -- Called at the end of a use of the Namet package (before a subsequent
415 -- call to Initialize). Currently this routine is only used to generate
416 -- debugging output.
418 procedure Lock;
419 -- Lock name tables before calling back end. We reserve some extra space
420 -- before locking to avoid unnecessary inefficiencies when we unlock.
422 procedure Unlock;
423 -- Unlocks the name table to allow use of the extra space reserved by the
424 -- call to Lock. See gnat1drv for details of the need for this.
426 procedure Write_Name (Id : Valid_Name_Id);
427 -- Write_Name writes the characters of the specified name using the
428 -- standard output procedures in package Output. The name is written
429 -- in encoded form (i.e. including Uhh, Whhh, Qx, _op as they appear in
430 -- the name table). If Id is Error_Name or No_Name, no text is output.
432 procedure Write_Name_Decoded (Id : Valid_Name_Id);
433 -- Like Write_Name, except that the name written is the decoded name, as
434 -- described for Append_Decoded.
436 procedure Write_Name_For_Debug (Id : Name_Id; Quote : String := "");
437 -- Like Write_Name, except it tries to be robust in the presence of invalid
438 -- data, and valid names are surrounded by Quote.
440 function Name_Entries_Count return Nat;
441 -- Return current number of entries in the names table
443 function Last_Name_Id return Name_Id;
444 -- Return the last Name_Id in the table. This information is valid until
445 -- new names have been added.
447 --------------------------
448 -- Obsolete Subprograms --
449 --------------------------
451 -- The following routines operate on Global_Name_Buffer. New code should
452 -- use the routines above, and declare Bounded_Strings as local
453 -- variables. Existing code can be improved incrementally by removing calls
454 -- to the following. If we eliminate all of these, we can remove
455 -- Global_Name_Buffer. But be sure to look at namet.h first.
457 -- To see what these do, look at the bodies. They are all trivially defined
458 -- in terms of routines above.
460 procedure Add_Char_To_Name_Buffer (C : Character);
461 pragma Inline (Add_Char_To_Name_Buffer);
463 procedure Add_Nat_To_Name_Buffer (V : Nat);
465 procedure Add_Str_To_Name_Buffer (S : String);
467 procedure Get_Decoded_Name_String (Id : Valid_Name_Id);
469 procedure Get_Decoded_Name_String_With_Brackets (Id : Valid_Name_Id);
471 procedure Get_Name_String (Id : Valid_Name_Id);
473 procedure Get_Name_String_And_Append (Id : Valid_Name_Id);
475 procedure Get_Unqualified_Decoded_Name_String (Id : Valid_Name_Id);
477 procedure Get_Unqualified_Name_String (Id : Valid_Name_Id);
479 procedure Insert_Str_In_Name_Buffer (S : String; Index : Positive);
481 function Is_Internal_Name return Boolean;
483 procedure Set_Character_Literal_Name (C : Char_Code);
485 procedure Store_Encoded_Character (C : Char_Code);
487 ------------------------------
488 -- File and Unit Name Types --
489 ------------------------------
491 -- These are defined here in Namet rather than Fname and Uname to avoid
492 -- problems with dependencies, and to avoid dragging in Fname and Uname
493 -- into many more files, but it would be cleaner to move to Fname/Uname.
495 type File_Name_Type is new Name_Id;
496 -- File names are stored in the names table and this type is used to
497 -- indicate that a Name_Id value is being used to hold a simple file name
498 -- (which does not include any directory information).
500 No_File : constant File_Name_Type := File_Name_Type (No_Name);
501 -- Constant used to indicate no file is present (this is used for example
502 -- when a search for a file indicates that no file of the name exists).
504 function Present (Nam : File_Name_Type) return Boolean;
505 pragma Inline (Present);
506 -- Determine whether file name Nam exists
508 Error_File_Name : constant File_Name_Type := File_Name_Type (Error_Name);
509 -- The special File_Name_Type value Error_File_Name is used to indicate
510 -- a unit name where some previous processing has found an error.
512 subtype Error_File_Name_Or_No_File is
513 File_Name_Type range No_File .. Error_File_Name;
514 -- Used to test for either error file name or no file
516 type Path_Name_Type is new Name_Id;
517 -- Path names are stored in the names table and this type is used to
518 -- indicate that a Name_Id value is being used to hold a path name (that
519 -- may contain directory information).
521 No_Path : constant Path_Name_Type := Path_Name_Type (No_Name);
522 -- Constant used to indicate no path name is present
524 type Unit_Name_Type is new Name_Id;
525 -- Unit names are stored in the names table and this type is used to
526 -- indicate that a Name_Id value is being used to hold a unit name, which
527 -- terminates in %b for a body or %s for a spec.
529 No_Unit_Name : constant Unit_Name_Type := Unit_Name_Type (No_Name);
530 -- Constant used to indicate no file name present
532 function Present (Nam : Unit_Name_Type) return Boolean;
533 pragma Inline (Present);
534 -- Determine whether unit name Nam exists
536 Error_Unit_Name : constant Unit_Name_Type := Unit_Name_Type (Error_Name);
537 -- The special Unit_Name_Type value Error_Unit_Name is used to indicate
538 -- a unit name where some previous processing has found an error.
540 subtype Error_Unit_Name_Or_No_Unit_Name is
541 Unit_Name_Type range No_Unit_Name .. Error_Unit_Name;
543 ------------------------
544 -- Debugging Routines --
545 ------------------------
547 procedure wn (Id : Name_Id);
548 pragma Export (Ada, wn);
549 -- Write Id to standard output, followed by a newline. Intended to be
550 -- called in the debugger.
552 private
554 ---------------------------
555 -- Table Data Structures --
556 ---------------------------
558 -- The following declarations define the data structures used to store
559 -- names. The definitions are in the private part of the package spec,
560 -- rather than the body, since they are referenced directly by gigi.
562 -- This table stores the actual string names. Although logically there is
563 -- no need for a terminating character (since the length is stored in the
564 -- name entry table), we still store a NUL character at the end of every
565 -- name (for convenience in interfacing to the C world).
567 package Name_Chars is new Table.Table (
568 Table_Component_Type => Character,
569 Table_Index_Type => Int,
570 Table_Low_Bound => 0,
571 Table_Initial => Alloc.Name_Chars_Initial,
572 Table_Increment => Alloc.Name_Chars_Increment,
573 Table_Name => "Name_Chars");
575 type Name_Entry is record
576 Name_Chars_Index : aliased Int;
577 -- Starting location of characters in the Name_Chars table minus one
578 -- (i.e. pointer to character just before first character). The reason
579 -- for the bias of one is that indexes in Name_Buffer are one's origin,
580 -- so this avoids unnecessary adds and subtracts of 1.
582 Name_Len : aliased Short;
583 -- Length of this name in characters
585 Byte_Info : aliased Byte;
586 -- Byte value associated with this name
588 Name_Has_No_Encodings : Boolean;
589 -- This flag is set True if the name entry is known not to contain any
590 -- special character encodings. This is used to speed up repeated calls
591 -- to Append_Decoded. A value of False means that it is not known
592 -- whether the name contains any such encodings.
594 Boolean1_Info : Boolean;
595 Boolean2_Info : Boolean;
596 Boolean3_Info : Boolean;
597 -- Boolean values associated with the name
599 Spare : Boolean;
600 -- Four remaining bits in the current byte
602 Hash_Link : aliased Name_Id;
603 -- Link to next entry in names table for same hash code
605 Int_Info : aliased Int;
606 -- Int Value associated with this name
608 end record;
610 for Name_Entry use record
611 Name_Chars_Index at 0 range 0 .. 31;
612 Name_Len at 4 range 0 .. 15;
613 Byte_Info at 6 range 0 .. 7;
614 Name_Has_No_Encodings at 7 range 0 .. 0;
615 Boolean1_Info at 7 range 1 .. 1;
616 Boolean2_Info at 7 range 2 .. 2;
617 Boolean3_Info at 7 range 3 .. 3;
618 Spare at 7 range 4 .. 7;
619 Hash_Link at 8 range 0 .. 31;
620 Int_Info at 12 range 0 .. 31;
621 end record;
623 for Name_Entry'Size use 16 * 8;
624 -- This ensures that we did not leave out any fields
626 -- This is the table that is referenced by Valid_Name_Id entries.
627 -- It contains one entry for each unique name in the table.
629 package Name_Entries is new Table.Table (
630 Table_Component_Type => Name_Entry,
631 Table_Index_Type => Valid_Name_Id'Base,
632 Table_Low_Bound => First_Name_Id,
633 Table_Initial => Alloc.Names_Initial,
634 Table_Increment => Alloc.Names_Increment,
635 Table_Name => "Name_Entries");
637 end Namet;