ghc-mod-5.0.1: Happy Haskell Programming

Safe HaskellNone




Low level access to the ghc-mod library.



type GHCOption = StringSource

A single GHC command line option.

type Package = (PackageBaseName, PackageVersion, PackageId)Source

A package's name, verson and id.

type PackageBaseName = StringSource

A package name.

type PackageVersion = StringSource

A package version.

type PackageId = StringSource

A package id.

type IncludeDir = FilePathSource

An include directory for modules.

data CompilerOptions Source

Option information for GHC




ghcOptions :: [GHCOption]

Command line options

includeDirs :: [IncludeDir]

Include directories for modules

depPackages :: [Package]

Dependent package names

Cabal API

parseCabalFile :: (MonadIO m, Error e, MonadError e m) => FilePath -> m PackageDescriptionSource

Parse a cabal file and return a PackageDescription.

getCompilerOptions :: (MonadIO m, MonadError GhcModError m, Functor m) => [GHCOption] -> Cradle -> PackageDescription -> m CompilerOptionsSource

Getting necessary CompilerOptions from three information sources.

cabalAllBuildInfo :: PackageDescription -> [BuildInfo]Source

Extracting all BuildInfo for libraries, executables, and tests.

cabalDependPackages :: [BuildInfo] -> [PackageBaseName]Source

Extracting package names of dependency.

cabalSourceDirs :: [BuildInfo] -> [IncludeDir]Source

Extracting include directories for modules.

cabalAllTargets :: PackageDescription -> IO ([String], [String], [String], [String])Source

Extracting all Module FilePaths for libraries, executables, tests and benchmarks.


ghcLibDir :: FilePathSource

Obtaining the directory for ghc system libraries.


getDynamicFlags :: IO DynFlagsSource

Return the DynFlags currently in use in the GHC session.


setTargetFiles :: IOish m => [FilePath] -> GhcModT m ()Source

Set the files as targets and load them.


withLogger :: IOish m => (DynFlags -> DynFlags) -> GhcModT m () -> GhcModT m (Either String String)Source

Set the session flag (e.g. -Wall or -w:) then executes a body. Logged messages are returned as String. Right is success and Left is failure.

Environment, state and logging

type GhcModLog = ()Source

Monad utilities

runGhcModT' :: IOish m => GhcModEnv -> GhcModState -> GhcModT m a -> m (Either GhcModError (a, GhcModState), GhcModLog)Source

Run a computation inside GhcModT providing the RWST environment and initial state. This is a low level function, use it only if you know what to do with GhcModEnv and GhcModState.

You should probably look at runGhcModT instead.

Accessing GhcModEnv and GhcModState

GhcMonad Choice

(||>) :: GhcMonad m => m a -> m a -> m aSource

Try the left Ghc action. If IOException occurs, try the right Ghc action.

goNext :: GhcMonad m => m aSource

Go to the next Ghc monad by throwing AltGhcgoNext.

runAnyOne :: GhcMonad m => [m a] -> m aSource

Run any one Ghc monad.