| blob | c53391a17bd43651655a55f5f951da41b1576918 |
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-2017, 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 ------------------------------------------
358 --------------------------------------------------
359 -- System Hierarchy Units from Reference Manual --
360 --------------------------------------------------
368 --------------------------------------
369 -- GNAT Defined Additions to System --
370 --------------------------------------
392 -- The following are strictly speaking Ada 2012 units, but we are allowed
393 -- to add children to system, so we consider them to be implementation
394 -- defined additions to System in earlier versions of Ada.
399 --------------------
400 -- Ada 2005 Units --
401 --------------------
403 -- The following units should be used only in Ada 05 mode
407 --------------------------------------------------------
408 -- Ada Hierarchy Units from Ada 2005 Reference Manual --
409 --------------------------------------------------------
480 ------------------------------------------------------
481 -- RM Required Additions to Ada 2005 for GNAT Types --
482 ------------------------------------------------------
484 -- Note: Long versions are considered RM defined, but not the Long Long,
485 -- Short, or Short_Short versions.
502 ----------------------------------------
503 -- GNAT Defined Additions to Ada 2005 --
504 ----------------------------------------
516 -- Note: strictly the following should be Ada 2012 units, but it seems
517 -- harmless (and useful) to make then available in Ada 2005 mode.
535 ---------------------------
536 -- GNAT Special IO Units --
537 ---------------------------
539 -- See Ada 95 section for further information. These packages are for the
540 -- implementation of the Wide_Wide_Text_IO generic packages.
549 ------------------------
550 -- GNAT Library Units --
551 ------------------------
556 --------------------
557 -- Ada 2012 Units --
558 --------------------
560 -- The following units should be used only in Ada 2012 mode
586 ----------------------------------------
587 -- GNAT Defined Additions to Ada 2012 --
588 ----------------------------------------
602 -----------------------
603 -- Alternative Units --
604 -----------------------
606 -- For some implementation units, there is a unit in the GNAT library
607 -- that has identical functionality that is usable. If we have such a
608 -- case we record the appropriate Unit name in Error_Msg_String.
615 -- Array of alternative unit names
628 -- Array giving mapping
633 ("htable", Shtable'Access),
634 ("os_lib", Sos_lib'Access),
635 ("regexp", Sregexp'Access),
636 ("regpat", Sregpat'Access),
637 ("string", Sstring'Access),
638 ("stusta", Sstusta'Access),
639 ("tasloc", Stasloc'Access),
640 ("utf_32", Sutf_32'Access));
642 ----------------------
643 -- Get_Kind_Of_File --
644 ----------------------
646 function Get_Kind_Of_File (File : String) return Kind_Of_Unit is
647 pragma Assert (File'First = 1);
649 Buffer : String (1 .. 8);
651 begin
652 Error_Msg_Strlen := 0;
654 -- Ada/System/Interfaces are all Ada 95 units
656 if File = "ada.ads"
657 or else File = "interfac.ads"
658 or else File = "system.ads"
659 then
660 return Ada_95_Unit;
661 end if;
663 -- If length of file name is greater than 12, not predefined. The value
664 -- 12 here is an 8 char name with extension .ads.
666 if File'Length > 12 then
667 return Not_Predefined_Unit;
668 end if;
670 -- Not predefined if file name does not start with a- g- s- i-
672 if File'Length < 3
674 or else
679 then
680 return Not_Predefined_Unit;
681 end if;
683 -- To be considered predefined, the file name must end in .ads or .adb.
684 -- File names with other extensions (coming from the use of non-standard
685 -- file naming schemes) can never be predefined.
687 -- Note that in the context of a compiler, the .adb case will never
688 -- arise. However it can arise for other tools, e.g. gnatprove uses
689 -- this routine to detect when a construct comes from an instance of
690 -- a generic defined in a predefined unit.
692 if File (File'Last - 3 .. File'Last) /= ".ads"
693 and then
694 File (File'Last - 3 .. File'Last) /= ".adb"
695 then
696 return Not_Predefined_Unit;
697 end if;
699 -- Otherwise normalize file name to 8 characters
701 Buffer (1 .. File'Length - 4) := File (1 .. File'Length - 4);
703 for J in File'Length - 3 .. 8 loop
705 end loop;
707 -- See if name is in 95 list
709 for J in Non_Imp_File_Names_95'Range loop
710 if Buffer = Non_Imp_File_Names_95 (J).Fname then
711 return Ada_95_Unit;
712 end if;
713 end loop;
715 -- See if name is in 2005 list
717 for J in Non_Imp_File_Names_05'Range loop
718 if Buffer = Non_Imp_File_Names_05 (J).Fname then
719 return Ada_2005_Unit;
720 end if;
721 end loop;
723 -- See if name is in 2012 list
725 for J in Non_Imp_File_Names_12'Range loop
726 if Buffer = Non_Imp_File_Names_12 (J).Fname then
727 return Ada_2012_Unit;
728 end if;
729 end loop;
731 -- Only remaining special possibilities are children of System.RPC and
732 -- System.Garlic and special files of the form System.Aux...
734 if File (1 .. 5) = "s-aux"
735 or else File (1 .. 5) = "s-gar"
736 or else File (1 .. 5) = "s-rpc"
737 then
738 return Ada_95_Unit;
739 end if;
741 -- All tests failed, this is definitely an implementation unit. See if
742 -- we have an alternative name.
744 if File'Length in 11 .. 12
745 and then File (1 .. 2) = "s-"
746 and then File (File'Last - 3 .. File'Last) = ".ads"
747 then
748 for J in Map_Array'Range loop
749 if (File'Length = 12 and then
750 File (3 .. 8) = Map_Array (J).Fname)
751 or else
752 (File'Length = 11 and then
753 File (3 .. 7) = Map_Array (J).Fname (1 .. 5))
754 then
755 Error_Msg_Strlen := Map_Array (J).Aname'Length;
756 Error_Msg_String (1 .. Error_Msg_Strlen) :=
757 Map_Array (J).Aname.all;
758 end if;
759 end loop;
760 end if;
762 return Implementation_Unit;
763 end Get_Kind_Of_File;
765 ----------------------
766 -- Get_Kind_Of_Unit --
767 ----------------------
769 function Get_Kind_Of_Unit (U : Unit_Number_Type) return Kind_Of_Unit is
770 begin
771 Get_Name_String (Unit_File_Name (U));
772 return Get_Kind_Of_File (Name_Buffer (1 .. Name_Len));
773 end Get_Kind_Of_Unit;
775 -------------------
776 -- Is_Known_Unit --
777 -------------------
779 function Is_Known_Unit (Nam : Node_Id) return Boolean is
780 Unam : Unit_Name_Type;
781 Fnam : File_Name_Type;
783 begin
784 -- If selector is not an identifier (e.g. it is a character literal or
785 -- some junk from a previous error), then definitely not a known unit.
787 if Nkind (Selector_Name (Nam)) /= N_Identifier then
788 return False;
789 end if;
791 -- Otherwise get corresponding file name
793 Unam := Get_Unit_Name (Nam);
794 Fnam := Get_File_Name (Unam, Subunit => False);
795 Get_Name_String (Fnam);
797 Error_Msg_Strlen := 0;
799 -- Ada/System/Interfaces are all Ada 95 units
801 if (Name_Len = 7 and then Name_Buffer (1 .. 7) = "ada.ads")
802 or else
803 (Name_Len = 10 and then Name_Buffer (1 .. 10) = "system.ads")
804 or else
805 (Name_Len = 12 and then Name_Buffer (1 .. 12) = "interfac.ads")
806 then
807 return True;
808 end if;
810 -- Remove extension from file name
812 if Name_Buffer (Name_Len - 3 .. Name_Len) = ".adb"
813 or else
814 Name_Buffer (Name_Len - 3 .. Name_Len) = ".ads"
815 then
816 Name_Len := Name_Len - 4;
817 else
818 return False;
819 end if;
821 -- Pad name to 8 characters
823 while Name_Len < 8 loop
824 Name_Len := Name_Len + 1;
826 end loop;
828 -- If length more than 8, definitely not a match
830 if Name_Len /= 8 then
831 return False;
832 end if;
834 -- If length is 8, search our tables
836 for J in Non_Imp_File_Names_95'Range loop
837 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_95 (J).Fname then
838 return True;
839 end if;
840 end loop;
842 for J in Non_Imp_File_Names_05'Range loop
843 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_05 (J).Fname then
844 return True;
845 end if;
846 end loop;
848 for J in Non_Imp_File_Names_12'Range loop
849 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_12 (J).Fname then
850 return True;
851 end if;
852 end loop;
854 -- If not found, not known
856 return False;
858 -- A safety guard, if we get an exception during this processing then it
859 -- is most likely the result of a previous error, or a peculiar case we
860 -- have not thought of. Since this routine is only used for error message
861 -- refinement, we will just return False.
863 exception
864 when others =>
865 return False;
866 end Is_Known_Unit;
868 ---------------------------
869 -- Not_Impl_Defined_Unit --
870 ---------------------------
872 function Not_Impl_Defined_Unit (U : Unit_Number_Type) return Boolean is
873 Fname : constant File_Name_Type := Unit_File_Name (U);
875 begin
876 Error_Msg_Strlen := 0;
877 Get_Name_String (Fname);
879 -- Ada/System/Interfaces are all RM-defined Ada 95 units
881 if (Name_Len = 7 and then Name_Buffer (1 .. 7) = "ada.ads")
882 or else
883 (Name_Len = 10 and then Name_Buffer (1 .. 10) = "system.ads")
884 or else
885 (Name_Len = 12 and then Name_Buffer (1 .. 12) = "interfac.ads")
886 then
887 return True;
888 end if;
890 -- If length of file name is greater than 12, then it's a user unit
891 -- and not a GNAT implementation defined unit.
893 if Name_Len > 12 then
894 return True;
895 end if;
897 -- Implementation defined if unit in the gnat hierarchy
899 if (Name_Len = 8 and then Name_Buffer (1 .. 8) = "gnat.ads")
900 or else (Name_Len > 2 and then Name_Buffer (1 .. 2) = "g-")
901 then
902 return False;
903 end if;
905 -- Not implementation defined if file name does not start with a- s- i-
907 if Name_Len < 3
910 and then
912 and then
914 then
915 return True;
916 end if;
918 -- Not impl-defined if file name does not end in .ads. This can happen
919 -- when non-standard file names are being used.
921 if Name_Buffer (Name_Len - 3 .. Name_Len) /= ".ads" then
922 return True;
923 end if;
925 -- Otherwise normalize file name to 8 characters
927 Name_Len := Name_Len - 4;
928 while Name_Len < 8 loop
929 Name_Len := Name_Len + 1;
931 end loop;
933 -- Check our lists of names, if we find a match, return corresponding
934 -- indication of whether the file is RM defined, respecting the RM
935 -- version in which it is defined.
937 for J in Non_Imp_File_Names_95'Range loop
938 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_95 (J).Fname then
939 return Non_Imp_File_Names_95 (J).RMdef;
940 end if;
941 end loop;
943 for J in Non_Imp_File_Names_05'Range loop
944 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_05 (J).Fname then
945 return Non_Imp_File_Names_05 (J).RMdef
946 and then Ada_Version >= Ada_2005;
947 end if;
948 end loop;
950 for J in Non_Imp_File_Names_12'Range loop
951 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_12 (J).Fname then
952 return Non_Imp_File_Names_95 (J).RMdef
953 and then Ada_Version >= Ada_2012;
954 end if;
955 end loop;
957 -- If unit is in System, Ada or Interfaces hierarchies and did not match
958 -- any entry in the list, means it is an internal implementation defined
959 -- unit which the restriction should definition forbid.
961 return True;
962 end Not_Impl_Defined_Unit;
964 end Impunit;