awesome-emacs/org-roam
1
0
Fork 0
mirror of https://github.com/org-roam/org-roam synced 2025-09-16 15:56:48 -05:00
Code Issues Packages Projects Releases Wiki Activity

Refactor caches into their own variables

Browse Source
This commit is contained in:
Jethro Kuan
2020-02-11 16:19:59 +08:00
parent 152c3cecdc
commit 1432c7c9c2
1 changed files with 79 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
org-roam.el
View File

@@ -92,8 +92,17 @@ If called interactively, then PARENTS is non-nil."
(write-region "" nil filename nil 0))) (write-region "" nil filename nil 0)))
;;; Dynamic variables ;;; Dynamic variables
(defvar org-roam-cache nil (defvar org-roam-cache-initialized nil
"Cache containing backlinks for `org-roam' buffers.") "Boolean value indicating whether the cache is initialized.")
(defvar org-roam-forward-links-cache (make-hash-table :test #'equal)
"Cache containing forward links.")
(defvar org-roam-backward-links-cache (make-hash-table :test #'equal)
"Cache containing backward-links.")
(defvar org-roam-titles-cache (make-hash-table :test #'equal)
"Cache containing titles for org-roam files.")
(defvar org-roam-current-file nil (defvar org-roam-current-file nil
"Currently displayed file in `org-roam' buffer.") "Currently displayed file in `org-roam' buffer.")
@@ -101,7 +110,7 @@ If called interactively, then PARENTS is non-nil."
;;; Utilities ;;; Utilities
(defun org-roam--ensure-cache-built () (defun org-roam--ensure-cache-built ()
"Ensures that org-roam cache is built." "Ensures that org-roam cache is built."
(unless org-roam-cache (unless org-roam-cache-initialized
(org-roam--build-cache-async) (org-roam--build-cache-async)
(user-error "Your Org-Roam cache isn't built yet! Please wait"))) (user-error "Your Org-Roam cache isn't built yet! Please wait")))
@@ -116,9 +125,7 @@ If called interactively, then PARENTS is non-nil."
It first tries the cache. If the cache does not contain the file, It first tries the cache. If the cache does not contain the file,
it will return the title by loading the file." it will return the title by loading the file."
(if-let ((titles-cache (plist-get org-roam-cache :titles))) (or (gethash file org-roam-titles-cache)
(or (gethash file titles-cache)
(org-roam--extract-file-title file))
(org-roam--extract-file-title file))) (org-roam--extract-file-title file)))
(defun org-roam--find-files (dir) (defun org-roam--find-files (dir)
@@ -232,7 +239,7 @@ If `ABSOLUTE', return the absolute file-path. Else, return the relative file-pat
;;; Building the org-roam cache (asynchronously) ;;; Building the org-roam cache (asynchronously)
(defun org-roam--build-cache-async () (defun org-roam--build-cache-async ()
"Builds the cache asychronously, saving it into `org-roam-cache'." "Builds the cache asychronously, saving it into the org-roam caches."
(interactive) (interactive)
(async-start (async-start
`(lambda () `(lambda ()
@@ -336,43 +343,40 @@ If `ABSOLUTE', return the absolute file-path. Else, return the relative file-pat
:backward backward-links :backward backward-links
:titles file-titles))) :titles file-titles)))
(lambda (cache) (lambda (cache)
(setq org-roam-cache cache) (setq org-roam-forward-links-cache (plist-get cache :forward))
(setq org-roam-backward-links-cache (plist-get cache :backward))
(setq org-roam-titles-cache (plist-get cache :titles))
(setq org-roam-cache-initialized t)
(message "Org-roam cache built!")))) (message "Org-roam cache built!"))))
(defun org-roam--insert-item (item) (defun org-roam--insert-item (item)
"Insert `ITEM' into `org-roam-cache'. "Insert `ITEM' into org-roam caches.
`ITEM' is of the form: (:from from-path :to to-path :content preview-content) `ITEM' is of the form: (:from from-path :to to-path :content preview-content)
Before calling this function, `org-roam-cache' should be already populated." Before calling this function, `org-roam-cache' should be already populated."
(let ((forward-cache (plist-get org-roam-cache :forward))
(backward-cache (plist-get org-roam-cache :backward))
(title-cache (plist-get org-roam-cache :titles)))
(pcase-let ((`(:from ,p-from :to ,p-to :content ,content) item)) (pcase-let ((`(:from ,p-from :to ,p-to :content ,content) item))
;; Build forward-links ;; Build forward-links
(let ((links (gethash p-from forward-cache))) (let ((links (gethash p-from org-roam-forward-links-cache)))
(if links (if links
(puthash p-from (puthash p-from
(if (member p-to links) (if (member p-to links)
links links
(cons p-to links)) forward-cache) (cons p-to links)) org-roam-forward-links-cache)
(puthash p-from (list p-to) forward-cache))) (puthash p-from (list p-to) org-roam-forward-links-cache)))
;; Build backward-links ;; Build backward-links
(let ((contents-hash (gethash p-to backward-cache))) (let ((contents-hash (gethash p-to org-roam-backward-links-cache)))
(if contents-hash (if contents-hash
(if-let ((contents-list (gethash p-from contents-hash))) (if-let ((contents-list (gethash p-from contents-hash)))
(let ((updated (cons content contents-list))) (let ((updated (cons content contents-list)))
(puthash p-from updated contents-hash) (puthash p-from updated contents-hash)
(puthash p-to contents-hash backward-cache)) (puthash p-to contents-hash org-roam-backward-links-cache))
(progn (progn
(puthash p-from (list content) contents-hash) (puthash p-from (list content) contents-hash)
(puthash p-to contents-hash backward-cache))) (puthash p-to contents-hash org-roam-backward-links-cache)))
(let ((contents-hash (make-hash-table :test #'equal))) (let ((contents-hash (make-hash-table :test #'equal)))
(puthash p-from (list content) contents-hash) (puthash p-from (list content) contents-hash)
(puthash p-to contents-hash backward-cache)))) (puthash p-to contents-hash org-roam-backward-links-cache))))))
(setq org-roam-cache (list :forward forward-cache
:backward backward-cache
:titles title-cache)))))
(defun org-roam--parse-content () (defun org-roam--parse-content ()
"Parse the current buffer, and return a list of items for processing." "Parse the current buffer, and return a list of items for processing."
@@ -401,36 +405,28 @@ Before calling this function, `org-roam-cache' should be already populated."
This is equivalent to removing the node from the graph." This is equivalent to removing the node from the graph."
(with-current-buffer (current-buffer) (with-current-buffer (current-buffer)
(let ((file (file-truename (buffer-file-name buffer))) (let ((file (file-truename (buffer-file-name buffer))))
(forward-cache (plist-get org-roam-cache :forward))
(backward-cache (plist-get org-roam-cache :backward))
(titles-cache (plist-get org-roam-cache :titles)))
;; Step 1: Remove all existing links for file ;; Step 1: Remove all existing links for file
(when-let ((forward-links (gethash file forward-cache))) (when-let ((forward-links (gethash file org-roam-forward-links-cache)))
;; Delete backlinks to file ;; Delete backlinks to file
(dolist (link forward-links) (dolist (link forward-links)
(when-let ((backward-links (gethash link backward-cache))) (when-let ((backward-links (gethash link org-roam-backward-links-cache)))
(remhash file backward-links) (remhash file backward-links)
(puthash link backward-links backward-cache))) (puthash link backward-links org-roam-backward-links-cache)))
;; Clean out forward links ;; Clean out forward links
(remhash file forward-cache)) (remhash file org-roam-forward-links-cache))
;; Step 2: Remove from the title cache ;; Step 2: Remove from the title cache
(remhash file titles-cache) (remhash file org-roam-titles-cache))))
(setq org-roam-cache (list :forward forward-cache
:backward backward-cache
:titles titles-cache)))))
(defun org-roam--update-cache-title (buffer) (defun org-roam--update-cache-title (buffer)
"Inserts the `TITLE' of file in buffer into the cache." "Inserts the `TITLE' of file in buffer into the cache."
(when-let ((titles-cache (plist-get org-roam-cache :titles)) (when-let ((title (org-roam--extract-title buffer)))
(title (org-roam--extract-title buffer)))
(puthash (file-truename (buffer-file-name buffer)) (puthash (file-truename (buffer-file-name buffer))
title title
titles-cache) org-roam-titles-cache)))
(setq org-roam-cache (plist-put org-roam-cache :titles titles-cache))))
(defun org-roam--update-cache () (defun org-roam--update-cache ()
"Update `org-roam-cache' for the current buffer file." "Update org-roam caches for the current buffer file."
(save-excursion (save-excursion
(org-roam--clear-cache-for-buffer (current-buffer)) (org-roam--clear-cache-for-buffer (current-buffer))
;; Insert into title cache ;; Insert into title cache
@@ -438,7 +434,9 @@ This is equivalent to removing the node from the graph."
;; Insert new items ;; Insert new items
(let ((items (org-roam--parse-content))) (let ((items (org-roam--parse-content)))
(dolist (item items) (dolist (item items)
(org-roam--insert-item item))))) (org-roam--insert-item item)))
;; Rerender buffer
(org-roam--update-buffer)))
;;; Org-roam daily notes ;;; Org-roam daily notes
(defun org-roam-today () (defun org-roam-today ()
@@ -494,7 +492,7 @@ This is equivalent to removing the node from the graph."
(setq org-return-follows-link t) (setq org-return-follows-link t)
(insert (insert
(propertize buffer-title 'font-lock-face 'org-document-title)) (propertize buffer-title 'font-lock-face 'org-document-title))
(if-let ((backlinks (gethash file-path (plist-get org-roam-cache :backward)))) (if-let ((backlinks (gethash file-path org-roam-backward-links-cache)))
(progn (progn
(insert (format "\n\n* %d Backlinks\n" (insert (format "\n\n* %d Backlinks\n"
(hash-table-count backlinks))) (hash-table-count backlinks)))
@@ -564,7 +562,7 @@ Valid states are 'visible, 'exists and 'none."
1. If the cache does not yet exist, build it asynchronously. 1. If the cache does not yet exist, build it asynchronously.
2. Setup hooks for updating the cache, and the org-roam buffer." 2. Setup hooks for updating the cache, and the org-roam buffer."
(unless org-roam-cache (unless org-roam-cache-initialized
(org-roam--build-cache-async)) (org-roam--build-cache-async))
(add-hook 'post-command-hook #'org-roam--maybe-update-buffer nil t) (add-hook 'post-command-hook #'org-roam--maybe-update-buffer nil t)
(add-hook 'after-save-hook #'org-roam--update-cache)) (add-hook 'after-save-hook #'org-roam--update-cache))
@@ -586,7 +584,11 @@ This needs to be quick/infrequent, because this is run at
(file-exists-p (file-truename (buffer-file-name (current-buffer)))) (file-exists-p (file-truename (buffer-file-name (current-buffer))))
(not (string= org-roam-current-file (not (string= org-roam-current-file
(file-truename (buffer-file-name (current-buffer)))))) (file-truename (buffer-file-name (current-buffer))))))
(org-roam-update (file-truename (buffer-file-name (window-buffer))))))) (org-roam--update-buffer))))
(defun org-roam--update-buffer ()
"Update `orgo-roam-buffer'."
(org-roam-update (file-truename (buffer-file-name (window-buffer)))))
(define-minor-mode org-roam-mode (define-minor-mode org-roam-mode
"Global minor mode to automatically update the org-roam buffer." "Global minor mode to automatically update the org-roam buffer."
@@ -599,7 +601,6 @@ This needs to be quick/infrequent, because this is run at
(defun org-roam-build-graph () (defun org-roam-build-graph ()
"Build graphviz graph output." "Build graphviz graph output."
(org-roam--ensure-cache-built) (org-roam--ensure-cache-built)
(let ((forward-links (plist-get org-roam-cache :forward)))
(with-temp-buffer (with-temp-buffer
(insert "digraph {\n") (insert "digraph {\n")
(mapcar (lambda (file) (mapcar (lambda (file)
@@ -615,9 +616,9 @@ This needs to be quick/infrequent, because this is run at
(org-roam--get-id from-link) (org-roam--get-id from-link)
(org-roam--get-id to-link)))) (org-roam--get-id to-link))))
) )
forward-links) org-roam-forward-links-cache)
(insert "}") (insert "}")
(buffer-string)))) (buffer-string)))
(defun org-roam-show-graph () (defun org-roam-show-graph ()
"Generate the org-roam graph in SVG format, and display it using `org-roam-graph-viewer'." "Generate the org-roam graph in SVG format, and display it using `org-roam-graph-viewer'."