| Safe Haskell | None |
|---|
Language.Haskell.GhcMod.Internal
Contents
Description
Low level access to the ghc-mod library.
- type LogReader = IO [String]
- type GHCOption = String
- type Package = String
- type IncludeDir = FilePath
- fromCabalFile :: [GHCOption] -> Cradle -> IO ([GHCOption], [IncludeDir], [Package])
- parseCabalFile :: FilePath -> IO PackageDescription
- cabalAllBuildInfo :: PackageDescription -> [BuildInfo]
- cabalDependPackages :: [BuildInfo] -> [Package]
- cabalSourceDirs :: [BuildInfo] -> [IncludeDir]
- canCheckFast :: ModuleGraph -> Bool
- getDynamicFlags :: IO DynFlags
- initializeFlags :: GhcMonad m => Options -> m ()
- initializeFlagsWithCradle :: GhcMonad m => Options -> Cradle -> [GHCOption] -> Bool -> m LogReader
- setTargetFiles :: GhcMonad m => [FilePath] -> m ()
- checkSlowAndSet :: GhcMonad m => m ()
- (||>) :: Ghc a -> Ghc a -> Ghc a
- goNext :: Ghc a
- runAnyOne :: [Ghc a] -> Ghc a
- (|||>) :: GhcMonad m => m a -> m a -> m a
Types
type IncludeDir = FilePathSource
Include directories for modules
Cabal API
fromCabalFile :: [GHCOption] -> Cradle -> IO ([GHCOption], [IncludeDir], [Package])Source
Parsing a cabal file in Cradle and returns
options for GHC, include directories for modules and
package names of dependency.
parseCabalFile :: FilePath -> IO PackageDescriptionSource
Parsing a cabal file and returns PackageDescription.
IOException is thrown if parsing fails.
cabalAllBuildInfo :: PackageDescription -> [BuildInfo]Source
Extracting all BuildInfo for libraries, executables, tests and benchmarks.
cabalDependPackages :: [BuildInfo] -> [Package]Source
Extracting package names of dependency.
cabalSourceDirs :: [BuildInfo] -> [IncludeDir]Source
Extracting include directories for modules.
GHC API
canCheckFast :: ModuleGraph -> BoolSource
Checking if Template Haskell or quasi quotes are used. If not, the process can be faster.
Getting DynFlags
getDynamicFlags :: IO DynFlagsSource
Return the DynFlags currently in use in the GHC session.
Initializing DynFlags
initializeFlags :: GhcMonad m => Options -> m ()Source
Initialize the DynFlags relating to the compilation of a single
file or GHC session.
initializeFlagsWithCradle :: GhcMonad m => Options -> Cradle -> [GHCOption] -> Bool -> m LogReaderSource
GhcMonad
setTargetFiles :: GhcMonad m => [FilePath] -> m ()Source
Set the files that GHC will load / compile.
checkSlowAndSet :: GhcMonad m => m ()Source
Ghc Choice
(||>) :: Ghc a -> Ghc a -> Ghc aSource
Try the left Ghc action. If IOException occurs, try
the right Ghc action.