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-2021, 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 3,  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.                                     --
17--                                                                          --
18-- As a special exception under Section 7 of GPL version 3, you are granted --
19-- additional permissions described in the GCC Runtime Library Exception,   --
20-- version 3.1, as published by the Free Software Foundation.               --
21--                                                                          --
22-- You should have received a copy of the GNU General Public License and    --
23-- a copy of the GCC Runtime Library Exception along with this program;     --
24-- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
25-- <http://www.gnu.org/licenses/>.                                          --
26--                                                                          --
27-- GNAT was originally developed  by the GNAT team at  New York University. --
28-- Extensive contributions were provided by Ada Core Technologies Inc.      --
29--                                                                          --
30------------------------------------------------------------------------------
31
32--  Spelling checker
33
34--  This package provides a utility routine for checking for bad spellings
35--  for the case of System.WCh_Cnv.UTF_32_String arguments.
36
37pragma Compiler_Unit_Warning;
38
39with System.WCh_Cnv;
40
41package GNAT.UTF_32_Spelling_Checker is
42   pragma Pure;
43
44   function Is_Bad_Spelling_Of
45     (Found  : System.WCh_Cnv.UTF_32_String;
46      Expect : System.WCh_Cnv.UTF_32_String) return Boolean;
47   --  Determines if the string Found is a plausible misspelling of the string
48   --  Expect. Returns True for an exact match or a probably misspelling, False
49   --  if no near match is detected. This routine is case sensitive, so the
50   --  caller should fold both strings to get a case insensitive match.
51   --
52   --  Note: the spec of this routine is deliberately rather vague. It is used
53   --  by GNAT itself to detect misspelled keywords and identifiers, and is
54   --  heuristically adjusted to be appropriate to this usage. It will work
55   --  well in any similar case of named entities.
56
57end GNAT.UTF_32_Spelling_Checker;
58