-
Notifications
You must be signed in to change notification settings - Fork 22
/
mermaid-mode.el
251 lines (207 loc) · 9.73 KB
/
mermaid-mode.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
;;; mermaid-mode.el --- major mode for working with mermaid graphs -*- lexical-binding: t; -*-
;; Copyright (C) 2019, Adrien Brochard
;; This file is NOT part of Emacs.
;; This program is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;; Version: 1.0
;; Author: Adrien Brochard
;; Keywords: mermaid graphs tools processes
;; URL: https://github.com/abrochard/mermaid-mode
;; License: GNU General Public License >= 3
;; Package-Requires: ((emacs "25.3"))
;;; Commentary:
;; Major mode for working with mermaid graphs.
;; See https://mermaid-js.github.io/
;;; Usage:
;; Currently supporting flow charts and sequence diagrams with syntax coloring and indentation.
;; C-c C-c to compile to an image
;; C-c C-f to compile file to an image
;; C-c C-r to compile region to an image
;; C-c C-b to compile buffer to an image
;; C-c C-o to open in the live editor
;; C-c C-d to open the official doc
;;; Customization:
;; You can specify the location of `mmdc` with the variable `mermaid-mmdc-location`,
;; the default assumes you have the binary in your exec PATH.
;; By default `mmdc` will compile to `png` format.
;; You can change that by setting the variable `mermaid-output-format`.
;; By default `mmdc` will use `/tmp` to store tmp-files.
;; You can change that by setting the variable `mermaid-tmp-dir`.
;;; Code:
(require 'browse-url)
(require 'ob)
(require 'ob-eval)
(defgroup mermaid-mode nil
"Major mode for working with mermaid graphs."
:group 'extensions
:link '(url-link :tag "Repository" "https://github.com/abrochard/mermaid-mode"))
(defcustom mermaid-mmdc-location "mmdc"
"Mmdc location."
:type 'string
:group 'mermaid-mode)
(defcustom mermaid-output-format ".png"
"Mmdc output format."
:group 'mermaid-mode
:type 'string)
(defcustom mermaid-tmp-dir "/tmp/"
"Dir for tmp files."
:group 'mermaid-mode
:type 'string)
(defcustom mermaid-flags ""
"Additional flags to pass to the mermaid-cli."
:group 'mermaid-mode
:type 'string)
(defcustom mermaid-indentation-level 4
"Spaces count for indentation"
:group 'mermaid-mode
:type 'number)
(defconst mermaid-font-lock-keywords
`((,(regexp-opt '("graph" "subgraph" "end" "flowchart" "sequenceDiagram" "classDiagram" "stateDiagram" "erDiagram" "gantt" "pie" "loop" "alt" "else" "opt") 'words) . font-lock-keyword-face)
("---\\|-?->*\\+?\\|==>\\|===" . font-lock-function-name-face)
(,(regexp-opt '("TB" "TD" "BT" "LR" "RL" "DT" "BT" "class" "title" "section" "participant" "actor" "dataFormat" "Note") 'words) . font-lock-constant-face)))
(defvar mermaid-syntax-table
(let ((syntax-table (make-syntax-table)))
;; Comment style "%% ..."
(modify-syntax-entry ?% ". 124" syntax-table)
(modify-syntax-entry ?\n ">" syntax-table)
syntax-table)
"Syntax table for `mermaid-mode'.")
(defvar org-babel-default-header-args:mermaid
'((:results . "file") (:exports . "results"))
"Default arguments for evaluating a mermaid source block.")
(defun org-babel-execute:mermaid (body params)
"Execute command with BODY and PARAMS from src block."
(let* ((out-file (or (cdr (assoc :file params))
(error "Mermaid requires a \":file\" header argument")))
(temp-file (org-babel-temp-file "mermaid-"))
(width (cdr (assoc :width params)))
(height (cdr (assoc :height params)))
(theme (cdr (assoc :theme params)))
(background-color (cdr (assoc :background-color params)))
(cmd (concat (shell-quote-argument mermaid-mmdc-location)
" -o " (org-babel-process-file-name out-file)
" -i " temp-file
(when width (format " -w %s" width))
(when height (format " -H %s" height))
(when theme (concat " -t " theme))
(when background-color (concat " -b " background-color))
" " mermaid-flags)))
(with-temp-file temp-file (insert body))
(org-babel-eval cmd "")
nil))
(defun mermaid--locate-declaration (str)
"Locate a certain declaration and return the line difference and indentation.
STR is the declaration."
(let ((l (line-number-at-pos)))
(save-excursion
(if (re-search-backward str (point-min) t)
(cons (- l (line-number-at-pos)) (current-indentation))
(cons -1 -1)))))
(defun mermaid--calculate-desired-indentation ()
"Determine the indentation level that this line should have."
(save-excursion
(end-of-line)
(let ((graph (mermaid--locate-declaration "^graph\\|sequenceDiagram\\|^gantt\\|^erDiagram"))
(subgraph (mermaid--locate-declaration "subgraph \\|loop \\|alt \\|opt"))
(both (mermaid--locate-declaration "^graph \\|^sequenceDiagram$\\|subgraph \\|loop \\|alt \\|opt\\|^gantt\\|^erDiagram"))
(else (mermaid--locate-declaration "else "))
(end (mermaid--locate-declaration "^ *end *$")))
(cond ((equal (car graph) 0) 0) ;; this is a graph declaration
((equal (car end) 0) (cdr subgraph)) ;; this is "end", indent to nearest subgraph
((equal (car subgraph) 0) (+ mermaid-indentation-level (cdr graph))) ;; this is a subgraph
((equal (car else) 0) (cdr subgraph)) ;; this is "else:, indent to nearest alt
;; everything else
((< (car end) 0) (+ mermaid-indentation-level (cdr both))) ;; no end in sight
((< (car both) (car end)) (+ mermaid-indentation-level (cdr both))) ;; (sub)graph declaration closer, +4
(t (cdr end)) ;; end declaration closer, same indent
))))
(defun mermaid-indent-line ()
"Indent the current line."
(interactive)
(indent-line-to (mermaid--calculate-desired-indentation)))
(defun mermaid-compile ()
"Compile the current mermaid file using mmdc."
(interactive)
(mermaid-compile-file (buffer-file-name)))
(defun mermaid-compile-buffer ()
"Compile the current mermaid buffer using mmdc."
(interactive)
(let* ((tmp-file-name (concat mermaid-tmp-dir "current-buffer.mmd")))
(write-region (point-min) (point-max) tmp-file-name)
(mermaid-compile-file tmp-file-name)))
(defun mermaid-compile-region ()
"Compile the current mermaid region using mmdc."
(interactive)
(let* ((tmp-file-name (concat mermaid-tmp-dir "current-region.mmd")))
(when (use-region-p)
(write-region (region-beginning) (region-end) tmp-file-name)
(mermaid-compile-file tmp-file-name))))
(defun mermaid-compile-file (file-name)
"Compile the given mermaid file using mmdc."
(interactive "fFilename: ")
(let* ((input file-name)
(output (concat (file-name-sans-extension input) mermaid-output-format))
(exit-code (apply #'call-process mermaid-mmdc-location nil "*mmdc*" nil (append (split-string mermaid-flags " ") (list "-i" input "-o" output)))))
(if (zerop exit-code)
(let ((buffer (find-file-noselect output t)))
(display-buffer buffer)
(save-excursion
(set-buffer buffer)
(auto-revert-mode)))
(pop-to-buffer "*mmdc*"))))
(defun mermaid--base64-encode-multibyte-string (input)
"Base64 encode the multibyte string INPUT."
(let ((coding-system-for-write 'utf-8))
(with-temp-buffer
(set-buffer-multibyte t)
(insert input)
(encode-coding-region (point-min) (point-max) 'utf-8)
(base64-encode-region (point-min) (point-max))
(buffer-string))))
(defun mermaid--make-browser-string (diagram)
"Create live-editor string for browser access.
DIAGRAM is a string of mermaid-js code to be displayed in the live-editor."
(concat "https://mermaid-js.github.io/mermaid-live-editor/#/edit/"
(replace-regexp-in-string "\n" ""
(mermaid--base64-encode-multibyte-string
(format "{\"code\":%s,\"mermaid\":{\"theme\":\"default\"},\"updateEditor\":false}"
(json-encode diagram))))))
(defun mermaid-open-browser ()
"Open the current buffer or active region in the mermaid live editor."
(interactive)
(browse-url (mermaid--make-browser-string (if (use-region-p)
(buffer-substring-no-properties (region-beginning) (region-end))
(buffer-string)))))
(defun mermaid-open-doc ()
"Open the mermaid home page and doc."
(interactive)
(browse-url "https://mermaid-js.github.io/"))
(defvar mermaid-mode-map
(let ((map (make-sparse-keymap)))
(define-key map (kbd "C-c C-c") 'mermaid-compile)
(define-key map (kbd "C-c C-f") 'mermaid-compile-file)
(define-key map (kbd "C-c C-b") 'mermaid-compile-buffer)
(define-key map (kbd "C-c C-r") 'mermaid-compile-region)
(define-key map (kbd "C-c C-o") 'mermaid-open-browser)
(define-key map (kbd "C-c C-d") 'mermaid-open-doc)
map))
;;;###autoload
(define-derived-mode mermaid-mode prog-mode "mermaid"
:syntax-table mermaid-syntax-table
(setq-local font-lock-defaults '(mermaid-font-lock-keywords))
(setq-local indent-line-function 'mermaid-indent-line)
(setq-local comment-start "%%")
(setq-local comment-end "")
(setq-local comment-start-skip "%%+ *"))
;;;###autoload
(add-to-list 'auto-mode-alist '("\\.mmd\\'" . mermaid-mode))
(provide 'mermaid-mode)
;;; mermaid-mode.el ends here