1 ;;; org-list.el --- Plain lists for Org-mode
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 ;; Free Software Foundation, Inc.
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Bastien Guerry <bzg AT altern DOT org>
8 ;; Keywords: outlines, hypermedia, calendar, wp
9 ;; Homepage: http://orgmode.org
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
30 ;; This file contains the code dealing with plain lists in Org-mode.
32 ;; The fundamental idea behind lists work is to use structures. A
33 ;; structure is a snapshot of the list, in the shape of data tree (see
34 ;; `org-list-struct').
36 ;; Once the list structure is stored, it is possible to make changes
37 ;; directly on it or get useful information about the list, with the
38 ;; two helper functions, namely `org-list-parents-alist' and
39 ;; `org-list-prevs-alist', and using accessors or methods.
41 ;; Structure is eventually applied to the buffer with
42 ;; `org-list-write-struct'. This function repairs (bullets,
43 ;; indentation, checkboxes) the structure before applying it. It
44 ;; should be called near the end of any function working on
47 ;; Thus, a function applying to lists should usually follow this
50 ;; 1. Verify point is in a list and grab item beginning (with the same
51 ;; function `org-in-item-p'). If the function requires the cursor
52 ;; to be at item's bullet, `org-at-item-p' is more selective. If
53 ;; the cursor is amidst the buffer, it is possible to find the
54 ;; closest item with `org-list-search-backward', or
55 ;; `org-list-search-forward', applied to `org-item-beginning-re'.
57 ;; 2. Get list structure with `org-list-struct'.
59 ;; 3. Compute one, or both, helper functions,
60 ;; (`org-list-parents-alist', `org-list-prevs-alist') depending on
63 ;; 4. Proceed with the modifications, using methods and accessors.
65 ;; 5. Verify and apply structure to buffer, using
66 ;; `org-list-write-struct'. Possibly use
67 ;; `org-update-checkbox-count-maybe' if checkboxes might have been
70 ;; Computing a list structure can be a costly operation on huge lists
71 ;; (a few thousand lines long). Thus, code should follow the rule :
72 ;; "collect once, use many". As a corollary, it is usally a bad idea
73 ;; to use directly an interactive function inside the code, as those,
74 ;; being independant 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
)
92 (defvar org-odd-levels-only
)
93 (defvar org-scheduled-string
)
94 (defvar org-ts-regexp
)
95 (defvar org-ts-regexp-both
)
97 (declare-function org-at-heading-p
"org" (&optional ignored
))
98 (declare-function org-back-over-empty-lines
"org" ())
99 (declare-function org-back-to-heading
"org" (&optional invisible-ok
))
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-entry-get
"org"
104 (pom property
&optional inherit literal-nil
))
105 (declare-function org-fix-tags-on-the-fly
"org" ())
106 (declare-function org-get-indentation
"org" (&optional line
))
107 (declare-function org-icompleting-read
"org" (&rest args
))
108 (declare-function org-in-regexp
"org" (re &optional nlines visually
))
109 (declare-function org-in-regexps-block-p
"org"
110 (start-re end-re
&optional bound
))
111 (declare-function org-inlinetask-goto-beginning
"org-inlinetask" ())
112 (declare-function org-inlinetask-goto-end
"org-inlinetask" ())
113 (declare-function org-inlinetask-in-task-p
"org-inlinetask" ())
114 (declare-function org-inlinetask-outline-regexp
"org-inlinetask" ())
115 (declare-function org-level-increment
"org" ())
116 (declare-function org-narrow-to-subtree
"org" ())
117 (declare-function org-on-heading-p
"org" (&optional invisible-ok
))
118 (declare-function org-previous-line-empty-p
"org" ())
119 (declare-function org-remove-if
"org" (predicate seq
))
120 (declare-function org-reduced-level
"org" (L))
121 (declare-function org-show-subtree
"org" ())
122 (declare-function org-time-string-to-seconds
"org" (s))
123 (declare-function org-timer-hms-to-secs
"org-timer" (hms))
124 (declare-function org-timer-item
"org-timer" (&optional arg
))
125 (declare-function org-trim
"org" (s))
126 (declare-function org-uniquify
"org" (list))
127 (declare-function outline-invisible-p
"outline" (&optional pos
))
128 (declare-function outline-flag-region
"outline" (from to flag
))
129 (declare-function outline-next-heading
"outline" ())
130 (declare-function outline-previous-heading
"outline" ())
132 ;;; Configuration variables
134 (defgroup org-plain-lists nil
135 "Options concerning plain lists in Org-mode."
136 :tag
"Org Plain lists"
137 :group
'org-structure
)
139 (defcustom org-cycle-include-plain-lists t
140 "When t, make TAB cycle visibility on plain list items.
141 Cycling plain lists works only when the cursor is on a plain list
142 item. When the cursor is on an outline heading, plain lists are
143 treated as text. This is the most stable way of handling this,
144 which is why it is the default.
146 When this is the symbol `integrate', then during cycling, plain
147 list items will *temporarily* be interpreted as outline headlines
148 with a level given by 1000+i where i is the indentation of the
149 bullet. This setting can lead to strange effects when switching
150 visibility to `children', because the first \"child\" in a
151 subtree decides what children should be listed. If that first
152 \"child\" is a plain list item with an implied large level
153 number, all true children and grand children of the outline
154 heading will be exposed in a children' view."
155 :group
'org-plain-lists
157 (const :tag
"Never" nil
)
158 (const :tag
"With cursor in plain list (recommended)" t
)
159 (const :tag
"As children of outline headings" integrate
)))
161 (defcustom org-list-demote-modify-bullet nil
162 "Default bullet type installed when demoting an item.
163 This is an association list, for each bullet type, this alist will point
164 to the bullet that should be used when this item is demoted.
167 (setq org-list-demote-modify-bullet
168 '((\"+\" . \"-\") (\"-\" . \"+\") (\"*\" . \"+\")))
173 + Silence of the Lambs
176 + The Hunt for Red October
182 - Silence of the Lambs
185 - The Hunt for Red October
187 :group
'org-plain-lists
190 (choice :tag
"If the current bullet is "
196 (choice :tag
"demotion will change it to"
203 (defcustom org-plain-list-ordered-item-terminator t
204 "The character that makes a line with leading number an ordered list item.
205 Valid values are ?. and ?\). To get both terminators, use t. While
206 ?. may look nicer, it creates the danger that a line with leading
207 number may be incorrectly interpreted as an item. ?\) therefore is
209 :group
'org-plain-lists
210 :type
'(choice (const :tag
"dot like in \"2.\"" ?.
)
211 (const :tag
"paren like in \"2)\"" ?\
))
212 (const :tab
"both" t
)))
214 (defcustom org-alphabetical-lists nil
215 "Non-nil means single character alphabetical bullets are allowed.
216 Both uppercase and lowercase are handled. Lists with more than 26
217 items will fallback to standard numbering. Alphabetical counters
218 like \"[@c]\" will be recognized."
219 :group
'org-plain-lists
222 (defcustom org-list-two-spaces-after-bullet-regexp nil
223 "A regular expression matching bullets that should have 2 spaces after them.
224 When nil, no bullet will have two spaces after them.
225 When a string, it will be used as a regular expression. When the
226 bullet type of a list is changed, the new bullet type will be
227 matched against this regexp. If it matches, there will be two
228 spaces instead of one after the bullet in each item of the list."
229 :group
'org-plain-lists
231 (const :tag
"never" nil
)
234 (defcustom org-list-ending-method
'both
235 "Determine where plain lists should end.
236 Valid values are: `regexp', `indent' or `both'.
238 When set to `regexp', Org will look into two variables,
239 `org-empty-line-terminates-plain-lists' and the more general
240 `org-list-end-regexp', to determine what will end lists.
242 When set to `indent', a list will end whenever a line following
243 an item, but not starting one, is less or equally indented than
244 the first item of the list.
246 When set to `both', each of the preceding methods is applied to
247 determine lists endings. This is the default method."
248 :group
'org-plain-lists
250 (const :tag
"With a regexp defining ending" regexp
)
251 (const :tag
"With indentation of regular (no bullet) text" indent
)
252 (const :tag
"With both methods" both
)))
254 (defcustom org-empty-line-terminates-plain-lists nil
255 "Non-nil means an empty line ends all plain list levels.
256 This variable only makes sense if `org-list-ending-method' is set
257 to `regexp' or `both'. This is then equivalent to set
258 `org-list-end-regexp' to \"^[ \\t]*$\"."
259 :group
'org-plain-lists
262 (defcustom org-list-end-regexp
"^[ \t]*\n[ \t]*\n"
263 "Regexp matching the end of all plain list levels.
264 It must start with \"^\" and end with \"\\n\". It defaults to 2
265 blank lines. `org-empty-line-terminates-plain-lists' has
267 :group
'org-plain-lists
270 (defcustom org-list-automatic-rules
'((bullet . t
)
273 "Non-nil means apply set of rules when acting on lists.
274 By default, automatic actions are taken when using
275 \\[org-meta-return], \\[org-metaright], \\[org-metaleft],
276 \\[org-shiftmetaright], \\[org-shiftmetaleft],
277 \\[org-ctrl-c-minus], \\[org-toggle-checkbox] or
278 \\[org-insert-todo-heading]. You can disable individually these
279 rules by setting them to nil. Valid rules are:
281 bullet when non-nil, cycling bullet do not allow lists at
282 column 0 to have * as a bullet and descriptions lists
284 checkbox when non-nil, checkbox statistics is updated each time
285 you either insert a new checkbox or toggle a checkbox.
286 It also prevents from inserting a checkbox in a
288 indent when non-nil, indenting or outdenting list top-item
289 with its subtree will move the whole list and
290 outdenting a list whose bullet is * to column 0 will
291 change that bullet to \"-\"."
292 :group
'org-plain-lists
293 :type
'(alist :tag
"Sets of rules"
296 (const :tag
"Bullet" bullet
)
297 (const :tag
"Checkbox" checkbox
)
298 (const :tag
"Indent" indent
))
300 (boolean :tag
"Activate" :value t
)))
302 (defvar org-checkbox-statistics-hook nil
303 "Hook that is run whenever Org thinks checkbox statistics should be updated.
304 This hook runs even if checkbox rule in
305 `org-list-automatic-rules' does not apply, so it can be used to
306 implement alternative ways of collecting statistics
309 (defcustom org-hierarchical-checkbox-statistics t
310 "Non-nil means checkbox statistics counts only the state of direct children.
311 When nil, all boxes below the cookie are counted.
312 This can be set to nil on a per-node basis using a COOKIE_DATA property
313 with the word \"recursive\" in the value."
314 :group
'org-plain-lists
317 (defcustom org-description-max-indent
20
318 "Maximum indentation for the second line of a description list.
319 When the indentation would be larger than this, it will become
320 5 characters instead."
321 :group
'org-plain-lists
324 (defcustom org-list-radio-list-templates
325 '((latex-mode "% BEGIN RECEIVE ORGLST %n
326 % END RECEIVE ORGLST %n
328 #+ORGLST: SEND %n org-list-to-latex
331 (texinfo-mode "@c BEGIN RECEIVE ORGLST %n
332 @c END RECEIVE ORGLST %n
334 #+ORGLST: SEND %n org-list-to-texinfo
337 (html-mode "<!-- BEGIN RECEIVE ORGLST %n -->
338 <!-- END RECEIVE ORGLST %n -->
340 #+ORGLST: SEND %n org-list-to-html
343 "Templates for radio lists in different major modes.
344 All occurrences of %n in a template will be replaced with the name of the
345 list, obtained by prompting the user."
346 :group
'org-plain-lists
348 (list (symbol :tag
"Major mode")
349 (string :tag
"Format"))))
351 (defvar org-list-forbidden-blocks
'("example" "verse" "src" "latex" "html" "docbook")
352 "Names of blocks where lists are not allowed.
353 Names must be in lower case.")
355 (defvar org-list-export-context
'(block inlinetask
)
356 "Context types where lists will be interpreted during export.
358 Valid types are `drawer', `inlinetask' and `block'. More
359 specifically, type `block' is determined by the variable
360 `org-list-forbidden-blocks'.")
363 ;;; Predicates and regexps
365 (defconst org-list-end-re
(if org-empty-line-terminates-plain-lists
368 "Regex corresponding to the end of a list.
369 It depends on `org-empty-line-terminates-plain-lists'.")
371 (defconst org-list-full-item-re
372 (concat "^[ \t]*\\(\\(?:[-+*]\\|\\(?:[0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]*\\)"
373 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\]\\)?"
374 "\\(?:\\(\\[[ X-]\\]\\)[ \t]+\\)?"
375 "\\(?:\\(.*\\)[ \t]+::\\(?:[ \t]+\\|$\\)\\)?")
376 "Matches a list item and puts everything into groups:
380 group 4: description tag")
382 (defun org-item-re ()
383 "Return the correct regular expression for plain lists."
385 ((eq org-plain-list-ordered-item-terminator t
) "[.)]")
386 ((= org-plain-list-ordered-item-terminator ?\
)) ")")
387 ((= org-plain-list-ordered-item-terminator ?.
) "\\.")
389 (alpha (if org-alphabetical-lists
"\\|[A-Za-z]" "")))
390 (concat "\\([ \t]*\\([-+]\\|\\(\\([0-9]+" alpha
"\\)" term
391 "\\)\\)\\|[ \t]+\\*\\)\\([ \t]+\\|$\\)")))
393 (defsubst org-item-beginning-re
()
394 "Regexp matching the beginning of a plain list item."
395 (concat "^" (org-item-re)))
397 (defun org-list-at-regexp-after-bullet-p (regexp)
398 "Is point at a list item with REGEXP after bullet?"
401 (goto-char (match-end 0))
402 (let ((counter-re (concat "\\(?:\\[@\\(?:start:\\)?"
403 (if org-alphabetical-lists
404 "\\([0-9]+\\|[A-Za-z]\\)"
407 ;; Ignore counter if any
408 (when (looking-at counter-re
) (goto-char (match-end 0))))
409 (looking-at regexp
))))
411 (defun org-list-in-valid-context-p ()
412 "Non-nil if point is in a valid block.
413 Invalid blocks are referring to `org-list-forbidden-blocks'."
415 (let ((case-fold-search t
))
416 (not (org-in-regexps-block-p
417 (concat "^[ \t]*#\\+begin_\\("
418 (mapconcat 'regexp-quote org-list-forbidden-blocks
"\\|")
420 '(concat "^[ \t]*#\\+end_" (match-string 1)))))))
422 (defun org-in-item-p ()
423 "Return item beginning position when in a plain list, nil otherwise.
424 This checks `org-list-ending-method'."
427 (let* ((case-fold-search t
)
428 (context (org-list-context))
429 (lim-up (car context
))
430 (drawers-re (concat "^[ \t]*:\\("
431 (mapconcat 'regexp-quote org-drawers
"\\|")
433 (inlinetask-re (and (featurep 'org-inlinetask
)
434 (org-inlinetask-outline-regexp)))
435 (item-re (org-item-re))
436 ;; Indentation isn't meaningful when point starts at an empty
437 ;; line or an inline task.
438 (ind-ref (if (or (looking-at "^[ \t]*$")
439 (and inlinetask-re
(looking-at inlinetask-re
)))
441 (org-get-indentation))))
443 ((eq (nth 2 context
) 'invalid
) nil
)
444 ((looking-at item-re
) (point))
446 ;; Detect if cursor in amidst `org-list-end-re'. First, count
447 ;; number HL of hard lines it takes, then call `org-in-regexp'
448 ;; to compute its boundaries END-BOUNDS. When point is
449 ;; in-between, move cursor before regexp beginning.
450 (let ((hl 0) (i -
1) end-bounds
)
451 (when (and (not (eq org-list-ending-method
'indent
))
453 (while (setq i
(string-match
454 "[\r\n]" org-list-end-re
(1+ i
)))
456 (setq end-bounds
(org-in-regexp org-list-end-re hl
)))
457 (>= (point) (car end-bounds
))
458 (< (point) (cdr end-bounds
)))
459 (goto-char (car end-bounds
))
461 ;; Look for an item, less indented that reference line if
462 ;; `org-list-ending-method' isn't `regexp'.
465 (let ((ind (org-get-indentation)))
467 ;; This is exactly what we want.
468 ((and (looking-at item-re
)
470 (eq org-list-ending-method
'regexp
)))
471 (throw 'exit
(point)))
472 ;; At upper bound of search or looking at the end of a
473 ;; previous list: search is over.
474 ((<= (point) lim-up
) (throw 'exit nil
))
475 ((and (not (eq org-list-ending-method
'indent
))
476 (looking-at org-list-end-re
))
478 ;; Skip blocks, drawers, inline-tasks, blank lines
479 ((and (looking-at "^[ \t]*#\\+end_")
480 (re-search-backward "^[ \t]*#\\+begin_" lim-up t
)))
481 ((and (looking-at "^[ \t]*:END:")
482 (re-search-backward drawers-re lim-up t
))
484 ((and inlinetask-re
(looking-at inlinetask-re
))
485 (org-inlinetask-goto-beginning)
487 ((looking-at "^[ \t]*$") (forward-line -
1))
488 ;; Text at column 0 cannot belong to a list: stop.
489 ((zerop ind
) (throw 'exit nil
))
490 ;; Normal text less indented than reference line, take
491 ;; it as new reference.
495 (t (forward-line -
1)))))))))))
497 (defun org-at-item-p ()
498 "Is point in a line starting a hand-formatted item?"
501 (and (looking-at (org-item-re)) (org-list-in-valid-context-p))))
503 (defun org-at-item-bullet-p ()
504 "Is point at the bullet of a plain list item?"
506 (not (member (char-after) '(?\ ?
\t)))
507 (< (point) (match-end 0))))
509 (defun org-at-item-timer-p ()
510 "Is point at a line starting a plain list item with a timer?"
511 (org-list-at-regexp-after-bullet-p
512 "\\([0-9]+:[0-9]+:[0-9]+\\)[ \t]+::[ \t]+"))
514 (defun org-at-item-description-p ()
515 "Is point at a description list item?"
516 (org-list-at-regexp-after-bullet-p "\\(\\S-.+\\)[ \t]+::[ \t]+"))
518 (defun org-at-item-checkbox-p ()
519 "Is point at a line starting a plain-list item with a checklet?"
520 (org-list-at-regexp-after-bullet-p "\\(\\[[- X]\\]\\)[ \t]+"))
522 (defun org-at-item-counter-p ()
523 "Is point at a line starting a plain-list item with a counter?"
525 (looking-at org-list-full-item-re
)
529 ;;; Structures and helper functions
531 (defun org-list-context ()
532 "Determine context, and its boundaries, around point.
534 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
535 are boundaries and CONTEXT is a symbol among `drawer', `block',
536 `invalid', `inlinetask' and nil.
538 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
541 (org-with-limited-levels
543 (let ((case-fold-search t
) (pos (point)) beg end context-type
544 ;; Get positions of surrounding headings. This is the
546 (lim-up (or (save-excursion (and (ignore-errors (org-back-to-heading t
))
549 (lim-down (or (save-excursion (outline-next-heading)) (point-max))))
550 ;; Is point inside a drawer?
551 (let ((end-re "^[ \t]*:END:")
552 ;; Can't use org-drawers-regexp as this function
553 ;; might be called in buffers not in Org mode
554 (beg-re (concat "^[ \t]*:\\("
555 (mapconcat 'regexp-quote org-drawers
"\\|")
557 (when (save-excursion
558 (and (not (looking-at beg-re
))
559 (not (looking-at end-re
))
560 (setq beg
(and (re-search-backward beg-re lim-up t
)
561 (1+ (point-at-eol))))
562 (setq end
(or (and (re-search-forward end-re lim-down t
)
563 (1- (match-beginning 0)))
566 (setq lim-up beg lim-down end context-type
'drawer
)))
567 ;; Is point strictly in a block, and of which type?
568 (let ((block-re "^[ \t]*#\\+\\(begin\\|end\\)_") type
)
569 (when (save-excursion
570 (and (not (looking-at block-re
))
571 (setq beg
(and (re-search-backward block-re lim-up t
)
572 (1+ (point-at-eol))))
573 (looking-at "^[ \t]*#\\+begin_\\(\\S-+\\)")
574 (setq type
(downcase (match-string 1)))
576 (setq end
(or (and (re-search-forward block-re lim-down t
)
580 (equal (downcase (match-string 1)) "end")))
581 (setq lim-up beg lim-down end
582 context-type
(if (member type org-list-forbidden-blocks
)
584 ;; Is point in an inlinetask?
585 (when (and (featurep 'org-inlinetask
)
587 (let* ((beg-re (org-inlinetask-outline-regexp))
588 (end-re (concat beg-re
"END[ \t]*$")))
589 (and (not (looking-at "^\\*+"))
590 (setq beg
(and (re-search-backward beg-re lim-up t
)
591 (1+ (point-at-eol))))
592 (not (looking-at end-re
))
593 (setq end
(and (re-search-forward end-re lim-down t
)
594 (1- (match-beginning 0))))
596 (setq lim-up beg lim-down end context-type
'inlinetask
))
597 ;; Return context boundaries and type.
598 (list lim-up lim-down context-type
))))))
600 (defun org-list-struct ()
601 "Return structure of list at point.
603 A list structure is an alist where key is point at item, and
606 2. bullet with trailing whitespace,
607 3. bullet counter, if any,
609 5. description tag, if any,
610 6. position at item end.
612 Thus the following list, where numbers in parens are
617 5. [@5] sub-item 2 (34)
618 some other text belonging to first item (55)
620 + tag :: description (109)
623 will get the following structure:
625 \(\(1 0 \"- \" nil \"[X]\" nil 97\)
626 \(18 2 \"1. \" nil nil nil 34\)
627 \(34 2 \"5. \" \"5\" nil nil 55\)
628 \(97 0 \"- \" nil nil nil 131\)
629 \(109 2 \"+ \" nil nil \"tag\" 131\)
631 Assume point is at an item."
634 (let* ((case-fold-search t
)
635 (context (org-list-context))
636 (lim-up (car context
))
637 (lim-down (nth 1 context
))
639 (item-re (org-item-re))
640 (drawers-re (concat "^[ \t]*:\\("
641 (mapconcat 'regexp-quote org-drawers
"\\|")
643 (inlinetask-re (and (featurep 'org-inlinetask
)
644 (org-inlinetask-outline-regexp)))
645 (beg-cell (cons (point) (org-get-indentation)))
646 ind itm-lst itm-lst-2 end-lst end-lst-2 struct
649 ;; Return association at point.
651 (looking-at org-list-full-item-re
)
654 (match-string-no-properties 1) ; bullet
655 (match-string-no-properties 2) ; counter
656 (match-string-no-properties 3) ; checkbox
657 (match-string-no-properties 4))))) ; description tag
660 ;; Ensure list ends at the first blank line.
662 (skip-chars-backward " \r\t\n")
663 (min (1+ (point-at-eol)) lim-down
)))))
664 ;; 1. Read list from starting item to its beginning, and save
665 ;; top item position and indentation in BEG-CELL. Also store
666 ;; ending position of items in END-LST.
670 (let ((ind (+ (or (get-text-property (point) 'original-indentation
) 0)
671 (org-get-indentation))))
674 ;; At upward limit: if we ended at an item, store it,
675 ;; else dimiss useless data recorded above BEG-CELL.
679 (if (or (not (looking-at item-re
))
680 (get-text-property (point) 'org-example
))
681 (memq (assq (car beg-cell
) itm-lst
) itm-lst
)
682 (setq beg-cell
(cons (point) ind
))
683 (cons (funcall assoc-at-point ind
) itm-lst
)))))
684 ;; At a verbatim block, go before its beginning. Move
685 ;; from eol to ensure `previous-single-property-change'
686 ;; will return a value.
687 ((get-text-property (point) 'org-example
)
688 (goto-char (previous-single-property-change
689 (point-at-eol) 'org-example nil lim-up
))
691 ;; Looking at a list ending regexp. Dismiss useless
692 ;; data recorded above BEG-CELL. Jump to part 2.
693 ((and (not (eq org-list-ending-method
'indent
))
694 (looking-at org-list-end-re
))
697 (memq (assq (car beg-cell
) itm-lst
) itm-lst
))))
698 ;; Point is at an item. Add data to ITM-LST. It may
699 ;; also end a previous item: save it in END-LST. If ind
700 ;; is less or equal than BEG-CELL and there is no end
701 ;; at this ind or lesser, this item becomes the new
703 ((looking-at item-re
)
704 (push (funcall assoc-at-point ind
) itm-lst
)
705 (push (cons ind
(point)) end-lst
)
706 (when (or (and (eq org-list-ending-method
'regexp
)
707 (<= ind
(cdr beg-cell
)))
708 (< ind text-min-ind
))
709 (setq beg-cell
(cons (point) ind
)))
711 ;; Skip blocks, drawers, inline tasks, blank lines.
712 ((and (looking-at "^[ \t]*#\\+end_")
713 (re-search-backward "^[ \t]*#\\+begin_" lim-up t
)))
714 ((and (looking-at "^[ \t]*:END:")
715 (re-search-backward drawers-re lim-up t
))
717 ((and inlinetask-re
(looking-at inlinetask-re
))
718 (org-inlinetask-goto-beginning)
720 ((looking-at "^[ \t]*$")
722 ;; From there, point is not at an item. Unless ending
723 ;; method is `regexp', interpret line's indentation:
724 ;; - text at column 0 is necessarily out of any list.
725 ;; Dismiss data recorded above BEG-CELL. Jump to
727 ;; - any other case may be an ending position for an
728 ;; hypothetical item above. Store it and proceed.
729 ((eq org-list-ending-method
'regexp
) (forward-line -
1))
733 (memq (assq (car beg-cell
) itm-lst
) itm-lst
))))
735 (when (< ind text-min-ind
) (setq text-min-ind ind
))
736 (push (cons ind
(point)) end-lst
)
737 (forward-line -
1)))))))
738 ;; 2. Read list from starting point to its end, that is until we
739 ;; get out of context, or that a non-item line is less or
740 ;; equally indented than BEG-CELL's cdr. Also, store ending
741 ;; position of items in END-LST-2.
744 (let ((ind (+ (or (get-text-property (point) 'original-indentation
) 0)
745 (org-get-indentation))))
747 ((>= (point) lim-down
)
748 ;; At downward limit: this is de facto the end of the
749 ;; list. Save point as an ending position, and jump to
752 (push (cons 0 (funcall end-before-blank
)) end-lst-2
)))
753 ;; At a verbatim block, move to its end. Point is at bol
754 ;; and 'org-example property is set by whole lines:
755 ;; `next-single-property-change' always return a value.
756 ((get-text-property (point) 'org-example
)
758 (next-single-property-change (point) 'org-example nil lim-down
)))
759 ;; Looking at a list ending regexp. Save point as an
760 ;; ending position and jump to part 3.
761 ((and (not (eq org-list-ending-method
'indent
))
762 (looking-at org-list-end-re
))
763 (throw 'exit
(push (cons 0 (point)) end-lst-2
)))
764 ((looking-at item-re
)
765 ;; Point is at an item. Add data to ITM-LST-2. It may also
766 ;; end a previous item, so save it in END-LST-2.
767 (push (funcall assoc-at-point ind
) itm-lst-2
)
768 (push (cons ind
(point)) end-lst-2
)
770 ;; Skip inline tasks and blank lines along the way
771 ((and inlinetask-re
(looking-at inlinetask-re
))
772 (org-inlinetask-goto-end))
773 ((looking-at "^[ \t]*$")
775 ;; Ind is lesser or equal than BEG-CELL's. The list is
776 ;; over: store point as an ending position and jump to
778 ((and (not (eq org-list-ending-method
'regexp
))
779 (<= ind
(cdr beg-cell
)))
781 (push (cons 0 (funcall end-before-blank
)) end-lst-2
)))
782 ;; Else, if ind is lesser or equal than previous item's,
783 ;; this is an ending position: store it. In any case,
784 ;; skip block or drawer at point, and move to next line.
786 (when (and (not (eq org-list-ending-method
'regexp
))
787 (<= ind
(nth 1 (car itm-lst-2
))))
788 (push (cons ind
(point)) end-lst-2
))
790 ((and (looking-at "^[ \t]*#\\+begin_")
791 (re-search-forward "^[ \t]*#\\+end_" lim-down t
)))
792 ((and (looking-at drawers-re
)
793 (re-search-forward "^[ \t]*:END:" lim-down t
))))
794 (forward-line 1))))))
795 (setq struct
(append itm-lst
(cdr (nreverse itm-lst-2
)))
796 end-lst
(append end-lst
(cdr (nreverse end-lst-2
))))
797 ;; 3. Correct ill-formed lists by ensuring top item is the least
799 (let ((min-ind (nth 1 (car struct
))))
801 (let ((ind (nth 1 item
))
803 (when (< ind min-ind
)
804 (setcar (cdr item
) min-ind
)
805 ;; Trim bullet so item will be seen as different
806 ;; when compared with repaired version.
807 (setcar (nthcdr 2 item
) (org-trim bul
)))))
809 ;; 4. Associate each item to its end pos.
810 (org-list-struct-assoc-end struct end-lst
)
814 (defun org-list-struct-assoc-end (struct end-list
)
815 "Associate proper ending point to items in STRUCT.
817 END-LIST is a pseudo-alist where car is indentation and cdr is
820 This function modifies STRUCT."
821 (let ((endings end-list
))
824 (let ((pos (car elt
))
826 ;; Remove end candidates behind current item
827 (while (or (<= (cdar endings
) pos
))
829 ;; Add end position to item assoc
830 (let ((old-end (nthcdr 6 elt
))
831 (new-end (assoc-default ind endings
'<=)))
833 (setcar old-end new-end
)
834 (setcdr elt
(append (cdr elt
) (list new-end
)))))))
837 (defun org-list-prevs-alist (struct)
838 "Return alist between item and previous item in STRUCT."
839 (let ((item-end-alist (mapcar (lambda (e) (cons (car e
) (nth 6 e
)))
842 (let ((prev (car (rassq (car e
) item-end-alist
))))
843 (cons (car e
) prev
)))
846 (defun org-list-parents-alist (struct)
847 "Return alist between item and parent in STRUCT."
848 (let ((ind-to-ori (list (list (nth 1 (car struct
)))))
849 (prev-pos (list (caar struct
))))
851 (mapcar (lambda (item)
852 (let ((pos (car item
))
854 (prev-ind (caar ind-to-ori
)))
859 (member (assq ind ind-to-ori
) ind-to-ori
))
860 (cons pos
(cdar ind-to-ori
)))
862 (let ((origin (nth 1 prev-pos
)))
863 (push (cons ind origin
) ind-to-ori
)
865 (t (cons pos
(cdar ind-to-ori
))))))
871 (defsubst org-list-get-nth
(n key struct
)
872 "Return the Nth value of KEY in STRUCT."
873 (nth n
(assq key struct
)))
875 (defun org-list-set-nth (n key struct new
)
876 "Set the Nth value of KEY in STRUCT to NEW.
877 \nThis function modifies STRUCT."
878 (setcar (nthcdr n
(assq key struct
)) new
))
880 (defsubst org-list-get-ind
(item struct
)
881 "Return indentation of ITEM in STRUCT."
882 (org-list-get-nth 1 item struct
))
884 (defun org-list-set-ind (item struct ind
)
885 "Set indentation of ITEM in STRUCT to IND.
886 \nThis function modifies STRUCT."
887 (org-list-set-nth 1 item struct ind
))
889 (defsubst org-list-get-bullet
(item struct
)
890 "Return bullet of ITEM in STRUCT."
891 (org-list-get-nth 2 item struct
))
893 (defun org-list-set-bullet (item struct bullet
)
894 "Set bullet of ITEM in STRUCT to BULLET.
895 \nThis function modifies STRUCT."
896 (org-list-set-nth 2 item struct bullet
))
898 (defsubst org-list-get-counter
(item struct
)
899 "Return counter of ITEM in STRUCT."
900 (org-list-get-nth 3 item struct
))
902 (defsubst org-list-get-checkbox
(item struct
)
903 "Return checkbox of ITEM in STRUCT or nil."
904 (org-list-get-nth 4 item struct
))
906 (defun org-list-set-checkbox (item struct checkbox
)
907 "Set checkbox of ITEM in STRUCT to CHECKBOX.
908 \nThis function modifies STRUCT."
909 (org-list-set-nth 4 item struct checkbox
))
911 (defsubst org-list-get-tag
(item struct
)
912 "Return end position of ITEM in STRUCT."
913 (org-list-get-nth 5 item struct
))
915 (defun org-list-get-item-end (item struct
)
916 "Return end position of ITEM in STRUCT."
917 (org-list-get-nth 6 item struct
))
919 (defun org-list-get-item-end-before-blank (item struct
)
920 "Return point at end of ITEM in STRUCT, before any blank line.
921 Point returned is at end of line."
923 (goto-char (org-list-get-item-end item struct
))
924 (skip-chars-backward " \r\t\n")
927 (defun org-list-get-parent (item struct parents
)
928 "Return parent of ITEM or nil.
929 STRUCT is the list structure. PARENTS is the alist of parents, as
930 returned by `org-list-parents-alist'."
931 (let ((parents (or parents
(org-list-parents-alist struct
))))
932 (cdr (assq item parents
))))
934 (defun org-list-has-child-p (item struct
)
935 "Non-nil if ITEM has a child.
937 STRUCT is the list structure.
939 Value returned is the position of the first child of ITEM."
940 (let ((ind (org-list-get-ind item struct
))
941 (child-maybe (car (nth 1 (member (assq item struct
) struct
)))))
942 (when (and child-maybe
943 (< ind
(org-list-get-ind child-maybe struct
)))
946 (defun org-list-get-next-item (item struct prevs
)
947 "Return next item in same sub-list as ITEM, or nil.
948 STRUCT is the list structure. PREVS is the alist of previous
949 items, as returned by `org-list-prevs-alist'."
950 (car (rassq item prevs
)))
952 (defun org-list-get-prev-item (item struct prevs
)
953 "Return previous item in same sub-list as ITEM, or nil.
954 STRUCT is the list structure. PREVS is the alist of previous
955 items, as returned by `org-list-prevs-alist'."
956 (cdr (assq item prevs
)))
958 (defun org-list-get-subtree (item struct
)
959 "List all items having ITEM as a common ancestor, or nil.
960 STRUCT is the list structure."
961 (let* ((item-end (org-list-get-item-end item struct
))
962 (sub-struct (cdr (member (assq item struct
) struct
)))
967 (if (< pos item-end
) (push pos subtree
) (throw 'exit nil
))))
971 (defun org-list-get-all-items (item struct prevs
)
972 "List all items in the same sub-list as ITEM.
973 STRUCT is the list structure. PREVS is the alist of previous
974 items, as returned by `org-list-prevs-alist'."
975 (let ((prev-item item
)
977 before-item after-item
)
978 (while (setq prev-item
(org-list-get-prev-item prev-item struct prevs
))
979 (push prev-item before-item
))
980 (while (setq next-item
(org-list-get-next-item next-item struct prevs
))
981 (push next-item after-item
))
982 (append before-item
(list item
) (nreverse after-item
))))
984 (defun org-list-get-children (item struct parents
)
985 "List all children of ITEM, or nil.
986 STRUCT is the list structure. PARENTS is the alist of parents, as
987 returned by `org-list-parents-alist'."
989 (while (setq child
(car (rassq item parents
)))
990 (setq parents
(cdr (member (assq child parents
) parents
)))
994 (defun org-list-get-top-point (struct)
995 "Return point at beginning of list.
996 STRUCT is the list structure."
999 (defun org-list-get-bottom-point (struct)
1000 "Return point at bottom of list.
1001 STRUCT is the list structure."
1003 (mapcar (lambda (e) (org-list-get-item-end (car e
) struct
)) struct
)))
1005 (defun org-list-get-list-begin (item struct prevs
)
1006 "Return point at beginning of sub-list ITEM belongs.
1007 STRUCT is the list structure. PREVS is the alist of previous
1008 items, as returned by `org-list-prevs-alist'."
1009 (let ((first-item item
) prev-item
)
1010 (while (setq prev-item
(org-list-get-prev-item first-item struct prevs
))
1011 (setq first-item prev-item
))
1014 (defalias 'org-list-get-first-item
'org-list-get-list-begin
)
1016 (defun org-list-get-last-item (item struct prevs
)
1017 "Return point at last item of sub-list ITEM belongs.
1018 STRUCT is the list structure. PREVS is the alist of previous
1019 items, as returned by `org-list-prevs-alist'."
1020 (let ((last-item item
) next-item
)
1021 (while (setq next-item
(org-list-get-next-item last-item struct prevs
))
1022 (setq last-item next-item
))
1025 (defun org-list-get-list-end (item struct prevs
)
1026 "Return point at end of sub-list ITEM belongs.
1027 STRUCT is the list structure. PREVS is the alist of previous
1028 items, as returned by `org-list-prevs-alist'."
1029 (org-list-get-item-end (org-list-get-last-item item struct prevs
) struct
))
1031 (defun org-list-get-list-type (item struct prevs
)
1032 "Return the type of the list containing ITEM, as a symbol.
1034 STRUCT is the list structure. PREVS is the alist of previous
1035 items, as returned by `org-list-prevs-alist'.
1037 Possible types are `descriptive', `ordered' and `unordered'. The
1038 type is determined by the first item of the list."
1039 (let ((first (org-list-get-list-begin item struct prevs
)))
1041 ((org-list-get-tag first struct
) 'descriptive
)
1042 ((string-match "[[:alnum:]]" (org-list-get-bullet first struct
)) 'ordered
)
1048 (defun org-list-search-generic (search re bound noerr
)
1049 "Search a string in valid contexts for lists.
1050 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1051 in `re-search-forward'."
1053 (let ((origin (point)))
1055 ;; 1. No match: return to origin or bound, depending on NOERR.
1056 (unless (funcall search re bound noerr
)
1057 (throw 'exit
(and (goto-char (if (memq noerr
'(t nil
)) origin bound
))
1059 ;; 2. Match in valid context: return point. Else, continue
1061 (when (org-list-in-valid-context-p) (throw 'exit
(point)))))))
1063 (defun org-list-search-backward (regexp &optional bound noerror
)
1064 "Like `re-search-backward' but stop only where lists are recognized.
1065 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1066 `re-search-backward'."
1067 (org-list-search-generic #'re-search-backward
1068 regexp
(or bound
(point-min)) noerror
))
1070 (defun org-list-search-forward (regexp &optional bound noerror
)
1071 "Like `re-search-forward' but stop only where lists are recognized.
1072 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1073 `re-search-forward'."
1074 (org-list-search-generic #'re-search-forward
1075 regexp
(or bound
(point-max)) noerror
))
1078 ;;; Methods on structures
1080 (defsubst org-list-bullet-string
(bullet)
1081 "Return BULLET with the correct number of whitespaces.
1082 It determines the number of whitespaces to append by looking at
1083 `org-list-two-spaces-after-bullet-regexp'."
1085 (let ((spaces (if (and org-list-two-spaces-after-bullet-regexp
1087 org-list-two-spaces-after-bullet-regexp bullet
))
1090 (string-match "\\S-+\\([ \t]*\\)" bullet
)
1091 (replace-match spaces nil nil bullet
1))))
1093 (defun org-list-separating-blank-lines-number (pos struct prevs
)
1094 "Return number of blank lines that should separate items in list.
1096 POS is the position of point where `org-list-insert-item' was called.
1098 STRUCT is the list structure. PREVS is the alist of previous
1099 items, as returned by `org-list-prevs-alist'.
1101 Assume point is at item's beginning. If the item is alone, apply
1102 some heuristics to guess the result."
1104 (let ((item (point))
1106 (cdr (assq 'plain-list-item org-blank-before-new-entry
)))
1109 ;; Trivial cases where there should be none.
1110 ((or (and (not (eq org-list-ending-method
'indent
))
1111 org-empty-line-terminates-plain-lists
)
1112 (not insert-blank-p
)) 0)
1113 ;; When `org-blank-before-new-entry' says so, it is 1.
1114 ((eq insert-blank-p t
) 1)
1115 ;; plain-list-item is 'auto. Count blank lines separating
1116 ;; neighbours items in list.
1117 (t (let ((next-p (org-list-get-next-item item struct prevs
)))
1119 ;; Is there a next item?
1120 (next-p (goto-char next-p
)
1121 (org-back-over-empty-lines))
1122 ;; Is there a previous item?
1123 ((org-list-get-prev-item item struct prevs
)
1124 (org-back-over-empty-lines))
1125 ;; User inserted blank lines, trust him
1126 ((and (> pos
(org-list-get-item-end-before-blank item struct
))
1129 (skip-chars-backward " \t")
1130 (setq usr-blank
(org-back-over-empty-lines))) 0))
1132 ;; Are there blank lines inside the item ?
1134 (org-list-search-forward
1135 "^[ \t]*$" (org-list-get-item-end-before-blank item struct
) t
))
1137 ;; No parent: no blank line.
1140 (defun org-list-insert-item (pos struct prevs
&optional checkbox after-bullet
)
1141 "Insert a new list item at POS and return the new structure.
1142 If POS is before first character after bullet of the item, the
1143 new item will be created before the current one.
1145 STRUCT is the list structure. PREVS is the the alist of previous
1146 items, as returned by `org-list-prevs-alist'.
1148 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1149 after the bullet. Cursor will be after this text once the
1152 This function modifies STRUCT."
1153 (let ((case-fold-search t
))
1154 ;; 1. Get information about list: structure, usual helper
1155 ;; functions, position of point with regards to item start
1156 ;; (BEFOREP), blank lines number separating items (BLANK-NB),
1157 ;; position of split (POS) if we're allowed to (SPLIT-LINE-P).
1158 (let* ((item (goto-char (org-list-get-item-begin)))
1159 (item-end (org-list-get-item-end item struct
))
1160 (item-end-no-blank (org-list-get-item-end-before-blank item struct
))
1161 (beforep (and (looking-at org-list-full-item-re
)
1162 (<= pos
(match-end 0))))
1163 (split-line-p (org-get-alist-option org-M-RET-may-split-line
'item
))
1164 (blank-nb (org-list-separating-blank-lines-number
1166 ;; 2. Build the new item to be created. Concatenate same
1167 ;; bullet as item, checkbox, text AFTER-BULLET if
1168 ;; provided, and text cut from point to end of item
1169 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1170 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1171 ;; between what was cut and what was inserted in buffer
1172 ;; is stored in SIZE-OFFSET.
1173 (ind (org-list-get-ind item struct
))
1174 (ind-size (if indent-tabs-mode
1175 (+ (/ ind tab-width
) (mod ind tab-width
))
1177 (bullet (org-list-bullet-string (org-list-get-bullet item struct
)))
1178 (box (when checkbox
"[ ]"))
1180 (and (not beforep
) split-line-p
1183 (skip-chars-backward " \r\t\n")
1185 (delete-and-extract-region pos item-end-no-blank
))))
1186 (body (concat bullet
(when box
(concat box
" ")) after-bullet
1188 (if (string-match "\\`[ \t]+" text-cut
)
1189 (replace-match "" t t text-cut
)
1192 (item-sep (make-string (1+ blank-nb
) ?
\n))
1193 (item-size (+ ind-size
(length body
) (length item-sep
)))
1194 (size-offset (- item-size
(length text-cut
))))
1195 ;; 4. Insert effectively item into buffer
1197 (org-indent-to-column ind
)
1198 (insert body item-sep
)
1199 ;; 5. Add new item to STRUCT.
1204 ;; Before inserted item, positions don't change but
1205 ;; an item ending after insertion has its end shifted
1208 (when (> end item
) (setcar (nthcdr 6 e
) (+ end size-offset
))))
1209 ;; Trivial cases where current item isn't split in
1210 ;; two. Just shift every item after new one by
1212 ((or beforep
(not split-line-p
))
1213 (setcar e
(+ p item-size
))
1214 (setcar (nthcdr 6 e
) (+ end item-size
)))
1215 ;; Item is split in two: elements before POS are just
1216 ;; shifted by ITEM-SIZE. In the case item would end
1217 ;; after split POS, ending is only shifted by
1220 (setcar e
(+ p item-size
))
1222 (setcar (nthcdr 6 e
) (+ end item-size
))
1223 (setcar (nthcdr 6 e
) (+ end size-offset
))))
1224 ;; Elements after POS are moved into new item. Length
1225 ;; of ITEM-SEP has to be removed as ITEM-SEP
1226 ;; doesn't appear in buffer yet.
1228 (setcar e
(+ p size-offset
(- item pos
(length item-sep
))))
1229 (if (= end item-end
)
1230 (setcar (nthcdr 6 e
) (+ item item-size
))
1231 (setcar (nthcdr 6 e
)
1233 (- item pos
(length item-sep
))))))
1234 ;; Elements at ITEM-END or after are only shifted by
1236 (t (setcar e
(+ p size-offset
))
1237 (setcar (nthcdr 6 e
) (+ end size-offset
))))))
1239 (push (list item ind bullet nil box nil
(+ item item-size
)) struct
)
1240 (setq struct
(sort struct
(lambda (e1 e2
) (< (car e1
) (car e2
)))))
1241 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1242 ;; exchange ITEM with the next item in list. Position cursor
1243 ;; after bullet, counter, checkbox, and label.
1246 (setq struct
(org-list-exchange-items item
(+ item item-size
) struct
))
1247 (goto-char (org-list-get-next-item
1248 item struct
(org-list-prevs-alist struct
))))
1251 (defun org-list-exchange-items (beg-A beg-B struct
)
1252 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1253 Blank lines at the end of items are left in place. Return the new
1254 structure after the changes.
1256 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1257 to the same sub-list.
1259 This function modifies STRUCT."
1261 (let* ((end-A-no-blank (org-list-get-item-end-before-blank beg-A struct
))
1262 (end-B-no-blank (org-list-get-item-end-before-blank beg-B struct
))
1263 (end-A (org-list-get-item-end beg-A struct
))
1264 (end-B (org-list-get-item-end beg-B struct
))
1265 (size-A (- end-A-no-blank beg-A
))
1266 (size-B (- end-B-no-blank beg-B
))
1267 (body-A (buffer-substring beg-A end-A-no-blank
))
1268 (body-B (buffer-substring beg-B end-B-no-blank
))
1269 (between-A-no-blank-and-B (buffer-substring end-A-no-blank beg-B
))
1270 (sub-A (cons beg-A
(org-list-get-subtree beg-A struct
)))
1271 (sub-B (cons beg-B
(org-list-get-subtree beg-B struct
))))
1272 ;; 1. Move effectively items in buffer.
1274 (delete-region beg-A end-B-no-blank
)
1275 (insert (concat body-B between-A-no-blank-and-B body-A
))
1276 ;; 2. Now modify struct. No need to re-read the list, the
1277 ;; transformation is just a shift of positions. Some special
1278 ;; attention is required for items ending at END-A and END-B
1279 ;; as empty spaces are not moved there. In others words, item
1280 ;; BEG-A will end with whitespaces that were at the end of
1281 ;; BEG-B and the same applies to BEG-B.
1283 (let ((pos (car e
)))
1287 (let ((end-e (nth 6 e
)))
1288 (setcar e
(+ pos
(- end-B-no-blank end-A-no-blank
)))
1289 (setcar (nthcdr 6 e
)
1290 (+ end-e
(- end-B-no-blank end-A-no-blank
)))
1291 (when (= end-e end-A
) (setcar (nthcdr 6 e
) end-B
))))
1293 (let ((end-e (nth 6 e
)))
1294 (setcar e
(- (+ pos beg-A
) beg-B
))
1295 (setcar (nthcdr 6 e
) (+ end-e
(- beg-A beg-B
)))
1296 (when (= end-e end-B
)
1297 (setcar (nthcdr 6 e
)
1298 (+ beg-A size-B
(- end-A end-A-no-blank
))))))
1300 (let ((end-e (nth 6 e
)))
1301 (setcar e
(+ pos
(- size-B size-A
)))
1302 (setcar (nthcdr 6 e
) (+ end-e
(- size-B size-A
))))))))
1304 (sort struct
(lambda (e1 e2
) (< (car e1
) (car e2
)))))))
1306 (defun org-list-struct-outdent (start end struct parents
)
1307 "Outdent items between positions START and END.
1309 STRUCT is the list structure. PARENTS is the alist of items'
1310 parents, as returned by `org-list-parents-alist'.
1312 START is included, END excluded."
1315 (let* ((item (car cell
))
1316 (parent (cdr cell
)))
1318 ;; Item not yet in zone: keep association
1319 ((< item start
) cell
)
1320 ;; Item out of zone: follow associations in acc
1322 (let ((convert (and parent
(assq parent acc
))))
1323 (if convert
(cons item
(cdr convert
)) cell
)))
1324 ;; Item has no parent: error
1326 (error "Cannot outdent top-level items"))
1327 ;; Parent is outdented: keep association
1329 (push (cons parent item
) acc
) cell
)
1331 ;; Parent isn't outdented: reparent to grand-parent
1332 (let ((grand-parent (org-list-get-parent
1333 parent struct parents
)))
1334 (push (cons parent item
) acc
)
1335 (cons item grand-parent
))))))))
1336 (mapcar out parents
)))
1338 (defun org-list-struct-indent (start end struct parents prevs
)
1339 "Indent items between positions START and END.
1341 STRUCT is the list structure. PARENTS is the alist of parents and
1342 PREVS is the alist of previous items, returned by, respectively,
1343 `org-list-parents-alist' and `org-list-prevs-alist'.
1345 START is included and END excluded.
1347 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1348 bullets between START and END."
1350 (set-assoc (lambda (cell) (push cell acc
) cell
))
1351 (change-bullet-maybe
1354 (let* ((bul (org-trim (org-list-get-bullet item struct
)))
1355 (new-bul-p (cdr (assoc bul org-list-demote-modify-bullet
))))
1356 (when new-bul-p
(org-list-set-bullet item struct new-bul-p
))))))
1359 (let* ((item (car cell
))
1360 (parent (cdr cell
)))
1362 ;; Item not yet in zone: keep association
1363 ((< item start
) cell
)
1365 ;; Item out of zone: follow associations in acc
1366 (let ((convert (assq parent acc
)))
1367 (if convert
(cons item
(cdr convert
)) cell
)))
1369 ;; Item is in zone...
1370 (let ((prev (org-list-get-prev-item item struct prevs
)))
1371 ;; Check if bullet needs to be changed
1372 (funcall change-bullet-maybe item
)
1374 ;; First item indented but not parent: error
1375 ((and (not prev
) (< parent start
))
1376 (error "Cannot indent the first item of a list"))
1377 ;; First item and parent indented: keep same parent
1378 ((not prev
) (funcall set-assoc cell
))
1379 ;; Previous item not indented: reparent to it
1380 ((< prev start
) (funcall set-assoc
(cons item prev
)))
1381 ;; Previous item indented: reparent like it
1384 (cons item
(cdr (assq prev acc
)))))))))))))
1385 (mapcar ind parents
)))
1388 ;;; Repairing structures
1390 (defun org-list-use-alpha-bul-p (first struct prevs
)
1391 "Non-nil if list starting at FIRST can have alphabetical bullets.
1393 STRUCT is list structure. PREVS is the alist of previous items,
1394 as returned by `org-list-prevs-alist'."
1395 (and org-alphabetical-lists
1397 (let ((item first
) (ascii 64) (case-fold-search nil
))
1398 ;; Pretend that bullets are uppercase and check if alphabet
1399 ;; is sufficient, taking counters into account.
1401 (let ((bul (org-list-get-bullet item struct
))
1402 (count (org-list-get-counter item struct
)))
1403 ;; Virtually determine current bullet
1404 (if (and count
(string-match "[a-zA-Z]" count
))
1405 ;; Counters are not case-sensitive.
1406 (setq ascii
(string-to-char (upcase count
)))
1407 (setq ascii
(1+ ascii
)))
1408 ;; Test if bullet would be over z or Z.
1411 (setq item
(org-list-get-next-item item struct prevs
)))))
1412 ;; All items checked. All good.
1415 (defun org-list-inc-bullet-maybe (bullet)
1416 "Increment BULLET if applicable."
1417 (let ((case-fold-search nil
))
1419 ;; Num bullet: increment it.
1420 ((string-match "[0-9]+" bullet
)
1422 (number-to-string (1+ (string-to-number (match-string 0 bullet
))))
1424 ;; Alpha bullet: increment it.
1425 ((string-match "[A-Za-z]" bullet
)
1427 (char-to-string (1+ (string-to-char (match-string 0 bullet
))))
1429 ;; Unordered bullet: leave it.
1432 (defun org-list-struct-fix-bul (struct prevs
)
1433 "Verify and correct bullets in STRUCT.
1434 PREVS is the alist of previous items, as returned by
1435 `org-list-prevs-alist'.
1437 This function modifies STRUCT."
1438 (let ((case-fold-search nil
)
1441 ;; Set bullet of ITEM in STRUCT, depending on the type of
1442 ;; first item of the list, the previous bullet and counter
1445 (let* ((prev (org-list-get-prev-item item struct prevs
))
1446 (prev-bul (and prev
(org-list-get-bullet prev struct
)))
1447 (counter (org-list-get-counter item struct
))
1448 (bullet (org-list-get-bullet item struct
))
1449 (alphap (and (not prev
)
1450 (org-list-use-alpha-bul-p item struct prevs
))))
1451 (org-list-set-bullet
1453 (org-list-bullet-string
1455 ;; Alpha counter in alpha list: use counter.
1457 (string-match "[a-zA-Z]" counter
)
1458 (string-match "[a-zA-Z]" prev-bul
))
1459 ;; Use cond to be sure `string-match' is used in
1463 ((string-match "[a-z]" prev-bul
) (downcase counter
))
1464 ((string-match "[A-Z]" prev-bul
) (upcase counter
)))))
1465 (replace-match real-count nil nil prev-bul
)))
1466 ;; Num counter in a num list: use counter.
1468 (string-match "[0-9]+" counter
)
1469 (string-match "[0-9]+" prev-bul
))
1470 (replace-match counter nil nil prev-bul
))
1471 ;; No counter: increase, if needed, previous bullet.
1473 (org-list-inc-bullet-maybe (org-list-get-bullet prev struct
)))
1474 ;; Alpha counter at first item: use counter.
1475 ((and counter
(org-list-use-alpha-bul-p item struct prevs
)
1476 (string-match "[A-Za-z]" counter
)
1477 (string-match "[A-Za-z]" bullet
))
1480 ((string-match "[a-z]" bullet
) (downcase counter
))
1481 ((string-match "[A-Z]" bullet
) (upcase counter
)))))
1482 (replace-match real-count nil nil bullet
)))
1483 ;; Num counter at first item: use counter.
1485 (string-match "[0-9]+" counter
)
1486 (string-match "[0-9]+" bullet
))
1487 (replace-match counter nil nil bullet
))
1488 ;; First bullet is alpha uppercase: use "A".
1489 ((and alphap
(string-match "[A-Z]" bullet
))
1490 (replace-match "A" nil nil bullet
))
1491 ;; First bullet is alpha lowercase: use "a".
1492 ((and alphap
(string-match "[a-z]" bullet
))
1493 (replace-match "a" nil nil bullet
))
1494 ;; First bullet is num: use "1".
1495 ((string-match "\\([0-9]+\\|[A-Za-z]\\)" bullet
)
1496 (replace-match "1" nil nil bullet
))
1497 ;; Not an ordered list: keep bullet.
1499 (mapc fix-bul
(mapcar 'car struct
))))
1501 (defun org-list-struct-fix-ind (struct parents
&optional bullet-size
)
1502 "Verify and correct indentation in STRUCT.
1504 PARENTS is the alist of parents, as returned by
1505 `org-list-parents-alist'.
1507 If numeric optional argument BULLET-SIZE is set, assume all
1508 bullets in list have this length to determine new indentation.
1510 This function modifies STRUCT."
1511 (let* ((ancestor (org-list-get-top-point struct
))
1512 (top-ind (org-list-get-ind ancestor struct
))
1515 (let ((parent (org-list-get-parent item struct parents
)))
1517 ;; Indent like parent + length of parent's bullet
1519 item struct
(+ (or bullet-size
1521 (org-list-get-bullet parent struct
)))
1522 (org-list-get-ind parent struct
)))
1523 ;; If no parent, indent like top-point
1524 (org-list-set-ind item struct top-ind
))))))
1525 (mapc new-ind
(mapcar 'car
(cdr struct
)))))
1527 (defun org-list-struct-fix-box (struct parents prevs
&optional ordered
)
1528 "Verify and correct checkboxes in STRUCT.
1530 PARENTS is the alist of parents and PREVS is the alist of
1531 previous items, as returned by, respectively,
1532 `org-list-parents-alist' and `org-list-prevs-alist'.
1534 If ORDERED is non-nil, a checkbox can only be checked when every
1535 checkbox before it is checked too. If there was an attempt to
1536 break this rule, the function will return the blocking item. In
1537 all others cases, the return value will be nil.
1539 This function modifies STRUCT."
1540 (let ((all-items (mapcar 'car struct
))
1545 (mapcar (lambda (child)
1546 (org-list-get-checkbox child struct
))
1547 (org-list-get-children item struct parents
))))
1548 (org-list-set-checkbox
1551 ((and (member "[ ]" box-list
) (member "[X]" box-list
)) "[-]")
1552 ((member "[-]" box-list
) "[-]")
1553 ((member "[X]" box-list
) "[X]")
1554 ((member "[ ]" box-list
) "[ ]")
1555 ;; parent has no boxed child: leave box as-is
1556 (t (org-list-get-checkbox item struct
))))))))
1558 ;; 1. List all parents with a checkbox
1561 (let* ((parent (org-list-get-parent e struct parents
))
1562 (parent-box-p (org-list-get-checkbox parent struct
)))
1563 (when (and parent-box-p
(not (memq parent parent-list
)))
1564 (push parent parent-list
))))
1566 ;; 2. Sort those parents by decreasing indentation
1567 (setq parent-list
(sort parent-list
1569 (> (org-list-get-ind e1 struct
)
1570 (org-list-get-ind e2 struct
)))))
1571 ;; 3. For each parent, get all children's checkboxes to determine
1572 ;; and set its checkbox accordingly
1573 (mapc set-parent-box parent-list
)
1574 ;; 4. If ORDERED is set, see if we need to uncheck some boxes
1577 (mapcar (lambda (e) (org-list-get-checkbox e struct
)) all-items
))
1578 (after-unchecked (member "[ ]" box-list
)))
1579 ;; there are boxes checked after an unchecked one: fix that
1580 (when (member "[X]" after-unchecked
)
1581 (let ((index (- (length struct
) (length after-unchecked
))))
1582 (mapc (lambda (e) (org-list-set-checkbox e struct
"[ ]"))
1583 (nthcdr index all-items
))
1584 ;; Verify once again the structure, without ORDERED
1585 (org-list-struct-fix-box struct parents prevs nil
)
1586 ;; return blocking item
1587 (nth index all-items
)))))))
1589 (defun org-list-struct-apply-struct (struct old-struct
)
1590 "Apply set-difference between STRUCT and OLD-STRUCT to the buffer.
1592 OLD-STRUCT is the structure before any modifications, and STRUCT
1593 the structure to be applied. The function will only modify parts
1594 of the list which have changed.
1596 Initial position of cursor is restored after the changes."
1597 (let* ((pos (copy-marker (point)))
1598 (inlinetask-re (and (featurep 'org-inlinetask
)
1599 (org-inlinetask-outline-regexp)))
1600 (item-re (org-item-re))
1601 (box-rule-p (cdr (assq 'checkbox org-list-automatic-rules
)))
1604 ;; Shift the indentation between END and BEG by DELTA.
1605 ;; Start from the line before END.
1606 (lambda (end beg delta
)
1608 (skip-chars-backward " \r\t\n")
1610 (while (or (> (point) beg
)
1611 (and (= (point) beg
)
1612 (not (looking-at item-re
))))
1614 ;; Skip inline tasks
1615 ((and inlinetask-re
(looking-at inlinetask-re
))
1616 (org-inlinetask-goto-beginning))
1617 ;; Shift only non-empty lines
1618 ((org-looking-at-p "^[ \t]*\\S-")
1619 (let ((i (org-get-indentation)))
1620 (org-indent-line-to (+ i delta
)))))
1621 (forward-line -
1)))))
1624 ;; Replace ITEM first line elements with new elements from
1625 ;; STRUCT, if appropriate.
1628 (let* ((new-ind (org-list-get-ind item struct
))
1629 (old-ind (org-get-indentation))
1630 (new-bul (org-list-bullet-string
1631 (org-list-get-bullet item struct
)))
1632 (old-bul (org-list-get-bullet item old-struct
))
1633 (new-box (org-list-get-checkbox item struct
)))
1634 (looking-at org-list-full-item-re
)
1635 ;; a. Replace bullet
1636 (unless (equal old-bul new-bul
)
1637 (replace-match new-bul nil nil nil
1))
1638 ;; b. Replace checkbox
1640 ((and new-box box-rule-p
1641 (save-match-data (org-at-item-description-p)))
1642 (message "Cannot add a checkbox to a description list item"))
1643 ((equal (match-string 3) new-box
))
1644 ((and (match-string 3) new-box
)
1645 (replace-match new-box nil nil nil
3))
1647 (goto-char (or (match-end 2) (match-end 1)))
1648 (looking-at "\\[[ X-]\\][ \t]+")
1650 (t (goto-char (or (match-end 2) (match-end 1)))
1651 (insert (concat new-box
" "))))
1652 ;; c. Indent item to appropriate column
1653 (unless (= new-ind old-ind
)
1654 (delete-region (goto-char (point-at-bol))
1655 (progn (skip-chars-forward " \t") (point)))
1656 (indent-to new-ind
)))))))
1657 ;; 1. First get list of items and position endings. We maintain
1658 ;; two alists: ITM-SHIFT, determining indentation shift needed
1659 ;; at item, and END-POS, a pseudo-alist where key is ending
1660 ;; position and value point
1661 (let (end-list acc-end itm-shift all-ends sliced-struct
)
1663 (let* ((pos (car e
))
1664 (ind-pos (org-list-get-ind pos struct
))
1665 (ind-old (org-list-get-ind pos old-struct
))
1666 (bul-pos (org-list-get-bullet pos struct
))
1667 (bul-old (org-list-get-bullet pos old-struct
))
1668 (ind-shift (- (+ ind-pos
(length bul-pos
))
1669 (+ ind-old
(length bul-old
))))
1670 (end-pos (org-list-get-item-end pos old-struct
)))
1671 (push (cons pos ind-shift
) itm-shift
)
1672 (unless (assq end-pos old-struct
)
1673 ;; To determine real ind of an ending position that is
1674 ;; not at an item, we have to find the item it belongs
1675 ;; to: it is the last item (ITEM-UP), whose ending is
1676 ;; further than the position we're interested in.
1677 (let ((item-up (assoc-default end-pos acc-end
'>)))
1678 (push (cons end-pos item-up
) end-list
)))
1679 (push (cons end-pos pos
) acc-end
)))
1681 ;; 2. Slice the items into parts that should be shifted by the
1682 ;; same amount of indentation. The slices are returned in
1683 ;; reverse order so changes modifying buffer do not change
1684 ;; positions they refer to.
1685 (setq all-ends
(sort (append (mapcar 'car itm-shift
)
1686 (org-uniquify (mapcar 'car end-list
)))
1688 (while (cdr all-ends
)
1689 (let* ((up (pop all-ends
))
1690 (down (car all-ends
))
1691 (ind (if (assq up struct
)
1692 (cdr (assq up itm-shift
))
1693 (cdr (assq (cdr (assq up end-list
)) itm-shift
)))))
1694 (push (list down up ind
) sliced-struct
)))
1695 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1696 ;; end to beginning. Take a special action when beginning is
1699 (unless (zerop (nth 2 e
)) (apply shift-body-ind e
))
1700 (let* ((beg (nth 1 e
))
1701 (cell (assq beg struct
)))
1702 (unless (or (not cell
) (equal cell
(assq beg old-struct
)))
1703 (funcall modify-item beg
))))
1705 ;; 4. Go back to initial position
1708 (defun org-list-write-struct (struct parents
)
1709 "Correct bullets, checkboxes and indentation in list at point.
1710 STRUCT is the list structure. PARENTS is the alist of parents, as
1711 returned by `org-list-parents-alist'."
1712 ;; Order of functions matters here: checkboxes and endings need
1713 ;; correct indentation to be set, and indentation needs correct
1716 ;; 0. Save a copy of structure before modifications
1717 (let ((old-struct (copy-tree struct
)))
1718 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1719 ;; order to get items endings and bullets properly
1720 (org-list-struct-fix-ind struct parents
2)
1721 ;; 2. Get pseudo-alist of ending positions and sort it by position.
1722 ;; Then associate them to the structure.
1723 (let (end-list acc-end
)
1725 (let* ((pos (car e
))
1726 (ind-pos (org-list-get-ind pos struct
))
1727 (end-pos (org-list-get-item-end pos struct
)))
1728 (unless (assq end-pos struct
)
1729 ;; To determine real ind of an ending position that is
1730 ;; not at an item, we have to find the item it belongs
1731 ;; to: it is the last item (ITEM-UP), whose ending is
1732 ;; further than the position we're interested in.
1733 (let ((item-up (assoc-default end-pos acc-end
'>)))
1735 ;; Else part is for the bottom point
1736 (if item-up
(+ (org-list-get-ind item-up struct
) 2) 0)
1739 (push (cons ind-pos pos
) end-list
)
1740 (push (cons end-pos pos
) acc-end
)))
1742 (setq end-list
(sort end-list
(lambda (e1 e2
) (< (cdr e1
) (cdr e2
)))))
1743 (org-list-struct-assoc-end struct end-list
))
1744 ;; 3. Get bullets right
1745 (let ((prevs (org-list-prevs-alist struct
)))
1746 (org-list-struct-fix-bul struct prevs
)
1747 ;; 4. Now get real indentation
1748 (org-list-struct-fix-ind struct parents
)
1749 ;; 5. Eventually fix checkboxes
1750 (org-list-struct-fix-box struct parents prevs
))
1751 ;; 6. Apply structure modifications to buffer
1752 (org-list-struct-apply-struct struct old-struct
)))
1757 (defun org-apply-on-list (function init-value
&rest args
)
1758 "Call FUNCTION on each item of the list at point.
1759 FUNCTION must be called with at least one argument: INIT-VALUE,
1760 that will contain the value returned by the function at the
1761 previous item, plus ARGS extra arguments.
1763 FUNCTION is applied on items in reverse order.
1765 As an example, \(org-apply-on-list \(lambda \(result\) \(1+ result\)\) 0\)
1766 will return the number of items in the current list.
1768 Sublists of the list are skipped. Cursor is always at the
1769 beginning of the item."
1770 (let* ((struct (org-list-struct))
1771 (prevs (org-list-prevs-alist struct
))
1772 (item (copy-marker (point-at-bol)))
1773 (all (org-list-get-all-items (marker-position item
) struct prevs
))
1777 (setq value
(apply function value args
)))
1782 (defun org-list-set-item-visibility (item struct view
)
1783 "Set visibility of ITEM in STRUCT to VIEW.
1785 Possible values are: `folded', `children' or `subtree'. See
1786 `org-cycle' for more information."
1789 (let ((item-end (org-list-get-item-end-before-blank item struct
)))
1791 (outline-flag-region (save-excursion (goto-char item
) (point-at-eol))
1793 ((eq view
'children
)
1794 ;; First show everything.
1795 (org-list-set-item-visibility item struct
'subtree
)
1796 ;; Then fold every child.
1797 (let* ((parents (org-list-parents-alist struct
))
1798 (children (org-list-get-children item struct parents
)))
1800 (org-list-set-item-visibility e struct
'folded
))
1804 (let ((item-end (org-list-get-item-end item struct
)))
1805 (outline-flag-region item item-end nil
)))))
1807 (defun org-list-item-body-column (item)
1808 "Return column at which body of ITEM should start."
1809 (let (bpos bcol tpos tcol
)
1812 (looking-at "[ \t]*\\(\\S-+\\)\\(.*[ \t]+::\\)?[ \t]+")
1813 (setq bpos
(match-beginning 1) tpos
(match-end 0)
1814 bcol
(progn (goto-char bpos
) (current-column))
1815 tcol
(progn (goto-char tpos
) (current-column)))
1816 (when (> tcol
(+ bcol org-description-max-indent
))
1817 (setq tcol
(+ bcol
5))))
1821 ;;; Interactive functions
1823 (defalias 'org-list-get-item-begin
'org-in-item-p
)
1825 (defun org-beginning-of-item ()
1826 "Go to the beginning of the current item.
1827 Throw an error when not in a list."
1829 (let ((begin (org-in-item-p)))
1830 (if begin
(goto-char begin
) (error "Not in an item"))))
1832 (defun org-beginning-of-item-list ()
1833 "Go to the beginning item of the current list or sublist.
1834 Throw an error when not in a list."
1836 (let ((begin (org-in-item-p)))
1838 (error "Not in an item")
1840 (let* ((struct (org-list-struct))
1841 (prevs (org-list-prevs-alist struct
)))
1842 (goto-char (org-list-get-list-begin begin struct prevs
))))))
1844 (defun org-end-of-item-list ()
1845 "Go to the end of the current list or sublist.
1846 Throw an error when not in a list."
1848 (let ((begin (org-in-item-p)))
1850 (error "Not in an item")
1852 (let* ((struct (org-list-struct))
1853 (prevs (org-list-prevs-alist struct
)))
1854 (goto-char (org-list-get-list-end begin struct prevs
))))))
1856 (defun org-end-of-item ()
1857 "Go to the end of the current item.
1858 Throw an error when not in a list."
1860 (let ((begin (org-in-item-p)))
1862 (error "Not in an item")
1864 (let ((struct (org-list-struct)))
1865 (goto-char (org-list-get-item-end begin struct
))))))
1867 (defun org-previous-item ()
1868 "Move to the beginning of the previous item.
1869 Throw an error when not in a list, or at first item."
1871 (let ((begin (org-in-item-p)))
1873 (error "Not in an item")
1875 (let* ((struct (org-list-struct))
1876 (prevs (org-list-prevs-alist struct
))
1877 (prevp (org-list-get-prev-item begin struct prevs
)))
1878 (if prevp
(goto-char prevp
) (error "On first item"))))))
1880 (defun org-next-item ()
1881 "Move to the beginning of the next item.
1882 Throw an error when not in a plain list, or at last item."
1884 (let ((begin (org-in-item-p)))
1886 (error "Not in an item")
1888 (let* ((struct (org-list-struct))
1889 (prevs (org-list-prevs-alist struct
))
1890 (prevp (org-list-get-next-item begin struct prevs
)))
1891 (if prevp
(goto-char prevp
) (error "On last item"))))))
1893 (defun org-move-item-down ()
1894 "Move the item at point down, i.e. swap with following item.
1895 Subitems (items with larger indentation) are considered part of
1896 the item, so this really moves item trees."
1898 (unless (org-at-item-p) (error "Not at an item"))
1899 (let* ((pos (point))
1900 (col (current-column))
1901 (actual-item (point-at-bol))
1902 (struct (org-list-struct))
1903 (prevs (org-list-prevs-alist struct
))
1904 (next-item (org-list-get-next-item (point-at-bol) struct prevs
)))
1908 (error "Cannot move this item further down"))
1910 (org-list-exchange-items actual-item next-item struct
))
1911 ;; Use a short variation of `org-list-write-struct' as there's
1912 ;; no need to go through all the steps.
1913 (let ((old-struct (copy-tree struct
))
1914 (prevs (org-list-prevs-alist struct
))
1915 (parents (org-list-parents-alist struct
)))
1916 (org-list-struct-fix-bul struct prevs
)
1917 (org-list-struct-fix-ind struct parents
)
1918 (org-list-struct-apply-struct struct old-struct
)
1919 (goto-char (org-list-get-next-item (point-at-bol) struct prevs
)))
1920 (org-move-to-column col
))))
1922 (defun org-move-item-up ()
1923 "Move the item at point up, i.e. swap with previous item.
1924 Subitems (items with larger indentation) are considered part of
1925 the item, so this really moves item trees."
1927 (unless (org-at-item-p) (error "Not at an item"))
1928 (let* ((pos (point))
1929 (col (current-column))
1930 (actual-item (point-at-bol))
1931 (struct (org-list-struct))
1932 (prevs (org-list-prevs-alist struct
))
1933 (prev-item (org-list-get-prev-item (point-at-bol) struct prevs
)))
1937 (error "Cannot move this item further up"))
1939 (org-list-exchange-items prev-item actual-item struct
))
1940 ;; Use a short variation of `org-list-write-struct' as there's
1941 ;; no need to go through all the steps.
1942 (let ((old-struct (copy-tree struct
))
1943 (prevs (org-list-prevs-alist struct
))
1944 (parents (org-list-parents-alist struct
)))
1945 (org-list-struct-fix-bul struct prevs
)
1946 (org-list-struct-fix-ind struct parents
)
1947 (org-list-struct-apply-struct struct old-struct
))
1948 (org-move-to-column col
))))
1950 (defun org-insert-item (&optional checkbox
)
1951 "Insert a new item at the current level.
1952 If cursor is before first character after bullet of the item, the
1953 new item will be created before the current one.
1955 If CHECKBOX is non-nil, add a checkbox next to the bullet.
1957 Return t when things worked, nil when we are not in an item, or
1959 (let ((itemp (org-in-item-p))
1961 ;; If cursor isn't is a list or if list is invisible, return nil.
1962 (unless (or (not itemp
)
1965 (outline-invisible-p)))
1968 (org-at-item-timer-p))
1969 ;; Timer list: delegate to `org-timer-item'.
1970 (progn (org-timer-item) t
)
1972 (let* ((struct (org-list-struct))
1973 (prevs (org-list-prevs-alist struct
))
1974 ;; If we're in a description list, ask for the new term.
1975 (desc (when (org-list-get-tag itemp struct
)
1976 (concat (read-string "Term: ") " :: ")))
1977 ;; Don't insert a checkbox if checkbox rule is applied
1978 ;; and it is a description item.
1979 (checkp (and checkbox
1981 (not (cdr (assq 'checkbox
1982 org-list-automatic-rules
)))))))
1984 (org-list-insert-item pos struct prevs checkp desc
))
1985 (org-list-write-struct struct
(org-list-parents-alist struct
))
1986 (when checkp
(org-update-checkbox-count-maybe))
1987 (looking-at org-list-full-item-re
)
1988 (goto-char (match-end 0))
1991 (defun org-list-repair ()
1992 "Fix indentation, bullets and checkboxes is the list at point."
1994 (unless (org-at-item-p) (error "This is not a list"))
1995 (let* ((struct (org-list-struct))
1996 (parents (org-list-parents-alist struct
)))
1997 (org-list-write-struct struct parents
)))
1999 (defun org-cycle-list-bullet (&optional which
)
2000 "Cycle through the different itemize/enumerate bullets.
2001 This cycle the entire list level through the sequence:
2003 `-' -> `+' -> `*' -> `1.' -> `1)'
2005 If WHICH is a valid string, use that as the new bullet. If WHICH
2006 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2007 `previous', cycle backwards."
2009 (unless (org-at-item-p) (error "Not at an item"))
2012 (let* ((struct (org-list-struct))
2013 (parents (org-list-parents-alist struct
))
2014 (prevs (org-list-prevs-alist struct
))
2015 (list-beg (org-list-get-first-item (point) struct prevs
))
2016 (bullet (org-list-get-bullet list-beg struct
))
2017 (bullet-rule-p (cdr (assq 'bullet org-list-automatic-rules
)))
2018 (alpha-p (org-list-use-alpha-bul-p list-beg struct prevs
))
2019 (case-fold-search nil
)
2021 ((string-match "[a-z]\\." bullet
) "a.")
2022 ((string-match "[a-z])" bullet
) "a)")
2023 ((string-match "[A-Z]\\." bullet
) "A.")
2024 ((string-match "[A-Z])" bullet
) "A)")
2025 ((string-match "\\." bullet
) "1.")
2026 ((string-match ")" bullet
) "1)")
2027 (t (org-trim bullet
))))
2028 ;; Compute list of possible bullets, depending on context
2031 ;; *-bullets are not allowed at column 0
2032 (unless (and bullet-rule-p
2033 (looking-at "\\S-")) '("*"))
2034 ;; Description items cannot be numbered
2035 (unless (or (eq org-plain-list-ordered-item-terminator ?\
))
2036 (and bullet-rule-p
(org-at-item-description-p)))
2038 (unless (or (eq org-plain-list-ordered-item-terminator ?.
)
2039 (and bullet-rule-p
(org-at-item-description-p)))
2041 (unless (or (not alpha-p
)
2042 (eq org-plain-list-ordered-item-terminator ?\
))
2043 (and bullet-rule-p
(org-at-item-description-p)))
2045 (unless (or (not alpha-p
)
2046 (eq org-plain-list-ordered-item-terminator ?.
)
2047 (and bullet-rule-p
(org-at-item-description-p)))
2049 (len (length bullet-list
))
2050 (item-index (- len
(length (member current bullet-list
))))
2051 (get-value (lambda (index) (nth (mod index len
) bullet-list
)))
2053 ((member which bullet-list
) which
)
2054 ((numberp which
) (funcall get-value which
))
2055 ((eq 'previous which
) (funcall get-value
(1- item-index
)))
2056 (t (funcall get-value
(1+ item-index
))))))
2057 ;; Use a short variation of `org-list-write-struct' as there's
2058 ;; no need to go through all the steps.
2059 (let ((old-struct (copy-tree struct
)))
2060 (org-list-set-bullet list-beg struct
(org-list-bullet-string new
))
2061 (org-list-struct-fix-bul struct prevs
)
2062 (org-list-struct-fix-ind struct parents
)
2063 (org-list-struct-apply-struct struct old-struct
)))))
2065 (defun org-toggle-checkbox (&optional toggle-presence
)
2066 "Toggle the checkbox in the current line.
2067 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2068 double prefix, set checkbox to [-].
2070 When there is an active region, toggle status or presence of the
2071 first checkbox there, and make every item inside have the same
2072 status or presence, respectively.
2074 If the cursor is in a headline, apply this to all checkbox items
2075 in the text below the heading, taking as reference the first item
2076 in subtree, ignoring drawers."
2083 (drawer-re (concat "^[ \t]*:\\("
2084 (mapconcat 'regexp-quote org-drawers
"\\|")
2086 (keyword-re (concat "^[ \t]*\\<\\(" org-scheduled-string
2087 "\\|" org-deadline-string
2088 "\\|" org-closed-string
2089 "\\|" org-clock-string
"\\)"
2090 " *[[<]\\([^]>]+\\)[]>]"))
2091 (orderedp (org-entry-get nil
"ORDERED"))
2093 ;; In a region, start at first item in region
2095 ((org-region-active-p)
2096 (let ((limit (region-end)))
2097 (goto-char (region-beginning))
2098 (if (org-list-search-forward (org-item-beginning-re) limit t
)
2099 (setq lim-up
(point-at-bol))
2100 (error "No item in region"))
2101 (setq lim-down
(copy-marker limit
))))
2103 ;; On an heading, start at first item after drawers and
2104 ;; time-stamps (scheduled, etc.)
2105 (let ((limit (save-excursion (outline-next-heading) (point))))
2107 (while (or (looking-at drawer-re
) (looking-at keyword-re
))
2108 (if (looking-at keyword-re
)
2110 (re-search-forward "^[ \t]*:END:" limit nil
)))
2111 (if (org-list-search-forward (org-item-beginning-re) limit t
)
2112 (setq lim-up
(point-at-bol))
2113 (error "No item in subtree"))
2114 (setq lim-down
(copy-marker limit
))))
2115 ;; Just one item: set singlep flag
2118 (setq lim-up
(point-at-bol)
2119 lim-down
(point-at-eol)))
2120 (t (error "Not at an item or heading, and no active region"))))
2121 ;; Determine the checkbox going to be applied to all items
2126 (let ((cbox (and (org-at-item-checkbox-p) (match-string 1))))
2128 ((equal toggle-presence
'(16)) "[-]")
2129 ((equal toggle-presence
'(4))
2130 (unless cbox
"[ ]"))
2131 ((equal "[X]" cbox
) "[ ]")
2133 ;; When an item is found within bounds, grab the full list at
2134 ;; point structure, then: 1. set checkbox of all its items
2135 ;; within bounds to ref-checkbox; 2. fix checkboxes of the whole
2136 ;; list; 3. move point after the list.
2138 (while (and (< (point) lim-down
)
2139 (org-list-search-forward (org-item-beginning-re)
2141 (let* ((struct (org-list-struct))
2142 (struct-copy (copy-tree struct
))
2143 (parents (org-list-parents-alist struct
))
2144 (prevs (org-list-prevs-alist struct
))
2145 (bottom (copy-marker (org-list-get-bottom-point struct
)))
2146 (items-to-toggle (org-remove-if
2147 (lambda (e) (or (< e lim-up
) (> e lim-down
)))
2148 (mapcar 'car struct
))))
2149 (mapc (lambda (e) (org-list-set-checkbox
2151 ;; if there is no box at item, leave as-is
2152 ;; unless function was called with C-u prefix
2153 (let ((cur-box (org-list-get-checkbox e struct
)))
2154 (if (or cur-box
(equal toggle-presence
'(4)))
2158 (setq block-item
(org-list-struct-fix-box
2159 struct parents prevs orderedp
))
2160 ;; Report some problems due to ORDERED status of subtree. If
2161 ;; only one box was being checked, throw an error, else,
2162 ;; only signal problems.
2164 ((and singlep block-item
(> lim-up block-item
))
2166 "Checkbox blocked because of unchecked box at line %d"
2167 (org-current-line block-item
)))
2170 "Checkboxes were removed due to unchecked box at line %d"
2171 (org-current-line block-item
))))
2173 (org-list-struct-apply-struct struct struct-copy
)))))
2174 (org-update-checkbox-count-maybe))
2176 (defun org-reset-checkbox-state-subtree ()
2177 "Reset all checkboxes in an entry subtree."
2181 (org-narrow-to-subtree)
2183 (goto-char (point-min))
2184 (let ((end (point-max)))
2185 (while (< (point) end
)
2186 (when (org-at-item-checkbox-p)
2187 (replace-match "[ ]" t t nil
1))
2188 (beginning-of-line 2))))
2189 (org-update-checkbox-count-maybe)))
2191 (defun org-update-checkbox-count (&optional all
)
2192 "Update the checkbox statistics in the current section.
2193 This will find all statistic cookies like [57%] and [6/12] and
2194 update them with the current numbers.
2196 With optional prefix argument ALL, do this for the whole buffer."
2199 (let ((cookie-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
2200 (box-re "^[ \t]*\\([-+*]\\|\\([0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2202 (or (not org-hierarchical-checkbox-statistics
)
2203 (string-match "\\<recursive\\>"
2204 (or (org-entry-get nil
"COOKIE_DATA") ""))))
2206 (cons (point-min) (point-max))
2207 (cons (or (ignore-errors (org-back-to-heading t
) (point))
2209 (save-excursion (outline-next-heading) (point)))))
2212 ;; Return number of checked boxes and boxes of all types
2213 ;; in all structures in STRUCTS. If RECURSIVEP is non-nil,
2214 ;; also count boxes in sub-lists. If ITEM is nil, count
2215 ;; across the whole structure, else count only across
2216 ;; subtree whose ancestor is ITEM.
2217 (lambda (item structs recursivep
)
2218 (let ((c-on 0) (c-all 0))
2221 (let* ((pre (org-list-prevs-alist s
))
2222 (par (org-list-parents-alist s
))
2225 ((and recursivep item
) (org-list-get-subtree item s
))
2226 (recursivep (mapcar 'car s
))
2227 (item (org-list-get-children item s par
))
2228 (t (org-list-get-all-items
2229 (org-list-get-top-point s
) s pre
))))
2230 (cookies (delq nil
(mapcar
2232 (org-list-get-checkbox e s
))
2234 (setq c-all
(+ (length cookies
) c-all
)
2235 c-on
(+ (org-count "[X]" cookies
) c-on
))))
2237 (cons c-on c-all
)))))
2239 cookies-list structs-bak box-num
)
2240 (goto-char (car bounds
))
2241 ;; 1. Build an alist for each cookie found within BOUNDS. The
2242 ;; key will be position at beginning of cookie and values
2243 ;; ending position, format of cookie, and a cell whose car is
2244 ;; number of checked boxes to report, and cdr total number of
2246 (while (re-search-forward cookie-re
(cdr bounds
) t
)
2251 (match-beginning 1) ; cookie start
2252 (match-end 1) ; cookie end
2253 (match-string 2) ; percent?
2255 ;; Cookie is at an heading, but specifically for todo,
2256 ;; not for checkboxes: skip it.
2257 ((and (org-on-heading-p)
2258 (string-match "\\<todo\\>"
2260 (or (org-entry-get nil
"COOKIE_DATA") ""))))
2262 ;; Cookie is at an heading, but all lists before next
2263 ;; heading already have been read. Use data collected
2264 ;; in STRUCTS-BAK. This should only happen when heading
2265 ;; has more than one cookie on it.
2266 ((and (org-on-heading-p)
2267 (<= (save-excursion (outline-next-heading) (point))
2269 (funcall count-boxes nil structs-bak recursivep
))
2270 ;; Cookie is at a fresh heading. Grab structure of
2271 ;; every list containing a checkbox between point and
2272 ;; next headline, and save them in STRUCTS-BAK.
2274 (setq backup-end
(save-excursion
2275 (outline-next-heading) (point)))
2276 (while (org-list-search-forward box-re backup-end
'move
)
2277 (let* ((struct (org-list-struct))
2278 (bottom (org-list-get-bottom-point struct
)))
2279 (push struct structs-bak
)
2280 (goto-char bottom
)))
2281 (funcall count-boxes nil structs-bak recursivep
))
2282 ;; Cookie is at an item, and we already have list
2283 ;; structure stored in STRUCTS-BAK.
2284 ((and (org-at-item-p)
2285 (< (point-at-bol) backup-end
)
2286 ;; Only lists in no special context are stored.
2287 (not (nth 2 (org-list-context))))
2288 (funcall count-boxes
(point-at-bol) structs-bak recursivep
))
2289 ;; Cookie is at an item, but we need to compute list
2292 (let ((struct (org-list-struct)))
2293 (setq backup-end
(org-list-get-bottom-point struct
)
2294 structs-bak
(list struct
)))
2295 (funcall count-boxes
(point-at-bol) structs-bak recursivep
))
2296 ;; Else, cookie found is at a wrong place. Skip it.
2297 (t (throw 'skip nil
))))
2299 ;; 2. Apply alist to buffer, in reverse order so positions stay
2300 ;; unchanged after cookie modifications.
2301 (mapc (lambda (cookie)
2302 (let* ((beg (car cookie
))
2303 (end (nth 1 cookie
))
2304 (percentp (nth 2 cookie
))
2305 (checked (car (nth 3 cookie
)))
2306 (total (cdr (nth 3 cookie
)))
2308 (format "[%d%%]" (/ (* 100 checked
)
2310 (format "[%d/%d]" checked total
))))
2313 (delete-region (point) (+ (point) (- end beg
)))
2314 (when org-auto-align-tags
(org-fix-tags-on-the-fly))))
2317 (defun org-get-checkbox-statistics-face ()
2318 "Select the face for checkbox statistics.
2319 The face will be `org-done' when all relevant boxes are checked.
2320 Otherwise it will be `org-todo'."
2322 (if (equal (match-string 1) "100%")
2323 'org-checkbox-statistics-done
2324 'org-checkbox-statistics-todo
)
2325 (if (and (> (match-end 2) (match-beginning 2))
2326 (equal (match-string 2) (match-string 3)))
2327 'org-checkbox-statistics-done
2328 'org-checkbox-statistics-todo
)))
2330 (defun org-update-checkbox-count-maybe ()
2331 "Update checkbox statistics unless turned off by user."
2332 (when (cdr (assq 'checkbox org-list-automatic-rules
))
2333 (org-update-checkbox-count))
2334 (run-hooks 'org-checkbox-statistics-hook
))
2336 (defvar org-last-indent-begin-marker
(make-marker))
2337 (defvar org-last-indent-end-marker
(make-marker))
2338 (defun org-list-indent-item-generic (arg no-subtree struct
)
2339 "Indent a local list item including its children.
2340 When number ARG is a negative, item will be outdented, otherwise
2341 it will be indented.
2343 If a region is active, all items inside will be moved.
2345 If NO-SUBTREE is non-nil, only indent the item itself, not its
2348 STRUCT is the list structure.
2350 Return t if successful."
2353 (let* ((regionp (org-region-active-p))
2354 (rbeg (and regionp
(region-beginning)))
2355 (rend (and regionp
(region-end)))
2356 (top (org-list-get-top-point struct
))
2357 (parents (org-list-parents-alist struct
))
2358 (prevs (org-list-prevs-alist struct
))
2359 ;; Are we going to move the whole list?
2361 (and (= top
(point))
2362 (cdr (assq 'indent org-list-automatic-rules
))
2365 "First item of list cannot move without its subtree")
2367 ;; Determine begin and end points of zone to indent. If moving
2368 ;; more than one item, save them for subsequent moves.
2369 (unless (and (memq last-command
'(org-shiftmetaright org-shiftmetaleft
))
2370 (memq this-command
'(org-shiftmetaright org-shiftmetaleft
)))
2373 (set-marker org-last-indent-begin-marker rbeg
)
2374 (set-marker org-last-indent-end-marker rend
))
2375 (set-marker org-last-indent-begin-marker
(point))
2376 (set-marker org-last-indent-end-marker
2378 (specialp (org-list-get-bottom-point struct
))
2379 (no-subtree (1+ (point)))
2380 (t (org-list-get-item-end (point) struct
))))))
2381 (let* ((beg (marker-position org-last-indent-begin-marker
))
2382 (end (marker-position org-last-indent-end-marker
)))
2384 ;; Special case: moving top-item with indent rule
2386 (let* ((level-skip (org-level-increment))
2387 (offset (if (< arg
0) (- level-skip
) level-skip
))
2388 (top-ind (org-list-get-ind beg struct
))
2389 (old-struct (copy-tree struct
)))
2390 (if (< (+ top-ind offset
) 0)
2391 (error "Cannot outdent beyond margin")
2392 ;; Change bullet if necessary
2393 (when (and (= (+ top-ind offset
) 0)
2395 (org-list-get-bullet beg struct
)))
2396 (org-list-set-bullet beg struct
2397 (org-list-bullet-string "-")))
2398 ;; Shift every item by OFFSET and fix bullets. Then
2399 ;; apply changes to buffer.
2401 (let ((ind (org-list-get-ind (car e
) struct
)))
2402 (org-list-set-ind (car e
) struct
(+ ind offset
))))
2404 (org-list-struct-fix-bul struct prevs
)
2405 (org-list-struct-apply-struct struct old-struct
))))
2408 ;; If only one item is moved, it mustn't have a child
2411 (org-list-has-child-p beg struct
))
2412 ;; If a subtree or region is moved, the last item
2413 ;; of the subtree mustn't have a child
2414 (let ((last-item (caar
2417 (lambda (e) (>= (car e
) end
))
2419 (org-list-has-child-p last-item struct
))))
2420 (error "Cannot outdent an item without its children"))
2425 (org-list-struct-outdent beg end struct parents
)
2426 (org-list-struct-indent beg end struct parents prevs
))))
2427 (org-list-write-struct struct new-parents
))
2428 (org-update-checkbox-count-maybe))))))
2431 (defun org-outdent-item ()
2432 "Outdent a local list item, but not its children.
2433 If a region is active, all items inside will be moved."
2436 (let ((struct (org-list-struct)))
2437 (org-list-indent-item-generic -
1 t struct
))
2438 (error "Not at an item")))
2440 (defun org-indent-item ()
2441 "Indent a local list item, but not its children.
2442 If a region is active, all items inside will be moved."
2445 (let ((struct (org-list-struct)))
2446 (org-list-indent-item-generic 1 t struct
))
2447 (error "Not at an item")))
2449 (defun org-outdent-item-tree ()
2450 "Outdent a local list item including its children.
2451 If a region is active, all items inside will be moved."
2453 (let ((regionp (org-region-active-p)))
2455 ((or (org-at-item-p)
2456 (and (org-region-active-p)
2457 (goto-char (region-beginning))
2459 (let ((struct (org-list-struct)))
2460 (org-list-indent-item-generic -
1 nil struct
)))
2461 (regionp (error "Region not starting at an item"))
2462 (t (error "Not at an item")))))
2464 (defun org-indent-item-tree ()
2465 "Indent a local list item including its children.
2466 If a region is active, all items inside will be moved."
2468 (let ((regionp (org-region-active-p)))
2470 ((or (org-at-item-p)
2471 (and (org-region-active-p)
2472 (goto-char (region-beginning))
2474 (let ((struct (org-list-struct)))
2475 (org-list-indent-item-generic 1 nil struct
)))
2476 (regionp (error "Region not starting at an item"))
2477 (t (error "Not at an item")))))
2479 (defvar org-tab-ind-state
)
2480 (defun org-cycle-item-indentation ()
2481 "Cycle levels of indentation of an empty item.
2482 The first run indents the item, if applicable. Subsequents runs
2483 outdent it at meaningful levels in the list. When done, item is
2484 put back at its original position with its original bullet.
2486 Return t at each successful move."
2487 (when (org-at-item-p)
2488 (let* ((org-adapt-indentation nil
)
2489 (struct (org-list-struct))
2490 (ind (org-list-get-ind (point-at-bol) struct
))
2491 (bullet (org-list-get-bullet (point-at-bol) struct
)))
2492 ;; Accept empty items or if cycle has already started.
2493 (when (or (eq last-command
'org-cycle-item-indentation
)
2494 (and (save-excursion
2496 (looking-at org-list-full-item-re
))
2497 (>= (match-end 0) (save-excursion
2498 (goto-char (org-list-get-item-end
2499 (point-at-bol) struct
))
2500 (skip-chars-backward " \r\t\n")
2502 (setq this-command
'org-cycle-item-indentation
)
2503 ;; When in the middle of the cycle, try to outdent first. If it
2504 ;; fails, and point is still at initial position, indent. Else,
2505 ;; go back to original position.
2506 (if (eq last-command
'org-cycle-item-indentation
)
2508 ((ignore-errors (org-list-indent-item-generic -
1 t struct
)))
2509 ((and (= ind
(car org-tab-ind-state
))
2510 (ignore-errors (org-list-indent-item-generic 1 t struct
))))
2511 (t (delete-region (point-at-bol) (point-at-eol))
2512 (org-indent-to-column (car org-tab-ind-state
))
2513 (insert (cdr org-tab-ind-state
))
2515 (setq this-command
'identity
)))
2516 ;; If a cycle is starting, remember indentation and bullet,
2517 ;; then try to indent. If it fails, try to outdent.
2518 (setq org-tab-ind-state
(cons ind bullet
))
2520 ((ignore-errors (org-list-indent-item-generic 1 t struct
)))
2521 ((ignore-errors (org-list-indent-item-generic -
1 t struct
)))
2522 (t (error "Cannot move item"))))
2525 (defun org-sort-list (&optional with-case sorting-type getkey-func compare-func
)
2527 The cursor may be at any item of the list that should be sorted.
2528 Sublists are not sorted. Checkboxes, if any, are ignored.
2530 Sorting can be alphabetically, numerically, by date/time as given by
2531 a time stamp, by a property or by priority.
2533 Comparing entries ignores case by default. However, with an
2534 optional argument WITH-CASE, the sorting considers case as well.
2536 The command prompts for the sorting type unless it has been given
2537 to the function through the SORTING-TYPE argument, which needs to
2538 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
2539 meaning of each character:
2541 n Numerically, by converting the beginning of the item to a number.
2542 a Alphabetically. Only the first line of item is checked.
2543 t By date/time, either the first active time stamp in the entry, if
2544 any, or by the first inactive one. In a timer list, sort the timers.
2546 Capital letters will reverse the sort order.
2548 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a
2549 function to be called with point at the beginning of the record.
2550 It must return either a string or a number that should serve as
2551 the sorting key for that record. It will then use COMPARE-FUNC to
2554 (let* ((case-func (if with-case
'identity
'downcase
))
2555 (struct (org-list-struct))
2556 (prevs (org-list-prevs-alist struct
))
2557 (start (org-list-get-list-begin (point-at-bol) struct prevs
))
2558 (end (org-list-get-list-end (point-at-bol) struct prevs
))
2562 "Sort plain list: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:")
2563 (read-char-exclusive)))
2564 (getkey-func (and (= (downcase sorting-type
) ?f
)
2565 (intern (org-icompleting-read "Sort using function: "
2566 obarray
'fboundp t nil nil
)))))
2567 (message "Sorting items...")
2569 (narrow-to-region start end
)
2570 (goto-char (point-min))
2571 (let* ((dcst (downcase sorting-type
))
2572 (case-fold-search nil
)
2573 (now (current-time))
2575 ((= dcst ?a
) 'string
<)
2576 ((= dcst ?f
) compare-func
)
2579 (next-record (lambda ()
2580 (skip-chars-forward " \r\t\n")
2581 (beginning-of-line)))
2582 (end-record (lambda ()
2583 (goto-char (org-list-get-item-end-before-blank
2587 (when (looking-at "[ \t]*[-+*0-9.)]+\\([ \t]+\\[[- X]\\]\\)?[ \t]+")
2590 (string-to-number (buffer-substring (match-end 0)
2594 (buffer-substring (match-end 0) (point-at-eol))))
2597 ;; If it is a timer list, convert timer to seconds
2598 ((org-at-item-timer-p)
2599 (org-timer-hms-to-secs (match-string 1)))
2600 ((or (re-search-forward org-ts-regexp
(point-at-eol) t
)
2601 (re-search-forward org-ts-regexp-both
2603 (org-time-string-to-seconds (match-string 0)))
2604 (t (org-float-time now
))))
2607 (let ((value (funcall getkey-func
)))
2609 (funcall case-func value
)
2611 (error "Invalid key function `%s'" getkey-func
)))
2612 (t (error "Invalid sorting type `%c'" sorting-type
)))))))
2613 (sort-subr (/= dcst sorting-type
)
2619 ;; Read and fix list again, as `sort-subr' probably destroyed
2622 (run-hooks 'org-after-sorting-entries-or-items-hook
)
2623 (message "Sorting items...done")))))
2626 ;;; Send and receive lists
2628 (defun org-list-parse-list (&optional delete
)
2629 "Parse the list at point and maybe DELETE it.
2631 Return a list whose car is a symbol of list type, among
2632 `ordered', `unordered' and `descriptive'. Then, each item is a
2633 list whose car is counter, and cdr are strings and other
2634 sub-lists. Inside strings, checkboxes are replaced by \"[CBON]\"
2637 For example, the following list:
2642 more text in first item
2648 \(nil \"first item\"
2650 \(nil \"sub-item one\"\)
2651 \(nil \"[CBON] sub-item two\"\)\)
2652 \"more text in first item\"\)
2653 \(3 \"last item\"\)\)
2655 Point is left at list end."
2656 (let* ((struct (org-list-struct))
2657 (prevs (org-list-prevs-alist struct
))
2658 (parents (org-list-parents-alist struct
))
2659 (top (org-list-get-top-point struct
))
2660 (bottom (org-list-get-bottom-point struct
))
2662 parse-item
; for byte-compiler
2665 ;; Return text between BEG and END, trimmed, with
2666 ;; checkboxes replaced.
2668 (let ((text (org-trim (buffer-substring beg end
))))
2669 (if (string-match "\\`\\[\\([X ]\\)\\]" text
)
2671 (if (equal (match-string 1 text
) " ") "CBOFF" "CBON")
2676 ;; Return a list whose car is list type and cdr a list of
2679 (cons (org-list-get-list-type (car e
) struct prevs
)
2680 (mapcar parse-item e
)))))
2683 ;; Return a list containing counter of item, if any, text
2684 ;; and any sublist inside it.
2686 (let ((start (save-excursion
2688 (looking-at "[ \t]*\\S-+\\([ \t]+\\[@\\(start:\\)?\\([0-9]+\\|[a-zA-Z]\\)\\]\\)?[ \t]*")
2690 ;; Get counter number. For alphabetic counter, get
2691 ;; its position in the alphabet.
2692 (counter (let ((c (org-list-get-counter e struct
)))
2695 ((string-match "[A-Za-z]" c
)
2696 (- (string-to-char (upcase (match-string 0 c
)))
2698 ((string-match "[0-9]+" c
)
2699 (string-to-number (match-string 0 c
))))))
2700 (childp (org-list-has-child-p e struct
))
2701 (end (org-list-get-item-end e struct
)))
2702 ;; If item has a child, store text between bullet and
2703 ;; next child, then recursively parse all sublists. At
2704 ;; the end of each sublist, check for the presence of
2705 ;; text belonging to the original item.
2707 (let* ((children (org-list-get-children e struct parents
))
2708 (body (list (funcall get-text start childp
))))
2710 (let* ((first (car children
))
2711 (sub (org-list-get-all-items first struct prevs
))
2712 (last-c (car (last sub
)))
2713 (last-end (org-list-get-item-end last-c struct
)))
2714 (push (funcall parse-sublist sub
) body
)
2715 ;; Remove children from the list just parsed.
2716 (setq children
(cdr (member last-c children
)))
2717 ;; There is a chunk of text belonging to the
2718 ;; item if last child doesn't end where next
2719 ;; child starts or where item ends.
2720 (unless (= (or (car children
) end
) last-end
)
2721 (push (funcall get-text
2722 last-end
(or (car children
) end
))
2724 (cons counter
(nreverse body
)))
2725 (list counter
(funcall get-text start end
))))))))
2726 ;; Store output, take care of cursor position and deletion of
2727 ;; list, then return output.
2728 (setq out
(funcall parse-sublist
(org-list-get-all-items top struct prevs
)))
2731 (delete-region top bottom
)
2732 (when (and (not (eq org-list-ending-method
'indent
))
2733 (looking-at org-list-end-re
))
2734 (replace-match "\n")))
2737 (defun org-list-make-subtree ()
2738 "Convert the plain list at point into a subtree."
2740 (if (not (ignore-errors (goto-char (org-in-item-p))))
2741 (error "Not in a list")
2742 (let ((list (save-excursion (org-list-parse-list t
))))
2743 (insert (org-list-to-subtree list
)))))
2745 (defun org-list-insert-radio-list ()
2746 "Insert a radio list template appropriate for this major mode."
2748 (let* ((e (assq major-mode org-list-radio-list-templates
))
2751 (unless e
(error "No radio list setup defined for %s" major-mode
))
2752 (setq name
(read-string "List name: "))
2753 (while (string-match "%n" txt
)
2754 (setq txt
(replace-match name t t txt
)))
2755 (or (bolp) (insert "\n"))
2760 (defun org-list-send-list (&optional maybe
)
2761 "Send a transformed version of this list to the receiver position.
2762 With argument MAYBE, fail quietly if no transformation is defined for
2766 (unless (org-at-item-p) (error "Not at a list item"))
2768 (re-search-backward "#\\+ORGLST" nil t
)
2769 (unless (looking-at "[ \t]*#\\+ORGLST[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
2772 (error "Don't know how to transform this list"))))
2773 (let* ((name (match-string 1))
2774 (transform (intern (match-string 2)))
2778 "\\(\\\\end{comment}\\|@end ignore\\|-->\\)" nil t
)
2779 (match-beginning 0)))
2782 (re-search-backward "#\\+ORGLST" nil t
)
2783 (re-search-forward (org-item-beginning-re) bottom-point t
)
2784 (match-beginning 0)))
2785 (list (save-restriction
2786 (narrow-to-region top-point bottom-point
)
2787 (org-list-parse-list)))
2789 (unless (fboundp transform
)
2790 (error "No such transformation function %s" transform
))
2791 (let ((txt (funcall transform list
)))
2792 ;; Find the insertion place
2794 (goto-char (point-min))
2795 (unless (re-search-forward
2796 (concat "BEGIN RECEIVE ORGLST +"
2798 "\\([ \t]\\|$\\)") nil t
)
2799 (error "Don't know where to insert translated list"))
2800 (goto-char (match-beginning 0))
2801 (beginning-of-line 2)
2803 (unless (re-search-forward (concat "END RECEIVE ORGLST +" name
) nil t
)
2804 (error "Cannot find end of insertion region"))
2805 (delete-region beg
(point-at-bol))
2808 (message "List converted and installed at receiver location"))))
2810 (defun org-list-to-generic (list params
)
2811 "Convert a LIST parsed through `org-list-parse-list' to other formats.
2812 Valid parameters PARAMS are
2814 :ustart String to start an unordered list
2815 :uend String to end an unordered list
2817 :ostart String to start an ordered list
2818 :oend String to end an ordered list
2820 :dstart String to start a descriptive list
2821 :dend String to end a descriptive list
2822 :dtstart String to start a descriptive term
2823 :dtend String to end a descriptive term
2824 :ddstart String to start a description
2825 :ddend String to end a description
2827 :splice When set to t, return only list body lines, don't wrap
2828 them into :[u/o]start and :[u/o]end. Default is nil.
2830 :istart String to start a list item.
2831 :icount String to start an item with a counter.
2832 :iend String to end a list item
2833 :isep String to separate items
2834 :lsep String to separate sublists
2835 :csep String to separate text from a sub-list
2837 :cboff String to insert for an unchecked checkbox
2838 :cbon String to insert for a checked checkbox
2840 Alternatively, each parameter can also be a form returning a
2841 string. These sexp can use keywords `counter' and `depth',
2842 reprensenting respectively counter associated to the current
2843 item, and depth of the current sub-list, starting at 0.
2844 Obviously, `counter' is only available for parameters applying to
2848 (splicep (plist-get p
:splice
))
2849 (ostart (plist-get p
:ostart
))
2850 (oend (plist-get p
:oend
))
2851 (ustart (plist-get p
:ustart
))
2852 (uend (plist-get p
:uend
))
2853 (dstart (plist-get p
:dstart
))
2854 (dend (plist-get p
:dend
))
2855 (dtstart (plist-get p
:dtstart
))
2856 (dtend (plist-get p
:dtend
))
2857 (ddstart (plist-get p
:ddstart
))
2858 (ddend (plist-get p
:ddend
))
2859 (istart (plist-get p
:istart
))
2860 (icount (plist-get p
:icount
))
2861 (iend (plist-get p
:iend
))
2862 (isep (plist-get p
:isep
))
2863 (lsep (plist-get p
:lsep
))
2864 (csep (plist-get p
:csep
))
2865 (cbon (plist-get p
:cbon
))
2866 (cboff (plist-get p
:cboff
))
2867 export-sublist
; for byte-compiler
2870 ;; Export an item ITEM of type TYPE, at DEPTH. First string
2871 ;; in item is treated in a special way as it can bring
2872 ;; extra information that needs to be processed.
2873 (lambda (item type depth
)
2874 (let* ((counter (pop item
))
2877 ((eq type
'descriptive
)
2878 ;; Stick DTSTART to ISTART by
2879 ;; left-trimming the latter.
2880 (concat (let ((s (eval istart
)))
2881 (or (and (string-match "[ \t\n\r]+\\'" s
)
2882 (replace-match "" t t s
))
2885 ((and counter
(eq type
'ordered
))
2886 (concat (eval icount
) "%s"))
2887 (t (concat (eval istart
) "%s")))
2890 ;; Replace checkbox if any is found.
2892 ((string-match "\\[CBON\\]" first
)
2893 (setq first
(replace-match cbon t t first
)))
2894 ((string-match "\\[CBOFF\\]" first
)
2895 (setq first
(replace-match cboff t t first
)))
2896 ((string-match "\\[-\\]" first
)
2897 (setq first
(replace-match "$\\boxminus$" t t first
))))
2898 ;; Insert descriptive term if TYPE is `descriptive'.
2899 (when (eq type
'descriptive
)
2900 (let* ((complete (string-match "^\\(.*\\)[ \t]+::" first
))
2903 (org-trim (match-string 1 first
)))
2906 (org-trim (substring first
(match-end 0)))
2908 (setq first
(concat (eval dtstart
) term
(eval dtend
)
2909 (eval ddstart
) desc
))))
2912 (mapconcat (lambda (e)
2914 (funcall export-sublist e
(1+ depth
))))
2915 item
(or (eval csep
) "")))))))
2918 ;; Export sublist SUB at DEPTH
2920 (let* ((type (car sub
))
2925 (concat (eval ostart
) "%s" (eval oend
)))
2926 ((eq type
'descriptive
)
2927 (concat (eval dstart
) "%s" (eval dend
)))
2928 (t (concat (eval ustart
) "%s" (eval uend
))))
2930 (format fmt
(mapconcat (lambda (e)
2931 (funcall export-item e type depth
))
2932 items
(or (eval isep
) ""))))))))
2933 (concat (funcall export-sublist list
0) "\n")))
2935 (defun org-list-to-latex (list &optional params
)
2936 "Convert LIST into a LaTeX list.
2937 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2938 with overruling parameters for `org-list-to-generic'."
2939 (org-list-to-generic
2942 '(:splice nil
:ostart
"\\begin{enumerate}\n" :oend
"\\end{enumerate}"
2943 :ustart
"\\begin{itemize}\n" :uend
"\\end{itemize}"
2944 :dstart
"\\begin{description}\n" :dend
"\\end{description}"
2945 :dtstart
"[" :dtend
"] "
2946 :istart
"\\item " :iend
"\n"
2947 :icount
(let ((enum (nth depth
'("i" "ii" "iii" "iv"))))
2949 ;; LaTeX increments counter just before
2950 ;; using it, so set it to the desired
2951 ;; value, minus one.
2952 (format "\\setcounter{enum%s}{%s}\n\\item "
2956 :cbon
"\\texttt{[X]}" :cboff
"\\texttt{[ ]}")
2959 (defun org-list-to-html (list &optional params
)
2960 "Convert LIST into a HTML list.
2961 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2962 with overruling parameters for `org-list-to-generic'."
2963 (org-list-to-generic
2966 '(:splice nil
:ostart
"<ol>\n" :oend
"\n</ol>"
2967 :ustart
"<ul>\n" :uend
"\n</ul>"
2968 :dstart
"<dl>\n" :dend
"\n</dl>"
2969 :dtstart
"<dt>" :dtend
"</dt>\n"
2970 :ddstart
"<dd>" :ddend
"</dd>"
2971 :istart
"<li>" :iend
"</li>"
2972 :icount
(format "<li value=\"%s\">" counter
)
2973 :isep
"\n" :lsep
"\n" :csep
"\n"
2974 :cbon
"<code>[X]</code>" :cboff
"<code>[ ]</code>")
2977 (defun org-list-to-texinfo (list &optional params
)
2978 "Convert LIST into a Texinfo list.
2979 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2980 with overruling parameters for `org-list-to-generic'."
2981 (org-list-to-generic
2984 '(:splice nil
:ostart
"@itemize @minus\n" :oend
"@end itemize"
2985 :ustart
"@enumerate\n" :uend
"@end enumerate"
2986 :dstart
"@table @asis\n" :dend
"@end table"
2987 :dtstart
" " :dtend
"\n"
2988 :istart
"@item\n" :iend
"\n"
2991 :cbon
"@code{[X]}" :cboff
"@code{[ ]}")
2994 (defun org-list-to-subtree (list &optional params
)
2995 "Convert LIST into an Org subtree.
2996 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2997 with overruling parameters for `org-list-to-generic'."
2998 (let* ((rule (cdr (assq 'heading org-blank-before-new-entry
)))
2999 (level (org-reduced-level (or (org-current-level) 0)))
3000 (blankp (or (eq rule t
)
3001 (and (eq rule
'auto
)
3003 (outline-previous-heading)
3004 (org-previous-line-empty-p)))))
3007 ;; Return the string for the heading, depending on depth D
3008 ;; of current sub-list.
3010 (let ((oddeven-level (+ level d
1)))
3011 (concat (make-string (if org-odd-levels-only
3012 (1- (* 2 oddeven-level
))
3016 (org-list-to-generic
3020 :dtstart
" " :dtend
" "
3021 :istart
(funcall get-stars depth
)
3022 :icount
(funcall get-stars depth
)
3023 :isep
(if blankp
"\n\n" "\n")
3024 :csep
(if blankp
"\n\n" "\n")
3025 :cbon
"DONE" :cboff
"TODO")
3030 ;; arch-tag: 73cf50c1-200f-4d1d-8a53-4e842a5b11c8
3031 ;;; org-list.el ends here