| blob | d24dad28363de28ceadac9b06c426b7eefb94d05 |
1 ;;; org-list.el --- Plain lists for Org-mode
2 ;;
3 ;; Copyright (C) 2004-2014 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Bastien Guerry <bzg@gnu.org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
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:
139 \f
140 ;;; Configuration variables
143 "Options concerning plain lists in Org-mode."
148 "When t, make TAB cycle visibility on plain list items.
149 Cycling plain lists works only when the cursor is on a plain list
150 item. When the cursor is on an outline heading, plain lists are
151 treated as text. This is the most stable way of handling this,
152 which is why it is the default.
154 When this is the symbol `integrate', then integrate plain list
155 items when cycling, as if they were children of outline headings.
157 This setting can lead to strange effects when switching visibility
160 plain list item with an implied large level number, all true
161 children and grand children of the outline heading will be
162 exposed in a children' view."
171 "Default bullet type installed when demoting an item.
172 This is an association list, for each bullet type, this alist will point
173 to the bullet that should be used when this item is demoted.
174 For example,
176 (setq org-list-demote-modify-bullet
179 will make
181 + Movies
182 + Silence of the Lambs
183 + My Cousin Vinny
184 + Books
185 + The Hunt for Red October
186 + The Road to Omaha
188 into
190 + Movies
191 - Silence of the Lambs
192 - My Cousin Vinny
193 + Books
194 - The Hunt for Red October
195 - The Road to Omaha"
213 "The character that makes a line with leading number an ordered list item.
214 Valid values are ?. and ?\). To get both terminators, use t."
223 "Non-nil means single character alphabetical bullets are allowed.
225 Both uppercase and lowercase are handled. Lists with more than
226 26 items will fallback to standard numbering. Alphabetical
229 This variable needs to be set before org.el is loaded. If you
230 need to make a change while Emacs is running, use the customize
231 interface or run the following code after updating it:
242 "A regular expression matching bullets that should have 2 spaces after them.
243 When nil, no bullet will have two spaces after them. When
244 a string, it will be used as a regular expression. When the
245 bullet type of a list is changed, the new bullet type will be
246 matched against this regexp. If it matches, there will be two
247 spaces instead of one after the bullet in each item of the list."
256 "Non-nil means an empty line ends all plain list levels.
257 Otherwise, two of them will be necessary."
263 "Non-nil means apply set of rules when acting on lists.
264 By default, automatic actions are taken when using
269 rules by setting them to nil. Valid rules are:
271 checkbox when non-nil, checkbox statistics is updated each time
272 you either insert a new checkbox or toggle a checkbox.
273 indent when non-nil, indenting or outdenting list top-item
274 with its subtree will move the whole list and
275 outdenting a list whose bullet is * to column 0 will
280 :key-type
284 :value-type
288 "Non-nil means commands implying motion in lists should be cyclic.
290 In that case, the item following the last item is the first one,
291 and the item preceding the first item is the last one.
301 "Hook that is run whenever Org thinks checkbox statistics should be updated.
302 This hook runs even if checkbox rule in
303 `org-list-automatic-rules' does not apply, so it can be used to
304 implement alternative ways of collecting statistics
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
320 "Maximum indentation for the second line of a description list.
321 When the indentation would be larger than this, it will become
322 5 characters instead."
327 "Additional indentation for sub-items in a list.
328 By setting this to a small number, usually 1 or 2, one can more
329 clearly distinguish sub-items in a list."
336 % END RECEIVE ORGLST %n
338 #+ORGLST: SEND %n org-list-to-latex
339 -
342 @c END RECEIVE ORGLST %n
343 @ignore
344 #+ORGLST: SEND %n org-list-to-texinfo
345 -
348 <!-- END RECEIVE ORGLST %n -->
349 <!--
350 #+ORGLST: SEND %n org-list-to-html
351 -
353 "Templates for radio lists in different major modes.
354 All occurrences of %n in a template will be replaced with the name of the
355 list, obtained by prompting the user."
363 "Names of blocks where lists are not allowed.
367 "Context types where lists will be interpreted during export.
369 Valid types are `drawer', `inlinetask' and `block'. More
370 specifically, type `block' is determined by the variable
374 \f
375 ;;; Predicates and regexps
379 "Regex corresponding to the end of a list.
387 "Matches a list item and puts everything into groups:
388 group 1: bullet
389 group 2: counter
390 group 3: checkbox
394 "Return the correct regular expression for plain lists."
405 "Regexp matching the beginning of a plain list item."
409 "Is point at a list item with REGEXP after bullet?"
418 ;; Ignore counter if any
423 "Is point in a context where lists are allowed?"
427 "Return item beginning position when in a plain list, nil otherwise."
439 ;; Indentation isn't meaningful when point starts at an empty
440 ;; line or an inline task.
443 10000
449 ;; Detect if cursor in amidst `org-list-end-re'. First, count
450 ;; number HL of hard lines it takes, then call `org-in-regexp'
451 ;; to compute its boundaries END-BOUNDS. When point is
452 ;; in-between, move cursor before regexp beginning.
463 ;; Look for an item, less indented that reference line.
468 ;; This is exactly what we want.
471 ;; At upper bound of search or looking at the end of a
472 ;; previous list: search is over.
475 ;; Skip blocks, drawers, inline-tasks, blank lines
485 ;; Text at column 0 cannot belong to a list: stop.
487 ;; Normal text less indented than reference line, take
488 ;; it as new reference.
495 "Is point in a line starting a hand-formatted item?"
501 "Is point at the bullet of a plain list item?"
507 "Is point at a line starting a plain list item with a timer?"
512 "Is point at a description list item?"
516 "Is point at a line starting a plain-list item with a checklet?"
520 "Is point at a line starting a plain-list item with a counter?"
526 \f
527 ;;; Structures and helper functions
530 "Determine context, and its boundaries, around point.
532 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
533 are boundaries and CONTEXT is a symbol among `drawer', `block',
534 `invalid', `inlinetask' and nil.
536 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
542 ;; Get positions of surrounding headings. This is the
543 ;; default context.
548 ;; Is point inside a drawer?
550 ;; Can't use org-drawers-regexp as this function might
551 ;; be called in buffers not in Org mode.
562 lim-down))
565 ;; Is point strictly in a block, and of which type?
576 lim-down))
582 ;; Is point in an inlinetask?
595 ;; Return context boundaries and type.
599 "Return structure of list at point.
601 A list structure is an alist where key is point at item, and
602 values are:
603 1. indentation,
604 2. bullet with trailing whitespace,
605 3. bullet counter, if any,
606 4. checkbox, if any,
607 5. description tag, if any,
608 6. position at item end.
610 Thus the following list, where numbers in parens are
611 point-at-bol:
613 - [X] first item (1)
614 1. sub-item 1 (18)
615 5. [@5] sub-item 2 (34)
616 some other text belonging to first item (55)
617 - last item (97)
618 + tag :: description (109)
619 (131)
621 will get the following structure:
629 Assume point is at an item."
644 ind itm-lst itm-lst-2 end-lst end-lst-2 struct
647 ;; Return association at point.
652 ind
653 bullet
656 ;; Description tag.
661 ;; Ensure list ends at the first blank line.
665 ;; 1. Read list from starting item to its beginning, and save
666 ;; top item position and indentation in BEG-CELL. Also store
667 ;; ending position of items in END-LST.
674 ;; At upward limit: if we ended at an item, store it,
675 ;; else dismiss useless data recorded above BEG-CELL.
676 ;; Jump to part 2.
683 ;; Looking at a list ending regexp. Dismiss useless
684 ;; data recorded above BEG-CELL. Jump to part 2.
689 ;; Point is at an item. Add data to ITM-LST. It may
690 ;; also end a previous item: save it in END-LST. If
691 ;; ind is less or equal than BEG-CELL and there is no
692 ;; end at this ind or lesser, this item becomes the new
693 ;; BEG-CELL.
699 ;; Skip blocks, drawers, inline tasks, blank lines.
710 ;; From there, point is not at an item. Interpret
711 ;; line's indentation:
712 ;; - text at column 0 is necessarily out of any list.
713 ;; Dismiss data recorded above BEG-CELL. Jump to
714 ;; part 2.
715 ;; - any other case may be an ending position for an
716 ;; hypothetical item above. Store it and proceed.
725 ;; 2. Read list from starting point to its end, that is until we
726 ;; get out of context, or that a non-item line is less or
727 ;; equally indented than BEG-CELL's cdr. Also, store ending
728 ;; position of items in END-LST-2.
734 ;; At downward limit: this is de facto the end of the
735 ;; list. Save point as an ending position, and jump to
736 ;; part 3.
739 ;; Looking at a list ending regexp. Save point as an
740 ;; ending position and jump to part 3.
744 ;; Point is at an item. Add data to ITM-LST-2. It may
745 ;; also end a previous item, so save it in END-LST-2.
749 ;; Skip inline tasks and blank lines along the way
754 ;; Ind is lesser or equal than BEG-CELL's. The list is
755 ;; over: store point as an ending position and jump to
756 ;; part 3.
760 ;; Else, if ind is lesser or equal than previous item's,
761 ;; this is an ending position: store it. In any case,
762 ;; skip block or drawer at point, and move to next line.
774 ;; 3. Associate each item to its end position.
776 ;; 4. Return STRUCT
777 struct)))
780 "Associate proper ending point to items in STRUCT.
782 END-LIST is a pseudo-alist where car is indentation and cdr is
783 ending position.
785 This function modifies STRUCT."
791 ;; Remove end candidates behind current item.
794 ;; Add end position to item assoc.
800 struct)))
803 "Return alist between item and previous item in STRUCT."
805 struct)))
809 struct)))
812 "Return alist between item and parent in STRUCT."
824 ;; A sub-list is over. Find the associated
825 ;; origin in IND-TO-ORI. If it cannot be
826 ;; found (ill-formed list), set its parent as
827 ;; the first item less indented. If there is
828 ;; none, make it a top-level item.
836 ind-to-ori)
839 ;; A sub-list starts. Every item at IND will
840 ;; have previous item as its parent.
845 ;; Another item in the same sub-list: it shares
846 ;; the same parent as the previous item.
851 \f
852 ;;; Accessors
855 "Return the Nth value of KEY in STRUCT."
859 "Set the Nth value of KEY in STRUCT to NEW.
864 "Return indentation of ITEM in STRUCT."
868 "Set indentation of ITEM in STRUCT to IND.
873 "Return bullet of ITEM in STRUCT."
877 "Set bullet of ITEM in STRUCT to BULLET.
882 "Return counter of ITEM in STRUCT."
886 "Return checkbox of ITEM in STRUCT or nil."
890 "Set checkbox of ITEM in STRUCT to CHECKBOX.
895 "Return end position of ITEM in STRUCT."
899 "Return end position of ITEM in STRUCT."
903 "Return point at end of ITEM in STRUCT, before any blank line.
904 Point returned is at end of line."
911 "Return parent of ITEM or nil.
912 STRUCT is the list structure. PARENTS is the alist of parents,
913 as returned by `org-list-parents-alist'."
918 "Non-nil if ITEM has a child.
920 STRUCT is the list structure.
922 Value returned is the position of the first child of ITEM."
927 child-maybe)))
930 "Return next item in same sub-list as ITEM, or nil.
931 STRUCT is the list structure. PREVS is the alist of previous
932 items, as returned by `org-list-prevs-alist'."
936 "Return previous item in same sub-list as ITEM, or nil.
937 STRUCT is the list structure. PREVS is the alist of previous
938 items, as returned by `org-list-prevs-alist'."
942 "List all items having ITEM as a common ancestor, or nil.
943 STRUCT is the list structure."
946 subtree)
951 sub-struct))
955 "List all items in the same sub-list as ITEM.
956 STRUCT is the list structure. PREVS is the alist of previous
957 items, as returned by `org-list-prevs-alist'."
960 before-item after-item)
968 "List all children of ITEM, or nil.
969 STRUCT is the list structure. PARENTS is the alist of parents,
970 as returned by `org-list-parents-alist'."
978 "Return point at beginning of list.
979 STRUCT is the list structure."
983 "Return point at bottom of list.
984 STRUCT is the list structure."
989 "Return point at beginning of sub-list ITEM belongs.
990 STRUCT is the list structure. PREVS is the alist of previous
991 items, as returned by `org-list-prevs-alist'."
995 first-item))
1000 "Return point at last item of sub-list ITEM belongs.
1001 STRUCT is the list structure. PREVS is the alist of previous
1002 items, as returned by `org-list-prevs-alist'."
1006 last-item))
1009 "Return point at end of sub-list ITEM belongs.
1010 STRUCT is the list structure. PREVS is the alist of previous
1011 items, as returned by `org-list-prevs-alist'."
1015 "Return the type of the list containing ITEM, as a symbol.
1017 STRUCT is the list structure. PREVS is the alist of previous
1018 items, as returned by `org-list-prevs-alist'.
1020 Possible types are `descriptive', `ordered' and `unordered'. The
1021 type is determined by the first item of the list."
1029 "Return ITEM's sequence number.
1031 STRUCT is the list structure. PREVS is the alist of previous
1032 items, as returned by `org-list-prevs-alist'. PARENTS is the
1033 alist of ancestors, as returned by `org-list-parents-alist'.
1035 Return value is a list of integers. Counters have an impact on
1036 that value."
1040 ;; Return relative sequence number of ITEM in the sub-list
1041 ;; it belongs. STRUCT is the list structure. PREVS is
1042 ;; the alist of previous items.
1051 seq))
1055 ;; Cons each parent relative number into return value (OUT).
1060 ;; Return value.
1061 out)))
1064 \f
1065 ;;; Searching
1068 "Search a string in valid contexts for lists.
1069 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1070 in `re-search-forward'."
1074 ;; 1. No match: return to origin or bound, depending on NOERR.
1077 nil)))
1078 ;; 2. Match in valid context: return point. Else, continue
1079 ;; searching.
1083 "Like `re-search-backward' but stop only where lists are recognized.
1084 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1085 `re-search-backward'."
1090 "Like `re-search-forward' but stop only where lists are recognized.
1091 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1092 `re-search-forward'."
1097 \f
1098 ;;; Methods on structures
1101 "Return BULLET with the correct number of whitespaces.
1102 It determines the number of whitespaces to append by looking at
1103 `org-list-two-spaces-after-bullet-regexp'."
1107 org-list-two-spaces-after-bullet-regexp bullet))
1108 " "
1112 bullet))))
1115 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1117 Blank lines at the end of items are left in place. Item
1118 visibility is preserved. Return the new structure after the
1119 changes.
1121 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1122 to the same sub-list.
1124 This function modifies STRUCT."
1137 ;; Store overlays responsible for visibility status. We
1138 ;; also need to store their boundaries as they will be
1139 ;; removed from buffer.
1147 ;; 1. Move effectively items in buffer.
1151 ;; 2. Now modify struct. No need to re-read the list, the
1152 ;; transformation is just a shift of positions. Some special
1153 ;; attention is required for items ending at END-A and END-B
1154 ;; as empty spaces are not moved there. In others words,
1155 ;; item BEG-A will end with whitespaces that were at the end
1156 ;; of BEG-B and the same applies to BEG-B.
1178 struct)
1180 ;; Restore visibility status, by moving overlays to their new
1181 ;; position.
1193 ;; Return structure.
1194 struct)))
1197 "Return number of blank lines that should separate items in list.
1199 POS is the position of point where `org-list-insert-item' was called.
1201 STRUCT is the list structure. PREVS is the alist of previous
1202 items, as returned by `org-list-prevs-alist'.
1204 Assume point is at item's beginning. If the item is alone, apply
1205 some heuristics to guess the result."
1210 usr-blank
1214 ;; Count blank lines above beginning of line.
1221 ;; Trivial cases where there should be none.
1223 ;; When `org-blank-before-new-entry' says so, it is 1.
1225 ;; `plain-list-item' is 'auto. Count blank lines separating
1226 ;; neighbors' items in list.
1229 ;; Is there a next item?
1232 ;; Is there a previous item?
1235 ;; User inserted blank lines, trust him.
1240 usr-blank)
1241 ;; Are there blank lines inside the list so far?
1244 ;; Do not use `org-list-search-forward' so blank lines
1245 ;; in blocks can be counted in.
1249 ;; Default choice: no blank line.
1253 "Insert a new list item at POS and return the new structure.
1254 If POS is before first character after bullet of the item, the
1255 new item will be created before the current one.
1257 STRUCT is the list structure. PREVS is the the alist of previous
1258 items, as returned by `org-list-prevs-alist'.
1260 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1261 after the bullet. Cursor will be after this text once the
1262 function ends.
1264 This function modifies STRUCT."
1266 ;; 1. Get information about list: position of point with regards
1267 ;; to item start (BEFOREP), blank lines number separating items
1268 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1275 ;; Do not count tag in a non-descriptive list.
1283 pos struct prevs))
1284 ;; 2. Build the new item to be created. Concatenate same
1285 ;; bullet as item, checkbox, text AFTER-BULLET if
1286 ;; provided, and text cut from point to end of item
1287 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1288 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1289 ;; between what was cut and what was inserted in buffer
1290 ;; is stored in SIZE-OFFSET.
1294 ind))
1301 ;; If POS is greater than ITEM-END, then point is
1302 ;; in some white lines after the end of the list.
1303 ;; Those must be removed, or they will be left,
1304 ;; stacking up after the list.
1314 text-cut))))
1318 ;; 4. Insert effectively item into buffer.
1322 ;; 5. Add new item to STRUCT.
1326 ;; Before inserted item, positions don't change but
1327 ;; an item ending after insertion has its end shifted
1328 ;; by SIZE-OFFSET.
1331 ;; Trivial cases where current item isn't split in
1332 ;; two. Just shift every item after new one by
1333 ;; ITEM-SIZE.
1337 ;; Item is split in two: elements before POS are just
1338 ;; shifted by ITEM-SIZE. In the case item would end
1339 ;; after split POS, ending is only shifted by
1340 ;; SIZE-OFFSET.
1346 ;; Elements after POS are moved into new item.
1347 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1348 ;; doesn't appear in buffer yet.
1354 (+ end size-offset
1356 ;; Elements at ITEM-END or after are only shifted by
1357 ;; SIZE-OFFSET.
1360 struct)
1363 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1364 ;; exchange ITEM with the next item in list. Position cursor
1365 ;; after bullet, counter, checkbox, and label.
1371 struct)))
1374 "Remove ITEM from the list and return the new structure.
1376 STRUCT is the list structure."
1379 ;; If ITEM ends with the list, delete blank lines
1380 ;; before it.
1385 item)))
1386 ;; Remove item from buffer.
1388 ;; Remove item from structure and shift others items accordingly.
1389 ;; Don't forget to shift also ending position when appropriate.
1407 struct)))))
1410 "Send ITEM to destination DEST.
1412 STRUCT is the list structure.
1414 DEST can have various values.
1416 If DEST is a buffer position, the function will assume it points
1417 to another item in the same list as ITEM, and will move the
1418 latter just before the former.
1420 If DEST is `begin' (respectively `end'), ITEM will be moved at
1421 the beginning (respectively end) of the list it belongs to.
1424 be moved at the Nth position in the list.
1426 If DEST is `kill', ITEM will be deleted and its body will be
1427 added to the kill-ring.
1429 If DEST is `delete', ITEM will be deleted.
1431 Visibility of item is preserved.
1433 This function returns, destructively, the new list structure."
1436 ;; Grab full item body minus its bullet.
1445 item-end)))
1446 ;; Change DEST into a buffer position. A trick is needed
1447 ;; when ITEM is meant to be sent at the end of the list.
1448 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1449 ;; nil and insertion point (INS-POINT) to the first line's
1450 ;; end of the last item, we ensure the new item will be
1451 ;; inserted after the last item, and not after any of its
1452 ;; hypothetical sub-items.
1468 ;; Send ITEM at the end of the list.
1476 ;; Store visibility.
1486 ;; 1. Structure returned by `org-list-insert-item' may not be
1487 ;; accurate, as it cannot see sub-items included in BODY.
1488 ;; Thus, first compute the real structure so far.
1496 ;; 1.1. Remove the item just created in structure.
1498 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1501 struct
1509 new-end
1511 moved-items))
1513 ;; 2. Restore visibility.
1518 visibility)
1519 ;; 3. Eventually delete extra copy of the item and clean marker.
1525 "Outdent items between positions START and END.
1527 STRUCT is the list structure. PARENTS is the alist of items'
1528 parents, as returned by `org-list-parents-alist'.
1530 START is included, END excluded."
1536 ;; Item not yet in zone: keep association.
1538 ;; Item out of zone: follow associations in ACC.
1542 ;; Item has no parent: error
1545 ;; Parent is outdented: keep association.
1549 ;; Parent isn't outdented: reparent to grand-parent.
1551 parent struct parents)))
1557 "Indent items between positions START and END.
1559 STRUCT is the list structure. PARENTS is the alist of parents
1560 and PREVS is the alist of previous items, returned by,
1561 respectively, `org-list-parents-alist' and
1562 `org-list-prevs-alist'.
1564 START is included and END excluded.
1566 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1567 bullets between START and END."
1575 ;; Normalize ordered bullets.
1585 org-list-demote-modify-bullet))))
1592 ;; Item not yet in zone: keep association.
1595 ;; Item out of zone: follow associations in ACC.
1599 ;; Item is in zone...
1601 ;; Check if bullet needs to be changed.
1604 ;; First item indented but not parent: error
1607 ;; First item and parent indented: keep same
1608 ;; parent.
1610 ;; Previous item not indented: reparent to it.
1612 ;; Previous item indented: reparent like it.
1619 \f
1620 ;;; Repairing structures
1623 "Non-nil if list starting at FIRST can have alphabetical bullets.
1625 STRUCT is list structure. PREVS is the alist of previous items,
1626 as returned by `org-list-prevs-alist'."
1630 ;; Pretend that bullets are uppercase and check if alphabet
1631 ;; is sufficient, taking counters into account.
1635 ;; Virtually determine current bullet
1637 ;; Counters are not case-sensitive.
1640 ;; Test if bullet would be over z or Z.
1644 ;; All items checked. All good.
1645 t))))
1648 "Increment BULLET if applicable."
1651 ;; Num bullet: increment it.
1655 nil nil bullet))
1656 ;; Alpha bullet: increment it.
1660 nil nil bullet))
1661 ;; Unordered bullet: leave it.
1665 "Verify and correct bullets in STRUCT.
1666 PREVS is the alist of previous items, as returned by
1667 `org-list-prevs-alist'.
1669 This function modifies STRUCT."
1673 ;; Set bullet of ITEM in STRUCT, depending on the type of
1674 ;; first item of the list, the previous bullet and counter
1675 ;; if any.
1684 item struct
1687 ;; Alpha counter in alpha list: use counter.
1691 ;; Use cond to be sure `string-match' is used in
1692 ;; both cases.
1698 ;; Num counter in a num list: use counter.
1703 ;; No counter: increase, if needed, previous bullet.
1706 ;; Alpha counter at first item: use counter.
1715 ;; Num counter at first item: use counter.
1720 ;; First bullet is alpha uppercase: use "A".
1723 ;; First bullet is alpha lowercase: use "a".
1726 ;; First bullet is num: use "1".
1729 ;; Not an ordered list: keep bullet.
1734 "Verify and correct indentation in STRUCT.
1736 PARENTS is the alist of parents, as returned by
1737 `org-list-parents-alist'.
1739 If numeric optional argument BULLET-SIZE is set, assume all
1740 bullets in list have this length to determine new indentation.
1742 This function modifies STRUCT."
1749 ;; Indent like parent + length of parent's bullet +
1750 ;; sub-list offset.
1756 org-list-indent-offset))
1757 ;; If no parent, indent like top-point.
1762 "Verify and correct checkboxes in STRUCT.
1764 PARENTS is the alist of parents and PREVS is the alist of
1765 previous items, as returned by, respectively,
1766 `org-list-parents-alist' and `org-list-prevs-alist'.
1768 If ORDERED is non-nil, a checkbox can only be checked when every
1769 checkbox before it is checked too. If there was an attempt to
1770 break this rule, the function will return the blocking item. In
1771 all others cases, the return value will be nil.
1773 This function modifies STRUCT."
1783 item struct
1789 ;; Parent has no boxed child: leave box as-is.
1791 parent-list)
1792 ;; 1. List all parents with a checkbox.
1799 all-items)
1800 ;; 2. Sort those parents by decreasing indentation.
1805 ;; 3. For each parent, get all children's checkboxes to determine
1806 ;; and set its checkbox accordingly.
1808 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1813 ;; There are boxes checked after an unchecked one: fix that.
1820 ;; Verify once again the structure, without ORDERED.
1822 ;; Return blocking item.
1826 "Verify and correct each item end position in STRUCT.
1828 This function modifies STRUCT."
1835 ;; To determine real ind of an ending position that is
1836 ;; not at an item, we have to find the item it belongs
1837 ;; to: it is the last item (ITEM-UP), whose ending is
1838 ;; further than the position we're interested in.
1841 ;; Else part is for the bottom point.
1843 end-pos)
1844 end-list)))
1847 struct)
1852 "Apply set difference between STRUCT and OLD-STRUCT to the buffer.
1854 OLD-STRUCT is the structure before any modifications, and STRUCT
1855 the structure to be applied. The function will only modify parts
1856 of the list which have changed.
1858 Initial position of cursor is restored after the changes."
1865 ;; Shift the indentation between END and BEG by DELTA. If
1866 ;; MAX-IND is non-nil, ensure that no line will be indented
1867 ;; more than that number. Start from the line before END.
1876 ;; Skip inline tasks.
1879 ;; Shift only non-empty lines.
1887 ;; Replace ITEM first line elements with new elements from
1888 ;; STRUCT, if appropriate.
1898 ;; a. Replace bullet
1901 ;; b. Replace checkbox.
1912 ;; c. Indent item to appropriate column.
1917 ;; 1. First get list of items and position endings. We maintain
1918 ;; two alists: ITM-SHIFT, determining indentation shift needed
1919 ;; at item, and END-LIST, a pseudo-alist where key is ending
1920 ;; position and value point.
1933 ;; To determine real ind of an ending position that
1934 ;; is not at an item, we have to find the item it
1935 ;; belongs to: it is the last item (ITEM-UP), whose
1936 ;; ending is further than the position we're
1937 ;; interested in.
1941 ;; 2. Slice the items into parts that should be shifted by the
1942 ;; same amount of indentation. Each slice follow the pattern
1943 ;; (END BEG DELTA MAX-IND-OR-NIL). Slices are returned in
1944 ;; reverse order.
1947 '<))
1954 ;; If we're not at an item, there's a child of the item
1955 ;; point belongs to above. Make sure this slice isn't
1956 ;; moved within that child by specifying a maximum
1957 ;; indentation.
1961 org-list-indent-offset))))
1963 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1964 ;; end to beginning. Take a special action when beginning is
1965 ;; at item bullet.
1973 ;; 4. Go back to initial position and clean marker.
1978 "Correct bullets, checkboxes and indentation in list at point.
1980 STRUCT is the list structure. PARENTS is the alist of parents,
1981 as returned by `org-list-parents-alist'.
1983 When non-nil, optional argument OLD-STRUCT is the reference
1984 structure of the list. It should be provided whenever STRUCT
1985 doesn't correspond anymore to the real list in buffer."
1986 ;; Order of functions matters here: checkboxes and endings need
1987 ;; correct indentation to be set, and indentation needs correct
1988 ;; bullets.
1989 ;;
1990 ;; 0. Save a copy of structure before modifications
1992 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1993 ;; order to get items endings and bullets properly
1995 ;; 2. Fix each item end to get correct prevs alist.
1997 ;; 3. Get bullets right.
2000 ;; 4. Now get real indentation.
2002 ;; 5. Eventually fix checkboxes.
2004 ;; 6. Apply structure modifications to buffer.
2008 \f
2009 ;;; Misc Tools
2012 "Call FUNCTION on each item of the list at point.
2013 FUNCTION must be called with at least one argument: INIT-VALUE,
2014 that will contain the value returned by the function at the
2015 previous item, plus ARGS extra arguments.
2017 FUNCTION is applied on items in reverse order.
2019 As an example, \(org-apply-on-list \(lambda \(result\) \(1+ result\)\) 0\)
2020 will return the number of items in the current list.
2022 Sublists of the list are skipped. Cursor is always at the
2023 beginning of the item."
2035 value))
2038 "Set visibility of ITEM in STRUCT to VIEW.
2040 Possible values are: `folded', `children' or `subtree'. See
2041 `org-cycle' for more information."
2045 ;; Hide from eol
2047 item-end t)))
2049 ;; First show everything.
2051 ;; Then fold every child.
2056 children)))
2058 ;; Show everything
2063 "Return column at which body of ITEM should start."
2073 tcol))
2076 \f
2077 ;;; Interactive functions
2082 "Go to the beginning of the current item.
2083 Throw an error when not in a list."
2089 "Go to the beginning item of the current list or sublist.
2090 Throw an error when not in a list."
2101 "Go to the end of the current list or sublist.
2102 Throw an error when not in a list."
2113 "Go to the end of the current item.
2114 Throw an error when not in a list."
2124 "Move to the beginning of the previous item.
2125 Throw an error when not in a list. Also throw an error when at
2126 first item, unless `org-list-use-circular-motion' is non-nil."
2142 "Move to the beginning of the next item.
2143 Throw an error when not in a list. Also throw an error when at
2144 last item, unless `org-list-use-circular-motion' is non-nil."
2160 "Move the item at point down, i.e. swap with following item.
2161 Sub-items (items with larger indentation) are considered part of
2162 the item, so this really moves item trees."
2181 "Move the item at point up, i.e. swap with previous item.
2182 Sub-items (items with larger indentation) are considered part of
2183 the item, so this really moves item trees."
2200 "Insert a new item at the current level.
2201 If cursor is before first character after bullet of the item, the
2202 new item will be created before the current one.
2204 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2206 Return t when things worked, nil when we are not in an item, or
2207 item is invisible."
2210 ;; If cursor isn't is a list or if list is invisible, return nil.
2218 ;; Timer list: delegate to `org-timer-item'.
2223 ;; If we're in a description list, ask for the new term.
2237 t)))))
2240 "Fix indentation, bullets and checkboxes is the list at point."
2248 "Cycle through the different itemize/enumerate bullets.
2249 This cycle the entire list level through the sequence:
2251 `-' -> `+' -> `*' -> `1.' -> `1)'
2253 If WHICH is a valid string, use that as the new bullet. If WHICH
2254 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2255 `previous', cycle backwards."
2275 ;; Compute list of possible bullets, depending on context.
2278 ;; *-bullets are not allowed at column 0.
2280 ;; Description items cannot be numbered.
2303 ;; Use a short variation of `org-list-write-struct' as there's
2304 ;; no need to go through all the steps.
2312 "Toggle the checkbox in the current line.
2313 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2314 double prefix, set checkbox to [-].
2316 When there is an active region, toggle status or presence of the
2317 first checkbox there, and make every item inside have the same
2318 status or presence, respectively.
2320 If the cursor is in a headline, apply this to all checkbox items
2321 in the text below the heading, taking as reference the first item
2322 in subtree, ignoring drawers."
2326 block-item
2327 lim-up
2328 lim-down
2339 ;; In a region, start at first item in region.
2349 ;; On an heading, start at first item after drawers and
2350 ;; time-stamps (scheduled, etc.).
2361 ;; Just one item: set SINGLEP flag.
2367 ;; Determine the checkbox going to be applied to all items
2368 ;; within bounds.
2379 ;; When an item is found within bounds, grab the full list at
2380 ;; point structure, then: (1) set check-box of all its items
2381 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2382 ;; whole list, (3) move point after the list.
2396 e struct
2397 ;; If there is no box at item, leave as-is
2398 ;; unless function was called with C-u prefix.
2401 ref-checkbox
2402 cur-box))))
2403 items-to-toggle)
2405 struct parents prevs orderedp))
2406 ;; Report some problems due to ORDERED status of subtree.
2407 ;; If only one box was being checked, throw an error, else,
2408 ;; only signal problems.
2412 "Checkbox blocked because of unchecked box at line %d"
2416 "Checkboxes were removed due to unchecked box at line %d"
2425 "Reset all checkboxes in an entry subtree."
2442 "Update the checkbox statistics in the current section.
2443 This will find all statistic cookies like [57%] and [6/12] and
2444 update them with the current numbers.
2446 With optional prefix argument ALL, do this for the whole buffer."
2450 (box-re "^[ \t]*\\([-+*]\\|\\([0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2462 ;; Return number of checked boxes and boxes of all types
2463 ;; in all structures in STRUCTS. If RECURSIVEP is
2464 ;; non-nil, also count boxes in sub-lists. If ITEM is
2465 ;; nil, count across the whole structure, else count only
2466 ;; across subtree whose ancestor is ITEM.
2483 items))))
2486 structs)
2489 cookies-list structs-bak box-num)
2491 ;; 1. Build an alist for each cookie found within BOUNDS. The
2492 ;; key will be position at beginning of cookie and values
2493 ;; ending position, format of cookie, and a cell whose car is
2494 ;; number of checked boxes to report, and cdr total number of
2495 ;; boxes.
2505 ;; Cookie is at an heading, but specifically for todo,
2506 ;; not for checkboxes: skip it.
2512 ;; Cookie is at an heading, but all lists before next
2513 ;; heading already have been read. Use data collected
2514 ;; in STRUCTS-BAK. This should only happen when
2515 ;; heading has more than one cookie on it.
2518 backup-end))
2520 ;; Cookie is at a fresh heading. Grab structure of
2521 ;; every list containing a checkbox between point and
2522 ;; next headline, and save them in STRUCTS-BAK.
2526 structs-bak nil)
2533 ;; Cookie is at an item, and we already have list
2534 ;; structure stored in STRUCTS-BAK.
2537 ;; Only lists in no special context are stored.
2540 ;; Cookie is at an item, but we need to compute list
2541 ;; structure.
2547 ;; Else, cookie found is at a wrong place. Skip it.
2549 cookies-list))))
2550 ;; 2. Apply alist to buffer, in reverse order so positions stay
2551 ;; unchanged after cookie modifications.
2566 cookies-list))))
2569 "Select the face for checkbox statistics.
2570 The face will be `org-done' when all relevant boxes are checked.
2571 Otherwise it will be `org-todo'."
2574 'org-checkbox-statistics-done
2578 'org-checkbox-statistics-done
2582 "Update checkbox statistics unless turned off by user.
2583 With an optional argument ALL, update them in the whole buffer."
2591 "Indent a local list item including its children.
2592 When number ARG is a negative, item will be outdented, otherwise
2593 it will be indented.
2595 If a region is active, all items inside will be moved.
2597 If NO-SUBTREE is non-nil, only indent the item itself, not its
2598 children.
2600 STRUCT is the list structure.
2602 Return t if successful."
2610 ;; Are we going to move the whole list?
2618 t))))
2619 ;; Determine begin and end points of zone to indent. If moving
2620 ;; more than one item, save them for subsequent moves.
2636 ;; Special case: moving top-item with indent rule.
2644 ;; Change bullet if necessary.
2650 ;; Shift every item by OFFSET and fix bullets. Then
2651 ;; apply changes to buffer.
2655 struct)
2658 ;; Forbidden move:
2660 ;; If only one item is moved, it mustn't have a child.
2664 ;; If a subtree or region is moved, the last item
2665 ;; of the subtree mustn't have a child.
2670 struct)))))
2673 ;; Normal shifting
2681 t)
2684 "Outdent a local list item, but not its children.
2685 If a region is active, all items inside will be moved."
2701 "Indent a local list item, but not its children.
2702 If a region is active, all items inside will be moved."
2718 "Outdent a local list item including its children.
2719 If a region is active, all items inside will be moved."
2735 "Indent a local list item including its children.
2736 If a region is active, all items inside will be moved."
2753 "Cycle levels of indentation of an empty item.
2754 The first run indents the item, if applicable. Subsequent runs
2755 outdent it at meaningful levels in the list. When done, item is
2756 put back at its original position with its original bullet.
2758 Return t at each successful move."
2764 ;; Accept empty items or if cycle has already started.
2775 ;; When in the middle of the cycle, try to outdent first. If
2776 ;; it fails, and point is still at initial position, indent.
2777 ;; Else, re-create it at its original position.
2786 ;; Break cycle
2788 ;; If a cycle is starting, remember indentation and bullet,
2789 ;; then try to indent. If it fails, try to outdent.
2795 t))))
2798 "Sort list items.
2799 The cursor may be at any item of the list that should be sorted.
2800 Sublists are not sorted. Checkboxes, if any, are ignored.
2802 Sorting can be alphabetically, numerically, by date/time as given
2803 by a time stamp, by a property or by priority.
2805 Comparing entries ignores case by default. However, with an
2806 optional argument WITH-CASE, the sorting considers case as well.
2808 The command prompts for the sorting type unless it has been given
2809 to the function through the SORTING-TYPE argument, which needs to
2810 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F ?x ?X). Here is the
2811 detailed meaning of each character:
2813 n Numerically, by converting the beginning of the item to a number.
2814 a Alphabetically. Only the first line of item is checked.
2815 t By date/time, either the first active time stamp in the entry, if
2816 any, or by the first inactive one. In a timer list, sort the timers.
2819 Capital letters will reverse the sort order.
2821 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2822 a function to be called with point at the beginning of the
2823 record. It must return either a string or a number that should
2824 serve as the sorting key for that record. It will then use
2825 COMPARE-FUNC to compare entries.
2827 Sorting is done against the visible part of the headlines, it
2828 ignores hidden links."
2879 ;; If it is a timer list, convert timer to seconds
2896 value))
2900 next-record
2901 end-record
2902 value-to-sort
2903 nil
2904 sort-func)
2905 ;; Read and fix list again, as `sort-subr' probably destroyed
2906 ;; its structure.
2912 \f
2913 ;;; Send and receive lists
2916 "Parse the list at point and maybe DELETE it.
2918 Return a list whose car is a symbol of list type, among
2919 `ordered', `unordered' and `descriptive'. Then, each item is
2920 a list whose car is counter, and cdr are strings and other
2921 sub-lists. Inside strings, check-boxes are replaced by
2924 For example, the following list:
2926 1. first item
2927 + sub-item one
2928 + [X] sub-item two
2929 more text in first item
2930 2. [@3] last item
2932 will be parsed as:
2934 \(ordered
2936 \(unordered
2942 Point is left at list end."
2948 out
2949 parse-item ; for byte-compiler
2952 ;; Return text between BEG and END, trimmed, with
2953 ;; checkboxes replaced.
2964 text)))))
2967 ;; Return a list whose car is list type and cdr a list of
2968 ;; items' body.
2974 ;; Return a list containing counter of item, if any, text
2975 ;; and any sublist inside it.
2981 ;; Get counter number. For alphabetic counter, get
2982 ;; its position in the alphabet.
2993 ;; If item has a child, store text between bullet and
2994 ;; next child, then recursively parse all sublists. At
2995 ;; the end of each sublist, check for the presence of
2996 ;; text belonging to the original item.
3006 ;; Remove children from the list just parsed.
3008 ;; There is a chunk of text belonging to the
3009 ;; item if last child doesn't end where next
3010 ;; child starts or where item ends.
3014 body))))
3017 ;; Store output, take care of cursor position and deletion of
3018 ;; list, then return output.
3025 out))
3028 "Convert the plain list at point into a subtree."
3036 "Insert a radio list template appropriate for this major mode."
3040 name pos)
3051 "Send a transformed version of this list to the receiver position.
3052 With argument MAYBE, fail quietly if no transformation is defined
3053 for this list."
3075 beg txt)
3079 ;; Find the insertion place
3084 name
3098 "Trim line breaks in a list ITEM."
3102 "Convert a LIST parsed through `org-list-parse-list' to other formats.
3103 Valid parameters PARAMS are:
3105 :ustart String to start an unordered list
3106 :uend String to end an unordered list
3108 :ostart String to start an ordered list
3109 :oend String to end an ordered list
3111 :dstart String to start a descriptive list
3112 :dend String to end a descriptive list
3113 :dtstart String to start a descriptive term
3114 :dtend String to end a descriptive term
3115 :ddstart String to start a description
3116 :ddend String to end a description
3118 :splice When set to t, return only list body lines, don't wrap
3119 them into :[u/o]start and :[u/o]end. Default is nil.
3121 :istart String to start a list item.
3122 :icount String to start an item with a counter.
3123 :iend String to end a list item
3124 :isep String to separate items
3125 :lsep String to separate sublists
3126 :csep String to separate text from a sub-list
3128 :cboff String to insert for an unchecked check-box
3129 :cbon String to insert for a checked check-box
3130 :cbtrans String to insert for a check-box in transitional state
3132 :nobr Non-nil means remove line breaks in lists items.
3134 Alternatively, each parameter can also be a form returning
3135 a string. These sexp can use keywords `counter' and `depth',
3136 representing respectively counter associated to the current
3137 item, and depth of the current sub-list, starting at 0.
3138 Obviously, `counter' is only available for parameters applying to
3139 items."
3163 export-sublist ; for byte-compiler
3166 ;; Export an item ITEM of type TYPE, at DEPTH. First
3167 ;; string in item is treated in a special way as it can
3168 ;; bring extra information that needs to be processed.
3174 ;; Stick DTSTART to ISTART by
3175 ;; left-trimming the latter.
3179 istart))
3186 ;; Replace checkbox if any is found.
3194 ;; Replace line breaks if required
3196 ;; Insert descriptive term if TYPE is `descriptive'.
3205 first)))
3216 ;; Export sublist SUB at DEPTH.
3234 "Convert LIST into a LaTeX list.
3235 LIST is as string representing the list to transform, as Org
3236 syntax. Return converted list as a string."
3241 "Convert LIST into a HTML list.
3242 LIST is as string representing the list to transform, as Org
3243 syntax. Return converted list as a string."
3248 "Convert LIST into a Texinfo list.
3249 LIST is as string representing the list to transform, as Org
3250 syntax. Return converted list as a string."
3255 "Convert LIST into an Org subtree.
3256 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3257 with overruling parameters for `org-list-to-generic'."
3267 ;; Return the string for the heading, depending on depth D
3268 ;; of current sub-list.
3273 oddeven-level)
3274 ?*)
3277 list
3279 '(:splice t
3286 params))))
3290 ;;; org-list.el ends here