8sa1-gcc/gcc/ada/fname.ads
Arnaud Charlet b740cf2853 [Ada] Update header of front-end files
gcc/ada/

	* alloc.ads, aspects.adb, aspects.ads, atree.adb, atree.ads,
	casing.adb, casing.ads, csets.adb, csets.ads, debug.adb, debug.ads,
	einfo.adb, einfo.ads, elists.adb, elists.ads, fname.adb, fname.ads,
	gnatvsn.adb, gnatvsn.ads, hostparm.ads, indepsw-aix.adb,
	indepsw-darwin.adb, indepsw-gnu.adb, indepsw.adb, indepsw.ads,
	krunch.adb, krunch.ads, lib-list.adb, lib-sort.adb, lib.adb, lib.ads,
	namet-sp.adb, namet-sp.ads, namet.adb, namet.ads, nlists.adb,
	nlists.ads, opt.adb, opt.ads, output.adb, output.ads, rident.ads,
	scans.adb, scans.ads, scil_ll.adb, scil_ll.ads, sem_aux.ads,
	sem_aux.adb, sfn_scan.adb, sinfo.adb, sinfo.ads, sinput.adb,
	sinput.ads, snames.adb-tmpl, snames.ads-tmpl, stand.ads,
	stringt.adb, stringt.ads, table.adb, table.ads, types.adb,
	types.ads, uintp.adb, uintp.ads, uname.adb, uname.ads,
	urealp.adb, urealp.ads, vast.adb, vast.ads, widechar.adb,
	widechar.ads: Update header.
2020-10-23 04:24:44 -04:00

98 lines
4.9 KiB
Ada

------------------------------------------------------------------------------
-- --
-- GNAT COMPILER COMPONENTS --
-- --
-- F N A M E --
-- --
-- S p e c --
-- --
-- Copyright (C) 1992-2020, 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 3, 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 COPYING3. If not, go to --
-- http://www.gnu.org/licenses for a complete copy of the 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 Namet; use Namet;
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 --
-----------------
function Is_Predefined_File_Name
(Fname : String;
Renamings_Included : Boolean := True) return Boolean;
function Is_Predefined_File_Name
(Fname : File_Name_Type;
Renamings_Included : Boolean := True) return Boolean;
-- These functions determine if the given file name (which must be a simple
-- file name with no directory information) is the source or ALI file name
-- for one of the predefined library units (i.e. part of the Ada, System,
-- or Interface hierarchies). Note that units in the GNAT hierarchy are not
-- considered predefined (see Is_Internal_File_Name below).
--
-- 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_Renaming_File_Name
(Fname : String) return Boolean;
function Is_Predefined_Renaming_File_Name
(Fname : File_Name_Type) return Boolean;
-- True if Fname is the file name for a predefined renaming (the same file
-- names that are included if Renamings_Included => True is passed to
-- Is_Predefined_File_Name).
function Is_Internal_File_Name
(Fname : String;
Renamings_Included : Boolean := True) return Boolean;
function Is_Internal_File_Name
(Fname : File_Name_Type;
Renamings_Included : Boolean := True) return Boolean;
-- Same as Is_Predefined_File_Name, except units in the GNAT hierarchy are
-- included.
function Is_GNAT_File_Name (Fname : String) return Boolean;
function Is_GNAT_File_Name (Fname : File_Name_Type) return Boolean;
-- True for units in the GNAT hierarchy
end Fname;