blob: 380b617f7805f5089598a6ea132a62dc9fb664c7 [file] [log] [blame]
-- --
-- --
-- F N A M E --
-- --
-- S p e c --
-- --
-- Copyright (C) 1992-2003 Free Software Foundation, Inc. --
-- --
-- GNAT is free software; you can redistribute it and/or modify it under --
-- terms of the GNU General Public License as published by the Free Soft- --
-- ware Foundation; either version 2, or (at your option) any later ver- --
-- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
-- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
-- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
-- for more details. You should have received a copy of the GNU General --
-- Public License distributed with GNAT; see file COPYING. If not, write --
-- to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, --
-- MA 02111-1307, USA. --
-- --
-- As a special exception, if other files instantiate generics from this --
-- unit, or you link this unit with other files to produce an executable, --
-- this unit does not by itself cause the resulting executable to be --
-- covered by the GNU General Public License. This exception does not --
-- however invalidate any other reasons why the executable file might be --
-- covered by the GNU Public License. --
-- --
-- GNAT was originally developed by the GNAT team at New York University. --
-- Extensive contributions were provided by Ada Core Technologies Inc. --
-- --
-- This package, together with its child package Fname.UF define the
-- association between source file names and unit names as defined
-- (see package Uname for definition of format of unit names).
with Types; use Types;
package Fname is
-- Note: this package spec does not depend on the Uname spec in the Ada
-- sense, but the comments and description of the semantics do depend on
-- the conventions established by Uname.
-- File Name Conventions --
-- GNAT requires that there be a one to one correspondence between source
-- file names (as used in the Osint package interface) and unit names as
-- defined by the Uname package. This correspondence is defined by the
-- two subprograms defined here in the Fname package.
-- For full rules of file naming, see GNAT User's Guide. Note that the
-- naming rules are affected by the presence of Source_File_Name pragmas
-- that have been previously processed.
-- Note that the file name does *not* include the directory name. The
-- management of directories is provided by Osint, and full file names
-- are used only for error message purposes within GNAT itself.
-- Subprograms --
type Expected_Unit_Type is (Expect_Body, Expect_Spec, Unknown);
-- Return value from Get_Expected_Unit_Type
function Get_Expected_Unit_Type
(Fname : File_Name_Type)
return Expected_Unit_Type;
-- If possible, determine whether the given file name corresponds to a unit
-- that is a spec or body (e.g. by examining the extension). If this cannot
-- be determined with the file naming conventions in use, then the returned
-- value is set to Unknown.
function Is_Predefined_File_Name
(Fname : File_Name_Type;
Renamings_Included : Boolean := True) return Boolean;
-- This function determines if the given file name (which must be a simple
-- file name with no directory information) is the file name for one of
-- the predefined library units. On return, Name_Buffer contains the
-- file name. The Renamings_Included parameter indicates whether annex
-- J renamings such as Text_IO are to be considered as predefined. If
-- Renamings_Included is True, then Text_IO will return True, otherwise
-- only children of Ada, Interfaces and System return True.
function Is_Predefined_File_Name
(Renamings_Included : Boolean := True) return Boolean;
-- This version is called with the file name already in Name_Buffer
function Is_Internal_File_Name
(Fname : File_Name_Type;
Renamings_Included : Boolean := True)
return Boolean;
-- Similar to Is_Predefined_File_Name. The internal file set is a
-- superset of the predefined file set including children of GNAT,
-- and also children of DEC for the VMS case.
procedure Tree_Read;
-- Dummy procedure (reads dummy table values from tree file)
procedure Tree_Write;
-- Writes out internal tables to current tree file using Tree_Write
-- This is actually a dummy routine, since the relevant table is
-- no longer used, but we retain it for now, to avoid a tree file
-- incompatibility with the 3.13 compiler. Should be removed for
-- the 3.14a release ???
end Fname;