org-indent.el 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413
  1. ;;; org-indent.el --- Dynamic indentation for Org -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2009-2017 Free Software Foundation, Inc.
  3. ;;
  4. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  5. ;; Keywords: outlines, hypermedia, calendar, wp
  6. ;; Homepage: http://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. (concat (org-add-props (make-string (+ n indentation) ?\s)
  136. nil 'face 'org-indent)
  137. (and (> n 0)
  138. (char-to-string org-indent-boundary-char)))))))
  139. (defsubst org-indent-remove-properties (beg end)
  140. "Remove indentations between BEG and END."
  141. (org-with-silent-modifications
  142. (remove-text-properties beg end '(line-prefix nil wrap-prefix nil))))
  143. ;;;###autoload
  144. (define-minor-mode org-indent-mode
  145. "When active, indent text according to outline structure.
  146. Internally this works by adding `line-prefix' and `wrap-prefix'
  147. properties, after each buffer modification, on the modified zone.
  148. The process is synchronous. Though, initial indentation of
  149. buffer, which can take a few seconds on large buffers, is done
  150. during idle time."
  151. nil " Ind" nil
  152. (cond
  153. (org-indent-mode
  154. ;; mode was turned on.
  155. (setq-local indent-tabs-mode nil)
  156. (setq-local org-indent--initial-marker (copy-marker 1))
  157. (when org-indent-mode-turns-off-org-adapt-indentation
  158. (setq-local org-adapt-indentation nil))
  159. (when org-indent-mode-turns-on-hiding-stars
  160. (setq-local org-hide-leading-stars-before-indent-mode
  161. org-hide-leading-stars)
  162. (setq-local org-hide-leading-stars t))
  163. (org-indent--compute-prefixes)
  164. (add-hook 'filter-buffer-substring-functions
  165. (lambda (fun start end delete)
  166. (org-indent-remove-properties-from-string
  167. (funcall fun start end delete)))
  168. nil t)
  169. (add-hook 'after-change-functions 'org-indent-refresh-maybe nil 'local)
  170. (add-hook 'before-change-functions
  171. 'org-indent-notify-modified-headline nil 'local)
  172. (and font-lock-mode (org-restart-font-lock))
  173. (org-indent-remove-properties (point-min) (point-max))
  174. ;; Submit current buffer to initialize agent. If it's the first
  175. ;; buffer submitted, also start the agent. Current buffer is
  176. ;; pushed in both cases to avoid a race condition.
  177. (if org-indent-agentized-buffers
  178. (push (current-buffer) org-indent-agentized-buffers)
  179. (push (current-buffer) org-indent-agentized-buffers)
  180. (setq org-indent-agent-timer
  181. (run-with-idle-timer 0.2 t #'org-indent-initialize-agent))))
  182. (t
  183. ;; mode was turned off (or we refused to turn it on)
  184. (kill-local-variable 'org-adapt-indentation)
  185. (setq org-indent-agentized-buffers
  186. (delq (current-buffer) org-indent-agentized-buffers))
  187. (when (markerp org-indent--initial-marker)
  188. (set-marker org-indent--initial-marker nil))
  189. (when (boundp 'org-hide-leading-stars-before-indent-mode)
  190. (setq-local org-hide-leading-stars
  191. org-hide-leading-stars-before-indent-mode))
  192. (remove-hook 'filter-buffer-substring-functions
  193. (lambda (fun start end delete)
  194. (org-indent-remove-properties-from-string
  195. (funcall fun start end delete))))
  196. (remove-hook 'after-change-functions 'org-indent-refresh-maybe 'local)
  197. (remove-hook 'before-change-functions
  198. 'org-indent-notify-modified-headline 'local)
  199. (org-with-wide-buffer
  200. (org-indent-remove-properties (point-min) (point-max)))
  201. (and font-lock-mode (org-restart-font-lock))
  202. (redraw-display))))
  203. (defun org-indent-indent-buffer ()
  204. "Add indentation properties to the accessible part of the buffer."
  205. (interactive)
  206. (if (not (derived-mode-p 'org-mode))
  207. (error "Not in Org mode")
  208. (message "Setting buffer indentation. It may take a few seconds...")
  209. (org-indent-remove-properties (point-min) (point-max))
  210. (org-indent-add-properties (point-min) (point-max))
  211. (message "Indentation of buffer set.")))
  212. (defun org-indent-remove-properties-from-string (string)
  213. "Remove indentation properties from STRING."
  214. (remove-text-properties 0 (length string)
  215. '(line-prefix nil wrap-prefix nil) string)
  216. string)
  217. (defun org-indent-initialize-agent ()
  218. "Start or resume current buffer initialization.
  219. Only buffers in `org-indent-agentized-buffers' trigger an action.
  220. When no more buffer is being watched, the agent suppress itself."
  221. (when org-indent-agent-resume-timer
  222. (cancel-timer org-indent-agent-resume-timer))
  223. (setq org-indent-agentized-buffers
  224. (cl-remove-if-not #'buffer-live-p org-indent-agentized-buffers))
  225. (cond
  226. ;; Job done: kill agent.
  227. ((not org-indent-agentized-buffers) (cancel-timer org-indent-agent-timer))
  228. ;; Current buffer is agentized: start/resume initialization
  229. ;; somewhat aggressively.
  230. ((memq (current-buffer) org-indent-agentized-buffers)
  231. (org-indent-initialize-buffer (current-buffer)
  232. org-indent-agent-active-delay))
  233. ;; Else, start/resume initialization of the last agentized buffer,
  234. ;; softly.
  235. (t (org-indent-initialize-buffer (car org-indent-agentized-buffers)
  236. org-indent-agent-passive-delay))))
  237. (defun org-indent-initialize-buffer (buffer delay)
  238. "Set virtual indentation for the buffer BUFFER, asynchronously.
  239. Give hand to other idle processes if it takes longer than DELAY,
  240. a time value."
  241. (with-current-buffer buffer
  242. (when org-indent-mode
  243. (org-with-wide-buffer
  244. (let ((interruptp
  245. ;; Always nil unless interrupted.
  246. (catch 'interrupt
  247. (and org-indent--initial-marker
  248. (marker-position org-indent--initial-marker)
  249. (equal (marker-buffer org-indent--initial-marker)
  250. buffer)
  251. (org-indent-add-properties org-indent--initial-marker
  252. (point-max)
  253. delay)
  254. nil))))
  255. (move-marker org-indent--initial-marker interruptp)
  256. ;; Job is complete: un-agentize buffer.
  257. (unless interruptp
  258. (setq org-indent-agentized-buffers
  259. (delq buffer org-indent-agentized-buffers))))))))
  260. (defun org-indent-set-line-properties (level indentation &optional heading)
  261. "Set prefix properties on current line an move to next one.
  262. LEVEL is the current level of heading. INDENTATION is the
  263. expected indentation when wrapping line.
  264. When optional argument HEADING is non-nil, assume line is at
  265. a heading. Moreover, if is is `inlinetask', the first star will
  266. have `org-warning' face."
  267. (let* ((line (aref (pcase heading
  268. (`nil org-indent--text-line-prefixes)
  269. (`inlinetask org-indent--inlinetask-line-prefixes)
  270. (_ org-indent--heading-line-prefixes))
  271. level))
  272. (wrap
  273. (org-add-props
  274. (concat line
  275. (if heading (concat (make-string level ?*) " ")
  276. (make-string indentation ?\s)))
  277. nil 'face 'org-indent)))
  278. ;; Add properties down to the next line to indent empty lines.
  279. (add-text-properties (line-beginning-position) (line-beginning-position 2)
  280. `(line-prefix ,line wrap-prefix ,wrap)))
  281. (forward-line))
  282. (defun org-indent-add-properties (beg end &optional delay)
  283. "Add indentation properties between BEG and END.
  284. When DELAY is non-nil, it must be a time value. In that case,
  285. the process is asynchronous and can be interrupted, either by
  286. user request, or after DELAY. This is done by throwing the
  287. `interrupt' tag along with the buffer position where the process
  288. stopped."
  289. (save-match-data
  290. (org-with-wide-buffer
  291. (goto-char beg)
  292. (beginning-of-line)
  293. ;; Initialize prefix at BEG, according to current entry's level.
  294. (let* ((case-fold-search t)
  295. (limited-re (org-get-limited-outline-regexp))
  296. (level (or (org-current-level) 0))
  297. (time-limit (and delay (time-add (current-time) delay))))
  298. ;; For each line, set `line-prefix' and `wrap-prefix'
  299. ;; properties depending on the type of line (headline, inline
  300. ;; task, item or other).
  301. (org-with-silent-modifications
  302. (while (and (<= (point) end) (not (eobp)))
  303. (cond
  304. ;; When in asynchronous mode, check if interrupt is
  305. ;; required.
  306. ((and delay (input-pending-p)) (throw 'interrupt (point)))
  307. ;; In asynchronous mode, take a break of
  308. ;; `org-indent-agent-resume-delay' every DELAY to avoid
  309. ;; blocking any other idle timer or process output.
  310. ((and delay (time-less-p time-limit (current-time)))
  311. (setq org-indent-agent-resume-timer
  312. (run-with-idle-timer
  313. (time-add (current-idle-time) org-indent-agent-resume-delay)
  314. nil #'org-indent-initialize-agent))
  315. (throw 'interrupt (point)))
  316. ;; Headline or inline task.
  317. ((looking-at org-outline-regexp)
  318. (let* ((nstars (- (match-end 0) (match-beginning 0) 1))
  319. (type (or (looking-at-p limited-re) 'inlinetask)))
  320. (org-indent-set-line-properties nstars 0 type)
  321. ;; At an headline, define new value for LEVEL.
  322. (unless (eq type 'inlinetask) (setq level nstars))))
  323. ;; List item: `wrap-prefix' is set where body starts.
  324. ((org-at-item-p)
  325. (org-indent-set-line-properties
  326. level (org-list-item-body-column (point))))
  327. ;; Regular line.
  328. (t
  329. (org-indent-set-line-properties level (org-get-indentation))))))))))
  330. (defun org-indent-notify-modified-headline (beg end)
  331. "Set `org-indent-modified-headline-flag' depending on context.
  332. BEG and END are the positions of the beginning and end of the
  333. range of deleted text.
  334. This function is meant to be called by `before-change-functions'.
  335. Flag will be non-nil if command is going to modify or delete an
  336. headline."
  337. (when org-indent-mode
  338. (setq org-indent-modified-headline-flag
  339. (org-with-wide-buffer
  340. (goto-char beg)
  341. (save-match-data
  342. (or (and (org-at-heading-p) (< beg (match-end 0)))
  343. (re-search-forward
  344. (org-with-limited-levels org-outline-regexp-bol) end t)))))))
  345. (defun org-indent-refresh-maybe (beg end _)
  346. "Refresh indentation properties in an adequate portion of buffer.
  347. BEG and END are the positions of the beginning and end of the
  348. range of inserted text. DUMMY is an unused argument.
  349. This function is meant to be called by `after-change-functions'."
  350. (when org-indent-mode
  351. (save-match-data
  352. ;; If a headline was modified or inserted, set properties until
  353. ;; next headline.
  354. (org-with-wide-buffer
  355. (if (or org-indent-modified-headline-flag
  356. (save-excursion
  357. (goto-char beg)
  358. (beginning-of-line)
  359. (re-search-forward
  360. (org-with-limited-levels org-outline-regexp-bol) end t)))
  361. (let ((end (save-excursion
  362. (goto-char end)
  363. (org-with-limited-levels (outline-next-heading))
  364. (point))))
  365. (setq org-indent-modified-headline-flag nil)
  366. (org-indent-add-properties beg end))
  367. ;; Otherwise, only set properties on modified area.
  368. (org-indent-add-properties beg end))))))
  369. (provide 'org-indent)
  370. ;; Local variables:
  371. ;; generated-autoload-file: "org-loaddefs.el"
  372. ;; End:
  373. ;;; org-indent.el ends here