File : 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-2013, 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 -- --
19 -- --
20 -- --
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 generic routine for checking for bad
35 -- spellings. This routine must be instantiated with an appropriate array
36 -- element type, which must represent a character encoding in which the
37 -- codes for ASCII characters in the range 16#20#..16#7F# have their normal
38 -- expected encoding values (e.g. the Pos value 16#31# must be digit 1).
39
40 pragma Compiler_Unit_Warning;
41
42 package GNAT.Spelling_Checker_Generic is
43 pragma Pure;
44
45 generic
46 type Char_Type is (<>);
47 -- See above for restrictions on what types can be used here
48
49 type String_Type is array (Positive range <>) of Char_Type;
50
51 function Is_Bad_Spelling_Of
52 (Found : String_Type;
53 Expect : String_Type) return Boolean;
54 -- Determines if the string Found is a plausible misspelling of the string
55 -- Expect. Returns True for an exact match or a probably misspelling, False
56 -- if no near match is detected. This routine is case sensitive, so the
57 -- caller should fold both strings to get a case insensitive match if the
58 -- character encoding represents upper/lower case.
59 --
60 -- Note: the spec of this routine is deliberately rather vague. This
61 -- routine is the one used by GNAT itself to detect misspelled keywords
62 -- and identifiers, and is heuristically adjusted to be appropriate to
63 -- this usage. It will work well in any similar case of named entities.
64
65 end GNAT.Spelling_Checker_Generic;