1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2009, Free Software Foundation, Inc. --
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. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
26 -- This package contains the low level, operating system routines used in the
27 -- compiler and binder for command line processing and file input output.
29 with Namet; use Namet;
30 with Types; use Types;
32 with System.Storage_Elements;
33 with System.OS_Lib; use System.OS_Lib;
34 with System; use System;
36 pragma Elaborate_All (System.OS_Lib);
37 -- For the call to function Get_Target_Object_Suffix in the private part
41 Multi_Unit_Index_Character : Character := '~';
42 -- The character before the index of the unit in a multi-unit source, in
43 -- ALI and object file names. This is not a constant, because it is changed
46 Ada_Include_Path : constant String := "ADA_INCLUDE_PATH";
47 Ada_Objects_Path : constant String := "ADA_OBJECTS_PATH";
48 Project_Include_Path_File : constant String := "ADA_PRJ_INCLUDE_FILE";
49 Project_Objects_Path_File : constant String := "ADA_PRJ_OBJECTS_FILE";
52 -- Initialize internal tables
54 function Normalize_Directory_Name (Directory : String) return String_Ptr;
55 -- Verify and normalize a directory name. If directory name is invalid,
56 -- this will return an empty string. Otherwise it will insure a trailing
57 -- slash and make other normalizations.
59 type File_Type is (Source, Library, Config, Definition, Preprocessing_Data);
63 T : File_Type) return File_Name_Type;
64 -- Finds a source, library or config file depending on the value of T
65 -- following the directory search order rules unless N is the name of the
66 -- file just read with Next_Main_File and already contains directory
67 -- information, in which case just look in the Primary_Directory. Returns
68 -- File_Name_Type of the full file name if found, No_File if file not
69 -- found. Note that for the special case of gnat.adc, only the compilation
70 -- environment directory is searched, i.e. the directory where the ali and
71 -- object files are written. Another special case is Debug_Generated_Code
72 -- set and the file name ends on ".dg", in which case we look for the
73 -- generated file only in the current directory, since that is where it is
76 function Get_File_Names_Case_Sensitive return Int;
77 pragma Import (C, Get_File_Names_Case_Sensitive,
78 "__gnat_get_file_names_case_sensitive");
79 File_Names_Case_Sensitive : constant Boolean :=
80 Get_File_Names_Case_Sensitive /= 0;
81 -- Set to indicate whether the operating system convention is for file
82 -- names to be case sensitive (e.g., in Unix, set True), or non case
83 -- sensitive (e.g., in OS/2, set False).
85 procedure Canonical_Case_File_Name (S : in out String);
86 -- Given a file name, converts it to canonical case form. For systems
87 -- where file names are case sensitive, this procedure has no effect.
88 -- If file names are not case sensitive (i.e. for example if you have
89 -- the file "xyz.adb", you can refer to it as XYZ.adb or XyZ.AdB), then
90 -- this call converts the given string to canonical all lower case form,
91 -- so that two file names compare equal if they refer to the same file.
93 function Number_Of_Files return Int;
94 -- Gives the total number of filenames found on the command line
96 No_Index : constant := -1;
97 -- Value used in Add_File to indicate no index is specified for main
99 procedure Add_File (File_Name : String; Index : Int := No_Index);
100 -- Called by the subprogram processing the command line for each file name
101 -- found. The index, when not defaulted to No_Index is the index of the
102 -- subprogram in its source, zero indicating that the source is not
105 procedure Find_Program_Name;
106 -- Put simple name of current program being run (excluding the directory
107 -- path) in Name_Buffer, with the length in Name_Len.
109 function Program_Name (Nam : String; Prog : String) return String_Access;
110 -- In the native compilation case, Create a string containing Nam. In the
111 -- cross compilation case, looks at the prefix of the current program being
112 -- run and prepend it to Nam. For instance if the program being run is
113 -- <target>-gnatmake and Nam is "gcc", the returned value will be a pointer
114 -- to "<target>-gcc". In the specific case where AAMP_On_Target is set, the
115 -- name "gcc" is mapped to "gnaamp", and names of the form "gnat*" are
116 -- mapped to "gnaamp*". This function clobbers Name_Buffer and Name_Len.
117 -- Also look at any suffix, e.g. gnatmake-4.1 -> "gcc-4.1". Prog is the
118 -- default name of the current program being executed, e.g. "gnatmake",
121 procedure Write_Program_Name;
122 -- Writes name of program as invoked to the current output (normally
125 procedure Fail (S : String);
126 pragma No_Return (Fail);
127 -- Outputs error message S preceded by the name of the executing program
128 -- and exits with E_Fatal. The output goes to standard error, except if
129 -- special output is in effect (see Output).
131 function Is_Directory_Separator (C : Character) return Boolean;
132 -- Returns True if C is a directory separator
134 function Get_Directory (Name : File_Name_Type) return File_Name_Type;
135 -- Get the prefix directory name (if any) from Name. The last separator
136 -- is preserved. Return the normalized current directory if there is no
137 -- directory part in the name.
139 function Is_Readonly_Library (File : File_Name_Type) return Boolean;
140 -- Check if this library file is a read-only file
142 function Strip_Directory (Name : File_Name_Type) return File_Name_Type;
143 -- Strips the prefix directory name (if any) from Name. Returns the
144 -- stripped name. Name cannot end with a directory separator.
146 function Strip_Suffix (Name : File_Name_Type) return File_Name_Type;
147 -- Strips the suffix (the last '.' and whatever comes after it) from Name.
148 -- Returns the stripped name.
150 function Executable_Name
151 (Name : File_Name_Type;
152 Only_If_No_Suffix : Boolean := False) return File_Name_Type;
153 -- Given a file name it adds the appropriate suffix at the end so that
154 -- it becomes the name of the executable on the system at end. For
155 -- instance under DOS it adds the ".exe" suffix, whereas under UNIX no
158 function Executable_Name
160 Only_If_No_Suffix : Boolean := False) return String;
161 -- Same as above, with String parameters
163 function File_Stamp (Name : File_Name_Type) return Time_Stamp_Type;
164 -- Returns the time stamp of file Name. Name should include relative path
165 -- information in order to locate it. If the source file cannot be opened,
166 -- or Name = No_File, and all blank time stamp is returned (this is not an
169 function File_Stamp (Name : Path_Name_Type) return Time_Stamp_Type;
170 -- Same as above for a path name
172 type String_Access_List is array (Positive range <>) of String_Access;
173 -- Dereferenced type used to return a list of file specs in
174 -- To_Canonical_File_List.
176 type String_Access_List_Access is access all String_Access_List;
177 -- Type used to return a String_Access_List without dragging in secondary
180 function To_Canonical_File_List
181 (Wildcard_Host_File : String;
182 Only_Dirs : Boolean) return String_Access_List_Access;
183 -- Expand a wildcard host syntax file or directory specification (e.g. on
184 -- a VMS host, any file or directory spec that contains: "*", or "%", or
185 -- "...") and return a list of valid Unix syntax file or directory specs.
186 -- If Only_Dirs is True, then only return directories.
188 function To_Canonical_Dir_Spec
190 Prefix_Style : Boolean) return String_Access;
191 -- Convert a host syntax directory specification (e.g. on a VMS host:
192 -- "SYS$DEVICE:[DIR]") to canonical (Unix) syntax (e.g. "/sys$device/dir").
193 -- If Prefix_Style then make it a valid file specification prefix. A file
194 -- specification prefix is a directory specification that can be appended
195 -- with a simple file specification to yield a valid absolute or relative
196 -- path to a file. On a conversion to Unix syntax this simply means the
197 -- spec has a trailing slash ("/").
199 function To_Canonical_File_Spec
200 (Host_File : String) return String_Access;
201 -- Convert a host syntax file specification (e.g. on a VMS host:
202 -- "SYS$DEVICE:[DIR]FILE.EXT;69 to canonical (Unix) syntax (e.g.
203 -- "/sys$device/dir/file.ext.69").
205 function To_Canonical_Path_Spec
206 (Host_Path : String) return String_Access;
207 -- Convert a host syntax Path specification (e.g. on a VMS host:
208 -- "SYS$DEVICE:[BAR],DISK$USER:[FOO] to canonical (Unix) syntax (e.g.
209 -- "/sys$device/foo:disk$user/foo").
211 function To_Host_Dir_Spec
212 (Canonical_Dir : String;
213 Prefix_Style : Boolean) return String_Access;
214 -- Convert a canonical syntax directory specification to host syntax. The
215 -- Prefix_Style flag is currently ignored but should be set to False.
216 -- Note that the caller must free result.
218 function To_Host_File_Spec
219 (Canonical_File : String) return String_Access;
220 -- Convert a canonical syntax file specification to host syntax
222 function Relocate_Path
224 Path : String) return String_Ptr;
225 -- Given an absolute path and a prefix, if Path starts with Prefix,
226 -- replace the Prefix substring with the root installation directory.
227 -- By default, try to compute the root installation directory by looking
228 -- at the executable name as it was typed on the command line and, if
229 -- needed, use the PATH environment variable. If the above computation
230 -- fails, return Path. This function assumes Prefix'First = Path'First.
232 function Shared_Lib (Name : String) return String;
233 -- Returns the runtime shared library in the form -l<name>-<version> where
234 -- version is the GNAT runtime library option for the platform. For example
235 -- this routine called with Name set to "gnat" will return "-lgnat-5.02"
236 -- on UNIX and Windows and -lgnat_5_02 on VMS.
238 ---------------------
239 -- File attributes --
240 ---------------------
242 -- The following subprograms offer services similar to those found in
243 -- System.OS_Lib, but with the ability to extra multiple information from
244 -- a single system call, depending on the system. This can result in fewer
245 -- system calls when reused.
247 -- In all these subprograms, the requested value is either read from the
248 -- File_Attributes parameter (resulting in no system call), or computed
249 -- from the disk and then cached in the File_Attributes parameter (possibly
250 -- along with other values).
252 type File_Attributes is private;
253 Unknown_Attributes : constant File_Attributes;
254 -- A cache for various attributes for a file (length, accessibility,...)
255 -- This must be initialized to Unknown_Attributes prior to the first call.
257 function Is_Directory
259 Attr : access File_Attributes) return Boolean;
260 function Is_Regular_File
262 Attr : access File_Attributes) return Boolean;
263 function Is_Symbolic_Link
265 Attr : access File_Attributes) return Boolean;
266 -- Return the type of the file,
270 Attr : access File_Attributes) return Long_Integer;
271 -- Return the length (number of bytes) of the file
273 function File_Time_Stamp
275 Attr : access File_Attributes) return OS_Time;
276 -- Return the time stamp of the file
278 function Is_Readable_File
280 Attr : access File_Attributes) return Boolean;
281 function Is_Executable_File
283 Attr : access File_Attributes) return Boolean;
284 function Is_Writable_File
286 Attr : access File_Attributes) return Boolean;
287 -- Return the access rights for the file
289 -------------------------
290 -- Search Dir Routines --
291 -------------------------
293 function Include_Dir_Default_Prefix return String;
294 -- Return the directory of the run-time library sources, as modified
297 function Object_Dir_Default_Prefix return String;
298 -- Return the directory of the run-time library ALI and object files, as
299 -- modified by update_path.
301 procedure Add_Default_Search_Dirs;
302 -- This routine adds the default search dirs indicated by the environment
303 -- variables and sdefault package.
305 procedure Add_Lib_Search_Dir (Dir : String);
306 -- Add Dir at the end of the library file search path
308 procedure Add_Src_Search_Dir (Dir : String);
309 -- Add Dir at the end of the source file search path
311 procedure Get_Next_Dir_In_Path_Init
312 (Search_Path : String_Access);
313 function Get_Next_Dir_In_Path
314 (Search_Path : String_Access) return String_Access;
315 -- These subprograms are used to parse out the directory names in a search
316 -- path specified by a Search_Path argument. The procedure initializes an
317 -- internal pointer to point to the initial directory name, and calls to
318 -- the function return successive directory names, with a null pointer
319 -- marking the end of the list.
321 type Search_File_Type is (Include, Objects);
323 procedure Add_Search_Dirs
324 (Search_Path : String_Ptr;
325 Path_Type : Search_File_Type);
326 -- These procedure adds all the search directories that are in Search_Path
327 -- in the proper file search path (library or source)
329 function Get_Primary_Src_Search_Directory return String_Ptr;
330 -- Retrieved the primary directory (directory containing the main source
331 -- file for Gnatmake.
333 function Nb_Dir_In_Src_Search_Path return Natural;
334 function Dir_In_Src_Search_Path (Position : Natural) return String_Ptr;
335 -- Functions to access the directory names in the source search path
337 function Nb_Dir_In_Obj_Search_Path return Natural;
338 function Dir_In_Obj_Search_Path (Position : Natural) return String_Ptr;
339 -- Functions to access the directory names in the Object search path
341 Include_Search_File : constant String_Access :=
342 new String'("ada_source_path");
343 Objects_Search_File : constant String_Access :=
344 new String'("ada_object_path");
345 -- Names of the files containing the default include or objects search
346 -- directories. These files, located in Sdefault.Search_Dir_Prefix, do
347 -- not necessarily exist.
349 Exec_Name : String_Ptr;
350 -- Executable name as typed by the user (used to compute the
351 -- executable prefix).
353 function Read_Default_Search_Dirs
354 (Search_Dir_Prefix : String_Access;
355 Search_File : String_Access;
356 Search_Dir_Default_Name : String_Access) return String_Access;
357 -- Read and return the default search directories from the file located
358 -- in Search_Dir_Prefix (as modified by update_path) and named Search_File.
359 -- If no such file exists or an error occurs then instead return the
360 -- Search_Dir_Default_Name (as modified by update_path).
362 function Get_RTS_Search_Dir
363 (Search_Dir : String;
364 File_Type : Search_File_Type) return String_Ptr;
365 -- This function retrieves the paths to the search (resp. lib) dirs and
366 -- return them. The search dir can be absolute or relative. If the search
367 -- dir contains Include_Search_File (resp. Object_Search_File), then this
368 -- function reads and returns the default search directories from the file.
369 -- Otherwise, if the directory is absolute, it will try to find 'adalib'
370 -- (resp. 'adainclude'). If found, null is returned. If the directory is
371 -- relative, the following directories for the directories 'adalib' and
372 -- 'adainclude' will be scanned:
374 -- - current directory (from which the tool has been spawned)
375 -- - $GNAT_ROOT/gcc/gcc-lib/$targ/$vers/
376 -- - $GNAT_ROOT/gcc/gcc-lib/$targ/$vers/rts-
378 -- The scan will stop as soon as the directory being searched for (adalib
379 -- or adainclude) is found. If the scan fails, null is returned.
381 -----------------------
382 -- Source File Input --
383 -----------------------
385 -- Source file input routines are used by the compiler to read the main
386 -- source files and the subsidiary source files (e.g. with'ed units), and
387 -- also by the binder to check presence/time stamps of sources.
389 procedure Read_Source_File
393 Src : out Source_Buffer_Ptr;
394 T : File_Type := Source);
395 -- Allocates a Source_Buffer of appropriate length and then reads the
396 -- entire contents of the source file N into the buffer. The address of
397 -- the allocated buffer is returned in Src.
399 -- Each line of text is terminated by one of the sequences:
405 -- The source is terminated by an EOF (16#1A#) character, which is the last
406 -- character of the returned source buffer (note that any EOF characters in
407 -- positions other than the last source character are treated as blanks).
409 -- The logical lower bound of the source buffer is the input value of Lo,
410 -- and on exit Hi is set to the logical upper bound of the source buffer.
411 -- Note that the returned value in Src points to an array with a physical
412 -- lower bound of zero. This virtual origin addressing approach means that
413 -- a constrained array pointer can be used with a low bound of zero which
414 -- results in more efficient code.
416 -- If the given file cannot be opened, then the action depends on whether
417 -- this file is the current main unit (i.e. its name matches the name
418 -- returned by the most recent call to Next_Main_Source). If so, then the
419 -- failure to find the file is a fatal error, an error message is output,
420 -- and program execution is terminated. Otherwise (for the case of a
421 -- subsidiary source loaded directly or indirectly using with), a file
422 -- not found condition causes null to be set as the result value.
424 -- Note that the name passed to this function is the simple file name,
425 -- without any directory information. The implementation is responsible
426 -- for searching for the file in the appropriate directories.
428 -- Note the special case that if the file name is gnat.adc, then the search
429 -- for the file is done ONLY in the directory corresponding to the current
430 -- compilation environment, i.e. in the same directory where the ali and
431 -- object files will be written.
433 function Full_Source_Name return File_Name_Type;
434 function Current_Source_File_Stamp return Time_Stamp_Type;
435 -- Returns the full name/time stamp of the source file most recently read
436 -- using Read_Source_File. Calling this routine entails no source file
437 -- directory lookup penalty.
439 procedure Full_Source_Name
441 Full_File : out File_Name_Type;
442 Attr : access File_Attributes);
443 function Full_Source_Name (N : File_Name_Type) return File_Name_Type;
444 function Source_File_Stamp (N : File_Name_Type) return Time_Stamp_Type;
445 -- Returns the full name/time stamp of the source file whose simple name
446 -- is N which should not include path information. Note that if the file
447 -- cannot be located No_File is returned for the first routine and an all
448 -- blank time stamp is returned for the second (this is not an error
449 -- situation). The full name includes appropriate directory information.
450 -- The source file directory lookup penalty is incurred every single time
451 -- the routines are called unless you have previously called
452 -- Source_File_Data (Cache => True). See below.
454 -- The procedural version also returns some file attributes for the ALI
455 -- file (to save on system calls later on).
457 function Current_File_Index return Int;
458 -- Return the index in its source file of the current main unit
460 function Matching_Full_Source_Name
462 T : Time_Stamp_Type) return File_Name_Type;
463 -- Same semantics than Full_Source_Name but will search on the source path
464 -- until a source file with time stamp matching T is found. If none is
465 -- found returns No_File.
467 procedure Source_File_Data (Cache : Boolean);
468 -- By default source file data (full source file name and time stamp)
469 -- are looked up every time a call to Full_Source_Name (N) or
470 -- Source_File_Stamp (N) is made. This may be undesirable in certain
471 -- applications as this is uselessly slow if source file data does not
472 -- change during program execution. When this procedure is called with
473 -- Cache => True access to source file data does not incur a penalty if
474 -- this data was previously retrieved.
476 procedure Dump_Source_File_Names;
477 -- Prints out the names of all source files that have been read by
478 -- Read_Source_File, except those that come from the run-time library
479 -- (i.e. Include_Dir_Default_Prefix). The text is sent to whatever Output
480 -- is currently using (e.g. standard output or standard error).
482 -------------------------------------------
483 -- Representation of Library Information --
484 -------------------------------------------
486 -- Associated with each compiled source file is library information, a
487 -- string of bytes whose exact format is described in the body of Lib.Writ.
488 -- Compiling a source file generates this library information for the
489 -- compiled unit, and access the library information for units that were
490 -- compiled previously on which the unit being compiled depends.
492 -- How this information is stored is up to the implementation of this
493 -- package. At the interface level, this information is simply associated
494 -- with its corresponding source.
496 -- Several different implementations are possible:
498 -- 1. The information could be directly associated with the source file,
499 -- e.g. placed in a resource fork of this file on the Mac, or on
500 -- MS-DOS, written to the source file after the end of file mark.
502 -- 2. The information could be written into the generated object module
503 -- if the system supports the inclusion of arbitrary informational
504 -- byte streams into object files. In this case there must be a naming
505 -- convention that allows object files to be located given the name of
506 -- the corresponding source file.
508 -- 3. The information could be written to a separate file, whose name is
509 -- related to the name of the source file by a fixed convention.
511 -- Which of these three methods is chosen depends on the constraints of the
512 -- host operating system. The interface described here is independent of
513 -- which of these approaches is used. Currently all versions of GNAT use
514 -- the third approach with a file name of xxx.ali where xxx is the source
517 -------------------------------
518 -- Library Information Input --
519 -------------------------------
521 -- These subprograms are used by the binder to read library information
522 -- files, see section above for representation of these files.
524 function Read_Library_Info
525 (Lib_File : File_Name_Type;
526 Fatal_Err : Boolean := False) return Text_Buffer_Ptr;
527 -- Allocates a Text_Buffer of appropriate length and reads in the entire
528 -- source of the library information from the library information file
529 -- whose name is given by the parameter Name.
531 -- See description of Read_Source_File for details on the format of the
532 -- returned text buffer (the format is identical). The lower bound of
533 -- the Text_Buffer is always zero
535 -- If the specified file cannot be opened, then the action depends on
536 -- Fatal_Err. If Fatal_Err is True, an error message is given and the
537 -- compilation is abandoned. Otherwise if Fatal_Err is False, then null
538 -- is returned. Note that the Lib_File is a simple name which does not
539 -- include any directory information. The implementation is responsible
540 -- for searching for the file in appropriate directories.
542 -- If Opt.Check_Object_Consistency is set to True then this routine checks
543 -- whether the object file corresponding to the Lib_File is consistent with
544 -- it. The object file is inconsistent if the object does not exist or if
545 -- it has an older time stamp than Lib_File. This check is not performed
546 -- when the Lib_File is "locked" (i.e. read/only) because in this case the
547 -- object file may be buried in a library. In case of inconsistencies
548 -- Read_Library_Info behaves as if it did not find Lib_File (namely if
549 -- Fatal_Err is False, null is returned).
551 function Read_Library_Info_From_Full
552 (Full_Lib_File : File_Name_Type;
553 Lib_File_Attr : access File_Attributes;
554 Fatal_Err : Boolean := False) return Text_Buffer_Ptr;
555 -- Same as Read_Library_Info, except Full_Lib_File must contains the full
556 -- path to the library file (instead of having Read_Library_Info recompute
558 -- Lib_File_Attr should be an initialized set of attributes for the
559 -- library file (it can be initialized to Unknown_Attributes, but in
560 -- general will have been initialized by a previous call to Find_File).
562 function Full_Library_Info_Name return File_Name_Type;
563 function Full_Object_File_Name return File_Name_Type;
564 -- Returns the full name of the library/object file most recently read
565 -- using Read_Library_Info, including appropriate directory information.
566 -- Calling this routine entails no library file directory lookup
567 -- penalty. Note that the object file corresponding to a library file
568 -- is not actually read. Its time stamp is affected when the flag
569 -- Opt.Check_Object_Consistency is set.
571 function Current_Library_File_Stamp return Time_Stamp_Type;
572 function Current_Object_File_Stamp return Time_Stamp_Type;
573 -- The time stamps of the files returned by the previous two routines.
574 -- It is an error to call Current_Object_File_Stamp if
575 -- Opt.Check_Object_Consistency is set to False.
577 procedure Full_Lib_File_Name
579 Lib_File : out File_Name_Type;
580 Attr : out File_Attributes);
581 function Full_Lib_File_Name (N : File_Name_Type) return File_Name_Type;
582 -- Returns the full name of library file N. N should not include
583 -- path information. Note that if the file cannot be located No_File is
584 -- returned for the first routine and an all blank time stamp is returned
585 -- for the second (this is not an error situation). The full name includes
586 -- the appropriate directory information. The library file directory lookup
587 -- penalty is incurred every single time this routine is called.
588 -- The procedural version also returns some file attributes for the ALI
589 -- file (to save on system calls later on).
591 function Lib_File_Name
592 (Source_File : File_Name_Type;
593 Munit_Index : Nat := 0) return File_Name_Type;
594 -- Given the name of a source file, returns the name of the corresponding
595 -- library information file. This may be the name of the object file or of
596 -- a separate file used to store the library information. In the current
597 -- implementation, a separate file (the ALI file) is always used. In either
598 -- case the returned result is suitable for calling Read_Library_Info. The
599 -- Munit_Index is the unit index in multiple unit per file mode, or zero in
600 -- normal single unit per file mode (used to add ~nnn suffix). Note: this
601 -- subprogram is in this section because it is used by the compiler to
602 -- determine the proper library information names to be placed in the
603 -- generated library information file.
609 Current_Exit_Status : Integer := 0;
610 -- Exit status that is set with procedure OS_Exit_Through_Exception below
611 -- and can be used in exception handler for Types.Terminate_Program to call
612 -- Set_Exit_Status as the last action of the program.
614 procedure OS_Exit_Through_Exception (Status : Integer);
615 -- Set the Current_Exit_Status, then raise Types.Terminate_Program
617 type Exit_Code_Type is (
618 E_Success, -- No warnings or errors
619 E_Warnings, -- Compiler warnings generated
620 E_No_Code, -- No code generated
621 E_No_Compile, -- Compilation not needed (smart recompilation)
622 E_Errors, -- Compiler error messages generated
623 E_Fatal, -- Fatal (serious) error, e.g. source file not found
624 E_Abort); -- Internally detected compiler error
626 procedure Exit_Program (Exit_Code : Exit_Code_Type);
627 pragma No_Return (Exit_Program);
628 -- A call to Exit_Program terminates execution with the given status. A
629 -- status of zero indicates normal completion, a non-zero status indicates
630 -- abnormal termination.
632 -------------------------
633 -- Command Line Access --
634 -------------------------
636 -- Direct interface to command line parameters. (We don't want to use
637 -- the predefined command line package because it defines functions
640 function Arg_Count return Natural;
641 pragma Import (C, Arg_Count, "__gnat_arg_count");
642 -- Get number of arguments (note: optional globbing may be enabled)
644 procedure Fill_Arg (A : System.Address; Arg_Num : Integer);
645 pragma Import (C, Fill_Arg, "__gnat_fill_arg");
646 -- Store one argument
648 function Len_Arg (Arg_Num : Integer) return Integer;
649 pragma Import (C, Len_Arg, "__gnat_len_arg");
650 -- Get length of argument
652 ALI_Default_Suffix : constant String_Ptr := new String'("ali");
653 ALI_Suffix : String_Ptr := ALI_Default_Suffix;
654 -- The suffixes used for the library files (also known as ALI files)
658 Current_Main : File_Name_Type := No_File;
659 -- Used to save a simple file name between calls to Next_Main_Source and
660 -- Read_Source_File. If the file name argument to Read_Source_File is
661 -- No_File, that indicates that the file whose name was returned by the
662 -- last call to Next_Main_Source (and stored here) is to be read.
664 Target_Object_Suffix : constant String := Get_Target_Object_Suffix.all;
665 -- The suffix used for the target object files
667 Output_FD : File_Descriptor;
668 -- File descriptor for current library info, list, tree, or binder output
670 Output_File_Name : File_Name_Type;
671 -- File_Name_Type for name of open file whose FD is in Output_FD, the name
672 -- stored does not include the trailing NUL character.
674 Argument_Count : constant Integer := Arg_Count - 1;
675 -- Number of arguments (excluding program name)
677 type File_Name_Array is array (Int range <>) of String_Ptr;
678 type File_Name_Array_Ptr is access File_Name_Array;
679 File_Names : File_Name_Array_Ptr :=
680 new File_Name_Array (1 .. Int (Argument_Count) + 2);
681 -- As arguments are scanned, file names are stored in this array. The
682 -- strings do not have terminating NUL files. The array is extensible,
683 -- because when using project files, there may be more files than
684 -- arguments on the command line.
686 type File_Index_Array is array (Int range <>) of Int;
687 type File_Index_Array_Ptr is access File_Index_Array;
688 File_Indexes : File_Index_Array_Ptr :=
689 new File_Index_Array (1 .. Int (Argument_Count) + 2);
691 Current_File_Name_Index : Int := 0;
692 -- The index in File_Names of the last file opened by Next_Main_Source
693 -- or Next_Main_Lib_File. The value 0 indicates that no files have been
696 procedure Create_File_And_Check
697 (Fdesc : out File_Descriptor;
699 -- Create file whose name (NUL terminated) is in Name_Buffer (with the
700 -- length in Name_Len), and place the resulting descriptor in Fdesc. Issue
701 -- message and exit with fatal error if file cannot be created. The Fmode
702 -- parameter is set to either Text or Binary (for details see description
703 -- of System.OS_Lib.Create_File).
705 type Program_Type is (Compiler, Binder, Make, Gnatls, Unspecified);
706 -- Program currently running
707 procedure Set_Program (P : Program_Type);
708 -- Indicates to the body of Osint the program currently running. This
709 -- procedure is called by the child packages of Osint. A check is made
710 -- that this procedure is not called more than once.
712 function More_Files return Boolean;
713 -- Implements More_Source_Files and More_Lib_Files
715 function Next_Main_File return File_Name_Type;
716 -- Implements Next_Main_Source and Next_Main_Lib_File
718 function Object_File_Name (N : File_Name_Type) return File_Name_Type;
719 -- Constructs the name of the object file corresponding to library file N.
720 -- If N is a full file name than the returned file name will also be a full
721 -- file name. Note that no lookup in the library file directories is done
722 -- for this file. This routine merely constructs the name.
724 procedure Write_Info (Info : String);
725 -- Implementation of Write_Binder_Info, Write_Debug_Info and
726 -- Write_Library_Info (identical)
728 procedure Write_With_Check (A : Address; N : Integer);
729 -- Writes N bytes from buffer starting at address A to file whose FD is
730 -- stored in Output_FD, and whose file name is stored as a File_Name_Type
731 -- in Output_File_Name. A check is made for disk full, and if this is
732 -- detected, the file being written is deleted, and a fatal error is
735 File_Attributes_Size : constant Integer := 50;
736 -- This should be big enough to fit a "struct file_attributes" on any
737 -- system. It doesn't matter if it is too big (which avoids the need for
738 -- either mapping the struct exactly or importing the sizeof from C, which
739 -- would result in dynamic code)
741 type File_Attributes is
742 array (1 .. File_Attributes_Size)
743 of System.Storage_Elements.Storage_Element;
744 for File_Attributes'Alignment use Standard'Maximum_Alignment;
746 Unknown_Attributes : constant File_Attributes := (others => 0);
747 -- Will be initialized properly at elaboration (for efficiency later on,
748 -- avoid function calls every time we want to reset the attributes).