1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2004 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 pragma Ident (Gnat_Static_Version_String);
46 Max_Column : constant := 80;
49 OK, -- matching timestamp
50 Checksum_OK, -- only matching checksum
51 Not_Found, -- file not found on source PATH
52 Not_Same, -- neither checksum nor timestamp matching
53 Not_First_On_PATH); -- matching file hidden by Not_Same file on path
56 type Dir_Ref is access Dir_Data;
58 type Dir_Data is record
59 Value : String_Access;
64 First_Source_Dir : Dir_Ref;
65 Last_Source_Dir : Dir_Ref;
66 -- The list of source directories from the command line.
67 -- These directories are added using Osint.Add_Src_Search_Dir
68 -- after those of the GNAT Project File, if any.
70 First_Lib_Dir : Dir_Ref;
71 Last_Lib_Dir : Dir_Ref;
72 -- The list of object directories from the command line.
73 -- These directories are added using Osint.Add_Lib_Search_Dir
74 -- after those of the GNAT Project File, if any.
76 Main_File : File_Name_Type;
77 Ali_File : File_Name_Type;
78 Text : Text_Buffer_Ptr;
81 Too_Long : Boolean := False;
82 -- When True, lines are too long for multi-column output and each
83 -- item of information is on a different line.
85 Selective_Output : Boolean := False;
86 Print_Usage : Boolean := False;
87 Print_Unit : Boolean := True;
88 Print_Source : Boolean := True;
89 Print_Object : Boolean := True;
90 -- Flags controlling the form of the outpout
92 Dependable : Boolean := False; -- flag -d
93 Also_Predef : Boolean := False;
97 Source_Start : Integer;
99 Object_Start : Integer;
100 Object_End : Integer;
101 -- Various column starts and ends
103 Spaces : constant String (1 .. Max_Column) := (others => ' ');
105 RTS_Specified : String_Access := null;
106 -- Used to detect multiple use of --RTS= switch
108 -----------------------
109 -- Local Subprograms --
110 -----------------------
112 procedure Add_Lib_Dir (Dir : String; And_Save : Boolean);
113 -- Add an object directory, using Osint.Add_Lib_Search_Dir
114 -- if And_Save is False or keeping in the list First_Lib_Dir,
115 -- Last_Lib_Dir if And_Save is True.
117 procedure Add_Source_Dir (Dir : String; And_Save : Boolean);
118 -- Add a source directory, using Osint.Add_Src_Search_Dir
119 -- if And_Save is False or keeping in the list First_Source_Dir,
120 -- Last_Source_Dir if And_Save is True.
122 procedure Find_General_Layout;
123 -- Determine the structure of the output (multi columns or not, etc)
125 procedure Find_Status
126 (FS : in out File_Name_Type;
127 Stamp : Time_Stamp_Type;
129 Status : out File_Status);
130 -- Determine the file status (Status) of the file represented by FS
131 -- with the expected Stamp and checksum given as argument. FS will be
132 -- updated to the full file name if available.
134 function Corresponding_Sdep_Entry (A : ALI_Id; U : Unit_Id) return Sdep_Id;
135 -- Give the Sdep entry corresponding to the unit U in ali record A.
137 procedure Output_Object (O : File_Name_Type);
138 -- Print out the name of the object when requested
140 procedure Output_Source (Sdep_I : Sdep_Id);
141 -- Print out the name and status of the source corresponding to this
144 procedure Output_Status (FS : File_Status; Verbose : Boolean);
145 -- Print out FS either in a coded form if verbose is false or in an
146 -- expanded form otherwise.
148 procedure Output_Unit (U_Id : Unit_Id);
149 -- Print out information on the unit when requested
151 procedure Reset_Print;
152 -- Reset Print flags properly when selective output is chosen
154 procedure Scan_Ls_Arg (Argv : String; And_Save : Boolean);
155 -- Scan and process lser specific arguments. Argv is a single argument.
158 -- Print usage message.
164 procedure Add_Lib_Dir (Dir : String; And_Save : Boolean) is
167 if First_Lib_Dir = null then
170 (Value => new String'(Dir),
172 Last_Lib_Dir := First_Lib_Dir;
177 (Value => new String'(Dir),
179 Last_Lib_Dir := Last_Lib_Dir.Next;
183 Add_Lib_Search_Dir (Dir);
191 procedure Add_Source_Dir (Dir : String; And_Save : Boolean) is
194 if First_Source_Dir = null then
197 (Value => new String'(Dir),
199 Last_Source_Dir := First_Source_Dir;
202 Last_Source_Dir.Next :=
204 (Value => new String'(Dir),
206 Last_Source_Dir := Last_Source_Dir.Next;
210 Add_Src_Search_Dir (Dir);
214 ------------------------------
215 -- Corresponding_Sdep_Entry --
216 ------------------------------
218 function Corresponding_Sdep_Entry
220 U : Unit_Id) return Sdep_Id
223 for D in ALIs.Table (A).First_Sdep .. ALIs.Table (A).Last_Sdep loop
224 if Sdep.Table (D).Sfile = Units.Table (U).Sfile then
229 Error_Msg_Name_1 := Units.Table (U).Uname;
230 Error_Msg_Name_2 := ALIs.Table (A).Afile;
232 Error_Msg ("wrong ALI format, can't find dependency line for & in %");
233 Exit_Program (E_Fatal);
234 end Corresponding_Sdep_Entry;
236 -------------------------
237 -- Find_General_Layout --
238 -------------------------
240 procedure Find_General_Layout is
241 Max_Unit_Length : Integer := 11;
242 Max_Src_Length : Integer := 11;
243 Max_Obj_Length : Integer := 11;
249 -- Compute maximum of each column
251 for Id in ALIs.First .. ALIs.Last loop
252 Get_Name_String (Units.Table (ALIs.Table (Id).First_Unit).Uname);
253 if Also_Predef or else not Is_Internal_Unit then
257 Max_Unit_Length := Integer'Max (Max_Unit_Length, Len);
261 FS := Full_Source_Name (ALIs.Table (Id).Sfile);
264 Get_Name_String (ALIs.Table (Id).Sfile);
265 Name_Len := Name_Len + 13;
267 Get_Name_String (FS);
270 Max_Src_Length := Integer'Max (Max_Src_Length, Name_Len + 1);
274 Get_Name_String (ALIs.Table (Id).Ofile_Full_Name);
275 Max_Obj_Length := Integer'Max (Max_Obj_Length, Name_Len + 1);
280 -- Verify is output is not wider than maximum number of columns
282 Too_Long := Verbose_Mode or else
283 (Max_Unit_Length + Max_Src_Length + Max_Obj_Length) > Max_Column;
285 -- Set start and end of columns.
288 Object_End := Object_Start - 1;
291 Object_End := Object_Start + Max_Obj_Length;
294 Unit_Start := Object_End + 1;
295 Unit_End := Unit_Start - 1;
298 Unit_End := Unit_Start + Max_Unit_Length;
301 Source_Start := Unit_End + 1;
303 if Source_Start > Spaces'Last then
304 Source_Start := Spaces'Last;
307 Source_End := Source_Start - 1;
310 Source_End := Source_Start + Max_Src_Length;
312 end Find_General_Layout;
318 procedure Find_Status
319 (FS : in out File_Name_Type;
320 Stamp : Time_Stamp_Type;
322 Status : out File_Status)
324 Tmp1 : File_Name_Type;
325 Tmp2 : File_Name_Type;
328 Tmp1 := Full_Source_Name (FS);
330 if Tmp1 = No_File then
333 elsif File_Stamp (Tmp1) = Stamp then
337 elsif Checksums_Match (Get_File_Checksum (FS), Checksum) then
339 Status := Checksum_OK;
342 Tmp2 := Matching_Full_Source_Name (FS, Stamp);
344 if Tmp2 = No_File then
349 Status := Not_First_On_PATH;
359 procedure Output_Object (O : File_Name_Type) is
360 Object_Name : String_Access;
365 Object_Name := To_Host_File_Spec (Name_Buffer (1 .. Name_Len));
366 Write_Str (Object_Name.all);
368 if Print_Source or else Print_Unit then
374 (Object_Start + Object_Name'Length .. Object_End));
384 procedure Output_Source (Sdep_I : Sdep_Id) is
385 Stamp : constant Time_Stamp_Type := Sdep.Table (Sdep_I).Stamp;
386 Checksum : constant Word := Sdep.Table (Sdep_I).Checksum;
387 FS : File_Name_Type := Sdep.Table (Sdep_I).Sfile;
388 Status : File_Status;
389 Object_Name : String_Access;
393 Find_Status (FS, Stamp, Checksum, Status);
394 Get_Name_String (FS);
396 Object_Name := To_Host_File_Spec (Name_Buffer (1 .. Name_Len));
399 Write_Str (" Source => ");
400 Write_Str (Object_Name.all);
404 (Spaces (Source_Start + Object_Name'Length .. Source_End));
407 Output_Status (Status, Verbose => True);
412 if not Selective_Output then
413 Output_Status (Status, Verbose => False);
416 Write_Str (Object_Name.all);
425 procedure Output_Status (FS : File_Status; Verbose : Boolean) is
430 Write_Str (" unchanged");
433 Write_Str (" slightly modified");
436 Write_Str (" file not found");
439 Write_Str (" modified");
441 when Not_First_On_PATH =>
442 Write_Str (" unchanged version not first on PATH");
459 when Not_First_On_PATH =>
469 procedure Output_Unit (U_Id : Unit_Id) is
471 U : Unit_Record renames Units.Table (U_Id);
475 Get_Name_String (U.Uname);
476 Kind := Name_Buffer (Name_Len);
477 Name_Len := Name_Len - 2;
479 if not Verbose_Mode then
480 Write_Str (Name_Buffer (1 .. Name_Len));
483 Write_Str ("Unit => ");
484 Write_Eol; Write_Str (" Name => ");
485 Write_Str (Name_Buffer (1 .. Name_Len));
486 Write_Eol; Write_Str (" Kind => ");
488 if Units.Table (U_Id).Unit_Kind = 'p' then
489 Write_Str ("package ");
491 Write_Str ("subprogram ");
511 Write_Eol; Write_Str (" Flags =>");
514 Write_Str (" Preelaborable");
518 Write_Str (" No_Elab_Code");
525 if U.Elaborate_Body then
526 Write_Str (" Elaborate Body");
529 if U.Remote_Types then
530 Write_Str (" Remote_Types");
533 if U.Shared_Passive then
534 Write_Str (" Shared_Passive");
538 Write_Str (" Predefined");
542 Write_Str (" Remote_Call_Interface");
549 Write_Eol; Write_Str (" ");
551 Write_Str (Spaces (Unit_Start + Name_Len + 1 .. Unit_End));
561 procedure Reset_Print is
563 if not Selective_Output then
564 Selective_Output := True;
565 Print_Source := False;
566 Print_Object := False;
575 procedure Scan_Ls_Arg (Argv : String; And_Save : Boolean) is
577 pragma Assert (Argv'First = 1);
579 if Argv'Length = 0 then
583 if Argv (1) = '-' then
585 if Argv'Length = 1 then
586 Fail ("switch character cannot be followed by a blank");
588 -- Processing for -I-
590 elsif Argv (2 .. Argv'Last) = "I-" then
591 Opt.Look_In_Primary_Dir := False;
593 -- Forbid -?- or -??- where ? is any character
595 elsif (Argv'Length = 3 and then Argv (3) = '-')
596 or else (Argv'Length = 4 and then Argv (4) = '-')
598 Fail ("Trailing ""-"" at the end of ", Argv, " forbidden.");
600 -- Processing for -Idir
602 elsif Argv (2) = 'I' then
603 Add_Source_Dir (Argv (3 .. Argv'Last), And_Save);
604 Add_Lib_Dir (Argv (3 .. Argv'Last), And_Save);
606 -- Processing for -aIdir (to gcc this is like a -I switch)
608 elsif Argv'Length >= 3 and then Argv (2 .. 3) = "aI" then
609 Add_Source_Dir (Argv (4 .. Argv'Last), And_Save);
611 -- Processing for -aOdir
613 elsif Argv'Length >= 3 and then Argv (2 .. 3) = "aO" then
614 Add_Lib_Dir (Argv (4 .. Argv'Last), And_Save);
616 -- Processing for -aLdir (to gnatbind this is like a -aO switch)
618 elsif Argv'Length >= 3 and then Argv (2 .. 3) = "aL" then
619 Add_Lib_Dir (Argv (4 .. Argv'Last), And_Save);
621 -- Processing for -nostdinc
623 elsif Argv (2 .. Argv'Last) = "nostdinc" then
624 Opt.No_Stdinc := True;
626 -- Processing for one character switches
628 elsif Argv'Length = 2 then
630 when 'a' => Also_Predef := True;
631 when 'h' => Print_Usage := True;
632 when 'u' => Reset_Print; Print_Unit := True;
633 when 's' => Reset_Print; Print_Source := True;
634 when 'o' => Reset_Print; Print_Object := True;
635 when 'v' => Verbose_Mode := True;
636 when 'd' => Dependable := True;
641 -- Processing for --RTS=path
643 elsif Argv'Length >= 5 and then Argv (1 .. 5) = "--RTS" then
644 if Argv'Length <= 6 or else Argv (6) /= '='then
645 Osint.Fail ("missing path for --RTS");
648 -- Check that it is the first time we see this switch or, if
649 -- it is not the first time, the same path is specified.
651 if RTS_Specified = null then
652 RTS_Specified := new String'(Argv (7 .. Argv'Last));
654 elsif RTS_Specified.all /= Argv (7 .. Argv'Last) then
655 Osint.Fail ("--RTS cannot be specified multiple times");
658 -- Valid --RTS switch
660 Opt.No_Stdinc := True;
661 Opt.RTS_Switch := True;
664 Src_Path_Name : constant String_Ptr :=
667 (Argv (7 .. Argv'Last), Include));
668 Lib_Path_Name : constant String_Ptr :=
671 (Argv (7 .. Argv'Last), Objects));
674 if Src_Path_Name /= null
675 and then Lib_Path_Name /= null
677 Add_Search_Dirs (Src_Path_Name, Include);
678 Add_Search_Dirs (Lib_Path_Name, Objects);
680 elsif Src_Path_Name = null
681 and then Lib_Path_Name = null
683 Osint.Fail ("RTS path not valid: missing " &
684 "adainclude and adalib directories");
686 elsif Src_Path_Name = null then
687 Osint.Fail ("RTS path not valid: missing " &
688 "adainclude directory");
690 elsif Lib_Path_Name = null then
691 Osint.Fail ("RTS path not valid: missing " &
698 -- If not a switch, it must be a file name
711 -- Start of processing for Usage
716 Write_Str ("Usage: ");
717 Osint.Write_Program_Name;
718 Write_Str (" switches [list of object files]");
724 Write_Str ("switches:");
729 Write_Str (" -a also output relevant predefined units");
734 Write_Str (" -u output only relevant unit names");
739 Write_Str (" -h output this help message");
744 Write_Str (" -s output only relevant source names");
749 Write_Str (" -o output only relevant object names");
754 Write_Str (" -d output sources on which specified units depend");
759 Write_Str (" -v verbose output, full path and unit information");
763 -- Line for -aI switch
765 Write_Str (" -aIdir specify source files search path");
768 -- Line for -aO switch
770 Write_Str (" -aOdir specify object files search path");
773 -- Line for -I switch
775 Write_Str (" -Idir like -aIdir -aOdir");
778 -- Line for -I- switch
780 Write_Str (" -I- do not look for sources & object files");
781 Write_Str (" in the default directory");
784 -- Line for -nostdinc
786 Write_Str (" -nostdinc do not look for source files");
787 Write_Str (" in the system default directory");
792 Write_Str (" --RTS=dir specify the default source and object search"
796 -- File Status explanation
799 Write_Str (" file status can be:");
802 for ST in File_Status loop
804 Output_Status (ST, Verbose => False);
806 Output_Status (ST, Verbose => True);
812 -- Start of processing for Gnatls
815 -- Initialize standard packages
820 -- Use low level argument routines to avoid dragging in the secondary stack
824 Scan_Args : while Next_Arg < Arg_Count loop
826 Next_Argv : String (1 .. Len_Arg (Next_Arg));
828 Fill_Arg (Next_Argv'Address, Next_Arg);
829 Scan_Ls_Arg (Next_Argv, And_Save => True);
832 Next_Arg := Next_Arg + 1;
835 -- Add the source and object directories specified on the
836 -- command line, if any, to the searched directories.
838 while First_Source_Dir /= null loop
839 Add_Src_Search_Dir (First_Source_Dir.Value.all);
840 First_Source_Dir := First_Source_Dir.Next;
843 while First_Lib_Dir /= null loop
844 Add_Lib_Search_Dir (First_Lib_Dir.Value.all);
845 First_Lib_Dir := First_Lib_Dir.Next;
848 -- Finally, add the default directories and obtain target parameters
850 Osint.Add_Default_Search_Dirs;
853 Targparm.Get_Target_Parameters;
855 -- WARNING: the output of gnatls -v is used during the compilation
856 -- and installation of GLADE to recreate sdefault.adb and locate
857 -- the libgnat.a to use. Any change in the output of gnatls -v must
858 -- be synchronized with the GLADE Dist/config.sdefault shell script.
861 Write_Str ("GNATLS ");
862 Write_Str (Gnat_Version_String);
863 Write_Str (" Copyright 1997-2004 Free Software Foundation, Inc.");
866 Write_Str ("Source Search Path:");
869 for J in 1 .. Nb_Dir_In_Src_Search_Path loop
872 if Dir_In_Src_Search_Path (J)'Length = 0 then
873 Write_Str ("<Current_Directory>");
875 Write_Str (To_Host_Dir_Spec
876 (Dir_In_Src_Search_Path (J).all, True).all);
884 Write_Str ("Object Search Path:");
887 for J in 1 .. Nb_Dir_In_Obj_Search_Path loop
890 if Dir_In_Obj_Search_Path (J)'Length = 0 then
891 Write_Str ("<Current_Directory>");
893 Write_Str (To_Host_Dir_Spec
894 (Dir_In_Obj_Search_Path (J).all, True).all);
903 -- Output usage information when requested
909 if not More_Lib_Files then
910 if not Print_Usage and then not Verbose_Mode then
914 Exit_Program (E_Fatal);
918 Initialize_ALI_Source;
920 -- Print out all library for which no ALI files can be located
922 while More_Lib_Files loop
923 Main_File := Next_Main_Lib_File;
924 Ali_File := Full_Lib_File_Name (Lib_File_Name (Main_File));
926 if Ali_File = No_File then
927 Write_Str ("Can't find library info for ");
928 Get_Name_String (Main_File);
930 Write_Str (Name_Buffer (1 .. Name_Len));
935 Ali_File := Strip_Directory (Ali_File);
937 if Get_Name_Table_Info (Ali_File) = 0 then
938 Text := Read_Library_Info (Ali_File, True);
942 pragma Unreferenced (Discard);
946 (Ali_File, Text, Ignore_ED => False, Err => False);
955 for Id in ALIs.First .. ALIs.Last loop
960 Get_Name_String (Units.Table (ALIs.Table (Id).First_Unit).Uname);
962 if Also_Predef or else not Is_Internal_Unit then
963 Output_Object (ALIs.Table (Id).Ofile_Full_Name);
965 -- In verbose mode print all main units in the ALI file, otherwise
966 -- just print the first one to ease columnwise printout
969 Last_U := ALIs.Table (Id).Last_Unit;
971 Last_U := ALIs.Table (Id).First_Unit;
974 for U in ALIs.Table (Id).First_Unit .. Last_U loop
975 if U /= ALIs.Table (Id).First_Unit
976 and then Selective_Output
984 -- Output source now, unless if it will be done as part of
985 -- outputing dependencies.
987 if not (Dependable and then Print_Source) then
988 Output_Source (Corresponding_Sdep_Entry (Id, U));
992 -- Print out list of dependable units
994 if Dependable and then Print_Source then
996 Write_Str ("depends upon");
1005 ALIs.Table (Id).First_Sdep .. ALIs.Table (Id).Last_Sdep
1008 or else not Is_Internal_File_Name (Sdep.Table (D).Sfile)
1010 if Verbose_Mode then
1020 Write_Str (Spaces (1 .. Source_Start - 2));
1033 -- All done. Set proper exit status
1036 Exit_Program (E_Success);