1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
5 -- G N A T . D I R E C T O R Y _ O P E R A T I O N S --
9 -- Copyright (C) 1998-2005, AdaCore --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 2, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING. If not, write --
19 -- to the Free Software Foundation, 51 Franklin Street, Fifth Floor, --
20 -- Boston, MA 02110-1301, USA. --
22 -- As a special exception, if other files instantiate generics from this --
23 -- unit, or you link this unit with other files to produce an executable, --
24 -- this unit does not by itself cause the resulting executable to be --
25 -- covered by the GNU General Public License. This exception does not --
26 -- however invalidate any other reasons why the executable file might be --
27 -- covered by the GNU Public License. --
29 -- GNAT was originally developed by the GNAT team at New York University. --
30 -- Extensive contributions were provided by Ada Core Technologies Inc. --
32 ------------------------------------------------------------------------------
34 -- Directory operations
36 -- This package provides routines for manipulating directories. A directory
37 -- can be treated as a file, using open and close routines, and a scanning
38 -- routine is provided for iterating through the entries in a directory.
40 -- See also child package GNAT.Directory_Operations.Iteration
42 -- Note: support on OpenVMS is limited to the support of Unix-style
43 -- directory names (OpenVMS native directory format is not supported).
44 -- Read individual entries for more specific notes on OpenVMS support.
46 with Ada
.Strings
.Maps
;
48 package GNAT
.Directory_Operations
is
50 subtype Dir_Name_Str
is String;
51 -- A subtype used in this package to represent string values that are
52 -- directory names. A directory name is a prefix for files that appear
53 -- with in the directory. This means that for UNIX systems, the string
54 -- includes a final '/', and for DOS-like systems, it includes a final
55 -- '\' character. It can also include drive letters if the operating
56 -- system provides for this. The final '/' or '\' in a Dir_Name_Str is
57 -- optional when passed as a procedure or function in parameter.
58 -- On OpenVMS, only Unix style path names are supported, not VMS style,
59 -- but the directory and file names are not case sensitive.
61 type Dir_Type
is limited private;
62 -- A value used to reference a directory. Conceptually this value includes
63 -- the identity of the directory, and a sequential position within it.
65 Null_Dir
: constant Dir_Type
;
66 -- Represent the value for an uninitialized or closed directory
68 Directory_Error
: exception;
69 -- Exception raised if the directory cannot be opened, read, closed,
70 -- created or if it is not possible to change the current execution
71 -- environment directory.
73 Dir_Separator
: constant Character;
74 -- Running system default directory separator
76 --------------------------------
77 -- Basic Directory operations --
78 --------------------------------
80 procedure Change_Dir
(Dir_Name
: Dir_Name_Str
);
81 -- Changes the working directory of the current execution environment
82 -- to the directory named by Dir_Name. Raises Directory_Error if Dir_Name
85 procedure Make_Dir
(Dir_Name
: Dir_Name_Str
);
86 -- Create a new directory named Dir_Name. Raises Directory_Error if
87 -- Dir_Name cannot be created.
90 (Dir_Name
: Dir_Name_Str
;
91 Recursive
: Boolean := False);
92 -- Remove the directory named Dir_Name. If Recursive is set to True, then
93 -- Remove_Dir removes all the subdirectories and files that are in
94 -- Dir_Name. Raises Directory_Error if Dir_Name cannot be removed.
96 function Get_Current_Dir
return Dir_Name_Str
;
97 -- Returns the current working directory for the execution environment
99 procedure Get_Current_Dir
(Dir
: out Dir_Name_Str
; Last
: out Natural);
100 -- Returns the current working directory for the execution environment
101 -- The name is returned in Dir_Name. Last is the index in Dir_Name such
102 -- that Dir_Name (Last) is the last character written. If Dir_Name is
103 -- too small for the directory name, the name will be truncated before
104 -- being copied to Dir_Name.
106 -------------------------
107 -- Pathname Operations --
108 -------------------------
110 subtype Path_Name
is String;
111 -- All routines using Path_Name handle both styles (UNIX and DOS) of
112 -- directory separators (either slash or back slash).
114 function Dir_Name
(Path
: Path_Name
) return Dir_Name_Str
;
115 -- Returns directory name for Path. This is similar to the UNIX dirname
116 -- command. Everything after the last directory separator is removed. If
117 -- there is no directory separator the current working directory is
118 -- returned. Note that the contents of Path is case-sensitive on
119 -- systems that have case-sensitive file names (like Unix), and
120 -- non-case-sensitive on systems where the file system is also non-
121 -- case-sensitive (such as Windows, and OpenVMS).
125 Suffix
: String := "") return String;
126 -- Any directory prefix is removed. A directory prefix is defined as
127 -- text up to and including the last directory separator character in
128 -- the input string. In addition if Path ends with the string given for
129 -- Suffix, then it is also removed. Note that Suffix here can be an
130 -- arbitrary string (it is not required to be a file extension). This
131 -- is equivalent to the UNIX basename command. The following rule is
134 -- 'Path' and 'Dir_Name (Path) & Directory_Separator & Base_Name (Path)'
135 -- represent the same file.
137 -- The comparison of Suffix is case-insensitive on systems such as Windows
138 -- and VMS where the file search is case-insensitive (e.g. on such systems,
139 -- Base_Name ("/Users/AdaCore/BB12.patch", ".Patch") returns "BB12").
141 -- Note that the index bounds of the result match the corresponding indexes
142 -- in the Path string (you cannot assume that the lower bound of the
143 -- returned string is one).
145 function File_Extension
(Path
: Path_Name
) return String;
146 -- Return the file extension. This is defined as the string after the
147 -- last dot, including the dot itself. For example, if the file name
148 -- is "file1.xyz.adq", then the returned value would be ".adq". If no
149 -- dot is present in the file name, or the last character of the file
150 -- name is a dot, then the null string is returned.
152 function File_Name
(Path
: Path_Name
) return String;
153 -- Returns the file name and the file extension if present. It removes all
154 -- path information. This is equivalent to Base_Name with default Extension
157 type Path_Style
is (UNIX
, DOS
, System_Default
);
158 function Format_Pathname
160 Style
: Path_Style
:= System_Default
) return Path_Name
;
161 -- Removes all double directory separator and converts all '\' to '/' if
162 -- Style is UNIX and converts all '/' to '\' if Style is set to DOS. This
163 -- function will help to provide a consistent naming scheme running for
164 -- different environments. If style is set to System_Default the routine
165 -- will use the default directory separator on the running environment.
167 -- The Style argument indicates the syntax to be used for path names:
170 -- Use '/' as the directory separator. The default on Unix systems
174 -- Use '\' as the directory separator. The default on Windows.
177 -- Use the default style for the current system
179 type Environment_Style
is (UNIX
, DOS
, Both
, System_Default
);
182 Mode
: Environment_Style
:= System_Default
) return Path_Name
;
183 -- Returns Path with environment variables (or logical names on OpenVMS)
184 -- replaced by the current environment variable value. For example,
185 -- $HOME/mydir will be replaced by /home/joe/mydir if $HOME environment
186 -- variable is set to /home/joe and Mode is UNIX. If an environment
187 -- variable does not exists the variable will be replaced by the empty
188 -- string. Two dollar or percent signs are replaced by a single
189 -- dollar/percent sign. Note that a variable must start with a letter.
191 -- The Mode argument indicates the recognized syntax for environment
192 -- variables as follows:
195 -- Environment variables and OpenVMS logical names use $ as prefix and
196 -- can use curly brackets as in ${HOME}/mydir. If there is no closing
197 -- curly bracket for an opening one then no translation is done, so for
198 -- example ${VAR/toto is returned as ${VAR/toto. The use of {} brackets
199 -- is required if the environment variable name contains other than
200 -- alphanumeric characters.
203 -- Environment variables uses % as prefix and suffix (e.g. %HOME%/dir).
204 -- The name DOS refer to "DOS-like" environment. This includes all
208 -- Recognize both forms described above.
211 -- Uses either UNIX on Unix and OpenVMS systems, or DOS on Windows and
212 -- OS/2 depending on the running environment.
218 procedure Open
(Dir
: out Dir_Type
; Dir_Name
: Dir_Name_Str
);
219 -- Opens the directory named by Dir_Name and returns a Dir_Type value
220 -- that refers to this directory, and is positioned at the first entry.
221 -- Raises Directory_Error if Dir_Name cannot be accessed. In that case
222 -- Dir will be set to Null_Dir.
224 procedure Close
(Dir
: in out Dir_Type
);
225 -- Closes the directory stream refered to by Dir. After calling Close
226 -- Is_Open will return False. Dir will be set to Null_Dir.
227 -- Raises Directory_Error if Dir has not be opened (Dir = Null_Dir).
229 function Is_Open
(Dir
: Dir_Type
) return Boolean;
230 -- Returns True if Dir is open, or False otherwise
233 (Dir
: in out Dir_Type
;
236 -- Reads the next entry from the directory and sets Str to the name
237 -- of that entry. Last is the index in Str such that Str (Last) is the
238 -- last character written. Last is 0 when there are no more files in the
239 -- directory. If Str is too small for the file name, the file name will
240 -- be truncated before being copied to Str. The list of files returned
241 -- includes directories in systems providing a hierarchical directory
242 -- structure, including . (the current directory) and .. (the parent
243 -- directory) in systems providing these entries. The directory is
244 -- returned in target-OS form. Raises Directory_Error if Dir has not
245 -- be opened (Dir = Null_Dir).
247 function Read_Is_Thread_Safe
return Boolean;
248 -- Indicates if procedure Read is thread safe. On systems where the
249 -- target system supports this functionality, Read is thread safe,
250 -- and this function returns True (e.g. this will be the case on any
251 -- UNIX or UNIX-like system providing a correct implementation of the
252 -- function readdir_r). If the system cannot provide a thread safe
253 -- implementation of Read, then this function returns False.
258 type Dir_Type
is access Dir_Type_Value
;
260 Null_Dir
: constant Dir_Type
:= null;
262 pragma Import
(C
, Dir_Separator
, "__gnat_dir_separator");
264 Dir_Seps
: constant Ada
.Strings
.Maps
.Character_Set
:=
265 Ada
.Strings
.Maps
.To_Set
("/\");
266 -- UNIX and DOS style directory separators
268 end GNAT.Directory_Operations;