exot/.emacs.d
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Improve implementation to find next started or open checkbox

Browse Source 
The algorithm has been simplified and has been commented where
appropriate (from my point of view).  An extensive docstring has been
added to describe the intention of the approch and its recursive nature.
This commit is contained in:
Daniel Borchmann 2024-07-12 08:58:01 +02:00
parent 1ea28a5823
commit f110d147fa
No known key found for this signature in database
GPG Key ID: 784AA8DF0CCDF625
1 changed files with 50 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

82
site-lisp/db-org.el
View File

@ -1430,18 +1430,25 @@ inserted template."
(insert "\n")))) (insert "\n"))))
(defun db/org-goto-first-open-checkbox-in-headline (&optional silent) (defun db/org-goto-first-open-checkbox-in-headline (&optional silent)
"Go to first open checkbox in the current subtree. "Move point to first started checkbox in the current headline.
First search for started checkboxes, i.e. [-], and if those are A started checkbox item is of the form “[-]”. The idea to move
not found, go to the first open checkbox, i.e. [ ]. If the item point there is to continue previously started work on the current
thus found contains a sublist of checkbox items on it's own, Org headline.
recursively repeat the search, until no more sublists exist that
contain open checkboxes.
If there's no such open checkbox, emit a message (unless SILENT If no started checkbox is found, move point to the first
is non-nil) and stay put. unstartetd checkbox “[ ]”. The idea is that this is where work
should continue if no partially completed item is present.
Do not search through branches, i.e., stop the search when the If there's neither a started or an open checkbox, emit a
message (unless SILENT is non-nil) and stay put.
If a checkbox is found this way and the checkbox has non-empty
contents, search for started or open checkboxes is continued in
this contents recursively, in the same way as described above.
The search for started or open checkboxes is not done in branches
of the current headline, i.e., the search is stopped when the
first sub-headline is found." first sub-headline is found."
(unless (derived-mode-p 'org-mode) (unless (derived-mode-p 'org-mode)
@ -1451,47 +1458,42 @@ first sub-headline is found."
(widen) (widen)
(org-back-to-heading 'invisible-ok) (org-back-to-heading 'invisible-ok)
(org-narrow-to-subtree) (org-narrow-to-subtree)
;; XXX: this needs a description of how the below algorithm works
(let ((ast (org-element-parse-buffer)) (let ((ast (-> (org-element-parse-buffer)
checkbox-pos (org-element-contents)
checkbox-node (-first-item) ; we skip the first headline
checkbox-pos-1) (org-element-contents)))
checkbox-node ; node found in the current run
checkbox-node-1 ; last node found, if any
)
(while ast (while ast
(when checkbox-pos (org-element-map (org-element-contents ast) '(item)
;; `checkbox-pos' might be nil when the found checkbox item is empty; in this case, `ast'
;; is not empty, and the following assignment will potentially delete the last known
;; position of a proper checkbox.
(setq checkbox-pos-1 checkbox-pos))
(setq checkbox-pos nil
checkbox-node nil)
(org-element-map ast '(item headline)
(lambda (node) (lambda (node)
(unless (eq node ast) (when (and (null checkbox-node)
(if (eq 'headline (org-element-type node))
nil ; Abort search to ignore headlines and everything that follows.
(when (and (null checkbox-pos)
(not (memq (org-element-property :checkbox node) (not (memq (org-element-property :checkbox node)
'(nil on)))) '(nil on))))
(setq checkbox-pos (org-element-contents-begin node) (setq checkbox-node node))
checkbox-node node))
;; Having this `when' separately and at the end of this function results in ;; Having this `when' separately and at the end of this function results in
;; `org-element-map' terminating the search as soon as a “[-]” is found. ;; `org-element-map' terminating the search as soon as a “[-]” is found. If no such
;; checkbox is ever found, we stick with the first open checkbox found in the previous
;; `when'.
(when (eq 'trans (org-element-property :checkbox node)) (when (eq 'trans (org-element-property :checkbox node))
(setq checkbox-pos (org-element-contents-begin node) (setq checkbox-node node)))
checkbox-node node))))) ;; Additional arguments to `org-element-map': stop at first non-nil result returned by
nil t) ;; FUN, and do not recurse into headlines.
nil t '(headline))
(setq ast checkbox-node)) (setq checkbox-node-1 (or checkbox-node checkbox-node-1)
ast checkbox-node
checkbox-node nil))
(cond (if checkbox-node-1
(checkbox-pos (goto-char checkbox-pos)) (goto-char (or (org-element-contents-begin checkbox-node-1)
(checkbox-pos-1 (goto-char checkbox-pos-1)) (org-element-begin checkbox-node-1)))
(t (unless silent (unless silent
(message "No open checkbox in subtree"))))))) (message "No open checkbox in subtree"))))))
(defun db/org-clock-goto-first-open-checkbox (&optional select) (defun db/org-clock-goto-first-open-checkbox (&optional select)
"Go to the currently clocked-in item or most recently clocked item. "Go to the currently clocked-in item or most recently clocked item.