1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 2003-2011, Free Software Foundation, 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 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. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
28 with Makeutl
; use Makeutl
;
29 with MLib
.Tgt
; use MLib
.Tgt
;
30 with Namet
; use Namet
;
32 with Osint
; use Osint
;
33 with Osint
.M
; use Osint
.M
;
38 with Prj
.Tree
; use Prj
.Tree
;
39 with Prj
.Util
; use Prj
.Util
;
42 with Switch
; use Switch
;
44 with Targparm
; use Targparm
;
45 with Types
; use Types
;
47 with Ada
.Command_Line
; use Ada
.Command_Line
;
49 with GNAT
.Directory_Operations
; use GNAT
.Directory_Operations
;
50 with GNAT
.IO
; use GNAT
.IO
;
51 with GNAT
.OS_Lib
; use GNAT
.OS_Lib
;
55 Initialized
: Boolean := False;
56 -- Set to True by the first call to Initialize.
57 -- To avoid reinitialization of some packages.
59 -- Suffixes of various files
61 Assembly_Suffix
: constant String := ".s";
62 ALI_Suffix
: constant String := ".ali";
63 Tree_Suffix
: constant String := ".adt";
64 Object_Suffix
: constant String := Get_Target_Object_Suffix
.all;
65 Debug_Suffix
: String := ".dg";
66 -- Changed to "_dg" for VMS in the body of the package
68 Repinfo_Suffix
: String := ".rep";
69 -- Changed to "_rep" for VMS in the body of the package
71 B_Start
: String_Ptr
:= new String'("b~");
72 -- Prefix of binder generated file, and number of actual characters used.
73 -- Changed to "b__" for VMS in the body of the package.
75 Project_Tree : constant Project_Tree_Ref :=
76 new Project_Tree_Data (Is_Root_Tree => True);
79 Object_Directory_Path : String_Access := null;
80 -- The path name of the object directory, set with switch -D
82 Force_Deletions : Boolean := False;
83 -- Set to True by switch -f. When True, attempts to delete non writable
84 -- files will be done.
86 Do_Nothing : Boolean := False;
87 -- Set to True when switch -n is specified. When True, no file is deleted.
88 -- gnatclean only lists the files that would have been deleted if the
89 -- switch -n had not been specified.
91 File_Deleted : Boolean := False;
92 -- Set to True if at least one file has been deleted
94 Copyright_Displayed : Boolean := False;
95 Usage_Displayed : Boolean := False;
97 Project_File_Name : String_Access := null;
99 Project_Node_Tree : Project_Node_Tree_Ref;
101 Root_Environment : Prj.Tree.Environment;
103 Main_Project : Prj.Project_Id := Prj.No_Project;
105 All_Projects : Boolean := False;
107 -- Packages of project files where unknown attributes are errors
109 Naming_String : aliased String := "naming";
110 Builder_String : aliased String := "builder";
111 Compiler_String : aliased String := "compiler";
112 Binder_String : aliased String := "binder";
113 Linker_String : aliased String := "linker";
115 Gnatmake_Packages : aliased String_List :=
116 (Naming_String 'Access,
117 Builder_String
'Access,
118 Compiler_String 'Access,
119 Binder_String
'Access,
120 Linker_String 'Access);
122 Packages_To_Check_By_Gnatmake
: constant String_List_Access
:=
123 Gnatmake_Packages
'Access;
125 package Processed_Projects
is new Table
.Table
126 (Table_Component_Type
=> Project_Id
,
127 Table_Index_Type
=> Natural,
128 Table_Low_Bound
=> 0,
130 Table_Increment
=> 100,
131 Table_Name
=> "Clean.Processed_Projects");
132 -- Table to keep track of what project files have been processed, when
133 -- switch -r is specified.
135 package Sources
is new Table
.Table
136 (Table_Component_Type
=> File_Name_Type
,
137 Table_Index_Type
=> Natural,
138 Table_Low_Bound
=> 0,
140 Table_Increment
=> 100,
141 Table_Name
=> "Clean.Processed_Projects");
142 -- Table to store all the source files of a library unit: spec, body and
143 -- subunits, to detect .dg files and delete them.
145 -----------------------------
146 -- Other local subprograms --
147 -----------------------------
149 procedure Add_Source_Dir
(N
: String);
150 -- Call Add_Src_Search_Dir and output one line when in verbose mode
152 procedure Add_Source_Directories
is
153 new Prj
.Env
.For_All_Source_Dirs
(Action
=> Add_Source_Dir
);
155 procedure Add_Object_Dir
(N
: String);
156 -- Call Add_Lib_Search_Dir and output one line when in verbose mode
158 procedure Add_Object_Directories
is
159 new Prj
.Env
.For_All_Object_Dirs
(Action
=> Add_Object_Dir
);
161 function ALI_File_Name
(Source
: File_Name_Type
) return String;
162 -- Returns the name of the ALI file corresponding to Source
164 function Assembly_File_Name
(Source
: File_Name_Type
) return String;
165 -- Returns the assembly file name corresponding to Source
167 procedure Clean_Archive
(Project
: Project_Id
; Global
: Boolean);
168 -- Delete a global archive or library project archive and the dependency
169 -- file, if they exist.
171 procedure Clean_Executables
;
172 -- Do the cleaning work when no project file is specified
174 procedure Clean_Interface_Copy_Directory
(Project
: Project_Id
);
175 -- Delete files in an interface copy directory: any file that is a copy of
176 -- a source of the project.
178 procedure Clean_Library_Directory
(Project
: Project_Id
);
179 -- Delete the library file in a library directory and any ALI file of a
180 -- source of the project in a library ALI directory.
182 procedure Clean_Project
(Project
: Project_Id
);
183 -- Do the cleaning work when a project file is specified. This procedure
184 -- calls itself recursively when there are several project files in the
185 -- tree rooted at the main project file and switch -r has been specified.
187 function Debug_File_Name
(Source
: File_Name_Type
) return String;
188 -- Name of the expanded source file corresponding to Source
190 procedure Delete
(In_Directory
: String; File
: String);
191 -- Delete one file, or list the file name if switch -n is specified
193 procedure Delete_Binder_Generated_Files
195 Source
: File_Name_Type
);
196 -- Delete the binder generated file in directory Dir for Source, if they
197 -- exist: for Unix these are b~<source>.ads, b~<source>.adb,
198 -- b~<source>.ali and b~<source>.o.
200 procedure Display_Copyright
;
201 -- Display the Copyright notice. If called several times, display the
202 -- Copyright notice only the first time.
204 procedure Initialize
;
205 -- Call the necessary package initializations
207 function Object_File_Name
(Source
: File_Name_Type
) return String;
208 -- Returns the object file name corresponding to Source
210 procedure Parse_Cmd_Line
;
211 -- Parse the command line
213 function Repinfo_File_Name
(Source
: File_Name_Type
) return String;
214 -- Returns the repinfo file name corresponding to Source
216 function Tree_File_Name
(Source
: File_Name_Type
) return String;
217 -- Returns the tree file name corresponding to Source
219 function In_Extension_Chain
220 (Of_Project
: Project_Id
;
221 Prj
: Project_Id
) return Boolean;
222 -- Returns True iff Prj is an extension of Of_Project or if Of_Project is
223 -- an extension of Prj.
226 -- Display the usage. If called several times, the usage is displayed only
233 procedure Add_Object_Dir
(N
: String) is
235 Add_Lib_Search_Dir
(N
);
237 if Opt
.Verbose_Mode
then
238 Put
("Adding object directory """);
249 procedure Add_Source_Dir
(N
: String) is
251 Add_Src_Search_Dir
(N
);
253 if Opt
.Verbose_Mode
then
254 Put
("Adding source directory """);
265 function ALI_File_Name
(Source
: File_Name_Type
) return String is
266 Src
: constant String := Get_Name_String
(Source
);
269 -- If the source name has an extension, then replace it with
272 for Index
in reverse Src
'First + 1 .. Src
'Last loop
273 if Src
(Index
) = '.' then
274 return Src
(Src
'First .. Index
- 1) & ALI_Suffix
;
278 -- If there is no dot, or if it is the first character, just add the
281 return Src
& ALI_Suffix
;
284 ------------------------
285 -- Assembly_File_Name --
286 ------------------------
288 function Assembly_File_Name
(Source
: File_Name_Type
) return String is
289 Src
: constant String := Get_Name_String
(Source
);
292 -- If the source name has an extension, then replace it with
293 -- the assembly suffix.
295 for Index
in reverse Src
'First + 1 .. Src
'Last loop
296 if Src
(Index
) = '.' then
297 return Src
(Src
'First .. Index
- 1) & Assembly_Suffix
;
301 -- If there is no dot, or if it is the first character, just add the
304 return Src
& Assembly_Suffix
;
305 end Assembly_File_Name
;
311 procedure Clean_Archive
(Project
: Project_Id
; Global
: Boolean) is
312 Current_Dir
: constant Dir_Name_Str
:= Get_Current_Dir
;
314 Lib_Prefix
: String_Access
;
315 Archive_Name
: String_Access
;
316 -- The name of the archive file for this project
318 Archive_Dep_Name
: String_Access
;
319 -- The name of the archive dependency file for this project
321 Obj_Dir
: constant String :=
322 Get_Name_String
(Project
.Object_Directory
.Display_Name
);
325 Change_Dir
(Obj_Dir
);
327 -- First, get the lib prefix, the archive file name and the archive
328 -- dependency file name.
332 new String'("lib" & Get_Name_String (Project.Display_Name));
335 new String'("lib" & Get_Name_String
(Project
.Library_Name
));
338 Archive_Name
:= new String'(Lib_Prefix.all & '.' & Archive_Ext);
339 Archive_Dep_Name := new String'(Lib_Prefix
.all & ".deps");
341 -- Delete the archive file and the archive dependency file, if they
344 if Is_Regular_File
(Archive_Name
.all) then
345 Delete
(Obj_Dir
, Archive_Name
.all);
348 if Is_Regular_File
(Archive_Dep_Name
.all) then
349 Delete
(Obj_Dir
, Archive_Dep_Name
.all);
352 Change_Dir
(Current_Dir
);
355 -----------------------
356 -- Clean_Executables --
357 -----------------------
359 procedure Clean_Executables
is
360 Main_Source_File
: File_Name_Type
;
361 -- Current main source
363 Main_Lib_File
: File_Name_Type
;
364 -- ALI file of the current main
366 Lib_File
: File_Name_Type
;
369 Full_Lib_File
: File_Name_Type
;
370 -- Full name of the current ALI file
372 Text
: Text_Buffer_Ptr
;
375 Source
: Queue
.Source_Info
;
378 Queue
.Initialize
(Queue_Per_Obj_Dir
=> False);
380 -- It does not really matter if there is or not an object file
381 -- corresponding to an ALI file: if there is one, it will be deleted.
383 Opt
.Check_Object_Consistency
:= False;
385 -- Proceed each executable one by one. Each source is marked as it is
386 -- processed, so common sources between executables will not be
387 -- processed several times.
389 for N_File
in 1 .. Osint
.Number_Of_Files
loop
390 Main_Source_File
:= Next_Main_Source
;
392 Osint
.Lib_File_Name
(Main_Source_File
, Current_File_Index
);
394 if Main_Lib_File
/= No_File
then
396 ((Format
=> Format_Gnatmake
,
397 File
=> Main_Lib_File
,
398 Unit
=> No_Unit_Name
,
400 Project
=> No_Project
));
403 while not Queue
.Is_Empty
loop
404 Sources
.Set_Last
(0);
405 Queue
.Extract
(Found
, Source
);
406 pragma Assert
(Found
);
407 pragma Assert
(Source
.File
/= No_File
);
408 Lib_File
:= Source
.File
;
409 Full_Lib_File
:= Osint
.Full_Lib_File_Name
(Lib_File
);
411 -- If we have existing ALI file that is not read-only, process it
413 if Full_Lib_File
/= No_File
414 and then not Is_Readonly_Library
(Full_Lib_File
)
416 Text
:= Read_Library_Info
(Lib_File
);
420 Scan_ALI
(Lib_File
, Text
, Ignore_ED
=> False, Err
=> True);
423 -- If no error was produced while loading this ALI file,
424 -- insert into the queue all the unmarked withed sources.
426 if The_ALI
/= No_ALI_Id
then
427 for J
in ALIs
.Table
(The_ALI
).First_Unit
..
428 ALIs
.Table
(The_ALI
).Last_Unit
430 Sources
.Increment_Last
;
431 Sources
.Table
(Sources
.Last
) :=
432 ALI
.Units
.Table
(J
).Sfile
;
434 for K
in ALI
.Units
.Table
(J
).First_With
..
435 ALI
.Units
.Table
(J
).Last_With
437 if Withs
.Table
(K
).Afile
/= No_File
then
439 ((Format
=> Format_Gnatmake
,
440 File
=> Withs
.Table
(K
).Afile
,
441 Unit
=> No_Unit_Name
,
443 Project
=> No_Project
));
448 -- Look for subunits and put them in the Sources table
450 for J
in ALIs
.Table
(The_ALI
).First_Sdep
..
451 ALIs
.Table
(The_ALI
).Last_Sdep
453 if Sdep
.Table
(J
).Subunit_Name
/= No_Name
then
454 Sources
.Increment_Last
;
455 Sources
.Table
(Sources
.Last
) :=
456 Sdep
.Table
(J
).Sfile
;
462 -- Now delete all existing files corresponding to this ALI file
465 Obj_Dir
: constant String :=
466 Dir_Name
(Get_Name_String
(Full_Lib_File
));
467 Obj
: constant String := Object_File_Name
(Lib_File
);
468 Adt
: constant String := Tree_File_Name
(Lib_File
);
469 Asm
: constant String := Assembly_File_Name
(Lib_File
);
472 Delete
(Obj_Dir
, Get_Name_String
(Lib_File
));
474 if Is_Regular_File
(Obj_Dir
& Dir_Separator
& Obj
) then
475 Delete
(Obj_Dir
, Obj
);
478 if Is_Regular_File
(Obj_Dir
& Dir_Separator
& Adt
) then
479 Delete
(Obj_Dir
, Adt
);
482 if Is_Regular_File
(Obj_Dir
& Dir_Separator
& Asm
) then
483 Delete
(Obj_Dir
, Asm
);
486 -- Delete expanded source files (.dg) and/or repinfo files
489 for J
in 1 .. Sources
.Last
loop
491 Deb
: constant String :=
492 Debug_File_Name
(Sources
.Table
(J
));
493 Rep
: constant String :=
494 Repinfo_File_Name
(Sources
.Table
(J
));
497 if Is_Regular_File
(Obj_Dir
& Dir_Separator
& Deb
) then
498 Delete
(Obj_Dir
, Deb
);
501 if Is_Regular_File
(Obj_Dir
& Dir_Separator
& Rep
) then
502 Delete
(Obj_Dir
, Rep
);
510 -- Delete the executable, if it exists, and the binder generated
513 if not Compile_Only
then
515 Source
: constant File_Name_Type
:=
516 Strip_Suffix
(Main_Lib_File
);
517 Executable
: constant String :=
518 Get_Name_String
(Executable_Name
(Source
));
520 if Is_Regular_File
(Executable
) then
521 Delete
("", Executable
);
524 Delete_Binder_Generated_Files
(Get_Current_Dir
, Source
);
528 end Clean_Executables
;
530 ------------------------------------
531 -- Clean_Interface_Copy_Directory --
532 ------------------------------------
534 procedure Clean_Interface_Copy_Directory
(Project
: Project_Id
) is
535 Current
: constant String := Get_Current_Dir
;
539 Name
: String (1 .. 200);
542 Delete_File
: Boolean;
547 and then Project
.Library_Src_Dir
/= No_Path_Information
550 Directory
: constant String :=
551 Get_Name_String
(Project
.Library_Src_Dir
.Display_Name
);
554 Change_Dir
(Directory
);
557 -- For each regular file in the directory, if switch -n has not
558 -- been specified, make it writable and delete the file if it is
559 -- a copy of a source of the project.
562 Read
(Direc
, Name
, Last
);
566 Filename
: constant String := Name
(1 .. Last
);
569 if Is_Regular_File
(Filename
) then
570 Canonical_Case_File_Name
(Name
(1 .. Last
));
571 Delete_File
:= False;
573 Unit
:= Units_Htable
.Get_First
(Project_Tree
.Units_HT
);
575 -- Compare with source file names of the project
577 while Unit
/= No_Unit_Index
loop
578 if Unit
.File_Names
(Impl
) /= null
579 and then Ultimate_Extending_Project_Of
580 (Unit
.File_Names
(Impl
).Project
) = Project
582 Get_Name_String
(Unit
.File_Names
(Impl
).File
) =
589 if Unit
.File_Names
(Spec
) /= null
590 and then Ultimate_Extending_Project_Of
591 (Unit
.File_Names
(Spec
).Project
) = Project
594 (Unit
.File_Names
(Spec
).File
) = Name
(1 .. Last
)
600 Unit
:= Units_Htable
.Get_Next
(Project_Tree
.Units_HT
);
604 if not Do_Nothing
then
605 Set_Writable
(Filename
);
608 Delete
(Directory
, Filename
);
616 -- Restore the initial working directory
618 Change_Dir
(Current
);
621 end Clean_Interface_Copy_Directory
;
623 -----------------------------
624 -- Clean_Library_Directory --
625 -----------------------------
627 Empty_String
: aliased String := "";
629 procedure Clean_Library_Directory
(Project
: Project_Id
) is
630 Current
: constant String := Get_Current_Dir
;
632 Lib_Filename
: constant String := Get_Name_String
(Project
.Library_Name
);
634 DLL_Prefix
& Lib_Filename
& "." & DLL_Ext
;
635 Archive_Name
: String :=
636 "lib" & Lib_Filename
& "." & Archive_Ext
;
639 Name
: String (1 .. 200);
642 Delete_File
: Boolean;
644 Minor
: String_Access
:= Empty_String
'Access;
645 Major
: String_Access
:= Empty_String
'Access;
648 if Project
.Library
then
649 if Project
.Library_Kind
/= Static
650 and then MLib
.Tgt
.Library_Major_Minor_Id_Supported
651 and then Project
.Lib_Internal_Name
/= No_Name
653 Minor
:= new String'(Get_Name_String (Project.Lib_Internal_Name));
654 Major := new String'(MLib
.Major_Id_Name
(DLL_Name
, Minor
.all));
658 Lib_Directory
: constant String :=
660 (Project
.Library_Dir
.Display_Name
);
661 Lib_ALI_Directory
: constant String :=
663 (Project
.Library_ALI_Dir
.Display_Name
);
666 Canonical_Case_File_Name
(Archive_Name
);
667 Canonical_Case_File_Name
(DLL_Name
);
669 Change_Dir
(Lib_Directory
);
672 -- For each regular file in the directory, if switch -n has not
673 -- been specified, make it writable and delete the file if it is
677 Read
(Direc
, Name
, Last
);
681 Filename
: constant String := Name
(1 .. Last
);
684 if Is_Regular_File
(Filename
)
685 or else Is_Symbolic_Link
(Filename
)
687 Canonical_Case_File_Name
(Name
(1 .. Last
));
688 Delete_File
:= False;
690 if (Project
.Library_Kind
= Static
691 and then Name
(1 .. Last
) = Archive_Name
)
693 ((Project
.Library_Kind
= Dynamic
695 Project
.Library_Kind
= Relocatable
)
697 (Name
(1 .. Last
) = DLL_Name
699 Name
(1 .. Last
) = Minor
.all
701 Name
(1 .. Last
) = Major
.all))
703 if not Do_Nothing
then
704 Set_Writable
(Filename
);
707 Delete
(Lib_Directory
, Filename
);
715 Change_Dir
(Lib_ALI_Directory
);
718 -- For each regular file in the directory, if switch -n has not
719 -- been specified, make it writable and delete the file if it is
720 -- any ALI file of a source of the project.
723 Read
(Direc
, Name
, Last
);
727 Filename
: constant String := Name
(1 .. Last
);
729 if Is_Regular_File
(Filename
) then
730 Canonical_Case_File_Name
(Name
(1 .. Last
));
731 Delete_File
:= False;
733 if Last
> 4 and then Name
(Last
- 3 .. Last
) = ".ali" then
737 -- Compare with ALI file names of the project
739 Unit
:= Units_Htable
.Get_First
740 (Project_Tree
.Units_HT
);
741 while Unit
/= No_Unit_Index
loop
742 if Unit
.File_Names
(Impl
) /= null
743 and then Unit
.File_Names
(Impl
).Project
/=
746 if Ultimate_Extending_Project_Of
747 (Unit
.File_Names
(Impl
).Project
) =
751 (Unit
.File_Names
(Impl
).File
);
752 Name_Len
:= Name_Len
-
754 (Name
(1 .. Name_Len
))'Length;
755 if Name_Buffer
(1 .. Name_Len
) =
763 elsif Unit
.File_Names
(Spec
) /= null
764 and then Ultimate_Extending_Project_Of
765 (Unit
.File_Names
(Spec
).Project
) =
769 (Unit
.File_Names
(Spec
).File
);
773 (Name
(1 .. Name_Len
))'Length;
775 if Name_Buffer
(1 .. Name_Len
) =
784 Units_Htable
.Get_Next
(Project_Tree
.Units_HT
);
790 if not Do_Nothing
then
791 Set_Writable
(Filename
);
794 Delete
(Lib_ALI_Directory
, Filename
);
802 -- Restore the initial working directory
804 Change_Dir
(Current
);
807 end Clean_Library_Directory
;
813 procedure Clean_Project
(Project
: Project_Id
) is
814 Main_Source_File
: File_Name_Type
;
815 -- Name of executable on the command line without directory info
817 Executable
: File_Name_Type
;
818 -- Name of the executable file
820 Current_Dir
: constant Dir_Name_Str
:= Get_Current_Dir
;
822 File_Name1
: File_Name_Type
;
824 File_Name2
: File_Name_Type
;
826 Lib_File
: File_Name_Type
;
828 Global_Archive
: Boolean := False;
831 -- Check that we don't specify executable on the command line for
832 -- a main library project.
834 if Project
= Main_Project
835 and then Osint
.Number_Of_Files
/= 0
836 and then Project
.Library
839 ("Cannot specify executable(s) for a Library Project File");
842 -- Nothing to clean in an externally built project
844 if Project
.Externally_Built
then
846 Put
("Nothing to do to clean externally built project """);
847 Put
(Get_Name_String
(Project
.Name
));
853 Put
("Cleaning project """);
854 Put
(Get_Name_String
(Project
.Name
));
858 -- Add project to the list of processed projects
860 Processed_Projects
.Increment_Last
;
861 Processed_Projects
.Table
(Processed_Projects
.Last
) := Project
;
863 if Project
.Object_Directory
/= No_Path_Information
then
865 Obj_Dir
: constant String :=
867 (Project
.Object_Directory
.Display_Name
);
870 Change_Dir
(Obj_Dir
);
872 -- First, deal with Ada
874 -- Look through the units to find those that are either
875 -- immediate sources or inherited sources of the project.
876 -- Extending projects may have no language specified, if
877 -- Source_Dirs or Source_Files is specified as an empty list,
878 -- so always look for Ada units in extending projects.
880 if Has_Ada_Sources
(Project
)
881 or else Project
.Extends
/= No_Project
883 Unit
:= Units_Htable
.Get_First
(Project_Tree
.Units_HT
);
884 while Unit
/= No_Unit_Index
loop
885 File_Name1
:= No_File
;
886 File_Name2
:= No_File
;
888 -- If either the spec or the body is a source of the
889 -- project, check for the corresponding ALI file in the
892 if (Unit
.File_Names
(Impl
) /= null
895 (Unit
.File_Names
(Impl
).Project
, Project
))
897 (Unit
.File_Names
(Spec
) /= null
898 and then In_Extension_Chain
899 (Unit
.File_Names
(Spec
).Project
, Project
))
901 if Unit
.File_Names
(Impl
) /= null then
902 File_Name1
:= Unit
.File_Names
(Impl
).File
;
903 Index1
:= Unit
.File_Names
(Impl
).Index
;
905 File_Name1
:= No_File
;
909 if Unit
.File_Names
(Spec
) /= null then
910 File_Name2
:= Unit
.File_Names
(Spec
).File
;
911 Index2
:= Unit
.File_Names
(Spec
).Index
;
913 File_Name2
:= No_File
;
917 -- If there is no body file name, then there may be
920 if File_Name1
= No_File
then
921 File_Name1
:= File_Name2
;
923 File_Name2
:= No_File
;
928 -- If there is either a spec or a body, look for files
929 -- in the object directory.
931 if File_Name1
/= No_File
then
932 Lib_File
:= Osint
.Lib_File_Name
(File_Name1
, Index1
);
935 Asm
: constant String :=
936 Assembly_File_Name
(Lib_File
);
937 ALI
: constant String :=
938 ALI_File_Name
(Lib_File
);
939 Obj
: constant String :=
940 Object_File_Name
(Lib_File
);
941 Adt
: constant String :=
942 Tree_File_Name
(Lib_File
);
943 Deb
: constant String :=
944 Debug_File_Name
(File_Name1
);
945 Rep
: constant String :=
946 Repinfo_File_Name
(File_Name1
);
947 Del
: Boolean := True;
950 -- If the ALI file exists and is read-only, no file
953 if Is_Regular_File
(ALI
) then
954 if Is_Writable_File
(ALI
) then
955 Delete
(Obj_Dir
, ALI
);
964 if Obj_Dir
(Obj_Dir
'Last) /=
971 Put_Line
(""" is read-only");
980 if Is_Regular_File
(Obj
) then
981 Delete
(Obj_Dir
, Obj
);
986 if Is_Regular_File
(Asm
) then
987 Delete
(Obj_Dir
, Asm
);
992 if Is_Regular_File
(Adt
) then
993 Delete
(Obj_Dir
, Adt
);
996 -- First expanded source file
998 if Is_Regular_File
(Deb
) then
999 Delete
(Obj_Dir
, Deb
);
1004 if Is_Regular_File
(Rep
) then
1005 Delete
(Obj_Dir
, Rep
);
1008 -- Second expanded source file
1010 if File_Name2
/= No_File
then
1012 Deb
: constant String :=
1013 Debug_File_Name
(File_Name2
);
1014 Rep
: constant String :=
1015 Repinfo_File_Name
(File_Name2
);
1018 if Is_Regular_File
(Deb
) then
1019 Delete
(Obj_Dir
, Deb
);
1022 if Is_Regular_File
(Rep
) then
1023 Delete
(Obj_Dir
, Rep
);
1031 Unit
:= Units_Htable
.Get_Next
(Project_Tree
.Units_HT
);
1035 -- Check if a global archive and it dependency file could have
1036 -- been created and, if they exist, delete them.
1038 if Project
= Main_Project
and then not Project
.Library
then
1039 Global_Archive
:= False;
1042 Proj
: Project_List
;
1045 Proj
:= Project_Tree
.Projects
;
1046 while Proj
/= null loop
1048 -- For gnatmake, when the project specifies more than
1049 -- just Ada as a language (even if course we could not
1050 -- find any source file for the other languages), we
1051 -- will take all the object files found in the object
1052 -- directories. Since we know the project supports at
1053 -- least Ada, we just have to test whether it has at
1054 -- least two languages, and we do not care about the
1057 if Proj
.Project
.Languages
/= null
1058 and then Proj
.Project
.Languages
.Next
/= null
1060 Global_Archive
:= True;
1068 if Global_Archive
then
1069 Clean_Archive
(Project
, Global
=> True);
1076 -- If this is a library project, clean the library directory, the
1077 -- interface copy dir and, for a Stand-Alone Library, the binder
1078 -- generated files of the library.
1080 -- The directories are cleaned only if switch -c is not specified
1082 if Project
.Library
then
1083 if not Compile_Only
then
1084 Clean_Library_Directory
(Project
);
1086 if Project
.Library_Src_Dir
/= No_Path_Information
then
1087 Clean_Interface_Copy_Directory
(Project
);
1091 if Project
.Standalone_Library
and then
1092 Project
.Object_Directory
/= No_Path_Information
1094 Delete_Binder_Generated_Files
1095 (Get_Name_String
(Project
.Object_Directory
.Display_Name
),
1096 File_Name_Type
(Project
.Library_Name
));
1100 if Verbose_Mode
then
1105 -- If switch -r is specified, call Clean_Project recursively for the
1106 -- imported projects and the project being extended.
1108 if All_Projects
then
1110 Imported
: Project_List
;
1114 -- For each imported project, call Clean_Project if the project
1115 -- has not been processed already.
1117 Imported
:= Project
.Imported_Projects
;
1118 while Imported
/= null loop
1122 J
in Processed_Projects
.First
.. Processed_Projects
.Last
1124 if Imported
.Project
= Processed_Projects
.Table
(J
) then
1131 Clean_Project
(Imported
.Project
);
1134 Imported
:= Imported
.Next
;
1137 -- If this project extends another project, call Clean_Project for
1138 -- the project being extended. It is guaranteed that it has not
1139 -- called before, because no other project may import or extend
1142 if Project
.Extends
/= No_Project
then
1143 Clean_Project
(Project
.Extends
);
1148 -- For the main project, delete the executables and the binder
1151 -- The executables are deleted only if switch -c is not specified
1153 if Project
= Main_Project
1154 and then Project
.Exec_Directory
/= No_Path_Information
1157 Exec_Dir
: constant String :=
1158 Get_Name_String
(Project
.Exec_Directory
.Display_Name
);
1161 Change_Dir
(Exec_Dir
);
1163 for N_File
in 1 .. Osint
.Number_Of_Files
loop
1164 Main_Source_File
:= Next_Main_Source
;
1166 if not Compile_Only
then
1170 Project_Tree
.Shared
,
1172 Current_File_Index
);
1175 Exec_File_Name
: constant String :=
1176 Get_Name_String
(Executable
);
1179 if Is_Absolute_Path
(Name
=> Exec_File_Name
) then
1180 if Is_Regular_File
(Exec_File_Name
) then
1181 Delete
("", Exec_File_Name
);
1185 if Is_Regular_File
(Exec_File_Name
) then
1186 Delete
(Exec_Dir
, Exec_File_Name
);
1192 if Project
.Object_Directory
/= No_Path_Information
then
1193 Delete_Binder_Generated_Files
1194 (Get_Name_String
(Project
.Object_Directory
.Display_Name
),
1195 Strip_Suffix
(Main_Source_File
));
1201 -- Change back to previous directory
1203 Change_Dir
(Current_Dir
);
1206 ---------------------
1207 -- Debug_File_Name --
1208 ---------------------
1210 function Debug_File_Name
(Source
: File_Name_Type
) return String is
1212 return Get_Name_String
(Source
) & Debug_Suffix
;
1213 end Debug_File_Name
;
1219 procedure Delete
(In_Directory
: String; File
: String) is
1220 Full_Name
: String (1 .. In_Directory
'Length + File
'Length + 1);
1221 Last
: Natural := 0;
1225 -- Indicate that at least one file is deleted or is to be deleted
1227 File_Deleted
:= True;
1229 -- Build the path name of the file to delete
1231 Last
:= In_Directory
'Length;
1232 Full_Name
(1 .. Last
) := In_Directory
;
1234 if Last
> 0 and then Full_Name
(Last
) /= Directory_Separator
then
1236 Full_Name
(Last
) := Directory_Separator
;
1239 Full_Name
(Last
+ 1 .. Last
+ File
'Length) := File
;
1240 Last
:= Last
+ File
'Length;
1242 -- If switch -n was used, simply output the path name
1245 Put_Line
(Full_Name
(1 .. Last
));
1247 -- Otherwise, delete the file if it is writable
1251 or else Is_Writable_File
(Full_Name
(1 .. Last
))
1252 or else Is_Symbolic_Link
(Full_Name
(1 .. Last
))
1254 Delete_File
(Full_Name
(1 .. Last
), Success
);
1259 if Verbose_Mode
or else not Quiet_Output
then
1261 Put
("Warning: """);
1262 Put
(Full_Name
(1 .. Last
));
1263 Put_Line
(""" could not be deleted");
1267 Put
(Full_Name
(1 .. Last
));
1268 Put_Line
(""" has been deleted");
1274 -----------------------------------
1275 -- Delete_Binder_Generated_Files --
1276 -----------------------------------
1278 procedure Delete_Binder_Generated_Files
1280 Source
: File_Name_Type
)
1282 Source_Name
: constant String := Get_Name_String
(Source
);
1283 Current
: constant String := Get_Current_Dir
;
1284 Last
: constant Positive := B_Start
'Length + Source_Name
'Length;
1285 File_Name
: String (1 .. Last
+ 4);
1290 -- Build the file name (before the extension)
1292 File_Name
(1 .. B_Start
'Length) := B_Start
.all;
1293 File_Name
(B_Start
'Length + 1 .. Last
) := Source_Name
;
1297 File_Name
(Last
+ 1 .. Last
+ 4) := ".ads";
1299 if Is_Regular_File
(File_Name
(1 .. Last
+ 4)) then
1300 Delete
(Dir
, File_Name
(1 .. Last
+ 4));
1305 File_Name
(Last
+ 1 .. Last
+ 4) := ".adb";
1307 if Is_Regular_File
(File_Name
(1 .. Last
+ 4)) then
1308 Delete
(Dir
, File_Name
(1 .. Last
+ 4));
1313 File_Name
(Last
+ 1 .. Last
+ 4) := ".ali";
1315 if Is_Regular_File
(File_Name
(1 .. Last
+ 4)) then
1316 Delete
(Dir
, File_Name
(1 .. Last
+ 4));
1321 File_Name
(Last
+ 1 .. Last
+ Object_Suffix
'Length) := Object_Suffix
;
1323 if Is_Regular_File
(File_Name
(1 .. Last
+ Object_Suffix
'Length)) then
1324 Delete
(Dir
, File_Name
(1 .. Last
+ Object_Suffix
'Length));
1327 -- Change back to previous directory
1329 Change_Dir
(Current
);
1330 end Delete_Binder_Generated_Files
;
1332 -----------------------
1333 -- Display_Copyright --
1334 -----------------------
1336 procedure Display_Copyright
is
1338 if not Copyright_Displayed
then
1339 Copyright_Displayed
:= True;
1340 Display_Version
("GNATCLEAN", "2003");
1342 end Display_Copyright
;
1348 procedure Gnatclean
is
1350 -- Do the necessary initializations
1354 -- Parse the command line, getting the switches and the executable names
1358 if Verbose_Mode
then
1362 if Project_File_Name
/= null then
1364 -- A project file was specified by a -P switch
1366 if Opt
.Verbose_Mode
then
1368 Put
("Parsing Project File """);
1369 Put
(Project_File_Name
.all);
1374 -- Set the project parsing verbosity to whatever was specified
1375 -- by a possible -vP switch.
1377 Prj
.Pars
.Set_Verbosity
(To
=> Current_Verbosity
);
1379 -- Parse the project file. If there is an error, Main_Project
1380 -- will still be No_Project.
1383 (Project
=> Main_Project
,
1384 In_Tree
=> Project_Tree
,
1385 In_Node_Tree
=> Project_Node_Tree
,
1386 Project_File_Name
=> Project_File_Name
.all,
1387 Env
=> Root_Environment
,
1388 Packages_To_Check
=> Packages_To_Check_By_Gnatmake
);
1390 if Main_Project
= No_Project
then
1391 Fail
("""" & Project_File_Name
.all & """ processing failed");
1394 if Opt
.Verbose_Mode
then
1396 Put
("Parsing of Project File """);
1397 Put
(Project_File_Name
.all);
1398 Put
(""" is finished.");
1402 -- Add source directories and object directories to the search paths
1404 Add_Source_Directories
(Main_Project
, Project_Tree
);
1405 Add_Object_Directories
(Main_Project
, Project_Tree
);
1408 Osint
.Add_Default_Search_Dirs
;
1410 -- If a project file was specified, but no executable name, put all
1411 -- the mains of the project file (if any) as if there were on the
1414 if Main_Project
/= No_Project
and then Osint
.Number_Of_Files
= 0 then
1416 Main
: String_Element
;
1417 Value
: String_List_Id
:= Main_Project
.Mains
;
1419 while Value
/= Prj
.Nil_String
loop
1420 Main
:= Project_Tree
.Shared
.String_Elements
.Table
(Value
);
1422 (File_Name
=> Get_Name_String
(Main
.Value
),
1423 Index
=> Main
.Index
);
1429 -- If neither a project file nor an executable were specified, output
1430 -- the usage and exit.
1432 if Main_Project
= No_Project
and then Osint
.Number_Of_Files
= 0 then
1437 if Verbose_Mode
then
1441 if Main_Project
/= No_Project
then
1443 -- If a project file has been specified, call Clean_Project with the
1444 -- project id of this project file, after resetting the list of
1445 -- processed projects.
1447 Processed_Projects
.Init
;
1448 Clean_Project
(Main_Project
);
1451 -- If no project file has been specified, the work is done in
1452 -- Clean_Executables.
1457 -- In verbose mode, if Delete has not been called, indicate that no file
1458 -- needs to be deleted.
1460 if Verbose_Mode
and (not File_Deleted
) then
1464 Put_Line
("No file needs to be deleted");
1466 Put_Line
("No file has been deleted");
1471 ------------------------
1472 -- In_Extension_Chain --
1473 ------------------------
1475 function In_Extension_Chain
1476 (Of_Project
: Project_Id
;
1477 Prj
: Project_Id
) return Boolean
1482 if Prj
= No_Project
or else Of_Project
= No_Project
then
1486 if Of_Project
= Prj
then
1491 while Proj
.Extends
/= No_Project
loop
1492 if Proj
.Extends
= Prj
then
1496 Proj
:= Proj
.Extends
;
1500 while Proj
.Extends
/= No_Project
loop
1501 if Proj
.Extends
= Of_Project
then
1505 Proj
:= Proj
.Extends
;
1509 end In_Extension_Chain
;
1515 procedure Initialize
is
1517 if not Initialized
then
1518 Initialized
:= True;
1520 -- Get default search directories to locate system.ads when calling
1521 -- Targparm.Get_Target_Parameters.
1523 Osint
.Add_Default_Search_Dirs
;
1525 -- Initialize some packages
1530 Prj
.Tree
.Initialize
(Root_Environment
, Gnatmake_Flags
);
1531 Prj
.Env
.Initialize_Default_Project_Path
1532 (Root_Environment
.Project_Path
,
1533 Target_Name
=> Sdefault
.Target_Name
.all);
1535 Project_Node_Tree
:= new Project_Node_Tree_Data
;
1536 Prj
.Tree
.Initialize
(Project_Node_Tree
);
1538 Prj
.Initialize
(Project_Tree
);
1540 -- Check if the platform is VMS and, if it is, change some variables
1542 Targparm
.Get_Target_Parameters
;
1544 if OpenVMS_On_Target
then
1545 Debug_Suffix
(Debug_Suffix
'First) := '_';
1546 Repinfo_Suffix
(Repinfo_Suffix
'First) := '_';
1547 B_Start
:= new String'("b__");
1551 -- Reset global variables
1553 Free (Object_Directory_Path);
1554 Do_Nothing := False;
1555 File_Deleted := False;
1556 Copyright_Displayed := False;
1557 Usage_Displayed := False;
1558 Free (Project_File_Name);
1559 Main_Project := Prj.No_Project;
1560 All_Projects := False;
1563 ----------------------
1564 -- Object_File_Name --
1565 ----------------------
1567 function Object_File_Name (Source : File_Name_Type) return String is
1568 Src : constant String := Get_Name_String (Source);
1571 -- If the source name has an extension, then replace it with
1572 -- the Object suffix.
1574 for Index in reverse Src'First + 1 .. Src'Last loop
1575 if Src (Index) = '.' then
1576 return Src (Src'First .. Index - 1) & Object_Suffix;
1580 -- If there is no dot, or if it is the first character, just add the
1583 return Src & Object_Suffix;
1584 end Object_File_Name;
1586 --------------------
1587 -- Parse_Cmd_Line --
1588 --------------------
1590 procedure Parse_Cmd_Line is
1591 Last : constant Natural := Argument_Count;
1592 Source_Index : Int := 0;
1595 procedure Check_Version_And_Help is new Check_Version_And_Help_G (Usage);
1598 -- First, check for --version and --help
1600 Check_Version_And_Help ("GNATCLEAN", "2003");
1603 while Index <= Last loop
1605 Arg : constant String := Argument (Index);
1607 procedure Bad_Argument;
1608 -- Signal bad argument
1614 procedure Bad_Argument is
1616 Fail ("invalid argument """ & Arg & """");
1620 if Arg'Length /= 0 then
1621 if Arg (1) = '-' then
1622 if Arg'Length = 1 then
1628 if Arg'Length > Subdirs_Option'Length and then
1629 Arg (1 .. Subdirs_Option'Length) = Subdirs_Option
1633 (Arg
(Subdirs_Option
'Length + 1 .. Arg
'Last));
1635 elsif Arg
= Makeutl
.Unchecked_Shared_Lib_Imports
then
1636 Opt
.Unchecked_Shared_Lib_Imports
:= True;
1643 if Arg
'Length < 4 then
1647 if Arg
(3) = 'O' then
1648 Add_Lib_Search_Dir
(Arg
(4 .. Arg
'Last));
1650 elsif Arg
(3) = 'P' then
1651 Prj
.Env
.Add_Directories
1652 (Root_Environment
.Project_Path
,
1653 Arg
(4 .. Arg
'Last));
1660 Compile_Only
:= True;
1663 if Object_Directory_Path
/= null then
1664 Fail
("duplicate -D switch");
1666 elsif Project_File_Name
/= null then
1667 Fail
("-P and -D cannot be used simultaneously");
1670 if Arg
'Length > 2 then
1672 Dir
: constant String := Arg
(3 .. Arg
'Last);
1674 if not Is_Directory
(Dir
) then
1675 Fail
(Dir
& " is not a directory");
1677 Add_Lib_Search_Dir
(Dir
);
1682 if Index
= Last
then
1683 Fail
("no directory specified after -D");
1689 Dir
: constant String := Argument
(Index
);
1691 if not Is_Directory
(Dir
) then
1692 Fail
(Dir
& " is not a directory");
1694 Add_Lib_Search_Dir
(Dir
);
1701 Follow_Links_For_Files
:= True;
1702 Follow_Links_For_Dirs
:= True;
1709 Force_Deletions
:= True;
1712 Full_Path_Name_For_Brief_Errors
:= True;
1718 if Arg
'Length = 2 then
1724 for J
in 3 .. Arg
'Last loop
1725 if Arg
(J
) not in '0' .. '9' then
1730 (20 * Source_Index
) +
1731 (Character'Pos (Arg
(J
)) - Character'Pos ('0'));
1736 Opt
.Look_In_Primary_Dir
:= False;
1739 if Arg
'Length = 2 then
1743 Add_Lib_Search_Dir
(Arg
(3 .. Arg
'Last));
1750 if Project_File_Name
/= null then
1751 Fail
("multiple -P switches");
1753 elsif Object_Directory_Path
/= null then
1754 Fail
("-D and -P cannot be used simultaneously");
1758 if Arg
'Length > 2 then
1760 Prj
: constant String := Arg
(3 .. Arg
'Last);
1762 if Prj
'Length > 1 and then
1763 Prj
(Prj
'First) = '='
1765 Project_File_Name
:=
1767 (Prj (Prj'First + 1 .. Prj'Last));
1769 Project_File_Name := new String'(Prj
);
1774 if Index
= Last
then
1775 Fail
("no project specified after -P");
1779 Project_File_Name
:= new String'(Argument (Index));
1783 Quiet_Output := True;
1786 All_Projects := True;
1790 Verbose_Mode := True;
1792 elsif Arg = "-vP0" then
1793 Current_Verbosity := Prj.Default;
1795 elsif Arg = "-vP1" then
1796 Current_Verbosity := Prj.Medium;
1798 elsif Arg = "-vP2" then
1799 Current_Verbosity := Prj.High;
1806 if Arg'Length = 2 then
1811 Ext_Asgn : constant String := Arg (3 .. Arg'Last);
1812 Start : Positive := Ext_Asgn'First;
1813 Stop : Natural := Ext_Asgn'Last;
1814 OK : Boolean := True;
1817 if Ext_Asgn (Start) = '"' then
1818 if Ext_Asgn (Stop) = '"' then
1829 Prj.Ext.Check (Root_Environment.External,
1830 Ext_Asgn (Start .. Stop))
1833 ("illegal external assignment '"
1844 Add_File (Arg, Source_Index);
1853 -----------------------
1854 -- Repinfo_File_Name --
1855 -----------------------
1857 function Repinfo_File_Name (Source : File_Name_Type) return String is
1859 return Get_Name_String (Source) & Repinfo_Suffix;
1860 end Repinfo_File_Name;
1862 --------------------
1863 -- Tree_File_Name --
1864 --------------------
1866 function Tree_File_Name (Source : File_Name_Type) return String is
1867 Src : constant String := Get_Name_String (Source);
1870 -- If source name has an extension, then replace it with the tree suffix
1872 for Index in reverse Src'First + 1 .. Src'Last loop
1873 if Src (Index) = '.' then
1874 return Src (Src'First .. Index - 1) & Tree_Suffix;
1878 -- If there is no dot, or if it is the first character, just add the
1881 return Src & Tree_Suffix;
1890 if not Usage_Displayed then
1891 Usage_Displayed := True;
1893 Put_Line ("Usage: gnatclean [switches] {[-innn] name}");
1896 Display_Usage_Version_And_Help;
1898 Put_Line (" names is one or more file names from which " &
1899 "the .adb or .ads suffix may be omitted");
1900 Put_Line (" names may be omitted if -P<project> is specified");
1903 Put_Line (" --subdirs=dir real obj/lib/exec dirs are subdirs");
1904 Put_Line (" " & Makeutl.Unchecked_Shared_Lib_Imports);
1905 Put_Line (" Allow shared libraries to import static libraries");
1908 Put_Line (" -c Only delete compiler generated files");
1909 Put_Line (" -D dir Specify dir as the object library");
1910 Put_Line (" -eL Follow symbolic links when processing " &
1912 Put_Line (" -f Force deletions of unwritable files");
1913 Put_Line (" -F Full project path name " &
1914 "in brief error messages");
1915 Put_Line (" -h Display this message");
1916 Put_Line (" -innn Index of unit in source for following names");
1917 Put_Line (" -n Nothing to do: only list files to delete");
1918 Put_Line (" -Pproj Use GNAT Project File proj");
1919 Put_Line (" -q Be quiet/terse");
1920 Put_Line (" -r Clean all projects recursively");
1921 Put_Line (" -v Verbose mode");
1922 Put_Line (" -vPx Specify verbosity when parsing " &
1923 "GNAT Project Files");
1924 Put_Line (" -Xnm=val Specify an external reference " &
1925 "for GNAT Project Files");
1928 Put_Line (" -aPdir Add directory dir to project search path");
1931 Put_Line (" -aOdir Specify ALI/object files search path");
1932 Put_Line (" -Idir Like -aOdir");
1933 Put_Line (" -I- Don't look for source/library files " &
1934 "in the default directory");