Hoogle

Contents

Description

The Hoogle API.

Synopsis

Utility types

Constructors

Str String	Plain text.
Tags [TagStr]	A list of tags one after another.
TagBold TagStr	Bold text.
TagEmph TagStr	Underlined/italic text.
TagLink String TagStr	A hyperlink to a URL.
TagColor Int TagStr	Colored text. Index into a 0-based palette.

Instances

Eq TagStr
Data TagStr
Ord TagStr
Show TagStr
Typeable TagStr
Monoid TagStr
Uniplate TagStr
BinaryDefer TagStr

showTagText :: TagStr -> String Source

Show a TagStr as a string, without any formatting.

showTagANSI :: TagStr -> String Source

Show a TagStr on a console with ANSI escape sequences.

showTagHTML :: TagStr -> String Source

Show a TagStr as HTML, using CSS classes for color styling.

showTagHTMLWith :: (TagStr -> Maybe String) -> TagStr -> String Source

Show TagStr with an override for specific tags.

formatTags :: String -> [((Int, Int), TagStr -> TagStr)] -> TagStr Source

data ParseError Source

1 based

Constructors

ParseError
Fields lineNo :: Int columnNo :: Int errorMessage :: String parseInput :: TagStr

Instances

Eq ParseError
Data ParseError
Ord ParseError
Show ParseError
Typeable ParseError

emptyParseError :: ParseError Source

type URL = String Source

data Language Source

Constructors

Haskell

Instances

Bounded Language
Enum Language
Eq Language
Data Language
Ord Language
Read Language
Show Language
Typeable Language

Database

data Database Source

Instances

Show Database
Monoid Database

loadDatabase :: FilePath -> IO Database Source

saveDatabase :: FilePath -> Database -> IO ()Source

createDatabase :: Language -> [Database] -> String -> ([ParseError], Database)Source

From a textbase lines we have currently

showDatabase :: Database -> Maybe [String] -> String Source

Query

data Query Source

Instances

Eq Query
Data Query
Show Query
Typeable Query

parseQuery :: Language -> String -> Either ParseError Query Source

renderQuery :: Query -> TagStr Source

isBlankQuery :: Query -> Bool Source

queryDatabases :: Query -> [String]Source

querySuggestions :: Database -> Query -> Maybe TagStr Source

queryCompletions :: Database -> String -> [String]Source

Score

data Score Source

Instances

Eq Score
Ord Score
Show Score
Monoid Score

scoring :: [(Score, Score)] -> IO String Source

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.

Search

data Result Source

Constructors

Result
Fields package :: Maybe (URL, String) modul :: Maybe (URL, String) self :: (URL, TagStr) docs :: TagStr

searchAll :: Database -> Query -> [(Score, Result)]Source

searchRange :: (Int, Int) -> Database -> Query -> [(Score, Result)]Source

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)