1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2008, 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
42 -- enough blanks to tab to column 13, i.e. assuming Sw is not longer
43 -- than 5 characters, the maximum allowed, Write_Switch_Char will
44 -- always output 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 in JGNAT/MGNAT
96 if VM_Target = No_VM 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 -gnatd switch
155 Write_Switch_Char ("d?");
156 Write_Line ("Compiler debug option ? ([.]a-z,A-Z,0-9), see debug.adb");
158 -- Line for -gnatD switch
160 Write_Switch_Char ("D");
161 Write_Line ("Debug expanded generated code (max line length = 72)");
162 Write_Switch_Char ("Dnn");
163 Write_Line ("Debug expanded generated code (max line length = nn)");
165 -- Line for -gnatec switch
167 Write_Switch_Char ("ec=?");
168 Write_Line ("Specify configuration pragmas file, e.g. -gnatec=/x/f.adc");
170 -- Line for -gnateD switch
172 Write_Switch_Char ("eD?");
173 Write_Line ("Define or redefine preprocessing symbol, e.g. -gnateDsym=val");
175 -- Line for -gnatef switch
177 Write_Switch_Char ("ef");
178 Write_Line ("Full source path in brief error messages");
180 -- Line for -gnateG switch
182 Write_Switch_Char ("eG");
183 Write_Line ("Generate preprocessed source");
185 -- Line for -gnateI switch
187 Write_Switch_Char ("eInn");
188 Write_Line ("Index in multi-unit source, e.g. -gnateI2");
190 -- Line for -gnatem switch
192 Write_Switch_Char ("em=?");
193 Write_Line ("Specify mapping file, e.g. -gnatem=mapping");
195 -- Line for -gnatep switch
197 Write_Switch_Char ("ep=?");
198 Write_Line ("Specify preprocessing data file, e.g. -gnatep=prep.data");
200 -- Line for -gnatE switch
202 Write_Switch_Char ("E");
203 Write_Line ("Dynamic elaboration checking mode enabled");
205 -- Line for -gnatf switch
207 Write_Switch_Char ("f");
208 Write_Line ("Full errors. Verbose details, all undefined references");
210 -- Line for -gnatF switch
212 Write_Switch_Char ("F");
213 Write_Line ("Force all import/export external names to all uppercase");
215 -- Line for -gnatg switch
217 Write_Switch_Char ("g");
218 Write_Line ("GNAT implementation mode (used for compiling GNAT units)");
220 -- Lines for -gnatG switch
222 Write_Switch_Char ("G");
223 Write_Line ("Output generated expanded code (max line length = 72)");
224 Write_Switch_Char ("Gnn");
225 Write_Line ("Output generated expanded code (max line length = nn)");
227 -- Line for -gnath switch
229 Write_Switch_Char ("h");
230 Write_Line ("Output this usage (help) information");
232 -- Line for -gnati switch
234 Write_Switch_Char ("i?");
235 Write_Line ("Identifier char set (?=1/2/3/4/5/8/9/p/f/n/w)");
237 -- Line for -gnatI switch
239 Write_Switch_Char ("I");
240 Write_Line ("Ignore all representation clauses");
242 -- Line for -gnatj switch
244 Write_Switch_Char ("jnn");
245 Write_Line ("Format error and warning messages to fit nn character lines");
247 -- Line for -gnatk switch
249 Write_Switch_Char ("k");
250 Write_Line ("Limit file names to nn characters (k = krunch)");
252 -- Lines for -gnatl switch
254 Write_Switch_Char ("l");
255 Write_Line ("Output full source listing with embedded error messages");
256 Write_Switch_Char ("l=f");
257 Write_Line ("Output full source listing to specified file");
259 -- Line for -gnatL switch
261 Write_Switch_Char ("L");
262 Write_Line ("List corresponding source text in -gnatG or -gnatD output");
264 -- Line for -gnatm switch
266 Write_Switch_Char ("mnn");
267 Write_Line ("Limit number of detected errors/warnings to nn (1-999999)");
269 -- Line for -gnatn switch
271 Write_Switch_Char ("n");
272 Write_Line ("Inlining of subprograms (apply pragma Inline across units)");
274 -- Line for -gnatN switch
276 Write_Switch_Char ("N");
277 Write_Line ("Full (frontend) inlining of subprograms");
279 -- Line for -gnato switch
281 Write_Switch_Char ("o");
282 Write_Line ("Enable overflow checking (off by default)");
284 -- Line for -gnatO switch
286 Write_Switch_Char ("O nm ");
287 Write_Line ("Set name of output ali file (internal switch)");
289 -- Line for -gnatp switch
291 Write_Switch_Char ("p");
292 Write_Line ("Suppress all checks");
294 -- Line for -gnatP switch
296 Write_Switch_Char ("P");
297 Write_Line ("Generate periodic calls to System.Polling.Poll");
299 -- Line for -gnatq switch
301 Write_Switch_Char ("q");
302 Write_Line ("Don't quit, try semantics, even if parse errors");
304 -- Line for -gnatQ switch
306 Write_Switch_Char ("Q");
307 Write_Line ("Don't quit, write ali/tree file even if compile errors");
309 -- Line for -gnatr switch
311 Write_Switch_Char ("r");
312 Write_Line ("Treat pragma Restrictions as Restriction_Warnings");
314 -- Lines for -gnatR switch
316 Write_Switch_Char ("R?");
317 Write_Line ("List rep info (?=0/1/2/3 for none/types/all/variable)");
318 Write_Switch_Char ("R?s");
319 Write_Line ("List rep info to file.rep instead of standard output");
321 -- Lines for -gnats switch
323 Write_Switch_Char ("s");
324 Write_Line ("Syntax check only");
326 -- Lines for -gnatS switch
328 Write_Switch_Char ("S");
329 Write_Line ("Print listing of package Standard");
331 -- Lines for -gnatt switch
333 Write_Switch_Char ("t");
334 Write_Line ("Tree output file to be generated");
336 -- Line for -gnatT switch
338 Write_Switch_Char ("Tnn");
339 Write_Line ("All compiler tables start at nn times usual starting size");
341 -- Line for -gnatu switch
343 Write_Switch_Char ("u");
344 Write_Line ("List units for this compilation");
346 -- Line for -gnatU switch
348 Write_Switch_Char ("U");
349 Write_Line ("Enable unique tag for error messages");
351 -- Line for -gnatv switch
353 Write_Switch_Char ("v");
354 Write_Line ("Verbose mode. Full error output with source lines to stdout");
356 -- Line for -gnatV switch
358 Write_Switch_Char ("Vxx");
360 ("Enable selected validity checking mode, xx = list of parameters:");
361 Write_Line (" a turn on all validity checking options");
362 Write_Line (" c turn on checking for copies");
363 Write_Line (" C turn off checking for copies");
364 Write_Line (" d turn on default (RM) checking");
365 Write_Line (" D turn off default (RM) checking");
366 Write_Line (" e turn on checking for elementary components");
367 Write_Line (" E turn off checking for elementary components");
368 Write_Line (" f turn on checking for floating-point");
369 Write_Line (" F turn off checking for floating-point");
370 Write_Line (" i turn on checking for in params");
371 Write_Line (" I turn off checking for in params");
372 Write_Line (" m turn on checking for in out params");
373 Write_Line (" M turn off checking for in out params");
374 Write_Line (" o turn on checking for operators/attributes");
375 Write_Line (" O turn off checking for operators/attributes");
376 Write_Line (" p turn on checking for parameters");
377 Write_Line (" P turn off checking for parameters");
378 Write_Line (" r turn on checking for returns");
379 Write_Line (" R turn off checking for returns");
380 Write_Line (" s turn on checking for subscripts");
381 Write_Line (" S turn off checking for subscripts");
382 Write_Line (" t turn on checking for tests");
383 Write_Line (" T turn off checking for tests");
384 Write_Line (" n turn off all validity checks (including RM)");
386 -- Lines for -gnatw switch
388 Write_Switch_Char ("wxx");
389 Write_Line ("Enable selected warning modes, xx = list of parameters:");
390 Write_Line (" a turn on all optional warnings " &
391 "(except dhl.ot.w)");
392 Write_Line (" A turn off all optional warnings");
393 Write_Line (" .a* turn on warnings for failing assertion");
394 Write_Line (" .A turn off warnings for failing assertion");
395 Write_Line (" b turn on warnings for bad fixed value " &
396 "(not multiple of small)");
397 Write_Line (" B* turn off warnings for bad fixed value " &
398 "(not multiple of small)");
399 Write_Line (" .b* turn on warnings for biased representation");
400 Write_Line (" .B turn off warnings for biased representation");
401 Write_Line (" c turn on warnings for constant conditional");
402 Write_Line (" C* turn off warnings for constant conditional");
403 Write_Line (" .c turn on warnings for unrepped components");
404 Write_Line (" .C* turn off warnings for unrepped components");
405 Write_Line (" d turn on warnings for implicit dereference");
406 Write_Line (" D* turn off warnings for implicit dereference");
407 Write_Line (" e treat all warnings as errors");
408 Write_Line (" .e turn on every optional warning (no exceptions)");
409 Write_Line (" f turn on warnings for unreferenced formal");
410 Write_Line (" F* turn off warnings for unreferenced formal");
411 Write_Line (" g* turn on warnings for unrecognized pragma");
412 Write_Line (" G turn off warnings for unrecognized pragma");
413 Write_Line (" h turn on warnings for hiding variable");
414 Write_Line (" H* turn off warnings for hiding variable");
415 Write_Line (" i* turn on warnings for implementation unit");
416 Write_Line (" I turn off warnings for implementation unit");
417 Write_Line (" j turn on warnings for obsolescent " &
418 "(annex J) feature");
419 Write_Line (" J* turn off warnings for obsolescent " &
420 "(annex J) feature");
421 Write_Line (" k turn on warnings on constant variable");
422 Write_Line (" K* turn off warnings on constant variable");
423 Write_Line (" l turn on warnings for missing " &
424 "elaboration pragma");
425 Write_Line (" L* turn off warnings for missing " &
426 "elaboration pragma");
427 Write_Line (" m turn on warnings for variable assigned " &
429 Write_Line (" M* turn off warnings for variable assigned " &
431 Write_Line (" n* normal warning mode (cancels -gnatws/-gnatwe)");
432 Write_Line (" o* turn on warnings for address clause overlay");
433 Write_Line (" O turn off warnings for address clause overlay");
434 Write_Line (" .o turn on warnings for out parameters assigned " &
436 Write_Line (" .O* turn off warnings for out parameters assigned " &
438 Write_Line (" p turn on warnings for ineffective pragma " &
439 "Inline in frontend");
440 Write_Line (" P* turn off warnings for ineffective pragma " &
441 "Inline in frontend");
442 Write_Line (" .p turn on warnings for suspicious parameter " &
444 Write_Line (" .P* turn off warnings for suspicious parameter " &
446 Write_Line (" q* turn on warnings for questionable " &
447 "missing parenthesis");
448 Write_Line (" Q turn off warnings for questionable " &
449 "missing parenthesis");
450 Write_Line (" r turn on warnings for redundant construct");
451 Write_Line (" R* turn off warnings for redundant construct");
452 Write_Line (" .r turn on warnings for object renaming function");
453 Write_Line (" .R* turn off warnings for object renaming function");
454 Write_Line (" s suppress all warnings");
455 Write_Line (" t turn on warnings for tracking deleted code");
456 Write_Line (" T* turn off warnings for tracking deleted code");
457 Write_Line (" u turn on warnings for unused entity");
458 Write_Line (" U* turn off warnings for unused entity");
459 Write_Line (" v* turn on warnings for unassigned variable");
460 Write_Line (" V turn off warnings for unassigned variable");
461 Write_Line (" w* turn on warnings for wrong low bound assumption");
462 Write_Line (" W turn off warnings for wrong low bound " &
464 Write_Line (" .w turn on warnings on pragma Warnings Off");
465 Write_Line (" .w* turn off warnings on pragma Warnings Off");
466 Write_Line (" x* turn on warnings for export/import");
467 Write_Line (" X turn off warnings for export/import");
468 Write_Line (" .x turn on warnings for non-local exception");
469 Write_Line (" .X* turn off warnings for non-local exception");
470 Write_Line (" y* turn on warnings for Ada 2005 incompatibility");
471 Write_Line (" Y turn off warnings for Ada 2005 incompatibility");
472 Write_Line (" z* turn on warnings for suspicious " &
473 "unchecked conversion");
474 Write_Line (" Z turn off warnings for suspicious " &
475 "unchecked conversion");
476 Write_Line (" * indicates default in above list");
478 -- Line for -gnatW switch
480 Write_Switch_Char ("W");
481 Write_Str ("Wide character encoding method (");
483 for J in WC_Encoding_Method loop
484 Write_Char (WC_Encoding_Letters (J));
486 if J = WC_Encoding_Method'Last then
495 -- Line for -gnatx switch
497 Write_Switch_Char ("x");
498 Write_Line ("Suppress output of cross-reference information");
500 -- Line for -gnatX switch
502 Write_Switch_Char ("X");
503 Write_Line ("Language extensions permitted");
505 -- Lines for -gnaty switch
507 Write_Switch_Char ("y");
508 Write_Line ("Enable default style checks (same as -gnaty3abcefhiklmnprst)");
509 Write_Switch_Char ("yxx");
510 Write_Line ("Enable selected style checks xx = list of parameters:");
511 Write_Line (" 1-9 check indentation");
512 Write_Line (" a check attribute casing");
513 Write_Line (" A check array attribute indexes");
514 Write_Line (" b check no blanks at end of lines");
515 Write_Line (" c check comment format");
516 Write_Line (" d check no DOS line terminators");
517 Write_Line (" e check end/exit labels present");
518 Write_Line (" f check no form feeds/vertical tabs in source");
519 Write_Line (" g check standard GNAT style rules");
520 Write_Line (" h check no horizontal tabs in source");
521 Write_Line (" i check if-then layout");
522 Write_Line (" I check mode in");
523 Write_Line (" k check casing rules for keywords");
524 Write_Line (" l check reference manual layout");
525 Write_Line (" Lnn check max nest level < nn ");
526 Write_Line (" m check line length <= 79 characters");
527 Write_Line (" n check casing of package Standard identifiers");
528 Write_Line (" Mnn check line length <= nn characters");
529 Write_Line (" N turn off all checks");
530 Write_Line (" o check subprogram bodies in alphabetical order");
531 Write_Line (" O check overriding indicators");
532 Write_Line (" p check pragma casing");
533 Write_Line (" r check casing for identifier references");
534 Write_Line (" s check separate subprogram specs present");
535 Write_Line (" S check separate lines after THEN or ELSE");
536 Write_Line (" t check token separation rules");
537 Write_Line (" u check no unnecessary blank lines");
538 Write_Line (" x check extra parentheses around conditionals");
539 Write_Line (" y turn on default style checks");
540 Write_Line (" - subtract (turn off) subsequent checks");
541 Write_Line (" + add (turn on) subsequent checks");
543 -- Lines for -gnatyN switch
545 Write_Switch_Char ("yN");
546 Write_Line ("Cancel all previously set style checks");
548 -- Lines for -gnatz switch
550 Write_Switch_Char ("z");
551 Write_Line ("Distribution stub generation (r/c for receiver/caller stubs)");
553 -- Line for -gnat83 switch
555 Write_Switch_Char ("83");
556 Write_Line ("Enforce Ada 83 restrictions");
558 -- Line for -gnat95 switch
560 Write_Switch_Char ("95");
562 if Ada_Version_Default = Ada_95 then
563 Write_Line ("Ada 95 mode (default)");
565 Write_Line ("Enforce Ada 95 restrictions");
568 -- Line for -gnat05 switch
570 Write_Switch_Char ("05");
572 if Ada_Version_Default = Ada_05 then
573 Write_Line ("Ada 2005 mode (default)");
575 Write_Line ("Allow Ada 2005 extensions");