gcc/ada/usage.adb

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                               U S A G E                                  --
   6 --                                                                          --
   7 --                                B o d y                                   --
   8 --                                                                          --
   9 --                           $Revision$
  10 --                                                                          --
  11 --          Copyright (C) 1992-2001, Free Software Foundation, Inc.         --
  12 --                                                                          --
  13 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  14 -- terms of the  GNU General Public License as published  by the Free Soft- --
  15 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  16 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  17 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  18 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  19 -- for  more details.  You should have  received  a copy of the GNU General --
  20 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  21 -- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
  22 -- MA 02111-1307, USA.                                                      --
  23 --                                                                          --
  24 -- GNAT was originally developed  by the GNAT team at  New York University. --
  25 -- It is now maintained by Ada Core Technologies Inc (http://www.gnat.com). --
  26 --                                                                          --
  27 ------------------------------------------------------------------------------
  28
  29 with Hostparm;
  30 with Namet;          use Namet;
  31 with Osint;          use Osint;
  32 with Output;         use Output;
  33 with System.WCh_Con; use System.WCh_Con;
  34
  35 procedure Usage is
  36
  37    procedure Write_Switch_Char (Sw : String; Prefix : String := "gnat");
  38    --  Output two spaces followed by default switch character followed
  39    --  Prefix, followed by the string given as the argument, and then
  40    --  enough blanks to tab to column 13, i.e. assuming Sw is not longer
  41    --  than 5 characters, the maximum allowed, Write_Switch_Char will
  42    --  always output exactly 12 characters.
  43
  44    procedure Write_Switch_Char (Sw : String; Prefix : String := "gnat") is
  45    begin
  46       Write_Str ("  ");
  47       Write_Char (Switch_Character);
  48       Write_Str (Prefix);
  49       Write_Str (Sw);
  50
  51       for J in 1 .. 12 - 3 - Prefix'Length - Sw'Length loop
  52          Write_Char (' ');
  53       end loop;
  54    end Write_Switch_Char;
  55
  56 --  Start of processing for Usage
  57
  58 begin
  59    Find_Program_Name;
  60
  61    --  For gnatmake, we are appending this information to the end of
  62    --  the normal gnatmake output, so generate appropriate header
  63
  64    if Name_Len >= 8
  65      and then (Name_Buffer (Name_Len - 7 .. Name_Len) = "gnatmake"
  66                  or else
  67                Name_Buffer (Name_Len - 7 .. Name_Len) = "GNATMAKE")
  68    then
  69       Write_Eol;
  70       Write_Line ("Compiler switches (passed to the compiler by gnatmake):");
  71
  72    else
  73       --  Usage line
  74
  75       Write_Str ("Usage: ");
  76       Write_Program_Name;
  77       Write_Char (' ');
  78       Write_Str ("switches sfile");
  79       Write_Eol;
  80       Write_Eol;
  81
  82       --  Line for sfile
  83
  84       Write_Line ("  sfile     Source file name");
  85    end if;
  86
  87    Write_Eol;
  88
  89    --  Common GCC switches not available in JGNAT
  90
  91    if not Hostparm.Java_VM then
  92       Write_Switch_Char ("fstack-check ", "");
  93       Write_Line ("Generate stack checking code");
  94
  95       Write_Switch_Char ("fno-inline   ", "");
  96       Write_Line ("Inhibit all inlining (makes executable smaller)");
  97    end if;
  98
  99    --  Common switches available to both GCC and JGNAT
 100
 101    Write_Switch_Char ("g            ", "");
 102    Write_Line ("Generate debugging information");
 103
 104    Write_Switch_Char ("Idir         ", "");
 105    Write_Line ("Specify source files search path");
 106
 107    Write_Switch_Char ("I-           ", "");
 108    Write_Line ("Do not look for sources in current directory");
 109
 110    Write_Switch_Char ("O[0123]      ", "");
 111    Write_Line ("Control the optimization level");
 112
 113    Write_Eol;
 114
 115    --  Individual lines for switches. Write_Switch_Char outputs fourteen
 116    --  characters, so the remaining message is allowed to be a maximum
 117    --  of 65 characters to be comfortable on an 80 character device.
 118    --  If the Write_Str fits on one line, it is short enough!
 119
 120    --  Line for -gnata switch
 121
 122    Write_Switch_Char ("a");
 123    Write_Line ("Assertions enabled. Pragma Assert/Debug to be activated");
 124
 125    --  Line for -gnatA switch
 126
 127    Write_Switch_Char ("A");
 128    Write_Line ("Avoid processing gnat.adc, if present file will be ignored");
 129
 130    --  Line for -gnatb switch
 131
 132    Write_Switch_Char ("b");
 133    Write_Line ("Generate brief messages to stderr even if verbose mode set");
 134
 135    --  Line for -gnatc switch
 136
 137    Write_Switch_Char ("c");
 138    Write_Line ("Check syntax and semantics only (no code generation)");
 139
 140    Write_Switch_Char ("C");
 141    Write_Line ("Compress names in external names and debug info tables");
 142
 143    --  Line for -gnatd switch
 144
 145    Write_Switch_Char ("d?");
 146    Write_Line ("Compiler debug option ? (a-z,A-Z,0-9), see debug.adb");
 147
 148    --  Line for -gnatD switch
 149
 150    Write_Switch_Char ("D");
 151    Write_Line ("Debug expanded generated code rather than source code");
 152
 153    --  Line for -gnatec switch
 154
 155    Write_Switch_Char ("ec?");
 156    Write_Line ("Specify configuration pragmas file, e.g. -gnatec/x/f.adc");
 157
 158    --  Line for -gnatE switch
 159
 160    Write_Switch_Char ("E");
 161    Write_Line ("Dynamic elaboration checking mode enabled");
 162
 163    --  Line for -gnatf switch
 164
 165    Write_Switch_Char ("f");
 166    Write_Line ("Full errors. Verbose details, all undefined references");
 167
 168    --  Line for -gnatF switch
 169
 170    Write_Switch_Char ("F");
 171    Write_Line ("Force all import/export external names to all uppercase");
 172
 173    --  Line for -gnatg switch
 174
 175    Write_Switch_Char ("g");
 176    Write_Line ("GNAT implementation mode (used for compiling GNAT units)");
 177
 178    --  Line for -gnatG switch
 179
 180    Write_Switch_Char ("G");
 181    Write_Line ("Output generated expanded code in source form");
 182
 183    --  Line for -gnath switch
 184
 185    Write_Switch_Char ("h");
 186    Write_Line ("Output this usage (help) information");
 187
 188    --  Line for -gnati switch
 189
 190    Write_Switch_Char ("i?");
 191    Write_Line ("Identifier char set (?=1/2/3/4/8/p/f/n/w)");
 192
 193    --  Line for -gnatk switch
 194
 195    Write_Switch_Char ("k");
 196    Write_Line ("Limit file names to nnn characters (k = krunch)");
 197
 198    --  Line for -gnatl switch
 199
 200    Write_Switch_Char ("l");
 201    Write_Line ("Output full source listing with embedded error messages");
 202
 203    --  Line for -gnatL switch
 204
 205    Write_Switch_Char ("L");
 206    Write_Line ("Use longjmp/setjmp for exception handling");
 207
 208    --  Line for -gnatm switch
 209
 210    Write_Switch_Char ("mnnn");
 211    Write_Line ("Limit number of detected errors to nnn (1-999)");
 212
 213    --  Line for -gnatn switch
 214
 215    Write_Switch_Char ("n");
 216    Write_Line ("Inlining of subprograms (apply pragma Inline across units)");
 217
 218    --  Line for -gnatN switch
 219
 220    Write_Switch_Char ("N");
 221    Write_Line ("Full (frontend) inlining of subprograqms");
 222
 223    --  Line for -gnato switch
 224
 225    Write_Switch_Char ("o");
 226    Write_Line ("Enable overflow checking (off by default)");
 227
 228    --  Line for -gnatO switch
 229
 230    Write_Switch_Char ("O nm ");
 231    Write_Line ("Set name of output ali file (internal switch)");
 232
 233    --  Line for -gnatp switch
 234
 235    Write_Switch_Char ("p");
 236    Write_Line ("Suppress all checks");
 237
 238    --  Line for -gnatP switch
 239
 240    Write_Switch_Char ("P");
 241    Write_Line ("Generate periodic calls to System.Polling.Poll");
 242
 243    --  Line for -gnatq switch
 244
 245    Write_Switch_Char ("q");
 246    Write_Line ("Don't quit, try semantics, even if parse errors");
 247
 248    --  Line for -gnatQ switch
 249
 250    Write_Switch_Char ("Q");
 251    Write_Line ("Don't quit, write ali/tree file even if compile errors");
 252
 253    --  Line for -gnatR switch
 254
 255    Write_Switch_Char ("R?");
 256    Write_Line ("List rep inf (?=0/1/2/3 for none/types/all/variable)");
 257
 258    --  Lines for -gnats switch
 259
 260    Write_Switch_Char ("s");
 261    Write_Line ("Syntax check only");
 262
 263    --  Lines for -gnatt switch
 264
 265    Write_Switch_Char ("t");
 266    Write_Line ("Tree output file to be generated");
 267
 268    --  Line for -gnatT switch
 269
 270    Write_Switch_Char ("Tnnn");
 271    Write_Line ("All compiler tables start at nnn times usual starting size");
 272
 273    --  Line for -gnatu switch
 274
 275    Write_Switch_Char ("u");
 276    Write_Line ("List units for this compilation");
 277
 278    --  Line for -gnatU switch
 279
 280    Write_Switch_Char ("U");
 281    Write_Line ("Enable unique tag for error messages");
 282
 283    --  Line for -gnatv switch
 284
 285    Write_Switch_Char ("v");
 286    Write_Line ("Verbose mode. Full error output with source lines to stdout");
 287
 288    --  Line for -gnatV switch
 289
 290    Write_Switch_Char ("Vxx");
 291    Write_Line
 292      ("Enable selected validity checking mode, xx = list of parameters:");
 293    Write_Line ("        a    turn on all validity checking options");
 294    Write_Line ("        c    turn on validity checking for copies");
 295    Write_Line ("        C    turn off validity checking for copies");
 296    Write_Line ("        f    turn on validity checking for floating-point");
 297    Write_Line ("        F    turn off validity checking for floating-point");
 298    Write_Line ("        i    turn on validity checking for in params");
 299    Write_Line ("        I    turn off validity checking for in params");
 300    Write_Line ("        m    turn on validity checking for in out params");
 301    Write_Line ("        M    turn off validity checking for in out params");
 302    Write_Line ("        r    turn on validity checking for returns");
 303    Write_Line ("        R    turn off validity checking for returns");
 304    Write_Line ("        s    turn on validity checking for subscripts");
 305    Write_Line ("        S    turn off validity checking for subscripts");
 306    Write_Line ("        t    turn on validity checking for tests");
 307    Write_Line ("        T    turn off validity checking for tests");
 308    Write_Line ("        n    turn off all validity checks (including RM)");
 309
 310    --  Lines for -gnatw switch
 311
 312    Write_Switch_Char ("wxx");
 313    Write_Line ("Enable selected warning modes, xx = list of parameters:");
 314    Write_Line ("        a    turn on all optional warnings (except b,h)");
 315    Write_Line ("        A    turn off all optional warnings");
 316    Write_Line ("        b    turn on biased rounding warnings");
 317    Write_Line ("        B    turn off biased rounding warnings");
 318    Write_Line ("        c    turn on constant conditional warnings");
 319    Write_Line ("        C*   turn off constant conditional warnings");
 320    Write_Line ("        e    treat all warnings as errors");
 321    Write_Line ("        h    turn on warnings for hiding variables");
 322    Write_Line ("        H*   turn off warnings for hiding variables");
 323    Write_Line ("        i*   turn on warnings for implementation units");
 324    Write_Line ("        I    turn off warnings for implementation units");
 325    Write_Line ("        l    turn on elaboration warnings");
 326    Write_Line ("        L*   turn off elaboration warnings");
 327    Write_Line ("        o*   turn on address clause overlay warnings");
 328    Write_Line ("        O    turn off address clause overlay warnings");
 329    Write_Line ("        p    turn on warnings for ineffective pragma inline");
 330    Write_Line ("        P*   turn off warnings for ineffective pragma inline");
 331    Write_Line ("        r    turn on redundant construct warnings");
 332    Write_Line ("        R*   turn off redundant construct warnings");
 333    Write_Line ("        s    suppress all warnings");
 334    Write_Line ("        u    turn on warnings for unused entities");
 335    Write_Line ("        U*   turn off warnings for unused entities");
 336    Write_Line ("        *    indicates default in above list");
 337
 338    --  Line for -gnatW switch
 339
 340    Write_Switch_Char ("W");
 341    Write_Str ("Wide character encoding method (");
 342
 343    for J in WC_Encoding_Method loop
 344       Write_Char (WC_Encoding_Letters (J));
 345
 346       if J = WC_Encoding_Method'Last then
 347          Write_Char (')');
 348       else
 349          Write_Char ('/');
 350       end if;
 351    end loop;
 352
 353    Write_Eol;
 354
 355    --  Line for -gnatx switch
 356
 357    Write_Switch_Char ("x");
 358    Write_Line ("Suppress output of cross-reference information");
 359
 360    --  Line for -gnatX switch
 361
 362    Write_Switch_Char ("X");
 363    Write_Line ("Language extensions permitted");
 364
 365    --  Lines for -gnaty switch
 366
 367    Write_Switch_Char ("y");
 368    Write_Line ("Enable all style checks except 'o', indent=3");
 369
 370    Write_Switch_Char ("yxx");
 371    Write_Line ("Enable selected style checks xx = list of parameters:");
 372    Write_Line ("        1-9  check indentation");
 373    Write_Line ("        a    check attribute casing");
 374    Write_Line ("        b    check no blanks at end of lines");
 375    Write_Line ("        c    check comment format");
 376    Write_Line ("        e    check end/exit labels present");
 377    Write_Line ("        f    check no form feeds/vertical tabs in source");
 378    Write_Line ("        h    check no horizontal tabs in source");
 379    Write_Line ("        i    check if-then layout");
 380    Write_Line ("        k    check casing rules for keywords, identifiers");
 381    Write_Line ("        l    check reference manual layout");
 382    Write_Line ("        m    check line length <= 79 characters");
 383    Write_Line ("        n    check casing of package Standard identifiers");
 384    Write_Line ("        Mnnn check line length <= nnn characters");
 385    Write_Line ("        o    check subprogram bodies in alphabetical order");
 386    Write_Line ("        p    check pragma casing");
 387    Write_Line ("        r    check RM column layout");
 388    Write_Line ("        s    check separate subprogram specs present");
 389    Write_Line ("        t    check token separation rules");
 390
 391    --  Lines for -gnatz switch
 392
 393    Write_Switch_Char ("z");
 394    Write_Line ("Distribution stub generation (r/s for receiver/sender stubs)");
 395
 396    --  Line for -gnatZ switch
 397
 398    Write_Switch_Char ("Z");
 399    Write_Line ("Use zero cost exception handling");
 400
 401    --  Line for -gnat83 switch
 402
 403    Write_Switch_Char ("83");
 404    Write_Line ("Enforce Ada 83 restrictions");
 405
 406 end Usage;