Safe Haskell	None
Language	GHC2021

Shrun.Configuration.Data.Graph

Contents

Args
Graph
- Creation
- Functions
  - Context

Synopsis

data EdgeArgs
- = EdgeArgsSequential EdgeSequential
- | EdgeArgsList Edges
newtype Edges = MkEdges {
- unEdges :: Seq Edge
}
sortEdges :: Edges -> Edges
type Edge = (CommandIndex, CommandIndex, EdgeLabel)
data EdgeSequential
- = EdgeSequentialAnd
- | EdgeSequentialOr
- | EdgeSequentialAny
data EdgeLabel
- = EdgeAnd
- | EdgeOr
- | EdgeAny
displayEdgeLabel :: IsString s => EdgeLabel -> s
data CommandGraph = MkCommandGraph {
- graph :: Gr CommandP1 EdgeLabel
- roots :: NESeq Vertex
}
type Vertex = Int
type LVertex a = (Vertex, a)
mkGraph :: (HasCallStack, MonadThrow m) => EdgeArgs -> NESeq CommandP1 -> m CommandGraph
mkEdgelessGraph :: NESeq CommandP1 -> CommandGraph
labVertices :: CommandGraph -> [LVertex CommandP1]
labVertex :: (HasCallStack, MonadEvaluate m) => CommandGraph -> Vertex -> m (LVertex CommandP1)
labInVertices :: CommandGraph -> Vertex -> [(Vertex, EdgeLabel)]
outVertices :: CommandGraph -> Vertex -> [Vertex]
vertices :: CommandGraph -> [Vertex]
context :: (HasCallStack, MonadEvaluate m) => CommandGraph -> Vertex -> m (Context CommandP1 EdgeLabel)
ctxLabVertex :: Context a b -> LVertex a
ctxOutVertices :: Context a b -> [Vertex]

Args

data EdgeArgs Source #

CLI command graph. The default instance is an "edgeless graph", in the sense that all commands are root nodes without any edges, hence normal behavior.

Constructors

EdgeArgsSequential EdgeSequential	Sequential i.e. a linear graph of success edges.
EdgeArgsList Edges	Explicit edges.

Instances

Instances details

IsList EdgeArgs Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

Associated Types

type Item EdgeArgs
Instance details Defined in Shrun.Configuration.Data.Graph type Item EdgeArgs = Edge

Methods

fromList :: [Item EdgeArgs] -> EdgeArgs #

fromListN :: Int -> [Item EdgeArgs] -> EdgeArgs #

toList :: EdgeArgs -> [Item EdgeArgs] #

Show EdgeArgs Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

Methods

showsPrec :: Int -> EdgeArgs -> ShowS #

show :: EdgeArgs -> String #

showList :: [EdgeArgs] -> ShowS #

Eq EdgeArgs Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

Methods

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

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

Default EdgeArgs Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

Methods

def :: EdgeArgs Source #

type Item EdgeArgs Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

type Item EdgeArgs = Edge

newtype Edges Source #

Dependency edges are supplied by the user on the CLI.

Constructors

MkEdges
Fields unEdges :: Seq Edge

Instances

Instances details

Monoid Edges Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

Methods

mempty :: Edges #

mappend :: Edges -> Edges -> Edges #

mconcat :: [Edges] -> Edges #

Semigroup Edges Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

Methods

(<>) :: Edges -> Edges -> Edges #

sconcat :: NonEmpty Edges -> Edges #

stimes :: Integral b => b -> Edges -> Edges #

IsList Edges Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

Associated Types

type Item Edges
Instance details Defined in Shrun.Configuration.Data.Graph type Item Edges = Item (Seq Edge)

Methods

fromList :: [Item Edges] -> Edges #

fromListN :: Int -> [Item Edges] -> Edges #

toList :: Edges -> [Item Edges] #

Show Edges Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

Methods

showsPrec :: Int -> Edges -> ShowS #

show :: Edges -> String #

showList :: [Edges] -> ShowS #

Eq Edges Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

Methods

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

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

(k ~ An_Iso, a ~ Seq Edge, b ~ Seq Edge) => LabelOptic "unEdges" k Edges Edges a b Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

Methods

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

type Item Edges Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

type Item Edges = Item (Seq Edge)

sortEdges :: Edges -> Edges Source #

type Edge = (CommandIndex, CommandIndex, EdgeLabel) Source #

An edge between two indices.

data EdgeSequential Source #

Sequential options.

Constructors

EdgeSequentialAnd	Sequential `and`-edges.
EdgeSequentialOr	Sequential `or`-edges.
EdgeSequentialAny	Sequential `any`-edges.

Instances

Instances details

NFData EdgeSequential Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

Methods

rnf :: EdgeSequential -> () #

Bounded EdgeSequential Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

Methods

minBound :: EdgeSequential #

maxBound :: EdgeSequential #

Enum EdgeSequential Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

Methods

succ :: EdgeSequential -> EdgeSequential #

pred :: EdgeSequential -> EdgeSequential #

toEnum :: Int -> EdgeSequential #

fromEnum :: EdgeSequential -> Int #

enumFrom :: EdgeSequential -> [EdgeSequential] #

enumFromThen :: EdgeSequential -> EdgeSequential -> [EdgeSequential] #

enumFromTo :: EdgeSequential -> EdgeSequential -> [EdgeSequential] #

enumFromThenTo :: EdgeSequential -> EdgeSequential -> EdgeSequential -> [EdgeSequential] #

Generic EdgeSequential Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

Associated Types

type Rep EdgeSequential

Instance details

Defined in Shrun.Configuration.Data.Graph

type Rep EdgeSequential = D1 ('MetaData "EdgeSequential" "Shrun.Configuration.Data.Graph" "shrun-0.10-inplace" 'False) (C1 ('MetaCons "EdgeSequentialAnd" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "EdgeSequentialOr" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "EdgeSequentialAny" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: EdgeSequential -> Rep EdgeSequential x #

to :: Rep EdgeSequential x -> EdgeSequential #

Show EdgeSequential Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

Methods

showsPrec :: Int -> EdgeSequential -> ShowS #

show :: EdgeSequential -> String #

showList :: [EdgeSequential] -> ShowS #

Eq EdgeSequential Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

Methods

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

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

Ord EdgeSequential Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

Methods

compare :: EdgeSequential -> EdgeSequential -> Ordering #

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

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

(>) :: EdgeSequential -> EdgeSequential -> Bool #

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

max :: EdgeSequential -> EdgeSequential -> EdgeSequential #

min :: EdgeSequential -> EdgeSequential -> EdgeSequential #

type Rep EdgeSequential Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

type Rep EdgeSequential = D1 ('MetaData "EdgeSequential" "Shrun.Configuration.Data.Graph" "shrun-0.10-inplace" 'False) (C1 ('MetaCons "EdgeSequentialAnd" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "EdgeSequentialOr" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "EdgeSequentialAny" 'PrefixI 'False) (U1 :: Type -> Type)))

data EdgeLabel Source #

Types of edges.

Constructors

EdgeAnd	cmd1 & cmd2 runs cmd2 iff cmd1 succeeds.
EdgeOr	cmd1 \| cmd2 runs cmd2 iff cmd1 fails.
EdgeAny	cmd1 ; cmd2 runs cmd2 iff cmd1 finishes with any status.

Instances

Instances details

NFData EdgeLabel Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

Methods

rnf :: EdgeLabel -> () #

Bounded EdgeLabel Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

Methods

minBound :: EdgeLabel #

maxBound :: EdgeLabel #

Enum EdgeLabel Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

Methods

succ :: EdgeLabel -> EdgeLabel #

pred :: EdgeLabel -> EdgeLabel #

toEnum :: Int -> EdgeLabel #

fromEnum :: EdgeLabel -> Int #

enumFrom :: EdgeLabel -> [EdgeLabel] #

enumFromThen :: EdgeLabel -> EdgeLabel -> [EdgeLabel] #

enumFromTo :: EdgeLabel -> EdgeLabel -> [EdgeLabel] #

enumFromThenTo :: EdgeLabel -> EdgeLabel -> EdgeLabel -> [EdgeLabel] #

Generic EdgeLabel Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

Associated Types

type Rep EdgeLabel
Instance details Defined in Shrun.Configuration.Data.Graph type Rep EdgeLabel = D1 ('MetaData "EdgeLabel" "Shrun.Configuration.Data.Graph" "shrun-0.10-inplace" 'False) (C1 ('MetaCons "EdgeAnd" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "EdgeOr" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "EdgeAny" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: EdgeLabel -> Rep EdgeLabel x #

to :: Rep EdgeLabel x -> EdgeLabel #

Show EdgeLabel Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

Methods

showsPrec :: Int -> EdgeLabel -> ShowS #

show :: EdgeLabel -> String #

showList :: [EdgeLabel] -> ShowS #

Eq EdgeLabel Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

Methods

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

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

Ord EdgeLabel Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

Methods

compare :: EdgeLabel -> EdgeLabel -> Ordering #

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

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

(>) :: EdgeLabel -> EdgeLabel -> Bool #

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

max :: EdgeLabel -> EdgeLabel -> EdgeLabel #

min :: EdgeLabel -> EdgeLabel -> EdgeLabel #

Hashable EdgeLabel Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

Methods

hashWithSalt :: Int -> EdgeLabel -> Int Source #

hash :: EdgeLabel -> Int Source #

Pretty EdgeLabel Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

Methods

pretty :: EdgeLabel -> Doc ann Source #

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

type Rep EdgeLabel Source #

Instance details

Defined in Shrun.Configuration.Data.Graph

type Rep EdgeLabel = D1 ('MetaData "EdgeLabel" "Shrun.Configuration.Data.Graph" "shrun-0.10-inplace" 'False) (C1 ('MetaCons "EdgeAnd" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "EdgeOr" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "EdgeAny" 'PrefixI 'False) (U1 :: Type -> Type)))

displayEdgeLabel :: IsString s => EdgeLabel -> s Source #

Graph

data CommandGraph Source #

Command dependency graph. Morally, Vertex == CommandIndex.

Constructors

MkCommandGraph
Fields graph :: Gr CommandP1 EdgeLabel Underlying graph. roots :: NESeq Vertex Root commands i.e. have no dependencies.

Instances

Instances details

Show CommandGraph Source #
Instance details Defined in Shrun.Configuration.Data.Graph Methods showsPrec :: Int -> CommandGraph -> ShowS # show :: CommandGraph -> String # showList :: [CommandGraph] -> ShowS #
Eq CommandGraph Source #
Instance details Defined in Shrun.Configuration.Data.Graph Methods (==) :: CommandGraph -> CommandGraph -> Bool # (/=) :: CommandGraph -> CommandGraph -> Bool #
Pretty CommandGraph Source #
Instance details Defined in Shrun.Configuration.Data.Graph Methods pretty :: CommandGraph -> Doc ann Source # prettyList :: [CommandGraph] -> Doc ann Source #
(k ~ A_Lens, a ~ Gr CommandP1 EdgeLabel, b ~ Gr CommandP1 EdgeLabel) => LabelOptic "graph" k CommandGraph CommandGraph a b Source #
Instance details Defined in Shrun.Configuration.Data.Graph Methods labelOptic :: Optic k NoIx CommandGraph CommandGraph a b Source #
(k ~ A_Lens, a ~ NESeq Vertex, b ~ NESeq Vertex) => LabelOptic "roots" k CommandGraph CommandGraph a b Source #
Instance details Defined in Shrun.Configuration.Data.Graph Methods labelOptic :: Optic k NoIx CommandGraph CommandGraph a b Source #

type Vertex = Int Source #

Type for Command graph vertex, for usage with fgl.

type LVertex a = (Vertex, a) Source #

Labeled Vertex.

Creation

mkGraph :: (HasCallStack, MonadThrow m) => EdgeArgs -> NESeq CommandP1 -> m CommandGraph Source #

Creates a command dependency graph from list of dependencies and typed commands.

mkEdgelessGraph :: NESeq CommandP1 -> CommandGraph Source #

Creates a trivial command dep graph where each command is a disconnected vertex, hence root. This exists to avoid the monad in mkGraph, as some uses want purity (defaultConfig...). We should have mkGraph mempty == mkEdgelessGraph.