OSDN Git Service

* gimplify.c (gimplify_type_sizes) [POINTER_TYPE, REFERENCE_TYPE]:
[pf3gnuchains/gcc-fork.git] / gcc / ada / osint.ads
1 ------------------------------------------------------------------------------
2 --                                                                          --
3 --                         GNAT COMPILER COMPONENTS                         --
4 --                                                                          --
5 --                                O S I N T                                 --
6 --                                                                          --
7 --                                 S p e c                                  --
8 --                                                                          --
9 --          Copyright (C) 1992-2005 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 2,  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 COPYING.  If not, write --
19 -- to  the  Free Software Foundation,  51  Franklin  Street,  Fifth  Floor, --
20 -- Boston, MA 02110-1301, USA.                                              --
21 --                                                                          --
22 -- GNAT was originally developed  by the GNAT team at  New York University. --
23 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
24 --                                                                          --
25 ------------------------------------------------------------------------------
26
27 --  This package contains the low level, operating system routines used in
28 --  the GNAT compiler and binder for command line processing and file input
29 --  output.
30
31 with GNAT.OS_Lib; use GNAT.OS_Lib;
32 with System;      use System;
33 with Types;       use Types;
34
35 pragma Elaborate (GNAT.OS_Lib);
36
37 package Osint is
38
39    Multi_Unit_Index_Character : Character := '~';
40    --  The character before the index of the unit in a multi-unit source,
41    --  in ALI and object file names. This is not a constant, because it is
42    --  changed to '$' on VMS.
43
44    Ada_Include_Path          : constant String := "ADA_INCLUDE_PATH";
45    Ada_Objects_Path          : constant String := "ADA_OBJECTS_PATH";
46    Project_Include_Path_File : constant String := "ADA_PRJ_INCLUDE_FILE";
47    Project_Objects_Path_File : constant String := "ADA_PRJ_OBJECTS_FILE";
48
49    procedure Initialize;
50    --  Initialize internal tables
51
52    function Normalize_Directory_Name (Directory : String) return String_Ptr;
53    --  Verify and normalize a directory name. If directory name is invalid,
54    --  this will return an empty string. Otherwise it will insure a trailing
55    --  slash and make other normalizations.
56
57    type File_Type is (Source, Library, Config, Definition, Preprocessing_Data);
58
59    function Find_File
60      (N : File_Name_Type;
61       T : File_Type) return File_Name_Type;
62    --  Finds a source, library or config file depending on the value
63    --  of T following the directory search order rules unless N is the
64    --  name of the file just read with Next_Main_File and already
65    --  contains directiory information, in which case just look in the
66    --  Primary_Directory.  Returns File_Name_Type of the full file name
67    --  if found, No_File if file not found. Note that for the special
68    --  case of gnat.adc, only the compilation environment directory is
69    --  searched, i.e. the directory where the ali and object files are
70    --  written. Another special case is when Debug_Generated_Code is
71    --  set and the file name ends on ".dg", in which case we look for
72    --  the generated file only in the current directory, since that is
73    --  where it is always built.
74
75    function Get_File_Names_Case_Sensitive return Int;
76    pragma Import (C, Get_File_Names_Case_Sensitive,
77                   "__gnat_get_file_names_case_sensitive");
78    File_Names_Case_Sensitive : constant Boolean :=
79                                  Get_File_Names_Case_Sensitive /= 0;
80    --  Set to indicate whether the operating system convention is for file
81    --  names to be case sensitive (e.g., in Unix, set True), or non case
82    --  sensitive (e.g., in OS/2, set False).
83
84    procedure Canonical_Case_File_Name (S : in out String);
85    --  Given a file name, converts it to canonical case form. For systems
86    --  where file names are case sensitive, this procedure has no effect.
87    --  If file names are not case sensitive (i.e. for example if you have
88    --  the file "xyz.adb", you can refer to it as XYZ.adb or XyZ.AdB), then
89    --  this call converts the given string to canonical all lower case form,
90    --  so that two file names compare equal if they refer to the same file.
91
92    function Number_Of_Files return Int;
93    --  Gives the total number of filenames found on the command line
94
95    No_Index : constant := -1;
96    --  Value used in Add_File to indicate no index is specified for main
97
98    procedure Add_File (File_Name : String; Index : Int := No_Index);
99    --  Called by the subprogram processing the command line for each file name
100    --  found. The index, when not defaulted to No_Index is the index of the
101    --  subprogram in its source, zero indicating that the source is not
102    --  multi-unit.
103
104    procedure Find_Program_Name;
105    --  Put simple name of current program being run (excluding the directory
106    --  path) in Name_Buffer, with the length in Name_Len.
107
108    function Program_Name (Nam : String) return String_Access;
109    --  In the native compilation case, Create a string containing Nam. In the
110    --  cross compilation case, looks at the prefix of the current program being
111    --  run and prepend it to Nam. For instance if the program being run is
112    --  <target>-gnatmake and Nam is "gcc", the returned value will be a pointer
113    --  to "<target>-gcc". This function clobbers Name_Buffer and Name_Len.
114
115    procedure Write_Program_Name;
116    --  Writes name of program as invoked to the current output
117    --  (normally standard output).
118
119    procedure Fail (S1 : String; S2 : String := ""; S3 : String := "");
120    pragma No_Return (Fail);
121    --  Outputs error messages S1 & S2 & S3 preceded by the name of the
122    --  executing program and exits with E_Fatal. The output goes to standard
123    --  error, except if special output is in effect (see Output).
124
125    function Is_Directory_Separator (C : Character) return Boolean;
126    --  Returns True if C is a directory separator
127
128    function Get_Directory (Name : File_Name_Type) return File_Name_Type;
129    --  Get the prefix directory name (if any) from Name. The last separator
130    --  is preserved. Return the normalized current directory if there is no
131    --  directory part in the name.
132
133    function Is_Readonly_Library (File : File_Name_Type) return Boolean;
134    --  Check if this library file is a read-only file
135
136    function Strip_Directory (Name : File_Name_Type) return File_Name_Type;
137    --  Strips the prefix directory name (if any) from Name. Returns the
138    --  stripped name. Name cannot end with a directory separator.
139
140    function Strip_Suffix (Name : File_Name_Type) return File_Name_Type;
141    --  Strips the suffix (the last '.' and whatever comes after it) from Name.
142    --  Returns the stripped name.
143
144    function Executable_Name (Name : File_Name_Type) return File_Name_Type;
145    --  Given a file name it adds the appropriate suffix at the end so that
146    --  it becomes the name of the executable on the system at end. For
147    --  instance under DOS it adds the ".exe" suffix, whereas under UNIX no
148    --  suffix is added.
149
150    function File_Stamp (Name : File_Name_Type) return Time_Stamp_Type;
151    --  Returns the time stamp of file Name. Name should include relative
152    --  path information in order to locate it. If the source file cannot be
153    --  opened, or Name = No_File, and all blank time stamp is returned (this is
154    --  not an error situation).
155
156    type String_Access_List is array (Positive range <>) of String_Access;
157    --  Deferenced type used to return a list of file specs in
158    --  To_Canonical_File_List.
159
160    type String_Access_List_Access is access all String_Access_List;
161    --  Type used to return a String_Access_List without dragging in secondary
162    --  stack.
163
164    function To_Canonical_File_List
165      (Wildcard_Host_File : String;
166       Only_Dirs          : Boolean) return String_Access_List_Access;
167    --  Expand a wildcard host syntax file or directory specification (e.g. on
168    --  a VMS host, any file or directory spec that contains:
169    --  "*", or "%", or "...")
170    --  and return a list of valid Unix syntax file or directory specs.
171    --  If Only_Dirs is True, then only return directories.
172
173    function To_Canonical_Dir_Spec
174      (Host_Dir     : String;
175       Prefix_Style : Boolean) return String_Access;
176    --  Convert a host syntax directory specification (e.g. on a VMS host:
177    --  "SYS$DEVICE:[DIR]") to canonical (Unix) syntax (e.g. "/sys$device/dir").
178    --  If Prefix_Style then make it a valid file specification prefix. A file
179    --  specification prefix is a directory specification that can be appended
180    --  with a simple file specification to yield a valid absolute or relative
181    --  path to a file. On a conversion to Unix syntax this simply means the
182    --  spec has a trailing slash ("/").
183
184    function To_Canonical_File_Spec
185      (Host_File : String) return String_Access;
186    --  Convert a host syntax file specification (e.g. on a VMS host:
187    --  "SYS$DEVICE:[DIR]FILE.EXT;69 to canonical (Unix) syntax (e.g.
188    --  "/sys$device/dir/file.ext.69").
189
190    function To_Canonical_Path_Spec
191      (Host_Path : String) return String_Access;
192    --  Convert a host syntax Path specification (e.g. on a VMS host:
193    --  "SYS$DEVICE:[BAR],DISK$USER:[FOO] to canonical (Unix) syntax (e.g.
194    --  "/sys$device/foo:disk$user/foo").
195
196    function To_Host_Dir_Spec
197      (Canonical_Dir : String;
198       Prefix_Style  : Boolean) return String_Access;
199    --  Convert a canonical syntax directory specification to host syntax.
200    --  The Prefix_Style flag is currently ignored but should be set to
201    --  False.
202
203    function To_Host_File_Spec
204      (Canonical_File : String) return String_Access;
205    --  Convert a canonical syntax file specification to host syntax
206
207    function Relocate_Path
208      (Prefix : String;
209       Path   : String) return String_Ptr;
210    --  Given an absolute path and a prefix, if Path starts with Prefix,
211    --  replace the Prefix substring with the root installation directory.
212    --  By default, try to compute the root installation directory by looking
213    --  at the executable name as it was typed on the command line and, if
214    --  needed, use the PATH environment variable. If the above computation
215    --  fails, return Path. This function assumes Prefix'First = Path'First.
216
217    function Shared_Lib (Name : String) return String;
218    --  Returns the runtime shared library in the form -l<name>-<version> where
219    --  version is the GNAT runtime library option for the platform. For example
220    --  this routine called with Name set to "gnat" will return "-lgnat-5.02"
221    --  on UNIX and Windows and -lgnat_5_02 on VMS.
222
223    -------------------------
224    -- Search Dir Routines --
225    -------------------------
226
227    function Include_Dir_Default_Prefix return String;
228    --  Return the directory of the run-time library sources, as modified
229    --  by update_path.
230
231    function Object_Dir_Default_Prefix return String;
232    --  Return the directory of the run-time library ALI and object files, as
233    --  modified by update_path.
234
235    procedure Add_Default_Search_Dirs;
236    --  This routine adds the default search dirs indicated by the
237    --  environment variables and sdefault package.
238
239    procedure Add_Lib_Search_Dir (Dir : String);
240    --  Add Dir at the end of the library file search path
241
242    procedure Add_Src_Search_Dir (Dir : String);
243    --  Add Dir at the end of the source file search path
244
245    procedure Get_Next_Dir_In_Path_Init
246      (Search_Path : String_Access);
247    function Get_Next_Dir_In_Path
248      (Search_Path : String_Access) return String_Access;
249    --  These subprograms are used to parse out the directory names in a
250    --  search path specified by a Search_Path argument. The procedure
251    --  initializes an internal pointer to point to the initial directory
252    --  name, and calls to the function return successive directory names,
253    --  with a null pointer marking the end of the list.
254
255    type Search_File_Type is (Include, Objects);
256
257    procedure Add_Search_Dirs
258      (Search_Path : String_Ptr;
259       Path_Type   : Search_File_Type);
260    --  These procedure adds all the search directories that are in Search_Path
261    --  in the proper file search path (library or source)
262
263    function Get_Primary_Src_Search_Directory return String_Ptr;
264    --  Retrieved the primary directory (directory containing the main source
265    --  file for Gnatmake.
266
267    function Nb_Dir_In_Src_Search_Path return Natural;
268    function Dir_In_Src_Search_Path (Position : Natural) return String_Ptr;
269    --  Functions to access the directory names in the source search path
270
271    function Nb_Dir_In_Obj_Search_Path return Natural;
272    function Dir_In_Obj_Search_Path (Position : Natural) return String_Ptr;
273    --  Functions to access the directory names in the Object search path
274
275    Include_Search_File : constant String_Access :=
276                            new String'("ada_source_path");
277    Objects_Search_File : constant String_Access :=
278                            new String'("ada_object_path");
279    --  Names of the files containg the default include or objects search
280    --  directories. These files, located in Sdefault.Search_Dir_Prefix, do
281    --  not necessarily exist.
282
283    Exec_Name : String_Ptr;
284    --  Executable name as typed by the user (used to compute the
285    --  executable prefix).
286
287    function Read_Default_Search_Dirs
288      (Search_Dir_Prefix       : String_Access;
289       Search_File             : String_Access;
290       Search_Dir_Default_Name : String_Access) return String_Access;
291    --  Read and return the default search directories from the file located
292    --  in Search_Dir_Prefix (as modified by update_path) and named Search_File.
293    --  If no such file exists or an error occurs then instead return the
294    --  Search_Dir_Default_Name (as modified by update_path).
295
296    function Get_RTS_Search_Dir
297      (Search_Dir : String;
298       File_Type  : Search_File_Type) return String_Ptr;
299    --  This function retrieves the paths to the search (resp. lib) dirs and
300    --  return them. The search dir can be absolute or relative. If the search
301    --  dir contains Include_Search_File (resp. Object_Search_File), then this
302    --  function reads and returns the default search directories from the file.
303    --  Otherwise, if the directory is absolute, it will try to find 'adalib'
304    --  (resp. 'adainclude'). If found, null is returned. If the directory is
305    --  relative, the following directories for the directories 'adalib' and
306    --  'adainclude' will be scanned:
307    --
308    --   - current directory (from which the tool has been spawned)
309    --   - $GNAT_ROOT/gcc/gcc-lib/$targ/$vers/
310    --   - $GNAT_ROOT/gcc/gcc-lib/$targ/$vers/rts-
311    --
312    --  The scan will stop as soon as the directory being searched for (adalib
313    --  or adainclude) is found. If the scan fails, null is returned.
314
315    -----------------------
316    -- Source File Input --
317    -----------------------
318
319    --  Source file input routines are used by the compiler to read the main
320    --  source files and the subsidiary source files (e.g. with'ed units), and
321    --  also by the binder to check presence/time stamps of sources.
322
323    procedure Read_Source_File
324      (N   : File_Name_Type;
325       Lo  : Source_Ptr;
326       Hi  : out Source_Ptr;
327       Src : out Source_Buffer_Ptr;
328       T   : File_Type := Source);
329    --  Allocates a Source_Buffer of appropriate length and then reads the
330    --  entire contents of the source file N into the buffer. The address of
331    --  the allocated buffer is returned in Src.
332    --
333    --  Each line of text is terminated by one of the sequences:
334    --
335    --    CR
336    --    CR/LF
337    --    LF/CR
338    --    LF
339
340    --  The source is terminated by an EOF (16#1A#) character, which is
341    --  the last charcater of the returned source bufer (note that any
342    --  EOF characters in positions other than the last source character
343    --  are treated as representing blanks).
344    --
345    --  The logical lower bound of the source buffer is the input value of Lo,
346    --  and on exit Hi is set to the logical upper bound of the source buffer.
347    --  Note that the returned value in Src points to an array with a physical
348    --  lower bound of zero. This virtual origin addressing approach means that
349    --  a constrained array pointer can be used with a low bound of zero which
350    --  results in more efficient code.
351    --
352    --  If the given file cannot be opened, then the action depends on whether
353    --  this file is the current main unit (i.e. its name matches the name
354    --  returned by the most recent call to Next_Main_Source). If so, then the
355    --  failure to find the file is a fatal error, an error message is output,
356    --  and program execution is terminated. Otherwise (for the case of a
357    --  subsidiary source loaded directly or indirectly using with), a file
358    --  not found condition causes null to be set as the result value.
359    --
360    --  Note that the name passed to this function is the simple file name,
361    --  without any directory information. The implementation is responsible
362    --  for searching for the file in the appropriate directories.
363    --
364    --  Note the special case that if the file name is gnat.adc, then the
365    --  search for the file is done ONLY in the directory corresponding to
366    --  the current compilation environment, i.e. in the same directory
367    --  where the ali and object files will be written.
368
369    function Full_Source_Name return File_Name_Type;
370    function Current_Source_File_Stamp return Time_Stamp_Type;
371    --  Returns the full name/time stamp of the source file most recently read
372    --  using Read_Source_File. Calling this routine entails no source file
373    --  directory lookup penalty.
374
375    function Full_Source_Name (N : File_Name_Type) return File_Name_Type;
376    function Source_File_Stamp (N : File_Name_Type) return Time_Stamp_Type;
377    --  Returns the full name/time stamp of the source file whose simple name
378    --  is N which should not include path information. Note that if the file
379    --  cannot be located No_File is returned for the first routine and an
380    --  all blank time stamp is returned for the second (this is not an error
381    --  situation). The full name includes the appropriate directory
382    --  information. The source file directory lookup penalty is incurred
383    --  every single time the routines are called unless you have previously
384    --  called Source_File_Data (Cache => True). See below.
385
386    function Current_File_Index return Int;
387    --  Return the index in its source file of the current main unit
388
389    function Matching_Full_Source_Name
390      (N : File_Name_Type;
391       T : Time_Stamp_Type) return File_Name_Type;
392    --  Same semantics than Full_Source_Name but will search on the source
393    --  path until a source file with time stamp matching T is found. If
394    --  none is found returns No_File.
395
396    procedure Source_File_Data (Cache : Boolean);
397    --  By default source file data (full source file name and time stamp)
398    --  are looked up every time a call to Full_Source_Name (N) or
399    --  Source_File_Stamp (N) is made. This may be undesirable in certain
400    --  applications as this is uselessly slow if source file data does not
401    --  change during program execution. When this procedure is called with
402    --  Cache => True access to source file data does not encurr a penalty if
403    --  this data was previously retrieved.
404
405    -------------------------------------------
406    -- Representation of Library Information --
407    -------------------------------------------
408
409    --  Associated with each compiled source file is library information,
410    --  a string of bytes whose exact format is described in the body of
411    --  Lib.Writ. Compiling a source file generates this library information
412    --  for the compiled unit, and access the library information for units
413    --  that were compiled previously on which the unit being compiled depends.
414
415    --  How this information is stored is up to the implementation of this
416    --  package. At the interface level, this information is simply associated
417    --  with its corresponding source.
418
419    --  Several different implementations are possible:
420
421    --    1. The information could be directly associated with the source file,
422    --       e.g. placed in a resource fork of this file on the Mac, or on
423    --       MS-DOS, written to the source file after the end of file mark.
424
425    --    2. The information could be written into the generated object module
426    --       if the system supports the inclusion of arbitrary informational
427    --       byte streams into object files. In this case there must be a naming
428    --       convention that allows object files to be located given the name of
429    --       the corresponding source file.
430
431    --    3. The information could be written to a separate file, whose name is
432    --       related to the name of the source file by a fixed convention.
433
434    --  Which of these three methods is chosen depends on the constraints of the
435    --  host operating system. The interface described here is independent of
436    --  which of these approaches is used.
437
438    -------------------------------
439    -- Library Information Input --
440    -------------------------------
441
442    --  These subprograms are used by the binder to read library information
443    --  files, see section above for representation of these files.
444
445    function Read_Library_Info
446      (Lib_File  : File_Name_Type;
447       Fatal_Err : Boolean := False) return Text_Buffer_Ptr;
448    --  Allocates a Text_Buffer of appropriate length and reads in the entire
449    --  source of the library information from the library information file
450    --  whose name is given by the parameter Name.
451    --
452    --  See description of Read_Source_File for details on the format of the
453    --  returned text buffer (the format is identical). THe lower bound of
454    --  the Text_Buffer is always zero
455    --
456    --  If the specified file cannot be opened, then the action depends on
457    --  Fatal_Err. If Fatal_Err is True, an error message is given and the
458    --  compilation is abandoned. Otherwise if Fatal_Err is False, then null
459    --  is returned. Note that the Lib_File is a simple name which does not
460    --  include any directory information. The implementation is responsible
461    --  for searching for the file in appropriate directories.
462    --
463    --  If Opt.Check_Object_Consistency is set to True then this routine
464    --  checks whether the object file corresponding to the Lib_File is
465    --  consistent with it. The object file is inconsistent if the object
466    --  does not exist or if it has an older time stamp than Lib_File.
467    --  This check is not performed when the Lib_File is "locked" (i.e.
468    --  read/only) because in this case the object file may be buried
469    --  in a library. In case of inconsistencies Read_Library_Info
470    --  behaves as if it did not find Lib_File (namely if Fatal_Err is
471    --  False, null is returned).
472
473    function Full_Library_Info_Name return File_Name_Type;
474    function Full_Object_File_Name return File_Name_Type;
475    --  Returns the full name of the library/object file most recently read
476    --  using Read_Library_Info, including appropriate directory information.
477    --  Calling this routine entails no library file directory lookup
478    --  penalty. Note that the object file corresponding to a library file
479    --  is not actually read. Its time stamp is fected when the flag
480    --  Opt.Check_Object_Consistency is set.
481
482    function Current_Library_File_Stamp return Time_Stamp_Type;
483    function Current_Object_File_Stamp return Time_Stamp_Type;
484    --  The time stamps of the files returned by the previous two routines.
485    --  It is an error to call Current_Object_File_Stamp if
486    --  Opt.Check_Object_Consistency is set to False.
487
488    function Full_Lib_File_Name (N : File_Name_Type) return File_Name_Type;
489    function Library_File_Stamp (N : File_Name_Type) return Time_Stamp_Type;
490    --  Returns the full name/time stamp of library file N. N should not
491    --  include path information. Note that if the file cannot be located
492    --  No_File is returned for the first routine and an all blank time stamp
493    --  is returned for the second (this is not an error situation). The
494    --  full name includes the appropriate directory information. The library
495    --  file directory lookup penalty is incurred every single time this
496    --  routine is called.
497
498    function Lib_File_Name
499      (Source_File : File_Name_Type;
500       Munit_Index : Nat := 0) return File_Name_Type;
501    --  Given the name of a source file, returns the name of the corresponding
502    --  library information file. This may be the name of the object file, or
503    --  of a separate file used to store the library information. In either case
504    --  the returned result is suitable for use in a call to Read_Library_Info.
505    --  The Munit_Index is the unit index in multiple unit per file mode, or
506    --  zero in normal single unit per file mode (used to add ~nnn suffix).
507    --  Note: this subprogram is in this section because it is used by the
508    --  compiler to determine the proper library information names to be placed
509    --  in the generated library information file.
510
511    -----------------
512    -- Termination --
513    -----------------
514
515    type Exit_Code_Type is (
516       E_Success,    -- No warnings or errors
517       E_Warnings,   -- Compiler warnings generated
518       E_No_Code,    -- No code generated
519       E_No_Compile, -- Compilation not needed (smart recompilation)
520       E_Errors,     -- Compiler error messages generated
521       E_Fatal,      -- Fatal (serious) error, e.g. source file not found
522       E_Abort);     -- Internally detected compiler error
523
524    procedure Exit_Program (Exit_Code : Exit_Code_Type);
525    pragma No_Return (Exit_Program);
526    --  A call to Exit_Program terminates execution with the given status.
527    --  A status of zero indicates normal completion, a non-zero status
528    --  indicates abnormal termination.
529
530    -------------------------
531    -- Command Line Access --
532    -------------------------
533
534    --  Direct interface to command line parameters. (We don't want to use
535    --  the predefined command line package because it defines functions
536    --  returning string)
537
538    function Arg_Count return Natural;
539    pragma Import (C, Arg_Count, "__gnat_arg_count");
540    --  Get number of arguments (note: optional globbing may be enabled)
541
542    procedure Fill_Arg (A : System.Address; Arg_Num : Integer);
543    pragma Import (C, Fill_Arg, "__gnat_fill_arg");
544    --  Store one argument
545
546    function Len_Arg (Arg_Num : Integer) return Integer;
547    pragma Import (C, Len_Arg, "__gnat_len_arg");
548    --  Get length of argument
549
550 private
551
552    ALI_Suffix : constant String_Ptr := new String'("ali");
553    --  The suffix used for the library files (also known as ALI files)
554
555    Current_Main : File_Name_Type := No_File;
556    --  Used to save a simple file name between calls to Next_Main_Source and
557    --  Read_Source_File. If the file name argument to Read_Source_File is
558    --  No_File, that indicates that the file whose name was returned by the
559    --  last call to Next_Main_Source (and stored here) is to be read.
560
561    Target_Object_Suffix : constant String := Get_Target_Object_Suffix.all;
562    --  The suffix used for the target object files
563
564    Output_FD : File_Descriptor;
565    --  The file descriptor for the current library info, tree or binder output
566
567    Output_File_Name : File_Name_Type;
568    --  File_Name_Type for name of open file whose FD is in Output_FD, the name
569    --  stored does not include the trailing NUL character.
570
571    Argument_Count : constant Integer := Arg_Count - 1;
572    --  Number of arguments (excluding program name)
573
574    type File_Name_Array is array (Int range <>) of String_Ptr;
575    type File_Name_Array_Ptr is access File_Name_Array;
576    File_Names : File_Name_Array_Ptr :=
577                   new File_Name_Array (1 .. Int (Argument_Count) + 2);
578    --  As arguments are scanned, file names are stored in this array
579    --  The strings do not have terminating NUL files. The array is
580    --  extensible, because when using project files, there may be
581    --  more files than arguments on the command line.
582
583    type File_Index_Array is array (Int range <>) of Int;
584    type File_Index_Array_Ptr is access File_Index_Array;
585    File_Indexes : File_Index_Array_Ptr :=
586                     new File_Index_Array (1 .. Int (Argument_Count) + 2);
587
588    Current_File_Name_Index : Int := 0;
589    --  The index in File_Names of the last file opened by Next_Main_Source
590    --  or Next_Main_Lib_File. The value 0 indicates that no files have been
591    --  opened yet.
592
593    procedure Create_File_And_Check
594      (Fdesc : out File_Descriptor;
595       Fmode : Mode);
596    --  Create file whose name (NUL terminated) is in Name_Buffer (with the
597    --  length in Name_Len), and place the resulting descriptor in Fdesc.
598    --  Issue message and exit with fatal error if file cannot be created.
599    --  The Fmode parameter is set to either Text or Binary (see description
600    --  of GNAT.OS_Lib.Create_File).
601
602    type Program_Type is (Compiler, Binder, Make, Gnatls, Unspecified);
603    --  Program currently running
604    procedure Set_Program (P : Program_Type);
605    --  Indicates to the body of Osint the program currently running.
606    --  This procedure is called by the child packages of Osint.
607    --  A check is made that this procedure is not called several times.
608
609    function More_Files return Boolean;
610    --  Implements More_Source_Files and More_Lib_Files
611
612    function Next_Main_File return File_Name_Type;
613    --  Implements Next_Main_Source and Next_Main_Lib_File
614
615    function Object_File_Name (N : File_Name_Type) return File_Name_Type;
616    --  Constructs the name of the object file corresponding to library
617    --  file N. If N is a full file name than the returned file name will
618    --  also be a full file name. Note that no lookup in the library file
619    --  directories is done for this file. This routine merely constructs
620    --  the name.
621
622    procedure Write_Info (Info : String);
623    --  Implementation of Write_Binder_Info, Write_Debug_Info and
624    --  Write_Library_Info (identical)
625
626 end Osint;