diff options
Diffstat (limited to 'gcc/ada/g-os_lib.ads')
| -rw-r--r-- | gcc/ada/g-os_lib.ads | 272 |
1 files changed, 230 insertions, 42 deletions
diff --git a/gcc/ada/g-os_lib.ads b/gcc/ada/g-os_lib.ads index c6dfede2021..f7cf85bb3fc 100644 --- a/gcc/ada/g-os_lib.ads +++ b/gcc/ada/g-os_lib.ads @@ -6,7 +6,7 @@ -- -- -- S p e c -- -- -- --- Copyright (C) 1995-2002 Free Software Foundation, Inc. -- +-- Copyright (C) 1995-2003 Free Software Foundation, Inc. -- -- -- -- GNAT is free software; you can redistribute it and/or modify it under -- -- terms of the GNU General Public License as published by the Free Soft- -- @@ -26,7 +26,8 @@ -- however invalidate any other reasons why the executable file might be -- -- covered by the GNU Public License. -- -- -- --- Extensive contributions were provided by Ada Core Technologies Inc. -- +-- GNAT was originally developed by the GNAT team at New York University. -- +-- Extensive contributions were provided by Ada Core Technologies Inc. -- -- -- ------------------------------------------------------------------------------ @@ -46,27 +47,44 @@ -- all GNAT implementations on all supported operating systems. with System; -with Unchecked_Deallocation; +with GNAT.Strings; package GNAT.OS_Lib is pragma Elaborate_Body (OS_Lib); - type String_Access is access all String; + subtype String_Access is Strings.String_Access; -- General purpose string access type. Some of the functions in this -- package allocate string results on the heap, and return a value of -- this type. Note that the caller is responsible for freeing this -- String to avoid memory leaks. - procedure Free is new Unchecked_Deallocation - (Object => String, Name => String_Access); + function "=" (Left, Right : in String_Access) return Boolean + renames Strings."="; + + procedure Free (X : in out String_Access) renames Strings.Free; -- This procedure is provided for freeing returned values of type -- String_Access - type String_List is array (Positive range <>) of String_Access; - type String_List_Access is access all String_List; + subtype String_List is Strings.String_List; + function "=" (Left, Right : in String_List) return Boolean + renames Strings."="; + + function "&" (Left : String_Access; Right : String_Access) + return String_List renames Strings."&"; + function "&" (Left : String_Access; Right : String_List) + return String_List renames Strings."&"; + function "&" (Left : String_List; Right : String_Access) + return String_List renames Strings."&"; + function "&" (Left : String_List; Right : String_List) + return String_List renames Strings."&"; + + subtype String_List_Access is Strings.String_List_Access; -- General purpose array and pointer for list of string accesses + function "=" (Left, Right : in String_List_Access) return Boolean + renames Strings."="; - procedure Free (Arg : in out String_List_Access); + procedure Free (Arg : in out String_List_Access) + renames Strings.Free; -- Frees the given array and all strings that its elements reference, -- and then sets the argument to null. Provided for freeing returned -- values of this type (including Argument_List_Access). @@ -100,6 +118,14 @@ pragma Elaborate_Body (OS_Lib); function GM_Minute (Date : OS_Time) return Minute_Type; function GM_Second (Date : OS_Time) return Second_Type; + function "<" (X, Y : OS_Time) return Boolean; + function ">" (X, Y : OS_Time) return Boolean; + function ">=" (X, Y : OS_Time) return Boolean; + function "<=" (X, Y : OS_Time) return Boolean; + -- Basic comparison operators on OS_Time with obvious meanings. Note + -- that these have Intrinsic convention, so for example it is not + -- permissible to create accesses to any of these functions. + procedure GM_Split (Date : OS_Time; Year : out Year_Type; @@ -125,15 +151,15 @@ pragma Elaborate_Body (OS_Lib); -- permitted, and will be ignored (more accurately, the NUL and any -- characters that follow it will be ignored). - type File_Descriptor is private; - -- Corresponds to the int file handle values used in the C routines, + type File_Descriptor is new Integer; + -- Corresponds to the int file handle values used in the C routines - Standin : constant File_Descriptor; - Standout : constant File_Descriptor; - Standerr : constant File_Descriptor; + Standin : constant File_Descriptor := 0; + Standout : constant File_Descriptor := 1; + Standerr : constant File_Descriptor := 2; -- File descriptors for standard input output files - Invalid_FD : constant File_Descriptor; + Invalid_FD : constant File_Descriptor := -1; -- File descriptor returned when error in opening/creating file; type Mode is (Binary, Text); @@ -145,7 +171,7 @@ pragma Elaborate_Body (OS_Lib); -- Text as the mode parameter causes the system to do CR/LF translation -- and also to recognize the DOS end of file character on input. The use -- of Text where appropriate allows programs to take a portable Unix view - -- of DOs-format files and process them appropriately. + -- of DOS-format files and process them appropriately. function Open_Read (Name : String; @@ -188,15 +214,40 @@ pragma Elaborate_Body (OS_Lib); procedure Create_Temp_File (FD : out File_Descriptor; Name : out Temp_File_Name); - -- Create and open for writing a temporary file. The name of the - -- file and the File Descriptor are returned. The File Descriptor - -- returned is Invalid_FD in the case of failure. No mode parameter - -- is provided. Since this is a temporary file, there is no point in - -- doing text translation on it. + -- Create and open for writing a temporary file in the current working + -- directory. The name of the file and the File Descriptor are returned. + -- The File Descriptor returned is Invalid_FD in the case of failure. + -- No mode parameter is provided. Since this is a temporary file, + -- there is no point in doing text translation on it. + -- On some OSes, the maximum number of temp files that can be + -- created with this procedure may be limited. When the maximum is + -- reached, this procedure returns Invalid_FD. On some OSes, there may be + -- a race condition between processes trying to create temp files + -- at the same time in the same directory using this procedure. + + procedure Create_Temp_File + (FD : out File_Descriptor; + Name : out String_Access); + -- Create and open for writing a temporary file in the current working + -- directory. The name of the file and the File Descriptor are returned. + -- No mode parameter is provided. Since this is a temporary file, + -- there is no point in doing text translation on it. + -- It is the responsibility of the caller to deallocate the access value + -- returned in Name. + -- This procedure will always succeed if the current working directory + -- is writable. If the current working directory is not writable, then + -- Invalid_FD is returned for the file descriptor and null for the Name. + -- There is no race condition problem between processes trying to + -- create temp files at the same time in the same directory. + + procedure Close (FD : File_Descriptor; Status : out Boolean); + -- Close file referenced by FD. Status is False if the underlying service + -- failed. Reasons for failure include: disk full, disk quotas exceeded + -- and invalid file descriptor (the file may have been closed twice). procedure Close (FD : File_Descriptor); - pragma Import (C, Close, "close"); - -- Close file referenced by FD + -- Close file referenced by FD. This form is used when the caller + -- wants to ignore any possible error (see above for error cases). procedure Delete_File (Name : String; Success : out Boolean); -- Deletes file. Success is set True or False indicating if the delete is @@ -206,8 +257,79 @@ pragma Elaborate_Body (OS_Lib); (Old_Name : String; New_Name : String; Success : out Boolean); - -- Rename a file. Success is set True or False indicating if the rename is - -- successful. + -- Rename a file. Success is set True or False indicating if the + -- rename is successful or not. + + -- The following defines the mode for the Copy_File procedure below. + -- Note that "time stamps and other file attributes" in the descriptions + -- below refers to the creation and last modification times, and also + -- the file access (read/write/execute) status flags. + + type Copy_Mode is + (Copy, + -- Copy the file. It is an error if the target file already exists. + -- The time stamps and other file attributes are preserved in the copy. + + Overwrite, + -- If the target file exists, the file is replaced otherwise + -- the file is just copied. The time stamps and other file + -- attributes are preserved in the copy. + + Append); + -- If the target file exists, the contents of the source file + -- is appended at the end. Otherwise the source file is just + -- copied. The time stamps and other file attributes are + -- are preserved if the destination file does not exist. + + type Attribute is + (Time_Stamps, + -- Copy time stamps from source file to target file. All other + -- attributes are set to normal default values for file creation. + + Full, + -- All attributes are copied from the source file to the target + -- file. This includes the timestamps, and for example also includes + -- read/write/execute attributes in Unix systems. + + None); + -- No attributes are copied. All attributes including the time stamp + -- values are set to normal default values for file creation. + + -- Note: The default is Time_Stamps, which corresponds to the normal + -- default on Windows style systems. Full corresponds to the typical + -- effect of "cp -p" on Unix systems, and None corresponds to the + -- typical effect of "cp" on Unix systems. + + -- Note: Time_Stamps and Full are not supported on VMS and VxWorks + + procedure Copy_File + (Name : String; + Pathname : String; + Success : out Boolean; + Mode : Copy_Mode := Copy; + Preserve : Attribute := Time_Stamps); + -- Copy a file. Name must designate a single file (no wild cards allowed). + -- Pathname can be a filename or directory name. In the latter case Name + -- is copied into the directory preserving the same file name. Mode + -- defines the kind of copy, see above with the default being a normal + -- copy in which the target file must not already exist. Success is set + -- to True or False indicating if the copy is successful (depending on + -- the specified Mode). + -- + -- Note: this procedure is only supported to a very limited extent on + -- VMS. The only supported mode is Overwrite, and the only supported + -- value for Preserve is None, resulting in the default action which + -- for Overwrite is to leave attributes unchanged. Furthermore, the + -- copy only works for simple text files. + + procedure Copy_Time_Stamps (Source, Dest : String; Success : out Boolean); + -- Copy Source file time stamps (last modification and last access time + -- stamps) to Dest file. Source and Dest must be valid filenames, + -- furthermore Dest must be writable. Success will be set to True if the + -- operation was successful and False otherwise. + -- + -- Note: this procedure is not supported on VMS and VxWorks. On these + -- platforms, Success is always set to False. function Read (FD : File_Descriptor; @@ -248,15 +370,17 @@ pragma Elaborate_Body (OS_Lib); function File_Time_Stamp (Name : String) return OS_Time; -- Given the name of a file or directory, Name, obtains and returns the - -- time stamp. This function can be used for an unopend file. + -- time stamp. This function can be used for an unopened file. function File_Time_Stamp (FD : File_Descriptor) return OS_Time; -- Get time stamp of file from file descriptor FD function Normalize_Pathname - (Name : String; - Directory : String := "") - return String; + (Name : String; + Directory : String := ""; + Resolve_Links : Boolean := True; + Case_Sensitive : Boolean := True) + return String; -- Returns a file name as an absolute path name, resolving all relative -- directories, and symbolic links. The parameter Directory is a fully -- resolved path name for a directory, or the empty string (the default). @@ -269,6 +393,11 @@ pragma Elaborate_Body (OS_Lib); -- not true; for example, this is not true in Unix for two hard links -- designating the same file. -- + -- If Resolve_Links is set to True, then the symbolic links, on systems + -- that support them, will be fully converted to the name of the file + -- or directory pointed to. This is slightly less efficient, since it + -- requires system calls. + -- -- If Name cannot be resolved or is null on entry (for example if there is -- a circularity in symbolic links: A is a symbolic link for B, while B is -- a symbolic link for A), then Normalize_Pathname returns an empty string. @@ -276,6 +405,14 @@ pragma Elaborate_Body (OS_Lib); -- In VMS, if Name follows the VMS syntax file specification, it is first -- converted into Unix syntax. If the conversion fails, Normalize_Pathname -- returns an empty string. + -- + -- For case-sensitive file systems, the value of Case_Sensitive parameter + -- is ignored. In systems that have a non case-sensitive file system like + -- Windows and OpenVMS, if this parameter is set OFF, then the result + -- is returned folded to lower case, this allows to checks if two files + -- are the same by applying this function to their names and by comparing + -- the results of these calls. If Case_Sensitive is ON, this function does + -- not change the casing of file and directory names. function Is_Absolute_Path (Name : String) return Boolean; -- Returns True if Name is an absolute path name, i.e. it designates @@ -289,9 +426,30 @@ pragma Elaborate_Body (OS_Lib); -- Determines if the given string, Name, is the name of a directory. -- Returns True if so, False otherwise. + function Is_Readable_File (Name : String) return Boolean; + -- Determines if the given string, Name, is the name of an existing + -- file that is readable. Returns True if so, False otherwise. Note + -- that this function simply interrogates the file attributes (e.g. + -- using the C function stat), so it does not indicate a situation + -- in which a file may not actually be readable due to some other + -- process having exclusive access. + function Is_Writable_File (Name : String) return Boolean; -- Determines if the given string, Name, is the name of an existing - -- file that is writable. Returns True if so, False otherwise. + -- file that is writable. Returns True if so, False otherwise. Note + -- that this function simply interrogates the file attributes (e.g. + -- using the C function stat), so it does not indicate a situation + -- in which a file may not actually be writeable due to some other + -- process having exclusive access. + + function Is_Symbolic_Link (Name : String) return Boolean; + -- Determines if the given string, Name, is the path of a symbolic link + -- on systems that support it. Returns True if so, False if the path + -- is not a symbolic link or if the system does not support symbolic links. + -- + -- A symbolic link is an indirect pointer to a file; its directory entry + -- contains the name of the file to which it is linked. Symbolic links may + -- span file systems and may refer to directories. function Locate_Exec_On_Path (Exec_Name : String) @@ -312,7 +470,10 @@ pragma Elaborate_Body (OS_Lib); -- directories listed in Path. If a file is found, its full pathname is -- returned; otherwise, a null pointer is returned. If the File_Name given -- is an absolute pathname, then Locate_Regular_File just checks that the - -- file exists and is a regular file. Otherwise, the Path argument is + -- file exists and is a regular file. Otherwise, if the File_Name given + -- includes directory information, Locate_Regular_File first checks if + -- the file exists relative to the current directory. If it does not, + -- or if the File_Name given is a simple file name, the Path argument is -- parsed according to OS conventions, and for each directory in the Path -- a check is made if File_Name is a relative pathname of a regular file -- from that directory. @@ -338,7 +499,7 @@ pragma Elaborate_Body (OS_Lib); -- The following section contains low-level routines using addresses to -- pass file name and executable name. In each routine the name must be -- Nul-Terminated. For complete documentation refer to the equivalent - -- routine (but using string) defined above. + -- routine (using String in place of C_File_Name) defined above. subtype C_File_Name is System.Address; -- This subtype is used to document that a parameter is the address @@ -371,13 +532,26 @@ pragma Elaborate_Body (OS_Lib); New_Name : C_File_Name; Success : out Boolean); + procedure Copy_File + (Name : C_File_Name; + Pathname : C_File_Name; + Success : out Boolean; + Mode : Copy_Mode := Copy; + Preserve : Attribute := Time_Stamps); + + procedure Copy_Time_Stamps + (Source, Dest : C_File_Name; + Success : out Boolean); + function File_Time_Stamp (Name : C_File_Name) return OS_Time; function Is_Regular_File (Name : C_File_Name) return Boolean; function Is_Directory (Name : C_File_Name) return Boolean; + function Is_Readable_File (Name : C_File_Name) return Boolean; function Is_Writable_File (Name : C_File_Name) return Boolean; + function Is_Symbolic_Link (Name : C_File_Name) return Boolean; function Locate_Regular_File (File_Name : C_File_Name; @@ -405,7 +579,7 @@ pragma Elaborate_Body (OS_Lib); -- on the same list it will do nothing the second time. Note that Spawn -- and Non_Blocking_Spawn call Normalize_Arguments automatically, but -- since there is a guarantee that a second call does nothing, this - -- internal call with have no effect if Normalize_Arguments is called + -- internal call will have no effect if Normalize_Arguments is called -- before calling Spawn. The call to Normalize_Arguments assumes that -- the individual referenced arguments in Argument_List are on the heap, -- and may free them and reallocate if they are modified. @@ -423,6 +597,8 @@ pragma Elaborate_Body (OS_Lib); -- argument. On some systems (notably Unix systems) a simple file -- name may also work (if the executable can be located in the path). -- + -- "Spawn" should not be used in tasking applications. + -- -- Note: Arguments in Args that contain spaces and/or quotes such as -- "--GCC=gcc -v" or "--GCC=""gcc -v""" are not portable across all -- operating systems, and would not have the desired effect if they @@ -448,6 +624,9 @@ pragma Elaborate_Body (OS_Lib); -- Similar to the above procedure, but returns the actual status returned -- by the operating system, or -1 under VxWorks and any other similar -- operating systems which have no notion of separately spawnable programs. + -- + -- "Spawn" should not be used in tasking applications. + -- type Process_Id is private; -- A private type used to identify a process activated by the following @@ -465,6 +644,8 @@ pragma Elaborate_Body (OS_Lib); -- is returned. Parameters are to be used as in Spawn. If Invalid_Id -- is returned the program could not be spawned. -- + -- "Non_Blocking_Spawn" should not be used in tasking applications. + -- -- This function will always return Invalid_Id under VxWorks, since -- there is no notion of executables under this OS. @@ -485,7 +666,7 @@ pragma Elaborate_Body (OS_Lib); function Argument_String_To_List (Arg_String : String) return Argument_List_Access; - -- Take a string that is a program and it's arguments and parse it into + -- Take a string that is a program and its arguments and parse it into -- an Argument_List. Note that the result is allocated on the heap, and -- must be freed by the programmer (when it is no longer needed) to avoid -- memory leaks. @@ -545,14 +726,21 @@ private pragma Import (C, Path_Separator, "__gnat_path_separator"); pragma Import (C, Directory_Separator, "__gnat_dir_separator"); - type OS_Time is new Integer; - - type File_Descriptor is new Integer; - - Standin : constant File_Descriptor := 0; - Standout : constant File_Descriptor := 1; - Standerr : constant File_Descriptor := 2; - Invalid_FD : constant File_Descriptor := -1; + type OS_Time is new Long_Integer; + -- Type used for timestamps in the compiler. This type is used to + -- hold time stamps, but may have a different representation than + -- C's time_t. This type needs to match the declaration of OS_Time + -- in adaint.h. + + -- Add pragma Inline statements for comparison operations on OS_Time. + -- It would actually be nice to use pragma Import (Intrinsic) here, + -- but this was not properly supported till GNAT 3.15a, so that would + -- cause bootstrap path problems. To be changed later ??? + + pragma Inline ("<"); + pragma Inline (">"); + pragma Inline ("<="); + pragma Inline (">="); type Process_Id is new Integer; Invalid_Pid : constant Process_Id := -1; |