| blob | 84b0729bfc4dee38b11dc4ae1a5f110f7b6f0818 |
1 ;;; org-list.el --- Plain lists for Org-mode
2 ;;
3 ;; Copyright (C) 2004-2012 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Bastien Guerry <bzg AT gnu DOT org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;;
10 ;; This file is part of GNU Emacs.
11 ;;
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
25 ;;
26 ;;; Commentary:
28 ;; This file contains the code dealing with plain lists in Org-mode.
30 ;; The core concept behind lists is their structure. A structure is
31 ;; a snapshot of the list, in the shape of a data tree (see
32 ;; `org-list-struct').
34 ;; Once the list structure is stored, it is possible to make changes
35 ;; on it that will be mirrored to the real list or to get information
36 ;; about the list, using accessors and methods provided in the
37 ;; library. Most of them require the use of one or two helper
38 ;; functions, namely `org-list-parents-alist' and
39 ;; `org-list-prevs-alist'.
41 ;; Structure is eventually applied to the buffer with
42 ;; `org-list-write-struct'. This function repairs (bullets,
43 ;; indentation, checkboxes) the list in the process. It should be
44 ;; called near the end of any function working on structures.
46 ;; Thus, a function applying to lists should usually follow this
47 ;; template:
49 ;; 1. Verify point is in a list and grab item beginning (with the same
50 ;; function `org-in-item-p'). If the function requires the cursor
51 ;; to be at item's bullet, `org-at-item-p' is more selective. It
52 ;; is also possible to move point to the closest item with
53 ;; `org-list-search-backward', or `org-list-search-forward',
54 ;; applied to the function `org-item-beginning-re'.
56 ;; 2. Get list structure with `org-list-struct'.
58 ;; 3. Compute one, or both, helper functions,
59 ;; (`org-list-parents-alist', `org-list-prevs-alist') depending on
60 ;; needed accessors.
62 ;; 4. Proceed with the modifications, using methods and accessors.
64 ;; 5. Verify and apply structure to buffer, using
65 ;; `org-list-write-struct'.
67 ;; 6. If changes made to the list might have modified check-boxes,
68 ;; call `org-update-checkbox-count-maybe'.
70 ;; Computing a structure can be a costly operation on huge lists (a
71 ;; few thousand lines long). Thus, code should follow the rule:
72 ;; "collect once, use many". As a corollary, it is usually a bad idea
73 ;; to use directly an interactive function inside the code, as those,
74 ;; being independent entities, read the whole list structure another
75 ;; time.
77 ;;; Code:
132 \f
133 ;;; Configuration variables
136 "Options concerning plain lists in Org-mode."
141 "When t, make TAB cycle visibility on plain list items.
142 Cycling plain lists works only when the cursor is on a plain list
143 item. When the cursor is on an outline heading, plain lists are
144 treated as text. This is the most stable way of handling this,
145 which is why it is the default.
147 When this is the symbol `integrate', then during cycling, plain
148 list items will *temporarily* be interpreted as outline headlines
149 with a level given by 1000+i where i is the indentation of the
150 bullet. This setting can lead to strange effects when switching
152 subtree decides what children should be listed. If that first
154 number, all true children and grand children of the outline
155 heading will be exposed in a children' view."
163 "Default bullet type installed when demoting an item.
164 This is an association list, for each bullet type, this alist will point
165 to the bullet that should be used when this item is demoted.
166 For example,
168 (setq org-list-demote-modify-bullet
171 will make
173 + Movies
174 + Silence of the Lambs
175 + My Cousin Vinny
176 + Books
177 + The Hunt for Red October
178 + The Road to Omaha
180 into
182 + Movies
183 - Silence of the Lambs
184 - My Cousin Vinny
185 + Books
186 - The Hunt for Red October
187 - The Road to Omaha"
205 "The character that makes a line with leading number an ordered list item.
206 Valid values are ?. and ?\). To get both terminators, use t."
213 "Non-nil means single character alphabetical bullets are allowed.
214 Both uppercase and lowercase are handled. Lists with more than
215 26 items will fallback to standard numbering. Alphabetical
222 "A regular expression matching bullets that should have 2 spaces after them.
223 When nil, no bullet will have two spaces after them. When
224 a string, it will be used as a regular expression. When the
225 bullet type of a list is changed, the new bullet type will be
226 matched against this regexp. If it matches, there will be two
227 spaces instead of one after the bullet in each item of the list."
234 "Determine where plain lists should end.
235 Valid values are: `regexp', `indent' or `both'.
237 When set to `regexp', Org will look into two variables,
238 `org-empty-line-terminates-plain-lists' and the more general
239 `org-list-end-regexp', to determine what will end lists.
241 When set to `indent', a list will end whenever a line following
242 an item, but not starting one, is less or equally indented than
243 the first item of the list.
245 When set to `both', each of the preceding methods is applied to
246 determine lists endings. This is the default method."
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
263 "Regexp matching the end of all plain list levels.
265 blank lines. `org-empty-line-terminates-plain-lists' has
266 precedence over it."
274 "Non-nil means apply set of rules when acting on lists.
275 By default, automatic actions are taken when using
280 rules by setting them to nil. Valid rules are:
282 bullet when non-nil, cycling bullet do not allow lists at
283 column 0 to have * as a bullet and descriptions lists
284 to be numbered.
285 checkbox when non-nil, checkbox statistics is updated each time
286 you either insert a new checkbox or toggle a checkbox.
287 It also prevents from inserting a checkbox in a
288 description item.
289 indent when non-nil, indenting or outdenting list top-item
290 with its subtree will move the whole list and
291 outdenting a list whose bullet is * to column 0 will
296 :key-type
301 :value-type
305 "Non-nil means commands implying motion in lists should be cyclic.
307 In that case, the item following the last item is the first one,
308 and the item preceding the first item is the last one.
318 "Hook that is run whenever Org thinks checkbox statistics should be updated.
319 This hook runs even if checkbox rule in
320 `org-list-automatic-rules' does not apply, so it can be used to
321 implement alternative ways of collecting statistics
325 "Non-nil means checkbox statistics counts only the state of direct children.
326 When nil, all boxes below the cookie are counted.
327 This can be set to nil on a per-node basis using a COOKIE_DATA property
333 "Maximum indentation for the second line of a description list.
334 When the indentation would be larger than this, it will become
335 5 characters instead."
340 "Additional indentation for sub-items in a list.
341 By setting this to a small number, usually 1 or 2, one can more
342 clearly distinguish sub-items in a list."
349 % END RECEIVE ORGLST %n
351 #+ORGLST: SEND %n org-list-to-latex
352 -
355 @c END RECEIVE ORGLST %n
356 @ignore
357 #+ORGLST: SEND %n org-list-to-texinfo
358 -
361 <!-- END RECEIVE ORGLST %n -->
362 <!--
363 #+ORGLST: SEND %n org-list-to-html
364 -
366 "Templates for radio lists in different major modes.
367 All occurrences of %n in a template will be replaced with the name of the
368 list, obtained by prompting the user."
376 "Names of blocks where lists are not allowed.
380 "Context types where lists will be interpreted during export.
382 Valid types are `drawer', `inlinetask' and `block'. More
383 specifically, type `block' is determined by the variable
387 \f
388 ;;; Predicates and regexps
392 org-list-end-regexp)
393 "Regex corresponding to the end of a list.
401 "Matches a list item and puts everything into groups:
402 group 1: bullet
403 group 2: counter
404 group 3: checkbox
408 "Return the correct regular expression for plain lists."
419 "Regexp matching the beginning of a plain list item."
423 "Is point at a list item with REGEXP after bullet?"
432 ;; Ignore counter if any
437 "Is point in a context where lists are allowed?"
441 "Return item beginning position when in a plain list, nil otherwise.
442 This checks `org-list-ending-method'."
454 ;; Indentation isn't meaningful when point starts at an empty
455 ;; line or an inline task.
458 10000
464 ;; Detect if cursor in amidst `org-list-end-re'. First, count
465 ;; number HL of hard lines it takes, then call `org-in-regexp'
466 ;; to compute its boundaries END-BOUNDS. When point is
467 ;; in-between, move cursor before regexp beginning.
479 ;; Look for an item, less indented that reference line if
480 ;; `org-list-ending-method' isn't `regexp'.
485 ;; This is exactly what we want.
490 ;; At upper bound of search or looking at the end of a
491 ;; previous list: search is over.
496 ;; Skip blocks, drawers, inline-tasks, blank lines
506 ;; Text at column 0 cannot belong to a list: stop.
508 ;; Normal text less indented than reference line, take
509 ;; it as new reference.
516 "Is point in a line starting a hand-formatted item?"
522 "Is point at the bullet of a plain list item?"
528 "Is point at a line starting a plain list item with a timer?"
533 "Is point at a description list item?"
537 "Is point at a line starting a plain-list item with a checklet?"
541 "Is point at a line starting a plain-list item with a counter?"
547 \f
548 ;;; Structures and helper functions
551 "Determine context, and its boundaries, around point.
553 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
554 are boundaries and CONTEXT is a symbol among `drawer', `block',
555 `invalid', `inlinetask' and nil.
557 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
563 ;; Get positions of surrounding headings. This is the
564 ;; default context.
569 ;; Is point inside a drawer?
571 ;; Can't use org-drawers-regexp as this function might
572 ;; be called in buffers not in Org mode.
583 lim-down))
586 ;; Is point strictly in a block, and of which type?
597 lim-down))
603 ;; Is point in an inlinetask?
616 ;; Return context boundaries and type.
620 "Return structure of list at point.
622 A list structure is an alist where key is point at item, and
623 values are:
624 1. indentation,
625 2. bullet with trailing whitespace,
626 3. bullet counter, if any,
627 4. checkbox, if any,
628 5. description tag, if any,
629 6. position at item end.
631 Thus the following list, where numbers in parens are
632 point-at-bol:
634 - [X] first item (1)
635 1. sub-item 1 (18)
636 5. [@5] sub-item 2 (34)
637 some other text belonging to first item (55)
638 - last item (97)
639 + tag :: description (109)
640 (131)
642 will get the following structure:
650 Assume point is at an item."
665 ind itm-lst itm-lst-2 end-lst end-lst-2 struct
668 ;; Return association at point.
672 ind
679 ;; Ensure list ends at the first blank line.
683 ;; 1. Read list from starting item to its beginning, and save
684 ;; top item position and indentation in BEG-CELL. Also store
685 ;; ending position of items in END-LST.
693 ;; At upward limit: if we ended at an item, store it,
694 ;; else dismiss useless data recorded above BEG-CELL.
695 ;; Jump to part 2.
703 ;; At a verbatim block, go before its beginning. Move
704 ;; from eol to ensure `previous-single-property-change'
705 ;; will return a value.
710 ;; Looking at a list ending regexp. Dismiss useless
711 ;; data recorded above BEG-CELL. Jump to part 2.
717 ;; Point is at an item. Add data to ITM-LST. It may
718 ;; also end a previous item: save it in END-LST. If
719 ;; ind is less or equal than BEG-CELL and there is no
720 ;; end at this ind or lesser, this item becomes the new
721 ;; BEG-CELL.
730 ;; Skip blocks, drawers, inline tasks, blank lines.
741 ;; From there, point is not at an item. Unless ending
742 ;; method is `regexp', interpret line's indentation:
743 ;; - text at column 0 is necessarily out of any list.
744 ;; Dismiss data recorded above BEG-CELL. Jump to
745 ;; part 2.
746 ;; - any other case may be an ending position for an
747 ;; hypothetical item above. Store it and proceed.
757 ;; 2. Read list from starting point to its end, that is until we
758 ;; get out of context, or that a non-item line is less or
759 ;; equally indented than BEG-CELL's cdr. Also, store ending
760 ;; position of items in END-LST-2.
767 ;; At downward limit: this is de facto the end of the
768 ;; list. Save point as an ending position, and jump to
769 ;; part 3.
772 ;; At a verbatim block, move to its end. Point is at bol
773 ;; and 'org-example property is set by whole lines:
774 ;; `next-single-property-change' always return a value.
778 ;; Looking at a list ending regexp. Save point as an
779 ;; ending position and jump to part 3.
784 ;; Point is at an item. Add data to ITM-LST-2. It may
785 ;; also end a previous item, so save it in END-LST-2.
789 ;; Skip inline tasks and blank lines along the way
794 ;; Ind is lesser or equal than BEG-CELL's. The list is
795 ;; over: store point as an ending position and jump to
796 ;; part 3.
801 ;; Else, if ind is lesser or equal than previous item's,
802 ;; this is an ending position: store it. In any case,
803 ;; skip block or drawer at point, and move to next line.
816 ;; 3. Associate each item to its end position.
818 ;; 4. Return STRUCT
819 struct)))
822 "Associate proper ending point to items in STRUCT.
824 END-LIST is a pseudo-alist where car is indentation and cdr is
825 ending position.
827 This function modifies STRUCT."
833 ;; Remove end candidates behind current item.
836 ;; Add end position to item assoc.
842 struct)))
845 "Return alist between item and previous item in STRUCT."
847 struct)))
851 struct)))
854 "Return alist between item and parent in STRUCT."
866 ;; A sub-list is over. Find the associated
867 ;; origin in IND-TO-ORI. If it cannot be
868 ;; found (ill-formed list), set its parent as
869 ;; the first item less indented. If there is
870 ;; none, make it a top-level item.
878 ind-to-ori)
881 ;; A sub-list starts. Every item at IND will
882 ;; have previous item as its parent.
887 ;; Another item in the same sub-list: it shares
888 ;; the same parent as the previous item.
893 \f
894 ;;; Accessors
897 "Return the Nth value of KEY in STRUCT."
901 "Set the Nth value of KEY in STRUCT to NEW.
906 "Return indentation of ITEM in STRUCT."
910 "Set indentation of ITEM in STRUCT to IND.
915 "Return bullet of ITEM in STRUCT."
919 "Set bullet of ITEM in STRUCT to BULLET.
924 "Return counter of ITEM in STRUCT."
928 "Return checkbox of ITEM in STRUCT or nil."
932 "Set checkbox of ITEM in STRUCT to CHECKBOX.
937 "Return end position of ITEM in STRUCT."
941 "Return end position of ITEM in STRUCT."
945 "Return point at end of ITEM in STRUCT, before any blank line.
946 Point returned is at end of line."
953 "Return parent of ITEM or nil.
954 STRUCT is the list structure. PARENTS is the alist of parents,
955 as returned by `org-list-parents-alist'."
960 "Non-nil if ITEM has a child.
962 STRUCT is the list structure.
964 Value returned is the position of the first child of ITEM."
969 child-maybe)))
972 "Return next item in same sub-list as ITEM, or nil.
973 STRUCT is the list structure. PREVS is the alist of previous
974 items, as returned by `org-list-prevs-alist'."
978 "Return previous item in same sub-list as ITEM, or nil.
979 STRUCT is the list structure. PREVS is the alist of previous
980 items, as returned by `org-list-prevs-alist'."
984 "List all items having ITEM as a common ancestor, or nil.
985 STRUCT is the list structure."
988 subtree)
993 sub-struct))
997 "List all items in the same sub-list as ITEM.
998 STRUCT is the list structure. PREVS is the alist of previous
999 items, as returned by `org-list-prevs-alist'."
1002 before-item after-item)
1010 "List all children of ITEM, or nil.
1011 STRUCT is the list structure. PARENTS is the alist of parents,
1012 as returned by `org-list-parents-alist'."
1020 "Return point at beginning of list.
1021 STRUCT is the list structure."
1025 "Return point at bottom of list.
1026 STRUCT is the list structure."
1031 "Return point at beginning of sub-list ITEM belongs.
1032 STRUCT is the list structure. PREVS is the alist of previous
1033 items, as returned by `org-list-prevs-alist'."
1037 first-item))
1042 "Return point at last item of sub-list ITEM belongs.
1043 STRUCT is the list structure. PREVS is the alist of previous
1044 items, as returned by `org-list-prevs-alist'."
1048 last-item))
1051 "Return point at end of sub-list ITEM belongs.
1052 STRUCT is the list structure. PREVS is the alist of previous
1053 items, as returned by `org-list-prevs-alist'."
1057 "Return the type of the list containing ITEM, as a symbol.
1059 STRUCT is the list structure. PREVS is the alist of previous
1060 items, as returned by `org-list-prevs-alist'.
1062 Possible types are `descriptive', `ordered' and `unordered'. The
1063 type is determined by the first item of the list."
1071 \f
1072 ;;; Searching
1075 "Search a string in valid contexts for lists.
1076 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1077 in `re-search-forward'."
1081 ;; 1. No match: return to origin or bound, depending on NOERR.
1084 nil)))
1085 ;; 2. Match in valid context: return point. Else, continue
1086 ;; searching.
1090 "Like `re-search-backward' but stop only where lists are recognized.
1091 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1092 `re-search-backward'."
1097 "Like `re-search-forward' but stop only where lists are recognized.
1098 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1099 `re-search-forward'."
1104 \f
1105 ;;; Methods on structures
1108 "Return BULLET with the correct number of whitespaces.
1109 It determines the number of whitespaces to append by looking at
1110 `org-list-two-spaces-after-bullet-regexp'."
1114 org-list-two-spaces-after-bullet-regexp bullet))
1115 " "
1121 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1122 Blank lines at the end of items are left in place. Return the
1123 new structure after the changes.
1125 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1126 to the same sub-list.
1128 This function modifies STRUCT."
1141 ;; 1. Move effectively items in buffer.
1145 ;; 2. Now modify struct. No need to re-read the list, the
1146 ;; transformation is just a shift of positions. Some special
1147 ;; attention is required for items ending at END-A and END-B
1148 ;; as empty spaces are not moved there. In others words,
1149 ;; item BEG-A will end with whitespaces that were at the end
1150 ;; of BEG-B and the same applies to BEG-B.
1172 struct)
1176 "Return number of blank lines that should separate items in list.
1178 POS is the position of point where `org-list-insert-item' was called.
1180 STRUCT is the list structure. PREVS is the alist of previous
1181 items, as returned by `org-list-prevs-alist'.
1183 Assume point is at item's beginning. If the item is alone, apply
1184 some heuristics to guess the result."
1189 usr-blank
1193 ;; Count blank lines above beginning of line.
1200 ;; Trivial cases where there should be none.
1202 org-empty-line-terminates-plain-lists)
1204 ;; When `org-blank-before-new-entry' says so, it is 1.
1206 ;; `plain-list-item' is 'auto. Count blank lines separating
1207 ;; neighbours items in list.
1210 ;; Is there a next item?
1213 ;; Is there a previous item?
1216 ;; User inserted blank lines, trust him.
1221 usr-blank)
1222 ;; Are there blank lines inside the list so far?
1228 ;; Default choice: no blank line.
1232 "Insert a new list item at POS and return the new structure.
1233 If POS is before first character after bullet of the item, the
1234 new item will be created before the current one.
1236 STRUCT is the list structure. PREVS is the the alist of previous
1237 items, as returned by `org-list-prevs-alist'.
1239 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1240 after the bullet. Cursor will be after this text once the
1241 function ends.
1243 This function modifies STRUCT."
1245 ;; 1. Get information about list: position of point with regards
1246 ;; to item start (BEFOREP), blank lines number separating items
1247 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1255 pos struct prevs))
1256 ;; 2. Build the new item to be created. Concatenate same
1257 ;; bullet as item, checkbox, text AFTER-BULLET if
1258 ;; provided, and text cut from point to end of item
1259 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1260 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1261 ;; between what was cut and what was inserted in buffer
1262 ;; is stored in SIZE-OFFSET.
1266 ind))
1273 ;; If POS is greater than ITEM-END, then point is
1274 ;; in some white lines after the end of the list.
1275 ;; Those must be removed, or they will be left,
1276 ;; stacking up after the list.
1286 text-cut))))
1290 ;; 4. Insert effectively item into buffer.
1294 ;; 5. Add new item to STRUCT.
1299 ;; Before inserted item, positions don't change but
1300 ;; an item ending after insertion has its end shifted
1301 ;; by SIZE-OFFSET.
1304 ;; Trivial cases where current item isn't split in
1305 ;; two. Just shift every item after new one by
1306 ;; ITEM-SIZE.
1310 ;; Item is split in two: elements before POS are just
1311 ;; shifted by ITEM-SIZE. In the case item would end
1312 ;; after split POS, ending is only shifted by
1313 ;; SIZE-OFFSET.
1319 ;; Elements after POS are moved into new item.
1320 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1321 ;; doesn't appear in buffer yet.
1327 (+ end size-offset
1329 ;; Elements at ITEM-END or after are only shifted by
1330 ;; SIZE-OFFSET.
1333 struct)
1336 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1337 ;; exchange ITEM with the next item in list. Position cursor
1338 ;; after bullet, counter, checkbox, and label.
1344 struct)))
1347 "Remove ITEM from the list and return the new structure.
1349 STRUCT is the list structure."
1352 ;; If ITEM ends with the list, delete blank lines
1353 ;; before it.
1358 item)))
1359 ;; Remove item from buffer.
1361 ;; Remove item from structure and shift others items accordingly.
1362 ;; Don't forget to shift also ending position when appropriate.
1380 struct)))))
1383 "Send ITEM to destination DEST.
1385 STRUCT is the list structure.
1387 DEST can have various values.
1389 If DEST is a buffer position, the function will assume it points
1390 to another item in the same list as ITEM, and will move the
1391 latter just before the former.
1393 If DEST is `begin' \(respectively `end'\), ITEM will be moved at
1394 the beginning \(respectively end\) of the list it belongs to.
1397 be moved at the Nth position in the list.
1399 If DEST is `kill', ITEM will be deleted and its body will be
1400 added to the kill-ring.
1402 If DEST is `delete', ITEM will be deleted.
1404 This function returns, destructively, the new list structure."
1407 ;; Grab full item body minus its bullet.
1416 item-end)))
1417 ;; Change DEST into a buffer position. A trick is needed
1418 ;; when ITEM is meant to be sent at the end of the list.
1419 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1420 ;; nil and insertion point (INS-POINT) to the first line's
1421 ;; end of the last item, we ensure the new item will be
1422 ;; inserted after the last item, and not after any of its
1423 ;; hypothetical sub-items.
1439 ;; Send ITEM at the end of the list.
1455 ;; 1. Structure returned by `org-list-insert-item' may not be
1456 ;; accurate, as it cannot see sub-items included in BODY.
1457 ;; Thus, first compute the real structure so far.
1465 ;; 1.1. Remove the item just created in structure.
1467 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1470 struct
1478 new-end
1480 moved-items))
1482 ;; 2. Eventually delete extra copy of the item and clean marker.
1489 "Outdent items between positions START and END.
1491 STRUCT is the list structure. PARENTS is the alist of items'
1492 parents, as returned by `org-list-parents-alist'.
1494 START is included, END excluded."
1500 ;; Item not yet in zone: keep association.
1502 ;; Item out of zone: follow associations in ACC.
1506 ;; Item has no parent: error
1509 ;; Parent is outdented: keep association.
1513 ;; Parent isn't outdented: reparent to grand-parent.
1515 parent struct parents)))
1521 "Indent items between positions START and END.
1523 STRUCT is the list structure. PARENTS is the alist of parents
1524 and PREVS is the alist of previous items, returned by,
1525 respectively, `org-list-parents-alist' and
1526 `org-list-prevs-alist'.
1528 START is included and END excluded.
1530 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1531 bullets between START and END."
1545 ;; Item not yet in zone: keep association.
1548 ;; Item out of zone: follow associations in ACC.
1552 ;; Item is in zone...
1554 ;; Check if bullet needs to be changed.
1557 ;; First item indented but not parent: error
1560 ;; First item and parent indented: keep same
1561 ;; parent.
1563 ;; Previous item not indented: reparent to it.
1565 ;; Previous item indented: reparent like it.
1572 \f
1573 ;;; Repairing structures
1576 "Non-nil if list starting at FIRST can have alphabetical bullets.
1578 STRUCT is list structure. PREVS is the alist of previous items,
1579 as returned by `org-list-prevs-alist'."
1583 ;; Pretend that bullets are uppercase and check if alphabet
1584 ;; is sufficient, taking counters into account.
1588 ;; Virtually determine current bullet
1590 ;; Counters are not case-sensitive.
1593 ;; Test if bullet would be over z or Z.
1597 ;; All items checked. All good.
1598 t))))
1601 "Increment BULLET if applicable."
1604 ;; Num bullet: increment it.
1608 nil nil bullet))
1609 ;; Alpha bullet: increment it.
1613 nil nil bullet))
1614 ;; Unordered bullet: leave it.
1618 "Verify and correct bullets in STRUCT.
1619 PREVS is the alist of previous items, as returned by
1620 `org-list-prevs-alist'.
1622 This function modifies STRUCT."
1626 ;; Set bullet of ITEM in STRUCT, depending on the type of
1627 ;; first item of the list, the previous bullet and counter
1628 ;; if any.
1637 item struct
1640 ;; Alpha counter in alpha list: use counter.
1644 ;; Use cond to be sure `string-match' is used in
1645 ;; both cases.
1651 ;; Num counter in a num list: use counter.
1656 ;; No counter: increase, if needed, previous bullet.
1659 ;; Alpha counter at first item: use counter.
1668 ;; Num counter at first item: use counter.
1673 ;; First bullet is alpha uppercase: use "A".
1676 ;; First bullet is alpha lowercase: use "a".
1679 ;; First bullet is num: use "1".
1682 ;; Not an ordered list: keep bullet.
1687 "Verify and correct indentation in STRUCT.
1689 PARENTS is the alist of parents, as returned by
1690 `org-list-parents-alist'.
1692 If numeric optional argument BULLET-SIZE is set, assume all
1693 bullets in list have this length to determine new indentation.
1695 This function modifies STRUCT."
1702 ;; Indent like parent + length of parent's bullet +
1703 ;; sub-list offset.
1709 org-list-indent-offset))
1710 ;; If no parent, indent like top-point.
1715 "Verify and correct checkboxes in STRUCT.
1717 PARENTS is the alist of parents and PREVS is the alist of
1718 previous items, as returned by, respectively,
1719 `org-list-parents-alist' and `org-list-prevs-alist'.
1721 If ORDERED is non-nil, a checkbox can only be checked when every
1722 checkbox before it is checked too. If there was an attempt to
1723 break this rule, the function will return the blocking item. In
1724 all others cases, the return value will be nil.
1726 This function modifies STRUCT."
1736 item struct
1742 ;; Parent has no boxed child: leave box as-is.
1744 parent-list)
1745 ;; 1. List all parents with a checkbox.
1752 all-items)
1753 ;; 2. Sort those parents by decreasing indentation.
1758 ;; 3. For each parent, get all children's checkboxes to determine
1759 ;; and set its checkbox accordingly.
1761 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1766 ;; There are boxes checked after an unchecked one: fix that.
1771 ;; Verify once again the structure, without ORDERED.
1773 ;; Return blocking item.
1777 "Verify and correct each item end position in STRUCT.
1779 This function modifies STRUCT."
1786 ;; To determine real ind of an ending position that is
1787 ;; not at an item, we have to find the item it belongs
1788 ;; to: it is the last item (ITEM-UP), whose ending is
1789 ;; further than the position we're interested in.
1792 ;; Else part is for the bottom point.
1794 end-pos)
1795 end-list)))
1798 struct)
1803 "Apply set difference between STRUCT and OLD-STRUCT to the buffer.
1805 OLD-STRUCT is the structure before any modifications, and STRUCT
1806 the structure to be applied. The function will only modify parts
1807 of the list which have changed.
1809 Initial position of cursor is restored after the changes."
1817 ;; Shift the indentation between END and BEG by DELTA.
1818 ;; Start from the line before END.
1827 ;; Skip inline tasks.
1830 ;; Shift only non-empty lines.
1837 ;; Replace ITEM first line elements with new elements from
1838 ;; STRUCT, if appropriate.
1848 ;; a. Replace bullet
1851 ;; b. Replace checkbox.
1865 ;; c. Indent item to appropriate column.
1870 ;; 1. First get list of items and position endings. We maintain
1871 ;; two alists: ITM-SHIFT, determining indentation shift needed
1872 ;; at item, and END-POS, a pseudo-alist where key is ending
1873 ;; position and value point.
1886 ;; To determine real ind of an ending position that
1887 ;; is not at an item, we have to find the item it
1888 ;; belongs to: it is the last item (ITEM-UP), whose
1889 ;; ending is further than the position we're
1890 ;; interested in.
1894 old-struct)
1895 ;; 2. Slice the items into parts that should be shifted by the
1896 ;; same amount of indentation. The slices are returned in
1897 ;; reverse order so changes modifying buffer do not change
1898 ;; positions they refer to.
1901 '<))
1909 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1910 ;; end to beginning. Take a special action when beginning is
1911 ;; at item bullet.
1918 sliced-struct))
1919 ;; 4. Go back to initial position and clean marker.
1924 "Correct bullets, checkboxes and indentation in list at point.
1926 STRUCT is the list structure. PARENTS is the alist of parents,
1927 as returned by `org-list-parents-alist'.
1929 When non-nil, optional argument OLD-STRUCT is the reference
1930 structure of the list. It should be provided whenever STRUCT
1931 doesn't correspond anymore to the real list in buffer."
1932 ;; Order of functions matters here: checkboxes and endings need
1933 ;; correct indentation to be set, and indentation needs correct
1934 ;; bullets.
1935 ;;
1936 ;; 0. Save a copy of structure before modifications
1938 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1939 ;; order to get items endings and bullets properly
1941 ;; 2. Fix each item end to get correct prevs alist.
1943 ;; 3. Get bullets right.
1946 ;; 4. Now get real indentation.
1948 ;; 5. Eventually fix checkboxes.
1950 ;; 6. Apply structure modifications to buffer.
1954 \f
1955 ;;; Misc Tools
1958 "Call FUNCTION on each item of the list at point.
1959 FUNCTION must be called with at least one argument: INIT-VALUE,
1960 that will contain the value returned by the function at the
1961 previous item, plus ARGS extra arguments.
1963 FUNCTION is applied on items in reverse order.
1965 As an example, \(org-apply-on-list \(lambda \(result\) \(1+ result\)\) 0\)
1966 will return the number of items in the current list.
1968 Sublists of the list are skipped. Cursor is always at the
1969 beginning of the item."
1981 value))
1984 "Set visibility of ITEM in STRUCT to VIEW.
1986 Possible values are: `folded', `children' or `subtree'. See
1987 `org-cycle' for more information."
1991 ;; Hide from eol
1993 item-end t)))
1995 ;; First show everything.
1997 ;; Then fold every child.
2002 children)))
2004 ;; Show everything
2009 "Return column at which body of ITEM should start."
2019 tcol))
2022 \f
2023 ;;; Interactive functions
2028 "Go to the beginning of the current item.
2029 Throw an error when not in a list."
2035 "Go to the beginning item of the current list or sublist.
2036 Throw an error when not in a list."
2047 "Go to the end of the current list or sublist.
2048 Throw an error when not in a list."
2059 "Go to the end of the current item.
2060 Throw an error when not in a list."
2070 "Move to the beginning of the previous item.
2071 Throw an error when not in a list. Also throw an error when at
2072 first item, unless `org-list-use-circular-motion' is non-nil."
2088 "Move to the beginning of the next item.
2089 Throw an error when not in a list. Also throw an error when at
2090 last item, unless `org-list-use-circular-motion' is non-nil."
2106 "Move the item at point down, i.e. swap with following item.
2107 Sub-items (items with larger indentation) are considered part of
2108 the item, so this really moves item trees."
2127 "Move the item at point up, i.e. swap with previous item.
2128 Sub-items (items with larger indentation) are considered part of
2129 the item, so this really moves item trees."
2146 "Insert a new item at the current level.
2147 If cursor is before first character after bullet of the item, the
2148 new item will be created before the current one.
2150 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2152 Return t when things worked, nil when we are not in an item, or
2153 item is invisible."
2156 ;; If cursor isn't is a list or if list is invisible, return nil.
2164 ;; Timer list: delegate to `org-timer-item'.
2169 ;; If we're in a description list, ask for the new term.
2172 ;; Don't insert a checkbox if checkbox rule is applied
2173 ;; and it is a description item.
2177 org-list-automatic-rules)))))))
2184 t)))))
2187 "Mark the current list.
2188 If this is a sublist, only mark the sublist."
2199 "Fix indentation, bullets and checkboxes is the list at point."
2207 "Cycle through the different itemize/enumerate bullets.
2208 This cycle the entire list level through the sequence:
2210 `-' -> `+' -> `*' -> `1.' -> `1)'
2212 If WHICH is a valid string, use that as the new bullet. If WHICH
2213 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2214 `previous', cycle backwards."
2235 ;; Compute list of possible bullets, depending on context.
2238 ;; *-bullets are not allowed at column 0.
2241 ;; Description items cannot be numbered.
2264 ;; Use a short variation of `org-list-write-struct' as there's
2265 ;; no need to go through all the steps.
2273 "Toggle the checkbox in the current line.
2274 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2275 double prefix, set checkbox to [-].
2277 When there is an active region, toggle status or presence of the
2278 first checkbox there, and make every item inside have the same
2279 status or presence, respectively.
2281 If the cursor is in a headline, apply this to all checkbox items
2282 in the text below the heading, taking as reference the first item
2283 in subtree, ignoring drawers."
2287 block-item
2288 lim-up
2289 lim-down
2300 ;; In a region, start at first item in region.
2310 ;; On an heading, start at first item after drawers and
2311 ;; time-stamps (scheduled, etc.).
2322 ;; Just one item: set SINGLEP flag.
2328 ;; Determine the checkbox going to be applied to all items
2329 ;; within bounds.
2340 ;; When an item is found within bounds, grab the full list at
2341 ;; point structure, then: (1) set check-box of all its items
2342 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2343 ;; whole list, (3) move point after the list.
2357 e struct
2358 ;; If there is no box at item, leave as-is
2359 ;; unless function was called with C-u prefix.
2362 ref-checkbox
2363 cur-box))))
2364 items-to-toggle)
2366 struct parents prevs orderedp))
2367 ;; Report some problems due to ORDERED status of subtree.
2368 ;; If only one box was being checked, throw an error, else,
2369 ;; only signal problems.
2373 "Checkbox blocked because of unchecked box at line %d"
2377 "Checkboxes were removed due to unchecked box at line %d"
2386 "Reset all checkboxes in an entry subtree."
2403 "Update the checkbox statistics in the current section.
2404 This will find all statistic cookies like [57%] and [6/12] and
2405 update them with the current numbers.
2407 With optional prefix argument ALL, do this for the whole buffer."
2411 (box-re "^[ \t]*\\([-+*]\\|\\([0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2423 ;; Return number of checked boxes and boxes of all types
2424 ;; in all structures in STRUCTS. If RECURSIVEP is
2425 ;; non-nil, also count boxes in sub-lists. If ITEM is
2426 ;; nil, count across the whole structure, else count only
2427 ;; across subtree whose ancestor is ITEM.
2444 items))))
2447 structs)
2450 cookies-list structs-bak box-num)
2452 ;; 1. Build an alist for each cookie found within BOUNDS. The
2453 ;; key will be position at beginning of cookie and values
2454 ;; ending position, format of cookie, and a cell whose car is
2455 ;; number of checked boxes to report, and cdr total number of
2456 ;; boxes.
2466 ;; Cookie is at an heading, but specifically for todo,
2467 ;; not for checkboxes: skip it.
2473 ;; Cookie is at an heading, but all lists before next
2474 ;; heading already have been read. Use data collected
2475 ;; in STRUCTS-BAK. This should only happen when
2476 ;; heading has more than one cookie on it.
2479 backup-end))
2481 ;; Cookie is at a fresh heading. Grab structure of
2482 ;; every list containing a checkbox between point and
2483 ;; next headline, and save them in STRUCTS-BAK.
2487 structs-bak nil)
2494 ;; Cookie is at an item, and we already have list
2495 ;; structure stored in STRUCTS-BAK.
2498 ;; Only lists in no special context are stored.
2501 ;; Cookie is at an item, but we need to compute list
2502 ;; structure.
2508 ;; Else, cookie found is at a wrong place. Skip it.
2510 cookies-list))))
2511 ;; 2. Apply alist to buffer, in reverse order so positions stay
2512 ;; unchanged after cookie modifications.
2527 cookies-list))))
2530 "Select the face for checkbox statistics.
2531 The face will be `org-done' when all relevant boxes are checked.
2532 Otherwise it will be `org-todo'."
2535 'org-checkbox-statistics-done
2539 'org-checkbox-statistics-done
2543 "Update checkbox statistics unless turned off by user.
2544 With an optional argument ALL, update them in the whole buffer."
2552 "Indent a local list item including its children.
2553 When number ARG is a negative, item will be outdented, otherwise
2554 it will be indented.
2556 If a region is active, all items inside will be moved.
2558 If NO-SUBTREE is non-nil, only indent the item itself, not its
2559 children.
2561 STRUCT is the list structure.
2563 Return t if successful."
2572 ;; Are we going to move the whole list?
2579 t))))
2580 ;; Determine begin and end points of zone to indent. If moving
2581 ;; more than one item, save them for subsequent moves.
2597 ;; Special case: moving top-item with indent rule.
2605 ;; Change bullet if necessary.
2611 ;; Shift every item by OFFSET and fix bullets. Then
2612 ;; apply changes to buffer.
2616 struct)
2619 ;; Forbidden move:
2621 ;; If only one item is moved, it mustn't have a child.
2625 ;; If a subtree or region is moved, the last item
2626 ;; of the subtree mustn't have a child.
2631 struct)))))
2634 ;; Normal shifting
2642 t)
2645 "Outdent a local list item, but not its children.
2646 If a region is active, all items inside will be moved."
2654 "Indent a local list item, but not its children.
2655 If a region is active, all items inside will be moved."
2663 "Outdent a local list item including its children.
2664 If a region is active, all items inside will be moved."
2678 "Indent a local list item including its children.
2679 If a region is active, all items inside will be moved."
2694 "Cycle levels of indentation of an empty item.
2695 The first run indents the item, if applicable. Subsequent runs
2696 outdent it at meaningful levels in the list. When done, item is
2697 put back at its original position with its original bullet.
2699 Return t at each successful move."
2705 ;; Accept empty items or if cycle has already started.
2716 ;; When in the middle of the cycle, try to outdent first. If
2717 ;; it fails, and point is still at initial position, indent.
2718 ;; Else, re-create it at its original position.
2727 ;; Break cycle
2729 ;; If a cycle is starting, remember indentation and bullet,
2730 ;; then try to indent. If it fails, try to outdent.
2736 t))))
2739 "Sort list items.
2740 The cursor may be at any item of the list that should be sorted.
2741 Sublists are not sorted. Checkboxes, if any, are ignored.
2743 Sorting can be alphabetically, numerically, by date/time as given
2744 by a time stamp, by a property or by priority.
2746 Comparing entries ignores case by default. However, with an
2747 optional argument WITH-CASE, the sorting considers case as well.
2749 The command prompts for the sorting type unless it has been given
2750 to the function through the SORTING-TYPE argument, which needs to
2751 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
2752 meaning of each character:
2754 n Numerically, by converting the beginning of the item to a number.
2755 a Alphabetically. Only the first line of item is checked.
2756 t By date/time, either the first active time stamp in the entry, if
2757 any, or by the first inactive one. In a timer list, sort the timers.
2759 Capital letters will reverse the sort order.
2761 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2762 a function to be called with point at the beginning of the
2763 record. It must return either a string or a number that should
2764 serve as the sorting key for that record. It will then use
2765 COMPARE-FUNC to compare entries."
2810 ;; If it is a timer list, convert timer to seconds
2823 value))
2827 next-record
2828 end-record
2829 value-to-sort
2830 nil
2831 sort-func)
2832 ;; Read and fix list again, as `sort-subr' probably destroyed
2833 ;; its structure.
2839 \f
2840 ;;; Send and receive lists
2843 "Parse the list at point and maybe DELETE it.
2845 Return a list whose car is a symbol of list type, among
2846 `ordered', `unordered' and `descriptive'. Then, each item is
2847 a list whose car is counter, and cdr are strings and other
2848 sub-lists. Inside strings, check-boxes are replaced by
2851 For example, the following list:
2853 1. first item
2854 + sub-item one
2855 + [X] sub-item two
2856 more text in first item
2857 2. [@3] last item
2859 will be parsed as:
2861 \(ordered
2863 \(unordered
2869 Point is left at list end."
2875 out
2876 parse-item ; for byte-compiler
2879 ;; Return text between BEG and END, trimmed, with
2880 ;; checkboxes replaced.
2891 text)))))
2894 ;; Return a list whose car is list type and cdr a list of
2895 ;; items' body.
2901 ;; Return a list containing counter of item, if any, text
2902 ;; and any sublist inside it.
2908 ;; Get counter number. For alphabetic counter, get
2909 ;; its position in the alphabet.
2920 ;; If item has a child, store text between bullet and
2921 ;; next child, then recursively parse all sublists. At
2922 ;; the end of each sublist, check for the presence of
2923 ;; text belonging to the original item.
2933 ;; Remove children from the list just parsed.
2935 ;; There is a chunk of text belonging to the
2936 ;; item if last child doesn't end where next
2937 ;; child starts or where item ends.
2941 body))))
2944 ;; Store output, take care of cursor position and deletion of
2945 ;; list, then return output.
2954 out))
2957 "Convert the plain list at point into a subtree."
2965 "Insert a radio list template appropriate for this major mode."
2969 name pos)
2980 "Send a transformed version of this list to the receiver position.
2981 With argument MAYBE, fail quietly if no transformation is defined
2982 for this list."
2988 (unless (looking-at "[ \t]*#\\+ORGLST[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
3007 beg txt)
3011 ;; Find the insertion place
3016 name
3030 "Trim line breaks in a list ITEM."
3034 "Convert a LIST parsed through `org-list-parse-list' to other formats.
3035 Valid parameters PARAMS are:
3037 :ustart String to start an unordered list
3038 :uend String to end an unordered list
3040 :ostart String to start an ordered list
3041 :oend String to end an ordered list
3043 :dstart String to start a descriptive list
3044 :dend String to end a descriptive list
3045 :dtstart String to start a descriptive term
3046 :dtend String to end a descriptive term
3047 :ddstart String to start a description
3048 :ddend String to end a description
3050 :splice When set to t, return only list body lines, don't wrap
3051 them into :[u/o]start and :[u/o]end. Default is nil.
3053 :istart String to start a list item.
3054 :icount String to start an item with a counter.
3055 :iend String to end a list item
3056 :isep String to separate items
3057 :lsep String to separate sublists
3058 :csep String to separate text from a sub-list
3060 :cboff String to insert for an unchecked check-box
3061 :cbon String to insert for a checked check-box
3062 :cbtrans String to insert for a check-box in transitional state
3064 :nobr Non-nil means remove line breaks in lists items.
3066 Alternatively, each parameter can also be a form returning
3067 a string. These sexp can use keywords `counter' and `depth',
3068 representing respectively counter associated to the current
3069 item, and depth of the current sub-list, starting at 0.
3070 Obviously, `counter' is only available for parameters applying to
3071 items."
3095 export-sublist ; for byte-compiler
3098 ;; Export an item ITEM of type TYPE, at DEPTH. First
3099 ;; string in item is treated in a special way as it can
3100 ;; bring extra information that needs to be processed.
3106 ;; Stick DTSTART to ISTART by
3107 ;; left-trimming the latter.
3111 istart))
3118 ;; Replace checkbox if any is found.
3126 ;; Replace line breaks if required
3128 ;; Insert descriptive term if TYPE is `descriptive'.
3137 first)))
3148 ;; Export sublist SUB at DEPTH.
3166 "Convert LIST into a LaTeX list.
3167 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3168 with overruling parameters for `org-list-to-generic'."
3170 list
3179 ;; LaTeX increments counter just before
3180 ;; using it, so set it to the desired
3181 ;; value, minus one.
3188 params)))
3191 "Convert LIST into a HTML list.
3192 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3193 with overruling parameters for `org-list-to-generic'."
3195 list
3207 params)))
3210 "Convert LIST into a Texinfo list.
3211 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3212 with overruling parameters for `org-list-to-generic'."
3214 list
3225 params)))
3228 "Convert LIST into an Org subtree.
3229 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3230 with overruling parameters for `org-list-to-generic'."
3240 ;; Return the string for the heading, depending on depth D
3241 ;; of current sub-list.
3246 oddeven-level)
3247 ?*)
3250 list
3252 '(:splice t
3259 params))))
3263 ;;; org-list.el ends here