Safe Haskell	None
Language	Haskell2010

Dojang.App

Description

The application monad for Dojang.

Synopsis

data (MonadFileSystem i, MonadError IOError i, MonadIO i) => App (i :: Type -> Type) v
data AppEnv = AppEnv {
- sourceDirectory :: OsPath
- intermediateDirectory :: OsPath
- manifestFile :: OsPath
- envFile :: OsPath
- dryRun :: Bool
- debug :: Bool
}
data Loc
data LogLevel
type LogSource = Text
data LogStr
currentEnvironment' :: forall (i :: Type -> Type). (MonadFileSystem i, MonadIO i) => App i Environment
doesManifestExist :: forall (i :: Type -> Type). (MonadFileSystem i, MonadIO i) => App i Bool
ensureContext :: forall (i :: Type -> Type). (MonadFileSystem i, MonadIO i) => App i (Context (App i))
ensureRepository :: forall (i :: Type -> Type). (MonadFileSystem i, MonadIO i) => App i Repository
loadManifest :: forall (i :: Type -> Type). (MonadFileSystem i, MonadIO i) => App i (Either Error (Maybe Manifest))
loadRepository :: forall (i :: Type -> Type). (MonadFileSystem i, MonadIO i) => App i (Either Error (Maybe Repository))
lookupEnv' :: (MonadFileSystem i, MonadIO i) => EnvironmentVariable -> i (Maybe OsString)
runAppWithLogging :: (MonadFileSystem i, MonadIO i) => AppEnv -> App i a -> (Loc -> LogSource -> LogLevel -> LogStr -> IO ()) -> i a
runAppWithStderrLogging :: (MonadFileSystem i, MonadIO i) => AppEnv -> App i a -> i a
runAppWithoutLogging :: (MonadFileSystem i, MonadIO i) => AppEnv -> App i a -> i a
saveManifest :: forall (i :: Type -> Type). (MonadFileSystem i, MonadIO i) => Manifest -> App i OsPath

Documentation

data (MonadFileSystem i, MonadError IOError i, MonadIO i) => App (i :: Type -> Type) v Source #

The application monad for Dojang.

Instances

Instances details

(MonadFileSystem i, MonadError IOError i, MonadIO i) => MonadError IOError (App i) Source #
Instance details Defined in Dojang.App Methods throwError :: IOError -> App i a # catchError :: App i a -> (IOError -> App i a) -> App i a #
Monad i => MonadReader AppEnv (App i) Source #
Instance details Defined in Dojang.App Methods ask :: App i AppEnv # local :: (AppEnv -> AppEnv) -> App i a -> App i a # reader :: (AppEnv -> a) -> App i a #
MonadIO i => MonadIO (App i) Source #
Instance details Defined in Dojang.App Methods liftIO :: IO a -> App i a #
Applicative i => Applicative (App i) Source #
Instance details Defined in Dojang.App Methods pure :: a -> App i a # (<>) :: App i (a -> b) -> App i a -> App i b # liftA2 :: (a -> b -> c) -> App i a -> App i b -> App i c # (>) :: App i a -> App i b -> App i b # (<*) :: App i a -> App i b -> App i a #
Functor i => Functor (App i) Source #
Instance details Defined in Dojang.App Methods fmap :: (a -> b) -> App i a -> App i b # (<$) :: a -> App i b -> App i a #
Monad i => Monad (App i) Source #
Instance details Defined in Dojang.App Methods (>>=) :: App i a -> (a -> App i b) -> App i b # (>>) :: App i a -> App i b -> App i b # return :: a -> App i a #
(MonadFileSystem i, MonadIO i) => MonadFileSystem (App i) Source #
Instance details Defined in Dojang.App Methods encodePath :: FilePath -> App i OsPath Source # decodePath :: OsPath -> App i FilePath Source # exists :: OsPath -> App i Bool Source # isFile :: OsPath -> App i Bool Source # isDirectory :: OsPath -> App i Bool Source # isSymlink :: OsPath -> App i Bool Source # readFile :: OsPath -> App i ByteString Source # writeFile :: OsPath -> ByteString -> App i () Source # readSymlinkTarget :: OsPath -> App i OsPath Source # copyFile :: OsPath -> OsPath -> App i () Source # createDirectory :: OsPath -> App i () Source # createDirectories :: OsPath -> App i () Source # removeFile :: OsPath -> App i () Source # removeDirectory :: OsPath -> App i () Source # removeDirectoryRecursively :: OsPath -> App i () Source # listDirectory :: OsPath -> App i [OsPath] Source # listDirectoryRecursively :: OsPath -> [FilePattern] -> App i [(FileType, OsPath)] Source # getFileSize :: OsPath -> App i Integer Source #
(MonadFileSystem i, MonadIO i) => MonadArchitecture (App i) Source #
Instance details Defined in Dojang.App Methods currentArchitecture :: App i Architecture Source #
(MonadFileSystem i, MonadIO i) => MonadEnvironment (App i) Source #
Instance details Defined in Dojang.App Methods currentEnvironment :: App i Environment Source #
(MonadFileSystem i, MonadIO i) => MonadOperatingSystem (App i) Source #
Instance details Defined in Dojang.App Methods currentOperatingSystem :: App i OperatingSystem Source #
MonadIO i => MonadLogger (App i) Source #
Instance details Defined in Dojang.App Methods monadLoggerLog :: ToLogStr msg => Loc -> LogSource -> LogLevel -> msg -> App i () #

data AppEnv Source #

The environment for the application monad.

Constructors

AppEnv

Fields

sourceDirectory :: OsPath
The source directory (i.e., repository).
intermediateDirectory :: OsPath
The intermediate directory which is managed by Dojang. It's normally .dojang in the source directory.
manifestFile :: OsPath
The manifest file.
envFile :: OsPath
The environment file.
dryRun :: Bool
Whether to actually perform actions or just print what would be done.
debug :: Bool
Whether debug logging is enabled.

Instances

Instances details

Show AppEnv Source #
Instance details Defined in Dojang.App Methods showsPrec :: Int -> AppEnv -> ShowS # show :: AppEnv -> String # showList :: [AppEnv] -> ShowS #
Monad i => MonadReader AppEnv (App i) Source #
Instance details Defined in Dojang.App Methods ask :: App i AppEnv # local :: (AppEnv -> AppEnv) -> App i a -> App i a # reader :: (AppEnv -> a) -> App i a #

data Loc #

Instances

Instances details

Data Loc

Instance details

Defined in Language.Haskell.TH.Syntax

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Loc -> c Loc #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Loc #

toConstr :: Loc -> Constr #

dataTypeOf :: Loc -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Loc) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Loc) #

gmapT :: (forall b. Data b => b -> b) -> Loc -> Loc #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Loc -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Loc -> r #

gmapQ :: (forall d. Data d => d -> u) -> Loc -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Loc -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Loc -> m Loc #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Loc -> m Loc #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Loc -> m Loc #

Generic Loc

Instance details

Defined in Language.Haskell.TH.Syntax

Associated Types

type Rep Loc

Instance details

Defined in Language.Haskell.TH.Syntax

type Rep Loc = D1 ('MetaData "Loc" "Language.Haskell.TH.Syntax" "template-haskell" 'False) (C1 ('MetaCons "Loc" 'PrefixI 'True) ((S1 ('MetaSel ('Just "loc_filename") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Just "loc_package") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)) :*: (S1 ('MetaSel ('Just "loc_module") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: (S1 ('MetaSel ('Just "loc_start") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CharPos) :*: S1 ('MetaSel ('Just "loc_end") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CharPos)))))

Methods

from :: Loc -> Rep Loc x #

to :: Rep Loc x -> Loc #

Show Loc

Instance details

Defined in Language.Haskell.TH.Syntax

Methods

showsPrec :: Int -> Loc -> ShowS #

show :: Loc -> String #

showList :: [Loc] -> ShowS #

Eq Loc

Instance details

Defined in Language.Haskell.TH.Syntax

Methods

(==) :: Loc -> Loc -> Bool #

(/=) :: Loc -> Loc -> Bool #

Ord Loc

Instance details

Defined in Language.Haskell.TH.Syntax

Methods

compare :: Loc -> Loc -> Ordering #

(<) :: Loc -> Loc -> Bool #

(<=) :: Loc -> Loc -> Bool #

(>) :: Loc -> Loc -> Bool #

(>=) :: Loc -> Loc -> Bool #

max :: Loc -> Loc -> Loc #

min :: Loc -> Loc -> Loc #

type Rep Loc

Instance details

Defined in Language.Haskell.TH.Syntax

type Rep Loc = D1 ('MetaData "Loc" "Language.Haskell.TH.Syntax" "template-haskell" 'False) (C1 ('MetaCons "Loc" 'PrefixI 'True) ((S1 ('MetaSel ('Just "loc_filename") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Just "loc_package") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)) :*: (S1 ('MetaSel ('Just "loc_module") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: (S1 ('MetaSel ('Just "loc_start") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CharPos) :*: S1 ('MetaSel ('Just "loc_end") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CharPos)))))

data LogLevel #

Instances

Instances details

Read LogLevel
Instance details Defined in Control.Monad.Logger Methods readsPrec :: Int -> ReadS LogLevel # readList :: ReadS [LogLevel] # readPrec :: ReadPrec LogLevel # readListPrec :: ReadPrec [LogLevel] #
Show LogLevel
Instance details Defined in Control.Monad.Logger Methods showsPrec :: Int -> LogLevel -> ShowS # show :: LogLevel -> String # showList :: [LogLevel] -> ShowS #
Eq LogLevel
Instance details Defined in Control.Monad.Logger Methods (==) :: LogLevel -> LogLevel -> Bool # (/=) :: LogLevel -> LogLevel -> Bool #
Ord LogLevel
Instance details Defined in Control.Monad.Logger Methods compare :: LogLevel -> LogLevel -> Ordering # (<) :: LogLevel -> LogLevel -> Bool # (<=) :: LogLevel -> LogLevel -> Bool # (>) :: LogLevel -> LogLevel -> Bool # (>=) :: LogLevel -> LogLevel -> Bool # max :: LogLevel -> LogLevel -> LogLevel # min :: LogLevel -> LogLevel -> LogLevel #
Lift LogLevel
Instance details Defined in Control.Monad.Logger Methods lift :: Quote m => LogLevel -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => LogLevel -> Code m LogLevel #

type LogSource = Text #

data LogStr #

Log message builder. Use (<>) to append two LogStr in O(1).

Instances

Instances details

IsString LogStr
Instance details Defined in System.Log.FastLogger.LogStr Methods fromString :: String -> LogStr #
Monoid LogStr
Instance details Defined in System.Log.FastLogger.LogStr Methods mempty :: LogStr # mappend :: LogStr -> LogStr -> LogStr # mconcat :: [LogStr] -> LogStr #
Semigroup LogStr
Instance details Defined in System.Log.FastLogger.LogStr Methods (<>) :: LogStr -> LogStr -> LogStr # sconcat :: NonEmpty LogStr -> LogStr # stimes :: Integral b => b -> LogStr -> LogStr #
Show LogStr
Instance details Defined in System.Log.FastLogger.LogStr Methods showsPrec :: Int -> LogStr -> ShowS # show :: LogStr -> String # showList :: [LogStr] -> ShowS #
ToLogStr LogStr
Instance details Defined in System.Log.FastLogger.LogStr Methods toLogStr :: LogStr -> LogStr #
Eq LogStr
Instance details Defined in System.Log.FastLogger.LogStr Methods (==) :: LogStr -> LogStr -> Bool # (/=) :: LogStr -> LogStr -> Bool #

currentEnvironment' :: forall (i :: Type -> Type). (MonadFileSystem i, MonadIO i) => App i Environment Source #

doesManifestExist :: forall (i :: Type -> Type). (MonadFileSystem i, MonadIO i) => App i Bool Source #

ensureContext :: forall (i :: Type -> Type). (MonadFileSystem i, MonadIO i) => App i (Context (App i)) Source #

ensureRepository :: forall (i :: Type -> Type). (MonadFileSystem i, MonadIO i) => App i Repository Source #

loadManifest :: forall (i :: Type -> Type). (MonadFileSystem i, MonadIO i) => App i (Either Error (Maybe Manifest)) Source #

loadRepository :: forall (i :: Type -> Type). (MonadFileSystem i, MonadIO i) => App i (Either Error (Maybe Repository)) Source #

lookupEnv' :: (MonadFileSystem i, MonadIO i) => EnvironmentVariable -> i (Maybe OsString) Source #

runAppWithLogging :: (MonadFileSystem i, MonadIO i) => AppEnv -> App i a -> (Loc -> LogSource -> LogLevel -> LogStr -> IO ()) -> i a Source #

Run the application monad with logging handled by the given function.

runAppWithStderrLogging :: (MonadFileSystem i, MonadIO i) => AppEnv -> App i a -> i a Source #

Run the application monad with logging to stderr.

runAppWithoutLogging :: (MonadFileSystem i, MonadIO i) => AppEnv -> App i a -> i a Source #

saveManifest :: forall (i :: Type -> Type). (MonadFileSystem i, MonadIO i) => Manifest -> App i OsPath Source #