| blob | 2dda8f02d6543091c8ced1e43fb43df3a094fdd1 |
1 ;;; org-list.el --- Plain lists for Org-mode -*- lexical-binding: t; -*-
2 ;;
3 ;; Copyright (C) 2004-2015 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:
110 org-element-map "org-element"
159 \f
160 ;;; Configuration variables
163 "Options concerning plain lists in Org-mode."
168 "When t, make TAB cycle visibility on plain list items.
169 Cycling plain lists works only when the cursor is on a plain list
170 item. When the cursor is on an outline heading, plain lists are
171 treated as text. This is the most stable way of handling this,
172 which is why it is the default.
174 When this is the symbol `integrate', then integrate plain list
175 items when cycling, as if they were children of outline headings.
177 This setting can lead to strange effects when switching visibility
180 plain list item with an implied large level number, all true
181 children and grand children of the outline heading will be
182 exposed in a children' view."
191 "Default bullet type installed when demoting an item.
192 This is an association list, for each bullet type, this alist will point
193 to the bullet that should be used when this item is demoted.
194 For example,
196 (setq org-list-demote-modify-bullet
199 will make
201 + Movies
202 + Silence of the Lambs
203 + My Cousin Vinny
204 + Books
205 + The Hunt for Red October
206 + The Road to Omaha
208 into
210 + Movies
211 - Silence of the Lambs
212 - My Cousin Vinny
213 + Books
214 - The Hunt for Red October
215 - The Road to Omaha"
233 "The character that makes a line with leading number an ordered list item.
234 Valid values are ?. and ?\). To get both terminators, use t.
236 This variable needs to be set before org.el is loaded. If you
237 need to make a change while Emacs is running, use the customize
238 interface or run the following code after updating it:
251 "Non-nil means single character alphabetical bullets are allowed.
253 Both uppercase and lowercase are handled. Lists with more than
254 26 items will fallback to standard numbering. Alphabetical
257 This variable needs to be set before org.el is loaded. If you
258 need to make a change while Emacs is running, use the customize
259 interface or run the following code after updating it:
269 "A regular expression matching bullets that should have 2 spaces after them.
270 When nil, no bullet will have two spaces after them. When
271 a string, it will be used as a regular expression. When the
272 bullet type of a list is changed, the new bullet type will be
273 matched against this regexp. If it matches, there will be two
274 spaces instead of one after the bullet in each item of the list."
282 "Non-nil means apply set of rules when acting on lists.
283 By default, automatic actions are taken when using
288 rules by setting them to nil. Valid rules are:
290 checkbox when non-nil, checkbox statistics is updated each time
291 you either insert a new checkbox or toggle a checkbox.
292 indent when non-nil, indenting or outdenting list top-item
293 with its subtree will move the whole list and
294 outdenting a list whose bullet is * to column 0 will
299 :key-type
303 :value-type
307 "Non-nil means commands implying motion in lists should be cyclic.
309 In that case, the item following the last item is the first one,
310 and the item preceding the first item is the last one.
320 "Hook that is run whenever Org thinks checkbox statistics should be updated.
321 This hook runs even if checkbox rule in
322 `org-list-automatic-rules' does not apply, so it can be used to
323 implement alternative ways of collecting statistics
329 "Non-nil means checkbox statistics counts only the state of direct children.
330 When nil, all boxes below the cookie are counted.
331 This can be set to nil on a per-node basis using a COOKIE_DATA property
339 "Maximum indentation for the second line of a description list.
340 When the indentation would be larger than this, it will become
341 5 characters instead."
346 "Additional indentation for sub-items in a list.
347 By setting this to a small number, usually 1 or 2, one can more
348 clearly distinguish sub-items in a list."
355 % END RECEIVE ORGLST %n
357 #+ORGLST: SEND %n org-list-to-latex
358 -
361 @c END RECEIVE ORGLST %n
362 @ignore
363 #+ORGLST: SEND %n org-list-to-texinfo
364 -
367 <!-- END RECEIVE ORGLST %n -->
368 <!--
369 #+ORGLST: SEND %n org-list-to-html
370 -
372 "Templates for radio lists in different major modes.
373 All occurrences of %n in a template will be replaced with the name of the
374 list, obtained by prompting the user."
382 "Names of blocks where lists are not allowed.
386 "Context types where lists will be interpreted during export.
388 Valid types are `drawer', `inlinetask' and `block'. More
389 specifically, type `block' is determined by the variable
393 \f
394 ;;; Predicates and regexps
404 "Matches a list item and puts everything into groups:
405 group 1: bullet
406 group 2: counter
407 group 3: checkbox
411 "Return the correct regular expression for plain lists."
422 "Regexp matching the beginning of a plain list item."
426 "Is point at a list item with REGEXP after bullet?"
435 ;; Ignore counter if any
440 "Is point in a context where lists are allowed?"
444 "Return item beginning position when in a plain list, nil otherwise."
453 ;; Indentation isn't meaningful when point starts at an empty
454 ;; line or an inline task.
457 10000
463 ;; Detect if cursor in amidst `org-list-end-re'. First, count
464 ;; number HL of hard lines it takes, then call `org-in-regexp'
465 ;; to compute its boundaries END-BOUNDS. When point is
466 ;; in-between, move cursor before regexp beginning.
477 ;; Look for an item, less indented that reference line.
482 ;; This is exactly what we want.
485 ;; At upper bound of search or looking at the end of a
486 ;; previous list: search is over.
489 ;; Skip blocks, drawers, inline-tasks, blank lines
499 ;; Text at column 0 cannot belong to a list: stop.
501 ;; Normal text less indented than reference line, take
502 ;; it as new reference.
509 "Is point in a line starting a hand-formatted item?"
515 "Is point at the bullet of a plain list item?"
521 "Is point at a line starting a plain list item with a timer?"
526 "Is point at a description list item?"
530 "Is point at a line starting a plain-list item with a checklet?"
534 "Is point at a line starting a plain-list item with a counter?"
540 \f
541 ;;; Structures and helper functions
544 "Determine context, and its boundaries, around point.
546 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
547 are boundaries and CONTEXT is a symbol among `drawer', `block',
548 `invalid', `inlinetask' and nil.
550 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
556 ;; Get positions of surrounding headings. This is the
557 ;; default context.
562 ;; Is point inside a drawer?
572 lim-down))
575 ;; Is point strictly in a block, and of which type?
586 lim-down))
592 ;; Is point in an inlinetask?
605 ;; Return context boundaries and type.
609 "Return structure of list at point.
611 A list structure is an alist where key is point at item, and
612 values are:
613 1. indentation,
614 2. bullet with trailing whitespace,
615 3. bullet counter, if any,
616 4. checkbox, if any,
617 5. description tag, if any,
618 6. position at item end.
620 Thus the following list, where numbers in parens are
621 point-at-bol:
623 - [X] first item (1)
624 1. sub-item 1 (18)
625 5. [@5] sub-item 2 (34)
626 some other text belonging to first item (55)
627 - last item (97)
628 + tag :: description (109)
629 (131)
631 will get the following structure:
639 Assume point is at an item."
651 itm-lst itm-lst-2 end-lst end-lst-2 struct
654 ;; Return association at point.
659 ind
660 bullet
663 ;; Description tag.
668 ;; Ensure list ends at the first blank line.
672 ;; 1. Read list from starting item to its beginning, and save
673 ;; top item position and indentation in BEG-CELL. Also store
674 ;; ending position of items in END-LST.
681 ;; At upward limit: if we ended at an item, store it,
682 ;; else dismiss useless data recorded above BEG-CELL.
683 ;; Jump to part 2.
690 ;; Looking at a list ending regexp. Dismiss useless
691 ;; data recorded above BEG-CELL. Jump to part 2.
696 ;; Point is at an item. Add data to ITM-LST. It may
697 ;; also end a previous item: save it in END-LST. If
698 ;; ind is less or equal than BEG-CELL and there is no
699 ;; end at this ind or lesser, this item becomes the new
700 ;; BEG-CELL.
706 ;; Skip blocks, drawers, inline tasks, blank lines.
717 ;; From there, point is not at an item. Interpret
718 ;; line's indentation:
719 ;; - text at column 0 is necessarily out of any list.
720 ;; Dismiss data recorded above BEG-CELL. Jump to
721 ;; part 2.
722 ;; - any other case may be an ending position for an
723 ;; hypothetical item above. Store it and proceed.
732 ;; 2. Read list from starting point to its end, that is until we
733 ;; get out of context, or that a non-item line is less or
734 ;; equally indented than BEG-CELL's cdr. Also, store ending
735 ;; position of items in END-LST-2.
741 ;; At downward limit: this is de facto the end of the
742 ;; list. Save point as an ending position, and jump to
743 ;; part 3.
746 ;; Looking at a list ending regexp. Save point as an
747 ;; ending position and jump to part 3.
751 ;; Point is at an item. Add data to ITM-LST-2. It may
752 ;; also end a previous item, so save it in END-LST-2.
756 ;; Skip inline tasks and blank lines along the way
761 ;; Ind is lesser or equal than BEG-CELL's. The list is
762 ;; over: store point as an ending position and jump to
763 ;; part 3.
767 ;; Else, if ind is lesser or equal than previous item's,
768 ;; this is an ending position: store it. In any case,
769 ;; skip block or drawer at point, and move to next line.
781 ;; 3. Associate each item to its end position.
783 ;; 4. Return STRUCT
784 struct)))
787 "Associate proper ending point to items in STRUCT.
789 END-LIST is a pseudo-alist where car is indentation and cdr is
790 ending position.
792 This function modifies STRUCT."
798 ;; Remove end candidates behind current item.
801 ;; Add end position to item assoc.
807 struct)))
810 "Return alist between item and previous item in STRUCT."
812 struct)))
816 struct)))
819 "Return alist between item and parent in STRUCT."
831 ;; A sub-list is over. Find the associated
832 ;; origin in IND-TO-ORI. If it cannot be
833 ;; found (ill-formed list), set its parent as
834 ;; the first item less indented. If there is
835 ;; none, make it a top-level item.
843 ind-to-ori)
846 ;; A sub-list starts. Every item at IND will
847 ;; have previous item as its parent.
852 ;; Another item in the same sub-list: it shares
853 ;; the same parent as the previous item.
858 \f
859 ;;; Accessors
862 "Return the Nth value of KEY in STRUCT."
866 "Set the Nth value of KEY in STRUCT to NEW.
871 "Return indentation of ITEM in STRUCT."
875 "Set indentation of ITEM in STRUCT to IND.
880 "Return bullet of ITEM in STRUCT."
884 "Set bullet of ITEM in STRUCT to BULLET.
889 "Return counter of ITEM in STRUCT."
893 "Return checkbox of ITEM in STRUCT or nil."
897 "Set checkbox of ITEM in STRUCT to CHECKBOX.
902 "Return end position of ITEM in STRUCT."
906 "Return end position of ITEM in STRUCT."
910 "Return point at end of ITEM in STRUCT, before any blank line.
911 Point returned is at end of line."
918 "Return parent of ITEM or nil.
919 STRUCT is the list structure. PARENTS is the alist of parents,
920 as returned by `org-list-parents-alist'."
925 "Non-nil if ITEM has a child.
927 STRUCT is the list structure.
929 Value returned is the position of the first child of ITEM."
934 child-maybe)))
937 "Return next item in same sub-list as ITEM, or nil.
938 STRUCT is the list structure. PREVS is the alist of previous
939 items, as returned by `org-list-prevs-alist'."
943 "Return previous item in same sub-list as ITEM, or nil.
944 STRUCT is the list structure. PREVS is the alist of previous
945 items, as returned by `org-list-prevs-alist'."
949 "List all items having ITEM as a common ancestor, or nil.
950 STRUCT is the list structure."
953 subtree)
958 sub-struct))
962 "List all items in the same sub-list as ITEM.
963 STRUCT is the list structure. PREVS is the alist of previous
964 items, as returned by `org-list-prevs-alist'."
967 before-item after-item)
975 "List all children of ITEM, or nil.
976 STRUCT is the list structure. PARENTS is the alist of parents,
977 as returned by `org-list-parents-alist'."
985 "Return point at beginning of list.
986 STRUCT is the list structure."
990 "Return point at bottom of list.
991 STRUCT is the list structure."
996 "Return point at beginning of sub-list ITEM belongs.
997 STRUCT is the list structure. PREVS is the alist of previous
998 items, as returned by `org-list-prevs-alist'."
1002 first-item))
1007 "Return point at last item of sub-list ITEM belongs.
1008 STRUCT is the list structure. PREVS is the alist of previous
1009 items, as returned by `org-list-prevs-alist'."
1013 last-item))
1016 "Return point at end of sub-list ITEM belongs.
1017 STRUCT is the list structure. PREVS is the alist of previous
1018 items, as returned by `org-list-prevs-alist'."
1022 "Return the type of the list containing ITEM, as a symbol.
1024 STRUCT is the list structure. PREVS is the alist of previous
1025 items, as returned by `org-list-prevs-alist'.
1027 Possible types are `descriptive', `ordered' and `unordered'. The
1028 type is determined by the first item of the list."
1036 "Return ITEM's sequence number.
1038 STRUCT is the list structure. PREVS is the alist of previous
1039 items, as returned by `org-list-prevs-alist'. PARENTS is the
1040 alist of ancestors, as returned by `org-list-parents-alist'.
1042 Return value is a list of integers. Counters have an impact on
1043 that value."
1047 ;; Return relative sequence number of ITEM in the sub-list
1048 ;; it belongs. STRUCT is the list structure. PREVS is
1049 ;; the alist of previous items.
1058 seq))
1062 ;; Cons each parent relative number into return value (OUT).
1067 ;; Return value.
1068 out)))
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 " "
1119 bullet))))
1122 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1124 Blank lines at the end of items are left in place. Item
1125 visibility is preserved. Return the new structure after the
1126 changes.
1128 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1129 to the same sub-list.
1131 This function modifies STRUCT."
1144 ;; Store overlays responsible for visibility status. We
1145 ;; also need to store their boundaries as they will be
1146 ;; removed from buffer.
1161 ;; 1. Move effectively items in buffer.
1165 ;; 2. Now modify struct. No need to re-read the list, the
1166 ;; transformation is just a shift of positions. Some special
1167 ;; attention is required for items ending at END-A and END-B
1168 ;; as empty spaces are not moved there. In others words,
1169 ;; item BEG-A will end with whitespaces that were at the end
1170 ;; of BEG-B and the same applies to BEG-B.
1193 ;; Restore visibility status, by moving overlays to their new
1194 ;; position.
1204 ;; Return structure.
1205 struct)))
1208 "Return number of blank lines that should separate items in list.
1210 POS is the position of point where `org-list-insert-item' was called.
1212 STRUCT is the list structure. PREVS is the alist of previous
1213 items, as returned by `org-list-prevs-alist'.
1215 Assume point is at item's beginning. If the item is alone, apply
1216 some heuristics to guess the result."
1221 usr-blank
1225 ;; Count blank lines above beginning of line.
1232 ;; Trivial cases where there should be none.
1234 ;; When `org-blank-before-new-entry' says so, it is 1.
1236 ;; `plain-list-item' is 'auto. Count blank lines separating
1237 ;; neighbors' items in list.
1240 ;; Is there a next item?
1243 ;; Is there a previous item?
1246 ;; User inserted blank lines, trust him.
1251 usr-blank)
1252 ;; Are there blank lines inside the list so far?
1255 ;; Do not use `org-list-search-forward' so blank lines
1256 ;; in blocks can be counted in.
1260 ;; Default choice: no blank line.
1264 "Insert a new list item at POS and return the new structure.
1265 If POS is before first character after bullet of the item, the
1266 new item will be created before the current one.
1268 STRUCT is the list structure. PREVS is the alist of previous
1269 items, as returned by `org-list-prevs-alist'.
1271 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1272 after the bullet. Cursor will be after this text once the
1273 function ends.
1275 This function modifies STRUCT."
1277 ;; 1. Get information about list: position of point with regards
1278 ;; to item start (BEFOREP), blank lines number separating items
1279 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1286 (<= pos
1289 ;; Ignore tag in a non-descriptive list.
1298 pos struct prevs))
1299 ;; 2. Build the new item to be created. Concatenate same
1300 ;; bullet as item, checkbox, text AFTER-BULLET if
1301 ;; provided, and text cut from point to end of item
1302 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1303 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1304 ;; between what was cut and what was inserted in buffer
1305 ;; is stored in SIZE-OFFSET.
1309 ind))
1316 ;; If POS is greater than ITEM-END, then point is
1317 ;; in some white lines after the end of the list.
1318 ;; Those must be removed, or they will be left,
1319 ;; stacking up after the list.
1329 text-cut))))
1333 ;; 4. Insert effectively item into buffer.
1337 ;; 5. Add new item to STRUCT.
1341 ;; Before inserted item, positions don't change but
1342 ;; an item ending after insertion has its end shifted
1343 ;; by SIZE-OFFSET.
1346 ;; Trivial cases where current item isn't split in
1347 ;; two. Just shift every item after new one by
1348 ;; ITEM-SIZE.
1352 ;; Item is split in two: elements before POS are just
1353 ;; shifted by ITEM-SIZE. In the case item would end
1354 ;; after split POS, ending is only shifted by
1355 ;; SIZE-OFFSET.
1361 ;; Elements after POS are moved into new item.
1362 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1363 ;; doesn't appear in buffer yet.
1369 (+ end size-offset
1371 ;; Elements at ITEM-END or after are only shifted by
1372 ;; SIZE-OFFSET.
1375 struct)
1378 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1379 ;; exchange ITEM with the next item in list. Position cursor
1380 ;; after bullet, counter, checkbox, and label.
1386 struct)))
1389 "Remove ITEM from the list and return the new structure.
1391 STRUCT is the list structure."
1394 ;; If ITEM ends with the list, delete blank lines
1395 ;; before it.
1400 item)))
1401 ;; Remove item from buffer.
1403 ;; Remove item from structure and shift others items accordingly.
1404 ;; Don't forget to shift also ending position when appropriate.
1422 struct)))))
1425 "Send ITEM to destination DEST.
1427 STRUCT is the list structure.
1429 DEST can have various values.
1431 If DEST is a buffer position, the function will assume it points
1432 to another item in the same list as ITEM, and will move the
1433 latter just before the former.
1435 If DEST is `begin' (respectively `end'), ITEM will be moved at
1436 the beginning (respectively end) of the list it belongs to.
1439 be moved at the Nth position in the list.
1441 If DEST is `kill', ITEM will be deleted and its body will be
1442 added to the kill-ring.
1444 If DEST is `delete', ITEM will be deleted.
1446 Visibility of item is preserved.
1448 This function returns, destructively, the new list structure."
1451 ;; Grab full item body minus its bullet.
1460 item-end)))
1461 ;; Change DEST into a buffer position. A trick is needed
1462 ;; when ITEM is meant to be sent at the end of the list.
1463 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1464 ;; nil and insertion point (INS-POINT) to the first line's
1465 ;; end of the last item, we ensure the new item will be
1466 ;; inserted after the last item, and not after any of its
1467 ;; hypothetical sub-items.
1483 ;; Send ITEM at the end of the list.
1491 ;; Store inner overlays (to preserve visibility).
1503 ;; 1. Structure returned by `org-list-insert-item' may not be
1504 ;; accurate, as it cannot see sub-items included in BODY.
1505 ;; Thus, first compute the real structure so far.
1513 ;; 1.1. Remove the item just created in structure.
1515 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1518 struct
1526 new-end
1528 moved-items))
1530 ;; 2. Restore inner overlays.
1535 ;; 3. Eventually delete extra copy of the item and clean marker.
1541 "Outdent items between positions START and END.
1543 STRUCT is the list structure. PARENTS is the alist of items'
1544 parents, as returned by `org-list-parents-alist'.
1546 START is included, END excluded."
1552 ;; Item not yet in zone: keep association.
1554 ;; Item out of zone: follow associations in ACC.
1558 ;; Item has no parent: error
1561 ;; Parent is outdented: keep association.
1565 ;; Parent isn't outdented: reparent to grand-parent.
1567 parent struct parents)))
1573 "Indent items between positions START and END.
1575 STRUCT is the list structure. PARENTS is the alist of parents
1576 and PREVS is the alist of previous items, returned by,
1577 respectively, `org-list-parents-alist' and
1578 `org-list-prevs-alist'.
1580 START is included and END excluded.
1582 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1583 bullets between START and END."
1591 ;; Normalize ordered bullets.
1601 org-list-demote-modify-bullet))))
1608 ;; Item not yet in zone: keep association.
1611 ;; Item out of zone: follow associations in ACC.
1615 ;; Item is in zone...
1617 ;; Check if bullet needs to be changed.
1620 ;; First item indented but not parent: error
1623 ;; First item and parent indented: keep same
1624 ;; parent.
1626 ;; Previous item not indented: reparent to it.
1628 ;; Previous item indented: reparent like it.
1635 \f
1636 ;;; Repairing structures
1639 "Non-nil if list starting at FIRST can have alphabetical bullets.
1641 STRUCT is list structure. PREVS is the alist of previous items,
1642 as returned by `org-list-prevs-alist'."
1646 ;; Pretend that bullets are uppercase and check if alphabet
1647 ;; is sufficient, taking counters into account.
1650 ;; Virtually determine current bullet
1652 ;; Counters are not case-sensitive.
1655 ;; Test if bullet would be over z or Z.
1659 ;; All items checked. All good.
1660 t))))
1663 "Increment BULLET if applicable."
1666 ;; Num bullet: increment it.
1670 nil nil bullet))
1671 ;; Alpha bullet: increment it.
1675 nil nil bullet))
1676 ;; Unordered bullet: leave it.
1680 "Verify and correct bullets in STRUCT.
1681 PREVS is the alist of previous items, as returned by
1682 `org-list-prevs-alist'.
1684 This function modifies STRUCT."
1688 ;; Set bullet of ITEM in STRUCT, depending on the type of
1689 ;; first item of the list, the previous bullet and counter
1690 ;; if any.
1699 item struct
1702 ;; Alpha counter in alpha list: use counter.
1706 ;; Use cond to be sure `string-match' is used in
1707 ;; both cases.
1713 ;; Num counter in a num list: use counter.
1718 ;; No counter: increase, if needed, previous bullet.
1721 ;; Alpha counter at first item: use counter.
1730 ;; Num counter at first item: use counter.
1735 ;; First bullet is alpha uppercase: use "A".
1738 ;; First bullet is alpha lowercase: use "a".
1741 ;; First bullet is num: use "1".
1744 ;; Not an ordered list: keep bullet.
1749 "Verify and correct indentation in STRUCT.
1751 PARENTS is the alist of parents, as returned by
1752 `org-list-parents-alist'.
1754 If numeric optional argument BULLET-SIZE is set, assume all
1755 bullets in list have this length to determine new indentation.
1757 This function modifies STRUCT."
1764 ;; Indent like parent + length of parent's bullet +
1765 ;; sub-list offset.
1771 org-list-indent-offset))
1772 ;; If no parent, indent like top-point.
1777 "Verify and correct checkboxes in STRUCT.
1779 PARENTS is the alist of parents and PREVS is the alist of
1780 previous items, as returned by, respectively,
1781 `org-list-parents-alist' and `org-list-prevs-alist'.
1783 If ORDERED is non-nil, a checkbox can only be checked when every
1784 checkbox before it is checked too. If there was an attempt to
1785 break this rule, the function will return the blocking item. In
1786 all others cases, the return value will be nil.
1788 This function modifies STRUCT."
1798 item struct
1804 ;; Parent has no boxed child: leave box as-is.
1806 parent-list)
1807 ;; 1. List all parents with a checkbox.
1814 all-items)
1815 ;; 2. Sort those parents by decreasing indentation.
1820 ;; 3. For each parent, get all children's checkboxes to determine
1821 ;; and set its checkbox accordingly.
1823 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1828 ;; There are boxes checked after an unchecked one: fix that.
1835 ;; Verify once again the structure, without ORDERED.
1837 ;; Return blocking item.
1841 "Verify and correct each item end position in STRUCT.
1843 This function modifies STRUCT."
1850 ;; To determine real ind of an ending position that is
1851 ;; not at an item, we have to find the item it belongs
1852 ;; to: it is the last item (ITEM-UP), whose ending is
1853 ;; further than the position we're interested in.
1856 ;; Else part is for the bottom point.
1858 end-pos)
1859 end-list)))
1862 struct)
1867 "Apply set difference between STRUCT and OLD-STRUCT to the buffer.
1869 OLD-STRUCT is the structure before any modifications, and STRUCT
1870 the structure to be applied. The function will only modify parts
1871 of the list which have changed.
1873 Initial position of cursor is restored after the changes."
1880 ;; Shift the indentation between END and BEG by DELTA.
1881 ;; Start from the line before END.
1890 ;; Skip inline tasks.
1893 ;; Shift only non-empty lines.
1899 ;; Replace ITEM first line elements with new elements from
1900 ;; STRUCT, if appropriate.
1910 ;; a. Replace bullet
1913 ;; b. Replace checkbox.
1924 ;; c. Indent item to appropriate column.
1929 ;; 1. First get list of items and position endings. We maintain
1930 ;; two alists: ITM-SHIFT, determining indentation shift needed
1931 ;; at item, and END-LIST, a pseudo-alist where key is ending
1932 ;; position and value point.
1945 ;; To determine real ind of an ending position that
1946 ;; is not at an item, we have to find the item it
1947 ;; belongs to: it is the last item (ITEM-UP), whose
1948 ;; ending is further than the position we're
1949 ;; interested in.
1953 ;; 2. Slice the items into parts that should be shifted by the
1954 ;; same amount of indentation. Each slice follow the pattern
1955 ;; (END BEG DELTA). Slices are returned in reverse order.
1958 #'<)
1966 ;; If we're not at an item, there's a child of the
1967 ;; item point belongs to above. Make sure the less
1968 ;; indented line in this slice has the same column
1969 ;; as that child.
1976 ;; Ignore empty lines. Also ignore blocks and
1977 ;; drawers contents.
1985 down t)))
1988 down t)))))
1992 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1993 ;; end to beginning. Take a special action when beginning is
1994 ;; at item bullet.
2001 ;; 4. Go back to initial position and clean marker.
2006 "Correct bullets, checkboxes and indentation in list at point.
2008 STRUCT is the list structure. PARENTS is the alist of parents,
2009 as returned by `org-list-parents-alist'.
2011 When non-nil, optional argument OLD-STRUCT is the reference
2012 structure of the list. It should be provided whenever STRUCT
2013 doesn't correspond anymore to the real list in buffer."
2014 ;; Order of functions matters here: checkboxes and endings need
2015 ;; correct indentation to be set, and indentation needs correct
2016 ;; bullets.
2017 ;;
2018 ;; 0. Save a copy of structure before modifications
2020 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
2021 ;; order to get items endings and bullets properly
2023 ;; 2. Fix each item end to get correct prevs alist.
2025 ;; 3. Get bullets right.
2028 ;; 4. Now get real indentation.
2030 ;; 5. Eventually fix checkboxes.
2032 ;; 6. Apply structure modifications to buffer.
2036 \f
2037 ;;; Misc Tools
2040 "Call FUNCTION on each item of the list at point.
2041 FUNCTION must be called with at least one argument: INIT-VALUE,
2042 that will contain the value returned by the function at the
2043 previous item, plus ARGS extra arguments.
2045 FUNCTION is applied on items in reverse order.
2047 As an example, \(org-apply-on-list \(lambda \(result) \(1+ result)) 0)
2048 will return the number of items in the current list.
2050 Sublists of the list are skipped. Cursor is always at the
2051 beginning of the item."
2063 value))
2066 "Set visibility of ITEM in STRUCT to VIEW.
2068 Possible values are: `folded', `children' or `subtree'. See
2069 `org-cycle' for more information."
2073 ;; Hide from eol
2075 item-end t)))
2077 ;; First show everything.
2079 ;; Then fold every child.
2084 children)))
2086 ;; Show everything
2091 "Return column at which body of ITEM should start."
2103 2
2107 \f
2108 ;;; Interactive functions
2113 "Go to the beginning of the current item.
2114 Throw an error when not in a list."
2120 "Go to the beginning item of the current list or sublist.
2121 Throw an error when not in a list."
2132 "Go to the end of the current list or sublist.
2133 Throw an error when not in a list."
2144 "Go to the end of the current item.
2145 Throw an error when not in a list."
2155 "Move to the beginning of the previous item.
2156 Throw an error when not in a list. Also throw an error when at
2157 first item, unless `org-list-use-circular-motion' is non-nil."
2173 "Move to the beginning of the next item.
2174 Throw an error when not in a list. Also throw an error when at
2175 last item, unless `org-list-use-circular-motion' is non-nil."
2191 "Move the item at point down, i.e. swap with following item.
2192 Sub-items (items with larger indentation) are considered part of
2193 the item, so this really moves item trees."
2212 "Move the item at point up, i.e. swap with previous item.
2213 Sub-items (items with larger indentation) are considered part of
2214 the item, so this really moves item trees."
2231 "Insert a new item at the current level.
2232 If cursor is before first character after bullet of the item, the
2233 new item will be created before the current one.
2235 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2237 Return t when things worked, nil when we are not in an item, or
2238 item is invisible."
2241 ;; If cursor isn't is a list or if list is invisible, return nil.
2249 ;; Timer list: delegate to `org-timer-item'.
2254 ;; If we're in a description list, ask for the new term.
2268 t)))))
2271 "Fix indentation, bullets and checkboxes in the list at point."
2279 "Cycle through the different itemize/enumerate bullets.
2280 This cycle the entire list level through the sequence:
2282 `-' -> `+' -> `*' -> `1.' -> `1)'
2284 If WHICH is a valid string, use that as the new bullet. If WHICH
2285 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2286 `previous', cycle backwards."
2306 ;; Compute list of possible bullets, depending on context.
2309 ;; *-bullets are not allowed at column 0.
2311 ;; Description items cannot be numbered.
2334 ;; Use a short variation of `org-list-write-struct' as there's
2335 ;; no need to go through all the steps.
2343 "Toggle the checkbox in the current line.
2344 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2345 double prefix, set checkbox to [-].
2347 When there is an active region, toggle status or presence of the
2348 first checkbox there, and make every item inside have the same
2349 status or presence, respectively.
2351 If the cursor is in a headline, apply this to all checkbox items
2352 in the text below the heading, taking as reference the first item
2353 in subtree, ignoring drawers."
2357 block-item
2358 lim-up
2359 lim-down
2367 ;; In a region, start at first item in region.
2377 ;; On an heading, start at first item after drawers and
2378 ;; time-stamps (scheduled, etc.).
2390 ;; Just one item: set SINGLEP flag.
2396 ;; Determine the checkbox going to be applied to all items
2397 ;; within bounds.
2408 ;; When an item is found within bounds, grab the full list at
2409 ;; point structure, then: (1) set check-box of all its items
2410 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2411 ;; whole list, (3) move point after the list.
2425 e struct
2426 ;; If there is no box at item, leave as-is
2427 ;; unless function was called with C-u prefix.
2430 ref-checkbox
2431 cur-box))))
2432 items-to-toggle)
2434 struct parents prevs orderedp))
2435 ;; Report some problems due to ORDERED status of subtree.
2436 ;; If only one box was being checked, throw an error, else,
2437 ;; only signal problems.
2441 "Checkbox blocked because of unchecked box at line %d"
2445 "Checkboxes were removed due to unchecked box at line %d"
2454 "Reset all checkboxes in an entry subtree."
2471 "Update the checkbox statistics in the current section.
2473 This will find all statistic cookies like [57%] and [6/12] and
2474 update them with the current numbers.
2476 With optional prefix argument ALL, do this for the whole buffer."
2497 ;; Return number of checked boxes and boxes of all types
2498 ;; in all structures in STRUCTS. If RECURSIVEP is
2499 ;; non-nil, also count boxes in sub-lists. If ITEM is
2500 ;; nil, count across the whole structure, else count only
2501 ;; across subtree whose ancestor is ITEM.
2516 items))))
2519 cookies-list cache)
2520 ;; Move to start.
2524 ;; Build an alist for each cookie found. The key is the position
2525 ;; at beginning of cookie and values ending position, format of
2526 ;; cookie, number of checked boxes to report and total number of
2527 ;; boxes.
2537 context
2539 quote-block special-block verse-block)))
2555 structs)
2560 structs)
2561 ;; Skip whole list since we have its
2562 ;; structure anyway.
2567 end))))))
2568 ;; Cache count for cookies applying to the same
2569 ;; area. Then return it.
2576 structs
2577 recursivep)))
2579 count))))))
2580 cookies-list))))
2581 ;; Apply alist to buffer.
2597 "Select the face for checkbox statistics.
2598 The face will be `org-done' when all relevant boxes are checked.
2599 Otherwise it will be `org-todo'."
2602 'org-checkbox-statistics-done
2606 'org-checkbox-statistics-done
2610 "Update checkbox statistics unless turned off by user.
2611 With an optional argument ALL, update them in the whole buffer."
2619 "Indent a local list item including its children.
2620 When number ARG is a negative, item will be outdented, otherwise
2621 it will be indented.
2623 If a region is active, all items inside will be moved.
2625 If NO-SUBTREE is non-nil, only indent the item itself, not its
2626 children.
2628 STRUCT is the list structure.
2630 Return t if successful."
2638 ;; Are we going to move the whole list?
2646 t))))
2647 ;; Determine begin and end points of zone to indent. If moving
2648 ;; more than one item, save them for subsequent moves.
2664 ;; Special case: moving top-item with indent rule.
2672 ;; Change bullet if necessary.
2678 ;; Shift every item by OFFSET and fix bullets. Then
2679 ;; apply changes to buffer.
2683 struct)
2686 ;; Forbidden move:
2688 ;; If only one item is moved, it mustn't have a child.
2692 ;; If a subtree or region is moved, the last item
2693 ;; of the subtree mustn't have a child.
2698 struct)))))
2701 ;; Normal shifting
2709 t)
2712 "Outdent a local list item, but not its children.
2713 If a region is active, all items inside will be moved."
2729 "Indent a local list item, but not its children.
2730 If a region is active, all items inside will be moved."
2746 "Outdent a local list item including its children.
2747 If a region is active, all items inside will be moved."
2763 "Indent a local list item including its children.
2764 If a region is active, all items inside will be moved."
2782 "Cycle levels of indentation of an empty item.
2783 The first run indents the item, if applicable. Subsequent runs
2784 outdent it at meaningful levels in the list. When done, item is
2785 put back at its original position with its original bullet.
2787 Return t at each successful move."
2793 ;; Accept empty items or if cycle has already started.
2804 ;; When in the middle of the cycle, try to outdent first. If
2805 ;; it fails, and point is still at initial position, indent.
2806 ;; Else, re-create it at its original position.
2815 ;; Break cycle
2817 ;; If a cycle is starting, remember indentation and bullet,
2818 ;; then try to indent. If it fails, try to outdent.
2824 t))))
2827 "Sort list items.
2828 The cursor may be at any item of the list that should be sorted.
2829 Sublists are not sorted. Checkboxes, if any, are ignored.
2831 Sorting can be alphabetically, numerically, by date/time as given
2832 by a time stamp, by a property or by priority.
2834 Comparing entries ignores case by default. However, with an
2835 optional argument WITH-CASE, the sorting considers case as well.
2837 The command prompts for the sorting type unless it has been given
2838 to the function through the SORTING-TYPE argument, which needs to
2839 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F ?x ?X). Here is the
2840 detailed meaning of each character:
2842 n Numerically, by converting the beginning of the item to a number.
2843 a Alphabetically. Only the first line of item is checked.
2844 t By date/time, either the first active time stamp in the entry, if
2845 any, or by the first inactive one. In a timer list, sort the timers.
2848 Capital letters will reverse the sort order.
2850 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2851 a function to be called with point at the beginning of the
2852 record. It must return either a string or a number that should
2853 serve as the sorting key for that record. It will then use
2854 COMPARE-FUNC to compare entries.
2856 Sorting is done against the visible part of the headlines, it
2857 ignores hidden links."
2908 ;; If it is a timer list, convert timer to seconds
2925 value))
2929 next-record
2930 end-record
2931 value-to-sort
2932 nil
2933 sort-func)
2934 ;; Read and fix list again, as `sort-subr' probably destroyed
2935 ;; its structure.
2941 \f
2942 ;;; Send and receive lists
2945 "Parse the list at point and maybe DELETE it.
2947 Return a list whose car is a symbol of list type, among
2948 `ordered', `unordered' and `descriptive'. Then, each item is
2949 a list of strings and other sub-lists.
2951 For example, the following list:
2953 1. first item
2954 + sub-item one
2955 + [X] sub-item two
2956 more text in first item
2957 2. [@3] last item
2959 is parsed as
2961 \(ordered
2963 \(unordered
2969 Point is left at list's end."
2977 ;; Remove indentation and final newline from TEXT.
2981 text))))
2984 ;; Return a list whose car is list type and cdr a list
2985 ;; of items' body.
2990 ;; Return a list containing counter of item, if any,
2991 ;; text and any sublist inside it.
3000 trim
3010 ;; Remove whole sub-list from children.
3012 ;; There is a chunk of text belonging to the item
3013 ;; if last child doesn't end where next child
3014 ;; starts or where item ends.
3019 trim
3021 body)))))
3023 ;; Store output, take care of cursor position and deletion of
3024 ;; list, then return output.
3035 "Convert the plain list at point into a subtree."
3043 "Insert a radio list template appropriate for this major mode."
3047 name pos)
3058 "Send a transformed version of this list to the receiver position.
3059 With argument MAYBE, fail quietly if no transformation is defined
3060 for this list."
3084 beg)
3088 ;; Find the insertion place
3093 name
3095 nil t)
3108 "Convert a LIST parsed through `org-list-to-lisp' to a custom format.
3110 LIST is a list as returned by `org-list-to-lisp', which see.
3111 PARAMS is a property list of parameters used to tweak the output
3112 format.
3114 Valid parameters are:
3116 :backend, :raw
3118 Export back-end used as a basis to transcode elements of the
3119 list, when no specific parameter applies to it. It is also
3120 used to translate its contents. You can prevent this by
3121 setting :raw property to a non-nil value.
3123 :splice
3125 When non-nil, only export the contents of the top most plain
3126 list, effectively ignoring its opening and closing lines.
3128 :ustart, :uend
3130 Strings to start and end an unordered list. They can also be
3131 set to a function returning a string or nil, which will be
3132 called with the depth of the list, counting from 1.
3134 :ostart, :oend
3136 Strings to start and end an ordered list. They can also be set
3137 to a function returning a string or nil, which will be called
3138 with the depth of the list, counting from 1.
3140 :dstart, :dend
3142 Strings to start and end a descriptive list. They can also be
3143 set to a function returning a string or nil, which will be
3144 called with the depth of the list, counting from 1.
3146 :dtstart, :dtend, :ddstart, :ddend
3148 Strings to start and end a descriptive term.
3150 :istart, :iend
3152 Strings to start or end a list item, and to start a list item
3153 with a counter. They can also be set to a function returning
3154 a string or nil, which will be called with the depth of the
3155 item, counting from 1.
3157 :icount
3159 Strings to start a list item with a counter. It can also be
3160 set to a function returning a string or nil, which will be
3161 called with two arguments: the depth of the item, counting from
3162 1, and the counter. Its value, when non-nil, has precedence
3163 over `:istart'.
3165 :isep
3167 String used to separate items. It can also be set to
3168 a function returning a string or nil, which will be called with
3169 the depth of the items, counting from 1. It always start on
3170 a new line.
3172 :cbon, :cboff, :cbtrans
3174 String to insert, respectively, an un-checked check-box,
3175 a checked check-box and a check-box in transitional state."
3181 :transcoders
3185 data info)
3186 ;; Write LIST back into Org syntax and parse it.
3216 ;; When`:raw' property has a non-nil value, turn all objects back
3217 ;; into Org syntax.
3223 ;; We use a low-level mechanism to export DATA so as to skip all
3224 ;; usual pre-processing and post-processing, i.e., hooks, filters,
3225 ;; Babel code evaluation, include keywords and macro expansion,
3226 ;; and filters.
3228 ;; Remove final newline.
3232 "Return the level of ELEMENT within current plain list.
3233 ELEMENT is either an item or a plain list."
3238 "Return the number of trailing newlines in STRING."
3245 "Evaluate VALUE according to its type.
3246 VALUE is either nil, a string or a function. In the latter case,
3247 it is called with arguments ARGS."
3254 "Return a transcoder for `plain-list' elements.
3255 PARAMS is a plist used to tweak the behavior of the transcoder."
3273 depth)))
3280 depth))))
3281 ;; Make sure trailing newlines in END appear in the output by
3282 ;; setting `:post-blank' property to their number.
3286 ;; Build output.
3289 contents
3291 end)))))
3294 "Return a transcoder for `item' elements.
3295 PARAMS is a plist used to tweak the behavior of the transcoder."
3320 ;; When a closing line or a separator is provided, make sure
3321 ;; its trailing newlines are taken into account when building
3322 ;; output. This is done by setting `:post-blank' property to
3323 ;; the number of such lines in the last line to be added.
3327 item
3328 :post-blank
3330 ;; Build output.
3348 tag backend info)
3350 dtend))
3355 ;; Remove final newline.
3358 closing
3359 separator)))))
3362 "Convert LIST into a LaTeX list.
3363 LIST is a parsed plain list, as returned by `org-list-to-lisp'.
3364 Return converted list as a string."
3369 "Convert LIST into a HTML list.
3370 LIST is a parsed plain list, as returned by `org-list-to-lisp'.
3371 Return converted list as a string."
3376 "Convert LIST into a Texinfo list.
3377 LIST is a parsed plain list, as returned by `org-list-to-lisp'.
3378 Return converted list as a string."
3383 "Convert LIST into an Org subtree.
3384 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3385 with overruling parameters for `org-list-to-generic'."
3394 ;; Return the string for the heading, depending on DEPTH
3395 ;; of current sub-list.
3399 oddeven-level)
3400 ?*)
3403 list
3406 :istart make-stars
3407 :icount make-stars
3411 params))))
3415 ;;; org-list.el ends here