1 ;;; org-list.el --- Plain lists for Org-mode
3 ;; Copyright (C) 2004-2015 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Bastien Guerry <bzg@gnu.org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
28 ;; This file contains the code dealing with plain lists in Org-mode.
30 ;; The core concept behind lists is their structure. A structure is
31 ;; a snapshot of the list, in the shape of a data tree (see
32 ;; `org-list-struct').
34 ;; Once the list structure is stored, it is possible to make changes
35 ;; on it that will be mirrored to the real list or to get information
36 ;; about the list, using accessors and methods provided in the
37 ;; library. Most of them require the use of one or two helper
38 ;; functions, namely `org-list-parents-alist' and
39 ;; `org-list-prevs-alist'.
41 ;; Structure is eventually applied to the buffer with
42 ;; `org-list-write-struct'. This function repairs (bullets,
43 ;; indentation, checkboxes) the list in the process. It should be
44 ;; called near the end of any function working on structures.
46 ;; Thus, a function applying to lists should usually follow this
49 ;; 1. Verify point is in a list and grab item beginning (with the same
50 ;; function `org-in-item-p'). If the function requires the cursor
51 ;; to be at item's bullet, `org-at-item-p' is more selective. It
52 ;; is also possible to move point to the closest item with
53 ;; `org-list-search-backward', or `org-list-search-forward',
54 ;; applied to the function `org-item-beginning-re'.
56 ;; 2. Get list structure with `org-list-struct'.
58 ;; 3. Compute one, or both, helper functions,
59 ;; (`org-list-parents-alist', `org-list-prevs-alist') depending on
62 ;; 4. Proceed with the modifications, using methods and accessors.
64 ;; 5. Verify and apply structure to buffer, using
65 ;; `org-list-write-struct'.
67 ;; 6. If changes made to the list might have modified check-boxes,
68 ;; call `org-update-checkbox-count-maybe'.
70 ;; Computing a structure can be a costly operation on huge lists (a
71 ;; few thousand lines long). Thus, code should follow the rule:
72 ;; "collect once, use many". As a corollary, it is usually a bad idea
73 ;; to use directly an interactive function inside the code, as those,
74 ;; being independent entities, read the whole list structure another
84 (defvar org-M-RET-may-split-line
)
85 (defvar org-auto-align-tags
)
86 (defvar org-blank-before-new-entry
)
87 (defvar org-clock-string
)
88 (defvar org-closed-string
)
89 (defvar org-deadline-string
)
90 (defvar org-description-max-indent
)
91 (defvar org-odd-levels-only
)
92 (defvar org-scheduled-string
)
93 (defvar org-ts-regexp
)
94 (defvar org-ts-regexp-both
)
95 (defvar org-drawer-regexp
)
97 (declare-function org-at-heading-p
"org" (&optional invisible-ok
))
98 (declare-function org-back-to-heading
"org" (&optional invisible-ok
))
99 (declare-function org-before-first-heading-p
"org" ())
100 (declare-function org-combine-plists
"org" (&rest plists
))
101 (declare-function org-count
"org" (cl-item cl-seq
))
102 (declare-function org-current-level
"org" ())
103 (declare-function org-element-at-point
"org-element" ())
104 (declare-function org-element-context
"org-element" (&optional element
))
105 (declare-function org-element-lineage
"org-element"
106 (blob &optional types with-self
))
107 (declare-function org-element-property
"org-element" (property element
))
108 (declare-function org-element-type
"org-element" (element))
109 (declare-function org-element-update-syntax
"org-element" ())
110 (declare-function org-entry-get
"org"
111 (pom property
&optional inherit literal-nil
))
112 (declare-function org-export-string-as
"ox"
113 (string backend
&optional body-only ext-plist
))
114 (declare-function org-fix-tags-on-the-fly
"org" ())
115 (declare-function org-get-indentation
"org" (&optional line
))
116 (declare-function org-icompleting-read
"org" (&rest args
))
117 (declare-function org-in-block-p
"org" (names))
118 (declare-function org-in-regexp
"org" (re &optional nlines visually
))
119 (declare-function org-inlinetask-goto-beginning
"org-inlinetask" ())
120 (declare-function org-inlinetask-goto-end
"org-inlinetask" ())
121 (declare-function org-inlinetask-in-task-p
"org-inlinetask" ())
122 (declare-function org-inlinetask-outline-regexp
"org-inlinetask" ())
123 (declare-function org-level-increment
"org" ())
124 (declare-function org-narrow-to-subtree
"org" ())
125 (declare-function org-previous-line-empty-p
"org" ())
126 (declare-function org-reduced-level
"org" (L))
127 (declare-function org-remove-if
"org" (predicate seq
))
128 (declare-function org-show-subtree
"org" ())
129 (declare-function org-sort-remove-invisible
"org" (S))
130 (declare-function org-time-string-to-seconds
"org" (s))
131 (declare-function org-timer-hms-to-secs
"org-timer" (hms))
132 (declare-function org-timer-item
"org-timer" (&optional arg
))
133 (declare-function org-trim
"org" (s))
134 (declare-function org-uniquify
"org" (list))
135 (declare-function outline-flag-region
"outline" (from to flag
))
136 (declare-function outline-invisible-p
"outline" (&optional pos
))
137 (declare-function outline-next-heading
"outline" ())
138 (declare-function outline-previous-heading
"outline" ())
142 ;;; Configuration variables
144 (defgroup org-plain-lists nil
145 "Options concerning plain lists in Org-mode."
146 :tag
"Org Plain lists"
147 :group
'org-structure
)
149 (defcustom org-cycle-include-plain-lists t
150 "When t, make TAB cycle visibility on plain list items.
151 Cycling plain lists works only when the cursor is on a plain list
152 item. When the cursor is on an outline heading, plain lists are
153 treated as text. This is the most stable way of handling this,
154 which is why it is the default.
156 When this is the symbol `integrate', then integrate plain list
157 items when cycling, as if they were children of outline headings.
159 This setting can lead to strange effects when switching visibility
160 to `children', because the first \"child\" in a subtree decides
161 what children should be listed. If that first \"child\" is a
162 plain list item with an implied large level number, all true
163 children and grand children of the outline heading will be
164 exposed in a children' view."
165 :group
'org-plain-lists
168 (const :tag
"Never" nil
)
169 (const :tag
"With cursor in plain list (recommended)" t
)
170 (const :tag
"As children of outline headings" integrate
)))
172 (defcustom org-list-demote-modify-bullet nil
173 "Default bullet type installed when demoting an item.
174 This is an association list, for each bullet type, this alist will point
175 to the bullet that should be used when this item is demoted.
178 (setq org-list-demote-modify-bullet
179 \\='((\"+\" . \"-\") (\"-\" . \"+\") (\"*\" . \"+\")))
184 + Silence of the Lambs
187 + The Hunt for Red October
193 - Silence of the Lambs
196 - The Hunt for Red October
198 :group
'org-plain-lists
201 (choice :tag
"If the current bullet is "
207 (choice :tag
"demotion will change it to"
214 (defcustom org-plain-list-ordered-item-terminator t
215 "The character that makes a line with leading number an ordered list item.
216 Valid values are ?. and ?\). To get both terminators, use t.
218 This variable needs to be set before org.el is loaded. If you
219 need to make a change while Emacs is running, use the customize
220 interface or run the following code after updating it:
222 \\[org-element-update-syntax]"
223 :group
'org-plain-lists
224 :type
'(choice (const :tag
"dot like in \"2.\"" ?.
)
225 (const :tag
"paren like in \"2)\"" ?\
))
226 (const :tag
"both" t
))
227 :set
(lambda (var val
) (set var val
)
228 (when (featurep 'org-element
) (org-element-update-syntax))))
230 (define-obsolete-variable-alias 'org-alphabetical-lists
231 'org-list-allow-alphabetical
"24.4") ; Since 8.0
232 (defcustom org-list-allow-alphabetical nil
233 "Non-nil means single character alphabetical bullets are allowed.
235 Both uppercase and lowercase are handled. Lists with more than
236 26 items will fallback to standard numbering. Alphabetical
237 counters like \"[@c]\" will be recognized.
239 This variable needs to be set before org.el is loaded. If you
240 need to make a change while Emacs is running, use the customize
241 interface or run the following code after updating it:
243 \\[org-element-update-syntax]"
244 :group
'org-plain-lists
247 :set
(lambda (var val
) (set var val
)
248 (when (featurep 'org-element
) (org-element-update-syntax))))
250 (defcustom org-list-two-spaces-after-bullet-regexp nil
251 "A regular expression matching bullets that should have 2 spaces after them.
252 When nil, no bullet will have two spaces after them. When
253 a string, it will be used as a regular expression. When the
254 bullet type of a list is changed, the new bullet type will be
255 matched against this regexp. If it matches, there will be two
256 spaces instead of one after the bullet in each item of the list."
257 :group
'org-plain-lists
259 (const :tag
"never" nil
)
262 (defcustom org-list-automatic-rules
'((checkbox . t
)
264 "Non-nil means apply set of rules when acting on lists.
265 By default, automatic actions are taken when using
266 \\[org-meta-return], \\[org-metaright], \\[org-metaleft],
267 \\[org-shiftmetaright], \\[org-shiftmetaleft],
268 \\[org-ctrl-c-minus], \\[org-toggle-checkbox] or
269 \\[org-insert-todo-heading]. You can disable individually these
270 rules by setting them to nil. Valid rules are:
272 checkbox when non-nil, checkbox statistics is updated each time
273 you either insert a new checkbox or toggle a checkbox.
274 indent when non-nil, indenting or outdenting list top-item
275 with its subtree will move the whole list and
276 outdenting a list whose bullet is * to column 0 will
277 change that bullet to \"-\"."
278 :group
'org-plain-lists
280 :type
'(alist :tag
"Sets of rules"
283 (const :tag
"Checkbox" checkbox
)
284 (const :tag
"Indent" indent
))
286 (boolean :tag
"Activate" :value t
)))
288 (defcustom org-list-use-circular-motion nil
289 "Non-nil means commands implying motion in lists should be cyclic.
291 In that case, the item following the last item is the first one,
292 and the item preceding the first item is the last one.
294 This affects the behavior of \\[org-move-item-up],
295 \\[org-move-item-down], \\[org-next-item] and
296 \\[org-previous-item]."
297 :group
'org-plain-lists
301 (defvar org-checkbox-statistics-hook nil
302 "Hook that is run whenever Org thinks checkbox statistics should be updated.
303 This hook runs even if checkbox rule in
304 `org-list-automatic-rules' does not apply, so it can be used to
305 implement alternative ways of collecting statistics
308 (define-obsolete-variable-alias 'org-hierarchical-checkbox-statistics
309 'org-checkbox-hierarchical-statistics
"24.4") ;; Since 8.0
310 (defcustom org-checkbox-hierarchical-statistics t
311 "Non-nil means checkbox statistics counts only the state of direct children.
312 When nil, all boxes below the cookie are counted.
313 This can be set to nil on a per-node basis using a COOKIE_DATA property
314 with the word \"recursive\" in the value."
315 :group
'org-plain-lists
318 (org-defvaralias 'org-description-max-indent
319 'org-list-description-max-indent
) ;; Since 8.0
320 (defcustom org-list-description-max-indent
20
321 "Maximum indentation for the second line of a description list.
322 When the indentation would be larger than this, it will become
323 5 characters instead."
324 :group
'org-plain-lists
327 (defcustom org-list-indent-offset
0
328 "Additional indentation for sub-items in a list.
329 By setting this to a small number, usually 1 or 2, one can more
330 clearly distinguish sub-items in a list."
331 :group
'org-plain-lists
335 (defcustom org-list-radio-list-templates
336 '((latex-mode "% BEGIN RECEIVE ORGLST %n
337 % END RECEIVE ORGLST %n
339 #+ORGLST: SEND %n org-list-to-latex
342 (texinfo-mode "@c BEGIN RECEIVE ORGLST %n
343 @c END RECEIVE ORGLST %n
345 #+ORGLST: SEND %n org-list-to-texinfo
348 (html-mode "<!-- BEGIN RECEIVE ORGLST %n -->
349 <!-- END RECEIVE ORGLST %n -->
351 #+ORGLST: SEND %n org-list-to-html
354 "Templates for radio lists in different major modes.
355 All occurrences of %n in a template will be replaced with the name of the
356 list, obtained by prompting the user."
357 :group
'org-plain-lists
359 (list (symbol :tag
"Major mode")
360 (string :tag
"Format"))))
362 (defvar org-list-forbidden-blocks
'("example" "verse" "src" "ascii" "beamer"
363 "html" "latex" "odt")
364 "Names of blocks where lists are not allowed.
365 Names must be in lower case.")
367 (defvar org-list-export-context
'(block inlinetask
)
368 "Context types where lists will be interpreted during export.
370 Valid types are `drawer', `inlinetask' and `block'. More
371 specifically, type `block' is determined by the variable
372 `org-list-forbidden-blocks'.")
376 ;;; Predicates and regexps
378 (defconst org-list-end-re
"^[ \t]*\n[ \t]*\n"
379 "Regex matching the end of a plain list.")
381 (defconst org-list-full-item-re
382 (concat "^[ \t]*\\(\\(?:[-+*]\\|\\(?:[0-9]+\\|[A-Za-z]\\)[.)]\\)\\(?:[ \t]+\\|$\\)\\)"
383 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
384 "\\(?:\\(\\[[ X-]\\]\\)\\(?:[ \t]+\\|$\\)\\)?"
385 "\\(?:\\(.*\\)[ \t]+::\\(?:[ \t]+\\|$\\)\\)?")
386 "Matches a list item and puts everything into groups:
390 group 4: description tag")
392 (defun org-item-re ()
393 "Return the correct regular expression for plain lists."
395 ((eq org-plain-list-ordered-item-terminator t
) "[.)]")
396 ((= org-plain-list-ordered-item-terminator ?\
)) ")")
397 ((= org-plain-list-ordered-item-terminator ?.
) "\\.")
399 (alpha (if org-list-allow-alphabetical
"\\|[A-Za-z]" "")))
400 (concat "\\([ \t]*\\([-+]\\|\\(\\([0-9]+" alpha
"\\)" term
401 "\\)\\)\\|[ \t]+\\*\\)\\([ \t]+\\|$\\)")))
403 (defsubst org-item-beginning-re
()
404 "Regexp matching the beginning of a plain list item."
405 (concat "^" (org-item-re)))
407 (defun org-list-at-regexp-after-bullet-p (regexp)
408 "Is point at a list item with REGEXP after bullet?"
411 (goto-char (match-end 0))
412 (let ((counter-re (concat "\\(?:\\[@\\(?:start:\\)?"
413 (if org-list-allow-alphabetical
414 "\\([0-9]+\\|[A-Za-z]\\)"
417 ;; Ignore counter if any
418 (when (looking-at counter-re
) (goto-char (match-end 0))))
419 (looking-at regexp
))))
421 (defun org-list-in-valid-context-p ()
422 "Is point in a context where lists are allowed?"
423 (not (org-in-block-p org-list-forbidden-blocks
)))
425 (defun org-in-item-p ()
426 "Return item beginning position when in a plain list, nil otherwise."
429 (let* ((case-fold-search t
)
430 (context (org-list-context))
431 (lim-up (car context
))
432 (inlinetask-re (and (featurep 'org-inlinetask
)
433 (org-inlinetask-outline-regexp)))
434 (item-re (org-item-re))
435 ;; Indentation isn't meaningful when point starts at an empty
436 ;; line or an inline task.
437 (ind-ref (if (or (looking-at "^[ \t]*$")
438 (and inlinetask-re
(looking-at inlinetask-re
)))
440 (org-get-indentation))))
442 ((eq (nth 2 context
) 'invalid
) nil
)
443 ((looking-at item-re
) (point))
445 ;; Detect if cursor in amidst `org-list-end-re'. First, count
446 ;; number HL of hard lines it takes, then call `org-in-regexp'
447 ;; to compute its boundaries END-BOUNDS. When point is
448 ;; in-between, move cursor before regexp beginning.
449 (let ((hl 0) (i -
1) end-bounds
)
451 (while (setq i
(string-match
452 "[\r\n]" org-list-end-re
(1+ i
)))
454 (setq end-bounds
(org-in-regexp org-list-end-re hl
)))
455 (>= (point) (car end-bounds
))
456 (< (point) (cdr end-bounds
)))
457 (goto-char (car end-bounds
))
459 ;; Look for an item, less indented that reference line.
462 (let ((ind (org-get-indentation)))
464 ;; This is exactly what we want.
465 ((and (looking-at item-re
) (< ind ind-ref
))
466 (throw 'exit
(point)))
467 ;; At upper bound of search or looking at the end of a
468 ;; previous list: search is over.
469 ((<= (point) lim-up
) (throw 'exit nil
))
470 ((looking-at org-list-end-re
) (throw 'exit nil
))
471 ;; Skip blocks, drawers, inline-tasks, blank lines
472 ((and (looking-at "^[ \t]*#\\+end_")
473 (re-search-backward "^[ \t]*#\\+begin_" lim-up t
)))
474 ((and (looking-at "^[ \t]*:END:")
475 (re-search-backward org-drawer-regexp lim-up t
))
477 ((and inlinetask-re
(looking-at inlinetask-re
))
478 (org-inlinetask-goto-beginning)
480 ((looking-at "^[ \t]*$") (forward-line -
1))
481 ;; Text at column 0 cannot belong to a list: stop.
482 ((zerop ind
) (throw 'exit nil
))
483 ;; Normal text less indented than reference line, take
484 ;; it as new reference.
488 (t (forward-line -
1)))))))))))
490 (defun org-at-item-p ()
491 "Is point in a line starting a hand-formatted item?"
494 (and (looking-at (org-item-re)) (org-list-in-valid-context-p))))
496 (defun org-at-item-bullet-p ()
497 "Is point at the bullet of a plain list item?"
499 (not (member (char-after) '(?\ ?
\t)))
500 (< (point) (match-end 0))))
502 (defun org-at-item-timer-p ()
503 "Is point at a line starting a plain list item with a timer?"
504 (org-list-at-regexp-after-bullet-p
505 "\\([0-9]+:[0-9]+:[0-9]+\\)[ \t]+::[ \t]+"))
507 (defun org-at-item-description-p ()
508 "Is point at a description list item?"
509 (org-list-at-regexp-after-bullet-p "\\(\\S-.+\\)[ \t]+::\\([ \t]+\\|$\\)"))
511 (defun org-at-item-checkbox-p ()
512 "Is point at a line starting a plain-list item with a checklet?"
513 (org-list-at-regexp-after-bullet-p "\\(\\[[- X]\\]\\)[ \t]+"))
515 (defun org-at-item-counter-p ()
516 "Is point at a line starting a plain-list item with a counter?"
518 (looking-at org-list-full-item-re
)
523 ;;; Structures and helper functions
525 (defun org-list-context ()
526 "Determine context, and its boundaries, around point.
528 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
529 are boundaries and CONTEXT is a symbol among `drawer', `block',
530 `invalid', `inlinetask' and nil.
532 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
535 (org-with-limited-levels
537 (let ((case-fold-search t
) (pos (point)) beg end context-type
538 ;; Get positions of surrounding headings. This is the
540 (lim-up (or (save-excursion (and (ignore-errors (org-back-to-heading t
))
543 (lim-down (or (save-excursion (outline-next-heading)) (point-max))))
544 ;; Is point inside a drawer?
545 (let ((end-re "^[ \t]*:END:")
546 (beg-re org-drawer-regexp
))
547 (when (save-excursion
548 (and (not (looking-at beg-re
))
549 (not (looking-at end-re
))
550 (setq beg
(and (re-search-backward beg-re lim-up t
)
551 (1+ (point-at-eol))))
552 (setq end
(or (and (re-search-forward end-re lim-down t
)
553 (1- (match-beginning 0)))
556 (setq lim-up beg lim-down end context-type
'drawer
)))
557 ;; Is point strictly in a block, and of which type?
558 (let ((block-re "^[ \t]*#\\+\\(begin\\|end\\)_") type
)
559 (when (save-excursion
560 (and (not (looking-at block-re
))
561 (setq beg
(and (re-search-backward block-re lim-up t
)
562 (1+ (point-at-eol))))
563 (looking-at "^[ \t]*#\\+begin_\\(\\S-+\\)")
564 (setq type
(downcase (match-string 1)))
566 (setq end
(or (and (re-search-forward block-re lim-down t
)
570 (equal (downcase (match-string 1)) "end")))
571 (setq lim-up beg lim-down end
572 context-type
(if (member type org-list-forbidden-blocks
)
574 ;; Is point in an inlinetask?
575 (when (and (featurep 'org-inlinetask
)
577 (let* ((beg-re (org-inlinetask-outline-regexp))
578 (end-re (concat beg-re
"END[ \t]*$")))
579 (and (not (looking-at "^\\*+"))
580 (setq beg
(and (re-search-backward beg-re lim-up t
)
581 (1+ (point-at-eol))))
582 (not (looking-at end-re
))
583 (setq end
(and (re-search-forward end-re lim-down t
)
584 (1- (match-beginning 0))))
586 (setq lim-up beg lim-down end context-type
'inlinetask
))
587 ;; Return context boundaries and type.
588 (list lim-up lim-down context-type
))))))
590 (defun org-list-struct ()
591 "Return structure of list at point.
593 A list structure is an alist where key is point at item, and
596 2. bullet with trailing whitespace,
597 3. bullet counter, if any,
599 5. description tag, if any,
600 6. position at item end.
602 Thus the following list, where numbers in parens are
607 5. [@5] sub-item 2 (34)
608 some other text belonging to first item (55)
610 + tag :: description (109)
613 will get the following structure:
615 ((1 0 \"- \" nil \"[X]\" nil 97)
616 (18 2 \"1. \" nil nil nil 34)
617 (34 2 \"5. \" \"5\" nil nil 55)
618 (97 0 \"- \" nil nil nil 131)
619 (109 2 \"+ \" nil nil \"tag\" 131))
621 Assume point is at an item."
624 (let* ((case-fold-search t
)
625 (context (org-list-context))
626 (lim-up (car context
))
627 (lim-down (nth 1 context
))
629 (item-re (org-item-re))
630 (inlinetask-re (and (featurep 'org-inlinetask
)
631 (org-inlinetask-outline-regexp)))
632 (beg-cell (cons (point) (org-get-indentation)))
633 itm-lst itm-lst-2 end-lst end-lst-2 struct
636 ;; Return association at point.
638 (looking-at org-list-full-item-re
)
639 (let ((bullet (match-string-no-properties 1)))
643 (match-string-no-properties 2) ; counter
644 (match-string-no-properties 3) ; checkbox
646 (and (save-match-data (string-match "[-+*]" bullet
))
647 (match-string-no-properties 4)))))))
650 ;; Ensure list ends at the first blank line.
652 (skip-chars-backward " \r\t\n")
653 (min (1+ (point-at-eol)) lim-down
)))))
654 ;; 1. Read list from starting item to its beginning, and save
655 ;; top item position and indentation in BEG-CELL. Also store
656 ;; ending position of items in END-LST.
660 (let ((ind (org-get-indentation)))
663 ;; At upward limit: if we ended at an item, store it,
664 ;; else dismiss useless data recorded above BEG-CELL.
668 (if (not (looking-at item-re
))
669 (memq (assq (car beg-cell
) itm-lst
) itm-lst
)
670 (setq beg-cell
(cons (point) ind
))
671 (cons (funcall assoc-at-point ind
) itm-lst
)))))
672 ;; Looking at a list ending regexp. Dismiss useless
673 ;; data recorded above BEG-CELL. Jump to part 2.
674 ((looking-at org-list-end-re
)
677 (memq (assq (car beg-cell
) itm-lst
) itm-lst
))))
678 ;; Point is at an item. Add data to ITM-LST. It may
679 ;; also end a previous item: save it in END-LST. If
680 ;; ind is less or equal than BEG-CELL and there is no
681 ;; end at this ind or lesser, this item becomes the new
683 ((looking-at item-re
)
684 (push (funcall assoc-at-point ind
) itm-lst
)
685 (push (cons ind
(point)) end-lst
)
686 (when (< ind text-min-ind
) (setq beg-cell
(cons (point) ind
)))
688 ;; Skip blocks, drawers, inline tasks, blank lines.
689 ((and (looking-at "^[ \t]*#\\+end_")
690 (re-search-backward "^[ \t]*#\\+begin_" lim-up t
)))
691 ((and (looking-at "^[ \t]*:END:")
692 (re-search-backward org-drawer-regexp lim-up t
))
694 ((and inlinetask-re
(looking-at inlinetask-re
))
695 (org-inlinetask-goto-beginning)
697 ((looking-at "^[ \t]*$")
699 ;; From there, point is not at an item. Interpret
700 ;; line's indentation:
701 ;; - text at column 0 is necessarily out of any list.
702 ;; Dismiss data recorded above BEG-CELL. Jump to
704 ;; - any other case may be an ending position for an
705 ;; hypothetical item above. Store it and proceed.
709 (memq (assq (car beg-cell
) itm-lst
) itm-lst
))))
711 (when (< ind text-min-ind
) (setq text-min-ind ind
))
712 (push (cons ind
(point)) end-lst
)
713 (forward-line -
1)))))))
714 ;; 2. Read list from starting point to its end, that is until we
715 ;; get out of context, or that a non-item line is less or
716 ;; equally indented than BEG-CELL's cdr. Also, store ending
717 ;; position of items in END-LST-2.
720 (let ((ind (org-get-indentation)))
722 ((>= (point) lim-down
)
723 ;; At downward limit: this is de facto the end of the
724 ;; list. Save point as an ending position, and jump to
727 (push (cons 0 (funcall end-before-blank
)) end-lst-2
)))
728 ;; Looking at a list ending regexp. Save point as an
729 ;; ending position and jump to part 3.
730 ((looking-at org-list-end-re
)
731 (throw 'exit
(push (cons 0 (point)) end-lst-2
)))
732 ((looking-at item-re
)
733 ;; Point is at an item. Add data to ITM-LST-2. It may
734 ;; also end a previous item, so save it in END-LST-2.
735 (push (funcall assoc-at-point ind
) itm-lst-2
)
736 (push (cons ind
(point)) end-lst-2
)
738 ;; Skip inline tasks and blank lines along the way
739 ((and inlinetask-re
(looking-at inlinetask-re
))
740 (org-inlinetask-goto-end))
741 ((looking-at "^[ \t]*$")
743 ;; Ind is lesser or equal than BEG-CELL's. The list is
744 ;; over: store point as an ending position and jump to
746 ((<= ind
(cdr beg-cell
))
748 (push (cons 0 (funcall end-before-blank
)) end-lst-2
)))
749 ;; Else, if ind is lesser or equal than previous item's,
750 ;; this is an ending position: store it. In any case,
751 ;; skip block or drawer at point, and move to next line.
753 (when (<= ind
(nth 1 (car itm-lst-2
)))
754 (push (cons ind
(point)) end-lst-2
))
756 ((and (looking-at "^[ \t]*#\\+begin_")
757 (re-search-forward "^[ \t]*#\\+end_" lim-down t
)))
758 ((and (looking-at org-drawer-regexp
)
759 (re-search-forward "^[ \t]*:END:" lim-down t
))))
760 (forward-line 1))))))
761 (setq struct
(append itm-lst
(cdr (nreverse itm-lst-2
)))
762 end-lst
(append end-lst
(cdr (nreverse end-lst-2
))))
763 ;; 3. Associate each item to its end position.
764 (org-list-struct-assoc-end struct end-lst
)
768 (defun org-list-struct-assoc-end (struct end-list
)
769 "Associate proper ending point to items in STRUCT.
771 END-LIST is a pseudo-alist where car is indentation and cdr is
774 This function modifies STRUCT."
775 (let ((endings end-list
))
778 (let ((pos (car elt
))
780 ;; Remove end candidates behind current item.
781 (while (or (<= (cdar endings
) pos
))
783 ;; Add end position to item assoc.
784 (let ((old-end (nthcdr 6 elt
))
785 (new-end (assoc-default ind endings
'<=)))
787 (setcar old-end new-end
)
788 (setcdr elt
(append (cdr elt
) (list new-end
)))))))
791 (defun org-list-prevs-alist (struct)
792 "Return alist between item and previous item in STRUCT."
793 (let ((item-end-alist (mapcar (lambda (e) (cons (car e
) (nth 6 e
)))
796 (let ((prev (car (rassq (car e
) item-end-alist
))))
797 (cons (car e
) prev
)))
800 (defun org-list-parents-alist (struct)
801 "Return alist between item and parent in STRUCT."
802 (let* ((ind-to-ori (list (list (nth 1 (car struct
)))))
803 (top-item (org-list-get-top-point struct
))
804 (prev-pos (list top-item
)))
806 (mapcar (lambda (item)
807 (let ((pos (car item
))
809 (prev-ind (caar ind-to-ori
)))
813 ;; A sub-list is over. Find the associated
814 ;; origin in IND-TO-ORI. If it cannot be
815 ;; found (ill-formed list), set its parent as
816 ;; the first item less indented. If there is
817 ;; none, make it a top-level item.
819 (or (member (assq ind ind-to-ori
) ind-to-ori
)
823 (when (< (car e
) ind
)
824 (throw 'exit
(member e ind-to-ori
))))
827 (cons pos
(cdar ind-to-ori
)))
828 ;; A sub-list starts. Every item at IND will
829 ;; have previous item as its parent.
831 (let ((origin (nth 1 prev-pos
)))
832 (push (cons ind origin
) ind-to-ori
)
834 ;; Another item in the same sub-list: it shares
835 ;; the same parent as the previous item.
836 (t (cons pos
(cdar ind-to-ori
))))))
843 (defsubst org-list-get-nth
(n key struct
)
844 "Return the Nth value of KEY in STRUCT."
845 (nth n
(assq key struct
)))
847 (defun org-list-set-nth (n key struct new
)
848 "Set the Nth value of KEY in STRUCT to NEW.
849 \nThis function modifies STRUCT."
850 (setcar (nthcdr n
(assq key struct
)) new
))
852 (defsubst org-list-get-ind
(item struct
)
853 "Return indentation of ITEM in STRUCT."
854 (org-list-get-nth 1 item struct
))
856 (defun org-list-set-ind (item struct ind
)
857 "Set indentation of ITEM in STRUCT to IND.
858 \nThis function modifies STRUCT."
859 (org-list-set-nth 1 item struct ind
))
861 (defsubst org-list-get-bullet
(item struct
)
862 "Return bullet of ITEM in STRUCT."
863 (org-list-get-nth 2 item struct
))
865 (defun org-list-set-bullet (item struct bullet
)
866 "Set bullet of ITEM in STRUCT to BULLET.
867 \nThis function modifies STRUCT."
868 (org-list-set-nth 2 item struct bullet
))
870 (defsubst org-list-get-counter
(item struct
)
871 "Return counter of ITEM in STRUCT."
872 (org-list-get-nth 3 item struct
))
874 (defsubst org-list-get-checkbox
(item struct
)
875 "Return checkbox of ITEM in STRUCT or nil."
876 (org-list-get-nth 4 item struct
))
878 (defun org-list-set-checkbox (item struct checkbox
)
879 "Set checkbox of ITEM in STRUCT to CHECKBOX.
880 \nThis function modifies STRUCT."
881 (org-list-set-nth 4 item struct checkbox
))
883 (defsubst org-list-get-tag
(item struct
)
884 "Return end position of ITEM in STRUCT."
885 (org-list-get-nth 5 item struct
))
887 (defun org-list-get-item-end (item struct
)
888 "Return end position of ITEM in STRUCT."
889 (org-list-get-nth 6 item struct
))
891 (defun org-list-get-item-end-before-blank (item struct
)
892 "Return point at end of ITEM in STRUCT, before any blank line.
893 Point returned is at end of line."
895 (goto-char (org-list-get-item-end item struct
))
896 (skip-chars-backward " \r\t\n")
899 (defun org-list-get-parent (item struct parents
)
900 "Return parent of ITEM or nil.
901 STRUCT is the list structure. PARENTS is the alist of parents,
902 as returned by `org-list-parents-alist'."
903 (let ((parents (or parents
(org-list-parents-alist struct
))))
904 (cdr (assq item parents
))))
906 (defun org-list-has-child-p (item struct
)
907 "Non-nil if ITEM has a child.
909 STRUCT is the list structure.
911 Value returned is the position of the first child of ITEM."
912 (let ((ind (org-list-get-ind item struct
))
913 (child-maybe (car (nth 1 (member (assq item struct
) struct
)))))
914 (when (and child-maybe
915 (< ind
(org-list-get-ind child-maybe struct
)))
918 (defun org-list-get-next-item (item _struct prevs
)
919 "Return next item in same sub-list as ITEM, or nil.
920 STRUCT is the list structure. PREVS is the alist of previous
921 items, as returned by `org-list-prevs-alist'."
922 (car (rassq item prevs
)))
924 (defun org-list-get-prev-item (item _struct prevs
)
925 "Return previous item in same sub-list as ITEM, or nil.
926 STRUCT is the list structure. PREVS is the alist of previous
927 items, as returned by `org-list-prevs-alist'."
928 (cdr (assq item prevs
)))
930 (defun org-list-get-subtree (item struct
)
931 "List all items having ITEM as a common ancestor, or nil.
932 STRUCT is the list structure."
933 (let* ((item-end (org-list-get-item-end item struct
))
934 (sub-struct (cdr (member (assq item struct
) struct
)))
939 (if (< pos item-end
) (push pos subtree
) (throw 'exit nil
))))
943 (defun org-list-get-all-items (item struct prevs
)
944 "List all items in the same sub-list as ITEM.
945 STRUCT is the list structure. PREVS is the alist of previous
946 items, as returned by `org-list-prevs-alist'."
947 (let ((prev-item item
)
949 before-item after-item
)
950 (while (setq prev-item
(org-list-get-prev-item prev-item struct prevs
))
951 (push prev-item before-item
))
952 (while (setq next-item
(org-list-get-next-item next-item struct prevs
))
953 (push next-item after-item
))
954 (append before-item
(list item
) (nreverse after-item
))))
956 (defun org-list-get-children (item _struct parents
)
957 "List all children of ITEM, or nil.
958 STRUCT is the list structure. PARENTS is the alist of parents,
959 as returned by `org-list-parents-alist'."
961 (while (setq child
(car (rassq item parents
)))
962 (setq parents
(cdr (member (assq child parents
) parents
)))
966 (defun org-list-get-top-point (struct)
967 "Return point at beginning of list.
968 STRUCT is the list structure."
971 (defun org-list-get-bottom-point (struct)
972 "Return point at bottom of list.
973 STRUCT is the list structure."
975 (mapcar (lambda (e) (org-list-get-item-end (car e
) struct
)) struct
)))
977 (defun org-list-get-list-begin (item struct prevs
)
978 "Return point at beginning of sub-list ITEM belongs.
979 STRUCT is the list structure. PREVS is the alist of previous
980 items, as returned by `org-list-prevs-alist'."
981 (let ((first-item item
) prev-item
)
982 (while (setq prev-item
(org-list-get-prev-item first-item struct prevs
))
983 (setq first-item prev-item
))
986 (defalias 'org-list-get-first-item
'org-list-get-list-begin
)
988 (defun org-list-get-last-item (item struct prevs
)
989 "Return point at last item of sub-list ITEM belongs.
990 STRUCT is the list structure. PREVS is the alist of previous
991 items, as returned by `org-list-prevs-alist'."
992 (let ((last-item item
) next-item
)
993 (while (setq next-item
(org-list-get-next-item last-item struct prevs
))
994 (setq last-item next-item
))
997 (defun org-list-get-list-end (item struct prevs
)
998 "Return point at end of sub-list ITEM belongs.
999 STRUCT is the list structure. PREVS is the alist of previous
1000 items, as returned by `org-list-prevs-alist'."
1001 (org-list-get-item-end (org-list-get-last-item item struct prevs
) struct
))
1003 (defun org-list-get-list-type (item struct prevs
)
1004 "Return the type of the list containing ITEM, as a symbol.
1006 STRUCT is the list structure. PREVS is the alist of previous
1007 items, as returned by `org-list-prevs-alist'.
1009 Possible types are `descriptive', `ordered' and `unordered'. The
1010 type is determined by the first item of the list."
1011 (let ((first (org-list-get-list-begin item struct prevs
)))
1013 ((string-match "[[:alnum:]]" (org-list-get-bullet first struct
)) 'ordered
)
1014 ((org-list-get-tag first struct
) 'descriptive
)
1017 (defun org-list-get-item-number (item struct prevs parents
)
1018 "Return ITEM's sequence number.
1020 STRUCT is the list structure. PREVS is the alist of previous
1021 items, as returned by `org-list-prevs-alist'. PARENTS is the
1022 alist of ancestors, as returned by `org-list-parents-alist'.
1024 Return value is a list of integers. Counters have an impact on
1026 (let ((get-relative-number
1028 (lambda (item struct prevs
)
1029 ;; Return relative sequence number of ITEM in the sub-list
1030 ;; it belongs. STRUCT is the list structure. PREVS is
1031 ;; the alist of previous items.
1032 (let ((seq 0) (pos item
) counter
)
1033 (while (and (not (setq counter
(org-list-get-counter pos struct
)))
1034 (setq pos
(org-list-get-prev-item pos struct prevs
)))
1036 (if (not counter
) (1+ seq
)
1038 ((string-match "[A-Za-z]" counter
)
1039 (+ (- (string-to-char (upcase (match-string 0 counter
))) 64)
1041 ((string-match "[0-9]+" counter
)
1042 (+ (string-to-number (match-string 0 counter
)) seq
))
1044 ;; Cons each parent relative number into return value (OUT).
1045 (let ((out (list (funcall get-relative-number item struct prevs
)))
1047 (while (setq parent
(org-list-get-parent parent struct parents
))
1048 (push (funcall get-relative-number parent struct prevs
) out
))
1056 (defun org-list-search-generic (search re bound noerr
)
1057 "Search a string in valid contexts for lists.
1058 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1059 in `re-search-forward'."
1061 (let ((origin (point)))
1063 ;; 1. No match: return to origin or bound, depending on NOERR.
1064 (unless (funcall search re bound noerr
)
1065 (throw 'exit
(and (goto-char (if (memq noerr
'(t nil
)) origin bound
))
1067 ;; 2. Match in valid context: return point. Else, continue
1069 (when (org-list-in-valid-context-p) (throw 'exit
(point)))))))
1071 (defun org-list-search-backward (regexp &optional bound noerror
)
1072 "Like `re-search-backward' but stop only where lists are recognized.
1073 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1074 `re-search-backward'."
1075 (org-list-search-generic #'re-search-backward
1076 regexp
(or bound
(point-min)) noerror
))
1078 (defun org-list-search-forward (regexp &optional bound noerror
)
1079 "Like `re-search-forward' but stop only where lists are recognized.
1080 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1081 `re-search-forward'."
1082 (org-list-search-generic #'re-search-forward
1083 regexp
(or bound
(point-max)) noerror
))
1087 ;;; Methods on structures
1089 (defsubst org-list-bullet-string
(bullet)
1090 "Return BULLET with the correct number of whitespaces.
1091 It determines the number of whitespaces to append by looking at
1092 `org-list-two-spaces-after-bullet-regexp'."
1094 (let ((spaces (if (and org-list-two-spaces-after-bullet-regexp
1096 org-list-two-spaces-after-bullet-regexp bullet
))
1099 (if (string-match "\\S-+\\([ \t]*\\)" bullet
)
1100 (replace-match spaces nil nil bullet
1)
1103 (defun org-list-swap-items (beg-A beg-B struct
)
1104 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1106 Blank lines at the end of items are left in place. Item
1107 visibility is preserved. Return the new structure after the
1110 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1111 to the same sub-list.
1113 This function modifies STRUCT."
1115 (let* ((end-A-no-blank (org-list-get-item-end-before-blank beg-A struct
))
1116 (end-B-no-blank (org-list-get-item-end-before-blank beg-B struct
))
1117 (end-A (org-list-get-item-end beg-A struct
))
1118 (end-B (org-list-get-item-end beg-B struct
))
1119 (size-A (- end-A-no-blank beg-A
))
1120 (size-B (- end-B-no-blank beg-B
))
1121 (body-A (buffer-substring beg-A end-A-no-blank
))
1122 (body-B (buffer-substring beg-B end-B-no-blank
))
1123 (between-A-no-blank-and-B (buffer-substring end-A-no-blank beg-B
))
1124 (sub-A (cons beg-A
(org-list-get-subtree beg-A struct
)))
1125 (sub-B (cons beg-B
(org-list-get-subtree beg-B struct
)))
1126 ;; Store overlays responsible for visibility status. We
1127 ;; also need to store their boundaries as they will be
1128 ;; removed from buffer.
1133 (and (>= (overlay-start o
) beg-A
)
1134 (<= (overlay-end o
) end-A
)
1135 (list o
(overlay-start o
) (overlay-end o
))))
1136 (overlays-in beg-A end-A
)))
1139 (and (>= (overlay-start o
) beg-B
)
1140 (<= (overlay-end o
) end-B
)
1141 (list o
(overlay-start o
) (overlay-end o
))))
1142 (overlays-in beg-B end-B
))))))
1143 ;; 1. Move effectively items in buffer.
1145 (delete-region beg-A end-B-no-blank
)
1146 (insert (concat body-B between-A-no-blank-and-B body-A
))
1147 ;; 2. Now modify struct. No need to re-read the list, the
1148 ;; transformation is just a shift of positions. Some special
1149 ;; attention is required for items ending at END-A and END-B
1150 ;; as empty spaces are not moved there. In others words,
1151 ;; item BEG-A will end with whitespaces that were at the end
1152 ;; of BEG-B and the same applies to BEG-B.
1154 (let ((pos (car e
)))
1158 (let ((end-e (nth 6 e
)))
1159 (setcar e
(+ pos
(- end-B-no-blank end-A-no-blank
)))
1160 (setcar (nthcdr 6 e
)
1161 (+ end-e
(- end-B-no-blank end-A-no-blank
)))
1162 (when (= end-e end-A
) (setcar (nthcdr 6 e
) end-B
))))
1164 (let ((end-e (nth 6 e
)))
1165 (setcar e
(- (+ pos beg-A
) beg-B
))
1166 (setcar (nthcdr 6 e
) (+ end-e
(- beg-A beg-B
)))
1167 (when (= end-e end-B
)
1168 (setcar (nthcdr 6 e
)
1169 (+ beg-A size-B
(- end-A end-A-no-blank
))))))
1171 (let ((end-e (nth 6 e
)))
1172 (setcar e
(+ pos
(- size-B size-A
)))
1173 (setcar (nthcdr 6 e
) (+ end-e
(- size-B size-A
))))))))
1174 (setq struct
(sort struct
#'car-less-than-car
))
1175 ;; Restore visibility status, by moving overlays to their new
1177 (dolist (ov (car overlays
))
1180 (+ (nth 1 ov
) (- (+ beg-B
(- size-B size-A
)) beg-A
))
1181 (+ (nth 2 ov
) (- (+ beg-B
(- size-B size-A
)) beg-A
))))
1182 (dolist (ov (cdr overlays
))
1183 (move-overlay (car ov
)
1184 (+ (nth 1 ov
) (- beg-A beg-B
))
1185 (+ (nth 2 ov
) (- beg-A beg-B
))))
1186 ;; Return structure.
1189 (defun org-list-separating-blank-lines-number (pos struct prevs
)
1190 "Return number of blank lines that should separate items in list.
1192 POS is the position of point where `org-list-insert-item' was called.
1194 STRUCT is the list structure. PREVS is the alist of previous
1195 items, as returned by `org-list-prevs-alist'.
1197 Assume point is at item's beginning. If the item is alone, apply
1198 some heuristics to guess the result."
1200 (let ((item (point))
1202 (cdr (assq 'plain-list-item org-blank-before-new-entry
)))
1207 ;; Count blank lines above beginning of line.
1209 (count-lines (goto-char (point-at-bol))
1210 (progn (skip-chars-backward " \r\t\n")
1214 ;; Trivial cases where there should be none.
1215 ((not insert-blank-p
) 0)
1216 ;; When `org-blank-before-new-entry' says so, it is 1.
1217 ((eq insert-blank-p t
) 1)
1218 ;; `plain-list-item' is 'auto. Count blank lines separating
1219 ;; neighbors' items in list.
1220 (t (let ((next-p (org-list-get-next-item item struct prevs
)))
1222 ;; Is there a next item?
1223 (next-p (goto-char next-p
)
1224 (funcall count-blanks
))
1225 ;; Is there a previous item?
1226 ((org-list-get-prev-item item struct prevs
)
1227 (funcall count-blanks
))
1228 ;; User inserted blank lines, trust him.
1229 ((and (> pos
(org-list-get-item-end-before-blank item struct
))
1230 (> (save-excursion (goto-char pos
)
1231 (setq usr-blank
(funcall count-blanks
)))
1234 ;; Are there blank lines inside the list so far?
1236 (goto-char (org-list-get-top-point struct
))
1237 ;; Do not use `org-list-search-forward' so blank lines
1238 ;; in blocks can be counted in.
1240 "^[ \t]*$" (org-list-get-item-end-before-blank item struct
) t
))
1242 ;; Default choice: no blank line.
1245 (defun org-list-insert-item (pos struct prevs
&optional checkbox after-bullet
)
1246 "Insert a new list item at POS and return the new structure.
1247 If POS is before first character after bullet of the item, the
1248 new item will be created before the current one.
1250 STRUCT is the list structure. PREVS is the alist of previous
1251 items, as returned by `org-list-prevs-alist'.
1253 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1254 after the bullet. Cursor will be after this text once the
1257 This function modifies STRUCT."
1258 (let ((case-fold-search t
))
1259 ;; 1. Get information about list: position of point with regards
1260 ;; to item start (BEFOREP), blank lines number separating items
1261 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1262 (let* ((item (progn (goto-char pos
) (goto-char (org-list-get-item-begin))))
1263 (item-end (org-list-get-item-end item struct
))
1264 (item-end-no-blank (org-list-get-item-end-before-blank item struct
))
1267 (looking-at org-list-full-item-re
)
1270 ((not (match-beginning 4)) (match-end 0))
1271 ;; Ignore tag in a non-descriptive list.
1272 ((save-match-data (string-match "[.)]" (match-string 1)))
1273 (match-beginning 4))
1275 (goto-char (match-end 4))
1276 (skip-chars-forward " \t")
1278 (split-line-p (org-get-alist-option org-M-RET-may-split-line
'item
))
1279 (blank-nb (org-list-separating-blank-lines-number
1281 ;; 2. Build the new item to be created. Concatenate same
1282 ;; bullet as item, checkbox, text AFTER-BULLET if
1283 ;; provided, and text cut from point to end of item
1284 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1285 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1286 ;; between what was cut and what was inserted in buffer
1287 ;; is stored in SIZE-OFFSET.
1288 (ind (org-list-get-ind item struct
))
1289 (ind-size (if indent-tabs-mode
1290 (+ (/ ind tab-width
) (mod ind tab-width
))
1292 (bullet (org-list-bullet-string (org-list-get-bullet item struct
)))
1293 (box (when checkbox
"[ ]"))
1295 (and (not beforep
) split-line-p
1298 ;; If POS is greater than ITEM-END, then point is
1299 ;; in some white lines after the end of the list.
1300 ;; Those must be removed, or they will be left,
1301 ;; stacking up after the list.
1302 (when (< item-end pos
)
1303 (delete-region (1- item-end
) (point-at-eol)))
1304 (skip-chars-backward " \r\t\n")
1306 (delete-and-extract-region pos item-end-no-blank
))))
1307 (body (concat bullet
(when box
(concat box
" ")) after-bullet
1309 (if (string-match "\\`[ \t]+" text-cut
)
1310 (replace-match "" t t text-cut
)
1312 (item-sep (make-string (1+ blank-nb
) ?
\n))
1313 (item-size (+ ind-size
(length body
) (length item-sep
)))
1314 (size-offset (- item-size
(length text-cut
))))
1315 ;; 4. Insert effectively item into buffer.
1317 (org-indent-to-column ind
)
1318 (insert body item-sep
)
1319 ;; 5. Add new item to STRUCT.
1321 (let ((p (car e
)) (end (nth 6 e
)))
1323 ;; Before inserted item, positions don't change but
1324 ;; an item ending after insertion has its end shifted
1327 (when (> end item
) (setcar (nthcdr 6 e
) (+ end size-offset
))))
1328 ;; Trivial cases where current item isn't split in
1329 ;; two. Just shift every item after new one by
1331 ((or beforep
(not split-line-p
))
1332 (setcar e
(+ p item-size
))
1333 (setcar (nthcdr 6 e
) (+ end item-size
)))
1334 ;; Item is split in two: elements before POS are just
1335 ;; shifted by ITEM-SIZE. In the case item would end
1336 ;; after split POS, ending is only shifted by
1339 (setcar e
(+ p item-size
))
1341 (setcar (nthcdr 6 e
) (+ end item-size
))
1342 (setcar (nthcdr 6 e
) (+ end size-offset
))))
1343 ;; Elements after POS are moved into new item.
1344 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1345 ;; doesn't appear in buffer yet.
1347 (setcar e
(+ p size-offset
(- item pos
(length item-sep
))))
1348 (if (= end item-end
)
1349 (setcar (nthcdr 6 e
) (+ item item-size
))
1350 (setcar (nthcdr 6 e
)
1352 (- item pos
(length item-sep
))))))
1353 ;; Elements at ITEM-END or after are only shifted by
1355 (t (setcar e
(+ p size-offset
))
1356 (setcar (nthcdr 6 e
) (+ end size-offset
))))))
1358 (push (list item ind bullet nil box nil
(+ item item-size
)) struct
)
1359 (setq struct
(sort struct
(lambda (e1 e2
) (< (car e1
) (car e2
)))))
1360 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1361 ;; exchange ITEM with the next item in list. Position cursor
1362 ;; after bullet, counter, checkbox, and label.
1365 (setq struct
(org-list-swap-items item
(+ item item-size
) struct
))
1366 (goto-char (org-list-get-next-item
1367 item struct
(org-list-prevs-alist struct
))))
1370 (defun org-list-delete-item (item struct
)
1371 "Remove ITEM from the list and return the new structure.
1373 STRUCT is the list structure."
1374 (let* ((end (org-list-get-item-end item struct
))
1375 (beg (if (= (org-list-get-bottom-point struct
) end
)
1376 ;; If ITEM ends with the list, delete blank lines
1380 (skip-chars-backward " \r\t\n")
1381 (min (1+ (point-at-eol)) (point-max)))
1383 ;; Remove item from buffer.
1384 (delete-region beg end
)
1385 ;; Remove item from structure and shift others items accordingly.
1386 ;; Don't forget to shift also ending position when appropriate.
1387 (let ((size (- end beg
)))
1388 (delq nil
(mapcar (lambda (e)
1389 (let ((pos (car e
)))
1392 (let ((end-e (nth 6 e
)))
1396 (append (butlast e
) (list beg
)))
1398 (append (butlast e
) (list (- end-e size
)))))))
1402 (append (butlast (cdr e
))
1403 (list (- (nth 6 e
) size
))))))))
1406 (defun org-list-send-item (item dest struct
)
1407 "Send ITEM to destination DEST.
1409 STRUCT is the list structure.
1411 DEST can have various values.
1413 If DEST is a buffer position, the function will assume it points
1414 to another item in the same list as ITEM, and will move the
1415 latter just before the former.
1417 If DEST is `begin' (respectively `end'), ITEM will be moved at
1418 the beginning (respectively end) of the list it belongs to.
1420 If DEST is a string like \"N\", where N is an integer, ITEM will
1421 be moved at the Nth position in the list.
1423 If DEST is `kill', ITEM will be deleted and its body will be
1424 added to the kill-ring.
1426 If DEST is `delete', ITEM will be deleted.
1428 Visibility of item is preserved.
1430 This function returns, destructively, the new list structure."
1431 (let* ((prevs (org-list-prevs-alist struct
))
1432 (item-end (org-list-get-item-end item struct
))
1433 ;; Grab full item body minus its bullet.
1440 (regexp-quote (org-list-get-bullet item struct
))))
1443 ;; Change DEST into a buffer position. A trick is needed
1444 ;; when ITEM is meant to be sent at the end of the list.
1445 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1446 ;; nil and insertion point (INS-POINT) to the first line's
1447 ;; end of the last item, we ensure the new item will be
1448 ;; inserted after the last item, and not after any of its
1449 ;; hypothetical sub-items.
1451 ((or (eq dest
'kill
) (eq dest
'delete
)))
1453 (setq dest
(org-list-get-list-begin item struct prevs
)))
1455 (setq dest
(org-list-get-list-end item struct prevs
))
1457 (goto-char (org-list-get-last-item item struct prevs
))
1459 ((string-match "\\`[0-9]+\\'" dest
)
1460 (let* ((all (org-list-get-all-items item struct prevs
))
1462 (index (mod (string-to-number dest
) len
)))
1463 (if (not (zerop index
))
1464 (setq dest
(nth (1- index
) all
))
1465 ;; Send ITEM at the end of the list.
1466 (setq dest
(org-list-get-list-end item struct prevs
))
1469 (org-list-get-last-item item struct prevs
))
1472 (org-M-RET-may-split-line nil
)
1473 ;; Store inner overlays (to preserve visibility).
1474 (overlays (org-remove-if (lambda (o) (or (< (overlay-start o
) item
)
1475 (> (overlay-end o
) item
)))
1476 (overlays-in item item-end
))))
1478 ((eq dest
'delete
) (org-list-delete-item item struct
))
1481 (org-list-delete-item item struct
))
1482 ((and (integerp dest
) (/= item ins-point
))
1483 (setq item
(copy-marker item
))
1484 (setq struct
(org-list-insert-item ins-point struct prevs nil body
))
1485 ;; 1. Structure returned by `org-list-insert-item' may not be
1486 ;; accurate, as it cannot see sub-items included in BODY.
1487 ;; Thus, first compute the real structure so far.
1489 (cons (marker-position item
)
1490 (org-list-get-subtree (marker-position item
) struct
)))
1491 (new-end (org-list-get-item-end (point) struct
))
1492 (old-end (org-list-get-item-end (marker-position item
) struct
))
1494 (shift (- (point) item
)))
1495 ;; 1.1. Remove the item just created in structure.
1496 (setq struct
(delete (assq new-item struct
) struct
))
1497 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1502 (let* ((cell (assq e struct
))
1506 (append (butlast (cdr cell
))
1507 (list (if (= end old-end
)
1511 #'car-less-than-car
)))
1512 ;; 2. Restore inner overlays.
1513 (dolist (o overlays
)
1515 (+ (overlay-start o
) (- (point) item
))
1516 (+ (overlay-end o
) (- (point) item
))))
1517 ;; 3. Eventually delete extra copy of the item and clean marker.
1518 (prog1 (org-list-delete-item (marker-position item
) struct
)
1519 (move-marker item nil
)))
1522 (defun org-list-struct-outdent (start end struct parents
)
1523 "Outdent items between positions START and END.
1525 STRUCT is the list structure. PARENTS is the alist of items'
1526 parents, as returned by `org-list-parents-alist'.
1528 START is included, END excluded."
1531 (let* ((item (car cell
))
1532 (parent (cdr cell
)))
1534 ;; Item not yet in zone: keep association.
1535 ((< item start
) cell
)
1536 ;; Item out of zone: follow associations in ACC.
1538 (let ((convert (and parent
(assq parent acc
))))
1539 (if convert
(cons item
(cdr convert
)) cell
)))
1540 ;; Item has no parent: error
1542 (error "Cannot outdent top-level items"))
1543 ;; Parent is outdented: keep association.
1545 (push (cons parent item
) acc
) cell
)
1547 ;; Parent isn't outdented: reparent to grand-parent.
1548 (let ((grand-parent (org-list-get-parent
1549 parent struct parents
)))
1550 (push (cons parent item
) acc
)
1551 (cons item grand-parent
))))))))
1552 (mapcar out parents
)))
1554 (defun org-list-struct-indent (start end struct parents prevs
)
1555 "Indent items between positions START and END.
1557 STRUCT is the list structure. PARENTS is the alist of parents
1558 and PREVS is the alist of previous items, returned by,
1559 respectively, `org-list-parents-alist' and
1560 `org-list-prevs-alist'.
1562 START is included and END excluded.
1564 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1565 bullets between START and END."
1567 (set-assoc (lambda (cell) (push cell acc
) cell
))
1568 (change-bullet-maybe
1573 ;; Normalize ordered bullets.
1574 (let ((bul (org-trim
1575 (org-list-get-bullet item struct
))))
1576 (cond ((string-match "[A-Z]\\." bul
) "A.")
1577 ((string-match "[A-Z])" bul
) "A)")
1578 ((string-match "[a-z]\\." bul
) "a.")
1579 ((string-match "[a-z])" bul
) "a)")
1580 ((string-match "[0-9]\\." bul
) "1.")
1581 ((string-match "[0-9])" bul
) "1)")
1583 org-list-demote-modify-bullet
))))
1584 (when new-bul-p
(org-list-set-bullet item struct new-bul-p
))))))
1587 (let* ((item (car cell
))
1588 (parent (cdr cell
)))
1590 ;; Item not yet in zone: keep association.
1591 ((< item start
) cell
)
1593 ;; Item out of zone: follow associations in ACC.
1594 (let ((convert (assq parent acc
)))
1595 (if convert
(cons item
(cdr convert
)) cell
)))
1597 ;; Item is in zone...
1598 (let ((prev (org-list-get-prev-item item struct prevs
)))
1599 ;; Check if bullet needs to be changed.
1600 (funcall change-bullet-maybe item
)
1602 ;; First item indented but not parent: error
1603 ((and (not prev
) (< parent start
))
1604 (error "Cannot indent the first item of a list"))
1605 ;; First item and parent indented: keep same
1607 ((not prev
) (funcall set-assoc cell
))
1608 ;; Previous item not indented: reparent to it.
1609 ((< prev start
) (funcall set-assoc
(cons item prev
)))
1610 ;; Previous item indented: reparent like it.
1613 (cons item
(cdr (assq prev acc
)))))))))))))
1614 (mapcar ind parents
)))
1618 ;;; Repairing structures
1620 (defun org-list-use-alpha-bul-p (first struct prevs
)
1621 "Non-nil if list starting at FIRST can have alphabetical bullets.
1623 STRUCT is list structure. PREVS is the alist of previous items,
1624 as returned by `org-list-prevs-alist'."
1625 (and org-list-allow-alphabetical
1627 (let ((item first
) (ascii 64) (case-fold-search nil
))
1628 ;; Pretend that bullets are uppercase and check if alphabet
1629 ;; is sufficient, taking counters into account.
1631 (let ((count (org-list-get-counter item struct
)))
1632 ;; Virtually determine current bullet
1633 (if (and count
(string-match "[a-zA-Z]" count
))
1634 ;; Counters are not case-sensitive.
1635 (setq ascii
(string-to-char (upcase count
)))
1636 (setq ascii
(1+ ascii
)))
1637 ;; Test if bullet would be over z or Z.
1640 (setq item
(org-list-get-next-item item struct prevs
)))))
1641 ;; All items checked. All good.
1644 (defun org-list-inc-bullet-maybe (bullet)
1645 "Increment BULLET if applicable."
1646 (let ((case-fold-search nil
))
1648 ;; Num bullet: increment it.
1649 ((string-match "[0-9]+" bullet
)
1651 (number-to-string (1+ (string-to-number (match-string 0 bullet
))))
1653 ;; Alpha bullet: increment it.
1654 ((string-match "[A-Za-z]" bullet
)
1656 (char-to-string (1+ (string-to-char (match-string 0 bullet
))))
1658 ;; Unordered bullet: leave it.
1661 (defun org-list-struct-fix-bul (struct prevs
)
1662 "Verify and correct bullets in STRUCT.
1663 PREVS is the alist of previous items, as returned by
1664 `org-list-prevs-alist'.
1666 This function modifies STRUCT."
1667 (let ((case-fold-search nil
)
1670 ;; Set bullet of ITEM in STRUCT, depending on the type of
1671 ;; first item of the list, the previous bullet and counter
1674 (let* ((prev (org-list-get-prev-item item struct prevs
))
1675 (prev-bul (and prev
(org-list-get-bullet prev struct
)))
1676 (counter (org-list-get-counter item struct
))
1677 (bullet (org-list-get-bullet item struct
))
1678 (alphap (and (not prev
)
1679 (org-list-use-alpha-bul-p item struct prevs
))))
1680 (org-list-set-bullet
1682 (org-list-bullet-string
1684 ;; Alpha counter in alpha list: use counter.
1686 (string-match "[a-zA-Z]" counter
)
1687 (string-match "[a-zA-Z]" prev-bul
))
1688 ;; Use cond to be sure `string-match' is used in
1692 ((string-match "[a-z]" prev-bul
) (downcase counter
))
1693 ((string-match "[A-Z]" prev-bul
) (upcase counter
)))))
1694 (replace-match real-count nil nil prev-bul
)))
1695 ;; Num counter in a num list: use counter.
1697 (string-match "[0-9]+" counter
)
1698 (string-match "[0-9]+" prev-bul
))
1699 (replace-match counter nil nil prev-bul
))
1700 ;; No counter: increase, if needed, previous bullet.
1702 (org-list-inc-bullet-maybe (org-list-get-bullet prev struct
)))
1703 ;; Alpha counter at first item: use counter.
1704 ((and counter
(org-list-use-alpha-bul-p item struct prevs
)
1705 (string-match "[A-Za-z]" counter
)
1706 (string-match "[A-Za-z]" bullet
))
1709 ((string-match "[a-z]" bullet
) (downcase counter
))
1710 ((string-match "[A-Z]" bullet
) (upcase counter
)))))
1711 (replace-match real-count nil nil bullet
)))
1712 ;; Num counter at first item: use counter.
1714 (string-match "[0-9]+" counter
)
1715 (string-match "[0-9]+" bullet
))
1716 (replace-match counter nil nil bullet
))
1717 ;; First bullet is alpha uppercase: use "A".
1718 ((and alphap
(string-match "[A-Z]" bullet
))
1719 (replace-match "A" nil nil bullet
))
1720 ;; First bullet is alpha lowercase: use "a".
1721 ((and alphap
(string-match "[a-z]" bullet
))
1722 (replace-match "a" nil nil bullet
))
1723 ;; First bullet is num: use "1".
1724 ((string-match "\\([0-9]+\\|[A-Za-z]\\)" bullet
)
1725 (replace-match "1" nil nil bullet
))
1726 ;; Not an ordered list: keep bullet.
1728 (mapc fix-bul
(mapcar #'car struct
))))
1730 (defun org-list-struct-fix-ind (struct parents
&optional bullet-size
)
1731 "Verify and correct indentation in STRUCT.
1733 PARENTS is the alist of parents, as returned by
1734 `org-list-parents-alist'.
1736 If numeric optional argument BULLET-SIZE is set, assume all
1737 bullets in list have this length to determine new indentation.
1739 This function modifies STRUCT."
1740 (let* ((ancestor (org-list-get-top-point struct
))
1741 (top-ind (org-list-get-ind ancestor struct
))
1744 (let ((parent (org-list-get-parent item struct parents
)))
1746 ;; Indent like parent + length of parent's bullet +
1749 item struct
(+ (or bullet-size
1751 (org-list-get-bullet parent struct
)))
1752 (org-list-get-ind parent struct
)
1753 org-list-indent-offset
))
1754 ;; If no parent, indent like top-point.
1755 (org-list-set-ind item struct top-ind
))))))
1756 (mapc new-ind
(mapcar #'car
(cdr struct
)))))
1758 (defun org-list-struct-fix-box (struct parents prevs
&optional ordered
)
1759 "Verify and correct checkboxes in STRUCT.
1761 PARENTS is the alist of parents and PREVS is the alist of
1762 previous items, as returned by, respectively,
1763 `org-list-parents-alist' and `org-list-prevs-alist'.
1765 If ORDERED is non-nil, a checkbox can only be checked when every
1766 checkbox before it is checked too. If there was an attempt to
1767 break this rule, the function will return the blocking item. In
1768 all others cases, the return value will be nil.
1770 This function modifies STRUCT."
1771 (let ((all-items (mapcar #'car struct
))
1776 (mapcar (lambda (child)
1777 (org-list-get-checkbox child struct
))
1778 (org-list-get-children item struct parents
))))
1779 (org-list-set-checkbox
1782 ((and (member "[ ]" box-list
) (member "[X]" box-list
)) "[-]")
1783 ((member "[-]" box-list
) "[-]")
1784 ((member "[X]" box-list
) "[X]")
1785 ((member "[ ]" box-list
) "[ ]")
1786 ;; Parent has no boxed child: leave box as-is.
1787 (t (org-list-get-checkbox item struct
))))))))
1789 ;; 1. List all parents with a checkbox.
1792 (let* ((parent (org-list-get-parent e struct parents
))
1793 (parent-box-p (org-list-get-checkbox parent struct
)))
1794 (when (and parent-box-p
(not (memq parent parent-list
)))
1795 (push parent parent-list
))))
1797 ;; 2. Sort those parents by decreasing indentation.
1798 (setq parent-list
(sort parent-list
1800 (> (org-list-get-ind e1 struct
)
1801 (org-list-get-ind e2 struct
)))))
1802 ;; 3. For each parent, get all children's checkboxes to determine
1803 ;; and set its checkbox accordingly.
1804 (mapc set-parent-box parent-list
)
1805 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1808 (mapcar (lambda (e) (org-list-get-checkbox e struct
)) all-items
))
1809 (after-unchecked (member "[ ]" box-list
)))
1810 ;; There are boxes checked after an unchecked one: fix that.
1811 (when (member "[X]" after-unchecked
)
1812 (let ((index (- (length struct
) (length after-unchecked
))))
1814 (when (org-list-get-checkbox e struct
)
1815 (org-list-set-checkbox e struct
"[ ]")))
1816 (nthcdr index all-items
))
1817 ;; Verify once again the structure, without ORDERED.
1818 (org-list-struct-fix-box struct parents prevs nil
)
1819 ;; Return blocking item.
1820 (nth index all-items
)))))))
1822 (defun org-list-struct-fix-item-end (struct)
1823 "Verify and correct each item end position in STRUCT.
1825 This function modifies STRUCT."
1826 (let (end-list acc-end
)
1828 (let* ((pos (car e
))
1829 (ind-pos (org-list-get-ind pos struct
))
1830 (end-pos (org-list-get-item-end pos struct
)))
1831 (unless (assq end-pos struct
)
1832 ;; To determine real ind of an ending position that is
1833 ;; not at an item, we have to find the item it belongs
1834 ;; to: it is the last item (ITEM-UP), whose ending is
1835 ;; further than the position we're interested in.
1836 (let ((item-up (assoc-default end-pos acc-end
'>)))
1838 ;; Else part is for the bottom point.
1839 (if item-up
(+ (org-list-get-ind item-up struct
) 2) 0)
1842 (push (cons ind-pos pos
) end-list
)
1843 (push (cons end-pos pos
) acc-end
)))
1845 (setq end-list
(sort end-list
(lambda (e1 e2
) (< (cdr e1
) (cdr e2
)))))
1846 (org-list-struct-assoc-end struct end-list
)))
1848 (defun org-list-struct-apply-struct (struct old-struct
)
1849 "Apply set difference between STRUCT and OLD-STRUCT to the buffer.
1851 OLD-STRUCT is the structure before any modifications, and STRUCT
1852 the structure to be applied. The function will only modify parts
1853 of the list which have changed.
1855 Initial position of cursor is restored after the changes."
1856 (let* ((origin (point-marker))
1857 (inlinetask-re (and (featurep 'org-inlinetask
)
1858 (org-inlinetask-outline-regexp)))
1859 (item-re (org-item-re))
1862 ;; Shift the indentation between END and BEG by DELTA.
1863 ;; Start from the line before END.
1864 (lambda (end beg delta
)
1866 (skip-chars-backward " \r\t\n")
1868 (while (or (> (point) beg
)
1869 (and (= (point) beg
)
1870 (not (looking-at item-re
))))
1872 ;; Skip inline tasks.
1873 ((and inlinetask-re
(looking-at inlinetask-re
))
1874 (org-inlinetask-goto-beginning))
1875 ;; Shift only non-empty lines.
1876 ((org-looking-at-p "^[ \t]*\\S-")
1877 (org-indent-line-to (+ (org-get-indentation) delta
))))
1878 (forward-line -
1)))))
1881 ;; Replace ITEM first line elements with new elements from
1882 ;; STRUCT, if appropriate.
1885 (let* ((new-ind (org-list-get-ind item struct
))
1886 (old-ind (org-get-indentation))
1887 (new-bul (org-list-bullet-string
1888 (org-list-get-bullet item struct
)))
1889 (old-bul (org-list-get-bullet item old-struct
))
1890 (new-box (org-list-get-checkbox item struct
)))
1891 (looking-at org-list-full-item-re
)
1892 ;; a. Replace bullet
1893 (unless (equal old-bul new-bul
)
1894 (replace-match new-bul nil nil nil
1))
1895 ;; b. Replace checkbox.
1897 ((equal (match-string 3) new-box
))
1898 ((and (match-string 3) new-box
)
1899 (replace-match new-box nil nil nil
3))
1901 (looking-at ".*?\\([ \t]*\\[[ X-]\\]\\)")
1902 (replace-match "" nil nil nil
1))
1903 (t (let ((counterp (match-end 2)))
1904 (goto-char (if counterp
(1+ counterp
) (match-end 1)))
1905 (insert (concat new-box
(unless counterp
" "))))))
1906 ;; c. Indent item to appropriate column.
1907 (unless (= new-ind old-ind
)
1908 (delete-region (goto-char (point-at-bol))
1909 (progn (skip-chars-forward " \t") (point)))
1910 (indent-to new-ind
)))))))
1911 ;; 1. First get list of items and position endings. We maintain
1912 ;; two alists: ITM-SHIFT, determining indentation shift needed
1913 ;; at item, and END-LIST, a pseudo-alist where key is ending
1914 ;; position and value point.
1915 (let (end-list acc-end itm-shift all-ends sliced-struct
)
1916 (dolist (e old-struct
)
1917 (let* ((pos (car e
))
1918 (ind-pos (org-list-get-ind pos struct
))
1919 (ind-old (org-list-get-ind pos old-struct
))
1920 (bul-pos (org-list-get-bullet pos struct
))
1921 (bul-old (org-list-get-bullet pos old-struct
))
1922 (ind-shift (- (+ ind-pos
(length bul-pos
))
1923 (+ ind-old
(length bul-old
))))
1924 (end-pos (org-list-get-item-end pos old-struct
)))
1925 (push (cons pos ind-shift
) itm-shift
)
1926 (unless (assq end-pos old-struct
)
1927 ;; To determine real ind of an ending position that
1928 ;; is not at an item, we have to find the item it
1929 ;; belongs to: it is the last item (ITEM-UP), whose
1930 ;; ending is further than the position we're
1932 (let ((item-up (assoc-default end-pos acc-end
#'>)))
1933 (push (cons end-pos item-up
) end-list
)))
1934 (push (cons end-pos pos
) acc-end
)))
1935 ;; 2. Slice the items into parts that should be shifted by the
1936 ;; same amount of indentation. Each slice follow the pattern
1937 ;; (END BEG DELTA). Slices are returned in reverse order.
1938 (setq all-ends
(sort (append (mapcar #'car itm-shift
)
1939 (org-uniquify (mapcar #'car end-list
)))
1941 acc-end
(nreverse acc-end
))
1942 (while (cdr all-ends
)
1943 (let* ((up (pop all-ends
))
1944 (down (car all-ends
))
1945 (itemp (assq up struct
))
1947 (if itemp
(cdr (assq up itm-shift
))
1948 ;; If we're not at an item, there's a child of the
1949 ;; item point belongs to above. Make sure the less
1950 ;; indented line in this slice has the same column
1952 (let* ((child (cdr (assq up acc-end
)))
1953 (ind (org-list-get-ind child struct
))
1954 (min-ind most-positive-fixnum
))
1957 (while (< (point) down
)
1958 ;; Ignore empty lines. Also ignore blocks and
1959 ;; drawers contents.
1960 (unless (org-looking-at-p "[ \t]*$")
1961 (setq min-ind
(min (org-get-indentation) min-ind
))
1963 ((and (looking-at "#\\+BEGIN\\(:\\|_\\S-+\\)")
1965 (format "^[ \t]*#\\+END%s[ \t]*$"
1968 ((and (looking-at org-drawer-regexp
)
1969 (re-search-forward "^[ \t]*:END:[ \t]*$"
1973 (push (list down up delta
) sliced-struct
)))
1974 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1975 ;; end to beginning. Take a special action when beginning is
1977 (dolist (e sliced-struct
)
1978 (unless (zerop (nth 2 e
)) (apply shift-body-ind e
))
1979 (let* ((beg (nth 1 e
))
1980 (cell (assq beg struct
)))
1981 (unless (or (not cell
) (equal cell
(assq beg old-struct
)))
1982 (funcall modify-item beg
)))))
1983 ;; 4. Go back to initial position and clean marker.
1985 (move-marker origin nil
)))
1987 (defun org-list-write-struct (struct parents
&optional old-struct
)
1988 "Correct bullets, checkboxes and indentation in list at point.
1990 STRUCT is the list structure. PARENTS is the alist of parents,
1991 as returned by `org-list-parents-alist'.
1993 When non-nil, optional argument OLD-STRUCT is the reference
1994 structure of the list. It should be provided whenever STRUCT
1995 doesn't correspond anymore to the real list in buffer."
1996 ;; Order of functions matters here: checkboxes and endings need
1997 ;; correct indentation to be set, and indentation needs correct
2000 ;; 0. Save a copy of structure before modifications
2001 (let ((old-struct (or old-struct
(copy-tree struct
))))
2002 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
2003 ;; order to get items endings and bullets properly
2004 (org-list-struct-fix-ind struct parents
2)
2005 ;; 2. Fix each item end to get correct prevs alist.
2006 (org-list-struct-fix-item-end struct
)
2007 ;; 3. Get bullets right.
2008 (let ((prevs (org-list-prevs-alist struct
)))
2009 (org-list-struct-fix-bul struct prevs
)
2010 ;; 4. Now get real indentation.
2011 (org-list-struct-fix-ind struct parents
)
2012 ;; 5. Eventually fix checkboxes.
2013 (org-list-struct-fix-box struct parents prevs
))
2014 ;; 6. Apply structure modifications to buffer.
2015 (org-list-struct-apply-struct struct old-struct
)))
2021 (defun org-apply-on-list (function init-value
&rest args
)
2022 "Call FUNCTION on each item of the list at point.
2023 FUNCTION must be called with at least one argument: INIT-VALUE,
2024 that will contain the value returned by the function at the
2025 previous item, plus ARGS extra arguments.
2027 FUNCTION is applied on items in reverse order.
2029 As an example, \(org-apply-on-list \(lambda \(result) \(1+ result)) 0)
2030 will return the number of items in the current list.
2032 Sublists of the list are skipped. Cursor is always at the
2033 beginning of the item."
2034 (let* ((struct (org-list-struct))
2035 (prevs (org-list-prevs-alist struct
))
2036 (item (copy-marker (point-at-bol)))
2037 (all (org-list-get-all-items (marker-position item
) struct prevs
))
2041 (setq value
(apply function value args
)))
2044 (move-marker item nil
)
2047 (defun org-list-set-item-visibility (item struct view
)
2048 "Set visibility of ITEM in STRUCT to VIEW.
2050 Possible values are: `folded', `children' or `subtree'. See
2051 `org-cycle' for more information."
2054 (let ((item-end (org-list-get-item-end-before-blank item struct
)))
2056 (outline-flag-region (save-excursion (goto-char item
) (point-at-eol))
2058 ((eq view
'children
)
2059 ;; First show everything.
2060 (org-list-set-item-visibility item struct
'subtree
)
2061 ;; Then fold every child.
2062 (let* ((parents (org-list-parents-alist struct
))
2063 (children (org-list-get-children item struct parents
)))
2065 (org-list-set-item-visibility e struct
'folded
))
2069 (let ((item-end (org-list-get-item-end item struct
)))
2070 (outline-flag-region item item-end nil
)))))
2072 (defun org-list-item-body-column (item)
2073 "Return column at which body of ITEM should start."
2076 (looking-at "[ \t]*\\(\\S-+\\)\\(.*[ \t]+::\\)?\\([ \t]+\\|$\\)")
2077 (if (match-beginning 2)
2078 (let ((start (1+ (match-end 2)))
2079 (ind (org-get-indentation)))
2080 (if (> start
(+ ind org-description-max-indent
)) (+ ind
5) start
))
2081 (+ (progn (goto-char (match-end 1)) (current-column))
2082 (if (and org-list-two-spaces-after-bullet-regexp
2083 (org-string-match-p org-list-two-spaces-after-bullet-regexp
2090 ;;; Interactive functions
2092 (defalias 'org-list-get-item-begin
'org-in-item-p
)
2094 (defun org-beginning-of-item ()
2095 "Go to the beginning of the current item.
2096 Throw an error when not in a list."
2098 (let ((begin (org-in-item-p)))
2099 (if begin
(goto-char begin
) (error "Not in an item"))))
2101 (defun org-beginning-of-item-list ()
2102 "Go to the beginning item of the current list or sublist.
2103 Throw an error when not in a list."
2105 (let ((begin (org-in-item-p)))
2107 (error "Not in an item")
2109 (let* ((struct (org-list-struct))
2110 (prevs (org-list-prevs-alist struct
)))
2111 (goto-char (org-list-get-list-begin begin struct prevs
))))))
2113 (defun org-end-of-item-list ()
2114 "Go to the end of the current list or sublist.
2115 Throw an error when not in a list."
2117 (let ((begin (org-in-item-p)))
2119 (error "Not in an item")
2121 (let* ((struct (org-list-struct))
2122 (prevs (org-list-prevs-alist struct
)))
2123 (goto-char (org-list-get-list-end begin struct prevs
))))))
2125 (defun org-end-of-item ()
2126 "Go to the end of the current item.
2127 Throw an error when not in a list."
2129 (let ((begin (org-in-item-p)))
2131 (error "Not in an item")
2133 (let ((struct (org-list-struct)))
2134 (goto-char (org-list-get-item-end begin struct
))))))
2136 (defun org-previous-item ()
2137 "Move to the beginning of the previous item.
2138 Throw an error when not in a list. Also throw an error when at
2139 first item, unless `org-list-use-circular-motion' is non-nil."
2141 (let ((item (org-in-item-p)))
2143 (error "Not in an item")
2145 (let* ((struct (org-list-struct))
2146 (prevs (org-list-prevs-alist struct
))
2147 (prevp (org-list-get-prev-item item struct prevs
)))
2149 (prevp (goto-char prevp
))
2150 (org-list-use-circular-motion
2151 (goto-char (org-list-get-last-item item struct prevs
)))
2152 (t (error "On first item")))))))
2154 (defun org-next-item ()
2155 "Move to the beginning of the next item.
2156 Throw an error when not in a list. Also throw an error when at
2157 last item, unless `org-list-use-circular-motion' is non-nil."
2159 (let ((item (org-in-item-p)))
2161 (error "Not in an item")
2163 (let* ((struct (org-list-struct))
2164 (prevs (org-list-prevs-alist struct
))
2165 (prevp (org-list-get-next-item item struct prevs
)))
2167 (prevp (goto-char prevp
))
2168 (org-list-use-circular-motion
2169 (goto-char (org-list-get-first-item item struct prevs
)))
2170 (t (error "On last item")))))))
2172 (defun org-move-item-down ()
2173 "Move the item at point down, i.e. swap with following item.
2174 Sub-items (items with larger indentation) are considered part of
2175 the item, so this really moves item trees."
2177 (unless (org-at-item-p) (error "Not at an item"))
2178 (let* ((col (current-column))
2179 (item (point-at-bol))
2180 (struct (org-list-struct))
2181 (prevs (org-list-prevs-alist struct
))
2182 (next-item (org-list-get-next-item (point-at-bol) struct prevs
)))
2183 (unless (or next-item org-list-use-circular-motion
)
2184 (user-error "Cannot move this item further down"))
2186 (setq struct
(org-list-send-item item
'begin struct
))
2187 (setq struct
(org-list-swap-items item next-item struct
))
2189 (org-list-get-next-item item struct
(org-list-prevs-alist struct
))))
2190 (org-list-write-struct struct
(org-list-parents-alist struct
))
2191 (org-move-to-column col
)))
2193 (defun org-move-item-up ()
2194 "Move the item at point up, i.e. swap with previous item.
2195 Sub-items (items with larger indentation) are considered part of
2196 the item, so this really moves item trees."
2198 (unless (org-at-item-p) (error "Not at an item"))
2199 (let* ((col (current-column))
2200 (item (point-at-bol))
2201 (struct (org-list-struct))
2202 (prevs (org-list-prevs-alist struct
))
2203 (prev-item (org-list-get-prev-item (point-at-bol) struct prevs
)))
2204 (unless (or prev-item org-list-use-circular-motion
)
2205 (user-error "Cannot move this item further up"))
2207 (setq struct
(org-list-send-item item
'end struct
))
2208 (setq struct
(org-list-swap-items prev-item item struct
)))
2209 (org-list-write-struct struct
(org-list-parents-alist struct
))
2210 (org-move-to-column col
)))
2212 (defun org-insert-item (&optional checkbox
)
2213 "Insert a new item at the current level.
2214 If cursor is before first character after bullet of the item, the
2215 new item will be created before the current one.
2217 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2219 Return t when things worked, nil when we are not in an item, or
2221 (let ((itemp (org-in-item-p))
2223 ;; If cursor isn't is a list or if list is invisible, return nil.
2224 (unless (or (not itemp
)
2227 (outline-invisible-p)))
2230 (org-at-item-timer-p))
2231 ;; Timer list: delegate to `org-timer-item'.
2232 (progn (org-timer-item) t
)
2233 (let* ((struct (save-excursion (goto-char itemp
)
2235 (prevs (org-list-prevs-alist struct
))
2236 ;; If we're in a description list, ask for the new term.
2237 (desc (when (eq (org-list-get-list-type itemp struct prevs
)
2240 (setq struct
(org-list-insert-item pos struct prevs checkbox desc
))
2241 (org-list-write-struct struct
(org-list-parents-alist struct
))
2242 (when checkbox
(org-update-checkbox-count-maybe))
2243 (looking-at org-list-full-item-re
)
2244 (goto-char (if (and (match-beginning 4)
2246 (string-match "[.)]" (match-string 1))))
2249 (if desc
(backward-char 1))
2252 (defun org-list-repair ()
2253 "Fix indentation, bullets and checkboxes in the list at point."
2255 (unless (org-at-item-p) (error "This is not a list"))
2256 (let* ((struct (org-list-struct))
2257 (parents (org-list-parents-alist struct
)))
2258 (org-list-write-struct struct parents
)))
2260 (defun org-cycle-list-bullet (&optional which
)
2261 "Cycle through the different itemize/enumerate bullets.
2262 This cycle the entire list level through the sequence:
2264 `-' -> `+' -> `*' -> `1.' -> `1)'
2266 If WHICH is a valid string, use that as the new bullet. If WHICH
2267 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2268 `previous', cycle backwards."
2270 (unless (org-at-item-p) (error "Not at an item"))
2273 (let* ((struct (org-list-struct))
2274 (parents (org-list-parents-alist struct
))
2275 (prevs (org-list-prevs-alist struct
))
2276 (list-beg (org-list-get-first-item (point) struct prevs
))
2277 (bullet (org-list-get-bullet list-beg struct
))
2278 (alpha-p (org-list-use-alpha-bul-p list-beg struct prevs
))
2279 (case-fold-search nil
)
2281 ((string-match "[a-z]\\." bullet
) "a.")
2282 ((string-match "[a-z])" bullet
) "a)")
2283 ((string-match "[A-Z]\\." bullet
) "A.")
2284 ((string-match "[A-Z])" bullet
) "A)")
2285 ((string-match "\\." bullet
) "1.")
2286 ((string-match ")" bullet
) "1)")
2287 (t (org-trim bullet
))))
2288 ;; Compute list of possible bullets, depending on context.
2291 ;; *-bullets are not allowed at column 0.
2292 (unless (looking-at "\\S-") '("*"))
2293 ;; Description items cannot be numbered.
2294 (unless (or (eq org-plain-list-ordered-item-terminator ?\
))
2295 (org-at-item-description-p))
2297 (unless (or (eq org-plain-list-ordered-item-terminator ?.
)
2298 (org-at-item-description-p))
2300 (unless (or (not alpha-p
)
2301 (eq org-plain-list-ordered-item-terminator ?\
))
2302 (org-at-item-description-p))
2304 (unless (or (not alpha-p
)
2305 (eq org-plain-list-ordered-item-terminator ?.
)
2306 (org-at-item-description-p))
2308 (len (length bullet-list
))
2309 (item-index (- len
(length (member current bullet-list
))))
2310 (get-value (lambda (index) (nth (mod index len
) bullet-list
)))
2312 ((member which bullet-list
) which
)
2313 ((numberp which
) (funcall get-value which
))
2314 ((eq 'previous which
) (funcall get-value
(1- item-index
)))
2315 (t (funcall get-value
(1+ item-index
))))))
2316 ;; Use a short variation of `org-list-write-struct' as there's
2317 ;; no need to go through all the steps.
2318 (let ((old-struct (copy-tree struct
)))
2319 (org-list-set-bullet list-beg struct
(org-list-bullet-string new
))
2320 (org-list-struct-fix-bul struct prevs
)
2321 (org-list-struct-fix-ind struct parents
)
2322 (org-list-struct-apply-struct struct old-struct
)))))
2324 (defun org-toggle-checkbox (&optional toggle-presence
)
2325 "Toggle the checkbox in the current line.
2326 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2327 double prefix, set checkbox to [-].
2329 When there is an active region, toggle status or presence of the
2330 first checkbox there, and make every item inside have the same
2331 status or presence, respectively.
2333 If the cursor is in a headline, apply this to all checkbox items
2334 in the text below the heading, taking as reference the first item
2335 in subtree, ignoring drawers."
2342 (keyword-re (concat "^[ \t]*\\<\\(" org-scheduled-string
2343 "\\|" org-deadline-string
2344 "\\|" org-closed-string
2345 "\\|" org-clock-string
"\\)"
2346 " *[[<]\\([^]>]+\\)[]>]"))
2347 (orderedp (org-entry-get nil
"ORDERED"))
2349 ;; In a region, start at first item in region.
2351 ((org-region-active-p)
2352 (let ((limit (region-end)))
2353 (goto-char (region-beginning))
2354 (if (org-list-search-forward (org-item-beginning-re) limit t
)
2355 (setq lim-up
(point-at-bol))
2356 (error "No item in region"))
2357 (setq lim-down
(copy-marker limit
))))
2359 ;; On an heading, start at first item after drawers and
2360 ;; time-stamps (scheduled, etc.).
2361 (let ((limit (save-excursion (outline-next-heading) (point))))
2363 (while (or (looking-at org-drawer-regexp
)
2364 (looking-at keyword-re
))
2365 (if (looking-at keyword-re
)
2367 (re-search-forward "^[ \t]*:END:" limit nil
)))
2368 (if (org-list-search-forward (org-item-beginning-re) limit t
)
2369 (setq lim-up
(point-at-bol))
2370 (error "No item in subtree"))
2371 (setq lim-down
(copy-marker limit
))))
2372 ;; Just one item: set SINGLEP flag.
2375 (setq lim-up
(point-at-bol)
2376 lim-down
(copy-marker (point-at-eol))))
2377 (t (error "Not at an item or heading, and no active region"))))
2378 ;; Determine the checkbox going to be applied to all items
2383 (let ((cbox (and (org-at-item-checkbox-p) (match-string 1))))
2385 ((equal toggle-presence
'(16)) "[-]")
2386 ((equal toggle-presence
'(4))
2387 (unless cbox
"[ ]"))
2388 ((equal "[X]" cbox
) "[ ]")
2390 ;; When an item is found within bounds, grab the full list at
2391 ;; point structure, then: (1) set check-box of all its items
2392 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2393 ;; whole list, (3) move point after the list.
2395 (while (and (< (point) lim-down
)
2396 (org-list-search-forward (org-item-beginning-re)
2398 (let* ((struct (org-list-struct))
2399 (struct-copy (copy-tree struct
))
2400 (parents (org-list-parents-alist struct
))
2401 (prevs (org-list-prevs-alist struct
))
2402 (bottom (copy-marker (org-list-get-bottom-point struct
)))
2403 (items-to-toggle (org-remove-if
2404 (lambda (e) (or (< e lim-up
) (> e lim-down
)))
2405 (mapcar #'car struct
))))
2406 (mapc (lambda (e) (org-list-set-checkbox
2408 ;; If there is no box at item, leave as-is
2409 ;; unless function was called with C-u prefix.
2410 (let ((cur-box (org-list-get-checkbox e struct
)))
2411 (if (or cur-box
(equal toggle-presence
'(4)))
2415 (setq block-item
(org-list-struct-fix-box
2416 struct parents prevs orderedp
))
2417 ;; Report some problems due to ORDERED status of subtree.
2418 ;; If only one box was being checked, throw an error, else,
2419 ;; only signal problems.
2421 ((and singlep block-item
(> lim-up block-item
))
2423 "Checkbox blocked because of unchecked box at line %d"
2424 (org-current-line block-item
)))
2427 "Checkboxes were removed due to unchecked box at line %d"
2428 (org-current-line block-item
))))
2430 (move-marker bottom nil
)
2431 (org-list-struct-apply-struct struct struct-copy
)))
2432 (move-marker lim-down nil
)))
2433 (org-update-checkbox-count-maybe))
2435 (defun org-reset-checkbox-state-subtree ()
2436 "Reset all checkboxes in an entry subtree."
2438 (if (org-before-first-heading-p)
2439 (error "Not inside a tree")
2442 (org-narrow-to-subtree)
2444 (goto-char (point-min))
2445 (let ((end (point-max)))
2446 (while (< (point) end
)
2447 (when (org-at-item-checkbox-p)
2448 (replace-match "[ ]" t t nil
1))
2449 (beginning-of-line 2)))
2450 (org-update-checkbox-count-maybe 'all
)))))
2452 (defun org-update-checkbox-count (&optional all
)
2453 "Update the checkbox statistics in the current section.
2455 This will find all statistic cookies like [57%] and [6/12] and
2456 update them with the current numbers.
2458 With optional prefix argument ALL, do this for the whole buffer."
2460 (org-with-wide-buffer
2461 (let* ((cookie-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
2462 (box-re "^[ \t]*\\([-+*]\\|\\([0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]+\
2463 \\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2465 (or (not org-checkbox-hierarchical-statistics
)
2466 (string-match "\\<recursive\\>"
2467 (or (org-entry-get nil
"COOKIE_DATA") ""))))
2468 (within-inlinetask (and (not all
)
2469 (featurep 'org-inlinetask
)
2470 (org-inlinetask-in-task-p)))
2471 (end (cond (all (point-max))
2473 (save-excursion (outline-next-heading) (point)))
2475 (org-with-limited-levels (outline-next-heading))
2478 (lambda (item structs recursivep
)
2479 ;; Return number of checked boxes and boxes of all types
2480 ;; in all structures in STRUCTS. If RECURSIVEP is
2481 ;; non-nil, also count boxes in sub-lists. If ITEM is
2482 ;; nil, count across the whole structure, else count only
2483 ;; across subtree whose ancestor is ITEM.
2484 (let ((c-on 0) (c-all 0))
2485 (dolist (s structs
(list c-on c-all
))
2486 (let* ((pre (org-list-prevs-alist s
))
2487 (par (org-list-parents-alist s
))
2490 ((and recursivep item
) (org-list-get-subtree item s
))
2491 (recursivep (mapcar #'car s
))
2492 (item (org-list-get-children item s par
))
2493 (t (org-list-get-all-items
2494 (org-list-get-top-point s
) s pre
))))
2495 (cookies (delq nil
(mapcar
2497 (org-list-get-checkbox e s
))
2499 (incf c-all
(length cookies
))
2500 (incf c-on
(org-count "[X]" cookies
)))))))
2503 (cond (all (goto-char (point-min)))
2504 (within-inlinetask (org-back-to-heading t
))
2505 (t (org-with-limited-levels (outline-previous-heading))))
2506 ;; Build an alist for each cookie found. The key is the position
2507 ;; at beginning of cookie and values ending position, format of
2508 ;; cookie, number of checked boxes to report and total number of
2510 (while (re-search-forward cookie-re end t
)
2511 (let ((context (save-excursion (backward-char)
2512 (save-match-data (org-element-context)))))
2513 (when (eq (org-element-type context
) 'statistics-cookie
)
2516 (list (match-beginning 1) (match-end 1) (match-end 2))
2518 (org-element-lineage
2520 '(drawer center-block dynamic-block inlinetask item
2521 quote-block special-block verse-block
)))
2523 (org-element-property :contents-begin container
)
2525 (org-with-limited-levels
2526 (outline-previous-heading))
2528 (or (cdr (assq beg cache
))
2533 (org-element-property :contents-end container
)
2535 (org-with-limited-levels (outline-next-heading))
2538 (while (re-search-forward box-re end t
)
2539 (let ((element (org-element-at-point)))
2540 (when (eq (org-element-type element
) 'item
)
2541 (push (org-element-property :structure element
)
2543 ;; Skip whole list since we have its
2544 ;; structure anyway.
2545 (while (setq element
(org-element-lineage
2546 element
'(plain-list)))
2548 (min (org-element-property :end element
)
2550 ;; Cache count for cookies applying to the same
2551 ;; area. Then return it.
2553 (funcall count-boxes
2554 (and (eq (org-element-type container
)
2556 (org-element-property
2560 (push (cons beg count
) cache
)
2563 ;; Apply alist to buffer.
2564 (dolist (cookie cookies-list
)
2565 (let* ((beg (car cookie
))
2566 (end (nth 1 cookie
))
2567 (percent (nth 2 cookie
))
2568 (checked (nth 3 cookie
))
2569 (total (nth 4 cookie
)))
2572 (if percent
(format "[%d%%]" (floor (* 100.0 checked
)
2574 (format "[%d/%d]" checked total
)))
2575 (delete-region (point) (+ (point) (- end beg
)))
2576 (when org-auto-align-tags
(org-fix-tags-on-the-fly)))))))
2578 (defun org-get-checkbox-statistics-face ()
2579 "Select the face for checkbox statistics.
2580 The face will be `org-done' when all relevant boxes are checked.
2581 Otherwise it will be `org-todo'."
2583 (if (equal (match-string 1) "100%")
2584 'org-checkbox-statistics-done
2585 'org-checkbox-statistics-todo
)
2586 (if (and (> (match-end 2) (match-beginning 2))
2587 (equal (match-string 2) (match-string 3)))
2588 'org-checkbox-statistics-done
2589 'org-checkbox-statistics-todo
)))
2591 (defun org-update-checkbox-count-maybe (&optional all
)
2592 "Update checkbox statistics unless turned off by user.
2593 With an optional argument ALL, update them in the whole buffer."
2594 (when (cdr (assq 'checkbox org-list-automatic-rules
))
2595 (org-update-checkbox-count all
))
2596 (run-hooks 'org-checkbox-statistics-hook
))
2598 (defvar org-last-indent-begin-marker
(make-marker))
2599 (defvar org-last-indent-end-marker
(make-marker))
2600 (defun org-list-indent-item-generic (arg no-subtree struct
)
2601 "Indent a local list item including its children.
2602 When number ARG is a negative, item will be outdented, otherwise
2603 it will be indented.
2605 If a region is active, all items inside will be moved.
2607 If NO-SUBTREE is non-nil, only indent the item itself, not its
2610 STRUCT is the list structure.
2612 Return t if successful."
2614 (let* ((regionp (org-region-active-p))
2615 (rbeg (and regionp
(region-beginning)))
2616 (rend (and regionp
(region-end)))
2617 (top (org-list-get-top-point struct
))
2618 (parents (org-list-parents-alist struct
))
2619 (prevs (org-list-prevs-alist struct
))
2620 ;; Are we going to move the whole list?
2623 (= top
(point-at-bol))
2624 (cdr (assq 'indent org-list-automatic-rules
))
2627 "First item of list cannot move without its subtree")
2629 ;; Determine begin and end points of zone to indent. If moving
2630 ;; more than one item, save them for subsequent moves.
2631 (unless (and (memq last-command
'(org-shiftmetaright org-shiftmetaleft
))
2632 (memq this-command
'(org-shiftmetaright org-shiftmetaleft
)))
2635 (set-marker org-last-indent-begin-marker rbeg
)
2636 (set-marker org-last-indent-end-marker rend
))
2637 (set-marker org-last-indent-begin-marker
(point-at-bol))
2638 (set-marker org-last-indent-end-marker
2640 (specialp (org-list-get-bottom-point struct
))
2641 (no-subtree (1+ (point-at-bol)))
2642 (t (org-list-get-item-end (point-at-bol) struct
))))))
2643 (let* ((beg (marker-position org-last-indent-begin-marker
))
2644 (end (marker-position org-last-indent-end-marker
)))
2646 ;; Special case: moving top-item with indent rule.
2648 (let* ((level-skip (org-level-increment))
2649 (offset (if (< arg
0) (- level-skip
) level-skip
))
2650 (top-ind (org-list-get-ind beg struct
))
2651 (old-struct (copy-tree struct
)))
2652 (if (< (+ top-ind offset
) 0)
2653 (error "Cannot outdent beyond margin")
2654 ;; Change bullet if necessary.
2655 (when (and (= (+ top-ind offset
) 0)
2657 (org-list-get-bullet beg struct
)))
2658 (org-list-set-bullet beg struct
2659 (org-list-bullet-string "-")))
2660 ;; Shift every item by OFFSET and fix bullets. Then
2661 ;; apply changes to buffer.
2663 (let ((ind (org-list-get-ind (car e
) struct
)))
2664 (org-list-set-ind (car e
) struct
(+ ind offset
))))
2666 (org-list-struct-fix-bul struct prevs
)
2667 (org-list-struct-apply-struct struct old-struct
))))
2670 ;; If only one item is moved, it mustn't have a child.
2673 (org-list-has-child-p beg struct
))
2674 ;; If a subtree or region is moved, the last item
2675 ;; of the subtree mustn't have a child.
2676 (let ((last-item (caar
2679 (lambda (e) (>= (car e
) end
))
2681 (org-list-has-child-p last-item struct
))))
2682 (error "Cannot outdent an item without its children"))
2687 (org-list-struct-outdent beg end struct parents
)
2688 (org-list-struct-indent beg end struct parents prevs
))))
2689 (org-list-write-struct struct new-parents
))
2690 (org-update-checkbox-count-maybe))))))
2693 (defun org-outdent-item ()
2694 "Outdent a local list item, but not its children.
2695 If a region is active, all items inside will be moved."
2697 (let ((regionp (org-region-active-p)))
2699 ((or (org-at-item-p)
2701 (save-excursion (goto-char (region-beginning))
2703 (let ((struct (if (not regionp
) (org-list-struct)
2704 (save-excursion (goto-char (region-beginning))
2705 (org-list-struct)))))
2706 (org-list-indent-item-generic -
1 t struct
)))
2707 (regionp (error "Region not starting at an item"))
2708 (t (error "Not at an item")))))
2710 (defun org-indent-item ()
2711 "Indent a local list item, but not its children.
2712 If a region is active, all items inside will be moved."
2714 (let ((regionp (org-region-active-p)))
2716 ((or (org-at-item-p)
2718 (save-excursion (goto-char (region-beginning))
2720 (let ((struct (if (not regionp
) (org-list-struct)
2721 (save-excursion (goto-char (region-beginning))
2722 (org-list-struct)))))
2723 (org-list-indent-item-generic 1 t struct
)))
2724 (regionp (error "Region not starting at an item"))
2725 (t (error "Not at an item")))))
2727 (defun org-outdent-item-tree ()
2728 "Outdent a local list item including its children.
2729 If a region is active, all items inside will be moved."
2731 (let ((regionp (org-region-active-p)))
2733 ((or (org-at-item-p)
2735 (save-excursion (goto-char (region-beginning))
2737 (let ((struct (if (not regionp
) (org-list-struct)
2738 (save-excursion (goto-char (region-beginning))
2739 (org-list-struct)))))
2740 (org-list-indent-item-generic -
1 nil struct
)))
2741 (regionp (error "Region not starting at an item"))
2742 (t (error "Not at an item")))))
2744 (defun org-indent-item-tree ()
2745 "Indent a local list item including its children.
2746 If a region is active, all items inside will be moved."
2748 (let ((regionp (org-region-active-p)))
2750 ((or (org-at-item-p)
2752 (save-excursion (goto-char (region-beginning))
2754 (let ((struct (if (not regionp
) (org-list-struct)
2755 (save-excursion (goto-char (region-beginning))
2756 (org-list-struct)))))
2757 (org-list-indent-item-generic 1 nil struct
)))
2758 (regionp (error "Region not starting at an item"))
2759 (t (error "Not at an item")))))
2761 (defvar org-tab-ind-state
)
2762 (defvar org-adapt-indentation
)
2763 (defun org-cycle-item-indentation ()
2764 "Cycle levels of indentation of an empty item.
2765 The first run indents the item, if applicable. Subsequent runs
2766 outdent it at meaningful levels in the list. When done, item is
2767 put back at its original position with its original bullet.
2769 Return t at each successful move."
2770 (when (org-at-item-p)
2771 (let* ((org-adapt-indentation nil
)
2772 (struct (org-list-struct))
2773 (ind (org-list-get-ind (point-at-bol) struct
))
2774 (bullet (org-trim (buffer-substring (point-at-bol) (point-at-eol)))))
2775 ;; Accept empty items or if cycle has already started.
2776 (when (or (eq last-command
'org-cycle-item-indentation
)
2777 (and (save-excursion
2779 (looking-at org-list-full-item-re
))
2780 (>= (match-end 0) (save-excursion
2781 (goto-char (org-list-get-item-end
2782 (point-at-bol) struct
))
2783 (skip-chars-backward " \r\t\n")
2785 (setq this-command
'org-cycle-item-indentation
)
2786 ;; When in the middle of the cycle, try to outdent first. If
2787 ;; it fails, and point is still at initial position, indent.
2788 ;; Else, re-create it at its original position.
2789 (if (eq last-command
'org-cycle-item-indentation
)
2791 ((ignore-errors (org-list-indent-item-generic -
1 t struct
)))
2792 ((and (= ind
(car org-tab-ind-state
))
2793 (ignore-errors (org-list-indent-item-generic 1 t struct
))))
2794 (t (delete-region (point-at-bol) (point-at-eol))
2795 (org-indent-to-column (car org-tab-ind-state
))
2796 (insert (cdr org-tab-ind-state
) " ")
2798 (setq this-command
'identity
)))
2799 ;; If a cycle is starting, remember indentation and bullet,
2800 ;; then try to indent. If it fails, try to outdent.
2801 (setq org-tab-ind-state
(cons ind bullet
))
2803 ((ignore-errors (org-list-indent-item-generic 1 t struct
)))
2804 ((ignore-errors (org-list-indent-item-generic -
1 t struct
)))
2805 (t (user-error "Cannot move item"))))
2808 (defun org-sort-list (&optional with-case sorting-type getkey-func compare-func
)
2810 The cursor may be at any item of the list that should be sorted.
2811 Sublists are not sorted. Checkboxes, if any, are ignored.
2813 Sorting can be alphabetically, numerically, by date/time as given
2814 by a time stamp, by a property or by priority.
2816 Comparing entries ignores case by default. However, with an
2817 optional argument WITH-CASE, the sorting considers case as well.
2819 The command prompts for the sorting type unless it has been given
2820 to the function through the SORTING-TYPE argument, which needs to
2821 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F ?x ?X). Here is the
2822 detailed meaning of each character:
2824 n Numerically, by converting the beginning of the item to a number.
2825 a Alphabetically. Only the first line of item is checked.
2826 t By date/time, either the first active time stamp in the entry, if
2827 any, or by the first inactive one. In a timer list, sort the timers.
2828 x By \"checked\" status of a check list.
2830 Capital letters will reverse the sort order.
2832 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2833 a function to be called with point at the beginning of the
2834 record. It must return either a string or a number that should
2835 serve as the sorting key for that record. It will then use
2836 COMPARE-FUNC to compare entries.
2838 Sorting is done against the visible part of the headlines, it
2839 ignores hidden links."
2841 (let* ((case-func (if with-case
'identity
'downcase
))
2842 (struct (org-list-struct))
2843 (prevs (org-list-prevs-alist struct
))
2844 (start (org-list-get-list-begin (point-at-bol) struct prevs
))
2845 (end (org-list-get-list-end (point-at-bol) struct prevs
))
2850 "Sort plain list: [a]lpha [n]umeric [t]ime [f]unc [x]checked A/N/T/F/X means reversed:")
2851 (read-char-exclusive))))
2854 (and (= (downcase sorting-type
) ?f
)
2855 (intern (org-icompleting-read "Sort using function: "
2856 obarray
'fboundp t nil nil
))))))
2857 (message "Sorting items...")
2859 (narrow-to-region start end
)
2860 (goto-char (point-min))
2861 (let* ((dcst (downcase sorting-type
))
2862 (case-fold-search nil
)
2863 (now (current-time))
2865 ((= dcst ?a
) 'string
<)
2866 ((= dcst ?f
) compare-func
)
2868 ((= dcst ?x
) 'string
<)))
2869 (next-record (lambda ()
2870 (skip-chars-forward " \r\t\n")
2871 (or (eobp) (beginning-of-line))))
2872 (end-record (lambda ()
2873 (goto-char (org-list-get-item-end-before-blank
2877 (when (looking-at "[ \t]*[-+*0-9.)]+\\([ \t]+\\[[- X]\\]\\)?[ \t]+")
2881 (org-sort-remove-invisible
2882 (buffer-substring (match-end 0) (point-at-eol)))))
2885 (org-sort-remove-invisible
2887 (match-end 0) (point-at-eol)))))
2890 ;; If it is a timer list, convert timer to seconds
2891 ((org-at-item-timer-p)
2892 (org-timer-hms-to-secs (match-string 1)))
2893 ((or (save-excursion
2894 (re-search-forward org-ts-regexp
(point-at-eol) t
))
2895 (save-excursion (re-search-forward org-ts-regexp-both
2897 (org-time-string-to-seconds (match-string 0)))
2898 (t (org-float-time now
))))
2899 ((= dcst ?x
) (or (and (stringp (match-string 1))
2904 (let ((value (funcall getkey-func
)))
2906 (funcall case-func value
)
2908 (error "Invalid key function `%s'" getkey-func
)))
2909 (t (error "Invalid sorting type `%c'" sorting-type
)))))))
2910 (sort-subr (/= dcst sorting-type
)
2916 ;; Read and fix list again, as `sort-subr' probably destroyed
2919 (run-hooks 'org-after-sorting-entries-or-items-hook
)
2920 (message "Sorting items...done")))))
2924 ;;; Send and receive lists
2926 (defun org-list-parse-list (&optional delete
)
2927 "Parse the list at point and maybe DELETE it.
2929 Return a list whose car is a symbol of list type, among
2930 `ordered', `unordered' and `descriptive'. Then, each item is
2931 a list whose car is counter, and cdr are strings and other
2932 sub-lists. Inside strings, check-boxes are replaced by
2933 \"[CBON]\", \"[CBOFF]\" and \"[CBTRANS]\".
2935 For example, the following list:
2940 more text in first item
2948 (nil \"sub-item one\")
2949 (nil \"[CBON] sub-item two\"))
2950 \"more text in first item\")
2953 Point is left at list end."
2954 (defvar parse-item
) ;FIXME: Or use `cl-labels' or `letrec'.
2955 (let* ((struct (org-list-struct))
2956 (prevs (org-list-prevs-alist struct
))
2957 (parents (org-list-parents-alist struct
))
2958 (top (org-list-get-top-point struct
))
2959 (bottom (org-list-get-bottom-point struct
))
2963 ;; Return text between BEG and END, trimmed, with
2964 ;; checkboxes replaced.
2966 (let ((text (org-trim (buffer-substring beg end
))))
2967 (if (string-match "\\`\\[\\([-X ]\\)\\]" text
)
2969 (let ((box (match-string 1 text
)))
2971 ((equal box
" ") "CBOFF")
2972 ((equal box
"-") "CBTRANS")
2978 ;; Return a list whose car is list type and cdr a list of
2981 (cons (org-list-get-list-type (car e
) struct prevs
)
2982 (mapcar parse-item e
)))))
2985 ;; Return a list containing counter of item, if any, text
2986 ;; and any sublist inside it.
2988 (let ((start (save-excursion
2990 (looking-at "[ \t]*\\S-+\\([ \t]+\\[@\\(start:\\)?\\([0-9]+\\|[a-zA-Z]\\)\\]\\)?[ \t]*")
2992 ;; Get counter number. For alphabetic counter, get
2993 ;; its position in the alphabet.
2994 (counter (let ((c (org-list-get-counter e struct
)))
2997 ((string-match "[A-Za-z]" c
)
2998 (- (string-to-char (upcase (match-string 0 c
)))
3000 ((string-match "[0-9]+" c
)
3001 (string-to-number (match-string 0 c
))))))
3002 (childp (org-list-has-child-p e struct
))
3003 (end (org-list-get-item-end e struct
)))
3004 ;; If item has a child, store text between bullet and
3005 ;; next child, then recursively parse all sublists. At
3006 ;; the end of each sublist, check for the presence of
3007 ;; text belonging to the original item.
3009 (let* ((children (org-list-get-children e struct parents
))
3010 (body (list (funcall get-text start childp
))))
3012 (let* ((first (car children
))
3013 (sub (org-list-get-all-items first struct prevs
))
3014 (last-c (car (last sub
)))
3015 (last-end (org-list-get-item-end last-c struct
)))
3016 (push (funcall parse-sublist sub
) body
)
3017 ;; Remove children from the list just parsed.
3018 (setq children
(cdr (member last-c children
)))
3019 ;; There is a chunk of text belonging to the
3020 ;; item if last child doesn't end where next
3021 ;; child starts or where item ends.
3022 (unless (= (or (car children
) end
) last-end
)
3023 (push (funcall get-text
3024 last-end
(or (car children
) end
))
3026 (cons counter
(nreverse body
)))
3027 (list counter
(funcall get-text start end
))))))))
3028 ;; Store output, take care of cursor position and deletion of
3029 ;; list, then return output.
3030 (setq out
(funcall parse-sublist
(org-list-get-all-items top struct prevs
)))
3033 (delete-region top bottom
)
3034 (when (and (not (looking-at "[ \t]*$")) (looking-at org-list-end-re
))
3035 (replace-match "")))
3038 (defun org-list-make-subtree ()
3039 "Convert the plain list at point into a subtree."
3041 (if (not (ignore-errors (goto-char (org-in-item-p))))
3042 (error "Not in a list")
3043 (let ((list (save-excursion (org-list-parse-list t
))))
3044 (insert (org-list-to-subtree list
)))))
3046 (defun org-list-insert-radio-list ()
3047 "Insert a radio list template appropriate for this major mode."
3049 (let* ((e (assq major-mode org-list-radio-list-templates
))
3052 (unless e
(error "No radio list setup defined for %s" major-mode
))
3053 (setq name
(read-string "List name: "))
3054 (while (string-match "%n" txt
)
3055 (setq txt
(replace-match name t t txt
)))
3056 (or (bolp) (insert "\n"))
3061 (defun org-list-send-list (&optional maybe
)
3062 "Send a transformed version of this list to the receiver position.
3063 With argument MAYBE, fail quietly if no transformation is defined
3067 (unless (org-at-item-p) (error "Not at a list item"))
3069 (re-search-backward "#\\+ORGLST" nil t
)
3070 (unless (looking-at "\\(?:[ \t]\\)?#\\+ORGLST:[ \t]+SEND[ \t]+\\(\\S-+\\)[ \t]+\\(\\S-+\\)")
3071 (if maybe
(throw 'exit nil
)
3072 (error "Don't know how to transform this list"))))
3073 (let* ((name (match-string 1))
3074 (transform (intern (match-string 2)))
3078 "\\(\\\\end{comment}\\|@end ignore\\|-->\\)" nil t
)
3079 (match-beginning 0)))
3082 (re-search-backward "#\\+ORGLST" nil t
)
3083 (re-search-forward (org-item-beginning-re) bottom-point t
)
3084 (match-beginning 0)))
3085 (plain-list (buffer-substring-no-properties top-point bottom-point
))
3087 (unless (fboundp transform
)
3088 (error "No such transformation function %s" transform
))
3089 (let ((txt (funcall transform plain-list
)))
3090 ;; Find the insertion place
3092 (goto-char (point-min))
3093 (unless (re-search-forward
3094 (concat "BEGIN RECEIVE ORGLST +"
3098 (error "Don't know where to insert translated list"))
3099 (goto-char (match-beginning 0))
3100 (beginning-of-line 2)
3102 (unless (re-search-forward (concat "END RECEIVE ORGLST +" name
) nil t
)
3103 (error "Cannot find end of insertion region"))
3104 (delete-region beg
(point-at-bol))
3107 (message "List converted and installed at receiver location"))))
3109 (defsubst org-list-item-trim-br
(item)
3110 "Trim line breaks in a list ITEM."
3111 (setq item
(replace-regexp-in-string "\n +" " " item
)))
3113 (defun org-list-to-generic (list params
)
3114 "Convert a LIST parsed through `org-list-parse-list' to other formats.
3115 Valid parameters PARAMS are:
3117 :ustart String to start an unordered list
3118 :uend String to end an unordered list
3120 :ostart String to start an ordered list
3121 :oend String to end an ordered list
3123 :dstart String to start a descriptive list
3124 :dend String to end a descriptive list
3125 :dtstart String to start a descriptive term
3126 :dtend String to end a descriptive term
3127 :ddstart String to start a description
3128 :ddend String to end a description
3130 :splice When set to t, return only list body lines, don't wrap
3131 them into :[u/o]start and :[u/o]end. Default is nil.
3133 :istart String to start a list item.
3134 :icount String to start an item with a counter.
3135 :iend String to end a list item
3136 :isep String to separate items
3137 :lsep String to separate sublists
3138 :csep String to separate text from a sub-list
3140 :cboff String to insert for an unchecked check-box
3141 :cbon String to insert for a checked check-box
3142 :cbtrans String to insert for a check-box in transitional state
3144 :nobr Non-nil means remove line breaks in lists items.
3146 Alternatively, each parameter can also be a form returning
3147 a string. These sexp can use keywords `counter' and `depth',
3148 representing respectively counter associated to the current
3149 item, and depth of the current sub-list, starting at 0.
3150 Obviously, `counter' is only available for parameters applying to
3154 (splicep (plist-get p
:splice
))
3155 (ostart (plist-get p
:ostart
))
3156 (oend (plist-get p
:oend
))
3157 (ustart (plist-get p
:ustart
))
3158 (uend (plist-get p
:uend
))
3159 (dstart (plist-get p
:dstart
))
3160 (dend (plist-get p
:dend
))
3161 (dtstart (plist-get p
:dtstart
))
3162 (dtend (plist-get p
:dtend
))
3163 (ddstart (plist-get p
:ddstart
))
3164 (ddend (plist-get p
:ddend
))
3165 (istart (plist-get p
:istart
))
3166 (icount (plist-get p
:icount
))
3167 (iend (plist-get p
:iend
))
3168 (isep (plist-get p
:isep
))
3169 (lsep (plist-get p
:lsep
))
3170 (csep (plist-get p
:csep
))
3171 (cbon (plist-get p
:cbon
))
3172 (cboff (plist-get p
:cboff
))
3173 (cbtrans (plist-get p
:cbtrans
))
3174 (nobr (plist-get p
:nobr
))
3175 export-sublist
; for byte-compiler
3178 ;; Export an item ITEM of type TYPE, at DEPTH. First
3179 ;; string in item is treated in a special way as it can
3180 ;; bring extra information that needs to be processed.
3181 (lambda (item type depth
)
3182 (let* ((counter (pop item
))
3185 ((eq type
'descriptive
)
3186 ;; Stick DTSTART to ISTART by
3187 ;; left-trimming the latter.
3188 (concat (let ((s (eval istart
)))
3189 (or (and (string-match "[ \t\n\r]+\\'" s
)
3190 (replace-match "" t t s
))
3193 ((and counter
(eq type
'ordered
))
3194 (concat (eval icount
) "%s"))
3195 (t (concat (eval istart
) "%s")))
3198 ;; Replace checkbox if any is found.
3200 ((string-match "\\[CBON\\]" first
)
3201 (setq first
(replace-match cbon t t first
)))
3202 ((string-match "\\[CBOFF\\]" first
)
3203 (setq first
(replace-match cboff t t first
)))
3204 ((string-match "\\[CBTRANS\\]" first
)
3205 (setq first
(replace-match cbtrans t t first
))))
3206 ;; Replace line breaks if required
3207 (when nobr
(setq first
(org-list-item-trim-br first
)))
3208 ;; Insert descriptive term if TYPE is `descriptive'.
3209 (when (eq type
'descriptive
)
3211 (string-match "^\\(.*\\)[ \t]+::[ \t]*" first
))
3214 (org-trim (match-string 1 first
)))
3216 (desc (if complete
(substring first
(match-end 0))
3218 (setq first
(concat (eval dtstart
) term
(eval dtend
)
3219 (eval ddstart
) desc
))))
3222 (mapconcat (lambda (e)
3224 (funcall export-sublist e
(1+ depth
))))
3225 item
(or (eval csep
) "")))))))
3228 ;; Export sublist SUB at DEPTH.
3230 (let* ((type (car sub
))
3235 (concat (eval ostart
) "%s" (eval oend
)))
3236 ((eq type
'descriptive
)
3237 (concat (eval dstart
) "%s" (eval dend
)))
3238 (t (concat (eval ustart
) "%s" (eval uend
))))
3240 (format fmt
(mapconcat (lambda (e)
3241 (funcall export-item e type depth
))
3242 items
(or (eval isep
) ""))))))))
3243 (concat (funcall export-sublist list
0) "\n")))
3245 (defun org-list-to-latex (list &optional _params
)
3246 "Convert LIST into a LaTeX list.
3247 LIST is as string representing the list to transform, as Org
3248 syntax. Return converted list as a string."
3250 (org-export-string-as list
'latex t
))
3252 (defun org-list-to-html (list)
3253 "Convert LIST into a HTML list.
3254 LIST is as string representing the list to transform, as Org
3255 syntax. Return converted list as a string."
3257 (org-export-string-as list
'html t
))
3259 (defun org-list-to-texinfo (list &optional _params
)
3260 "Convert LIST into a Texinfo list.
3261 LIST is as string representing the list to transform, as Org
3262 syntax. Return converted list as a string."
3263 (require 'ox-texinfo
)
3264 (org-export-string-as list
'texinfo t
))
3266 (defun org-list-to-subtree (list &optional params
)
3267 "Convert LIST into an Org subtree.
3268 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3269 with overruling parameters for `org-list-to-generic'."
3270 (defvar get-stars
) (defvar org--blankp
)
3271 (let* ((rule (cdr (assq 'heading org-blank-before-new-entry
)))
3272 (level (org-reduced-level (or (org-current-level) 0)))
3273 (org--blankp (or (eq rule t
)
3274 (and (eq rule
'auto
)
3276 (outline-previous-heading)
3277 (org-previous-line-empty-p)))))
3278 (get-stars ;FIXME: Can't rename without renaming it in org.el as well!
3280 ;; Return the string for the heading, depending on depth D
3281 ;; of current sub-list.
3283 (let ((oddeven-level (+ level d
1)))
3284 (concat (make-string (if org-odd-levels-only
3285 (1- (* 2 oddeven-level
))
3289 (org-list-to-generic
3293 :dtstart
" " :dtend
" "
3294 :istart
(funcall get-stars depth
)
3295 :icount
(funcall get-stars depth
)
3296 :isep
(if org--blankp
"\n\n" "\n")
3297 :csep
(if org--blankp
"\n\n" "\n")
3298 :cbon
"DONE" :cboff
"TODO" :cbtrans
"TODO")
3303 ;;; org-list.el ends here