ghc-lib-8.10.6.20210814: The GHC API, decoupled from GHC versions
Safe HaskellNone
LanguageHaskell2010

HieBin

Synopsis

Documentation

readHieFile :: NameCache -> FilePath -> IO (HieFileResult, NameCache) Source #

Read a HieFile from a FilePath. Can use an existing NameCache.

readHieFileWithVersion :: (HieHeader -> Bool) -> NameCache -> FilePath -> IO (Either HieHeader (HieFileResult, NameCache)) Source #

Read a HieFile from a FilePath. Can use an existing NameCache. Allows you to specify which versions of hieFile to attempt to read. Left case returns the failing header versions.

writeHieFile :: FilePath -> HieFile -> IO () Source #

Write a HieFile to the given FilePath, with a proper header and symbol tables for Names and FastStrings

data HieName Source #

Name's get converted into HieName's before being written into .hie files. See toHieName and fromHieName for logic on how to convert between these two types.

Instances

Instances details
Eq HieName Source # 
Instance details

Defined in HieBin

Methods

(==) :: HieName -> HieName -> Bool #

(/=) :: HieName -> HieName -> Bool #

Ord HieName Source # 
Instance details

Defined in HieBin

Outputable HieName Source # 
Instance details

Defined in HieBin

Methods

ppr :: HieName -> SDoc #

pprPrec :: Rational -> HieName -> SDoc #

hieMagic :: [Word8] Source #

The header for HIE files - Capital ASCII letters HIE.