| blob | 6b6b45febaaf4d737be68795554d431de1828493 |
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-2013, 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 ------------------------
329 -----------------------------------------------------
330 -- Interface Hierarchy Units from Reference Manual --
331 -----------------------------------------------------
339 ------------------------------------------
340 -- GNAT Defined Additions to Interfaces --
341 ------------------------------------------
354 --------------------------------------------------
355 -- System Hierarchy Units from Reference Manual --
356 --------------------------------------------------
364 --------------------------------------
365 -- GNAT Defined Additions to System --
366 --------------------------------------
386 -- The following are strictly speaking Ada 2012 units, but we are allowed
387 -- to add children to system, so we consider them to be implementation
388 -- defined additions to System in earlier versions of Ada.
393 --------------------
394 -- Ada 2005 Units --
395 --------------------
397 -- The following units should be used only in Ada 05 mode
401 --------------------------------------------------------
402 -- Ada Hierarchy Units from Ada 2005 Reference Manual --
403 --------------------------------------------------------
473 ------------------------------------------------------
474 -- RM Required Additions to Ada 2005 for GNAT Types --
475 ------------------------------------------------------
477 -- Note: Long versions are considered RM defined, but not the Long Long,
478 -- Short, or Short_Short versions.
495 ----------------------------------------
496 -- GNAT Defined Additions to Ada 2005 --
497 ----------------------------------------
509 -- Note: strictly the following should be Ada 2012 units, but it seems
510 -- harmless (and useful) to make then available in Ada 2005 mode.
527 ---------------------------
528 -- GNAT Special IO Units --
529 ---------------------------
531 -- See Ada 95 section for further information. These packages are for the
532 -- implementation of the Wide_Wide_Text_IO generic packages.
541 ------------------------
542 -- GNAT Library Units --
543 ------------------------
548 --------------------
549 -- Ada 2012 Units --
550 --------------------
552 -- The following units should be used only in Ada 2012 mode
577 ----------------------------------------
578 -- GNAT Defined Additions to Ada 2012 --
579 ----------------------------------------
588 -----------------------
589 -- Alternative Units --
590 -----------------------
592 -- For some implementation units, there is a unit in the GNAT library
593 -- that has identical functionality that is usable. If we have such a
594 -- case we record the appropriate Unit name in Error_Msg_String.
601 -- Array of alternative unit names
614 -- Array giving mapping
619 ("htable", Shtable'Access),
620 ("os_lib", Sos_lib'Access),
621 ("regexp", Sregexp'Access),
622 ("regpat", Sregpat'Access),
623 ("string", Sstring'Access),
624 ("stusta", Sstusta'Access),
625 ("tasloc", Stasloc'Access),
626 ("utf_32", Sutf_32'Access));
628 ----------------------
629 -- Get_Kind_Of_Unit --
630 ----------------------
632 function Get_Kind_Of_Unit (U : Unit_Number_Type) return Kind_Of_Unit is
633 Fname : constant File_Name_Type := Unit_File_Name (U);
635 begin
636 Error_Msg_Strlen := 0;
637 Get_Name_String (Fname);
639 -- Ada/System/Interfaces are all Ada 95 units
641 if (Name_Len = 7 and then Name_Buffer (1 .. 7) = "ada.ads")
642 or else
643 (Name_Len = 10 and then Name_Buffer (1 .. 10) = "system.ads")
644 or else
645 (Name_Len = 12 and then Name_Buffer (1 .. 12) = "interfac.ads")
646 then
647 return Ada_95_Unit;
648 end if;
650 -- If length of file name is greater than 12, not predefined. The value
651 -- 12 here is an 8 char name with extension .ads.
653 if Name_Len > 12 then
654 return Not_Predefined_Unit;
655 end if;
657 -- Not predefined if file name does not start with a- g- s- i-
659 if Name_Len < 3
662 and then
664 and then
666 and then
668 then
669 return Not_Predefined_Unit;
670 end if;
672 -- To be considered predefined, the file name must end in .ads or .adb.
673 -- File names with other extensions (coming from the use of non-standard
674 -- file naming schemes) can never be predefined.
676 -- Note that in the context of a compiler, the .adb case will never
677 -- arise. However it can arise for other tools, e.g. gnatprove uses
678 -- this routine to detect when a construct comes from an instance of
679 -- a generic defined in a predefined unit.
681 if Name_Buffer (Name_Len - 3 .. Name_Len) /= ".ads"
682 and then
683 Name_Buffer (Name_Len - 3 .. Name_Len) /= ".adb"
684 then
685 return Not_Predefined_Unit;
686 end if;
688 -- Otherwise normalize file name to 8 characters
690 Name_Len := Name_Len - 4;
691 while Name_Len < 8 loop
692 Name_Len := Name_Len + 1;
694 end loop;
696 -- See if name is in 95 list
698 for J in Non_Imp_File_Names_95'Range loop
699 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_95 (J).Fname then
700 return Ada_95_Unit;
701 end if;
702 end loop;
704 -- See if name is in 2005 list
706 for J in Non_Imp_File_Names_05'Range loop
707 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_05 (J).Fname then
708 return Ada_2005_Unit;
709 end if;
710 end loop;
712 -- See if name is in 2012 list
714 for J in Non_Imp_File_Names_12'Range loop
715 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_12 (J).Fname then
716 return Ada_2012_Unit;
717 end if;
718 end loop;
720 -- Only remaining special possibilities are children of System.RPC and
721 -- System.Garlic and special files of the form System.Aux...
723 Get_Name_String (Unit_Name (U));
725 if Name_Len > 12
726 and then Name_Buffer (1 .. 11) = "system.rpc."
727 then
728 return Ada_95_Unit;
729 end if;
731 if Name_Len > 15
732 and then Name_Buffer (1 .. 14) = "system.garlic."
733 then
734 return Ada_95_Unit;
735 end if;
737 if Name_Len > 11
738 and then Name_Buffer (1 .. 10) = "system.aux"
739 then
740 return Ada_95_Unit;
741 end if;
743 -- All tests failed, this is definitely an implementation unit. See if
744 -- we have an alternative name.
746 Get_Name_String (Fname);
748 if Name_Len in 11 .. 12
749 and then Name_Buffer (1 .. 2) = "s-"
750 and then Name_Buffer (Name_Len - 3 .. Name_Len) = ".ads"
751 then
752 for J in Map_Array'Range loop
753 if (Name_Len = 12 and then
754 Name_Buffer (3 .. 8) = Map_Array (J).Fname)
755 or else
756 (Name_Len = 11 and then
757 Name_Buffer (3 .. 7) = Map_Array (J).Fname (1 .. 5))
758 then
759 Error_Msg_Strlen := Map_Array (J).Aname'Length;
760 Error_Msg_String (1 .. Error_Msg_Strlen) :=
761 Map_Array (J).Aname.all;
762 end if;
763 end loop;
764 end if;
766 return Implementation_Unit;
767 end Get_Kind_Of_Unit;
769 -------------------
770 -- Is_Known_Unit --
771 -------------------
773 function Is_Known_Unit (Nam : Node_Id) return Boolean is
774 Unam : Unit_Name_Type;
775 Fnam : File_Name_Type;
777 begin
778 -- If selector is not an identifier (e.g. it is a character literal or
779 -- some junk from a previous error), then definitely not a known unit.
781 if Nkind (Selector_Name (Nam)) /= N_Identifier then
782 return False;
783 end if;
785 -- Otherwise get corresponding file name
787 Unam := Get_Unit_Name (Nam);
788 Fnam := Get_File_Name (Unam, Subunit => False);
789 Get_Name_String (Fnam);
791 Error_Msg_Strlen := 0;
793 -- Ada/System/Interfaces are all Ada 95 units
795 if (Name_Len = 7 and then Name_Buffer (1 .. 7) = "ada.ads")
796 or else
797 (Name_Len = 10 and then Name_Buffer (1 .. 10) = "system.ads")
798 or else
799 (Name_Len = 12 and then Name_Buffer (1 .. 12) = "interfac.ads")
800 then
801 return True;
802 end if;
804 -- Remove extension from file name
806 if Name_Buffer (Name_Len - 3 .. Name_Len) = ".adb"
807 or else
808 Name_Buffer (Name_Len - 3 .. Name_Len) = ".ads"
809 then
810 Name_Len := Name_Len - 4;
811 else
812 return False;
813 end if;
815 -- Pad name to 8 characters
817 while Name_Len < 8 loop
818 Name_Len := Name_Len + 1;
820 end loop;
822 -- If length more than 8, definitely not a match
824 if Name_Len /= 8 then
825 return False;
826 end if;
828 -- If length is 8, search our tables
830 for J in Non_Imp_File_Names_95'Range loop
831 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_95 (J).Fname then
832 return True;
833 end if;
834 end loop;
836 for J in Non_Imp_File_Names_05'Range loop
837 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_05 (J).Fname then
838 return True;
839 end if;
840 end loop;
842 for J in Non_Imp_File_Names_12'Range loop
843 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_12 (J).Fname then
844 return True;
845 end if;
846 end loop;
848 -- If not found, not known
850 return False;
852 -- A safety guard, if we get an exception during this processing then it
853 -- is most likely the result of a previous error, or a peculiar case we
854 -- have not thought of. Since this routine is only used for error message
855 -- refinement, we will just return False.
857 exception
858 when others =>
859 return False;
860 end Is_Known_Unit;
862 ---------------------------
863 -- Not_Impl_Defined_Unit --
864 ---------------------------
866 function Not_Impl_Defined_Unit (U : Unit_Number_Type) return Boolean is
867 Fname : constant File_Name_Type := Unit_File_Name (U);
869 begin
870 Error_Msg_Strlen := 0;
871 Get_Name_String (Fname);
873 -- Ada/System/Interfaces are all RM-defined Ada 95 units
875 if (Name_Len = 7 and then Name_Buffer (1 .. 7) = "ada.ads")
876 or else
877 (Name_Len = 10 and then Name_Buffer (1 .. 10) = "system.ads")
878 or else
879 (Name_Len = 12 and then Name_Buffer (1 .. 12) = "interfac.ads")
880 then
881 return True;
882 end if;
884 -- If length of file name is greater than 12, then it's a user unit
885 -- and not a GNAT implementation defined unit.
887 if Name_Len > 12 then
888 return True;
889 end if;
891 -- Implementation defined if unit in the gnat hierarchy
893 if (Name_Len = 8 and then Name_Buffer (1 .. 8) = "gnat.ads")
894 or else (Name_Len > 2 and then Name_Buffer (1 .. 2) = "g-")
895 then
896 return False;
897 end if;
899 -- Not implementation defined if file name does not start with a- s- i-
901 if Name_Len < 3
904 and then
906 and then
908 then
909 return True;
910 end if;
912 -- Not impl-defined if file name does not end in .ads. This can happen
913 -- when non-standard file names are being used.
915 if Name_Buffer (Name_Len - 3 .. Name_Len) /= ".ads" then
916 return True;
917 end if;
919 -- Otherwise normalize file name to 8 characters
921 Name_Len := Name_Len - 4;
922 while Name_Len < 8 loop
923 Name_Len := Name_Len + 1;
925 end loop;
927 -- Check our lists of names, if we find a match, return corresponding
928 -- indication of whether the file is RM defined, respecting the RM
929 -- version in which it is defined.
931 for J in Non_Imp_File_Names_95'Range loop
932 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_95 (J).Fname then
933 return Non_Imp_File_Names_95 (J).RMdef;
934 end if;
935 end loop;
937 for J in Non_Imp_File_Names_05'Range loop
938 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_05 (J).Fname then
939 return Non_Imp_File_Names_05 (J).RMdef
940 and then Ada_Version >= Ada_2005;
941 end if;
942 end loop;
944 for J in Non_Imp_File_Names_12'Range loop
945 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_12 (J).Fname then
946 return Non_Imp_File_Names_95 (J).RMdef
947 and then Ada_Version >= Ada_2012;
948 end if;
949 end loop;
951 -- If unit is in System, Ada or Interfaces hierarchies and did not match
952 -- any entry in the list, means it is an internal implementation defined
953 -- unit which the restriction should definition forbid.
955 return True;
956 end Not_Impl_Defined_Unit;
958 end Impunit;