blob: be152f505ed05090a4108a55a78e2f2fe7104916 (
plain) (
blame)
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
|
;;; hcel-utils.el --- Commonly used utilities -*- lexical-binding: t; -*-
;; Copyright (C) 2022 Free Software Foundation, Inc.
;;
;; This file is part of hcel.
;;
;; hcel is free software: you can redistribute it and/or modify it under
;; the terms of the GNU Affero General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;;
;; hcel 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 Affero General
;; Public License for more details.
;;
;; You should have received a copy of the GNU Affero General Public
;; License along with hcel. If not, see <https://www.gnu.org/licenses/>.
(require 'dom)
(require 'shr)
;; data conversions
(defun hcel-parse-package-id (package-id &optional divider)
(unless (stringp divider) (setq divider " "))
(string-match (format "^\\(.*\\)%s\\(.*\\)$" divider) package-id)
(list (cons 'name (match-string 1 package-id))
(cons 'version (match-string 2 package-id))))
(defun hcel-location-tag (location-info)
"Gets the tag of LOCATION-INFO."
(alist-get 'tag location-info))
(defun hcel-id-src-span-to-location-info (package-id module-path id-src-span)
"Converts an idSrcSpan to an exact location.
Example of an idSrcSpan:
\"idSrcSpan\": {
\"endColumn\": 43,
\"line\": 228,
\"modulePath\": \"src/HaskellCodeExplorer/Types.hs\",
\"startColumn\": 26
}
"
(list
(cons 'packageId package-id)
(cons 'modulePath module-path)
(cons 'startLine (alist-get 'line id-src-span))
(cons 'startColumn (alist-get 'startColumn id-src-span))
(cons 'endLine (alist-get 'line id-src-span))
(cons 'endColumn (alist-get 'endColumn id-src-span))
(cons 'tag "ExactLocation")))
(defun hcel-expression (expr)
(when-let* ((span (alist-get 'srcSpan expr))
(line-beg (alist-get 'line (alist-get 'start span)))
(col-beg (alist-get 'column (alist-get 'start span)))
(line-end (alist-get 'line (alist-get 'end span)))
(col-end (alist-get 'column (alist-get 'end span))))
(hcel-buffer-substring-line-column line-beg (1- col-beg) line-end (1- col-end))))
;; buffers and strings manipulation
(defun hcel-goto-line-column (line column)
(goto-char (point-min))
(forward-line (1- line))
(move-to-column column))
(defun hcel-unquote-html (html)
(replace-regexp-in-string
"&" "&"
(replace-regexp-in-string
"'" "'"
(replace-regexp-in-string
""" "\""
(replace-regexp-in-string
">" ">"
(replace-regexp-in-string
"<" "<" html))))))
(defun hcel-buffer-substring-line-column (line-beg col-beg line-end col-end)
(save-excursion
(buffer-substring
(progn (hcel-goto-line-column line-beg col-beg) (point))
(progn (hcel-goto-line-column line-end col-end) (point)))))
(defun hcel-fontify-with-haskell-mode ()
"Fontify using haskell-mode"
(require 'haskell)
(let ((text (buffer-string)))
(with-temp-buffer
(haskell-mode)
(insert text)
(if (fboundp 'font-lock-ensure)
(font-lock-ensure)
(with-no-warnings (font-lock-fontify-buffer)))
(setq text (buffer-substring (point-min) (point-max))))
(erase-buffer)
(insert text)))
(defun hcel-remove-html-markup (html)
(replace-regexp-in-string
"<.*?>" ""
(replace-regexp-in-string "</p>" "\n\n" html)))
(defun hcel-fill-string (text)
(with-temp-buffer
(insert text)
(fill-region (point-min) (point-max))
(buffer-substring (point-min) (point-max))))
;; string formatting
(defun hcel-format-package-id (package &optional divider)
(unless (stringp divider) (setq divider " "))
(concat (alist-get 'name package) divider (alist-get 'version package)))
(defun hcel-render-components (components &optional name comp-max-len)
(when (or components name)
(concat (when name (replace-regexp-in-string "\n" " " name))
(when components
(let ((rendered-comp
(concat (when name " :: ")
(substring
(replace-regexp-in-string
"\n" " " (mapconcat
(lambda (component)
(propertize
(or (alist-get 'name component)
(alist-get 'contents component))
'internal-id (alist-get 'internalId component)))
components
""))))))
(if (and comp-max-len (< comp-max-len (length rendered-comp)))
(concat (substring rendered-comp 0 comp-max-len) "...")
rendered-comp))))))
(defun hcel-render-id-type (id-type)
(concat
(hcel-render-components (alist-get 'components id-type))
(when-let ((expanded (hcel-render-components
(alist-get 'componentsExpanded id-type))))
(concat "\nExpands to: " expanded))))
(defun hcel-expression-and-type (expr)
"Returns a pair of expression text and its type text."
(when-let ((expression (hcel-expression expr))
(type (hcel-render-id-type
(alist-get 'exprType (alist-get 'info expr)))))
(cons expression type)))
(defun hcel-render-html (html action)
(unless action (setq action 'hcel-tag-span-button-load-source))
(when html
;; (hcel-debug-html html)
(with-temp-buffer
(insert html)
(let* ((hcel-tag-span (hcel-tag-span-function action))
(shr-external-rendering-functions
`((span . ,hcel-tag-span)
(div . hcel-tag-div))))
(shr-render-region (point-min) (point-max)))
(buffer-string))))
(defun hcel-debug-html (html)
(with-temp-buffer
(insert html)
(pp (libxml-parse-html-region (point-min) (point-max)))))
(defun hcel-tag-span-function (button-action)
(lambda (dom)
(let ((start (point)))
(shr-tag-span dom)
(mapc (lambda (attr)
(cond ((eq (car attr) 'data-location)
(put-text-property start (point)
'location-info
(json-read-from-string (cdr attr)))
(make-text-button start (point)
'action button-action
'face 'button)
)))
(dom-attributes dom)))))
(defun hcel-tag-div (dom)
(if (equal (dom-attr dom 'class) "source-code")
(shr-tag-pre dom)
(shr-tag-div dom)))
(defun hcel-text-property-near-point (prop)
"Find property prop at point, or just before point."
(or (get-text-property (point) prop)
(get-text-property (max (point-min) (1- (point))) prop)))
(defun hcel-string-with-text-property-at-point (prop)
"Find the string with property PROP at point.
Does not check whether point does indeed has property PROP."
(save-excursion
(let ((beg) (end))
(setq end (next-single-char-property-change (point) prop))
(setq beg (previous-single-char-property-change end prop))
(buffer-substring-no-properties beg end))))
(provide 'hcel-utils)
;;; hcel-utils.el ends here.
|
