aspell-pipe-0.2: Pipe-based interface to the Aspell program

Safe HaskellSafe
LanguageHaskell2010

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

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

Synopsis

Documentation

data Aspell Source #

A handle to a running Aspell instance.

Instances

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.

data Mistake Source #

A spelling mistake.

Constructors

Mistake 

Fields

data AspellOption Source #

An Aspell option.

Constructors

UseDictionary Text

Use the specified dictionary (see aspell -d).

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.