gcc/ada/g-speche.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUNTIME COMPONENTS                          --
   4 --                                                                          --
   5 --                 G N A T . S P E L L I N G _ C H E C K E R                --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --                                                                          --
  10 --              Copyright (C) 1998 Ada Core Technologies, Inc.              --
  11 --                                                                          --
  12 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  13 -- terms of the  GNU General Public License as published  by the Free Soft- --
  14 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  15 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  16 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  17 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  18 -- for  more details.  You should have  received  a copy of the GNU General --
  19 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  20 -- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
  21 -- MA 02111-1307, USA.                                                      --
  22 --                                                                          --
  23 -- As a special exception,  if other files  instantiate  generics from this --
  24 -- unit, or you link  this unit with other files  to produce an executable, --
  25 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  26 -- covered  by the  GNU  General  Public  License.  This exception does not --
  27 -- however invalidate  any other reasons why  the executable file  might be --
  28 -- covered by the  GNU Public License.                                      --
  29 --                                                                          --
  30 -- GNAT is maintained by Ada Core Technologies Inc (http://www.gnat.com).   --
  31 --                                                                          --
  32 ------------------------------------------------------------------------------
  33
  34 --  Spelling checker
  35
  36 --  This package provides a utility routine for checking for bad spellings
  37
  38 package GNAT.Spelling_Checker is
  39 pragma Pure (Spelling_Checker);
  40
  41    function Is_Bad_Spelling_Of
  42      (Found  : String;
  43       Expect : String)
  44       return   Boolean;
  45    --  Determines if the string Found is a plausible misspelling of the
  46    --  string Expect. Returns True for an exact match or a probably
  47    --  misspelling, False if no near match is detected. This routine
  48    --  is case sensitive, so the caller should fold both strings to
  49    --  get a case insensitive match.
  50    --
  51    --  Note: the spec of this routine is deliberately rather vague. This
  52    --  routine is the one used by GNAT itself to detect misspelled keywords
  53    --  and identifiers, and is heuristically adjusted to be appropriate to
  54    --  this usage. It will work well in any similar case of named entities
  55    --  with relatively short mnemonic names.
  56
  57 end GNAT.Spelling_Checker;