1------------------------------------------------------------------------------
2--                                                                          --
3--                         GNAT COMPILER COMPONENTS                         --
4--                                                                          --
5--                              I M P U N I T                               --
6--                                                                          --
7--                                 S p e c                                  --
8--                                                                          --
9--          Copyright (C) 2000-2011, 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------------------------------------------------------------------------------
25
26--  This package contains data and functions used to determine if a given unit
27--  is an internal unit intended only for use by the implementation and which
28--  should not be directly WITH'ed by user code. It also checks for Ada 2005
29--  units that should only be WITH'ed in Ada 2005 mode, and Ada 2012 units
30--  that should only be WITH'ed in Ada 2012 mode.
31
32with Types; use Types;
33
34package Impunit is
35
36   type Kind_Of_Unit is
37     (Implementation_Unit,
38      --  Unit from predefined library intended to be used only by the compiler
39      --  generated code, or from the implementation of the run time. Use of
40      --  such a unit generates a warning unless the client is compiled with
41      --  the -gnatg switch. If we are being super strict, this should be an
42      --  error for the case of Ada units, but that seems over strenuous.
43
44      Not_Predefined_Unit,
45      --  This is not a predefined unit, so no checks are needed
46
47      Ada_95_Unit,
48      --  This unit is defined in the Ada 95 RM, and can be freely with'ed in
49      --  both Ada 95 mode and Ada 05 mode. Note that in Ada 83 mode, no child
50      --  units are allowed, so you can't even name such a unit.
51
52      Ada_2005_Unit,
53      --  This unit is defined in the Ada 2005 RM. Withing this unit from an
54      --  Ada 95 mode program will generate a warning (again, strictly speaking
55      --  this should be an error, but that seems over-strenuous).
56
57      Ada_2012_Unit);
58      --  This unit is defined in the Ada 2012 RM. Withing this unit from an
59      --  Ada 95 or 2005 mode program will generate a warning (again, strictly
60      --  speaking this should be an error, but that seems over-strenuous).
61
62   function Get_Kind_Of_Unit (U : Unit_Number_Type) return Kind_Of_Unit;
63   --  Given the unit number of a unit, this function determines the type
64   --  of the unit, as defined above. If the result is Implementation_Unit,
65   --  then the name of a possible atlernative equivalent unit is placed in
66   --  Error_Msg_String/Slen on return. If there is no alternative name, or if
67   --  the result is not Implementation_Unit, then Error_Msg_Slen is zero on
68   --  return, indicating that no alternative name was found.
69
70   function Is_Known_Unit (Nam : Node_Id) return Boolean;
71   --  Nam is the possible name of a child unit, represented as a selected
72   --  component node. This function determines whether the name matches one of
73   --  the known library units, and if so, returns True. If the name does not
74   --  match any known library unit, False is returned.
75
76   function Not_Impl_Defined_Unit (U : Unit_Number_Type) return Boolean;
77   --  This function returns True if U represents a unit that is permitted by
78   --  the restriction No_Implementation_Units (i.e. a unit in the Ada, System,
79   --  and Interfaces hierarchies that is defined in the RM, or a user defined
80   --  unit. It returns False if U represents a unit that is not permitted by
81   --  this restriction, which includes units in these three hierarchies that
82   --  are GNAT implementation defined. It also returns False for any units in
83   --  the GNAT hierarchy, which is not strictly conforming, but so obviously
84   --  useful that it is a reasonable deviation from the standard.
85
86end Impunit;
87