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-2003 Ada Core Technologies, 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 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, 59 Temple Place - Suite 330, Boston, --
20 -- MA 02111-1307, 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;
36 with Ada.Strings.Maps;
37 with Unchecked_Deallocation;
38 with Unchecked_Conversion;
39 with System; use System;
43 package body GNAT.Directory_Operations is
47 type Dir_Type_Value is new System.Address;
48 -- This is the low-level address directory structure as returned by the C
51 Filename_Max : constant Integer := 1024;
52 -- 1024 is the value of FILENAME_MAX in stdio.h
55 Unchecked_Deallocation (Dir_Type_Value, Dir_Type);
63 Suffix : String := "")
66 function Get_File_Names_Case_Sensitive return Integer;
68 (C, Get_File_Names_Case_Sensitive,
69 "__gnat_get_file_names_case_sensitive");
71 Case_Sensitive_File_Name : constant Boolean :=
72 Get_File_Names_Case_Sensitive = 1;
76 Suffix : 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 := "")
93 Cut_Start : Natural :=
95 (Path, Dir_Seps, Going => Strings.Backward);
99 -- Cut_Start point to the first basename character
101 if Cut_Start = 0 then
102 Cut_Start := Path'First;
105 Cut_Start := Cut_Start + 1;
108 -- Cut_End point to the last basename character.
110 Cut_End := Path'Last;
112 -- If basename ends with Suffix, adjust Cut_End.
115 and then Path (Path'Last - Suffix'Length + 1 .. Cut_End) = Suffix
117 Cut_End := Path'Last - Suffix'Length;
120 Check_For_Standard_Dirs : declare
121 Offset : constant Integer := Path'First - Base_Name.Path'First;
122 BN : constant String :=
123 Base_Name.Path (Cut_Start - Offset .. Cut_End - Offset);
124 -- Here we use Base_Name.Path to keep the original casing
126 Has_Drive_Letter : constant Boolean :=
127 OS_Lib.Path_Separator /= ':';
128 -- If Path separator is not ':' then we are on a DOS based OS
129 -- where this character is used as a drive letter separator.
132 if BN = "." or else BN = ".." then
135 elsif Has_Drive_Letter
136 and then BN'Length > 2
137 and then Characters.Handling.Is_Letter (BN (BN'First))
138 and then BN (BN'First + 1) = ':'
140 -- We have a DOS drive letter prefix, remove it
142 return BN (BN'First + 2 .. BN'Last);
147 end Check_For_Standard_Dirs;
150 -- Start processing for Base_Name
153 if Path'Length <= Suffix'Length then
157 if Case_Sensitive_File_Name then
158 return Basename (Path, Suffix);
161 (Characters.Handling.To_Lower (Path),
162 Characters.Handling.To_Lower (Suffix));
170 procedure Change_Dir (Dir_Name : Dir_Name_Str) is
171 C_Dir_Name : constant String := Dir_Name & ASCII.NUL;
173 function chdir (Dir_Name : String) return Integer;
174 pragma Import (C, chdir, "chdir");
177 if chdir (C_Dir_Name) /= 0 then
178 raise Directory_Error;
186 procedure Close (Dir : in out Dir_Type) is
188 function closedir (Directory : System.Address) return Integer;
189 pragma Import (C, closedir, "closedir");
192 pragma Warnings (Off, Discard);
195 if not Is_Open (Dir) then
196 raise Directory_Error;
199 Discard := closedir (System.Address (Dir.all));
207 function Dir_Name (Path : Path_Name) return Dir_Name_Str is
208 Last_DS : constant Natural :=
210 (Path, Dir_Seps, Going => Strings.Backward);
215 -- There is no directory separator, returns current working directory
217 return "." & Dir_Separator;
220 return Path (Path'First .. Last_DS);
230 Mode : Environment_Style := System_Default)
233 Environment_Variable_Char : Character;
234 pragma Import (C, Environment_Variable_Char, "__gnat_environment_char");
236 Result : OS_Lib.String_Access := new String (1 .. 200);
237 Result_Last : Natural := 0;
239 procedure Append (C : Character);
240 procedure Append (S : String);
243 procedure Double_Result_Size;
244 -- Reallocate Result, doubling its size
246 function Is_Var_Prefix (C : Character) return Boolean;
247 pragma Inline (Is_Var_Prefix);
249 procedure Read (K : in out Positive);
250 -- Update Result while reading current Path starting at position K. If
251 -- a variable is found, call Var below.
253 procedure Var (K : in out Positive);
254 -- Translate variable name starting at position K with the associated
255 -- environment value.
261 procedure Append (C : Character) is
263 if Result_Last = Result'Last then
267 Result_Last := Result_Last + 1;
268 Result (Result_Last) := C;
271 procedure Append (S : String) is
273 while Result_Last + S'Length - 1 > Result'Last loop
277 Result (Result_Last + 1 .. Result_Last + S'Length) := S;
278 Result_Last := Result_Last + S'Length;
281 ------------------------
282 -- Double_Result_Size --
283 ------------------------
285 procedure Double_Result_Size is
286 New_Result : constant OS_Lib.String_Access :=
287 new String (1 .. 2 * Result'Last);
290 New_Result (1 .. Result_Last) := Result (1 .. Result_Last);
291 OS_Lib.Free (Result);
292 Result := New_Result;
293 end Double_Result_Size;
299 function Is_Var_Prefix (C : Character) return Boolean is
301 return (C = Environment_Variable_Char and then Mode = System_Default)
303 (C = '$' and then (Mode = UNIX or else Mode = Both))
305 (C = '%' and then (Mode = DOS or else Mode = Both));
312 procedure Read (K : in out Positive) is
315 For_All_Characters : loop
316 if Is_Var_Prefix (Path (K)) then
319 -- Could be a variable
321 if K < Path'Last then
323 if Path (K + 1) = P then
325 -- Not a variable after all, this is a double $ or %,
326 -- just insert one in the result string.
332 -- Let's parse the variable
338 -- We have an ending $ or % sign
344 -- This is a standard character, just add it to the result
349 -- Skip to next character
353 exit For_All_Characters when K > Path'Last;
354 end loop For_All_Characters;
361 procedure Var (K : in out Positive) is
362 P : constant Character := Path (K);
369 if P = '%' or else Path (K) = '{' then
371 -- Set terminator character
380 -- Look for terminator character, k point to the first character
381 -- for the variable name.
387 exit when Path (E) = T or else E = Path'Last;
392 -- OK found, translate with environment value
395 Env : OS_Lib.String_Access :=
396 OS_Lib.Getenv (Path (K .. E - 1));
404 -- No terminator character, not a variable after all or a
405 -- syntax error, ignore it, insert string as-is.
407 Append (P); -- Add prefix character
409 if T = '}' then -- If we were looking for curly bracket
410 Append ('{'); -- terminator, add the curly bracket
413 Append (Path (K .. E));
417 -- The variable name is everything from current position to first
418 -- non letter/digit character.
422 -- Check that first chartacter is a letter
424 if Characters.Handling.Is_Letter (Path (E)) then
428 exit Var_Name when E > Path'Last;
430 if Characters.Handling.Is_Letter (Path (E))
431 or else Characters.Handling.Is_Digit (Path (E))
442 Env : OS_Lib.String_Access := OS_Lib.Getenv (Path (K .. E));
450 -- This is not a variable after all
461 -- Start of processing for Expand_Path
465 K : Positive := Path'First;
471 Returned_Value : constant String := Result (1 .. Result_Last);
474 OS_Lib.Free (Result);
475 return Returned_Value;
484 function File_Extension (Path : Path_Name) return String is
487 (Path, Dir_Seps, Going => Strings.Backward);
496 Dot := Strings.Fixed.Index (Path (First .. Path'Last),
498 Going => Strings.Backward);
500 if Dot = 0 or else Dot = Path'Last then
503 return Path (Dot .. Path'Last);
511 function File_Name (Path : Path_Name) return String is
513 return Base_Name (Path);
516 ---------------------
517 -- Format_Pathname --
518 ---------------------
520 function Format_Pathname
522 Style : Path_Style := System_Default)
525 N_Path : String := Path;
526 K : Positive := N_Path'First;
527 Prev_Dirsep : Boolean := False;
530 if Dir_Separator = '\'
531 and then Path'Length > 1
532 and then Path (K .. K + 1) = "\\"
535 N_Path (K .. K + 1) := "//";
541 for J in K .. Path'Last loop
542 if Strings.Maps.Is_In (Path (J), Dir_Seps) then
543 if not Prev_Dirsep then
545 when UNIX => N_Path (K) := '/';
546 when DOS => N_Path (K) := '\';
547 when System_Default => N_Path (K) := Dir_Separator;
556 N_Path (K) := Path (J);
558 Prev_Dirsep := False;
562 return N_Path (N_Path'First .. K - 1);
565 ---------------------
566 -- Get_Current_Dir --
567 ---------------------
570 pragma Import (C, Max_Path, "__gnat_max_path_len");
572 function Get_Current_Dir return Dir_Name_Str is
573 Current_Dir : String (1 .. Max_Path + 1);
577 Get_Current_Dir (Current_Dir, Last);
578 return Current_Dir (1 .. Last);
581 procedure Get_Current_Dir (Dir : out Dir_Name_Str; Last : out Natural) is
582 Path_Len : Natural := Max_Path;
583 Buffer : String (Dir'First .. Dir'First + Max_Path + 1);
585 procedure Local_Get_Current_Dir
586 (Dir : System.Address;
587 Length : System.Address);
588 pragma Import (C, Local_Get_Current_Dir, "__gnat_get_current_dir");
591 Local_Get_Current_Dir (Buffer'Address, Path_Len'Address);
593 if Dir'Length > Path_Len then
594 Last := Dir'First + Path_Len - 1;
599 Dir (Buffer'First .. Last) := Buffer (Buffer'First .. Last);
606 function Is_Open (Dir : Dir_Type) return Boolean is
608 return Dir /= Null_Dir
609 and then System.Address (Dir.all) /= System.Null_Address;
616 procedure Make_Dir (Dir_Name : Dir_Name_Str) is
617 C_Dir_Name : constant String := Dir_Name & ASCII.NUL;
619 function mkdir (Dir_Name : String) return Integer;
620 pragma Import (C, mkdir, "__gnat_mkdir");
623 if mkdir (C_Dir_Name) /= 0 then
624 raise Directory_Error;
634 Dir_Name : Dir_Name_Str)
636 C_File_Name : constant String := Dir_Name & ASCII.NUL;
640 return Dir_Type_Value;
641 pragma Import (C, opendir, "opendir");
644 Dir := new Dir_Type_Value'(opendir (C_File_Name));
646 if not Is_Open (Dir) then
649 raise Directory_Error;
658 (Dir : in out Dir_Type;
662 Filename_Addr : Address;
663 Filename_Len : Integer;
665 Buffer : array (0 .. Filename_Max + 12) of Character;
666 -- 12 is the size of the dirent structure (see dirent.h), without the
667 -- field for the filename.
669 function readdir_gnat
670 (Directory : System.Address;
671 Buffer : System.Address)
672 return System.Address;
673 pragma Import (C, readdir_gnat, "__gnat_readdir");
675 function strlen (S : Address) return Integer;
676 pragma Import (C, strlen, "strlen");
679 if not Is_Open (Dir) then
680 raise Directory_Error;
684 readdir_gnat (System.Address (Dir.all), Buffer'Address);
686 if Filename_Addr = System.Null_Address then
691 Filename_Len := strlen (Filename_Addr);
693 if Str'Length > Filename_Len then
694 Last := Str'First + Filename_Len - 1;
700 subtype Path_String is String (1 .. Filename_Len);
701 type Path_String_Access is access Path_String;
703 function Address_To_Access is new
706 Target => Path_String_Access);
708 Path_Access : constant Path_String_Access :=
709 Address_To_Access (Filename_Addr);
712 for J in Str'First .. Last loop
713 Str (J) := Path_Access (J - Str'First + 1);
718 -------------------------
719 -- Read_Is_Thread_Sage --
720 -------------------------
722 function Read_Is_Thread_Safe return Boolean is
724 function readdir_is_thread_safe return Integer;
726 (C, readdir_is_thread_safe, "__gnat_readdir_is_thread_safe");
729 return (readdir_is_thread_safe /= 0);
730 end Read_Is_Thread_Safe;
737 (Dir_Name : Dir_Name_Str;
738 Recursive : Boolean := False)
740 C_Dir_Name : constant String := Dir_Name & ASCII.NUL;
741 Current_Dir : constant Dir_Name_Str := Get_Current_Dir;
743 Str : String (1 .. Filename_Max);
745 Working_Dir : Dir_Type;
747 procedure rmdir (Dir_Name : String);
748 pragma Import (C, rmdir, "rmdir");
751 -- Remove the directory only if it is empty
753 if not Recursive then
756 if GNAT.OS_Lib.Is_Directory (Dir_Name) then
757 raise Directory_Error;
760 -- Remove directory and all files and directories that it may contain
763 Change_Dir (Dir_Name);
764 Open (Working_Dir, ".");
767 Read (Working_Dir, Str, Last);
770 if GNAT.OS_Lib.Is_Directory (Str (1 .. Last)) then
771 if Str (1 .. Last) /= "." and then Str (1 .. Last) /= ".." then
772 Remove_Dir (Str (1 .. Last), True);
773 Remove_Dir (Str (1 .. Last));
777 GNAT.OS_Lib.Delete_File (Str (1 .. Last), Success);
780 Change_Dir (Current_Dir);
781 raise Directory_Error;
786 Change_Dir (Current_Dir);
788 Remove_Dir (Dir_Name);
792 end GNAT.Directory_Operations;