Safe Haskell	Safe-Inferred
Language	GHC2021

DotParse.Examples.AST

Description

Example of Dot graph construction for the chart-svg class heirarchy.

Synopsis

data SubComponents = SubComponents {
- classComponent :: ByteString
- subComponents :: [ByteString]
}
data ComponentEdge = ComponentEdge {
- edgeClassComponent :: ByteString
- edgeSubComponent :: ByteString
- subComponentClass :: ByteString
- edgeLabel :: Maybe ByteString
}
graphVs :: Monoid a => [SubComponents] -> Graph a (ByteString, ByteString)
subs :: SubComponents -> [(ByteString, ByteString)]
graphEs :: [ComponentEdge] -> Graph (Maybe ByteString) (ByteString, ByteString)
graphAST :: [SubComponents] -> [ComponentEdge] -> Graph (Maybe ByteString) (ByteString, ByteString)
fromCEs :: [ComponentEdge] -> [SubComponents]
recordNodes :: Graph (Maybe ByteString) (ByteString, ByteString) -> [Statement]
recordEdges :: Directed -> Graph (Maybe ByteString) (ByteString, ByteString) -> [Statement]
toStatementsRecord :: Directed -> Graph (Maybe ByteString) (ByteString, ByteString) -> [Statement]
toURL :: ByteString -> Maybe ByteString
dotAST :: [SubComponents] -> [ComponentEdge] -> Graph
data ItemModule = ItemModule {
- item :: ByteString
- itemModule :: ByteString
- itemPackage :: ByteString
}
itemModules :: [ItemModule]
componentEdges :: [ComponentEdge]
allSC :: [SubComponents]

Documentation

>>> import DotParse
>>> :set -XOverloadedStrings

data SubComponents Source #

A Haskell class and (informal) list of sub-components.

Constructors

SubComponents
Fields classComponent :: ByteString subComponents :: [ByteString]

Instances

Instances details

Generic SubComponents Source #
Instance details Defined in DotParse.Examples.AST Associated Types type Rep SubComponents :: Type -> Type # Methods from :: SubComponents -> Rep SubComponents x # to :: Rep SubComponents x -> SubComponents #
Show SubComponents Source #
Instance details Defined in DotParse.Examples.AST Methods showsPrec :: Int -> SubComponents -> ShowS # show :: SubComponents -> String # showList :: [SubComponents] -> ShowS #
Eq SubComponents Source #
Instance details Defined in DotParse.Examples.AST Methods (==) :: SubComponents -> SubComponents -> Bool # (/=) :: SubComponents -> SubComponents -> Bool #
Ord SubComponents Source #
Instance details Defined in DotParse.Examples.AST Methods compare :: SubComponents -> SubComponents -> Ordering # (<) :: SubComponents -> SubComponents -> Bool # (<=) :: SubComponents -> SubComponents -> Bool # (>) :: SubComponents -> SubComponents -> Bool # (>=) :: SubComponents -> SubComponents -> Bool # max :: SubComponents -> SubComponents -> SubComponents # min :: SubComponents -> SubComponents -> SubComponents #
type Rep SubComponents Source #
Instance details Defined in DotParse.Examples.AST type Rep SubComponents = D1 ('MetaData "SubComponents" "DotParse.Examples.AST" "dotparse-0.1.0.0-Glh386MQdGkE2gsLJXwO3r" 'False) (C1 ('MetaCons "SubComponents" 'PrefixI 'True) (S1 ('MetaSel ('Just "classComponent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString) :*: S1 ('MetaSel ('Just "subComponents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ByteString])))

data ComponentEdge Source #

Relationship between a class, a sub-component and the class of the sub-component.

Constructors

ComponentEdge
Fields edgeClassComponent :: ByteString edgeSubComponent :: ByteString subComponentClass :: ByteString edgeLabel :: Maybe ByteString

Instances

Instances details

Generic ComponentEdge Source #
Instance details Defined in DotParse.Examples.AST Associated Types type Rep ComponentEdge :: Type -> Type # Methods from :: ComponentEdge -> Rep ComponentEdge x # to :: Rep ComponentEdge x -> ComponentEdge #
Show ComponentEdge Source #
Instance details Defined in DotParse.Examples.AST Methods showsPrec :: Int -> ComponentEdge -> ShowS # show :: ComponentEdge -> String # showList :: [ComponentEdge] -> ShowS #
Eq ComponentEdge Source #
Instance details Defined in DotParse.Examples.AST Methods (==) :: ComponentEdge -> ComponentEdge -> Bool # (/=) :: ComponentEdge -> ComponentEdge -> Bool #
Ord ComponentEdge Source #
Instance details Defined in DotParse.Examples.AST Methods compare :: ComponentEdge -> ComponentEdge -> Ordering # (<) :: ComponentEdge -> ComponentEdge -> Bool # (<=) :: ComponentEdge -> ComponentEdge -> Bool # (>) :: ComponentEdge -> ComponentEdge -> Bool # (>=) :: ComponentEdge -> ComponentEdge -> Bool # max :: ComponentEdge -> ComponentEdge -> ComponentEdge # min :: ComponentEdge -> ComponentEdge -> ComponentEdge #
type Rep ComponentEdge Source #
Instance details Defined in DotParse.Examples.AST type Rep ComponentEdge = D1 ('MetaData "ComponentEdge" "DotParse.Examples.AST" "dotparse-0.1.0.0-Glh386MQdGkE2gsLJXwO3r" 'False) (C1 ('MetaCons "ComponentEdge" 'PrefixI 'True) ((S1 ('MetaSel ('Just "edgeClassComponent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString) :: S1 ('MetaSel ('Just "edgeSubComponent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)) :: (S1 ('MetaSel ('Just "subComponentClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString) :*: S1 ('MetaSel ('Just "edgeLabel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ByteString)))))

graphVs :: Monoid a => [SubComponents] -> Graph a (ByteString, ByteString) Source #

algebraic graph vertices

subs :: SubComponents -> [(ByteString, ByteString)] Source #

Convert sub-components to a list of class, subcomponent bytestring tuples.

graphEs :: [ComponentEdge] -> Graph (Maybe ByteString) (ByteString, ByteString) Source #

algebraic graph edges

graphAST :: [SubComponents] -> [ComponentEdge] -> Graph (Maybe ByteString) (ByteString, ByteString) Source #

algebraic graph

fromCEs :: [ComponentEdge] -> [SubComponents] Source #

Create a list of SubComponents from a list of ComponentEdges

recordNodes :: Graph (Maybe ByteString) (ByteString, ByteString) -> [Statement] Source #

Convert an algebraic Graph into dot record nodes

recordEdges :: Directed -> Graph (Maybe ByteString) (ByteString, ByteString) -> [Statement] Source #

Convert an algebraic Graph into dot edges

toStatementsRecord :: Directed -> Graph (Maybe ByteString) (ByteString, ByteString) -> [Statement] Source #

create Statements from a (edge labelled) algebraic graph

https://graphviz.org/Gallery/directed/datastruct.html

toURL :: ByteString -> Maybe ByteString Source #

Convert a node ID to a label for chart-svg charts Doing this directly in dot doesn't quite work because the engines get the width of the link wrong.

dotAST :: [SubComponents] -> [ComponentEdge] -> Graph Source #

AST Graph

gAST = dotAST allSC componentEdges
C.writeFile "other/ast.dot" $ dotPrint defaultDotConfig gAST
bsSvg <- processDotWith Directed ["-Tsvg"] (dotPrint defaultDotConfig gAST)
C.writeFile "other/ast.svg" bsSvg

data ItemModule Source #

Link values

Constructors

ItemModule
Fields item :: ByteString itemModule :: ByteString itemPackage :: ByteString

Instances

Instances details

Generic ItemModule Source #
Instance details Defined in DotParse.Examples.AST Associated Types type Rep ItemModule :: Type -> Type # Methods from :: ItemModule -> Rep ItemModule x # to :: Rep ItemModule x -> ItemModule #
Show ItemModule Source #
Instance details Defined in DotParse.Examples.AST Methods showsPrec :: Int -> ItemModule -> ShowS # show :: ItemModule -> String # showList :: [ItemModule] -> ShowS #
Eq ItemModule Source #
Instance details Defined in DotParse.Examples.AST Methods (==) :: ItemModule -> ItemModule -> Bool # (/=) :: ItemModule -> ItemModule -> Bool #
type Rep ItemModule Source #
Instance details Defined in DotParse.Examples.AST type Rep ItemModule = D1 ('MetaData "ItemModule" "DotParse.Examples.AST" "dotparse-0.1.0.0-Glh386MQdGkE2gsLJXwO3r" 'False) (C1 ('MetaCons "ItemModule" 'PrefixI 'True) (S1 ('MetaSel ('Just "item") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString) :: (S1 ('MetaSel ('Just "itemModule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString) :: S1 ('MetaSel ('Just "itemPackage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString))))

itemModules :: [ItemModule] Source #

List of link values

componentEdges :: [ComponentEdge] Source #

list of chart-svg component edges

allSC :: [SubComponents] Source #

list of chart-svg subcomponents