flowchart.go 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318
  1. // Package renderer provides rendering functionality to convert AST back to Mermaid syntax.
  2. // Based on the rendering patterns from mermaid.js
  3. package renderer
  4. import (
  5. "fmt"
  6. "strings"
  7. "mermaid-go/pkg/ast"
  8. )
  9. // Renderer interface for converting diagrams back to mermaid syntax
  10. type Renderer interface {
  11. Render(diagram ast.Diagram) string
  12. }
  13. // FlowchartRenderer renders flowchart diagrams back to mermaid syntax
  14. type FlowchartRenderer struct{}
  15. // NewFlowchartRenderer creates a new flowchart renderer
  16. func NewFlowchartRenderer() *FlowchartRenderer {
  17. return &FlowchartRenderer{}
  18. }
  19. // Render converts a flowchart back to mermaid syntax
  20. func (r *FlowchartRenderer) Render(flowchart *ast.Flowchart) (string, error) {
  21. var builder strings.Builder
  22. // Write graph declaration with direction
  23. direction := flowchart.Direction
  24. if direction == "" {
  25. direction = "TD" // Default direction
  26. }
  27. builder.WriteString(fmt.Sprintf("graph %s\n", direction))
  28. // Collect all vertices that are referenced in edges for proper node definitions
  29. referencedVertices := make(map[string]bool)
  30. for _, edge := range flowchart.Edges {
  31. referencedVertices[edge.Start] = true
  32. referencedVertices[edge.End] = true
  33. }
  34. // Render edges (which implicitly define vertices)
  35. for _, edge := range flowchart.Edges {
  36. line := r.renderEdge(edge, flowchart.Vertices)
  37. builder.WriteString(" ")
  38. builder.WriteString(line)
  39. builder.WriteString("\n")
  40. }
  41. // Render standalone vertices (not connected to any edges)
  42. for id, vertex := range flowchart.Vertices {
  43. if !referencedVertices[id] {
  44. line := r.renderStandaloneVertex(vertex)
  45. if line != "" {
  46. builder.WriteString(" ")
  47. builder.WriteString(line)
  48. builder.WriteString("\n")
  49. }
  50. }
  51. }
  52. // Render subgraphs
  53. for _, subGraph := range flowchart.SubGraphs {
  54. r.renderSubGraph(&builder, subGraph)
  55. }
  56. // Render class definitions
  57. for _, class := range flowchart.Classes {
  58. r.renderClassDef(&builder, class)
  59. }
  60. // Render class assignments
  61. classAssignments := make(map[string][]string)
  62. for _, vertex := range flowchart.Vertices {
  63. for _, className := range vertex.Classes {
  64. if classAssignments[className] == nil {
  65. classAssignments[className] = make([]string, 0)
  66. }
  67. classAssignments[className] = append(classAssignments[className], vertex.ID)
  68. }
  69. }
  70. for className, nodeIDs := range classAssignments {
  71. if len(nodeIDs) > 0 {
  72. builder.WriteString(fmt.Sprintf(" class %s %s\n", strings.Join(nodeIDs, ","), className))
  73. }
  74. }
  75. // Render individual node styles
  76. for _, vertex := range flowchart.Vertices {
  77. if len(vertex.Styles) > 0 {
  78. styles := strings.Join(vertex.Styles, " ")
  79. builder.WriteString(fmt.Sprintf(" style %s %s\n", vertex.ID, styles))
  80. }
  81. }
  82. // Render click events
  83. for _, vertex := range flowchart.Vertices {
  84. if vertex.OnClick != nil {
  85. if vertex.OnClick.Link != nil {
  86. if vertex.OnClick.Target != nil {
  87. builder.WriteString(fmt.Sprintf(" click %s \"%s\" \"%s\"\n",
  88. vertex.ID, *vertex.OnClick.Link, *vertex.OnClick.Target))
  89. } else {
  90. builder.WriteString(fmt.Sprintf(" click %s \"%s\"\n",
  91. vertex.ID, *vertex.OnClick.Link))
  92. }
  93. } else if vertex.OnClick.Callback != nil {
  94. builder.WriteString(fmt.Sprintf(" click %s %s\n",
  95. vertex.ID, *vertex.OnClick.Callback))
  96. }
  97. }
  98. }
  99. // Render tooltips
  100. for nodeID, tooltip := range flowchart.Tooltips {
  101. builder.WriteString(fmt.Sprintf(" %s --> tooltip[\"%s\"]\n", nodeID, tooltip))
  102. }
  103. return builder.String(), nil
  104. }
  105. // renderEdge renders an edge with its connected vertices
  106. func (r *FlowchartRenderer) renderEdge(edge *ast.FlowEdge, vertices map[string]*ast.FlowVertex) string {
  107. startPart := r.renderVertexReference(edge.Start, vertices)
  108. arrow := r.renderArrow(edge)
  109. endPart := r.renderVertexReference(edge.End, vertices)
  110. return fmt.Sprintf("%s %s %s", startPart, arrow, endPart)
  111. }
  112. // renderVertexReference renders a vertex with its shape and label
  113. func (r *FlowchartRenderer) renderVertexReference(vertexID string, vertices map[string]*ast.FlowVertex) string {
  114. vertex := vertices[vertexID]
  115. if vertex == nil {
  116. return vertexID
  117. }
  118. return r.renderVertexWithShape(vertex)
  119. }
  120. // renderVertexWithShape renders a vertex with its shape delimiters
  121. func (r *FlowchartRenderer) renderVertexWithShape(vertex *ast.FlowVertex) string {
  122. text := vertex.ID
  123. if vertex.Text != nil && *vertex.Text != "" {
  124. text = *vertex.Text
  125. }
  126. // Determine shape based on vertex type
  127. vertexType := ast.VertexTypeRect // default
  128. if vertex.Type != nil {
  129. vertexType = *vertex.Type
  130. }
  131. switch vertexType {
  132. case ast.VertexTypeRect, ast.VertexTypeSquare:
  133. return fmt.Sprintf("%s[%s]", vertex.ID, text)
  134. case ast.VertexTypeRound:
  135. return fmt.Sprintf("%s(%s)", vertex.ID, text)
  136. case ast.VertexTypeCircle:
  137. return fmt.Sprintf("%s((%s))", vertex.ID, text)
  138. case ast.VertexTypeDiamond:
  139. return fmt.Sprintf("%s{%s}", vertex.ID, text)
  140. case ast.VertexTypeFlag:
  141. return fmt.Sprintf("%s>%s]", vertex.ID, text)
  142. case ast.VertexTypeLeanRight:
  143. return fmt.Sprintf("%s[/%s/]", vertex.ID, text)
  144. case ast.VertexTypeLeanLeft:
  145. return fmt.Sprintf("%s[\\%s\\]", vertex.ID, text)
  146. case ast.VertexTypeStadium:
  147. return fmt.Sprintf("%s([%s])", vertex.ID, text)
  148. case ast.VertexTypeCylinder:
  149. return fmt.Sprintf("%s[(%s)]", vertex.ID, text)
  150. case ast.VertexTypeSubroutine:
  151. return fmt.Sprintf("%s[[%s]]", vertex.ID, text)
  152. case ast.VertexTypeHexagon:
  153. return fmt.Sprintf("%s{{%s}}", vertex.ID, text)
  154. case ast.VertexTypeOdd:
  155. return fmt.Sprintf("%s>%s]", vertex.ID, text)
  156. case ast.VertexTypeTrapezoid:
  157. return fmt.Sprintf("%s[/%s/]", vertex.ID, text)
  158. case ast.VertexTypeInvTrapezoid:
  159. return fmt.Sprintf("%s[\\%s\\]", vertex.ID, text)
  160. default:
  161. return fmt.Sprintf("%s[%s]", vertex.ID, text)
  162. }
  163. }
  164. // renderArrow renders the arrow part of an edge with optional label
  165. func (r *FlowchartRenderer) renderArrow(edge *ast.FlowEdge) string {
  166. // Build arrow based on stroke and type
  167. arrow := r.buildArrowString(edge)
  168. // Add label if present
  169. if edge.Text != "" {
  170. return fmt.Sprintf("%s|%s|%s", r.getArrowStart(edge), edge.Text, r.getArrowEnd(edge))
  171. }
  172. return arrow
  173. }
  174. // buildArrowString creates the arrow string based on edge properties
  175. func (r *FlowchartRenderer) buildArrowString(edge *ast.FlowEdge) string {
  176. stroke := ast.StrokeNormal
  177. if edge.Stroke != nil {
  178. stroke = *edge.Stroke
  179. }
  180. edgeType := "arrow_point"
  181. if edge.Type != nil {
  182. edgeType = *edge.Type
  183. }
  184. switch stroke {
  185. case ast.StrokeNormal:
  186. switch edgeType {
  187. case "arrow_point":
  188. return "-->"
  189. case "arrow_cross":
  190. return "--x"
  191. case "arrow_circle":
  192. return "--o"
  193. case "arrow_open":
  194. return "---"
  195. default:
  196. return "-->"
  197. }
  198. case ast.StrokeThick:
  199. return "==>"
  200. case ast.StrokeDotted:
  201. return "-.->"
  202. case ast.StrokeInvisible:
  203. return "~~~"
  204. default:
  205. return "-->"
  206. }
  207. }
  208. // getArrowStart returns the start part of arrow for labeled edges
  209. func (r *FlowchartRenderer) getArrowStart(edge *ast.FlowEdge) string {
  210. stroke := ast.StrokeNormal
  211. if edge.Stroke != nil {
  212. stroke = *edge.Stroke
  213. }
  214. switch stroke {
  215. case ast.StrokeThick:
  216. return "=="
  217. case ast.StrokeDotted:
  218. return "-."
  219. case ast.StrokeInvisible:
  220. return "~~"
  221. default:
  222. return "--"
  223. }
  224. }
  225. // getArrowEnd returns the end part of arrow for labeled edges
  226. func (r *FlowchartRenderer) getArrowEnd(edge *ast.FlowEdge) string {
  227. edgeType := "arrow_point"
  228. if edge.Type != nil {
  229. edgeType = *edge.Type
  230. }
  231. switch edgeType {
  232. case "arrow_point":
  233. return ">"
  234. case "arrow_cross":
  235. return "x"
  236. case "arrow_circle":
  237. return "o"
  238. case "arrow_open":
  239. return ""
  240. default:
  241. return ">"
  242. }
  243. }
  244. // renderStandaloneVertex renders vertices not connected to any edges
  245. func (r *FlowchartRenderer) renderStandaloneVertex(vertex *ast.FlowVertex) string {
  246. // Only render if vertex has explicit shape/text definition
  247. if vertex.Text != nil || vertex.Type != nil {
  248. return r.renderVertexWithShape(vertex)
  249. }
  250. return ""
  251. }
  252. // renderSubGraph renders a subgraph definition
  253. func (r *FlowchartRenderer) renderSubGraph(builder *strings.Builder, subGraph *ast.FlowSubGraph) {
  254. builder.WriteString(fmt.Sprintf(" subgraph %s", subGraph.ID))
  255. if subGraph.Title != "" {
  256. builder.WriteString(fmt.Sprintf("[%s]", subGraph.Title))
  257. }
  258. builder.WriteString("\n")
  259. // Render direction if specified
  260. if subGraph.Dir != nil && *subGraph.Dir != "" {
  261. builder.WriteString(fmt.Sprintf(" direction %s\n", *subGraph.Dir))
  262. }
  263. // Render subgraph nodes
  264. for _, nodeID := range subGraph.Nodes {
  265. builder.WriteString(fmt.Sprintf(" %s\n", nodeID))
  266. }
  267. builder.WriteString(" end\n")
  268. }
  269. // renderClassDef renders a class definition
  270. func (r *FlowchartRenderer) renderClassDef(builder *strings.Builder, class *ast.FlowClass) {
  271. if len(class.Styles) > 0 {
  272. styles := strings.Join(class.Styles, " ")
  273. builder.WriteString(fmt.Sprintf(" classDef %s %s\n", class.ID, styles))
  274. }
  275. }