GHC.Driver.Pipeline.Monad

The CompPipeline monad and associated ops

Defined in separate module so that it can safely be imported from Hooks

Documentation

newtype CompPipeline a

Constructors

P

Fields

• unP :: PipeEnv -> PipeState -> IO (PipeState, a)

Instances

Monad CompPipeline

Defined in GHC.Driver.Pipeline.Monad

Methods

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

(>>) :: CompPipeline a -> CompPipeline b -> CompPipeline b

return :: a -> CompPipeline a

Functor CompPipeline

Defined in GHC.Driver.Pipeline.Monad

Methods

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

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

Applicative CompPipeline

Defined in GHC.Driver.Pipeline.Monad

Methods

pure :: a -> CompPipeline a

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

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

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

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

MonadIO CompPipeline

Defined in GHC.Driver.Pipeline.Monad

Methods

liftIO :: IO a -> CompPipeline a

HasDynFlags CompPipeline

Defined in GHC.Driver.Pipeline.Monad

Methods

getDynFlags :: CompPipeline DynFlags

HasLogger CompPipeline

Defined in GHC.Driver.Pipeline.Monad

Methods

getLogger :: CompPipeline Logger

evalP :: CompPipeline a -> PipeEnv -> PipeState -> IO (PipeState, a)

data PhasePlus

Constructors

RealPhase Phase

HscOut HscSource ModuleName HscStatus

Instances

Outputable PhasePlus

Defined in GHC.Driver.Pipeline.Monad

Methods

ppr :: PhasePlus -> SDoc

data PipeEnv

Constructors

PipeEnv

Fields

• stop_phase :: Phase

  Stop just before this phase

• src_filename :: String

  basename of original input source

• src_basename :: String

  basename of original input source

• src_suffix :: String

  its extension

• output_spec :: PipelineOutput

  says where to put the pipeline output

data PipeState

Constructors

PipeState

Fields

• hsc_env :: HscEnv

  only the DynFlags and the Plugins change in the HscEnv. The DynFlags change at various points, for example when we read the OPTIONS_GHC pragmas in the Cpp phase.

• maybe_loc :: Maybe ModLocation

  the ModLocation. This is discovered during compilation, in the Hsc phase where we read the module header.

• foreign_os :: [FilePath]

  additional object files resulting from compiling foreign code. They come from two sources: foreign stubs, and add{C,Cxx,Objc,Objcxx}File from template haskell

• iface :: Maybe (ModIface, ModDetails)

  Interface generated by HscOut phase. Only available after the phase runs.

data PipelineOutput

Constructors

Temporary TempFileLifetime

Output should be to a temporary file: we're going to run more compilation steps on this output later.

Persistent

We want a persistent file, i.e. a file in the current directory derived from the input filename, but with the appropriate extension. eg. in "ghc -c Foo.hs" the output goes into ./Foo.o.

SpecificFile

The output must go into the specific outputFile in DynFlags. We don't store the filename in the constructor as it changes when doing -dynamic-too.

Instances

Show PipelineOutput

Defined in GHC.Driver.Pipeline.Monad

Methods

showsPrec :: Int -> PipelineOutput -> ShowS

show :: PipelineOutput -> String

showList :: [PipelineOutput] -> ShowS

getPipeEnv :: CompPipeline PipeEnv

getPipeState :: CompPipeline PipeState

getPipeSession :: CompPipeline HscEnv

setDynFlags :: DynFlags -> CompPipeline ()

setModLocation :: ModLocation -> CompPipeline ()

setForeignOs :: [FilePath] -> CompPipeline ()

setIface :: ModIface -> ModDetails -> CompPipeline ()

pipeStateDynFlags :: PipeState -> DynFlags

pipeStateModIface :: PipeState -> Maybe (ModIface, ModDetails)

setPlugins :: [LoadedPlugin] -> [StaticPlugin] -> CompPipeline ()