Haskell.Docs.Index

Make an index from identifiers to modules.

Looking up identifiers

lookupIdent :: [String] -> Text -> IO (Maybe (HashMap Text [Text]))

Lookup an identifier. Automatically creates an index if none exists.

Internally generating indexes

type Index = HashMap Text Text

An identifier index.

generateIndex :: [String] -> IO Index

Generate an identifier index.

generateFlatFile :: [String] -> IO [(String, String, String)]

Generate a flat file of all package, module, name combinations.

saveIndex :: Index -> IO ()

Save the index to file.

getIndexFilename :: IO FilePath

Filename to read/write index to.

Internally looking up inside indexes

lookupInIndex :: Text -> IO (Maybe (HashMap Text [Text]))

Lookup an entry in the index by identifier.

extractModules :: ByteString -> HashMap Text [Text]

Extract the "package:Module package:Module" string into a map from package to modules.

sha1 :: String -> String

SHA1 hex-encode a string.

getPkgFlags :: IO String

Get unique package flags string.