Language.Haskell.GhcMod.Internal

Low level access to the ghc-mod library.

Types

type LogReader = IO [String]

A means to read the log.

type GHCOption = String

A single GHC command line option.

type Package = (PackageBaseName, Maybe String)

A package name and its 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

Cradle

userPackageDbOptsForGhc :: Maybe FilePath -> [String]

Creating user package db options for GHC.

>>> userPackageDbOptsForGhc (Just "/foo/bar/i386-osx-ghc-7.6.3-packages.conf.d")
["-no-user-package-db","-package-db","/foo/bar/i386-osx-ghc-7.6.3-packages.conf.d"]
>>> userPackageDbOptsForGhc (Just "/foo/bar/i386-osx-ghc-7.4.1-packages.conf.d")
["-no-user-package-conf","-package-conf","/foo/bar/i386-osx-ghc-7.4.1-packages.conf.d"]

userPackageDbOptsForGhcPkg :: Maybe FilePath -> [String]

Creating user package db options for ghc-pkg.

>>> userPackageDbOptsForGhcPkg (Just "/foo/bar/i386-osx-ghc-7.6.3-packages.conf.d")
["--no-user-package-db","--package-db=/foo/bar/i386-osx-ghc-7.6.3-packages.conf.d"]
>>> userPackageDbOptsForGhcPkg (Just "/foo/bar/i386-osx-ghc-7.4.1-packages.conf.d")
["--no-user-package-conf","--package-conf=/foo/bar/i386-osx-ghc-7.4.1-packages.conf.d"]

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

initializeFlags :: GhcMonad m => Options -> m ()

Initialize the DynFlags relating to the compilation of a single file or GHC session.

initializeFlagsWithCradle :: GhcMonad m => Options -> Cradle -> [GHCOption] -> Bool -> m (LogReader, Maybe PackageDescription)

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

Ghc Monad

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

Set the files that GHC will load / compile.

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

Adding the files to the targets.

handleErrMsg :: LineSeparator -> SourceError -> Ghc [String]

Converting SourceError to String.

browseAll :: DynFlags -> Ghc [(String, String)]

Browsing all functions in all system/user modules.

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.