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