gcc/ada/switch-m.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                             S W I T C H - M                              --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --                            $Revision$
  10 --                                                                          --
  11 --          Copyright (C) 2001 Free Software Foundation, Inc.               --
  12 --                                                                          --
  13 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  14 -- terms of the  GNU General Public License as published  by the Free Soft- --
  15 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  16 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  17 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  18 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  19 -- for  more details.  You should have  received  a copy of the GNU General --
  20 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  21 -- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
  22 -- MA 02111-1307, USA.                                                      --
  23 --                                                                          --
  24 -- GNAT was originally developed  by the GNAT team at  New York University. --
  25 -- It is now maintained by Ada Core Technologies Inc (http://www.gnat.com). --
  26 --                                                                          --
  27 ------------------------------------------------------------------------------
  28
  29 --  This package scans make switches. Note that the body of Usage must be
  30 --  coordinated with the switches that are recognized by this package.
  31 --  The Usage package also acts as the official documentation for the
  32 --  switches that are recognized. In addition, package Debug documents
  33 --  the otherwise undocumented debug switches that are also recognized.
  34
  35 with GNAT.OS_Lib; use GNAT.OS_Lib;
  36
  37 package Switch.M is
  38
  39    procedure Scan_Make_Switches (Switch_Chars : String);
  40    --  Procedures to scan out binder switches stored in the given string.
  41    --  The first character is known to be a valid switch character, and there
  42    --  are no blanks or other switch terminator characters in the string, so
  43    --  the entire string should consist of valid switch characters, except that
  44    --  an optional terminating NUL character is allowed. A bad switch causes
  45    --  a fatal error exit and control does not return. The call also sets
  46    --  Usage_Requested to True if a ? switch is encountered.
  47
  48    procedure Normalize_Compiler_Switches
  49      (Switch_Chars : String;
  50       Switches     : in out Argument_List_Access;
  51       Last         : out Natural);
  52    --  Takes a compiler switch which potentially is equivalent to more
  53    --  that one simple switches and returns the equivalent list of simple
  54    --  switches that are stored in an ALI file. Switches will be extended
  55    --  if initially null or too short. Last indicates the index in Switches
  56    --  of the last simple switch. Last is equal to zero, if it has been
  57    --  determined that Switch_Chars is ill-formed or does not contain any
  58    --  switch that should be stored in an ALI file. Otherwise, the list of
  59    --  simple switches is Switches (Switches'First .. Last).
  60    --
  61    --    Example: if Switch_Chars is equal to "-gnatAwue", then the list of
  62    --    simple switches will have 3 components: -gnatA, -gnatwu, -gnatwe.
  63    --
  64    --  The String_Access components of Switches should not be deallocated:
  65    --  they are shallow copies of components in a table in the body.
  66
  67    function Normalize_Compiler_Switches
  68      (Switch_Chars : String)
  69       return         Argument_List;
  70    --  Similar to the previous procedure. The return value is the list of
  71    --  simple switches. It may be an empty array if it has been determined
  72    --  that Switch_Chars is ill-formed or does not contain any switch that
  73    --  should be stored in an ALI file. The String_Access components of the
  74    --  returned value should not be deallocated.
  75
  76 end Switch.M;