| blob | 45b937944b30d847756b8efee3e49531fb0831a9 |
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- I M P U N I T --
6 -- --
7 -- B o d y --
8 -- --
9 -- Copyright (C) 2000-2015, 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 ------------------------------------------------------------------------------
35 -- Note: this package body is used by GPS and GNATBench to supply a list of
36 -- entries for help on available library routines.
44 -- 8 character name of unit
47 -- True if unit is RM defined. False for any unit that is implementation
48 -- defined (and thus not with'able in No_Implementation_Units mode).
55 -- Short hand for RM_Defined values in lists below
57 ------------------
58 -- Ada 95 Units --
59 ------------------
61 -- The following is a giant string list containing the names of all non-
62 -- implementation internal files, i.e. the complete list of files for
63 -- internal units which a program may legitimately WITH when operating in
64 -- either Ada 95 or Ada 2005 mode.
66 -- Note that this list should match the list of units documented in the
67 -- "GNAT Library" section of the GNAT Reference Manual. A unit listed here
68 -- must either be documented in that section or described in the Ada RM.
72 ------------------------------------------------------
73 -- Ada Hierarchy Units from Ada-95 Reference Manual --
74 ------------------------------------------------------
134 -------------------------------------------------
135 -- RM Required Additions to Ada for GNAT Types --
136 -------------------------------------------------
138 -- Note: Long versions are considered RM defined, but not the Long Long,
139 -- Short, or Short_Short versions.
165 -----------------------------------
166 -- GNAT Defined Additions to Ada --
167 -----------------------------------
187 -- Note: strictly the next two should be Ada 2005 units, but it seems
188 -- harmless (and useful) to make then available in Ada 95 mode, since
189 -- they only deal with Wide_Character, not Wide_Wide_Character.
194 -- Note: strictly the following should be Ada 2012 units, but it seems
195 -- harmless (and useful) to make then available in Ada 95 mode, since
196 -- they do not deal with Wide_Wide_Character.
204 ---------------------------
205 -- GNAT Special IO Units --
206 ---------------------------
208 -- As further explained elsewhere (see Sem_Ch10), the internal packages of
209 -- Text_IO and Wide_Text_IO are actually implemented as separate children,
210 -- but this fact is intended to be hidden from the user completely. Any
211 -- attempt to WITH one of these units will be diagnosed as an error later
212 -- on, but for now we do not consider these internal implementation units
213 -- (if we did, then we would get a junk warning which would be confusing
214 -- and unnecessary, given that we generate a clear error message).
230 ------------------------
231 -- GNAT Library Units --
232 ------------------------
333 -----------------------------------------------------
334 -- Interface Hierarchy Units from Reference Manual --
335 -----------------------------------------------------
343 ------------------------------------------
344 -- GNAT Defined Additions to Interfaces --
345 ------------------------------------------
357 --------------------------------------------------
358 -- System Hierarchy Units from Reference Manual --
359 --------------------------------------------------
367 --------------------------------------
368 -- GNAT Defined Additions to System --
369 --------------------------------------
391 -- The following are strictly speaking Ada 2012 units, but we are allowed
392 -- to add children to system, so we consider them to be implementation
393 -- defined additions to System in earlier versions of Ada.
398 --------------------
399 -- Ada 2005 Units --
400 --------------------
402 -- The following units should be used only in Ada 05 mode
406 --------------------------------------------------------
407 -- Ada Hierarchy Units from Ada 2005 Reference Manual --
408 --------------------------------------------------------
479 ------------------------------------------------------
480 -- RM Required Additions to Ada 2005 for GNAT Types --
481 ------------------------------------------------------
483 -- Note: Long versions are considered RM defined, but not the Long Long,
484 -- Short, or Short_Short versions.
501 ----------------------------------------
502 -- GNAT Defined Additions to Ada 2005 --
503 ----------------------------------------
515 -- Note: strictly the following should be Ada 2012 units, but it seems
516 -- harmless (and useful) to make then available in Ada 2005 mode.
534 ---------------------------
535 -- GNAT Special IO Units --
536 ---------------------------
538 -- See Ada 95 section for further information. These packages are for the
539 -- implementation of the Wide_Wide_Text_IO generic packages.
548 ------------------------
549 -- GNAT Library Units --
550 ------------------------
555 --------------------
556 -- Ada 2012 Units --
557 --------------------
559 -- The following units should be used only in Ada 2012 mode
585 ----------------------------------------
586 -- GNAT Defined Additions to Ada 2012 --
587 ----------------------------------------
598 -----------------------
599 -- Alternative Units --
600 -----------------------
602 -- For some implementation units, there is a unit in the GNAT library
603 -- that has identical functionality that is usable. If we have such a
604 -- case we record the appropriate Unit name in Error_Msg_String.
611 -- Array of alternative unit names
624 -- Array giving mapping
629 ("htable", Shtable'Access),
630 ("os_lib", Sos_lib'Access),
631 ("regexp", Sregexp'Access),
632 ("regpat", Sregpat'Access),
633 ("string", Sstring'Access),
634 ("stusta", Sstusta'Access),
635 ("tasloc", Stasloc'Access),
636 ("utf_32", Sutf_32'Access));
638 ----------------------
639 -- Get_Kind_Of_File --
640 ----------------------
642 function Get_Kind_Of_File (File : String) return Kind_Of_Unit is
643 pragma Assert (File'First = 1);
645 Buffer : String (1 .. 8);
647 begin
648 Error_Msg_Strlen := 0;
650 -- Ada/System/Interfaces are all Ada 95 units
652 if File = "ada.ads"
653 or else File = "interfac.ads"
654 or else File = "system.ads"
655 then
656 return Ada_95_Unit;
657 end if;
659 -- If length of file name is greater than 12, not predefined. The value
660 -- 12 here is an 8 char name with extension .ads.
662 if File'Length > 12 then
663 return Not_Predefined_Unit;
664 end if;
666 -- Not predefined if file name does not start with a- g- s- i-
668 if File'Length < 3
670 or else
675 then
676 return Not_Predefined_Unit;
677 end if;
679 -- To be considered predefined, the file name must end in .ads or .adb.
680 -- File names with other extensions (coming from the use of non-standard
681 -- file naming schemes) can never be predefined.
683 -- Note that in the context of a compiler, the .adb case will never
684 -- arise. However it can arise for other tools, e.g. gnatprove uses
685 -- this routine to detect when a construct comes from an instance of
686 -- a generic defined in a predefined unit.
688 if File (File'Last - 3 .. File'Last) /= ".ads"
689 and then
690 File (File'Last - 3 .. File'Last) /= ".adb"
691 then
692 return Not_Predefined_Unit;
693 end if;
695 -- Otherwise normalize file name to 8 characters
697 Buffer (1 .. File'Length - 4) := File (1 .. File'Length - 4);
699 for J in File'Length - 3 .. 8 loop
701 end loop;
703 -- See if name is in 95 list
705 for J in Non_Imp_File_Names_95'Range loop
706 if Buffer = Non_Imp_File_Names_95 (J).Fname then
707 return Ada_95_Unit;
708 end if;
709 end loop;
711 -- See if name is in 2005 list
713 for J in Non_Imp_File_Names_05'Range loop
714 if Buffer = Non_Imp_File_Names_05 (J).Fname then
715 return Ada_2005_Unit;
716 end if;
717 end loop;
719 -- See if name is in 2012 list
721 for J in Non_Imp_File_Names_12'Range loop
722 if Buffer = Non_Imp_File_Names_12 (J).Fname then
723 return Ada_2012_Unit;
724 end if;
725 end loop;
727 -- Only remaining special possibilities are children of System.RPC and
728 -- System.Garlic and special files of the form System.Aux...
730 if File (1 .. 5) = "s-aux"
731 or else File (1 .. 5) = "s-gar"
732 or else File (1 .. 5) = "s-rpc"
733 then
734 return Ada_95_Unit;
735 end if;
737 -- All tests failed, this is definitely an implementation unit. See if
738 -- we have an alternative name.
740 if File'Length in 11 .. 12
741 and then File (1 .. 2) = "s-"
742 and then File (File'Last - 3 .. File'Last) = ".ads"
743 then
744 for J in Map_Array'Range loop
745 if (File'Length = 12 and then
746 File (3 .. 8) = Map_Array (J).Fname)
747 or else
748 (File'Length = 11 and then
749 File (3 .. 7) = Map_Array (J).Fname (1 .. 5))
750 then
751 Error_Msg_Strlen := Map_Array (J).Aname'Length;
752 Error_Msg_String (1 .. Error_Msg_Strlen) :=
753 Map_Array (J).Aname.all;
754 end if;
755 end loop;
756 end if;
758 return Implementation_Unit;
759 end Get_Kind_Of_File;
761 ----------------------
762 -- Get_Kind_Of_Unit --
763 ----------------------
765 function Get_Kind_Of_Unit (U : Unit_Number_Type) return Kind_Of_Unit is
766 begin
767 Get_Name_String (Unit_File_Name (U));
768 return Get_Kind_Of_File (Name_Buffer (1 .. Name_Len));
769 end Get_Kind_Of_Unit;
771 -------------------
772 -- Is_Known_Unit --
773 -------------------
775 function Is_Known_Unit (Nam : Node_Id) return Boolean is
776 Unam : Unit_Name_Type;
777 Fnam : File_Name_Type;
779 begin
780 -- If selector is not an identifier (e.g. it is a character literal or
781 -- some junk from a previous error), then definitely not a known unit.
783 if Nkind (Selector_Name (Nam)) /= N_Identifier then
784 return False;
785 end if;
787 -- Otherwise get corresponding file name
789 Unam := Get_Unit_Name (Nam);
790 Fnam := Get_File_Name (Unam, Subunit => False);
791 Get_Name_String (Fnam);
793 Error_Msg_Strlen := 0;
795 -- Ada/System/Interfaces are all Ada 95 units
797 if (Name_Len = 7 and then Name_Buffer (1 .. 7) = "ada.ads")
798 or else
799 (Name_Len = 10 and then Name_Buffer (1 .. 10) = "system.ads")
800 or else
801 (Name_Len = 12 and then Name_Buffer (1 .. 12) = "interfac.ads")
802 then
803 return True;
804 end if;
806 -- Remove extension from file name
808 if Name_Buffer (Name_Len - 3 .. Name_Len) = ".adb"
809 or else
810 Name_Buffer (Name_Len - 3 .. Name_Len) = ".ads"
811 then
812 Name_Len := Name_Len - 4;
813 else
814 return False;
815 end if;
817 -- Pad name to 8 characters
819 while Name_Len < 8 loop
820 Name_Len := Name_Len + 1;
822 end loop;
824 -- If length more than 8, definitely not a match
826 if Name_Len /= 8 then
827 return False;
828 end if;
830 -- If length is 8, search our tables
832 for J in Non_Imp_File_Names_95'Range loop
833 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_95 (J).Fname then
834 return True;
835 end if;
836 end loop;
838 for J in Non_Imp_File_Names_05'Range loop
839 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_05 (J).Fname then
840 return True;
841 end if;
842 end loop;
844 for J in Non_Imp_File_Names_12'Range loop
845 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_12 (J).Fname then
846 return True;
847 end if;
848 end loop;
850 -- If not found, not known
852 return False;
854 -- A safety guard, if we get an exception during this processing then it
855 -- is most likely the result of a previous error, or a peculiar case we
856 -- have not thought of. Since this routine is only used for error message
857 -- refinement, we will just return False.
859 exception
860 when others =>
861 return False;
862 end Is_Known_Unit;
864 ---------------------------
865 -- Not_Impl_Defined_Unit --
866 ---------------------------
868 function Not_Impl_Defined_Unit (U : Unit_Number_Type) return Boolean is
869 Fname : constant File_Name_Type := Unit_File_Name (U);
871 begin
872 Error_Msg_Strlen := 0;
873 Get_Name_String (Fname);
875 -- Ada/System/Interfaces are all RM-defined Ada 95 units
877 if (Name_Len = 7 and then Name_Buffer (1 .. 7) = "ada.ads")
878 or else
879 (Name_Len = 10 and then Name_Buffer (1 .. 10) = "system.ads")
880 or else
881 (Name_Len = 12 and then Name_Buffer (1 .. 12) = "interfac.ads")
882 then
883 return True;
884 end if;
886 -- If length of file name is greater than 12, then it's a user unit
887 -- and not a GNAT implementation defined unit.
889 if Name_Len > 12 then
890 return True;
891 end if;
893 -- Implementation defined if unit in the gnat hierarchy
895 if (Name_Len = 8 and then Name_Buffer (1 .. 8) = "gnat.ads")
896 or else (Name_Len > 2 and then Name_Buffer (1 .. 2) = "g-")
897 then
898 return False;
899 end if;
901 -- Not implementation defined if file name does not start with a- s- i-
903 if Name_Len < 3
906 and then
908 and then
910 then
911 return True;
912 end if;
914 -- Not impl-defined if file name does not end in .ads. This can happen
915 -- when non-standard file names are being used.
917 if Name_Buffer (Name_Len - 3 .. Name_Len) /= ".ads" then
918 return True;
919 end if;
921 -- Otherwise normalize file name to 8 characters
923 Name_Len := Name_Len - 4;
924 while Name_Len < 8 loop
925 Name_Len := Name_Len + 1;
927 end loop;
929 -- Check our lists of names, if we find a match, return corresponding
930 -- indication of whether the file is RM defined, respecting the RM
931 -- version in which it is defined.
933 for J in Non_Imp_File_Names_95'Range loop
934 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_95 (J).Fname then
935 return Non_Imp_File_Names_95 (J).RMdef;
936 end if;
937 end loop;
939 for J in Non_Imp_File_Names_05'Range loop
940 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_05 (J).Fname then
941 return Non_Imp_File_Names_05 (J).RMdef
942 and then Ada_Version >= Ada_2005;
943 end if;
944 end loop;
946 for J in Non_Imp_File_Names_12'Range loop
947 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_12 (J).Fname then
948 return Non_Imp_File_Names_95 (J).RMdef
949 and then Ada_Version >= Ada_2012;
950 end if;
951 end loop;
953 -- If unit is in System, Ada or Interfaces hierarchies and did not match
954 -- any entry in the list, means it is an internal implementation defined
955 -- unit which the restriction should definition forbid.
957 return True;
958 end Not_Impl_Defined_Unit;
960 end Impunit;