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 with Targparm; use Targparm;
27 with Namet; use Namet;
29 with Osint; use Osint;
30 with Output; use Output;
32 with System.WCh_Con; use System.WCh_Con;
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.
43 -----------------------
44 -- Write_Switch_Char --
45 -----------------------
47 procedure Write_Switch_Char (Sw : String; Prefix : String := "gnat") is
53 for J in 1 .. 12 - 3 - Prefix'Length - Sw'Length loop
56 end Write_Switch_Char;
58 -- Start of processing for Usage
63 -- For gnatmake, we are appending this information to the end of
64 -- the normal gnatmake output, so generate appropriate header
67 and then (Name_Buffer (Name_Len - 7 .. Name_Len) = "gnatmake"
69 Name_Buffer (Name_Len - 7 .. Name_Len) = "GNATMAKE")
72 Write_Line ("Compiler switches (passed to the compiler by gnatmake):");
77 Write_Str ("Usage: ");
80 Write_Str ("switches sfile");
86 Write_Line (" sfile Source file name");
91 -- Common GCC switches not available in JGNAT/MGNAT
93 if VM_Target = No_VM then
94 Write_Switch_Char ("fstack-check ", "");
95 Write_Line ("Generate stack checking code");
97 Write_Switch_Char ("fno-inline ", "");
98 Write_Line ("Inhibit all inlining (makes executable smaller)");
101 -- Common switches available to both GCC and JGNAT
103 Write_Switch_Char ("g ", "");
104 Write_Line ("Generate debugging information");
106 Write_Switch_Char ("Idir ", "");
107 Write_Line ("Specify source files search path");
109 Write_Switch_Char ("I- ", "");
110 Write_Line ("Do not look for sources in current directory");
112 Write_Switch_Char ("O[0123] ", "");
113 Write_Line ("Control the optimization level");
117 -- Individual lines for switches. Write_Switch_Char outputs fourteen
118 -- characters, so the remaining message is allowed to be a maximum
119 -- of 65 characters to be comfortable on an 80 character device.
120 -- If the Write_Str fits on one line, it is short enough!
122 -- Line for -gnata switch
124 Write_Switch_Char ("a");
125 Write_Line ("Assertions enabled. Pragma Assert/Debug to be activated");
127 -- Line for -gnatA switch
129 Write_Switch_Char ("A");
130 Write_Line ("Avoid processing gnat.adc, if present file will be ignored");
132 -- Line for -gnatb switch
134 Write_Switch_Char ("b");
135 Write_Line ("Generate brief messages to stderr even if verbose mode set");
137 -- Line for -gnatc switch
139 Write_Switch_Char ("c");
140 Write_Line ("Check syntax and semantics only (no code generation)");
142 -- Line for -gnatd switch
144 Write_Switch_Char ("d?");
145 Write_Line ("Compiler debug option ? ([.]a-z,A-Z,0-9), see debug.adb");
147 -- Line for -gnatD switch
149 Write_Switch_Char ("D");
150 Write_Line ("Debug expanded generated code rather than source code");
152 -- Line for -gnatec switch
154 Write_Switch_Char ("ec=?");
155 Write_Line ("Specify configuration pragmas file, e.g. -gnatec=/x/f.adc");
157 -- Line for -gnateD switch
159 Write_Switch_Char ("eD?");
160 Write_Line ("Define or redefine preprocessing symbol, e.g. -gnateDsym=val");
162 -- Line for -gnatef switch
164 Write_Switch_Char ("ef");
165 Write_Line ("Full source path in brief error messages");
167 -- Line for -gnateI switch
169 Write_Switch_Char ("eInn");
170 Write_Line ("Index in multi-unit source, e.g. -gnateI2");
172 -- Line for -gnatem switch
174 Write_Switch_Char ("em=?");
175 Write_Line ("Specify mapping file, e.g. -gnatem=mapping");
177 -- Line for -gnatep switch
179 Write_Switch_Char ("ep=?");
180 Write_Line ("Specify preprocessing data file, e.g. -gnatep=prep.data");
182 -- Line for -gnatE switch
184 Write_Switch_Char ("E");
185 Write_Line ("Dynamic elaboration checking mode enabled");
187 -- Line for -gnatf switch
189 Write_Switch_Char ("f");
190 Write_Line ("Full errors. Verbose details, all undefined references");
192 -- Line for -gnatF switch
194 Write_Switch_Char ("F");
195 Write_Line ("Force all import/export external names to all uppercase");
197 -- Line for -gnatg switch
199 Write_Switch_Char ("g");
200 Write_Line ("GNAT implementation mode (used for compiling GNAT units)");
202 -- Line for -gnatG switch
204 Write_Switch_Char ("G");
205 Write_Line ("Output generated expanded code in source form");
207 -- Line for -gnath switch
209 Write_Switch_Char ("h");
210 Write_Line ("Output this usage (help) information");
212 -- Line for -gnati switch
214 Write_Switch_Char ("i?");
215 Write_Line ("Identifier char set (?=1/2/3/4/5/8/9/p/f/n/w)");
217 -- Line for -gnatI switch
219 Write_Switch_Char ("I");
220 Write_Line ("Ignore all representation clauses");
222 -- Line for -gnatj switch
224 Write_Switch_Char ("jnn");
225 Write_Line ("Format error and warning messages to fit nn character lines");
227 -- Line for -gnatk switch
229 Write_Switch_Char ("k");
230 Write_Line ("Limit file names to nn characters (k = krunch)");
232 -- Lines for -gnatl switch
234 Write_Switch_Char ("l");
235 Write_Line ("Output full source listing with embedded error messages");
236 Write_Switch_Char ("l=f");
237 Write_Line ("Output full source listing to specified file");
239 -- Line for -gnatL switch
241 Write_Switch_Char ("L");
242 Write_Line ("List corresponding source text in -gnatG or -gnatD output");
244 -- Line for -gnatm switch
246 Write_Switch_Char ("mnn");
247 Write_Line ("Limit number of detected errors to nn (1-999999)");
249 -- Line for -gnatn switch
251 Write_Switch_Char ("n");
252 Write_Line ("Inlining of subprograms (apply pragma Inline across units)");
254 -- Line for -gnatN switch
256 Write_Switch_Char ("N");
257 Write_Line ("Full (frontend) inlining of subprograms");
259 -- Line for -gnato switch
261 Write_Switch_Char ("o");
262 Write_Line ("Enable overflow checking (off by default)");
264 -- Line for -gnatO switch
266 Write_Switch_Char ("O nm ");
267 Write_Line ("Set name of output ali file (internal switch)");
269 -- Line for -gnatp switch
271 Write_Switch_Char ("p");
272 Write_Line ("Suppress all checks");
274 -- Line for -gnatP switch
276 Write_Switch_Char ("P");
277 Write_Line ("Generate periodic calls to System.Polling.Poll");
279 -- Line for -gnatq switch
281 Write_Switch_Char ("q");
282 Write_Line ("Don't quit, try semantics, even if parse errors");
284 -- Line for -gnatQ switch
286 Write_Switch_Char ("Q");
287 Write_Line ("Don't quit, write ali/tree file even if compile errors");
289 -- Lines for -gnatR switch
291 Write_Switch_Char ("R?");
292 Write_Line ("List rep info (?=0/1/2/3 for none/types/all/variable)");
293 Write_Switch_Char ("R?s");
294 Write_Line ("List rep info to file.rep instead of standard output");
296 -- Lines for -gnats switch
298 Write_Switch_Char ("s");
299 Write_Line ("Syntax check only");
301 -- Lines for -gnatS switch
303 Write_Switch_Char ("S");
304 Write_Line ("Print listing of package Standard");
306 -- Lines for -gnatt switch
308 Write_Switch_Char ("t");
309 Write_Line ("Tree output file to be generated");
311 -- Line for -gnatT switch
313 Write_Switch_Char ("Tnn");
314 Write_Line ("All compiler tables start at nn times usual starting size");
316 -- Line for -gnatu switch
318 Write_Switch_Char ("u");
319 Write_Line ("List units for this compilation");
321 -- Line for -gnatU switch
323 Write_Switch_Char ("U");
324 Write_Line ("Enable unique tag for error messages");
326 -- Line for -gnatv switch
328 Write_Switch_Char ("v");
329 Write_Line ("Verbose mode. Full error output with source lines to stdout");
331 -- Line for -gnatV switch
333 Write_Switch_Char ("Vxx");
335 ("Enable selected validity checking mode, xx = list of parameters:");
336 Write_Line (" a turn on all validity checking options");
337 Write_Line (" c turn on checking for copies");
338 Write_Line (" C turn off checking for copies");
339 Write_Line (" d turn on default (RM) checking");
340 Write_Line (" D turn off default (RM) checking");
341 Write_Line (" e turn on checking for elementary components");
342 Write_Line (" E turn off checking for elementary components");
343 Write_Line (" f turn on checking for floating-point");
344 Write_Line (" F turn off checking for floating-point");
345 Write_Line (" i turn on checking for in params");
346 Write_Line (" I turn off checking for in params");
347 Write_Line (" m turn on checking for in out params");
348 Write_Line (" M turn off checking for in out params");
349 Write_Line (" o turn on checking for operators/attributes");
350 Write_Line (" O turn off checking for operators/attributes");
351 Write_Line (" p turn on checking for parameters");
352 Write_Line (" P turn off checking for parameters");
353 Write_Line (" r turn on checking for returns");
354 Write_Line (" R turn off checking for returns");
355 Write_Line (" s turn on checking for subscripts");
356 Write_Line (" S turn off checking for subscripts");
357 Write_Line (" t turn on checking for tests");
358 Write_Line (" T turn off checking for tests");
359 Write_Line (" n turn off all validity checks (including RM)");
361 -- Lines for -gnatw switch
363 Write_Switch_Char ("wxx");
364 Write_Line ("Enable selected warning modes, xx = list of parameters:");
365 Write_Line (" a turn on all optional warnings (except dhl.o.w)");
366 Write_Line (" A turn off all optional warnings");
367 Write_Line (" .a* turn on warnings for failing assertions");
368 Write_Line (" .A turn off warnings for failing assertions");
369 Write_Line (" b turn on warnings for bad fixed value " &
370 "(not multiple of small)");
371 Write_Line (" B* turn off warnings for bad fixed value " &
372 "(not multiple of small)");
373 Write_Line (" c turn on warnings for constant conditional");
374 Write_Line (" C* turn off warnings for constant conditional");
375 Write_Line (" .c turn on warnings for unrepped components");
376 Write_Line (" .C* turn off warnings for unrepped components");
377 Write_Line (" d turn on warnings for implicit dereference");
378 Write_Line (" D* turn off warnings for implicit dereference");
379 Write_Line (" e treat all warnings as errors");
380 Write_Line (" f turn on warnings for unreferenced formal");
381 Write_Line (" F* turn off warnings for unreferenced formal");
382 Write_Line (" g* turn on warnings for unrecognized pragma");
383 Write_Line (" G turn off warnings for unrecognized pragma");
384 Write_Line (" h turn on warnings for hiding variable ");
385 Write_Line (" H* turn off warnings for hiding variable");
386 Write_Line (" i* turn on warnings for implementation unit");
387 Write_Line (" I turn off warnings for implementation unit");
388 Write_Line (" j turn on warnings for obsolescent " &
389 "(annex J) feature");
390 Write_Line (" J* turn off warnings for obsolescent " &
391 "(annex J) feature");
392 Write_Line (" k turn on warnings on constant variable");
393 Write_Line (" K* turn off warnings on constant variable");
394 Write_Line (" l turn on warnings for missing " &
395 "elaboration pragma");
396 Write_Line (" L* turn off warnings for missing " &
397 "elaboration pragma");
398 Write_Line (" m turn on warnings for variable assigned " &
400 Write_Line (" M* turn off warnings for variable assigned " &
402 Write_Line (" n* normal warning mode (cancels -gnatws/-gnatwe)");
403 Write_Line (" o* turn on warnings for address clause overlay");
404 Write_Line (" O turn off warnings for address clause overlay");
405 Write_Line (" .o turn on warnings for out parameters assigned " &
407 Write_Line (" .O* turn off warnings for out parameters assigned " &
409 Write_Line (" p turn on warnings for ineffective pragma " &
410 "Inline in frontend");
411 Write_Line (" P* turn off warnings for ineffective pragma " &
412 "Inline in frontend");
413 Write_Line (" q* turn on warnings for questionable " &
414 "missing parentheses");
415 Write_Line (" Q turn off warnings for questionable " &
416 "missing parentheses");
417 Write_Line (" r turn on warnings for redundant construct");
418 Write_Line (" R* turn off warnings for redundant construct");
419 Write_Line (" .r turn on warnings for object renaming function");
420 Write_Line (" .R* turn off warnings for object renaming function");
421 Write_Line (" s suppress all warnings");
422 Write_Line (" t turn on warnings for tracking deleted code");
423 Write_Line (" T* turn off warnings for tracking deleted code");
424 Write_Line (" u turn on warnings for unused entity");
425 Write_Line (" U* turn off warnings for unused entity");
426 Write_Line (" v* turn on warnings for unassigned variable");
427 Write_Line (" V turn off warnings for unassigned variable");
428 Write_Line (" w* turn on warnings for wrong low bound assumption");
429 Write_Line (" W turn off warnings for wrong low bound " &
431 Write_Line (" .w turn on warnings on pragma Warnings Off");
432 Write_Line (" .w* turn off warnings on pragma Warnings Off");
433 Write_Line (" x* turn on warnings for export/import");
434 Write_Line (" X turn off warnings for export/import");
435 Write_Line (" .x turn on warnings for non-local exceptions");
436 Write_Line (" .X* turn off warnings for non-local exceptions");
437 Write_Line (" y* turn on warnings for Ada 2005 incompatibility");
438 Write_Line (" Y turn off warnings for Ada 2005 incompatibility");
439 Write_Line (" z* turn on convention/size/align warnings for " &
440 "unchecked conversion");
441 Write_Line (" Z turn off convention/size/align warnings for " &
442 "unchecked conversion");
443 Write_Line (" * indicates default in above list");
445 -- Line for -gnatW switch
447 Write_Switch_Char ("W");
448 Write_Str ("Wide character encoding method (");
450 for J in WC_Encoding_Method loop
451 Write_Char (WC_Encoding_Letters (J));
453 if J = WC_Encoding_Method'Last then
462 -- Line for -gnatx switch
464 Write_Switch_Char ("x");
465 Write_Line ("Suppress output of cross-reference information");
467 -- Line for -gnatX switch
469 Write_Switch_Char ("X");
470 Write_Line ("Language extensions permitted");
472 -- Lines for -gnaty switch
474 Write_Switch_Char ("y");
475 Write_Line ("Enable default style checks (same as -gnaty3abcefhiklmnprst)");
476 Write_Switch_Char ("yxx");
477 Write_Line ("Enable selected style checks xx = list of parameters:");
478 Write_Line (" 1-9 check indentation");
479 Write_Line (" a check attribute casing");
480 Write_Line (" A check array attribute indexes");
481 Write_Line (" b check no blanks at end of lines");
482 Write_Line (" c check comment format");
483 Write_Line (" d check no DOS line terminators");
484 Write_Line (" e check end/exit labels present");
485 Write_Line (" f check no form feeds/vertical tabs in source");
486 Write_Line (" g check standard GNAT style rules");
487 Write_Line (" h check no horizontal tabs in source");
488 Write_Line (" i check if-then layout");
489 Write_Line (" I check mode in");
490 Write_Line (" k check casing rules for keywords");
491 Write_Line (" l check reference manual layout");
492 Write_Line (" Lnn check max nest level < nn ");
493 Write_Line (" m check line length <= 79 characters");
494 Write_Line (" n check casing of package Standard identifiers");
495 Write_Line (" Mnn check line length <= nn characters");
496 Write_Line (" o check subprogram bodies in alphabetical order");
497 Write_Line (" p check pragma casing");
498 Write_Line (" r check casing for identifier references");
499 Write_Line (" s check separate subprogram specs present");
500 Write_Line (" S check separate lines after THEN or ELSE");
501 Write_Line (" t check token separation rules");
502 Write_Line (" u check no unnecessary blank lines");
503 Write_Line (" x check extra parentheses around conditionals");
505 -- Lines for -gnatyN switch
507 Write_Switch_Char ("yN");
508 Write_Line ("Cancel all previously set style checks");
510 -- Lines for -gnatz switch
512 Write_Switch_Char ("z");
513 Write_Line ("Distribution stub generation (r/c for receiver/caller stubs)");
515 -- Line for -gnat83 switch
517 Write_Switch_Char ("83");
518 Write_Line ("Enforce Ada 83 restrictions");
520 -- Line for -gnat95 switch
522 Write_Switch_Char ("95");
524 if Ada_Version_Default = Ada_95 then
525 Write_Line ("Ada 95 mode (default)");
527 Write_Line ("Enforce Ada 95 restrictions");
530 -- Line for -gnat05 switch
532 Write_Switch_Char ("05");
534 if Ada_Version_Default = Ada_05 then
535 Write_Line ("Ada 2005 mode (default)");
537 Write_Line ("Allow Ada 2005 extensions");