summaryrefslogtreecommitdiffhomepage
path: root/lib/doc/jao-org-focus.el
blob: ac33df9c2447bd4cf74381a0c174bfd8ff9e5a27 (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
;;; jao-org-focus.el --- focusing on org subtrees  -*- lexical-binding: t; -*-

;; Copyright (C) 2025  Jose Antonio Ortega Ruiz

;; Author: Jose Antonio Ortega Ruiz <mail@jao.io>
;; Keywords: docs

;; 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 <https://www.gnu.org/licenses/>.

;;; Commentary:

;; Miscellanous utilities for working with org files

(require 'org)

;;; focus on subtree
(defvar-local jao-org-focus--parent nil)
(defvar-local jao-org-focus--section nil)

(defun jao-org-focus ()
  "Pop creatingly to an indirect buffer focused on the encloing subtree.

When invoked on an indirect buffer, pops back to its base."
  (interactive)
  (if-let* ((b (get-buffer (or jao-org-focus--parent ""))))
      (pop-to-buffer b)
    (when-let* ((elem (org-element-at-point))
                (header (if (eq 'headline (org-element-type elem))
                            elem
                          (org-previous-visible-heading 1)
                          (org-element-at-point)))
                (title (org-element-property :title header))
                (parent (buffer-name))
                (bname (format "%s [%s]" title parent)))
      (if-let* ((b (get-buffer bname)))
          (pop-to-buffer b)
        (clone-indirect-buffer bname t)
        (setq jao-org-focus--parent parent
              jao-org-focus--section title)
        (org-narrow-to-subtree)
        (show-subtree)))))

(defun jao-org-focus-redisplay ()
  "Redisplay a focused buffer.

Useful when its parent has been reorganised and the narrowing is out of
sync."
  (interactive)
  (when-let* ((title jao-org-focus--section))
    (widen)
    (goto-char (point-min))
    (when (re-search-forward (format "\\*+ %s" title) nil t)
      (org-narrow-to-subtree)
      (beginning-of-line))))

(defun jao-org-focus-redisplay-children ()
  "Find focused children and redisplay them."
  (interactive)
  (dolist (b (jao-org-focus-list))
    (with-current-buffer b (jao-org-focus-redisplay))))

(defun jao-org-focus-list (&optional any-parent)
  "List of buffers that are focusing on a subtree of this one or its parent."
  (let ((n (or jao-org-focus--parent (buffer-name))))
    (seq-filter (lambda (b)
                  (let ((p (buffer-local-value 'jao-org-focus--parent b)))
                    (and p (or any-parent (string= n p)))))
                (buffer-list))))

(defvar jao-org-focus--focused-history nil)

(defun jao-org-focus-switch (arg)
  "Read with completion a focused child and pop to it.

With arg, offer to switch to all children, regardless of their parent."
  (interactive "P")
  (let ((fl (mapcar 'buffer-name (jao-org-focus-list arg))))
    (unless fl (error "No focused children"))
    (pop-to-buffer
     (completing-read "Focused child: " fl
                      nil t nil 'jao-org-focus--focused-history))))

(defvar jao-org-focus-consult-buffer-source
  `(:name "Focus buffers"
    :category jao-org-focus-buffers
    :action switch-to-buffer
    :hidden t
    :narrow ,(cons ?o "focus")
    :history jao-org-focus--focused-history
    :items ,(lambda () (mapcar 'buffer-name (jao-org-focus-list t)))))

(provide 'jao-org-focus)
;;; jao-org.el ends here