-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathconsult-org-roam.el
322 lines (298 loc) · 14.5 KB
/
consult-org-roam.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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
;;; consult-org-roam.el --- Consult integration for org-roam -*- lexical-binding: t; -*-
;; Copyright (C) 2022 jgru
;; Author: jgru <https://github.com/jgru>
;; Created: March 3rd, 2022
;; SPDX-License-Identifier: GPL-3.0-or-later
;; Version: 0.1
;; Homepage: https://github.com/jgru/consult-org-roam
;; Package-Requires: ((emacs "27.1") (org-roam "2.2.0") (consult "0.16"))
;;; Commentary:
;; This is a set of functions to use org-roam with consult.
;; This packages replaces org-roam's own completing read functions
;; with equivalent versions utilizing consult's internal API. By doing so,
;; one gains all advantages of consult which enhances Emacs' own
;; completing-read funcionality.
;;; Code:
;; ============================================================================
;;;; Dependencies
;; ============================================================================
(require 'org-roam)
(require 'consult)
(require 'consult-org-roam-buffer)
;; ============================================================================
;;;; Customize definitions
;; ============================================================================
(defgroup consult-org-roam nil
"Consult interface for org-roam."
:group 'org
:group 'convenience
:prefix "consult-org-roam-")
(defcustom consult-org-roam-grep-func #'consult-grep
"Function for searching files."
:type 'function
:group 'consult-org-roam)
;; ============================================================================
;;;; Functions
;; ============================================================================
;;;###autoload
(defun consult-org-roam-search (&optional initial)
"Search org-roam directory using `consult-org-roam-grep-func' with live-preview.
With an option for INITIAL input when called non-interactively.
The function is restricted to files with .org-suffix."
(interactive)
(let ((consult-ripgrep-args
(concat consult-ripgrep-args " --glob *.org"))
(consult-grep-args
(add-to-list 'consult-grep-args " --include *.org" t)))
(if initial
(funcall consult-org-roam-grep-func org-roam-directory (format "%s" initial))
(funcall consult-org-roam-grep-func org-roam-directory))))
(defun consult-org-roam--ids-to-files (ids)
"Take a bunch of IDS of org-roam-nodes and convert those into file paths."
(mapcar (lambda (id)
(org-roam-node-file (org-roam-node-from-id (car id))))
ids))
(defun consult-org-roam--open-or-capture (&optional other-window node-or-string)
"Take an `org-roam-node' and open it or take a string and capture it.
NODE-OR-STRING the `org-roam-node' or string.
If OTHER-WINDOW, visit the NODE in another window."
(if node-or-string
(if (org-roam-node-file node-or-string)
(org-roam-node-visit node-or-string other-window)
(org-roam-capture-
:node (org-roam-node-create :title node-or-string)
:props '(:finalize find-file)))))
;;;###autoload
(defun consult-org-roam-backlinks (&optional other-window)
"Select from list of all notes that link to the current note.
If OTHER-WINDOW, visit the NODE in another window."
(interactive current-prefix-arg)
(let* ((node (org-roam-node-at-point))
(ids (mapcar (lambda (el) (car el))(org-roam-db-query
[:select [source]
:from links
:where (= dest $s1)
:and (= type "id")]
(if node
(org-roam-node-id (org-roam-node-at-point))
(user-error "Buffer does not contain org-roam-nodes")))))
(chosen-node-or-str (if ids
(consult-org-roam-node-read ""
(lambda (n)
(if (org-roam-node-p n)
(if (member (org-roam-node-id n) ids)
t
nil))))
(user-error "No backlinks found"))))
(consult-org-roam--open-or-capture other-window chosen-node-or-str)))
;;;###autoload
(defun consult-org-roam-backlinks-recursive (&optional other-window)
"Select from list of all notes that link to the current note (recursively).
Compared to `consult-org-roam-backlinks' (the nonrecursive variant) this also
considers headline nodes without explicit links to their ancestor headline
and/or file nodes.
If OTHER-WINDOW, visit the NODE in another window."
(interactive current-prefix-arg)
(let* ((node (org-roam-node-at-point))
(ids (mapcar (lambda (el) (car el))(org-roam-db-query
[:with :recursive [
; Compute trees of headline nodes. org-roam does not store
; these natively.
(as (funcall headlines node_id ancestor_id) [
:select [node:id ancestor:id]
:from (on (join (as nodes node)
(as nodes ancestor))
(and (= node:file ancestor:file)
(> node:level ancestor:level)
(or (= node:level 1)
(= ancestor:level 0)
(and (= ancestor:level 1)
(LIKE node:olp
; TODO escape meta chars in title
(|| '"("
ancestor:title
'"%")))
(and (> ancestor:level 1)
(LIKE node:olp
; TODO escape meta chars in olp/title
(|| '"("
(funcall TRIM ancestor:olp '"()")
'" "
ancestor:title
'"%"))))))
:group-by node:id
:having (= ancestor:level (funcall MAX ancestor:level))])
(as (funcall links_tr id) [
:values [$s1]
:union
:select source
:from [links links_tr]
:where (and (= type "id")
(= dest links_tr:id))
:union
:select source
:from [(on (join links refs)
(and (= links:dest refs:ref)
(= links:type refs:type)))
links_tr]
:where (= refs:node_id links_tr:id)
:union
:select citations:node_id
:from [(on (join citations refs)
(and (= citations:cite_key refs:ref)
(= refs:type "cite")))
links_tr]
:where (= refs:node_id links_tr:id)
:union
:select headlines:node_id
:from [headlines, links_tr]
:where (= headlines:ancestor_id links_tr:id)])]
:select id
:from links_tr
:where (<> id $s1)]
(if node
(org-roam-node-id (org-roam-node-at-point))
(user-error "Buffer does not contain org-roam-nodes")))))
(chosen-node-or-str (if ids
(consult-org-roam-node-read ""
(lambda (n)
(if (org-roam-node-p n)
(if (member (org-roam-node-id n) ids)
t
nil))))
(user-error "No backlinks found"))))
(consult-org-roam--open-or-capture other-window chosen-node-or-str)))
;;;###autoload
(defun consult-org-roam-forward-links (&optional other-window)
"Select a forward link contained in the current buffer.
If OTHER-WINDOW, visit the NODE in another window."
(interactive)
(let ((id-links '())
(chosen-node-or-str nil))
(org-element-map (org-element-parse-buffer) 'link
(lambda (link)
(when (string= (org-element-property :type link) "id")
(push
(org-element-property :path link) id-links))))
(setq chosen-node-or-str (if id-links
(consult-org-roam-node-read ""
(lambda (n)
(if (org-roam-node-p n)
(if (member (org-roam-node-id n) id-links)
t
nil))))
(user-error "No forward links found")))
(consult-org-roam--open-or-capture other-window chosen-node-or-str)))
(defun consult-org-roam--node-file-p (node)
"Take NODE and return t if level 0.
This filters org-roam nodes to file nodes."
(= (org-roam-node-level node) 0))
;;;###autoload
(defun consult-org-roam-file-find (arg)
"Find org-roam node with preview, if ARG open in other window."
(interactive "P")
(let ((other-window (if arg t nil)))
(org-roam-node-find other-window nil #'consult-org-roam--node-file-p)))
;; Completing-read interface using consult. Override
;; `org-roam-node-read' so that each an every completing function
;; resorts to consult
(defun consult-org-roam-node-read (&optional initial-input filter-fn sort-fn
require-match prompt)
"Read and return an `org-roam-node' with the help of consult.
INITIAL-INPUT is the initial minibuffer prompt value.
FILTER-FN is a function to filter out nodes: it takes an `org-roam-node',
and when nil is returned the node will be filtered out.
SORT-FN is a function to sort nodes. See `org-roam-node-read-sort-by-file-mtime'
for an example sort function.filter-fn sort-fn
If REQUIRE-MATCH, the minibuffer prompt will require a match.
PROMPT is a string to show at the beginning of the mini-buffer,
defaulting to \"Node: \""
(let* ((nodes (org-roam-node-read--completions filter-fn sort-fn)) ;;
(prompt (or prompt "Node: "))
;; Sets state-func only when there are nodes to avoid errors
;; with empty roam-dirs
(state-func (when nodes
(consult-org-roam--node-preview)))
(node
(consult--read
nodes
:prompt prompt
:initial initial-input
:sort nil ;; cands are already sorted
:require-match require-match
:category 'org-roam-node
;;:history 'org-roam-node-history
:state state-func
:annotate (lambda (title)
(funcall org-roam-node-annotation-function
(get-text-property 0 'node title)))
;; Uses the DEFAULT argument of alist-get to return input in case the input is not found as key.
:lookup (lambda (selected candidates input narrow) (alist-get selected candidates input nil #'equal)))))
(if (org-roam-node-p node) (progn node)
(progn (org-roam-node-create :title node)))))
(defun consult-org-roam--node-preview ()
"Create preview function for nodes."
(let ((open (consult--temporary-files))
(preview (consult--buffer-preview))
(state (window-state-get)))
(lambda (action cand)
(when (eq action 'exit)
(progn
;; Restore saved window state
;; To move point to the original position
(window-state-put state)
(funcall open)))
(if (org-roam-node-p cand)
(funcall preview action
(and cand
(eq action 'preview)
(set-window-start
(selected-window)
(org-roam-node-point cand))
(funcall open (org-roam-node-file cand))))))))
;; Completing-read interface for references using consult. Override
;; `org-roam-ref-read' so that each an every completing function
;; regarding refs resorts to consult
(defun consult-org-roam-ref-read (&optional initial-input filter-fn)
"Read a ref and return its `org-roam-node' with the help of consult.
INITIAL-INPUT is the initial prompt value.
FILTER-FN is a function to filter out nodes: it takes an `org-roam-node',
and when nil is returned the node will be filtered out.
filtered out."
(let* ((refs (org-roam-ref-read--completions))
(refs (cl-remove-if-not (lambda (n)
(if filter-fn (funcall filter-fn (cdr n)) t)) refs))
(ref (consult--read
refs
:prompt "Refs: "
:initial initial-input
:predicate filter-fn
:require-match t
:category 'org-roam-ref
:history 'org-roam-ref-history
:state (consult-org-roam--node-preview)
:annotate (lambda (ref)
(funcall org-roam-ref-annotation-function ref))
:lookup #'consult--lookup-cdr)))
(progn ref)))
;;;###autoload
(define-minor-mode consult-org-roam-mode
"Toggle `consult-org-roam-mode' to integrate consult with org-roam.
By enabling `consult-org-roam-mode' the functions `org-roam-node-read' and
`org-roam-ref-read' are overriden by consults-org-roam's equivalents. Optional
argument ARG indicates whether the mode should be enabled or disabled."
:global t
:lighter " cor"
;; Add or remove advice when enabled respectively disabled
(if consult-org-roam-mode
(progn
(if consult-org-roam-buffer-enabled
(consult-org-roam-buffer-setup))
(advice-add #'org-roam-node-read :override #'consult-org-roam-node-read)
(advice-add #'org-roam-ref-read :override #'consult-org-roam-ref-read))
(progn
(consult-org-roam-buffer-teardown)
(advice-remove #'org-roam-node-read #'consult-org-roam-node-read)
(advice-remove #'org-roam-ref-read #'consult-org-roam-ref-read))))
(provide 'consult-org-roam)
;;; consult-org-roam.el ends here