Safe Haskell | Safe |
---|---|
Language | Haskell2010 |
Text.Aspell
Description
A pipe-based interface to Aspell.
This interface is beneficial when dynamic linking against the Aspell library would be undesirable, e.g., for binary portability reasons.
This implementation is based on the description of the Aspell pipe protocol at
Synopsis
- data Aspell
- data AspellResponse
- = AllCorrect
- | Mistakes [Mistake]
- data Mistake = Mistake {
- mistakeWord :: Text
- mistakeNearMisses :: Int
- mistakeOffset :: Int
- mistakeAlternatives :: [Text]
- data AspellOption = UseDictionary Text
- startAspell :: [AspellOption] -> IO (Either String Aspell)
- stopAspell :: Aspell -> IO ()
- askAspell :: Aspell -> Text -> IO [AspellResponse]
- aspellIdentification :: Aspell -> Text
- aspellDictionaries :: IO (Either String [Text])
Documentation
A handle to a running Aspell instance.
data AspellResponse Source #
The kind of responses we can get from Aspell.
Constructors
AllCorrect | The input had no spelling mistakes. |
Mistakes [Mistake] | The input had the specified mistakes. |
Instances
Eq AspellResponse Source # | |
Defined in Text.Aspell Methods (==) :: AspellResponse -> AspellResponse -> Bool (/=) :: AspellResponse -> AspellResponse -> Bool | |
Show AspellResponse Source # | |
Defined in Text.Aspell Methods showsPrec :: Int -> AspellResponse -> ShowS show :: AspellResponse -> String showList :: [AspellResponse] -> ShowS |
A spelling mistake.
Constructors
Mistake | |
Fields
|
data AspellOption Source #
An Aspell option.
Constructors
UseDictionary Text | Use the specified dictionary (see aspell -d). |
Instances
Eq AspellOption Source # | |
Defined in Text.Aspell | |
Show AspellOption Source # | |
Defined in Text.Aspell Methods showsPrec :: Int -> AspellOption -> ShowS show :: AspellOption -> String showList :: [AspellOption] -> ShowS |
startAspell :: [AspellOption] -> IO (Either String Aspell) Source #
Start Aspell with the specified options. Returns either an error message on failure or an Aspell handle on success.
stopAspell :: Aspell -> IO () Source #
Stop a running Aspell instance.
askAspell :: Aspell -> Text -> IO [AspellResponse] Source #
Submit user input to Aspell for spell-checking. Returns an AspellResponse for each line of user input.
aspellIdentification :: Aspell -> Text Source #
startup-reported version string
aspellDictionaries :: IO (Either String [Text]) Source #
Obtain the list of installed Aspell dictionaries.