GHC

Initialisation

defaultErrorHandler :: ExceptionMonad m => FatalMessager -> FlushOut -> m a -> m a

Install some default exception handlers and run the inner computation. Unless you want to handle exceptions yourself, you should wrap this around the top level of your program. The default handlers output the error message(s) to stderr and exit cleanly.

defaultCleanupHandler :: ExceptionMonad m => DynFlags -> m a -> m a

Deprecated: Cleanup is now done by runGhc/runGhcT

This function is no longer necessary, cleanup is now done by runGhc/runGhcT.

prettyPrintGhcErrors :: ExceptionMonad m => DynFlags -> m a -> m a

withSignalHandlers :: ExceptionMonad m => m a -> m a

withCleanupSession :: GhcMonad m => m a -> m a

GHC Monad

data Ghc a

Instances

Monad Ghc

Defined in GHC.Driver.Monad

Methods

(>>=) :: Ghc a -> (a -> Ghc b) -> Ghc b

(>>) :: Ghc a -> Ghc b -> Ghc b

return :: a -> Ghc a

Functor Ghc

Defined in GHC.Driver.Monad

Methods

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

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

MonadFix Ghc

Defined in GHC.Driver.Monad

Methods

mfix :: (a -> Ghc a) -> Ghc a

Applicative Ghc

Defined in GHC.Driver.Monad

Methods

pure :: a -> Ghc a

(<*>) :: Ghc (a -> b) -> Ghc a -> Ghc b

liftA2 :: (a -> b -> c) -> Ghc a -> Ghc b -> Ghc c

(*>) :: Ghc a -> Ghc b -> Ghc b

(<*) :: Ghc a -> Ghc b -> Ghc a

MonadIO Ghc

Defined in GHC.Driver.Monad

Methods

liftIO :: IO a -> Ghc a

MonadThrow Ghc

Defined in GHC.Driver.Monad

Methods

throwM :: Exception e => e -> Ghc a

MonadCatch Ghc

Defined in GHC.Driver.Monad

Methods

catch :: Exception e => Ghc a -> (e -> Ghc a) -> Ghc a

MonadMask Ghc

Defined in GHC.Driver.Monad

Methods

mask :: ((forall a. Ghc a -> Ghc a) -> Ghc b) -> Ghc b

uninterruptibleMask :: ((forall a. Ghc a -> Ghc a) -> Ghc b) -> Ghc b

generalBracket :: Ghc a -> (a -> ExitCase b -> Ghc c) -> (a -> Ghc b) -> Ghc (b, c)

HasDynFlags Ghc

Defined in GHC.Driver.Monad

Methods

getDynFlags :: Ghc DynFlags

GhcMonad Ghc

Defined in GHC.Driver.Monad

Methods

getSession :: Ghc HscEnv

setSession :: HscEnv -> Ghc ()

data GhcT (m :: Type -> Type) a

Instances

Monad m => Monad (GhcT m)

Defined in GHC.Driver.Monad

Methods

(>>=) :: GhcT m a -> (a -> GhcT m b) -> GhcT m b

(>>) :: GhcT m a -> GhcT m b -> GhcT m b

return :: a -> GhcT m a

Functor m => Functor (GhcT m)

Defined in GHC.Driver.Monad

Methods

fmap :: (a -> b) -> GhcT m a -> GhcT m b

(<$) :: a -> GhcT m b -> GhcT m a

Applicative m => Applicative (GhcT m)

Defined in GHC.Driver.Monad

Methods

pure :: a -> GhcT m a

(<*>) :: GhcT m (a -> b) -> GhcT m a -> GhcT m b

liftA2 :: (a -> b -> c) -> GhcT m a -> GhcT m b -> GhcT m c

(*>) :: GhcT m a -> GhcT m b -> GhcT m b

(<*) :: GhcT m a -> GhcT m b -> GhcT m a

MonadIO m => MonadIO (GhcT m)

Defined in GHC.Driver.Monad

Methods

liftIO :: IO a -> GhcT m a

MonadThrow m => MonadThrow (GhcT m)

Defined in GHC.Driver.Monad

Methods

throwM :: Exception e => e -> GhcT m a

MonadCatch m => MonadCatch (GhcT m)

Defined in GHC.Driver.Monad

Methods

catch :: Exception e => GhcT m a -> (e -> GhcT m a) -> GhcT m a

MonadMask m => MonadMask (GhcT m)

Defined in GHC.Driver.Monad

Methods

mask :: ((forall a. GhcT m a -> GhcT m a) -> GhcT m b) -> GhcT m b

uninterruptibleMask :: ((forall a. GhcT m a -> GhcT m a) -> GhcT m b) -> GhcT m b

generalBracket :: GhcT m a -> (a -> ExitCase b -> GhcT m c) -> (a -> GhcT m b) -> GhcT m (b, c)

MonadIO m => HasDynFlags (GhcT m)

Defined in GHC.Driver.Monad

Methods

getDynFlags :: GhcT m DynFlags

ExceptionMonad m => GhcMonad (GhcT m)

Defined in GHC.Driver.Monad

Methods

getSession :: GhcT m HscEnv

setSession :: HscEnv -> GhcT m ()

class (Functor m, ExceptionMonad m, HasDynFlags m) => GhcMonad (m :: Type -> Type) where

Methods

getSession :: m HscEnv

setSession :: HscEnv -> m ()

Instances

GhcMonad Ghc

Defined in GHC.Driver.Monad

Methods

getSession :: Ghc HscEnv

setSession :: HscEnv -> Ghc ()

ExceptionMonad m => GhcMonad (GhcT m)

Defined in GHC.Driver.Monad

Methods

getSession :: GhcT m HscEnv

setSession :: HscEnv -> GhcT m ()

data HscEnv

runGhc

Arguments

:: Maybe FilePath

See argument to initGhcMonad.

-> Ghc a

The action to perform.

-> IO a

Run function for the Ghc monad.

It initialises the GHC session and warnings via initGhcMonad. Each call to this function will create a new session which should not be shared among several threads.

Any errors not handled inside the Ghc action are propagated as IO exceptions.

runGhcT

Arguments

:: ExceptionMonad m

=> Maybe FilePath

See argument to initGhcMonad.

-> GhcT m a

The action to perform.

-> m a

Run function for GhcT monad transformer.

It initialises the GHC session and warnings via initGhcMonad. Each call to this function will create a new session which should not be shared among several threads.

initGhcMonad :: GhcMonad m => Maybe FilePath -> m ()

Initialise a GHC session.

If you implement a custom GhcMonad you must call this function in the monad run function. It will initialise the session variable and clear all warnings.

The first argument should point to the directory where GHC's library files reside. More precisely, this should be the output of ghc --print-libdir of the version of GHC the module using this API is compiled with. For portability, you should use the ghc-paths package, available at http://hackage.haskell.org/package/ghc-paths.

printException :: GhcMonad m => SourceError -> m ()

handleSourceError :: MonadCatch m => (SourceError -> m a) -> m a -> m a

needsTemplateHaskellOrQQ :: ModuleGraph -> Bool

Flags and settings

data DynFlags

Constructors

DynFlags

Fields

• ghcMode :: GhcMode
• ghcLink :: GhcLink
• hscTarget :: HscTarget
• ghcNameVersion :: !GhcNameVersion
• fileSettings :: !FileSettings
• targetPlatform :: Platform
• toolSettings :: !ToolSettings
• platformMisc :: !PlatformMisc
• platformConstants :: PlatformConstants
• rawSettings :: [(String, String)]
• llvmConfig :: LlvmConfig
• verbosity :: Int
• optLevel :: Int
• debugLevel :: Int
• simplPhases :: Int
• maxSimplIterations :: Int
• ruleCheck :: Maybe String
• inlineCheck :: Maybe String
• strictnessBefore :: [Int]
• parMakeCount :: Maybe Int
• enableTimeStats :: Bool
• ghcHeapSize :: Maybe Int
• maxRelevantBinds :: Maybe Int
• maxValidHoleFits :: Maybe Int
• maxRefHoleFits :: Maybe Int
• refLevelHoleFits :: Maybe Int
• maxUncoveredPatterns :: Int
• maxPmCheckModels :: Int
• simplTickFactor :: Int
• specConstrThreshold :: Maybe Int
• specConstrCount :: Maybe Int
• specConstrRecursive :: Int
• binBlobThreshold :: Word
• liberateCaseThreshold :: Maybe Int
• floatLamArgs :: Maybe Int
• liftLamsRecArgs :: Maybe Int
• liftLamsNonRecArgs :: Maybe Int
• liftLamsKnown :: Bool
• cmmProcAlignment :: Maybe Int
• historySize :: Int
• importPaths :: [FilePath]
• mainModIs :: Module
• mainFunIs :: Maybe String
• reductionDepth :: IntWithInf
• solverIterations :: IntWithInf
• homeUnitId :: UnitId
• homeUnitInstanceOfId :: Maybe IndefUnitId
• homeUnitInstantiations :: [(ModuleName, Module)]
• ways :: Set Way
• splitInfo :: Maybe (String, Int)
• objectDir :: Maybe String
• dylibInstallName :: Maybe String
• hiDir :: Maybe String
• hieDir :: Maybe String
• stubDir :: Maybe String
• dumpDir :: Maybe String
• objectSuf :: String
• hcSuf :: String
• hiSuf :: String
• hieSuf :: String
• canGenerateDynamicToo :: IORef Bool
• dynObjectSuf :: String
• dynHiSuf :: String
• outputFile :: Maybe String
• dynOutputFile :: Maybe String
• outputHi :: Maybe String
• dynLibLoader :: DynLibLoader
• dumpPrefix :: Maybe FilePath
• dumpPrefixForce :: Maybe FilePath
• ldInputs :: [Option]
• includePaths :: IncludeSpecs
• libraryPaths :: [String]
• frameworkPaths :: [String]
• cmdlineFrameworks :: [String]
• rtsOpts :: Maybe String
• rtsOptsEnabled :: RtsOptsEnabled
• rtsOptsSuggestions :: Bool
• hpcDir :: String
• pluginModNames :: [ModuleName]
• pluginModNameOpts :: [(ModuleName, String)]
• frontendPluginOpts :: [String]
• cachedPlugins :: [LoadedPlugin]
• staticPlugins :: [StaticPlugin]
• hooks :: Hooks
• depMakefile :: FilePath
• depIncludePkgDeps :: Bool
• depIncludeCppDeps :: Bool
• depExcludeMods :: [ModuleName]
• depSuffixes :: [String]
• packageDBFlags :: [PackageDBFlag]
• ignorePackageFlags :: [IgnorePackageFlag]
• packageFlags :: [PackageFlag]
• pluginPackageFlags :: [PackageFlag]
• trustFlags :: [TrustFlag]
• packageEnv :: Maybe FilePath
• unitDatabases :: Maybe [UnitDatabase UnitId]
• unitState :: UnitState
• filesToClean :: IORef FilesToClean
• dirsToClean :: IORef (Map FilePath FilePath)
• nextTempSuffix :: IORef Int
• generatedDumps :: IORef (Set FilePath)
• dumpFlags :: EnumSet DumpFlag
• generalFlags :: EnumSet GeneralFlag
• warningFlags :: EnumSet WarningFlag
• fatalWarningFlags :: EnumSet WarningFlag
• language :: Maybe Language
• safeHaskell :: SafeHaskellMode
• safeInfer :: Bool
• safeInferred :: Bool
• thOnLoc :: SrcSpan
• newDerivOnLoc :: SrcSpan
• overlapInstLoc :: SrcSpan
• incoherentOnLoc :: SrcSpan
• pkgTrustOnLoc :: SrcSpan
• warnSafeOnLoc :: SrcSpan
• warnUnsafeOnLoc :: SrcSpan
• trustworthyOnLoc :: SrcSpan
• extensions :: [OnOff Extension]
• extensionFlags :: EnumSet Extension
• ufCreationThreshold :: Int
• ufUseThreshold :: Int
• ufFunAppDiscount :: Int
• ufDictDiscount :: Int
• ufDearOp :: Int
• ufVeryAggressive :: Bool
• maxWorkerArgs :: Int
• ghciHistSize :: Int
• log_action :: LogAction
• dump_action :: DumpAction
• trace_action :: TraceAction
• flushOut :: FlushOut
• flushErr :: FlushErr
• ghcVersionFile :: Maybe FilePath
• haddockOptions :: Maybe String
• ghciScripts :: [String]
• pprUserLength :: Int
• pprCols :: Int
• useUnicode :: Bool
• useColor :: OverridingBool
• canUseColor :: Bool
• colScheme :: Scheme
• profAuto :: ProfAuto
• interactivePrint :: Maybe String
• nextWrapperNum :: IORef (ModuleEnv Int)
• sseVersion :: Maybe SseVersion
• bmiVersion :: Maybe BmiVersion
• avx :: Bool
• avx2 :: Bool
• avx512cd :: Bool
• avx512er :: Bool
• avx512f :: Bool
• avx512pf :: Bool
• rtldInfo :: IORef (Maybe LinkerInfo)
• rtccInfo :: IORef (Maybe CompilerInfo)
• maxInlineAllocSize :: Int
• maxInlineMemcpyInsns :: Int
• maxInlineMemsetInsns :: Int
• reverseErrors :: Bool
• maxErrors :: Maybe Int
• initialUnique :: Int
• uniqueIncrement :: Int
• cfgWeightInfo :: CfgWeights

data GeneralFlag

Constructors

Opt_DumpToFile

Opt_D_faststring_stats

Opt_D_dump_minimal_imports

Opt_DoCoreLinting

Opt_DoLinearCoreLinting

Opt_DoStgLinting

Opt_DoCmmLinting

Opt_DoAsmLinting

Opt_DoAnnotationLinting

Opt_NoLlvmMangler

Opt_FastLlvm

Opt_NoTypeableBinds

Opt_WarnIsError

Opt_ShowWarnGroups

Opt_HideSourcePaths

Opt_PrintExplicitForalls

Opt_PrintExplicitKinds

Opt_PrintExplicitCoercions

Opt_PrintExplicitRuntimeReps

Opt_PrintEqualityRelations

Opt_PrintAxiomIncomps

Opt_PrintUnicodeSyntax

Opt_PrintExpandedSynonyms

Opt_PrintPotentialInstances

Opt_PrintTypecheckerElaboration

Opt_CallArity

Opt_Exitification

Opt_Strictness

Opt_LateDmdAnal

Opt_KillAbsence

Opt_KillOneShot

Opt_FullLaziness

Opt_FloatIn

Opt_LateSpecialise

Opt_Specialise

Opt_SpecialiseAggressively

Opt_CrossModuleSpecialise

Opt_StaticArgumentTransformation

Opt_CSE

Opt_StgCSE

Opt_StgLiftLams

Opt_LiberateCase

Opt_SpecConstr

Opt_SpecConstrKeen

Opt_DoLambdaEtaExpansion

Opt_IgnoreAsserts

Opt_DoEtaReduction

Opt_CaseMerge

Opt_CaseFolding

Opt_UnboxStrictFields

Opt_UnboxSmallStrictFields

Opt_DictsCheap

Opt_EnableRewriteRules

Opt_EnableThSpliceWarnings

Opt_RegsGraph

Opt_RegsIterative

Opt_PedanticBottoms

Opt_LlvmTBAA

Opt_LlvmFillUndefWithGarbage

Opt_IrrefutableTuples

Opt_CmmSink

Opt_CmmStaticPred

Opt_CmmElimCommonBlocks

Opt_AsmShortcutting

Opt_OmitYields

Opt_FunToThunk

Opt_DictsStrict

Opt_DmdTxDictSel

Opt_Loopification

Opt_CfgBlocklayout

Opt_WeightlessBlocklayout

Opt_CprAnal

Opt_WorkerWrapper

Opt_SolveConstantDicts

Opt_AlignmentSanitisation

Opt_CatchBottoms

Opt_NumConstantFolding

Opt_SimplPreInlining

Opt_IgnoreInterfacePragmas

Opt_OmitInterfacePragmas

Opt_ExposeAllUnfoldings

Opt_WriteInterface

Opt_WriteHie

Opt_AutoSccsOnIndividualCafs

Opt_ProfCountEntries

Opt_Pp

Opt_ForceRecomp

Opt_IgnoreOptimChanges

Opt_IgnoreHpcChanges

Opt_ExcessPrecision

Opt_EagerBlackHoling

Opt_NoHsMain

Opt_SplitSections

Opt_StgStats

Opt_HideAllPackages

Opt_HideAllPluginPackages

Opt_PrintBindResult

Opt_Haddock

Opt_HaddockOptions

Opt_BreakOnException

Opt_BreakOnError

Opt_PrintEvldWithShow

Opt_PrintBindContents

Opt_GenManifest

Opt_EmbedManifest

Opt_SharedImplib

Opt_BuildingCabalPackage

Opt_IgnoreDotGhci

Opt_GhciSandbox

Opt_GhciHistory

Opt_GhciLeakCheck

Opt_ValidateHie

Opt_LocalGhciHistory

Opt_NoIt

Opt_HelpfulErrors

Opt_DeferTypeErrors

Opt_DeferTypedHoles

Opt_DeferOutOfScopeVariables

Opt_PIC

Opt_PIE

Opt_PICExecutable

Opt_ExternalDynamicRefs

Opt_Ticky

Opt_Ticky_Allocd

Opt_Ticky_LNE

Opt_Ticky_Dyn_Thunk

Opt_RPath

Opt_RelativeDynlibPaths

Opt_Hpc

Opt_FlatCache

Opt_ExternalInterpreter

Opt_OptimalApplicativeDo

Opt_VersionMacros

Opt_WholeArchiveHsLibs

Opt_SingleLibFolder

Opt_KeepCAFs

Opt_KeepGoing

Opt_ByteCodeIfUnboxed

Opt_LinkRts

Opt_ErrorSpans

Opt_DeferDiagnostics

Opt_DiagnosticsShowCaret

Opt_PprCaseAsLet

Opt_PprShowTicks

Opt_ShowHoleConstraints

Opt_ShowValidHoleFits

Opt_SortValidHoleFits

Opt_SortBySizeHoleFits

Opt_SortBySubsumHoleFits

Opt_AbstractRefHoleFits

Opt_UnclutterValidHoleFits

Opt_ShowTypeAppOfHoleFits

Opt_ShowTypeAppVarsOfHoleFits

Opt_ShowDocsOfHoleFits

Opt_ShowTypeOfHoleFits

Opt_ShowProvOfHoleFits

Opt_ShowMatchesOfHoleFits

Opt_ShowLoadedModules

Opt_HexWordLiterals

Opt_SuppressCoercions

Opt_SuppressVarKinds

Opt_SuppressModulePrefixes

Opt_SuppressTypeApplications

Opt_SuppressIdInfo

Opt_SuppressUnfoldings

Opt_SuppressTypeSignatures

Opt_SuppressUniques

Opt_SuppressStgExts

Opt_SuppressTicks

Opt_SuppressTimestamps

Opt_AutoLinkPackages

Opt_ImplicitImportQualified

Opt_KeepHscppFiles

Opt_KeepHiDiffs

Opt_KeepHcFiles

Opt_KeepSFiles

Opt_KeepTmpFiles

Opt_KeepRawTokenStream

Opt_KeepLlvmFiles

Opt_KeepHiFiles

Opt_KeepOFiles

Opt_BuildDynamicToo

Opt_DistrustAllPackages

Opt_PackageTrust

Opt_PluginTrustworthy

Opt_G_NoStateHack

Opt_G_NoOptCoercion

Instances

Enum GeneralFlag

Defined in GHC.Driver.Flags

Methods

succ :: GeneralFlag -> GeneralFlag

pred :: GeneralFlag -> GeneralFlag

toEnum :: Int -> GeneralFlag

fromEnum :: GeneralFlag -> Int

enumFrom :: GeneralFlag -> [GeneralFlag]

enumFromThen :: GeneralFlag -> GeneralFlag -> [GeneralFlag]

enumFromTo :: GeneralFlag -> GeneralFlag -> [GeneralFlag]

enumFromThenTo :: GeneralFlag -> GeneralFlag -> GeneralFlag -> [GeneralFlag]

Eq GeneralFlag

Defined in GHC.Driver.Flags

Methods

(==) :: GeneralFlag -> GeneralFlag -> Bool

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

Show GeneralFlag

Defined in GHC.Driver.Flags

Methods

showsPrec :: Int -> GeneralFlag -> ShowS

show :: GeneralFlag -> String

showList :: [GeneralFlag] -> ShowS

data Severity

Constructors

SevOutput

SevFatal

SevInteractive

SevDump

SevInfo

SevWarning

SevError

Instances

Show Severity

Defined in GHC.Utils.Error

Methods

showsPrec :: Int -> Severity -> ShowS

show :: Severity -> String

showList :: [Severity] -> ShowS

ToJson Severity

Defined in GHC.Utils.Error

Methods

json :: Severity -> JsonDoc

data HscTarget

Constructors

HscC

HscAsm

HscLlvm

HscInterpreted

HscNothing

Instances

Eq HscTarget

Defined in GHC.Driver.Session

Methods

(==) :: HscTarget -> HscTarget -> Bool

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

Show HscTarget

Defined in GHC.Driver.Session

Methods

showsPrec :: Int -> HscTarget -> ShowS

show :: HscTarget -> String

showList :: [HscTarget] -> ShowS

gopt :: GeneralFlag -> DynFlags -> Bool

data GhcMode

Constructors

CompManager

OneShot

MkDepend

Instances

Eq GhcMode

Defined in GHC.Driver.Session

Methods

(==) :: GhcMode -> GhcMode -> Bool

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

Outputable GhcMode

Defined in GHC.Driver.Session

Methods

ppr :: GhcMode -> SDoc

pprPrec :: Rational -> GhcMode -> SDoc

data GhcLink

Constructors

NoLink

LinkBinary

LinkInMemory

LinkDynLib

LinkStaticLib

Instances

Eq GhcLink

Defined in GHC.Driver.Session

Methods

(==) :: GhcLink -> GhcLink -> Bool

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

Show GhcLink

Defined in GHC.Driver.Session

Methods

showsPrec :: Int -> GhcLink -> ShowS

show :: GhcLink -> String

showList :: [GhcLink] -> ShowS

defaultObjectTarget :: DynFlags -> HscTarget

parseDynamicFlags :: MonadIO m => DynFlags -> [Located String] -> m (DynFlags, [Located String], [Warn])

getSessionDynFlags :: GhcMonad m => m DynFlags

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

Updates both the interactive and program DynFlags in a Session. This also reads the package database (unless it has already been read), and prepares the compilers knowledge about packages. It can be called again to load new packages: just add new package flags to (packageFlags dflags).

Returns a list of new packages that may need to be linked in using the dynamic linker (see linkPackages) as a result of new package flags. If you are not doing linking or doing static linking, you can ignore the list of packages returned.

getProgramDynFlags :: GhcMonad m => m DynFlags

Returns the program DynFlags.

setProgramDynFlags :: GhcMonad m => DynFlags -> m Bool

Sets the program DynFlags. Note: this invalidates the internal cached module graph, causing more work to be done the next time load is called.

Returns a boolean indicating if preload units have changed and need to be reloaded.

setLogAction :: GhcMonad m => LogAction -> m ()

Set the action taken when the compiler produces a message. This can also be accomplished using setProgramDynFlags, but using setLogAction avoids invalidating the cached module graph.

getInteractiveDynFlags :: GhcMonad m => m DynFlags

Get the DynFlags used to evaluate interactive expressions.

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

Set the DynFlags used to evaluate interactive expressions. Note: this cannot be used for changes to packages. Use setSessionDynFlags, or setProgramDynFlags and then copy the unitState into the interactive DynFlags.

interpretPackageEnv :: DynFlags -> IO DynFlags

Find the package environment (if one exists)

We interpret the package environment as a set of package flags; to be specific, if we find a package environment file like

clear-package-db
global-package-db
package-db blah/package.conf.d
package-id id1
package-id id2

we interpret this as

[ -hide-all-packages
, -clear-package-db
, -global-package-db
, -package-db blah/package.conf.d
, -package-id id1
, -package-id id2
]

There's also an older syntax alias for package-id, which is just an unadorned package id

id1
id2

Targets

data Target

Constructors

Target

Fields

• targetId :: TargetId
• targetAllowObjCode :: Bool
• targetContents :: Maybe (InputFileBuffer, UTCTime)

Instances

Outputable Target

Defined in GHC.Driver.Types

Methods

ppr :: Target -> SDoc

pprPrec :: Rational -> Target -> SDoc

data TargetId

Constructors

TargetModule ModuleName

TargetFile FilePath (Maybe Phase)

Instances

Eq TargetId

Defined in GHC.Driver.Types

Methods

(==) :: TargetId -> TargetId -> Bool

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

Outputable TargetId

Defined in GHC.Driver.Types

Methods

ppr :: TargetId -> SDoc

pprPrec :: Rational -> TargetId -> SDoc

data Phase

Instances

Eq Phase

Defined in GHC.Driver.Phases

Methods

(==) :: Phase -> Phase -> Bool

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

Show Phase

Defined in GHC.Driver.Phases

Methods

showsPrec :: Int -> Phase -> ShowS

show :: Phase -> String

showList :: [Phase] -> ShowS

Outputable Phase

Defined in GHC.Driver.Phases

Methods

ppr :: Phase -> SDoc

pprPrec :: Rational -> Phase -> SDoc

setTargets :: GhcMonad m => [Target] -> m ()

Sets the targets for this session. Each target may be a module name or a filename. The targets correspond to the set of root modules for the program/library. Unloading the current program is achieved by setting the current set of targets to be empty, followed by load.

getTargets :: GhcMonad m => m [Target]

Returns the current set of targets

addTarget :: GhcMonad m => Target -> m ()

Add another target.

removeTarget :: GhcMonad m => TargetId -> m ()

Remove a target

guessTarget :: GhcMonad m => String -> Maybe Phase -> m Target

Attempts to guess what Target a string refers to. This function implements the --make/GHCi command-line syntax for filenames:

• if the string looks like a Haskell source filename, then interpret it as such
• if adding a .hs or .lhs suffix yields the name of an existing file, then use that
• otherwise interpret the string as a module name

Loading/compiling the program

depanal

Arguments

:: GhcMonad m

=> [ModuleName]

excluded modules

-> Bool

allow duplicate roots

-> m ModuleGraph

Perform a dependency analysis starting from the current targets and update the session with the new module graph.

Dependency analysis entails parsing the import directives and may therefore require running certain preprocessors.

Note that each ModSummary in the module graph caches its DynFlags. These DynFlags are determined by the current session DynFlags and the OPTIONS and LANGUAGE pragmas of the parsed module. Thus if you want changes to the DynFlags to take effect you need to call this function again. In case of errors, just throw them.

depanalE

Arguments

:: GhcMonad m

=> [ModuleName]

excluded modules

-> Bool

allow duplicate roots

-> m (ErrorMessages, ModuleGraph)

Perform dependency analysis like in depanal. In case of errors, the errors and an empty module graph are returned.

load :: GhcMonad m => LoadHowMuch -> m SuccessFlag

Try to load the program. See LoadHowMuch for the different modes.

This function implements the core of GHC's --make mode. It preprocesses, compiles and loads the specified modules, avoiding re-compilation wherever possible. Depending on the target (see hscTarget) compiling and loading may result in files being created on disk.

Calls the defaultWarnErrLogger after each compiling each module, whether successful or not.

If errors are encountered during dependency analysis, the module depanalE returns together with the errors an empty ModuleGraph. After processing this empty ModuleGraph, the errors of depanalE are thrown. All other errors are reported using the defaultWarnErrLogger.

data LoadHowMuch

Describes which modules of the module graph need to be loaded.

Constructors

LoadAllTargets

Load all targets and its dependencies.

LoadUpTo ModuleName

Load only the given module and its dependencies.

LoadDependenciesOf ModuleName

Load only the dependencies of the given module, but not the module itself.

data InteractiveImport

Constructors

IIDecl (ImportDecl GhcPs)

IIModule ModuleName

Instances

Outputable InteractiveImport

Defined in GHC.Driver.Types

Methods

ppr :: InteractiveImport -> SDoc

pprPrec :: Rational -> InteractiveImport -> SDoc

data SuccessFlag

Constructors

Succeeded

Failed

Instances

Outputable SuccessFlag

Defined in GHC.Types.Basic

Methods

ppr :: SuccessFlag -> SDoc

pprPrec :: Rational -> SuccessFlag -> SDoc

succeeded :: SuccessFlag -> Bool

failed :: SuccessFlag -> Bool

defaultWarnErrLogger :: WarnErrLogger

type WarnErrLogger = forall (m :: Type -> Type). GhcMonad m => Maybe SourceError -> m ()

workingDirectoryChanged :: GhcMonad m => m ()

Inform GHC that the working directory has changed. GHC will flush its cache of module locations, since it may no longer be valid.

Note: Before changing the working directory make sure all threads running in the same session have stopped. If you change the working directory, you should also unload the current program (set targets to empty, followed by load).

parseModule :: GhcMonad m => ModSummary -> m ParsedModule

Parse a module.

Throws a SourceError on parse error.

typecheckModule :: GhcMonad m => ParsedModule -> m TypecheckedModule

Typecheck and rename a parsed module.

Throws a SourceError if either fails.

desugarModule :: GhcMonad m => TypecheckedModule -> m DesugaredModule

Desugar a typechecked module.

loadModule :: (TypecheckedMod mod, GhcMonad m) => mod -> m mod

Load a module. Input doesn't need to be desugared.

A module must be loaded before dependent modules can be typechecked. This always includes generating a ModIface and, depending on the DynFlags's hscTarget, may also include code generation.

This function will always cause recompilation and will always overwrite previous compilation results (potentially files on disk).

data ParsedModule

The result of successful parsing.

Constructors

ParsedModule

Fields

• pm_mod_summary :: ModSummary
• pm_parsed_source :: ParsedSource
• pm_extra_src_files :: [FilePath]
• pm_annotations :: ApiAnns

Instances

ParsedMod ParsedModule

Defined in GHC

Methods

modSummary :: ParsedModule -> ModSummary

parsedSource :: ParsedModule -> ParsedSource

data TypecheckedModule

The result of successful typechecking. It also contains the parser result.

Constructors

TypecheckedModule

Fields

• tm_parsed_module :: ParsedModule
• tm_renamed_source :: Maybe RenamedSource
• tm_typechecked_source :: TypecheckedSource
• tm_checked_module_info :: ModuleInfo
• tm_internals_ :: (TcGblEnv, ModDetails)

Instances

TypecheckedMod TypecheckedModule

Defined in GHC

Methods

renamedSource :: TypecheckedModule -> Maybe RenamedSource

typecheckedSource :: TypecheckedModule -> TypecheckedSource

moduleInfo :: TypecheckedModule -> ModuleInfo

tm_internals :: TypecheckedModule -> (TcGblEnv, ModDetails)

ParsedMod TypecheckedModule

Defined in GHC

Methods

modSummary :: TypecheckedModule -> ModSummary

parsedSource :: TypecheckedModule -> ParsedSource

data DesugaredModule

The result of successful desugaring (i.e., translation to core). Also contains all the information of a typechecked module.

Constructors

DesugaredModule

Fields

• dm_typechecked_module :: TypecheckedModule
• dm_core_module :: ModGuts

Instances

TypecheckedMod DesugaredModule

Defined in GHC

Methods

renamedSource :: DesugaredModule -> Maybe RenamedSource

typecheckedSource :: DesugaredModule -> TypecheckedSource

moduleInfo :: DesugaredModule -> ModuleInfo

tm_internals :: DesugaredModule -> (TcGblEnv, ModDetails)

ParsedMod DesugaredModule

Defined in GHC

Methods

modSummary :: DesugaredModule -> ModSummary

parsedSource :: DesugaredModule -> ParsedSource

type TypecheckedSource = LHsBinds GhcTc

type ParsedSource = Located HsModule

type RenamedSource = (HsGroup GhcRn, [LImportDecl GhcRn], Maybe [(LIE GhcRn, Avails)], Maybe LHsDocString)

class ParsedMod m => TypecheckedMod m

Minimal complete definition

renamedSource, typecheckedSource, moduleInfo, tm_internals

Instances

TypecheckedMod DesugaredModule

Defined in GHC

Methods

renamedSource :: DesugaredModule -> Maybe RenamedSource

typecheckedSource :: DesugaredModule -> TypecheckedSource

moduleInfo :: DesugaredModule -> ModuleInfo

tm_internals :: DesugaredModule -> (TcGblEnv, ModDetails)

TypecheckedMod TypecheckedModule

Defined in GHC

Methods

renamedSource :: TypecheckedModule -> Maybe RenamedSource

typecheckedSource :: TypecheckedModule -> TypecheckedSource

moduleInfo :: TypecheckedModule -> ModuleInfo

tm_internals :: TypecheckedModule -> (TcGblEnv, ModDetails)

class ParsedMod m

Minimal complete definition

modSummary, parsedSource

Instances

ParsedMod DesugaredModule

Defined in GHC

Methods

modSummary :: DesugaredModule -> ModSummary

parsedSource :: DesugaredModule -> ParsedSource

ParsedMod TypecheckedModule

Defined in GHC

Methods

modSummary :: TypecheckedModule -> ModSummary

parsedSource :: TypecheckedModule -> ParsedSource

ParsedMod ParsedModule

Defined in GHC

Methods

modSummary :: ParsedModule -> ModSummary

parsedSource :: ParsedModule -> ParsedSource

moduleInfo :: TypecheckedMod m => m -> ModuleInfo

renamedSource :: TypecheckedMod m => m -> Maybe RenamedSource

typecheckedSource :: TypecheckedMod m => m -> TypecheckedSource

parsedSource :: ParsedMod m => m -> ParsedSource

coreModule :: DesugaredMod m => m -> ModGuts

Compiling to Core

data CoreModule

A CoreModule consists of just the fields of a ModGuts that are needed for the compileToCoreModule interface.

Constructors

CoreModule

Fields

• cm_module :: !Module

  Module name

• cm_types :: !TypeEnv

  Type environment for types declared in this module

• cm_binds :: CoreProgram

  Declarations

• cm_safe :: SafeHaskellMode

  Safe Haskell mode

Instances

Outputable CoreModule

Defined in GHC

Methods

ppr :: CoreModule -> SDoc

pprPrec :: Rational -> CoreModule -> SDoc

compileToCoreModule :: GhcMonad m => FilePath -> m CoreModule

This is the way to get access to the Core bindings corresponding to a module. compileToCore parses, typechecks, and desugars the module, then returns the resulting Core module (consisting of the module name, type declarations, and function declarations) if successful.

compileToCoreSimplified :: GhcMonad m => FilePath -> m CoreModule

Like compileToCoreModule, but invokes the simplifier, so as to return simplified and tidied Core.

Inspecting the module structure of the program

data ModuleGraph

emptyMG :: ModuleGraph

mapMG :: (ModSummary -> ModSummary) -> ModuleGraph -> ModuleGraph

mkModuleGraph :: [ModSummary] -> ModuleGraph

mgModSummaries :: ModuleGraph -> [ModSummary]

mgLookupModule :: ModuleGraph -> Module -> Maybe ModSummary

data ModSummary

Constructors

ModSummary

Fields

• ms_mod :: Module
• ms_hsc_src :: HscSource
• ms_location :: ModLocation
• ms_hs_date :: UTCTime
• ms_obj_date :: Maybe UTCTime
• ms_iface_date :: Maybe UTCTime
• ms_hie_date :: Maybe UTCTime
• ms_srcimps :: [(Maybe FastString, Located ModuleName)]
• ms_textual_imps :: [(Maybe FastString, Located ModuleName)]
• ms_parsed_mod :: Maybe HsParsedModule
• ms_hspp_file :: FilePath
• ms_hspp_opts :: DynFlags
• ms_hspp_buf :: Maybe StringBuffer

Instances

Outputable ModSummary

Defined in GHC.Driver.Types

Methods

ppr :: ModSummary -> SDoc

pprPrec :: Rational -> ModSummary -> SDoc

ms_mod_name :: ModSummary -> ModuleName

data ModLocation

Constructors

ModLocation

Fields

• ml_hs_file :: Maybe FilePath
• ml_hi_file :: FilePath
• ml_obj_file :: FilePath
• ml_hie_file :: FilePath

Instances

Show ModLocation

Defined in GHC.Unit.Module.Location

Methods

showsPrec :: Int -> ModLocation -> ShowS

show :: ModLocation -> String

showList :: [ModLocation] -> ShowS

Outputable ModLocation

Defined in GHC.Unit.Module.Location

Methods

ppr :: ModLocation -> SDoc

pprPrec :: Rational -> ModLocation -> SDoc

getModSummary :: GhcMonad m => ModuleName -> m ModSummary

Return the ModSummary of a module with the given name.

The module must be part of the module graph (see hsc_mod_graph and ModuleGraph). If this is not the case, this function will throw a GhcApiError.

This function ignores boot modules and requires that there is only one non-boot module with the given name.

getModuleGraph :: GhcMonad m => m ModuleGraph

Get the module dependency graph.

isLoaded :: GhcMonad m => ModuleName -> m Bool

Return True <==> module is loaded.

topSortModuleGraph

Arguments

:: Bool

Drop hi-boot nodes? (see below)

-> ModuleGraph

-> Maybe ModuleName

Root module name. If Nothing, use the full graph.

-> [SCC ModSummary]

Topological sort of the module graph

Calculate SCCs of the module graph, possibly dropping the hi-boot nodes The resulting list of strongly-connected-components is in topologically sorted order, starting with the module(s) at the bottom of the dependency graph (ie compile them first) and ending with the ones at the top.

Drop hi-boot nodes (first boolean arg)?

• False: treat the hi-boot summaries as nodes of the graph, so the graph must be acyclic
• True: eliminate the hi-boot nodes, and instead pretend the a source-import of Foo is an import of Foo The resulting graph has no hi-boot nodes, but can be cyclic

Inspecting modules

data ModuleInfo

Container for information about a Module.

getModuleInfo :: GhcMonad m => Module -> m (Maybe ModuleInfo)

Request information about a loaded Module

modInfoTyThings :: ModuleInfo -> [TyThing]

The list of top-level entities defined in a module

modInfoTopLevelScope :: ModuleInfo -> Maybe [Name]

modInfoExports :: ModuleInfo -> [Name]

modInfoExportsWithSelectors :: ModuleInfo -> [Name]

modInfoInstances :: ModuleInfo -> [ClsInst]

Returns the instances defined by the specified module. Warning: currently unimplemented for package modules.

modInfoIsExportedName :: ModuleInfo -> Name -> Bool

modInfoLookupName :: GhcMonad m => ModuleInfo -> Name -> m (Maybe TyThing)

modInfoIface :: ModuleInfo -> Maybe ModIface

modInfoRdrEnv :: ModuleInfo -> Maybe GlobalRdrEnv

modInfoSafe :: ModuleInfo -> SafeHaskellMode

Retrieve module safe haskell mode

lookupGlobalName :: GhcMonad m => Name -> m (Maybe TyThing)

Looks up a global name: that is, any top-level name in any visible module. Unlike lookupName, lookupGlobalName does not use the interactive context, and therefore does not require a preceding setContext.

findGlobalAnns :: (GhcMonad m, Typeable a) => ([Word8] -> a) -> AnnTarget Name -> m [a]

mkPrintUnqualifiedForModule :: GhcMonad m => ModuleInfo -> m (Maybe PrintUnqualified)

type ModIface = ModIface_ 'ModIfaceFinal

data ModIface_ (phase :: ModIfacePhase)

Constructors

ModIface

Fields

• mi_module :: !Module
• mi_sig_of :: !(Maybe Module)
• mi_hsc_src :: !HscSource
• mi_deps :: Dependencies
• mi_usages :: [Usage]
• mi_exports :: ![IfaceExport]
• mi_used_th :: !Bool
• mi_fixities :: [(OccName, Fixity)]
• mi_warns :: Warnings
• mi_anns :: [IfaceAnnotation]
• mi_decls :: [IfaceDeclExts phase]
• mi_globals :: !(Maybe GlobalRdrEnv)
• mi_insts :: [IfaceClsInst]
• mi_fam_insts :: [IfaceFamInst]
• mi_rules :: [IfaceRule]
• mi_hpc :: !AnyHpcUsage
• mi_trust :: !IfaceTrustInfo
• mi_trust_pkg :: !Bool
• mi_complete_sigs :: [IfaceCompleteMatch]
• mi_doc_hdr :: Maybe HsDocString
• mi_decl_docs :: DeclDocMap
• mi_arg_docs :: ArgDocMap
• mi_final_exts :: !(IfaceBackendExts phase)
• mi_ext_fields :: ExtensibleFields

Instances

Binary ModIface

Defined in GHC.Driver.Types

Methods

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

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

get :: BinHandle -> IO ModIface

(NFData (IfaceBackendExts phase), NFData (IfaceDeclExts phase)) => NFData (ModIface_ phase)

Defined in GHC.Driver.Types

Methods

rnf :: ModIface_ phase -> ()

data SafeHaskellMode

Constructors

Sf_None

Sf_Unsafe

Sf_Trustworthy

Sf_Safe

Sf_SafeInferred

Sf_Ignore

Instances

Eq SafeHaskellMode

Defined in GHC.Driver.Session

Methods

(==) :: SafeHaskellMode -> SafeHaskellMode -> Bool

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

Show SafeHaskellMode

Defined in GHC.Driver.Session

Methods

showsPrec :: Int -> SafeHaskellMode -> ShowS

show :: SafeHaskellMode -> String

showList :: [SafeHaskellMode] -> ShowS

Outputable SafeHaskellMode

Defined in GHC.Driver.Session

Methods

ppr :: SafeHaskellMode -> SDoc

pprPrec :: Rational -> SafeHaskellMode -> SDoc

Querying the environment

Printing

data PrintUnqualified

alwaysQualify :: PrintUnqualified

Interactive evaluation

Executing statements

execStmt

Arguments

:: GhcMonad m

=> String

a statement (bind or expression)

-> ExecOptions

-> m ExecResult

Run a statement in the current interactive context.

execStmt' :: GhcMonad m => GhciLStmt GhcPs -> String -> ExecOptions -> m ExecResult

Like execStmt, but takes a parsed statement as argument. Useful when doing preprocessing on the AST before execution, e.g. in GHCi (see GHCi.UI.runStmt).

data ExecOptions

Constructors

ExecOptions

Fields

• execSingleStep :: SingleStep
• execSourceFile :: String
• execLineNumber :: Int
• execWrap :: ForeignHValue -> EvalExpr ForeignHValue

execOptions :: ExecOptions

default ExecOptions

data ExecResult

Constructors

ExecComplete

Fields

• execResult :: Either SomeException [Name]
• execAllocation :: Word64

ExecBreak

Fields

• breakNames :: [Name]
• breakInfo :: Maybe BreakInfo

resumeExec :: GhcMonad m => (SrcSpan -> Bool) -> SingleStep -> m ExecResult

Adding new declarations

runDecls :: GhcMonad m => String -> m [Name]

runDeclsWithLocation :: GhcMonad m => String -> Int -> String -> m [Name]

Run some declarations and return any user-visible names that were brought into scope.

runParsedDecls :: GhcMonad m => [LHsDecl GhcPs] -> m [Name]

Like runDeclsWithLocation, but takes parsed declarations as argument. Useful when doing preprocessing on the AST before execution, e.g. in GHCi (see GHCi.UI.runStmt).

Get/set the current context

parseImportDecl :: GhcMonad m => String -> m (ImportDecl GhcPs)

setContext :: GhcMonad m => [InteractiveImport] -> m ()

Set the interactive evaluation context.

(setContext imports) sets the ic_imports field (which in turn determines what is in scope at the prompt) to imports, and constructs the ic_rn_glb_env environment to reflect it.

We retain in scope all the things defined at the prompt, and kept in ic_tythings. (Indeed, they shadow stuff from ic_imports.)

getContext :: GhcMonad m => m [InteractiveImport]

Get the interactive evaluation context, consisting of a pair of the set of modules from which we take the full top-level scope, and the set of modules from which we take just the exports respectively.

setGHCiMonad :: GhcMonad m => String -> m ()

Set the monad GHCi lifts user statements into.

Checks that a type (in string form) is an instance of the GHC.GHCi.GHCiSandboxIO type class. Sets it to be the GHCi monad if it is, throws an error otherwise.

getGHCiMonad :: GhcMonad m => m Name

Get the monad GHCi lifts user statements into.

Inspecting the current context

getBindings :: GhcMonad m => m [TyThing]

Return the bindings for the current interactive session.

getInsts :: GhcMonad m => m ([ClsInst], [FamInst])

Return the instances for the current interactive session.

getPrintUnqual :: GhcMonad m => m PrintUnqualified

findModule :: GhcMonad m => ModuleName -> Maybe FastString -> m Module

Takes a ModuleName and possibly a UnitId, and consults the filesystem and package database to find the corresponding Module, using the algorithm that is used for an import declaration.

lookupModule :: GhcMonad m => ModuleName -> Maybe FastString -> m Module

Like findModule, but differs slightly when the module refers to a source file, and the file has not been loaded via load. In this case, findModule will throw an error (module not loaded), but lookupModule will check to see whether the module can also be found in a package, and if so, that package Module will be returned. If not, the usual module-not-found error will be thrown.

isModuleTrusted :: GhcMonad m => Module -> m Bool

Check that a module is safe to import (according to Safe Haskell).

We return True to indicate the import is safe and False otherwise although in the False case an error may be thrown first.

moduleTrustReqs :: GhcMonad m => Module -> m (Bool, Set UnitId)

Return if a module is trusted and the pkgs it depends on to be trusted.

getNamesInScope :: GhcMonad m => m [Name]

Returns all names in scope in the current interactive context

getRdrNamesInScope :: GhcMonad m => m [RdrName]

Returns all RdrNames in scope in the current interactive context, excluding any that are internally-generated.

getGRE :: GhcMonad m => m GlobalRdrEnv

get the GlobalRdrEnv for a session

moduleIsInterpreted :: GhcMonad m => Module -> m Bool

Returns True if the specified module is interpreted, and hence has its full top-level scope available.

getInfo :: GhcMonad m => Bool -> Name -> m (Maybe (TyThing, Fixity, [ClsInst], [FamInst], SDoc))

Looks up an identifier in the current interactive context (for :info) Filter the instances by the ones whose tycons (or clases resp) are in scope (qualified or otherwise). Otherwise we list a whole lot too many! The exact choice of which ones to show, and which to hide, is a judgement call. (see #1581)

showModule :: GhcMonad m => ModSummary -> m String

moduleIsBootOrNotObjectLinkable :: GhcMonad m => ModSummary -> m Bool

getNameToInstancesIndex

Arguments

:: GhcMonad m

=> [Module]

visible modules. An orphan instance will be returned if it is visible from at least one module in the list.

-> Maybe [Module]

modules to load. If this is not specified, we load modules for everything that is in scope unqualified.

-> m (Messages, Maybe (NameEnv ([ClsInst], [FamInst])))

Retrieve all type and family instances in the environment, indexed by Name. Each name's lists will contain every instance in which that name is mentioned in the instance head.

Inspecting types and kinds

exprType :: GhcMonad m => TcRnExprMode -> String -> m Type

Get the type of an expression Returns the type as described by TcRnExprMode

data TcRnExprMode

How should we infer a type? See Note [TcRnExprMode]

Constructors

TM_Inst

Instantiate the type fully (:type)

TM_NoInst

Do not instantiate the type (:type +v)

TM_Default

Default the type eagerly (:type +d)

typeKind :: GhcMonad m => Bool -> String -> m (Type, Kind)

Get the kind of a type

Looking up a Name

parseName :: GhcMonad m => String -> m [Name]

Parses a string as an identifier, and returns the list of Names that the identifier can refer to in the current interactive context.

lookupName :: GhcMonad m => Name -> m (Maybe TyThing)

Returns the TyThing for a Name. The Name may refer to any entity known to GHC, including Names defined using runStmt.

Compiling expressions

data HValue

Instances

Show HValue

Defined in GHCi.RemoteTypes

Methods

showsPrec :: Int -> HValue -> ShowS

show :: HValue -> String

showList :: [HValue] -> ShowS

parseExpr :: GhcMonad m => String -> m (LHsExpr GhcPs)

Parse an expression, the parsed expression can be further processed and passed to compileParsedExpr.

compileParsedExpr :: GhcMonad m => LHsExpr GhcPs -> m HValue

compileExpr :: GhcMonad m => String -> m HValue

Compile an expression, run it, and deliver the resulting HValue.

dynCompileExpr :: GhcMonad m => String -> m Dynamic

Compile an expression, run it and return the result as a Dynamic.

type ForeignHValue = ForeignRef HValue

compileExprRemote :: GhcMonad m => String -> m ForeignHValue

Compile an expression, run it, and deliver the resulting HValue.

compileParsedExprRemote :: GhcMonad m => LHsExpr GhcPs -> m ForeignHValue

Compile a parsed expression (before renaming), run it, and deliver the resulting HValue.

Docs

getDocs :: GhcMonad m => Name -> m (Either GetDocsFailure (Maybe HsDocString, Map Int HsDocString))

data GetDocsFailure

Failure modes for getDocs.

Constructors

NameHasNoModule Name

nameModule_maybe returned Nothing.

NoDocsInIface Module Bool

True: The module was compiled. False: The module was :loaded.

InteractiveName

The Name was defined interactively.

Instances

Outputable GetDocsFailure

Defined in GHC.Runtime.Eval

Methods

ppr :: GetDocsFailure -> SDoc

pprPrec :: Rational -> GetDocsFailure -> SDoc

Other

runTcInteractive :: HscEnv -> TcRn a -> IO (Messages, Maybe a)

isStmt :: ParserFlags -> String -> Bool

Returns True if passed string is a statement.

hasImport :: ParserFlags -> String -> Bool

Returns True if passed string has an import declaration.

isImport :: ParserFlags -> String -> Bool

Returns True if passed string is an import declaration.

isDecl :: ParserFlags -> String -> Bool

Returns True if passed string is a declaration but not a splice.

The debugger

data SingleStep

Constructors

RunToCompletion

SingleStep

RunAndLogSteps

data Resume

Constructors

Resume

Fields

• resumeStmt :: String
• resumeContext :: ForeignRef (ResumeContext [HValueRef])
• resumeBindings :: ([TyThing], GlobalRdrEnv)
• resumeFinalIds :: [Id]
• resumeApStack :: ForeignHValue
• resumeBreakInfo :: Maybe BreakInfo
• resumeSpan :: SrcSpan
• resumeDecl :: String
• resumeCCS :: RemotePtr CostCentreStack
• resumeHistory :: [History]
• resumeHistoryIx :: Int

data History

getHistorySpan :: GhcMonad m => History -> m SrcSpan

getHistoryModule :: History -> Module

abandon :: GhcMonad m => m Bool

abandonAll :: GhcMonad m => m Bool

getResumeContext :: GhcMonad m => m [Resume]

obtainTermFromId :: GhcMonad m => Int -> Bool -> Id -> m Term

obtainTermFromVal :: GhcMonad m => Int -> Bool -> Type -> a -> m Term

reconstructType :: HscEnv -> Int -> Id -> IO (Maybe Type)

modInfoModBreaks :: ModuleInfo -> ModBreaks

data ModBreaks

Constructors

ModBreaks

Fields

• modBreaks_flags :: ForeignRef BreakArray
• modBreaks_locs :: !(Array BreakIndex SrcSpan)
• modBreaks_vars :: !(Array BreakIndex [OccName])
• modBreaks_decls :: !(Array BreakIndex [String])
• modBreaks_ccs :: !(Array BreakIndex (RemotePtr CostCentre))
• modBreaks_breakInfo :: IntMap CgBreakInfo

type BreakIndex = Int

data BreakInfo

back :: GhcMonad m => Int -> m ([Name], Int, SrcSpan, String)

forward :: GhcMonad m => Int -> m ([Name], Int, SrcSpan, String)

Abstract syntax elements

Units

type Unit = GenUnit UnitId

Modules

type Module = GenModule Unit

mkModule :: u -> ModuleName -> GenModule u

pprModule :: Module -> SDoc

moduleName :: GenModule unit -> ModuleName

moduleUnit :: GenModule unit -> unit

data ModuleName

Instances

Eq ModuleName

Defined in GHC.Unit.Module.Name

Methods

(==) :: ModuleName -> ModuleName -> Bool

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

Data ModuleName

Defined in GHC.Unit.Module.Name

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModuleName -> c ModuleName

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModuleName

toConstr :: ModuleName -> Constr

dataTypeOf :: ModuleName -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ModuleName)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModuleName)

gmapT :: (forall b. Data b => b -> b) -> ModuleName -> ModuleName

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModuleName -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModuleName -> r

gmapQ :: (forall d. Data d => d -> u) -> ModuleName -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ModuleName -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModuleName -> m ModuleName

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModuleName -> m ModuleName

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModuleName -> m ModuleName

Ord ModuleName

Defined in GHC.Unit.Module.Name

Methods

compare :: ModuleName -> ModuleName -> Ordering

(<) :: ModuleName -> ModuleName -> Bool

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

(>) :: ModuleName -> ModuleName -> Bool

(>=) :: ModuleName -> ModuleName -> Bool

max :: ModuleName -> ModuleName -> ModuleName

min :: ModuleName -> ModuleName -> ModuleName

NFData ModuleName

Defined in GHC.Unit.Module.Name

Methods

rnf :: ModuleName -> ()

Uniquable ModuleName

Defined in GHC.Unit.Module.Name

Methods

getUnique :: ModuleName -> Unique

Binary ModuleName

Defined in GHC.Unit.Module.Name

Methods

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

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

get :: BinHandle -> IO ModuleName

Outputable ModuleName

Defined in GHC.Unit.Module.Name

Methods

ppr :: ModuleName -> SDoc

pprPrec :: Rational -> ModuleName -> SDoc

mkModuleName :: String -> ModuleName

moduleNameString :: ModuleName -> String

Names

data Name

Instances

Eq Name

Defined in GHC.Types.Name

Methods

(==) :: Name -> Name -> Bool

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

Data Name

Defined in GHC.Types.Name

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Name -> c Name

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Name

toConstr :: Name -> Constr

dataTypeOf :: Name -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Name)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Name)

gmapT :: (forall b. Data b => b -> b) -> Name -> Name

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Name -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Name -> r

gmapQ :: (forall d. Data d => d -> u) -> Name -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Name -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Name -> m Name

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Name -> m Name

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Name -> m Name

Ord Name

Defined in GHC.Types.Name

Methods

compare :: Name -> Name -> Ordering

(<) :: Name -> Name -> Bool

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

(>) :: Name -> Name -> Bool

(>=) :: Name -> Name -> Bool

max :: Name -> Name -> Name

min :: Name -> Name -> Name

NFData Name

Defined in GHC.Types.Name

Methods

rnf :: Name -> ()

Uniquable Name

Defined in GHC.Types.Name

Methods

getUnique :: Name -> Unique

NamedThing Name

Defined in GHC.Types.Name

Methods

getOccName :: Name -> OccName

getName :: Name -> Name

HasOccName Name

Defined in GHC.Types.Name

Methods

occName :: Name -> OccName

Binary Name

Defined in GHC.Types.Name

Methods

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

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

get :: BinHandle -> IO Name

OutputableBndr Name

Defined in GHC.Types.Name

Methods

pprBndr :: BindingSite -> Name -> SDoc

pprPrefixOcc :: Name -> SDoc

pprInfixOcc :: Name -> SDoc

bndrIsJoin_maybe :: Name -> Maybe Int

Outputable Name

Defined in GHC.Types.Name

Methods

ppr :: Name -> SDoc

pprPrec :: Rational -> Name -> SDoc

isExternalName :: Name -> Bool

nameModule :: HasDebugCallStack => Name -> Module

pprParenSymName :: NamedThing a => a -> SDoc

print a NamedThing, adding parentheses if the name is an operator.

nameSrcSpan :: Name -> SrcSpan

class NamedThing a where

Minimal complete definition

getName

Methods

getOccName :: a -> OccName

getName :: a -> Name

Instances

NamedThing Name

Defined in GHC.Types.Name

Methods

getOccName :: Name -> OccName

getName :: Name -> Name

NamedThing TyThing

Defined in GHC.Core.TyCo.Rep

Methods

getOccName :: TyThing -> OccName

getName :: TyThing -> Name

NamedThing Var

Defined in GHC.Types.Var

Methods

getOccName :: Var -> OccName

getName :: Var -> Name

NamedThing TyCon

Defined in GHC.Core.TyCon

Methods

getOccName :: TyCon -> OccName

getName :: TyCon -> Name

NamedThing Class

Defined in GHC.Core.Class

Methods

getOccName :: Class -> OccName

getName :: Class -> Name

NamedThing DataCon

Defined in GHC.Core.DataCon

Methods

getOccName :: DataCon -> OccName

getName :: DataCon -> Name

NamedThing ConLike

Defined in GHC.Core.ConLike

Methods

getOccName :: ConLike -> OccName

getName :: ConLike -> Name

NamedThing PatSyn

Defined in GHC.Core.PatSyn

Methods

getOccName :: PatSyn -> OccName

getName :: PatSyn -> Name

NamedThing IfaceDecl

Defined in GHC.Iface.Syntax

Methods

getOccName :: IfaceDecl -> OccName

getName :: IfaceDecl -> Name

NamedThing ClsInst

Defined in GHC.Core.InstEnv

Methods

getOccName :: ClsInst -> OccName

getName :: ClsInst -> Name

NamedThing FamInst

Defined in GHC.Core.FamInstEnv

Methods

getOccName :: FamInst -> OccName

getName :: FamInst -> Name

NamedThing HoleFitCandidate

Defined in GHC.Tc.Errors.Hole.FitTypes

Methods

getOccName :: HoleFitCandidate -> OccName

getName :: HoleFitCandidate -> Name

NamedThing IfaceClassOp

Defined in GHC.Iface.Syntax

Methods

getOccName :: IfaceClassOp -> OccName

getName :: IfaceClassOp -> Name

NamedThing IfaceConDecl

Defined in GHC.Iface.Syntax

Methods

getOccName :: IfaceConDecl -> OccName

getName :: IfaceConDecl -> Name

NamedThing e => NamedThing (Located e)

Defined in GHC.Types.Name

Methods

getOccName :: Located e -> OccName

getName :: Located e -> Name

NamedThing (CoAxiom br)

Defined in GHC.Core.Coercion.Axiom

Methods

getOccName :: CoAxiom br -> OccName

getName :: CoAxiom br -> Name

NamedThing tv => NamedThing (VarBndr tv flag)

Defined in GHC.Types.Var

Methods

getOccName :: VarBndr tv flag -> OccName

getName :: VarBndr tv flag -> Name

NamedThing (HsTyVarBndr flag GhcRn)

Defined in GHC.Hs.Type

Methods

getOccName :: HsTyVarBndr flag GhcRn -> OccName

getName :: HsTyVarBndr flag GhcRn -> Name

data RdrName

Constructors

Unqual OccName

Qual ModuleName OccName

Instances

Eq RdrName

Defined in GHC.Types.Name.Reader

Methods

(==) :: RdrName -> RdrName -> Bool

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

Data RdrName

Defined in GHC.Types.Name.Reader

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RdrName -> c RdrName

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RdrName

toConstr :: RdrName -> Constr

dataTypeOf :: RdrName -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RdrName)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RdrName)

gmapT :: (forall b. Data b => b -> b) -> RdrName -> RdrName

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RdrName -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RdrName -> r

gmapQ :: (forall d. Data d => d -> u) -> RdrName -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RdrName -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RdrName -> m RdrName

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RdrName -> m RdrName

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RdrName -> m RdrName

Ord RdrName

Defined in GHC.Types.Name.Reader

Methods

compare :: RdrName -> RdrName -> Ordering

(<) :: RdrName -> RdrName -> Bool

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

(>) :: RdrName -> RdrName -> Bool

(>=) :: RdrName -> RdrName -> Bool

max :: RdrName -> RdrName -> RdrName

min :: RdrName -> RdrName -> RdrName

HasOccName RdrName

Defined in GHC.Types.Name.Reader

Methods

occName :: RdrName -> OccName

OutputableBndr RdrName

Defined in GHC.Types.Name.Reader

Methods

pprBndr :: BindingSite -> RdrName -> SDoc

pprPrefixOcc :: RdrName -> SDoc

pprInfixOcc :: RdrName -> SDoc

bndrIsJoin_maybe :: RdrName -> Maybe Int

Outputable RdrName

Defined in GHC.Types.Name.Reader

Methods

ppr :: RdrName -> SDoc

pprPrec :: Rational -> RdrName -> SDoc

DisambInfixOp RdrName

Defined in GHC.Parser.PostProcess

Methods

mkHsVarOpPV :: Located RdrName -> PV (Located RdrName)

mkHsConOpPV :: Located RdrName -> PV (Located RdrName)

mkHsInfixHolePV :: SrcSpan -> PV (Located RdrName)

Identifiers

type Id = Var

idType :: Id -> Kind

isImplicitId :: Id -> Bool

isDeadBinder :: Id -> Bool

isExportedId :: Var -> Bool

isLocalId :: Var -> Bool

isGlobalId :: Var -> Bool

isRecordSelector :: Id -> Bool

isPrimOpId :: Id -> Bool

isFCallId :: Id -> Bool

isClassOpId_maybe :: Id -> Maybe Class

isDataConWorkId :: Id -> Bool

idDataCon :: Id -> DataCon

isDeadEndId :: Var -> Bool

isDictonaryId :: Id -> Bool

recordSelectorTyCon :: Id -> RecSelParent

Type constructors

data TyCon

Instances

Eq TyCon

Defined in GHC.Core.TyCon

Methods

(==) :: TyCon -> TyCon -> Bool

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

Data TyCon

Defined in GHC.Core.TyCon

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TyCon -> c TyCon

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TyCon

toConstr :: TyCon -> Constr

dataTypeOf :: TyCon -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TyCon)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TyCon)

gmapT :: (forall b. Data b => b -> b) -> TyCon -> TyCon

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TyCon -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TyCon -> r

gmapQ :: (forall d. Data d => d -> u) -> TyCon -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> TyCon -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TyCon -> m TyCon

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TyCon -> m TyCon

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TyCon -> m TyCon

Uniquable TyCon

Defined in GHC.Core.TyCon

Methods

getUnique :: TyCon -> Unique

NamedThing TyCon

Defined in GHC.Core.TyCon

Methods

getOccName :: TyCon -> OccName

getName :: TyCon -> Name

Outputable TyCon

Defined in GHC.Core.TyCon

Methods

ppr :: TyCon -> SDoc

pprPrec :: Rational -> TyCon -> SDoc

tyConTyVars :: TyCon -> [TyVar]

tyConDataCons :: TyCon -> [DataCon]

tyConArity :: TyCon -> Arity

isClassTyCon :: TyCon -> Bool

isTypeSynonymTyCon :: TyCon -> Bool

isTypeFamilyTyCon :: TyCon -> Bool

isNewTyCon :: TyCon -> Bool

isPrimTyCon :: TyCon -> Bool

isFunTyCon :: TyCon -> Bool

isFamilyTyCon :: TyCon -> Bool

isOpenFamilyTyCon :: TyCon -> Bool

isOpenTypeFamilyTyCon :: TyCon -> Bool

tyConClass_maybe :: TyCon -> Maybe Class

synTyConRhs_maybe :: TyCon -> Maybe Type

synTyConDefn_maybe :: TyCon -> Maybe ([TyVar], Type)

tyConKind :: TyCon -> Kind

Type variables

type TyVar = Var

alphaTyVars :: [TyVar]

Data constructors

data DataCon

Instances

Eq DataCon

Defined in GHC.Core.DataCon

Methods

(==) :: DataCon -> DataCon -> Bool

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

Data DataCon

Defined in GHC.Core.DataCon

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DataCon -> c DataCon

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DataCon

toConstr :: DataCon -> Constr

dataTypeOf :: DataCon -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DataCon)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DataCon)

gmapT :: (forall b. Data b => b -> b) -> DataCon -> DataCon

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DataCon -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DataCon -> r

gmapQ :: (forall d. Data d => d -> u) -> DataCon -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DataCon -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DataCon -> m DataCon

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DataCon -> m DataCon

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DataCon -> m DataCon

Uniquable DataCon

Defined in GHC.Core.DataCon

Methods

getUnique :: DataCon -> Unique

NamedThing DataCon

Defined in GHC.Core.DataCon

Methods

getOccName :: DataCon -> OccName

getName :: DataCon -> Name

OutputableBndr DataCon

Defined in GHC.Core.DataCon

Methods

pprBndr :: BindingSite -> DataCon -> SDoc

pprPrefixOcc :: DataCon -> SDoc

pprInfixOcc :: DataCon -> SDoc

bndrIsJoin_maybe :: DataCon -> Maybe Int

Outputable DataCon

Defined in GHC.Core.DataCon

Methods

ppr :: DataCon -> SDoc

pprPrec :: Rational -> DataCon -> SDoc

dataConType :: DataCon -> Type

dataConTyCon :: DataCon -> TyCon

dataConFieldLabels :: DataCon -> [FieldLabel]

dataConIsInfix :: DataCon -> Bool

isVanillaDataCon :: DataCon -> Bool

dataConWrapperType :: DataCon -> Type

dataConSrcBangs :: DataCon -> [HsSrcBang]

data StrictnessMark

Constructors

MarkedStrict

NotMarkedStrict

Instances

Outputable StrictnessMark

Defined in GHC.Core.DataCon

Methods

ppr :: StrictnessMark -> SDoc

pprPrec :: Rational -> StrictnessMark -> SDoc

isMarkedStrict :: StrictnessMark -> Bool

Classes

data Class

Instances

Eq Class

Defined in GHC.Core.Class

Methods

(==) :: Class -> Class -> Bool

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

Data Class

Defined in GHC.Core.Class

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Class -> c Class

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Class

toConstr :: Class -> Constr

dataTypeOf :: Class -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Class)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Class)

gmapT :: (forall b. Data b => b -> b) -> Class -> Class

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Class -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Class -> r

gmapQ :: (forall d. Data d => d -> u) -> Class -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Class -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Class -> m Class

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Class -> m Class

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Class -> m Class

Uniquable Class

Defined in GHC.Core.Class

Methods

getUnique :: Class -> Unique

NamedThing Class

Defined in GHC.Core.Class

Methods

getOccName :: Class -> OccName

getName :: Class -> Name

Outputable Class

Defined in GHC.Core.Class

Methods

ppr :: Class -> SDoc

pprPrec :: Rational -> Class -> SDoc

classMethods :: Class -> [Id]

classSCTheta :: Class -> [PredType]

classTvsFds :: Class -> ([TyVar], [FunDep TyVar])

classATs :: Class -> [TyCon]

pprFundeps :: Outputable a => [FunDep a] -> SDoc

Instances

data ClsInst

Instances

Data ClsInst

Defined in GHC.Core.InstEnv

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ClsInst -> c ClsInst

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ClsInst

toConstr :: ClsInst -> Constr

dataTypeOf :: ClsInst -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ClsInst)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ClsInst)

gmapT :: (forall b. Data b => b -> b) -> ClsInst -> ClsInst

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ClsInst -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ClsInst -> r

gmapQ :: (forall d. Data d => d -> u) -> ClsInst -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ClsInst -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ClsInst -> m ClsInst

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ClsInst -> m ClsInst

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ClsInst -> m ClsInst

NamedThing ClsInst

Defined in GHC.Core.InstEnv

Methods

getOccName :: ClsInst -> OccName

getName :: ClsInst -> Name

Outputable ClsInst

Defined in GHC.Core.InstEnv

Methods

ppr :: ClsInst -> SDoc

pprPrec :: Rational -> ClsInst -> SDoc

instanceDFunId :: ClsInst -> DFunId

pprInstance :: ClsInst -> SDoc

pprInstanceHdr :: ClsInst -> SDoc

pprFamInst :: FamInst -> SDoc

Pretty-prints a FamInst (type/data family instance) with its defining location.

data FamInst

Instances

NamedThing FamInst

Defined in GHC.Core.FamInstEnv

Methods

getOccName :: FamInst -> OccName

getName :: FamInst -> Name

Outputable FamInst

Defined in GHC.Core.FamInstEnv

Methods

ppr :: FamInst -> SDoc

pprPrec :: Rational -> FamInst -> SDoc

Types and Kinds

data Type

Instances

Data Type

Defined in GHC.Core.TyCo.Rep

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Type -> c Type

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Type

toConstr :: Type -> Constr

dataTypeOf :: Type -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Type)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Type)

gmapT :: (forall b. Data b => b -> b) -> Type -> Type

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Type -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Type -> r

gmapQ :: (forall d. Data d => d -> u) -> Type -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Type -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Type -> m Type

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Type -> m Type

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Type -> m Type

Outputable Type

Defined in GHC.Core.TyCo.Rep

Methods

ppr :: Type -> SDoc

pprPrec :: Rational -> Type -> SDoc

Eq (DeBruijn Type)

Defined in GHC.Core.Map

Methods

(==) :: DeBruijn Type -> DeBruijn Type -> Bool

(/=) :: DeBruijn Type -> DeBruijn Type -> Bool

splitForAllTys :: Type -> ([TyCoVar], Type)

funResultTy :: Type -> Type

pprParendType :: Type -> SDoc

pprTypeApp :: TyCon -> [Type] -> SDoc

type Kind = Type

type PredType = Type

type ThetaType = [PredType]

pprForAll :: [TyCoVarBinder] -> SDoc

pprThetaArrowTy :: ThetaType -> SDoc

parseInstanceHead :: GhcMonad m => String -> m Type

getInstancesForType :: GhcMonad m => Type -> m [ClsInst]

Entities

data TyThing

Constructors

AnId Id

AConLike ConLike

ATyCon TyCon

ACoAxiom (CoAxiom Branched)

Instances

NamedThing TyThing

Defined in GHC.Core.TyCo.Rep

Methods

getOccName :: TyThing -> OccName

getName :: TyThing -> Name

Outputable TyThing

Defined in GHC.Core.TyCo.Rep

Methods

ppr :: TyThing -> SDoc

pprPrec :: Rational -> TyThing -> SDoc

Syntax

Fixities

data FixityDirection

Constructors

InfixL

InfixR

InfixN

Instances

Eq FixityDirection

Defined in GHC.Types.Basic

Methods

(==) :: FixityDirection -> FixityDirection -> Bool

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

Data FixityDirection

Defined in GHC.Types.Basic

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> FixityDirection -> c FixityDirection

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c FixityDirection

toConstr :: FixityDirection -> Constr

dataTypeOf :: FixityDirection -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c FixityDirection)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c FixityDirection)

gmapT :: (forall b. Data b => b -> b) -> FixityDirection -> FixityDirection

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> FixityDirection -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> FixityDirection -> r

gmapQ :: (forall d. Data d => d -> u) -> FixityDirection -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> FixityDirection -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> FixityDirection -> m FixityDirection

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> FixityDirection -> m FixityDirection

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> FixityDirection -> m FixityDirection

Binary FixityDirection

Defined in GHC.Utils.Binary

Methods

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

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

get :: BinHandle -> IO FixityDirection

Outputable FixityDirection

Defined in GHC.Types.Basic

Methods

ppr :: FixityDirection -> SDoc

pprPrec :: Rational -> FixityDirection -> SDoc

defaultFixity :: Fixity

maxPrecedence :: Int

negateFixity :: Fixity

compareFixity :: Fixity -> Fixity -> (Bool, Bool)

data LexicalFixity

Constructors

Prefix

Infix

Instances

Eq LexicalFixity

Defined in GHC.Types.Basic

Methods

(==) :: LexicalFixity -> LexicalFixity -> Bool

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

Data LexicalFixity

Defined in GHC.Types.Basic

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LexicalFixity -> c LexicalFixity

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LexicalFixity

toConstr :: LexicalFixity -> Constr

dataTypeOf :: LexicalFixity -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c LexicalFixity)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LexicalFixity)

gmapT :: (forall b. Data b => b -> b) -> LexicalFixity -> LexicalFixity

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LexicalFixity -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LexicalFixity -> r

gmapQ :: (forall d. Data d => d -> u) -> LexicalFixity -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> LexicalFixity -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> LexicalFixity -> m LexicalFixity

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LexicalFixity -> m LexicalFixity

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LexicalFixity -> m LexicalFixity

Outputable LexicalFixity

Defined in GHC.Types.Basic

Methods

ppr :: LexicalFixity -> SDoc

pprPrec :: Rational -> LexicalFixity -> SDoc

Source locations

data SrcLoc

Constructors

RealSrcLoc !RealSrcLoc !(Maybe BufPos)

UnhelpfulLoc FastString

Instances

Eq SrcLoc

Defined in GHC.Types.SrcLoc

Methods

(==) :: SrcLoc -> SrcLoc -> Bool

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

Show SrcLoc

Defined in GHC.Types.SrcLoc

Methods

showsPrec :: Int -> SrcLoc -> ShowS

show :: SrcLoc -> String

showList :: [SrcLoc] -> ShowS

Outputable SrcLoc

Defined in GHC.Types.SrcLoc

Methods

ppr :: SrcLoc -> SDoc

pprPrec :: Rational -> SrcLoc -> SDoc

data RealSrcLoc

Instances

Eq RealSrcLoc

Defined in GHC.Types.SrcLoc

Methods

(==) :: RealSrcLoc -> RealSrcLoc -> Bool

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

Ord RealSrcLoc

Defined in GHC.Types.SrcLoc

Methods

compare :: RealSrcLoc -> RealSrcLoc -> Ordering

(<) :: RealSrcLoc -> RealSrcLoc -> Bool

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

(>) :: RealSrcLoc -> RealSrcLoc -> Bool

(>=) :: RealSrcLoc -> RealSrcLoc -> Bool

max :: RealSrcLoc -> RealSrcLoc -> RealSrcLoc

min :: RealSrcLoc -> RealSrcLoc -> RealSrcLoc

Show RealSrcLoc

Defined in GHC.Types.SrcLoc

Methods

showsPrec :: Int -> RealSrcLoc -> ShowS

show :: RealSrcLoc -> String

showList :: [RealSrcLoc] -> ShowS

Outputable RealSrcLoc

Defined in GHC.Types.SrcLoc

Methods

ppr :: RealSrcLoc -> SDoc

pprPrec :: Rational -> RealSrcLoc -> SDoc

mkSrcLoc :: FastString -> Int -> Int -> SrcLoc

noSrcLoc :: SrcLoc

srcLocFile :: RealSrcLoc -> FastString

srcLocLine :: RealSrcLoc -> Int

srcLocCol :: RealSrcLoc -> Int

data SrcSpan

Constructors

RealSrcSpan !RealSrcSpan !(Maybe BufSpan)

UnhelpfulSpan !UnhelpfulSpanReason

Instances

Eq SrcSpan

Defined in GHC.Types.SrcLoc

Methods

(==) :: SrcSpan -> SrcSpan -> Bool

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

Data SrcSpan

Defined in GHC.Types.SrcLoc

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SrcSpan -> c SrcSpan

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SrcSpan

toConstr :: SrcSpan -> Constr

dataTypeOf :: SrcSpan -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SrcSpan)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SrcSpan)

gmapT :: (forall b. Data b => b -> b) -> SrcSpan -> SrcSpan

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SrcSpan -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SrcSpan -> r

gmapQ :: (forall d. Data d => d -> u) -> SrcSpan -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SrcSpan -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SrcSpan -> m SrcSpan

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SrcSpan -> m SrcSpan

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SrcSpan -> m SrcSpan

Show SrcSpan

Defined in GHC.Types.SrcLoc

Methods

showsPrec :: Int -> SrcSpan -> ShowS

show :: SrcSpan -> String

showList :: [SrcSpan] -> ShowS

NFData SrcSpan

Defined in GHC.Types.SrcLoc

Methods

rnf :: SrcSpan -> ()

Binary SrcSpan

Defined in GHC.Utils.Binary

Methods

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

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

get :: BinHandle -> IO SrcSpan

Outputable SrcSpan

Defined in GHC.Types.SrcLoc

Methods

ppr :: SrcSpan -> SDoc

pprPrec :: Rational -> SrcSpan -> SDoc

ToJson SrcSpan

Defined in GHC.Types.SrcLoc

Methods

json :: SrcSpan -> JsonDoc

NamedThing e => NamedThing (Located e)

Defined in GHC.Types.Name

Methods

getOccName :: Located e -> OccName

getName :: Located e -> Name

Binary a => Binary (Located a)

Defined in GHC.Utils.Binary

Methods

put_ :: BinHandle -> Located a -> IO ()

put :: BinHandle -> Located a -> IO (Bin (Located a))

get :: BinHandle -> IO (Located a)

data RealSrcSpan

Instances

Eq RealSrcSpan

Defined in GHC.Types.SrcLoc

Methods

(==) :: RealSrcSpan -> RealSrcSpan -> Bool

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

Data RealSrcSpan

Defined in GHC.Types.SrcLoc

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RealSrcSpan -> c RealSrcSpan

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RealSrcSpan

toConstr :: RealSrcSpan -> Constr

dataTypeOf :: RealSrcSpan -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RealSrcSpan)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RealSrcSpan)

gmapT :: (forall b. Data b => b -> b) -> RealSrcSpan -> RealSrcSpan

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RealSrcSpan -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RealSrcSpan -> r

gmapQ :: (forall d. Data d => d -> u) -> RealSrcSpan -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RealSrcSpan -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RealSrcSpan -> m RealSrcSpan

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RealSrcSpan -> m RealSrcSpan

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RealSrcSpan -> m RealSrcSpan

Ord RealSrcSpan

Defined in GHC.Types.SrcLoc

Methods

compare :: RealSrcSpan -> RealSrcSpan -> Ordering

(<) :: RealSrcSpan -> RealSrcSpan -> Bool

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

(>) :: RealSrcSpan -> RealSrcSpan -> Bool

(>=) :: RealSrcSpan -> RealSrcSpan -> Bool

max :: RealSrcSpan -> RealSrcSpan -> RealSrcSpan

min :: RealSrcSpan -> RealSrcSpan -> RealSrcSpan

Show RealSrcSpan

Defined in GHC.Types.SrcLoc

Methods

showsPrec :: Int -> RealSrcSpan -> ShowS

show :: RealSrcSpan -> String

showList :: [RealSrcSpan] -> ShowS

Binary RealSrcSpan

Defined in GHC.Utils.Binary

Methods

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

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

get :: BinHandle -> IO RealSrcSpan

Outputable RealSrcSpan

Defined in GHC.Types.SrcLoc

Methods

ppr :: RealSrcSpan -> SDoc

pprPrec :: Rational -> RealSrcSpan -> SDoc

ToJson RealSrcSpan

Defined in GHC.Types.SrcLoc

Methods

json :: RealSrcSpan -> JsonDoc

mkSrcSpan :: SrcLoc -> SrcLoc -> SrcSpan

srcLocSpan :: SrcLoc -> SrcSpan

isGoodSrcSpan :: SrcSpan -> Bool

noSrcSpan :: SrcSpan

srcSpanStart :: SrcSpan -> SrcLoc

srcSpanEnd :: SrcSpan -> SrcLoc

srcSpanFile :: RealSrcSpan -> FastString

srcSpanStartLine :: RealSrcSpan -> Int

srcSpanEndLine :: RealSrcSpan -> Int

srcSpanStartCol :: RealSrcSpan -> Int

srcSpanEndCol :: RealSrcSpan -> Int

Located

data GenLocated l e

Constructors

L l e

Instances

Functor (GenLocated l)

Defined in GHC.Types.SrcLoc

Methods

fmap :: (a -> b) -> GenLocated l a -> GenLocated l b

(<$) :: a -> GenLocated l b -> GenLocated l a

Foldable (GenLocated l)

Defined in GHC.Types.SrcLoc

Methods

fold :: Monoid m => GenLocated l m -> m

foldMap :: Monoid m => (a -> m) -> GenLocated l a -> m

foldMap' :: Monoid m => (a -> m) -> GenLocated l a -> m

foldr :: (a -> b -> b) -> b -> GenLocated l a -> b

foldr' :: (a -> b -> b) -> b -> GenLocated l a -> b

foldl :: (b -> a -> b) -> b -> GenLocated l a -> b

foldl' :: (b -> a -> b) -> b -> GenLocated l a -> b

foldr1 :: (a -> a -> a) -> GenLocated l a -> a

foldl1 :: (a -> a -> a) -> GenLocated l a -> a

toList :: GenLocated l a -> [a]

null :: GenLocated l a -> Bool

length :: GenLocated l a -> Int

elem :: Eq a => a -> GenLocated l a -> Bool

maximum :: Ord a => GenLocated l a -> a

minimum :: Ord a => GenLocated l a -> a

sum :: Num a => GenLocated l a -> a

product :: Num a => GenLocated l a -> a

Traversable (GenLocated l)

Defined in GHC.Types.SrcLoc

Methods

traverse :: Applicative f => (a -> f b) -> GenLocated l a -> f (GenLocated l b)

sequenceA :: Applicative f => GenLocated l (f a) -> f (GenLocated l a)

mapM :: Monad m => (a -> m b) -> GenLocated l a -> m (GenLocated l b)

sequence :: Monad m => GenLocated l (m a) -> m (GenLocated l a)

NamedThing e => NamedThing (Located e)

Defined in GHC.Types.Name

Methods

getOccName :: Located e -> OccName

getName :: Located e -> Name

Binary a => Binary (Located a)

Defined in GHC.Utils.Binary

Methods

put_ :: BinHandle -> Located a -> IO ()

put :: BinHandle -> Located a -> IO (Bin (Located a))

get :: BinHandle -> IO (Located a)

(Eq l, Eq e) => Eq (GenLocated l e)

Defined in GHC.Types.SrcLoc

Methods

(==) :: GenLocated l e -> GenLocated l e -> Bool

(/=) :: GenLocated l e -> GenLocated l e -> Bool

(Data l, Data e) => Data (GenLocated l e)

Defined in GHC.Types.SrcLoc

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GenLocated l e -> c (GenLocated l e)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (GenLocated l e)

toConstr :: GenLocated l e -> Constr

dataTypeOf :: GenLocated l e -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (GenLocated l e))

dataCast2 :: Typeable t => (forall d e0. (Data d, Data e0) => c (t d e0)) -> Maybe (c (GenLocated l e))

gmapT :: (forall b. Data b => b -> b) -> GenLocated l e -> GenLocated l e

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GenLocated l e -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GenLocated l e -> r

gmapQ :: (forall d. Data d => d -> u) -> GenLocated l e -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GenLocated l e -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GenLocated l e -> m (GenLocated l e)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GenLocated l e -> m (GenLocated l e)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GenLocated l e -> m (GenLocated l e)

(Ord l, Ord e) => Ord (GenLocated l e)

Defined in GHC.Types.SrcLoc

Methods

compare :: GenLocated l e -> GenLocated l e -> Ordering

(<) :: GenLocated l e -> GenLocated l e -> Bool

(<=) :: GenLocated l e -> GenLocated l e -> Bool

(>) :: GenLocated l e -> GenLocated l e -> Bool

(>=) :: GenLocated l e -> GenLocated l e -> Bool

max :: GenLocated l e -> GenLocated l e -> GenLocated l e

min :: GenLocated l e -> GenLocated l e -> GenLocated l e

(Outputable l, Outputable e) => Outputable (GenLocated l e)

Defined in GHC.Types.SrcLoc

Methods

ppr :: GenLocated l e -> SDoc

pprPrec :: Rational -> GenLocated l e -> SDoc

type Located = GenLocated SrcSpan

type RealLocated = GenLocated RealSrcSpan

Constructing Located

noLoc :: e -> Located e

mkGeneralLocated :: String -> e -> Located e

Deconstructing Located

getLoc :: GenLocated l e -> l

unLoc :: GenLocated l e -> e

getRealSrcSpan :: RealLocated a -> RealSrcSpan

unRealSrcSpan :: RealLocated a -> a

Combining and comparing Located values

eqLocated :: Eq a => GenLocated l a -> GenLocated l a -> Bool

cmpLocated :: Ord a => GenLocated l a -> GenLocated l a -> Ordering

combineLocs :: Located a -> Located b -> SrcSpan

addCLoc :: Located a -> Located b -> c -> Located c

leftmost_smallest :: SrcSpan -> SrcSpan -> Ordering

leftmost_largest :: SrcSpan -> SrcSpan -> Ordering

rightmost_smallest :: SrcSpan -> SrcSpan -> Ordering

spans :: SrcSpan -> (Int, Int) -> Bool

isSubspanOf :: SrcSpan -> SrcSpan -> Bool

Exceptions

data GhcException

Constructors

Signal Int

UsageError String

CmdLineError String

Panic String

PprPanic String SDoc

Sorry String

PprSorry String SDoc

InstallationError String

ProgramError String

PprProgramError String SDoc

Instances

Show GhcException

Defined in GHC.Utils.Panic

Methods

showsPrec :: Int -> GhcException -> ShowS

show :: GhcException -> String

showList :: [GhcException] -> ShowS

Exception GhcException

Defined in GHC.Utils.Panic

Methods

toException :: GhcException -> SomeException

fromException :: SomeException -> Maybe GhcException

displayException :: GhcException -> String

showGhcException :: GhcException -> ShowS

Token stream manipulations

data Token

Instances

Show Token

Defined in GHC.Parser.Lexer

Methods

showsPrec :: Int -> Token -> ShowS

show :: Token -> String

showList :: [Token] -> ShowS

Outputable Token

Defined in GHC.Parser.Lexer

Methods

ppr :: Token -> SDoc

pprPrec :: Rational -> Token -> SDoc

getTokenStream :: GhcMonad m => Module -> m [Located Token]

Return module source as token stream, including comments.

The module must be in the module graph and its source must be available. Throws a SourceError on parse error.

getRichTokenStream :: GhcMonad m => Module -> m [(Located Token, String)]

Give even more information on the source than getTokenStream This function allows reconstructing the source completely with showRichTokenStream.

showRichTokenStream :: [(Located Token, String)] -> String

Take a rich token stream such as produced from getRichTokenStream and return source code almost identical to the original code (except for insignificant whitespace.)

addSourceToTokens :: RealSrcLoc -> StringBuffer -> [Located Token] -> [(Located Token, String)]

Given a source location and a StringBuffer corresponding to this location, return a rich token stream with the source associated to the tokens.

Pure interface to the parser

parser

Arguments

:: String

Haskell module source text (full Unicode is supported)

-> DynFlags

the flags

-> FilePath

the filename (for source locations)

-> (WarningMessages, Either ErrorMessages (Located HsModule))

A pure interface to the module parser.

API Annotations

data ApiAnns

Constructors

ApiAnns

Fields

• apiAnnItems :: Map ApiAnnKey [RealSrcSpan]
• apiAnnEofPos :: Maybe RealSrcSpan
• apiAnnComments :: Map RealSrcSpan [RealLocated AnnotationComment]
• apiAnnRogueComments :: [RealLocated AnnotationComment]

data AnnKeywordId

Constructors

AnnAnyclass

AnnAs

AnnAt

AnnBang

AnnBackquote

AnnBy

AnnCase

AnnClass

AnnClose

AnnCloseB

AnnCloseBU

AnnCloseC

AnnCloseQ

AnnCloseQU

AnnCloseP

AnnCloseS

AnnColon

AnnComma

AnnCommaTuple

AnnDarrow

AnnDarrowU

AnnData

AnnDcolon

AnnDcolonU

AnnDefault

AnnDeriving

AnnDo

AnnDot

AnnDotdot

AnnElse

AnnEqual

AnnExport

AnnFamily

AnnForall

AnnForallU

AnnForeign

AnnFunId

AnnGroup

AnnHeader

AnnHiding

AnnIf

AnnImport

AnnIn

AnnInfix

AnnInstance

AnnLam

AnnLarrow

AnnLarrowU

AnnLet

AnnLollyU

AnnMdo

AnnMinus

AnnModule

AnnPercentOne

AnnNewtype

AnnName

AnnOf

AnnOpen

AnnOpenB

AnnOpenBU

AnnOpenC

AnnOpenE

AnnOpenEQ

AnnOpenEQU

AnnOpenP

AnnOpenS

AnnDollar

AnnDollarDollar

AnnPackageName

AnnPattern

AnnPercent

AnnProc

AnnQualified

AnnRarrow

AnnRarrowU

AnnRec

AnnRole

AnnSafe

AnnSemi

AnnSimpleQuote

AnnSignature

AnnStatic

AnnStock

AnnThen

AnnThTyQuote

AnnTilde

AnnType

AnnUnit

AnnUsing

AnnVal

AnnValStr

AnnVbar

AnnVia

AnnWhere

Annlarrowtail

AnnlarrowtailU

Annrarrowtail

AnnrarrowtailU

AnnLarrowtail

AnnLarrowtailU

AnnRarrowtail

AnnRarrowtailU

Instances

Eq AnnKeywordId

Defined in GHC.Parser.Annotation

Methods

(==) :: AnnKeywordId -> AnnKeywordId -> Bool

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

Data AnnKeywordId

Defined in GHC.Parser.Annotation

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AnnKeywordId -> c AnnKeywordId

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AnnKeywordId

toConstr :: AnnKeywordId -> Constr

dataTypeOf :: AnnKeywordId -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AnnKeywordId)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AnnKeywordId)

gmapT :: (forall b. Data b => b -> b) -> AnnKeywordId -> AnnKeywordId

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AnnKeywordId -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AnnKeywordId -> r

gmapQ :: (forall d. Data d => d -> u) -> AnnKeywordId -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> AnnKeywordId -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AnnKeywordId -> m AnnKeywordId

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AnnKeywordId -> m AnnKeywordId

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AnnKeywordId -> m AnnKeywordId

Ord AnnKeywordId

Defined in GHC.Parser.Annotation

Methods

compare :: AnnKeywordId -> AnnKeywordId -> Ordering

(<) :: AnnKeywordId -> AnnKeywordId -> Bool

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

(>) :: AnnKeywordId -> AnnKeywordId -> Bool

(>=) :: AnnKeywordId -> AnnKeywordId -> Bool

max :: AnnKeywordId -> AnnKeywordId -> AnnKeywordId

min :: AnnKeywordId -> AnnKeywordId -> AnnKeywordId

Show AnnKeywordId

Defined in GHC.Parser.Annotation

Methods

showsPrec :: Int -> AnnKeywordId -> ShowS

show :: AnnKeywordId -> String

showList :: [AnnKeywordId] -> ShowS

Outputable AnnKeywordId

Defined in GHC.Parser.Annotation

Methods

ppr :: AnnKeywordId -> SDoc

pprPrec :: Rational -> AnnKeywordId -> SDoc

data AnnotationComment

Constructors

AnnDocCommentNext String

AnnDocCommentPrev String

AnnDocCommentNamed String

AnnDocSection Int String

AnnDocOptions String

AnnLineComment String

AnnBlockComment String

Instances

Eq AnnotationComment

Defined in GHC.Parser.Annotation

Methods

(==) :: AnnotationComment -> AnnotationComment -> Bool

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

Data AnnotationComment

Defined in GHC.Parser.Annotation

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AnnotationComment -> c AnnotationComment

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AnnotationComment

toConstr :: AnnotationComment -> Constr

dataTypeOf :: AnnotationComment -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AnnotationComment)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AnnotationComment)

gmapT :: (forall b. Data b => b -> b) -> AnnotationComment -> AnnotationComment

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AnnotationComment -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AnnotationComment -> r

gmapQ :: (forall d. Data d => d -> u) -> AnnotationComment -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> AnnotationComment -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AnnotationComment -> m AnnotationComment

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AnnotationComment -> m AnnotationComment

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AnnotationComment -> m AnnotationComment

Ord AnnotationComment

Defined in GHC.Parser.Annotation

Methods

compare :: AnnotationComment -> AnnotationComment -> Ordering

(<) :: AnnotationComment -> AnnotationComment -> Bool

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

(>) :: AnnotationComment -> AnnotationComment -> Bool

(>=) :: AnnotationComment -> AnnotationComment -> Bool

max :: AnnotationComment -> AnnotationComment -> AnnotationComment

min :: AnnotationComment -> AnnotationComment -> AnnotationComment

Show AnnotationComment

Defined in GHC.Parser.Annotation

Methods

showsPrec :: Int -> AnnotationComment -> ShowS

show :: AnnotationComment -> String

showList :: [AnnotationComment] -> ShowS

Outputable AnnotationComment

Defined in GHC.Parser.Annotation

Methods

ppr :: AnnotationComment -> SDoc

pprPrec :: Rational -> AnnotationComment -> SDoc

type ApiAnnKey = (RealSrcSpan, AnnKeywordId)

getAnnotation :: ApiAnns -> RealSrcSpan -> AnnKeywordId -> [RealSrcSpan]

getAndRemoveAnnotation :: ApiAnns -> RealSrcSpan -> AnnKeywordId -> ([RealSrcSpan], ApiAnns)

getAnnotationComments :: ApiAnns -> RealSrcSpan -> [RealLocated AnnotationComment]

getAndRemoveAnnotationComments :: ApiAnns -> RealSrcSpan -> ([RealLocated AnnotationComment], ApiAnns)

unicodeAnn :: AnnKeywordId -> AnnKeywordId

Miscellaneous

cyclicModuleErr :: [ModSummary] -> SDoc