gcc/ada/gnatfind.adb

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                             G N A T F I N D                              --
   6 --                                                                          --
   7 --                                 B o d y                                  --
   8 --                                                                          --
   9 --         Copyright (C) 1998-2003 Free Software Foundation, Inc.           --
  10 --                                                                          --
  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.                                                      --
  21 --                                                                          --
  22 -- GNAT was originally developed  by the GNAT team at  New York University. --
  23 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  24 --                                                                          --
  25 ------------------------------------------------------------------------------
  26
  27 with Xr_Tabls;     use Xr_Tabls;
  28 with Xref_Lib;     use Xref_Lib;
  29 with Osint;        use Osint;
  30 with Types;        use Types;
  31
  32 with Gnatvsn;
  33 with Opt;
  34
  35 with Ada.Strings.Fixed; use Ada.Strings.Fixed;
  36 with Ada.Text_IO;       use Ada.Text_IO;
  37 with GNAT.Command_Line; use GNAT.Command_Line;
  38 with GNAT.Strings;      use GNAT.Strings;
  39 ---------------
  40 --  Gnatfind --
  41 ---------------
  42
  43 procedure Gnatfind is
  44
  45    Output_Ref      : Boolean := False;
  46    Pattern         : Xref_Lib.Search_Pattern;
  47    Local_Symbols   : Boolean := True;
  48    Prj_File        : File_Name_String;
  49    Prj_File_Length : Natural := 0;
  50    Nb_File         : Natural := 0;
  51    Usage_Error     : exception;
  52    Full_Path_Name  : Boolean := False;
  53    Have_Entity     : Boolean := False;
  54    Wide_Search     : Boolean := True;
  55    Glob_Mode       : Boolean := True;
  56    Der_Info        : Boolean := False;
  57    Type_Tree       : Boolean := False;
  58    Read_Only       : Boolean := False;
  59    Source_Lines    : Boolean := False;
  60
  61    Has_File_In_Entity : Boolean := False;
  62    --  Will be true if a file name was specified in the entity
  63
  64    RTS_Specified : String_Access := null;
  65    --  Used to detect multiple use of --RTS= switch
  66
  67    procedure Parse_Cmd_Line;
  68    --  Parse every switch on the command line
  69
  70    procedure Write_Usage;
  71    --  Print a small help page for program usage
  72
  73    --------------------
  74    -- Parse_Cmd_Line --
  75    --------------------
  76
  77    procedure Parse_Cmd_Line is
  78    begin
  79       loop
  80          case
  81            GNAT.Command_Line.Getopt
  82              ("a aI: aO: d e f g h I: nostdinc nostdlib p: r s t -RTS=")
  83          is
  84             when ASCII.NUL =>
  85                exit;
  86
  87             when 'a'    =>
  88                if GNAT.Command_Line.Full_Switch = "a" then
  89                   Read_Only := True;
  90
  91                elsif GNAT.Command_Line.Full_Switch = "aI" then
  92                   Osint.Add_Src_Search_Dir (GNAT.Command_Line.Parameter);
  93
  94                else
  95                   Osint.Add_Lib_Search_Dir (GNAT.Command_Line.Parameter);
  96                end if;
  97
  98             when 'd'    =>
  99                Der_Info := True;
 100
 101             when 'e'    =>
 102                Glob_Mode := False;
 103
 104             when 'f'    =>
 105                Full_Path_Name := True;
 106
 107             when 'g'    =>
 108                Local_Symbols := False;
 109
 110             when 'h'    =>
 111                Write_Usage;
 112
 113             when 'I'    =>
 114                Osint.Add_Src_Search_Dir (GNAT.Command_Line.Parameter);
 115                Osint.Add_Lib_Search_Dir (GNAT.Command_Line.Parameter);
 116
 117             when 'n'    =>
 118                if GNAT.Command_Line.Full_Switch = "nostdinc" then
 119                   Opt.No_Stdinc := True;
 120
 121                elsif GNAT.Command_Line.Full_Switch = "nostlib" then
 122                   Opt.No_Stdlib := True;
 123                end if;
 124
 125             when 'p'    =>
 126                declare
 127                   S : constant String := GNAT.Command_Line.Parameter;
 128
 129                begin
 130                   Prj_File_Length := S'Length;
 131                   Prj_File (1 .. Prj_File_Length) := S;
 132                end;
 133
 134             when 'r'    =>
 135                Output_Ref := True;
 136
 137             when 's' =>
 138                Source_Lines := True;
 139
 140             when 't' =>
 141                Type_Tree := True;
 142
 143             --  Only switch starting with -- recognized is --RTS
 144
 145             when '-'    =>
 146                --  Check that it is the first time we see this switch
 147
 148                if RTS_Specified = null then
 149                   RTS_Specified := new String'(GNAT.Command_Line.Parameter);
 150
 151                elsif RTS_Specified.all /= GNAT.Command_Line.Parameter then
 152                   Osint.Fail ("--RTS cannot be specified multiple times");
 153                end if;
 154
 155                Opt.No_Stdinc := True;
 156                Opt.RTS_Switch := True;
 157
 158                declare
 159                   Src_Path_Name : constant String_Ptr :=
 160                                     Get_RTS_Search_Dir
 161                                       (GNAT.Command_Line.Parameter, Include);
 162                   Lib_Path_Name : constant String_Ptr :=
 163                                     Get_RTS_Search_Dir
 164                                       (GNAT.Command_Line.Parameter, Objects);
 165
 166                begin
 167                   if Src_Path_Name /= null and then Lib_Path_Name /= null then
 168                      Add_Search_Dirs (Src_Path_Name, Include);
 169                      Add_Search_Dirs (Lib_Path_Name, Objects);
 170
 171                   elsif Src_Path_Name = null and then Lib_Path_Name = null then
 172                      Osint.Fail ("RTS path not valid: missing " &
 173                                  "adainclude and adalib directories");
 174
 175                   elsif Src_Path_Name = null then
 176                      Osint.Fail ("RTS path not valid: missing " &
 177                                  "adainclude directory");
 178
 179                   elsif Lib_Path_Name = null then
 180                      Osint.Fail ("RTS path not valid: missing " &
 181                                  "adalib directory");
 182                   end if;
 183                end;
 184
 185             when others =>
 186                Write_Usage;
 187          end case;
 188       end loop;
 189
 190       --  Get the other arguments
 191
 192       loop
 193          declare
 194             S : constant String := GNAT.Command_Line.Get_Argument;
 195
 196          begin
 197             exit when S'Length = 0;
 198
 199             --  First argument is the pattern
 200
 201             if not Have_Entity then
 202                Add_Entity (Pattern, S, Glob_Mode);
 203                Have_Entity := True;
 204
 205                if not Has_File_In_Entity
 206                  and then Index (S, ":") /= 0
 207                then
 208                   Has_File_In_Entity := True;
 209                end if;
 210
 211             --  Next arguments are the files to search
 212             else
 213                Add_Xref_File (S);
 214                Wide_Search := False;
 215                Nb_File := Nb_File + 1;
 216             end if;
 217          end;
 218       end loop;
 219
 220    exception
 221       when GNAT.Command_Line.Invalid_Switch =>
 222          Ada.Text_IO.Put_Line ("Invalid switch : "
 223                                & GNAT.Command_Line.Full_Switch);
 224          Write_Usage;
 225
 226       when GNAT.Command_Line.Invalid_Parameter =>
 227          Ada.Text_IO.Put_Line ("Parameter missing for : "
 228                                & GNAT.Command_Line.Full_Switch);
 229          Write_Usage;
 230
 231       when Xref_Lib.Invalid_Argument =>
 232          Ada.Text_IO.Put_Line ("Invalid line or column in the pattern");
 233          Write_Usage;
 234    end Parse_Cmd_Line;
 235
 236    -----------------
 237    -- Write_Usage --
 238    -----------------
 239
 240    procedure Write_Usage is
 241    begin
 242       Put_Line ("GNATFIND " & Gnatvsn.Gnat_Version_String
 243                 & " Copyright 1998-2003, Ada Core Technologies Inc.");
 244       Put_Line ("Usage: gnatfind pattern[:sourcefile[:line[:column]]] "
 245                 & "[file1 file2 ...]");
 246       New_Line;
 247       Put_Line ("  pattern     Name of the entity to look for (can have "
 248                 & "wildcards)");
 249       Put_Line ("  sourcefile  Only find entities referenced from this "
 250                 & "file");
 251       Put_Line ("  line        Only find entities referenced from this line "
 252                 & "of file");
 253       Put_Line ("  column      Only find entities referenced from this columns"
 254                 & " of file");
 255       Put_Line ("  file ...    Set of Ada source files to search for "
 256                 & "references. This parameters are optional");
 257       New_Line;
 258       Put_Line ("gnatfind switches:");
 259       Put_Line ("   -a        Consider all files, even when the ali file is "
 260                 & "readonly");
 261       Put_Line ("   -aIdir    Specify source files search path");
 262       Put_Line ("   -aOdir    Specify library/object files search path");
 263       Put_Line ("   -d        Output derived type information");
 264       Put_Line ("   -e        Use the full regular expression set for "
 265                 & "pattern");
 266       Put_Line ("   -f        Output full path name");
 267       Put_Line ("   -g        Output information only for global symbols");
 268       Put_Line ("   -Idir     Like -aIdir -aOdir");
 269       Put_Line ("   -nostdinc Don't look for sources in the system default"
 270                 & " directory");
 271       Put_Line ("   -nostdlib Don't look for library files in the system"
 272                 & " default directory");
 273       Put_Line ("   --RTS=dir specify the default source and object search"
 274                 & " path");
 275       Put_Line ("   -p file   Use file as the default project file");
 276       Put_Line ("   -r        Find all references (default to find declaration"
 277                 & " only)");
 278       Put_Line ("   -s        Print source line");
 279       Put_Line ("   -t        Print type hierarchy");
 280       New_Line;
 281
 282       raise Usage_Error;
 283    end Write_Usage;
 284
 285 --  Start of processing for Gnatfind
 286
 287 begin
 288    Parse_Cmd_Line;
 289
 290    if not Have_Entity then
 291       Write_Usage;
 292    end if;
 293
 294    --  Special case to speed things up: if the user has a command line of the
 295    --  form 'gnatfind entity:file', ie has specified a file and only wants the
 296    --  bodies and specs, then we can restrict the search to the .ali file
 297    --  associated with 'file'.
 298
 299    if Has_File_In_Entity
 300      and then not Output_Ref
 301    then
 302       Wide_Search := False;
 303    end if;
 304
 305    --  Find the project file
 306
 307    if Prj_File_Length = 0 then
 308       Xr_Tabls.Create_Project_File (Default_Project_File ("."));
 309    else
 310       Xr_Tabls.Create_Project_File (Prj_File (1 .. Prj_File_Length));
 311    end if;
 312
 313    --  Fill up the table
 314
 315    if Type_Tree and then Nb_File > 1 then
 316       Ada.Text_IO.Put_Line ("Error: for type hierarchy output you must "
 317                             & "specify only one file.");
 318       Ada.Text_IO.New_Line;
 319       Write_Usage;
 320    end if;
 321
 322    Search (Pattern, Local_Symbols, Wide_Search, Read_Only,
 323            Der_Info, Type_Tree);
 324
 325    if Source_Lines then
 326       Xr_Tabls.Grep_Source_Files;
 327    end if;
 328
 329    Print_Gnatfind (Output_Ref, Full_Path_Name);
 330
 331 exception
 332    when Usage_Error =>
 333       null;
 334 end Gnatfind;