| blob | 19d5b03f04c75b264fa2580207380b472d638490 |
1 ;;; org-list.el --- Plain lists for Org-mode -*- lexical-binding: t; -*-
2 ;;
3 ;; Copyright (C) 2004-2015 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Bastien Guerry <bzg@gnu.org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;;
10 ;; This file is part of GNU Emacs.
11 ;;
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
25 ;;
26 ;;; Commentary:
28 ;; This file contains the code dealing with plain lists in Org-mode.
30 ;; The core concept behind lists is their structure. A structure is
31 ;; a snapshot of the list, in the shape of a data tree (see
32 ;; `org-list-struct').
34 ;; Once the list structure is stored, it is possible to make changes
35 ;; on it that will be mirrored to the real list or to get information
36 ;; about the list, using accessors and methods provided in the
37 ;; library. Most of them require the use of one or two helper
38 ;; functions, namely `org-list-parents-alist' and
39 ;; `org-list-prevs-alist'.
41 ;; Structure is eventually applied to the buffer with
42 ;; `org-list-write-struct'. This function repairs (bullets,
43 ;; indentation, checkboxes) the list in the process. It should be
44 ;; called near the end of any function working on structures.
46 ;; Thus, a function applying to lists should usually follow this
47 ;; template:
49 ;; 1. Verify point is in a list and grab item beginning (with the same
50 ;; function `org-in-item-p'). If the function requires the cursor
51 ;; to be at item's bullet, `org-at-item-p' is more selective. It
52 ;; is also possible to move point to the closest item with
53 ;; `org-list-search-backward', or `org-list-search-forward',
54 ;; applied to the function `org-item-beginning-re'.
56 ;; 2. Get list structure with `org-list-struct'.
58 ;; 3. Compute one, or both, helper functions,
59 ;; (`org-list-parents-alist', `org-list-prevs-alist') depending on
60 ;; needed accessors.
62 ;; 4. Proceed with the modifications, using methods and accessors.
64 ;; 5. Verify and apply structure to buffer, using
65 ;; `org-list-write-struct'.
67 ;; 6. If changes made to the list might have modified check-boxes,
68 ;; call `org-update-checkbox-count-maybe'.
70 ;; Computing a structure can be a costly operation on huge lists (a
71 ;; few thousand lines long). Thus, code should follow the rule:
72 ;; "collect once, use many". As a corollary, it is usually a bad idea
73 ;; to use directly an interactive function inside the code, as those,
74 ;; being independent entities, read the whole list structure another
75 ;; time.
77 ;;; Code:
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."
263 "Non-nil means apply set of rules when acting on lists.
264 By default, automatic actions are taken when using
269 rules by setting them to nil. Valid rules are:
271 checkbox when non-nil, checkbox statistics is updated each time
272 you either insert a new checkbox or toggle a checkbox.
273 indent when non-nil, indenting or outdenting list top-item
274 with its subtree will move the whole list and
275 outdenting a list whose bullet is * to column 0 will
280 :key-type
284 :value-type
288 "Non-nil means commands implying motion in lists should be cyclic.
290 In that case, the item following the last item is the first one,
291 and the item preceding the first item is the last one.
301 "Hook that is run whenever Org thinks checkbox statistics should be updated.
302 This hook runs even if checkbox rule in
303 `org-list-automatic-rules' does not apply, so it can be used to
304 implement alternative ways of collecting statistics
310 "Non-nil means checkbox statistics counts only the state of direct children.
311 When nil, all boxes below the cookie are counted.
312 This can be set to nil on a per-node basis using a COOKIE_DATA property
320 "Maximum indentation for the second line of a description list.
321 When the indentation would be larger than this, it will become
322 5 characters instead."
327 "Additional indentation for sub-items in a list.
328 By setting this to a small number, usually 1 or 2, one can more
329 clearly distinguish sub-items in a list."
336 % END RECEIVE ORGLST %n
338 #+ORGLST: SEND %n org-list-to-latex
339 -
342 @c END RECEIVE ORGLST %n
343 @ignore
344 #+ORGLST: SEND %n org-list-to-texinfo
345 -
348 <!-- END RECEIVE ORGLST %n -->
349 <!--
350 #+ORGLST: SEND %n org-list-to-html
351 -
353 "Templates for radio lists in different major modes.
354 All occurrences of %n in a template will be replaced with the name of the
355 list, obtained by prompting the user."
363 "Names of blocks where lists are not allowed.
367 "Context types where lists will be interpreted during export.
369 Valid types are `drawer', `inlinetask' and `block'. More
370 specifically, type `block' is determined by the variable
374 \f
375 ;;; Predicates and regexps
385 "Matches a list item and puts everything into groups:
386 group 1: bullet
387 group 2: counter
388 group 3: checkbox
392 "Return the correct regular expression for plain lists."
403 "Regexp matching the beginning of a plain list item."
407 "Is point at a list item with REGEXP after bullet?"
416 ;; Ignore counter if any
421 "Is point in a context where lists are allowed?"
425 "Return item beginning position when in a plain list, nil otherwise."
434 ;; Indentation isn't meaningful when point starts at an empty
435 ;; line or an inline task.
438 10000
444 ;; Detect if cursor in amidst `org-list-end-re'. First, count
445 ;; number HL of hard lines it takes, then call `org-in-regexp'
446 ;; to compute its boundaries END-BOUNDS. When point is
447 ;; in-between, move cursor before regexp beginning.
458 ;; Look for an item, less indented that reference line.
463 ;; This is exactly what we want.
466 ;; At upper bound of search or looking at the end of a
467 ;; previous list: search is over.
470 ;; Skip blocks, drawers, inline-tasks, blank lines
480 ;; Text at column 0 cannot belong to a list: stop.
482 ;; Normal text less indented than reference line, take
483 ;; it as new reference.
490 "Is point in a line starting a hand-formatted item?"
496 "Is point at the bullet of a plain list item?"
502 "Is point at a line starting a plain list item with a timer?"
507 "Is point at a description list item?"
511 "Is point at a line starting a plain-list item with a checklet?"
515 "Is point at a line starting a plain-list item with a counter?"
521 \f
522 ;;; Structures and helper functions
525 "Determine context, and its boundaries, around point.
527 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
528 are boundaries and CONTEXT is a symbol among `drawer', `block',
529 `invalid', `inlinetask' and nil.
531 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
537 ;; Get positions of surrounding headings. This is the
538 ;; default context.
543 ;; Is point inside a drawer?
553 lim-down))
556 ;; Is point strictly in a block, and of which type?
567 lim-down))
573 ;; Is point in an inlinetask?
586 ;; Return context boundaries and type.
590 "Return structure of list at point.
592 A list structure is an alist where key is point at item, and
593 values are:
594 1. indentation,
595 2. bullet with trailing whitespace,
596 3. bullet counter, if any,
597 4. checkbox, if any,
598 5. description tag, if any,
599 6. position at item end.
601 Thus the following list, where numbers in parens are
602 point-at-bol:
604 - [X] first item (1)
605 1. sub-item 1 (18)
606 5. [@5] sub-item 2 (34)
607 some other text belonging to first item (55)
608 - last item (97)
609 + tag :: description (109)
610 (131)
612 will get the following structure:
620 Assume point is at an item."
632 itm-lst itm-lst-2 end-lst end-lst-2 struct
635 ;; Return association at point.
640 ind
641 bullet
644 ;; Description tag.
649 ;; Ensure list ends at the first blank line.
653 ;; 1. Read list from starting item to its beginning, and save
654 ;; top item position and indentation in BEG-CELL. Also store
655 ;; ending position of items in END-LST.
662 ;; At upward limit: if we ended at an item, store it,
663 ;; else dismiss useless data recorded above BEG-CELL.
664 ;; Jump to part 2.
671 ;; Looking at a list ending regexp. Dismiss useless
672 ;; data recorded above BEG-CELL. Jump to part 2.
677 ;; Point is at an item. Add data to ITM-LST. It may
678 ;; also end a previous item: save it in END-LST. If
679 ;; ind is less or equal than BEG-CELL and there is no
680 ;; end at this ind or lesser, this item becomes the new
681 ;; BEG-CELL.
687 ;; Skip blocks, drawers, inline tasks, blank lines.
698 ;; From there, point is not at an item. Interpret
699 ;; line's indentation:
700 ;; - text at column 0 is necessarily out of any list.
701 ;; Dismiss data recorded above BEG-CELL. Jump to
702 ;; part 2.
703 ;; - any other case may be an ending position for an
704 ;; hypothetical item above. Store it and proceed.
713 ;; 2. Read list from starting point to its end, that is until we
714 ;; get out of context, or that a non-item line is less or
715 ;; equally indented than BEG-CELL's cdr. Also, store ending
716 ;; position of items in END-LST-2.
722 ;; At downward limit: this is de facto the end of the
723 ;; list. Save point as an ending position, and jump to
724 ;; part 3.
727 ;; Looking at a list ending regexp. Save point as an
728 ;; ending position and jump to part 3.
732 ;; Point is at an item. Add data to ITM-LST-2. It may
733 ;; also end a previous item, so save it in END-LST-2.
737 ;; Skip inline tasks and blank lines along the way
742 ;; Ind is lesser or equal than BEG-CELL's. The list is
743 ;; over: store point as an ending position and jump to
744 ;; part 3.
748 ;; Else, if ind is lesser or equal than previous item's,
749 ;; this is an ending position: store it. In any case,
750 ;; skip block or drawer at point, and move to next line.
762 ;; 3. Associate each item to its end position.
764 ;; 4. Return STRUCT
765 struct)))
768 "Associate proper ending point to items in STRUCT.
770 END-LIST is a pseudo-alist where car is indentation and cdr is
771 ending position.
773 This function modifies STRUCT."
779 ;; Remove end candidates behind current item.
782 ;; Add end position to item assoc.
788 struct)))
791 "Return alist between item and previous item in STRUCT."
793 struct)))
797 struct)))
800 "Return alist between item and parent in STRUCT."
812 ;; A sub-list is over. Find the associated
813 ;; origin in IND-TO-ORI. If it cannot be
814 ;; found (ill-formed list), set its parent as
815 ;; the first item less indented. If there is
816 ;; none, make it a top-level item.
824 ind-to-ori)
827 ;; A sub-list starts. Every item at IND will
828 ;; have previous item as its parent.
833 ;; Another item in the same sub-list: it shares
834 ;; the same parent as the previous item.
839 \f
840 ;;; Accessors
843 "Return the Nth value of KEY in STRUCT."
847 "Set the Nth value of KEY in STRUCT to NEW.
852 "Return indentation of ITEM in STRUCT."
856 "Set indentation of ITEM in STRUCT to IND.
861 "Return bullet of ITEM in STRUCT."
865 "Set bullet of ITEM in STRUCT to BULLET.
870 "Return counter of ITEM in STRUCT."
874 "Return checkbox of ITEM in STRUCT or nil."
878 "Set checkbox of ITEM in STRUCT to CHECKBOX.
883 "Return end position of ITEM in STRUCT."
887 "Return end position of ITEM in STRUCT."
891 "Return point at end of ITEM in STRUCT, before any blank line.
892 Point returned is at end of line."
899 "Return parent of ITEM or nil.
900 STRUCT is the list structure. PARENTS is the alist of parents,
901 as returned by `org-list-parents-alist'."
906 "Non-nil if ITEM has a child.
908 STRUCT is the list structure.
910 Value returned is the position of the first child of ITEM."
915 child-maybe)))
918 "Return next item in same sub-list as ITEM, or nil.
919 STRUCT is the list structure. PREVS is the alist of previous
920 items, as returned by `org-list-prevs-alist'."
924 "Return previous item in same sub-list as ITEM, or nil.
925 STRUCT is the list structure. PREVS is the alist of previous
926 items, as returned by `org-list-prevs-alist'."
930 "List all items having ITEM as a common ancestor, or nil.
931 STRUCT is the list structure."
934 subtree)
939 sub-struct))
943 "List all items in the same sub-list as ITEM.
944 STRUCT is the list structure. PREVS is the alist of previous
945 items, as returned by `org-list-prevs-alist'."
948 before-item after-item)
956 "List all children of ITEM, or nil.
957 STRUCT is the list structure. PARENTS is the alist of parents,
958 as returned by `org-list-parents-alist'."
966 "Return point at beginning of list.
967 STRUCT is the list structure."
971 "Return point at bottom of list.
972 STRUCT is the list structure."
977 "Return point at beginning of sub-list ITEM belongs.
978 STRUCT is the list structure. PREVS is the alist of previous
979 items, as returned by `org-list-prevs-alist'."
983 first-item))
988 "Return point at last item 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 last-item))
997 "Return point at end of sub-list ITEM belongs.
998 STRUCT is the list structure. PREVS is the alist of previous
999 items, as returned by `org-list-prevs-alist'."
1003 "Return the type of the list containing ITEM, as a symbol.
1005 STRUCT is the list structure. PREVS is the alist of previous
1006 items, as returned by `org-list-prevs-alist'.
1008 Possible types are `descriptive', `ordered' and `unordered'. The
1009 type is determined by the first item of the list."
1017 "Return ITEM's sequence number.
1019 STRUCT is the list structure. PREVS is the alist of previous
1020 items, as returned by `org-list-prevs-alist'. PARENTS is the
1021 alist of ancestors, as returned by `org-list-parents-alist'.
1023 Return value is a list of integers. Counters have an impact on
1024 that value."
1028 ;; Return relative sequence number of ITEM in the sub-list
1029 ;; it belongs. STRUCT is the list structure. PREVS is
1030 ;; the alist of previous items.
1039 seq))
1043 ;; Cons each parent relative number into return value (OUT).
1048 ;; Return value.
1049 out)))
1052 \f
1053 ;;; Searching
1056 "Search a string in valid contexts for lists.
1057 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1058 in `re-search-forward'."
1062 ;; 1. No match: return to origin or bound, depending on NOERR.
1065 nil)))
1066 ;; 2. Match in valid context: return point. Else, continue
1067 ;; searching.
1071 "Like `re-search-backward' but stop only where lists are recognized.
1072 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1073 `re-search-backward'."
1078 "Like `re-search-forward' but stop only where lists are recognized.
1079 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1080 `re-search-forward'."
1085 \f
1086 ;;; Methods on structures
1089 "Return BULLET with the correct number of whitespaces.
1090 It determines the number of whitespaces to append by looking at
1091 `org-list-two-spaces-after-bullet-regexp'."
1095 org-list-two-spaces-after-bullet-regexp bullet))
1096 " "
1100 bullet))))
1103 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1105 Blank lines at the end of items are left in place. Item
1106 visibility is preserved. Return the new structure after the
1107 changes.
1109 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1110 to the same sub-list.
1112 This function modifies STRUCT."
1125 ;; Store overlays responsible for visibility status. We
1126 ;; also need to store their boundaries as they will be
1127 ;; removed from buffer.
1142 ;; 1. Move effectively items in buffer.
1146 ;; 2. Now modify struct. No need to re-read the list, the
1147 ;; transformation is just a shift of positions. Some special
1148 ;; attention is required for items ending at END-A and END-B
1149 ;; as empty spaces are not moved there. In others words,
1150 ;; item BEG-A will end with whitespaces that were at the end
1151 ;; of BEG-B and the same applies to BEG-B.
1174 ;; Restore visibility status, by moving overlays to their new
1175 ;; position.
1185 ;; Return structure.
1186 struct)))
1189 "Return number of blank lines that should separate items in list.
1191 POS is the position of point where `org-list-insert-item' was called.
1193 STRUCT is the list structure. PREVS is the alist of previous
1194 items, as returned by `org-list-prevs-alist'.
1196 Assume point is at item's beginning. If the item is alone, apply
1197 some heuristics to guess the result."
1202 usr-blank
1206 ;; Count blank lines above beginning of line.
1213 ;; Trivial cases where there should be none.
1215 ;; When `org-blank-before-new-entry' says so, it is 1.
1217 ;; `plain-list-item' is 'auto. Count blank lines separating
1218 ;; neighbors' items in list.
1221 ;; Is there a next item?
1224 ;; Is there a previous item?
1227 ;; User inserted blank lines, trust him.
1232 usr-blank)
1233 ;; Are there blank lines inside the list so far?
1236 ;; Do not use `org-list-search-forward' so blank lines
1237 ;; in blocks can be counted in.
1241 ;; Default choice: no blank line.
1245 "Insert a new list item at POS and return the new structure.
1246 If POS is before first character after bullet of the item, the
1247 new item will be created before the current one.
1249 STRUCT is the list structure. PREVS is the alist of previous
1250 items, as returned by `org-list-prevs-alist'.
1252 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1253 after the bullet. Cursor will be after this text once the
1254 function ends.
1256 This function modifies STRUCT."
1258 ;; 1. Get information about list: position of point with regards
1259 ;; to item start (BEFOREP), blank lines number separating items
1260 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1267 (<= pos
1270 ;; Ignore tag in a non-descriptive list.
1279 pos struct prevs))
1280 ;; 2. Build the new item to be created. Concatenate same
1281 ;; bullet as item, checkbox, text AFTER-BULLET if
1282 ;; provided, and text cut from point to end of item
1283 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1284 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1285 ;; between what was cut and what was inserted in buffer
1286 ;; is stored in SIZE-OFFSET.
1290 ind))
1297 ;; If POS is greater than ITEM-END, then point is
1298 ;; in some white lines after the end of the list.
1299 ;; Those must be removed, or they will be left,
1300 ;; stacking up after the list.
1310 text-cut))))
1314 ;; 4. Insert effectively item into buffer.
1318 ;; 5. Add new item to STRUCT.
1322 ;; Before inserted item, positions don't change but
1323 ;; an item ending after insertion has its end shifted
1324 ;; by SIZE-OFFSET.
1327 ;; Trivial cases where current item isn't split in
1328 ;; two. Just shift every item after new one by
1329 ;; ITEM-SIZE.
1333 ;; Item is split in two: elements before POS are just
1334 ;; shifted by ITEM-SIZE. In the case item would end
1335 ;; after split POS, ending is only shifted by
1336 ;; SIZE-OFFSET.
1342 ;; Elements after POS are moved into new item.
1343 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1344 ;; doesn't appear in buffer yet.
1350 (+ end size-offset
1352 ;; Elements at ITEM-END or after are only shifted by
1353 ;; SIZE-OFFSET.
1356 struct)
1359 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1360 ;; exchange ITEM with the next item in list. Position cursor
1361 ;; after bullet, counter, checkbox, and label.
1367 struct)))
1370 "Remove ITEM from the list and return the new structure.
1372 STRUCT is the list structure."
1375 ;; If ITEM ends with the list, delete blank lines
1376 ;; before it.
1381 item)))
1382 ;; Remove item from buffer.
1384 ;; Remove item from structure and shift others items accordingly.
1385 ;; Don't forget to shift also ending position when appropriate.
1403 struct)))))
1406 "Send ITEM to destination DEST.
1408 STRUCT is the list structure.
1410 DEST can have various values.
1412 If DEST is a buffer position, the function will assume it points
1413 to another item in the same list as ITEM, and will move the
1414 latter just before the former.
1416 If DEST is `begin' (respectively `end'), ITEM will be moved at
1417 the beginning (respectively end) of the list it belongs to.
1420 be moved at the Nth position in the list.
1422 If DEST is `kill', ITEM will be deleted and its body will be
1423 added to the kill-ring.
1425 If DEST is `delete', ITEM will be deleted.
1427 Visibility of item is preserved.
1429 This function returns, destructively, the new list structure."
1432 ;; Grab full item body minus its bullet.
1441 item-end)))
1442 ;; Change DEST into a buffer position. A trick is needed
1443 ;; when ITEM is meant to be sent at the end of the list.
1444 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1445 ;; nil and insertion point (INS-POINT) to the first line's
1446 ;; end of the last item, we ensure the new item will be
1447 ;; inserted after the last item, and not after any of its
1448 ;; hypothetical sub-items.
1464 ;; Send ITEM at the end of the list.
1472 ;; Store inner overlays (to preserve visibility).
1484 ;; 1. Structure returned by `org-list-insert-item' may not be
1485 ;; accurate, as it cannot see sub-items included in BODY.
1486 ;; Thus, first compute the real structure so far.
1494 ;; 1.1. Remove the item just created in structure.
1496 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1499 struct
1507 new-end
1509 moved-items))
1511 ;; 2. Restore inner overlays.
1516 ;; 3. Eventually delete extra copy of the item and clean marker.
1522 "Outdent items between positions START and END.
1524 STRUCT is the list structure. PARENTS is the alist of items'
1525 parents, as returned by `org-list-parents-alist'.
1527 START is included, END excluded."
1533 ;; Item not yet in zone: keep association.
1535 ;; Item out of zone: follow associations in ACC.
1539 ;; Item has no parent: error
1542 ;; Parent is outdented: keep association.
1546 ;; Parent isn't outdented: reparent to grand-parent.
1548 parent struct parents)))
1554 "Indent items between positions START and END.
1556 STRUCT is the list structure. PARENTS is the alist of parents
1557 and PREVS is the alist of previous items, returned by,
1558 respectively, `org-list-parents-alist' and
1559 `org-list-prevs-alist'.
1561 START is included and END excluded.
1563 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1564 bullets between START and END."
1572 ;; Normalize ordered bullets.
1582 org-list-demote-modify-bullet))))
1589 ;; Item not yet in zone: keep association.
1592 ;; Item out of zone: follow associations in ACC.
1596 ;; Item is in zone...
1598 ;; Check if bullet needs to be changed.
1601 ;; First item indented but not parent: error
1604 ;; First item and parent indented: keep same
1605 ;; parent.
1607 ;; Previous item not indented: reparent to it.
1609 ;; Previous item indented: reparent like it.
1616 \f
1617 ;;; Repairing structures
1620 "Non-nil if list starting at FIRST can have alphabetical bullets.
1622 STRUCT is list structure. PREVS is the alist of previous items,
1623 as returned by `org-list-prevs-alist'."
1627 ;; Pretend that bullets are uppercase and check if alphabet
1628 ;; is sufficient, taking counters into account.
1631 ;; Virtually determine current bullet
1633 ;; Counters are not case-sensitive.
1636 ;; Test if bullet would be over z or Z.
1640 ;; All items checked. All good.
1641 t))))
1644 "Increment BULLET if applicable."
1647 ;; Num bullet: increment it.
1651 nil nil bullet))
1652 ;; Alpha bullet: increment it.
1656 nil nil bullet))
1657 ;; Unordered bullet: leave it.
1661 "Verify and correct bullets in STRUCT.
1662 PREVS is the alist of previous items, as returned by
1663 `org-list-prevs-alist'.
1665 This function modifies STRUCT."
1669 ;; Set bullet of ITEM in STRUCT, depending on the type of
1670 ;; first item of the list, the previous bullet and counter
1671 ;; if any.
1680 item struct
1683 ;; Alpha counter in alpha list: use counter.
1687 ;; Use cond to be sure `string-match' is used in
1688 ;; both cases.
1694 ;; Num counter in a num list: use counter.
1699 ;; No counter: increase, if needed, previous bullet.
1702 ;; Alpha counter at first item: use counter.
1711 ;; Num counter at first item: use counter.
1716 ;; First bullet is alpha uppercase: use "A".
1719 ;; First bullet is alpha lowercase: use "a".
1722 ;; First bullet is num: use "1".
1725 ;; Not an ordered list: keep bullet.
1730 "Verify and correct indentation in STRUCT.
1732 PARENTS is the alist of parents, as returned by
1733 `org-list-parents-alist'.
1735 If numeric optional argument BULLET-SIZE is set, assume all
1736 bullets in list have this length to determine new indentation.
1738 This function modifies STRUCT."
1745 ;; Indent like parent + length of parent's bullet +
1746 ;; sub-list offset.
1752 org-list-indent-offset))
1753 ;; If no parent, indent like top-point.
1758 "Verify and correct checkboxes in STRUCT.
1760 PARENTS is the alist of parents and PREVS is the alist of
1761 previous items, as returned by, respectively,
1762 `org-list-parents-alist' and `org-list-prevs-alist'.
1764 If ORDERED is non-nil, a checkbox can only be checked when every
1765 checkbox before it is checked too. If there was an attempt to
1766 break this rule, the function will return the blocking item. In
1767 all others cases, the return value will be nil.
1769 This function modifies STRUCT."
1779 item struct
1785 ;; Parent has no boxed child: leave box as-is.
1787 parent-list)
1788 ;; 1. List all parents with a checkbox.
1795 all-items)
1796 ;; 2. Sort those parents by decreasing indentation.
1801 ;; 3. For each parent, get all children's checkboxes to determine
1802 ;; and set its checkbox accordingly.
1804 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1809 ;; There are boxes checked after an unchecked one: fix that.
1816 ;; Verify once again the structure, without ORDERED.
1818 ;; Return blocking item.
1822 "Verify and correct each item end position in STRUCT.
1824 This function modifies STRUCT."
1831 ;; To determine real ind of an ending position that is
1832 ;; not at an item, we have to find the item it belongs
1833 ;; to: it is the last item (ITEM-UP), whose ending is
1834 ;; further than the position we're interested in.
1837 ;; Else part is for the bottom point.
1839 end-pos)
1840 end-list)))
1843 struct)
1848 "Apply set difference between STRUCT and OLD-STRUCT to the buffer.
1850 OLD-STRUCT is the structure before any modifications, and STRUCT
1851 the structure to be applied. The function will only modify parts
1852 of the list which have changed.
1854 Initial position of cursor is restored after the changes."
1861 ;; Shift the indentation between END and BEG by DELTA.
1862 ;; Start from the line before END.
1871 ;; Skip inline tasks.
1874 ;; Shift only non-empty lines.
1880 ;; Replace ITEM first line elements with new elements from
1881 ;; STRUCT, if appropriate.
1891 ;; a. Replace bullet
1894 ;; b. Replace checkbox.
1905 ;; c. Indent item to appropriate column.
1910 ;; 1. First get list of items and position endings. We maintain
1911 ;; two alists: ITM-SHIFT, determining indentation shift needed
1912 ;; at item, and END-LIST, a pseudo-alist where key is ending
1913 ;; position and value point.
1926 ;; To determine real ind of an ending position that
1927 ;; is not at an item, we have to find the item it
1928 ;; belongs to: it is the last item (ITEM-UP), whose
1929 ;; ending is further than the position we're
1930 ;; interested in.
1934 ;; 2. Slice the items into parts that should be shifted by the
1935 ;; same amount of indentation. Each slice follow the pattern
1936 ;; (END BEG DELTA). Slices are returned in reverse order.
1939 #'<)
1947 ;; If we're not at an item, there's a child of the
1948 ;; item point belongs to above. Make sure the less
1949 ;; indented line in this slice has the same column
1950 ;; as that child.
1957 ;; Ignore empty lines. Also ignore blocks and
1958 ;; drawers contents.
1966 down t)))
1969 down t)))))
1973 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1974 ;; end to beginning. Take a special action when beginning is
1975 ;; at item bullet.
1982 ;; 4. Go back to initial position and clean marker.
1987 "Correct bullets, checkboxes and indentation in list at point.
1989 STRUCT is the list structure. PARENTS is the alist of parents,
1990 as returned by `org-list-parents-alist'.
1992 When non-nil, optional argument OLD-STRUCT is the reference
1993 structure of the list. It should be provided whenever STRUCT
1994 doesn't correspond anymore to the real list in buffer."
1995 ;; Order of functions matters here: checkboxes and endings need
1996 ;; correct indentation to be set, and indentation needs correct
1997 ;; bullets.
1998 ;;
1999 ;; 0. Save a copy of structure before modifications
2001 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
2002 ;; order to get items endings and bullets properly
2004 ;; 2. Fix each item end to get correct prevs alist.
2006 ;; 3. Get bullets right.
2009 ;; 4. Now get real indentation.
2011 ;; 5. Eventually fix checkboxes.
2013 ;; 6. Apply structure modifications to buffer.
2017 \f
2018 ;;; Misc Tools
2021 "Call FUNCTION on each item of the list at point.
2022 FUNCTION must be called with at least one argument: INIT-VALUE,
2023 that will contain the value returned by the function at the
2024 previous item, plus ARGS extra arguments.
2026 FUNCTION is applied on items in reverse order.
2028 As an example, \(org-apply-on-list \(lambda \(result) \(1+ result)) 0)
2029 will return the number of items in the current list.
2031 Sublists of the list are skipped. Cursor is always at the
2032 beginning of the item."
2044 value))
2047 "Set visibility of ITEM in STRUCT to VIEW.
2049 Possible values are: `folded', `children' or `subtree'. See
2050 `org-cycle' for more information."
2054 ;; Hide from eol
2056 item-end t)))
2058 ;; First show everything.
2060 ;; Then fold every child.
2065 children)))
2067 ;; Show everything
2072 "Return column at which body of ITEM should start."
2084 2
2088 \f
2089 ;;; Interactive functions
2094 "Go to the beginning of the current item.
2095 Throw an error when not in a list."
2101 "Go to the beginning item of the current list or sublist.
2102 Throw an error when not in a list."
2113 "Go to the end of the current list or sublist.
2114 Throw an error when not in a list."
2125 "Go to the end of the current item.
2126 Throw an error when not in a list."
2136 "Move to the beginning of the previous item.
2137 Throw an error when not in a list. Also throw an error when at
2138 first item, unless `org-list-use-circular-motion' is non-nil."
2154 "Move to the beginning of the next item.
2155 Throw an error when not in a list. Also throw an error when at
2156 last item, unless `org-list-use-circular-motion' is non-nil."
2172 "Move the item at point down, i.e. swap with following item.
2173 Sub-items (items with larger indentation) are considered part of
2174 the item, so this really moves item trees."
2193 "Move the item at point up, i.e. swap with previous item.
2194 Sub-items (items with larger indentation) are considered part of
2195 the item, so this really moves item trees."
2212 "Insert a new item at the current level.
2213 If cursor is before first character after bullet of the item, the
2214 new item will be created before the current one.
2216 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2218 Return t when things worked, nil when we are not in an item, or
2219 item is invisible."
2222 ;; If cursor isn't is a list or if list is invisible, return nil.
2230 ;; Timer list: delegate to `org-timer-item'.
2235 ;; If we're in a description list, ask for the new term.
2249 t)))))
2252 "Fix indentation, bullets and checkboxes in the list at point."
2260 "Cycle through the different itemize/enumerate bullets.
2261 This cycle the entire list level through the sequence:
2263 `-' -> `+' -> `*' -> `1.' -> `1)'
2265 If WHICH is a valid string, use that as the new bullet. If WHICH
2266 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2267 `previous', cycle backwards."
2287 ;; Compute list of possible bullets, depending on context.
2290 ;; *-bullets are not allowed at column 0.
2292 ;; Description items cannot be numbered.
2315 ;; Use a short variation of `org-list-write-struct' as there's
2316 ;; no need to go through all the steps.
2324 "Toggle the checkbox in the current line.
2325 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2326 double prefix, set checkbox to [-].
2328 When there is an active region, toggle status or presence of the
2329 first checkbox there, and make every item inside have the same
2330 status or presence, respectively.
2332 If the cursor is in a headline, apply this to all checkbox items
2333 in the text below the heading, taking as reference the first item
2334 in subtree, ignoring drawers."
2338 block-item
2339 lim-up
2340 lim-down
2348 ;; In a region, start at first item in region.
2358 ;; On an heading, start at first item after drawers and
2359 ;; time-stamps (scheduled, etc.).
2371 ;; Just one item: set SINGLEP flag.
2377 ;; Determine the checkbox going to be applied to all items
2378 ;; within bounds.
2389 ;; When an item is found within bounds, grab the full list at
2390 ;; point structure, then: (1) set check-box of all its items
2391 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2392 ;; whole list, (3) move point after the list.
2406 e struct
2407 ;; If there is no box at item, leave as-is
2408 ;; unless function was called with C-u prefix.
2411 ref-checkbox
2412 cur-box))))
2413 items-to-toggle)
2415 struct parents prevs orderedp))
2416 ;; Report some problems due to ORDERED status of subtree.
2417 ;; If only one box was being checked, throw an error, else,
2418 ;; only signal problems.
2422 "Checkbox blocked because of unchecked box at line %d"
2426 "Checkboxes were removed due to unchecked box at line %d"
2435 "Reset all checkboxes in an entry subtree."
2452 "Update the checkbox statistics in the current section.
2454 This will find all statistic cookies like [57%] and [6/12] and
2455 update them with the current numbers.
2457 With optional prefix argument ALL, do this for the whole buffer."
2478 ;; Return number of checked boxes and boxes of all types
2479 ;; in all structures in STRUCTS. If RECURSIVEP is
2480 ;; non-nil, also count boxes in sub-lists. If ITEM is
2481 ;; nil, count across the whole structure, else count only
2482 ;; across subtree whose ancestor is ITEM.
2497 items))))
2500 cookies-list cache)
2501 ;; Move to start.
2505 ;; Build an alist for each cookie found. The key is the position
2506 ;; at beginning of cookie and values ending position, format of
2507 ;; cookie, number of checked boxes to report and total number of
2508 ;; boxes.
2518 context
2520 quote-block special-block verse-block)))
2536 structs)
2541 structs)
2542 ;; Skip whole list since we have its
2543 ;; structure anyway.
2548 end))))))
2549 ;; Cache count for cookies applying to the same
2550 ;; area. Then return it.
2557 structs
2558 recursivep)))
2560 count))))))
2561 cookies-list))))
2562 ;; Apply alist to buffer.
2578 "Select the face for checkbox statistics.
2579 The face will be `org-done' when all relevant boxes are checked.
2580 Otherwise it will be `org-todo'."
2583 'org-checkbox-statistics-done
2587 'org-checkbox-statistics-done
2591 "Update checkbox statistics unless turned off by user.
2592 With an optional argument ALL, update them in the whole buffer."
2600 "Indent a local list item including its children.
2601 When number ARG is a negative, item will be outdented, otherwise
2602 it will be indented.
2604 If a region is active, all items inside will be moved.
2606 If NO-SUBTREE is non-nil, only indent the item itself, not its
2607 children.
2609 STRUCT is the list structure.
2611 Return t if successful."
2619 ;; Are we going to move the whole list?
2627 t))))
2628 ;; Determine begin and end points of zone to indent. If moving
2629 ;; more than one item, save them for subsequent moves.
2645 ;; Special case: moving top-item with indent rule.
2653 ;; Change bullet if necessary.
2659 ;; Shift every item by OFFSET and fix bullets. Then
2660 ;; apply changes to buffer.
2664 struct)
2667 ;; Forbidden move:
2669 ;; If only one item is moved, it mustn't have a child.
2673 ;; If a subtree or region is moved, the last item
2674 ;; of the subtree mustn't have a child.
2679 struct)))))
2682 ;; Normal shifting
2690 t)
2693 "Outdent a local list item, but not its children.
2694 If a region is active, all items inside will be moved."
2710 "Indent a local list item, but not its children.
2711 If a region is active, all items inside will be moved."
2727 "Outdent a local list item including its children.
2728 If a region is active, all items inside will be moved."
2744 "Indent a local list item including its children.
2745 If a region is active, all items inside will be moved."
2763 "Cycle levels of indentation of an empty item.
2764 The first run indents the item, if applicable. Subsequent runs
2765 outdent it at meaningful levels in the list. When done, item is
2766 put back at its original position with its original bullet.
2768 Return t at each successful move."
2774 ;; Accept empty items or if cycle has already started.
2785 ;; When in the middle of the cycle, try to outdent first. If
2786 ;; it fails, and point is still at initial position, indent.
2787 ;; Else, re-create it at its original position.
2796 ;; Break cycle
2798 ;; If a cycle is starting, remember indentation and bullet,
2799 ;; then try to indent. If it fails, try to outdent.
2805 t))))
2808 "Sort list items.
2809 The cursor may be at any item of the list that should be sorted.
2810 Sublists are not sorted. Checkboxes, if any, are ignored.
2812 Sorting can be alphabetically, numerically, by date/time as given
2813 by a time stamp, by a property or by priority.
2815 Comparing entries ignores case by default. However, with an
2816 optional argument WITH-CASE, the sorting considers case as well.
2818 The command prompts for the sorting type unless it has been given
2819 to the function through the SORTING-TYPE argument, which needs to
2820 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F ?x ?X). Here is the
2821 detailed meaning of each character:
2823 n Numerically, by converting the beginning of the item to a number.
2824 a Alphabetically. Only the first line of item is checked.
2825 t By date/time, either the first active time stamp in the entry, if
2826 any, or by the first inactive one. In a timer list, sort the timers.
2829 Capital letters will reverse the sort order.
2831 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2832 a function to be called with point at the beginning of the
2833 record. It must return either a string or a number that should
2834 serve as the sorting key for that record. It will then use
2835 COMPARE-FUNC to compare entries.
2837 Sorting is done against the visible part of the headlines, it
2838 ignores hidden links."
2889 ;; If it is a timer list, convert timer to seconds
2906 value))
2910 next-record
2911 end-record
2912 value-to-sort
2913 nil
2914 sort-func)
2915 ;; Read and fix list again, as `sort-subr' probably destroyed
2916 ;; its structure.
2922 \f
2923 ;;; Send and receive lists
2926 "Parse the list at point and maybe DELETE it.
2928 Return a list whose car is a symbol of list type, among
2929 `ordered', `unordered' and `descriptive'. Then, each item is
2930 a list whose car is counter, and cdr are strings and other
2931 sub-lists. Inside strings, check-boxes are replaced by
2934 For example, the following list:
2936 1. first item
2937 + sub-item one
2938 + [X] sub-item two
2939 more text in first item
2940 2. [@3] last item
2942 will be parsed as:
2944 (ordered
2946 (unordered
2952 Point is left at list end."
2959 ;; Return text between BEG and END, trimmed, with
2960 ;; checkboxes replaced.
2971 text))))
2973 ;; Return a list whose car is list type and cdr a list of
2974 ;; items' body.
2979 ;; Return a list containing counter of item, if any, text
2980 ;; and any sublist inside it.
2986 ;; Get counter number. For alphabetic counter, get
2987 ;; its position in the alphabet.
2998 ;; If item has a child, store text between bullet and
2999 ;; next child, then recursively parse all sublists.
3000 ;; At the end of each sublist, check for the presence
3001 ;; of text belonging to the original item.
3011 ;; Remove children from the list just parsed.
3013 ;; There is a chunk of text belonging to the
3014 ;; item if last child doesn't end where next
3015 ;; child starts or where item ends.
3019 body))))
3022 ;; Store output, take care of cursor position and deletion of
3023 ;; list, then return output.
3032 "Convert the plain list at point into a subtree."
3040 "Insert a radio list template appropriate for this major mode."
3044 name pos)
3055 "Send a transformed version of this list to the receiver position.
3056 With argument MAYBE, fail quietly if no transformation is defined
3057 for this list."
3079 beg)
3083 ;; Find the insertion place
3088 name
3090 nil t)
3103 "Trim line breaks in a list ITEM."
3107 "Convert a LIST parsed through `org-list-parse-list' to other formats.
3108 Valid parameters PARAMS are:
3110 :ustart String to start an unordered list
3111 :uend String to end an unordered list
3113 :ostart String to start an ordered list
3114 :oend String to end an ordered list
3116 :dstart String to start a descriptive list
3117 :dend String to end a descriptive list
3118 :dtstart String to start a descriptive term
3119 :dtend String to end a descriptive term
3120 :ddstart String to start a description
3121 :ddend String to end a description
3123 :splice When set to t, return only list body lines, don't wrap
3124 them into :[u/o]start and :[u/o]end. Default is nil.
3126 :istart String to start a list item.
3127 :icount String to start an item with a counter.
3128 :iend String to end a list item
3129 :isep String to separate items
3130 :lsep String to separate sublists
3131 :csep String to separate text from a sub-list
3133 :cboff String to insert for an unchecked check-box
3134 :cbon String to insert for a checked check-box
3135 :cbtrans String to insert for a check-box in transitional state
3137 :nobr Non-nil means remove line breaks in lists items.
3139 Alternatively, each parameter can also be a function returning
3140 a string. This function is called with one argument, the depth
3141 of the current sub-list, starting at 0."
3167 ;; Export an item ITEM of type TYPE, at DEPTH. First
3168 ;; string in item is treated in a special way as it can
3169 ;; bring extra information that needs to be processed.
3175 ;; Stick DTSTART to ISTART by
3176 ;; left-trimming the latter.
3180 istart))
3187 ;; Replace checkbox if any is found.
3195 ;; Replace line breaks if required
3197 ;; Insert descriptive term if TYPE is `descriptive'.
3206 first)))
3208 term
3211 desc))))
3220 ;; Export sublist SUB at DEPTH.
3229 "%s"
3233 "%s"
3236 "%s"
3241 items
3246 "Convert LIST into a LaTeX list.
3247 LIST is as string representing the list to transform, as Org
3248 syntax. Return converted list as a string."
3253 "Convert LIST into a HTML 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 Texinfo 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 an Org subtree.
3268 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3269 with overruling parameters for `org-list-to-generic'."
3278 ;; Return the string for the heading, depending on depth
3279 ;; D of current sub-list.
3284 oddeven-level)
3285 ?*)
3288 list
3290 `(:splice t
3297 params))))
3301 ;;; org-list.el ends here