blob: b78b65f5100b823a41a344e65bb1a1823d344ef0 (
plain)
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
|
;;; consult-dash.el --- Consult front-end for dash-docs -*- lexical-binding: t; -*-
;; Copyright (C) 2022 Ravi R Kiran
;; Author: Ravi R Kiran <aine.marina@gmail.com>
;; Keywords: consult, dash
;; 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:
;; consult-dash is the only interface function
;; To do
;; - Segment matches per docset
;; - Avoid concatenating commands through the shell
;;; Code:
(require 'dash-docs)
(require 'subr-x)
(require 'thingatpt)
(defvar-local consult-dash-docsets nil
"Docsets to use for this buffer")
(defvar consult-dash-sqlite-args "sqlite3 -list"
"Sqlite command-line arguments")
(advice-add #'dash-docs-buffer-local-docsets :around
(lambda (old-fun &rest args)
(let ((old (apply old-fun args)))
(delq nil (delete-dups (append old consult-dash-docsets))))))
(defvar consult-dash--history nil
"Previous queries for dash docs via consult")
(defvar consult-dash--docset-prefix "DOCSET:"
"Prefix to identify docset boundaries")
(defun consult-dash--builder-one-docset (docset pattern)
(let* ((query (dash-docs-sql-query (caddr docset)
(dash-docs-sub-docset-name-in-pattern pattern
(car docset))))
(cmd (concat "echo " consult-dash--docset-prefix
(shell-quote-argument (car docset))
"; "
consult-dash-sqlite-args
" "
(shell-quote-argument (cadr docset))
" "
(shell-quote-argument query)
"; ")))
cmd))
;; Is there a better way to run multiple commands when using consult--async-command?
(defun consult-dash--builder (input)
(pcase-let ((`(,arg . ,opts) (consult--command-split input)))
(unless (string-blank-p arg)
(when-let* ((docsets (dash-docs-maybe-narrow-docsets arg))
(cmds (mapcar (lambda (ds) (consult-dash--builder-one-docset ds arg)) docsets)))
(list :command (list "sh" "-c" (apply #'concat cmds))
:highlight (cdr (consult--default-regexp-compiler arg 'basic t)))))))
(defun consult-dash--with-buffer-context (func)
"Ensure that FUNC is called with the correct buffer context"
(let ((buf (current-buffer)))
(lambda (&rest args)
(with-current-buffer buf
(apply func args)))))
(defvar consult-dash--current-docset nil
"Stored current docset output for chunked calls to consult-dash--format")
(defun consult-dash--format (lines)
(let ((candidates)
(current-candidate))
(save-match-data
(dolist (str lines)
(setq current-candidate (split-string str "|" t))
(if (= 1 (length current-candidate))
;; FIXME: If we do not find the right prefix, we should raise an error
(when (string-prefix-p consult-dash--docset-prefix str)
(setq consult-dash--current-docset (substring str (length consult-dash--docset-prefix))))
(let ((name (cadr current-candidate))
(type (car current-candidate))
(path (caddr current-candidate))
(anchor (cadddr current-candidate)))
(add-face-text-property 0 (length name) 'consult-key nil name)
(put-text-property 0 (length name)
'consult-dash-docinfo
(list consult-dash--current-docset type path anchor)
name)
(push (list
name ;; replaces(format "%s (%s)" name type)
consult-dash--current-docset
current-candidate)
candidates)))))
(nreverse candidates)))
(defun consult-dash--group (candidate transform)
(if transform
candidate
(car (get-text-property 0 'consult-dash-docinfo candidate))))
(defun consult-dash--annotate (candidate)
(seq-let (docset-name type filename anchor) (get-text-property 0 'consult-dash-docinfo candidate)
(format " %s %s: %s%s" docset-name type filename (if anchor (format "#%s" anchor) ""))))
(defun consult-dash-candidate-url (candidate)
(seq-let (docset-name type filename anchor) (get-text-property 0 'consult-dash-docinfo candidate)
(dash-docs-result-url docset-name filename anchor)))
(defun consult-dash-yank-candidate-url (candidate)
(if-let (url (consult-dash-candidate-url candidate))
(kill-new url)
(message "No URL for this candidate")))
(defun consult-dash--open-url (candidate)
(seq-let (docset-name type filename anchor) (get-text-property 0 'consult-dash-docinfo candidate)
(funcall dash-docs-browser-func (dash-docs-result-url docset-name filename anchor))))
(defun consult-dash (&optional initial)
(interactive)
(dash-docs-create-common-connections)
(dash-docs-create-buffer-connections)
(setq consult-dash--current-docset nil)
(when-let* ((builder (consult-dash--with-buffer-context #'consult-dash--builder))
(search-result (consult--read
(consult--async-command builder
(consult--async-transform consult-dash--format)
(consult--async-highlight builder))
:prompt "Dash: "
:require-match t
:group #'consult-dash--group
:lookup #'consult--lookup-cdr
:category 'consult-dash-result
:annotate #'consult-dash--annotate
:initial (consult--async-split-initial initial)
:add-history (consult--async-split-thingatpt 'symbol)
:history '(:input consult-dash--history))))
(dash-docs-browse-url search-result)))
(defun consult-dash-at-point ()
(interactive)
(consult-dash (thing-at-point 'symbol)))
;; Embark integration
(with-eval-after-load "embark"
(embark-define-keymap consult-dash-embark-keymap
"Actions for consult dash results"
("RET" consult-dash--open-url)
("y" consult-dash-yank-candidate-url))
(add-to-list 'embark-keymap-alist
'(consult-dash-result . consult-dash-embark-keymap)))
;; Marginalia integration
(with-eval-after-load "marginalia"
(defun consult-dash--annotate-marginalia (candidate)
(seq-let (docset-name type filename anchor) (get-text-property 0 'consult-dash-docinfo candidate)
(when (and type filename docset-name)
(marginalia--fields
(docset-name)
(type)
((format "%s%s" filename (if anchor (format "#%s" anchor) "")))))))
(add-to-list 'marginalia-annotator-registry
'(consult-dash-result consult-dash--annotate-marginalia)))
(provide 'consult-dash)
;;; consult-dash.el ends here
|
