OSDN Git Service

Regenerate gcc/configure.
[pf3gnuchains/gcc-fork.git] / 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 --          Copyright (C) 1992-2009, 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 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.          --
20 --                                                                          --
21 -- GNAT was originally developed  by the GNAT team at  New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
23 --                                                                          --
24 ------------------------------------------------------------------------------
25
26 --  Warning: the output of this usage for warnings is duplicated in the GNAT
27 --  reference manual. Be sure to update that if you change the warning list.
28
29 with Targparm; use Targparm;
30 with Namet;    use Namet;
31 with Opt;      use Opt;
32 with Osint;    use Osint;
33 with Output;   use Output;
34
35 with System.WCh_Con; use System.WCh_Con;
36
37 procedure Usage is
38
39    procedure Write_Switch_Char (Sw : String; Prefix : String := "gnat");
40    --  Output two spaces followed by the switch character minus followed
41    --  Prefix, followed by the string given as the argument, and then enough
42    --  blanks to tab to column 13, i.e. assuming Sw is not longer than 5
43    --  characters, the maximum allowed, Write_Switch_Char will always output
44    --  exactly 12 characters.
45
46    -----------------------
47    -- Write_Switch_Char --
48    -----------------------
49
50    procedure Write_Switch_Char (Sw : String; Prefix : String := "gnat") is
51    begin
52       Write_Str ("  -");
53       Write_Str (Prefix);
54       Write_Str (Sw);
55
56       for J in 1 .. 12 - 3 - Prefix'Length - Sw'Length loop
57          Write_Char (' ');
58       end loop;
59    end Write_Switch_Char;
60
61 --  Start of processing for Usage
62
63 begin
64    Find_Program_Name;
65
66    --  For gnatmake, we are appending this information to the end of
67    --  the normal gnatmake output, so generate appropriate header
68
69    if Name_Len >= 8
70      and then (Name_Buffer (Name_Len - 7 .. Name_Len) = "gnatmake"
71                  or else
72                Name_Buffer (Name_Len - 7 .. Name_Len) = "GNATMAKE")
73    then
74       Write_Eol;
75       Write_Line ("Compiler switches (passed to the compiler by gnatmake):");
76
77    else
78       --  Usage line
79
80       Write_Str ("Usage: ");
81       Write_Program_Name;
82       Write_Char (' ');
83       Write_Str ("switches sfile");
84       Write_Eol;
85       Write_Eol;
86
87       --  Line for sfile
88
89       Write_Line ("  sfile     Source file name");
90    end if;
91
92    Write_Eol;
93
94    --  Common GCC switches not available for JVM, .NET, and AAMP targets
95
96    if VM_Target = No_VM and then not AAMP_On_Target then
97       Write_Switch_Char ("fstack-check ", "");
98       Write_Line ("Generate stack checking code");
99
100       Write_Switch_Char ("fno-inline   ", "");
101       Write_Line ("Inhibit all inlining (makes executable smaller)");
102
103       Write_Switch_Char ("fpreserve-control-flow ", "");
104       Write_Line ("Preserve control flow for coverage analysis");
105    end if;
106
107    --  Common switches available to both GCC and JGNAT
108
109    Write_Switch_Char ("g            ", "");
110    Write_Line ("Generate debugging information");
111
112    Write_Switch_Char ("Idir         ", "");
113    Write_Line ("Specify source files search path");
114
115    Write_Switch_Char ("I-           ", "");
116    Write_Line ("Do not look for sources in current directory");
117
118    Write_Switch_Char ("O[0123]      ", "");
119    Write_Line ("Control the optimization level");
120
121    Write_Eol;
122
123    --  Individual lines for switches. Write_Switch_Char outputs fourteen
124    --  characters, so the remaining message is allowed to be a maximum
125    --  of 65 characters to be comfortable on an 80 character device.
126    --  If the Write_Str fits on one line, it is short enough!
127
128    --  Line for -gnata switch
129
130    Write_Switch_Char ("a");
131    Write_Line ("Assertions enabled. Pragma Assert/Debug to be activated");
132
133    --  Line for -gnatA switch
134
135    Write_Switch_Char ("A");
136    Write_Line ("Avoid processing gnat.adc, if present file will be ignored");
137
138    --  Line for -gnatb switch
139
140    Write_Switch_Char ("b");
141    Write_Line ("Generate brief messages to stderr even if verbose mode set");
142
143    --  Line for -gnatB switch
144
145    Write_Switch_Char ("B");
146    Write_Line ("Assume no bad (invalid) values except in 'Valid attribute");
147
148    --  Line for -gnatc switch
149
150    Write_Switch_Char ("c");
151    Write_Line ("Check syntax and semantics only (no code generation)");
152
153    --  Line for -gnatC switch
154
155    Write_Switch_Char ("C");
156    Write_Line ("Generate CodePeer information (no code generation)");
157
158    --  Line for -gnatd switch
159
160    Write_Switch_Char ("d?");
161    Write_Line ("Compiler debug option ? ([.]a-z,A-Z,0-9), see debug.adb");
162
163    --  Line for -gnatD switch
164
165    Write_Switch_Char ("D");
166    Write_Line ("Debug expanded generated code (max line length = 72)");
167    Write_Switch_Char ("Dnn");
168    Write_Line ("Debug expanded generated code (max line length = nn)");
169
170    --  Line for -gnatec switch
171
172    Write_Switch_Char ("ec=?");
173    Write_Line ("Specify configuration pragmas file, e.g. -gnatec=/x/f.adc");
174
175    --  Line for -gnateD switch
176
177    Write_Switch_Char ("eD?");
178    Write_Line ("Define or redefine preprocessing symbol, e.g. -gnateDsym=val");
179
180    --  Line for -gnatef switch
181
182    Write_Switch_Char ("ef");
183    Write_Line ("Full source path in brief error messages");
184
185    --  Line for -gnateG switch
186
187    Write_Switch_Char ("eG");
188    Write_Line ("Generate preprocessed source");
189
190    --  Line for -gnateI switch
191
192    Write_Switch_Char ("eInn");
193    Write_Line ("Index in multi-unit source, e.g. -gnateI2");
194
195    --  Line for -gnatem switch
196
197    Write_Switch_Char ("em=?");
198    Write_Line ("Specify mapping file, e.g. -gnatem=mapping");
199
200    --  Line for -gnatep switch
201
202    Write_Switch_Char ("ep=?");
203    Write_Line ("Specify preprocessing data file, e.g. -gnatep=prep.data");
204
205    --  Line for -gnateS switch
206
207    Write_Switch_Char ("eS");
208    Write_Line ("Generate SCO (Source Coverage Obligation) information");
209
210    --  Line for -gnatE switch
211
212    Write_Switch_Char ("E");
213    Write_Line ("Dynamic elaboration checking mode enabled");
214
215    --  Line for -gnatf switch
216
217    Write_Switch_Char ("f");
218    Write_Line ("Full errors. Verbose details, all undefined references");
219
220    --  Line for -gnatF switch
221
222    Write_Switch_Char ("F");
223    Write_Line ("Force all import/export external names to all uppercase");
224
225    --  Line for -gnatg switch
226
227    Write_Switch_Char ("g");
228    Write_Line ("GNAT implementation mode (used for compiling GNAT units)");
229
230    --  Lines for -gnatG switch
231
232    Write_Switch_Char ("G");
233    Write_Line ("Output generated expanded code (max line length = 72)");
234    Write_Switch_Char ("Gnn");
235    Write_Line ("Output generated expanded code (max line length = nn)");
236
237    --  Line for -gnath switch
238
239    Write_Switch_Char ("h");
240    Write_Line ("Output this usage (help) information");
241
242    --  Line for -gnati switch
243
244    Write_Switch_Char ("i?");
245    Write_Line ("Identifier char set (?=1/2/3/4/5/8/9/p/f/n/w)");
246
247    --  Line for -gnatI switch
248
249    Write_Switch_Char ("I");
250    Write_Line ("Ignore all representation clauses");
251
252    --  Line for -gnatj switch
253
254    Write_Switch_Char ("jnn");
255    Write_Line ("Format error and warning messages to fit nn character lines");
256
257    --  Line for -gnatk switch
258
259    Write_Switch_Char ("k");
260    Write_Line ("Limit file names to nn characters (k = krunch)");
261
262    --  Lines for -gnatl switch
263
264    Write_Switch_Char ("l");
265    Write_Line ("Output full source listing with embedded error messages");
266    Write_Switch_Char ("l=f");
267    Write_Line ("Output full source listing to specified file");
268
269    --  Line for -gnatL switch
270
271    Write_Switch_Char ("L");
272    Write_Line ("List corresponding source text in -gnatG or -gnatD output");
273
274    --  Line for -gnatm switch
275
276    Write_Switch_Char ("mnn");
277    Write_Line ("Limit number of detected errors/warnings to nn (1-999999)");
278
279    --  Line for -gnatn switch
280
281    Write_Switch_Char ("n");
282    Write_Line ("Inlining of subprograms (apply pragma Inline across units)");
283
284    --  Line for -gnatN switch
285
286    Write_Switch_Char ("N");
287    Write_Line ("Full (frontend) inlining of subprograms");
288
289    --  Line for -gnato switch
290
291    Write_Switch_Char ("o");
292    Write_Line ("Enable overflow checking (off by default)");
293
294    --  Line for -gnatO switch
295
296    Write_Switch_Char ("O nm ");
297    Write_Line ("Set name of output ali file (internal switch)");
298
299    --  Line for -gnatp switch
300
301    Write_Switch_Char ("p");
302    Write_Line ("Suppress all checks");
303
304    --  Line for -gnatP switch
305
306    Write_Switch_Char ("P");
307    Write_Line ("Generate periodic calls to System.Polling.Poll");
308
309    --  Line for -gnatq switch
310
311    Write_Switch_Char ("q");
312    Write_Line ("Don't quit, try semantics, even if parse errors");
313
314    --  Line for -gnatQ switch
315
316    Write_Switch_Char ("Q");
317    Write_Line ("Don't quit, write ali/tree file even if compile errors");
318
319    --  Line for -gnatr switch
320
321    Write_Switch_Char ("r");
322    Write_Line ("Treat pragma Restrictions as Restriction_Warnings");
323
324    --  Lines for -gnatR switch
325
326    Write_Switch_Char ("R?");
327    Write_Line ("List rep info (?=0/1/2/3 for none/types/all/variable)");
328    Write_Switch_Char ("R?s");
329    Write_Line ("List rep info to file.rep instead of standard output");
330
331    --  Lines for -gnats switch
332
333    Write_Switch_Char ("s");
334    Write_Line ("Syntax check only");
335
336    --  Lines for -gnatS switch
337
338    Write_Switch_Char ("S");
339    Write_Line ("Print listing of package Standard");
340
341    --  Lines for -gnatt switch
342
343    Write_Switch_Char ("t");
344    Write_Line ("Tree output file to be generated");
345
346    --  Line for -gnatT switch
347
348    Write_Switch_Char ("Tnn");
349    Write_Line ("All compiler tables start at nn times usual starting size");
350
351    --  Line for -gnatu switch
352
353    Write_Switch_Char ("u");
354    Write_Line ("List units for this compilation");
355
356    --  Line for -gnatU switch
357
358    Write_Switch_Char ("U");
359    Write_Line ("Enable unique tag for error messages");
360
361    --  Line for -gnatv switch
362
363    Write_Switch_Char ("v");
364    Write_Line ("Verbose mode. Full error output with source lines to stdout");
365
366    --  Line for -gnatV switch
367
368    Write_Switch_Char ("Vxx");
369    Write_Line
370      ("Enable selected validity checking mode, xx = list of parameters:");
371    Write_Line ("        a    turn on all validity checking options");
372    Write_Line ("        c    turn on checking for copies");
373    Write_Line ("        C    turn off checking for copies");
374    Write_Line ("        d    turn on default (RM) checking");
375    Write_Line ("        D    turn off default (RM) checking");
376    Write_Line ("        e    turn on checking for elementary components");
377    Write_Line ("        E    turn off checking for elementary components");
378    Write_Line ("        f    turn on checking for floating-point");
379    Write_Line ("        F    turn off checking for floating-point");
380    Write_Line ("        i    turn on checking for in params");
381    Write_Line ("        I    turn off checking for in params");
382    Write_Line ("        m    turn on checking for in out params");
383    Write_Line ("        M    turn off checking for in out params");
384    Write_Line ("        o    turn on checking for operators/attributes");
385    Write_Line ("        O    turn off checking for operators/attributes");
386    Write_Line ("        p    turn on checking for parameters");
387    Write_Line ("        P    turn off checking for parameters");
388    Write_Line ("        r    turn on checking for returns");
389    Write_Line ("        R    turn off checking for returns");
390    Write_Line ("        s    turn on checking for subscripts");
391    Write_Line ("        S    turn off checking for subscripts");
392    Write_Line ("        t    turn on checking for tests");
393    Write_Line ("        T    turn off checking for tests");
394    Write_Line ("        n    turn off all validity checks (including RM)");
395
396    --  Lines for -gnatw switch
397
398    Write_Switch_Char ("wxx");
399    Write_Line ("Enable selected warning modes, xx = list of parameters:");
400    Write_Line ("        a    turn on all optional info/warnings " &
401                                                   "(except dhl.ot.w)");
402    Write_Line ("        A    turn off all optional info/warnings");
403    Write_Line ("        .a*  turn on warnings for failing assertion");
404    Write_Line ("        .A   turn off warnings for failing assertion");
405    Write_Line ("        b    turn on warnings for bad fixed value " &
406                                                   "(not multiple of small)");
407    Write_Line ("        B*   turn off warnings for bad fixed value " &
408                                                   "(not multiple of small)");
409    Write_Line ("        .b*  turn on warnings for biased representation");
410    Write_Line ("        .B   turn off warnings for biased representation");
411    Write_Line ("        c    turn on warnings for constant conditional");
412    Write_Line ("        C*   turn off warnings for constant conditional");
413    Write_Line ("        .c   turn on warnings for unrepped components");
414    Write_Line ("        .C*  turn off warnings for unrepped components");
415    Write_Line ("        d    turn on warnings for implicit dereference");
416    Write_Line ("        D*   turn off warnings for implicit dereference");
417    Write_Line ("        e    treat all warnings (but not info) as errors");
418    Write_Line ("        .e   turn on every optional info/warning " &
419                                                   "(no exceptions)");
420    Write_Line ("        f    turn on warnings for unreferenced formal");
421    Write_Line ("        F*   turn off warnings for unreferenced formal");
422    Write_Line ("        g*   turn on warnings for unrecognized pragma");
423    Write_Line ("        G    turn off warnings for unrecognized pragma");
424    Write_Line ("        h    turn on warnings for hiding variable");
425    Write_Line ("        H*   turn off warnings for hiding variable");
426    Write_Line ("        i*   turn on warnings for implementation unit");
427    Write_Line ("        I    turn off warnings for implementation unit");
428    Write_Line ("        .i   turn on warnings for overlapping actuals");
429    Write_Line ("        .I*  turn off warnings for overlapping actuals");
430    Write_Line ("        j    turn on warnings for obsolescent " &
431                                                   "(annex J) feature");
432    Write_Line ("        J*   turn off warnings for obsolescent " &
433                                                   "(annex J) feature");
434    Write_Line ("        k    turn on warnings on constant variable");
435    Write_Line ("        K*   turn off warnings on constant variable");
436    Write_Line ("        l    turn on warnings for missing " &
437                                                   "elaboration pragma");
438    Write_Line ("        L*   turn off warnings for missing " &
439                                                   "elaboration pragma");
440    Write_Line ("        m    turn on warnings for variable assigned " &
441                                                   "but not read");
442    Write_Line ("        M*   turn off warnings for variable assigned " &
443                                                   "but not read");
444    Write_Line ("        .m*  turn on warnings for suspicious modulus value");
445    Write_Line ("        .M   turn off warnings for suspicious modulus value");
446    Write_Line ("        n*   normal warning mode (cancels -gnatws/-gnatwe)");
447    Write_Line ("        o*   turn on warnings for address clause overlay");
448    Write_Line ("        O    turn off warnings for address clause overlay");
449    Write_Line ("        .o   turn on warnings for out parameters assigned " &
450                                                   "but not read");
451    Write_Line ("        .O*  turn off warnings for out parameters assigned " &
452                                                   "but not read");
453    Write_Line ("        p    turn on warnings for ineffective pragma " &
454                                                   "Inline in frontend");
455    Write_Line ("        P*   turn off warnings for ineffective pragma " &
456                                                   "Inline in frontend");
457    Write_Line ("        .p   turn on warnings for suspicious parameter " &
458                                                   "order");
459    Write_Line ("        .P*  turn off warnings for suspicious parameter " &
460                                                   "order");
461    Write_Line ("        q*   turn on warnings for questionable " &
462                                                   "missing parenthesis");
463    Write_Line ("        Q    turn off warnings for questionable " &
464                                                   "missing parenthesis");
465    Write_Line ("        r    turn on warnings for redundant construct");
466    Write_Line ("        R*   turn off warnings for redundant construct");
467    Write_Line ("        .r   turn on warnings for object renaming function");
468    Write_Line ("        .R*  turn off warnings for object renaming function");
469    Write_Line ("        s    suppress all info/warnings");
470    Write_Line ("        t    turn on warnings for tracking deleted code");
471    Write_Line ("        T*   turn off warnings for tracking deleted code");
472    Write_Line ("        u    turn on warnings for unused entity");
473    Write_Line ("        U*   turn off warnings for unused entity");
474    Write_Line ("        v*   turn on warnings for unassigned variable");
475    Write_Line ("        V    turn off warnings for unassigned variable");
476    Write_Line ("        .v*  turn on info messages for reverse bit order");
477    Write_Line ("        .V   turn off info messages for reverse bit order");
478    Write_Line ("        w*   turn on warnings for wrong low bound assumption");
479    Write_Line ("        W    turn off warnings for wrong low bound " &
480                                                   "assumption");
481    Write_Line ("        .w   turn on warnings on pragma Warnings Off");
482    Write_Line ("        .W*  turn off warnings on pragma Warnings Off");
483    Write_Line ("        x*   turn on warnings for export/import");
484    Write_Line ("        X    turn off warnings for export/import");
485    Write_Line ("        .x   turn on warnings for non-local exception");
486    Write_Line ("        .X*  turn off warnings for non-local exception");
487    Write_Line ("        y*   turn on warnings for Ada 2005 incompatibility");
488    Write_Line ("        Y    turn off warnings for Ada 2005 incompatibility");
489    Write_Line ("        z*   turn on warnings for suspicious " &
490                                                   "unchecked conversion");
491    Write_Line ("        Z    turn off warnings for suspicious " &
492                                                   "unchecked conversion");
493    Write_Line ("        *    indicates default in above list");
494
495    --  Line for -gnatW switch
496
497    Write_Switch_Char ("W");
498    Write_Str ("Wide character encoding method (");
499
500    for J in WC_Encoding_Method loop
501       Write_Char (WC_Encoding_Letters (J));
502
503       if J = WC_Encoding_Method'Last then
504          Write_Char (')');
505       else
506          Write_Char ('/');
507       end if;
508    end loop;
509
510    Write_Eol;
511
512    --  Line for -gnatx switch
513
514    Write_Switch_Char ("x");
515    Write_Line ("Suppress output of cross-reference information");
516
517    --  Line for -gnatX switch
518
519    Write_Switch_Char ("X");
520    Write_Line ("Language extensions permitted");
521
522    --  Lines for -gnaty switch
523
524    Write_Switch_Char ("y");
525    Write_Line ("Enable default style checks (same as -gnaty3abcefhiklmnprst)");
526    Write_Switch_Char ("yxx");
527    Write_Line ("Enable selected style checks xx = list of parameters:");
528    Write_Line ("        1-9  check indentation");
529    Write_Line ("        a    check attribute casing");
530    Write_Line ("        A    check array attribute indexes");
531    Write_Line ("        b    check no blanks at end of lines");
532    Write_Line ("        B    check no use of AND/OR for boolean expressions");
533    Write_Line ("        c    check comment format");
534    Write_Line ("        d    check no DOS line terminators");
535    Write_Line ("        e    check end/exit labels present");
536    Write_Line ("        f    check no form feeds/vertical tabs in source");
537    Write_Line ("        g    check standard GNAT style rules");
538    Write_Line ("        h    check no horizontal tabs in source");
539    Write_Line ("        i    check if-then layout");
540    Write_Line ("        I    check mode in");
541    Write_Line ("        k    check casing rules for keywords");
542    Write_Line ("        l    check reference manual layout");
543    Write_Line ("        Lnn  check max nest level < nn ");
544    Write_Line ("        m    check line length <= 79 characters");
545    Write_Line ("        n    check casing of package Standard identifiers");
546    Write_Line ("        Mnn  check line length <= nn characters");
547    Write_Line ("        N    turn off all checks");
548    Write_Line ("        o    check subprogram bodies in alphabetical order");
549    Write_Line ("        O    check overriding indicators");
550    Write_Line ("        p    check pragma casing");
551    Write_Line ("        r    check casing for identifier references");
552    Write_Line ("        s    check separate subprogram specs present");
553    Write_Line ("        S    check separate lines after THEN or ELSE");
554    Write_Line ("        t    check token separation rules");
555    Write_Line ("        u    check no unnecessary blank lines");
556    Write_Line ("        x    check extra parentheses around conditionals");
557    Write_Line ("        y    turn on default style checks");
558    Write_Line ("        -    subtract (turn off) subsequent checks");
559    Write_Line ("        +    add (turn on) subsequent checks");
560
561    --  Lines for -gnatyN switch
562
563    Write_Switch_Char ("yN");
564    Write_Line ("Cancel all previously set style checks");
565
566    --  Lines for -gnatzc switch
567
568    Write_Switch_Char ("zc");
569    Write_Line ("Distribution stub generation for caller stubs");
570
571    --  Lines for -gnatzr switch
572
573    Write_Switch_Char ("zr");
574    Write_Line ("Distribution stub generation for receiver stubs");
575
576    --  Line for -gnat83 switch
577
578    Write_Switch_Char ("83");
579    Write_Line ("Enforce Ada 83 restrictions");
580
581    --  Line for -gnat95 switch
582
583    Write_Switch_Char ("95");
584
585    if Ada_Version_Default = Ada_95 then
586       Write_Line ("Ada 95 mode (default)");
587    else
588       Write_Line ("Enforce Ada 95 restrictions");
589    end if;
590
591    --  Line for -gnat05 switch
592
593    Write_Switch_Char ("05");
594
595    if Ada_Version_Default = Ada_05 then
596       Write_Line ("Ada 2005 mode (default)");
597    else
598       Write_Line ("Allow Ada 2005 extensions");
599    end if;
600
601 end Usage;