| blob | 05f19228e1d0c01e7e99987e720a0228aa70251f |
1 ;;; org-list.el --- Plain lists for Org-mode
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:
141 \f
142 ;;; Configuration variables
145 "Options concerning plain lists in Org-mode."
150 "When t, make TAB cycle visibility on plain list items.
151 Cycling plain lists works only when the cursor is on a plain list
152 item. When the cursor is on an outline heading, plain lists are
153 treated as text. This is the most stable way of handling this,
154 which is why it is the default.
156 When this is the symbol `integrate', then integrate plain list
157 items when cycling, as if they were children of outline headings.
159 This setting can lead to strange effects when switching visibility
162 plain list item with an implied large level number, all true
163 children and grand children of the outline heading will be
164 exposed in a children' view."
173 "Default bullet type installed when demoting an item.
174 This is an association list, for each bullet type, this alist will point
175 to the bullet that should be used when this item is demoted.
176 For example,
178 (setq org-list-demote-modify-bullet
181 will make
183 + Movies
184 + Silence of the Lambs
185 + My Cousin Vinny
186 + Books
187 + The Hunt for Red October
188 + The Road to Omaha
190 into
192 + Movies
193 - Silence of the Lambs
194 - My Cousin Vinny
195 + Books
196 - The Hunt for Red October
197 - The Road to Omaha"
215 "The character that makes a line with leading number an ordered list item.
216 Valid values are ?. and ?\). To get both terminators, use t.
218 This variable needs to be set before org.el is loaded. If you
219 need to make a change while Emacs is running, use the customize
220 interface or run the following code after updating it:
233 "Non-nil means single character alphabetical bullets are allowed.
235 Both uppercase and lowercase are handled. Lists with more than
236 26 items will fallback to standard numbering. Alphabetical
239 This variable needs to be set before org.el is loaded. If you
240 need to make a change while Emacs is running, use the customize
241 interface or run the following code after updating it:
251 "A regular expression matching bullets that should have 2 spaces after them.
252 When nil, no bullet will have two spaces after them. When
253 a string, it will be used as a regular expression. When the
254 bullet type of a list is changed, the new bullet type will be
255 matched against this regexp. If it matches, there will be two
256 spaces instead of one after the bullet in each item of the list."
265 "Non-nil means an empty line ends all plain list levels.
266 Otherwise, two of them will be necessary."
272 "Non-nil means apply set of rules when acting on lists.
273 By default, automatic actions are taken when using
278 rules by setting them to nil. Valid rules are:
280 checkbox when non-nil, checkbox statistics is updated each time
281 you either insert a new checkbox or toggle a checkbox.
282 indent when non-nil, indenting or outdenting list top-item
283 with its subtree will move the whole list and
284 outdenting a list whose bullet is * to column 0 will
289 :key-type
293 :value-type
297 "Non-nil means commands implying motion in lists should be cyclic.
299 In that case, the item following the last item is the first one,
300 and the item preceding the first item is the last one.
310 "Hook that is run whenever Org thinks checkbox statistics should be updated.
311 This hook runs even if checkbox rule in
312 `org-list-automatic-rules' does not apply, so it can be used to
313 implement alternative ways of collecting statistics
319 "Non-nil means checkbox statistics counts only the state of direct children.
320 When nil, all boxes below the cookie are counted.
321 This can be set to nil on a per-node basis using a COOKIE_DATA property
329 "Maximum indentation for the second line of a description list.
330 When the indentation would be larger than this, it will become
331 5 characters instead."
336 "Additional indentation for sub-items in a list.
337 By setting this to a small number, usually 1 or 2, one can more
338 clearly distinguish sub-items in a list."
345 % END RECEIVE ORGLST %n
347 #+ORGLST: SEND %n org-list-to-latex
348 -
351 @c END RECEIVE ORGLST %n
352 @ignore
353 #+ORGLST: SEND %n org-list-to-texinfo
354 -
357 <!-- END RECEIVE ORGLST %n -->
358 <!--
359 #+ORGLST: SEND %n org-list-to-html
360 -
362 "Templates for radio lists in different major modes.
363 All occurrences of %n in a template will be replaced with the name of the
364 list, obtained by prompting the user."
372 "Names of blocks where lists are not allowed.
376 "Context types where lists will be interpreted during export.
378 Valid types are `drawer', `inlinetask' and `block'. More
379 specifically, type `block' is determined by the variable
383 \f
384 ;;; Predicates and regexps
388 "Regex corresponding to the end of a list.
396 "Matches a list item and puts everything into groups:
397 group 1: bullet
398 group 2: counter
399 group 3: checkbox
403 "Return the correct regular expression for plain lists."
414 "Regexp matching the beginning of a plain list item."
418 "Is point at a list item with REGEXP after bullet?"
427 ;; Ignore counter if any
432 "Is point in a context where lists are allowed?"
436 "Return item beginning position when in a plain list, nil otherwise."
445 ;; Indentation isn't meaningful when point starts at an empty
446 ;; line or an inline task.
449 10000
455 ;; Detect if cursor in amidst `org-list-end-re'. First, count
456 ;; number HL of hard lines it takes, then call `org-in-regexp'
457 ;; to compute its boundaries END-BOUNDS. When point is
458 ;; in-between, move cursor before regexp beginning.
469 ;; Look for an item, less indented that reference line.
474 ;; This is exactly what we want.
477 ;; At upper bound of search or looking at the end of a
478 ;; previous list: search is over.
481 ;; Skip blocks, drawers, inline-tasks, blank lines
491 ;; Text at column 0 cannot belong to a list: stop.
493 ;; Normal text less indented than reference line, take
494 ;; it as new reference.
501 "Is point in a line starting a hand-formatted item?"
507 "Is point at the bullet of a plain list item?"
513 "Is point at a line starting a plain list item with a timer?"
518 "Is point at a description list item?"
522 "Is point at a line starting a plain-list item with a checklet?"
526 "Is point at a line starting a plain-list item with a counter?"
532 \f
533 ;;; Structures and helper functions
536 "Determine context, and its boundaries, around point.
538 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
539 are boundaries and CONTEXT is a symbol among `drawer', `block',
540 `invalid', `inlinetask' and nil.
542 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
548 ;; Get positions of surrounding headings. This is the
549 ;; default context.
554 ;; Is point inside a drawer?
564 lim-down))
567 ;; Is point strictly in a block, and of which type?
578 lim-down))
584 ;; Is point in an inlinetask?
597 ;; Return context boundaries and type.
601 "Return structure of list at point.
603 A list structure is an alist where key is point at item, and
604 values are:
605 1. indentation,
606 2. bullet with trailing whitespace,
607 3. bullet counter, if any,
608 4. checkbox, if any,
609 5. description tag, if any,
610 6. position at item end.
612 Thus the following list, where numbers in parens are
613 point-at-bol:
615 - [X] first item (1)
616 1. sub-item 1 (18)
617 5. [@5] sub-item 2 (34)
618 some other text belonging to first item (55)
619 - last item (97)
620 + tag :: description (109)
621 (131)
623 will get the following structure:
631 Assume point is at an item."
643 itm-lst itm-lst-2 end-lst end-lst-2 struct
646 ;; Return association at point.
651 ind
652 bullet
655 ;; Description tag.
660 ;; Ensure list ends at the first blank line.
664 ;; 1. Read list from starting item to its beginning, and save
665 ;; top item position and indentation in BEG-CELL. Also store
666 ;; ending position of items in END-LST.
673 ;; At upward limit: if we ended at an item, store it,
674 ;; else dismiss useless data recorded above BEG-CELL.
675 ;; Jump to part 2.
682 ;; Looking at a list ending regexp. Dismiss useless
683 ;; data recorded above BEG-CELL. Jump to part 2.
688 ;; Point is at an item. Add data to ITM-LST. It may
689 ;; also end a previous item: save it in END-LST. If
690 ;; ind is less or equal than BEG-CELL and there is no
691 ;; end at this ind or lesser, this item becomes the new
692 ;; BEG-CELL.
698 ;; Skip blocks, drawers, inline tasks, blank lines.
709 ;; From there, point is not at an item. Interpret
710 ;; line's indentation:
711 ;; - text at column 0 is necessarily out of any list.
712 ;; Dismiss data recorded above BEG-CELL. Jump to
713 ;; part 2.
714 ;; - any other case may be an ending position for an
715 ;; hypothetical item above. Store it and proceed.
724 ;; 2. Read list from starting point to its end, that is until we
725 ;; get out of context, or that a non-item line is less or
726 ;; equally indented than BEG-CELL's cdr. Also, store ending
727 ;; position of items in END-LST-2.
733 ;; At downward limit: this is de facto the end of the
734 ;; list. Save point as an ending position, and jump to
735 ;; part 3.
738 ;; Looking at a list ending regexp. Save point as an
739 ;; ending position and jump to part 3.
743 ;; Point is at an item. Add data to ITM-LST-2. It may
744 ;; also end a previous item, so save it in END-LST-2.
748 ;; Skip inline tasks and blank lines along the way
753 ;; Ind is lesser or equal than BEG-CELL's. The list is
754 ;; over: store point as an ending position and jump to
755 ;; part 3.
759 ;; Else, if ind is lesser or equal than previous item's,
760 ;; this is an ending position: store it. In any case,
761 ;; skip block or drawer at point, and move to next line.
773 ;; 3. Associate each item to its end position.
775 ;; 4. Return STRUCT
776 struct)))
779 "Associate proper ending point to items in STRUCT.
781 END-LIST is a pseudo-alist where car is indentation and cdr is
782 ending position.
784 This function modifies STRUCT."
790 ;; Remove end candidates behind current item.
793 ;; Add end position to item assoc.
799 struct)))
802 "Return alist between item and previous item in STRUCT."
804 struct)))
808 struct)))
811 "Return alist between item and parent in STRUCT."
823 ;; A sub-list is over. Find the associated
824 ;; origin in IND-TO-ORI. If it cannot be
825 ;; found (ill-formed list), set its parent as
826 ;; the first item less indented. If there is
827 ;; none, make it a top-level item.
835 ind-to-ori)
838 ;; A sub-list starts. Every item at IND will
839 ;; have previous item as its parent.
844 ;; Another item in the same sub-list: it shares
845 ;; the same parent as the previous item.
850 \f
851 ;;; Accessors
854 "Return the Nth value of KEY in STRUCT."
858 "Set the Nth value of KEY in STRUCT to NEW.
863 "Return indentation of ITEM in STRUCT."
867 "Set indentation of ITEM in STRUCT to IND.
872 "Return bullet of ITEM in STRUCT."
876 "Set bullet of ITEM in STRUCT to BULLET.
881 "Return counter of ITEM in STRUCT."
885 "Return checkbox of ITEM in STRUCT or nil."
889 "Set checkbox of ITEM in STRUCT to CHECKBOX.
894 "Return end position of ITEM in STRUCT."
898 "Return end position of ITEM in STRUCT."
902 "Return point at end of ITEM in STRUCT, before any blank line.
903 Point returned is at end of line."
910 "Return parent of ITEM or nil.
911 STRUCT is the list structure. PARENTS is the alist of parents,
912 as returned by `org-list-parents-alist'."
917 "Non-nil if ITEM has a child.
919 STRUCT is the list structure.
921 Value returned is the position of the first child of ITEM."
926 child-maybe)))
929 "Return next item in same sub-list as ITEM, or nil.
930 STRUCT is the list structure. PREVS is the alist of previous
931 items, as returned by `org-list-prevs-alist'."
935 "Return previous item in same sub-list as ITEM, or nil.
936 STRUCT is the list structure. PREVS is the alist of previous
937 items, as returned by `org-list-prevs-alist'."
941 "List all items having ITEM as a common ancestor, or nil.
942 STRUCT is the list structure."
945 subtree)
950 sub-struct))
954 "List all items in the same sub-list as ITEM.
955 STRUCT is the list structure. PREVS is the alist of previous
956 items, as returned by `org-list-prevs-alist'."
959 before-item after-item)
967 "List all children of ITEM, or nil.
968 STRUCT is the list structure. PARENTS is the alist of parents,
969 as returned by `org-list-parents-alist'."
977 "Return point at beginning of list.
978 STRUCT is the list structure."
982 "Return point at bottom of list.
983 STRUCT is the list structure."
988 "Return point at beginning of sub-list ITEM belongs.
989 STRUCT is the list structure. PREVS is the alist of previous
990 items, as returned by `org-list-prevs-alist'."
994 first-item))
999 "Return point at last item of sub-list ITEM belongs.
1000 STRUCT is the list structure. PREVS is the alist of previous
1001 items, as returned by `org-list-prevs-alist'."
1005 last-item))
1008 "Return point at end of sub-list ITEM belongs.
1009 STRUCT is the list structure. PREVS is the alist of previous
1010 items, as returned by `org-list-prevs-alist'."
1014 "Return the type of the list containing ITEM, as a symbol.
1016 STRUCT is the list structure. PREVS is the alist of previous
1017 items, as returned by `org-list-prevs-alist'.
1019 Possible types are `descriptive', `ordered' and `unordered'. The
1020 type is determined by the first item of the list."
1028 "Return ITEM's sequence number.
1030 STRUCT is the list structure. PREVS is the alist of previous
1031 items, as returned by `org-list-prevs-alist'. PARENTS is the
1032 alist of ancestors, as returned by `org-list-parents-alist'.
1034 Return value is a list of integers. Counters have an impact on
1035 that value."
1039 ;; Return relative sequence number of ITEM in the sub-list
1040 ;; it belongs. STRUCT is the list structure. PREVS is
1041 ;; the alist of previous items.
1050 seq))
1054 ;; Cons each parent relative number into return value (OUT).
1059 ;; Return value.
1060 out)))
1063 \f
1064 ;;; Searching
1067 "Search a string in valid contexts for lists.
1068 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1069 in `re-search-forward'."
1073 ;; 1. No match: return to origin or bound, depending on NOERR.
1076 nil)))
1077 ;; 2. Match in valid context: return point. Else, continue
1078 ;; searching.
1082 "Like `re-search-backward' but stop only where lists are recognized.
1083 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1084 `re-search-backward'."
1089 "Like `re-search-forward' but stop only where lists are recognized.
1090 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1091 `re-search-forward'."
1096 \f
1097 ;;; Methods on structures
1100 "Return BULLET with the correct number of whitespaces.
1101 It determines the number of whitespaces to append by looking at
1102 `org-list-two-spaces-after-bullet-regexp'."
1106 org-list-two-spaces-after-bullet-regexp bullet))
1107 " "
1111 bullet))))
1114 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1116 Blank lines at the end of items are left in place. Item
1117 visibility is preserved. Return the new structure after the
1118 changes.
1120 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1121 to the same sub-list.
1123 This function modifies STRUCT."
1136 ;; Store overlays responsible for visibility status. We
1137 ;; also need to store their boundaries as they will be
1138 ;; removed from buffer.
1153 ;; 1. Move effectively items in buffer.
1157 ;; 2. Now modify struct. No need to re-read the list, the
1158 ;; transformation is just a shift of positions. Some special
1159 ;; attention is required for items ending at END-A and END-B
1160 ;; as empty spaces are not moved there. In others words,
1161 ;; item BEG-A will end with whitespaces that were at the end
1162 ;; of BEG-B and the same applies to BEG-B.
1185 ;; Restore visibility status, by moving overlays to their new
1186 ;; position.
1196 ;; Return structure.
1197 struct)))
1200 "Return number of blank lines that should separate items in list.
1202 POS is the position of point where `org-list-insert-item' was called.
1204 STRUCT is the list structure. PREVS is the alist of previous
1205 items, as returned by `org-list-prevs-alist'.
1207 Assume point is at item's beginning. If the item is alone, apply
1208 some heuristics to guess the result."
1213 usr-blank
1217 ;; Count blank lines above beginning of line.
1224 ;; Trivial cases where there should be none.
1226 ;; When `org-blank-before-new-entry' says so, it is 1.
1228 ;; `plain-list-item' is 'auto. Count blank lines separating
1229 ;; neighbors' items in list.
1232 ;; Is there a next item?
1235 ;; Is there a previous item?
1238 ;; User inserted blank lines, trust him.
1243 usr-blank)
1244 ;; Are there blank lines inside the list so far?
1247 ;; Do not use `org-list-search-forward' so blank lines
1248 ;; in blocks can be counted in.
1252 ;; Default choice: no blank line.
1256 "Insert a new list item at POS and return the new structure.
1257 If POS is before first character after bullet of the item, the
1258 new item will be created before the current one.
1260 STRUCT is the list structure. PREVS is the alist of previous
1261 items, as returned by `org-list-prevs-alist'.
1263 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1264 after the bullet. Cursor will be after this text once the
1265 function ends.
1267 This function modifies STRUCT."
1269 ;; 1. Get information about list: position of point with regards
1270 ;; to item start (BEFOREP), blank lines number separating items
1271 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1278 (<= pos
1281 ;; Ignore tag in a non-descriptive list.
1290 pos struct prevs))
1291 ;; 2. Build the new item to be created. Concatenate same
1292 ;; bullet as item, checkbox, text AFTER-BULLET if
1293 ;; provided, and text cut from point to end of item
1294 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1295 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1296 ;; between what was cut and what was inserted in buffer
1297 ;; is stored in SIZE-OFFSET.
1301 ind))
1308 ;; If POS is greater than ITEM-END, then point is
1309 ;; in some white lines after the end of the list.
1310 ;; Those must be removed, or they will be left,
1311 ;; stacking up after the list.
1321 text-cut))))
1325 ;; 4. Insert effectively item into buffer.
1329 ;; 5. Add new item to STRUCT.
1333 ;; Before inserted item, positions don't change but
1334 ;; an item ending after insertion has its end shifted
1335 ;; by SIZE-OFFSET.
1338 ;; Trivial cases where current item isn't split in
1339 ;; two. Just shift every item after new one by
1340 ;; ITEM-SIZE.
1344 ;; Item is split in two: elements before POS are just
1345 ;; shifted by ITEM-SIZE. In the case item would end
1346 ;; after split POS, ending is only shifted by
1347 ;; SIZE-OFFSET.
1353 ;; Elements after POS are moved into new item.
1354 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1355 ;; doesn't appear in buffer yet.
1361 (+ end size-offset
1363 ;; Elements at ITEM-END or after are only shifted by
1364 ;; SIZE-OFFSET.
1367 struct)
1370 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1371 ;; exchange ITEM with the next item in list. Position cursor
1372 ;; after bullet, counter, checkbox, and label.
1378 struct)))
1381 "Remove ITEM from the list and return the new structure.
1383 STRUCT is the list structure."
1386 ;; If ITEM ends with the list, delete blank lines
1387 ;; before it.
1392 item)))
1393 ;; Remove item from buffer.
1395 ;; Remove item from structure and shift others items accordingly.
1396 ;; Don't forget to shift also ending position when appropriate.
1414 struct)))))
1417 "Send ITEM to destination DEST.
1419 STRUCT is the list structure.
1421 DEST can have various values.
1423 If DEST is a buffer position, the function will assume it points
1424 to another item in the same list as ITEM, and will move the
1425 latter just before the former.
1427 If DEST is `begin' (respectively `end'), ITEM will be moved at
1428 the beginning (respectively end) of the list it belongs to.
1431 be moved at the Nth position in the list.
1433 If DEST is `kill', ITEM will be deleted and its body will be
1434 added to the kill-ring.
1436 If DEST is `delete', ITEM will be deleted.
1438 Visibility of item is preserved.
1440 This function returns, destructively, the new list structure."
1443 ;; Grab full item body minus its bullet.
1452 item-end)))
1453 ;; Change DEST into a buffer position. A trick is needed
1454 ;; when ITEM is meant to be sent at the end of the list.
1455 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1456 ;; nil and insertion point (INS-POINT) to the first line's
1457 ;; end of the last item, we ensure the new item will be
1458 ;; inserted after the last item, and not after any of its
1459 ;; hypothetical sub-items.
1475 ;; Send ITEM at the end of the list.
1483 ;; Store inner overlays (to preserve visibility).
1495 ;; 1. Structure returned by `org-list-insert-item' may not be
1496 ;; accurate, as it cannot see sub-items included in BODY.
1497 ;; Thus, first compute the real structure so far.
1505 ;; 1.1. Remove the item just created in structure.
1507 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1510 struct
1518 new-end
1520 moved-items))
1522 ;; 2. Restore inner overlays.
1527 ;; 3. Eventually delete extra copy of the item and clean marker.
1533 "Outdent items between positions START and END.
1535 STRUCT is the list structure. PARENTS is the alist of items'
1536 parents, as returned by `org-list-parents-alist'.
1538 START is included, END excluded."
1544 ;; Item not yet in zone: keep association.
1546 ;; Item out of zone: follow associations in ACC.
1550 ;; Item has no parent: error
1553 ;; Parent is outdented: keep association.
1557 ;; Parent isn't outdented: reparent to grand-parent.
1559 parent struct parents)))
1565 "Indent items between positions START and END.
1567 STRUCT is the list structure. PARENTS is the alist of parents
1568 and PREVS is the alist of previous items, returned by,
1569 respectively, `org-list-parents-alist' and
1570 `org-list-prevs-alist'.
1572 START is included and END excluded.
1574 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1575 bullets between START and END."
1583 ;; Normalize ordered bullets.
1593 org-list-demote-modify-bullet))))
1600 ;; Item not yet in zone: keep association.
1603 ;; Item out of zone: follow associations in ACC.
1607 ;; Item is in zone...
1609 ;; Check if bullet needs to be changed.
1612 ;; First item indented but not parent: error
1615 ;; First item and parent indented: keep same
1616 ;; parent.
1618 ;; Previous item not indented: reparent to it.
1620 ;; Previous item indented: reparent like it.
1627 \f
1628 ;;; Repairing structures
1631 "Non-nil if list starting at FIRST can have alphabetical bullets.
1633 STRUCT is list structure. PREVS is the alist of previous items,
1634 as returned by `org-list-prevs-alist'."
1638 ;; Pretend that bullets are uppercase and check if alphabet
1639 ;; is sufficient, taking counters into account.
1642 ;; Virtually determine current bullet
1644 ;; Counters are not case-sensitive.
1647 ;; Test if bullet would be over z or Z.
1651 ;; All items checked. All good.
1652 t))))
1655 "Increment BULLET if applicable."
1658 ;; Num bullet: increment it.
1662 nil nil bullet))
1663 ;; Alpha bullet: increment it.
1667 nil nil bullet))
1668 ;; Unordered bullet: leave it.
1672 "Verify and correct bullets in STRUCT.
1673 PREVS is the alist of previous items, as returned by
1674 `org-list-prevs-alist'.
1676 This function modifies STRUCT."
1680 ;; Set bullet of ITEM in STRUCT, depending on the type of
1681 ;; first item of the list, the previous bullet and counter
1682 ;; if any.
1691 item struct
1694 ;; Alpha counter in alpha list: use counter.
1698 ;; Use cond to be sure `string-match' is used in
1699 ;; both cases.
1705 ;; Num counter in a num list: use counter.
1710 ;; No counter: increase, if needed, previous bullet.
1713 ;; Alpha counter at first item: use counter.
1722 ;; Num counter at first item: use counter.
1727 ;; First bullet is alpha uppercase: use "A".
1730 ;; First bullet is alpha lowercase: use "a".
1733 ;; First bullet is num: use "1".
1736 ;; Not an ordered list: keep bullet.
1741 "Verify and correct indentation in STRUCT.
1743 PARENTS is the alist of parents, as returned by
1744 `org-list-parents-alist'.
1746 If numeric optional argument BULLET-SIZE is set, assume all
1747 bullets in list have this length to determine new indentation.
1749 This function modifies STRUCT."
1756 ;; Indent like parent + length of parent's bullet +
1757 ;; sub-list offset.
1763 org-list-indent-offset))
1764 ;; If no parent, indent like top-point.
1769 "Verify and correct checkboxes in STRUCT.
1771 PARENTS is the alist of parents and PREVS is the alist of
1772 previous items, as returned by, respectively,
1773 `org-list-parents-alist' and `org-list-prevs-alist'.
1775 If ORDERED is non-nil, a checkbox can only be checked when every
1776 checkbox before it is checked too. If there was an attempt to
1777 break this rule, the function will return the blocking item. In
1778 all others cases, the return value will be nil.
1780 This function modifies STRUCT."
1790 item struct
1796 ;; Parent has no boxed child: leave box as-is.
1798 parent-list)
1799 ;; 1. List all parents with a checkbox.
1806 all-items)
1807 ;; 2. Sort those parents by decreasing indentation.
1812 ;; 3. For each parent, get all children's checkboxes to determine
1813 ;; and set its checkbox accordingly.
1815 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1820 ;; There are boxes checked after an unchecked one: fix that.
1827 ;; Verify once again the structure, without ORDERED.
1829 ;; Return blocking item.
1833 "Verify and correct each item end position in STRUCT.
1835 This function modifies STRUCT."
1842 ;; To determine real ind of an ending position that is
1843 ;; not at an item, we have to find the item it belongs
1844 ;; to: it is the last item (ITEM-UP), whose ending is
1845 ;; further than the position we're interested in.
1848 ;; Else part is for the bottom point.
1850 end-pos)
1851 end-list)))
1854 struct)
1859 "Apply set difference between STRUCT and OLD-STRUCT to the buffer.
1861 OLD-STRUCT is the structure before any modifications, and STRUCT
1862 the structure to be applied. The function will only modify parts
1863 of the list which have changed.
1865 Initial position of cursor is restored after the changes."
1872 ;; Shift the indentation between END and BEG by DELTA.
1873 ;; Start from the line before END.
1882 ;; Skip inline tasks.
1885 ;; Shift only non-empty lines.
1891 ;; Replace ITEM first line elements with new elements from
1892 ;; STRUCT, if appropriate.
1902 ;; a. Replace bullet
1905 ;; b. Replace checkbox.
1916 ;; c. Indent item to appropriate column.
1921 ;; 1. First get list of items and position endings. We maintain
1922 ;; two alists: ITM-SHIFT, determining indentation shift needed
1923 ;; at item, and END-LIST, a pseudo-alist where key is ending
1924 ;; position and value point.
1937 ;; To determine real ind of an ending position that
1938 ;; is not at an item, we have to find the item it
1939 ;; belongs to: it is the last item (ITEM-UP), whose
1940 ;; ending is further than the position we're
1941 ;; interested in.
1945 ;; 2. Slice the items into parts that should be shifted by the
1946 ;; same amount of indentation. Each slice follow the pattern
1947 ;; (END BEG DELTA). Slices are returned in reverse order.
1950 #'<)
1958 ;; If we're not at an item, there's a child of the
1959 ;; item point belongs to above. Make sure the less
1960 ;; indented line in this slice has the same column
1961 ;; as that child.
1968 ;; Ignore empty lines. Also ignore blocks and
1969 ;; drawers contents.
1977 down t)))
1980 down t)))))
1984 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1985 ;; end to beginning. Take a special action when beginning is
1986 ;; at item bullet.
1993 ;; 4. Go back to initial position and clean marker.
1998 "Correct bullets, checkboxes and indentation in list at point.
2000 STRUCT is the list structure. PARENTS is the alist of parents,
2001 as returned by `org-list-parents-alist'.
2003 When non-nil, optional argument OLD-STRUCT is the reference
2004 structure of the list. It should be provided whenever STRUCT
2005 doesn't correspond anymore to the real list in buffer."
2006 ;; Order of functions matters here: checkboxes and endings need
2007 ;; correct indentation to be set, and indentation needs correct
2008 ;; bullets.
2009 ;;
2010 ;; 0. Save a copy of structure before modifications
2012 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
2013 ;; order to get items endings and bullets properly
2015 ;; 2. Fix each item end to get correct prevs alist.
2017 ;; 3. Get bullets right.
2020 ;; 4. Now get real indentation.
2022 ;; 5. Eventually fix checkboxes.
2024 ;; 6. Apply structure modifications to buffer.
2028 \f
2029 ;;; Misc Tools
2032 "Call FUNCTION on each item of the list at point.
2033 FUNCTION must be called with at least one argument: INIT-VALUE,
2034 that will contain the value returned by the function at the
2035 previous item, plus ARGS extra arguments.
2037 FUNCTION is applied on items in reverse order.
2039 As an example, \(org-apply-on-list \(lambda \(result\) \(1+ result\)\) 0\)
2040 will return the number of items in the current list.
2042 Sublists of the list are skipped. Cursor is always at the
2043 beginning of the item."
2055 value))
2058 "Set visibility of ITEM in STRUCT to VIEW.
2060 Possible values are: `folded', `children' or `subtree'. See
2061 `org-cycle' for more information."
2065 ;; Hide from eol
2067 item-end t)))
2069 ;; First show everything.
2071 ;; Then fold every child.
2076 children)))
2078 ;; Show everything
2083 "Return column at which body of ITEM should start."
2095 2
2099 \f
2100 ;;; Interactive functions
2105 "Go to the beginning of the current item.
2106 Throw an error when not in a list."
2112 "Go to the beginning item of the current list or sublist.
2113 Throw an error when not in a list."
2124 "Go to the end of the current list or sublist.
2125 Throw an error when not in a list."
2136 "Go to the end of the current item.
2137 Throw an error when not in a list."
2147 "Move to the beginning of the previous item.
2148 Throw an error when not in a list. Also throw an error when at
2149 first item, unless `org-list-use-circular-motion' is non-nil."
2165 "Move to the beginning of the next item.
2166 Throw an error when not in a list. Also throw an error when at
2167 last item, unless `org-list-use-circular-motion' is non-nil."
2183 "Move the item at point down, i.e. swap with following item.
2184 Sub-items (items with larger indentation) are considered part of
2185 the item, so this really moves item trees."
2204 "Move the item at point up, i.e. swap with previous item.
2205 Sub-items (items with larger indentation) are considered part of
2206 the item, so this really moves item trees."
2223 "Insert a new item at the current level.
2224 If cursor is before first character after bullet of the item, the
2225 new item will be created before the current one.
2227 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2229 Return t when things worked, nil when we are not in an item, or
2230 item is invisible."
2233 ;; If cursor isn't is a list or if list is invisible, return nil.
2241 ;; Timer list: delegate to `org-timer-item'.
2246 ;; If we're in a description list, ask for the new term.
2260 t)))))
2263 "Fix indentation, bullets and checkboxes in the list at point."
2271 "Cycle through the different itemize/enumerate bullets.
2272 This cycle the entire list level through the sequence:
2274 `-' -> `+' -> `*' -> `1.' -> `1)'
2276 If WHICH is a valid string, use that as the new bullet. If WHICH
2277 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2278 `previous', cycle backwards."
2298 ;; Compute list of possible bullets, depending on context.
2301 ;; *-bullets are not allowed at column 0.
2303 ;; Description items cannot be numbered.
2326 ;; Use a short variation of `org-list-write-struct' as there's
2327 ;; no need to go through all the steps.
2335 "Toggle the checkbox in the current line.
2336 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2337 double prefix, set checkbox to [-].
2339 When there is an active region, toggle status or presence of the
2340 first checkbox there, and make every item inside have the same
2341 status or presence, respectively.
2343 If the cursor is in a headline, apply this to all checkbox items
2344 in the text below the heading, taking as reference the first item
2345 in subtree, ignoring drawers."
2349 block-item
2350 lim-up
2351 lim-down
2359 ;; In a region, start at first item in region.
2369 ;; On an heading, start at first item after drawers and
2370 ;; time-stamps (scheduled, etc.).
2382 ;; Just one item: set SINGLEP flag.
2388 ;; Determine the checkbox going to be applied to all items
2389 ;; within bounds.
2400 ;; When an item is found within bounds, grab the full list at
2401 ;; point structure, then: (1) set check-box of all its items
2402 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2403 ;; whole list, (3) move point after the list.
2417 e struct
2418 ;; If there is no box at item, leave as-is
2419 ;; unless function was called with C-u prefix.
2422 ref-checkbox
2423 cur-box))))
2424 items-to-toggle)
2426 struct parents prevs orderedp))
2427 ;; Report some problems due to ORDERED status of subtree.
2428 ;; If only one box was being checked, throw an error, else,
2429 ;; only signal problems.
2433 "Checkbox blocked because of unchecked box at line %d"
2437 "Checkboxes were removed due to unchecked box at line %d"
2446 "Reset all checkboxes in an entry subtree."
2463 "Update the checkbox statistics in the current section.
2465 This will find all statistic cookies like [57%] and [6/12] and
2466 update them with the current numbers.
2468 With optional prefix argument ALL, do this for the whole buffer."
2489 ;; Return number of checked boxes and boxes of all types
2490 ;; in all structures in STRUCTS. If RECURSIVEP is
2491 ;; non-nil, also count boxes in sub-lists. If ITEM is
2492 ;; nil, count across the whole structure, else count only
2493 ;; across subtree whose ancestor is ITEM.
2508 items))))
2511 cookies-list cache)
2512 ;; Move to start.
2516 ;; Build an alist for each cookie found. The key is the position
2517 ;; at beginning of cookie and values ending position, format of
2518 ;; cookie, number of checked boxes to report and total number of
2519 ;; boxes.
2529 context
2531 quote-block special-block verse-block)))
2547 structs)
2552 structs)
2554 :end
2556 element))))))
2557 ;; Cache count for cookies applying to the same
2558 ;; area. Then return it.
2565 structs
2566 recursivep)))
2568 count))))))
2569 cookies-list))))
2570 ;; Apply alist to buffer.
2586 "Select the face for checkbox statistics.
2587 The face will be `org-done' when all relevant boxes are checked.
2588 Otherwise it will be `org-todo'."
2591 'org-checkbox-statistics-done
2595 'org-checkbox-statistics-done
2599 "Update checkbox statistics unless turned off by user.
2600 With an optional argument ALL, update them in the whole buffer."
2608 "Indent a local list item including its children.
2609 When number ARG is a negative, item will be outdented, otherwise
2610 it will be indented.
2612 If a region is active, all items inside will be moved.
2614 If NO-SUBTREE is non-nil, only indent the item itself, not its
2615 children.
2617 STRUCT is the list structure.
2619 Return t if successful."
2627 ;; Are we going to move the whole list?
2635 t))))
2636 ;; Determine begin and end points of zone to indent. If moving
2637 ;; more than one item, save them for subsequent moves.
2653 ;; Special case: moving top-item with indent rule.
2661 ;; Change bullet if necessary.
2667 ;; Shift every item by OFFSET and fix bullets. Then
2668 ;; apply changes to buffer.
2672 struct)
2675 ;; Forbidden move:
2677 ;; If only one item is moved, it mustn't have a child.
2681 ;; If a subtree or region is moved, the last item
2682 ;; of the subtree mustn't have a child.
2687 struct)))))
2690 ;; Normal shifting
2698 t)
2701 "Outdent a local list item, but not its children.
2702 If a region is active, all items inside will be moved."
2718 "Indent a local list item, but not its children.
2719 If a region is active, all items inside will be moved."
2735 "Outdent a local list item including its children.
2736 If a region is active, all items inside will be moved."
2752 "Indent a local list item including its children.
2753 If a region is active, all items inside will be moved."
2771 "Cycle levels of indentation of an empty item.
2772 The first run indents the item, if applicable. Subsequent runs
2773 outdent it at meaningful levels in the list. When done, item is
2774 put back at its original position with its original bullet.
2776 Return t at each successful move."
2782 ;; Accept empty items or if cycle has already started.
2793 ;; When in the middle of the cycle, try to outdent first. If
2794 ;; it fails, and point is still at initial position, indent.
2795 ;; Else, re-create it at its original position.
2804 ;; Break cycle
2806 ;; If a cycle is starting, remember indentation and bullet,
2807 ;; then try to indent. If it fails, try to outdent.
2813 t))))
2816 "Sort list items.
2817 The cursor may be at any item of the list that should be sorted.
2818 Sublists are not sorted. Checkboxes, if any, are ignored.
2820 Sorting can be alphabetically, numerically, by date/time as given
2821 by a time stamp, by a property or by priority.
2823 Comparing entries ignores case by default. However, with an
2824 optional argument WITH-CASE, the sorting considers case as well.
2826 The command prompts for the sorting type unless it has been given
2827 to the function through the SORTING-TYPE argument, which needs to
2828 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F ?x ?X). Here is the
2829 detailed meaning of each character:
2831 n Numerically, by converting the beginning of the item to a number.
2832 a Alphabetically. Only the first line of item is checked.
2833 t By date/time, either the first active time stamp in the entry, if
2834 any, or by the first inactive one. In a timer list, sort the timers.
2837 Capital letters will reverse the sort order.
2839 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2840 a function to be called with point at the beginning of the
2841 record. It must return either a string or a number that should
2842 serve as the sorting key for that record. It will then use
2843 COMPARE-FUNC to compare entries.
2845 Sorting is done against the visible part of the headlines, it
2846 ignores hidden links."
2897 ;; If it is a timer list, convert timer to seconds
2914 value))
2918 next-record
2919 end-record
2920 value-to-sort
2921 nil
2922 sort-func)
2923 ;; Read and fix list again, as `sort-subr' probably destroyed
2924 ;; its structure.
2930 \f
2931 ;;; Send and receive lists
2934 "Parse the list at point and maybe DELETE it.
2936 Return a list whose car is a symbol of list type, among
2937 `ordered', `unordered' and `descriptive'. Then, each item is
2938 a list whose car is counter, and cdr are strings and other
2939 sub-lists. Inside strings, check-boxes are replaced by
2942 For example, the following list:
2944 1. first item
2945 + sub-item one
2946 + [X] sub-item two
2947 more text in first item
2948 2. [@3] last item
2950 will be parsed as:
2952 \(ordered
2954 \(unordered
2960 Point is left at list end."
2967 out
2970 ;; Return text between BEG and END, trimmed, with
2971 ;; checkboxes replaced.
2982 text)))))
2985 ;; Return a list whose car is list type and cdr a list of
2986 ;; items' body.
2992 ;; Return a list containing counter of item, if any, text
2993 ;; and any sublist inside it.
2999 ;; Get counter number. For alphabetic counter, get
3000 ;; its position in the alphabet.
3011 ;; If item has a child, store text between bullet and
3012 ;; next child, then recursively parse all sublists. At
3013 ;; the end of each sublist, check for the presence of
3014 ;; text belonging to the original item.
3024 ;; Remove children from the list just parsed.
3026 ;; There is a chunk of text belonging to the
3027 ;; item if last child doesn't end where next
3028 ;; child starts or where item ends.
3032 body))))
3035 ;; Store output, take care of cursor position and deletion of
3036 ;; list, then return output.
3043 out))
3046 "Convert the plain list at point into a subtree."
3054 "Insert a radio list template appropriate for this major mode."
3058 name pos)
3069 "Send a transformed version of this list to the receiver position.
3070 With argument MAYBE, fail quietly if no transformation is defined
3071 for this list."
3093 beg)
3097 ;; Find the insertion place
3102 name
3104 nil t)
3117 "Trim line breaks in a list ITEM."
3121 "Convert a LIST parsed through `org-list-parse-list' to other formats.
3122 Valid parameters PARAMS are:
3124 :ustart String to start an unordered list
3125 :uend String to end an unordered list
3127 :ostart String to start an ordered list
3128 :oend String to end an ordered list
3130 :dstart String to start a descriptive list
3131 :dend String to end a descriptive list
3132 :dtstart String to start a descriptive term
3133 :dtend String to end a descriptive term
3134 :ddstart String to start a description
3135 :ddend String to end a description
3137 :splice When set to t, return only list body lines, don't wrap
3138 them into :[u/o]start and :[u/o]end. Default is nil.
3140 :istart String to start a list item.
3141 :icount String to start an item with a counter.
3142 :iend String to end a list item
3143 :isep String to separate items
3144 :lsep String to separate sublists
3145 :csep String to separate text from a sub-list
3147 :cboff String to insert for an unchecked check-box
3148 :cbon String to insert for a checked check-box
3149 :cbtrans String to insert for a check-box in transitional state
3151 :nobr Non-nil means remove line breaks in lists items.
3153 Alternatively, each parameter can also be a form returning
3154 a string. These sexp can use keywords `counter' and `depth',
3155 representing respectively counter associated to the current
3156 item, and depth of the current sub-list, starting at 0.
3157 Obviously, `counter' is only available for parameters applying to
3158 items."
3182 export-sublist ; for byte-compiler
3185 ;; Export an item ITEM of type TYPE, at DEPTH. First
3186 ;; string in item is treated in a special way as it can
3187 ;; bring extra information that needs to be processed.
3193 ;; Stick DTSTART to ISTART by
3194 ;; left-trimming the latter.
3198 istart))
3205 ;; Replace checkbox if any is found.
3213 ;; Replace line breaks if required
3215 ;; Insert descriptive term if TYPE is `descriptive'.
3224 first)))
3235 ;; Export sublist SUB at DEPTH.
3253 "Convert LIST into a LaTeX list.
3254 LIST is as string representing the list to transform, as Org
3255 syntax. Return converted list as a string."
3260 "Convert LIST into a HTML list.
3261 LIST is as string representing the list to transform, as Org
3262 syntax. Return converted list as a string."
3267 "Convert LIST into a Texinfo list.
3268 LIST is as string representing the list to transform, as Org
3269 syntax. Return converted list as a string."
3274 "Convert LIST into an Org subtree.
3275 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3276 with overruling parameters for `org-list-to-generic'."
3287 ;; Return the string for the heading, depending on depth D
3288 ;; of current sub-list.
3293 oddeven-level)
3294 ?*)
3297 list
3299 '(:splice t
3306 params))))
3310 ;;; org-list.el ends here