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)");
104 -- Common switches available to both GCC and JGNAT
106 Write_Switch_Char ("g ", "");
107 Write_Line ("Generate debugging information");
109 Write_Switch_Char ("Idir ", "");
110 Write_Line ("Specify source files search path");
112 Write_Switch_Char ("I- ", "");
113 Write_Line ("Do not look for sources in current directory");
115 Write_Switch_Char ("O[0123] ", "");
116 Write_Line ("Control the optimization level");
120 -- Individual lines for switches. Write_Switch_Char outputs fourteen
121 -- characters, so the remaining message is allowed to be a maximum
122 -- of 65 characters to be comfortable on an 80 character device.
123 -- If the Write_Str fits on one line, it is short enough!
125 -- Line for -gnata switch
127 Write_Switch_Char ("a");
128 Write_Line ("Assertions enabled. Pragma Assert/Debug to be activated");
130 -- Line for -gnatA switch
132 Write_Switch_Char ("A");
133 Write_Line ("Avoid processing gnat.adc, if present file will be ignored");
135 -- Line for -gnatb switch
137 Write_Switch_Char ("b");
138 Write_Line ("Generate brief messages to stderr even if verbose mode set");
140 -- Line for -gnatc switch
142 Write_Switch_Char ("c");
143 Write_Line ("Check syntax and semantics only (no code generation)");
145 -- Line for -gnatd switch
147 Write_Switch_Char ("d?");
148 Write_Line ("Compiler debug option ? ([.]a-z,A-Z,0-9), see debug.adb");
150 -- Line for -gnatD switch
152 Write_Switch_Char ("D");
153 Write_Line ("Debug expanded generated code rather than source code");
155 -- Line for -gnatec switch
157 Write_Switch_Char ("ec=?");
158 Write_Line ("Specify configuration pragmas file, e.g. -gnatec=/x/f.adc");
160 -- Line for -gnateD switch
162 Write_Switch_Char ("eD?");
163 Write_Line ("Define or redefine preprocessing symbol, e.g. -gnateDsym=val");
165 -- Line for -gnatef switch
167 Write_Switch_Char ("ef");
168 Write_Line ("Full source path in brief error messages");
170 -- Line for -gnateI switch
172 Write_Switch_Char ("eInn");
173 Write_Line ("Index in multi-unit source, e.g. -gnateI2");
175 -- Line for -gnatem switch
177 Write_Switch_Char ("em=?");
178 Write_Line ("Specify mapping file, e.g. -gnatem=mapping");
180 -- Line for -gnatep switch
182 Write_Switch_Char ("ep=?");
183 Write_Line ("Specify preprocessing data file, e.g. -gnatep=prep.data");
185 -- Line for -gnatE switch
187 Write_Switch_Char ("E");
188 Write_Line ("Dynamic elaboration checking mode enabled");
190 -- Line for -gnatf switch
192 Write_Switch_Char ("f");
193 Write_Line ("Full errors. Verbose details, all undefined references");
195 -- Line for -gnatF switch
197 Write_Switch_Char ("F");
198 Write_Line ("Force all import/export external names to all uppercase");
200 -- Line for -gnatg switch
202 Write_Switch_Char ("g");
203 Write_Line ("GNAT implementation mode (used for compiling GNAT units)");
205 -- Line for -gnatG switch
207 Write_Switch_Char ("G");
208 Write_Line ("Output generated expanded code in source form");
210 -- Line for -gnath switch
212 Write_Switch_Char ("h");
213 Write_Line ("Output this usage (help) information");
215 -- Line for -gnati switch
217 Write_Switch_Char ("i?");
218 Write_Line ("Identifier char set (?=1/2/3/4/5/8/9/p/f/n/w)");
220 -- Line for -gnatI switch
222 Write_Switch_Char ("I");
223 Write_Line ("Ignore all representation clauses");
225 -- Line for -gnatj switch
227 Write_Switch_Char ("jnn");
228 Write_Line ("Format error and warning messages to fit nn character lines");
230 -- Line for -gnatk switch
232 Write_Switch_Char ("k");
233 Write_Line ("Limit file names to nn characters (k = krunch)");
235 -- Lines for -gnatl switch
237 Write_Switch_Char ("l");
238 Write_Line ("Output full source listing with embedded error messages");
239 Write_Switch_Char ("l=f");
240 Write_Line ("Output full source listing to specified file");
242 -- Line for -gnatL switch
244 Write_Switch_Char ("L");
245 Write_Line ("List corresponding source text in -gnatG or -gnatD output");
247 -- Line for -gnatm switch
249 Write_Switch_Char ("mnn");
250 Write_Line ("Limit number of detected errors to nn (1-999999)");
252 -- Line for -gnatn switch
254 Write_Switch_Char ("n");
255 Write_Line ("Inlining of subprograms (apply pragma Inline across units)");
257 -- Line for -gnatN switch
259 Write_Switch_Char ("N");
260 Write_Line ("Full (frontend) inlining of subprograms");
262 -- Line for -gnato switch
264 Write_Switch_Char ("o");
265 Write_Line ("Enable overflow checking (off by default)");
267 -- Line for -gnatO switch
269 Write_Switch_Char ("O nm ");
270 Write_Line ("Set name of output ali file (internal switch)");
272 -- Line for -gnatp switch
274 Write_Switch_Char ("p");
275 Write_Line ("Suppress all checks");
277 -- Line for -gnatP switch
279 Write_Switch_Char ("P");
280 Write_Line ("Generate periodic calls to System.Polling.Poll");
282 -- Line for -gnatq switch
284 Write_Switch_Char ("q");
285 Write_Line ("Don't quit, try semantics, even if parse errors");
287 -- Line for -gnatQ switch
289 Write_Switch_Char ("Q");
290 Write_Line ("Don't quit, write ali/tree file even if compile errors");
292 -- Lines for -gnatR switch
294 Write_Switch_Char ("R?");
295 Write_Line ("List rep info (?=0/1/2/3 for none/types/all/variable)");
296 Write_Switch_Char ("R?s");
297 Write_Line ("List rep info to file.rep instead of standard output");
299 -- Lines for -gnats switch
301 Write_Switch_Char ("s");
302 Write_Line ("Syntax check only");
304 -- Lines for -gnatS switch
306 Write_Switch_Char ("S");
307 Write_Line ("Print listing of package Standard");
309 -- Lines for -gnatt switch
311 Write_Switch_Char ("t");
312 Write_Line ("Tree output file to be generated");
314 -- Line for -gnatT switch
316 Write_Switch_Char ("Tnn");
317 Write_Line ("All compiler tables start at nn times usual starting size");
319 -- Line for -gnatu switch
321 Write_Switch_Char ("u");
322 Write_Line ("List units for this compilation");
324 -- Line for -gnatU switch
326 Write_Switch_Char ("U");
327 Write_Line ("Enable unique tag for error messages");
329 -- Line for -gnatv switch
331 Write_Switch_Char ("v");
332 Write_Line ("Verbose mode. Full error output with source lines to stdout");
334 -- Line for -gnatV switch
336 Write_Switch_Char ("Vxx");
338 ("Enable selected validity checking mode, xx = list of parameters:");
339 Write_Line (" a turn on all validity checking options");
340 Write_Line (" c turn on checking for copies");
341 Write_Line (" C turn off checking for copies");
342 Write_Line (" d turn on default (RM) checking");
343 Write_Line (" D turn off default (RM) checking");
344 Write_Line (" e turn on checking for elementary components");
345 Write_Line (" E turn off checking for elementary components");
346 Write_Line (" f turn on checking for floating-point");
347 Write_Line (" F turn off checking for floating-point");
348 Write_Line (" i turn on checking for in params");
349 Write_Line (" I turn off checking for in params");
350 Write_Line (" m turn on checking for in out params");
351 Write_Line (" M turn off checking for in out params");
352 Write_Line (" o turn on checking for operators/attributes");
353 Write_Line (" O turn off checking for operators/attributes");
354 Write_Line (" p turn on checking for parameters");
355 Write_Line (" P turn off checking for parameters");
356 Write_Line (" r turn on checking for returns");
357 Write_Line (" R turn off checking for returns");
358 Write_Line (" s turn on checking for subscripts");
359 Write_Line (" S turn off checking for subscripts");
360 Write_Line (" t turn on checking for tests");
361 Write_Line (" T turn off checking for tests");
362 Write_Line (" n turn off all validity checks (including RM)");
364 -- Lines for -gnatw switch
366 Write_Switch_Char ("wxx");
367 Write_Line ("Enable selected warning modes, xx = list of parameters:");
368 Write_Line (" a turn on all optional warnings " &
369 "(except dhl.ot.w)");
370 Write_Line (" A turn off all optional warnings");
371 Write_Line (" .a* turn on warnings for failing assertions");
372 Write_Line (" .A turn off warnings for failing assertions");
373 Write_Line (" b turn on warnings for bad fixed value " &
374 "(not multiple of small)");
375 Write_Line (" B* turn off warnings for bad fixed value " &
376 "(not multiple of small)");
377 Write_Line (" c turn on warnings for constant conditional");
378 Write_Line (" C* turn off warnings for constant conditional");
379 Write_Line (" .c turn on warnings for unrepped components");
380 Write_Line (" .C* turn off warnings for unrepped components");
381 Write_Line (" d turn on warnings for implicit dereference");
382 Write_Line (" D* turn off warnings for implicit dereference");
383 Write_Line (" e treat all warnings as errors");
384 Write_Line (" .e turn on every optional warning (no exceptions)");
385 Write_Line (" f turn on warnings for unreferenced formal");
386 Write_Line (" F* turn off warnings for unreferenced formal");
387 Write_Line (" g* turn on warnings for unrecognized pragma");
388 Write_Line (" G turn off warnings for unrecognized pragma");
389 Write_Line (" h turn on warnings for hiding variable ");
390 Write_Line (" H* turn off warnings for hiding variable");
391 Write_Line (" i* turn on warnings for implementation unit");
392 Write_Line (" I turn off warnings for implementation unit");
393 Write_Line (" j turn on warnings for obsolescent " &
394 "(annex J) feature");
395 Write_Line (" J* turn off warnings for obsolescent " &
396 "(annex J) feature");
397 Write_Line (" k turn on warnings on constant variable");
398 Write_Line (" K* turn off warnings on constant variable");
399 Write_Line (" l turn on warnings for missing " &
400 "elaboration pragma");
401 Write_Line (" L* turn off warnings for missing " &
402 "elaboration pragma");
403 Write_Line (" m turn on warnings for variable assigned " &
405 Write_Line (" M* turn off warnings for variable assigned " &
407 Write_Line (" n* normal warning mode (cancels -gnatws/-gnatwe)");
408 Write_Line (" o* turn on warnings for address clause overlay");
409 Write_Line (" O turn off warnings for address clause overlay");
410 Write_Line (" .o turn on warnings for out parameters assigned " &
412 Write_Line (" .O* turn off warnings for out parameters assigned " &
414 Write_Line (" p turn on warnings for ineffective pragma " &
415 "Inline in frontend");
416 Write_Line (" P* turn off warnings for ineffective pragma " &
417 "Inline in frontend");
418 Write_Line (" .p turn on warnings for suspicious parameter " &
420 Write_Line (" .P* turn off warnings for suspicious parameter " &
422 Write_Line (" q* turn on warnings for questionable " &
423 "missing parentheses");
424 Write_Line (" Q turn off warnings for questionable " &
425 "missing parentheses");
426 Write_Line (" r turn on warnings for redundant construct");
427 Write_Line (" R* turn off warnings for redundant construct");
428 Write_Line (" .r turn on warnings for object renaming function");
429 Write_Line (" .R* turn off warnings for object renaming function");
430 Write_Line (" s suppress all warnings");
431 Write_Line (" t turn on warnings for tracking deleted code");
432 Write_Line (" T* turn off warnings for tracking deleted code");
433 Write_Line (" u turn on warnings for unused entity");
434 Write_Line (" U* turn off warnings for unused entity");
435 Write_Line (" v* turn on warnings for unassigned variable");
436 Write_Line (" V turn off warnings for unassigned variable");
437 Write_Line (" w* turn on warnings for wrong low bound assumption");
438 Write_Line (" W turn off warnings for wrong low bound " &
440 Write_Line (" .w turn on warnings on pragma Warnings Off");
441 Write_Line (" .w* turn off warnings on pragma Warnings Off");
442 Write_Line (" x* turn on warnings for export/import");
443 Write_Line (" X turn off warnings for export/import");
444 Write_Line (" .x turn on warnings for non-local exceptions");
445 Write_Line (" .X* turn off warnings for non-local exceptions");
446 Write_Line (" y* turn on warnings for Ada 2005 incompatibility");
447 Write_Line (" Y turn off warnings for Ada 2005 incompatibility");
448 Write_Line (" z* turn on convention/size/align warnings for " &
449 "unchecked conversion");
450 Write_Line (" Z turn off convention/size/align warnings for " &
451 "unchecked conversion");
452 Write_Line (" * indicates default in above list");
454 -- Line for -gnatW switch
456 Write_Switch_Char ("W");
457 Write_Str ("Wide character encoding method (");
459 for J in WC_Encoding_Method loop
460 Write_Char (WC_Encoding_Letters (J));
462 if J = WC_Encoding_Method'Last then
471 -- Line for -gnatx switch
473 Write_Switch_Char ("x");
474 Write_Line ("Suppress output of cross-reference information");
476 -- Line for -gnatX switch
478 Write_Switch_Char ("X");
479 Write_Line ("Language extensions permitted");
481 -- Lines for -gnaty switch
483 Write_Switch_Char ("y");
484 Write_Line ("Enable default style checks (same as -gnaty3abcefhiklmnprst)");
485 Write_Switch_Char ("yxx");
486 Write_Line ("Enable selected style checks xx = list of parameters:");
487 Write_Line (" 1-9 check indentation");
488 Write_Line (" a check attribute casing");
489 Write_Line (" A check array attribute indexes");
490 Write_Line (" b check no blanks at end of lines");
491 Write_Line (" c check comment format");
492 Write_Line (" d check no DOS line terminators");
493 Write_Line (" e check end/exit labels present");
494 Write_Line (" f check no form feeds/vertical tabs in source");
495 Write_Line (" g check standard GNAT style rules");
496 Write_Line (" h check no horizontal tabs in source");
497 Write_Line (" i check if-then layout");
498 Write_Line (" I check mode in");
499 Write_Line (" k check casing rules for keywords");
500 Write_Line (" l check reference manual layout");
501 Write_Line (" Lnn check max nest level < nn ");
502 Write_Line (" m check line length <= 79 characters");
503 Write_Line (" n check casing of package Standard identifiers");
504 Write_Line (" Mnn check line length <= nn characters");
505 Write_Line (" N turn off all checks");
506 Write_Line (" o check subprogram bodies in alphabetical order");
507 Write_Line (" p check pragma casing");
508 Write_Line (" r check casing for identifier references");
509 Write_Line (" s check separate subprogram specs present");
510 Write_Line (" S check separate lines after THEN or ELSE");
511 Write_Line (" t check token separation rules");
512 Write_Line (" u check no unnecessary blank lines");
513 Write_Line (" x check extra parentheses around conditionals");
514 Write_Line (" y turn on default style checks");
515 Write_Line (" - subtract (turn off) subsequent checks");
516 Write_Line (" + add (turn on) subsequent checks");
518 -- Lines for -gnatyN switch
520 Write_Switch_Char ("yN");
521 Write_Line ("Cancel all previously set style checks");
523 -- Lines for -gnatz switch
525 Write_Switch_Char ("z");
526 Write_Line ("Distribution stub generation (r/c for receiver/caller stubs)");
528 -- Line for -gnat83 switch
530 Write_Switch_Char ("83");
531 Write_Line ("Enforce Ada 83 restrictions");
533 -- Line for -gnat95 switch
535 Write_Switch_Char ("95");
537 if Ada_Version_Default = Ada_95 then
538 Write_Line ("Ada 95 mode (default)");
540 Write_Line ("Enforce Ada 95 restrictions");
543 -- Line for -gnat05 switch
545 Write_Switch_Char ("05");
547 if Ada_Version_Default = Ada_05 then
548 Write_Line ("Ada 2005 mode (default)");
550 Write_Line ("Allow Ada 2005 extensions");