| blob | bd32e8185499c60a86433a354420561e5aaddba9 |
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 ------------------------
331 -----------------------------------------------------
332 -- Interface Hierarchy Units from Reference Manual --
333 -----------------------------------------------------
341 ------------------------------------------
342 -- GNAT Defined Additions to Interfaces --
343 ------------------------------------------
355 --------------------------------------------------
356 -- System Hierarchy Units from Reference Manual --
357 --------------------------------------------------
365 --------------------------------------
366 -- GNAT Defined Additions to System --
367 --------------------------------------
389 -- The following are strictly speaking Ada 2012 units, but we are allowed
390 -- to add children to system, so we consider them to be implementation
391 -- defined additions to System in earlier versions of Ada.
396 --------------------
397 -- Ada 2005 Units --
398 --------------------
400 -- The following units should be used only in Ada 05 mode
404 --------------------------------------------------------
405 -- Ada Hierarchy Units from Ada 2005 Reference Manual --
406 --------------------------------------------------------
477 ------------------------------------------------------
478 -- RM Required Additions to Ada 2005 for GNAT Types --
479 ------------------------------------------------------
481 -- Note: Long versions are considered RM defined, but not the Long Long,
482 -- Short, or Short_Short versions.
499 ----------------------------------------
500 -- GNAT Defined Additions to Ada 2005 --
501 ----------------------------------------
513 -- Note: strictly the following should be Ada 2012 units, but it seems
514 -- harmless (and useful) to make then available in Ada 2005 mode.
532 ---------------------------
533 -- GNAT Special IO Units --
534 ---------------------------
536 -- See Ada 95 section for further information. These packages are for the
537 -- implementation of the Wide_Wide_Text_IO generic packages.
546 ------------------------
547 -- GNAT Library Units --
548 ------------------------
553 --------------------
554 -- Ada 2012 Units --
555 --------------------
557 -- The following units should be used only in Ada 2012 mode
583 ----------------------------------------
584 -- GNAT Defined Additions to Ada 2012 --
585 ----------------------------------------
596 -----------------------
597 -- Alternative Units --
598 -----------------------
600 -- For some implementation units, there is a unit in the GNAT library
601 -- that has identical functionality that is usable. If we have such a
602 -- case we record the appropriate Unit name in Error_Msg_String.
609 -- Array of alternative unit names
622 -- Array giving mapping
627 ("htable", Shtable'Access),
628 ("os_lib", Sos_lib'Access),
629 ("regexp", Sregexp'Access),
630 ("regpat", Sregpat'Access),
631 ("string", Sstring'Access),
632 ("stusta", Sstusta'Access),
633 ("tasloc", Stasloc'Access),
634 ("utf_32", Sutf_32'Access));
636 ----------------------
637 -- Get_Kind_Of_Unit --
638 ----------------------
640 function Get_Kind_Of_Unit (U : Unit_Number_Type) return Kind_Of_Unit is
641 Fname : constant File_Name_Type := Unit_File_Name (U);
643 begin
644 Error_Msg_Strlen := 0;
645 Get_Name_String (Fname);
647 -- Ada/System/Interfaces are all Ada 95 units
649 if (Name_Len = 7 and then Name_Buffer (1 .. 7) = "ada.ads")
650 or else
651 (Name_Len = 10 and then Name_Buffer (1 .. 10) = "system.ads")
652 or else
653 (Name_Len = 12 and then Name_Buffer (1 .. 12) = "interfac.ads")
654 then
655 return Ada_95_Unit;
656 end if;
658 -- If length of file name is greater than 12, not predefined. The value
659 -- 12 here is an 8 char name with extension .ads.
661 if Name_Len > 12 then
662 return Not_Predefined_Unit;
663 end if;
665 -- Not predefined if file name does not start with a- g- s- i-
667 if Name_Len < 3
670 and then
672 and then
674 and then
676 then
677 return Not_Predefined_Unit;
678 end if;
680 -- To be considered predefined, the file name must end in .ads or .adb.
681 -- File names with other extensions (coming from the use of non-standard
682 -- file naming schemes) can never be predefined.
684 -- Note that in the context of a compiler, the .adb case will never
685 -- arise. However it can arise for other tools, e.g. gnatprove uses
686 -- this routine to detect when a construct comes from an instance of
687 -- a generic defined in a predefined unit.
689 if Name_Buffer (Name_Len - 3 .. Name_Len) /= ".ads"
690 and then
691 Name_Buffer (Name_Len - 3 .. Name_Len) /= ".adb"
692 then
693 return Not_Predefined_Unit;
694 end if;
696 -- Otherwise normalize file name to 8 characters
698 Name_Len := Name_Len - 4;
699 while Name_Len < 8 loop
700 Name_Len := Name_Len + 1;
702 end loop;
704 -- See if name is in 95 list
706 for J in Non_Imp_File_Names_95'Range loop
707 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_95 (J).Fname then
708 return Ada_95_Unit;
709 end if;
710 end loop;
712 -- See if name is in 2005 list
714 for J in Non_Imp_File_Names_05'Range loop
715 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_05 (J).Fname then
716 return Ada_2005_Unit;
717 end if;
718 end loop;
720 -- See if name is in 2012 list
722 for J in Non_Imp_File_Names_12'Range loop
723 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_12 (J).Fname then
724 return Ada_2012_Unit;
725 end if;
726 end loop;
728 -- Only remaining special possibilities are children of System.RPC and
729 -- System.Garlic and special files of the form System.Aux...
731 Get_Name_String (Unit_Name (U));
733 if Name_Len > 12
734 and then Name_Buffer (1 .. 11) = "system.rpc."
735 then
736 return Ada_95_Unit;
737 end if;
739 if Name_Len > 15
740 and then Name_Buffer (1 .. 14) = "system.garlic."
741 then
742 return Ada_95_Unit;
743 end if;
745 if Name_Len > 11
746 and then Name_Buffer (1 .. 10) = "system.aux"
747 then
748 return Ada_95_Unit;
749 end if;
751 -- All tests failed, this is definitely an implementation unit. See if
752 -- we have an alternative name.
754 Get_Name_String (Fname);
756 if Name_Len in 11 .. 12
757 and then Name_Buffer (1 .. 2) = "s-"
758 and then Name_Buffer (Name_Len - 3 .. Name_Len) = ".ads"
759 then
760 for J in Map_Array'Range loop
761 if (Name_Len = 12 and then
762 Name_Buffer (3 .. 8) = Map_Array (J).Fname)
763 or else
764 (Name_Len = 11 and then
765 Name_Buffer (3 .. 7) = Map_Array (J).Fname (1 .. 5))
766 then
767 Error_Msg_Strlen := Map_Array (J).Aname'Length;
768 Error_Msg_String (1 .. Error_Msg_Strlen) :=
769 Map_Array (J).Aname.all;
770 end if;
771 end loop;
772 end if;
774 return Implementation_Unit;
775 end Get_Kind_Of_Unit;
777 -------------------
778 -- Is_Known_Unit --
779 -------------------
781 function Is_Known_Unit (Nam : Node_Id) return Boolean is
782 Unam : Unit_Name_Type;
783 Fnam : File_Name_Type;
785 begin
786 -- If selector is not an identifier (e.g. it is a character literal or
787 -- some junk from a previous error), then definitely not a known unit.
789 if Nkind (Selector_Name (Nam)) /= N_Identifier then
790 return False;
791 end if;
793 -- Otherwise get corresponding file name
795 Unam := Get_Unit_Name (Nam);
796 Fnam := Get_File_Name (Unam, Subunit => False);
797 Get_Name_String (Fnam);
799 Error_Msg_Strlen := 0;
801 -- Ada/System/Interfaces are all Ada 95 units
803 if (Name_Len = 7 and then Name_Buffer (1 .. 7) = "ada.ads")
804 or else
805 (Name_Len = 10 and then Name_Buffer (1 .. 10) = "system.ads")
806 or else
807 (Name_Len = 12 and then Name_Buffer (1 .. 12) = "interfac.ads")
808 then
809 return True;
810 end if;
812 -- Remove extension from file name
814 if Name_Buffer (Name_Len - 3 .. Name_Len) = ".adb"
815 or else
816 Name_Buffer (Name_Len - 3 .. Name_Len) = ".ads"
817 then
818 Name_Len := Name_Len - 4;
819 else
820 return False;
821 end if;
823 -- Pad name to 8 characters
825 while Name_Len < 8 loop
826 Name_Len := Name_Len + 1;
828 end loop;
830 -- If length more than 8, definitely not a match
832 if Name_Len /= 8 then
833 return False;
834 end if;
836 -- If length is 8, search our tables
838 for J in Non_Imp_File_Names_95'Range loop
839 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_95 (J).Fname then
840 return True;
841 end if;
842 end loop;
844 for J in Non_Imp_File_Names_05'Range loop
845 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_05 (J).Fname then
846 return True;
847 end if;
848 end loop;
850 for J in Non_Imp_File_Names_12'Range loop
851 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_12 (J).Fname then
852 return True;
853 end if;
854 end loop;
856 -- If not found, not known
858 return False;
860 -- A safety guard, if we get an exception during this processing then it
861 -- is most likely the result of a previous error, or a peculiar case we
862 -- have not thought of. Since this routine is only used for error message
863 -- refinement, we will just return False.
865 exception
866 when others =>
867 return False;
868 end Is_Known_Unit;
870 ---------------------------
871 -- Not_Impl_Defined_Unit --
872 ---------------------------
874 function Not_Impl_Defined_Unit (U : Unit_Number_Type) return Boolean is
875 Fname : constant File_Name_Type := Unit_File_Name (U);
877 begin
878 Error_Msg_Strlen := 0;
879 Get_Name_String (Fname);
881 -- Ada/System/Interfaces are all RM-defined Ada 95 units
883 if (Name_Len = 7 and then Name_Buffer (1 .. 7) = "ada.ads")
884 or else
885 (Name_Len = 10 and then Name_Buffer (1 .. 10) = "system.ads")
886 or else
887 (Name_Len = 12 and then Name_Buffer (1 .. 12) = "interfac.ads")
888 then
889 return True;
890 end if;
892 -- If length of file name is greater than 12, then it's a user unit
893 -- and not a GNAT implementation defined unit.
895 if Name_Len > 12 then
896 return True;
897 end if;
899 -- Implementation defined if unit in the gnat hierarchy
901 if (Name_Len = 8 and then Name_Buffer (1 .. 8) = "gnat.ads")
902 or else (Name_Len > 2 and then Name_Buffer (1 .. 2) = "g-")
903 then
904 return False;
905 end if;
907 -- Not implementation defined if file name does not start with a- s- i-
909 if Name_Len < 3
912 and then
914 and then
916 then
917 return True;
918 end if;
920 -- Not impl-defined if file name does not end in .ads. This can happen
921 -- when non-standard file names are being used.
923 if Name_Buffer (Name_Len - 3 .. Name_Len) /= ".ads" then
924 return True;
925 end if;
927 -- Otherwise normalize file name to 8 characters
929 Name_Len := Name_Len - 4;
930 while Name_Len < 8 loop
931 Name_Len := Name_Len + 1;
933 end loop;
935 -- Check our lists of names, if we find a match, return corresponding
936 -- indication of whether the file is RM defined, respecting the RM
937 -- version in which it is defined.
939 for J in Non_Imp_File_Names_95'Range loop
940 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_95 (J).Fname then
941 return Non_Imp_File_Names_95 (J).RMdef;
942 end if;
943 end loop;
945 for J in Non_Imp_File_Names_05'Range loop
946 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_05 (J).Fname then
947 return Non_Imp_File_Names_05 (J).RMdef
948 and then Ada_Version >= Ada_2005;
949 end if;
950 end loop;
952 for J in Non_Imp_File_Names_12'Range loop
953 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_12 (J).Fname then
954 return Non_Imp_File_Names_95 (J).RMdef
955 and then Ada_Version >= Ada_2012;
956 end if;
957 end loop;
959 -- If unit is in System, Ada or Interfaces hierarchies and did not match
960 -- any entry in the list, means it is an internal implementation defined
961 -- unit which the restriction should definition forbid.
963 return True;
964 end Not_Impl_Defined_Unit;
966 end Impunit;