Control.MultiWalk.Contains

This module contains the instances and definitions supporting Multiwalk module, along with the combinators for writing MultiSub instances.

Documentation

type family AllMods (p :: Type -> Constraint) (as :: Spec) :: Constraint where ...

Equations

AllMods p ('SpecList ls) = AllMods' p ls

AllMods p ('SpecSelf t) = p t

AllMods p 'SpecLeaf = ()

type family All (p :: k -> Constraint) (as :: [k]) :: Constraint where ...

Equations

All p '[] = ()

All p (a ': as) = (p a, All p as)

data GSubTag

Instances

(Generic t, HasSub' ctag (l ': ls) ('Nothing :: Maybe Symbol) ('Nothing :: Maybe Symbol) (Rep t)) => HasSub ctag GSubTag ('SpecList (l ': ls)) t

Defined in Control.MultiWalk.HasSub

Methods

modSub :: forall c m. (Applicative m, AllMods c ('SpecList (l ': ls))) => Proxy c -> (forall s. c s => Proxy s -> Carrier ctag s -> m (Carrier ctag s)) -> t -> m t

getSub :: forall c m. (Monoid m, AllMods c ('SpecList (l ': ls))) => Proxy c -> (forall s. c s => Proxy s -> Carrier ctag s -> m) -> t -> m

data SelSpec

Constructors

NoSel

ConsSel Symbol

FieldSel Symbol

ConsFieldSel Symbol Symbol

data SubSpec

Constructors

SubSpec

Fields

• SelSpec

  Constructor and field selectors

• Type

  Modifiers (used for customizing constraints)

• Type

  Carrier type, should be equal to Carrier of type above (to be aligned with the target's generic subtypes)

Instances

(Generic t, HasSub' ctag (l ': ls) ('Nothing :: Maybe Symbol) ('Nothing :: Maybe Symbol) (Rep t)) => HasSub ctag GSubTag ('SpecList (l ': ls)) t

Defined in Control.MultiWalk.HasSub

Methods

modSub :: forall c m. (Applicative m, AllMods c ('SpecList (l ': ls))) => Proxy c -> (forall s. c s => Proxy s -> Carrier ctag s -> m (Carrier ctag s)) -> t -> m t

getSub :: forall c m. (Monoid m, AllMods c ('SpecList (l ': ls))) => Proxy c -> (forall s. c s => Proxy s -> Carrier ctag s -> m) -> t -> m

data Spec

Constructors

SpecList [SubSpec]

SpecLeaf

SpecSelf Type

Modifiers (used for customizing constraints)

data Under (b :: Type) (s :: SelSpec) (a :: Type)

Use this for matching a subcomponent nested inside another type. Useful if you don't want to add the middle type to the list of walkable types.

Instances

(TContains fs a, HasSub GSubTag ('SpecList '['SubSpec s a (Carrier a)]) b) => TContains fs (Under b s a)

Defined in Control.MultiWalk.Contains

Methods

tGetW :: Applicative m => FList m fs -> ContainsCarrier (Under b s a) -> m (ContainsCarrier (Under b s a))

tGetQ :: Monoid m => QList m fs -> ContainsCarrier (Under b s a) -> m

data MatchWith (s :: Type) (a :: Type)

Use this for matching with another type that is coercible to the type you want.

Instances

(TContains fs a, Coercible (Carrier a) s) => TContains fs (MatchWith s a)

Defined in Control.MultiWalk.Contains

Methods

tGetW :: Applicative m => FList m fs -> ContainsCarrier (MatchWith s a) -> m (ContainsCarrier (MatchWith s a))

tGetQ :: Monoid m => QList m fs -> ContainsCarrier (MatchWith s a) -> m

data Trav (k :: Type -> Type) (a :: Type)

Use this for matching with a type inside a traversable functor.

Instances

(Traversable f, TContains fs a) => TContains fs (Trav f a)

Defined in Control.MultiWalk.Contains

Methods

tGetW :: Applicative m => FList m fs -> ContainsCarrier (Trav f a) -> m (ContainsCarrier (Trav f a))

tGetQ :: Monoid m => QList m fs -> ContainsCarrier (Trav f a) -> m

class TContains (fs :: [Type]) (t :: Type) where

Auxiliary class that keeps track of how retrieve queries and walks from their lists and apply them according to the combinators.

Methods

tGetW :: Applicative m => FList m fs -> ContainsCarrier t -> m (ContainsCarrier t)

tGetQ :: Monoid m => QList m fs -> ContainsCarrier t -> m

Instances

(FContains fs (Carrier a), QContains fs (Carrier a)) => TContains fs a

Defined in Control.MultiWalk.Contains

Methods

tGetW :: Applicative m => FList m fs -> ContainsCarrier a -> m (ContainsCarrier a)

tGetQ :: Monoid m => QList m fs -> ContainsCarrier a -> m

(TContains fs a, Coercible (Carrier a) s) => TContains fs (MatchWith s a)

Defined in Control.MultiWalk.Contains

Methods

tGetW :: Applicative m => FList m fs -> ContainsCarrier (MatchWith s a) -> m (ContainsCarrier (MatchWith s a))

tGetQ :: Monoid m => QList m fs -> ContainsCarrier (MatchWith s a) -> m

(Traversable f, TContains fs a) => TContains fs (Trav f a)

Defined in Control.MultiWalk.Contains

Methods

tGetW :: Applicative m => FList m fs -> ContainsCarrier (Trav f a) -> m (ContainsCarrier (Trav f a))

tGetQ :: Monoid m => QList m fs -> ContainsCarrier (Trav f a) -> m

(TContains fs a, HasSub GSubTag ('SpecList '['SubSpec s a (Carrier a)]) b) => TContains fs (Under b s a)

Defined in Control.MultiWalk.Contains

Methods

tGetW :: Applicative m => FList m fs -> ContainsCarrier (Under b s a) -> m (ContainsCarrier (Under b s a))

tGetQ :: Monoid m => QList m fs -> ContainsCarrier (Under b s a) -> m

class FContains (l :: [Type]) (t :: Type) where

Methods

fGet :: FList m l -> t -> m t

fSet :: FList m l -> (t -> m t) -> FList m l

Instances

FContains (t ': xs) t

Defined in Control.MultiWalk.Contains

Methods

fGet :: FList m (t ': xs) -> t -> m t

fSet :: FList m (t ': xs) -> (t -> m t) -> FList m (t ': xs)

FContains xs t => FContains (x ': xs) t

Defined in Control.MultiWalk.Contains

Methods

fGet :: FList m (x ': xs) -> t -> m t

fSet :: FList m (x ': xs) -> (t -> m t) -> FList m (x ': xs)

data FList :: (Type -> Type) -> [Type] -> Type where

Heterogeneous list of monadic-valued functions

Constructors

FNil :: FList m '[]

(:.:) :: (x -> m x) -> FList m xs -> FList m (x ': xs) infixr 8

class QContains (l :: [Type]) (t :: Type) where

Methods

qGet :: QList m l -> t -> m

qSet :: QList m l -> (t -> m) -> QList m l

Instances

QContains (t ': xs) t

Defined in Control.MultiWalk.Contains

Methods

qGet :: QList m (t ': xs) -> t -> m

qSet :: QList m (t ': xs) -> (t -> m) -> QList m (t ': xs)

QContains xs t => QContains (x ': xs) t

Defined in Control.MultiWalk.Contains

Methods

qGet :: QList m (x ': xs) -> t -> m

qSet :: QList m (x ': xs) -> (t -> m) -> QList m (x ': xs)

data QList :: Type -> [Type] -> Type where

Heterogeneous list of queries

Constructors

QNil :: QList m '[]

(:?:) :: (x -> m) -> QList m xs -> QList m (x ': xs) infixr 8

type ToSpecSel s a = ToSpecSel MWCTag s a

type ToSpec a = ToSpec MWCTag a

type Carrier a = Carrier MWCTag a

type HasSub tag ls t = HasSub MWCTag tag ls t

type family ContainsCarrier (a :: Type) :: Type where ...

Equations

ContainsCarrier (Under b s a) = b

ContainsCarrier (MatchWith s a) = s

ContainsCarrier (Trav f a) = f (Carrier a)

ContainsCarrier a = a

data MWCTag

Instances

type Carrier MWCTag a

Defined in Control.MultiWalk.Contains

type Carrier MWCTag a = ContainsCarrier a

type Carrier MWCTag a

Defined in Control.MultiWalk.Contains

type Carrier MWCTag a = ContainsCarrier a

modSubWithFList :: forall tag ls t fs m. (HasSub tag ls t, Applicative m, AllMods (TContains fs) ls) => FList m fs -> t -> m t

Modify (only) substructures by applying functions from FList.

getSubWithQList :: forall tag ls t fs m. (HasSub tag ls t, Monoid m, AllMods (TContains fs) ls) => QList m fs -> t -> m

Query (only) substructures by applying functions from QList.