This is the mail archive of the gcc-patches@gcc.gnu.org mailing list for the GCC project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

[Ada] Add ability to list compiler switches with gnatcmd


This patch adds a new switch (--help-ada) to gnatcmd for displaying all
the availible build flags as well as fixing some minor differences in
output between implicit and explicit help for gnatcmd (e.g. "gnat" vs
"gnat --help").

$ gnat
GNAT Pro 20.0w (19940713)
Copyright 1996-2019, Free Software Foundation, Inc.

To list Ada build switches use --help-ada

List of available commands

gnat bind               gnatbind
gnat chop               gnatchop
gnat clean              gnatclean
gnat compile            gnatmake -f -u -c
gnat check              gnatcheck
gnat elim               gnatelim
gnat find               gnatfind
gnat krunch             gnatkr
gnat link               gnatlink
gnat list               gnatls
gnat make               gnatmake
gnat metric             gnatmetric
gnat name               gnatname
gnat preprocess         gnatprep
gnat pretty             gnatpp
gnat stack              gnatstack
gnat stub               gnatstub
gnat test               gnattest
gnat xref               gnatxref

Report bugs to report@adacore.com

$ gnat --help
GNAT Pro 20.0w (19940713)
Copyright 1996-2019, Free Software Foundation, Inc.

To list Ada build switches use --help-ada

List of available commands

gnat bind               gnatbind
gnat chop               gnatchop
gnat clean              gnatclean
gnat compile            gnatmake -f -u -c
gnat check              gnatcheck
gnat elim               gnatelim
gnat find               gnatfind
gnat krunch             gnatkr
gnat link               gnatlink
gnat list               gnatls
gnat make               gnatmake
gnat metric             gnatmetric
gnat name               gnatname
gnat preprocess         gnatprep
gnat pretty             gnatpp
gnat stack              gnatstack
gnat stub               gnatstub
gnat test               gnattest
gnat xref               gnatxref

Report bugs to report@adacore.com

$ gnat --help-ada
Usage: gnat switches sfile

  sfile     Source file name

  -g            Generate debugging information
  -Idir         Specify source files search path
  -I-           Do not look for sources in current directory
  -O[0123]      Control the optimization level

  -gnata    Assertions enabled. Pragma Assert/Debug to be activated
  -gnatA    Avoid processing gnat.adc, if present file will be ignored
  -gnatb    Generate brief messages to stderr even if verbose mode set
  -gnatB    Assume no bad (invalid) values except in 'Valid attribute
  -gnatc    Check syntax and semantics only (no code generation)
  -gnatC    Generate CodePeer intermediate format (no code generation)
  -gnatd?   Compiler debug option ? ([.]a-z,A-Z,0-9), see debug.adb
  -gnatD    Debug expanded generated code (max line length = 72)
  -gnatDnn  Debug expanded generated code (max line length = nn)
  -gnateA   Aliasing checks on subprogram parameters
  -gnatec=? Specify configuration pragmas file, e.g. -gnatec=/x/f.adc
  -gnateC   Generate CodePeer messages (ignored without -gnatcC)
  -gnated   Disable synchronization of atomic variables
  -gnateD?  Define or redefine preprocessing symbol, e.g. -gnateDsym=val
  -gnateE   Generate extra information in exception messages
  -gnatef   Full source path in brief error messages
  -gnateF   Check overflow on predefined Float types
  -gnateG   Generate preprocessed source
  -gnateinn Set maximum number of instantiations to nn
  -gnateInn Index in multi-unit source, e.g. -gnateI2
  -gnatel   Turn on info messages on generated Elaborate[_All] pragmas
  -gnateL   Turn off info messages on generated Elaborate[_All] pragmas
  -gnatem=? Specify mapping file, e.g. -gnatem=mapping
  -gnatep=? Specify preprocessing data file, e.g. -gnatep=prep.data
  -gnateP   Pure/Prelaborate errors generate warnings rather than errors
  -gnateS   Generate SCO (Source Coverage Obligation) information
  -gnatet=? Write target dependent information file ?, e.g. gnatet=tdf
  -gnateT=? Read target dependent information file ?, e.g. gnateT=tdf
  -gnateu   Ignore unrecognized style/validity/warning switches
  -gnateV   Validity checks on subprogram parameters
  -gnateY   Ignore all Style_Checks pragmas in source
  -gnatE    Dynamic elaboration checking mode enabled
  -gnatf    Full errors. Verbose details, all undefined references
  -gnatF    Force all import/export external names to all uppercase
  -gnatg    GNAT implementation mode (used for compiling GNAT units)
  -gnatG    Output generated expanded code (max line length = 72)
  -gnatGnn  Output generated expanded code (max line length = nn)
  -gnath    Output this usage (help) information
  -gnatH    Legacy elaboration checking mode enabled
  -gnati?   Identifier char set (?=1/2/3/4/5/8/9/p/f/n/w)
  -gnatI    Ignore all representation clauses
  -gnatjnn  Format error and warning messages to fit nn character lines
  -gnatJ    Relaxed elaboration checking mode enabled
  -gnatk    Limit file names to nn characters (k = krunch)
  -gnatl    Output full source listing with embedded error messages
  -gnatl=f  Output full source listing to specified file
  -gnatL    List corresponding source text in -gnatG or -gnatD output
  -gnatmnn  Limit number of detected errors/warnings to nn (1-999999)
  -gnatn[?] Enable pragma Inline across units (?=1/2 for moderate/full)
  -gnato0   Disable overflow checking
  -gnato    Enable overflow checking in STRICT (-gnato1) mode (default)
  -gnato?   Enable overflow checks in STRICT/MINIMIZED/ELIMINATED (1/2/3) mode
  -gnato??  Set mode for general/assertion expressions separately
  -gnatp    Suppress all checks
  -gnatP    Generate periodic calls to System.Polling.Poll
  -gnatq    Don't quit, try semantics, even if parse errors
  -gnatQ    Don't quit, write ali/tree file even if compile errors
  -gnatr    Treat pragma Restrictions as Restriction_Warnings
  -gnatR?   List rep info (?=0/1/2/3/4/e/m for none/types/all/sym/cg/ext/mech)
  -gnatR?j  List rep info in the JSON data interchange format
  -gnatR?s  List rep info to file.rep instead of standard output
  -gnats    Syntax check only
  -gnatS    Print listing of package Standard
  -gnatt    Tree output file to be generated
  -gnatTnn  All compiler tables start at nn times usual starting size
  -gnatu    List units for this compilation
  -gnatU    Enable unique tag for error messages
  -gnatv    Verbose mode. Full error output with source lines to stdout
  -gnatVxx  Enable selected validity checking mode, xx = list of parameters:
        a    turn on all validity checking options
        c    turn on checking for copies
        C    turn off checking for copies
        d    turn on default (RM) checking
        D    turn off default (RM) checking
        e    turn on checking for elementary components
        E    turn off checking for elementary components
        f    turn on checking for floating-point
        F    turn off checking for floating-point
        i    turn on checking for in params
        I    turn off checking for in params
        m    turn on checking for in out params
        M    turn off checking for in out params
        n    turn off all validity checks (including RM)
        o    turn on checking for operators/attributes
        O    turn off checking for operators/attributes
        p    turn on checking for parameters
        P    turn off checking for parameters
        r    turn on checking for returns
        R    turn off checking for returns
        s    turn on checking for subscripts
        S    turn off checking for subscripts
        t    turn on checking for tests
        T    turn off checking for tests
  -gnatwxx  Enable selected warning modes, xx = list of parameters:
        *    indicates default setting
        +    indicates warning flag included in -gnatwa
        a    turn on all info/warnings marked below with +
        A    turn off all optional info/warnings
        .a*+ turn on warnings for failing assertion
        .A   turn off warnings for failing assertion
        _a*+ turn on warnings for anonymous allocators
        _A   turn off warnings for anonymous allocators
        b+   turn on warnings for bad fixed value (not multiple of small)
        B*   turn off warnings for bad fixed value (not multiple of small)
        .b*+ turn on warnings for biased representation
        .B   turn off warnings for biased representation
        c+   turn on warnings for constant conditional
        C*   turn off warnings for constant conditional
        .c+  turn on warnings for unrepped components
        .C*  turn off warnings for unrepped components
        d    turn on warnings for implicit dereference
        D*   turn off warnings for implicit dereference
        .d   turn on tagging of warnings with -gnatw switch
        .D*  turn off tagging of warnings with -gnatw switch
        e    treat all warnings (but not info) as errors
        .e   turn on every optional info/warning (no exceptions)
        E    treat all run-time warnings as errors
        f+   turn on warnings for unreferenced formal
        F*   turn off warnings for unreferenced formal
        .f   turn on warnings for suspicious Subp'Access
        .F*  turn off warnings for suspicious Subp'Access
        g*+  turn on warnings for unrecognized pragma
        G    turn off warnings for unrecognized pragma
        .g   turn on GNAT warnings
        h    turn on warnings for hiding declarations
        H*   turn off warnings for hiding declarations
        .h   turn on warnings for holes in records
        .H*  turn off warnings for holes in records
        i*+  turn on warnings for implementation unit
        I    turn off warnings for implementation unit
        .i*+ turn on warnings for overlapping actuals
        .I   turn off warnings for overlapping actuals
        j+   turn on warnings for obsolescent (annex J) feature
        J*   turn off warnings for obsolescent (annex J) feature
        .j+  turn on warnings for late dispatching primitives
        .J*  turn off warnings for late dispatching primitives
        k+   turn on warnings on constant variable
        K*   turn off warnings on constant variable
        .k   turn on warnings for standard redefinition
        .K*  turn off warnings for standard redefinition
        l    turn on warnings for elaboration problems
        L*   turn off warnings for elaboration problems
        .l   turn on info messages for inherited aspects
        .L*  turn off info messages for inherited aspects
        m+   turn on warnings for variable assigned but not read
        M*   turn off warnings for variable assigned but not read
        .m*+ turn on warnings for suspicious modulus value
        .M   turn off warnings for suspicious modulus value
        n*   normal warning mode (cancels -gnatws/-gnatwe)
        .n   turn on info messages for atomic synchronization
        .N*  turn off info messages for atomic synchronization
        o*   turn on warnings for address clause overlay
        O    turn off warnings for address clause overlay
        .o   turn on warnings for out parameters assigned but not read
        .O*  turn off warnings for out parameters assigned but not read
        p+   turn on warnings for ineffective pragma Inline in frontend
        P*   turn off warnings for ineffective pragma Inline in frontend
        .p+  turn on warnings for suspicious parameter order
        .P*  turn off warnings for suspicious parameter order
        q*+  turn on warnings for questionable missing parenthesis
        Q    turn off warnings for questionable missing parenthesis
        .q+  turn on warnings for questionable layout of record types
        .Q*  turn off warnings for questionable layout of record types
        r+   turn on warnings for redundant construct
        R*   turn off warnings for redundant construct
        .r+  turn on warnings for object renaming function
        .R*  turn off warnings for object renaming function
        s    suppress all info/warnings
        .s   turn on warnings for overridden size clause
        .S*  turn off warnings for overridden size clause
        t    turn on warnings for tracking deleted code
        T*   turn off warnings for tracking deleted code
        .t*+ turn on warnings for suspicious contract
        .T   turn off warnings for suspicious contract
        u+   turn on warnings for unused entity
        U*   turn off warnings for unused entity
        .u   turn on warnings for unordered enumeration
        .U*  turn off warnings for unordered enumeration
        v*+  turn on warnings for unassigned variable
        V    turn off warnings for unassigned variable
        .v*+ turn on info messages for reverse bit order
        .V   turn off info messages for reverse bit order
        w*+  turn on warnings for wrong low bound assumption
        W    turn off warnings for wrong low bound assumption
        .w   turn on warnings on pragma Warnings Off
        .W*  turn off warnings on pragma Warnings Off
        x*+  turn on warnings for export/import
        X    turn off warnings for export/import
        .x+  turn on warnings for non-local exception
        .X*  turn off warnings for non-local exception
        y*+  turn on warnings for Ada compatibility issues
        Y    turn off warnings for Ada compatibility issues
        .y   turn on info messages for why pkg body needed
        .Y*  turn off info messages for why pkg body needed
        z*+  turn on warnings for suspicious unchecked conversion
        Z    turn off warnings for suspicious unchecked conversion
        .z*+ turn on warnings for record size not a multiple of alignment
        .Z   turn off warnings for record size not a multiple of alignment
  -gnatW?   Wide character encoding method (?=h/u/s/e/8/b)
  -gnatx    Suppress output of cross-reference information
  -gnatX    Language extensions permitted
  -gnaty    Enable default style checks (same as -gnaty3abcefhiklmnprst)
  -gnatyxx  Enable selected style checks xx = list of parameters:
        1-9  check indentation
        a    check attribute casing
        A    check array attribute indexes
        b    check no blanks at end of lines
        B    check no use of AND/OR for boolean expressions
        c    check comment format (two spaces)
        C    check comment format (one space)
        d    check no DOS line terminators
        e    check end/exit labels present
        f    check no form feeds/vertical tabs in source
        g    check standard GNAT style rules, same as ydISux
        h    check no horizontal tabs in source
        i    check if-then layout
        I    check mode in
        k    check casing rules for keywords
        l    check reference manual layout
        Lnn  check max nest level < nn
        m    check line length <= 79 characters
        Mnn  check line length <= nn characters
        n    check casing of package Standard identifiers
        N    turn off all checks
        o    check subprogram bodies in alphabetical order
        O    check overriding indicators
        p    check pragma casing
        r    check casing for identifier references
        s    check separate subprogram specs present
        S    check separate lines after THEN or ELSE
        t    check token separation rules
        u    check no unnecessary blank lines
        x    check extra parentheses around conditionals
        y    turn on default style checks
        -    subtract (turn off) subsequent checks
        +    add (turn on) subsequent checks
  -gnatyN   Cancel all previously set style checks
  -gnatzc   Distribution stub generation for caller stubs
  -gnatzr   Distribution stub generation for receiver stubs
  -gnat83   Ada 83 mode
  -gnat95   Ada 95 mode
  -gnat2005 Ada 2005 mode
  -gnat2012 Ada 2012 mode (default)
  -gnat-p   Cancel effect of previous -gnatp switch

Tested on x86_64-pc-linux-gnu, committed on trunk

2019-08-13  Justin Squirek  <squirek@adacore.com>

gcc/ada/

	* gnatcmd.adb (GNATCmd): Add constant for new compiler switch
	--help-ada, and include usage subprogram. Add line to usage help
	explaining the new flag.
	(GNATCmd_Usage): Rename from locally declared Usage so as not to
	confuse with the newly imported version. Add new argument case
	for --help-ada and add bug report email to implicit display of
	help without the --help flag so as to unify output between the
	two cases.
--- gcc/ada/gnatcmd.adb
+++ gcc/ada/gnatcmd.adb
@@ -30,6 +30,7 @@ with Osint;    use Osint;
 with Output;   use Output;
 with Switch;   use Switch;
 with Table;
+with Usage;
 
 with Ada.Characters.Handling; use Ada.Characters.Handling;
 with Ada.Command_Line;        use Ada.Command_Line;
@@ -43,6 +44,9 @@ procedure GNATCmd is
    Gprname  : constant String := "gprname";
    Gprls    : constant String := "gprls";
 
+   Ada_Help_Switch : constant String := "--help-ada";
+   --  Flag to display available build switches
+
    Error_Exit : exception;
    --  Raise this exception if error detected
 
@@ -229,7 +233,7 @@ procedure GNATCmd is
    procedure Output_Version;
    --  Output the version of this program
 
-   procedure Usage;
+   procedure GNATCmd_Usage;
    --  Display usage
 
    --------------------
@@ -244,14 +248,16 @@ procedure GNATCmd is
                 & ", Free Software Foundation, Inc.");
    end Output_Version;
 
-   -----------
-   -- Usage --
-   -----------
+   -------------------
+   -- GNATCmd_Usage --
+   -------------------
 
-   procedure Usage is
+   procedure GNATCmd_Usage is
    begin
       Output_Version;
       New_Line;
+      Put_Line ("To list Ada build switches use " & Ada_Help_Switch);
+      New_Line;
       Put_Line ("List of available commands");
       New_Line;
 
@@ -276,9 +282,10 @@ procedure GNATCmd is
       end loop;
 
       New_Line;
-   end Usage;
+   end GNATCmd_Usage;
 
-   procedure Check_Version_And_Help is new Check_Version_And_Help_G (Usage);
+   procedure Check_Version_And_Help
+     is new Check_Version_And_Help_G (GNATCmd_Usage);
 
 --  Start of processing for GNATCmd
 
@@ -351,6 +358,12 @@ begin
             Keep_Temporary_Files := True;
             Command_Arg := Command_Arg + 1;
 
+         elsif Command_Arg <= Argument_Count
+           and then Argument (Command_Arg) = Ada_Help_Switch
+         then
+            Usage;
+            Exit_Program (E_Success);
+
          else
             exit;
          end if;
@@ -359,7 +372,12 @@ begin
       --  If there is no command, just output the usage
 
       if Command_Arg > Argument_Count then
-         Usage;
+         GNATCmd_Usage;
+
+         --  Add the following so that output is consistent with or without the
+         --  --help flag.
+         Write_Eol;
+         Write_Line ("Report bugs to report@adacore.com");
          return;
       end if;
 
@@ -379,7 +397,7 @@ begin
 
          exception
             when Constraint_Error =>
-               Usage;
+               GNATCmd_Usage;
                Fail ("unknown command: " & Argument (Command_Arg));
          end;
    end;


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]