Safe Haskell	None
Language	GHC2021

Shrun.Command.Types

Contents

Command
- Index
Order
Status
- Map
Misc

Description

Provides the Command wrapper for commands.

Synopsis

data CommandP (p :: CommandPhase) = MkCommandP {
- index :: CommandIndex
- key :: Maybe Text
- command :: Text
}
type CommandP1 = CommandP 'CommandPhase1
type CommandP2 = CommandP 'CommandPhase2
commandToProcess :: CommandP1 -> Maybe Text -> CreateProcess
data CommandIndex
fromPositive :: Positive Int -> CommandIndex
unsafeFromInt :: HasCallStack => Int -> CommandIndex
toVertex :: CommandIndex -> Vertex
fromVertex :: HasCallStack => Vertex -> CommandIndex
succ :: CommandIndex -> CommandIndex
addNN :: CommandIndex -> NonNegative Int -> CommandIndex
range :: CommandIndex -> CommandIndex -> Either String (CommandIndex, NESeq CommandIndex)
joinRange :: (a, NESeq a) -> NESeq a
newtype CommandOrd (p :: CommandPhase) = MkCommandOrd (CommandP p)
data CommandStatus
- = CommandSuccess
- | CommandFailure
- | CommandRunning (Maybe Pid, [Pid])
- | CommandWaiting
newtype CommandStatusMapP (p :: CommandStatusMapIndex) = MkCommandStatusMapP {
- unCommandStatusMap :: CommandStatusMapIndexF p
}
type TCommandStatusMap = CommandStatusMapP 'CommandStatusMapStm
type CommandStatusMap = CommandStatusMapP 'CommandStatusMapPure
readCommandStatus :: (HasCallStack, MonadAtomic m) => TCommandStatusMap -> m CommandStatusMap
data CommandPhase
- = CommandPhase1
- | CommandPhase2
type Vertex = Int
type LVertex a = (Vertex, a)

Command

data CommandP (p :: CommandPhase) Source #

Wrapper for shell commands. Whenever the CommandIndex order is important, see CommandOrd.

Constructors

MkCommandP
Fields index :: CommandIndex NonNegative index for the command. key :: Maybe Text The key name for the command, for display purposes. command :: Text The shell command to run.

Instances

Instances details

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "command" k (CommandP p) (CommandP p) a b Source #

Instance details

Defined in Shrun.Command.Types

Methods

labelOptic :: Optic k NoIx (CommandP p) (CommandP p) a b Source #

(k ~ A_Lens, a ~ CommandIndex, b ~ CommandIndex) => LabelOptic "index" k (CommandP p) (CommandP p) a b Source #

Instance details

Defined in Shrun.Command.Types

Methods

labelOptic :: Optic k NoIx (CommandP p) (CommandP p) a b Source #

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "key" k (CommandP p) (CommandP p) a b Source #

Instance details

Defined in Shrun.Command.Types

Methods

labelOptic :: Optic k NoIx (CommandP p) (CommandP p) a b Source #

NFData (CommandP p) Source #

Instance details

Defined in Shrun.Command.Types

Methods

rnf :: CommandP p -> () #

Generic (CommandP p) Source #

Instance details

Defined in Shrun.Command.Types

Associated Types

type Rep (CommandP p)

Instance details

Defined in Shrun.Command.Types

type Rep (CommandP p) = D1 ('MetaData "CommandP" "Shrun.Command.Types" "shrun-0.10-inplace" 'False) (C1 ('MetaCons "MkCommandP" 'PrefixI 'True) (S1 ('MetaSel ('Just "index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CommandIndex) :*: (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "command") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

Methods

from :: CommandP p -> Rep (CommandP p) x #

to :: Rep (CommandP p) x -> CommandP p #

Show (CommandP p) Source #

Instance details

Defined in Shrun.Command.Types

Methods

showsPrec :: Int -> CommandP p -> ShowS #

show :: CommandP p -> String #

showList :: [CommandP p] -> ShowS #

Eq (CommandP p) Source #

Instance details

Defined in Shrun.Command.Types

Methods

(==) :: CommandP p -> CommandP p -> Bool #

(/=) :: CommandP p -> CommandP p -> Bool #

Hashable (CommandP p) Source #

Instance details

Defined in Shrun.Command.Types

Methods

hashWithSalt :: Int -> CommandP p -> Int Source #

hash :: CommandP p -> Int Source #

type Rep (CommandP p) Source #

Instance details

Defined in Shrun.Command.Types

type Rep (CommandP p) = D1 ('MetaData "CommandP" "Shrun.Command.Types" "shrun-0.10-inplace" 'False) (C1 ('MetaCons "MkCommandP" 'PrefixI 'True) (S1 ('MetaSel ('Just "index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CommandIndex) :*: (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "command") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

type CommandP1 = CommandP 'CommandPhase1 Source #

Phase1 commands.

type CommandP2 = CommandP 'CommandPhase2 Source #

Phase2 commands.

commandToProcess :: CommandP1 -> Maybe Text -> CreateProcess Source #

Index

data CommandIndex Source #

Numeric index for each command, for handling command graph dependencies. Conversion to/from Vertex should use indexToVertex and indexFromVertex, as CommandIndex is 1-based whereas Vertex is 0-based.

Instances

Instances details

ASemigroup CommandIndex Source #

Instance details

Defined in Shrun.Command.Types.Internal

Methods

(.+.) :: CommandIndex -> CommandIndex -> CommandIndex Source #

MMonoid CommandIndex Source #

Instance details

Defined in Shrun.Command.Types.Internal

Methods

one :: CommandIndex Source #

MSemigroup CommandIndex Source #

Instance details

Defined in Shrun.Command.Types.Internal

Methods

(.*.) :: CommandIndex -> CommandIndex -> CommandIndex Source #

NFData CommandIndex Source #

Instance details

Defined in Shrun.Command.Types.Internal

Methods

rnf :: CommandIndex -> () #

Enum CommandIndex Source #

Instance details

Defined in Shrun.Command.Types.Internal

Methods

succ :: CommandIndex -> CommandIndex #

pred :: CommandIndex -> CommandIndex #

toEnum :: Int -> CommandIndex #

fromEnum :: CommandIndex -> Int #

enumFrom :: CommandIndex -> [CommandIndex] #

enumFromThen :: CommandIndex -> CommandIndex -> [CommandIndex] #

enumFromTo :: CommandIndex -> CommandIndex -> [CommandIndex] #

enumFromThenTo :: CommandIndex -> CommandIndex -> CommandIndex -> [CommandIndex] #

Generic CommandIndex Source #

Instance details

Defined in Shrun.Command.Types.Internal

Associated Types

type Rep CommandIndex
Instance details Defined in Shrun.Command.Types.Internal type Rep CommandIndex = D1 ('MetaData "CommandIndex" "Shrun.Command.Types.Internal" "shrun-0.10-inplace" 'True) (C1 ('MetaCons "MkCommandIndex" 'PrefixI 'True) (S1 ('MetaSel ('Just "unCommandIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Positive Int))))

Methods

from :: CommandIndex -> Rep CommandIndex x #

to :: Rep CommandIndex x -> CommandIndex #

Show CommandIndex Source #

Instance details

Defined in Shrun.Command.Types.Internal

Methods

showsPrec :: Int -> CommandIndex -> ShowS #

show :: CommandIndex -> String #

showList :: [CommandIndex] -> ShowS #

Eq CommandIndex Source #

Instance details

Defined in Shrun.Command.Types.Internal

Methods

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

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

Ord CommandIndex Source #

Instance details

Defined in Shrun.Command.Types.Internal

Methods

compare :: CommandIndex -> CommandIndex -> Ordering #

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

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

(>) :: CommandIndex -> CommandIndex -> Bool #

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

max :: CommandIndex -> CommandIndex -> CommandIndex #

min :: CommandIndex -> CommandIndex -> CommandIndex #

Hashable CommandIndex Source #

Instance details

Defined in Shrun.Command.Types.Internal

Methods

hashWithSalt :: Int -> CommandIndex -> Int Source #

hash :: CommandIndex -> Int Source #

Pretty CommandIndex Source #

Instance details

Defined in Shrun.Command.Types.Internal

Methods

pretty :: CommandIndex -> Doc ann Source #

prettyList :: [CommandIndex] -> Doc ann Source #

(k ~ An_Iso, a ~ Positive Int, b ~ Positive Int) => LabelOptic "unCommandIndex" k CommandIndex CommandIndex a b Source #

Instance details

Defined in Shrun.Command.Types.Internal

Methods

labelOptic :: Optic k NoIx CommandIndex CommandIndex a b Source #

type Rep CommandIndex Source #

Instance details

Defined in Shrun.Command.Types.Internal

type Rep CommandIndex = D1 ('MetaData "CommandIndex" "Shrun.Command.Types.Internal" "shrun-0.10-inplace" 'True) (C1 ('MetaCons "MkCommandIndex" 'PrefixI 'True) (S1 ('MetaSel ('Just "unCommandIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Positive Int))))

fromPositive :: Positive Int -> CommandIndex Source #

unsafeFromInt :: HasCallStack => Int -> CommandIndex Source #

toVertex :: CommandIndex -> Vertex Source #

Conversion to Vertex.

fromVertex :: HasCallStack => Vertex -> CommandIndex Source #

Conversion from Vertex.

succ :: CommandIndex -> CommandIndex Source #

addNN :: CommandIndex -> NonNegative Int -> CommandIndex Source #

range :: CommandIndex -> CommandIndex -> Either String (CommandIndex, NESeq CommandIndex) Source #

Given m, n s.t. m < n, returns [m .. n]. Notice this is strictly increasing.

joinRange :: (a, NESeq a) -> NESeq a Source #

Collapses range output back into a single NESeq.

Order

newtype CommandOrd (p :: CommandPhase) Source #

Wraps CommandP for the purposes of ordering by index.

Constructors

MkCommandOrd (CommandP p)

Instances

Instances details

(k ~ An_Iso, a ~ CommandP p, b ~ CommandP p) => LabelOptic "unCommandOrd" k (CommandOrd p) (CommandOrd p) a b Source #

Instance details

Defined in Shrun.Command.Types

Methods

labelOptic :: Optic k NoIx (CommandOrd p) (CommandOrd p) a b Source #

Generic (CommandOrd p) Source #

Instance details

Defined in Shrun.Command.Types

Associated Types

type Rep (CommandOrd p)
Instance details Defined in Shrun.Command.Types type Rep (CommandOrd p) = Rep (CommandP p)

Methods

from :: CommandOrd p -> Rep (CommandOrd p) x #

to :: Rep (CommandOrd p) x -> CommandOrd p #

Eq (CommandOrd p) Source #

Instance details

Defined in Shrun.Command.Types

Methods

(==) :: CommandOrd p -> CommandOrd p -> Bool #

(/=) :: CommandOrd p -> CommandOrd p -> Bool #

Ord (CommandOrd p) Source #

Instance details

Defined in Shrun.Command.Types

Methods

compare :: CommandOrd p -> CommandOrd p -> Ordering #

(<) :: CommandOrd p -> CommandOrd p -> Bool #

(<=) :: CommandOrd p -> CommandOrd p -> Bool #

(>) :: CommandOrd p -> CommandOrd p -> Bool #

(>=) :: CommandOrd p -> CommandOrd p -> Bool #

max :: CommandOrd p -> CommandOrd p -> CommandOrd p #

min :: CommandOrd p -> CommandOrd p -> CommandOrd p #

Hashable (CommandOrd p) Source #

Instance details

Defined in Shrun.Command.Types

Methods

hashWithSalt :: Int -> CommandOrd p -> Int Source #

hash :: CommandOrd p -> Int Source #

type Rep (CommandOrd p) Source #

Instance details

Defined in Shrun.Command.Types

type Rep (CommandOrd p) = Rep (CommandP p)

Status

data CommandStatus Source #

Represents a Command's status.

Constructors

CommandSuccess	The command ran successfully.
CommandFailure	The command failed.
CommandRunning (Maybe Pid, [Pid])	The command is running. It is associated to its own PID and child PIDs, for later cleanup.
CommandWaiting	The command is waiting to run.

Map

newtype CommandStatusMapP (p :: CommandStatusMapIndex) Source #

Command status map.

Constructors

MkCommandStatusMapP
Fields unCommandStatusMap :: CommandStatusMapIndexF p

Instances

Instances details

(k ~ An_Iso, a ~ CommandStatusMapIndexF p, b ~ CommandStatusMapIndexF p) => LabelOptic "unCommandStatusMap" k (CommandStatusMapP p) (CommandStatusMapP p) a b Source #
Instance details Defined in Shrun.Command.Types Methods labelOptic :: Optic k NoIx (CommandStatusMapP p) (CommandStatusMapP p) a b Source #

type TCommandStatusMap = CommandStatusMapP 'CommandStatusMapStm Source #

Normal status map, mutable in stm.

type CommandStatusMap = CommandStatusMapP 'CommandStatusMapPure Source #

Pure status map i.e. after the stm map has been read.

readCommandStatus :: (HasCallStack, MonadAtomic m) => TCommandStatusMap -> m CommandStatusMap Source #

Reads a map of TVars into a pure map via a single STM transaction.

Misc

data CommandPhase Source #

Constructors

CommandPhase1
CommandPhase2

type Vertex = Int Source #

Type for Command graph vertex, for usage with fgl.

type LVertex a = (Vertex, a) Source #

Labeled Vertex.