Safe Haskell	None
Language	Haskell2010

B9.Artifact.Readable.Interpreter

Description

Mostly effectful functions to assemble artifacts.

Synopsis

buildArtifacts :: ArtifactGenerator -> B9 String
getArtifactOutputFiles :: ArtifactGenerator -> Either String [FilePath]
assemble :: ArtifactGenerator -> B9 [AssembledArtifact]
evalArtifactGenerator :: String -> String -> Environment -> ArtifactGenerator -> Either String [InstanceGenerator [SourceGenerator]]
parseArtifactGenerator :: ArtifactGenerator -> CGParser ()
withArtifactSources :: [ArtifactSource] -> CGParser () -> CGParser ()
withBindings :: [(String, String)] -> CGParser () -> CGParser ()
addBindings :: MonadThrow m => [(String, String)] -> CGEnv -> m CGEnv
withXBindings :: [(String, [String])] -> CGParser () -> CGParser ()
eachBindingSetT :: ArtifactGenerator -> [String] -> [[String]] -> CGParser [[(String, String)]]
eachBindingSet :: ArtifactGenerator -> [(String, [String])] -> CGParser [[(String, String)]]
writeInstanceGenerator :: InstanceId -> ArtifactAssembly -> CGParser ()
newtype CGParser a = CGParser {
- runCGParser :: WriterT [InstanceGenerator CGEnv] (ReaderT CGEnv (Either SomeException)) a
}
data CGEnv = CGEnv {
- agEnv :: Environment
- agSources :: [ArtifactSource]
}
data InstanceGenerator e = IG InstanceId e ArtifactAssembly
newtype CGError = CGError String
cgError :: String -> CGParser a
execCGParser :: CGParser () -> CGEnv -> Either SomeException [InstanceGenerator CGEnv]
execIGEnv :: InstanceGenerator CGEnv -> Either String (InstanceGenerator [SourceGenerator])
substAssembly :: Environment -> ArtifactAssembly -> ArtifactAssembly
toSourceGen :: Environment -> ArtifactSource -> Either String [SourceGenerator]
createAssembledArtifacts :: [InstanceGenerator [SourceGenerator]] -> B9 [AssembledArtifact]
generateSources :: FilePath -> InstanceGenerator [SourceGenerator] -> B9 (InstanceGenerator FilePath)
createTargets :: InstanceGenerator FilePath -> B9 AssembledArtifact
generateUniqueIID :: InstanceId -> B9 InstanceId
generateSourceTo :: FilePath -> SourceGenerator -> B9 ()
sgReadSourceFile :: Environment -> SourceFile -> B9 ByteString
sgChangePerm :: FilePath -> SGPerm -> B9 ()
data SourceGenerator = SG Environment SGSource SGPerm FilePath
sourceGeneratorOutputFile :: SourceGenerator -> FilePath
data SGSource
- = SGFiles [SourceFile]
- | SGContent Content
data SGPerm
- = SGSetPerm (Int, Int, Int)
- | KeepPerm
sgGetFroms :: SourceGenerator -> [SourceFile]
setSGPerm :: Int -> Int -> Int -> SourceGenerator -> Either String SourceGenerator
setSGFromDirectory :: FilePath -> SourceGenerator -> SourceGenerator
setSGToDirectory :: FilePath -> SourceGenerator -> SourceGenerator
createTarget :: InstanceId -> FilePath -> ArtifactAssembly -> B9 [ArtifactTarget]

Documentation

buildArtifacts :: ArtifactGenerator -> B9 String Source #

Execute an ArtifactGenerator and return a B9Invocation that returns the build id obtained by getBuildId.

getArtifactOutputFiles :: ArtifactGenerator -> Either String [FilePath] Source #

Return a list of relative paths for the local files to be generated by the ArtifactGenerator. This excludes Shared and Transient image targets.

assemble :: ArtifactGenerator -> B9 [AssembledArtifact] Source #

Run an artifact generator to produce the artifacts.

evalArtifactGenerator :: String -> String -> Environment -> ArtifactGenerator -> Either String [InstanceGenerator [SourceGenerator]] Source #

Evaluate an ArtifactGenerator into a list of low-level build instructions that can be built with createAssembledArtifacts.

parseArtifactGenerator :: ArtifactGenerator -> CGParser () Source #

Parse an artifacto generator inside a CGParser monad.

withArtifactSources :: [ArtifactSource] -> CGParser () -> CGParser () Source #

Execute a CGParser action in an environment that contains a list of ArtifactSources.

withBindings :: [(String, String)] -> CGParser () -> CGParser () Source #

addBindings :: MonadThrow m => [(String, String)] -> CGEnv -> m CGEnv Source #

withXBindings :: [(String, [String])] -> CGParser () -> CGParser () Source #

eachBindingSetT :: ArtifactGenerator -> [String] -> [[String]] -> CGParser [[(String, String)]] Source #

eachBindingSet :: ArtifactGenerator -> [(String, [String])] -> CGParser [[(String, String)]] Source #

writeInstanceGenerator :: InstanceId -> ArtifactAssembly -> CGParser () Source #

newtype CGParser a Source #

Monad for creating Instance generators.

Constructors

CGParser
Fields runCGParser :: WriterT [InstanceGenerator CGEnv] (ReaderT CGEnv (Either SomeException)) a

Instances

Monad CGParser Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods (>>=) :: CGParser a -> (a -> CGParser b) -> CGParser b # (>>) :: CGParser a -> CGParser b -> CGParser b # return :: a -> CGParser a # fail :: String -> CGParser a #
Functor CGParser Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods fmap :: (a -> b) -> CGParser a -> CGParser b # (<$) :: a -> CGParser b -> CGParser a #
Applicative CGParser Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods pure :: a -> CGParser a # (<>) :: CGParser (a -> b) -> CGParser a -> CGParser b # liftA2 :: (a -> b -> c) -> CGParser a -> CGParser b -> CGParser c # (>) :: CGParser a -> CGParser b -> CGParser b # (<*) :: CGParser a -> CGParser b -> CGParser a #
MonadThrow CGParser Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods throwM :: Exception e => e -> CGParser a #
MonadReader CGEnv CGParser Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods ask :: CGParser CGEnv # local :: (CGEnv -> CGEnv) -> CGParser a -> CGParser a # reader :: (CGEnv -> a) -> CGParser a #
MonadWriter [InstanceGenerator CGEnv] CGParser Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods writer :: (a, [InstanceGenerator CGEnv]) -> CGParser a # tell :: [InstanceGenerator CGEnv] -> CGParser () # listen :: CGParser a -> CGParser (a, [InstanceGenerator CGEnv]) # pass :: CGParser (a, [InstanceGenerator CGEnv] -> [InstanceGenerator CGEnv]) -> CGParser a #

data CGEnv Source #

Constructors

CGEnv
Fields agEnv :: Environment agSources :: [ArtifactSource]

Instances

Eq CGEnv Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods (==) :: CGEnv -> CGEnv -> Bool # (/=) :: CGEnv -> CGEnv -> Bool #
Show CGEnv Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods showsPrec :: Int -> CGEnv -> ShowS # show :: CGEnv -> String # showList :: [CGEnv] -> ShowS #
MonadReader CGEnv CGParser Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods ask :: CGParser CGEnv # local :: (CGEnv -> CGEnv) -> CGParser a -> CGParser a # reader :: (CGEnv -> a) -> CGParser a #
MonadWriter [InstanceGenerator CGEnv] CGParser Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods writer :: (a, [InstanceGenerator CGEnv]) -> CGParser a # tell :: [InstanceGenerator CGEnv] -> CGParser () # listen :: CGParser a -> CGParser (a, [InstanceGenerator CGEnv]) # pass :: CGParser (a, [InstanceGenerator CGEnv] -> [InstanceGenerator CGEnv]) -> CGParser a #

data InstanceGenerator e Source #

Constructors

IG InstanceId e ArtifactAssembly

Instances

Eq e => Eq (InstanceGenerator e) Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods (==) :: InstanceGenerator e -> InstanceGenerator e -> Bool # (/=) :: InstanceGenerator e -> InstanceGenerator e -> Bool #
Data e => Data (InstanceGenerator e) Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> InstanceGenerator e -> c (InstanceGenerator e) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (InstanceGenerator e) # toConstr :: InstanceGenerator e -> Constr # dataTypeOf :: InstanceGenerator e -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (InstanceGenerator e)) # dataCast2 :: Typeable t => (forall d e0. (Data d, Data e0) => c (t d e0)) -> Maybe (c (InstanceGenerator e)) # gmapT :: (forall b. Data b => b -> b) -> InstanceGenerator e -> InstanceGenerator e # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> InstanceGenerator e -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> InstanceGenerator e -> r # gmapQ :: (forall d. Data d => d -> u) -> InstanceGenerator e -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> InstanceGenerator e -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> InstanceGenerator e -> m (InstanceGenerator e) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> InstanceGenerator e -> m (InstanceGenerator e) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> InstanceGenerator e -> m (InstanceGenerator e) #
Read e => Read (InstanceGenerator e) Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods readsPrec :: Int -> ReadS (InstanceGenerator e) # readList :: ReadS [InstanceGenerator e] # readPrec :: ReadPrec (InstanceGenerator e) # readListPrec :: ReadPrec [InstanceGenerator e] #
Show e => Show (InstanceGenerator e) Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods showsPrec :: Int -> InstanceGenerator e -> ShowS # show :: InstanceGenerator e -> String # showList :: [InstanceGenerator e] -> ShowS #
MonadWriter [InstanceGenerator CGEnv] CGParser Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods writer :: (a, [InstanceGenerator CGEnv]) -> CGParser a # tell :: [InstanceGenerator CGEnv] -> CGParser () # listen :: CGParser a -> CGParser (a, [InstanceGenerator CGEnv]) # pass :: CGParser (a, [InstanceGenerator CGEnv] -> [InstanceGenerator CGEnv]) -> CGParser a #

newtype CGError Source #

Constructors

CGError String

Instances

Eq CGError Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods (==) :: CGError -> CGError -> Bool # (/=) :: CGError -> CGError -> Bool #
Data CGError Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CGError -> c CGError # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CGError # toConstr :: CGError -> Constr # dataTypeOf :: CGError -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CGError) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CGError) # gmapT :: (forall b. Data b => b -> b) -> CGError -> CGError # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CGError -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CGError -> r # gmapQ :: (forall d. Data d => d -> u) -> CGError -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CGError -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CGError -> m CGError # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CGError -> m CGError # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CGError -> m CGError #
Read CGError Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods readsPrec :: Int -> ReadS CGError # readList :: ReadS [CGError] # readPrec :: ReadPrec CGError # readListPrec :: ReadPrec [CGError] #
Show CGError Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods showsPrec :: Int -> CGError -> ShowS # show :: CGError -> String # showList :: [CGError] -> ShowS #
Exception CGError Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods toException :: CGError -> SomeException # fromException :: SomeException -> Maybe CGError # displayException :: CGError -> String #

cgError :: String -> CGParser a Source #

execCGParser :: CGParser () -> CGEnv -> Either SomeException [InstanceGenerator CGEnv] Source #

execIGEnv :: InstanceGenerator CGEnv -> Either String (InstanceGenerator [SourceGenerator]) Source #

substAssembly :: Environment -> ArtifactAssembly -> ArtifactAssembly Source #

toSourceGen :: Environment -> ArtifactSource -> Either String [SourceGenerator] Source #

createAssembledArtifacts :: [InstanceGenerator [SourceGenerator]] -> B9 [AssembledArtifact] Source #

generateSources :: FilePath -> InstanceGenerator [SourceGenerator] -> B9 (InstanceGenerator FilePath) Source #

createTargets :: InstanceGenerator FilePath -> B9 AssembledArtifact Source #

generateUniqueIID :: InstanceId -> B9 InstanceId Source #

generateSourceTo :: FilePath -> SourceGenerator -> B9 () Source #

sgReadSourceFile :: Environment -> SourceFile -> B9 ByteString Source #

sgChangePerm :: FilePath -> SGPerm -> B9 () Source #

data SourceGenerator Source #

Internal data type simplifying the rather complex source generation by bioling down ArtifactSources to a flat list of uniform SourceGenerators.

Constructors

SG Environment SGSource SGPerm FilePath

Instances

Eq SourceGenerator Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods (==) :: SourceGenerator -> SourceGenerator -> Bool # (/=) :: SourceGenerator -> SourceGenerator -> Bool #
Show SourceGenerator Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods showsPrec :: Int -> SourceGenerator -> ShowS # show :: SourceGenerator -> String # showList :: [SourceGenerator] -> ShowS #

sourceGeneratorOutputFile :: SourceGenerator -> FilePath Source #

Return the (internal-)output file of the source file that is generated.

data SGSource Source #

Constructors

SGFiles [SourceFile]
SGContent Content

Instances

Eq SGSource Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods (==) :: SGSource -> SGSource -> Bool # (/=) :: SGSource -> SGSource -> Bool #
Read SGSource Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods readsPrec :: Int -> ReadS SGSource # readList :: ReadS [SGSource] # readPrec :: ReadPrec SGSource # readListPrec :: ReadPrec [SGSource] #
Show SGSource Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods showsPrec :: Int -> SGSource -> ShowS # show :: SGSource -> String # showList :: [SGSource] -> ShowS #

data SGPerm Source #

Constructors

SGSetPerm (Int, Int, Int)
KeepPerm

Instances

Eq SGPerm Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods (==) :: SGPerm -> SGPerm -> Bool # (/=) :: SGPerm -> SGPerm -> Bool #
Data SGPerm Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SGPerm -> c SGPerm # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SGPerm # toConstr :: SGPerm -> Constr # dataTypeOf :: SGPerm -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SGPerm) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SGPerm) # gmapT :: (forall b. Data b => b -> b) -> SGPerm -> SGPerm # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SGPerm -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SGPerm -> r # gmapQ :: (forall d. Data d => d -> u) -> SGPerm -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SGPerm -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SGPerm -> m SGPerm # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SGPerm -> m SGPerm # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SGPerm -> m SGPerm #
Read SGPerm Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods readsPrec :: Int -> ReadS SGPerm # readList :: ReadS [SGPerm] # readPrec :: ReadPrec SGPerm # readListPrec :: ReadPrec [SGPerm] #
Show SGPerm Source #
Instance details Defined in B9.Artifact.Readable.Interpreter Methods showsPrec :: Int -> SGPerm -> ShowS # show :: SGPerm -> String # showList :: [SGPerm] -> ShowS #

sgGetFroms :: SourceGenerator -> [SourceFile] Source #

setSGPerm :: Int -> Int -> Int -> SourceGenerator -> Either String SourceGenerator Source #

setSGFromDirectory :: FilePath -> SourceGenerator -> SourceGenerator Source #

setSGToDirectory :: FilePath -> SourceGenerator -> SourceGenerator Source #

createTarget :: InstanceId -> FilePath -> ArtifactAssembly -> B9 [ArtifactTarget] Source #

Create the actual target, either just a mountpoint, or an ISO or VFAT image.