-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Pipe-based interface to the Aspell program
--   
--   A pipe-based interface to the Aspell program (no dynamic linking
--   required).
@package aspell-pipe
@version 0.6


-- | 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
--   
--   <a>http://aspell.net/man-html/Through-A-Pipe.html</a>
module Text.Aspell

-- | A handle to a running Aspell instance.
data Aspell

-- | The kind of responses we can get from Aspell.
data AspellResponse

-- | The input had no spelling mistakes.
AllCorrect :: AspellResponse

-- | The input had the specified mistakes.
Mistakes :: [Mistake] -> AspellResponse

-- | A spelling mistake.
data Mistake
Mistake :: Text -> Int -> Int -> [Text] -> Mistake

-- | The original word in misspelled form.
[mistakeWord] :: Mistake -> Text

-- | The number of alternative correct spellings that were counted.
[mistakeNearMisses] :: Mistake -> Int

-- | The offset, starting at zero, in the original input where this
--   misspelling occurred.
[mistakeOffset] :: Mistake -> Int

-- | The correct spelling alternatives.
[mistakeAlternatives] :: Mistake -> [Text]

-- | An Aspell option.
data AspellOption

-- | Use the specified dictionary (see <tt>aspell -d</tt>).
UseDictionary :: Text -> AspellOption

-- | Provide a command-line argument directly to <tt>aspell</tt>.
RawArg :: Text -> AspellOption

-- | Start Aspell with the specified options. Returns either an error
--   message on failure or an <a>Aspell</a> handle on success.
--   
--   Any <a>RawArg</a>s provided in the option list are provided to
--   <tt>aspell</tt> as command-line arguments in the order provided.
startAspell :: [AspellOption] -> IO (Either String Aspell)

-- | Stop a running Aspell instance.
stopAspell :: Aspell -> IO ()

-- | Submit input text to Aspell for spell-checking. The input text may
--   contain multiple lines. This returns an <a>AspellResponse</a> for each
--   line.
--   
--   This function is thread-safe and will block until other callers
--   finish.
askAspell :: Aspell -> Text -> IO [AspellResponse]

-- | startup-reported version string
aspellIdentification :: Aspell -> Text

-- | Obtain the list of installed Aspell dictionaries.
aspellDictionaries :: IO (Either String [Text])
instance GHC.Classes.Eq Text.Aspell.Mistake
instance GHC.Show.Show Text.Aspell.Mistake
instance GHC.Show.Show Text.Aspell.AspellResponse
instance GHC.Classes.Eq Text.Aspell.AspellResponse
instance GHC.Classes.Eq Text.Aspell.AspellOption
instance GHC.Show.Show Text.Aspell.AspellOption
instance GHC.Show.Show Text.Aspell.Aspell