blob: 51cea0b19d17853848680d3aa34e41c05d7d1692 (
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
181
182
183
184
185
186
187
188
189
|
;;; nroam.el --- Org-roam backlinks within org-mode buffers -*- lexical-binding: t; -*-
;; Copyright (C) 2021 Nicolas Petton
;; Author: Nicolas Petton <nicolas@petton.fr>
;; URL: https://github.com/NicolasPetton/nroam
;; Keywords: outlines, convenience
;; Version: 0.9.0
;; Package-Requires: ((emacs "26.1") (org-roam "1.2.3") (org "9.4.4"))
;; 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 <http://www.gnu.org/licenses/>.
;;; Commentary:
;; nroam is a supplementary package for org-roam that replaces the backlink side
;; buffer of Org-roam. Instead, it displays org-roam backlinks at the end of
;; org-roam buffers.
;;
;; To setup nroam for all org-roam buffers, evaluate the following:
;; (add-hook 'org-mode-hook #'nroam-setup-maybe)
;;; Code:
(require 'org-element)
(require 'org-capture)
(require 'seq)
(require 'subr-x)
(require 'bookmark)
(require 'nroam-utils)
(require 'nroam-backlinks)
(require 'nroam-unlinked)
(defvar nroam--sections nil
"List of functions to be called to insert sections in nroam buffers.")
(defvar nroam--sections-map
(let ((map (make-sparse-keymap)))
(define-key map (kbd "C-c C-c") #'nroam-update)
(define-key map (kbd "RET") #'nroam-return)
map)
"Local keymap within nroam sections.")
(defun nroam-register-section (function)
"Add FUNCTION as a section in nroam."
(add-to-list 'nroam--sections function t))
(defvar-local nroam-start-marker nil)
(defvar-local nroam-end-marker nil)
(defmacro with-nroam-markers (&rest body)
"Evaluate BODY.
Make the region inserted by BODY read-only, and marked with
`nroam-start-marker' and `nroam-end-marker'."
(declare (indent 0) (debug t))
`(let ((beg (point)))
(set-marker nroam-start-marker (point))
,@body
(let* ((end (point))
(ov (make-overlay beg end)))
(overlay-put ov 'keymap nroam--sections-map)
(put-text-property beg (1+ beg) 'front-sticky '(read-only))
(put-text-property beg end 'read-only t)
;; Add a non-read-only newline so that text can be inserted at the end of
;; the buffer.
(insert "\n"))
(set-marker nroam-end-marker (point))))
;;;###autoload
(defun nroam-setup-maybe ()
"Setup nroam for the current buffer iff an `org-roam' buffer."
(when (nroam--org-roam-file-p)
(nroam-mode)))
;;;###autoload
(define-minor-mode nroam-mode
"Show nroam sections at the end of org-roam buffers."
:lighter " nroam"
(if nroam-mode
(progn
(add-hook 'before-save-hook #'nroam--prune nil t)
(add-hook 'after-save-hook #'nroam--update-maybe nil t)
(nroam--maybe-insert-immediately))
(remove-hook 'before-save-hook #'nroam--prune t)
(remove-hook 'after-save-hook #'nroam--update-maybe t)
(nroam--prune)))
(defun nroam--maybe-insert-immediately ()
"Insert nroam sections iff the buffer file exists."
(when (file-exists-p buffer-file-name)
(nroam-update)))
;;;###autoload
(defun nroam-return ()
"Open nroam link or push button at point."
(interactive)
(if (get-text-property (point) 'button)
(call-interactively #'push-button)
(nroam--follow-link)))
;;;###autoload
(defun nroam-update ()
"Update nroam sections for the current buffer."
(interactive)
(nroam--setup-markers)
(nroam--prune)
(nroam--insert))
(defun nroam--org-roam-file-p ()
"Return non-nil if the current buffer is an `org-roam' buffer."
(org-roam--org-roam-file-p))
(defun nroam--update-maybe ()
"Update backlinks when nroam is enabled."
(when nroam-mode
(nroam-update)))
(defun nroam--setup-markers ()
"Setup the current buffer with markers for nroam."
(unless (nroam--sections-inserted-p)
(progn
(setq nroam-start-marker (make-marker))
(setq nroam-end-marker (make-marker)))))
(defun nroam--sections-inserted-p ()
"Return non-nil if the current buffer has nroam sections inserted."
(and (markerp nroam-start-marker)
(marker-position nroam-start-marker)))
(defun nroam-goto ()
"Move point to the beginning of nroam sections if any."
(interactive)
(when (nroam--sections-inserted-p)
(setf (point) (marker-position nroam-start-marker))))
(defun nroam--prune ()
"Remove nroam sections from the current buffer."
(let ((inhibit-read-only t))
(save-excursion
(goto-char (point-min))
(with-buffer-modified-unmodified
(when (nroam--sections-inserted-p)
(delete-region nroam-start-marker nroam-end-marker))))))
(defun nroam--insert ()
"Insert nroam sections in the current buffer."
(with-buffer-modified-unmodified
(save-excursion
(goto-char (point-max))
(unless (bobp)
(nroam--ensure-empty-line))
(with-nroam-markers
(nroam--insert-heading 1 "Backlinks" "noexport")
(nroam--do-separated-by-newlines #'funcall nroam--sections))
(nroam--set-sections-visibility))))
(defun nroam--set-sections-visibility ()
"Set nroam section visibility according to `org-set-startup-visibility'."
(when (nroam--sections-inserted-p)
(save-restriction
(narrow-to-region nroam-start-marker nroam-end-marker)
(org-set-startup-visibility))))
(defun nroam--follow-link ()
"Follow backlink at point."
(when (get-text-property (point) 'nroam-link)
(let ((file (get-text-property (point) 'file))
(point (get-text-property (point) 'point)))
(org-open-file file t)
(goto-char point))))
(nroam-backlinks-register-section)
(nroam-unlinked-register-section)
(provide 'nroam)
;;; nroam.el ends here
|
