Hhp.Internal

The Happy Haskell Programming library in low level.

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

Show CompilerOptions

Defined in Hhp.Types

Methods

showsPrec :: Int -> CompilerOptions -> ShowS

show :: CompilerOptions -> String

showList :: [CompilerOptions] -> ShowS

Eq CompilerOptions

Defined in Hhp.Types

Methods

(==) :: CompilerOptions -> CompilerOptions -> Bool

(/=) :: CompilerOptions -> CompilerOptions -> Bool

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

getDynamicFlags :: IO DynFlags

Return the DynFlags currently in use in the GHC session.

Targets

setTargetFiles :: [FilePath] -> Ghc ()

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.

setNoWarningFlags :: DynFlags -> DynFlags

Set DynFlags equivalent to "-w:".

setAllWarningFlags :: DynFlags -> DynFlags

Set DynFlags equivalent to "-Wall".