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


-- | Haskell API Search
--   
--   Hoogle is a Haskell API search engine, which allows you to search many
--   standard Haskell libraries by either function name, or by approximate
--   type signature.
@package hoogle
@version 4.1.2


-- | The Hoogle API.
module Hoogle
data TagStr

-- | Plain text.
Str :: String -> TagStr

-- | A list of tags one after another.
Tags :: [TagStr] -> TagStr

-- | Bold text.
TagBold :: TagStr -> TagStr

-- | Underlined/italic text.
TagEmph :: TagStr -> TagStr

-- | A hyperlink to a URL.
TagLink :: String -> TagStr -> TagStr

-- | Colored text. Index into a 0-based palette.
TagColor :: Int -> TagStr -> TagStr

-- | Show a <a>TagStr</a> as a string, without any formatting.
showTagText :: TagStr -> String

-- | Show a <a>TagStr</a> on a console with ANSI escape sequences.
showTagANSI :: TagStr -> String

-- | Show a <a>TagStr</a> as HTML, using CSS classes for color styling.
showTagHTML :: TagStr -> String

-- | Show TagStr with an override for specific tags.
showTagHTMLWith :: (TagStr -> Maybe String) -> TagStr -> String
formatTags :: String -> [((Int, Int), TagStr -> TagStr)] -> TagStr

-- | 1 based
data ParseError
ParseError :: Int -> Int -> String -> TagStr -> ParseError
lineNo :: ParseError -> Int
columnNo :: ParseError -> Int
errorMessage :: ParseError -> String
parseInput :: ParseError -> TagStr
emptyParseError :: ParseError
type URL = String
data Language
Haskell :: Language
data Database
loadDatabase :: FilePath -> IO Database
saveDatabase :: FilePath -> Database -> IO ()

-- | From a textbase lines we have currently
createDatabase :: Language -> [Database] -> String -> ([ParseError], Database)
showDatabase :: Database -> Maybe [String] -> String
data Query
parseQuery :: Language -> String -> Either ParseError Query
renderQuery :: Query -> TagStr
isBlankQuery :: Query -> Bool
queryDatabases :: Query -> [String]
querySuggestions :: Database -> Query -> Maybe TagStr
queryCompletions :: Database -> String -> [String]
data Score

-- | A list of scores where one is lower than the other, returns the score
--   result. In the <a>IO</a> monad since it may require randomness, and it
--   may output status messages while solving, particularly if in Verbose
--   mode.
scoring :: [(Score, Score)] -> IO String
data Result
Result :: Maybe (URL, String) -> Maybe (URL, String) -> (URL, TagStr) -> TagStr -> Result
package :: Result -> Maybe (URL, String)
modul :: Result -> Maybe (URL, String)
self :: Result -> (URL, TagStr)
docs :: Result -> TagStr
searchAll :: Database -> Query -> [(Score, Result)]

-- | A pair of bounds. These bounds are the lowest and highest indices in
--   the array, in that order. For example, the first 10 elements are (0,9)
--   and the next 10 are (10,19)
searchRange :: (Int, Int) -> Database -> Query -> [(Score, Result)]
instance Typeable Language
instance Enum Language
instance Read Language
instance Show Language
instance Eq Language
instance Ord Language
instance Bounded Language
instance Data Language
instance Show Database
instance Monoid Database