forked from emacs-tree-sitter/ts-fold
-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathts-fold-summary.el
236 lines (194 loc) · 8.45 KB
/
ts-fold-summary.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
;;; ts-fold-summary.el --- Extract summary from fold region -*- lexical-binding: t; -*-
;; Copyright (C) 2021-2023 Shen, Jen-Chieh
;; Created date 2021-10-04 16:59:22
;; This file is NOT part of GNU 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 <https://www.gnu.org/licenses/>.
;;; Commentary:
;;
;; Extract summary from fold region.
;;
;;; Code:
(require 's)
(defcustom ts-fold-summary-show t
"Flag to show summary if available."
:type 'boolean
:group 'ts-fold)
(defcustom ts-fold-summary-max-length 60
"Maximum length for summary to display."
:type '(choice (const :tag "nil" nil)
(integer :tag "positive integer number"))
:group 'ts-fold)
(defcustom ts-fold-summary-exceeded-string "..."
"String that added after display summary.
This happens only when summary length is larger than variable
`ts-fold-summary-max-length'."
:type 'string
:group 'ts-fold)
(defcustom ts-fold-summary-format " <S> %s "
"Prefix string added before summary overlay."
:type 'string
:group 'ts-fold)
;;
;; (@* "Externals" )
;;
(defvar ts-fold-replacement-face)
;;
;; (@* "Parsers" )
;;
(defun ts-fold-summary--valid-content-p (content)
"Return non-nil if CONTENT is a valid document string for extraction.
Some programmers use some type of characters for splitting the code module
into sections. For instance, ===, ---, ///, =-=, etc. Try to omit these
type of content by checking the word boundary's existence."
(string-match-p "\\w" content))
(defun ts-fold-summary--apply-sym (line sym)
"Remove SYM from LINE."
(when (string-prefix-p sym line)
(setq line (substring line (length sym) (length line))
line (string-trim line)))
line)
(defun ts-fold-summary--extract-summary (doc-str sym)
"Extract only document summary from DOC-STR using SYM."
(let ((lines (split-string doc-str "\n")) new-lines)
(dolist (line lines)
(setq line (string-trim line))
(cond ((listp sym)
(dolist (c sym) (setq line (ts-fold-summary--apply-sym line c))))
(t (setq line (ts-fold-summary--apply-sym line sym))))
(when (ts-fold-summary--valid-content-p line) (push line new-lines)))
(reverse new-lines)))
(defun ts-fold-summary--doc-extract (doc-str sym)
"Default way to extract the doc summary from DOC-STR using SYM."
(let* ((lines (ts-fold-summary--extract-summary doc-str sym)) (summary (nth 0 lines)))
(when summary (setq summary (string-trim summary)))
(if (string-empty-p summary) nil summary)))
(defun ts-fold-summary--generic (doc-str sym)
"Generic DOC-STR extraction using SYM."
(when (ts-fold--doc-faces-p doc-str)
(ts-fold-summary--doc-extract doc-str sym)))
(defun ts-fold-summary-batch (doc-str)
"Extract summary from DOC-STR in Batch."
(ts-fold-summary--generic doc-str '("::" "rem" "REM")))
(defun ts-fold-summary-csharp-vsdoc (doc-str)
"Extract summary from DOC-STR in C# vsdoc."
(let ((type-triple (string-match-p "///" doc-str)))
(setq doc-str (s-replace-regexp "<[/]*[^>]+." "" doc-str))
(ts-fold-summary--generic doc-str (if type-triple "///" "//"))))
(defun ts-fold-summary-csharp (doc-str)
"Extract summary from DOC-STR in C#."
(cond ((string-match-p "///" doc-str)
(ts-fold-summary-csharp-vsdoc doc-str))
(t (ts-fold-summary-javadoc doc-str))))
(defun ts-fold-summary-javadoc (doc-str)
"Extract summary from DOC-STR in Javadoc."
(ts-fold-summary--generic doc-str "*"))
(defun ts-fold-summary-go (doc-str)
"Extract summary from DOC-STR in Go."
(ts-fold-summary--generic doc-str "//"))
(defun ts-fold-summary-lua-doc (doc-str)
"Extract summary from DOC-STR in Lua."
(ts-fold-summary--generic doc-str "--"))
(defun ts-fold-summary-python-doc (doc-str)
"Extract summary from DOC-STR in Python."
(ts-fold-summary--generic doc-str "\"\"\""))
(defun ts-fold-summary-ruby-doc (doc-str)
"Extract summary from DOC-STR in Ruby."
(ts-fold-summary--generic doc-str "#"))
(defun ts-fold-summary-rust-doc (doc-str)
"Extract summary from DOC-STR in Rust."
(ts-fold-summary--generic doc-str "///"))
(defun ts-fold-summary-c-macro (doc-str)
"Parse C macro summary from DOC-STR."
(when (ts-fold--is-face doc-str
'(font-lock-preprocessor-face
preproc-font-lock-preprocessor-background))
(ts-fold-summary--doc-extract doc-str "")))
(defun ts-fold-summary-c (doc-str)
"Extract summary from DOC-STR in C comment."
(or (ts-fold-summary-javadoc doc-str)
(ts-fold-summary-c-macro doc-str)))
(defun ts-fold-summary-markdown (doc-str)
"Extract summary from DOC-STR in Markdown block."
(ts-fold-summary--doc-extract doc-str '()))
(defun ts-fold-summary-org (doc-str)
"Extract summary from DOC-STR in Org block."
(ts-fold-summary--doc-extract doc-str '()))
(defun ts-fold-summary-xml (doc-str)
"Extract summary from DOC-STR in XML."
(ts-fold-summary--generic doc-str "-"))
(defun ts-fold-summary-julia-doc (doc-str)
"Extract summary from DOC-STR in julia."
(ts-fold-summary--generic doc-str "\"\"\""))
;;
;; (@* "Core" )
;;
(defun ts-fold-summary--keep-length (summary)
"Keep the SUMMARY length to `ts-fold-summary-max-length'."
(let ((len-sum (length summary))
(len-exc (length ts-fold-summary-exceeded-string)))
(when (< ts-fold-summary-max-length len-sum)
(setq summary (substring summary 0 (- ts-fold-summary-max-length len-exc))
summary (concat summary ts-fold-summary-exceeded-string))))
summary)
(defun ts-fold-summary--apply-format (summary)
"Return the SUMMARY that has added the summary prefix."
(format ts-fold-summary-format summary))
(defun ts-fold-summary--parser ()
"Return the summary parser from `ts-fold-summary-parsers-alist'."
(assoc (buffer-local-value 'major-mode (current-buffer)) ts-fold-summary-parsers-alist))
(defun ts-fold-summary--get (doc-str)
"Extract summary from DOC-STR in order to display ontop of the overlay."
(let ((parser (cdr (ts-fold-summary--parser))) summary)
(when parser
(setq summary (funcall parser doc-str))
(when (integerp ts-fold-summary-max-length)
(setq summary (ts-fold-summary--keep-length summary)))
(when summary
(setq summary (ts-fold-summary--apply-format summary)
summary (propertize summary 'face 'ts-fold-replacement-face))))
summary))
;; TODO(everyone): keep this alist alphabetically sorted
(defcustom ts-fold-summary-parsers-alist
`((actionscript-mode . ts-fold-summary-javadoc)
(bat-mode . ts-fold-summary-batch)
(c-mode . ts-fold-summary-c)
(c++-mode . ts-fold-summary-c)
(csharp-mode . ts-fold-summary-csharp)
(css-mode . ts-fold-summary-javadoc)
(go-mode . ts-fold-summary-go)
(html-mode . ts-fold-summary-xml)
(java-mode . ts-fold-summary-javadoc)
(javascript-mode . ts-fold-summary-javadoc)
(js-mode . ts-fold-summary-javadoc)
(js2-mode . ts-fold-summary-javadoc)
(js3-mode . ts-fold-summary-javadoc)
(julia-mode . ts-fold-summary-julia-doc)
(kotlin-mode . ts-fold-summary-javadoc)
(lua-mode . ts-fold-summary-lua-doc)
(markdown-mode . ts-fold-summary-markdown)
(objc-mode . ts-fold-summary-c)
(org-mode . ts-fold-summary-org)
(php-mode . ts-fold-summary-javadoc)
(python-mode . ts-fold-summary-python-doc)
(rjsx-mode . ts-fold-summary-javadoc)
(ruby-mode . ts-fold-summary-ruby-doc)
(rust-mode . ts-fold-summary-rust-doc)
(scala-mode . ts-fold-summary-javadoc)
(sh-mode . ts-fold-summary-javadoc)
(swift-mode . ts-fold-summary-c)
(typescript-mode . ts-fold-summary-javadoc)
(nxml-mode . ts-fold-summary-xml))
"Alist mapping `major-mode' to doc parser function."
:type '(alist :key-type symbol :value-type function)
:group 'ts-fold)
(provide 'ts-fold-summary)
;;; ts-fold-summary.el ends here