Development.IDE.GHC.Compat

Attempt at hiding the GHC version differences we can.

Documentation

newtype NameCacheUpdater

A function that atomically updates the name cache given a modifier function. The second result of the modifier function will be the result of the IO action.

Constructors

NCU

Fields

• updateNameCache :: forall c. (NameCache -> (NameCache, c)) -> IO c

hPutStringBuffer :: Handle -> StringBuffer -> IO ()

addIncludePathsQuote :: FilePath -> DynFlags -> DynFlags

getModuleHash :: ModIface -> Fingerprint

setUpTypedHoles :: DynFlags -> DynFlags

upNameCache :: IORef NameCache -> (NameCache -> (NameCache, c)) -> IO c

disableWarningsAsErrors :: DynFlags -> DynFlags

reLoc :: Located a -> Located a

reLocA :: Located a -> Located a

getMessages' :: PState -> DynFlags -> (Bag WarnMsg, Bag ErrMsg)

pattern PFailedWithErrorMessages :: (DynFlags -> ErrorMessages) -> ParseResult a

isObjectLinkable :: Linkable -> Bool

type RefMap a = Map Identifier [(Span, IdentifierDetails a)]

nodeInfo' :: Ord a => HieAST a -> NodeInfo a

getNodeIds :: HieAST a -> NodeIdentifiers a

nodeInfoFromSource :: HieAST a -> Maybe (NodeInfo a)

isAnnotationInNodeInfo :: (FastString, FastString) -> NodeInfo a -> Bool

mkAstNode :: NodeInfo a -> Span -> [HieAST a] -> HieAST a

combineRealSrcSpans :: RealSrcSpan -> RealSrcSpan -> RealSrcSpan

isQualifiedImport :: ImportDecl a -> Bool

data GhcVersion

Constructors

GHC86

GHC88

GHC810

GHC90

GHC92

Instances

Eq GhcVersion

Defined in Development.IDE.GHC.Compat

Methods

(==) :: GhcVersion -> GhcVersion -> Bool

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

Ord GhcVersion

Defined in Development.IDE.GHC.Compat

Methods

compare :: GhcVersion -> GhcVersion -> Ordering

(<) :: GhcVersion -> GhcVersion -> Bool

(<=) :: GhcVersion -> GhcVersion -> Bool

(>) :: GhcVersion -> GhcVersion -> Bool

(>=) :: GhcVersion -> GhcVersion -> Bool

max :: GhcVersion -> GhcVersion -> GhcVersion

min :: GhcVersion -> GhcVersion -> GhcVersion

Show GhcVersion

Defined in Development.IDE.GHC.Compat

Methods

showsPrec :: Int -> GhcVersion -> ShowS

show :: GhcVersion -> String

showList :: [GhcVersion] -> ShowS

ghcVersion :: GhcVersion

ghcVersionStr :: String

HIE Compat

data HieFileResult

Constructors

HieFileResult

Fields

• hie_file_result_version :: Integer
• hie_file_result_ghc_version :: ByteString
• hie_file_result :: HieFile

data HieFile

GHC builds up a wealth of information about Haskell source as it compiles it. .hie files are a way of persisting some of this information to disk so that external tools that need to work with haskell source don't need to parse, typecheck, and rename all over again. These files contain:

• a simplified AST

  • nodes are annotated with source positions and types
  • identifiers are annotated with scope information
• the raw bytes of the initial Haskell source

Besides saving compilation cycles, .hie files also offer a more stable interface than the GHC API.

Constructors

HieFile

Fields

• hie_hs_file :: FilePath

  Initial Haskell source file path

• hie_module :: Module

  The module this HIE file is for

• hie_types :: Array TypeIndex HieTypeFlat

  Types referenced in the hie_asts.

  See Note [Efficient serialization of redundant type info]

• hie_asts :: HieASTs TypeIndex

  Type-annotated abstract syntax trees

• hie_exports :: [AvailInfo]

  The names that this module exports

• hie_hs_src :: ByteString

  Raw bytes of the initial Haskell source

Instances

Show HieFile

Defined in Development.IDE.GHC.Orphans

Methods

showsPrec :: Int -> HieFile -> ShowS

show :: HieFile -> String

showList :: [HieFile] -> ShowS

NFData HieFile

Defined in Development.IDE.GHC.Orphans

Methods

rnf :: HieFile -> ()

Binary HieFile

Defined in HieTypes

Methods

put_ :: BinHandle -> HieFile -> IO ()

put :: BinHandle -> HieFile -> IO (Bin HieFile)

get :: BinHandle -> IO HieFile

hieExportNames :: HieFile -> [(SrcSpan, Name)]

mkHieFile' :: ModSummary -> [AvailInfo] -> HieASTs Type -> ByteString -> Hsc HieFile

enrichHie :: TypecheckedSource -> RenamedSource -> Hsc (HieASTs Type)

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

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

readHieFile :: NameCacheUpdater -> FilePath -> IO HieFileResult

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

supportsHieFiles :: Bool

setHieDir :: FilePath -> DynFlags -> DynFlags

dontWriteHieFiles :: DynFlags -> DynFlags

module Compat.HieTypes

module Compat.HieUtils

Compat modules

module Development.IDE.GHC.Compat.Core

module Development.IDE.GHC.Compat.Env

module Development.IDE.GHC.Compat.ExactPrint

module Development.IDE.GHC.Compat.Iface

module Development.IDE.GHC.Compat.Logger

module Development.IDE.GHC.Compat.Outputable

module Development.IDE.GHC.Compat.Parser

module Development.IDE.GHC.Compat.Plugins

module Development.IDE.GHC.Compat.Units

Extras that rely on compat modules

SysTools

data Option

When invoking external tools as part of the compilation pipeline, we pass these a sequence of options on the command-line. Rather than just using a list of Strings, we use a type that allows us to distinguish between filepaths and 'other stuff'. The reason for this is that this type gives us a handle on transforming filenames, and filenames only, to whatever format they're expected to be on a particular platform.

Constructors

FileOption String String

Option String

Instances

Eq Option

Defined in CliOption

Methods

(==) :: Option -> Option -> Bool

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

runUnlit :: Logger -> DynFlags -> [Option] -> IO ()

runPp :: Logger -> DynFlags -> [Option] -> IO ()

Recompilation avoidance

hscCompileCoreExprHook :: Hooks -> Maybe (HscEnv -> SrcSpan -> CoreExpr -> IO ForeignHValue)

type CoreExpr = Expr CoreBndr

Expressions where binders are CoreBndrs

simplifyExpr :: DynFlags -> HscEnv -> CoreExpr -> IO CoreExpr

tidyExpr :: TidyEnv -> CoreExpr -> CoreExpr

emptyTidyEnv :: TidyEnv

corePrepExpr :: DynFlags -> HscEnv -> CoreExpr -> IO CoreExpr

lintInteractiveExpr :: String -> HscEnv -> CoreExpr -> IO ()

icInteractiveModule :: InteractiveContext -> Module

type HomePackageTable = DModuleNameEnv HomeModInfo

Helps us find information about modules in the home package

lookupHpt :: HomePackageTable -> ModuleName -> Maybe HomeModInfo

data Dependencies

Dependency information about ALL modules and packages below this one in the import hierarchy.

Invariant: the dependencies of a module M never includes M.

Invariant: none of the lists contain duplicates.

Instances

Eq Dependencies

Defined in HscTypes

Methods

(==) :: Dependencies -> Dependencies -> Bool

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

Binary Dependencies

Defined in HscTypes

Methods

put_ :: BinHandle -> Dependencies -> IO ()

put :: BinHandle -> Dependencies -> IO (Bin Dependencies)

get :: BinHandle -> IO Dependencies

bcoFreeNames :: UnlinkedBCO -> UniqDSet Name

Finds external references. Remember to remove the names defined by this group of BCOs themselves

type ModIfaceAnnotation = Annotation

pattern Annotation :: CoreAnnTarget -> AnnPayload -> Annotation

data AnnTarget name

An annotation target

Constructors

ModuleTarget Module

We are annotating a particular module

Instances

Functor AnnTarget

Defined in Annotations

Methods

fmap :: (a -> b) -> AnnTarget a -> AnnTarget b

(<$) :: a -> AnnTarget b -> AnnTarget a

Binary name => Binary (AnnTarget name)

Defined in Annotations

Methods

put_ :: BinHandle -> AnnTarget name -> IO ()

put :: BinHandle -> AnnTarget name -> IO (Bin (AnnTarget name))

get :: BinHandle -> IO (AnnTarget name)

Uniquable name => Uniquable (AnnTarget name)

Defined in Annotations

Methods

getUnique :: AnnTarget name -> Unique

Outputable name => Outputable (AnnTarget name)

Defined in Annotations

Methods

ppr :: AnnTarget name -> SDoc

pprPrec :: Rational -> AnnTarget name -> SDoc

extendAnnEnvList :: AnnEnv -> [Annotation] -> AnnEnv

Add the given annotation to the environment.

module UniqDSet

module UniqSet

module UniqDFM

getDependentMods :: ModIface -> [ModuleName]

coreExprToBCOs :: HscEnv -> Module -> CoreExpr -> IO UnlinkedBCO

linkExpr :: HscEnv -> SrcSpan -> UnlinkedBCO -> IO ForeignHValue

Link a single expression, including first linking packages and modules that this expression depends on.

Raises an IO exception (ProgramError) if it can't find a compiled version of the dependents to link.