-
Notifications
You must be signed in to change notification settings - Fork 16
/
plantuml-mode.el
271 lines (228 loc) · 9.86 KB
/
plantuml-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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
;;; plantuml-mode.el --- Major mode for plantuml
;; Author: Zhang Weize (zwz)
;; Keywords: uml ascii
;; You can redistribute this program and/or modify it under the terms
;; of the GNU General Public License as published by the Free Software
;; Foundation; either version 2, or (at your option) any later
;; version.
;;; DESCRIPTION
;; A major mode for plantuml, see: http://plantuml.sourceforge.net/
;; Plantuml is an open-source tool in java that allows to quickly write :
;; - sequence diagram,
;; - use case diagram,
;; - class diagram,
;; - activity diagram,
;; - component diagram,
;; - state diagram
;; - object diagram
;; using a simple and intuitive language.
;;; HISTORY
;; version 0.2, 2010-09-20 Initialize the keywords from the -language output of plantuml.jar
;; instead of the hard-coded way.
;; version 0.1, 2010-08-25 First version
(require 'thingatpt)
;;; Code:
(defgroup plantuml-mode nil
"Major mode for editing plantuml file."
:group 'languages)
(defvar plantuml-jar-path (expand-file-name "~/plantuml.jar"))
(defvar plantuml-mode-hook nil "Standard hook for plantuml-mode.")
(defvar plantuml-mode-version nil "plantuml-mode version string.")
(defvar plantuml-run-command "java -jar %s")
(defvar plantuml-mode-map
(let ((map (make-sparse-keymap)))
(define-key map (kbd "C-c C-c") 'plantuml-run-and-display)
map)
"Keymap for plantuml-mode")
(defun plantuml-render-command (&rest arguments)
"Returns a nicely escaped command string for executing the plantuml JAR file."
;; (shell-command (format "") (concat plantuml-run-command " " buffer-file-name))
(let ((cmd (format plantuml-run-command (shell-quote-argument plantuml-jar-path)))
(argstring (mapconcat 'shell-quote-argument arguments " ")))
(concat cmd " " argstring)))
;;; syntax table
(defvar plantuml-mode-syntax-table
(let ((synTable (make-syntax-table)))
(modify-syntax-entry ?' "< b" synTable)
(modify-syntax-entry ?\n "> b" synTable)
(modify-syntax-entry ?! "w" synTable)
(modify-syntax-entry ?@ "w" synTable)
(modify-syntax-entry ?# "'" synTable)
synTable)
"Syntax table for `plantuml-mode'.")
(defvar plantuml-types nil)
(defvar plantuml-keywords nil)
(defvar plantuml-preprocessors nil)
(defvar plantuml-builtins nil)
;; keyword completion
(defvar plantuml-kwdList nil "plantuml keywords.")
;; run plantuml
(defun plantuml-run()
"Run plantuml on the current buffer"
(interactive)
(let ((cmd (plantuml-render-command buffer-file-name)))
(message "running: %s" cmd)
(shell-command cmd)))
(defun plantuml-display-image()
"Display the rendered image"
(interactive)
(let ((plantuml-file (concat (file-name-sans-extension buffer-file-name) ".png")))
(if (not (buffer-live-p (get-buffer (file-name-nondirectory plantuml-file))))
(find-file plantuml-file)
(progn
(switch-to-buffer (file-name-nondirectory plantuml-file))
(revert-buffer nil t nil)))))
(defun plantuml-run-and-display()
"Run plantuml and display the resulting image"
(interactive)
(progn
(plantuml-run)
(plantuml-display-image)))
;;; font-lock
(defun plantuml-init ()
"Initialize the keywords or builtins from the cmdline language output"
(unless (file-exists-p plantuml-jar-path)
(error "Could not find plantuml.jar at %s" plantuml-jar-path))
(with-temp-buffer
(shell-command (plantuml-render-command "-language") (current-buffer))
(goto-char (point-min))
(let ((found (search-forward ";" nil t))
(word "")
(count 0)
(pos 0))
(while found
(forward-char)
(setq word (current-word))
(if (string= word "EOF") (setq found nil)
;; else
(forward-line)
(setq count (string-to-number (current-word)))
(beginning-of-line 2)
(setq pos (point))
(forward-line count)
(cond ((string= word "type")
(setq plantuml-types
(split-string
(buffer-substring-no-properties pos (point)))))
((string= word "keyword")
(setq plantuml-keywords
(split-string
(buffer-substring-no-properties pos (point)))))
((string= word "preprocessor")
(setq plantuml-preprocessors
(split-string
(buffer-substring-no-properties pos (point)))))
(t (setq plantuml-builtins
(append
plantuml-builtins
(split-string
(buffer-substring-no-properties pos (point)))))))
;; ((string= word "skinparameter")
;; ((string= word "color")))
(setq found (search-forward ";" nil nil)))))))
(unless plantuml-kwdList
(plantuml-init)
(defvar plantuml-types-regexp (concat "^\\s *\\(" (regexp-opt plantuml-types 'words) "\\|\\<\\(note\\s +over\\|note\\s +\\(left\\|right\\|bottom\\|top\\)\\s +\\(of\\)?\\)\\>\\|\\<\\(\\(left\\|center\\|right\\)\\s +\\(header\\|footer\\)\\)\\>\\)"))
(defvar plantuml-keywords-regexp (concat "^\\s *" (regexp-opt plantuml-keywords 'words) "\\|\\(<\\|<|\\|\\*\\|o\\)\\(\\.+\\|-+\\)\\|\\(\\.+\\|-+\\)\\(>\\||>\\|\\*\\|o\\)\\|\\.\\{2,\\}\\|-\\{2,\\}"))
(defvar plantuml-builtins-regexp (regexp-opt plantuml-builtins 'words))
(defvar plantuml-preprocessors-regexp (concat "^\\s *" (regexp-opt plantuml-preprocessors 'words)))
(setq plantuml-font-lock-keywords
`(
(,plantuml-types-regexp . font-lock-type-face)
(,plantuml-keywords-regexp . font-lock-keyword-face)
(,plantuml-builtins-regexp . font-lock-builtin-face)
(,plantuml-preprocessors-regexp . font-lock-preprocessor-face)
;; note: order matters
))
(setq plantuml-kwdList (make-hash-table :test 'equal))
(mapc (lambda (x) (puthash x t plantuml-kwdList)) plantuml-types)
(mapc (lambda (x) (puthash x t plantuml-kwdList)) plantuml-keywords)
(mapc (lambda (x) (puthash x t plantuml-kwdList)) plantuml-builtins)
(mapc (lambda (x) (puthash x t plantuml-kwdList)) plantuml-preprocessors)
(put 'plantuml-kwdList 'risky-local-variable t)
;; clear memory
(setq plantuml-types nil)
(setq plantuml-keywords nil)
(setq plantuml-builtins nil)
(setq plantuml-preprocessors nil)
(setq plantuml-types-regexp nil)
(setq plantuml-keywords-regexp nil)
(setq plantuml-builtins-regexp nil)
(setq plantuml-preprocessors-regexp nil))
(defun plantuml-complete-symbol ()
"Perform keyword completion on word before cursor."
(interactive)
(let ((posEnd (point))
(meat (thing-at-point 'symbol))
maxMatchResult)
(when (not meat) (setq meat ""))
(setq maxMatchResult (try-completion meat plantuml-kwdList))
(cond ((eq maxMatchResult t))
((null maxMatchResult)
(message "Can't find completion for \"%s\"" meat)
(ding))
((not (string= meat maxMatchResult))
(delete-region (- posEnd (length meat)) posEnd)
(insert maxMatchResult))
(t (message "Making completion list...")
(with-output-to-temp-buffer "*Completions*"
(display-completion-list
(all-completions meat plantuml-kwdList)
meat))
(message "Making completion list...%s" "done")))))
(add-to-list 'auto-mode-alist '("\\.plu$" . plantuml-mode))
(defun plantuml-trim-string-end (string)
"Remove trailing whitespace from the end of STRING."
(replace-regexp-in-string (rx (* (any " \t\n")) eos) "" string))
(defun plantuml-render-string (string unicode)
"Render STRING as PlantUML, use UNICODE if non-nil."
(let ((in-file (make-temp-file "plantuml"))
(out-ext (if unicode ".utxt" ".atxt"))
(out-opt (if unicode "-tutxt" "-ttxt")))
(with-temp-file in-file
(insert "@startuml\n" string "\n@enduml\n"))
(let ((out-file (concat (file-name-sans-extension in-file) out-ext))
(command (plantuml-render-command out-opt in-file)))
(shell-command command)
(delete-file in-file nil)
(prog1
(with-temp-buffer
(insert-file-contents out-file)
(plantuml-trim-string-end
(buffer-substring (point-min) (point-max))))
(delete-file out-file nil)))))
(defun plantuml-replace-region (beg end unicode)
"Render PlantUML at region from BEG to END, use UNICODE if non-nil."
(let ((indentation (current-indentation)))
(save-excursion
(goto-char end)
(insert (plantuml-render-string (buffer-substring beg end) unicode))
(indent-rigidly end (point) indentation)
(delete-region beg end))))
;;;###autoload
(defun plantuml-render-region ()
"Replace PlantUML at region with rendered UML."
(interactive)
(plantuml-replace-region (mark) (point) t))
;;;###autoload
(defun plantuml-mode ()
"Major mode for plantuml.
Shortcuts Command Name
\\[plantuml-complete-symbol] `plantuml-complete-symbol'"
(interactive)
(kill-all-local-variables)
;; (python-mode) ; for indentation
(setq major-mode 'plantuml-mode
mode-name "plantuml")
(set-syntax-table plantuml-mode-syntax-table)
(use-local-map plantuml-mode-map)
(make-local-variable 'font-lock-defaults)
(setq font-lock-defaults '((plantuml-font-lock-keywords) nil t))
(make-local-variable 'comment-start)
(setq comment-start "'")
(run-mode-hooks 'plantuml-mode-hook))
;;;###autoload
(progn
(add-to-list 'auto-mode-alist '("\\.(plantuml|puml)\\'" . plantuml-mode)))
(provide 'plantuml-mode)
;;; plantuml-mode.el ends here