org-indent.el 15 KB

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