1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2003 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 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 -- GNAT was originally developed by the GNAT team at New York University. --
23 -- Extensive contributions were provided by Ada Core Technologies Inc. --
25 ------------------------------------------------------------------------------
28 with ALI.Util; use ALI.Util;
29 with Binderr; use Binderr;
30 with Butil; use Butil;
31 with Csets; use Csets;
32 with Fname; use Fname;
33 with Gnatvsn; use Gnatvsn;
34 with GNAT.OS_Lib; use GNAT.OS_Lib;
35 with Namet; use Namet;
37 with Osint; use Osint;
38 with Osint.L; use Osint.L;
39 with Output; use Output;
40 with Targparm; use Targparm;
41 with Types; use Types;
44 Max_Column : constant := 80;
47 OK, -- matching timestamp
48 Checksum_OK, -- only matching checksum
49 Not_Found, -- file not found on source PATH
50 Not_Same, -- neither checksum nor timestamp matching
51 Not_First_On_PATH); -- matching file hidden by Not_Same file on path
54 type Dir_Ref is access Dir_Data;
56 type Dir_Data is record
57 Value : String_Access;
62 First_Source_Dir : Dir_Ref;
63 Last_Source_Dir : Dir_Ref;
64 -- The list of source directories from the command line.
65 -- These directories are added using Osint.Add_Src_Search_Dir
66 -- after those of the GNAT Project File, if any.
68 First_Lib_Dir : Dir_Ref;
69 Last_Lib_Dir : Dir_Ref;
70 -- The list of object directories from the command line.
71 -- These directories are added using Osint.Add_Lib_Search_Dir
72 -- after those of the GNAT Project File, if any.
74 Main_File : File_Name_Type;
75 Ali_File : File_Name_Type;
77 Text : Text_Buffer_Ptr;
82 Too_Long : Boolean := False;
83 -- When True, lines are too long for multi-column output and each
84 -- item of information is on a different line.
86 Selective_Output : Boolean := False;
87 Print_Usage : Boolean := False;
88 Print_Unit : Boolean := True;
89 Print_Source : Boolean := True;
90 Print_Object : Boolean := True;
91 -- Flags controlling the form of the outpout
93 Dependable : Boolean := False; -- flag -d
94 Also_Predef : Boolean := False;
98 Source_Start : Integer;
100 Object_Start : Integer;
101 Object_End : Integer;
102 -- Various column starts and ends
104 Spaces : constant String (1 .. Max_Column) := (others => ' ');
106 RTS_Specified : String_Access := null;
107 -- Used to detect multiple use of --RTS= switch
109 -----------------------
110 -- Local Subprograms --
111 -----------------------
113 procedure Add_Lib_Dir (Dir : String; And_Save : Boolean);
114 -- Add an object directory, using Osint.Add_Lib_Search_Dir
115 -- if And_Save is False or keeping in the list First_Lib_Dir,
116 -- Last_Lib_Dir if And_Save is True.
118 procedure Add_Source_Dir (Dir : String; And_Save : Boolean);
119 -- Add a source directory, using Osint.Add_Src_Search_Dir
120 -- if And_Save is False or keeping in the list First_Source_Dir,
121 -- Last_Source_Dir if And_Save is True.
123 procedure Find_General_Layout;
124 -- Determine the structure of the output (multi columns or not, etc)
126 procedure Find_Status
127 (FS : in out File_Name_Type;
128 Stamp : Time_Stamp_Type;
130 Status : out File_Status);
131 -- Determine the file status (Status) of the file represented by FS
132 -- with the expected Stamp and checksum given as argument. FS will be
133 -- updated to the full file name if available.
135 function Corresponding_Sdep_Entry (A : ALI_Id; U : Unit_Id) return Sdep_Id;
136 -- Give the Sdep entry corresponding to the unit U in ali record A.
138 procedure Output_Object (O : File_Name_Type);
139 -- Print out the name of the object when requested
141 procedure Output_Source (Sdep_I : Sdep_Id);
142 -- Print out the name and status of the source corresponding to this
145 procedure Output_Status (FS : File_Status; Verbose : Boolean);
146 -- Print out FS either in a coded form if verbose is false or in an
147 -- expanded form otherwise.
149 procedure Output_Unit (U_Id : Unit_Id);
150 -- Print out information on the unit when requested
152 procedure Reset_Print;
153 -- Reset Print flags properly when selective output is chosen
155 procedure Scan_Ls_Arg (Argv : String; And_Save : Boolean);
156 -- Scan and process lser specific arguments. Argv is a single argument.
159 -- Print usage message.
165 procedure Add_Lib_Dir (Dir : String; And_Save : Boolean) is
168 if First_Lib_Dir = null then
171 (Value => new String'(Dir),
173 Last_Lib_Dir := First_Lib_Dir;
178 (Value => new String'(Dir),
180 Last_Lib_Dir := Last_Lib_Dir.Next;
184 Add_Lib_Search_Dir (Dir);
192 procedure Add_Source_Dir (Dir : String; And_Save : Boolean) is
195 if First_Source_Dir = null then
198 (Value => new String'(Dir),
200 Last_Source_Dir := First_Source_Dir;
203 Last_Source_Dir.Next :=
205 (Value => new String'(Dir),
207 Last_Source_Dir := Last_Source_Dir.Next;
211 Add_Src_Search_Dir (Dir);
215 ------------------------------
216 -- Corresponding_Sdep_Entry --
217 ------------------------------
219 function Corresponding_Sdep_Entry
225 for D in ALIs.Table (A).First_Sdep .. ALIs.Table (A).Last_Sdep loop
226 if Sdep.Table (D).Sfile = Units.Table (U).Sfile then
231 Error_Msg_Name_1 := Units.Table (U).Uname;
232 Error_Msg_Name_2 := ALIs.Table (A).Afile;
234 Error_Msg ("wrong ALI format, can't find dependency line for & in %");
235 Exit_Program (E_Fatal);
236 end Corresponding_Sdep_Entry;
238 -------------------------
239 -- Find_General_Layout --
240 -------------------------
242 procedure Find_General_Layout is
243 Max_Unit_Length : Integer := 11;
244 Max_Src_Length : Integer := 11;
245 Max_Obj_Length : Integer := 11;
251 -- Compute maximum of each column
253 for Id in ALIs.First .. ALIs.Last loop
255 Get_Name_String (Units.Table (ALIs.Table (Id).First_Unit).Uname);
256 if Also_Predef or else not Is_Internal_Unit then
260 Max_Unit_Length := Integer'Max (Max_Unit_Length, Len);
264 FS := Full_Source_Name (ALIs.Table (Id).Sfile);
267 Get_Name_String (ALIs.Table (Id).Sfile);
268 Name_Len := Name_Len + 13;
270 Get_Name_String (FS);
273 Max_Src_Length := Integer'Max (Max_Src_Length, Name_Len + 1);
277 Get_Name_String (ALIs.Table (Id).Ofile_Full_Name);
278 Max_Obj_Length := Integer'Max (Max_Obj_Length, Name_Len + 1);
283 -- Verify is output is not wider than maximum number of columns
285 Too_Long := Verbose_Mode or else
286 (Max_Unit_Length + Max_Src_Length + Max_Obj_Length) > Max_Column;
288 -- Set start and end of columns.
291 Object_End := Object_Start - 1;
294 Object_End := Object_Start + Max_Obj_Length;
297 Unit_Start := Object_End + 1;
298 Unit_End := Unit_Start - 1;
301 Unit_End := Unit_Start + Max_Unit_Length;
304 Source_Start := Unit_End + 1;
306 if Source_Start > Spaces'Last then
307 Source_Start := Spaces'Last;
310 Source_End := Source_Start - 1;
313 Source_End := Source_Start + Max_Src_Length;
315 end Find_General_Layout;
321 procedure Find_Status
322 (FS : in out File_Name_Type;
323 Stamp : Time_Stamp_Type;
325 Status : out File_Status)
327 Tmp1 : File_Name_Type;
328 Tmp2 : File_Name_Type;
331 Tmp1 := Full_Source_Name (FS);
333 if Tmp1 = No_File then
336 elsif File_Stamp (Tmp1) = Stamp then
340 elsif Checksums_Match (Get_File_Checksum (FS), Checksum) then
342 Status := Checksum_OK;
345 Tmp2 := Matching_Full_Source_Name (FS, Stamp);
347 if Tmp2 = No_File then
352 Status := Not_First_On_PATH;
362 procedure Output_Object (O : File_Name_Type) is
363 Object_Name : String_Access;
368 Object_Name := To_Host_File_Spec (Name_Buffer (1 .. Name_Len));
369 Write_Str (Object_Name.all);
371 if Print_Source or else Print_Unit then
377 (Object_Start + Object_Name'Length .. Object_End));
387 procedure Output_Source (Sdep_I : Sdep_Id) is
388 Stamp : constant Time_Stamp_Type := Sdep.Table (Sdep_I).Stamp;
389 Checksum : constant Word := Sdep.Table (Sdep_I).Checksum;
390 FS : File_Name_Type := Sdep.Table (Sdep_I).Sfile;
391 Status : File_Status;
392 Object_Name : String_Access;
396 Find_Status (FS, Stamp, Checksum, Status);
397 Get_Name_String (FS);
399 Object_Name := To_Host_File_Spec (Name_Buffer (1 .. Name_Len));
402 Write_Str (" Source => ");
403 Write_Str (Object_Name.all);
407 (Spaces (Source_Start + Object_Name'Length .. Source_End));
410 Output_Status (Status, Verbose => True);
415 if not Selective_Output then
416 Output_Status (Status, Verbose => False);
419 Write_Str (Object_Name.all);
428 procedure Output_Status (FS : File_Status; Verbose : Boolean) is
433 Write_Str (" unchanged");
436 Write_Str (" slightly modified");
439 Write_Str (" file not found");
442 Write_Str (" modified");
444 when Not_First_On_PATH =>
445 Write_Str (" unchanged version not first on PATH");
462 when Not_First_On_PATH =>
472 procedure Output_Unit (U_Id : Unit_Id) is
474 U : Unit_Record renames Units.Table (U_Id);
478 Get_Name_String (U.Uname);
479 Kind := Name_Buffer (Name_Len);
480 Name_Len := Name_Len - 2;
482 if not Verbose_Mode then
483 Write_Str (Name_Buffer (1 .. Name_Len));
486 Write_Str ("Unit => ");
487 Write_Eol; Write_Str (" Name => ");
488 Write_Str (Name_Buffer (1 .. Name_Len));
489 Write_Eol; Write_Str (" Kind => ");
491 if Units.Table (U_Id).Unit_Kind = 'p' then
492 Write_Str ("package ");
494 Write_Str ("subprogram ");
514 Write_Eol; Write_Str (" Flags =>");
517 Write_Str (" Preelaborable");
521 Write_Str (" No_Elab_Code");
528 if U.Elaborate_Body then
529 Write_Str (" Elaborate Body");
532 if U.Remote_Types then
533 Write_Str (" Remote_Types");
536 if U.Shared_Passive then
537 Write_Str (" Shared_Passive");
541 Write_Str (" Predefined");
545 Write_Str (" Remote_Call_Interface");
552 Write_Eol; Write_Str (" ");
554 Write_Str (Spaces (Unit_Start + Name_Len + 1 .. Unit_End));
564 procedure Reset_Print is
566 if not Selective_Output then
567 Selective_Output := True;
568 Print_Source := False;
569 Print_Object := False;
578 procedure Scan_Ls_Arg (Argv : String; And_Save : Boolean) is
580 pragma Assert (Argv'First = 1);
582 if Argv'Length = 0 then
586 if Argv (1) = '-' then
588 if Argv'Length = 1 then
589 Fail ("switch character cannot be followed by a blank");
591 -- Processing for -I-
593 elsif Argv (2 .. Argv'Last) = "I-" then
594 Opt.Look_In_Primary_Dir := False;
596 -- Forbid -?- or -??- where ? is any character
598 elsif (Argv'Length = 3 and then Argv (3) = '-')
599 or else (Argv'Length = 4 and then Argv (4) = '-')
601 Fail ("Trailing ""-"" at the end of ", Argv, " forbidden.");
603 -- Processing for -Idir
605 elsif Argv (2) = 'I' then
606 Add_Source_Dir (Argv (3 .. Argv'Last), And_Save);
607 Add_Lib_Dir (Argv (3 .. Argv'Last), And_Save);
609 -- Processing for -aIdir (to gcc this is like a -I switch)
611 elsif Argv'Length >= 3 and then Argv (2 .. 3) = "aI" then
612 Add_Source_Dir (Argv (4 .. Argv'Last), And_Save);
614 -- Processing for -aOdir
616 elsif Argv'Length >= 3 and then Argv (2 .. 3) = "aO" then
617 Add_Lib_Dir (Argv (4 .. Argv'Last), And_Save);
619 -- Processing for -aLdir (to gnatbind this is like a -aO switch)
621 elsif Argv'Length >= 3 and then Argv (2 .. 3) = "aL" then
622 Add_Lib_Dir (Argv (4 .. Argv'Last), And_Save);
624 -- Processing for -nostdinc
626 elsif Argv (2 .. Argv'Last) = "nostdinc" then
627 Opt.No_Stdinc := True;
629 -- Processing for one character switches
631 elsif Argv'Length = 2 then
633 when 'a' => Also_Predef := True;
634 when 'h' => Print_Usage := True;
635 when 'u' => Reset_Print; Print_Unit := True;
636 when 's' => Reset_Print; Print_Source := True;
637 when 'o' => Reset_Print; Print_Object := True;
638 when 'v' => Verbose_Mode := True;
639 when 'd' => Dependable := True;
644 -- Processing for --RTS=path
646 elsif Argv'Length >= 5 and then Argv (1 .. 5) = "--RTS" then
647 if Argv'Length <= 6 or else Argv (6) /= '='then
648 Osint.Fail ("missing path for --RTS");
651 -- Check that it is the first time we see this switch or, if
652 -- it is not the first time, the same path is specified.
654 if RTS_Specified = null then
655 RTS_Specified := new String'(Argv (7 .. Argv'Last));
657 elsif RTS_Specified.all /= Argv (7 .. Argv'Last) then
658 Osint.Fail ("--RTS cannot be specified multiple times");
661 -- Valid --RTS switch
663 Opt.No_Stdinc := True;
664 Opt.RTS_Switch := True;
667 Src_Path_Name : constant String_Ptr :=
670 (Argv (7 .. Argv'Last), Include));
671 Lib_Path_Name : constant String_Ptr :=
674 (Argv (7 .. Argv'Last), Objects));
677 if Src_Path_Name /= null
678 and then Lib_Path_Name /= null
680 Add_Search_Dirs (Src_Path_Name, Include);
681 Add_Search_Dirs (Lib_Path_Name, Objects);
683 elsif Src_Path_Name = null
684 and then Lib_Path_Name = null
686 Osint.Fail ("RTS path not valid: missing " &
687 "adainclude and adalib directories");
689 elsif Src_Path_Name = null then
690 Osint.Fail ("RTS path not valid: missing " &
691 "adainclude directory");
693 elsif Lib_Path_Name = null then
694 Osint.Fail ("RTS path not valid: missing " &
701 -- If not a switch, it must be a file name
714 -- Start of processing for Usage
719 Write_Str ("Usage: ");
720 Osint.Write_Program_Name;
721 Write_Str (" switches [list of object files]");
727 Write_Str ("switches:");
732 Write_Str (" -a also output relevant predefined units");
737 Write_Str (" -u output only relevant unit names");
742 Write_Str (" -h output this help message");
747 Write_Str (" -s output only relevant source names");
752 Write_Str (" -o output only relevant object names");
757 Write_Str (" -d output sources on which specified units depend");
762 Write_Str (" -v verbose output, full path and unit information");
766 -- Line for -aI switch
768 Write_Str (" -aIdir specify source files search path");
771 -- Line for -aO switch
773 Write_Str (" -aOdir specify object files search path");
776 -- Line for -I switch
778 Write_Str (" -Idir like -aIdir -aOdir");
781 -- Line for -I- switch
783 Write_Str (" -I- do not look for sources & object files");
784 Write_Str (" in the default directory");
787 -- Line for -nostdinc
789 Write_Str (" -nostdinc do not look for source files");
790 Write_Str (" in the system default directory");
795 Write_Str (" --RTS=dir specify the default source and object search"
799 -- File Status explanation
802 Write_Str (" file status can be:");
805 for ST in File_Status loop
807 Output_Status (ST, Verbose => False);
809 Output_Status (ST, Verbose => True);
815 -- Start of processing for Gnatls
818 -- Initialize standard packages
823 -- Use low level argument routines to avoid dragging in the secondary stack
827 Scan_Args : while Next_Arg < Arg_Count loop
829 Next_Argv : String (1 .. Len_Arg (Next_Arg));
832 Fill_Arg (Next_Argv'Address, Next_Arg);
833 Scan_Ls_Arg (Next_Argv, And_Save => True);
836 Next_Arg := Next_Arg + 1;
839 -- Add the source and object directories specified on the
840 -- command line, if any, to the searched directories.
842 while First_Source_Dir /= null loop
843 Add_Src_Search_Dir (First_Source_Dir.Value.all);
844 First_Source_Dir := First_Source_Dir.Next;
847 while First_Lib_Dir /= null loop
848 Add_Lib_Search_Dir (First_Lib_Dir.Value.all);
849 First_Lib_Dir := First_Lib_Dir.Next;
852 -- Finally, add the default directories and obtain target parameters
854 Osint.Add_Default_Search_Dirs;
857 Targparm.Get_Target_Parameters;
859 -- WARNING: the output of gnatls -v is used during the compilation
860 -- and installation of GLADE to recreate sdefault.adb and locate
861 -- the libgnat.a to use. Any change in the output of gnatls -v must
862 -- be synchronized with the GLADE Dist/config.sdefault shell script.
865 Write_Str ("GNATLS ");
866 Write_Str (Gnat_Version_String);
867 Write_Str (" Copyright 1997-2003 Free Software Foundation, Inc.");
870 Write_Str ("Source Search Path:");
873 for J in 1 .. Nb_Dir_In_Src_Search_Path loop
876 if Dir_In_Src_Search_Path (J)'Length = 0 then
877 Write_Str ("<Current_Directory>");
879 Write_Str (To_Host_Dir_Spec
880 (Dir_In_Src_Search_Path (J).all, True).all);
888 Write_Str ("Object Search Path:");
891 for J in 1 .. Nb_Dir_In_Obj_Search_Path loop
894 if Dir_In_Obj_Search_Path (J)'Length = 0 then
895 Write_Str ("<Current_Directory>");
897 Write_Str (To_Host_Dir_Spec
898 (Dir_In_Obj_Search_Path (J).all, True).all);
907 -- Output usage information when requested
913 if not More_Lib_Files then
914 if not Print_Usage and then not Verbose_Mode then
918 Exit_Program (E_Fatal);
922 Initialize_ALI_Source;
924 -- Print out all library for which no ALI files can be located
926 while More_Lib_Files loop
927 Main_File := Next_Main_Lib_File;
928 Ali_File := Full_Lib_File_Name (Lib_File_Name (Main_File));
930 if Ali_File = No_File then
931 Write_Str ("Can't find library info for ");
932 Get_Name_String (Main_File);
934 Write_Str (Name_Buffer (1 .. Name_Len));
939 Ali_File := Strip_Directory (Ali_File);
941 if Get_Name_Table_Info (Ali_File) = 0 then
942 Text := Read_Library_Info (Ali_File, True);
945 (Ali_File, Text, Ignore_ED => False, Err => False);
952 for Id in ALIs.First .. ALIs.Last loop
957 Get_Name_String (Units.Table (ALIs.Table (Id).First_Unit).Uname);
959 if Also_Predef or else not Is_Internal_Unit then
960 Output_Object (ALIs.Table (Id).Ofile_Full_Name);
962 -- In verbose mode print all main units in the ALI file, otherwise
963 -- just print the first one to ease columnwise printout
966 Last_U := ALIs.Table (Id).Last_Unit;
968 Last_U := ALIs.Table (Id).First_Unit;
971 for U in ALIs.Table (Id).First_Unit .. Last_U loop
972 if U /= ALIs.Table (Id).First_Unit
973 and then Selective_Output
981 -- Output source now, unless if it will be done as part of
982 -- outputing dependencies.
984 if not (Dependable and then Print_Source) then
985 Output_Source (Corresponding_Sdep_Entry (Id, U));
989 -- Print out list of dependable units
991 if Dependable and then Print_Source then
993 Write_Str ("depends upon");
1002 ALIs.Table (Id).First_Sdep .. ALIs.Table (Id).Last_Sdep
1005 or else not Is_Internal_File_Name (Sdep.Table (D).Sfile)
1007 if Verbose_Mode then
1017 Write_Str (Spaces (1 .. Source_Start - 2));
1030 -- All done. Set proper exit status.
1033 Exit_Program (E_Success);