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