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