License	Apache-2.0
Safe Haskell	None
Language	Haskell2010

CabalHelper.Compiletime.Compile

Description

Synopsis

data Compile
- = CompileWithCabalSource {
  - compCabalSourceDir :: !CabalSourceDir
  - compCabalSourceVersion :: !Version
  }
- | CompileWithCabalPackage {
  }
data CompPaths = CompPaths {
- compBuildDir :: !FilePath
- compOutDir :: !FilePath
- compExePath :: !FilePath
}
data CompilationProductScope
- = CPSGlobal
- | CPSProject
type CompHelperEnv = CompHelperEnv' CabalVersion
data CompHelperEnv' cv = CompHelperEnv {
- cheCabalVer :: !cv
- chePkgDb :: !(Maybe PackageDbDir)
- cheProjDir :: !FilePath
- chePlanJson :: !(Maybe PlanJson)
- cheDistV2 :: !(Maybe FilePath)
- cheProjLocalCacheDir :: FilePath
}
compileHelper :: Env => CompHelperEnv -> IO (Either ExitCode FilePath)
compileHelper' :: Env => CompHelperEnv' UnpackedCabalVersion -> IO (Either ExitCode FilePath)
compile :: Env => CompPaths -> Compile -> IO (Either ExitCode FilePath)
compPaths :: FilePath -> FilePath -> Compile -> CompPaths
exeName :: ResolvedCabalVersion -> String
compGhcInvocation :: Compile -> CompPaths -> GhcInvocation
cabalVersionMacro :: Version -> String
cabalMinVersionMacro :: Version -> String
errorInstallCabal :: CabalVersion' a -> IO b
cabalFileVersion :: String -> Version
cabalFileBuildType :: String -> String
cabalFileTopField :: String -> String -> String

Documentation

data Compile Source #

Constructors

CompileWithCabalSource
Fields compCabalSourceDir :: !CabalSourceDir compCabalSourceVersion :: !Version
CompileWithCabalPackage
Fields compPackageSource :: !GhcPackageSource compCabalVersion :: !ResolvedCabalVersion compProductTarget :: !CompilationProductScope

data CompPaths Source #

Constructors

CompPaths
Fields compBuildDir :: !FilePath compOutDir :: !FilePath compExePath :: !FilePath

data CompilationProductScope Source #

The Helper executable we produce as a compilation product can either be placed in a per-project location, or a per-user/global location in the user's home directory. This type controls where the compilation process places the executable.

Constructors

CPSGlobal
CPSProject

type CompHelperEnv = CompHelperEnv' CabalVersion Source #

data CompHelperEnv' cv Source #

Constructors

CompHelperEnv
Fields cheCabalVer :: !cv chePkgDb :: !(Maybe PackageDbDir) A package-db where we are guaranteed to find Cabal-`cheCabalVer`. cheProjDir :: !FilePath chePlanJson :: !(Maybe PlanJson) cheDistV2 :: !(Maybe FilePath) cheProjLocalCacheDir :: FilePath

compileHelper :: Env => CompHelperEnv -> IO (Either ExitCode FilePath) Source #

compileHelper' :: Env => CompHelperEnv' UnpackedCabalVersion -> IO (Either ExitCode FilePath) Source #

compile :: Env => CompPaths -> Compile -> IO (Either ExitCode FilePath) Source #

compPaths :: FilePath -> FilePath -> Compile -> CompPaths Source #

exeName :: ResolvedCabalVersion -> String Source #

compGhcInvocation :: Compile -> CompPaths -> GhcInvocation Source #

cabalVersionMacro :: Version -> String Source #

cabalMinVersionMacro :: Version -> String Source #

errorInstallCabal :: CabalVersion' a -> IO b Source #

cabalFileVersion :: String -> Version Source #

Find version: XXX delcaration in a cabal file

cabalFileBuildType :: String -> String Source #

Find build-type: XXX delcaration in a cabal file

cabalFileTopField :: String -> String -> String Source #