gcc/ada/g-spchge.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUN-TIME COMPONENTS                         --
   4 --                                                                          --
   5 --          G N A T . S P E L L I N G _ C H E C K E R _ G E N E R I C       --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --                     Copyright (C) 1998-2008, AdaCore                     --
  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,  51  Franklin  Street,  Fifth  Floor, --
  20 -- Boston, MA 02110-1301, 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 --  Spelling checker
  35
  36 --  This package provides a utility generic routine for checking for bad
  37 --  spellings. This routine must be instantiated with an appropriate array
  38 --  element type, which must represent a character encoding in which the
  39 --  codes for ASCII characters in the range 16#20#..16#7F# have their normal
  40 --  expected encoding values (e.g. the Pos value 16#31# must be digit 1).
  41
  42 pragma Compiler_Unit;
  43
  44 package GNAT.Spelling_Checker_Generic is
  45    pragma Pure;
  46
  47    generic
  48       type Char_Type is (<>);
  49       --  See above for restrictions on what types can be used here
  50
  51       type String_Type is array (Positive range <>) of Char_Type;
  52
  53    function Is_Bad_Spelling_Of
  54      (Found  : String_Type;
  55       Expect : String_Type) return Boolean;
  56    --  Determines if the string Found is a plausible misspelling of the string
  57    --  Expect. Returns True for an exact match or a probably misspelling, False
  58    --  if no near match is detected. This routine is case sensitive, so the
  59    --  caller should fold both strings to get a case insensitive match if the
  60    --  character encoding represents upper/lower case.
  61    --
  62    --  Note: the spec of this routine is deliberately rather vague. This
  63    --  routine is the one used by GNAT itself to detect misspelled keywords
  64    --  and identifiers, and is heuristically adjusted to be appropriate to
  65    --  this usage. It will work well in any similar case of named entities.
  66
  67 end GNAT.Spelling_Checker_Generic;