gcc/ada/casing.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                               C A S I N G                                --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2000 Free Software Foundation, Inc.          --
  10 --                                                                          --
  11 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  12 -- terms of the  GNU General Public License as published  by the Free Soft- --
  13 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  14 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  15 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  16 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  17 -- for  more details.  You should have  received  a copy of the GNU General --
  18 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  19 -- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
  20 -- MA 02111-1307, USA.                                                      --
  21 --                                                                          --
  22 -- As a special exception,  if other files  instantiate  generics from this --
  23 -- unit, or you link  this unit with other files  to produce an executable, --
  24 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  25 -- covered  by the  GNU  General  Public  License.  This exception does not --
  26 -- however invalidate  any other reasons why  the executable file  might be --
  27 -- covered by the  GNU Public License.                                      --
  28 --                                                                          --
  29 -- GNAT was originally developed  by the GNAT team at  New York University. --
  30 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  31 --                                                                          --
  32 ------------------------------------------------------------------------------
  33
  34 with Types; use Types;
  35
  36 package Casing is
  37
  38    --  This package contains data and subprograms to support the feature that
  39    --  recognizes the letter case styles used in the source program being
  40    --  compiled, and uses this information for error message formatting, and
  41    --  for recognizing reserved words that are misused as identifiers.
  42
  43    -------------------------------
  44    -- Case Control Declarations --
  45    -------------------------------
  46
  47    --  Declaration of type for describing casing convention
  48
  49    type Casing_Type is (
  50
  51       All_Upper_Case,
  52       --  All letters are upper case
  53
  54       All_Lower_Case,
  55       --  All letters are lower case
  56
  57       Mixed_Case,
  58       --  The initial letter, and any letters after underlines are upper case.
  59       --  All other letters are lower case
  60
  61       Unknown
  62       --  Used if an identifier does not distinguish between the above cases,
  63       --  (e.g. X, Y_3, M4, A_B, or if it is inconsistent ABC_def).
  64    );
  65
  66    ------------------------------
  67    -- Case Control Subprograms --
  68    ------------------------------
  69
  70    procedure Set_Casing (C : Casing_Type; D : Casing_Type := Mixed_Case);
  71    --  Takes the name stored in the first Name_Len positions of Name_Buffer
  72    --  and modifies it to be consistent with the casing given by C, or if
  73    --  C = Unknown, then with the casing given by D. The name is basically
  74    --  treated as an identifier, except that special separator characters
  75    --  other than underline are permitted and treated like underlines (this
  76    --  handles cases like minus and period in unit names, apostrophes in error
  77    --  messages, angle brackets in names like <any_type>, etc).
  78
  79    procedure Set_All_Upper_Case;
  80    pragma Inline (Set_All_Upper_Case);
  81    --  This procedure is called with an identifier name stored in Name_Buffer.
  82    --  On return, the identifier is converted to all upper case. The call is
  83    --  equivalent to Set_Casing (All_Upper_Case).
  84
  85    function Determine_Casing (Ident : Text_Buffer) return Casing_Type;
  86    --  Determines the casing of the identifier/keyword string Ident
  87
  88 end Casing;