1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1998-2019, 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 ------------------------------------------------------------------------------
27 with Osint
; use Osint
;
28 with Switch
; use Switch
;
29 with Types
; use Types
;
31 with Xref_Lib
; use Xref_Lib
;
33 with Ada
.Command_Line
; use Ada
.Command_Line
;
34 with Ada
.Strings
.Fixed
; use Ada
.Strings
.Fixed
;
35 with Ada
.Text_IO
; use Ada
.Text_IO
;
37 with GNAT
.Command_Line
; use GNAT
.Command_Line
;
39 with System
.Strings
; use System
.Strings
;
46 Output_Ref
: Boolean := False;
47 Pattern
: Xref_Lib
.Search_Pattern
;
48 Local_Symbols
: Boolean := True;
49 Prj_File
: File_Name_String
;
50 Prj_File_Length
: Natural := 0;
51 Nb_File
: Natural := 0;
52 Usage_Error
: exception;
53 Full_Path_Name
: Boolean := False;
54 Have_Entity
: Boolean := False;
55 Wide_Search
: Boolean := True;
56 Glob_Mode
: Boolean := True;
57 Der_Info
: Boolean := False;
58 Type_Tree
: Boolean := False;
59 Read_Only
: Boolean := False;
60 Source_Lines
: Boolean := False;
62 Has_File_In_Entity
: Boolean := False;
63 -- Will be true if a file name was specified in the entity
65 RTS_Specified
: String_Access
:= null;
66 -- Used to detect multiple use of --RTS= switch
68 EXT_Specified
: String_Access
:= null;
69 -- Used to detect multiple use of --ext= switch
71 procedure Parse_Cmd_Line
;
72 -- Parse every switch on the command line
77 procedure Write_Usage
;
78 pragma No_Return
(Write_Usage
);
79 -- Print a small help page for program usage and exit program
85 procedure Parse_Cmd_Line
is
87 procedure Check_Version_And_Help
is new Check_Version_And_Help_G
(Usage
);
89 -- Start of processing for Parse_Cmd_Line
92 -- First check for --version or --help
94 Check_Version_And_Help
("GNATFIND", "1998");
96 -- Now scan the other switches
98 GNAT
.Command_Line
.Initialize_Option_Scan
;
102 GNAT
.Command_Line
.Getopt
103 ("a aI: aO: d e f g h I: nostdinc nostdlib p: r s t -RTS= -ext=")
109 if GNAT
.Command_Line
.Full_Switch
= "a" then
111 elsif GNAT
.Command_Line
.Full_Switch
= "aI" then
112 Osint
.Add_Src_Search_Dir
(GNAT
.Command_Line
.Parameter
);
114 Osint
.Add_Lib_Search_Dir
(GNAT
.Command_Line
.Parameter
);
124 Full_Path_Name
:= True;
127 Local_Symbols
:= False;
133 Osint
.Add_Src_Search_Dir
(GNAT
.Command_Line
.Parameter
);
134 Osint
.Add_Lib_Search_Dir
(GNAT
.Command_Line
.Parameter
);
137 if GNAT
.Command_Line
.Full_Switch
= "nostdinc" then
138 Opt
.No_Stdinc
:= True;
139 elsif GNAT
.Command_Line
.Full_Switch
= "nostdlib" then
140 Opt
.No_Stdlib
:= True;
145 S
: constant String := GNAT
.Command_Line
.Parameter
;
147 Prj_File_Length
:= S
'Length;
148 Prj_File
(1 .. Prj_File_Length
) := S
;
155 Source_Lines
:= True;
160 -- Only switch starting with -- recognized is --RTS
163 if GNAT
.Command_Line
.Full_Switch
= "-RTS" then
165 -- Check that it is the first time we see this switch
167 if RTS_Specified
= null then
168 RTS_Specified
:= new String'(GNAT.Command_Line.Parameter);
169 elsif RTS_Specified.all /= GNAT.Command_Line.Parameter then
170 Osint.Fail ("--RTS cannot be specified multiple times");
173 Opt.No_Stdinc := True;
174 Opt.RTS_Switch := True;
177 Src_Path_Name : constant String_Ptr :=
179 (GNAT.Command_Line.Parameter,
181 Lib_Path_Name : constant String_Ptr :=
183 (GNAT.Command_Line.Parameter,
187 if Src_Path_Name /= null
188 and then Lib_Path_Name /= null
190 Add_Search_Dirs (Src_Path_Name, Include);
191 Add_Search_Dirs (Lib_Path_Name, Objects);
193 elsif Src_Path_Name = null
194 and then Lib_Path_Name = null
196 Osint.Fail ("RTS path not valid: missing " &
197 "adainclude and adalib directories");
199 elsif Src_Path_Name = null then
200 Osint.Fail ("RTS path not valid: missing " &
201 "adainclude directory");
203 elsif Lib_Path_Name = null then
204 Osint.Fail ("RTS path not valid: missing " &
209 -- Process -ext switch
211 elsif GNAT.Command_Line.Full_Switch = "-ext" then
213 -- Check that it is the first time we see this switch
215 if EXT_Specified = null then
216 EXT_Specified := new String'(GNAT
.Command_Line
.Parameter
);
217 elsif EXT_Specified
.all /= GNAT
.Command_Line
.Parameter
then
218 Osint
.Fail
("--ext cannot be specified multiple times");
222 EXT_Specified
'Length = Osint
.ALI_Default_Suffix
'Length
224 Osint
.ALI_Suffix
:= EXT_Specified
.all'Access;
226 Osint
.Fail
("--ext argument must have 3 characters");
237 -- Get the other arguments
241 S
: constant String := GNAT
.Command_Line
.Get_Argument
;
244 exit when S
'Length = 0;
246 -- First argument is the pattern
248 if not Have_Entity
then
249 Add_Entity
(Pattern
, S
, Glob_Mode
);
252 if not Has_File_In_Entity
253 and then Index
(S
, ":") /= 0
255 Has_File_In_Entity
:= True;
258 -- Next arguments are the files to search
262 Wide_Search
:= False;
263 Nb_File
:= Nb_File
+ 1;
269 when GNAT
.Command_Line
.Invalid_Switch
=>
270 Ada
.Text_IO
.Put_Line
("Invalid switch : "
271 & GNAT
.Command_Line
.Full_Switch
);
275 when GNAT
.Command_Line
.Invalid_Parameter
=>
276 Ada
.Text_IO
.Put_Line
("Parameter missing for : "
277 & GNAT
.Command_Line
.Full_Switch
);
281 when Xref_Lib
.Invalid_Argument
=>
282 Ada
.Text_IO
.Put_Line
("Invalid line or column in the pattern");
293 Put_Line
("Usage: gnatfind pattern[:sourcefile[:line[:column]]] "
294 & "[file1 file2 ...]");
296 Put_Line
(" pattern Name of the entity to look for (can have "
298 Put_Line
(" sourcefile Only find entities referenced from this "
300 Put_Line
(" line Only find entities referenced from this line "
302 Put_Line
(" column Only find entities referenced from this columns"
304 Put_Line
(" file ... Set of Ada source files to search for "
305 & "references. This parameters are optional");
307 Put_Line
("gnatfind switches:");
308 Display_Usage_Version_And_Help
;
309 Put_Line
(" -a Consider all files, even when the ali file is "
311 Put_Line
(" -aIdir Specify source files search path");
312 Put_Line
(" -aOdir Specify library/object files search path");
313 Put_Line
(" -d Output derived type information");
314 Put_Line
(" -e Use the full regular expression set for "
316 Put_Line
(" -f Output full path name");
317 Put_Line
(" -g Output information only for global symbols");
318 Put_Line
(" -Idir Like -aIdir -aOdir");
319 Put_Line
(" -nostdinc Don't look for sources in the system default"
321 Put_Line
(" -nostdlib Don't look for library files in the system"
322 & " default directory");
323 Put_Line
(" --ext=xxx Specify alternate ali file extension");
324 Put_Line
(" --RTS=dir specify the default source and object search"
326 Put_Line
(" -p file Use file as the configuration file");
327 Put_Line
(" -r Find all references (default to find declaration"
329 Put_Line
(" -s Print source line");
330 Put_Line
(" -t Print type hierarchy");
337 procedure Write_Usage
is
339 Display_Version
("GNATFIND", "1998");
347 -- Start of processing for Gnatfind
352 if not Have_Entity
then
353 if Argument_Count
= 0 then
361 -- Special case to speed things up: if the user has a command line of the
362 -- form 'gnatfind entity:file', i.e. has specified a file and only wants
363 -- the bodies and specs, then we can restrict the search to the .ali file
364 -- associated with 'file'.
366 if Has_File_In_Entity
367 and then not Output_Ref
369 Wide_Search
:= False;
372 -- Find the project file
374 if Prj_File_Length
= 0 then
375 Xr_Tabls
.Create_Project_File
(Default_Project_File
("."));
377 Xr_Tabls
.Create_Project_File
(Prj_File
(1 .. Prj_File_Length
));
382 if Type_Tree
and then Nb_File
> 1 then
383 Ada
.Text_IO
.Put_Line
("Error: for type hierarchy output you must "
384 & "specify only one file.");
385 Ada
.Text_IO
.New_Line
;
390 Search
(Pattern
, Local_Symbols
, Wide_Search
, Read_Only
,
391 Der_Info
, Type_Tree
);
394 Xr_Tabls
.Grep_Source_Files
;
397 Print_Gnatfind
(Output_Ref
, Full_Path_Name
);