{-# LANGUAGE AllowAmbiguousTypes #-}
{-# LANGUAGE MonoLocalBinds #-}

-- |
--  This module provides functions to extract
--  a DOT graph (https://en.wikipedia.org/wiki/DOT_(graph_description_language)
--  out of a Registry
module Data.Registry.Dot
  ( module D,
    makeDot,
    makeDotEither,
  )
where

import Data.Registry.Internal.Dot as D
import Data.Registry.Registry
import Data.Registry.Statistics
import Protolude

-- | Make a DOT graph for a specific value a built from the Registry
--   a is at the root of the graph and its children are values
--   needed to build a
makeDot :: forall a ins out. (Typeable a) => Registry ins out -> Dot
makeDot :: forall {k} (a :: k) (ins :: [*]) (out :: [*]).
Typeable a =>
Registry ins out -> Dot
makeDot = Operations -> Dot
toDot (Operations -> Dot)
-> (Registry ins out -> Operations) -> Registry ins out -> Dot
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Statistics -> Operations
operations (Statistics -> Operations)
-> (Registry ins out -> Statistics)
-> Registry ins out
-> Operations
forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (a :: k) (ins :: [*]) (out :: [*]).
Typeable a =>
Registry ins out -> Statistics
forall {k} (a :: k) (ins :: [*]) (out :: [*]).
Typeable a =>
Registry ins out -> Statistics
makeStatistics @a

-- | Similar to make but does not check if a can be made out of the Registry
--   It returns a Left value if that's not the case
makeDotEither :: forall a ins out. (Typeable a) => Registry ins out -> Either Text Dot
makeDotEither :: forall {k} (a :: k) (ins :: [*]) (out :: [*]).
Typeable a =>
Registry ins out -> Either Text Dot
makeDotEither Registry ins out
r = Operations -> Dot
toDot (Operations -> Dot)
-> (Statistics -> Operations) -> Statistics -> Dot
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Statistics -> Operations
operations (Statistics -> Dot) -> Either Text Statistics -> Either Text Dot
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall (a :: k) (ins :: [*]) (out :: [*]).
Typeable a =>
Registry ins out -> Either Text Statistics
forall {k} (a :: k) (ins :: [*]) (out :: [*]).
Typeable a =>
Registry ins out -> Either Text Statistics
makeStatisticsEither @a Registry ins out
r