1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2013, 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 ------------------------------------------------------------------------------
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.
29 with Targparm; use Targparm;
30 with Namet; use Namet;
32 with Osint; use Osint;
33 with Output; use Output;
35 with System.WCh_Con; use System.WCh_Con;
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.
46 -----------------------
47 -- Write_Switch_Char --
48 -----------------------
50 procedure Write_Switch_Char (Sw : String; Prefix : String := "gnat") is
56 for J in 1 .. 12 - 3 - Prefix'Length - Sw'Length loop
59 end Write_Switch_Char;
61 -- Start of processing for Usage
66 -- For gnatmake, we are appending this information to the end of
67 -- the normal gnatmake output, so generate appropriate header
70 and then (Name_Buffer (Name_Len - 7 .. Name_Len) = "gnatmake"
72 Name_Buffer (Name_Len - 7 .. Name_Len) = "GNATMAKE")
75 Write_Line ("Compiler switches (passed to the compiler by gnatmake):");
80 Write_Str ("Usage: ");
83 Write_Str ("switches sfile");
89 Write_Line (" sfile Source file name");
94 -- Common GCC switches not available for JVM, .NET, and AAMP targets
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");
100 Write_Switch_Char ("fno-inline ", "");
101 Write_Line ("Inhibit all inlining (makes executable smaller)");
103 Write_Switch_Char ("fpreserve-control-flow ", "");
104 Write_Line ("Preserve control flow for coverage analysis");
107 -- Common switches available to both GCC and JGNAT
109 Write_Switch_Char ("g ", "");
110 Write_Line ("Generate debugging information");
112 Write_Switch_Char ("Idir ", "");
113 Write_Line ("Specify source files search path");
115 Write_Switch_Char ("I- ", "");
116 Write_Line ("Do not look for sources in current directory");
118 Write_Switch_Char ("O[0123] ", "");
119 Write_Line ("Control the optimization level");
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!
128 -- Line for -gnata switch
130 Write_Switch_Char ("a");
131 Write_Line ("Assertions enabled. Pragma Assert/Debug to be activated");
133 -- Line for -gnatA switch
135 Write_Switch_Char ("A");
136 Write_Line ("Avoid processing gnat.adc, if present file will be ignored");
138 -- Line for -gnatb switch
140 Write_Switch_Char ("b");
141 Write_Line ("Generate brief messages to stderr even if verbose mode set");
143 -- Line for -gnatB switch
145 Write_Switch_Char ("B");
146 Write_Line ("Assume no bad (invalid) values except in 'Valid attribute");
148 -- Line for -gnatc switch
150 Write_Switch_Char ("c");
151 Write_Line ("Check syntax and semantics only (no code generation)");
153 -- Line for -gnatC switch
155 Write_Switch_Char ("C");
156 Write_Line ("Generate CodePeer information (no code generation)");
158 -- Line for -gnatd switch
160 Write_Switch_Char ("d?");
161 Write_Line ("Compiler debug option ? ([.]a-z,A-Z,0-9), see debug.adb");
163 -- Line for -gnatD switch
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)");
170 -- No line for -gnatea : internal switch
172 -- Line for -gnateA switch
174 Write_Switch_Char ("eA");
175 Write_Line ("Aliasing checks on subprogram parameters");
177 -- Line for -gnatec switch
179 Write_Switch_Char ("ec=?");
180 Write_Line ("Specify configuration pragmas file, e.g. -gnatec=/x/f.adc");
182 -- Line for -gnated switch
184 Write_Switch_Char ("ed");
185 Write_Line ("Disable synchronization of atomic variables");
187 -- Line for -gnateD switch
189 Write_Switch_Char ("eD?");
190 Write_Line ("Define or redefine preprocessing symbol, e.g. -gnateDsym=val");
192 -- Line for -gnateE switch
194 Write_Switch_Char ("eE");
195 Write_Line ("Generate extra information in exception messages");
197 -- Line for -gnatef switch
199 Write_Switch_Char ("ef");
200 Write_Line ("Full source path in brief error messages");
202 -- Line for -gnateF switch
204 Write_Switch_Char ("eF");
205 Write_Line ("Check overflow on predefined Float types");
207 -- Line for -gnateG switch
209 Write_Switch_Char ("eG");
210 Write_Line ("Generate preprocessed source");
212 -- Line for -gnatei switch
214 Write_Switch_Char ("einn");
215 Write_Line ("Set maximumum number of instantiations to nn");
217 -- Line for -gnateI switch
219 Write_Switch_Char ("eInn");
220 Write_Line ("Index in multi-unit source, e.g. -gnateI2");
222 -- Line for -gnatem switch
224 Write_Switch_Char ("em=?");
225 Write_Line ("Specify mapping file, e.g. -gnatem=mapping");
227 -- No line for -gnateO=? : internal switch
229 -- Line for -gnatep switch
231 Write_Switch_Char ("ep=?");
232 Write_Line ("Specify preprocessing data file, e.g. -gnatep=prep.data");
234 -- Line for -gnateP switch
236 Write_Switch_Char ("eP");
237 Write_Line ("Pure/Prelaborate errors generate warnings rather than errors");
239 -- Line for -gnateS switch
241 Write_Switch_Char ("eS");
242 Write_Line ("Generate SCO (Source Coverage Obligation) information");
244 -- Line for -gnatet switch
246 Write_Switch_Char ("et");
247 Write_Line ("Write target dependent information file");
249 -- Line for -gnateT switch
251 Write_Switch_Char ("eT");
252 Write_Line ("Read target dependent information file");
254 -- Line for -gnateV switch
256 Write_Switch_Char ("eV");
257 Write_Line ("Validity checks on subprogram parameters");
259 -- Line for -gnateY switch
261 Write_Switch_Char ("eY");
262 Write_Line ("Ignore all Style_Checks pragmas in source");
264 -- No line for -gnatez : internal switch
266 -- Line for -gnatE switch
268 Write_Switch_Char ("E");
269 Write_Line ("Dynamic elaboration checking mode enabled");
271 -- Line for -gnatf switch
273 Write_Switch_Char ("f");
274 Write_Line ("Full errors. Verbose details, all undefined references");
276 -- Line for -gnatF switch
278 Write_Switch_Char ("F");
279 Write_Line ("Force all import/export external names to all uppercase");
281 -- Line for -gnatg switch
283 Write_Switch_Char ("g");
284 Write_Line ("GNAT implementation mode (used for compiling GNAT units)");
286 -- Lines for -gnatG switch
288 Write_Switch_Char ("G");
289 Write_Line ("Output generated expanded code (max line length = 72)");
290 Write_Switch_Char ("Gnn");
291 Write_Line ("Output generated expanded code (max line length = nn)");
293 -- Line for -gnath switch
295 Write_Switch_Char ("h");
296 Write_Line ("Output this usage (help) information");
298 -- Line for -gnati switch
300 Write_Switch_Char ("i?");
301 Write_Line ("Identifier char set (?=1/2/3/4/5/8/9/p/f/n/w)");
303 -- Line for -gnatI switch
305 Write_Switch_Char ("I");
306 Write_Line ("Ignore all representation clauses");
308 -- Line for -gnatj switch
310 Write_Switch_Char ("jnn");
311 Write_Line ("Format error and warning messages to fit nn character lines");
313 -- Line for -gnatk switch
315 Write_Switch_Char ("k");
316 Write_Line ("Limit file names to nn characters (k = krunch)");
318 -- Lines for -gnatl switch
320 Write_Switch_Char ("l");
321 Write_Line ("Output full source listing with embedded error messages");
322 Write_Switch_Char ("l=f");
323 Write_Line ("Output full source listing to specified file");
325 -- Line for -gnatL switch
327 Write_Switch_Char ("L");
328 Write_Line ("List corresponding source text in -gnatG or -gnatD output");
330 -- Line for -gnatm switch
332 Write_Switch_Char ("mnn");
333 Write_Line ("Limit number of detected errors/warnings to nn (1-999999)");
335 -- Line for -gnatn switch
337 Write_Switch_Char ("n[?]");
338 Write_Line ("Enable pragma Inline (both within and across units, ?=1/2)");
340 -- Line for -gnato switch
342 Write_Switch_Char ("o");
343 Write_Line ("Enable overflow checking mode to CHECKED (off by default)");
345 -- Lines for -gnato? switches
347 Write_Switch_Char ("o?");
349 ("Enable overflow checks in STRICT/MINIMIZED/ELIMINATED (1/2/3) mode ");
350 Write_Switch_Char ("o??");
352 ("Set mode for general/assertion expressions separately");
354 -- No line for -gnatO : internal switch
356 -- Line for -gnatp switch
358 Write_Switch_Char ("p");
359 Write_Line ("Suppress all checks");
361 -- Line for -gnatP switch
363 Write_Switch_Char ("P");
364 Write_Line ("Generate periodic calls to System.Polling.Poll");
366 -- Line for -gnatq switch
368 Write_Switch_Char ("q");
369 Write_Line ("Don't quit, try semantics, even if parse errors");
371 -- Line for -gnatQ switch
373 Write_Switch_Char ("Q");
374 Write_Line ("Don't quit, write ali/tree file even if compile errors");
376 -- Line for -gnatr switch
378 Write_Switch_Char ("r");
379 Write_Line ("Treat pragma Restrictions as Restriction_Warnings");
381 -- Lines for -gnatR switch
383 Write_Switch_Char ("R?");
384 Write_Line ("List rep info (?=0/1/2/3 for none/types/all/variable)");
385 Write_Switch_Char ("R?s");
386 Write_Line ("List rep info to file.rep instead of standard output");
388 -- Line for -gnats switch
390 Write_Switch_Char ("s");
391 Write_Line ("Syntax check only");
393 -- Line for -gnatS switch
395 Write_Switch_Char ("S");
396 Write_Line ("Print listing of package Standard");
398 -- Line for -gnatt switch
400 Write_Switch_Char ("t");
401 Write_Line ("Tree output file to be generated");
403 -- Line for -gnatTnn switch
405 Write_Switch_Char ("Tnn");
406 Write_Line ("All compiler tables start at nn times usual starting size");
408 -- Line for -gnatu switch
410 Write_Switch_Char ("u");
411 Write_Line ("List units for this compilation");
413 -- Line for -gnatU switch
415 Write_Switch_Char ("U");
416 Write_Line ("Enable unique tag for error messages");
418 -- Line for -gnatv switch
420 Write_Switch_Char ("v");
421 Write_Line ("Verbose mode. Full error output with source lines to stdout");
423 -- Lines for -gnatV switch
425 Write_Switch_Char ("Vxx");
427 ("Enable selected validity checking mode, xx = list of parameters:");
428 Write_Line (" a turn on all validity checking options");
429 Write_Line (" c turn on checking for copies");
430 Write_Line (" C turn off checking for copies");
431 Write_Line (" d turn on default (RM) checking");
432 Write_Line (" D turn off default (RM) checking");
433 Write_Line (" e turn on checking for elementary components");
434 Write_Line (" E turn off checking for elementary components");
435 Write_Line (" f turn on checking for floating-point");
436 Write_Line (" F turn off checking for floating-point");
437 Write_Line (" i turn on checking for in params");
438 Write_Line (" I turn off checking for in params");
439 Write_Line (" m turn on checking for in out params");
440 Write_Line (" M turn off checking for in out params");
441 Write_Line (" o turn on checking for operators/attributes");
442 Write_Line (" O turn off checking for operators/attributes");
443 Write_Line (" p turn on checking for parameters");
444 Write_Line (" P turn off checking for parameters");
445 Write_Line (" r turn on checking for returns");
446 Write_Line (" R turn off checking for returns");
447 Write_Line (" s turn on checking for subscripts");
448 Write_Line (" S turn off checking for subscripts");
449 Write_Line (" t turn on checking for tests");
450 Write_Line (" T turn off checking for tests");
451 Write_Line (" n turn off all validity checks (including RM)");
453 -- Lines for -gnatw switch
455 Write_Switch_Char ("wxx");
456 Write_Line ("Enable selected warning modes, xx = list of parameters:");
457 Write_Line (" * indicates default setting");
458 Write_Line (" + indicates warning flag included in -gnatwa");
459 Write_Line (" a turn on all info/warnings marked below with +");
460 Write_Line (" A turn off all optional info/warnings");
461 Write_Line (" .a*+ turn on warnings for failing assertion");
462 Write_Line (" .A turn off warnings for failing assertion");
463 Write_Line (" b+ turn on warnings for bad fixed value " &
464 "(not multiple of small)");
465 Write_Line (" B* turn off warnings for bad fixed value " &
466 "(not multiple of small)");
467 Write_Line (" .b*+ turn on warnings for biased representation");
468 Write_Line (" .B turn off warnings for biased representation");
469 Write_Line (" c+ turn on warnings for constant conditional");
470 Write_Line (" C* turn off warnings for constant conditional");
471 Write_Line (" .c+ turn on warnings for unrepped components");
472 Write_Line (" .C* turn off warnings for unrepped components");
473 Write_Line (" d turn on warnings for implicit dereference");
474 Write_Line (" D* turn off warnings for implicit dereference");
476 -- Switches -gnatw.d/w.D not available on VMS
478 if not OpenVMS_On_Target then
480 (" .d turn on tagging of warnings with -gnatw switch");
482 (" .D* turn off tagging of warnings with -gnatw switch");
485 Write_Line (" e treat all warnings (but not info) as errors");
486 Write_Line (" .e turn on every optional info/warning " &
488 Write_Line (" f+ turn on warnings for unreferenced formal");
489 Write_Line (" F* turn off warnings for unreferenced formal");
490 Write_Line (" g*+ turn on warnings for unrecognized pragma");
491 Write_Line (" G turn off warnings for unrecognized pragma");
492 Write_Line (" h turn on warnings for hiding declarations");
493 Write_Line (" H* turn off warnings for hiding declarations");
494 Write_Line (" .h turn on warnings for holes in records");
495 Write_Line (" .H* turn off warnings for holes in records");
496 Write_Line (" i*+ turn on warnings for implementation unit");
497 Write_Line (" I turn off warnings for implementation unit");
498 Write_Line (" .i*+ turn on warnings for overlapping actuals");
499 Write_Line (" .I turn off warnings for overlapping actuals");
500 Write_Line (" j+ turn on warnings for obsolescent " &
501 "(annex J) feature");
502 Write_Line (" J* turn off warnings for obsolescent " &
503 "(annex J) feature");
504 Write_Line (" k+ turn on warnings on constant variable");
505 Write_Line (" K* turn off warnings on constant variable");
506 Write_Line (" .k turn on warnings for standard redefinition");
507 Write_Line (" .K* turn off warnings for standard redefinition");
508 Write_Line (" l turn on warnings for missing " &
509 "elaboration pragma");
510 Write_Line (" L* turn off warnings for missing " &
511 "elaboration pragma");
512 Write_Line (" .l turn on info messages for inherited aspects");
513 Write_Line (" .L* turn off info messages for inherited aspects");
514 Write_Line (" m+ turn on warnings for variable assigned " &
516 Write_Line (" M* turn off warnings for variable assigned " &
518 Write_Line (" .m* turn on warnings for suspicious modulus value");
519 Write_Line (" .M turn off warnings for suspicious modulus value");
520 Write_Line (" n* normal warning mode (cancels -gnatws/-gnatwe)");
521 Write_Line (" .n turn on info messages for atomic " &
523 Write_Line (" .N* turn off info messages for atomic " &
525 Write_Line (" o* turn on warnings for address clause overlay");
526 Write_Line (" O turn off warnings for address clause overlay");
527 Write_Line (" .o turn on warnings for out parameters assigned " &
529 Write_Line (" .O* turn off warnings for out parameters assigned " &
531 Write_Line (" p+ turn on warnings for ineffective pragma " &
532 "Inline in frontend");
533 Write_Line (" P* turn off warnings for ineffective pragma " &
534 "Inline in frontend");
535 Write_Line (" .p+ turn on warnings for suspicious parameter " &
537 Write_Line (" .P* turn off warnings for suspicious parameter " &
539 Write_Line (" q*+ turn on warnings for questionable " &
540 "missing parenthesis");
541 Write_Line (" Q turn off warnings for questionable " &
542 "missing parenthesis");
543 Write_Line (" r+ turn on warnings for redundant construct");
544 Write_Line (" R* turn off warnings for redundant construct");
545 Write_Line (" .r+ turn on warnings for object renaming function");
546 Write_Line (" .R* turn off warnings for object renaming function");
547 Write_Line (" s suppress all info/warnings");
548 Write_Line (" .s turn on warnings for overridden size clause");
549 Write_Line (" .S* turn off warnings for overridden size clause");
550 Write_Line (" t turn on warnings for tracking deleted code");
551 Write_Line (" T* turn off warnings for tracking deleted code");
552 Write_Line (" .t*+ turn on warnings for suspicious contract");
553 Write_Line (" .T turn off warnings for suspicious contract");
554 Write_Line (" u+ turn on warnings for unused entity");
555 Write_Line (" U* turn off warnings for unused entity");
556 Write_Line (" .u turn on warnings for unordered enumeration");
557 Write_Line (" .U* turn off warnings for unordered enumeration");
558 Write_Line (" v*+ turn on warnings for unassigned variable");
559 Write_Line (" V turn off warnings for unassigned variable");
560 Write_Line (" .v*+ turn on info messages for reverse bit order");
561 Write_Line (" .V turn off info messages for reverse bit order");
562 Write_Line (" w*+ turn on warnings for wrong low bound assumption");
563 Write_Line (" W turn off warnings for wrong low bound " &
565 Write_Line (" .w turn on warnings on pragma Warnings Off");
566 Write_Line (" .W* turn off warnings on pragma Warnings Off");
567 Write_Line (" x*+ turn on warnings for export/import");
568 Write_Line (" X turn off warnings for export/import");
569 Write_Line (" .x+ turn on warnings for non-local exception");
570 Write_Line (" .X* turn off warnings for non-local exception");
571 Write_Line (" y*+ turn on warnings for Ada compatibility issues");
572 Write_Line (" Y turn off warnings for Ada compatibility issues");
573 Write_Line (" z*+ turn on warnings for suspicious " &
574 "unchecked conversion");
575 Write_Line (" Z turn off warnings for suspicious " &
576 "unchecked conversion");
578 -- Line for -gnatW switch
580 Write_Switch_Char ("W?");
581 Write_Str ("Wide character encoding method (?=");
583 for J in WC_Encoding_Method loop
584 Write_Char (WC_Encoding_Letters (J));
586 if J = WC_Encoding_Method'Last then
595 -- Line for -gnatx switch
597 Write_Switch_Char ("x");
598 Write_Line ("Suppress output of cross-reference information");
600 -- Line for -gnatX switch
602 Write_Switch_Char ("X");
603 Write_Line ("Language extensions permitted");
605 -- Lines for -gnaty switch
607 Write_Switch_Char ("y");
608 Write_Line ("Enable default style checks (same as -gnaty3abcefhiklmnprst)");
609 Write_Switch_Char ("yxx");
610 Write_Line ("Enable selected style checks xx = list of parameters:");
611 Write_Line (" 1-9 check indentation");
612 Write_Line (" a check attribute casing");
613 Write_Line (" A check array attribute indexes");
614 Write_Line (" b check no blanks at end of lines");
615 Write_Line (" B check no use of AND/OR for boolean expressions");
616 Write_Line (" c check comment format (two spaces)");
617 Write_Line (" C check comment format (one space)");
618 Write_Line (" d check no DOS line terminators");
619 Write_Line (" e check end/exit labels present");
620 Write_Line (" f check no form feeds/vertical tabs in source");
621 Write_Line (" g check standard GNAT style rules");
622 Write_Line (" h check no horizontal tabs in source");
623 Write_Line (" i check if-then layout");
624 Write_Line (" I check mode in");
625 Write_Line (" k check casing rules for keywords");
626 Write_Line (" l check reference manual layout");
627 Write_Line (" Lnn check max nest level < nn ");
628 Write_Line (" m check line length <= 79 characters");
629 Write_Line (" n check casing of package Standard identifiers");
630 Write_Line (" Mnn check line length <= nn characters");
631 Write_Line (" N turn off all checks");
632 Write_Line (" o check subprogram bodies in alphabetical order");
633 Write_Line (" O check overriding indicators");
634 Write_Line (" p check pragma casing");
635 Write_Line (" r check casing for identifier references");
636 Write_Line (" s check separate subprogram specs present");
637 Write_Line (" S check separate lines after THEN or ELSE");
638 Write_Line (" t check token separation rules");
639 Write_Line (" u check no unnecessary blank lines");
640 Write_Line (" x check extra parentheses around conditionals");
641 Write_Line (" y turn on default style checks");
642 Write_Line (" - subtract (turn off) subsequent checks");
643 Write_Line (" + add (turn on) subsequent checks");
645 -- Lines for -gnatyN switch
647 Write_Switch_Char ("yN");
648 Write_Line ("Cancel all previously set style checks");
650 -- Lines for -gnatzc switch
652 Write_Switch_Char ("zc");
653 Write_Line ("Distribution stub generation for caller stubs");
655 -- Lines for -gnatzr switch
657 Write_Switch_Char ("zr");
658 Write_Line ("Distribution stub generation for receiver stubs");
660 -- Line for -gnat83 switch
662 Write_Switch_Char ("83");
663 Write_Line ("Ada 83 mode");
665 -- Line for -gnat95 switch
667 Write_Switch_Char ("95");
669 if Ada_Version_Default = Ada_95 then
670 Write_Line ("Ada 95 mode (default)");
672 Write_Line ("Ada 95 mode");
675 -- Line for -gnat2005 switch
677 Write_Switch_Char ("2005");
679 if Ada_Version_Default = Ada_2005 then
680 Write_Line ("Ada 2005 mode (default)");
682 Write_Line ("Ada 2005 mode");
685 -- Line for -gnat2012 switch
687 Write_Switch_Char ("2012");
689 if Ada_Version_Default = Ada_2012 then
690 Write_Line ("Ada 2012 mode (default)");
692 Write_Line ("Ada 2012 mode");
695 -- Line for -gnat-p switch
697 Write_Switch_Char ("-p");
698 Write_Line ("Cancel effect of previous -gnatp switch");