org-indent.el 16 KB

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