Refactor lang/org

modules/lang/org/+attach.el

@@ -1,7 +1,5 @@
 ;;; lang/org/+attach.el -*- lexical-binding: t; -*-
 
-(add-hook 'org-load-hook #'+org|init-attach)
-
 ;; I believe Org's native attachment system is over-complicated and litters
 ;; files with metadata I don't want. So I wrote my own, which:
 ;;
@@ -25,7 +23,37 @@
 
 
 ;;
-;; Packages
+;;; Bootstrap
+
+(setq org-attach-directory (expand-file-name +org-attach-dir org-directory)
+      org-download-image-dir org-attach-directory
+      org-download-heading-lvl nil
+      org-download-timestamp "_%Y%m%d_%H%M%S")
+
+;; A shorter link to attachments
+(add-to-list 'org-link-abbrev-alist (cons "attach" (abbreviate-file-name org-attach-directory)))
+
+(org-link-set-parameters
+ "attach"
+ :follow   (lambda (link) (find-file (expand-file-name link org-attach-directory)))
+ :complete (lambda (&optional _arg)
+             (+org--relpath (+org-link-read-file "attach" org-attach-directory)
+                            org-attach-directory))
+ :face     (lambda (link)
+             (if (file-exists-p (expand-file-name link org-attach-directory))
+                 'org-link
+               'error)))
+
+(after! projectile
+  (add-to-list 'projectile-globally-ignored-directories
+               (car (last (split-string +org-attach-dir "/" t)))))
+
+(after! recentf
+  (add-to-list 'recentf-exclude (format "%s.+$" (regexp-quote org-attach-directory))))
+
+
+;;
+;;; Packages
 
 (def-package! org-download
   :commands (org-download-dnd org-download-dnd-base64)
@@ -62,35 +90,3 @@
   (advice-add #'org-download--dir-2 :override #'ignore)
   (advice-add #'org-download--fullname
               :filter-return #'+org-attach*download-fullname))
-
-
-;;
-;; Bootstrap
-
-(defun +org|init-attach ()
-  (setq org-attach-directory (expand-file-name +org-attach-dir org-directory))
-  (setq-default org-download-image-dir org-attach-directory
-                org-download-heading-lvl nil
-                org-download-timestamp "_%Y%m%d_%H%M%S")
-
-  ;; A shorter link to attachments
-  (add-to-list 'org-link-abbrev-alist (cons "attach" (abbreviate-file-name org-attach-directory)))
-
-  (org-link-set-parameters
-   "attach"
-   :follow   (lambda (link) (find-file (expand-file-name link org-attach-directory)))
-   :complete (lambda (&optional _arg)
-               (+org--relpath (+org-link-read-file "attach" org-attach-directory)
-                              org-attach-directory))
-   :face     (lambda (link)
-               (if (file-exists-p (expand-file-name link org-attach-directory))
-                   'org-link
-                 'error)))
-
-  (after! projectile
-    (add-to-list 'projectile-globally-ignored-directories
-                 (car (last (split-string +org-attach-dir "/" t)))))
-
-  (after! recentf
-    (add-to-list 'recentf-exclude (format "%s.+$" (regexp-quote org-attach-directory)))))
-

modules/lang/org/+babel.el

@@ -1,7 +1,5 @@
 ;;; lang/org/+babel.el -*- lexical-binding: t; -*-
 
-(add-hook 'org-load-hook #'+org|init-babel)
-
 (defvar +org-babel-mode-alist
   '((cpp . C)
     (C++ . C)
@@ -16,11 +14,14 @@ For example, with (fish . shell) will cause #+BEGIN_SRC fish to load ob-shell.el
 when executed.")
 
 (defvar +org-babel-load-functions ()
-  "A list of functions for loading the current executing src block. They take
+  "A list of functions executed to load the current executing src block. They
-one argument (the language specified in the src block, as a string). Stops at
+take one argument (the language specified in the src block, as a string). Stops
-the first function to return non-nil.")
+at the first function to return non-nil.")
+
+
+;;
+;;; Bootstrap
 
-(defun +org|init-babel ()
 (setq org-src-fontify-natively t      ; make code pretty
       org-src-preserve-indentation t  ; use native major-mode indentation
       org-src-tab-acts-natively t
@@ -28,7 +29,7 @@ the first function to return non-nil.")
       org-confirm-babel-evaluate nil) ; you don't need my permission
 
 (defun +org*babel-lazy-load-library (info)
-    "Load babel libraries as needed when babel blocks are executed."
+  "Load babel libraries lazily when babel blocks are executed."
   (let* ((lang (nth 0 info))
          (lang (if (symbolp lang) lang (intern lang)))
          (lang (or (cdr (assq lang +org-babel-mode-alist))
@@ -53,11 +54,11 @@ the first function to return non-nil.")
   (cl-loop with fn = (if others #'not #'identity)
            for p in params
            if (funcall fn (eq (car p) key))
-             collect p)))
+           collect p))
 
 
 ;;
-;; Packages
+;;; Packages
 
 (def-package! ob-ipython
   :when (featurep! +ipython)
@@ -83,7 +84,6 @@ the first function to return non-nil.")
       ("\\*Python:.*"
        :slot 0 :side right :size 100
        :select nil :quit nil :transient nil)))
-  ;; TODO Add more popup styles
 
   ;; advices for remote kernel and org-src-edit
   (advice-add 'org-babel-edit-prep:ipython :override #'+org*org-babel-edit-prep:ipython)

modules/lang/org/+capture.el

@@ -1,7 +1,5 @@
 ;;; lang/org/+capture.el -*- lexical-binding: t; -*-
 
-(add-hook 'org-load-hook #'+org|init-capture)
-
 ;; Sets up some reasonable defaults, as well as two `org-capture' workflows that
 ;; I like:
 ;;
@@ -28,10 +26,14 @@ Is relative to `org-directory', unless it is absolute. Is used in Doom's default
 
 It is used in Doom's default `org-capture-templates'.")
 
-(defvar org-capture-templates
+
+;;
+;;; Bootstrap
+
+(setq org-capture-templates
       '(("t" "Personal todo" entry
          (file+headline +org-capture-todo-file "Inbox")
-     "* [ ] %?\n%i\n%a" :prepend t :kill-buffer t)
+         "* TODO %?\n%i\n%a" :prepend t :kill-buffer t)
         ("n" "Personal notes" entry
          (file+headline +org-capture-notes-file "Inbox")
          "* %u %?\n%i\n%a" :prepend t :kill-buffer t)
@@ -49,28 +51,18 @@ It is used in Doom's default `org-capture-templates'.")
          (file+headline +org-capture-project-notes-file "Unreleased")
          "* TODO %?\n%i\n%a" :prepend t :kill-buffer t)))
 
-
+(defvaralias '+org-capture-notes-file 'org-default-notes-file)
-(defvar org-default-notes-file nil)  ; defined in org.el
-
-
-;;
-(defun +org|init-capture ()
-  (dolist (var '(+org-capture-todo-file
-                 +org-capture-notes-file))
-    (set var (expand-file-name (symbol-value var) org-directory)))
-  (unless org-default-notes-file
-    (setq org-default-notes-file +org-capture-notes-file))
 
 (add-hook 'org-capture-after-finalize-hook #'+org-capture|cleanup-frame)
 
-  (defun +org*expand-variable-paths (file)
+(defun +org*capture-expand-variable-file (file)
   "If a variable is used for a file path in `org-capture-template', it is used
 as is, and expanded relative to `default-directory'. This changes it to be
 relative to `org-directory', unless it is an absolute path."
   (if (and (symbolp file) (boundp file))
       (expand-file-name (symbol-value file) org-directory)
     file))
-  (advice-add #'org-capture-expand-file :filter-args #'+org*expand-variable-paths)
+(advice-add #'org-capture-expand-file :filter-args #'+org*capture-expand-variable-file)
 
 (defun +org*prevent-save-prompts-when-refiling (&rest _)
   "Fix #462: when refiling from org-capture, Emacs prompts to kill the
@@ -92,4 +84,4 @@ underlying, modified buffer. This fixes that."
   (add-hook 'org-capture-mode-hook #'evil-insert-state))
 
 (when (featurep! :ui doom-dashboard)
-    (add-hook '+doom-dashboard-inhibit-functions #'+org-capture-frame-p)))
+  (add-hook '+doom-dashboard-inhibit-functions #'+org-capture-frame-p))

modules/lang/org/+export.el

@@ -1,7 +1,5 @@
 ;;; lang/org/+export.el -*- lexical-binding: t; -*-
 
-(add-hook 'org-load-hook #'+org|init-export)
-
 ;; I don't have any beef with org's built-in export system, but I do wish it
 ;; would export to a central directory (by default), rather than
 ;; `default-directory'. This is because all my org files are usually in one
@@ -14,7 +12,6 @@ path too.")
 
 
 ;;
-(defun +org|init-export ()
 (setq org-export-backends '(ascii html latex md)
       org-publish-timestamp-directory (concat doom-cache-dir "org-timestamps/"))
 
@@ -40,4 +37,4 @@ file isn't in `org-directory'."
           (make-directory dir t))
         (setq args (list extension subtreep dir)))))
   args)
-  (advice-add #'org-export-output-file-name :filter-args #'+org*export-output-file-name))
+(advice-add #'org-export-output-file-name :filter-args #'+org*export-output-file-name)

modules/lang/org/+present.el

@@ -1,7 +1,5 @@
 ;;; lang/org/+present.el -*- lexical-binding: t; -*-
 
-(add-hook 'org-load-hook #'+org|init-present)
-
 (defvar +org-present-text-scale 7
   "The `text-scale-amount' for `org-tree-slide-mode'.")
 
@@ -10,7 +8,7 @@
 ;; Packages
 
 (def-package! ox-reveal
-  :defer t
+  :after ox
   :init
   ;; Fix #1127, where ox-reveal adds an errant entry to
   ;; `org-structure-template-alist'
@@ -34,18 +32,10 @@
         :n [left]  #'org-tree-slide-move-previous-tree)
 
   (add-hook! 'org-tree-slide-mode-after-narrow-hook
-    #'(+org-present|detect-slide +org-present|add-overlays org-display-inline-images))
+    #'(+org-present|detect-slide
+       +org-present|add-overlays
+       org-display-inline-images))
 
   (add-hook 'org-tree-slide-mode-hook #'+org-present|init-org-tree-window)
   (advice-add #'org-tree-slide--display-tree-with-narrow
               :around #'+org-present*narrow-to-subtree))
-
-
-(def-package! centered-window :commands centered-window-mode)
-
-
-;;
-;; Bootstrap
-
-(defun +org|init-present ()
-  (require 'ox-reveal))

modules/lang/org/autoload/org-link.el

@@ -13,3 +13,20 @@
     (format "%s:%s"
             key
             (file-relative-name file dir))))
+
+;;;###autoload
+(defun +org-inline-data-image (_protocol link _description)
+  "Interpret LINK as base64-encoded image data."
+  (base64-decode-string link))
+
+;;;###autoload
+(defun +org-image-link (protocol link _description)
+  "Interpret LINK as base64-encoded image data."
+  (when (image-type-from-file-name link)
+    (if-let* ((buf (url-retrieve-synchronously (concat protocol ":" link))))
+        (with-current-buffer buf
+          (goto-char (point-min))
+          (re-search-forward "\r?\n\r?\n" nil t)
+          (buffer-substring-no-properties (point) (point-max)))
+      (message "Download of image \"%s\" failed" link)
+      nil)))

modules/lang/org/config.el

@@ -1,8 +1,5 @@
 ;;; lang/org/config.el -*- lexical-binding: t; -*-
 
-;; FIXME deprecated
-(define-obsolete-variable-alias '+org-dir 'org-directory "2.1.0")
-
 ;; Changed org defaults (should be set before org loads)
 (defvar org-directory "~/org/")
 (defvar org-modules
@@ -17,78 +14,16 @@
     ;; org-rmail
     ))
 
-;; Sub-modules
-(if (featurep! +attach)  (load! "+attach"))
-(if (featurep! +babel)   (load! "+babel"))
-(if (featurep! +capture) (load! "+capture"))
-(if (featurep! +export)  (load! "+export"))
-(if (featurep! +present) (load! "+present"))
-;; TODO (if (featurep! +publish) (load! "+publish"))
-
-(doom-load-packages-incrementally
- '(calendar find-func format-spec org-macs org-compat
-   org-faces org-entities org-list org-pcomplete org-src
-   org-footnote org-macro ob org org-agenda org-capture))
-
 
 ;;
-;; Packages
+;;; Bootstrap
 
-;; `toc-org'
+(def-package! org
-(setq toc-org-hrefify-default "org")
+  :defer-incrementally
-
+  (calendar find-func format-spec org-macs org-compat org-faces org-entities
-(def-package! evil-org
+   org-list org-pcomplete org-src org-footnote org-macro ob org org-agenda
-  :when (featurep! :feature evil +everywhere)
+   org-capture)
-  :hook (org-mode . evil-org-mode)
   :init
-  (defvar evil-org-key-theme '(navigation insert textobjects))
-  (defvar evil-org-special-o/O '(table-row))
-  (add-hook 'org-load-hook #'+org|setup-evil)
-  (add-hook 'evil-org-mode-hook #'evil-normalize-keymaps)
-  :config
-  ;; change `evil-org-key-theme' instead
-  (advice-add #'evil-org-set-key-theme :override #'ignore)
-  (def-package! evil-org-agenda
-    :after org-agenda
-    :config (evil-org-agenda-set-keys)))
-
-(def-package! org-pdfview
-  :when (featurep! :tools pdf)
-  :commands (org-pdfview-open)
-  :init
-  (after! org
-    (delete '("\\.pdf\\'" . default) org-file-apps)
-    ;; org links to pdf files are opened in pdf-view-mode
-    (add-to-list 'org-file-apps '("\\.pdf\\'" . (lambda (_file link) (org-pdfview-open link)))) 
-    ;; support for links to specific pages
-    (add-to-list 'org-file-apps '("\\.pdf::\\([[:digit:]]+\\)\\'" . (lambda (_file link) (org-pdfview-open link))))))
-
-(def-package! org-yt
-  :after org
-  :config
-  (defun +org-inline-data-image (_protocol link _description)
-    "Interpret LINK as base64-encoded image data."
-    (base64-decode-string link))
-
-  (defun +org-image-link (protocol link _description)
-    "Interpret LINK as base64-encoded image data."
-    (when (image-type-from-file-name link)
-      (if-let* ((buf (url-retrieve-synchronously (concat protocol ":" link))))
-          (with-current-buffer buf
-            (goto-char (point-min))
-            (re-search-forward "\r?\n\r?\n" nil t)
-            (buffer-substring-no-properties (point) (point-max)))
-        (message "Download of image \"%s\" failed" link)
-        nil)))
-
-  (org-link-set-parameters "http"  :image-data-fun #'+org-image-link)
-  (org-link-set-parameters "https" :image-data-fun #'+org-image-link)
-  (org-link-set-parameters "img"   :image-data-fun #'+org-inline-data-image))
-
-
-;;
-;; Bootstrap
-
   (add-hook! 'org-load-hook
     #'(+org|setup-ui
        +org|setup-popup-rules
@@ -112,9 +47,73 @@
        +org|smartparens-compatibility-config
        +org|unfold-to-2nd-level-or-point))
 
+  :config
+  ;; Sub-modules
+  (if (featurep! +attach)  (load! "+attach"))
+  (if (featurep! +babel)   (load! "+babel"))
+  (if (featurep! +capture) (load! "+capture"))
+  (if (featurep! +export)  (load! "+export"))
+  (if (featurep! +present) (load! "+present")))
+
 
 ;;
-;; `org-mode' hooks
+;;; Packages
+
+;; `toc-org'
+(setq toc-org-hrefify-default "gh")
+(defun +org*unfold-toc (&rest _)
+  (save-excursion
+    (when (re-search-forward toc-org-toc-org-regexp (point-max) t)
+      (+org/open-fold))))
+(advice-add #'toc-org-insert-toc :before #'+org*unfold-toc)
+
+(def-package! evil-org
+  :when (featurep! :feature evil +everywhere)
+  :hook (org-mode . evil-org-mode)
+  :init
+  (defvar evil-org-key-theme '(navigation insert textobjects))
+  (defvar evil-org-special-o/O '(table-row))
+  (add-hook 'org-load-hook #'+org|setup-evil-keybinds)
+  (add-hook 'evil-org-mode-hook #'evil-normalize-keymaps)
+  :config
+  ;; change `evil-org-key-theme' instead
+  (advice-add #'evil-org-set-key-theme :override #'ignore)
+  (def-package! evil-org-agenda
+    :after org-agenda
+    :config (evil-org-agenda-set-keys)))
+
+(def-package! org-pdfview
+  :when (featurep! :tools pdf)
+  :commands (org-pdfview-open)
+  :init
+  (delete '("\\.pdf\\'" . default) org-file-apps)
+  ;; org links to pdf files are opened in pdf-view-mode
+  (add-to-list 'org-file-apps '("\\.pdf\\'" . (lambda (_file link) (org-pdfview-open link))))
+  ;; support for links to specific pages
+  (add-to-list 'org-file-apps '("\\.pdf::\\([[:digit:]]+\\)\\'" . (lambda (_file link) (org-pdfview-open link)))))
+
+(def-package! org-crypt ; built-in
+  :commands org-encrypt-entries
+  :hook (org-reveal-start . org-decrypt-entry)
+  :init
+  (add-hook! 'org-mode-hook
+    (add-hook 'before-save-hook 'org-encrypt-entries nil t))
+  :config
+  (setq org-tags-exclude-from-inheritance '("crypt")
+        org-crypt-key user-mail-address))
+
+(def-package! org-clock ; built-in
+  :commands org-clock-save
+  :hook (org-mode . org-clock-load)
+  :init
+  (setq org-clock-persist 'history
+        org-clock-persist-file (concat doom-etc-dir "org-clock-save.el"))
+  :config
+  (add-hook 'kill-emacs-hook #'org-clock-save))
+
+
+;;
+;;; `org-mode' hooks
 
 (defun +org|unfold-to-2nd-level-or-point ()
   "My version of the 'overview' #+STARTUP option: expand first-level headings.
@@ -163,7 +162,7 @@ unfold to point on startup."
 
 
 ;;
-;; `org-load' hooks
+;;; `org-load' hooks
 
 (defun +org|setup-agenda ()
   (unless org-agenda-files
@@ -179,6 +178,7 @@ unfold to point on startup."
    org-agenda-start-on-weekday nil
    org-agenda-start-day "-3d"))
 
+
 (defun +org|setup-popup-rules ()
   "Defines popup rules for org-mode (does nothing if :ui popup is disabled)."
   (set-popup-rules!
@@ -189,6 +189,7 @@ unfold to point on startup."
       ("^\\*Org Src"       :size 0.3 :quit nil :select t :autosave t :ttl nil)
       ("^CAPTURE.*\\.org$" :size 0.2 :quit nil :select t :autosave t))))
 
+
 (defun +org|setup-pretty-code ()
   "Setup the default pretty symbols for"
   (set-pretty-symbols! 'org-mode
@@ -196,6 +197,7 @@ unfold to point on startup."
     :src_block "#+BEGIN_SRC"
     :src_block_end "#+END_SRC"))
 
+
 (defun +org|setup-custom-links ()
   "Set up custom org links."
   (setq org-link-abbrev-alist
@@ -235,7 +237,14 @@ unfold to point on startup."
   (+org-def-link "org" org-directory)
   (+org-def-link "doom" doom-emacs-dir)
   (+org-def-link "doom-docs" doom-docs-dir)
-  (+org-def-link "doom-modules" doom-modules-dir))
+  (+org-def-link "doom-modules" doom-modules-dir)
+
+  (def-package! org-yt
+    :config
+    (org-link-set-parameters "http"  :image-data-fun #'+org-image-link)
+    (org-link-set-parameters "https" :image-data-fun #'+org-image-link)
+    (org-link-set-parameters "img"   :image-data-fun #'+org-inline-data-image)))
+
 
 (defun +org|setup-ui ()
   "Configures the UI for `org-mode'."
@@ -272,8 +281,8 @@ unfold to point on startup."
    org-startup-with-inline-images nil
    org-tags-column 0
    org-todo-keywords
-   '((sequence "[ ](t)" "[-](p)" "[?](m)" "|" "[X](d)")
+   '((sequence "TODO(t)" "|" "DONE(d)")
-     (sequence "TODO(T)" "|" "DONE(D)")
+     (sequence "[ ](T)" "[-](p)" "[?](m)" "|" "[X](D)")
      (sequence "NEXT(n)" "WAITING(w)" "LATER(l)" "|" "CANCELLED(c)"))
    org-todo-keyword-faces
    '(("[-]" :inherit (font-lock-constant-face bold))
@@ -303,6 +312,7 @@ unfold to point on startup."
                                 :background nil t))))
   (add-hook 'doom-load-theme-hook #'+org|update-latex-preview-background-color))
 
+
 (defun +org|setup-keybinds ()
   "Sets up org-mode and evil keybindings. Tries to fix the idiosyncrasies
 between the two."
@@ -331,7 +341,8 @@ between the two."
         [remap doom/backward-to-bol-or-indent]          #'org-beginning-of-line
         [remap doom/forward-to-last-non-comment-or-eol] #'org-end-of-line))
 
-(defun +org|setup-evil (&rest args)
+
+(defun +org|setup-evil-keybinds (&rest args)
   ;; In case this hook is used in an advice on `evil-org-set-key-theme', this
   ;; prevents recursive requires.
   (unless args (require 'evil-org))
@@ -420,6 +431,7 @@ between the two."
           "G" (λ! (org-clock-goto 'select))
           "x" #'org-clock-cancel)))
 
+
 (defun +org|setup-hacks ()
   "Getting org to behave."
   ;; Don't open separate windows
@@ -469,29 +481,7 @@ conditions where a window's buffer hasn't changed at the time this hook is run."
 
 
 ;;
-;; Built-in libraries
+;;; In case org has already been loaded (or you're running `doom/reload')
 
-(def-package! org-crypt ; built-in
-  :commands org-encrypt-entries
-  :hook (org-reveal-start . org-decrypt-entry)
-  :init
-  (add-hook! 'org-mode-hook
-    (add-hook 'before-save-hook 'org-encrypt-entries nil t))
-  :config
-  (setq org-tags-exclude-from-inheritance '("crypt")
-        org-crypt-key user-mail-address))
-
-(def-package! org-clock
-  :commands org-clock-save
-  :hook (org-mode . org-clock-load)
-  :defer-incrementally t
-  :init
-  (setq org-clock-persist 'history
-        org-clock-persist-file (concat doom-etc-dir "org-clock-save.el"))
-  :config
-  (add-hook 'kill-emacs-hook #'org-clock-save))
-
-
-;; In case org has already been loaded (or you're running `doom/reload')
 (when (featurep 'org)
   (run-hooks 'org-load-hook))