gcc/ada/fname.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                                F N A M E                                 --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --                            $Revision: 1.1 $
  10 --                                                                          --
  11 --          Copyright (C) 1992-2000 Free Software Foundation, Inc.          --
  12 --                                                                          --
  13 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  14 -- terms of the  GNU General Public License as published  by the Free Soft- --
  15 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  16 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  17 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  18 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  19 -- for  more details.  You should have  received  a copy of the GNU General --
  20 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  21 -- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
  22 -- MA 02111-1307, USA.                                                      --
  23 --                                                                          --
  24 -- As a special exception,  if other files  instantiate  generics from this --
  25 -- unit, or you link  this unit with other files  to produce an executable, --
  26 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  27 -- covered  by the  GNU  General  Public  License.  This exception does not --
  28 -- however invalidate  any other reasons why  the executable file  might be --
  29 -- covered by the  GNU Public License.                                      --
  30 --                                                                          --
  31 -- GNAT was originally developed  by the GNAT team at  New York University. --
  32 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  33 --                                                                          --
  34 ------------------------------------------------------------------------------
  35
  36 --  This package, together with its child package Fname.UF define the
  37 --  association between source file names and unit names as defined
  38 --  (see package Uname for definition of format of unit names).
  39
  40 with Types; use Types;
  41
  42 package Fname is
  43
  44    --  Note: this package spec does not depend on the Uname spec in the Ada
  45    --  sense, but the comments and description of the semantics do depend on
  46    --  the conventions established by Uname.
  47
  48    ---------------------------
  49    -- File Name Conventions --
  50    ---------------------------
  51
  52    --  GNAT requires that there be a one to one correspondence between source
  53    --  file names (as used in the Osint package interface) and unit names as
  54    --  defined by the Uname package. This correspondence is defined by the
  55    --  two subprograms defined here in the Fname package.
  56
  57    --   For full rules of file naming, see GNAT User's Guide. Note that the
  58    --   naming rules are affected by the presence of Source_File_Name pragmas
  59    --   that have been previously processed.
  60
  61    --  Note that the file name does *not* include the directory name. The
  62    --  management of directories is provided by Osint, and full file names
  63    --  are used only for error message purposes within GNAT itself.
  64
  65    -----------------
  66    -- Subprograms --
  67    -----------------
  68
  69    type Expected_Unit_Type is (Expect_Body, Expect_Spec, Unknown);
  70    --  Return value from Get_Expected_Unit_Type
  71
  72    function Get_Expected_Unit_Type
  73      (Fname : File_Name_Type)
  74       return  Expected_Unit_Type;
  75    --  If possible, determine whether the given file name corresponds to a unit
  76    --  that is a spec or body (e.g. by examining the extension). If this cannot
  77    --  be determined with the file naming conventions in use, then the returned
  78    --  value is set to Unknown.
  79
  80    function Is_Predefined_File_Name
  81      (Fname              : File_Name_Type;
  82       Renamings_Included : Boolean := True)
  83       return               Boolean;
  84    --  This function determines if the given file name (which must be a simple
  85    --  file name with no directory information) is the file name for one of
  86    --  the predefined library units. On return, Name_Buffer contains the
  87    --  file name. The Renamings_Included parameter indicates whether annex
  88    --  J renamings such as Text_IO are to be considered as predefined. If
  89    --  Renamings_Included is True, then Text_IO will return True, otherwise
  90    --  only children of Ada, Interfaces and System return True.
  91
  92    function Is_Internal_File_Name
  93      (Fname              : File_Name_Type;
  94       Renamings_Included : Boolean := True)
  95       return               Boolean;
  96    --  Similar to Is_Predefined_File_Name. The internal file set is a
  97    --  superset of the predefined file set including children of GNAT,
  98    --  and also children of DEC for the VMS case.
  99
 100    procedure Tree_Read;
 101    --  Dummy procedure (reads dummy table values from tree file)
 102
 103    procedure Tree_Write;
 104    --  Writes out internal tables to current tree file using Tree_Write
 105    --  This is actually a dummy routine, since the relevant table is
 106    --  no longer used, but we retain it for now, to avoid a tree file
 107    --  incompatibility with the 3.13 compiler. Should be removed for
 108    --  the 3.14a release ???
 109
 110 end Fname;