Language.Haskell.TH.TypeGraph.TypeGraph

Abstract operations on Maps containing graph edges.

Documentation

data TypeGraph

Instances

Ppr TypeGraph

(Monad m, MonadReaders [StackElement] m) => MonadReaders [StackElement] (ReaderT TypeGraph m)

typeInfo :: Lens' TypeGraph TypeInfo

edges :: Lens' TypeGraph (GraphEdges TGV)

graph :: Lens' TypeGraph (Graph, Vertex -> ((), TGV, [TGV]), TGV -> Maybe Vertex)

gsimple :: Lens' TypeGraph (Graph, Vertex -> ((), TGVSimple, [TGVSimple]), TGVSimple -> Maybe Vertex)

stack :: Lens' TypeGraph [StackElement]

makeTypeGraph :: MonadReaders TypeInfo m => GraphEdges TGV -> m TypeGraph

Build a TypeGraph given a set of edges and the TypeInfo environment

graphFromMap :: forall key. Ord key => GraphEdges key -> (Graph, Vertex -> ((), key, [key]), key -> Maybe Vertex)

Build a graph from the result of typeGraphEdges, each edge goes from a type to one of the types it contains. Thus, each edge represents a primitive lens, and each path in the graph is a composition of lenses.

TypeGraph queries

allLensKeys :: (DsMonad m, MonadStates ExpandMap m, MonadReaders TypeGraph m) => m (Map TGVSimple (Set TGV))

Lenses represent steps in a path, but the start point is a type vertex and the endpoint is a field vertex.

allPathKeys :: (DsMonad m, MonadStates ExpandMap m, MonadReaders TypeGraph m) => m (Map TGVSimple (Set TGVSimple))

Paths go between simple types.

allPathStarts :: forall m. (DsMonad m, MonadStates ExpandMap m, MonadReaders TypeGraph m) => m (Set TGV)

reachableFrom :: forall m. (DsMonad m, MonadReaders TypeGraph m) => TGV -> m (Set TGV)

reachableFromSimple :: forall m. (DsMonad m, MonadReaders TypeGraph m) => TGVSimple -> m (Set TGVSimple)

goalReachableFull :: (Functor m, DsMonad m, MonadReaders TypeGraph m) => TGV -> TGV -> m Bool

Can we reach the goal type from the start type in this key?

goalReachableSimple :: (Functor m, DsMonad m, MonadReaders TypeGraph m) => TGVSimple -> TGVSimple -> m Bool

Can we reach the goal type in the simplified graph?

goalReachableSimple' :: (Functor m, DsMonad m, MonadReaders TypeGraph m) => TGV -> TGV -> m Bool

Version of goalReachableSimple that first simplifies its argument nodes

data VertexStatus typ

When a VertexStatus value is associated with a Type it describes alterations in the type graph from the usual default.

Constructors

Vertex

normal case

Sink

out degree zero - don't create any outgoing edges

Divert typ

replace all outgoing edges with an edge to an alternate type

Extra typ

add an extra outgoing edge to the given type

Instances

Show typ => Show (VertexStatus typ)

Default (VertexStatus typ)

adjacent :: forall m. (MonadReaders TypeGraph m, DsMonad m, MonadStates ExpandMap m) => TGV -> m (Set TGV)

Return the set of adjacent vertices according to the default type graph - i.e. the one determined only by the type definitions, not by any additional hinting function.

typeGraphVertex :: (MonadReaders TypeGraph m, MonadStates ExpandMap m, DsMonad m) => Type -> m TGV

Return the TGV associated with a particular type, with no field specified.

typeGraphVertexOfField :: (MonadReaders TypeGraph m, MonadStates ExpandMap m, DsMonad m) => (Name, Name, Either Int Name) -> Type -> m TGV

Return the TGV associated with a particular type and field.