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-2010, 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 with Ada
.Characters
.Handling
;
35 with Ada
.Strings
.Fixed
;
37 with Ada
.Unchecked_Deallocation
;
38 with Ada
.Unchecked_Conversion
;
40 with System
; use System
;
41 with System
.CRTL
; use System
.CRTL
;
45 package body GNAT
.Directory_Operations
is
49 Filename_Max
: constant Integer := 1024;
50 -- 1024 is the value of FILENAME_MAX in stdio.h
53 Ada
.Unchecked_Deallocation
(Dir_Type_Value
, Dir_Type
);
55 On_Windows
: constant Boolean := GNAT
.OS_Lib
.Directory_Separator
= '\';
56 -- An indication that we are on Windows. Used in Get_Current_Dir, to
57 -- deal with drive letters in the beginning of absolute paths.
65 Suffix
: String := "") return String
67 function Get_File_Names_Case_Sensitive
return Integer;
69 (C
, Get_File_Names_Case_Sensitive
,
70 "__gnat_get_file_names_case_sensitive");
72 Case_Sensitive_File_Name
: constant Boolean :=
73 Get_File_Names_Case_Sensitive
= 1;
77 Suffix
: String := "") return String;
78 -- This function does the job. The only difference between Basename
79 -- and Base_Name (the parent function) is that the former is case
80 -- sensitive, while the latter is not. Path and Suffix are adjusted
81 -- appropriately before calling Basename under platforms where the
82 -- file system is not case sensitive.
90 Suffix
: String := "") return String
92 Cut_Start
: Natural :=
94 (Path
, Dir_Seps
, Going
=> Strings
.Backward
);
98 -- Cut_Start point to the first basename character
100 Cut_Start
:= (if Cut_Start
= 0 then Path
'First else Cut_Start
+ 1);
102 -- Cut_End point to the last basename character
104 Cut_End
:= Path
'Last;
106 -- If basename ends with Suffix, adjust Cut_End
109 and then Path
(Path
'Last - Suffix
'Length + 1 .. Cut_End
) = Suffix
111 Cut_End
:= Path
'Last - Suffix
'Length;
114 Check_For_Standard_Dirs
: declare
115 Offset
: constant Integer := Path
'First - Base_Name
.Path
'First;
116 BN
: constant String :=
117 Base_Name
.Path
(Cut_Start
- Offset
.. Cut_End
- Offset
);
118 -- Here we use Base_Name.Path to keep the original casing
120 Has_Drive_Letter
: constant Boolean :=
121 OS_Lib
.Path_Separator
/= ':';
122 -- If Path separator is not ':' then we are on a DOS based OS
123 -- where this character is used as a drive letter separator.
126 if BN
= "." or else BN
= ".." then
129 elsif Has_Drive_Letter
130 and then BN
'Length > 2
131 and then Characters
.Handling
.Is_Letter
(BN
(BN
'First))
132 and then BN
(BN
'First + 1) = ':'
134 -- We have a DOS drive letter prefix, remove it
136 return BN
(BN
'First + 2 .. BN
'Last);
141 end Check_For_Standard_Dirs
;
144 -- Start of processing for Base_Name
147 if Path
'Length <= Suffix
'Length then
151 if Case_Sensitive_File_Name
then
152 return Basename
(Path
, Suffix
);
155 (Characters
.Handling
.To_Lower
(Path
),
156 Characters
.Handling
.To_Lower
(Suffix
));
164 procedure Change_Dir
(Dir_Name
: Dir_Name_Str
) is
165 C_Dir_Name
: constant String := Dir_Name
& ASCII
.NUL
;
167 if chdir
(C_Dir_Name
) /= 0 then
168 raise Directory_Error
;
176 procedure Close
(Dir
: in out Dir_Type
) is
178 pragma Warnings
(Off
, Discard
);
180 function closedir
(directory
: DIRs
) return Integer;
181 pragma Import
(C
, closedir
, "__gnat_closedir");
184 if not Is_Open
(Dir
) then
185 raise Directory_Error
;
188 Discard
:= closedir
(DIRs
(Dir
.all));
196 function Dir_Name
(Path
: Path_Name
) return Dir_Name_Str
is
197 Last_DS
: constant Natural :=
199 (Path
, Dir_Seps
, Going
=> Strings
.Backward
);
204 -- There is no directory separator, returns current working directory
206 return "." & Dir_Separator
;
209 return Path
(Path
'First .. Last_DS
);
219 Mode
: Environment_Style
:= System_Default
) return Path_Name
221 Environment_Variable_Char
: Character;
222 pragma Import
(C
, Environment_Variable_Char
, "__gnat_environment_char");
224 Result
: OS_Lib
.String_Access
:= new String (1 .. 200);
225 Result_Last
: Natural := 0;
227 procedure Append
(C
: Character);
228 procedure Append
(S
: String);
231 procedure Double_Result_Size
;
232 -- Reallocate Result, doubling its size
234 function Is_Var_Prefix
(C
: Character) return Boolean;
235 pragma Inline
(Is_Var_Prefix
);
237 procedure Read
(K
: in out Positive);
238 -- Update Result while reading current Path starting at position K. If
239 -- a variable is found, call Var below.
241 procedure Var
(K
: in out Positive);
242 -- Translate variable name starting at position K with the associated
243 -- environment value.
249 procedure Append
(C
: Character) is
251 if Result_Last
= Result
'Last then
255 Result_Last
:= Result_Last
+ 1;
256 Result
(Result_Last
) := C
;
259 procedure Append
(S
: String) is
261 while Result_Last
+ S
'Length - 1 > Result
'Last loop
265 Result
(Result_Last
+ 1 .. Result_Last
+ S
'Length) := S
;
266 Result_Last
:= Result_Last
+ S
'Length;
269 ------------------------
270 -- Double_Result_Size --
271 ------------------------
273 procedure Double_Result_Size
is
274 New_Result
: constant OS_Lib
.String_Access
:=
275 new String (1 .. 2 * Result
'Last);
277 New_Result
(1 .. Result_Last
) := Result
(1 .. Result_Last
);
278 OS_Lib
.Free
(Result
);
279 Result
:= New_Result
;
280 end Double_Result_Size
;
286 function Is_Var_Prefix
(C
: Character) return Boolean is
288 return (C
= Environment_Variable_Char
and then Mode
= System_Default
)
290 (C
= '$' and then (Mode
= UNIX
or else Mode
= Both
))
292 (C
= '%' and then (Mode
= DOS
or else Mode
= Both
));
299 procedure Read
(K
: in out Positive) is
303 For_All_Characters
: loop
304 if Is_Var_Prefix
(Path
(K
)) then
307 -- Could be a variable
309 if K
< Path
'Last then
310 if Path
(K
+ 1) = P
then
312 -- Not a variable after all, this is a double $ or %,
313 -- just insert one in the result string.
319 -- Let's parse the variable
325 -- We have an ending $ or % sign
331 -- This is a standard character, just add it to the result
336 -- Skip to next character
340 exit For_All_Characters
when K
> Path
'Last;
341 end loop For_All_Characters
;
348 procedure Var
(K
: in out Positive) is
349 P
: constant Character := Path
(K
);
356 if P
= '%' or else Path
(K
) = '{' then
358 -- Set terminator character
367 -- Look for terminator character, k point to the first character
368 -- for the variable name.
374 exit when Path
(E
) = T
or else E
= Path
'Last;
379 -- OK found, translate with environment value
382 Env
: OS_Lib
.String_Access
:=
383 OS_Lib
.Getenv
(Path
(K
.. E
- 1));
391 -- No terminator character, not a variable after all or a
392 -- syntax error, ignore it, insert string as-is.
394 Append
(P
); -- Add prefix character
396 if T
= '}' then -- If we were looking for curly bracket
397 Append
('{'); -- terminator, add the curly bracket
400 Append
(Path
(K
.. E
));
404 -- The variable name is everything from current position to first
405 -- non letter/digit character.
409 -- Check that first character is a letter
411 if Characters
.Handling
.Is_Letter
(Path
(E
)) then
415 exit Var_Name
when E
> Path
'Last;
417 if Characters
.Handling
.Is_Letter
(Path
(E
))
418 or else Characters
.Handling
.Is_Digit
(Path
(E
))
429 Env
: OS_Lib
.String_Access
:= OS_Lib
.Getenv
(Path
(K
.. E
));
437 -- This is not a variable after all
448 -- Start of processing for Expand_Path
452 K
: Positive := Path
'First;
458 Returned_Value
: constant String := Result
(1 .. Result_Last
);
461 OS_Lib
.Free
(Result
);
462 return Returned_Value
;
471 function File_Extension
(Path
: Path_Name
) return String is
474 (Path
, Dir_Seps
, Going
=> Strings
.Backward
);
483 Dot
:= Strings
.Fixed
.Index
(Path
(First
.. Path
'Last),
485 Going
=> Strings
.Backward
);
487 if Dot
= 0 or else Dot
= Path
'Last then
490 return Path
(Dot
.. Path
'Last);
498 function File_Name
(Path
: Path_Name
) return String is
500 return Base_Name
(Path
);
503 ---------------------
504 -- Format_Pathname --
505 ---------------------
507 function Format_Pathname
509 Style
: Path_Style
:= System_Default
) return String
511 N_Path
: String := Path
;
512 K
: Positive := N_Path
'First;
513 Prev_Dirsep
: Boolean := False;
516 if Dir_Separator
= '\'
517 and then Path
'Length > 1
518 and then Path
(K
.. K
+ 1) = "\\"
521 N_Path
(K
.. K
+ 1) := "//";
527 for J
in K
.. Path
'Last loop
528 if Strings
.Maps
.Is_In
(Path
(J
), Dir_Seps
) then
529 if not Prev_Dirsep
then
531 when UNIX
=> N_Path
(K
) := '/';
532 when DOS
=> N_Path
(K
) := '\';
533 when System_Default
=> N_Path
(K
) := Dir_Separator
;
542 N_Path
(K
) := Path
(J
);
544 Prev_Dirsep
:= False;
548 return N_Path
(N_Path
'First .. K
- 1);
551 ---------------------
552 -- Get_Current_Dir --
553 ---------------------
556 pragma Import
(C
, Max_Path
, "__gnat_max_path_len");
558 function Get_Current_Dir
return Dir_Name_Str
is
559 Current_Dir
: String (1 .. Max_Path
+ 1);
562 Get_Current_Dir
(Current_Dir
, Last
);
563 return Current_Dir
(1 .. Last
);
566 procedure Get_Current_Dir
(Dir
: out Dir_Name_Str
; Last
: out Natural) is
567 Path_Len
: Natural := Max_Path
;
568 Buffer
: String (Dir
'First .. Dir
'First + Max_Path
+ 1);
570 procedure Local_Get_Current_Dir
571 (Dir
: System
.Address
;
572 Length
: System
.Address
);
573 pragma Import
(C
, Local_Get_Current_Dir
, "__gnat_get_current_dir");
576 Local_Get_Current_Dir
(Buffer
'Address, Path_Len
'Address);
579 (if Dir
'Length > Path_Len
then Dir
'First + Path_Len
- 1 else Dir
'Last);
581 Dir
(Buffer
'First .. Last
) := Buffer
(Buffer
'First .. Last
);
583 -- By default, the drive letter on Windows is in upper case
585 if On_Windows
and then Last
> Dir
'First and then
586 Dir
(Dir
'First + 1) = ':'
589 Ada
.Characters
.Handling
.To_Upper
(Dir
(Dir
'First));
597 function Is_Open
(Dir
: Dir_Type
) return Boolean is
599 return Dir
/= Null_Dir
600 and then System
.Address
(Dir
.all) /= System
.Null_Address
;
607 procedure Make_Dir
(Dir_Name
: Dir_Name_Str
) is
608 C_Dir_Name
: constant String := Dir_Name
& ASCII
.NUL
;
610 function mkdir
(Dir_Name
: String) return Integer;
611 pragma Import
(C
, mkdir
, "__gnat_mkdir");
614 if mkdir
(C_Dir_Name
) /= 0 then
615 raise Directory_Error
;
625 Dir_Name
: Dir_Name_Str
)
627 function opendir
(file_name
: String) return DIRs
;
628 pragma Import
(C
, opendir
, "__gnat_opendir");
630 C_File_Name
: constant String := Dir_Name
& ASCII
.NUL
;
633 Dir
:= new Dir_Type_Value
'(Dir_Type_Value (opendir (C_File_Name)));
635 if not Is_Open (Dir) then
638 raise Directory_Error;
651 Filename_Addr : Address;
652 Filename_Len : aliased Integer;
654 Buffer : array (0 .. Filename_Max + 12) of Character;
655 -- 12 is the size of the dirent structure (see dirent.h), without the
656 -- field for the filename.
658 function readdir_gnat
659 (Directory : System.Address;
660 Buffer : System.Address;
661 Last : not null access Integer) return System.Address;
662 pragma Import (C, readdir_gnat, "__gnat_readdir");
665 if not Is_Open (Dir) then
666 raise Directory_Error;
671 (System.Address (Dir.all), Buffer'Address, Filename_Len'Access);
673 if Filename_Addr = System.Null_Address then
679 (if Str'Length > Filename_Len then Str'First + Filename_Len - 1
683 subtype Path_String is String (1 .. Filename_Len);
684 type Path_String_Access is access Path_String;
686 function Address_To_Access is new
687 Ada.Unchecked_Conversion
689 Target => Path_String_Access);
691 Path_Access : constant Path_String_Access :=
692 Address_To_Access (Filename_Addr);
695 for J in Str'First .. Last loop
696 Str (J) := Path_Access (J - Str'First + 1);
701 -------------------------
702 -- Read_Is_Thread_Sage --
703 -------------------------
705 function Read_Is_Thread_Safe return Boolean is
706 function readdir_is_thread_safe return Integer;
708 (C, readdir_is_thread_safe, "__gnat_readdir_is_thread_safe");
710 return (readdir_is_thread_safe /= 0);
711 end Read_Is_Thread_Safe;
718 (Dir_Name : Dir_Name_Str;
719 Recursive : Boolean := False)
721 C_Dir_Name : constant String := Dir_Name & ASCII.NUL;
723 Str : String (1 .. Filename_Max);
725 Current_Dir : Dir_Type;
728 -- Remove the directory only if it is empty
730 if not Recursive then
731 if rmdir (C_Dir_Name) /= 0 then
732 raise Directory_Error;
735 -- Remove directory and all files and directories that it may contain
738 Open (Current_Dir, Dir_Name);
741 Read (Current_Dir, Str, Last);
744 if GNAT.OS_Lib.Is_Directory
745 (Dir_Name & Dir_Separator & Str (1 .. Last))
747 if Str (1 .. Last) /= "."
749 Str (1 .. Last) /= ".."
751 -- Recursive call to remove a subdirectory and all its
755 (Dir_Name & Dir_Separator & Str (1 .. Last),
760 GNAT.OS_Lib.Delete_File
761 (Dir_Name & Dir_Separator & Str (1 .. Last),
765 raise Directory_Error;
771 Remove_Dir (Dir_Name);
775 end GNAT.Directory_Operations;