gcc/ada/g-u3spch.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUN-TIME COMPONENTS                         --
   4 --                                                                          --
   5 --          G N A T . U T F _ 3 2 _ S P E L L I N G _ C H E C K E R         --
   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 routine for checking for bad spellings
  37 --  for the case of System.WCh_Cnv.UTF_32_String arguments.
  38
  39 pragma Compiler_Unit;
  40
  41 with System.WCh_Cnv;
  42
  43 package GNAT.UTF_32_Spelling_Checker is
  44    pragma Pure;
  45
  46    function Is_Bad_Spelling_Of
  47      (Found  : System.WCh_Cnv.UTF_32_String;
  48       Expect : System.WCh_Cnv.UTF_32_String) return Boolean;
  49    --  Determines if the string Found is a plausible misspelling of the string
  50    --  Expect. Returns True for an exact match or a probably misspelling, False
  51    --  if no near match is detected. This routine is case sensitive, so the
  52    --  caller should fold both strings to get a case insensitive match.
  53    --
  54    --  Note: the spec of this routine is deliberately rather vague. It is used
  55    --  by GNAT itself to detect misspelled keywords and identifiers, and is
  56    --  heuristically adjusted to be appropriate to this usage. It will work
  57    --  well in any similar case of named entities.
  58
  59 end GNAT.UTF_32_Spelling_Checker;