| blob | a78a3dbf6034fe20706f8b36c34f39d46a91b4b1 |
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- V M S _ D A T A --
6 -- --
7 -- S p e c --
8 -- --
9 -- Copyright (C) 1996-2007, 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 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. --
20 -- --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
23 -- --
24 ------------------------------------------------------------------------------
26 -- This package contains, for each of the command of the GNAT driver, one
27 -- constant array; each component of this array is a string that defines,
28 -- in coded form as explained below, the conversion of a VMS qualifier of the
29 -- command to the corresponding switch of the GNAT tool corresponding to the
30 -- command.
32 -- This package is used by the GNAT driver to invokes the GNAT tools with the
33 -- switches corresponding to the VMS qualifier and by the Project Manager to
34 -- convert VMS qualifiers in project files to their corresponding switch
35 -- values.
37 -- This package is also an input to the tool that generates the VMS GNAT
38 -- help information automatically.
40 -- NOTE: the format of this package must follow the following rules, so that
41 -- the VMS GNAT help tool works properly:
43 -- - Each command zone (where the eventual qualifiers are declared must
44 -- begin with a boxed comment of the form:
46 -- ---------------------------------
47 -- -- Switches for GNAT <COMMAND> --
48 -- ---------------------------------
50 -- where <COMMAND> is the name of a GNAT command in capital letters, for
51 -- example BIND, COMPILE, XREF, ...
53 -- - each qualifier declaration must be followed either by
54 -- - a comment starting with "-- NODOC", to indicate that there is
55 -- no documentation for this qualifier, or
56 -- - a contiguous sequence of comments that constitute the
57 -- documentation of the qualifier.
59 -- - each command zone ends with the declaration of the contant array
60 -- for the command, of the form:
62 -- <Command>__Switches : aliased constant Switches :=
66 ----------------
67 -- QUALIFIERS --
68 ----------------
70 -- The syntax of a qualifier delaration is as follows:
72 -- SWITCH_STRING ::= "/ command-qualifier-name TRANSLATION"
74 -- TRANSLATION ::=
75 -- DIRECT_TRANSLATION
76 -- | DIRECTORIES_TRANSLATION
77 -- | FILE_TRANSLATION
78 -- | NO_SPACE_FILE_TRANSL
79 -- | NUMERIC_TRANSLATION
80 -- | STRING_TRANSLATION
81 -- | OPTIONS_TRANSLATION
82 -- | COMMANDS_TRANSLATION
83 -- | ALPHANUMPLUS_TRANSLATION
84 -- | OTHER_TRANSLATION
86 -- DIRECT_TRANSLATION ::= space UNIX_SWITCHES
87 -- DIRECTORIES_TRANSLATION ::= =* UNIX_SWITCH *
88 -- DIRECTORY_TRANSLATION ::= =% UNIX_SWITCH %
89 -- FILE_TRANSLATION ::= =@ UNIX_SWITCH @
90 -- NO_SPACE_FILE_TRANSL ::= =< UNIX_SWITCH >
91 -- NUMERIC_TRANSLATION ::= =# UNIX_SWITCH # | # number #
92 -- STRING_TRANSLATION ::= =" UNIX_SWITCH "
93 -- OPTIONS_TRANSLATION ::= =OPTION {space OPTION}
94 -- COMMANDS_TRANSLATION ::= =? ARGS space command-name
95 -- ALPHANUMPLUS_TRANSLATION ::= =| UNIX_SWITCH |
97 -- UNIX_SWITCHES ::= UNIX_SWITCH {, UNIX_SWITCH}
99 -- UNIX_SWITCH ::= unix-switch-string | !unix-switch-string | `string'
101 -- OPTION ::= option-name space UNIX_SWITCHES
103 -- ARGS ::= -cargs | -bargs | -largs
105 -- Here command-qual is the name of the switch recognized by the GNATCmd.
106 -- This is always given in upper case in the templates, although in the
107 -- actual commands, either upper or lower case is allowed.
109 -- The unix-switch-string always starts with a minus, and has no commas
110 -- or spaces in it. Case is significant in the unix switch string. If a
111 -- unix switch string is preceded by the not sign (!) it means that the
112 -- effect of the corresponding command qualifer is to remove any previous
113 -- occurrence of the given switch in the command line.
115 -- The DIRECTORIES_TRANSLATION format is used where a list of directories
116 -- is given. This possible corresponding formats recognized by GNATCmd are
117 -- as shown by the following example for the case of PATH
119 -- PATH=direc
120 -- PATH=(direc,direc,direc,direc)
122 -- When more than one directory is present for the DIRECTORIES case, then
123 -- multiple instances of the corresponding unix switch are generated,
124 -- with the file name being substituted for the occurrence of *.
126 -- The FILE_TRANSLATION format is similar except that only a single
127 -- file is allowed, not a list of files, and only one unix switch is
128 -- generated as a result.
130 -- the NO_SPACE_FILE_TRANSL is similar to FILE_TRANSLATION, except that
131 -- no space is inserted between the switch and the file name.
133 -- The NUMERIC_TRANSLATION format is similar to the FILE_TRANSLATION case
134 -- except that the parameter is a decimal integer in the range 0 to 999.
136 -- For the OPTIONS_TRANSLATION case, GNATCmd similarly permits one or
137 -- more options to appear (although only in some cases does the use of
138 -- multiple options make logical sense). For example, taking the
139 -- case of ERRORS for GCC, the following are all allowed:
141 -- /ERRORS=BRIEF
142 -- /ERRORS=(FULL,VERBOSE)
143 -- /ERRORS=(BRIEF IMMEDIATE)
145 -- If no option is provided (e.g. just /ERRORS is written), then the
146 -- first option in the list is the default option. For /ERRORS this
147 -- is NORMAL, so /ERRORS with no option is equivalent to /ERRORS=NORMAL.
149 -- The COMMANDS_TRANSLATION case is only used for gnatmake, to correspond
150 -- to the use of -cargs, -bargs and -largs (the ARGS string as indicated
151 -- is one of these three possibilities). The name given by COMMAND is the
152 -- corresponding command name to be used to interprete the switches to be
153 -- passed on. Switches of this type set modes, e.g. /COMPILER_QUALIFIERS
154 -- sets the mode so that all subsequent switches, up to another switch
155 -- with COMMANDS_TRANSLATION apply to the corresponding commands issued
156 -- by the make utility. For example
158 -- /COMPILER_QUALIFIERS /LIST /BINDER_QUALIFIERS /MAIN
159 -- /COMPILER_QUALIFIERS /NOLIST /COMPILE_CHECKS=SYNTAX
161 -- Clearly these switches must come at the end of the list of switches
162 -- since all subsequent switches apply to an issued command.
164 -- For the DIRECT_TRANSLATION case, an implicit additional qualifier
165 -- declaration is created by prepending NO to the name of the qualifer,
166 -- and then inverting the sense of the UNIX_SWITCHES string. For example,
167 -- given the qualifier definition:
169 -- "/LIST -gnatl"
171 -- An implicit qualifier definition is created:
173 -- "/NOLIST !-gnatl"
175 -- In the case where, a ! is already present, inverting the sense of the
176 -- switch means removing it.
179 -- A synonym to shorten the table
182 -- String pointer type used throughout
185 -- Type used for array of swtiches
189 ----------------------------
190 -- Switches for GNAT BIND --
191 ----------------------------
195 -- /ADD_PROJECT_SEARCH_PATH==(directory[,...])
196 --
197 -- Add directories to the project search path.
204 -- /BIND_FILE[=bind-file-option]
205 --
206 -- Specifies the language of the binder generated file.
207 --
208 -- ADA (D) Binder file is Ada.
209 --
210 -- C Binder file is 'C'.
214 -- /BUILD_LIBRARY=xxx
215 --
216 -- Binds the units for library building. In this case the adainit and
217 -- adafinal procedures are rename to xxxinit and xxxfinal. Implies
218 -- /NOMAIN.
222 -- /CURRENT_DIRECTORY (D)
223 -- /NOCURRENT_DIRECTORY
224 --
225 -- Look for source, library or object files in the default directory.
242 -- /DEBUG[=debug-level]
243 -- /NODEBUG
244 --
245 -- Specify level of debugging information generated for the elaboration
246 -- routine. See corresponding qualifier for GNAT COMPILE.
250 -- NODOC (see /DEBUG)
254 -- /ELABORATION_DEPENDENCIES
255 -- /NOELABORATION_DEPENDENCIES (D)
256 --
257 -- Output complete list of elaboration-order dependencies, showing the
258 -- reason for each dependency. This output can be rather extensive but may
259 -- be useful in diagnosing problems with elaboration order. The output is
260 -- written to SYS$OUTPUT.
264 -- /ERROR_LIMIT=nnn
265 --
266 -- Limit number of detected errors to nnn (1-999999).
270 -- /EXTERNAL_REFERENCE="name=val"
271 --
272 -- Specifies an external reference to the project manager. Useful only if
273 -- /PROJECT_FILE is used.
274 --
275 -- Example:
276 -- /EXTERNAL_REFERENCE="DEBUG=TRUE"
280 -- /NOFORCE_ELAB_FLAGS (D)
281 -- /FORCE_ELAB_FLAGS
282 --
283 -- Force checking of elaboration Flags
287 -- /HELP
288 --
289 -- Output usage information.
298 -- /INITIALIZE_SCALARS[=scalar-option]
299 --
300 -- Indicate how uninitialized scalar values for which a pragma
301 -- Initialize_Scalars applies should be initialized.
302 -- scalar-option may be one of the following:
303 --
304 -- INVALID (D) Initialize with an invalid value.
305 -- LOW Initialize with the lowest valid value of the subtype.
306 -- HIGH Initialize with the highest valid value of the subtype.
310 -- /ENABLE_LEAP_SECONDS
311 -- /NOENABLE_LEAP_SECONDS (D)
312 --
313 -- Enable leap seconds support in Ada.Calendar and its children.
317 -- /LIBRARY_SEARCH=(direc[,...])
318 --
319 -- When looking for library and object files look also in directories
320 -- specified.
324 -- /NOLINKER_OPTION_LIST (D)
325 -- /LINKER_OPTION_LIST
326 --
327 -- Output linker options to SYS$OUTPUT. Includes library search
328 -- paths, contents of pragmas Ident and Linker_Options, and
329 -- libraries added by GNAT BIND.
333 -- /MAIN (D)
334 --
335 -- The main program is in Ada.
336 --
337 -- /NOMAIN
338 --
339 -- The main program is not in Ada.
348 -- /MESSAGES_PROJECT_FILE[=messages-option]
349 --
350 -- Specifies the "verbosity" of the parsing of project files.
351 -- messages-option may be one of the following:
352 --
353 -- DEFAULT (D) No messages are output if there is no error or warning.
354 --
355 -- MEDIUM A small number of messages are output.
356 --
357 -- HIGH A great number of messages are output, most of them not
358 -- being useful for the user.
362 -- /NOSTD_INCLUDES
363 --
364 -- Do not look for sources the in the system default directory.
368 -- /NOSTD_LIBRARIES
369 --
370 -- Do not look for library files in the system default directory.
374 -- NODOC (see /TIME_STAMP_CHECK)
378 -- /NOOBJECT_LIST (D)
379 -- /OBJECT_LIST
380 --
381 -- Output full names of all the object files that must be linker to
382 -- provide the Ada component of the program. The output is written to
383 -- SYS$OUTPUT.
387 -- /NOORDER_OF_ELABORATION (D)
388 -- /ORDER_OF_ELABORATION
389 --
390 -- Output chosen elaboration order. The output is written to SYS$OUTPUT.
394 -- /OUTPUT=filename
395 --
396 -- File name to use for the program containing the elaboration code.
400 -- /NOOUTPUT
401 --
402 -- Check only. Do not generate the binder output file.
403 --
404 -- In this mode the binder performs all error checks but does not generate
405 -- an output file.
409 -- /PESSIMISTIC_ELABORATION
410 --
411 -- Causes the binder to choose a "pessimistic" elaboration order, i.e. one
412 -- which is most likely to cause elaboration order problems. This can be
413 -- useful in testing portable code to make sure that there are no missing
414 -- elaborate pragmas.
418 -- /PROJECT_FILE=filename
419 --
420 -- Specifies the main project file to be used. The project files rooted
421 -- at the main project file will be parsed before the invocation of the
422 -- binder. The source and object directories to be searched will be
423 -- communicated to the binder through logical names ADA_PRJ_INCLUDE_FILE
424 -- and ADA_PRJ_OBJECTS_FILE.
433 -- /READ_SOURCES[=(keyword[,...])]
434 -- /NOREAD_SOURCES
435 --
436 -- The following keyword are accepted:
437 --
438 -- ALL (D) Require source files to be present. In this mode, the
439 -- binder insists on being able to locate all source files
440 -- that are referenced and checks their consistency. In
441 -- normal mode, if a source file cannot be located it is
442 -- simply ignored. If you specify the ALL keyword, a
443 -- missing source file is an error.
444 --
445 -- NONE Exclude source files. In this mode, the binder only
446 -- checks that ALI files are consistent with one another.
447 -- source files are not accessed. The binder runs faster
448 -- in this mode, and there is still a guarantee that the
449 -- resulting program is self-consistent.
450 --
451 -- If a source file has been edited since it was last
452 -- compiled and you specify the NONE keyword, the binder
453 -- will not detect that the object file is out of date
454 -- with the source file.
455 --
456 -- This is the same as specifying /NOREAD_SOURCES.
457 --
458 -- AVAILABLE Check that object files are consistent with one
459 -- another and are consistent with any source files that
460 -- can be located.
464 -- NODOC (see /READ_SOURCES)
468 -- /RENAME_MAIN=xxx
469 --
470 -- Renames the generated main program from main to xxx.
471 -- This is useful in the case of some cross-building environments, where
472 -- the actual main program is separate from the one generated
473 -- by GNAT BIND.
482 -- /REPORT_ERRORS[=(keyword[,...])]
483 -- VERBOSE (D)
484 -- BRIEF
485 -- DEFAULT
486 -- /NOREPORT_ERRORS
487 --
488 -- With the DEFAULT keyword (which is not the default when the binder is
489 -- run from GNAT BIND) or the /NOREPORT_ERRORS qualifier, brief error
490 -- messages are generated to SYS$ERROR. If the VERBOSE keyword is
491 -- present, a header is written to SYS$OUTPUT and any error messages are
492 -- directed to SYS$OUTPUT All that is written to SYS$ERROR is a brief
493 -- summary message.
494 --
495 -- If the BRIEF keyword is specified, the binder will generate brief error
496 -- messages to SYS$ERROR even if verbose mode is specified. This is
497 -- relevant only when used together with the VERBOSE keyword or /VERBOSE
498 -- qualifier.
502 -- NODOC (see /REPORT_ERRORS)
506 -- /NORESTRICTION_LIST (D)
507 -- /RESTRICTION_LIST
508 --
509 -- Generate list of pragma Rerstrictions that could be applied to the
510 -- current unit. This is useful for code audit purposes, and also may be
511 -- used to improve code generation in some cases.
518 -- /RETURN_CODES=POSIX (D)
519 -- /RETURN_CODES=VMS
520 --
521 -- Specifies the style of default exit code returned. Must be used in
522 -- conjunction with and match the Link qualifer with same name.
523 --
524 -- POSIX (D) Return Posix success (0) by default.
525 --
526 -- VMS Return VMS success (1) by default.
530 -- /RUNTIME_SYSTEM=xxx
531 --
532 -- Binds against an alternate runtime system named xxx or RTS-xxx.
536 -- /SEARCH=(directory[,...])
537 --
538 -- When looking for source or object files also look in directories
539 -- specified.
540 --
541 -- This is the same as specifying both /LIBRARY_SEARCH and /SOURCE_SEARCH
542 -- for a directory.
546 -- /SHARED
547 -- /NOSHARED
548 --
549 -- Link against a shared GNAT run time when available.
553 -- /TIME_SLICE=nnn
554 --
555 -- Set the time slice value to nnn milliseconds. A value of zero means no
556 -- time slicing and also indicates to the tasking run time to match as
557 -- close as possible to the annex D requirements of the RM.
561 -- /SOURCE_SEARCH=(directory[,...])
562 --
563 -- When looking for source files also look in directories specified.
567 -- /STATIC
568 -- /NOSTATIC
569 --
570 -- Link against a static GNAT run time.
574 -- /STORE_TRACEBACKS (D)
575 -- /NOSTORE_TRACEBACKS
576 --
577 -- Store tracebacks in exception occurrences.
578 -- This is the default on VMS, with the zero-cost exception mechanism.
579 -- This qualifier has no impact, except when using the setjmp/longjmp
580 -- exception mechanism, with the GNAT COMPILE qualifier /LONGJMP_SETJMP.
584 -- /TIME_STAMP_CHECK (D)
585 --
586 -- Time stamp errors will be treated as errors.
587 --
588 -- /NOTIME_STAMP_CHECK
589 --
590 -- Ignore time stamp errors. Any time stamp error messages are treated as
591 -- warning messages. This switch essentially disconnects the normal
592 -- consistency checking, and the resulting program may have undefined
593 -- semantics if inconsistent units are present.
594 --
595 -- This means that /NOTIME_STAMP_CHECK should be used only in unusual
596 -- situations, with extreme care.
600 -- /VERBOSE (D)
601 -- /NOVERBOSE
602 --
603 -- Equivalent to /REPORT_ERRORS=VERBOSE.
612 -- /WARNINGS[=(keyword[,...])]
613 -- /NOWARNINGS
614 --
615 -- The following keywords are supported:
616 --
617 -- NORMAL (D) Print warning messages and treat them as warning.
618 -- SUPPRESS Suppress all warning messages (same as /NOWARNINGS).
619 -- ERROR Treat any warning messages as fatal errors
623 -- NODOC (see /WARNINGS)
627 -- /NOZERO_MAIN (D)
628 -- /ZERO_MAIN
629 --
630 -- Normally the binder checks that the unit name given on the command line
631 -- corresponds to a suitable main subprogram. When /ZERO_MAIN is used,
632 -- a list of ALI files can be given, and the execution of the program
633 -- consists of elaboration of these units in an appropriate order.
638 S_Bind_Build 'Access,
640 S_Bind_Debug 'Access,
642 S_Bind_Elab 'Access,
644 S_Bind_Ext 'Access,
646 S_Bind_Help 'Access,
648 S_Bind_Leap 'Access,
650 S_Bind_Linker 'Access,
652 S_Bind_Mess 'Access,
654 S_Bind_Nostlib 'Access,
656 S_Bind_Object 'Access,
658 S_Bind_Output 'Access,
660 S_Bind_Pess 'Access,
662 S_Bind_Read 'Access,
664 S_Bind_Rename 'Access,
666 S_Bind_ReportX 'Access,
668 S_Bind_Return 'Access,
670 S_Bind_Search 'Access,
672 S_Bind_Slice 'Access,
674 S_Bind_Static 'Access,
676 S_Bind_Time 'Access,
678 S_Bind_Warn 'Access,
680 S_Bind_Zero 'Access);
682 -----------------------------
683 -- Switches for GNAT CHECK --
684 -----------------------------
686 S_Check_Add : aliased constant S := "/ADD_PROJECT_SEARCH_DIR=*" &
687 "-aP*";
688 -- /ADD_PROJECT_SEARCH_PATH==(directory[,...])
689 --
690 -- Add directories to the project search path.
692 S_Check_All : aliased constant S := "/ALL " &
693 "-a";
694 -- /NOALL (D)
695 -- /ALL
696 --
697 -- Also check the components of the GNAT run time and process the needed
698 -- components of the GNAT RTL when building and analyzing the global
699 -- structure for checking the global rules.
703 -- /EXTERNAL_REFERENCE="name=val"
704 --
705 -- Specifies an external reference to the project manager. Useful only if
706 -- /PROJECT_FILE is used.
707 --
708 -- Example:
709 -- /EXTERNAL_REFERENCE="DEBUG=TRUE"
711 S_Check_Files : aliased constant S := "/FILES=@" &
712 "-files=@";
713 -- /FILES=filename
714 --
715 -- Take as arguments the files that are listed in the specified
716 -- text file.
718 S_Check_Help : aliased constant S := "/HELP " &
719 "-h";
720 -- /NOHELP (D)
721 -- /HELP
722 --
723 -- Print information about currently implemented checks.
725 S_Check_Locs : aliased constant S := "/LOCS " &
726 "-l";
727 -- /NOLOCS (D)
728 -- /LOCS
729 --
730 -- Use full source locations referebces in the report file.
732 S_Check_Mess : aliased constant S := "/MESSAGES_PROJECT_FILE=" &
733 "DEFAULT " &
734 "-vP0 " &
735 "MEDIUM " &
736 "-vP1 " &
737 "HIGH " &
738 "-vP2";
739 -- /MESSAGES_PROJECT_FILE[=messages-option]
740 --
741 -- Specifies the "verbosity" of the parsing of project files.
742 -- messages-option may be one of the following:
743 --
744 -- DEFAULT (D) No messages are output if there is no error or warning.
745 --
746 -- MEDIUM A small number of messages are output.
747 --
748 -- HIGH A great number of messages are output, most of them not
749 -- being useful for the user.
751 S_Check_Project : aliased constant S := "/PROJECT_FILE=<" &
752 "-P>";
753 -- /PROJECT_FILE=filename
754 --
755 -- Specifies the main project file to be used. The project files rooted
756 -- at the main project file will be parsed before the invocation of the
757 -- gnatcheck. The source directories to be searched will be communicated
758 -- to gnatcheck through logical name ADA_PRJ_INCLUDE_FILE.
760 S_Check_Quiet : aliased constant S := "/QUIET " &
761 "-q";
762 -- /NOQUIET (D)
763 -- /QUIET
764 --
765 -- Work quietly, only output warnings and errors.
767 S_Check_Sections : aliased constant S := "/SECTIONS=" &
768 "DEFAULT " &
769 "-s123 " &
770 "COMPILER_STYLE " &
771 "-s1 " &
772 "BY_RULES " &
773 "-s2 " &
774 "BY_FILES_BY_RULES " &
775 "-s3";
776 -- /SECTIONS[=section-option, section-option, ...]
777 --
778 -- Specify what sections should be included into the report file.
779 -- By default, all three section (diagnises in the format correcponding
780 -- to compiler error and warning messages, diagnoses grouped by rules and
781 -- then - by files, diagnoses grouped by files and then - by rules) are
782 -- included in the report file.
783 --
784 -- section-option may be one of the following:
785 --
786 -- COMPILER_STYLE Include diagnoses in compile-style format
787 -- (diagoses are grouped by files, for each file
788 -- they are ordered according to the references
789 -- into the source)
790 -- BY_RULES Include diagnoses grouped first by rules and
791 -- then by files
792 -- BY_FILES_BY_RULES Include diagnoses grouped first by files and
793 -- then by rules
794 --
795 -- If one of these options is specified, then the report file contains
796 -- only sections set by these options
798 S_Check_Short : aliased constant S := "/SHORT " &
799 "-s";
800 -- /NOSHORT (D)
801 -- /SHORT
802 --
803 -- Generate a short form of the report file.
805 S_Check_Verb : aliased constant S := "/VERBOSE " &
806 "-v";
807 -- /NOVERBOSE (D)
808 -- /VERBOSE
809 --
810 -- The version number and copyright notice are output, as well as exact
811 -- copies of the gnat1 commands spawned to obtain the chop control
812 -- information.
814 Check_Switches : aliased constant Switches :=
816 S_Check_All 'Access,
818 S_Check_Files 'Access,
820 S_Check_Locs 'Access,
822 S_Check_Project 'Access,
824 S_Check_Sections 'Access,
826 S_Check_Verb 'Access);
828 ----------------------------
829 -- Switches for GNAT CHOP --
830 ----------------------------
832 S_Chop_Comp : aliased constant S := "/COMPILATION " &
833 "-c";
834 -- /NOCOMPILATION (D)
835 -- /COMPILATION
836 --
837 -- Compilation mode, handle configuration pragmas strictly according to
838 -- RM rules.
840 S_Chop_File : aliased constant S := "/FILE_NAME_MAX_LENGTH=#" &
841 "-k#";
842 -- /FILE_NAME_MAX_LENGTH[=nnn]
843 --
844 -- Limit generated file names to NNN (default of 8) characters. This is
845 -- useful if the resulting set of files is required to be interoperable
846 -- with systems like MS-DOS which limit the length of file names.
848 S_Chop_Help : aliased constant S := "/HELP " &
849 "-h";
850 -- /NOHELP (D)
851 -- /HELP
852 --
853 -- Print usage information.
855 S_Chop_Over : aliased constant S := "/OVERWRITE " &
856 "-w";
857 -- /NOOVERWRITE (D)
858 -- /OVERWRITE
859 --
860 -- Overwrite existing file names. Normally GNAT CHOP regards it as a
861 -- fatal error situation if there is already a file with the same name as
862 -- a file it would otherwise output. The /OVERWRITE qualifier bypasses
863 -- this check, and any such existing files will be silently overwritten.
865 S_Chop_Pres : aliased constant S := "/PRESERVE " &
866 "-p";
867 -- /NOPRESERVE (D)
868 -- /PRESERVE
869 --
870 -- Causes the file modification time stamp of the input file to be
871 -- preserved and used for the time stamp of the output file(s). This may
872 -- be useful for preserving coherency of time stamps in an enviroment
873 -- where gnatchop is used as part of a standard build process.
875 S_Chop_Quiet : aliased constant S := "/QUIET " &
876 "-q";
877 -- /NOQUIET (D)
878 -- /QUIET
879 --
880 -- Work quietly, only output warnings and errors.
882 S_Chop_Ref : aliased constant S := "/REFERENCE " &
883 "-r";
884 -- /NOREFERENCE (D)
885 -- /REFERENCE
886 --
887 -- Generate "Source_Reference" pragmas. Use this qualifier if the output
888 -- files are regarded as temporary and development is to be done in terms
889 -- of the original unchopped file. The /REFERENCE qualifier causes
890 -- "Source_Reference" pragmas to be inserted into each of the generated
891 -- files to refers back to the original file name and line number. The
892 -- result is that all error messages refer back to the original unchopped
893 -- file.
894 --
895 -- In addition, the debugging information placed into the object file
896 -- (when the /DEBUG qualifier of GNAT COMPILE or GNAT MAKE is specified)
897 -- also refers back to this original file so that tools like profilers
898 -- and debuggers will give information in terms of the original unchopped
899 -- file.
901 S_Chop_Verb : aliased constant S := "/VERBOSE " &
902 "-v";
903 -- /NOVERBOSE (D)
904 -- /VERBOSE
905 --
906 -- The version number and copyright notice are output, as well as exact
907 -- copies of the gnat1 commands spawned to obtain the chop control
908 -- information.
910 Chop_Switches : aliased constant Switches :=
912 S_Chop_File 'Access,
914 S_Chop_Over 'Access,
916 S_Chop_Quiet 'Access,
918 S_Chop_Verb 'Access);
920 -----------------------------
921 -- Switches for GNAT CLEAN --
922 -----------------------------
924 S_Clean_Add : aliased constant S := "/ADD_PROJECT_SEARCH_DIR=*" &
925 "-aP*";
926 -- /ADD_PROJECT_SEARCH_PATH==(directory[,...])
927 --
928 -- Add directories to the project search path.
930 S_Clean_Compil : aliased constant S := "/COMPILER_FILES_ONLY " &
931 "-c";
932 -- /NOCOMPILER_FILES_ONLY (D)
933 -- /COMPILER_FILES_ONLY
934 --
935 -- Only attempt to delete the files produced by the compiler, not those
936 -- produced by the binder or the linker. The files that are not to be
937 -- deleted are library files, interface copy files, binder generated files
938 -- and executable files.
940 S_Clean_Current : aliased constant S := "/CURRENT_DIRECTORY " &
941 "!-I-";
942 -- /CURRENT_DIRECTORY (D)
943 --
944 -- Look for ALI or object files in the directory where GNAT CLEAN was
945 -- invoked.
946 --
947 -- /NOCURRENT_DIRECTORY
948 --
949 -- Do not look for ALI or object files in the directory where GNAT CLEAN
950 -- was invoked.
952 S_Clean_Delete : aliased constant S := "/DELETE " &
953 "!-n";
954 -- /DELETE (D)
955 --
956 -- Delete the files that are not read-only.
957 --
958 -- /NODELETE
959 --
960 -- Informative-only mode. Do not delete any files. Output the list of the
961 -- files that would have been deleted if this switch was not specified.
963 S_Clean_Dirobj : aliased constant S := "/DIRECTORY_OBJECTS=@" &
964 "-D@";
965 -- /DIRECTORY_OBJECTS=<file>
966 --
967 -- Find the object files and .ALI files in <file>.
968 -- This qualifier is not compatible with /PROJECT_FILE.
972 -- /EXTERNAL_REFERENCE="name=val"
973 --
974 -- Specifies an external reference to the project manager. Useful only if
975 -- /PROJECT_FILE is used.
976 --
977 -- Example:
978 -- /EXTERNAL_REFERENCE="DEBUG=TRUE"
980 S_Clean_Full : aliased constant S := "/FULL_PATH_IN_BRIEF_MESSAGES " &
981 "-F";
982 -- /NOFULL_PATH_IN_BRIEF_MESSAGES (D)
983 -- /FULL_PATH_IN_BRIEF_MESSAGES
984 --
985 -- When using project files, if some errors or warnings are detected
986 -- during parsing and verbose mode is not in effect (no use of qualifier
987 -- /VERBOSE), then error lines start with the full path name of the
988 -- project file, rather than its simple file name.
990 S_Clean_Help : aliased constant S := "/HELP " &
991 "-h";
992 -- /NOHELP (D)
993 -- /HELP
994 --
995 -- Output a message explaining the usage of gnatclean.
997 S_Clean_Index : aliased constant S := "/SOURCE_INDEX=#" &
998 "-i#";
999 -- /SOURCE_INDEX=nnn
1000 --
1001 -- Specifies the index of the units in the source file
1002 -- By default, source files are mono-unit and there is no index
1004 S_Clean_Mess : aliased constant S := "/MESSAGES_PROJECT_FILE=" &
1005 "DEFAULT " &
1006 "-vP0 " &
1007 "MEDIUM " &
1008 "-vP1 " &
1009 "HIGH " &
1010 "-vP2";
1011 -- /MESSAGES_PROJECT_FILE[=messages-option]
1012 --
1013 -- Specifies the "verbosity" of the parsing of project files.
1014 -- messages-option may be one of the following:
1015 --
1016 -- DEFAULT (D) No messages are output if there is no error or warning.
1017 --
1018 -- MEDIUM A small number of messages are output.
1019 --
1020 -- HIGH A great number of messages are output, most of them not
1021 -- being useful for the user.
1023 S_Clean_Object : aliased constant S := "/OBJECT_SEARCH=*" &
1024 "-aO*";
1025 -- /OBJECT_SEARCH=(directory,...)
1026 --
1027 -- When searching for library and object files, look in the specified
1028 -- directories. The order in which library files are searched is the same
1029 -- as for MAKE.
1031 S_Clean_Project : aliased constant S := "/PROJECT_FILE=<" &
1032 "-P>";
1033 -- /PROJECT_FILE=filename
1034 --
1035 -- Specifies the main project file to be used. The project files rooted
1036 -- at the main project file will be parsed before the invocation of the
1037 -- compiler. The source and object directories to be searched will be
1038 -- communicated to gnatclean through logical names ADA_PRJ_INCLUDE_FILE
1039 -- and ADA_PRJ_OBJECTS_FILE.
1041 S_Clean_Quiet : aliased constant S := "/QUIET " &
1042 "-q";
1043 -- /NOQUIET (D)
1044 -- /QUIET
1045 --
1046 -- Quiet output. If there are no error, do not ouuput anything, except in
1047 -- verbose mode (qualifier /VERBOSE) or in informative-only mode
1048 -- (qualifier /NODELETE).
1050 S_Clean_Recurs : aliased constant S := "/RECURSIVE " &
1051 "-r";
1052 -- /NORECURSIVE (D)
1053 -- /RECURSIVE
1054 --
1055 -- When a project file is specified (using switch -P), clean all imported
1056 -- and extended project files, recursively. If this qualifier is not
1057 -- specified, only the files related to the main project file are to be
1058 -- deleted. This qualifier has no effect if no project file is specified.
1060 S_Clean_Search : aliased constant S := "/SEARCH=*" &
1061 "-I*";
1062 -- /SEARCH=(directory,...)
1063 --
1064 -- Equivalent to /OBJECT_SEARCH=(directory,...).
1066 S_Clean_Verbose : aliased constant S := "/VERBOSE " &
1067 "-v";
1068 -- /NOVERBOSE (D)
1069 -- /VERBOSE
1070 --
1071 -- Verbose mode.
1073 Clean_Switches : aliased constant Switches :=
1075 S_Clean_Compil 'Access,
1076 S_Clean_Current'Access,
1078 S_Clean_Dirobj 'Access,
1080 S_Clean_Full 'Access,
1082 S_Clean_Index 'Access,
1084 S_Clean_Object 'Access,
1085 S_Clean_Project'Access,
1087 S_Clean_Recurs 'Access,
1091 -------------------------------
1092 -- Switches for GNAT COMPILE --
1093 -------------------------------
1097 -- /NO83 (D)
1098 -- /83
1099 --
1100 -- Although GNAT is primarily an Ada 95 compiler, it accepts this
1101 -- qualifier to specify that an Ada 83 mode program is being compiled. If
1102 -- you specify this qualifier, GNAT rejects Ada 95 extensions and applies
1103 -- Ada 83 semantics. It is not possible to guarantee this qualifier does
1104 -- a perfect job; for example, some subtle tests of pathological cases,
1105 -- such as are found in ACVC tests that have been removed from the ACVC
1106 -- suite for Ada 95, may not compile correctly. However for practical
1107 -- purposes, using this qualifier should ensure that programs that
1108 -- compile correctly under the /83 qualifier can be ported reasonably
1109 -- easily to an Ada 83 compiler. This is the main use of this qualifier.
1110 --
1111 -- With few exceptions (most notably the need to use "<>" on
1112 -- unconstrained generic formal parameters), it is not necessary to use
1113 -- this qualifier switch when compiling Ada 83 programs, because, with
1114 -- rare and obscure exceptions, Ada 95 is upwardly compatible with Ada
1115 -- 83. This means that a correct Ada 83 program is usually also a correct
1116 -- Ada 95 program.
1120 -- /95 (D)
1121 --
1122 -- Allows GNAT to recognize the full range of Ada 95 constructs.
1123 -- This is the normal default for GNAT Pro.
1127 -- /05 (D)
1128 --
1129 -- Allows GNAT to recognize all implemented proposed Ada 2005
1130 -- extensions. See features file for list of implemented features.
1134 -- /ADD_PROJECT_SEARCH_PATH==(directory[,...])
1135 --
1136 -- Add directories to the project search path.
1140 -- /NOASM (D)
1141 -- /ASM
1142 --
1143 -- Use to cause the assembler source file to be generated, using S as the
1144 -- filetype, instead of the object file. This may be useful if you need
1145 -- to examine the generated assembly code.
1162 -- /NOCHECKS
1163 -- /CHECKS[=(keyword[,...])]
1164 --
1165 -- If you compile with the default options, GNAT will insert many runtime
1166 -- checks into the compiled code, including code that performs range
1167 -- checking against constraints, but not arithmetic overflow checking for
1168 -- integer operations (including division by zero) or checks for access
1169 -- before elaboration on subprogram calls. All other runtime checks, as
1170 -- required by the Ada 95 Reference Manual, are generated by default.
1171 --
1172 -- You may specify one or more of the following keywords to the /CHECKS
1173 -- qualifier to modify this behavior:
1174 --
1175 -- DEFAULT The behavior described above. This is the default
1176 -- if the /CHECKS qualifier is not present on the
1177 -- command line. Same as /NOCHECKS.
1178 --
1179 -- OVERFLOW Enables overflow checking for integer operations and
1180 -- checks for access before elaboration on subprogram
1181 -- calls. This causes GNAT to generate slower and larger
1182 -- executable programs by adding code to check for both
1183 -- overflow and division by zero (resulting in raising
1184 -- "Constraint_Error" as required by Ada semantics).
1185 -- Similarly, GNAT does not generate elaboration check
1186 -- by default, and you must specify this keyword to
1187 -- enable them.
1188 --
1189 -- Note that this keyword does not affect the code
1190 -- generated for any floating-point operations; it
1191 -- applies only to integer operations. For floating-point,
1192 -- GNAT has the "Machine_Overflows" attribute set to
1193 -- "False" and the normal mode of operation is to generate
1194 -- IEEE NaN and infinite values on overflow or invalid
1195 -- operations (such as dividing 0.0 by 0.0).
1196 --
1197 -- ELABORATION Enables dynamic checks for access-before-elaboration
1198 -- on subprogram calls and generic instantiations.
1199 --
1200 -- ASSERTIONS The pragmas "Assert" and "Debug" normally have no
1201 -- effect and are ignored. This keyword causes "Assert"
1202 -- and "Debug" pragmas to be activated.
1203 --
1204 -- SUPPRESS_ALL Suppress all runtime checks as though you have "pragma
1205 -- Suppress (all_checks)" in your source. Use this switch
1206 -- to improve the performance of the code at the expense
1207 -- of safety in the presence of invalid data or program
1208 -- bugs.
1209 --
1210 -- DEFAULT Suppress the effect of any option OVERFLOW or
1211 -- ASSERTIONS.
1212 --
1213 -- FULL (D) Similar to OVERFLOW, but suppress the effect of any
1214 -- option ELABORATION or SUPPRESS_ALL.
1215 --
1216 -- These keywords only control the default setting of the checks. You
1217 -- may modify them using either "Suppress" (to remove checks) or
1218 -- "Unsuppress" (to add back suppressed checks) pragmas in your program
1219 -- source.
1223 -- NODOC (see /CHECKS)
1227 -- /NOCOMPRESS_NAMES (D)
1228 -- /COMPRESS_NAMES
1229 --
1230 -- Compress debug information and external symbol name table entries.
1231 -- In the generated debugging information, and also in the case of long
1232 -- external names, the compiler uses a compression mechanism if the name
1233 -- is very long. This compression method uses a checksum, and avoids
1234 -- trouble on some operating systems which have difficulty with very long
1235 -- names.
1239 -- /CONFIGURATION_PRAGMAS_FILE=file
1240 --
1241 -- Specify a configuration pragmas file that need to be taken into account
1245 -- /CURRENT_DIRECTORY (D)
1246 -- /NOCURRENT_DIRECTORY
1247 --
1248 -- Look for source files in the default directory.
1252 -- /DATA_PREPROCESSING=file_name
1253 --
1254 -- This qualifier indicates to the compiler the file name (without
1255 -- directory information) of the preprocessor data file to use.
1256 -- The preprocessor data file should be found in the source directories.
1257 --
1258 -- A preprocessing data file is a text file with significant lines
1259 -- indicating how should be preprocessed either a specific source or all
1260 -- sources not mentioned in other lines. A significant line is a non
1261 -- empty, non comment line. Comments are similar to Ada comments.
1262 --
1263 -- Each significant line starts with either a literal string or the
1264 -- character '*'. A literal string is the file name (without directory
1265 -- information) of the source to preprocess. A character '*' indicates the
1266 -- preprocessing for all the sources that are not specified explicitly on
1267 -- other lines. It is an error to have two lines with the same file name
1268 -- or two lines starting with the character '*'.
1269 --
1270 -- After the file name or the character '*', another optional literal
1271 -- string indicating the file name of the definition file to be used for
1272 -- preprocessing. (see 15.3 Form of Definitions File. The definition files
1273 -- are found by the compiler in one of the source directories. In some
1274 -- cases, when compiling a source in a directory other than the current
1275 -- directory, if the definition file is in the current directory, it may
1276 -- be necessary to add the current directory as a source directory through
1277 -- qualifier "/SEARCH=[]", otherwise the compiler would not find the
1278 -- definition file.
1279 --
1280 -- Then, optionally, switches similar to those of gnatprep may be found.
1281 -- Those switches are:
1282 --
1283 -- -b Causes both preprocessor lines and the lines deleted by
1284 -- preprocessing to be replaced by blank lines, preserving
1285 -- the line number. This switch is always implied;
1286 -- however, if specified after `-c' it cancels the effect
1287 -- of `-c'.
1288 --
1289 -- -c Causes both preprocessor lines and the lines deleted by
1290 -- preprocessing to be retained as comments marked with
1291 -- the special string "--! ".
1292 --
1293 -- -Dsymbol=value Define or redefine a symbol, associated with value.
1294 -- A symbol is an Ada identifier, or an Ada reserved word,
1295 -- with the exception of "if", "else", "elsif", "end",
1296 -- "and", "or" and "then". value is either a literal
1297 -- string, an Ada identifier or any Ada reserved word.
1298 -- A symbol declared with this switch replaces a symbol
1299 -- with the same name defined in a definition file.
1300 --
1301 -- -s Causes a sorted list of symbol names and values to be
1302 -- listed on the standard output file.
1303 --
1304 -- -u Causes undefined symbols to be treated as having the
1305 -- value FALSE in the context of a preprocessor test.
1306 -- In the absence of this option, an undefined symbol
1307 -- in a #if or #elsif test will be treated as an error.
1308 --
1309 -- Examples of valid lines in a preprocessor data file:
1310 --
1311 -- "toto.adb" "prep.def" -u
1312 -- -- preprocess "toto.adb", using definition file "prep.def",
1313 -- -- undefined symbol are False.
1314 --
1315 -- * -c -DVERSION=V101
1316 -- -- preprocess all other sources without a definition file;
1317 -- -- suppressed lined are commented; symbol VERSION has the value
1318 -- -- V101.
1319 --
1320 -- "titi.adb" "prep2.def" -s
1321 -- -- preprocess "titi.adb", using definition file "prep2.def";
1322 -- -- list all symbols with their values.
1337 -- /DEBUG[=debug-level]
1338 -- /NODEBUG
1339 --
1340 -- Specifies how much debugging information is to be included in
1341 -- the resulting object fie.
1342 --
1343 -- 'debug-level' is one of the following:
1344 --
1345 -- SYMBOLS (D) Include both debugger symbol records and traceback
1346 -- in the object file.
1347 --
1348 -- ALL Include debugger symbol records, traceback plus
1349 -- extra debug information in the object file.
1350 --
1351 -- NONE Excludes both debugger symbol records and traceback
1352 -- from the object file. Same as /NODEBUG.
1353 --
1354 -- TRACEBACK Includes only traceback records in the object
1355 -- file. This is the default when /DEBUG is not used.
1359 -- NODOC (see /Debug)
1366 -- /NODISTRIBUTION_STUBS (D)
1367 -- /DISTRIBUTION_STUBS[=dist-opt]
1368 --
1369 -- 'dist-opt' is either RECEIVER (the default) or SENDER and indicates
1370 -- that stubs for use in distributed programs (see the Distributed
1371 -- Systems Annex of the Ada RM) should be generated.
1375 -- NODOC (see /DISTRIBUTION_STUBS)
1379 -- /NOERROR_LIMIT (D)
1380 -- /ERROR_LIMIT=nnn
1381 --
1382 -- NNN is a decimal integer in the range of 1 to 999999 and limits the
1383 -- number of error messages to be generated to that number. Once that
1384 -- number has been reached, the compilation is abandoned.
1385 -- Specifying 999999 is equivalent to /NOERROR_LIMIT.
1389 -- NODOC (see /ERROR_LIMIT)
1393 -- /NOEXPAND_SOURCE (D)
1394 -- /EXPAND_SOURCE
1395 --
1396 -- Produces a listing of the expanded code in Ada source form. For
1397 -- example, all tasking constructs are reduced to appropriate run-time
1398 -- library calls.
1402 -- /NOEXTENSIONS_ALLOWED (D)
1403 -- /EXTENSIONS_ALLOWED
1404 --
1405 -- GNAT specific language extensions allowed.
1409 -- /EXTERNAL_REFERENCE="name=val"
1410 --
1411 -- Specifies an external reference to the project manager. Useful only if
1412 -- /PROJECT_FILE is used.
1413 --
1414 -- Example:
1415 -- /EXTERNAL_REFERENCE="DEBUG=TRUE"
1419 -- /FILE_NAME_MAX_LENGTH=nnn
1420 --
1421 -- Activates file name "krunching". NNN, a decimal integer in the range
1422 -- 1-999, indicates the maximum allowable length of a file name (not
1423 -- including the ADS or ADB filetype. The default is not to enable file
1424 -- name krunching.
1428 -- /NOFORCE_ALI (D)
1429 -- /FORCE_ALI
1430 --
1431 -- In normal operation mode, the .ALI file is not generated if any
1432 -- illegalities are detected in the program. The use of this qualifier
1433 -- forces generation of the .ALI file. This file is marked as being
1434 -- in error, so it cannot be used for binding purposes, but it does
1435 -- contain reasonably complete cross-reference information, and thus may
1436 -- be useful for use by tools (e.g. semantic browing tools or integrated
1437 -- development environments) that are driven from the .ALI file.
1441 -- /NOFULL_PATH_IN_BRIEF_MESSAGES (D)
1442 -- /FULL_PATH_IN_BRIEF_MESSAGES
1443 --
1444 -- When using project files, if some errors or warnings are detected
1445 -- during parsing and verbose mode is not in effect (no use of qualifier
1446 -- /VERBOSE), then error lines start with the full path name of the
1447 -- project file, rather than its simple file name.
1451 -- /NOGNAT_INTERNAL (D)
1452 -- /GNAT_INTERNAL
1453 --
1454 -- Internal GNAT implementation mode. This should not be used for
1455 -- applications programs, it is intended only for use by the compiler
1456 -- and its run-time library. For documentation, see the GNAT sources.
1457 -- Note that it implies /WARNINGS=ALL,ERRORS and /STYLE_CHECKS=GNAT
1458 -- so that all standard warnings and all standard style options are
1459 -- turned on. All warnings and style error messages are treated as
1460 -- errors.
1464 -- /NOHELP (D)
1465 -- /HELP
1466 --
1467 -- Output usage information.
1492 -- /NOIDENTIFIER_CHARACTER_SET (D)
1493 -- /IDENTIFIER_CHARACTER_SET=char-set
1494 --
1495 -- Normally GNAT recognizes the Latin-1 character set in source program
1496 -- identifiers, as described in the reference manual. This qualifier
1497 -- causes GNAT to recognize alternate character sets in identifiers.
1498 -- 'char-set' is one of the following strings indicating the character
1499 -- set:
1500 --
1501 -- DEFAULT (D) Equivalent to 1, below. Also equivalent to
1502 -- /NOIDENTIFIER_CHARACTER_SET.
1503 --
1504 -- 1 The basic character set is Latin-1. This character
1505 -- set is defined by ISO standard 8859, part 1. The lower
1506 -- half (character codes 16#00# ... 16#7F#) is identical
1507 -- to standard ASCII coding, but the upper half is used
1508 -- to represent additional characters. This includes
1509 -- extended letters used by European languages, such as
1510 -- the umlaut used in German.
1511 --
1512 -- You may use any of these extended characters freely
1513 -- in character or string literals. In addition, the
1514 -- extended characters that represent letters can be
1515 -- used in identifiers.
1516 --
1517 -- 2 Latin-2 letters allowed in identifiers, with uppercase
1518 -- and lowercase equivalence.
1519 --
1520 -- 3 Latin-3 letters allowed in identifiers, with uppercase
1521 -- and lower case equivalence.
1522 --
1523 -- 4 Latin-4 letters allowed in identifiers, with uppercase
1524 -- and lower case equivalence.
1525 --
1526 -- PC IBM PC code page 437. This code page is the normal
1527 -- default for PCs in the U.S. It corresponds to the
1528 -- original IBM PC character set. This set has some, but
1529 -- not all, of the extended Latin-1 letters, but these
1530 -- letters do not have the same encoding as Latin-1. In
1531 -- this mode, these letters are allowed in identifiers
1532 -- with uppercase and lowercase equivalence.
1533 --
1534 -- PC850 This code page (850) is a modification of 437 extended
1535 -- to include all the Latin-1 letters, but still not with
1536 -- the usual Latin-1 encoding. In this mode, all these
1537 -- letters are allowed in identifiers with uppercase and
1538 -- lower case equivalence.
1539 --
1540 -- FULL_UPPER Any character in the range 80-FF allowed in
1541 -- identifiers, and all are considered distinct. In
1542 -- other words, there are no uppercase and lower case
1543 -- equivalences in this range.
1544 --
1545 -- NO_UPPER No upper-half characters in the range 80-FF are
1546 -- allowed in identifiers. This gives Ada 95
1547 -- compatibility for identifier names.
1548 --
1549 -- WIDE GNAT allows wide character codes to appear in
1550 -- character and string literals, and also optionally
1551 -- in identifiers. See the /WIDE_CHARACTER_ENCODING
1552 -- qualifier for information on encoding formats.
1556 -- NODOC (see /IDENTIFIER_CHARACTER_SET)
1560 -- /IGNORE_REP_CLAUSES
1561 --
1562 -- Causes all representation clauses to be ignored and treated as
1563 -- comments. Useful when compiling foreign code (for example when ASIS
1564 -- is used to analyze such code).
1568 -- /NOIMMEDIATE_ERRORS (D)
1569 -- /IMMEDIATE_ERRORS
1570 --
1571 -- Causes errors to be displayed as soon as they are encountered, rather
1572 -- than after compilation is terminated. If GNAT terminates prematurely
1573 -- or goes into an infinite loop, the last error message displayed may
1574 -- help to pinpoint the culprit.
1583 -- /NOINLINE (D)
1584 -- /INLINE[=keyword]
1585 --
1586 -- Selects the level of inlining for your program. In the absence of this
1587 -- qualifier, GNAT does not attempt inlining across units and does not
1588 -- need to access the bodies of subprograms for which "pragma Inline" is
1589 -- specified if they are not in the current unit.
1590 --
1591 -- The supported keywords are as follows:
1592 --
1593 -- PRAGMA (D) Recognize and process "Inline" pragmas. However,
1594 -- for the inlining to actually occur, optimization
1595 -- must be enabled. This enables inlining across unit
1596 -- boundaries, that is, inlining a call in one unit of
1597 -- a subprogram declared in a with'ed unit. The compiler
1598 -- will access these bodies, creating an extra source
1599 -- dependency for the resulting object file, and where
1600 -- possible, the call will be inlined.
1601 --
1602 -- This qualifier also turns on full optimization and
1603 -- requests GNAT to try to attempt automatic inlining
1604 -- of small subprograms within a unit.
1605 --
1606 -- Specifying /OPTIMIZE=NONE will disable the main effect
1607 -- of this qualifier, but you may specify other
1608 -- optimization options, to get either lower
1609 -- (/OPTIMIZE=SOME) or higher (/OPTIMIZE=UNROLL_LOOPS)
1610 -- levels of optimization.
1611 --
1612 -- FULL Front end inlining. The front end inlining activated
1613 -- by this switch is generally more extensive, and quite
1614 -- often more effective than the standard PRAGMA inlining
1615 -- mode. It will also generate additional dependencies.
1616 --
1617 -- SUPPRESS Suppresses all inlining, even if other optimization
1618 -- or inlining switches are set.
1622 -- NODOC (see /INLINE)
1627 -- /NO_INTERSPERSE_SOURCE (D)
1628 -- /INTERSPERSE_SOURCE
1629 --
1630 -- Causes output from /XDEBUG or /EXPAND_SOURCE to be interspersed with
1631 -- lines from the original source file, output as comment lines with the
1632 -- associated line number.
1637 -- /NO_JUSTIFY_MESSAGES (D)
1638 -- /JUSTIFY_MESSAGES=nnn
1639 --
1640 -- Causes error messages to be reformatted so that a message and all its
1641 -- continuation lines count as one warning or error in the statistics on
1642 -- total errors, and the message is broken down into lines (justified) so
1643 -- that no line is longer than nnn characters. The default message
1644 -- behavior (each message counted separately and not reformatted to fit
1645 -- a particular line length) can be obtained using /NO_JUSTIFY_MESSAGES.
1650 -- NODOC (see /JUSTIFY_MESSAGES)
1654 -- /MAX_LINE_LENGTH=nnn
1655 --
1656 -- Set maximum line length.
1657 -- The length of lines must not exceed the given value nnn.
1661 -- /NOLIST (D)
1662 -- /LIST
1663 --
1664 -- Cause a full listing of the file to be generated. In the case where
1665 -- a body is compiled, the corresponding spec is also listed, along
1666 -- with any subunits.
1670 -- /MAPPING_FILE=file_name
1671 --
1672 -- Use mapping file file_name
1673 --
1674 -- A mapping file is a way to communicate to the compiler two mappings:
1675 -- from unit names to file names (without any directory information) and
1676 -- from file names to path names (with full directory information).
1677 -- These mappings are used by the compiler to short-circuit the path
1678 -- search.
1679 --
1680 -- The use of mapping files is not required for correct operation of the
1681 -- compiler, but mapping files can improve efficiency, particularly when
1682 -- sources are read over a slow network connection. In normal operation,
1683 -- you need not be concerned with the format or use of mapping files,
1684 -- and /MAPPING_FILE is not a qualifier that you would use explicitly.
1685 -- It is intended only for use by automatic tools such as GNAT MAKE
1686 -- running under the project file facility. The description here of the
1687 -- format of mapping files is provided for completeness and for possible
1688 -- use by other tools.
1689 --
1690 -- A mapping file is a sequence of sets of three lines. In each set, the
1691 -- first line is the unit name, in lower case, with "%s" appended for
1692 -- specifications and "%b" appended for bodies; the second line is the
1693 -- file name; and the third line is the path name.
1694 --
1695 -- Example:
1696 --
1697 -- main%b
1698 -- main.2_ada
1699 -- /gnat/project1/sources/main.2_ada
1700 --
1701 -- When qualifier ?MAPPING_FILE is specified, the compiler will create in
1702 -- memory the two mappings from the specified file. If there is any
1703 -- problem (non existent file, truncated file or duplicate entries),
1704 -- no mapping will be created.
1705 --
1706 -- Several /MAPPING_FILE qualifiers may be specified; however, only the
1707 -- last one on the command line will be taken into account.
1708 --
1709 -- When using a project file, GNAT MAKE creates a temporary mapping file
1710 -- and communicates it to the compiler using this switch.
1719 -- /MESSAGES_PROJECT_FILE[=messages-option]
1720 --
1721 -- Specifies the "verbosity" of the parsing of project files.
1722 -- messages-option may be one of the following:
1723 --
1724 -- DEFAULT (D) No messages are output if there is no error or warning.
1725 --
1726 -- MEDIUM A small number of messages are output.
1727 --
1728 -- HIGH A great number of messages are output, most of them not
1729 -- being useful for the user.
1733 -- /MAX_NESTING=nnn
1734 --
1735 -- Set maximum level of nesting of constructs (including subprograms,
1736 -- loops, blocks, packages, and conditionals).
1737 -- The level of nesting must not exceed the given value nnn.
1738 -- A value of zero disable this style check (not enabled by default).
1742 -- /NO_GNAT_ADC
1743 --
1744 -- Cause the compiler to ignore any configuration pragmas file GNAT.ADC
1745 -- in the default directory. Implied by qualifier /PROJECT_FILE.
1746 -- Often used in conjunction with qualifier /CONFIGURATION_PRAGMAS_FILE.
1750 -- /NOLOAD
1751 --
1752 -- Cause the compiler to operate in semantic check mode with full
1753 -- checking for all illegalities specified in the reference manual, but
1754 -- without generation of any source code (no object or ALI file
1755 -- generated).
1756 --
1757 -- Since dependent files must be accessed, you must follow the GNAT
1758 -- semantic restrictions on file structuring to operate in this mode:
1759 --
1760 -- o The needed source files must be accessible.
1761 -- o Each file must contain only one compilation unit.
1762 -- o The file name and unit name must match.
1763 --
1764 -- The output consists of error messages as appropriate. No object file
1765 -- or ALI file is generated. The checking corresponds exactly to the
1766 -- notion of legality in the Ada reference manual.
1767 --
1768 -- Any unit can be compiled in semantics-checking-only mode, including
1769 -- units that would not normally be compiled (generic library units,
1770 -- subunits, and specifications where a separate body is present).
1774 -- /NOSTD_INCLUDES
1775 --
1776 -- Do not look in the default directory for source files of the runtime.
1780 -- /NOSTD_LIBRARIES
1781 --
1782 -- Do not look for library files in the system default directory.
1801 -- /NOOPTIMIZE (D)
1802 -- /OPTIMIZE[=(keyword[,...])]
1803 --
1804 -- Selects the level of optimization for your program. The supported
1805 -- keywords are as follows:
1806 --
1807 -- ALL (D) Perform most optimizations, including those that
1808 -- may be expensive.
1809 --
1810 -- NONE Do not do any optimizations. Same as /NOOPTIMIZE.
1811 --
1812 -- SOME Perform some optimizations, but omit ones that
1813 -- are costly in compilation time.
1814 --
1815 -- SPACE Optimize space usage
1816 --
1817 -- DEVELOPMENT Same as SOME.
1818 --
1819 -- INLINING Full optimization, and also attempt automatic inlining
1820 -- of small subprograms within a unit
1821 --
1822 -- UNROLL_LOOPS Try to unroll loops. This keyword may be specified
1823 -- with any keyword above other than NONE. Loop
1824 -- unrolling usually, but not always, improves the
1825 -- performance of programs.
1826 --
1827 -- NO_STRICT_ALIASING
1828 -- Suppress aliasing analysis. When optimization is
1829 -- enabled (ALL or SOME above), the compiler assumes
1830 -- that pointers do in fact point to legitimate values
1831 -- of the pointer type (allocated from the proper pool).
1832 -- If this assumption is violated, e.g. by the use of
1833 -- unchecked conversion, then it may be necessary to
1834 -- suppress this assumption using this keyword (which
1835 -- may be specified only in conjunction with any
1836 -- keyword above, other than NONE).
1840 -- NODOC (see /OPTIMIZE)
1844 -- /OUTPUT_FILE=fname
1845 --
1846 -- This has the same effect as /LIST except that the output is written
1847 -- to a file instead of to standard output. If the given fname
1848 -- does not start with a period, then it is the full name of the file
1849 -- to be written. If fname starts with a period, the name of the file
1850 -- is the concatenation of to the name of the file being compiled with
1851 -- fname where the period is replace by an underline. For example, if
1852 -- file xyz.adb is compiled with -gnatl=.lst, then the output is written
1853 -- to file xyz.adb_lst.
1857 -- /NOPOLLING (D)
1858 -- /POLLING
1859 --
1860 -- Enable polling. See the description of pragma Polling in the GNAT
1861 -- Reference Manual for full details.
1865 -- /PROJECT_FILE=filename
1866 --
1867 -- Specifies the main project file to be used. The project files rooted
1868 -- at the main project file will be parsed before the invocation of the
1869 -- compiler. The source and object directories to be searched will be
1870 -- communicated to the compiler through logical names
1871 -- ADA_PRJ_INCLUDE_FILE and ADA_PRJ_OBJECTS_FILE.
1875 -- /PRINT_STANDARD
1876 --
1877 -- cause the compiler to output a representation of package Standard
1878 -- in a form very close to standard Ada. It is not quite possible to
1879 -- do this and remain entirely Standard (since new numeric base types
1880 -- cannot be created in standard Ada), but the output is easily
1881 -- readable to any Ada programmer, and is useful to determine the
1882 -- characteristics of target dependent types in package Standard.
1895 -- /NOREPORT_ERRORS (D)
1896 -- /REPORT_ERRORS[=(keyword[,...])]
1897 --
1898 -- Change the way errors are reported. The following keywords are
1899 -- supported:
1900 --
1901 -- VERBOSE (D) Verbose mode. Full error output with source lines
1902 -- to SYS$OUTPUT.
1903 --
1904 -- BRIEF Generate the brief format error messages to
1905 -- SYS$OUTPUT as well as the verbose format message or
1906 -- full listing.
1907 --
1908 -- FULL Normally, the compiler suppresses error messages that
1909 -- are likely to be redundant. This keyword causes all
1910 -- error messages to be generated. One particular effect
1911 -- is for the case of references to undefined variables.
1912 -- If a given variable is referenced several times, the
1913 -- normal format of messages produces one error. With
1914 -- FULL, each undefined reference produces a separate
1915 -- error message.
1916 --
1917 -- IMMEDIATE Normally, the compiler saves up error messages and
1918 -- generates them at the end of compilation in proper
1919 -- sequence. This keyword causes error messages to be
1920 -- generated as soon as they are detected. The use of
1921 -- IMMEDIATE usually causes error messages to be
1922 -- generated out of sequence. Use it when the compiler
1923 -- blows up due to an internal error. In this case, the
1924 -- error messages may be lost. Sometimes blowups are
1925 -- the result of mishandled error messages, so you may
1926 -- want to run with this keyword to determine whether
1927 -- any error messages were generated.
1928 --
1929 -- DEFAULT Turn off VERBOSE and BRIEF. Same as /NOREPORT_ERRORS.
1933 -- NODOC (see /REPORT_ERRORS)
1952 -- /NOREPRESENTATION_INFO (D)
1953 -- /REPRESENTATION_INFO[=(keyword[,...])]
1954 --
1955 -- This qualifier controls output from the compiler of a listing showing
1956 -- representation information for declared types and objects.
1957 --
1958 -- ARRAYS (D) Size and alignment information is listed for
1959 -- declared array and record types.
1960 --
1961 -- ARRAYS_FILE Similar to ARRAYS, but the output is to a file
1962 -- with the name 'file_rep' where 'file' is the name
1963 -- of the corresponding source file.
1964 --
1965 -- NONE no information is output (equivalent to omitting
1966 -- the /REPRESENTATION_INFO qualifiers).
1967 --
1968 -- OBJECTS Size and alignment information is listed for all
1969 -- declared types and objects.
1970 --
1971 -- OBJECTS_FILE Similar to OBJECTS, but the output is to a file
1972 -- with the name 'file_rep' where 'file' is the name
1973 -- of the corresponding source file.
1974 --
1975 -- SYMBOLIC Symbolic expression information for values that
1976 -- are computed at run time for variant records.
1977 --
1978 -- SYMBOLIC_FILE Similar to SYMBOLIC, but the output is to a file
1979 -- with the name 'file_rep' where 'file' is the name
1980 -- of the corresponding source file.
1981 --
1982 -- DEFAULT Equivalent to ARRAYS.
1986 -- NODOC (see /REPRESENTATION_INFO)
1990 -- /RUNTIME_SYSTEM=xxx
1991 --
1992 -- Build against an alternate runtime system named xxx or RTS-xxx.
1996 -- /SEARCH=(directory[,...])
1997 --
1998 -- When looking for source files also look in directories specified.
2069 -- /NOSTYLE_CHECKS (D)
2070 -- /STYLE_CHECKS[=(keyword,[...])]
2071 --
2072 -- Normally, GNAT permits any code layout consistent with the reference
2073 -- manual requirements. This qualifier imposes style checking on the
2074 -- input source code. The following keywords are supported:
2075 --
2076 -- ALL_BUILTIN (D) Equivalent to the following list of options:
2077 -- 3, ATTRIBUTE, BLANKS, COMMENTS, END, VTABS,
2078 -- HTABS, IF_THEN, KEYWORD, LAYOUT, LINE_LENGTH,
2079 -- PRAGMA, REFERENCES, SPECS, TOKEN.
2080 --
2081 -- 1 .. 9 Specify indentation level from 1 to 9.
2082 -- The general style of required indentation is as
2083 -- specified by the examples in the Ada Reference
2084 -- Manual. Full line comments must be aligned with
2085 -- the -- starting on a column that is a multiple
2086 -- of the alignment level.
2087 --
2088 -- ATTRIBUTE Check attribute casing.
2089 -- Attribute names, including the case of keywords
2090 -- such as digits used as attributes names,
2091 -- must be written in mixed case, that is,
2092 -- the initial letter and any letter following an
2093 -- underscore must be uppercase.
2094 -- All other letters must be lowercase.
2095 --
2096 -- ARRAY_INDEXES Check indexes of array attributes.
2097 -- For array attributes First, Last, Range,
2098 -- or Length, the index number must be omitted
2099 -- for one-dimensional arrays and is required
2100 -- for multi-dimensional arrays.
2101 --
2102 -- BLANKS Blanks not allowed at statement end.
2103 -- Trailing blanks are not allowed at the end of
2104 -- statements. The purpose of this rule, together
2105 -- with option HTABS (no horizontal tabs), is to
2106 -- enforce a canonical format for the use of
2107 -- blanks to separate source tokens.
2108 --
2109 -- COMMENTS Check comments.
2110 -- Comments must meet the following set of rules:
2111 --
2112 -- * The "--" that starts the column must either
2113 -- start in column one, or else at least one
2114 -- blank must precede this sequence.
2115 --
2116 -- * Comments that follow other tokens on a line
2117 -- must have at least one blank following the
2118 -- "--" at the start of the comment.
2119 --
2120 -- * Full line comments must have two blanks
2121 -- following the "--" that starts the comment,
2122 -- with the following exceptions.
2123 --
2124 -- * A line consisting only of the "--"
2125 -- characters, possibly preceded by blanks is
2126 -- permitted.
2127 --
2128 -- * A comment starting with "--x" where x is
2129 -- a special character is permitted. This
2130 -- allows proper processing of the output
2131 -- generated by specialized tools including
2132 -- gnatprep (where --! is used) and the SPARK
2133 -- annnotation language (where --# is used).
2134 -- For the purposes of this rule, a special
2135 -- character is defined as being in one of the
2136 -- ASCII ranges 16#21#..16#2F# or
2137 -- 16#3A#..16#3F#.
2138 --
2139 -- * A line consisting entirely of minus signs,
2140 -- possibly preceded by blanks, is permitted.
2141 -- This allows the construction of box
2142 -- comments where lines of minus signs are
2143 -- used to form the top and bottom of the box.
2144 --
2145 -- * If a comment starts and ends with "--" is
2146 -- permitted as long as at least one blank
2147 -- follows the initial "--". Together with
2148 -- the preceding rule, this allows the
2149 -- construction of box comments, as shown in
2150 -- the following example:
2151 --
2152 -- ---------------------------
2153 -- -- This is a box comment --
2154 -- ---------------------------
2155 --
2156 -- DOS_LINE_ENDINGS Check that no DOS line terminators are present
2157 -- All lines must be terminated by a single
2158 -- ASCII.LF character. In particular the DOS line
2159 -- terminator sequence CR / LF is not allowed).
2160 --
2161 -- END Check end/exit labels.
2162 -- Optional labels on end statements ending
2163 -- subprograms and on exit statements exiting
2164 -- named loops, are required to be present.
2165 --
2166 -- GNAT Enforces a set of style conventions that
2167 -- match the style used in the GNAT source code.
2168 -- This maybe useful when developing code that
2169 -- is eventually intended to be incorporated into
2170 -- GNAT. For further details, see GNAT sources.
2171 --
2172 -- HTABS No horizontal tabs.
2173 -- Horizontal tab characters are not permitted in
2174 -- the source text. Together with the BLANKS
2175 -- (no blanks at end of line) option, this
2176 -- enforces a canonical form for the use of blanks
2177 -- to separate source tokens.
2178 --
2179 -- IF_THEN Check if-then layout.
2180 -- The keyword then must appear either on the
2181 -- same line as the corresponding if, or on a line
2182 -- on its own, lined up under the if with at least
2183 -- one non-blank line in between containing all or
2184 -- part of the condition to be tested.
2185 --
2186 -- KEYWORD Check keyword casing.
2187 -- All keywords must be in lower case (with the
2188 -- exception of keywords such as digits used as
2189 -- attribute names to which this check does not
2190 -- apply).
2191 --
2192 -- LAYOUT Check layout.
2193 -- Layout of statement and declaration constructs
2194 -- must follow the recommendations in the Ada
2195 -- Reference Manual, as indicated by the form of
2196 -- the syntax rules. For example an else keyword
2197 -- must be lined up with the corresponding if
2198 -- keyword.
2199 --
2200 -- There are two respects in which the style rule
2201 -- enforced by this check option are more liberal
2202 -- than those in the Ada Reference Manual.
2203 -- First in the case of record declarations,
2204 -- it is permissible to put the record keyword on
2205 -- the same line as the type keyword, and then
2206 -- the end in end record must line up under type.
2207 -- For example, either of the following two
2208 -- layouts is acceptable:
2209 --
2210 -- type q is record
2211 -- a : integer;
2212 -- b : integer;
2213 -- end record;
2214 --
2215 -- type q is
2216 -- record
2217 -- a : integer;
2218 -- b : integer;
2219 -- end record;
2220 --
2221 -- Second, in the case of a block statement,
2222 -- a permitted alternative is to put the block
2223 -- label on the same line as the declare or begin
2224 -- keyword, and then line the end keyword up under
2225 -- the block label. For example both the following
2226 -- are permitted:
2227 --
2228 --
2229 --
2230 -- Block : declare
2231 -- A : Integer := 3;
2232 -- begin
2233 -- Proc (A, A);
2234 -- end Block;
2235 --
2236 -- Block :
2237 -- declare
2238 -- A : Integer := 3;
2239 -- begin
2240 -- Proc (A, A);
2241 -- end Block;
2242 --
2243 -- The same alternative format is allowed for
2244 -- loops. For example, both of the following are
2245 -- permitted:
2246 --
2247 --
2248 --
2249 -- Clear : while J < 10 loop
2250 -- A (J) := 0;
2251 -- end loop Clear;
2252 --
2253 -- Clear :
2254 -- while J < 10 loop
2255 -- A (J) := 0;
2256 -- end loop Clear;
2257 --
2258 --
2259 --
2260 -- LINE_LENGTH Check maximum line length.
2261 -- The length of source lines must not exceed 79
2262 -- characters, including any trailing blanks
2263 -- The value of 79 allows convenient display on
2264 -- an 80 character wide device or window, allowing
2265 -- for possible special treatment of 80 character
2266 -- lines.
2267 --
2268 -- NONE Clear any previously set style checks.
2269 --
2270 -- ORDERED_SUBPROGRAMS Check order of subprogram bodies.
2271 -- All subprogram bodies in a given scope (e.g.
2272 -- a package body) must be in alphabetical order.
2273 -- The ordering rule uses normal Ada rules for
2274 -- comparing strings, ignoring casing of letters,
2275 -- except that if there is a trailing numeric
2276 -- suffix, then the value of this suffix is used
2277 -- in the ordering (e.g. Junk2 comes before
2278 -- Junk10).
2279 --
2280 -- PRAGMA Check pragma casing.
2281 -- Pragma names must be written in mixed case,
2282 -- that is, the initial letter and any letter
2283 -- following an underscore must be uppercase.
2284 -- All other letters must be lowercase.
2285 --
2286 -- REFERENCES Check references.
2287 -- All identifier references must be cased in the
2288 -- same way as the corresponding declaration.
2289 -- No specific casing style is imposed on
2290 -- identifiers. The only requirement is for
2291 -- consistency of references with declarations.
2292 --
2293 -- SPECS Check separate specs.
2294 -- Separate declarations ("specs") are required
2295 -- for subprograms (a body is not allowed to serve
2296 -- as its own declaration). The only exception is
2297 -- that parameterless library level procedures are
2298 -- not required to have a separate declaration.
2299 -- This exception covers the most frequent form of
2300 -- main program procedures.
2301 --
2302 -- STANDARD_CASING Check casing of entities in Standard.
2303 -- Any identifier from Standard must be cased to
2304 -- match the presentation in the Ada Reference
2305 -- Manual (for example, Integer and ASCII.NUL).
2306 --
2307 -- TOKEN Check token spacing.
2308 -- The following token spacing rules are enforced:
2309 --
2310 -- * The keywords abs and not must be followed
2311 -- by a space.
2312 --
2313 -- * The token => must be surrounded by spaces.
2314 --
2315 -- * The token <> must be preceded by a space or
2316 -- a left parenthesis.
2317 --
2318 -- * Binary operators other than ** must be
2319 -- surrounded by spaces. There is no
2320 -- restriction on the layout of the ** binary
2321 -- operator.
2322 --
2323 -- * Colon must be surrounded by spaces.
2324 --
2325 -- * Colon-equal (assignment) must be surrounded
2326 -- by spaces.
2327 --
2328 -- * Comma must be the first non-blank character
2329 -- on the line, or be immediately preceded by
2330 -- a non-blank character, and must be followed
2331 -- by a space.
2332 --
2333 -- * If the token preceding a left paren ends
2334 -- with a letter or digit, then a space must
2335 -- separate the two tokens.
2336 --
2337 -- * A right parenthesis must either be the
2338 -- first non-blank character on a line, or it
2339 -- must be preceded by a non-blank character.
2340 --
2341 -- * A semicolon must not be preceded by
2342 -- a space, and must not be followed by
2343 -- a non-blank character.
2344 --
2345 -- * A unary plus or minus may not be followed
2346 -- by a space.
2347 --
2348 -- * A vertical bar must be surrounded by
2349 -- spaces.
2350 --
2351 -- In the above rules, appearing in column one is
2352 -- always permitted, that is, counts as meeting
2353 -- either a requirement for a required preceding
2354 -- space, or as meeting a requirement for no
2355 -- preceding space.
2356 --
2357 -- Appearing at the end of a line is also always
2358 -- permitted, that is, counts as meeting either
2359 -- a requirement for a following space,
2360 -- or as meeting a requirement for no following
2361 -- space.
2362 --
2363 -- UNNECESSARY_BLANK_LINES
2364 -- Check for unnecessary blank lines.
2365 -- A blank line is considered unnecessary if it
2366 -- appears at the end of the file, or if more
2367 -- than one blank line occurs in sequence.
2368 --
2369 -- VTABS No form feeds or vertical tabs.
2370 -- Form feeds or vertical tab characters are not
2371 -- permitted in the source text.
2372 --
2373 -- XTRA_PARENS Check for the use of an unnecessary extra
2374 -- level of parentheses (C - style) around
2375 -- conditions in if statements, while statements
2376 -- and exit statements.
2380 -- NODOC (see /STYLE_CHECKS)
2384 -- /SYMBOL_PREPROCESSING="symbol=value"
2385 --
2386 -- Define or redefine a preprocessing symbol, associated with value.
2387 -- If "=value" is not specified, then the value of the symbol is True.
2388 -- A symbol is an identifier, following normal Ada (case-insensitive)
2389 -- rules for its syntax, and value is any sequence (including an empty
2390 -- sequence) of characters from the set (letters, digits, period,
2391 -- underline). Ada reserved words may be used as symbols, with the
2392 -- exceptions of "if", "else", "elsif", "end", "and", "or" and "then".
2393 --
2394 -- A symbol declared with this qualifier on the command line replaces
2395 -- a symbol with the same name either in a definition file or specified
2396 -- with a switch -D in the preprocessor data file.
2397 --
2398 -- This qualifier is similar to qualifier /ASSOCIATE of
2399 -- GNAT PREPROCESSING.
2403 -- /NOSYNTAX_ONLY (D)
2404 -- /SYNTAX_ONLY
2405 --
2406 -- Run GNAT in syntax checking only mode. You can check a series of
2407 -- files in a single command, and can use wild cards to specify such a
2408 -- group of files.
2409 --
2410 -- You may use other qualifiers in conjunction with this qualifier. In
2411 -- particular, /LIST and /REPORT_ERRORS=VERBOSE are useful to control the
2412 -- format of any generated error messages.
2413 --
2414 -- The output is simply the error messages, if any. No object file or ALI
2415 -- file is generated by a syntax-only compilation. Also, no units other
2416 -- than the one specified are accessed. For example, if a unit "X" with's
2417 -- a unit "Y", compiling unit "X" in syntax check only mode does not
2418 -- access the source file containing unit "Y".
2419 --
2420 -- Normally, GNAT allows only a single unit in a source file. However,
2421 -- this restriction does not apply in syntax-check-only mode, and it is
2422 -- possible to check a file containing multiple compilation units
2423 -- concatenated together. This is primarily used by the GNAT CHOP
2424 -- command.
2428 -- /TABLE_MULTIPLIER=nnn
2429 --
2430 -- All compiler tables start at nnn times usual starting size.
2434 -- /TRACE_UNITS
2435 -- /NOTRACE_UNITS
2436 --
2437 -- This switch that does for the frontend what /VERBOSE does for the
2438 -- backend. The system prints the name of each unit, either a compilation
2439 -- unit or nested unit, as it is being analyzed.
2443 -- /TREE_OUTPUT
2444 -- /NOTREE_OUTPUT
2445 --
2446 -- Cause GNAT to write the internal tree for a unit to a file (with the
2447 -- filetype ATB for a body or ATS for a spec). This is not normally
2448 -- required, but is used by separate analysis tools. Typically these
2449 -- tools do the necessary compilations automatically, so you should never
2450 -- have to specify this switch in normal operation.
2454 -- /TRY_SEMANTICS
2455 -- /NOTRY_SEMANTICS
2456 --
2457 -- In normal operation mode the compiler first parses the program and
2458 -- determines if there are any syntax errors. If there are, appropriate
2459 -- error messages are generated and compilation is immediately
2460 -- terminated. This qualifier tells GNAT to continue with semantic
2461 -- analysis even if syntax errors have been found. This may enable the
2462 -- detection of more errors in a single run. On the other hand, the
2463 -- semantic analyzer is more likely to encounter some internal fatal
2464 -- error when given a syntactically invalid tree.
2468 -- /NOUNITS_LIST (D)
2469 -- /UNITS_LIST
2470 --
2471 -- Print a list of units required by this compilation on SYS$OUTPUT. The
2472 -- listing includes all units on which the unit being compiled depends
2473 -- either directly or indirectly.
2477 -- /NOUNIQUE_ERROR_TAG (D)
2478 -- /UNIQUE_ERROR_TAG
2479 --
2480 -- Tag compiler error messages with the string "error: ".
2484 -- /NOUPPERCASE_EXTERNALS (D)
2485 -- /UPPERCASE_EXTERNALS
2486 --
2487 -- Fold default and explicit external names in pragmas Import and Export
2488 -- to uppercase for compatibility with the default behavior of DEC C.
2535 -- /VALIDITY_CHECKING[=(keyword,[...])]
2536 --
2537 -- Control level of validity checking.
2538 --
2539 -- DEFAULT (D) In this mode checks are made to prevent
2540 -- erroneous behavior in accordance with the RM.
2541 -- Notably extra checks may be needed for case
2542 -- statements and subscripted array assignments.
2543 --
2544 -- NONE No special checks for invalid values are
2545 -- performed. This means that references to
2546 -- uninitialized variables can cause erroneous
2547 -- behavior from constructs like case statements
2548 -- and subscripted array assignments. In this
2549 -- mode, invalid values can lead to erroneous
2550 -- behavior.
2551 --
2552 -- FULL Every assignment is checked for validity, so
2553 -- that it is impossible to assign invalid values.
2554 -- The RM specifically allows such assignments,
2555 -- but in this mode, invalid values can never be
2556 -- assigned, and an attempt to perform such an
2557 -- assignment immediately raises Constraint_Error.
2558 -- This behavior is allowed (but not required) by
2559 -- the RM. This mode is intended as a debugging aid,
2560 -- and may be useful in helping to track down
2561 -- uninitialized variables. It may be useful to
2562 -- use this in conjunction with the Normalize_Scalars
2563 -- pragma which attempts to initialize with invalid
2564 -- values where possible.
2568 -- /VERBOSE
2569 -- /NOVERBOSE
2570 --
2571 -- Show commands generated by the GCC driver. Normally used only for
2572 -- debugging purposes or if you need to be sure what version of the
2573 -- compiler you are executing.
2577 -- /NOASM (D)
2578 -- /ASM
2579 --
2580 -- Use to cause the assembler source file to be generated, using S as the
2581 -- filetype, instead of the object file. This may be useful if you need
2582 -- to examine the generated assembly code.
2701 -- /NOWARNINGS
2702 --
2703 -- Suppress the output of all warning messages from the GNAT front end.
2704 -- Note that it does not suppress warnings from the gcc back end.
2705 --
2706 -- /WARNINGS[=(keyword[,...])]
2707 --
2708 -- In addition to error messages, corresponding to illegalities as
2709 -- defined in the reference manual, the compiler detects two kinds of
2710 -- warning situations. First, the compiler considers some constructs
2711 -- suspicious and generates a warning message to alert you to a possible
2712 -- error. Second, if the compiler detects a situation that is sure to
2713 -- raise an exception at runtime, it generates a warning message.
2714 --
2715 -- You may specify the following keywords to change this behavior:
2716 --
2717 -- DEFAULT (D) The default behavior above.
2718 --
2719 -- ALL Activate all optional warnings.
2720 -- Activates most optional warning messages,
2721 -- see remaining list in this section for
2722 -- details on optional warning messages that
2723 -- can be individually controlled.
2724 -- The warnings that are not turned on by
2725 -- this option are BIASED_ROUNDING,
2726 -- IMPLICIT_DEREFERENCE, HIDING and
2727 -- ELABORATION. All other optional Ada
2728 -- warnings are turned on.
2729 --
2730 -- NOALL Suppress all optional errors.
2731 -- Suppresses all optional warning messages
2732 -- that can be activated by option ALL.
2733 --
2734 -- ALL_GCC Request additional messages from the GCC
2735 -- backend. Most of these are not relevant
2736 -- to Ada.
2737 --
2738 -- CONDITIONALS Activate warnings for conditional
2739 -- Expressions used in tests that are known
2740 -- to be True or False at compile time. The
2741 -- default is that such warnings are not
2742 -- generated.
2743 --
2744 -- NOCONDITIONALS Suppress warnings for conditional
2745 -- expressions used in tests that are known
2746 -- to be True or False at compile time.
2747 --
2748 -- IMPLICIT_DEREFERENCE Activate warnings on implicit dereferencing.
2749 -- The use of a prefix of an access type in an
2750 -- indexed component, slice, or selected component
2751 -- without an explicit .all will generate
2752 -- a warning. With this warning enabled, access
2753 -- checks occur only at points where an explicit
2754 -- .all appears in the source code (assuming no
2755 -- warnings are generated as a result of this
2756 -- option). The default is that such warnings are
2757 -- not generated. Note that /WARNINGS=ALL does not
2758 -- affect the setting of this warning option.
2759 --
2760 -- NOIMPLICIT_DEREFERENCE Suppress warnings on implicit dereferencing.
2761 -- in indexed components, slices, and selected
2762 -- components.
2763 --
2764 -- ELABORATION Activate warnings on missing pragma
2765 -- Elaborate_All statements. The default is
2766 -- that such warnings are not generated.
2767 --
2768 -- NOELABORATION Suppress warnings on missing pragma
2769 -- Elaborate_All statements.
2770 --
2771 -- ERRORS Warning messages are to be treated as errors.
2772 -- The warning string still appears, but the
2773 -- warning messages are counted as errors, and
2774 -- prevent the generation of an object file.
2775 --
2776 -- HIDING Activate warnings on hiding declarations.
2777 -- A declaration is considered hiding if it is
2778 -- for a non-overloadable entity, and it declares
2779 -- an entity with the same name as some other
2780 -- entity that is directly or use-visible. The
2781 -- default is that such warnings are not
2782 -- generated.
2783 --
2784 -- NOHIDING Suppress warnings on hiding declarations.
2785 --
2786 -- IMPLEMENTATION Activate warnings for a with of an internal
2787 -- GNAT implementation unit, defined as any unit
2788 -- from the Ada, Interfaces, GNAT, DEC or
2789 -- System hierarchies that is not documented in
2790 -- either the Ada Reference Manual or the GNAT
2791 -- Programmer's Reference Manual. Such units are
2792 -- intended only for internal implementation
2793 -- purposes and should not be with'ed by user
2794 -- programs. The default is that such warnings
2795 -- are generated.
2796 --
2797 -- NOIMPLEMENTATION Disables warnings for a with of an internal
2798 -- GNAT implementation unit.
2799 --
2800 -- INEFFECTIVE_INLINE Activate warnings on ineffective pragma Inlines
2801 -- Activates warnings for failure of front end
2802 -- inlining (activated by /INLINE=FULL) to inline
2803 -- a particular call. There are many reasons for
2804 -- not being able to inline a call, including most
2805 -- commonly that the call is too complex to
2806 -- inline. This warning can also be turned on
2807 -- using /INLINE=FULL.
2808 --
2809 -- NOINEFFECTIVE_INLINE Suppress warnings on ineffective pragma Inlines
2810 -- Suppresses warnings on ineffective pragma
2811 -- Inlines. If the inlining mechanism cannot
2812 -- inline a call, it will simply ignore the
2813 -- request silently.
2814 --
2815 -- MISSING_COMPONENT_CLAUSES
2816 -- Activate warnings for cases when there are
2817 -- component clauses for a record type, but not
2818 -- for every component of the record.
2819 --
2820 -- NOMISSING_COMPONENT_CLAUSES
2821 -- Suppress warnings for cases when there are
2822 -- missing component clauses for a record type.
2823 --
2824 -- MISSING_PARENS
2825 -- Activate warnings for cases where parentheses
2826 -- are not used and the result is potential
2827 -- ambiguity from a reader's point of view.
2828 -- For example (not a > b) when a and b are
2829 -- modular means (not (a) > b) and very likely
2830 -- the programmer intended (not (a > b)).
2831 --
2832 -- NOMISSING_PARENS
2833 -- Suppress warnings for cases where parentheses
2834 -- are not used and the result is potential
2835 -- ambiguity from a reader's point of view.
2836 --
2837 -- MODIFIED_UNREF Activates warnings for variables that are
2838 -- assigned (using an initialization value or with
2839 -- one or more assignment statements) but whose
2840 -- value is never read. The warning is suppressed
2841 -- for volatile variables and also for variables
2842 -- that are renamings of other variables or for
2843 -- which an address clause is given. This warning
2844 -- can also be turned on using /WARNINGS/OPTIONAL.
2845 --
2846 -- NOMODIFIED_UNREF Disables warnings for variables that are
2847 -- assigned or initialized, but never read.
2848 --
2849 -- NORMAL Sets normal warning mode, in which enabled
2850 -- warnings are issued and treated as warnings
2851 -- rather than errors. This is the default mode.
2852 -- It can be used to cancel the effect of an
2853 -- explicit /WARNINGS=SUPPRESS or
2854 -- /WARNINGS=ERRORS. It also cancels the effect
2855 -- of the implicit /WARNINGS=ERRORS that is
2856 -- activated by the use of /STYLE=GNAT.
2857 --
2858 -- OBSOLESCENT Activates warnings for calls to subprograms
2859 -- marked with pragma Obsolescent and for use of
2860 -- features in Annex J of the Ada Reference
2861 -- Manual. In the case of Annex J, not all
2862 -- features are flagged. In particular use of the
2863 -- renamed packages (like Text_IO), use of package
2864 -- ASCII and use of the attribute 'Constrained are
2865 -- not flagged, since these are very common and
2866 -- would generate many annoying positive warnings.
2867 -- The default is that such warnings are not
2868 -- generated.
2869 --
2870 -- NOOBSOLESCENT Disables warnings on use of obsolescent
2871 -- features.
2872 --
2873 -- OPTIONAL Activate all optional warning messages.
2874 -- See other options under this qualifier
2875 -- for details on optional warning messages
2876 -- that can be individually controlled. The
2877 -- one exception is that /WARNINGS=OPTIONAL
2878 -- doesn't activate warnings for hiding
2879 -- variables (/WARNINGS=HIDING), so if this
2880 -- warning is required it must be explicitly
2881 -- set.
2882 --
2883 -- NOOPTIONAL Suppress all optional warning messages.
2884 -- See other options under this qualifier
2885 -- for details on optional warning messages
2886 -- that can be individually controlled.
2887 --
2888 -- OVERLAYS Activate warnings for possibly unintended
2889 -- initialization effects of defining address
2890 -- clauses that cause one variable to overlap
2891 -- another. The default is that such warnings
2892 -- are generated.
2893 --
2894 -- NOOVERLAYS Suppress warnings on possibly unintended
2895 -- initialization effects of defining address
2896 -- clauses that cause one variable to overlap
2897 -- another.
2898 --
2899 -- REDUNDANT Activate warnings for redundant constructs.
2900 -- In particular assignments of a variable to
2901 -- itself, and a type conversion that converts
2902 -- an object to its own type. The default
2903 -- is that such warnings are not generated.
2904 --
2905 -- NOREDUNDANT Suppress warnings for redundant constructs.
2906 --
2907 -- SUPPRESS Completely suppresse the output of all warning
2908 -- messages. Same as /NOWARNINGS.
2909 --
2910 -- UNCHECKED_CONVERSIONS Activates warnings on unchecked conversions.
2911 -- Causes warnings to be generated for
2912 -- unchecked conversions when the two types are
2913 -- known at compile time to have different sizes.
2914 -- The default is that such warnings are
2915 -- generated.
2916 --
2917 -- NOUNCHECKED_CONVERSIONS Suppress warnings for unchecked conversions.
2918 --
2919 -- UNINITIALIZED Generate warnings for uninitialized variables.
2920 -- This is a GCC option, not an Ada option.
2921 -- You must also specify the /OPTIMIZE qualifier
2922 -- with a value other than NONE (in other words,
2923 -- this keyword works only if optimization is
2924 -- turned on).
2925 --
2926 -- UNREFERENCED_FORMALS Activate warnings on unreferenced formals.
2927 -- Causes a warning to be generated if a formal
2928 -- parameter is not referenced in the body of
2929 -- the subprogram. This warning can also be turned
2930 -- on using option ALL or UNUSED.
2931 --
2932 -- NOUNREFERENCED_FORMALS Suppress warnings on unreferenced formals.
2933 -- Suppresses warnings for unreferenced formal
2934 -- parameters. Note that the combination UNUSED
2935 -- followed by NOUNREFERENCED_FORMALS has the
2936 -- effect of warning on unreferenced entities
2937 -- other than subprogram formals.
2938 --
2939 -- UNUSED Activates warnings to be generated for entities
2940 -- that are defined but not referenced, and for
2941 -- units that are with'ed and not referenced. In
2942 -- the case of packages, a warning is also
2943 -- generated if no entities in the package are
2944 -- referenced. This means that if the package
2945 -- is referenced but the only references are in
2946 -- use clauses or renames declarations, a warning
2947 -- is still generated. A warning is also generated
2948 -- for a generic package that is with'ed but never
2949 -- instantiated. In the case where a package or
2950 -- subprogram body is compiled, and there is a
2951 -- with on the corresponding spec that is only
2952 -- referenced in the body, a warning is also
2953 -- generated, noting that the with can be moved
2954 -- to the body. The default is that such warnings
2955 -- are not generated.
2956 --
2957 -- NOUNUSED Suppress warnings for unused entities and
2958 -- packages.
2959 --
2960 -- VARIABLES_UNINITIALIZED Activates warnings on unassigned variables.
2961 -- Causes warnings to be generated when a variable
2962 -- is accessed which may not be properly
2963 -- uninitialized.
2964 -- The default is that such warnings are
2965 -- generated.
2966 --
2967 -- NOVARIABLES_UNINITIALIZED Suppress warnings for uninitialized
2968 -- variables.
2972 -- NODOC (see /WARNINGS)
2976 -- /NO_BACK_END_WARNINGS
2977 --
2978 -- Inhibit all warning messages of the GCC back-end.
2993 -- /NOWIDE_CHARACTER_ENCODING (D)
2994 -- /WIDE_CHARACTER_ENCODING[=encode-type]
2995 --
2996 -- Specifies the mechanism used to encode wide characters. 'encode-type'
2997 -- is one of the following:
2998 --
2999 -- BRACKETS (D) A wide character is encoded as ["xxxx"] where XXXX
3000 -- are four hexadecimal digits representing the coding
3001 -- ('Pos value) of the character in type
3002 -- Wide_Character. The hexadecimal digits may use upper
3003 -- or lower case letters.
3004 --
3005 -- This notation can also be used for upper half
3006 -- Character values using the format ["xx"] where XX is
3007 -- two hexadecimal digits representing the coding ('Pos
3008 -- value) of the character in type Character (or
3009 -- Wide_Character). The hexadecimal digits may use upper
3010 -- of lower case.
3011 --
3012 -- NONE No wide characters are allowed. Same
3013 -- as /NOWIDE_CHARCTER_ENCODING.
3014 --
3015 -- HEX In this encoding, a wide character is represented by
3016 -- the following five character sequence: ESC a b c d
3017 -- Where 'a', 'b', 'c', and 'd' are the four hexadecimal
3018 -- characters (using uppercase letters) of the wide
3019 -- character code. For example, ESC A345 is used to
3020 -- represent the wide character with code 16#A345#. This
3021 -- scheme is compatible with use of the full
3022 -- Wide_Character set.
3023 --
3024 -- UPPER The wide character with encoding 16#abcd# where the
3025 -- upper bit is on (in other words, "a" is in the range
3026 -- 8-F) is represented as two bytes, 16#ab# and 16#cd#.
3027 -- The second byte may never be a format control
3028 -- character, but is not required to be in the upper
3029 -- half. This method can be also used for shift-JIS or
3030 -- EUC, where the internal coding matches the external
3031 -- coding.
3032 --
3033 -- SHIFT_JIS A wide character is represented by a two-character
3034 -- sequence, 16#ab# and 16#cd#, with the restrictions
3035 -- described for upper-half encoding as described above.
3036 -- The internal character code is the corresponding JIS
3037 -- character according to the standard algorithm for
3038 -- Shift-JIS conversion. Only characters defined in the
3039 -- JIS code set table can be used with this encoding
3040 -- method.
3041 --
3042 -- UTF8 A wide character is represented using
3043 -- UCS Transformation Format 8 (UTF-8) as defined in Annex
3044 -- R of ISO 10646-1/Am.2. Depending on the character
3045 -- value, the representation is a one, two, or three byte
3046 -- sequence:
3047 --
3048 -- 16#0000#-16#007f#: 2#0xxxxxxx#
3049 -- 16#0080#-16#07ff#: 2#110xxxxx# 2#10xxxxxx#
3050 -- 16#0800#-16#ffff#: 2#1110xxxx# 2#10xxxxxx# 2#10xxxxxx#
3051 --
3052 -- where the xxx bits correspond to the left-padded bits
3053 -- of the the 16-bit character value. Note that all lower
3054 -- half ASCII characters are represented as ASCII bytes
3055 -- and all upper half characters and other wide characters
3056 -- are represented as sequences of upper-half (The full
3057 -- UTF-8 scheme allows for encoding 31-bit characters as
3058 -- 6-byte sequences, but in this implementation, all UTF-8
3059 -- sequences of four or more bytes length will be treated
3060 -- as illegal).
3061 --
3062 -- EUC A wide character is represented by a two-character
3063 -- sequence 16#ab# and 16#cd#, with both characters being
3064 -- in the upper half. The internal character code is the
3065 -- corresponding JIS character according to the EUC
3066 -- encoding algorithm. Only characters defined in the JIS
3067 -- code set table can be used with this encoding method.
3071 -- NODOC (see /WIDE_CHARACTER_ENCODING)
3075 -- /NOXDEBUG (D)
3076 -- /XDEBUG
3077 --
3078 -- Output expanded source files for source level debugging.
3079 -- The expanded source (see /EXPAND_SOURCE) is written to files
3080 -- with names formed by appending "_DG" to the input file name,
3081 -- The debugging information generated by the /DEBUG qualifier will then
3082 -- refer to the generated file. This allows source level debugging using
3083 -- the generated code which is sometimes useful for complex code, for
3084 -- example to find out exactly which part of a complex construction
3085 -- raised an exception.
3092 -- /XREF[=keyword]
3093 --
3094 -- Normally the compiler generates full cross-referencing information in
3095 -- the .ALI file. This information is used by a number of tools,
3096 -- including GNAT FIND and GNAT XREF.
3097 --
3098 -- GENERATE (D) Generate cross-referencing information.
3099 --
3100 -- SUPPRESS Suppress cross-referencing information.
3101 -- This saves some space and may slightly
3102 -- speed up compilation, but means that some
3103 -- tools cannot be used.
3108 S_GCC_Ada_05 'Access,
3110 S_GCC_Asm 'Access,
3112 S_GCC_ChecksX 'Access,
3114 S_GCC_Config 'Access,
3116 S_GCC_Debug 'Access,
3118 S_GCC_Data 'Access,
3120 S_GCC_DistX 'Access,
3122 S_GCC_ErrorX 'Access,
3124 S_GCC_Extend 'Access,
3126 S_GCC_File 'Access,
3128 S_GCC_Full 'Access,
3130 S_GCC_Help 'Access,
3132 S_GCC_IdentX 'Access,
3134 S_GCC_Immed 'Access,
3136 S_GCC_InlineX 'Access,
3138 S_GCC_Just 'Access,
3140 S_GCC_Length 'Access,
3142 S_GCC_Output 'Access,
3144 S_GCC_Mess 'Access,
3146 S_GCC_Noadc 'Access,
3148 S_GCC_Nostinc 'Access,
3150 S_GCC_Opt 'Access,
3152 S_GCC_Polling 'Access,
3154 S_GCC_Psta 'Access,
3156 S_GCC_ReportX 'Access,
3158 S_GCC_RepinfX 'Access,
3160 S_GCC_Search 'Access,
3162 S_GCC_StyleX 'Access,
3164 S_GCC_Syntax 'Access,
3166 S_GCC_Trace 'Access,
3168 S_GCC_Trys 'Access,
3170 S_GCC_Unique 'Access,
3172 S_GCC_Valid 'Access,
3175 S_GCC_Warn 'Access,
3177 S_GCC_Wide 'Access,
3179 S_GCC_No_Back 'Access,
3181 S_GCC_Xref 'Access);
3183 ----------------------------
3184 -- Switches for GNAT ELIM --
3185 ----------------------------
3187 S_Elim_Add : aliased constant S := "/ADD_PROJECT_SEARCH_DIR=*" &
3188 "-aP*";
3189 -- /ADD_PROJECT_SEARCH_PATH==(directory[,...])
3190 --
3191 -- Add directories to the project search path.
3193 S_Elim_All : aliased constant S := "/ALL " &
3194 "-a";
3195 -- /NOALL (D)
3196 -- /ALL
3197 --
3198 -- Also look for subprograms from the GNAT run time that can be
3200 -- the entire program must be recompiled with qualifier /ALL_FILES of
3201 -- GNAT MAKE.
3203 S_Elim_Bind : aliased constant S := "/BIND_FILE=<" &
3204 "-b>";
3205 -- /BIND_FILE=file_name
3206 --
3207 -- Specifies file_name as the bind file to process. If this qualifier is
3208 -- not used, the name of the bind file is computed from the full expanded
3209 -- Ada name of a main subprogram.
3211 S_Elim_Comp : aliased constant S := "/COMPILER=@" &
3212 "--GCC=@";
3213 -- /COMPILER=path_name
3214 --
3215 -- Instructs GNAT ELIM to use a specific gcc compiler instead of one
3216 -- available on the path.
3218 S_Elim_Config : aliased constant S := "/CONFIGURATION_PRAGMAS=<" &
3219 "-C>";
3220 -- /CONFIGURATION_PRAGMAS=path_name
3221 --
3222 -- Specifies a file that contains configuration pragmas.
3223 -- The file must be specified with absolute path.
3225 S_Elim_Current : aliased constant S := "/CURRENT_DIRECTORY " &
3226 "!-I-";
3227 -- /CURRENT_DIRECTORY (D)
3228 -- /NOCURRENT_DIRECTORY
3229 --
3230 -- Look for source files in the default directory.
3234 -- /EXTERNAL_REFERENCE="name=val"
3235 --
3236 -- Specifies an external reference to the project manager. Useful only if
3237 -- /PROJECT_FILE is used.
3238 --
3239 -- Example:
3240 -- /EXTERNAL_REFERENCE="DEBUG=TRUE"
3242 S_Elim_GNATMAKE : aliased constant S := "/GNATMAKE=@" &
3243 "--GNATMAKE=@";
3244 -- /GNATMAKE=path_name
3245 --
3246 -- Instructs GNAT MAKE to use a specific gnatmake instead of one available
3247 -- on the path.
3249 S_Elim_Mess : aliased constant S := "/MESSAGES_PROJECT_FILE=" &
3250 "DEFAULT " &
3251 "-vP0 " &
3252 "MEDIUM " &
3253 "-vP1 " &
3254 "HIGH " &
3255 "-vP2";
3256 -- /MESSAGES_PROJECT_FILE[=messages-option]
3257 --
3258 -- Specifies the "verbosity" of the parsing of project files.
3259 -- messages-option may be one of the following:
3260 --
3261 -- DEFAULT (D) No messages are output if there is no error or warning.
3262 --
3263 -- MEDIUM A small number of messages are output.
3264 --
3265 -- HIGH A great number of messages are output, most of them not
3266 -- being useful for the user.
3268 S_Elim_Project : aliased constant S := "/PROJECT_FILE=<" &
3269 "-P>";
3270 -- /PROJECT_FILE=filename
3271 --
3272 -- Specifies the main project file to be used. The project files rooted
3273 -- at the main project file will be parsed before the invocation of the
3274 -- gnatelim. The source directories to be searched will be communicated
3275 -- to gnatelim through logical name ADA_PRJ_INCLUDE_FILE.
3277 S_Elim_Quiet : aliased constant S := "/QUIET " &
3278 "-q";
3279 -- /NOQUIET (D)
3280 -- /QUIET
3281 --
3282 -- Quiet mode: by default GNAT ELIM outputs to the standard error stream
3283 -- the number of program units left to be processed. This option turns
3284 -- this trace off.
3286 S_Elim_Search : aliased constant S := "/SEARCH=*" &
3287 "-I*";
3288 -- /SEARCH=(directory, ...)
3289 --
3290 -- When looking for source files also look in the specified directories.
3292 S_Elim_Verb : aliased constant S := "/VERBOSE " &
3293 "-v";
3294 -- /NOVERBOSE (D)
3295 -- /VERBOSE
3296 --
3297 -- Verbose mode: GNAT ELIM version information is output as Ada comments
3298 -- to the standard output stream. Also, in addition to the number of
3299 -- program units left, GNAT ELIM will output the name of the current unit
3300 -- being processed.
3302 Elim_Switches : aliased constant Switches :=
3304 S_Elim_All 'Access,
3306 S_Elim_Comp 'Access,
3308 S_Elim_Current 'Access,
3311 S_Elim_Mess 'Access,
3313 S_Elim_Quiet 'Access,
3315 S_Elim_Verb 'Access);
3317 ----------------------------
3318 -- Switches for GNAT FIND --
3319 ----------------------------
3321 S_Find_Add : aliased constant S := "/ADD_PROJECT_SEARCH_DIR=*" &
3322 "-aP*";
3323 -- /ADD_PROJECT_SEARCH_PATH==(directory[,...])
3324 --
3325 -- Add directories to the project search path.
3327 S_Find_All : aliased constant S := "/ALL_FILES " &
3328 "-a";
3329 -- /NOALL_FILES (D)
3330 -- /ALL_FILES
3331 --
3332 -- If this switch is present, FIND and XREF will parse the read-only
3333 -- files found in the library search path. Otherwise, these files will
3334 -- be ignored. This option can be used to protect Gnat sources or your
3335 -- own libraries from being parsed, thus making FIND and XREF much
3336 -- faster, and their output much smaller.
3338 S_Find_Deriv : aliased constant S := "/DERIVED_TYPE_INFORMATION " &
3339 "-d";
3340 -- /NODERIVED_TYPE_INFORMATION (D)
3341 -- /DERIVED_TYPE_INFORMATION
3342 --
3343 -- Output the parent type reference for each matching derived types.
3345 S_Find_Expr : aliased constant S := "/EXPRESSIONS " &
3346 "-e";
3347 -- /NOEXPRESSIONS (D)
3348 -- /EXPRESSIONS
3349 --
3350 -- By default, FIND accepts the simple regular expression set for pattern.
3351 -- If this switch is set, then the pattern will be considered as a full
3352 -- Unix-style regular expression.
3356 -- /EXTERNAL_REFERENCE="name=val"
3357 --
3358 -- Specifies an external reference to the project manager. Useful only if
3359 -- /PROJECT_FILE is used.
3360 --
3361 -- Example:
3362 -- /EXTERNAL_REFERENCE="DEBUG=TRUE"
3364 S_Find_Full : aliased constant S := "/FULL_PATHNAME " &
3365 "-f";
3366 -- /NOFULL_PATHNAME (D)
3367 -- /FULL_PATHNAME
3368 --
3369 -- If this switch is set, the output file names will be preceded by their
3370 -- directory (if the file was found in the search path). If this switch
3371 -- is not set, the directory will not be printed.
3373 S_Find_Ignore : aliased constant S := "/IGNORE_LOCALS " &
3374 "-g";
3375 -- /NOIGNORE_LOCALS (D)
3376 -- /IGNORE_LOCALS
3377 --
3378 -- If this switch is set, information is output only for library-level
3379 -- entities, ignoring local entities. The use of this switch may
3380 -- accelerate FIND and XREF.
3382 S_Find_Mess : aliased constant S := "/MESSAGES_PROJECT_FILE=" &
3383 "DEFAULT " &
3384 "-vP0 " &
3385 "MEDIUM " &
3386 "-vP1 " &
3387 "HIGH " &
3388 "-vP2";
3389 -- /MESSAGES_PROJECT_FILE[=messages-option]
3390 --
3391 -- Specifies the "verbosity" of the parsing of project files.
3392 -- messages-option may be one of the following:
3393 --
3394 -- DEFAULT (D) No messages are output if there is no error or warning.
3395 --
3396 -- MEDIUM A small number of messages are output.
3397 --
3398 -- HIGH A great number of messages are output, most of them not
3399 -- being useful for the user.
3401 S_Find_Nostinc : aliased constant S := "/NOSTD_INCLUDES " &
3402 "-nostdinc";
3403 -- /NOSTD_INCLUDES
3404 --
3405 -- Do not look for sources in the system default directory.
3407 S_Find_Nostlib : aliased constant S := "/NOSTD_LIBRARIES " &
3408 "-nostdlib";
3409 -- /NOSTD_LIBRARIES
3410 --
3411 -- Do not look for library files in the system default directory.
3413 S_Find_Object : aliased constant S := "/OBJECT_SEARCH=*" &
3414 "-aO*";
3415 -- /OBJECT_SEARCH=(directory,...)
3416 --
3417 -- When searching for library and object files, look in the specified
3418 -- directories. The order in which library files are searched is the same
3419 -- as for MAKE.
3421 S_Find_Print : aliased constant S := "/PRINT_LINES " &
3422 "-s";
3423 -- /NOPRINT_LINES (D)
3424 -- /PRINT_LINES
3425 --
3426 -- Output the content of the Ada source file lines were the entity was
3427 -- found.
3429 S_Find_Project : aliased constant S := "/PROJECT=@" &
3430 "-p@";
3431 -- /PROJECT=file
3432 --
3433 -- Specify a project file to use. By default, FIND and XREF will try to
3434 -- locate a project file in the current directory.
3435 --
3436 -- If a project file is either specified or found by the tools, then the
3437 -- content of the source directory and object directory lines are added
3438 -- as if they had been specified respectively by /SOURCE_SEARCH and
3439 -- /OBJECT_SEARCH.
3440 --
3441 -- This qualifier is not compatible with /PROJECT_FILE
3443 S_Find_Prj : aliased constant S := "/PROJECT_FILE=<" &
3444 "-P>";
3445 -- /PROJECT_FILE=filename
3446 --
3447 -- Specifies the main project file to be used. The project files rooted
3448 -- at the main project file will be parsed before looking for sources.
3449 -- The source and object directories to be searched will be communicated
3450 -- to gnatfind through logical names ADA_PRJ_INCLUDE_FILE and
3451 -- ADA_PRJ_OBJECTS_FILE.
3453 S_Find_Ref : aliased constant S := "/REFERENCES " &
3454 "-r";
3455 -- /NOREFERENCES (D)
3456 -- /REFERENCES
3457 --
3458 -- By default, FIND will output only the information about the
3459 -- declaration, body or type completion of the entities. If this switch
3460 -- is set, the FIND will locate every reference to the entities in the
3461 -- files specified on the command line (or in every file in the search
3462 -- path if no file is given on the command line).
3464 S_Find_Search : aliased constant S := "/SEARCH=*" &
3465 "-I*";
3466 -- /SEARCH=(directory,...)
3467 --
3468 -- Equivalent to:
3469 -- /OBJECT_SEARCH=(directory,...) /SOURCE_SEARCH=(directory,...)
3471 S_Find_Source : aliased constant S := "/SOURCE_SEARCH=*" &
3472 "-aI*";
3473 -- /SOURCE_SEARCH=(directory,...)
3474 --
3475 -- When looking for source files also look in the specified directories.
3476 -- The order in which source file search is undertaken is the same as for
3477 -- MAKE.
3479 S_Find_Types : aliased constant S := "/TYPE_HIERARCHY " &
3480 "-t";
3481 -- /NOTYPE_HIERARCHY (D)
3482 -- /TYPE_HIERARCHY
3483 --
3484 -- Output the type hierarchy for the specified type. It acts like the
3485 -- /DERIVED_TYPE_INFORMATION qualifier, but recursively from parent type
3486 -- to parent type. When this qualifier is specified it is not possible to
3487 -- specify more than one file.
3489 Find_Switches : aliased constant Switches :=
3491 S_Find_All 'Access,
3493 S_Find_Expr 'Access,
3495 S_Find_Full 'Access,
3497 S_Find_Mess 'Access,
3499 S_Find_Nostlib 'Access,
3501 S_Find_Print 'Access,
3503 S_Find_Prj 'Access,
3505 S_Find_Search 'Access,
3507 S_Find_Types 'Access);
3509 ------------------------------
3510 -- Switches for GNAT KRUNCH --
3511 ------------------------------
3513 S_Krunch_Count : aliased constant S := "/COUNT=#" &
3514 "`#";
3515 -- /COUNT=39 (D)
3516 -- /COUNT=nnn
3517 --
3518 -- Limit file names to nnn characters (where nnn is a decimal
3519 -- integer). The maximum file name length is 39, but if you want to
3520 -- generate a set of files that would be usable if ported to a system
3521 -- with some different maximum file length, then a different value can
3522 -- be specified.
3524 Krunch_Switches : aliased constant Switches :=
3527 ----------------------------
3528 -- Switches for GNAT LINK --
3529 ----------------------------
3533 -- /ADD_PROJECT_SEARCH_PATH==(directory[,...])
3534 --
3535 -- Add directories to the project search path.
3542 -- /BIND_FILE=[bind-file-option]
3543 --
3544 -- Specifies the language of the binder generated file.
3545 --
3546 -- ADA (D) Binder file is Ada.
3547 --
3548 -- C Binder file is 'C'.
3559 -- /NODEBUG (D)
3560 -- /DEBUG[=debug-option]
3561 --
3562 -- Specifies the amount of debugging information included. 'debug-option'
3563 -- is one of the following:
3564 --
3565 -- ALL (D) Include full debugging information.
3566 --
3567 -- NONE Provide no debugging information. Same as /NODEBUG.
3568 --
3569 -- TRACEBACK Provide sufficient debug information for a traceback.
3570 --
3571 -- NOTRACEBACK Same as NONE.
3575 -- NODOC (see /DEBUG)
3579 -- /EXECUTABLE=exec-name
3580 --
3581 -- 'exec-name' specifies an alternative name for the generated executable
3582 -- program. If this qualifier switch is omitted, the executable is called
3583 -- the name of the main unit. So "$ GNAT LINK TRY.ALI" creates an
3584 -- executable called TRY.EXE.
3588 -- /EXTERNAL_REFERENCE="name=val"
3589 --
3590 -- Specifies an external reference to the project manager. Useful only if
3591 -- /PROJECT_FILE is used.
3592 --
3593 -- Example:
3594 -- /EXTERNAL_REFERENCE="DEBUG=TRUE"
3598 -- /FOR_LINKER=<string>
3599 --
3600 -- Transmit the option <string> to the underlying linker.
3604 -- /NOFORCE_OBJECT_FILE_LIST (D)
3605 -- /FORCE_OBJECT_FILE_LIST
3606 --
3607 -- Forces the generation of a file that contains commands for the linker.
3608 -- This is useful in some cases to deal with special situations where the
3609 -- command line length is exceeded.
3614 -- /IDENTIFICATION="<string>"
3615 --
3616 -- "<string>" specifies the string to be stored in the image file ident-
3617 -- ification field in the image header. It overrides any pragma Ident
3618 -- specified string.
3622 -- /LIBDIR=(directory, ...)
3623 --
3624 -- Look for libraries in the specified directories.
3628 -- /LYBRARY=xyz
3629 --
3630 -- Link with library named "xyz".
3639 -- /MESSAGES_PROJECT_FILE[=messages-option]
3640 --
3641 -- Specifies the "verbosity" of the parsing of project files.
3642 -- messages-option may be one of the following:
3643 --
3644 -- DEFAULT (D) No messages are output if there is no error or warning.
3645 --
3646 -- MEDIUM A small number of messages are output.
3647 --
3648 -- HIGH A great number of messages are output, most of them not
3649 -- being useful for the user.
3653 -- /NOCOMPILE
3654 --
3655 -- Do not compile the file generated by the binder.
3656 -- This may be used when a link is rerun with different options,
3657 -- but there is no need to recompile the binder generated file.
3661 -- /NOINHIBIT-EXEC
3662 --
3663 -- Delete executable if there are errors or warnings.
3667 -- /NOSTART_FILES
3668 --
3669 -- Link in default image initialization and startup functions.
3673 -- /PROJECT_FILE=filename
3674 --
3675 -- Specifies the main project file to be used. The project files rooted
3676 -- at the main project file will be parsed before the invocation of the
3677 -- linker.
3678 -- The source and object directories to be searched will be communicated
3679 -- to the linker through logical names ADA_PRJ_INCLUDE_FILE and
3680 -- ADA_PRJ_OBJECTS_FILE.
3687 -- /RETURN_CODES=POSIX (D)
3688 -- /RETURN_CODES=VMS
3689 --
3690 -- Specifies the style of codes returned by
3691 -- Ada.Command_Line.Set_Exit_Status. Must be used in conjunction with
3692 -- and match the Bind qualifer with the same name.
3693 --
3694 -- POSIX (D) Return Posix compatible exit codes.
3695 --
3696 -- VMS Return VMS compatible exit codes. The value returned
3697 -- is identically equal to the Set_Exit_Status parameter.
3701 -- /NOSTATIC (D)
3702 -- /STATIC
3703 --
3704 -- Indicate to the linker that the link is static.
3708 -- /NOVERBOSE (D)
3709 -- /VERBOSE
3710 --
3711 -- Causes additional information to be output, including a full list of
3712 -- the included object files. This switch option is most useful when you
3713 -- want to see what set of object files are being used in the link step.
3717 -- /<other>
3718 --
3719 -- Any other switch that will be transmited to the underlying linker.
3724 S_Link_Debug 'Access,
3726 S_Link_Execut 'Access,
3728 S_Link_Forlink 'Access,
3730 S_Link_Ident 'Access,
3732 S_Link_Library 'Access,
3734 S_Link_Nocomp 'Access,
3736 S_Link_Noinhib 'Access,
3738 S_Link_Return 'Access,
3740 S_Link_Verb 'Access,
3743 ----------------------------
3744 -- Switches for GNAT LIST --
3745 ----------------------------
3749 -- /ADD_PROJECT_SEARCH_PATH==(directory[,...])
3750 --
3751 -- Add directories to the project search path.
3755 -- /NOALL_UNITS (D)
3756 -- /ALL_UNITS
3757 --
3758 -- Consider all units, including those of the predefined Ada library.
3759 -- Especially useful with /DEPENDENCIES.
3763 -- /NOALL_PROJECTS (D)
3764 -- /ALL_PROJECTS
3765 --
3766 -- When used with a project file and no file specified, indicate
3767 -- that gnatls should be called for all sources of all projects in
3768 -- the project tree.
3772 -- /CURRENT_DIRECTORY (D)
3773 -- /NOCURRENT_DIRECTORY
3774 --
3775 -- Look for source, library or object files in the default directory.
3779 -- /NODEPENDENCIES (D)
3780 -- /DEPENDENCIES
3784 -- /EXTERNAL_REFERENCE="name=val"
3785 --
3786 -- Specifies an external reference to the project manager. Useful only if
3787 -- /PROJECT_FILE is used.
3788 --
3789 -- Example:
3790 -- /EXTERNAL_REFERENCE="DEBUG=TRUE"
3794 -- /FILES=filename
3795 --
3796 -- Take as arguments the files that are listed in the specified
3797 -- text file.
3806 -- /MESSAGES_PROJECT_FILE[=messages-option]
3807 --
3808 -- Specifies the "verbosity" of the parsing of project files.
3809 -- messages-option may be one of the following:
3810 --
3811 -- DEFAULT (D) No messages are output if there is no error or warning.
3812 --
3813 -- MEDIUM A small number of messages are output.
3814 --
3815 -- HIGH A great number of messages are output, most of them not
3816 -- being useful for the user.
3820 -- /NOSTD_INCLUDES
3821 --
3822 -- Do not look for sources of the run time in the standard directory.
3826 -- /OBJECT_SEARCH=(directory,...)
3827 --
3828 -- When looking for library and object files look also in the specified
3829 -- directories.
3844 -- /OUTPUT=(option,option,...)
3845 --
3846 -- SOURCES (D) Only output information about source files.
3847 --
3848 -- DEPEND List sources from which specified units depend on.
3849 --
3850 -- OBJECTS Only output information about object files.
3851 --
3852 -- UNITS Only output information about compilation units.
3853 --
3854 -- OPTIONS Output the list of options.
3855 --
3856 -- VERBOSE Output the complete source and object paths.
3857 -- Do not use the default column layout but instead
3858 -- use long format giving as much as information
3859 -- possible on each requested units, including
3860 -- special characteristics.
3864 -- /PROJECT_FILE=filename
3865 --
3866 -- Specifies the main project file to be used. The project files rooted
3867 -- at the main project file will be parsed before doing any listing.
3868 -- The source and object directories to be searched will be communicated
3869 -- to gnatlist through logical names ADA_PRJ_INCLUDE_FILE and
3870 -- ADA_PRJ_OBJECTS_FILE.
3874 -- /SEARCH=(directory,...)
3875 --
3876 -- Search the specified directories for both source and object files.
3880 -- /SOURCE_SEARCH=(directory,...)
3881 --
3882 -- When looking for source files also look in the specified directories.
3887 S_List_Allproj 'Access,
3889 S_List_Depend 'Access,
3891 S_List_Files 'Access,
3893 S_List_Nostinc 'Access,
3895 S_List_Output 'Access,
3897 S_List_Search 'Access,
3900 ----------------------------
3901 -- Switches for GNAT MAKE --
3902 ----------------------------
3911 -- /ACTIONS=(keyword[,...])
3912 --
3913 -- GNAT MAKE default behavior is to check if the sources are up to date,
3914 -- compile those sources that are not up to date, bind the main source,
3915 -- then link the executable.
3916 --
3917 -- With the /ACTIONS qualifier, GNAT MAKE may be restricted to one or
3918 -- two of these three steps:
3919 --
3920 -- o Compile
3921 -- o Bind
3922 -- o Link
3923 --
3924 --
3925 -- You may specify one or more of the following keywords to the /ACTIONS
3926 -- qualifier:
3927 --
3928 -- BIND Bind only. Can be combined with /ACTIONS=COMPILE
3929 -- to do compilation and binding, but no linking.
3930 -- Can be combined with /ACTIONS=LINK to do binding and
3931 -- linking. When not combined with /ACTIONS=COMPILE,
3932 -- all the units in the closure of the main program must
3933 -- have been previously compiled and must be up to date.
3934 --
3935 -- COMPILE Compile only. Do not perform binding, except when
3936 -- /ACTIONS=BIND is also specified. Do not perform
3937 -- linking, except if both /ACTIONS=BIND and /ACTIONS=LINK
3938 -- are also specified.
3939 --
3940 -- LINK Link only. Can be combined with /ACTIONS=BIND to do
3941 -- binding and linking. Linking will not be performed
3942 -- if combined with /ACTIONS=COMPILE but not with
3943 -- /ACTIONS=BIND\. When not combined with /ACTIONS=BIND
3944 -- all the units in the closure of the main program must
3945 -- have been previously compiled and must be up to date,
3946 -- and the main program need to have been bound.
3950 -- /ADD_PROJECT_SEARCH_PATH==(directory[,...])
3951 --
3952 -- Add directories to the project search path.
3956 -- /NOALL_FILES (D)
3957 -- /ALL_FILES
3958 --
3959 -- Consider all files in the make process, even the GNAT internal system
3960 -- files (for example, the predefined Ada library files). By default,
3961 -- GNAT MAKE does not check these files (however, if there is an
3962 -- installation problem, it will be caught when GNAT MAKE binds your
3963 -- program). You may have to specify this qualifier if you are working on
3964 -- GNAT itself. The vast majority of GNAT MAKE users never need to
3965 -- specify this switch. All GNAT internal files with will be compiled
3966 -- with /STYLE_CHECK=GNAT.
3970 -- /NOALL_PROJECTS (D)
3971 -- /ALL_PROJECTS
3972 --
3973 -- Implies /Unique.
3974 -- When used without project files, it is equivalent to /UNIQUE.
3975 -- When used with a project file with no main (neither on the command
3976 -- line nor in the attribute Main) check every source of every project,
3977 -- recompile all sources that are not up to date and rebuild libraries
3978 -- if necessary.
3982 -- /BINDER_QUALIFIERS
3983 --
3984 -- Any qualifiers specified after this qualifier other than
3985 -- /COMPILER_QUALIFIERS, /LINKER_QUALIFIERS and /MAKE_QUALIFIERS will be
3986 -- passed to any GNAT BIND commands generated by GNAT MAKE.
3990 -- /BND_LNK_FULL_PROJECT
3991 --
3992 -- Bind and link all sources of a project, without any consideration
3993 -- to attribute Main, if there is one. This qualifier need to be
3994 -- used in conjunction with the /PROJECT_FILE= qualifier and cannot
3995 -- be used with a main subprogram on the command line or for
3996 -- a library project file. As the binder is invoked with the option
3997 -- meaning "No Ada main subprogram", the user must ensure that the
3998 -- proper options are specified to the linker. This qualifier is
3999 -- normally used when the main subprogram is in a foreign language
4000 -- such as C.
4004 -- /COMPILER_QUALIFIERS
4005 --
4006 -- Any qualifiers specified after this qualifier other than
4007 -- /BINDER_QUALIFIERS, /LINKER_QUALIFIERS and /MAKE_QUALIFIERS will be
4008 -- passed to any GNAT COMPILE commands generated by GNAT MAKE.
4012 -- /CONDITIONAL_SOURCE_SEARCH=dir
4013 --
4014 -- Equivalent to "/SOURCE_SEARCH=dir /SKIP_MISSING=dir".
4018 -- /NOCONTINUE_ON_ERROR (D)
4019 -- /CONTINUE_ON_ERROR
4020 --
4021 -- Keep going. Continue as much as possible after a compilation error.
4022 -- To ease the programmer's task in case of compilation errors, the list
4023 -- of sources for which the compile fails is given when GNAT MAKE
4024 -- terminates.
4028 -- /CURRENT_DIRECTORY (D)
4029 -- /NOCURRENT_DIRECTORY
4030 --
4031 -- Look for source, library or object files in the default directory.
4035 -- /NODEPENDENCIES_LIST (D)
4036 -- /DEPENDENCIES_LIST
4037 --
4038 -- Check if all objects are up to date. If they are, output the object
4039 -- dependences to SYS$OUTPUT in a form that can be directly exploited in
4040 -- a Unix-style Makefile. By default, each source file is prefixed with
4041 -- its (relative or absolute) directory name. This name is whatever you
4042 -- specified in the various /SOURCE_SEARCH and /SEARCH qualifiers. If
4043 -- you also speficy the /QUIET qualifier, only the source file names,
4044 -- without relative paths, are output. If you just specify the
4045 -- /DEPENDENCY_LIST qualifier, dependencies of the GNAT internal system
4046 -- files are omitted. This is typically what you want. If you also
4047 -- specify the /ALL_FILES qualifier, dependencies of the GNAT internal
4048 -- files are also listed. Note that dependencies of the objects in
4049 -- external Ada libraries (see the /SKIP_MISSING qualifier) are never
4050 -- reported.
4054 -- /DIRECTORY_OBJECTS=<file>
4055 --
4056 -- Put all object files and .ALI files in <file>.
4057 -- This qualifier is not compatible with /PROJECT_FILE.
4061 -- /NODO_OBJECT_CHECK (D)
4062 -- /DO_OBJECT_CHECK
4063 --
4064 -- Don't compile, bind, or link. Output a single command that will
4065 -- recompile an out of date unit, if any. Repeated use of this option,
4066 -- followed by carrying out the indicated compilation, will eventually
4067 -- result in recompiling all required units.
4068 --
4069 -- If any ALI is missing during the process, GNAT MAKE halts and
4070 -- displays an error message.
4074 -- /EXECUTABLE=exec-name
4075 --
4076 -- The name of the final executable program will be 'exec_name'. If this
4077 -- qualifier is omitted the default name for the executable will be the
4078 -- name of the input file with an EXE filetype. You may prefix
4079 -- 'exec_name' with a relative or absolute directory path.
4083 -- /EXTERNAL_REFERENCE="name=val"
4084 --
4085 -- Specifies an external reference to the project manager. Useful only if
4086 -- /PROJECT_FILE is used.
4087 --
4088 -- Example:
4089 -- /EXTERNAL_REFERENCE="DEBUG=TRUE"
4093 -- /NOFORCE_COMPILE (D)
4094 -- /FORCE_COMPILE
4095 --
4096 -- Force recompilations. Recompile all sources, even though some object
4097 -- files may be up to date, but don't recompile predefined or GNAT
4098 -- internal files unless the /ALL_FILES qualfier is also specified.
4102 -- /NOFULL_PATH_IN_BRIEF_MESSAGES (D)
4103 -- /FULL_PATH_IN_BRIEF_MESSAGES
4104 --
4105 -- When using project files, if some errors or warnings are detected
4106 -- during parsing and verbose mode is not in effect (no use of qualifier
4107 -- /VERBOSE), then error lines start with the full path name of the
4108 -- project file, rather than its simple file name.
4112 -- /NOHIGH_VERBOSITY (D)
4113 -- /HIGH_VERBOSITY
4114 --
4115 -- Displays the reason for all recompilations GNAT MAKE decides are
4116 -- necessary, in high verbosity. Equivalent to /VERBOSE.
4120 -- /NOIN_PLACE (D)
4121 -- /IN_PLACE
4122 --
4123 -- In normal mode, GNAT MAKE compiles all object files and ALI files
4124 -- into the current directory. If the /IN_PLACE switch is used,
4125 -- then instead object files and ALI files that already exist are over-
4126 -- written in place. This means that once a large project is organized
4127 -- into separate directories in the desired manner, then GNAT MAKE will
4128 -- automatically maintain and update this organization. If no ALI files
4129 -- are found on the Ada object path, the new object and ALI files are
4130 -- created in the directory containing the source being compiled.
4134 -- /SOURCE_INDEX=nnn
4135 --
4136 -- Specifies the index of the units in the source file
4137 -- By default, source files are mono-unit and there is no index
4138 -- When /SOURCE_INDEX=nnn is specified, only one main may be specified
4139 -- on the command line.
4143 -- /LIBRARY_SEARCH=(directory[,...])
4144 --
4145 -- Add the specified directories to the list of directories in which the
4146 -- linker will search for libraries.
4150 -- /LINKER_QUALIFIERS
4151 --
4152 -- Any qualifiers specified after this qualifier other than
4153 -- /COMPILER_QUALIFIERS, /BINDER_QUALIFIERS and /MAKE_QUALIFIERS will be
4154 -- passed to any GNAT LINK commands generated by GNAT LINK.
4158 -- /NOLOW_VERBOSITY (D)
4159 -- /LOW_VERBOSITY
4160 --
4161 -- Displays the reason for all recompilations GNAT MAKE decides are
4162 -- necessary, in low verbosity, that is with less output than
4163 -- /MEDIUM_VERBOSITY, /HIGH_VERBOSITY or /VERBOSE.
4167 -- /MAKE_QUALIFIERS
4168 --
4169 -- Any qualifiers specified after this qualifier other than
4170 -- /COMPILER_QUALIFIERS, /BINDER_QUALIFIERS and /LINKER_QUALIFIERS
4171 -- are for the benefit of GNAT MAKE itself.
4175 -- /NOMAPPING (D)
4176 -- /MAPPING
4177 --
4178 -- Use a mapping file. A mapping file is a way to communicate to the
4179 -- compiler two mappings: from unit names to file names (without any
4180 -- directory information) and from file names to path names (with full
4181 -- directory information). These mappings are used by the compiler to
4182 -- short-circuit the path search. When GNAT MAKE is invoked with this
4183 -- qualifier, it will create a mapping file, initially populated by the
4184 -- project manager, if /PROJECT_File= is used, otherwise initially empty.
4185 -- Each invocation of the compiler will add the newly accessed sources to
4186 -- the mapping file. This will improve the source search during the next
4187 -- invocations of the compiler
4191 -- /NOMEDIUM_VERBOSITY (D)
4192 -- /MEDIUM_VERBOSITY
4193 --
4194 -- Displays the reason for all recompilations GNAT MAKE decides are
4195 -- necessary, in medium verbosity, that is with potentially less output
4196 -- than /HIGH_VERBOSITY or /VERBOSE.
4205 -- /MESSAGES_PROJECT_FILE[=messages-option]
4206 --
4207 -- Specifies the "verbosity" of the parsing of project files.
4208 -- messages-option may be one of the following:
4209 --
4210 -- DEFAULT (D) No messages are output if there is no error or warning.
4211 --
4212 -- MEDIUM A small number of messages are output.
4213 --
4214 -- HIGH A great number of messages are output, most of them not
4215 -- being useful for the user.
4219 -- /NOMINIMAL_RECOMPILATION (D)
4220 -- /MINIMAL_RECOMPILATION
4221 --
4222 -- Specifies that the minimum necessary amount of recompilation
4223 -- be performed. In this mode GNAT MAKE ignores time stamp differences
4224 -- when the only modifications to a source file consist in
4225 -- adding/removing comments, empty lines, spaces or tabs.
4229 -- /NOCREATE_MISSING_DIRS (D)
4230 -- /CREATE_MISSING_DIRS
4231 --
4232 -- When an object directory, a library directory or an exec directory
4233 -- in missing, attempt to create the directory.
4237 -- /NOLINK
4238 --
4239 -- Compile only. Do not perform binding and linking. If the root unit is
4240 -- not a main unit, this is the default. Otherwise GNAT MAKE will
4241 -- attempt binding and linking unless all objects are up to date and the
4242 -- executable is more recent than the objects.
4243 -- This is equivalent to /ACTIONS=COMPILE
4247 -- /NOMAIN
4248 --
4249 -- No main subprogram. Bind and link the program even if the unit name
4250 -- given on the command line is a package name. The resulting executable
4251 -- will execute the elaboration routines of the package and its closure,
4252 -- then the finalization routines.
4256 -- /NON_PROJECT_UNIT_COMPILATION
4257 --
4258 -- Normally, when using project files, a unit that is not part of any
4259 -- project file, cannot be compile. These units may be compile, when
4260 -- needed, if this qualifier is specified.
4264 -- /NOSTD_INCLUDES
4265 --
4266 -- Do not look for sources the in the system default directory.
4270 -- /NOSTD_LIBRARIES
4271 --
4272 -- Do not look for library files in the system default directory.
4276 -- /OBJECT_SEARCH=(directory[,...])
4277 --
4278 -- When looking for library and object files look also in the specified
4279 -- directories.
4283 -- /NOPROCESSES (D)
4284 -- /PROCESSES=NNN
4285 --
4286 -- Use NNN processes to carry out the (re)complations. If you have a
4287 -- multiprocessor machine, compilations will occur in parallel. In the
4288 -- event of compilation errors, messages from various compilations might
4289 -- get interspersed (but GNAT MAKE will give you the full ordered list of
4290 -- failing compiles at the end). This can at times be annoying. To get a
4291 -- clean list of error messages don't use this qualifier.
4295 -- NODOC (see /PROCESS)
4299 -- /PROJECT_FILE=filename
4300 --
4301 -- Specifies the main project file to be used. The project files rooted
4302 -- at the main project file will be parsed before any other processing to
4303 -- set the building environment.
4307 -- /NOQUIET (D)
4308 -- /QUIET
4309 --
4310 -- When this qualifiers is specified, the commands carried out by GNAT
4311 -- MAKE are not displayed.
4315 -- /NOREASONS (D)
4316 -- /REASONS
4317 --
4318 -- Displays the reason for all recompilations GNAT MAKE decides are
4319 -- necessary.
4323 -- /RUNTIME_SYSTEM=xxx
4324 --
4325 -- Build against an alternate runtime system named xxx or RTS-xxx.
4329 -- /SEARCH=(directory[,...])
4330 --
4331 -- Search the specified directories for both source and object files.
4335 -- /SKIP_MISSING=(directory[,...])
4336 --
4337 -- Skip missing library sources if ALI in 'directory'.
4341 -- /SOURCE_SEARCH=(directory[,...])
4342 --
4343 -- When looking for source files also look in the specified directories.
4347 -- /NOSTANDARD_OUTPUT_FOR_COMMANDS (D)
4348 -- /STANDARD_OUTPUT_FOR_COMMANDS
4349 --
4350 -- Output the commands for the compiler, the binder and the linker
4351 -- on SYS$OUTPUT, instead of SYS$ERROR.
4355 -- /NOSWITCH_CHECK (D)
4356 -- /SWITCH_CHECK
4357 --
4358 -- Recompile if compiler switches have changed since last compilation.
4359 -- All compiler switches but -I and -o are taken into account in the
4360 -- following way: orders between different "first letter" switches are
4361 -- ignored, but orders between same switches are taken into account.
4362 -- For example, -O -O2 is different than -O2 -O, but -g -O is equivalent
4363 -- to -O -g.
4367 -- /NOUNIQUE (D)
4368 -- /UNIQUE
4369 --
4370 -- Recompile at most the main file. It implies /ACTIONS=COMPILE.
4371 -- Combined with /FORCE_COMPILE, it is equivalent to calling the compiler
4372 -- directly.
4376 -- /USE_MAPPING_FILE=file_name
4377 --
4378 -- Use a specific mapping file. The file 'file_name', specified as a path
4379 -- name (absolute or relative) by this qualifier, should already exist,
4380 -- otherwise the qualifier is ineffective. The specified mapping file
4381 -- will be communicated to the compiler. This switch is not compatible
4382 -- with a project file (/PROJECT_FILE=) or with multiple compiling
4383 -- processes (/PROCESSES=nnn, when nnn is greater than 1).
4387 -- /NOVERBOSE (D)
4388 -- /VERBOSE
4389 --
4390 -- Displays the reason for all recompilations GNAT MAKE decides are
4391 -- necessary.
4396 S_Make_All 'Access,
4398 S_Make_Bind 'Access,
4400 S_Make_Cond 'Access,
4402 S_Make_Current 'Access,
4404 S_Make_Dirobj 'Access,
4406 S_Make_Execut 'Access,
4408 S_Make_Force 'Access,
4410 S_Make_Hi_Verb 'Access,
4412 S_Make_Index 'Access,
4414 S_Make_Link 'Access,
4415 S_Make_Low_Verb'Access,
4417 S_Make_Mapping 'Access,
4418 S_Make_Med_Verb'Access,
4420 S_Make_Minimal 'Access,
4422 S_Make_Nolink 'Access,
4424 S_Make_Nonpro 'Access,
4426 S_Make_Nostlib 'Access,
4428 S_Make_Proc 'Access,
4430 S_Make_Project 'Access,
4432 S_Make_Reason 'Access,
4434 S_Make_Search 'Access,
4436 S_Make_Source 'Access,
4438 S_Make_Switch 'Access,
4440 S_Make_Use_Map 'Access,
4443 ------------------------------
4444 -- Switches for GNAT METRIC --
4445 ------------------------------
4449 -- /ADD_PROJECT_SEARCH_PATH==(directory[,...])
4450 --
4451 -- Add directories to the project search path.
4455 -- /NOALL_PROJECTS (D)
4456 -- /ALL_PROJECTS
4457 -- When GNAT METRIC is used with a Project File and no source is
4458 -- specified, the underlying tool gnatmetric is called for all the
4459 -- sources of all the Project Files in the project tree.
4463 -- /DEBUG_OUTPUT
4464 --
4465 -- Generate the debug information
4469 -- /DIRECTORY=pathname
4470 --
4471 -- Put the files with detailed metric information into the specified
4472 -- directory
4497 -- NODOC (see /SYNTAX_METRICS)
4536 -- /SYNTAX_METRICS(option, option ...)
4537 --
4538 -- Specifies the syntax element metrics to be computed (if at least one
4539 -- positive syntax element metric, line metric or complexity metric is
4540 -- specified then only explicitly specified specified syntax element
4541 -- metrics are computed and reported)
4542 --
4543 -- option may be one of the following:
4544 --
4545 -- ALL_ON (D) All the syntax element metrics are computed
4546 -- ALL_OFF None of syntax element metrics is computed
4547 -- DECLARATIONS_ON Compute the total number of declarations
4548 -- DECLARATIONS_OFF Do not compute the total number of
4549 -- declarations
4550 -- STATEMENTS_ON Compute the total number of statements
4551 -- STATEMENTS_OFF Do not compute the total number of
4552 -- statements
4553 -- PUBLIC_SUBPROGRAMS_ON Compute the number of public subprograms
4554 -- PUBLIC_SUBPROGRAMS_OFF Do not compute the number of public
4555 -- subprograms
4556 -- ALL_SUBPROGRAMS_ON Compute the number of all the subprograms
4557 -- ALL_SUBPROGRAMS_OFF Do not compute the number of all the
4558 -- subprograms
4559 -- PUBLIC_TYPES_ON Compute the number of public types
4560 -- PUBLIC_TYPES_OFF Do not compute the number of public types
4561 -- ALL_TYPES_ON Compute the number of all the types
4562 -- ALL_TYPES_OFF Do not compute the number of all the types
4563 -- UNIT_NESTING_ON Compute the maximal program unit nesting
4564 -- level
4565 -- UNIT_NESTING_OFF Do not compute the maximal program unit
4566 -- nesting level
4567 -- CONSTRUCT_NESTING_ON Compute the maximal construct nesting level
4568 -- CONSTRUCT_NESTING_OFF Do not compute the maximal construct nesting
4569 -- level
4570 --
4571 -- All combinations of syntax element metrics options are allowed.
4575 -- /EXTERNAL_REFERENCE="name=val"
4576 --
4577 -- Specifies an external reference to the project manager. Useful only if
4578 -- /PROJECT_FILE is used.
4579 --
4580 -- Example:
4581 -- /EXTERNAL_REFERENCE="DEBUG=TRUE"
4585 -- /FILES=filename
4586 --
4587 -- Take as arguments the files that are listed in the specified
4588 -- text file.
4599 -- /FORMAT_OUTPUT=(option, option ...)
4600 --
4601 -- Specifies the details of the tool output
4602 --
4603 -- option may be one of the following:
4604 --
4605 -- DEFAULT (D) Generate the text output only, use full
4606 -- argument source names in global information
4607 -- XML Generate the output in XML format
4608 -- NO_TEXT Do not generate the text output (implies XML)
4609 -- SHORT_SOURCE_FILE_NAME Use short argument source names in output
4613 -- /GLOBAL_OUTPUT=filename
4614 --
4615 -- Put the textual global metric information into the specified file
4635 -- NODOC (see /LINE_COUNT_METRICS)
4670 -- /LINE_COUNT_METRICS=(option, option ...)
4672 -- Specifies the line metrics to be computed (if at least one positive
4673 -- syntax element metric, line metric or complexity metric is specified
4674 -- then only explicitly specified specified line metrics are computed and
4675 -- reported)
4676 --
4677 -- option may be one of the following:
4678 --
4679 -- ALL_ON (D) All the line metrics are computed
4680 -- ALL_OFF None of line metrics is computed
4681 -- ALL_LINES_ON All lines are computed
4682 -- ALL_LINES_OFF All lines are not computed
4683 -- CODE_LINES_ON Lines with Ada code are computed
4684 -- CODE_LINES_OFF Lines with Ada code are not computed
4685 -- COMMENT_LINES_ON Comment lines are computed
4686 -- COMMENT_LINES_OFF Comment lines are not computed
4687 -- COMMENT_PERCENTAGE_ON Ratio between comment lines and all the
4688 -- lines containing comments and program code
4689 -- is computed
4690 -- COMMENT_PERCENTAGE_OFF Ratio between comment lines and all the
4691 -- lines containing comments and program code
4692 -- is not computed
4693 -- BLANK_LINES_ON Blank lines are computed
4694 -- BLANK_LINES_OFF Blank lines are not computed
4695 -- AVERAGE_BODY_LINES_ON Average number of code lines in subprogram,
4696 -- task and entry bodies and statement
4697 -- sequences of package bodies is computed
4698 -- AVERAGE_BODY_LINES_OFF Average number of code lines in subprogram,
4699 -- task and entry bodies and statement
4700 -- sequences of package bodies is not computed
4701 --
4702 -- All combinations of line metrics options are allowed.
4725 -- /COMPLEXITY_METRICS=(option, option ...)
4727 -- Specifies the complexity metrics to be computed (if at least one
4728 -- positive syntax element metric, line metric or complexity metric is
4729 -- specified then only explicitly specified specified line metrics are
4730 -- computed and reported)
4731 --
4732 -- option may be one of the following:
4733 --
4734 -- ALL_ON (D) All the complexity metrics are computed
4735 -- ALL_OFF None of complexity metrics is computed
4736 -- CYCLOMATIC_ON Compute the McCabe Cyclomatic Complexity
4737 -- CYCLOMATIC_OFF Do not compute the McCabe Cyclomatic
4738 -- Complexity
4739 -- ESSENTIAL_ON Compute the Essential Complexity
4740 -- ESSENTIAL_OFF Do not ompute the Essential Complexity
4741 -- LOOP_NESTIMG_ON Compute the maximal loop nesting
4742 -- LOOP_NESTIMG_OFF Do not compute the maximal loop nesting
4743 -- AVERAGE_COMPLEXITY_ON Compute the average complexity for
4744 -- executable bodies
4745 -- AVERAGE_COMPLEXITY_OFF Do not compute the average complexity for
4746 -- executable bodies
4747 --
4748 -- All combinations of line metrics options are allowed.
4752 -- /LOCAL_DETAILS (D)
4753 -- /NO_LOCAL_DETAILS
4754 --
4755 -- Do not compute the detailed metrics for local program units.
4759 -- /EXITS_AS_GOTOS (D)
4760 -- /NO_EXITS_AS_GOTOS
4761 --
4762 -- Do not count EXIT statements as GOTOs when computing the Essential
4763 -- Complexity.
4772 -- /MESSAGES_PROJECT_FILE[=messages-option]
4773 --
4774 -- Specifies the "verbosity" of the parsing of project files.
4775 -- messages-option may be one of the following:
4776 --
4777 -- DEFAULT (D) No messages are output if there is no error or warning.
4778 --
4779 -- MEDIUM A small number of messages are output.
4780 --
4781 -- HIGH A great number of messages are output, most of them not
4782 -- being useful for the user.
4786 -- /PROJECT_FILE=filename
4787 --
4788 -- Specifies the main project file to be used. The project files rooted
4789 -- at the main project file will be parsed before the invocation of the
4790 -- binder.
4794 -- /NOQUIET (D)
4795 -- /QUIET
4796 --
4797 -- Quiet mode: by default GNAT METRIC outputs to the standard error stream
4798 -- the number of program units left to be processed. This option turns
4799 -- this trace off.
4803 -- /SUFFIX_DETAILS=suffix
4804 --
4805 -- Use the given suffix as the suffix for the name of the file to place
4806 -- the detailed metrics into.
4822 -- NODOC (see /COMPLEXITY_METRICS /NO_LOCAL_DETAILS /NO_EXITS_AS_GOTOS)
4826 -- /NOVERBOSE (D)
4827 -- /VERBOSE
4828 --
4829 -- Verbose mode.
4833 -- /XML_OUTPUT=filename
4834 --
4835 -- Place the XML output into the specified file
4840 S_Metric_Complexity 'Access,
4842 S_Metric_Direct 'Access,
4844 S_Metric_Ext 'Access,
4846 S_Metric_Format 'Access,
4848 S_Metric_Line 'Access,
4850 S_Metric_Mess 'Access,
4851 S_Metric_No_Exits_As_Gotos'Access,
4853 S_Metric_Project 'Access,
4855 S_Metric_Suffix 'Access,
4857 S_Metric_Suppress 'Access,
4859 S_Metric_XMLout 'Access);
4861 ----------------------------
4862 -- Switches for GNAT NAME --
4863 ----------------------------
4865 S_Name_Conf : aliased constant S := "/CONFIG_FILE=<" &
4866 "-c>";
4867 -- /CONFIG_FILE=path_name
4868 --
4871 -- must be writable. There may be only one qualifier /CONFIG_FILE.
4872 -- This qualifier is not compatible with qualifier /PROJECT_FILE.
4874 S_Name_Dirs : aliased constant S := "/SOURCE_DIRS=*" &
4875 "-d*";
4876 -- /SOURCE_DIRS=(directory, ...)
4877 --
4878 -- Look for source files in the specified directories. When this qualifier
4879 -- is specified, the current working directory will not be searched for
4880 -- source files, unless it is explicitly specified with a qualifier
4881 -- /SOURCE_DIRS or /DIRS_FILE. Several qualifiers /SOURCE_DIRS may be
4882 -- specified. If a directory is specified as a relative path, it is
4883 -- relative to the directory of the configuration pragmas file specified
4884 -- with qualifier /CONFIG_FILE, or to the directory of the project file
4885 -- specified with qualifier /PROJECT_FILE or, if neither qualifier
4886 -- /CONFIG_FILE nor qualifier /PROJECT_FILE are specified, it is relative
4887 -- to the current working directory. The directories specified with
4888 -- qualifiers /SOURCE_DIRS must exist and be readable.
4890 S_Name_Dfile : aliased constant S := "/DIRS_FILE=<" &
4891 "-D>";
4892 -- /DIRS_FILE=file_name
4893 --
4894 -- Look for source files in all directories listed in text file
4896 -- Each non empty line in the specified file must be a directory.
4897 -- Specifying qualifier /DIRS_FILE is equivalent to specifying as many
4898 -- qualifiers /SOURCE_DIRS as there are non empty lines in the specified
4899 -- text file.
4903 -- /FOREIGN_PATTERN=<string>
4904 --
4905 -- Specify a foreign pattern.
4906 -- Using this qualifier, it is possible to add sources of languages other
4907 -- than Ada to the list of sources of a project file. It is only useful
4908 -- if a qualifier /PROJECT_FILE is used. For example,
4909 --
4910 -- GNAT NAME /PROJECT_FILE=PRJ /FOREIGN_PATTERN="*.C" "*.ADA"
4911 --
4913 -- will add to the list of file for project PRJ.GPR the C files with
4914 -- extension ".C".
4916 S_Name_Help : aliased constant S := "/HELP " &
4917 "-h";
4918 -- /NOHELP (D)
4919 -- /HELP
4920 --
4921 -- Output usage information to the standard output stream.
4923 S_Name_Proj : aliased constant S := "/PROJECT_FILE=<" &
4924 "-P>";
4925 -- /PROJECT_FILE=file_name
4926 --
4928 -- information. The specified file must be writable. There may be only
4929 -- one qualifier /PROJECT_FILE. When a qualifier /PROJECT_DILE is
4930 -- specified, no qualifier /CONFIG_FILE may be specified.
4932 S_Name_Verbose : aliased constant S := "/VERBOSE " &
4933 "-v";
4934 -- /NOVERBOSE (D)
4935 -- /VERBOSE
4936 --
4937 -- Verbose mode. Output detailed explanation of behavior to the standard
4938 -- output stream. This includes name of the file written, the name of the
4939 -- directories to search and, for each file in those directories whose
4940 -- name matches at least one of the Naming Patterns, an indication of
4941 -- whether the file contains a unit, and if so the name of the unit.
4945 -- /EXCLUDED_PATTERN=<string>
4946 --
4947 -- Specify an excluded pattern.
4948 -- Using this qualifier, it is possible to exclude some files that would
4949 -- match the Naming patterns. For example,
4950 --
4951 -- GNAT NAME /EXCLUDED_PATTERN="*_NT.ADA" "*.ADA"
4952 --
4956 Name_Switches : aliased constant Switches :=
4958 S_Name_Dirs 'Access,
4960 S_Name_Frng 'Access,
4962 S_Name_Proj 'Access,
4964 S_Name_Excl 'Access);
4966 ----------------------------------
4967 -- Switches for GNAT PREPROCESS --
4968 ----------------------------------
4972 -- /ASSOCIATE="name=val"
4973 --
4974 -- Defines a new symbol, associated with value. If no value is given
4975 -- on the command line, then symbol is considered to be True.
4976 -- This qualifier can be used in place of a definition file.
4978 S_Prep_Blank : aliased constant S := "/BLANK_LINES " &
4979 "-b";
4980 -- /NOBLANK_LINES (D)
4981 -- /BLANK_LINES
4982 --
4983 -- Causes both preprocessor lines and the lines deleted by preprocessing
4984 -- to be replaced by blank lines in the output source file, thus
4985 -- preserving line numbers in the output file.
4987 S_Prep_Com : aliased constant S := "/COMMENTS " &
4988 "-c";
4989 -- /NOCOMMENTS (D)
4990 -- /COMMENTS
4991 --
4992 -- /COMMENTS causes both preprocessor lines and the lines deleted
4993 -- by preprocessing to be retained in the output source as comments marked
4994 -- with the special string "--! ". This option will result in line numbers
4995 -- being preserved in the output file.
4996 --
4997 -- /NOCOMMENTS causes both preprocessor lines and the lines deleted by
4998 -- preprocessing to be replaced by blank lines in the output source file,
4999 -- thus preserving line numbers in the output file.
5001 S_Prep_Ref : aliased constant S := "/REFERENCE " &
5002 "-r";
5003 -- /NOREFERENCE (D)
5004 -- /REFERENCE
5005 --
5006 -- Causes a "Source_Reference" pragma to be generated that references the
5007 -- original input file, so that error messages will use the file name of
5008 -- this original file. Also implies /BLANK_LINES if /COMMENTS is not
5009 -- specified.
5011 S_Prep_Remove : aliased constant S := "/REMOVE " &
5012 "!-b,!-c";
5013 -- /REMOVE (D)
5014 -- /NOREMOVE
5015 --
5016 -- Preprocessor lines and deleted lines are completely removed from the
5017 -- output.
5019 S_Prep_Replace : aliased constant S := "/REPLACE_IN_COMMENTS " &
5020 "-C";
5021 -- /NOREPLACE_IN_COMMENTS (D)
5022 -- /REPLACE_IN_COMMENTS
5023 --
5024 -- Causes preprocessor to scan comments and perform replacements on
5025 -- any $symbol occurrences within the comment text.
5027 S_Prep_Symbols : aliased constant S := "/SYMBOLS " &
5028 "-s";
5029 -- /NOSYMBOLS (D)
5030 -- /SYMBOLS
5031 --
5032 -- Causes a sorted list of symbol names and values to be listed on
5033 -- SYS$OUTPUT.
5035 S_Prep_Undef : aliased constant S := "/UNDEFINED " &
5036 "-u";
5037 -- /NOUNDEFINED (D)
5038 -- /UNDEFINED
5040 Prep_Switches : aliased constant Switches :=
5042 S_Prep_Blank 'Access,
5044 S_Prep_Ref 'Access,
5046 S_Prep_Replace 'Access,
5048 S_Prep_Undef 'Access);
5050 ------------------------------
5051 -- Switches for GNAT PRETTY --
5052 ------------------------------
5054 S_Pretty_Add : aliased constant S := "/ADD_PROJECT_SEARCH_DIR=*" &
5055 "-aP*";
5056 -- /ADD_PROJECT_SEARCH_PATH==(directory[,...])
5057 --
5058 -- Add directories to the project search path.
5060 S_Pretty_Align : aliased constant S := "/ALIGN=" &
5061 "DEFAULT " &
5062 "-A12345 " &
5063 "OFF " &
5064 "-A0 " &
5065 "COLONS " &
5066 "-A1 " &
5067 "DECLARATIONS " &
5068 "-A2 " &
5069 "STATEMENTS " &
5070 "-A3 " &
5071 "ARROWS " &
5072 "-A4 " &
5073 "COMPONENT_CLAUSES " &
5074 "-A5";
5075 -- /ALIGN[=align-option, align-option, ...]
5076 --
5077 -- Set alignments. By default, all alignments (colons in declarations,
5078 -- initialisations in declarations, assignments and arrow delimiters) are
5079 -- ON.
5080 --
5081 -- align-option may be one of the following:
5082 --
5083 -- OFF (D) Set all alignments to OFF
5084 -- COLONS Set alignments of colons in declarations to ON
5085 -- DECLARATIONS Set alignments of initialisations in declarations
5086 -- to ON
5087 -- STATEMENTS Set alignments of assignments statements to ON
5088 -- ARROWS Set alignments of arrow delimiters to ON.
5089 -- COMPONENT_CLAUSES Set alignments of AT keywords in component
5090 -- clauses ON
5091 --
5092 -- Specifying one of the ON options without first specifying the OFF
5093 -- option has no effect, because by default all alignments are set to ON.
5095 S_Pretty_All_Prjs : aliased constant S := "/ALL_PROJECTS " &
5096 "-U";
5097 -- /NOALL_PROJECTS (D)
5098 -- /ALL_PROJECTS
5099 -- When GNAT PRETTY is used with a Project File and no source is
5100 -- specified, the underlying tool gnatpp is called for all the
5101 -- sources of all the Project Files in the project tree.
5103 S_Pretty_Attrib : aliased constant S := "/ATTRIBUTE_CASING=" &
5104 "MIXED_CASE " &
5105 "-aM " &
5106 "LOWER_CASE " &
5107 "-aL " &
5108 "UPPER_CASE " &
5109 "-aU";
5110 -- /ATTRIBUTE_CASING[=casing-option]
5111 --
5112 -- Set the case of the attributes. By default the attributes are in mixed
5113 -- case.
5114 -- casing-option may be one of the following:
5115 --
5116 -- MIXED_CASE (D)
5117 -- LOWER_CASE
5118 -- UPPER_CASE
5120 S_Pretty_Comments : aliased constant S := "/COMMENTS_LAYOUT=" &
5121 "UNTOUCHED " &
5122 "-c0 " &
5123 "DEFAULT " &
5124 "-c1 " &
5125 "STANDARD_INDENT " &
5126 "-c2 " &
5127 "GNAT_BEGINNING " &
5128 "-c3 " &
5129 "REFORMAT " &
5130 "-c4 " &
5131 "KEEP_SPECIAL " &
5132 "-c5";
5133 -- /COMMENTS_LAYOUT[=layout-option, layout-option, ...]
5134 --
5135 -- Set the comment layout. By default, comments use the GNAT style
5136 -- comment line indentation.
5137 --
5138 -- layout-option may be one of the following:
5139 --
5140 -- UNTOUCHEDÂ Â Â Â Â Â Â Â Â Â All the comments remain unchanged
5141 -- DEFAULT (D) GNAT style comment line indentation
5142 -- STANDARD_INDENT Standard comment line indentation
5143 -- GNAT_BEGINNING GNAT style comment beginning
5144 -- REFORMAT Reformat comment blocks
5145 -- KEEP_SPECIAL Keep unchanged special form comments
5146 --
5147 -- All combinations of layout options are allowed, except for DEFAULT
5148 -- and STANDARD_INDENT which are mutually exclusive, and also if
5149 -- UNTOUCHED is specified, this must be the only option.
5150 --
5151 -- The difference between "GNAT style comment line indentation" and
5152 -- "standard comment line indentation" is the following: for standard
5153 -- comment indentation, any comment line is indented as if it were
5154 -- a declaration or statement at the same place.
5155 -- For GNAT style comment indentation, comment lines which are
5156 -- immediately followed by if or case statement alternative, record
5158 -- them.:
5159 --
5160 -- Standard indentation:
5161 --
5162 -- if A then
5163 -- null;
5164 -- -- some comment
5165 -- else
5166 -- null;
5167 -- end if;
5168 --
5169 -- GNAT style indentation:
5170 --
5171 -- if A then
5172 -- null;
5173 -- -- some comment
5174 -- else
5175 -- null;
5176 -- end if;
5177 --
5178 -- Option "GNAT style comment beginning" means that for each comment
5179 -- which is not considered as non-formattable separator (that is, the
5180 -- comment line contains only dashes, or a comment line ends with two
5181 -- dashes), there will be at least two spaces between starting "--" and
5182 -- the first non-blank character of the comment.
5184 S_Pretty_Config : aliased constant S := "/CONFIGURATION_PRAGMAS_FILE=<" &
5185 "-gnatec>";
5186 -- /CONFIGURATION_PRAGMAS_FILE=file
5187 --
5188 -- Specify a configuration pragmas file that need to be passed to the
5189 -- compiler.
5191 S_Pretty_Constr : aliased constant S := "/CONSTRUCT_LAYOUT=" &
5192 "GNAT " &
5193 "-l1 " &
5194 "COMPACT " &
5195 "-l2 " &
5196 "UNCOMPACT " &
5197 "-l3";
5198 -- /CONSTRUCT_LAYOUT[=construct-option]
5199 --
5200 -- Set construct layout. Default is GNAT style layout.
5201 -- construct-option may be one of the following:
5202 --
5203 -- GNAT (D)
5204 -- COMPACT
5205 -- UNCOMPACT
5206 --
5207 -- The difference between GNAT style and Compact layout on one hand
5208 -- and Uncompact layout on the other hand can be illustrated by the
5209 -- following examples:
5210 --
5211 -- GNAT style and Uncompact layout
5212 -- Compact layout
5213 --
5214 -- type q is record type q is
5215 -- a : integer; record
5216 -- b : integer; a : integer;
5217 -- end record; b : integer;
5218 -- end record;
5219 --
5220 --
5221 -- Block : declare Block :
5222 -- A : Integer := 3; declare
5223 -- begin A : Integer := 3;
5224 -- Proc (A, A); begin
5225 -- end Block; Proc (A, A);
5226 -- end Block;
5227 --
5228 -- Clear : for J in 1 .. 10 loop Clear :
5229 -- A (J) := 0; for J in 1 .. 10 loop
5230 -- end loop Clear; A (J) := 0;
5231 -- end loop Clear;
5232 --
5233 --
5234 -- A further difference between GNAT style layout and compact layout is
5235 -- that in GNAT style layout compound statements, return statements and
5236 -- bodies are always separated by empty lines.
5238 S_Pretty_Comind : aliased constant S := "/CONTINUATION_INDENT=#" &
5239 "-cl#";
5240 -- /CONTINUATION_INDENT=nnn
5241 --
5242 -- Indentation level for continuation lines, nnn from 1 .. 9.
5243 -- The default value is one less then the (normal) indentation level,
5244 -- unless the indentation is set to 1: in that case the default value for
5245 -- continuation line indentation is also 1.
5247 S_Pretty_Compact_Is : aliased constant S := "/NO_SEPARATE_IS " &
5248 "--no-separate-is";
5249 -- /NO_SEPARATE_IS
5250 --
5251 -- Do not place the IS keyword on a separate line in a subprogram body in
5252 -- case if the specification occupies more then one line.
5254 S_Pretty_Sep_Loop_Then : aliased constant S := "/SEPARATE_LOOP_THEN " &
5255 "--separate-loop-then";
5256 -- /SEPARATE_LOOP_THEN
5257 --
5258 -- Place the THEN keyword in IF statement and the LOOP keyword in for-
5259 -- and while-loops on a separate line.
5261 S_Pretty_Use_On_New_Line : aliased constant S := "/USE_ON_NEW_LINE " &
5262 "--use-on-new-line";
5263 -- /USE_ON_NEW_LINE
5264 --
5265 -- Start any USE clause that is a part of a context clause from a
5266 -- separate line.
5268 S_Pretty_Stnm_On_Nw_Line : aliased constant S := "/STMT_NAME_ON_NEW_LINE " &
5269 "--separate-stmt-name";
5270 -- /STMT_NAME_ON_NEW_LINE
5271 --
5272 -- For named block and loop statements use a separate line for the
5273 -- statement name, but do not use an extra indentation level for the
5274 -- statement itself.
5276 S_Pretty_Eol : aliased constant S := "/END_OF_LINE=" &
5277 "DOS " &
5278 "--eol=dos " &
5279 "UNIX " &
5280 "--eol=unix " &
5281 "CRLF " &
5282 "--eol=crlf " &
5283 "LF " &
5284 "--eol=lf";
5285 -- /END_OF_LINE=[option]
5286 --
5287 -- Specifies the form of the line terminators in the produced source.
5288 -- By default, the form of the line terminator depends on the platforms.
5289 -- On Unix and VMS, it is a Line Feed (LF) chararcter. On Windows (DOS),
5290 -- It is a Carriage Return (CR) followed by a Line Feed.
5291 -- The Options DOS and CRLF are equivalent. The options UNIX and LF are
5292 -- also equivalent.
5296 -- /EXTERNAL_REFERENCE="name=val"
5297 --
5298 -- Specifies an external reference to the project manager. Useful only if
5299 -- /PROJECT_FILE is used.
5300 --
5301 -- Example:
5302 -- /EXTERNAL_REFERENCE="DEBUG=TRUE"
5304 S_Pretty_Current : aliased constant S := "/CURRENT_DIRECTORY " &
5305 "!-I-";
5306 -- /CURRENT_DIRECTORY (D)
5307 --
5308 -- Look for source files in the current working directory.
5309 --
5310 -- /NOCURRENT_DIRECTORY
5311 -- Do not look for source files in the current working directory.
5313 S_Pretty_Dico : aliased constant S := "/DICTIONARY=*" &
5314 "-D*";
5315 -- /DICTIONARY=(file_name, ...)
5316 --
5317 -- Use each specified file as a dictionary file that defines the casing
5318 -- for a set of specified names, thereby overriding the effect on these
5319 -- names by any explicit or implicit /NAME_CASING qualifier.
5320 --
5321 -- GNAT PRETTY implicitly uses a default dictionary file to define the
5322 -- casing for the Ada predefined names and the names declared in the GNAT
5323 -- libraries.
5324 --
5325 -- The structure of a dictionary file, and details on the conventions
5326 -- used in the default dictionary file, are defined in the GNAT User's
5327 -- Guide.
5329 S_Pretty_Encoding : aliased constant S := "/RESULT_ENCODING=" &
5330 "BRACKETS " &
5331 "-Wb " &
5332 "HEX " &
5333 "-Wh " &
5334 "UPPER " &
5335 "-Wu " &
5336 "SHIFT_JIS " &
5337 "-Ws " &
5338 "EUC " &
5339 "-We " &
5340 "UTF8 " &
5341 "-W8";
5342 -- /RESULT_ENCODING[=encoding-type]
5343 --
5344 -- Specify the wide character encoding method used when writtimg the
5346 -- following:
5347 --
5348 -- BRACKETS (D) Brackets encoding.
5349 --
5350 -- HEX Hex ESC encoding.
5351 --
5352 -- UPPER Upper half encoding.
5353 --
5354 -- SHIFT_JIS Shift-JIS encoding.
5355 --
5356 -- EUC EUC Encoding.
5357 --
5358 -- UTF8 UTF-8 encoding.
5359 --
5361 -- about the different character encoding methods.
5363 S_Pretty_Files : aliased constant S := "/FILES=@" &
5364 "-files=@";
5365 -- /FILES=filename
5366 --
5367 -- Take as arguments the files that are listed in the specified
5368 -- text file.
5370 S_Pretty_Forced : aliased constant S := "/FORCED_OUTPUT=@" &
5371 "-of@";
5372 -- /FORCED_OUTPUT=file
5373 --
5374 -- Write the output into the specified file, overriding any possibly
5375 -- existing file.
5377 S_Pretty_Formfeed : aliased constant S := "/FORM_FEED_AFTER_PRAGMA_PAGE " &
5378 "-ff";
5379 -- /FORM_FEED_AFTER_PRAGMA_PAGE
5380 --
5381 -- When there is a pragma Page in the source, insert a Form Feed
5382 -- character immediately after the semicolon that follows the pragma
5383 -- Page.
5385 S_Pretty_Indent : aliased constant S := "/INDENTATION_LEVEL=#" &
5386 "-i#";
5387 -- /INDENTATION_LEVEL=nnn
5388 --
5389 -- Specify the number of spaces to add for each indentation level.
5390 -- nnn must be between 1 and 9. The default is 3.
5392 S_Pretty_Keyword : aliased constant S := "/KEYWORD_CASING=" &
5393 "LOWER_CASE " &
5394 "-kL " &
5395 "UPPER_CASE " &
5396 "-kU";
5397 -- /KEYWORD_CASING[=keyword-option]
5398 --
5399 -- Specify the case of Ada keywords. The default is keywords in lower
5400 -- case.
5401 -- keyword-option may be one of the following:
5402 --
5403 -- LOWER_CASE (D)
5404 -- UPPER_CASE
5406 S_Pretty_Maxlen : aliased constant S := "/LINE_LENGTH_MAX=#" &
5407 "-M#";
5408 -- /LINE_LENGTH_MAX=nnn
5409 --
5410 -- Set the maximum line length, nnn from 32 ..256. The default is 79.
5412 S_Pretty_Maxind : aliased constant S := "/MAX_INDENT=#" &
5413 "-T#";
5414 -- /MAX_INDENT=nnn
5415 --
5416 -- Do not use an additional indentation level for case alternatives
5417 -- and variants if their number is nnn or more. The default is 10.
5418 -- If nnn is zero, an additional indentation level is used for any number
5419 -- of case alternatives and variants.
5421 S_Pretty_Mess : aliased constant S := "/MESSAGES_PROJECT_FILE=" &
5422 "DEFAULT " &
5423 "-vP0 " &
5424 "MEDIUM " &
5425 "-vP1 " &
5426 "HIGH " &
5427 "-vP2";
5428 -- /MESSAGES_PROJECT_FILE[=messages-option]
5429 --
5430 -- Specifies the "verbosity" of the parsing of project files.
5431 -- messages-option may be one of the following:
5432 --
5433 -- DEFAULT (D) No messages are output if there is no error or warning.
5434 --
5435 -- MEDIUM A small number of messages are output.
5436 --
5437 -- HIGH A great number of messages are output, most of them not
5438 -- being useful for the user.
5440 S_Pretty_Names : aliased constant S := "/NAME_CASING=" &
5441 "AS_DECLARED " &
5442 "-nD " &
5443 "LOWER_CASE " &
5444 "-nL " &
5445 "UPPER_CASE " &
5446 "-nU " &
5447 "MIXED_CASE " &
5448 "-nM";
5449 -- /NAME_CASING[=name-option]
5450 --
5451 -- Specify the casing of names.
5453 --
5454 -- AS_DECLARED (D) Name casing for defining occurrences are as they
5455 -- appear in the source file.
5456 --
5457 -- LOWER_CASE Names are in lower case.
5458 --
5459 -- UPPER_CASE Names are in upper case.
5460 --
5461 -- MIXED_CASE Names are in mixed case.
5463 S_Pretty_No_Backup : aliased constant S := "/NO_BACKUP " &
5464 "-rnb";
5465 -- /REPLACE_NO_BACKUP
5466 --
5467 -- Replace the argument source with the pretty-printed source without
5468 -- creating any backup copy of the argument source.
5470 S_Pretty_No_Labels : aliased constant S := "/NO_MISSED_LABELS " &
5471 "-e";
5472 -- /NO_MISSED_LABELS
5473 --
5474 -- Do not insert missing end/exit labels. The end label is the name of
5475 -- a construct that may optionally appear at the end of the construct.
5476 -- This includes the names of packages and subprograms.
5477 -- Similarly, the exit label is the name of a loop that may appear as the
5478 -- argument of an exit statement within the loop. By default, GNAT PRETTY
5479 -- inserts these end/exit labels when they are absent in the original
5480 -- source. This qualifier /NO_MISSED_LABELS suppresses this insertion,
5481 -- so that the formatted source reflects the original.
5483 S_Pretty_Notabs : aliased constant S := "/NOTABS " &
5484 "-notabs";
5485 -- /NOTABS
5486 --
5487 -- Replace all tabulations in comments with spaces.
5489 S_Pretty_Output : aliased constant S := "/OUTPUT=@" &
5490 "-o@";
5491 -- /OUTPUT=file
5492 --
5493 -- Write the output to the specified file. If the file already exists,
5494 -- an error is reported.
5496 S_Pretty_Override : aliased constant S := "/OVERRIDING_REPLACE " &
5497 "-rf";
5498 -- /NOOVERRIDING_REPLACE (D)
5499 -- /OVERRIDING_REPLACE
5500 --
5501 -- Replace the argument source with the pretty-printed source and copy the
5502 -- argument source into filename.NPP, overriding any existing file if
5503 -- needed.
5505 S_Pretty_Pragma : aliased constant S := "/PRAGMA_CASING=" &
5506 "MIXED_CASE " &
5507 "-pM " &
5508 "LOWER_CASE " &
5509 "-pL " &
5510 "UPPER_CASE " &
5511 "-pU";
5512 -- /PRAGMA_CASING[=pragma-option]
5513 --
5514 -- Set the case of pragma identifiers. The default is Mixed case.
5515 -- pragma-option may be one of the following:
5516 --
5517 -- MIXED_CASE (D)
5518 -- LOWER_CASE
5519 -- UPPER_CASE
5521 S_Pretty_Project : aliased constant S := "/PROJECT_FILE=<" &
5522 "-P>";
5523 -- /PROJECT_FILE=filename
5524 --
5525 -- Specifies the main project file to be used. The project files rooted
5526 -- at the main project file will be parsed before any other processing to
5527 -- set the building environment.
5529 S_Pretty_Replace : aliased constant S := "/REPLACE " &
5530 "-r";
5531 -- /NOREPLACE (D)
5532 -- /REPLACE
5533 --
5534 -- Replace the argument source with the pretty-printed source and copy the
5535 -- argument source into filename.NPP. If filename.NPP already exists,
5536 -- report an error and exit.
5538 S_Pretty_RTS : aliased constant S := "/RUNTIME_SYSTEM=|" &
5539 "--RTS=|";
5540 -- /RUNTIME_SYSTEM=xxx
5541 --
5542 -- Compile against an alternate runtime system named xxx or RTS-xxx.
5544 S_Pretty_Search : aliased constant S := "/SEARCH=*" &
5545 "-I*";
5546 -- /SEARCH=(directory[,...])
5547 --
5548 -- When looking for source files also look in directories specified.
5550 S_Pretty_Specific : aliased constant S := "/SPECIFIC_CASING " &
5551 "-D-";
5552 -- /SPECIFIC_CASING
5553 --
5554 -- Do not use the default dictionary file; instead, use the casing
5555 -- defined by a qualifier /NAME_CASING and/or any explicit dictionary
5556 -- file specified by a qualifier /DICTIONARY.
5558 S_Pretty_Standard : aliased constant S := "/STANDARD_OUTPUT " &
5559 "-pipe";
5560 -- /NOSTANDARD_OUTPUT (D)
5561 -- /STANDARD_OUTPUT
5562 --
5563 -- Redirect the output to the standard output.
5565 S_Pretty_Verbose : aliased constant S := "/VERBOSE " &
5566 "-v";
5567 -- /NOVERBOSE (D)
5568 -- /VERBOSE
5569 --
5570 -- Verbose mode; GNAT PRETTY generates version information and then a
5571 -- trace of the actions it takes to produce or obtain the ASIS tree.
5573 S_Pretty_Warnings : aliased constant S := "/WARNINGS " &
5574 "-w";
5575 -- /NOWARNINGS (D)
5576 -- /WARNINGS
5577 --
5578 -- Issue a warning to the standard error stream if it is not possible
5579 -- to provide the required layout in the result source.
5580 -- By default such warnings are not activated.
5582 Pretty_Switches : aliased constant Switches :=
5584 S_Pretty_Align 'Access,
5586 S_Pretty_Attrib 'Access,
5588 S_Pretty_Compact_Is 'Access,
5590 S_Pretty_Constr 'Access,
5592 S_Pretty_Current 'Access,
5594 S_Pretty_Eol 'Access,
5596 S_Pretty_Encoding 'Access,
5598 S_Pretty_Forced 'Access,
5600 S_Pretty_Indent 'Access,
5602 S_Pretty_Maxlen 'Access,
5604 S_Pretty_Mess 'Access,
5606 S_Pretty_No_Backup 'Access,
5608 S_Pretty_Notabs 'Access,
5610 S_Pretty_Override 'Access,
5612 S_Pretty_Replace 'Access,
5614 S_Pretty_RTS 'Access,
5616 S_Pretty_Sep_Loop_Then 'Access,
5617 S_Pretty_Use_On_New_Line'Access,
5618 S_Pretty_Stnm_On_Nw_Line'Access,
5620 S_Pretty_Standard 'Access,
5622 S_Pretty_Warnings 'Access);
5624 ------------------------------
5625 -- Switches for GNAT SHARED --
5626 ------------------------------
5628 S_Shared_Debug : aliased constant S := "/DEBUG=" &
5629 "ALL " &
5630 "-g3 " &
5631 "NONE " &
5632 "-g0 " &
5633 "TRACEBACK " &
5634 "-g1 " &
5635 "NOTRACEBACK " &
5636 "-g0";
5637 -- /DEBUG[=debug-option]
5638 -- /NODEBUG
5639 --
5641 -- is one of the following:
5642 --
5643 -- ALL (D) Include full debugging information.
5644 --
5645 -- NONE Provide no debugging information. Same as /NODEBUG.
5646 --
5647 -- TRACEBACK Provide sufficient debug information for a traceback.
5648 --
5649 -- NOTRACEBACK Same as NONE.
5651 S_Shared_Image : aliased constant S := "/IMAGE=@" &
5652 "-o@";
5653 -- /IMAGE=image-name
5654 --
5660 -- /IDENTIFICATION="<string>"
5661 --
5662 -- "<string>" specifies the string to be stored in the image file ident-
5663 -- ification field in the image header. It overrides any pragma Ident
5664 -- specified string.
5668 -- /NOSTART_FILES
5669 --
5670 -- Link in default image initialization and startup functions.
5674 -- /NOINHIBIT-IMAGE
5675 --
5676 -- Delete image if there are errors or warnings.
5680 -- /NOVERBOSE (D)
5681 -- /VERBOSE
5682 --
5683 -- Causes additional information to be output, including a full list of
5684 -- the included object files. This switch option is most useful when you
5685 -- want to see what set of object files are being used in the link step.
5689 -- /<other>
5690 --
5691 -- Any other switch transmitted to the underlying linker.
5696 S_Shared_Ident 'Access,
5698 S_Shared_Noinhib 'Access,
5700 S_Shared_ZZZZZ 'Access);
5702 -----------------------------
5703 -- Switches for GNAT STACK --
5704 -----------------------------
5706 S_Stack_Add : aliased constant S := "/ADD_PROJECT_SEARCH_DIR=*" &
5707 "-aP*";
5708 -- /ADD_PROJECT_SEARCH_PATH==(directory[,...])
5709 --
5710 -- Add directories to the project search path.
5712 S_Stack_All : aliased constant S := "/ALL_SUBPROGRAMS " &
5713 "-a";
5714 -- /NOALL_SUBPROGRAMS (D)
5715 -- /ALL_SUBPROGRAMS
5716 --
5717 -- Consider all subprograms as entry points.
5719 S_Stack_All_Cycles : aliased constant S := "/ALL_CYCLES " &
5720 "-ca";
5721 -- /NOALL_CYCLES (D)
5722 -- /ALL_CYCLES
5723 --
5724 -- Extract all possible cycles in the call graph.
5726 S_Stack_All_Prjs : aliased constant S := "/ALL_PROJECTS " &
5727 "-U";
5728 -- /NOALL_PROJECTS (D)
5729 -- /ALL_PROJECTS
5730 --
5731 -- When GNAT STACK is used with a Project File and no source is
5732 -- specified, the underlying tool gnatstack is called for all the
5733 -- units of all the Project Files in the project tree.
5735 S_Stack_Debug : aliased constant S := "/DEBUG " &
5736 "-g";
5737 -- /NODEBUG (D)
5738 -- /DEBUG
5739 --
5740 -- Generate internal debug information.
5742 S_Stack_Directory : aliased constant S := "/DIRECTORY=*" &
5743 "-aO*";
5744 -- /DIRECTORY=(direc[,...])
5745 --
5746 -- When looking for .ci files look also in directories specified.
5748 S_Stack_Entries : aliased constant S := "/ENTRIES=*" &
5749 "-e*";
5750 --
5751 -- /ENTRY=(entry_point[,...])
5752 --
5753 -- Name of symbol to be used as entry point for the analysis.
5755 S_Stack_Files : aliased constant S := "/FILES=@" &
5756 "-files=@";
5757 -- /FILES=filename
5758 --
5759 -- Take as arguments the files that are listed in the specified
5760 -- text file.
5762 S_Stack_Help : aliased constant S := "/HELP " &
5763 "-h";
5764 -- /NOHELP (D)
5765 -- /HELP
5766 --
5767 -- Output a message explaining the usage of gnatstack.
5769 S_Stack_List : aliased constant S := "/LIST=#" &
5770 "-l#";
5771 -- /LIST=nnn
5772 --
5773 -- Print the nnn subprograms requiring the biggest local stack usage. By
5774 -- default none will be displayed.
5776 S_Stack_Order : aliased constant S := "/ORDER=" &
5777 "STACK " &
5778 "-os " &
5779 "ALPHABETICAL " &
5780 "-oa";
5781 -- /ORDER[=order-option]
5782 --
5783 -- Specifies the order for displaying the different call graphs.
5784 -- order-option may be one of the following:
5785 --
5786 -- STACK (D) Select stack usage order
5787 --
5788 -- ALPHABETICAL Select alphabetical order
5790 S_Stack_Path : aliased constant S := "/PATH " &
5791 "-p";
5792 -- /NOPATH (D)
5793 -- /PATH
5794 --
5795 -- Print all the subprograms that make up the worst-case path for every
5796 -- entry point.
5798 S_Stack_Project : aliased constant S := "/PROJECT_FILE=<" &
5799 "-P>";
5800 -- /PROJECT_FILE=filename
5801 --
5802 -- Specifies the main project file to be used. The project files rooted
5803 -- at the main project file will be parsed before the invocation of
5804 -- gnatstack.
5806 S_Stack_Output : aliased constant S := "/OUTPUT=@" &
5807 "-f@";
5808 -- /OUTPUT=filename
5809 --
5810 -- Name of the file containing the generated graph (VCG format).
5812 S_Stack_Regexp : aliased constant S := "/EXPRESSION=|" &
5813 "-r|";
5814 --
5815 -- /EXPRESSION=regular-expression
5816 --
5817 -- Any symbol matching the regular expression will be considered as a
5818 -- potential entry point for the analysis.
5820 S_Stack_Unbounded : aliased constant S := "/UNBOUNDED=#" &
5821 "-d#";
5822 -- /UNBOUNDED=nnn
5823 --
5824 -- Default stack size to be used for unbounded (dynamic) frames.
5826 S_Stack_Unknown : aliased constant S := "/UNKNOWN=#" &
5827 "-u#";
5828 -- /UNKNOWN=nnn
5829 --
5830 -- Default stack size to be used for unknown (external) calls.
5832 S_Stack_Verbose : aliased constant S := "/VERBOSE " &
5833 "-v";
5834 -- /NOVERBOSE (D)
5835 -- /VERBOSE
5836 --
5837 -- Specifies the amount of information to be displayed about the
5838 -- different subprograms. In verbose mode the full location of the
5839 -- subprogram will be part of the output, as well as detailed information
5840 -- about inaccurate data.
5842 S_Stack_Warnings : aliased constant S := "/WARNINGS=" &
5843 "ALL " &
5844 "-Wa " &
5845 "CYCLES " &
5846 "-Wc " &
5847 "UNBOUNDED " &
5848 "-Wu " &
5849 "EXTERNAL " &
5850 "-We " &
5851 "INDIRECT " &
5852 "-Wi";
5853 -- /WARNINGS[=(keyword[,...])]
5854 --
5855 -- The following keywords are supported:
5856 --
5857 -- ALL Turn on all optional warnings
5858 --
5859 -- CYCLES Turn on warnings for cycles
5860 --
5861 -- UNBOUNDED Turn on warnings for unbounded frames
5862 --
5863 -- EXTERNAL Turn on warnings for external calls
5864 --
5865 -- INDIRECT Turn on warnings for indirect calls
5867 Stack_Switches : aliased constant Switches :=
5869 S_Stack_All 'Access,
5871 S_Stack_All_Prjs 'Access,
5873 S_Stack_Directory 'Access,
5875 S_Stack_Files 'Access,
5877 S_Stack_List 'Access,
5879 S_Stack_Path 'Access,
5881 S_Stack_Output 'Access,
5883 S_Stack_Unbounded 'Access,
5885 S_Stack_Verbose 'Access,
5888 ----------------------------
5889 -- Switches for GNAT STUB --
5890 ----------------------------
5894 -- /ADD_PROJECT_SEARCH_PATH==(directory[,...])
5895 --
5896 -- Add directories to the project search path.
5900 -- /CONFIGURATION_PRAGMAS_FILE=filespec
5901 --
5902 -- Specifies a configuration pragmas file that must be taken into account
5903 -- when compiling.
5907 -- /CURRENT_DIRECTORY (D)
5908 -- /NOCURRENT_DIRECTORY
5909 --
5910 -- Look for source, library or object files in the default directory.
5914 -- /EXTERNAL_REFERENCE="name=val"
5915 --
5916 -- Specifies an external reference to the project manager. Useful only if
5917 -- /PROJECT_FILE is used.
5918 --
5919 -- Example:
5920 -- /EXTERNAL_REFERENCE="DEBUG=TRUE"
5924 -- /NOFULL (D)
5925 -- /FULL
5926 --
5927 -- If the destination directory already contains a file with the name of
5928 -- the body file for the argument file spec, replace it with the generated
5929 -- body stub. If /FULL is not used and there is already a body file, this
5930 -- existing body file is not replaced.
5937 -- /HEADER[=header-option]
5938 --
5939 -- Specifies the form of the comment header above the generated body stub.
5940 -- If no /HEADER qualifier is specified, there is no comment header.
5941 -- header-option is one of the following:
5942 --
5943 --
5944 -- GENERAL (D) Put a sample comment header into the body stub.
5945 --
5946 -- SPEC Put the comment header (i.e., all the comments
5947 -- preceding the compilation unit) from the source of the
5948 -- library unit declaration into the body stub.
5952 -- /INDENTATION=nnn
5953 --
5954 -- (nnn is a non-negative integer). Set the indentation level in the
5955 -- generated body stub to nnn. nnn=0 means "no indentation".
5956 -- Default insdentation is 3.
5960 -- /NOKEEP (D)
5961 -- /KEEP
5962 --
5963 -- Do not delete the tree file (i.e., the snapshot of the compiler
5964 -- internal structures used by gnatstub) after creating the body stub.
5968 -- /LINE_LENGTH=nnn
5969 --
5970 -- (n is a non-negative integer). Set the maximum line length in the body
5971 -- stub to nnn. Default is 78.
5980 -- /MESSAGES_PROJECT_FILE[=messages-option]
5981 --
5982 -- Specifies the "verbosity" of the parsing of project files.
5983 -- messages-option may be one of the following:
5984 --
5985 -- DEFAULT (D) No messages are output if there is no error or warning.
5986 --
5987 -- MEDIUM A small number of messages are output.
5988 --
5989 -- HIGH A great number of messages are output, most of them not
5990 -- being useful for the user.
5994 -- /OUTPUT=filespec
5995 --
5996 -- Body file name. This should be set if the argument file name does not
5997 -- follow the GNAT file naming conventions. If this switch is omitted,
5998 -- the default name for the body will be obtained from the argument file
5999 -- name according to the GNAT file naming conventions.
6003 -- /PROJECT_FILE=filename
6004 --
6005 -- Specifies the main project file to be used. The project files rooted
6006 -- at the main project file will be parsed before any other processing.
6007 -- The source and object directories to be searched will be communicated
6008 -- to gnatstub through logical names ADA_PRJ_INCLUDE_FILE and
6009 -- ADA_PRJ_OBJECTS_FILE.
6013 -- /NOQUIET (D)
6014 -- /QUIET
6015 --
6016 -- Quiet mode: do not generate a confirmation when a body is successfully
6017 -- created, and do not generate a message when a body is not required for
6018 -- an argument unit.
6022 -- /SEARCH=(directory[,...])
6023 --
6024 -- When looking for source files also look in directories specified.
6033 -- /TREE_FILE[=treefile-option]
6034 --
6035 -- Specify what to do with the tree file.
6036 -- treefile-option is one of the following:
6037 --
6038 -- OVERWRITE (D) Overwrite the existing tree file. If the current
6039 -- directory already contains the file which, according
6040 -- to the GNAT file naming rules should be considered
6041 -- as a tree file for the argument source file,
6042 -- gnatstub will refuse to create the tree file needed
6043 -- to create a sample body unless this option is chosen.
6044 --
6045 -- SAVE Do not remove the tree file (i.e., the snapshot
6046 -- of the compiler internal structures used by gnatstub)
6047 -- after creating the body stub.
6048 --
6049 -- REUSE Reuse the tree file (if it exists) instead of
6050 -- creating it.
6051 -- Instead of creating the tree file for the library
6052 -- unit declaration, gnatstub tries to find it in the
6053 -- current directory and use it for creating a body.
6054 -- If the tree file is not found, no body is created.
6055 -- This option also implies `SAVE', whether or not the
6056 -- latter is set explicitly.
6060 -- /NOVERBOSE (D)
6061 -- /VERBOSE
6062 --
6063 -- Verbose mode: generate version information.
6068 S_Stub_Current 'Access,
6070 S_Stub_Full 'Access,
6072 S_Stub_Indent 'Access,
6074 S_Stub_Length 'Access,
6076 S_Stub_Output 'Access,
6078 S_Stub_Quiet 'Access,
6080 S_Stub_Tree 'Access,
6083 ----------------------------
6084 -- Switches for GNAT XREF --
6085 ----------------------------
6089 -- /ADD_PROJECT_SEARCH_PATH==(directory[,...])
6090 --
6091 -- Add directories to the project search path.
6095 -- /NOALL_FILES (D)
6096 -- /ALL_FILES
6097 --
6098 -- If this switch is present, FIND and XREF will parse the read-only
6099 -- files found in the library search path. Otherwise, these files will
6100 -- be ignored. This option can be used to protect Gnat sources or your
6101 -- own libraries from being parsed, thus making FIND and XREF much
6102 -- faster, and their output much smaller.
6106 -- /NODERIVED_TYPES (D)
6107 -- /DERIVED_TYPES
6108 --
6109 -- Output the parent type reference for each matching derived types.
6113 -- /EXTERNAL_REFERENCE="name=val"
6114 --
6115 -- Specifies an external reference to the project manager. Useful only if
6116 -- /PROJECT_FILE is used.
6117 --
6118 -- Example:
6119 -- /EXTERNAL_REFERENCE="DEBUG=TRUE"
6123 -- /NOFULL_PATHNAME (D)
6124 -- /FULL_PATHNAME
6125 --
6126 -- If this switch is set, the output file names will be preceded by their
6127 -- directory (if the file was found in the search path). If this switch
6128 -- is not set, the directory will not be printed.
6132 -- /NOIGNORE_LOCALS (D)
6133 -- /IGNORE_LOCALS
6134 --
6135 -- If this switch is set, information is output only for library-level
6136 -- entities, ignoring local entities. The use of this switch may
6137 -- accelerate FIND and XREF.
6146 -- /MESSAGES_PROJECT_FILE[=messages-option]
6147 --
6148 -- Specifies the "verbosity" of the parsing of project files.
6149 -- messages-option may be one of the following:
6150 --
6151 -- DEFAULT (D) No messages are output if there is no error or warning.
6152 --
6153 -- MEDIUM A small number of messages are output.
6154 --
6155 -- HIGH A great number of messages are output, most of them not
6156 -- being useful for the user.
6160 -- /NOSTD_INCLUDES
6161 --
6162 -- Do not look for sources in the system default directory.
6166 -- /NOSTD_LIBRARIES
6167 --
6168 -- Do not look for library files in the system default directory.
6172 -- /OBJECT_SEARCH=(directory,...)
6173 --
6174 -- When searching for library and object files, look in the specified
6175 -- directories. The order in which library files are searched is the same
6176 -- as for MAKE.
6180 -- /PROJECT=file
6181 --
6182 -- Specify a project file to use. By default, FIND and XREF will try to
6183 -- locate a project file in the current directory.
6184 --
6185 -- If a project file is either specified or found by the tools, then the
6186 -- content of the source directory and object directory lines are added
6187 -- as if they had been specified respectively by /SOURCE_SEARCH and
6188 -- /OBJECT_SEARCH.
6192 -- /PROJECT_FILE=filename
6193 --
6194 -- Specifies the main project file to be used. The project files rooted
6195 -- at the main project file will be parsed before doing any processing.
6196 -- The source and object directories to be searched will be communicated
6197 -- to gnatxref through logical names ADA_PRJ_INCLUDE_FILE and
6198 -- ADA_PRJ_OBJECTS_FILE.
6202 -- /SEARCH=(directory,...)
6203 --
6204 -- Equivalent to:
6205 -- /OBJECT_SEARCH=(directory,...) /SOURCE_SEARCH=(directory,...)
6209 -- /SOURCE_SEARCH=(directory,...)
6210 --
6211 -- When looking for source files also look in the specified directories.
6212 -- The order in which source file search is undertaken is the same as for
6213 -- MAKE.
6217 -- /SOURCE_SEARCH=(directory,...)
6218 --
6219 -- When looking for source files also look in the specified directories.
6220 -- The order in which source file search is undertaken is the same as for
6221 -- MAKE.
6225 -- /NOTAGS (D)
6226 -- /TAGS
6227 --
6228 -- Print a 'tags' file for vi.
6233 S_Xref_Deriv 'Access,
6235 S_Xref_Full 'Access,
6237 S_Xref_Mess 'Access,
6239 S_Xref_Nostlib 'Access,
6241 S_Xref_Project 'Access,
6243 S_Xref_Search 'Access,
6245 S_Xref_Output 'Access,