| blob | bb62264c66b168115cf239ec7ce37c1b0188a0cf |
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 ------------------------
328 -----------------------------------------------------
329 -- Interface Hierarchy Units from Reference Manual --
330 -----------------------------------------------------
338 ------------------------------------------
339 -- GNAT Defined Additions to Interfaces --
340 ------------------------------------------
353 --------------------------------------------------
354 -- System Hierarchy Units from Reference Manual --
355 --------------------------------------------------
363 --------------------------------------
364 -- GNAT Defined Additions to System --
365 --------------------------------------
385 -- The following are strictly speaking Ada 2012 units, but we are allowed
386 -- to add children to system, so we consider them to be implementation
387 -- defined additions to System in earlier versions of Ada.
392 --------------------
393 -- Ada 2005 Units --
394 --------------------
396 -- The following units should be used only in Ada 05 mode
400 --------------------------------------------------------
401 -- Ada Hierarchy Units from Ada 2005 Reference Manual --
402 --------------------------------------------------------
472 ------------------------------------------------------
473 -- RM Required Additions to Ada 2005 for GNAT Types --
474 ------------------------------------------------------
476 -- Note: Long versions are considered RM defined, but not the Long Long,
477 -- Short, or Short_Short versions.
494 ----------------------------------------
495 -- GNAT Defined Additions to Ada 2005 --
496 ----------------------------------------
508 -- Note: strictly the following should be Ada 2012 units, but it seems
509 -- harmless (and useful) to make then available in Ada 2005 mode.
526 ---------------------------
527 -- GNAT Special IO Units --
528 ---------------------------
530 -- See Ada 95 section for further information. These packages are for the
531 -- implementation of the Wide_Wide_Text_IO generic packages.
540 ------------------------
541 -- GNAT Library Units --
542 ------------------------
547 --------------------
548 -- Ada 2012 Units --
549 --------------------
551 -- The following units should be used only in Ada 2012 mode
576 ----------------------------------------
577 -- GNAT Defined Additions to Ada 2012 --
578 ----------------------------------------
587 -----------------------
588 -- Alternative Units --
589 -----------------------
591 -- For some implementation units, there is a unit in the GNAT library
592 -- that has identical functionality that is usable. If we have such a
593 -- case we record the appropriate Unit name in Error_Msg_String.
600 -- Array of alternative unit names
613 -- Array giving mapping
618 ("htable", Shtable'Access),
619 ("os_lib", Sos_lib'Access),
620 ("regexp", Sregexp'Access),
621 ("regpat", Sregpat'Access),
622 ("string", Sstring'Access),
623 ("stusta", Sstusta'Access),
624 ("tasloc", Stasloc'Access),
625 ("utf_32", Sutf_32'Access));
627 ----------------------
628 -- Get_Kind_Of_Unit --
629 ----------------------
631 function Get_Kind_Of_Unit (U : Unit_Number_Type) return Kind_Of_Unit is
632 Fname : constant File_Name_Type := Unit_File_Name (U);
634 begin
635 Error_Msg_Strlen := 0;
636 Get_Name_String (Fname);
638 -- Ada/System/Interfaces are all Ada 95 units
640 if (Name_Len = 7 and then Name_Buffer (1 .. 7) = "ada.ads")
641 or else
642 (Name_Len = 10 and then Name_Buffer (1 .. 10) = "system.ads")
643 or else
644 (Name_Len = 12 and then Name_Buffer (1 .. 12) = "interfac.ads")
645 then
646 return Ada_95_Unit;
647 end if;
649 -- If length of file name is greater than 12, not predefined. The value
650 -- 12 here is an 8 char name with extension .ads.
652 if Name_Len > 12 then
653 return Not_Predefined_Unit;
654 end if;
656 -- Not predefined if file name does not start with a- g- s- i-
658 if Name_Len < 3
661 and then
663 and then
665 and then
667 then
668 return Not_Predefined_Unit;
669 end if;
671 -- To be considered predefined, the file name must end in .ads or .adb.
672 -- File names with other extensions (coming from the use of non-standard
673 -- file naming schemes) can never be predefined.
675 -- Note that in the context of a compiler, the .adb case will never
676 -- arise. However it can arise for other tools, e.g. gnatprove uses
677 -- this routine to detect when a construct comes from an instance of
678 -- a generic defined in a predefined unit.
680 if Name_Buffer (Name_Len - 3 .. Name_Len) /= ".ads"
681 and then
682 Name_Buffer (Name_Len - 3 .. Name_Len) /= ".adb"
683 then
684 return Not_Predefined_Unit;
685 end if;
687 -- Otherwise normalize file name to 8 characters
689 Name_Len := Name_Len - 4;
690 while Name_Len < 8 loop
691 Name_Len := Name_Len + 1;
693 end loop;
695 -- See if name is in 95 list
697 for J in Non_Imp_File_Names_95'Range loop
698 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_95 (J).Fname then
699 return Ada_95_Unit;
700 end if;
701 end loop;
703 -- See if name is in 2005 list
705 for J in Non_Imp_File_Names_05'Range loop
706 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_05 (J).Fname then
707 return Ada_2005_Unit;
708 end if;
709 end loop;
711 -- See if name is in 2012 list
713 for J in Non_Imp_File_Names_12'Range loop
714 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_12 (J).Fname then
715 return Ada_2012_Unit;
716 end if;
717 end loop;
719 -- Only remaining special possibilities are children of System.RPC and
720 -- System.Garlic and special files of the form System.Aux...
722 Get_Name_String (Unit_Name (U));
724 if Name_Len > 12
725 and then Name_Buffer (1 .. 11) = "system.rpc."
726 then
727 return Ada_95_Unit;
728 end if;
730 if Name_Len > 15
731 and then Name_Buffer (1 .. 14) = "system.garlic."
732 then
733 return Ada_95_Unit;
734 end if;
736 if Name_Len > 11
737 and then Name_Buffer (1 .. 10) = "system.aux"
738 then
739 return Ada_95_Unit;
740 end if;
742 -- All tests failed, this is definitely an implementation unit. See if
743 -- we have an alternative name.
745 Get_Name_String (Fname);
747 if Name_Len in 11 .. 12
748 and then Name_Buffer (1 .. 2) = "s-"
749 and then Name_Buffer (Name_Len - 3 .. Name_Len) = ".ads"
750 then
751 for J in Map_Array'Range loop
752 if (Name_Len = 12 and then
753 Name_Buffer (3 .. 8) = Map_Array (J).Fname)
754 or else
755 (Name_Len = 11 and then
756 Name_Buffer (3 .. 7) = Map_Array (J).Fname (1 .. 5))
757 then
758 Error_Msg_Strlen := Map_Array (J).Aname'Length;
759 Error_Msg_String (1 .. Error_Msg_Strlen) :=
760 Map_Array (J).Aname.all;
761 end if;
762 end loop;
763 end if;
765 return Implementation_Unit;
766 end Get_Kind_Of_Unit;
768 -------------------
769 -- Is_Known_Unit --
770 -------------------
772 function Is_Known_Unit (Nam : Node_Id) return Boolean is
773 Unam : Unit_Name_Type;
774 Fnam : File_Name_Type;
776 begin
777 -- If selector is not an identifier (e.g. it is a character literal or
778 -- some junk from a previous error), then definitely not a known unit.
780 if Nkind (Selector_Name (Nam)) /= N_Identifier then
781 return False;
782 end if;
784 -- Otherwise get corresponding file name
786 Unam := Get_Unit_Name (Nam);
787 Fnam := Get_File_Name (Unam, Subunit => False);
788 Get_Name_String (Fnam);
790 Error_Msg_Strlen := 0;
792 -- Ada/System/Interfaces are all Ada 95 units
794 if (Name_Len = 7 and then Name_Buffer (1 .. 7) = "ada.ads")
795 or else
796 (Name_Len = 10 and then Name_Buffer (1 .. 10) = "system.ads")
797 or else
798 (Name_Len = 12 and then Name_Buffer (1 .. 12) = "interfac.ads")
799 then
800 return True;
801 end if;
803 -- Remove extension from file name
805 if Name_Buffer (Name_Len - 3 .. Name_Len) = ".adb"
806 or else
807 Name_Buffer (Name_Len - 3 .. Name_Len) = ".ads"
808 then
809 Name_Len := Name_Len - 4;
810 else
811 return False;
812 end if;
814 -- Pad name to 8 characters
816 while Name_Len < 8 loop
817 Name_Len := Name_Len + 1;
819 end loop;
821 -- If length more than 8, definitely not a match
823 if Name_Len /= 8 then
824 return False;
825 end if;
827 -- If length is 8, search our tables
829 for J in Non_Imp_File_Names_95'Range loop
830 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_95 (J).Fname then
831 return True;
832 end if;
833 end loop;
835 for J in Non_Imp_File_Names_05'Range loop
836 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_05 (J).Fname then
837 return True;
838 end if;
839 end loop;
841 for J in Non_Imp_File_Names_12'Range loop
842 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_12 (J).Fname then
843 return True;
844 end if;
845 end loop;
847 -- If not found, not known
849 return False;
851 -- A safety guard, if we get an exception during this processing then it
852 -- is most likely the result of a previous error, or a peculiar case we
853 -- have not thought of. Since this routine is only used for error message
854 -- refinement, we will just return False.
856 exception
857 when others =>
858 return False;
859 end Is_Known_Unit;
861 ---------------------------
862 -- Not_Impl_Defined_Unit --
863 ---------------------------
865 function Not_Impl_Defined_Unit (U : Unit_Number_Type) return Boolean is
866 Fname : constant File_Name_Type := Unit_File_Name (U);
868 begin
869 Error_Msg_Strlen := 0;
870 Get_Name_String (Fname);
872 -- Ada/System/Interfaces are all RM-defined Ada 95 units
874 if (Name_Len = 7 and then Name_Buffer (1 .. 7) = "ada.ads")
875 or else
876 (Name_Len = 10 and then Name_Buffer (1 .. 10) = "system.ads")
877 or else
878 (Name_Len = 12 and then Name_Buffer (1 .. 12) = "interfac.ads")
879 then
880 return True;
881 end if;
883 -- If length of file name is greater than 12, then it's a user unit
884 -- and not a GNAT implementation defined unit.
886 if Name_Len > 12 then
887 return True;
888 end if;
890 -- Implementation defined if unit in the gnat hierarchy
892 if (Name_Len = 8 and then Name_Buffer (1 .. 8) = "gnat.ads")
893 or else (Name_Len > 2 and then Name_Buffer (1 .. 2) = "g-")
894 then
895 return False;
896 end if;
898 -- Not implementation defined if file name does not start with a- s- i-
900 if Name_Len < 3
903 and then
905 and then
907 then
908 return True;
909 end if;
911 -- Not impl-defined if file name does not end in .ads. This can happen
912 -- when non-standard file names are being used.
914 if Name_Buffer (Name_Len - 3 .. Name_Len) /= ".ads" then
915 return True;
916 end if;
918 -- Otherwise normalize file name to 8 characters
920 Name_Len := Name_Len - 4;
921 while Name_Len < 8 loop
922 Name_Len := Name_Len + 1;
924 end loop;
926 -- Check our lists of names, if we find a match, return corresponding
927 -- indication of whether the file is RM defined, respecting the RM
928 -- version in which it is defined.
930 for J in Non_Imp_File_Names_95'Range loop
931 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_95 (J).Fname then
932 return Non_Imp_File_Names_95 (J).RMdef;
933 end if;
934 end loop;
936 for J in Non_Imp_File_Names_05'Range loop
937 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_05 (J).Fname then
938 return Non_Imp_File_Names_05 (J).RMdef
939 and then Ada_Version >= Ada_2005;
940 end if;
941 end loop;
943 for J in Non_Imp_File_Names_12'Range loop
944 if Name_Buffer (1 .. 8) = Non_Imp_File_Names_12 (J).Fname then
945 return Non_Imp_File_Names_95 (J).RMdef
946 and then Ada_Version >= Ada_2012;
947 end if;
948 end loop;
950 -- If unit is in System, Ada or Interfaces hierarchies and did not match
951 -- any entry in the list, means it is an internal implementation defined
952 -- unit which the restriction should definition forbid.
954 return True;
955 end Not_Impl_Defined_Unit;
957 end Impunit;