| blob | bbdb4faa45738413710c77edc529d215da25ad63 |
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:
140 \f
141 ;;; Configuration variables
144 "Options concerning plain lists in Org-mode."
149 "When t, make TAB cycle visibility on plain list items.
150 Cycling plain lists works only when the cursor is on a plain list
151 item. When the cursor is on an outline heading, plain lists are
152 treated as text. This is the most stable way of handling this,
153 which is why it is the default.
155 When this is the symbol `integrate', then integrate plain list
156 items when cycling, as if they were children of outline headings.
158 This setting can lead to strange effects when switching visibility
161 plain list item with an implied large level number, all true
162 children and grand children of the outline heading will be
163 exposed in a children' view."
172 "Default bullet type installed when demoting an item.
173 This is an association list, for each bullet type, this alist will point
174 to the bullet that should be used when this item is demoted.
175 For example,
177 (setq org-list-demote-modify-bullet
180 will make
182 + Movies
183 + Silence of the Lambs
184 + My Cousin Vinny
185 + Books
186 + The Hunt for Red October
187 + The Road to Omaha
189 into
191 + Movies
192 - Silence of the Lambs
193 - My Cousin Vinny
194 + Books
195 - The Hunt for Red October
196 - The Road to Omaha"
214 "The character that makes a line with leading number an ordered list item.
215 Valid values are ?. and ?\). To get both terminators, use t.
217 This variable needs to be set before org.el is loaded. If you
218 need to make a change while Emacs is running, use the customize
219 interface or run the following code after updating it:
232 "Non-nil means single character alphabetical bullets are allowed.
234 Both uppercase and lowercase are handled. Lists with more than
235 26 items will fallback to standard numbering. Alphabetical
238 This variable needs to be set before org.el is loaded. If you
239 need to make a change while Emacs is running, use the customize
240 interface or run the following code after updating it:
250 "A regular expression matching bullets that should have 2 spaces after them.
251 When nil, no bullet will have two spaces after them. When
252 a string, it will be used as a regular expression. When the
253 bullet type of a list is changed, the new bullet type will be
254 matched against this regexp. If it matches, there will be two
255 spaces instead of one after the bullet in each item of the list."
264 "Non-nil means an empty line ends all plain list levels.
265 Otherwise, two of them will be necessary."
271 "Non-nil means apply set of rules when acting on lists.
272 By default, automatic actions are taken when using
277 rules by setting them to nil. Valid rules are:
279 checkbox when non-nil, checkbox statistics is updated each time
280 you either insert a new checkbox or toggle a checkbox.
281 indent when non-nil, indenting or outdenting list top-item
282 with its subtree will move the whole list and
283 outdenting a list whose bullet is * to column 0 will
288 :key-type
292 :value-type
296 "Non-nil means commands implying motion in lists should be cyclic.
298 In that case, the item following the last item is the first one,
299 and the item preceding the first item is the last one.
309 "Hook that is run whenever Org thinks checkbox statistics should be updated.
310 This hook runs even if checkbox rule in
311 `org-list-automatic-rules' does not apply, so it can be used to
312 implement alternative ways of collecting statistics
318 "Non-nil means checkbox statistics counts only the state of direct children.
319 When nil, all boxes below the cookie are counted.
320 This can be set to nil on a per-node basis using a COOKIE_DATA property
328 "Maximum indentation for the second line of a description list.
329 When the indentation would be larger than this, it will become
330 5 characters instead."
335 "Additional indentation for sub-items in a list.
336 By setting this to a small number, usually 1 or 2, one can more
337 clearly distinguish sub-items in a list."
344 % END RECEIVE ORGLST %n
346 #+ORGLST: SEND %n org-list-to-latex
347 -
350 @c END RECEIVE ORGLST %n
351 @ignore
352 #+ORGLST: SEND %n org-list-to-texinfo
353 -
356 <!-- END RECEIVE ORGLST %n -->
357 <!--
358 #+ORGLST: SEND %n org-list-to-html
359 -
361 "Templates for radio lists in different major modes.
362 All occurrences of %n in a template will be replaced with the name of the
363 list, obtained by prompting the user."
371 "Names of blocks where lists are not allowed.
375 "Context types where lists will be interpreted during export.
377 Valid types are `drawer', `inlinetask' and `block'. More
378 specifically, type `block' is determined by the variable
382 \f
383 ;;; Predicates and regexps
387 "Regex corresponding to the end of a list.
395 "Matches a list item and puts everything into groups:
396 group 1: bullet
397 group 2: counter
398 group 3: checkbox
402 "Return the correct regular expression for plain lists."
413 "Regexp matching the beginning of a plain list item."
417 "Is point at a list item with REGEXP after bullet?"
426 ;; Ignore counter if any
431 "Is point in a context where lists are allowed?"
435 "Return item beginning position when in a plain list, nil otherwise."
444 ;; Indentation isn't meaningful when point starts at an empty
445 ;; line or an inline task.
448 10000
454 ;; Detect if cursor in amidst `org-list-end-re'. First, count
455 ;; number HL of hard lines it takes, then call `org-in-regexp'
456 ;; to compute its boundaries END-BOUNDS. When point is
457 ;; in-between, move cursor before regexp beginning.
468 ;; Look for an item, less indented that reference line.
473 ;; This is exactly what we want.
476 ;; At upper bound of search or looking at the end of a
477 ;; previous list: search is over.
480 ;; Skip blocks, drawers, inline-tasks, blank lines
490 ;; Text at column 0 cannot belong to a list: stop.
492 ;; Normal text less indented than reference line, take
493 ;; it as new reference.
500 "Is point in a line starting a hand-formatted item?"
506 "Is point at the bullet of a plain list item?"
512 "Is point at a line starting a plain list item with a timer?"
517 "Is point at a description list item?"
521 "Is point at a line starting a plain-list item with a checklet?"
525 "Is point at a line starting a plain-list item with a counter?"
531 \f
532 ;;; Structures and helper functions
535 "Determine context, and its boundaries, around point.
537 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
538 are boundaries and CONTEXT is a symbol among `drawer', `block',
539 `invalid', `inlinetask' and nil.
541 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
547 ;; Get positions of surrounding headings. This is the
548 ;; default context.
553 ;; Is point inside a drawer?
563 lim-down))
566 ;; Is point strictly in a block, and of which type?
577 lim-down))
583 ;; Is point in an inlinetask?
596 ;; Return context boundaries and type.
600 "Return structure of list at point.
602 A list structure is an alist where key is point at item, and
603 values are:
604 1. indentation,
605 2. bullet with trailing whitespace,
606 3. bullet counter, if any,
607 4. checkbox, if any,
608 5. description tag, if any,
609 6. position at item end.
611 Thus the following list, where numbers in parens are
612 point-at-bol:
614 - [X] first item (1)
615 1. sub-item 1 (18)
616 5. [@5] sub-item 2 (34)
617 some other text belonging to first item (55)
618 - last item (97)
619 + tag :: description (109)
620 (131)
622 will get the following structure:
630 Assume point is at an item."
642 itm-lst itm-lst-2 end-lst end-lst-2 struct
645 ;; Return association at point.
650 ind
651 bullet
654 ;; Description tag.
659 ;; Ensure list ends at the first blank line.
663 ;; 1. Read list from starting item to its beginning, and save
664 ;; top item position and indentation in BEG-CELL. Also store
665 ;; ending position of items in END-LST.
672 ;; At upward limit: if we ended at an item, store it,
673 ;; else dismiss useless data recorded above BEG-CELL.
674 ;; Jump to part 2.
681 ;; Looking at a list ending regexp. Dismiss useless
682 ;; data recorded above BEG-CELL. Jump to part 2.
687 ;; Point is at an item. Add data to ITM-LST. It may
688 ;; also end a previous item: save it in END-LST. If
689 ;; ind is less or equal than BEG-CELL and there is no
690 ;; end at this ind or lesser, this item becomes the new
691 ;; BEG-CELL.
697 ;; Skip blocks, drawers, inline tasks, blank lines.
708 ;; From there, point is not at an item. Interpret
709 ;; line's indentation:
710 ;; - text at column 0 is necessarily out of any list.
711 ;; Dismiss data recorded above BEG-CELL. Jump to
712 ;; part 2.
713 ;; - any other case may be an ending position for an
714 ;; hypothetical item above. Store it and proceed.
723 ;; 2. Read list from starting point to its end, that is until we
724 ;; get out of context, or that a non-item line is less or
725 ;; equally indented than BEG-CELL's cdr. Also, store ending
726 ;; position of items in END-LST-2.
732 ;; At downward limit: this is de facto the end of the
733 ;; list. Save point as an ending position, and jump to
734 ;; part 3.
737 ;; Looking at a list ending regexp. Save point as an
738 ;; ending position and jump to part 3.
742 ;; Point is at an item. Add data to ITM-LST-2. It may
743 ;; also end a previous item, so save it in END-LST-2.
747 ;; Skip inline tasks and blank lines along the way
752 ;; Ind is lesser or equal than BEG-CELL's. The list is
753 ;; over: store point as an ending position and jump to
754 ;; part 3.
758 ;; Else, if ind is lesser or equal than previous item's,
759 ;; this is an ending position: store it. In any case,
760 ;; skip block or drawer at point, and move to next line.
772 ;; 3. Associate each item to its end position.
774 ;; 4. Return STRUCT
775 struct)))
778 "Associate proper ending point to items in STRUCT.
780 END-LIST is a pseudo-alist where car is indentation and cdr is
781 ending position.
783 This function modifies STRUCT."
789 ;; Remove end candidates behind current item.
792 ;; Add end position to item assoc.
798 struct)))
801 "Return alist between item and previous item in STRUCT."
803 struct)))
807 struct)))
810 "Return alist between item and parent in STRUCT."
822 ;; A sub-list is over. Find the associated
823 ;; origin in IND-TO-ORI. If it cannot be
824 ;; found (ill-formed list), set its parent as
825 ;; the first item less indented. If there is
826 ;; none, make it a top-level item.
834 ind-to-ori)
837 ;; A sub-list starts. Every item at IND will
838 ;; have previous item as its parent.
843 ;; Another item in the same sub-list: it shares
844 ;; the same parent as the previous item.
849 \f
850 ;;; Accessors
853 "Return the Nth value of KEY in STRUCT."
857 "Set the Nth value of KEY in STRUCT to NEW.
862 "Return indentation of ITEM in STRUCT."
866 "Set indentation of ITEM in STRUCT to IND.
871 "Return bullet of ITEM in STRUCT."
875 "Set bullet of ITEM in STRUCT to BULLET.
880 "Return counter of ITEM in STRUCT."
884 "Return checkbox of ITEM in STRUCT or nil."
888 "Set checkbox of ITEM in STRUCT to CHECKBOX.
893 "Return end position of ITEM in STRUCT."
897 "Return end position of ITEM in STRUCT."
901 "Return point at end of ITEM in STRUCT, before any blank line.
902 Point returned is at end of line."
909 "Return parent of ITEM or nil.
910 STRUCT is the list structure. PARENTS is the alist of parents,
911 as returned by `org-list-parents-alist'."
916 "Non-nil if ITEM has a child.
918 STRUCT is the list structure.
920 Value returned is the position of the first child of ITEM."
925 child-maybe)))
928 "Return next item in same sub-list as ITEM, or nil.
929 STRUCT is the list structure. PREVS is the alist of previous
930 items, as returned by `org-list-prevs-alist'."
934 "Return previous item in same sub-list as ITEM, or nil.
935 STRUCT is the list structure. PREVS is the alist of previous
936 items, as returned by `org-list-prevs-alist'."
940 "List all items having ITEM as a common ancestor, or nil.
941 STRUCT is the list structure."
944 subtree)
949 sub-struct))
953 "List all items in the same sub-list as ITEM.
954 STRUCT is the list structure. PREVS is the alist of previous
955 items, as returned by `org-list-prevs-alist'."
958 before-item after-item)
966 "List all children of ITEM, or nil.
967 STRUCT is the list structure. PARENTS is the alist of parents,
968 as returned by `org-list-parents-alist'."
976 "Return point at beginning of list.
977 STRUCT is the list structure."
981 "Return point at bottom of list.
982 STRUCT is the list structure."
987 "Return point at beginning of sub-list ITEM belongs.
988 STRUCT is the list structure. PREVS is the alist of previous
989 items, as returned by `org-list-prevs-alist'."
993 first-item))
998 "Return point at last item of sub-list ITEM belongs.
999 STRUCT is the list structure. PREVS is the alist of previous
1000 items, as returned by `org-list-prevs-alist'."
1004 last-item))
1007 "Return point at end 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 "Return the type of the list containing ITEM, as a symbol.
1015 STRUCT is the list structure. PREVS is the alist of previous
1016 items, as returned by `org-list-prevs-alist'.
1018 Possible types are `descriptive', `ordered' and `unordered'. The
1019 type is determined by the first item of the list."
1027 "Return ITEM's sequence number.
1029 STRUCT is the list structure. PREVS is the alist of previous
1030 items, as returned by `org-list-prevs-alist'. PARENTS is the
1031 alist of ancestors, as returned by `org-list-parents-alist'.
1033 Return value is a list of integers. Counters have an impact on
1034 that value."
1038 ;; Return relative sequence number of ITEM in the sub-list
1039 ;; it belongs. STRUCT is the list structure. PREVS is
1040 ;; the alist of previous items.
1049 seq))
1053 ;; Cons each parent relative number into return value (OUT).
1058 ;; Return value.
1059 out)))
1062 \f
1063 ;;; Searching
1066 "Search a string in valid contexts for lists.
1067 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1068 in `re-search-forward'."
1072 ;; 1. No match: return to origin or bound, depending on NOERR.
1075 nil)))
1076 ;; 2. Match in valid context: return point. Else, continue
1077 ;; searching.
1081 "Like `re-search-backward' but stop only where lists are recognized.
1082 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1083 `re-search-backward'."
1088 "Like `re-search-forward' but stop only where lists are recognized.
1089 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1090 `re-search-forward'."
1095 \f
1096 ;;; Methods on structures
1099 "Return BULLET with the correct number of whitespaces.
1100 It determines the number of whitespaces to append by looking at
1101 `org-list-two-spaces-after-bullet-regexp'."
1105 org-list-two-spaces-after-bullet-regexp bullet))
1106 " "
1110 bullet))))
1113 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1115 Blank lines at the end of items are left in place. Item
1116 visibility is preserved. Return the new structure after the
1117 changes.
1119 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1120 to the same sub-list.
1122 This function modifies STRUCT."
1135 ;; Store overlays responsible for visibility status. We
1136 ;; also need to store their boundaries as they will be
1137 ;; removed from buffer.
1152 ;; 1. Move effectively items in buffer.
1156 ;; 2. Now modify struct. No need to re-read the list, the
1157 ;; transformation is just a shift of positions. Some special
1158 ;; attention is required for items ending at END-A and END-B
1159 ;; as empty spaces are not moved there. In others words,
1160 ;; item BEG-A will end with whitespaces that were at the end
1161 ;; of BEG-B and the same applies to BEG-B.
1184 ;; Restore visibility status, by moving overlays to their new
1185 ;; position.
1195 ;; Return structure.
1196 struct)))
1199 "Return number of blank lines that should separate items in list.
1201 POS is the position of point where `org-list-insert-item' was called.
1203 STRUCT is the list structure. PREVS is the alist of previous
1204 items, as returned by `org-list-prevs-alist'.
1206 Assume point is at item's beginning. If the item is alone, apply
1207 some heuristics to guess the result."
1212 usr-blank
1216 ;; Count blank lines above beginning of line.
1223 ;; Trivial cases where there should be none.
1225 ;; When `org-blank-before-new-entry' says so, it is 1.
1227 ;; `plain-list-item' is 'auto. Count blank lines separating
1228 ;; neighbors' items in list.
1231 ;; Is there a next item?
1234 ;; Is there a previous item?
1237 ;; User inserted blank lines, trust him.
1242 usr-blank)
1243 ;; Are there blank lines inside the list so far?
1246 ;; Do not use `org-list-search-forward' so blank lines
1247 ;; in blocks can be counted in.
1251 ;; Default choice: no blank line.
1255 "Insert a new list item at POS and return the new structure.
1256 If POS is before first character after bullet of the item, the
1257 new item will be created before the current one.
1259 STRUCT is the list structure. PREVS is the alist of previous
1260 items, as returned by `org-list-prevs-alist'.
1262 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1263 after the bullet. Cursor will be after this text once the
1264 function ends.
1266 This function modifies STRUCT."
1268 ;; 1. Get information about list: position of point with regards
1269 ;; to item start (BEFOREP), blank lines number separating items
1270 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1277 (<= pos
1280 ;; Ignore tag in a non-descriptive list.
1289 pos struct prevs))
1290 ;; 2. Build the new item to be created. Concatenate same
1291 ;; bullet as item, checkbox, text AFTER-BULLET if
1292 ;; provided, and text cut from point to end of item
1293 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1294 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1295 ;; between what was cut and what was inserted in buffer
1296 ;; is stored in SIZE-OFFSET.
1300 ind))
1307 ;; If POS is greater than ITEM-END, then point is
1308 ;; in some white lines after the end of the list.
1309 ;; Those must be removed, or they will be left,
1310 ;; stacking up after the list.
1320 text-cut))))
1324 ;; 4. Insert effectively item into buffer.
1328 ;; 5. Add new item to STRUCT.
1332 ;; Before inserted item, positions don't change but
1333 ;; an item ending after insertion has its end shifted
1334 ;; by SIZE-OFFSET.
1337 ;; Trivial cases where current item isn't split in
1338 ;; two. Just shift every item after new one by
1339 ;; ITEM-SIZE.
1343 ;; Item is split in two: elements before POS are just
1344 ;; shifted by ITEM-SIZE. In the case item would end
1345 ;; after split POS, ending is only shifted by
1346 ;; SIZE-OFFSET.
1352 ;; Elements after POS are moved into new item.
1353 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1354 ;; doesn't appear in buffer yet.
1360 (+ end size-offset
1362 ;; Elements at ITEM-END or after are only shifted by
1363 ;; SIZE-OFFSET.
1366 struct)
1369 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1370 ;; exchange ITEM with the next item in list. Position cursor
1371 ;; after bullet, counter, checkbox, and label.
1377 struct)))
1380 "Remove ITEM from the list and return the new structure.
1382 STRUCT is the list structure."
1385 ;; If ITEM ends with the list, delete blank lines
1386 ;; before it.
1391 item)))
1392 ;; Remove item from buffer.
1394 ;; Remove item from structure and shift others items accordingly.
1395 ;; Don't forget to shift also ending position when appropriate.
1413 struct)))))
1416 "Send ITEM to destination DEST.
1418 STRUCT is the list structure.
1420 DEST can have various values.
1422 If DEST is a buffer position, the function will assume it points
1423 to another item in the same list as ITEM, and will move the
1424 latter just before the former.
1426 If DEST is `begin' (respectively `end'), ITEM will be moved at
1427 the beginning (respectively end) of the list it belongs to.
1430 be moved at the Nth position in the list.
1432 If DEST is `kill', ITEM will be deleted and its body will be
1433 added to the kill-ring.
1435 If DEST is `delete', ITEM will be deleted.
1437 Visibility of item is preserved.
1439 This function returns, destructively, the new list structure."
1442 ;; Grab full item body minus its bullet.
1451 item-end)))
1452 ;; Change DEST into a buffer position. A trick is needed
1453 ;; when ITEM is meant to be sent at the end of the list.
1454 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1455 ;; nil and insertion point (INS-POINT) to the first line's
1456 ;; end of the last item, we ensure the new item will be
1457 ;; inserted after the last item, and not after any of its
1458 ;; hypothetical sub-items.
1474 ;; Send ITEM at the end of the list.
1482 ;; Store inner overlays (to preserve visibility).
1494 ;; 1. Structure returned by `org-list-insert-item' may not be
1495 ;; accurate, as it cannot see sub-items included in BODY.
1496 ;; Thus, first compute the real structure so far.
1504 ;; 1.1. Remove the item just created in structure.
1506 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1509 struct
1517 new-end
1519 moved-items))
1521 ;; 2. Restore inner overlays.
1526 ;; 3. Eventually delete extra copy of the item and clean marker.
1532 "Outdent items between positions START and END.
1534 STRUCT is the list structure. PARENTS is the alist of items'
1535 parents, as returned by `org-list-parents-alist'.
1537 START is included, END excluded."
1543 ;; Item not yet in zone: keep association.
1545 ;; Item out of zone: follow associations in ACC.
1549 ;; Item has no parent: error
1552 ;; Parent is outdented: keep association.
1556 ;; Parent isn't outdented: reparent to grand-parent.
1558 parent struct parents)))
1564 "Indent items between positions START and END.
1566 STRUCT is the list structure. PARENTS is the alist of parents
1567 and PREVS is the alist of previous items, returned by,
1568 respectively, `org-list-parents-alist' and
1569 `org-list-prevs-alist'.
1571 START is included and END excluded.
1573 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1574 bullets between START and END."
1582 ;; Normalize ordered bullets.
1592 org-list-demote-modify-bullet))))
1599 ;; Item not yet in zone: keep association.
1602 ;; Item out of zone: follow associations in ACC.
1606 ;; Item is in zone...
1608 ;; Check if bullet needs to be changed.
1611 ;; First item indented but not parent: error
1614 ;; First item and parent indented: keep same
1615 ;; parent.
1617 ;; Previous item not indented: reparent to it.
1619 ;; Previous item indented: reparent like it.
1626 \f
1627 ;;; Repairing structures
1630 "Non-nil if list starting at FIRST can have alphabetical bullets.
1632 STRUCT is list structure. PREVS is the alist of previous items,
1633 as returned by `org-list-prevs-alist'."
1637 ;; Pretend that bullets are uppercase and check if alphabet
1638 ;; is sufficient, taking counters into account.
1641 ;; Virtually determine current bullet
1643 ;; Counters are not case-sensitive.
1646 ;; Test if bullet would be over z or Z.
1650 ;; All items checked. All good.
1651 t))))
1654 "Increment BULLET if applicable."
1657 ;; Num bullet: increment it.
1661 nil nil bullet))
1662 ;; Alpha bullet: increment it.
1666 nil nil bullet))
1667 ;; Unordered bullet: leave it.
1671 "Verify and correct bullets in STRUCT.
1672 PREVS is the alist of previous items, as returned by
1673 `org-list-prevs-alist'.
1675 This function modifies STRUCT."
1679 ;; Set bullet of ITEM in STRUCT, depending on the type of
1680 ;; first item of the list, the previous bullet and counter
1681 ;; if any.
1690 item struct
1693 ;; Alpha counter in alpha list: use counter.
1697 ;; Use cond to be sure `string-match' is used in
1698 ;; both cases.
1704 ;; Num counter in a num list: use counter.
1709 ;; No counter: increase, if needed, previous bullet.
1712 ;; Alpha counter at first item: use counter.
1721 ;; Num counter at first item: use counter.
1726 ;; First bullet is alpha uppercase: use "A".
1729 ;; First bullet is alpha lowercase: use "a".
1732 ;; First bullet is num: use "1".
1735 ;; Not an ordered list: keep bullet.
1740 "Verify and correct indentation in STRUCT.
1742 PARENTS is the alist of parents, as returned by
1743 `org-list-parents-alist'.
1745 If numeric optional argument BULLET-SIZE is set, assume all
1746 bullets in list have this length to determine new indentation.
1748 This function modifies STRUCT."
1755 ;; Indent like parent + length of parent's bullet +
1756 ;; sub-list offset.
1762 org-list-indent-offset))
1763 ;; If no parent, indent like top-point.
1768 "Verify and correct checkboxes in STRUCT.
1770 PARENTS is the alist of parents and PREVS is the alist of
1771 previous items, as returned by, respectively,
1772 `org-list-parents-alist' and `org-list-prevs-alist'.
1774 If ORDERED is non-nil, a checkbox can only be checked when every
1775 checkbox before it is checked too. If there was an attempt to
1776 break this rule, the function will return the blocking item. In
1777 all others cases, the return value will be nil.
1779 This function modifies STRUCT."
1789 item struct
1795 ;; Parent has no boxed child: leave box as-is.
1797 parent-list)
1798 ;; 1. List all parents with a checkbox.
1805 all-items)
1806 ;; 2. Sort those parents by decreasing indentation.
1811 ;; 3. For each parent, get all children's checkboxes to determine
1812 ;; and set its checkbox accordingly.
1814 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1819 ;; There are boxes checked after an unchecked one: fix that.
1826 ;; Verify once again the structure, without ORDERED.
1828 ;; Return blocking item.
1832 "Verify and correct each item end position in STRUCT.
1834 This function modifies STRUCT."
1841 ;; To determine real ind of an ending position that is
1842 ;; not at an item, we have to find the item it belongs
1843 ;; to: it is the last item (ITEM-UP), whose ending is
1844 ;; further than the position we're interested in.
1847 ;; Else part is for the bottom point.
1849 end-pos)
1850 end-list)))
1853 struct)
1858 "Apply set difference between STRUCT and OLD-STRUCT to the buffer.
1860 OLD-STRUCT is the structure before any modifications, and STRUCT
1861 the structure to be applied. The function will only modify parts
1862 of the list which have changed.
1864 Initial position of cursor is restored after the changes."
1871 ;; Shift the indentation between END and BEG by DELTA.
1872 ;; Start from the line before END.
1881 ;; Skip inline tasks.
1884 ;; Shift only non-empty lines.
1890 ;; Replace ITEM first line elements with new elements from
1891 ;; STRUCT, if appropriate.
1901 ;; a. Replace bullet
1904 ;; b. Replace checkbox.
1915 ;; c. Indent item to appropriate column.
1920 ;; 1. First get list of items and position endings. We maintain
1921 ;; two alists: ITM-SHIFT, determining indentation shift needed
1922 ;; at item, and END-LIST, a pseudo-alist where key is ending
1923 ;; position and value point.
1936 ;; To determine real ind of an ending position that
1937 ;; is not at an item, we have to find the item it
1938 ;; belongs to: it is the last item (ITEM-UP), whose
1939 ;; ending is further than the position we're
1940 ;; interested in.
1944 ;; 2. Slice the items into parts that should be shifted by the
1945 ;; same amount of indentation. Each slice follow the pattern
1946 ;; (END BEG DELTA). Slices are returned in reverse order.
1949 #'<)
1957 ;; If we're not at an item, there's a child of the
1958 ;; item point belongs to above. Make sure the less
1959 ;; indented line in this slice has the same column
1960 ;; as that child.
1967 ;; Ignore empty lines. Also ignore blocks and
1968 ;; drawers contents.
1976 down t)))
1979 down t)))))
1983 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1984 ;; end to beginning. Take a special action when beginning is
1985 ;; at item bullet.
1992 ;; 4. Go back to initial position and clean marker.
1997 "Correct bullets, checkboxes and indentation in list at point.
1999 STRUCT is the list structure. PARENTS is the alist of parents,
2000 as returned by `org-list-parents-alist'.
2002 When non-nil, optional argument OLD-STRUCT is the reference
2003 structure of the list. It should be provided whenever STRUCT
2004 doesn't correspond anymore to the real list in buffer."
2005 ;; Order of functions matters here: checkboxes and endings need
2006 ;; correct indentation to be set, and indentation needs correct
2007 ;; bullets.
2008 ;;
2009 ;; 0. Save a copy of structure before modifications
2011 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
2012 ;; order to get items endings and bullets properly
2014 ;; 2. Fix each item end to get correct prevs alist.
2016 ;; 3. Get bullets right.
2019 ;; 4. Now get real indentation.
2021 ;; 5. Eventually fix checkboxes.
2023 ;; 6. Apply structure modifications to buffer.
2027 \f
2028 ;;; Misc Tools
2031 "Call FUNCTION on each item of the list at point.
2032 FUNCTION must be called with at least one argument: INIT-VALUE,
2033 that will contain the value returned by the function at the
2034 previous item, plus ARGS extra arguments.
2036 FUNCTION is applied on items in reverse order.
2038 As an example, \(org-apply-on-list \(lambda \(result\) \(1+ result\)\) 0\)
2039 will return the number of items in the current list.
2041 Sublists of the list are skipped. Cursor is always at the
2042 beginning of the item."
2054 value))
2057 "Set visibility of ITEM in STRUCT to VIEW.
2059 Possible values are: `folded', `children' or `subtree'. See
2060 `org-cycle' for more information."
2064 ;; Hide from eol
2066 item-end t)))
2068 ;; First show everything.
2070 ;; Then fold every child.
2075 children)))
2077 ;; Show everything
2082 "Return column at which body of ITEM should start."
2094 2
2098 \f
2099 ;;; Interactive functions
2104 "Go to the beginning of the current item.
2105 Throw an error when not in a list."
2111 "Go to the beginning item of the current list or sublist.
2112 Throw an error when not in a list."
2123 "Go to the end of the current list or sublist.
2124 Throw an error when not in a list."
2135 "Go to the end of the current item.
2136 Throw an error when not in a list."
2146 "Move to the beginning of the previous item.
2147 Throw an error when not in a list. Also throw an error when at
2148 first item, unless `org-list-use-circular-motion' is non-nil."
2164 "Move to the beginning of the next item.
2165 Throw an error when not in a list. Also throw an error when at
2166 last item, unless `org-list-use-circular-motion' is non-nil."
2182 "Move the item at point down, i.e. swap with following item.
2183 Sub-items (items with larger indentation) are considered part of
2184 the item, so this really moves item trees."
2203 "Move the item at point up, i.e. swap with previous item.
2204 Sub-items (items with larger indentation) are considered part of
2205 the item, so this really moves item trees."
2222 "Insert a new item at the current level.
2223 If cursor is before first character after bullet of the item, the
2224 new item will be created before the current one.
2226 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2228 Return t when things worked, nil when we are not in an item, or
2229 item is invisible."
2232 ;; If cursor isn't is a list or if list is invisible, return nil.
2240 ;; Timer list: delegate to `org-timer-item'.
2245 ;; If we're in a description list, ask for the new term.
2259 t)))))
2262 "Fix indentation, bullets and checkboxes in the list at point."
2270 "Cycle through the different itemize/enumerate bullets.
2271 This cycle the entire list level through the sequence:
2273 `-' -> `+' -> `*' -> `1.' -> `1)'
2275 If WHICH is a valid string, use that as the new bullet. If WHICH
2276 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2277 `previous', cycle backwards."
2297 ;; Compute list of possible bullets, depending on context.
2300 ;; *-bullets are not allowed at column 0.
2302 ;; Description items cannot be numbered.
2325 ;; Use a short variation of `org-list-write-struct' as there's
2326 ;; no need to go through all the steps.
2334 "Toggle the checkbox in the current line.
2335 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2336 double prefix, set checkbox to [-].
2338 When there is an active region, toggle status or presence of the
2339 first checkbox there, and make every item inside have the same
2340 status or presence, respectively.
2342 If the cursor is in a headline, apply this to all checkbox items
2343 in the text below the heading, taking as reference the first item
2344 in subtree, ignoring drawers."
2348 block-item
2349 lim-up
2350 lim-down
2358 ;; In a region, start at first item in region.
2368 ;; On an heading, start at first item after drawers and
2369 ;; time-stamps (scheduled, etc.).
2381 ;; Just one item: set SINGLEP flag.
2387 ;; Determine the checkbox going to be applied to all items
2388 ;; within bounds.
2399 ;; When an item is found within bounds, grab the full list at
2400 ;; point structure, then: (1) set check-box of all its items
2401 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2402 ;; whole list, (3) move point after the list.
2416 e struct
2417 ;; If there is no box at item, leave as-is
2418 ;; unless function was called with C-u prefix.
2421 ref-checkbox
2422 cur-box))))
2423 items-to-toggle)
2425 struct parents prevs orderedp))
2426 ;; Report some problems due to ORDERED status of subtree.
2427 ;; If only one box was being checked, throw an error, else,
2428 ;; only signal problems.
2432 "Checkbox blocked because of unchecked box at line %d"
2436 "Checkboxes were removed due to unchecked box at line %d"
2445 "Reset all checkboxes in an entry subtree."
2462 "Update the checkbox statistics in the current section.
2464 This will find all statistic cookies like [57%] and [6/12] and
2465 update them with the current numbers.
2467 With optional prefix argument ALL, do this for the whole buffer."
2488 ;; Return number of checked boxes and boxes of all types
2489 ;; in all structures in STRUCTS. If RECURSIVEP is
2490 ;; non-nil, also count boxes in sub-lists. If ITEM is
2491 ;; nil, count across the whole structure, else count only
2492 ;; across subtree whose ancestor is ITEM.
2507 items))))
2510 cookies-list cache)
2511 ;; Move to start.
2515 ;; Build an alist for each cookie found. The key is the position
2516 ;; at beginning of cookie and values ending position, format of
2517 ;; cookie, number of checked boxes to report and total number of
2518 ;; boxes.
2528 context
2530 quote-block special-block verse-block)))
2543 structs)
2548 structs)
2550 :end
2552 element))))))
2553 ;; Cache count for cookies applying to the same
2554 ;; area. Then return it.
2561 structs
2562 recursivep)))
2564 count))))))
2565 cookies-list))))
2566 ;; Apply alist to buffer.
2581 "Select the face for checkbox statistics.
2582 The face will be `org-done' when all relevant boxes are checked.
2583 Otherwise it will be `org-todo'."
2586 'org-checkbox-statistics-done
2590 'org-checkbox-statistics-done
2594 "Update checkbox statistics unless turned off by user.
2595 With an optional argument ALL, update them in the whole buffer."
2603 "Indent a local list item including its children.
2604 When number ARG is a negative, item will be outdented, otherwise
2605 it will be indented.
2607 If a region is active, all items inside will be moved.
2609 If NO-SUBTREE is non-nil, only indent the item itself, not its
2610 children.
2612 STRUCT is the list structure.
2614 Return t if successful."
2622 ;; Are we going to move the whole list?
2630 t))))
2631 ;; Determine begin and end points of zone to indent. If moving
2632 ;; more than one item, save them for subsequent moves.
2648 ;; Special case: moving top-item with indent rule.
2656 ;; Change bullet if necessary.
2662 ;; Shift every item by OFFSET and fix bullets. Then
2663 ;; apply changes to buffer.
2667 struct)
2670 ;; Forbidden move:
2672 ;; If only one item is moved, it mustn't have a child.
2676 ;; If a subtree or region is moved, the last item
2677 ;; of the subtree mustn't have a child.
2682 struct)))))
2685 ;; Normal shifting
2693 t)
2696 "Outdent a local list item, but not its children.
2697 If a region is active, all items inside will be moved."
2713 "Indent a local list item, but not its children.
2714 If a region is active, all items inside will be moved."
2730 "Outdent a local list item including its children.
2731 If a region is active, all items inside will be moved."
2747 "Indent a local list item including its children.
2748 If a region is active, all items inside will be moved."
2766 "Cycle levels of indentation of an empty item.
2767 The first run indents the item, if applicable. Subsequent runs
2768 outdent it at meaningful levels in the list. When done, item is
2769 put back at its original position with its original bullet.
2771 Return t at each successful move."
2777 ;; Accept empty items or if cycle has already started.
2788 ;; When in the middle of the cycle, try to outdent first. If
2789 ;; it fails, and point is still at initial position, indent.
2790 ;; Else, re-create it at its original position.
2799 ;; Break cycle
2801 ;; If a cycle is starting, remember indentation and bullet,
2802 ;; then try to indent. If it fails, try to outdent.
2808 t))))
2811 "Sort list items.
2812 The cursor may be at any item of the list that should be sorted.
2813 Sublists are not sorted. Checkboxes, if any, are ignored.
2815 Sorting can be alphabetically, numerically, by date/time as given
2816 by a time stamp, by a property or by priority.
2818 Comparing entries ignores case by default. However, with an
2819 optional argument WITH-CASE, the sorting considers case as well.
2821 The command prompts for the sorting type unless it has been given
2822 to the function through the SORTING-TYPE argument, which needs to
2823 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F ?x ?X). Here is the
2824 detailed meaning of each character:
2826 n Numerically, by converting the beginning of the item to a number.
2827 a Alphabetically. Only the first line of item is checked.
2828 t By date/time, either the first active time stamp in the entry, if
2829 any, or by the first inactive one. In a timer list, sort the timers.
2832 Capital letters will reverse the sort order.
2834 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2835 a function to be called with point at the beginning of the
2836 record. It must return either a string or a number that should
2837 serve as the sorting key for that record. It will then use
2838 COMPARE-FUNC to compare entries.
2840 Sorting is done against the visible part of the headlines, it
2841 ignores hidden links."
2892 ;; If it is a timer list, convert timer to seconds
2909 value))
2913 next-record
2914 end-record
2915 value-to-sort
2916 nil
2917 sort-func)
2918 ;; Read and fix list again, as `sort-subr' probably destroyed
2919 ;; its structure.
2925 \f
2926 ;;; Send and receive lists
2929 "Parse the list at point and maybe DELETE it.
2931 Return a list whose car is a symbol of list type, among
2932 `ordered', `unordered' and `descriptive'. Then, each item is
2933 a list whose car is counter, and cdr are strings and other
2934 sub-lists. Inside strings, check-boxes are replaced by
2937 For example, the following list:
2939 1. first item
2940 + sub-item one
2941 + [X] sub-item two
2942 more text in first item
2943 2. [@3] last item
2945 will be parsed as:
2947 \(ordered
2949 \(unordered
2955 Point is left at list end."
2962 out
2965 ;; Return text between BEG and END, trimmed, with
2966 ;; checkboxes replaced.
2977 text)))))
2980 ;; Return a list whose car is list type and cdr a list of
2981 ;; items' body.
2987 ;; Return a list containing counter of item, if any, text
2988 ;; and any sublist inside it.
2994 ;; Get counter number. For alphabetic counter, get
2995 ;; its position in the alphabet.
3006 ;; If item has a child, store text between bullet and
3007 ;; next child, then recursively parse all sublists. At
3008 ;; the end of each sublist, check for the presence of
3009 ;; text belonging to the original item.
3019 ;; Remove children from the list just parsed.
3021 ;; There is a chunk of text belonging to the
3022 ;; item if last child doesn't end where next
3023 ;; child starts or where item ends.
3027 body))))
3030 ;; Store output, take care of cursor position and deletion of
3031 ;; list, then return output.
3038 out))
3041 "Convert the plain list at point into a subtree."
3049 "Insert a radio list template appropriate for this major mode."
3053 name pos)
3064 "Send a transformed version of this list to the receiver position.
3065 With argument MAYBE, fail quietly if no transformation is defined
3066 for this list."
3088 beg)
3092 ;; Find the insertion place
3097 name
3099 nil t)
3112 "Trim line breaks in a list ITEM."
3116 "Convert a LIST parsed through `org-list-parse-list' to other formats.
3117 Valid parameters PARAMS are:
3119 :ustart String to start an unordered list
3120 :uend String to end an unordered list
3122 :ostart String to start an ordered list
3123 :oend String to end an ordered list
3125 :dstart String to start a descriptive list
3126 :dend String to end a descriptive list
3127 :dtstart String to start a descriptive term
3128 :dtend String to end a descriptive term
3129 :ddstart String to start a description
3130 :ddend String to end a description
3132 :splice When set to t, return only list body lines, don't wrap
3133 them into :[u/o]start and :[u/o]end. Default is nil.
3135 :istart String to start a list item.
3136 :icount String to start an item with a counter.
3137 :iend String to end a list item
3138 :isep String to separate items
3139 :lsep String to separate sublists
3140 :csep String to separate text from a sub-list
3142 :cboff String to insert for an unchecked check-box
3143 :cbon String to insert for a checked check-box
3144 :cbtrans String to insert for a check-box in transitional state
3146 :nobr Non-nil means remove line breaks in lists items.
3148 Alternatively, each parameter can also be a form returning
3149 a string. These sexp can use keywords `counter' and `depth',
3150 representing respectively counter associated to the current
3151 item, and depth of the current sub-list, starting at 0.
3152 Obviously, `counter' is only available for parameters applying to
3153 items."
3177 export-sublist ; for byte-compiler
3180 ;; Export an item ITEM of type TYPE, at DEPTH. First
3181 ;; string in item is treated in a special way as it can
3182 ;; bring extra information that needs to be processed.
3188 ;; Stick DTSTART to ISTART by
3189 ;; left-trimming the latter.
3193 istart))
3200 ;; Replace checkbox if any is found.
3208 ;; Replace line breaks if required
3210 ;; Insert descriptive term if TYPE is `descriptive'.
3219 first)))
3230 ;; Export sublist SUB at DEPTH.
3248 "Convert LIST into a LaTeX list.
3249 LIST is as string representing the list to transform, as Org
3250 syntax. Return converted list as a string."
3255 "Convert LIST into a HTML list.
3256 LIST is as string representing the list to transform, as Org
3257 syntax. Return converted list as a string."
3262 "Convert LIST into a Texinfo list.
3263 LIST is as string representing the list to transform, as Org
3264 syntax. Return converted list as a string."
3269 "Convert LIST into an Org subtree.
3270 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3271 with overruling parameters for `org-list-to-generic'."
3282 ;; Return the string for the heading, depending on depth D
3283 ;; of current sub-list.
3288 oddeven-level)
3289 ?*)
3292 list
3294 '(:splice t
3301 params))))
3305 ;;; org-list.el ends here