org-indent.el (17338B)
1 ;;; org-indent.el --- Dynamic indentation for Org -*- lexical-binding: t; -*- 2 3 ;; Copyright (C) 2009-2023 Free Software Foundation, Inc. 4 ;; 5 ;; Author: Carsten Dominik <carsten.dominik@gmail.com> 6 ;; Keywords: outlines, hypermedia, calendar, wp 7 ;; URL: https://orgmode.org 8 ;; 9 ;; This file is part of GNU Emacs. 10 ;; 11 ;; GNU Emacs is free software: you can redistribute it and/or modify 12 ;; it under the terms of the GNU General Public License as published by 13 ;; the Free Software Foundation, either version 3 of the License, or 14 ;; (at your option) any later version. 15 ;; 16 ;; GNU Emacs is distributed in the hope that it will be useful, 17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19 ;; GNU General Public License for more details. 20 ;; 21 ;; You should have received a copy of the GNU General Public License 22 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. 23 ;; 24 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 25 ;; 26 ;;; Commentary: 27 28 ;; This is an implementation of dynamic virtual indentation. It works 29 ;; by adding text properties to a buffer to make sure lines are 30 ;; indented according to outline structure. 31 ;; 32 ;; The process is synchronous, toggled at every buffer modification. 33 ;; Though, the initialization (indentation of text already in the 34 ;; buffer), which can take a few seconds in large buffers, happens on 35 ;; idle time. 36 ;; 37 ;;; Code: 38 39 (require 'org-macs) 40 (org-assert-version) 41 42 (require 'org-macs) 43 (require 'org-compat) 44 (require 'org) 45 46 (require 'cl-lib) 47 48 (declare-function org-inlinetask-get-task-level "org-inlinetask" ()) 49 (declare-function org-inlinetask-in-task-p "org-inlinetask" ()) 50 (declare-function org-list-item-body-column "org-list" (item)) 51 (defvar org-inlinetask-show-first-star) 52 53 (defgroup org-indent nil 54 "Options concerning dynamic virtual outline indentation." 55 :tag "Org Indent" 56 :group 'org) 57 58 (defvar org-indent-inlinetask-first-star (org-add-props "*" '(face org-warning)) 59 "First star of inline tasks, with correct face.") 60 (defvar org-indent-agent-timer nil 61 "Timer running the initialize agent.") 62 (defvar org-indent-agentized-buffers nil 63 "List of buffers watched by the initialize agent.") 64 (defvar org-indent-agent-resume-timer nil 65 "Timer to reschedule agent after switching to other idle processes.") 66 (defvar org-indent-agent-active-delay '(0 2 0) 67 "Time to run agent before switching to other idle processes. 68 Delay used when the buffer to initialize is current.") 69 (defvar org-indent-agent-passive-delay '(0 0 400000) 70 "Time to run agent before switching to other idle processes. 71 Delay used when the buffer to initialize isn't current.") 72 (defvar org-indent-agent-resume-delay '(0 0 100000) 73 "Minimal time for other idle processes before switching back to agent.") 74 (defvar org-indent--initial-marker nil 75 "Position of initialization before interrupt. 76 This is used locally in each buffer being initialized.") 77 (defvar org-indent-modified-headline-flag nil 78 "Non-nil means the last deletion operated on a headline. 79 It is modified by `org-indent-notify-modified-headline'.") 80 81 82 (defcustom org-indent-boundary-char ?\s 83 "The end of the virtual indentation strings, a single-character string. 84 The default is just a space, but if you wish, you can use \"|\" or so. 85 This can be useful on a terminal window - under a windowing system, 86 it may be prettier to customize the `org-indent' face." 87 :group 'org-indent 88 :type 'character) 89 90 (defcustom org-indent-mode-turns-off-org-adapt-indentation t 91 "Non-nil means setting `org-indent-mode' will turn off indentation adaptation. 92 For details see the variable `org-adapt-indentation'." 93 :group 'org-indent 94 :type 'boolean) 95 96 (defcustom org-indent-mode-turns-on-hiding-stars t 97 "Non-nil means setting `org-indent-mode' will turn on `org-hide-leading-stars'." 98 :group 'org-indent 99 :type 'boolean) 100 101 (defcustom org-indent-indentation-per-level 2 102 "Indentation per level in number of characters." 103 :group 'org-indent 104 :type 'integer) 105 106 (defface org-indent '((t (:inherit org-hide))) 107 "Face for outline indentation. 108 The default is to make it look like whitespace. But you may find it 109 useful to make it ever so slightly different." 110 :group 'org-faces) 111 112 (defvar org-indent--text-line-prefixes nil 113 "Vector containing line prefixes strings for regular text.") 114 115 (defvar org-indent--heading-line-prefixes nil 116 "Vector containing line prefix strings for headlines.") 117 118 (defvar org-indent--inlinetask-line-prefixes nil 119 "Vector containing line prefix strings for inline tasks.") 120 121 (defconst org-indent--deepest-level 50 122 "Maximum theoretical headline depth.") 123 124 (defun org-indent--compute-prefixes () 125 "Compute prefix strings for regular text and headlines." 126 (setq org-indent--heading-line-prefixes 127 (make-vector org-indent--deepest-level nil)) 128 (setq org-indent--inlinetask-line-prefixes 129 (make-vector org-indent--deepest-level nil)) 130 (setq org-indent--text-line-prefixes 131 (make-vector org-indent--deepest-level nil)) 132 (when (> org-indent-indentation-per-level 0) 133 (dotimes (n org-indent--deepest-level) 134 (let ((indentation (if (<= n 1) 0 135 (* (1- org-indent-indentation-per-level) 136 (1- n))))) 137 ;; Headlines line prefixes. 138 (let ((heading-prefix (make-string indentation ?*))) 139 (aset org-indent--heading-line-prefixes 140 n 141 (org-add-props heading-prefix nil 'face 'org-indent)) 142 ;; Inline tasks line prefixes 143 (aset org-indent--inlinetask-line-prefixes 144 n 145 (cond ((<= n 1) "") 146 ((bound-and-true-p org-inlinetask-show-first-star) 147 (concat org-indent-inlinetask-first-star 148 (substring heading-prefix 1))) 149 (t (org-add-props heading-prefix nil 'face 'org-indent))))) 150 ;; Text line prefixes. 151 (aset org-indent--text-line-prefixes 152 n 153 (org-add-props 154 (concat (make-string (+ n indentation) ?\s) 155 (and (> n 0) 156 (char-to-string org-indent-boundary-char))) 157 nil 'face 'org-indent)))))) 158 159 (defsubst org-indent-remove-properties (beg end) 160 "Remove indentations between BEG and END." 161 (with-silent-modifications 162 (remove-text-properties beg end '(line-prefix nil wrap-prefix nil)))) 163 164 ;;;###autoload 165 (define-minor-mode org-indent-mode 166 "When active, indent text according to outline structure. 167 168 Internally this works by adding `line-prefix' and `wrap-prefix' 169 properties, after each buffer modification, on the modified zone. 170 171 The process is synchronous. Though, initial indentation of 172 buffer, which can take a few seconds on large buffers, is done 173 during idle time." 174 :lighter " Ind" 175 (cond 176 (org-indent-mode 177 ;; mode was turned on. 178 (setq-local indent-tabs-mode nil) 179 (setq-local org-indent--initial-marker (copy-marker 1)) 180 (when org-indent-mode-turns-off-org-adapt-indentation 181 ;; Don't turn off `org-adapt-indentation' when its value is 182 ;; 'headline-data, just indent headline data specially. 183 (or (eq org-adapt-indentation 'headline-data) 184 (setq-local org-adapt-indentation nil))) 185 (when org-indent-mode-turns-on-hiding-stars 186 (setq-local org-hide-leading-stars t)) 187 (org-indent--compute-prefixes) 188 (if (boundp 'filter-buffer-substring-functions) 189 (add-hook 'filter-buffer-substring-functions 190 (lambda (fun start end delete) 191 (org-indent-remove-properties-from-string 192 (funcall fun start end delete))) 193 nil t) 194 ;; Emacs >= 24.4. 195 (add-function :filter-return (local 'filter-buffer-substring-function) 196 #'org-indent-remove-properties-from-string)) 197 (add-hook 'after-change-functions 'org-indent-refresh-maybe nil 'local) 198 (add-hook 'before-change-functions 199 'org-indent-notify-modified-headline nil 'local) 200 (and font-lock-mode (org-restart-font-lock)) 201 (org-indent-remove-properties (point-min) (point-max)) 202 ;; Submit current buffer to initialize agent. If it's the first 203 ;; buffer submitted, also start the agent. Current buffer is 204 ;; pushed in both cases to avoid a race condition. 205 (if org-indent-agentized-buffers 206 (push (current-buffer) org-indent-agentized-buffers) 207 (push (current-buffer) org-indent-agentized-buffers) 208 (setq org-indent-agent-timer 209 (run-with-idle-timer 0.2 t #'org-indent-initialize-agent)))) 210 (t 211 ;; Mode was turned off (or we refused to turn it on) 212 (kill-local-variable 'org-adapt-indentation) 213 (setq org-indent-agentized-buffers 214 (delq (current-buffer) org-indent-agentized-buffers)) 215 (when (markerp org-indent--initial-marker) 216 (set-marker org-indent--initial-marker nil)) 217 (when (local-variable-p 'org-hide-leading-stars) 218 (kill-local-variable 'org-hide-leading-stars)) 219 (if (boundp 'filter-buffer-substring-functions) 220 (remove-hook 'filter-buffer-substring-functions 221 (lambda (fun start end delete) 222 (org-indent-remove-properties-from-string 223 (funcall fun start end delete)))) 224 (remove-function (local 'filter-buffer-substring-function) 225 #'org-indent-remove-properties-from-string)) 226 (remove-hook 'after-change-functions 'org-indent-refresh-maybe 'local) 227 (remove-hook 'before-change-functions 228 'org-indent-notify-modified-headline 'local) 229 (org-with-wide-buffer 230 (org-indent-remove-properties (point-min) (point-max))) 231 (and font-lock-mode (org-restart-font-lock)) 232 (redraw-display)))) 233 234 (defun org-indent-indent-buffer () 235 "Add indentation properties to the accessible part of the buffer." 236 (interactive) 237 (if (not (derived-mode-p 'org-mode)) 238 (error "Not in Org mode") 239 (message "Setting buffer indentation. It may take a few seconds...") 240 (org-indent-remove-properties (point-min) (point-max)) 241 (org-indent-add-properties (point-min) (point-max)) 242 (message "Indentation of buffer set."))) 243 244 (defun org-indent-remove-properties-from-string (string) 245 "Remove indentation properties from STRING." 246 (remove-text-properties 0 (length string) 247 '(line-prefix nil wrap-prefix nil) string) 248 string) 249 250 (defun org-indent-initialize-agent () 251 "Start or resume current buffer initialization. 252 Only buffers in `org-indent-agentized-buffers' trigger an action. 253 When no more buffer is being watched, the agent suppress itself." 254 (when org-indent-agent-resume-timer 255 (cancel-timer org-indent-agent-resume-timer)) 256 (setq org-indent-agentized-buffers 257 (cl-remove-if-not #'buffer-live-p org-indent-agentized-buffers)) 258 (cond 259 ;; Job done: kill agent. 260 ((not org-indent-agentized-buffers) (cancel-timer org-indent-agent-timer)) 261 ;; Current buffer is agentized: start/resume initialization 262 ;; somewhat aggressively. 263 ((memq (current-buffer) org-indent-agentized-buffers) 264 (org-indent-initialize-buffer (current-buffer) 265 org-indent-agent-active-delay)) 266 ;; Else, start/resume initialization of the last agentized buffer, 267 ;; softly. 268 (t (org-indent-initialize-buffer (car org-indent-agentized-buffers) 269 org-indent-agent-passive-delay)))) 270 271 (defun org-indent-initialize-buffer (buffer delay) 272 "Set virtual indentation for the buffer BUFFER, asynchronously. 273 Give hand to other idle processes if it takes longer than DELAY, 274 a time value." 275 (with-current-buffer buffer 276 (when org-indent-mode 277 (org-with-wide-buffer 278 (let ((interruptp 279 ;; Always nil unless interrupted. 280 (catch 'interrupt 281 (and org-indent--initial-marker 282 (marker-position org-indent--initial-marker) 283 (equal (marker-buffer org-indent--initial-marker) 284 buffer) 285 (org-indent-add-properties org-indent--initial-marker 286 (point-max) 287 delay) 288 nil)))) 289 (move-marker org-indent--initial-marker interruptp) 290 ;; Job is complete: un-agentize buffer. 291 (unless interruptp 292 (setq org-indent-agentized-buffers 293 (delq buffer org-indent-agentized-buffers)))))))) 294 295 (defun org-indent-set-line-properties (level indentation &optional heading) 296 "Set prefix properties on current line an move to next one. 297 298 LEVEL is the current level of heading. INDENTATION is the 299 expected indentation when wrapping line. 300 301 When optional argument HEADING is non-nil, assume line is at 302 a heading. Moreover, if it is `inlinetask', the first star will 303 have `org-warning' face." 304 (let* ((line (aref (pcase heading 305 (`nil org-indent--text-line-prefixes) 306 (`inlinetask org-indent--inlinetask-line-prefixes) 307 (_ org-indent--heading-line-prefixes)) 308 level)) 309 (wrap 310 (org-add-props 311 (concat line 312 (if heading (concat (make-string level ?*) " ") 313 (make-string indentation ?\s))) 314 nil 'face 'org-indent))) 315 ;; Add properties down to the next line to indent empty lines. 316 (add-text-properties (line-beginning-position) (line-beginning-position 2) 317 `(line-prefix ,line wrap-prefix ,wrap))) 318 (forward-line)) 319 320 (defun org-indent-add-properties (beg end &optional delay) 321 "Add indentation properties between BEG and END. 322 323 When DELAY is non-nil, it must be a time value. In that case, 324 the process is asynchronous and can be interrupted, either by 325 user request, or after DELAY. This is done by throwing the 326 `interrupt' tag along with the buffer position where the process 327 stopped." 328 (save-match-data 329 (org-with-wide-buffer 330 (goto-char beg) 331 (beginning-of-line) 332 ;; Initialize prefix at BEG, according to current entry's level. 333 (let* ((case-fold-search t) 334 (limited-re (org-get-limited-outline-regexp)) 335 (level (or (org-current-level) 0)) 336 (time-limit (and delay (time-add nil delay)))) 337 ;; For each line, set `line-prefix' and `wrap-prefix' 338 ;; properties depending on the type of line (headline, inline 339 ;; task, item or other). 340 (with-silent-modifications 341 (while (and (<= (point) end) (not (eobp))) 342 (cond 343 ;; When in asynchronous mode, check if interrupt is 344 ;; required. 345 ((and delay (input-pending-p)) (throw 'interrupt (point))) 346 ;; In asynchronous mode, take a break of 347 ;; `org-indent-agent-resume-delay' every DELAY to avoid 348 ;; blocking any other idle timer or process output. 349 ((and delay (time-less-p time-limit nil)) 350 (setq org-indent-agent-resume-timer 351 (run-with-idle-timer 352 (time-add (current-idle-time) org-indent-agent-resume-delay) 353 nil #'org-indent-initialize-agent)) 354 (throw 'interrupt (point))) 355 ;; Headline or inline task. 356 ((looking-at org-outline-regexp) 357 (let* ((nstars (- (match-end 0) (match-beginning 0) 1)) 358 (type (or (looking-at-p limited-re) 'inlinetask))) 359 (org-indent-set-line-properties nstars 0 type) 360 ;; At an headline, define new value for LEVEL. 361 (unless (eq type 'inlinetask) (setq level nstars)))) 362 ;; List item: `wrap-prefix' is set where body starts. 363 ((org-at-item-p) 364 (org-indent-set-line-properties 365 level (org-list-item-body-column (point)))) 366 ;; Regular line. 367 (t 368 (org-indent-set-line-properties 369 level 370 (current-indentation) 371 ;; When adapt indentation is 'headline-data, use 372 ;; `org-indent--heading-line-prefixes' for setting 373 ;; headline data indentation. 374 (and (eq org-adapt-indentation 'headline-data) 375 (or (org-at-planning-p) 376 (org-at-clock-log-p) 377 (looking-at-p org-property-start-re) 378 (looking-at-p org-property-end-re) 379 (looking-at-p org-property-re)))))))))))) 380 381 (defun org-indent-notify-modified-headline (beg end) 382 "Set `org-indent-modified-headline-flag' depending on context. 383 384 BEG and END are the positions of the beginning and end of the 385 range of deleted text. 386 387 This function is meant to be called by `before-change-functions'. 388 Flag will be non-nil if command is going to modify or delete an 389 headline." 390 (when org-indent-mode 391 (setq org-indent-modified-headline-flag 392 (org-with-wide-buffer 393 (goto-char beg) 394 (save-match-data 395 (or (and (org-at-heading-p) (< beg (match-end 0))) 396 (re-search-forward 397 (org-with-limited-levels org-outline-regexp-bol) end t))))))) 398 399 (defun org-indent-refresh-maybe (beg end _) 400 "Refresh indentation properties in an adequate portion of buffer. 401 BEG and END are the positions of the beginning and end of the 402 range of inserted text. DUMMY is an unused argument. 403 404 This function is meant to be called by `after-change-functions'." 405 (when org-indent-mode 406 (save-match-data 407 ;; If a headline was modified or inserted, set properties until 408 ;; next headline. 409 (org-with-wide-buffer 410 (if (or org-indent-modified-headline-flag 411 (save-excursion 412 (goto-char beg) 413 (beginning-of-line) 414 (re-search-forward 415 (org-with-limited-levels org-outline-regexp-bol) 416 (save-excursion 417 (goto-char end) 418 ;; Extend to headline if END is within its 419 ;; headline stars. 420 (line-end-position)) 421 t))) 422 (let ((end (save-excursion 423 (goto-char end) 424 (org-with-limited-levels (outline-next-heading)) 425 (point)))) 426 (setq org-indent-modified-headline-flag nil) 427 (org-indent-add-properties beg end)) 428 ;; Otherwise, only set properties on modified area. 429 (org-indent-add-properties beg end)))))) 430 431 (provide 'org-indent) 432 433 ;; Local variables: 434 ;; generated-autoload-file: "org-loaddefs.el" 435 ;; End: 436 437 ;;; org-indent.el ends here