Text.SpellingSuggest

Simplified interface for spelling suggestion.

Documentation

data PhoneticCoder

We need to know the name and coding function of each phonetic coder.

data SpellingDictionary

The spelling dictionary.

Constructors

WordList [String]

FlatFile String

data SearchParams

Parameters controlling the suggestion search.

Constructors

SearchParams

Fields

searchParamsFilter :: SpellingWordFilter

Prefilter to use to limit search.

searchParamsCoder :: PhoneticCoder

Phonetic coder to use for matches.

searchParamsChoices :: Int

Maximum number of choices returned.

defaultSearchParams :: SearchParams

These params work OK in practice.

findPhoneticCoder :: String -> Maybe PhoneticCoder

Return the coding system with the given name.

defaultPhoneticCoder :: PhoneticCoder

A default phonetic coder.

defaultWordFilter :: SpellingWordFilter

A default word filter.

dictionaryIsDB :: SpellingDictionary -> Bool

For performance reasons, it may sometimes be desirable to know what's sitting under the dictionary.

openDictionary :: Maybe String -> Maybe String -> IO SpellingDictionary

Make a connection to the given or default database. If this fails, open the given or default dictionary and cache the words. XXX Will leak a file handle if readDictionary does.

closeDictionary :: SpellingDictionary -> IO ()

suggest :: SearchParams -> SpellingDictionary -> String -> IO [String]

Suggest candidates in order using the given information. Requires a valid spelling dictionary.

suggestFromList :: SearchParams -> [String] -> String -> [String]

Suggest candidates from the given list in order using the given information.

nearbyWordFilter :: String -> String -> Bool

Return True if the editDistance from the target word to the given word is small enough.

anyWordFilter :: String -> String -> Bool

Always returns True.

defaultDB :: IO String

File path for default cache database.

defaultDictionary :: String

File path for default dictionary.