Text.Aspell

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

http://aspell.net/man-html/Through-A-Pipe.html

Documentation

data Aspell

A handle to a running Aspell instance.

Instances

Show Aspell

Defined in Text.Aspell

Methods

showsPrec :: Int -> Aspell -> ShowS

show :: Aspell -> String

showList :: [Aspell] -> ShowS

data AspellResponse

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

Defined in Text.Aspell

Methods

(==) :: AspellResponse -> AspellResponse -> Bool

(/=) :: AspellResponse -> AspellResponse -> Bool

Show AspellResponse

Defined in Text.Aspell

Methods

showsPrec :: Int -> AspellResponse -> ShowS

show :: AspellResponse -> String

showList :: [AspellResponse] -> ShowS

data Mistake

A spelling mistake.

Constructors

Mistake

Fields

• mistakeWord :: Text

  The original word in misspelled form.

• mistakeNearMisses :: Int

  The number of alternative correct spellings that were counted.

• mistakeOffset :: Int

  The offset, starting at zero, in the original input where this misspelling occurred.

• mistakeAlternatives :: [Text]

  The correct spelling alternatives.

Instances

Eq Mistake

Defined in Text.Aspell

Methods

(==) :: Mistake -> Mistake -> Bool

(/=) :: Mistake -> Mistake -> Bool

Show Mistake

Defined in Text.Aspell

Methods

showsPrec :: Int -> Mistake -> ShowS

show :: Mistake -> String

showList :: [Mistake] -> ShowS

data AspellOption

An Aspell option.

Constructors

UseDictionary Text

Use the specified dictionary (see aspell -d).

RawArg Text

Provide a command-line argument directly to aspell.

Instances

Eq AspellOption

Defined in Text.Aspell

Methods

(==) :: AspellOption -> AspellOption -> Bool

(/=) :: AspellOption -> AspellOption -> Bool

Show AspellOption

Defined in Text.Aspell

Methods

showsPrec :: Int -> AspellOption -> ShowS

show :: AspellOption -> String

showList :: [AspellOption] -> ShowS

startAspell :: [AspellOption] -> IO (Either String Aspell)

Start Aspell with the specified options. Returns either an error message on failure or an Aspell handle on success.

Any RawArgs provided in the option list are provided to aspell as command-line arguments in the order provided.

stopAspell :: Aspell -> IO ()

Stop a running Aspell instance.

askAspell :: Aspell -> Text -> IO [AspellResponse]

Submit input text to Aspell for spell-checking. The input text may contain multiple lines. This returns an AspellResponse for each line.

This function is thread-safe and will block until other callers finish.

aspellIdentification :: Aspell -> Text

startup-reported version string

aspellDictionaries :: IO (Either String [Text])

Obtain the list of installed Aspell dictionaries.