| blob | fc5bf374eb0a6ffbaa6c58fb5610dbf22f6456d8 |
1 ;;; org-list.el --- Plain lists for Org-mode -*- lexical-binding: t; -*-
2 ;;
3 ;; Copyright (C) 2004-2016 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Bastien Guerry <bzg@gnu.org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;;
10 ;; This file is part of GNU Emacs.
11 ;;
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
25 ;;
26 ;;; Commentary:
28 ;; This file contains the code dealing with plain lists in Org-mode.
30 ;; The core concept behind lists is their structure. A structure is
31 ;; a snapshot of the list, in the shape of a data tree (see
32 ;; `org-list-struct').
34 ;; Once the list structure is stored, it is possible to make changes
35 ;; on it that will be mirrored to the real list or to get information
36 ;; about the list, using accessors and methods provided in the
37 ;; library. Most of them require the use of one or two helper
38 ;; functions, namely `org-list-parents-alist' and
39 ;; `org-list-prevs-alist'.
41 ;; Structure is eventually applied to the buffer with
42 ;; `org-list-write-struct'. This function repairs (bullets,
43 ;; indentation, checkboxes) the list in the process. It should be
44 ;; called near the end of any function working on structures.
46 ;; Thus, a function applying to lists should usually follow this
47 ;; template:
49 ;; 1. Verify point is in a list and grab item beginning (with the same
50 ;; function `org-in-item-p'). If the function requires the cursor
51 ;; to be at item's bullet, `org-at-item-p' is more selective. It
52 ;; is also possible to move point to the closest item with
53 ;; `org-list-search-backward', or `org-list-search-forward',
54 ;; applied to the function `org-item-beginning-re'.
56 ;; 2. Get list structure with `org-list-struct'.
58 ;; 3. Compute one, or both, helper functions,
59 ;; (`org-list-parents-alist', `org-list-prevs-alist') depending on
60 ;; needed accessors.
62 ;; 4. Proceed with the modifications, using methods and accessors.
64 ;; 5. Verify and apply structure to buffer, using
65 ;; `org-list-write-struct'.
67 ;; 6. If changes made to the list might have modified check-boxes,
68 ;; call `org-update-checkbox-count-maybe'.
70 ;; Computing a structure can be a costly operation on huge lists (a
71 ;; few thousand lines long). Thus, code should follow the rule:
72 ;; "collect once, use many". As a corollary, it is usually a bad idea
73 ;; to use directly an interactive function inside the code, as those,
74 ;; being independent entities, read the whole list structure another
75 ;; time.
77 ;;; Code:
110 org-element-map "org-element"
158 \f
159 ;;; Configuration variables
162 "Options concerning plain lists in Org-mode."
167 "When t, make TAB cycle visibility on plain list items.
168 Cycling plain lists works only when the cursor is on a plain list
169 item. When the cursor is on an outline heading, plain lists are
170 treated as text. This is the most stable way of handling this,
171 which is why it is the default.
173 When this is the symbol `integrate', then integrate plain list
174 items when cycling, as if they were children of outline headings.
176 This setting can lead to strange effects when switching visibility
179 plain list item with an implied large level number, all true
180 children and grand children of the outline heading will be
181 exposed in a children' view."
190 "Default bullet type installed when demoting an item.
191 This is an association list, for each bullet type, this alist will point
192 to the bullet that should be used when this item is demoted.
193 For example,
195 (setq org-list-demote-modify-bullet
198 will make
200 + Movies
201 + Silence of the Lambs
202 + My Cousin Vinny
203 + Books
204 + The Hunt for Red October
205 + The Road to Omaha
207 into
209 + Movies
210 - Silence of the Lambs
211 - My Cousin Vinny
212 + Books
213 - The Hunt for Red October
214 - The Road to Omaha"
232 "The character that makes a line with leading number an ordered list item.
233 Valid values are ?. and ?\). To get both terminators, use t.
235 This variable needs to be set before org.el is loaded. If you
236 need to make a change while Emacs is running, use the customize
237 interface or run the following code after updating it:
250 "Non-nil means single character alphabetical bullets are allowed.
252 Both uppercase and lowercase are handled. Lists with more than
253 26 items will fallback to standard numbering. Alphabetical
256 This variable needs to be set before org.el is loaded. If you
257 need to make a change while Emacs is running, use the customize
258 interface or run the following code after updating it:
268 "A regular expression matching bullets that should have 2 spaces after them.
269 When nil, no bullet will have two spaces after them. When
270 a string, it will be used as a regular expression. When the
271 bullet type of a list is changed, the new bullet type will be
272 matched against this regexp. If it matches, there will be two
273 spaces instead of one after the bullet in each item of the list."
281 "Non-nil means apply set of rules when acting on lists.
282 By default, automatic actions are taken when using
287 rules by setting them to nil. Valid rules are:
289 checkbox when non-nil, checkbox statistics is updated each time
290 you either insert a new checkbox or toggle a checkbox.
291 indent when non-nil, indenting or outdenting list top-item
292 with its subtree will move the whole list and
293 outdenting a list whose bullet is * to column 0 will
298 :key-type
302 :value-type
306 "Non-nil means commands implying motion in lists should be cyclic.
308 In that case, the item following the last item is the first one,
309 and the item preceding the first item is the last one.
319 "Hook that is run whenever Org thinks checkbox statistics should be updated.
320 This hook runs even if checkbox rule in
321 `org-list-automatic-rules' does not apply, so it can be used to
322 implement alternative ways of collecting statistics
328 "Non-nil means checkbox statistics counts only the state of direct children.
329 When nil, all boxes below the cookie are counted.
330 This can be set to nil on a per-node basis using a COOKIE_DATA property
338 "Maximum indentation for the second line of a description list.
339 When the indentation would be larger than this, it will become
340 5 characters instead."
345 "Additional indentation for sub-items in a list.
346 By setting this to a small number, usually 1 or 2, one can more
347 clearly distinguish sub-items in a list."
354 % END RECEIVE ORGLST %n
356 #+ORGLST: SEND %n org-list-to-latex
357 -
360 @c END RECEIVE ORGLST %n
361 @ignore
362 #+ORGLST: SEND %n org-list-to-texinfo
363 -
366 <!-- END RECEIVE ORGLST %n -->
367 <!--
368 #+ORGLST: SEND %n org-list-to-html
369 -
371 "Templates for radio lists in different major modes.
372 All occurrences of %n in a template will be replaced with the name of the
373 list, obtained by prompting the user."
380 "Names of blocks where lists are not allowed.
384 "Context types where lists will be interpreted during export.
386 Valid types are `drawer', `inlinetask' and `block'. More
387 specifically, type `block' is determined by the variable
391 \f
392 ;;; Predicates and regexps
402 "Matches a list item and puts everything into groups:
403 group 1: bullet
404 group 2: counter
405 group 3: checkbox
409 "Return the correct regular expression for plain lists."
420 "Regexp matching the beginning of a plain list item."
424 "Is point at a list item with REGEXP after bullet?"
433 ;; Ignore counter if any
438 "Is point in a context where lists are allowed?"
442 "Return item beginning position when in a plain list, nil otherwise."
451 ;; Indentation isn't meaningful when point starts at an empty
452 ;; line or an inline task.
455 10000
461 ;; Detect if cursor in amidst `org-list-end-re'. First, count
462 ;; number HL of hard lines it takes, then call `org-in-regexp'
463 ;; to compute its boundaries END-BOUNDS. When point is
464 ;; in-between, move cursor before regexp beginning.
475 ;; Look for an item, less indented that reference line.
480 ;; This is exactly what we want.
483 ;; At upper bound of search or looking at the end of a
484 ;; previous list: search is over.
487 ;; Skip blocks, drawers, inline-tasks, blank lines
497 ;; Text at column 0 cannot belong to a list: stop.
499 ;; Normal text less indented than reference line, take
500 ;; it as new reference.
507 "Is point in a line starting a hand-formatted item?"
513 "Is point at the bullet of a plain list item?"
519 "Is point at a line starting a plain list item with a timer?"
524 "Is point at a description list item?"
528 "Is point at a line starting a plain-list item with a checklet?"
532 "Is point at a line starting a plain-list item with a counter?"
538 \f
539 ;;; Structures and helper functions
542 "Determine context, and its boundaries, around point.
544 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
545 are boundaries and CONTEXT is a symbol among `drawer', `block',
546 `invalid', `inlinetask' and nil.
548 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
554 ;; Get positions of surrounding headings. This is the
555 ;; default context.
560 ;; Is point inside a drawer?
570 lim-down))
573 ;; Is point strictly in a block, and of which type?
584 lim-down))
590 ;; Is point in an inlinetask?
603 ;; Return context boundaries and type.
607 "Return structure of list at point.
609 A list structure is an alist where key is point at item, and
610 values are:
611 1. indentation,
612 2. bullet with trailing whitespace,
613 3. bullet counter, if any,
614 4. checkbox, if any,
615 5. description tag, if any,
616 6. position at item end.
618 Thus the following list, where numbers in parens are
619 point-at-bol:
621 - [X] first item (1)
622 1. sub-item 1 (18)
623 5. [@5] sub-item 2 (34)
624 some other text belonging to first item (55)
625 - last item (97)
626 + tag :: description (109)
627 (131)
629 will get the following structure:
637 Assume point is at an item."
649 itm-lst itm-lst-2 end-lst end-lst-2 struct
652 ;; Return association at point.
657 ind
658 bullet
661 ;; Description tag.
666 ;; Ensure list ends at the first blank line.
670 ;; 1. Read list from starting item to its beginning, and save
671 ;; top item position and indentation in BEG-CELL. Also store
672 ;; ending position of items in END-LST.
679 ;; At upward limit: if we ended at an item, store it,
680 ;; else dismiss useless data recorded above BEG-CELL.
681 ;; Jump to part 2.
688 ;; Looking at a list ending regexp. Dismiss useless
689 ;; data recorded above BEG-CELL. Jump to part 2.
694 ;; Point is at an item. Add data to ITM-LST. It may
695 ;; also end a previous item: save it in END-LST. If
696 ;; ind is less or equal than BEG-CELL and there is no
697 ;; end at this ind or lesser, this item becomes the new
698 ;; BEG-CELL.
704 ;; Skip blocks, drawers, inline tasks, blank lines.
715 ;; From there, point is not at an item. Interpret
716 ;; line's indentation:
717 ;; - text at column 0 is necessarily out of any list.
718 ;; Dismiss data recorded above BEG-CELL. Jump to
719 ;; part 2.
720 ;; - any other case may be an ending position for an
721 ;; hypothetical item above. Store it and proceed.
730 ;; 2. Read list from starting point to its end, that is until we
731 ;; get out of context, or that a non-item line is less or
732 ;; equally indented than BEG-CELL's cdr. Also, store ending
733 ;; position of items in END-LST-2.
739 ;; At downward limit: this is de facto the end of the
740 ;; list. Save point as an ending position, and jump to
741 ;; part 3.
744 ;; Looking at a list ending regexp. Save point as an
745 ;; ending position and jump to part 3.
749 ;; Point is at an item. Add data to ITM-LST-2. It may
750 ;; also end a previous item, so save it in END-LST-2.
754 ;; Skip inline tasks and blank lines along the way
759 ;; Ind is lesser or equal than BEG-CELL's. The list is
760 ;; over: store point as an ending position and jump to
761 ;; part 3.
765 ;; Else, if ind is lesser or equal than previous item's,
766 ;; this is an ending position: store it. In any case,
767 ;; skip block or drawer at point, and move to next line.
779 ;; 3. Associate each item to its end position.
781 ;; 4. Return STRUCT
782 struct)))
785 "Associate proper ending point to items in STRUCT.
787 END-LIST is a pseudo-alist where car is indentation and cdr is
788 ending position.
790 This function modifies STRUCT."
796 ;; Remove end candidates behind current item.
799 ;; Add end position to item assoc.
805 struct)))
808 "Return alist between item and previous item in STRUCT."
810 struct)))
814 struct)))
817 "Return alist between item and parent in STRUCT."
829 ;; A sub-list is over. Find the associated
830 ;; origin in IND-TO-ORI. If it cannot be
831 ;; found (ill-formed list), set its parent as
832 ;; the first item less indented. If there is
833 ;; none, make it a top-level item.
841 ind-to-ori)
844 ;; A sub-list starts. Every item at IND will
845 ;; have previous item as its parent.
850 ;; Another item in the same sub-list: it shares
851 ;; the same parent as the previous item.
856 \f
857 ;;; Accessors
860 "Return the Nth value of KEY in STRUCT."
864 "Set the Nth value of KEY in STRUCT to NEW.
869 "Return indentation of ITEM in STRUCT."
873 "Set indentation of ITEM in STRUCT to IND.
878 "Return bullet of ITEM in STRUCT."
882 "Set bullet of ITEM in STRUCT to BULLET.
887 "Return counter of ITEM in STRUCT."
891 "Return checkbox of ITEM in STRUCT or nil."
895 "Set checkbox of ITEM in STRUCT to CHECKBOX.
900 "Return end position of ITEM in STRUCT."
904 "Return end position of ITEM in STRUCT."
908 "Return point at end of ITEM in STRUCT, before any blank line.
909 Point returned is at end of line."
916 "Return parent of ITEM or nil.
917 STRUCT is the list structure. PARENTS is the alist of parents,
918 as returned by `org-list-parents-alist'."
923 "Non-nil if ITEM has a child.
925 STRUCT is the list structure.
927 Value returned is the position of the first child of ITEM."
932 child-maybe)))
935 "Return next item in same sub-list as ITEM, or nil.
936 STRUCT is the list structure. PREVS is the alist of previous
937 items, as returned by `org-list-prevs-alist'."
941 "Return previous item in same sub-list as ITEM, or nil.
942 STRUCT is the list structure. PREVS is the alist of previous
943 items, as returned by `org-list-prevs-alist'."
947 "List all items having ITEM as a common ancestor, or nil.
948 STRUCT is the list structure."
951 subtree)
956 sub-struct))
960 "List all items in the same sub-list as ITEM.
961 STRUCT is the list structure. PREVS is the alist of previous
962 items, as returned by `org-list-prevs-alist'."
965 before-item after-item)
973 "List all children of ITEM, or nil.
974 STRUCT is the list structure. PARENTS is the alist of parents,
975 as returned by `org-list-parents-alist'."
983 "Return point at beginning of list.
984 STRUCT is the list structure."
988 "Return point at bottom of list.
989 STRUCT is the list structure."
994 "Return point at beginning of sub-list ITEM belongs.
995 STRUCT is the list structure. PREVS is the alist of previous
996 items, as returned by `org-list-prevs-alist'."
1000 first-item))
1005 "Return point at last item of sub-list ITEM belongs.
1006 STRUCT is the list structure. PREVS is the alist of previous
1007 items, as returned by `org-list-prevs-alist'."
1011 last-item))
1014 "Return point at end of sub-list ITEM belongs.
1015 STRUCT is the list structure. PREVS is the alist of previous
1016 items, as returned by `org-list-prevs-alist'."
1020 "Return the type of the list containing ITEM, as a symbol.
1022 STRUCT is the list structure. PREVS is the alist of previous
1023 items, as returned by `org-list-prevs-alist'.
1025 Possible types are `descriptive', `ordered' and `unordered'. The
1026 type is determined by the first item of the list."
1034 "Return ITEM's sequence number.
1036 STRUCT is the list structure. PREVS is the alist of previous
1037 items, as returned by `org-list-prevs-alist'. PARENTS is the
1038 alist of ancestors, as returned by `org-list-parents-alist'.
1040 Return value is a list of integers. Counters have an impact on
1041 that value."
1045 ;; Return relative sequence number of ITEM in the sub-list
1046 ;; it belongs. STRUCT is the list structure. PREVS is
1047 ;; the alist of previous items.
1056 seq))
1060 ;; Cons each parent relative number into return value (OUT).
1065 ;; Return value.
1066 out)))
1069 \f
1070 ;;; Searching
1073 "Search a string in valid contexts for lists.
1074 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1075 in `re-search-forward'."
1079 ;; 1. No match: return to origin or bound, depending on NOERR.
1082 nil)))
1083 ;; 2. Match in valid context: return point. Else, continue
1084 ;; searching.
1088 "Like `re-search-backward' but stop only where lists are recognized.
1089 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1090 `re-search-backward'."
1095 "Like `re-search-forward' but stop only where lists are recognized.
1096 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1097 `re-search-forward'."
1102 \f
1103 ;;; Methods on structures
1106 "Return BULLET with the correct number of whitespaces.
1107 It determines the number of whitespaces to append by looking at
1108 `org-list-two-spaces-after-bullet-regexp'."
1112 org-list-two-spaces-after-bullet-regexp bullet))
1113 " "
1117 bullet))))
1120 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1122 Blank lines at the end of items are left in place. Item
1123 visibility is preserved. Return the new structure after the
1124 changes.
1126 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1127 to the same sub-list.
1129 This function modifies STRUCT."
1142 ;; Store overlays responsible for visibility status. We
1143 ;; also need to store their boundaries as they will be
1144 ;; removed from buffer.
1159 ;; 1. Move effectively items in buffer.
1163 ;; 2. Now modify struct. No need to re-read the list, the
1164 ;; transformation is just a shift of positions. Some special
1165 ;; attention is required for items ending at END-A and END-B
1166 ;; as empty spaces are not moved there. In others words,
1167 ;; item BEG-A will end with whitespaces that were at the end
1168 ;; of BEG-B and the same applies to BEG-B.
1191 ;; Restore visibility status, by moving overlays to their new
1192 ;; position.
1202 ;; Return structure.
1203 struct)))
1206 "Return number of blank lines that should separate items in list.
1208 POS is the position of point where `org-list-insert-item' was called.
1210 STRUCT is the list structure. PREVS is the alist of previous
1211 items, as returned by `org-list-prevs-alist'.
1213 Assume point is at item's beginning. If the item is alone, apply
1214 some heuristics to guess the result."
1219 usr-blank
1223 ;; Count blank lines above beginning of line.
1230 ;; Trivial cases where there should be none.
1232 ;; When `org-blank-before-new-entry' says so, it is 1.
1234 ;; `plain-list-item' is 'auto. Count blank lines separating
1235 ;; neighbors' items in list.
1238 ;; Is there a next item?
1241 ;; Is there a previous item?
1244 ;; User inserted blank lines, trust him.
1249 usr-blank)
1250 ;; Are there blank lines inside the list so far?
1253 ;; Do not use `org-list-search-forward' so blank lines
1254 ;; in blocks can be counted in.
1258 ;; Default choice: no blank line.
1262 "Insert a new list item at POS and return the new structure.
1263 If POS is before first character after bullet of the item, the
1264 new item will be created before the current one.
1266 STRUCT is the list structure. PREVS is the alist of previous
1267 items, as returned by `org-list-prevs-alist'.
1269 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1270 after the bullet. Cursor will be after this text once the
1271 function ends.
1273 This function modifies STRUCT."
1275 ;; 1. Get information about list: position of point with regards
1276 ;; to item start (BEFOREP), blank lines number separating items
1277 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1284 (<= pos
1287 ;; Ignore tag in a non-descriptive list.
1296 pos struct prevs))
1297 ;; 2. Build the new item to be created. Concatenate same
1298 ;; bullet as item, checkbox, text AFTER-BULLET if
1299 ;; provided, and text cut from point to end of item
1300 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1301 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1302 ;; between what was cut and what was inserted in buffer
1303 ;; is stored in SIZE-OFFSET.
1307 ind))
1314 ;; If POS is greater than ITEM-END, then point is
1315 ;; in some white lines after the end of the list.
1316 ;; Those must be removed, or they will be left,
1317 ;; stacking up after the list.
1327 text-cut))))
1331 ;; 4. Insert effectively item into buffer.
1335 ;; 5. Add new item to STRUCT.
1339 ;; Before inserted item, positions don't change but
1340 ;; an item ending after insertion has its end shifted
1341 ;; by SIZE-OFFSET.
1344 ;; Trivial cases where current item isn't split in
1345 ;; two. Just shift every item after new one by
1346 ;; ITEM-SIZE.
1350 ;; Item is split in two: elements before POS are just
1351 ;; shifted by ITEM-SIZE. In the case item would end
1352 ;; after split POS, ending is only shifted by
1353 ;; SIZE-OFFSET.
1359 ;; Elements after POS are moved into new item.
1360 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1361 ;; doesn't appear in buffer yet.
1367 (+ end size-offset
1369 ;; Elements at ITEM-END or after are only shifted by
1370 ;; SIZE-OFFSET.
1373 struct)
1376 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1377 ;; exchange ITEM with the next item in list. Position cursor
1378 ;; after bullet, counter, checkbox, and label.
1384 struct)))
1387 "Remove ITEM from the list and return the new structure.
1389 STRUCT is the list structure."
1392 ;; If ITEM ends with the list, delete blank lines
1393 ;; before it.
1398 item)))
1399 ;; Remove item from buffer.
1401 ;; Remove item from structure and shift others items accordingly.
1402 ;; Don't forget to shift also ending position when appropriate.
1420 struct)))))
1423 "Send ITEM to destination DEST.
1425 STRUCT is the list structure.
1427 DEST can have various values.
1429 If DEST is a buffer position, the function will assume it points
1430 to another item in the same list as ITEM, and will move the
1431 latter just before the former.
1433 If DEST is `begin' (respectively `end'), ITEM will be moved at
1434 the beginning (respectively end) of the list it belongs to.
1437 be moved at the Nth position in the list.
1439 If DEST is `kill', ITEM will be deleted and its body will be
1440 added to the kill-ring.
1442 If DEST is `delete', ITEM will be deleted.
1444 Visibility of item is preserved.
1446 This function returns, destructively, the new list structure."
1449 ;; Grab full item body minus its bullet.
1458 item-end)))
1459 ;; Change DEST into a buffer position. A trick is needed
1460 ;; when ITEM is meant to be sent at the end of the list.
1461 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1462 ;; nil and insertion point (INS-POINT) to the first line's
1463 ;; end of the last item, we ensure the new item will be
1464 ;; inserted after the last item, and not after any of its
1465 ;; hypothetical sub-items.
1481 ;; Send ITEM at the end of the list.
1489 ;; Store inner overlays (to preserve visibility).
1501 ;; 1. Structure returned by `org-list-insert-item' may not be
1502 ;; accurate, as it cannot see sub-items included in BODY.
1503 ;; Thus, first compute the real structure so far.
1511 ;; 1.1. Remove the item just created in structure.
1513 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1516 struct
1524 new-end
1526 moved-items))
1528 ;; 2. Restore inner overlays.
1533 ;; 3. Eventually delete extra copy of the item and clean marker.
1539 "Outdent items between positions START and END.
1541 STRUCT is the list structure. PARENTS is the alist of items'
1542 parents, as returned by `org-list-parents-alist'.
1544 START is included, END excluded."
1550 ;; Item not yet in zone: keep association.
1552 ;; Item out of zone: follow associations in ACC.
1556 ;; Item has no parent: error
1559 ;; Parent is outdented: keep association.
1563 ;; Parent isn't outdented: reparent to grand-parent.
1565 parent struct parents)))
1571 "Indent items between positions START and END.
1573 STRUCT is the list structure. PARENTS is the alist of parents
1574 and PREVS is the alist of previous items, returned by,
1575 respectively, `org-list-parents-alist' and
1576 `org-list-prevs-alist'.
1578 START is included and END excluded.
1580 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1581 bullets between START and END."
1589 ;; Normalize ordered bullets.
1599 org-list-demote-modify-bullet))))
1606 ;; Item not yet in zone: keep association.
1609 ;; Item out of zone: follow associations in ACC.
1613 ;; Item is in zone...
1615 ;; Check if bullet needs to be changed.
1618 ;; First item indented but not parent: error
1621 ;; First item and parent indented: keep same
1622 ;; parent.
1624 ;; Previous item not indented: reparent to it.
1626 ;; Previous item indented: reparent like it.
1633 \f
1634 ;;; Repairing structures
1637 "Non-nil if list starting at FIRST can have alphabetical bullets.
1639 STRUCT is list structure. PREVS is the alist of previous items,
1640 as returned by `org-list-prevs-alist'."
1644 ;; Pretend that bullets are uppercase and check if alphabet
1645 ;; is sufficient, taking counters into account.
1648 ;; Virtually determine current bullet
1650 ;; Counters are not case-sensitive.
1653 ;; Test if bullet would be over z or Z.
1657 ;; All items checked. All good.
1658 t))))
1661 "Increment BULLET if applicable."
1664 ;; Num bullet: increment it.
1668 nil nil bullet))
1669 ;; Alpha bullet: increment it.
1673 nil nil bullet))
1674 ;; Unordered bullet: leave it.
1678 "Verify and correct bullets in STRUCT.
1679 PREVS is the alist of previous items, as returned by
1680 `org-list-prevs-alist'.
1682 This function modifies STRUCT."
1686 ;; Set bullet of ITEM in STRUCT, depending on the type of
1687 ;; first item of the list, the previous bullet and counter
1688 ;; if any.
1697 item struct
1700 ;; Alpha counter in alpha list: use counter.
1704 ;; Use cond to be sure `string-match' is used in
1705 ;; both cases.
1711 ;; Num counter in a num list: use counter.
1716 ;; No counter: increase, if needed, previous bullet.
1719 ;; Alpha counter at first item: use counter.
1728 ;; Num counter at first item: use counter.
1733 ;; First bullet is alpha uppercase: use "A".
1736 ;; First bullet is alpha lowercase: use "a".
1739 ;; First bullet is num: use "1".
1742 ;; Not an ordered list: keep bullet.
1747 "Verify and correct indentation in STRUCT.
1749 PARENTS is the alist of parents, as returned by
1750 `org-list-parents-alist'.
1752 If numeric optional argument BULLET-SIZE is set, assume all
1753 bullets in list have this length to determine new indentation.
1755 This function modifies STRUCT."
1762 ;; Indent like parent + length of parent's bullet +
1763 ;; sub-list offset.
1769 org-list-indent-offset))
1770 ;; If no parent, indent like top-point.
1775 "Verify and correct checkboxes in STRUCT.
1777 PARENTS is the alist of parents and PREVS is the alist of
1778 previous items, as returned by, respectively,
1779 `org-list-parents-alist' and `org-list-prevs-alist'.
1781 If ORDERED is non-nil, a checkbox can only be checked when every
1782 checkbox before it is checked too. If there was an attempt to
1783 break this rule, the function will return the blocking item. In
1784 all others cases, the return value will be nil.
1786 This function modifies STRUCT."
1796 item struct
1802 ;; Parent has no boxed child: leave box as-is.
1804 parent-list)
1805 ;; 1. List all parents with a checkbox.
1812 all-items)
1813 ;; 2. Sort those parents by decreasing indentation.
1818 ;; 3. For each parent, get all children's checkboxes to determine
1819 ;; and set its checkbox accordingly.
1821 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1826 ;; There are boxes checked after an unchecked one: fix that.
1833 ;; Verify once again the structure, without ORDERED.
1835 ;; Return blocking item.
1839 "Verify and correct each item end position in STRUCT.
1841 This function modifies STRUCT."
1848 ;; To determine real ind of an ending position that is
1849 ;; not at an item, we have to find the item it belongs
1850 ;; to: it is the last item (ITEM-UP), whose ending is
1851 ;; further than the position we're interested in.
1854 ;; Else part is for the bottom point.
1856 end-pos)
1857 end-list)))
1860 struct)
1865 "Apply set difference between STRUCT and OLD-STRUCT to the buffer.
1867 OLD-STRUCT is the structure before any modifications, and STRUCT
1868 the structure to be applied. The function will only modify parts
1869 of the list which have changed.
1871 Initial position of cursor is restored after the changes."
1878 ;; Shift the indentation between END and BEG by DELTA.
1879 ;; Start from the line before END.
1888 ;; Skip inline tasks.
1891 ;; Shift only non-empty lines.
1897 ;; Replace ITEM first line elements with new elements from
1898 ;; STRUCT, if appropriate.
1908 ;; a. Replace bullet
1911 ;; b. Replace checkbox.
1922 ;; c. Indent item to appropriate column.
1927 ;; 1. First get list of items and position endings. We maintain
1928 ;; two alists: ITM-SHIFT, determining indentation shift needed
1929 ;; at item, and END-LIST, a pseudo-alist where key is ending
1930 ;; position and value point.
1943 ;; To determine real ind of an ending position that
1944 ;; is not at an item, we have to find the item it
1945 ;; belongs to: it is the last item (ITEM-UP), whose
1946 ;; ending is further than the position we're
1947 ;; interested in.
1951 ;; 2. Slice the items into parts that should be shifted by the
1952 ;; same amount of indentation. Each slice follow the pattern
1953 ;; (END BEG DELTA). Slices are returned in reverse order.
1956 #'<)
1964 ;; If we're not at an item, there's a child of the
1965 ;; item point belongs to above. Make sure the less
1966 ;; indented line in this slice has the same column
1967 ;; as that child.
1974 ;; Ignore empty lines. Also ignore blocks and
1975 ;; drawers contents.
1983 down t)))
1986 down t)))))
1990 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1991 ;; end to beginning. Take a special action when beginning is
1992 ;; at item bullet.
1999 ;; 4. Go back to initial position and clean marker.
2004 "Correct bullets, checkboxes and indentation in list at point.
2006 STRUCT is the list structure. PARENTS is the alist of parents,
2007 as returned by `org-list-parents-alist'.
2009 When non-nil, optional argument OLD-STRUCT is the reference
2010 structure of the list. It should be provided whenever STRUCT
2011 doesn't correspond anymore to the real list in buffer."
2012 ;; Order of functions matters here: checkboxes and endings need
2013 ;; correct indentation to be set, and indentation needs correct
2014 ;; bullets.
2015 ;;
2016 ;; 0. Save a copy of structure before modifications
2018 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
2019 ;; order to get items endings and bullets properly
2021 ;; 2. Fix each item end to get correct prevs alist.
2023 ;; 3. Get bullets right.
2026 ;; 4. Now get real indentation.
2028 ;; 5. Eventually fix checkboxes.
2030 ;; 6. Apply structure modifications to buffer.
2034 \f
2035 ;;; Misc Tools
2038 "Call FUNCTION on each item of the list at point.
2039 FUNCTION must be called with at least one argument: INIT-VALUE,
2040 that will contain the value returned by the function at the
2041 previous item, plus ARGS extra arguments.
2043 FUNCTION is applied on items in reverse order.
2045 As an example, \(org-apply-on-list \(lambda \(result) \(1+ result)) 0)
2046 will return the number of items in the current list.
2048 Sublists of the list are skipped. Cursor is always at the
2049 beginning of the item."
2061 value))
2064 "Set visibility of ITEM in STRUCT to VIEW.
2066 Possible values are: `folded', `children' or `subtree'. See
2067 `org-cycle' for more information."
2071 ;; Hide from eol
2073 item-end t)))
2075 ;; First show everything.
2077 ;; Then fold every child.
2082 children)))
2084 ;; Show everything
2089 "Return column at which body of ITEM should start."
2101 2
2105 \f
2106 ;;; Interactive functions
2111 "Go to the beginning of the current item.
2112 Throw an error when not in a list."
2118 "Go to the beginning item of the current list or sublist.
2119 Throw an error when not in a list."
2130 "Go to the end of the current list or sublist.
2131 Throw an error when not in a list."
2142 "Go to the end of the current item.
2143 Throw an error when not in a list."
2153 "Move to the beginning of the previous item.
2154 Throw an error when not in a list. Also throw an error when at
2155 first item, unless `org-list-use-circular-motion' is non-nil."
2171 "Move to the beginning of the next item.
2172 Throw an error when not in a list. Also throw an error when at
2173 last item, unless `org-list-use-circular-motion' is non-nil."
2189 "Move the item at point down, i.e. swap with following item.
2190 Sub-items (items with larger indentation) are considered part of
2191 the item, so this really moves item trees."
2210 "Move the item at point up, i.e. swap with previous item.
2211 Sub-items (items with larger indentation) are considered part of
2212 the item, so this really moves item trees."
2229 "Insert a new item at the current level.
2230 If cursor is before first character after bullet of the item, the
2231 new item will be created before the current one.
2233 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2235 Return t when things worked, nil when we are not in an item, or
2236 item is invisible."
2239 ;; If cursor isn't is a list or if list is invisible, return nil.
2247 ;; Timer list: delegate to `org-timer-item'.
2252 ;; If we're in a description list, ask for the new term.
2266 t)))))
2269 "Fix indentation, bullets and checkboxes in the list at point."
2277 "Cycle through the different itemize/enumerate bullets.
2278 This cycle the entire list level through the sequence:
2280 `-' -> `+' -> `*' -> `1.' -> `1)'
2282 If WHICH is a valid string, use that as the new bullet. If WHICH
2283 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2284 `previous', cycle backwards."
2304 ;; Compute list of possible bullets, depending on context.
2307 ;; *-bullets are not allowed at column 0.
2309 ;; Description items cannot be numbered.
2332 ;; Use a short variation of `org-list-write-struct' as there's
2333 ;; no need to go through all the steps.
2341 "Toggle the checkbox in the current line.
2342 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2343 double prefix, set checkbox to [-].
2345 When there is an active region, toggle status or presence of the
2346 first checkbox there, and make every item inside have the same
2347 status or presence, respectively.
2349 If the cursor is in a headline, apply this to all checkbox items
2350 in the text below the heading, taking as reference the first item
2351 in subtree, ignoring drawers."
2355 block-item
2356 lim-up
2357 lim-down
2365 ;; In a region, start at first item in region.
2375 ;; On an heading, start at first item after drawers and
2376 ;; time-stamps (scheduled, etc.).
2388 ;; Just one item: set SINGLEP flag.
2394 ;; Determine the checkbox going to be applied to all items
2395 ;; within bounds.
2406 ;; When an item is found within bounds, grab the full list at
2407 ;; point structure, then: (1) set check-box of all its items
2408 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2409 ;; whole list, (3) move point after the list.
2423 e struct
2424 ;; If there is no box at item, leave as-is
2425 ;; unless function was called with C-u prefix.
2428 ref-checkbox
2429 cur-box))))
2430 items-to-toggle)
2432 struct parents prevs orderedp))
2433 ;; Report some problems due to ORDERED status of subtree.
2434 ;; If only one box was being checked, throw an error, else,
2435 ;; only signal problems.
2439 "Checkbox blocked because of unchecked box at line %d"
2443 "Checkboxes were removed due to unchecked box at line %d"
2452 "Reset all checkboxes in an entry subtree."
2469 "Update the checkbox statistics in the current section.
2471 This will find all statistic cookies like [57%] and [6/12] and
2472 update them with the current numbers.
2474 With optional prefix argument ALL, do this for the whole buffer."
2495 ;; Return number of checked boxes and boxes of all types
2496 ;; in all structures in STRUCTS. If RECURSIVEP is
2497 ;; non-nil, also count boxes in sub-lists. If ITEM is
2498 ;; nil, count across the whole structure, else count only
2499 ;; across subtree whose ancestor is ITEM.
2514 items))))
2517 cookies-list cache)
2518 ;; Move to start.
2522 ;; Build an alist for each cookie found. The key is the position
2523 ;; at beginning of cookie and values ending position, format of
2524 ;; cookie, number of checked boxes to report and total number of
2525 ;; boxes.
2535 context
2537 quote-block special-block verse-block)))
2553 structs)
2558 structs)
2559 ;; Skip whole list since we have its
2560 ;; structure anyway.
2565 end))))))
2566 ;; Cache count for cookies applying to the same
2567 ;; area. Then return it.
2574 structs
2575 recursivep)))
2577 count))))))
2578 cookies-list))))
2579 ;; Apply alist to buffer.
2595 "Select the face for checkbox statistics.
2596 The face will be `org-done' when all relevant boxes are checked.
2597 Otherwise it will be `org-todo'."
2600 'org-checkbox-statistics-done
2604 'org-checkbox-statistics-done
2608 "Update checkbox statistics unless turned off by user.
2609 With an optional argument ALL, update them in the whole buffer."
2617 "Indent a local list item including its children.
2618 When number ARG is a negative, item will be outdented, otherwise
2619 it will be indented.
2621 If a region is active, all items inside will be moved.
2623 If NO-SUBTREE is non-nil, only indent the item itself, not its
2624 children.
2626 STRUCT is the list structure.
2628 Return t if successful."
2636 ;; Are we going to move the whole list?
2644 t))))
2645 ;; Determine begin and end points of zone to indent. If moving
2646 ;; more than one item, save them for subsequent moves.
2662 ;; Special case: moving top-item with indent rule.
2670 ;; Change bullet if necessary.
2676 ;; Shift every item by OFFSET and fix bullets. Then
2677 ;; apply changes to buffer.
2681 struct)
2684 ;; Forbidden move:
2686 ;; If only one item is moved, it mustn't have a child.
2690 ;; If a subtree or region is moved, the last item
2691 ;; of the subtree mustn't have a child.
2696 struct)))))
2699 ;; Normal shifting
2707 t)
2710 "Outdent a local list item, but not its children.
2711 If a region is active, all items inside will be moved."
2727 "Indent a local list item, but not its children.
2728 If a region is active, all items inside will be moved."
2744 "Outdent a local list item including its children.
2745 If a region is active, all items inside will be moved."
2761 "Indent a local list item including its children.
2762 If a region is active, all items inside will be moved."
2780 "Cycle levels of indentation of an empty item.
2781 The first run indents the item, if applicable. Subsequent runs
2782 outdent it at meaningful levels in the list. When done, item is
2783 put back at its original position with its original bullet.
2785 Return t at each successful move."
2791 ;; Accept empty items or if cycle has already started.
2802 ;; When in the middle of the cycle, try to outdent first. If
2803 ;; it fails, and point is still at initial position, indent.
2804 ;; Else, re-create it at its original position.
2813 ;; Break cycle
2815 ;; If a cycle is starting, remember indentation and bullet,
2816 ;; then try to indent. If it fails, try to outdent.
2822 t))))
2825 "Sort list items.
2826 The cursor may be at any item of the list that should be sorted.
2827 Sublists are not sorted. Checkboxes, if any, are ignored.
2829 Sorting can be alphabetically, numerically, by date/time as given
2830 by a time stamp, by a property or by priority.
2832 Comparing entries ignores case by default. However, with an
2833 optional argument WITH-CASE, the sorting considers case as well.
2835 The command prompts for the sorting type unless it has been given
2836 to the function through the SORTING-TYPE argument, which needs to
2837 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F ?x ?X). Here is the
2838 detailed meaning of each character:
2840 n Numerically, by converting the beginning of the item to a number.
2841 a Alphabetically. Only the first line of item is checked.
2842 t By date/time, either the first active time stamp in the entry, if
2843 any, or by the first inactive one. In a timer list, sort the timers.
2846 Capital letters will reverse the sort order.
2848 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2849 a function to be called with point at the beginning of the
2850 record. It must return either a string or a number that should
2851 serve as the sorting key for that record. It will then use
2852 COMPARE-FUNC to compare entries.
2854 Sorting is done against the visible part of the headlines, it
2855 ignores hidden links."
2906 ;; If it is a timer list, convert timer to seconds
2923 value))
2927 next-record
2928 end-record
2929 value-to-sort
2930 nil
2931 sort-func)
2932 ;; Read and fix list again, as `sort-subr' probably destroyed
2933 ;; its structure.
2939 \f
2940 ;;; Send and receive lists
2943 "Parse the list at point and maybe DELETE it.
2945 Return a list whose car is a symbol of list type, among
2946 `ordered', `unordered' and `descriptive'. Then, each item is
2947 a list of strings and other sub-lists.
2949 For example, the following list:
2951 1. first item
2952 + sub-item one
2953 + [X] sub-item two
2954 more text in first item
2955 2. [@3] last item
2957 is parsed as
2959 \(ordered
2961 \(unordered
2967 Point is left at list's end."
2975 ;; Remove indentation and final newline from TEXT.
2979 text))))
2982 ;; Return a list whose car is list type and cdr a list
2983 ;; of items' body.
2988 ;; Return a list containing counter of item, if any,
2989 ;; text and any sublist inside it.
2998 trim
3008 ;; Remove whole sub-list from children.
3010 ;; There is a chunk of text belonging to the item
3011 ;; if last child doesn't end where next child
3012 ;; starts or where item ends.
3017 trim
3019 body)))))
3021 ;; Store output, take care of cursor position and deletion of
3022 ;; list, then return output.
3033 "Convert the plain list at point into a subtree."
3041 "Insert a radio list template appropriate for this major mode."
3045 name pos)
3056 "Send a transformed version of this list to the receiver position.
3057 With argument MAYBE, fail quietly if no transformation is defined
3058 for this list."
3084 beg)
3088 ;; Find the insertion place
3093 name
3095 nil t)
3108 "Convert a LIST parsed through `org-list-to-lisp' to a custom format.
3110 LIST is a list as returned by `org-list-to-lisp', which see.
3111 PARAMS is a property list of parameters used to tweak the output
3112 format.
3114 Valid parameters are:
3116 :backend, :raw
3118 Export back-end used as a basis to transcode elements of the
3119 list, when no specific parameter applies to it. It is also
3120 used to translate its contents. You can prevent this by
3121 setting :raw property to a non-nil value.
3123 :splice
3125 When non-nil, only export the contents of the top most plain
3126 list, effectively ignoring its opening and closing lines.
3128 :ustart, :uend
3130 Strings to start and end an unordered list. They can also be
3131 set to a function returning a string or nil, which will be
3132 called with the depth of the list, counting from 1.
3134 :ostart, :oend
3136 Strings to start and end an ordered list. They can also be set
3137 to a function returning a string or nil, which will be called
3138 with the depth of the list, counting from 1.
3140 :dstart, :dend
3142 Strings to start and end a descriptive list. They can also be
3143 set to a function returning a string or nil, which will be
3144 called with the depth of the list, counting from 1.
3146 :dtstart, :dtend, :ddstart, :ddend
3148 Strings to start and end a descriptive term.
3150 :istart, :iend
3152 Strings to start or end a list item, and to start a list item
3153 with a counter. They can also be set to a function returning
3154 a string or nil, which will be called with the depth of the
3155 item, counting from 1.
3157 :icount
3159 Strings to start a list item with a counter. It can also be
3160 set to a function returning a string or nil, which will be
3161 called with two arguments: the depth of the item, counting from
3162 1, and the counter. Its value, when non-nil, has precedence
3163 over `:istart'.
3165 :isep
3167 String used to separate items. It can also be set to
3168 a function returning a string or nil, which will be called with
3169 the depth of the items, counting from 1. It always start on
3170 a new line.
3172 :cbon, :cboff, :cbtrans
3174 String to insert, respectively, an un-checked check-box,
3175 a checked check-box and a check-box in transitional state."
3181 :transcoders
3185 data info)
3186 ;; Write LIST back into Org syntax and parse it.
3216 ;; When`:raw' property has a non-nil value, turn all objects back
3217 ;; into Org syntax.
3223 ;; We use a low-level mechanism to export DATA so as to skip all
3224 ;; usual pre-processing and post-processing, i.e., hooks, filters,
3225 ;; Babel code evaluation, include keywords and macro expansion,
3226 ;; and filters.
3228 ;; Remove final newline.
3232 "Return the level of ELEMENT within current plain list.
3233 ELEMENT is either an item or a plain list."
3238 "Return the number of trailing newlines in STRING."
3245 "Evaluate VALUE according to its type.
3246 VALUE is either nil, a string or a function. In the latter case,
3247 it is called with arguments ARGS."
3254 "Return a transcoder for `plain-list' elements.
3255 PARAMS is a plist used to tweak the behavior of the transcoder."
3273 depth)))
3280 depth))))
3281 ;; Make sure trailing newlines in END appear in the output by
3282 ;; setting `:post-blank' property to their number.
3286 ;; Build output.
3289 contents
3291 end)))))
3294 "Return a transcoder for `item' elements.
3295 PARAMS is a plist used to tweak the behavior of the transcoder."
3320 ;; When a closing line or a separator is provided, make sure
3321 ;; its trailing newlines are taken into account when building
3322 ;; output. This is done by setting `:post-blank' property to
3323 ;; the number of such lines in the last line to be added.
3327 item
3328 :post-blank
3330 ;; Build output.
3348 tag backend info)
3350 dtend))
3355 ;; Remove final newline.
3358 closing
3359 separator)))))
3362 "Convert LIST into a LaTeX list.
3363 LIST is a parsed plain list, as returned by `org-list-to-lisp'.
3364 Return converted list as a string."
3369 "Convert LIST into a HTML list.
3370 LIST is a parsed plain list, as returned by `org-list-to-lisp'.
3371 Return converted list as a string."
3376 "Convert LIST into a Texinfo list.
3377 LIST is a parsed plain list, as returned by `org-list-to-lisp'.
3378 Return converted list as a string."
3383 "Convert LIST into an Org subtree.
3384 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3385 with overruling parameters for `org-list-to-generic'."
3394 ;; Return the string for the heading, depending on DEPTH
3395 ;; of current sub-list.
3399 oddeven-level)
3400 ?*)
3403 list
3406 :istart make-stars
3407 :icount make-stars
3411 params))))
3415 ;;; org-list.el ends here