Language.Haskell.GhcMod.Internal

Low level access to the ghc-mod library.

Types

type GHCOption = String

A single GHC command line option.

type Package = (PackageBaseName, PackageVersion, PackageId)

A package's name, verson and id.

type PackageBaseName = String

A package name.

type PackageVersion = String

A package version.

type PackageId = String

A package id.

type IncludeDir = FilePath

An include directory for modules.

data CompilerOptions

Option information for GHC

Constructors

CompilerOptions

Fields

ghcOptions :: [GHCOption]

Command line options

includeDirs :: [IncludeDir]

Include directories for modules

depPackages :: [Package]

Dependent package names

Instances

Eq CompilerOptions

Show CompilerOptions

Cabal API

parseCabalFile :: FilePath -> IO PackageDescription

Parsing a cabal file and returns PackageDescription. IOException is thrown if parsing fails.

getCompilerOptions :: [GHCOption] -> Cradle -> PackageDescription -> IO CompilerOptions

Getting necessary CompilerOptions from three information sources.

cabalAllBuildInfo :: PackageDescription -> [BuildInfo]

Extracting all BuildInfo for libraries, executables, and tests.

cabalDependPackages :: [BuildInfo] -> [PackageBaseName]

Extracting package names of dependency.

cabalSourceDirs :: [BuildInfo] -> [IncludeDir]

Extracting include directories for modules.

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

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

IO

getSystemLibDir :: IO (Maybe FilePath)

Obtaining the directory for system libraries.

getDynamicFlags :: IO DynFlags

Return the DynFlags currently in use in the GHC session.

Initializing DynFlags

initializeFlagsWithCradle :: GhcMonad m => Options -> Cradle -> m ()

Initialize the DynFlags relating to the compilation of a single file or GHC session according to the Cradle and Options provided.

Targets

setTargetFiles :: GhcMonad m => [FilePath] -> m ()

Set the files as targets and load them.

Logging

withLogger :: Options -> (DynFlags -> DynFlags) -> Ghc () -> Ghc (Either String String)

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

setNoWaringFlags :: DynFlags -> DynFlags

Set DynFlags equivalent to -w:.

setAllWaringFlags :: DynFlags -> DynFlags

Set DynFlags equivalent to -Wall.

Ghc Choice

(||>) :: Ghc a -> Ghc a -> Ghc a

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

goNext :: Ghc a

Go to the next Ghc monad by throwing AltGhcgoNext.

runAnyOne :: [Ghc a] -> Ghc a

Run any one Ghc monad.

GhcMonad Choice

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

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