Development.IDE.GHC.Util

General utility functions, mostly focused around GHC operations.

HcsEnv and environment

data HscEnvEq

An HscEnv with equality. Two values are considered equal if they are created with the same call to newHscEnvEq.

Instances

Eq HscEnvEq

Defined in Development.IDE.GHC.Util

Methods

(==) :: HscEnvEq -> HscEnvEq -> Bool

(/=) :: HscEnvEq -> HscEnvEq -> Bool

Show HscEnvEq

Defined in Development.IDE.GHC.Util

Methods

showsPrec :: Int -> HscEnvEq -> ShowS

show :: HscEnvEq -> String

showList :: [HscEnvEq] -> ShowS

Hashable HscEnvEq

Defined in Development.IDE.GHC.Util

Methods

hashWithSalt :: Int -> HscEnvEq -> Int

hash :: HscEnvEq -> Int

Binary HscEnvEq

Defined in Development.IDE.GHC.Util

Methods

put :: HscEnvEq -> Put

get :: Get HscEnvEq

putList :: [HscEnvEq] -> Put

NFData HscEnvEq

Defined in Development.IDE.GHC.Util

Methods

rnf :: HscEnvEq -> ()

hscEnv :: HscEnvEq -> HscEnv

newHscEnvEq :: FilePath -> HscEnv -> [(InstalledUnitId, DynFlags)] -> IO HscEnvEq

Wrap an HscEnv into an HscEnvEq.

hscEnvWithImportPaths :: HscEnvEq -> HscEnv

Unwrap the HscEnv with the original import paths. Used only for locating imports

envImportPaths :: HscEnvEq -> Maybe [String]

If Just, import dirs originally configured in this env If Nothing, the env import dirs are unaltered

modifyDynFlags :: GhcMonad m => (DynFlags -> DynFlags) -> m ()

Used to modify dyn flags in preference to calling setSessionDynFlags, since that function also reloads packages (which is very slow).

evalGhcEnv :: HscEnv -> Ghc b -> IO b

Run a Ghc monad value using an existing HscEnv. Sets up and tears down all the required pieces, but designed to be more efficient than a standard runGhc.

deps :: HscEnvEq -> [(InstalledUnitId, DynFlags)]

In memory components for this HscEnv This is only used at the moment for the import dirs in the DynFlags

GHC wrappers

prettyPrint :: Outputable a => a -> String

Pretty print a GHC value using 'unsafeGlobalDynFlags '.

printRdrName :: RdrName -> String

Pretty print a RdrName wrapping operators in parens

printName :: Name -> String

Pretty print a Name wrapping operators in parens

data ParseResult a

The result of running a parser.

Constructors

POk

The parser has consumed a (possibly empty) prefix of the input and produced a result. Use getMessages to check for accumulated warnings and non-fatal errors.

Fields

• PState

  The resulting parsing state. Can be used to resume parsing.

• a

  The resulting value.

PFailed

The parser has consumed a (possibly empty) prefix of the input and failed.

Fields

• PState

  The parsing state right before failure, including the fatal parse error. getMessages and getErrorMessages must return a non-empty bag of errors.

runParser :: DynFlags -> String -> P a -> ParseResult a

lookupPackageConfig :: UnitId -> HscEnv -> Maybe PackageConfig

Given a UnitId try and find the associated PackageConfig in the environment.

textToStringBuffer :: Text -> StringBuffer

Convert from the text package to the GHC StringBuffer. Currently implemented somewhat inefficiently (if it ever comes up in a profile).

bytestringToStringBuffer :: ByteString -> StringBuffer

stringBufferToByteString :: StringBuffer -> ByteString

moduleImportPath :: NormalizedFilePath -> ModuleName -> Maybe FilePath

Given a module location, and its parse tree, figure out what is the include directory implied by it. For example, given the file /usr/Test/Foo/Bar.hs with the module name Foo.Bar the directory /usr/Test should be on the include path to find sibling modules.

cgGutsToCoreModule :: SafeHaskellMode -> CgGuts -> ModDetails -> CoreModule

Convert from a CgGuts to a CoreModule.

fingerprintToBS :: Fingerprint -> ByteString

Convert a Fingerprint to a ByteString by copying the byte across. Will produce an 8 byte unreadable ByteString.

fingerprintFromStringBuffer :: StringBuffer -> IO Fingerprint

Take the Fingerprint of a StringBuffer.

General utilities

readFileUtf8 :: FilePath -> IO Text

Read a UTF8 file, with lenient decoding, so it will never raise a decoding error.

hDuplicateTo' :: Handle -> Handle -> IO ()

A slightly modified version of hDuplicateTo from GHC. Importantly, it avoids the bug listed in https://gitlab.haskell.org/ghc/ghc/merge_requests/2318.

setHieDir :: FilePath -> DynFlags -> DynFlags

dontWriteHieFiles :: DynFlags -> DynFlags

disableWarningsAsErrors :: DynFlags -> DynFlags

newHscEnvEqPreserveImportPaths :: HscEnv -> [(InstalledUnitId, DynFlags)] -> IO HscEnvEq

Wrap an HscEnv into an HscEnvEq.

newHscEnvEqWithImportPaths :: Maybe [String] -> HscEnv -> [(InstalledUnitId, DynFlags)] -> IO HscEnvEq