The Hoogle API.
- data TagStr
- showTagText :: TagStr -> String
- showTagANSI :: TagStr -> String
- showTagHTML :: TagStr -> String
- showTagHTMLWith :: (TagStr -> Maybe String) -> TagStr -> String
- formatTags :: String -> [((Int, Int), TagStr -> TagStr)] -> TagStr
- data ParseError = ParseError {
- lineNo :: Int
- columnNo :: Int
- errorMessage :: String
- parseInput :: TagStr
- emptyParseError :: ParseError
- type URL = String
- data Language = Haskell
- data Database
- loadDatabase :: FilePath -> IO Database
- saveDatabase :: FilePath -> Database -> IO ()
- 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
- scoring :: [(Score, Score)] -> IO String
- data Result = Result {}
- searchAll :: Database -> Query -> [(Score, Result)]
- searchRange :: (Int, Int) -> Database -> Query -> [(Score, Result)]
Utility types
showTagText :: TagStr -> StringSource
Show a TagStr
as a string, without any formatting.
showTagANSI :: TagStr -> StringSource
Show a TagStr
on a console with ANSI escape sequences.
showTagHTML :: TagStr -> StringSource
Show a TagStr
as HTML, using CSS classes for color styling.
showTagHTMLWith :: (TagStr -> Maybe String) -> TagStr -> StringSource
Show TagStr with an override for specific tags.
data ParseError Source
1 based
ParseError | |
|
Database
loadDatabase :: FilePath -> IO DatabaseSource
createDatabase :: Language -> [Database] -> String -> ([ParseError], Database)Source
From a textbase lines we have currently
Query
parseQuery :: Language -> String -> Either ParseError QuerySource
renderQuery :: Query -> TagStrSource
isBlankQuery :: Query -> BoolSource
queryDatabases :: Query -> [String]Source
queryCompletions :: Database -> String -> [String]Source
Score
scoring :: [(Score, Score)] -> IO StringSource
A list of scores where one is lower than the other, returns the score result.
In the IO
monad since it may require randomness, and it may output status messages while solving,
particularly if in Verbose mode.