Add org-roam-backlinks building

This commit is contained in:
Jethro Kuan
2020-01-21 23:30:33 +08:00
parent 294964b957
commit 104151853a

View File

@ -1,8 +1,21 @@
(require 'deft) (require 'deft)
(require 'dash)
(require 'ht)
(defgroup org-roam nil
"Roam Research replica in Org-mode."
:group 'org
:prefix "org-roam-")
(defcustom org-roam-zettel-indicator "§" (defcustom org-roam-zettel-indicator "§"
"Indicator in front of a zettel.") "Indicator in front of a zettel.")
(defvar org-roam-backlinks-buffer "*org-roam-backlinks*"
"Backlink buffer name.")
(defvar org-roam-hash-backlinks nil
"Cache containing backlinks for org-roam buffers.")
(defun org-roam-insert (file-name) (defun org-roam-insert (file-name)
"Finds a file, inserts it as a link with the base file name as the link name." "Finds a file, inserts it as a link with the base file name as the link name."
(interactive (list (completing-read "File: " (deft-find-all-files-no-prefix)))) (interactive (list (completing-read "File: " (deft-find-all-files-no-prefix))))
@ -26,6 +39,38 @@
search-term search-term
3))) 3)))
(defun org-roam-get-links-from-buffer (buffer)
"Returns a list of links from an Org buffer."
(with-current-buffer buffer
(org-element-map (org-element-parse-buffer) 'link
(lambda (link)
(let ((type (org-element-property :type link))
(path (org-element-property :path link)))
(when (and (string= type "file")
(string= (file-name-extension path) "org"))
path))))))
(defun org-roam-build-backlinks ()
(interactive)
(message "building backlinks...")
(let ((backlinks (ht)))
(-map (lambda (file)
(with-temp-buffer
(insert-file-contents file)
(-map (lambda (link)
(let* ((item (ht-get backlinks link))
(added-item (file-name-nondirectory file))
(updated (if (and item)
(if (member added-item item)
item
(cons added-item item))
(list added-item))))
(ht-set! backlinks link updated)))
(org-roam-get-links-from-buffer (current-buffer)))))
(deft-find-all-files))
(setq org-roam-hash-backlinks backlinks)))
(defun org-roam-new-file-named (slug) (defun org-roam-new-file-named (slug)
"Create a new file named SLUG. "Create a new file named SLUG.
SLUG is the short file name, without a path or a file extension." SLUG is the short file name, without a path or a file extension."
@ -42,4 +87,34 @@ SLUG is the short file name, without a path or a file extension."
(interactive) (interactive)
(org-roam-new-file-named (format-time-string "%Y-%m-%d" (current-time)))) (org-roam-new-file-named (format-time-string "%Y-%m-%d" (current-time))))
(defun org-roam-backlinks-split ()
"Split window and show backlinks."
(when (= (length (window-list)) 1)
(split-window-right))
(other-window 1)
(switch-to-buffer org-roam-backlinks-buffer)
(other-window -1))
(defun org-roam-backlinks ()
(interactive)
"Show the backlinks for the current org-buffer."
(unless org-roam-hash-backlinks
(org-roam-build-backlinks))
(get-buffer-create org-roam-backlinks-buffer)
(unless (get-buffer-window org-roam-backlinks-buffer)
(org-roam-backlinks-split))
(let* ((file (file-name-nondirectory (buffer-file-name (current-buffer))))
(backlinks (ht-get org-roam-hash-backlinks file)))
(with-current-buffer org-roam-backlinks-buffer
(read-only-mode -1)
(erase-buffer)
(org-mode)
(make-local-variable 'org-return-follows-link)
(setq org-return-follows-link t)
(insert (format "Backlinks for %s:\n\n" file))
(-map (lambda (link)
(insert (format "- [[file:%s][%s]]\n" (expand-file-name link deft-directory) link))
) backlinks)
(read-only-mode +1))))
(provide 'org-roam) (provide 'org-roam)