1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2020, Free Software Foundation, Inc. --
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. --
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. --
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/>. --
27 -- GNAT was originally developed by the GNAT team at New York University. --
28 -- Extensive contributions were provided by Ada Core Technologies Inc. --
30 ------------------------------------------------------------------------------
32 with Atree; use Atree;
33 with Casing; use Casing;
34 with Einfo; use Einfo;
37 with Nlists; use Nlists;
38 with Output; use Output;
39 with Sinfo; use Sinfo;
40 with Sinput; use Sinput;
44 function Has_Prefix (X, Prefix : String) return Boolean;
45 -- True if Prefix is at the beginning of X. For example,
46 -- Has_Prefix("a-filename.ads", Prefix => "a-") is True.
52 function Get_Body_Name (N : Unit_Name_Type) return Unit_Name_Type is
56 pragma Assert (Name_Len > 2
57 and then Name_Buffer (Name_Len - 1) = '%'
58 and then Name_Buffer (Name_Len) = 's');
60 Name_Buffer (Name_Len) := 'b';
64 -----------------------------------
65 -- Get_External_Unit_Name_String --
66 -----------------------------------
68 procedure Get_External_Unit_Name_String (N : Unit_Name_Type) is
73 -- Get unit name and eliminate trailing %s or %b
76 Name_Len := Name_Len - 2;
78 -- Find number of components
81 for J in 1 .. Name_Len loop
82 if Name_Buffer (J) = '.' then
87 -- If simple name, nothing to do
93 -- If name has multiple components, replace dots by double underscore
95 Newlen := Name_Len + Pcount;
97 for J in reverse 1 .. Name_Len loop
98 if Name_Buffer (J) = '.' then
99 Name_Buffer (Newlen) := '_';
100 Name_Buffer (Newlen - 1) := '_';
101 Newlen := Newlen - 2;
104 Name_Buffer (Newlen) := Name_Buffer (J);
105 Newlen := Newlen - 1;
109 Name_Len := Name_Len + Pcount;
110 end Get_External_Unit_Name_String;
112 --------------------------
113 -- Get_Parent_Body_Name --
114 --------------------------
116 function Get_Parent_Body_Name (N : Unit_Name_Type) return Unit_Name_Type is
120 while Name_Buffer (Name_Len) /= '.' loop
121 pragma Assert (Name_Len > 1); -- not a child or subunit name
122 Name_Len := Name_Len - 1;
125 Name_Buffer (Name_Len) := '%';
126 Name_Len := Name_Len + 1;
127 Name_Buffer (Name_Len) := 'b';
130 end Get_Parent_Body_Name;
132 --------------------------
133 -- Get_Parent_Spec_Name --
134 --------------------------
136 function Get_Parent_Spec_Name (N : Unit_Name_Type) return Unit_Name_Type is
140 while Name_Buffer (Name_Len) /= '.' loop
144 Name_Len := Name_Len - 1;
148 Name_Buffer (Name_Len) := '%';
149 Name_Len := Name_Len + 1;
150 Name_Buffer (Name_Len) := 's';
153 end Get_Parent_Spec_Name;
159 function Get_Spec_Name (N : Unit_Name_Type) return Unit_Name_Type is
163 pragma Assert (Name_Len > 2
164 and then Name_Buffer (Name_Len - 1) = '%'
165 and then Name_Buffer (Name_Len) = 'b');
167 Name_Buffer (Name_Len) := 's';
175 function Get_Unit_Name (N : Node_Id) return Unit_Name_Type is
177 Unit_Name_Buffer : String (1 .. Hostparm.Max_Name_Length);
178 -- Buffer used to build name of unit. Note that we cannot use the
179 -- Name_Buffer in package Name_Table because we use it to read
182 Unit_Name_Length : Natural := 0;
183 -- Length of name stored in Unit_Name_Buffer
188 procedure Add_Char (C : Character);
189 -- Add a single character to stored unit name
191 procedure Add_Name (Name : Name_Id);
192 -- Add the characters of a names table entry to stored unit name
194 procedure Add_Node_Name (Node : Node_Id);
195 -- Recursive procedure adds characters associated with Node
197 function Get_Parent (Node : Node_Id) return Node_Id;
198 -- Get parent compilation unit of a stub
204 procedure Add_Char (C : Character) is
206 -- Should really check for max length exceeded here???
207 Unit_Name_Length := Unit_Name_Length + 1;
208 Unit_Name_Buffer (Unit_Name_Length) := C;
215 procedure Add_Name (Name : Name_Id) is
217 Get_Name_String (Name);
219 for J in 1 .. Name_Len loop
220 Add_Char (Name_Buffer (J));
228 procedure Add_Node_Name (Node : Node_Id) is
229 Kind : constant Node_Kind := Nkind (Node);
232 -- Just ignore an error node (someone else will give a message)
237 -- Otherwise see what kind of node we have
241 when N_Defining_Identifier
242 | N_Defining_Operator_Symbol
245 -- Note: it is of course an error to have a defining
246 -- operator symbol at this point, but this is not where
247 -- the error is signalled, so we handle it nicely here.
249 Add_Name (Chars (Node));
251 when N_Defining_Program_Unit_Name =>
252 Add_Node_Name (Name (Node));
254 Add_Node_Name (Defining_Identifier (Node));
257 | N_Selected_Component
259 Add_Node_Name (Prefix (Node));
261 Add_Node_Name (Selector_Name (Node));
263 when N_Package_Specification
264 | N_Subprogram_Specification
266 Add_Node_Name (Defining_Unit_Name (Node));
268 when N_Generic_Declaration
269 | N_Package_Declaration
271 | N_Subprogram_Declaration
273 Add_Node_Name (Specification (Node));
275 when N_Generic_Instantiation =>
276 Add_Node_Name (Defining_Unit_Name (Node));
278 when N_Package_Body =>
279 Add_Node_Name (Defining_Unit_Name (Node));
281 when N_Protected_Body
284 Add_Node_Name (Defining_Identifier (Node));
286 when N_Package_Renaming_Declaration =>
287 Add_Node_Name (Defining_Unit_Name (Node));
289 when N_Subprogram_Renaming_Declaration =>
290 Add_Node_Name (Specification (Node));
292 when N_Generic_Renaming_Declaration =>
293 Add_Node_Name (Defining_Unit_Name (Node));
295 when N_Subprogram_Body_Stub =>
296 Add_Node_Name (Get_Parent (Node));
298 Add_Node_Name (Specification (Node));
300 when N_Compilation_Unit =>
301 Add_Node_Name (Unit (Node));
303 when N_Package_Body_Stub
304 | N_Protected_Body_Stub
307 Add_Node_Name (Get_Parent (Node));
309 Add_Node_Name (Defining_Identifier (Node));
312 Add_Node_Name (Name (Node));
314 Add_Node_Name (Proper_Body (Node));
316 when N_With_Clause =>
317 Add_Node_Name (Name (Node));
320 Add_Node_Name (Expression (First
321 (Pragma_Argument_Associations (Node))));
323 -- Tasks and protected stuff appear only in an error context,
324 -- but the error has been posted elsewhere, so we deal nicely
325 -- with these error situations here, and produce a reasonable
326 -- unit name using the defining identifier.
328 when N_Protected_Type_Declaration
329 | N_Single_Protected_Declaration
330 | N_Single_Task_Declaration
331 | N_Task_Type_Declaration
333 Add_Node_Name (Defining_Identifier (Node));
345 function Get_Parent (Node : Node_Id) return Node_Id is
349 while Nkind (N) /= N_Compilation_Unit loop
356 -- Start of processing for Get_Unit_Name
361 -- If we have Defining_Identifier, find the associated unit node
363 if Nkind (Node) = N_Defining_Identifier then
364 Node := Declaration_Node (Node);
366 -- If an expanded name, it is an already analyzed child unit, find
369 elsif Nkind (Node) = N_Expanded_Name then
370 Node := Declaration_Node (Entity (Node));
373 if Nkind (Node) = N_Package_Specification
374 or else Nkind (Node) in N_Subprogram_Specification
376 Node := Parent (Node);
379 -- Node points to the unit, so get its name and add proper suffix
381 Add_Node_Name (Node);
385 when N_Generic_Declaration
386 | N_Generic_Instantiation
387 | N_Generic_Renaming_Declaration
388 | N_Package_Declaration
389 | N_Package_Renaming_Declaration
391 | N_Protected_Type_Declaration
392 | N_Single_Protected_Declaration
393 | N_Single_Task_Declaration
394 | N_Subprogram_Declaration
395 | N_Subprogram_Renaming_Declaration
396 | N_Task_Type_Declaration
405 | N_Selected_Component
416 Name_Buffer (1 .. Unit_Name_Length) :=
417 Unit_Name_Buffer (1 .. Unit_Name_Length);
418 Name_Len := Unit_Name_Length;
423 --------------------------
424 -- Get_Unit_Name_String --
425 --------------------------
427 procedure Get_Unit_Name_String
429 Suffix : Boolean := True)
431 Unit_Is_Body : Boolean;
434 Get_Decoded_Name_String (N);
435 Unit_Is_Body := Name_Buffer (Name_Len) = 'b';
436 Set_Casing (Identifier_Casing (Source_Index (Main_Unit)));
438 -- A special fudge, normally we don't have operator symbols present,
439 -- since it is always an error to do so. However, if we do, at this
440 -- stage it has the form:
444 -- and the %s or %b has already been eliminated so put 2 chars back
446 if Name_Buffer (1) = '"' then
447 Name_Len := Name_Len + 2;
450 -- Now adjust the %s or %b to (spec) or (body)
454 Name_Buffer (Name_Len - 1 .. Name_Len + 5) := " (body)";
456 Name_Buffer (Name_Len - 1 .. Name_Len + 5) := " (spec)";
460 for J in 1 .. Name_Len loop
461 if Name_Buffer (J) = '-' then
462 Name_Buffer (J) := '.';
469 Name_Len := Name_Len + (7 - 2);
471 Name_Len := Name_Len - 2;
473 end Get_Unit_Name_String;
479 function Has_Prefix (X, Prefix : String) return Boolean is
481 if X'Length >= Prefix'Length then
483 Slice : String renames
484 X (X'First .. X'First + Prefix'Length - 1);
486 return Slice = Prefix;
496 function Is_Body_Name (N : Unit_Name_Type) return Boolean is
500 and then Name_Buffer (Name_Len - 1) = '%'
501 and then Name_Buffer (Name_Len) = 'b';
508 function Is_Child_Name (N : Unit_Name_Type) return Boolean is
515 while Name_Buffer (J) /= '.' loop
517 return False; -- not a child or subunit name
526 ---------------------------
527 -- Is_Internal_Unit_Name --
528 ---------------------------
530 function Is_Internal_Unit_Name
532 Renamings_Included : Boolean := True) return Boolean
534 Gnat : constant String := "gnat";
541 if Has_Prefix (Name, Prefix => Gnat & ".") then
545 return Is_Predefined_Unit_Name (Name, Renamings_Included);
546 end Is_Internal_Unit_Name;
548 -----------------------------
549 -- Is_Predefined_Unit_Name --
550 -----------------------------
552 function Is_Predefined_Unit_Name
554 Renamings_Included : Boolean := True) return Boolean
556 Ada : constant String := "ada";
557 Interfaces : constant String := "interfaces";
558 System : constant String := "system";
562 or else Name = Interfaces
563 or else Name = System
568 if Has_Prefix (Name, Prefix => Ada & ".")
569 or else Has_Prefix (Name, Prefix => Interfaces & ".")
570 or else Has_Prefix (Name, Prefix => System & ".")
575 if not Renamings_Included then
579 -- The following are the predefined renamings
583 or else Name = "machine_code"
584 or else Name = "unchecked_conversion"
585 or else Name = "unchecked_deallocation"
586 or else Name = "direct_io"
587 or else Name = "io_exceptions"
588 or else Name = "sequential_io"
589 or else Name = "text_io";
590 end Is_Predefined_Unit_Name;
596 function Is_Spec_Name (N : Unit_Name_Type) return Boolean is
600 and then Name_Buffer (Name_Len - 1) = '%'
601 and then Name_Buffer (Name_Len) = 's';
604 -----------------------
605 -- Name_To_Unit_Name --
606 -----------------------
608 function Name_To_Unit_Name (N : Name_Id) return Unit_Name_Type is
611 Name_Buffer (Name_Len + 1) := '%';
612 Name_Buffer (Name_Len + 2) := 's';
613 Name_Len := Name_Len + 2;
615 end Name_To_Unit_Name;
622 (Old : Unit_Name_Type;
623 Newp : Unit_Name_Type) return Unit_Name_Type
628 Get_Name_String (Old);
631 Child : constant String := Name_Buffer (1 .. Name_Len);
634 Get_Name_String (Newp);
635 Name_Len := Name_Len - 2;
638 while Child (P) /= '.' loop
642 while P <= Child'Last loop
643 Name_Len := Name_Len + 1;
644 Name_Buffer (Name_Len) := Child (P);
656 function Uname_Ge (Left, Right : Unit_Name_Type) return Boolean is
658 return Left = Right or else Uname_Gt (Left, Right);
665 function Uname_Gt (Left, Right : Unit_Name_Type) return Boolean is
667 return Left /= Right and then not Uname_Lt (Left, Right);
674 function Uname_Le (Left, Right : Unit_Name_Type) return Boolean is
676 return Left = Right or else Uname_Lt (Left, Right);
683 function Uname_Lt (Left, Right : Unit_Name_Type) return Boolean is
684 Left_Name : String (1 .. Hostparm.Max_Name_Length);
685 Left_Length : Natural;
686 Right_Name : String renames Name_Buffer;
687 Right_Length : Natural renames Name_Len;
691 pragma Warnings (Off, Right_Length);
692 -- Suppress warnings on Right_Length, used in pragma Assert
698 Get_Name_String (Left);
699 Left_Name (1 .. Name_Len + 1) := Name_Buffer (1 .. Name_Len + 1);
700 Left_Length := Name_Len;
701 Get_Name_String (Right);
705 exit when Left_Name (J) = '%';
707 if Right_Name (J) = '%' then
708 return False; -- left name is longer
711 pragma Assert (J <= Left_Length and then J <= Right_Length);
713 if Left_Name (J) /= Right_Name (J) then
714 return Left_Name (J) < Right_Name (J); -- parent names different
720 -- Come here pointing to % in left name
722 if Right_Name (J) /= '%' then
723 return True; -- right name is longer
726 -- Here the parent names are the same and specs sort low. If neither is
727 -- a spec, then we are comparing the same name and we want a result of
728 -- False in any case.
730 return Left_Name (J + 1) = 's';
733 ---------------------
734 -- Write_Unit_Name --
735 ---------------------
737 procedure Write_Unit_Name (N : Unit_Name_Type) is
739 Get_Unit_Name_String (N);
740 Write_Str (Name_Buffer (1 .. Name_Len));