Modulesmall-steps-1.1.4.0

Control.State.Transition

Synopsis

value ?!
value ?!:
value applyRuleInternal
value applySTSInternal
value applySTSOpts
value applySTSOptsEither
value applySTSOptsResult
value failBecause
value failOnJust
value failOnNonEmpty
value failOnNonEmptyMap
value failOnNonEmptySet
value failureOnJust
value failureOnNonEmpty
value failureOnNonEmptyMap
value failureOnNonEmptySet
value globalAssertionPolicy
value ifFailureFree
value judgmentContext
value labeled
value labeledPred
value labeledPredE
value liftSTS
value mapEventReturn
value reapplySTS
value runRule
value sfor_
value tellEvent
value tellEvents
value trans
value validate
value validateTrans
value validateTransLabeled
value whenFailureFree
value whenFailureFreeDefault
value applySTS
value applySTSIndifferently
data ApplySTSOpts
data Assertion
data AssertionException
data AssertionPolicy
data AssertionViolation
family BaseM
class Embed
family Environment
family Event
data EventPolicy
family EventReturnType
class EventReturnTypeRep
newtype IRC
type InitialRule
type Label
family PredicateFailure
type Rule
family RuleContext
type RuleInterpreter
data RuleType
class RuleTypeRep
class STS
type STSInterpreter
data STSResult
data STUB
family Signal
data SingEP
family State
newtype TRC
newtype Threshold
type TransitionRule
data ValidationPolicy

Packagesmall-steps-1.1.4.0
Exports69
LicenceApache-2.0

value(?!) :: Bool -> PredicateFailure sts -> Rule sts ctx ()

value(?!:) :: Either e () -> (e -> PredicateFailure sts) -> Rule sts ctx ()

valueapplyRuleInternal

:: (STS s, RuleTypeRep rtype, m ~ BaseM s)
=> IsFailing
-> SingEP ep
-> ValidationPolicy
-> IsFailing -> STSInterpreter ep
-> RuleContext rtype s
-> Rule s rtype result
-> m (EventReturnType ep s (result, [PredicateFailure s]))

valueapplySTSInternal

:: (STS s, RuleTypeRep rtype, m ~ BaseM s)
=> SingEP ep
-> AssertionPolicy
-> RuleInterpreter ep
-> RuleContext rtype s
-> ExceptT (AssertionViolation s) m (EventReturnType ep s (State s, [PredicateFailure s]))

valueapplySTSOpts

:: (STS s, RuleTypeRep rtype, m ~ BaseM s)
=> ApplySTSOpts ep
-> RuleContext rtype s
-> m (EventReturnType ep s (State s, [PredicateFailure s]))

valueapplySTSOptsEither

:: (STS s, RuleTypeRep rtype, m ~ BaseM s)
=> ApplySTSOpts ep
-> RuleContext rtype s
-> m (Either (NonEmpty (PredicateFailure s)) (EventReturnType ep s (State s)))

valueapplySTSOptsResult

:: (STS s, RuleTypeRep rtype, m ~ BaseM s)
=> ApplySTSOpts ep
-> RuleContext rtype s
-> m (STSResult s)

valuefailBecause :: PredicateFailure sts -> Rule sts ctx ()

valuefailOnJust :: Maybe a -> (a -> PredicateFailure sts) -> Rule sts ctx ()

valuefailOnNonEmpty

:: Foldable f
=> f a
-> NonEmpty a -> PredicateFailure sts
-> Rule sts ctx ()

valuefailOnNonEmptyMap

:: Map k v
-> NonEmptyMap k v -> PredicateFailure sts
-> Rule sts ctx ()

valuefailOnNonEmptySet

:: (Foldable f, Ord a)
=> f a
-> NonEmptySet a -> PredicateFailure sts
-> Rule sts ctx ()

valuefailureOnJust :: Maybe a -> (a -> e) -> Validation (NonEmpty e) ()

valuefailureOnNonEmpty

:: Foldable f
=> f a
-> NonEmpty a -> e
-> Validation (NonEmpty e) ()

valuefailureOnNonEmptyMap

:: Map k v
-> NonEmptyMap k v -> e
-> Validation (NonEmpty e) ()

valuefailureOnNonEmptySet

:: (Foldable f, Ord a)
=> f a
-> NonEmptySet a -> e
-> Validation (NonEmpty e) ()

valueglobalAssertionPolicy :: AssertionPolicy

valueifFailureFree :: Rule sts rtype a -> Rule sts rtype a -> Rule sts rtype a

valuejudgmentContext :: Rule sts rtype (RuleContext rtype sts)

valuelabeled :: NonEmpty Label -> Rule sts ctx () -> Rule sts ctx ()

valuelabeledPred

:: NonEmpty Label
-> Bool
-> PredicateFailure sts
-> Rule sts ctx ()

valuelabeledPredE

:: NonEmpty Label
-> Either e ()
-> e -> PredicateFailure sts
-> Rule sts ctx ()

valueliftSTS :: STS sts => BaseM sts a -> Rule sts ctx a

valuemapEventReturn

:: EventReturnTypeRep ep
=> a -> b
-> EventReturnType ep sts a
-> EventReturnType ep sts b

valuereapplySTS

:: (STS s, RuleTypeRep rtype, m ~ BaseM s)
=> RuleContext rtype s
-> m (State s)

valuerunRule

:: (STS s, RuleTypeRep rtype)
=> RuleContext rtype s
-> Rule s rtype result
-> BaseM s (result, [PredicateFailure s])

valuesfor_ :: (Foldable t, Applicative f) => t a -> (a -> f b) -> f ()

valuetellEvent :: Event sts -> Rule sts ctx ()

valuetellEvents :: [Event sts] -> Rule sts ctx ()

valuetrans

:: Embed sub super
=> RuleContext rtype sub
-> Rule super rtype (State sub)

valuevalidate

:: Validation (NonEmpty (PredicateFailure sts)) ()
-> Rule sts ctx ()

valuevalidateTrans

:: e -> PredicateFailure sts
-> Validation (NonEmpty e) ()
-> Rule sts ctx ()

valuevalidateTransLabeled

:: e -> PredicateFailure sts
-> NonEmpty Label
-> Validation (NonEmpty e) ()
-> Rule sts ctx ()

valuewhenFailureFree :: Rule sts rtype () -> Rule sts rtype ()

valuewhenFailureFreeDefault :: a -> Rule sts rtype a -> Rule sts rtype a

valueapplySTS

:: (STS s, RuleTypeRep rtype, BaseM s ~ Identity)
=> RuleContext rtype s
-> Either (NonEmpty (PredicateFailure s)) (State s)

valueapplySTSIndifferently

:: (STS s, RuleTypeRep rtype, Identity ~ BaseM s)
=> RuleContext rtype s
-> (State s, [PredicateFailure s])

datadata ApplySTSOpts (ep :: EventPolicy)

Constructors

ApplySTSOpts
- asoAssertions :: AssertionPolicy
- asoValidation :: ValidationPolicy
- asoEvents :: SingEP ep

datadata Assertion sts

Constructors

PreCondition String (TRC sts -> Bool)
PostCondition String (TRC sts -> State sts -> Bool)

datadata AssertionException where

Constructors

AssertionException :: STS sts => AssertionViolation sts -> AssertionException

Instances2Show, Exception

Show AssertionExceptionDefined in small-steps-1.1.4.0 · Control.State.Transition.Extended
Exception AssertionExceptionDefined in small-steps-1.1.4.0 · Control.State.Transition.Extended

datadata AssertionPolicy

AssertionsAll AssertionsPre AssertionsPost AssertionsOff

Instances2Eq, Show

Eq AssertionPolicyDefined in small-steps-1.1.4.0 · Control.State.Transition.Extended
Show AssertionPolicyDefined in small-steps-1.1.4.0 · Control.State.Transition.Extended

datadata AssertionViolation sts

Constructors

AssertionViolation
- avSTS :: String
- avMsg :: String
- avCtx :: TRC sts
- avState :: Maybe (State sts)

Instances1Show

STS sts => Show (AssertionViolation sts)Defined in small-steps-1.1.4.0 · Control.State.Transition.Extended

familytype family BaseM a :: Type -> Type

Instances1BaseM

type BaseM (STUB e st si f m) = mDefined in small-steps-1.1.4.0 · Control.State.Transition.Extended

classclass (STS sub, BaseM sub ~ BaseM super) => Embed sub super where

Methods

wrapFailed :: PredicateFailure sub -> PredicateFailure super
wrapEvent :: Event sub -> Event super

Instances1Embed

STS sts => Embed sts stsDefined in small-steps-1.1.4.0 · Control.State.Transition.Extended

familytype family Environment a

Instances1Environment

type Environment (STUB e st si f m) = eDefined in small-steps-1.1.4.0 · Control.State.Transition.Extended

familytype family Event a

Instances1Event

type Event (STUB e st si f m) = VoidDefined in small-steps-1.1.4.0 · Control.State.Transition.Extended

datadata EventPolicy

EventPolicyReturn EventPolicyDiscard

familytype family EventReturnType (ep :: EventPolicy) sts a where

Equations

EventReturnType 'EventPolicyReturn sts a = (a, [Event sts])
EventReturnType _1 _2 a = a

classclass EventReturnTypeRep (ert :: EventPolicy) where

Instances2EventReturnTypeRep

EventReturnTypeRep 'EventPolicyDiscardDefined in small-steps-1.1.4.0 · Control.State.Transition.Extended
EventReturnTypeRep 'EventPolicyReturnDefined in small-steps-1.1.4.0 · Control.State.Transition.Extended

newtypenewtype IRC sts

Constructors

IRC (Environment sts)

typetype InitialRule sts = Rule sts 'Initial (State sts)

typetype Label = String

familytype family PredicateFailure a

Instances1PredicateFailure

type PredicateFailure (STUB e st si f m) = fDefined in small-steps-1.1.4.0 · Control.State.Transition.Extended

typetype Rule sts (rtype :: RuleType) = F (Clause sts rtype)

familytype family RuleContext (t :: RuleType) :: Type -> Type where

Equations

RuleContext 'Initial = IRC
RuleContext 'Transition = TRC

type

type RuleInterpreter (ep :: EventPolicy) = forall s (m :: Type -> Type) (rtype :: RuleType). (STS s, RuleTypeRep rtype, m ~ BaseM s) => RuleContext rtype s -> Rule s rtype (State s) -> m (EventReturnType ep s (State s, [PredicateFailure s]))

datadata RuleType

Initial Transition

classclass RuleTypeRep (t :: RuleType) where

Instances2RuleTypeRep

RuleTypeRep 'InitialDefined in small-steps-1.1.4.0 · Control.State.Transition.Extended
RuleTypeRep 'TransitionDefined in small-steps-1.1.4.0 · Control.State.Transition.Extended

classclass (Eq (PredicateFailure a), Show (PredicateFailure a), Monad (BaseM a), Typeable a) => STS a where

Associated types

type family State a
type family Signal a
type family Environment a
type family BaseM a :: Type -> Type
type family Event a
type family PredicateFailure a

Methods

initialRules :: [InitialRule a]
transitionRules :: [TransitionRule a]
assertions :: [Assertion a]
renderAssertionViolation :: AssertionViolation a -> String

Instances1STS

(Eq f, Monad m, Show f, Typeable e, Typeable f, Typeable si, Typeable st, Typeable m) => STS (STUB e st si f m)Defined in small-steps-1.1.4.0 · Control.State.Transition.Extended

type

type STSInterpreter (ep :: EventPolicy) = forall s (m :: Type -> Type) (rtype :: RuleType). (STS s, RuleTypeRep rtype, m ~ BaseM s) => RuleContext rtype s -> m (EventReturnType ep s (State s, [PredicateFailure s]))

datadata STSResult s

Constructors

STSResult
- stsResultState :: State s
- stsResultFailures :: [PredicateFailure s]
- stsResultEvents :: [Event s]

datadata STUB e st si f (m :: Type -> Type)

Instances7STS, BaseM, Environment, Event, PredicateFailure, Signal, …

(Eq f, Monad m, Show f, Typeable e, Typeable f, Typeable si, Typeable st, Typeable m) => STS (STUB e st si f m)Defined in small-steps-1.1.4.0 · Control.State.Transition.Extended
type BaseM (STUB e st si f m) = mDefined in small-steps-1.1.4.0 · Control.State.Transition.Extended
type Environment (STUB e st si f m) = eDefined in small-steps-1.1.4.0 · Control.State.Transition.Extended
type Event (STUB e st si f m) = VoidDefined in small-steps-1.1.4.0 · Control.State.Transition.Extended
type PredicateFailure (STUB e st si f m) = fDefined in small-steps-1.1.4.0 · Control.State.Transition.Extended
type Signal (STUB e st si f m) = siDefined in small-steps-1.1.4.0 · Control.State.Transition.Extended
type State (STUB e st si f m) = stDefined in small-steps-1.1.4.0 · Control.State.Transition.Extended

familytype family Signal a

Instances1Signal

type Signal (STUB e st si f m) = siDefined in small-steps-1.1.4.0 · Control.State.Transition.Extended

datadata SingEP (ep :: EventPolicy) where

Constructors

EPReturn :: SingEP 'EventPolicyReturn
EPDiscard :: SingEP 'EventPolicyDiscard

familytype family State a

Instances1State

type State (STUB e st si f m) = stDefined in small-steps-1.1.4.0 · Control.State.Transition.Extended

newtypenewtype TRC sts

Constructors

TRC (Environment sts, State sts, Signal sts)

Instances1Show

(Show (Environment sts), Show (State sts), Show (Signal sts)) => Show (TRC sts)Defined in small-steps-1.1.4.0 · Control.State.Transition.Extended

newtypenewtype Threshold a

Constructors

Threshold a

Instances5Eq, Data, Ord, Show, NoThunks

Eq a => Eq (Threshold a)Defined in small-steps-1.1.4.0 · Control.State.Transition.Extended
Data a => Data (Threshold a)Defined in small-steps-1.1.4.0 · Control.State.Transition.Extended
Ord a => Ord (Threshold a)Defined in small-steps-1.1.4.0 · Control.State.Transition.Extended
Show a => Show (Threshold a)Defined in small-steps-1.1.4.0 · Control.State.Transition.Extended
NoThunks a => NoThunks (Threshold a)Defined in small-steps-1.1.4.0 · Control.State.Transition.Extended

typetype TransitionRule sts = Rule sts 'Transition (State sts)

datadata ValidationPolicy