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 --                            $Revision: 1.12 $
  10 --                                                                          --
  11 --          Copyright (C) 1992-2000 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 -- As a special exception,  if other files  instantiate  generics from this --
  25 -- unit, or you link  this unit with other files  to produce an executable, --
  26 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  27 -- covered  by the  GNU  General  Public  License.  This exception does not --
  28 -- however invalidate  any other reasons why  the executable file  might be --
  29 -- covered by the  GNU Public License.                                      --
  30 --                                                                          --
  31 -- GNAT was originally developed  by the GNAT team at  New York University. --
  32 -- It is now maintained by Ada Core Technologies Inc (http://www.gnat.com). --
  33 --                                                                          --
  34 ------------------------------------------------------------------------------
  35
  36 with Types; use Types;
  37
  38 package Casing is
  39
  40    --  This package contains data and subprograms to support the feature that
  41    --  recognizes the letter case styles used in the source program being
  42    --  compiled, and uses this information for error message formatting, and
  43    --  for recognizing reserved words that are misused as identifiers.
  44
  45    -------------------------------
  46    -- Case Control Declarations --
  47    -------------------------------
  48
  49    --  Declaration of type for describing casing convention
  50
  51    type Casing_Type is (
  52
  53       All_Upper_Case,
  54       --  All letters are upper case
  55
  56       All_Lower_Case,
  57       --  All letters are lower case
  58
  59       Mixed_Case,
  60       --  The initial letter, and any letters after underlines are upper case.
  61       --  All other letters are lower case
  62
  63       Unknown
  64       --  Used if an identifier does not distinguish between the above cases,
  65       --  (e.g. X, Y_3, M4, A_B, or if it is inconsistent ABC_def).
  66    );
  67
  68    ------------------------------
  69    -- Case Control Subprograms --
  70    ------------------------------
  71
  72    procedure Set_Casing (C : Casing_Type; D : Casing_Type := Mixed_Case);
  73    --  Takes the name stored in the first Name_Len positions of Name_Buffer
  74    --  and modifies it to be consistent with the casing given by C, or if
  75    --  C = Unknown, then with the casing given by D. The name is basically
  76    --  treated as an identifier, except that special separator characters
  77    --  other than underline are permitted and treated like underlines (this
  78    --  handles cases like minus and period in unit names, apostrophes in error
  79    --  messages, angle brackets in names like <any_type>, etc).
  80
  81    procedure Set_All_Upper_Case;
  82    pragma Inline (Set_All_Upper_Case);
  83    --  This procedure is called with an identifier name stored in Name_Buffer.
  84    --  On return, the identifier is converted to all upper case. The call is
  85    --  equivalent to Set_Casing (All_Upper_Case).
  86
  87    function Determine_Casing (Ident : Text_Buffer) return Casing_Type;
  88    --  Determines the casing of the identifier/keyword string Ident
  89
  90 end Casing;