| blob | d865a7886846bec2d91f21305e85dd09ae2a4924 |
1 ;;; org-list.el --- Plain lists for Org-mode
2 ;;
3 ;; Copyright (C) 2004-2015 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Bastien Guerry <bzg@gnu.org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;;
10 ;; This file is part of GNU Emacs.
11 ;;
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
25 ;;
26 ;;; Commentary:
28 ;; This file contains the code dealing with plain lists in Org-mode.
30 ;; The core concept behind lists is their structure. A structure is
31 ;; a snapshot of the list, in the shape of a data tree (see
32 ;; `org-list-struct').
34 ;; Once the list structure is stored, it is possible to make changes
35 ;; on it that will be mirrored to the real list or to get information
36 ;; about the list, using accessors and methods provided in the
37 ;; library. Most of them require the use of one or two helper
38 ;; functions, namely `org-list-parents-alist' and
39 ;; `org-list-prevs-alist'.
41 ;; Structure is eventually applied to the buffer with
42 ;; `org-list-write-struct'. This function repairs (bullets,
43 ;; indentation, checkboxes) the list in the process. It should be
44 ;; called near the end of any function working on structures.
46 ;; Thus, a function applying to lists should usually follow this
47 ;; template:
49 ;; 1. Verify point is in a list and grab item beginning (with the same
50 ;; function `org-in-item-p'). If the function requires the cursor
51 ;; to be at item's bullet, `org-at-item-p' is more selective. It
52 ;; is also possible to move point to the closest item with
53 ;; `org-list-search-backward', or `org-list-search-forward',
54 ;; applied to the function `org-item-beginning-re'.
56 ;; 2. Get list structure with `org-list-struct'.
58 ;; 3. Compute one, or both, helper functions,
59 ;; (`org-list-parents-alist', `org-list-prevs-alist') depending on
60 ;; needed accessors.
62 ;; 4. Proceed with the modifications, using methods and accessors.
64 ;; 5. Verify and apply structure to buffer, using
65 ;; `org-list-write-struct'.
67 ;; 6. If changes made to the list might have modified check-boxes,
68 ;; call `org-update-checkbox-count-maybe'.
70 ;; Computing a structure can be a costly operation on huge lists (a
71 ;; few thousand lines long). Thus, code should follow the rule:
72 ;; "collect once, use many". As a corollary, it is usually a bad idea
73 ;; to use directly an interactive function inside the code, as those,
74 ;; being independent entities, read the whole list structure another
75 ;; time.
77 ;;; Code:
141 \f
142 ;;; Configuration variables
145 "Options concerning plain lists in Org-mode."
150 "When t, make TAB cycle visibility on plain list items.
151 Cycling plain lists works only when the cursor is on a plain list
152 item. When the cursor is on an outline heading, plain lists are
153 treated as text. This is the most stable way of handling this,
154 which is why it is the default.
156 When this is the symbol `integrate', then integrate plain list
157 items when cycling, as if they were children of outline headings.
159 This setting can lead to strange effects when switching visibility
162 plain list item with an implied large level number, all true
163 children and grand children of the outline heading will be
164 exposed in a children' view."
173 "Default bullet type installed when demoting an item.
174 This is an association list, for each bullet type, this alist will point
175 to the bullet that should be used when this item is demoted.
176 For example,
178 (setq org-list-demote-modify-bullet
181 will make
183 + Movies
184 + Silence of the Lambs
185 + My Cousin Vinny
186 + Books
187 + The Hunt for Red October
188 + The Road to Omaha
190 into
192 + Movies
193 - Silence of the Lambs
194 - My Cousin Vinny
195 + Books
196 - The Hunt for Red October
197 - The Road to Omaha"
215 "The character that makes a line with leading number an ordered list item.
216 Valid values are ?. and ?\). To get both terminators, use t.
218 This variable needs to be set before org.el is loaded. If you
219 need to make a change while Emacs is running, use the customize
220 interface or run the following code after updating it:
233 "Non-nil means single character alphabetical bullets are allowed.
235 Both uppercase and lowercase are handled. Lists with more than
236 26 items will fallback to standard numbering. Alphabetical
239 This variable needs to be set before org.el is loaded. If you
240 need to make a change while Emacs is running, use the customize
241 interface or run the following code after updating it:
251 "A regular expression matching bullets that should have 2 spaces after them.
252 When nil, no bullet will have two spaces after them. When
253 a string, it will be used as a regular expression. When the
254 bullet type of a list is changed, the new bullet type will be
255 matched against this regexp. If it matches, there will be two
256 spaces instead of one after the bullet in each item of the list."
264 "Non-nil means apply set of rules when acting on lists.
265 By default, automatic actions are taken when using
270 rules by setting them to nil. Valid rules are:
272 checkbox when non-nil, checkbox statistics is updated each time
273 you either insert a new checkbox or toggle a checkbox.
274 indent when non-nil, indenting or outdenting list top-item
275 with its subtree will move the whole list and
276 outdenting a list whose bullet is * to column 0 will
281 :key-type
285 :value-type
289 "Non-nil means commands implying motion in lists should be cyclic.
291 In that case, the item following the last item is the first one,
292 and the item preceding the first item is the last one.
302 "Hook that is run whenever Org thinks checkbox statistics should be updated.
303 This hook runs even if checkbox rule in
304 `org-list-automatic-rules' does not apply, so it can be used to
305 implement alternative ways of collecting statistics
311 "Non-nil means checkbox statistics counts only the state of direct children.
312 When nil, all boxes below the cookie are counted.
313 This can be set to nil on a per-node basis using a COOKIE_DATA property
321 "Maximum indentation for the second line of a description list.
322 When the indentation would be larger than this, it will become
323 5 characters instead."
328 "Additional indentation for sub-items in a list.
329 By setting this to a small number, usually 1 or 2, one can more
330 clearly distinguish sub-items in a list."
337 % END RECEIVE ORGLST %n
339 #+ORGLST: SEND %n org-list-to-latex
340 -
343 @c END RECEIVE ORGLST %n
344 @ignore
345 #+ORGLST: SEND %n org-list-to-texinfo
346 -
349 <!-- END RECEIVE ORGLST %n -->
350 <!--
351 #+ORGLST: SEND %n org-list-to-html
352 -
354 "Templates for radio lists in different major modes.
355 All occurrences of %n in a template will be replaced with the name of the
356 list, obtained by prompting the user."
364 "Names of blocks where lists are not allowed.
368 "Context types where lists will be interpreted during export.
370 Valid types are `drawer', `inlinetask' and `block'. More
371 specifically, type `block' is determined by the variable
375 \f
376 ;;; Predicates and regexps
386 "Matches a list item and puts everything into groups:
387 group 1: bullet
388 group 2: counter
389 group 3: checkbox
393 "Return the correct regular expression for plain lists."
404 "Regexp matching the beginning of a plain list item."
408 "Is point at a list item with REGEXP after bullet?"
417 ;; Ignore counter if any
422 "Is point in a context where lists are allowed?"
426 "Return item beginning position when in a plain list, nil otherwise."
435 ;; Indentation isn't meaningful when point starts at an empty
436 ;; line or an inline task.
439 10000
445 ;; Detect if cursor in amidst `org-list-end-re'. First, count
446 ;; number HL of hard lines it takes, then call `org-in-regexp'
447 ;; to compute its boundaries END-BOUNDS. When point is
448 ;; in-between, move cursor before regexp beginning.
459 ;; Look for an item, less indented that reference line.
464 ;; This is exactly what we want.
467 ;; At upper bound of search or looking at the end of a
468 ;; previous list: search is over.
471 ;; Skip blocks, drawers, inline-tasks, blank lines
481 ;; Text at column 0 cannot belong to a list: stop.
483 ;; Normal text less indented than reference line, take
484 ;; it as new reference.
491 "Is point in a line starting a hand-formatted item?"
497 "Is point at the bullet of a plain list item?"
503 "Is point at a line starting a plain list item with a timer?"
508 "Is point at a description list item?"
512 "Is point at a line starting a plain-list item with a checklet?"
516 "Is point at a line starting a plain-list item with a counter?"
522 \f
523 ;;; Structures and helper functions
526 "Determine context, and its boundaries, around point.
528 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
529 are boundaries and CONTEXT is a symbol among `drawer', `block',
530 `invalid', `inlinetask' and nil.
532 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
538 ;; Get positions of surrounding headings. This is the
539 ;; default context.
544 ;; Is point inside a drawer?
554 lim-down))
557 ;; Is point strictly in a block, and of which type?
568 lim-down))
574 ;; Is point in an inlinetask?
587 ;; Return context boundaries and type.
591 "Return structure of list at point.
593 A list structure is an alist where key is point at item, and
594 values are:
595 1. indentation,
596 2. bullet with trailing whitespace,
597 3. bullet counter, if any,
598 4. checkbox, if any,
599 5. description tag, if any,
600 6. position at item end.
602 Thus the following list, where numbers in parens are
603 point-at-bol:
605 - [X] first item (1)
606 1. sub-item 1 (18)
607 5. [@5] sub-item 2 (34)
608 some other text belonging to first item (55)
609 - last item (97)
610 + tag :: description (109)
611 (131)
613 will get the following structure:
621 Assume point is at an item."
633 itm-lst itm-lst-2 end-lst end-lst-2 struct
636 ;; Return association at point.
641 ind
642 bullet
645 ;; Description tag.
650 ;; Ensure list ends at the first blank line.
654 ;; 1. Read list from starting item to its beginning, and save
655 ;; top item position and indentation in BEG-CELL. Also store
656 ;; ending position of items in END-LST.
663 ;; At upward limit: if we ended at an item, store it,
664 ;; else dismiss useless data recorded above BEG-CELL.
665 ;; Jump to part 2.
672 ;; Looking at a list ending regexp. Dismiss useless
673 ;; data recorded above BEG-CELL. Jump to part 2.
678 ;; Point is at an item. Add data to ITM-LST. It may
679 ;; also end a previous item: save it in END-LST. If
680 ;; ind is less or equal than BEG-CELL and there is no
681 ;; end at this ind or lesser, this item becomes the new
682 ;; BEG-CELL.
688 ;; Skip blocks, drawers, inline tasks, blank lines.
699 ;; From there, point is not at an item. Interpret
700 ;; line's indentation:
701 ;; - text at column 0 is necessarily out of any list.
702 ;; Dismiss data recorded above BEG-CELL. Jump to
703 ;; part 2.
704 ;; - any other case may be an ending position for an
705 ;; hypothetical item above. Store it and proceed.
714 ;; 2. Read list from starting point to its end, that is until we
715 ;; get out of context, or that a non-item line is less or
716 ;; equally indented than BEG-CELL's cdr. Also, store ending
717 ;; position of items in END-LST-2.
723 ;; At downward limit: this is de facto the end of the
724 ;; list. Save point as an ending position, and jump to
725 ;; part 3.
728 ;; Looking at a list ending regexp. Save point as an
729 ;; ending position and jump to part 3.
733 ;; Point is at an item. Add data to ITM-LST-2. It may
734 ;; also end a previous item, so save it in END-LST-2.
738 ;; Skip inline tasks and blank lines along the way
743 ;; Ind is lesser or equal than BEG-CELL's. The list is
744 ;; over: store point as an ending position and jump to
745 ;; part 3.
749 ;; Else, if ind is lesser or equal than previous item's,
750 ;; this is an ending position: store it. In any case,
751 ;; skip block or drawer at point, and move to next line.
763 ;; 3. Associate each item to its end position.
765 ;; 4. Return STRUCT
766 struct)))
769 "Associate proper ending point to items in STRUCT.
771 END-LIST is a pseudo-alist where car is indentation and cdr is
772 ending position.
774 This function modifies STRUCT."
780 ;; Remove end candidates behind current item.
783 ;; Add end position to item assoc.
789 struct)))
792 "Return alist between item and previous item in STRUCT."
794 struct)))
798 struct)))
801 "Return alist between item and parent in STRUCT."
813 ;; A sub-list is over. Find the associated
814 ;; origin in IND-TO-ORI. If it cannot be
815 ;; found (ill-formed list), set its parent as
816 ;; the first item less indented. If there is
817 ;; none, make it a top-level item.
825 ind-to-ori)
828 ;; A sub-list starts. Every item at IND will
829 ;; have previous item as its parent.
834 ;; Another item in the same sub-list: it shares
835 ;; the same parent as the previous item.
840 \f
841 ;;; Accessors
844 "Return the Nth value of KEY in STRUCT."
848 "Set the Nth value of KEY in STRUCT to NEW.
853 "Return indentation of ITEM in STRUCT."
857 "Set indentation of ITEM in STRUCT to IND.
862 "Return bullet of ITEM in STRUCT."
866 "Set bullet of ITEM in STRUCT to BULLET.
871 "Return counter of ITEM in STRUCT."
875 "Return checkbox of ITEM in STRUCT or nil."
879 "Set checkbox of ITEM in STRUCT to CHECKBOX.
884 "Return end position of ITEM in STRUCT."
888 "Return end position of ITEM in STRUCT."
892 "Return point at end of ITEM in STRUCT, before any blank line.
893 Point returned is at end of line."
900 "Return parent of ITEM or nil.
901 STRUCT is the list structure. PARENTS is the alist of parents,
902 as returned by `org-list-parents-alist'."
907 "Non-nil if ITEM has a child.
909 STRUCT is the list structure.
911 Value returned is the position of the first child of ITEM."
916 child-maybe)))
919 "Return next item in same sub-list as ITEM, or nil.
920 STRUCT is the list structure. PREVS is the alist of previous
921 items, as returned by `org-list-prevs-alist'."
925 "Return previous item in same sub-list as ITEM, or nil.
926 STRUCT is the list structure. PREVS is the alist of previous
927 items, as returned by `org-list-prevs-alist'."
931 "List all items having ITEM as a common ancestor, or nil.
932 STRUCT is the list structure."
935 subtree)
940 sub-struct))
944 "List all items in the same sub-list as ITEM.
945 STRUCT is the list structure. PREVS is the alist of previous
946 items, as returned by `org-list-prevs-alist'."
949 before-item after-item)
957 "List all children of ITEM, or nil.
958 STRUCT is the list structure. PARENTS is the alist of parents,
959 as returned by `org-list-parents-alist'."
967 "Return point at beginning of list.
968 STRUCT is the list structure."
972 "Return point at bottom of list.
973 STRUCT is the list structure."
978 "Return point at beginning of sub-list ITEM belongs.
979 STRUCT is the list structure. PREVS is the alist of previous
980 items, as returned by `org-list-prevs-alist'."
984 first-item))
989 "Return point at last item of sub-list ITEM belongs.
990 STRUCT is the list structure. PREVS is the alist of previous
991 items, as returned by `org-list-prevs-alist'."
995 last-item))
998 "Return point at end of sub-list ITEM belongs.
999 STRUCT is the list structure. PREVS is the alist of previous
1000 items, as returned by `org-list-prevs-alist'."
1004 "Return the type of the list containing ITEM, as a symbol.
1006 STRUCT is the list structure. PREVS is the alist of previous
1007 items, as returned by `org-list-prevs-alist'.
1009 Possible types are `descriptive', `ordered' and `unordered'. The
1010 type is determined by the first item of the list."
1018 "Return ITEM's sequence number.
1020 STRUCT is the list structure. PREVS is the alist of previous
1021 items, as returned by `org-list-prevs-alist'. PARENTS is the
1022 alist of ancestors, as returned by `org-list-parents-alist'.
1024 Return value is a list of integers. Counters have an impact on
1025 that value."
1029 ;; Return relative sequence number of ITEM in the sub-list
1030 ;; it belongs. STRUCT is the list structure. PREVS is
1031 ;; the alist of previous items.
1040 seq))
1044 ;; Cons each parent relative number into return value (OUT).
1049 ;; Return value.
1050 out)))
1053 \f
1054 ;;; Searching
1057 "Search a string in valid contexts for lists.
1058 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1059 in `re-search-forward'."
1063 ;; 1. No match: return to origin or bound, depending on NOERR.
1066 nil)))
1067 ;; 2. Match in valid context: return point. Else, continue
1068 ;; searching.
1072 "Like `re-search-backward' but stop only where lists are recognized.
1073 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1074 `re-search-backward'."
1079 "Like `re-search-forward' but stop only where lists are recognized.
1080 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1081 `re-search-forward'."
1086 \f
1087 ;;; Methods on structures
1090 "Return BULLET with the correct number of whitespaces.
1091 It determines the number of whitespaces to append by looking at
1092 `org-list-two-spaces-after-bullet-regexp'."
1096 org-list-two-spaces-after-bullet-regexp bullet))
1097 " "
1101 bullet))))
1104 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1106 Blank lines at the end of items are left in place. Item
1107 visibility is preserved. Return the new structure after the
1108 changes.
1110 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1111 to the same sub-list.
1113 This function modifies STRUCT."
1126 ;; Store overlays responsible for visibility status. We
1127 ;; also need to store their boundaries as they will be
1128 ;; removed from buffer.
1143 ;; 1. Move effectively items in buffer.
1147 ;; 2. Now modify struct. No need to re-read the list, the
1148 ;; transformation is just a shift of positions. Some special
1149 ;; attention is required for items ending at END-A and END-B
1150 ;; as empty spaces are not moved there. In others words,
1151 ;; item BEG-A will end with whitespaces that were at the end
1152 ;; of BEG-B and the same applies to BEG-B.
1175 ;; Restore visibility status, by moving overlays to their new
1176 ;; position.
1186 ;; Return structure.
1187 struct)))
1190 "Return number of blank lines that should separate items in list.
1192 POS is the position of point where `org-list-insert-item' was called.
1194 STRUCT is the list structure. PREVS is the alist of previous
1195 items, as returned by `org-list-prevs-alist'.
1197 Assume point is at item's beginning. If the item is alone, apply
1198 some heuristics to guess the result."
1203 usr-blank
1207 ;; Count blank lines above beginning of line.
1214 ;; Trivial cases where there should be none.
1216 ;; When `org-blank-before-new-entry' says so, it is 1.
1218 ;; `plain-list-item' is 'auto. Count blank lines separating
1219 ;; neighbors' items in list.
1222 ;; Is there a next item?
1225 ;; Is there a previous item?
1228 ;; User inserted blank lines, trust him.
1233 usr-blank)
1234 ;; Are there blank lines inside the list so far?
1237 ;; Do not use `org-list-search-forward' so blank lines
1238 ;; in blocks can be counted in.
1242 ;; Default choice: no blank line.
1246 "Insert a new list item at POS and return the new structure.
1247 If POS is before first character after bullet of the item, the
1248 new item will be created before the current one.
1250 STRUCT is the list structure. PREVS is the alist of previous
1251 items, as returned by `org-list-prevs-alist'.
1253 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1254 after the bullet. Cursor will be after this text once the
1255 function ends.
1257 This function modifies STRUCT."
1259 ;; 1. Get information about list: position of point with regards
1260 ;; to item start (BEFOREP), blank lines number separating items
1261 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1268 (<= pos
1271 ;; Ignore tag in a non-descriptive list.
1280 pos struct prevs))
1281 ;; 2. Build the new item to be created. Concatenate same
1282 ;; bullet as item, checkbox, text AFTER-BULLET if
1283 ;; provided, and text cut from point to end of item
1284 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1285 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1286 ;; between what was cut and what was inserted in buffer
1287 ;; is stored in SIZE-OFFSET.
1291 ind))
1298 ;; If POS is greater than ITEM-END, then point is
1299 ;; in some white lines after the end of the list.
1300 ;; Those must be removed, or they will be left,
1301 ;; stacking up after the list.
1311 text-cut))))
1315 ;; 4. Insert effectively item into buffer.
1319 ;; 5. Add new item to STRUCT.
1323 ;; Before inserted item, positions don't change but
1324 ;; an item ending after insertion has its end shifted
1325 ;; by SIZE-OFFSET.
1328 ;; Trivial cases where current item isn't split in
1329 ;; two. Just shift every item after new one by
1330 ;; ITEM-SIZE.
1334 ;; Item is split in two: elements before POS are just
1335 ;; shifted by ITEM-SIZE. In the case item would end
1336 ;; after split POS, ending is only shifted by
1337 ;; SIZE-OFFSET.
1343 ;; Elements after POS are moved into new item.
1344 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1345 ;; doesn't appear in buffer yet.
1351 (+ end size-offset
1353 ;; Elements at ITEM-END or after are only shifted by
1354 ;; SIZE-OFFSET.
1357 struct)
1360 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1361 ;; exchange ITEM with the next item in list. Position cursor
1362 ;; after bullet, counter, checkbox, and label.
1368 struct)))
1371 "Remove ITEM from the list and return the new structure.
1373 STRUCT is the list structure."
1376 ;; If ITEM ends with the list, delete blank lines
1377 ;; before it.
1382 item)))
1383 ;; Remove item from buffer.
1385 ;; Remove item from structure and shift others items accordingly.
1386 ;; Don't forget to shift also ending position when appropriate.
1404 struct)))))
1407 "Send ITEM to destination DEST.
1409 STRUCT is the list structure.
1411 DEST can have various values.
1413 If DEST is a buffer position, the function will assume it points
1414 to another item in the same list as ITEM, and will move the
1415 latter just before the former.
1417 If DEST is `begin' (respectively `end'), ITEM will be moved at
1418 the beginning (respectively end) of the list it belongs to.
1421 be moved at the Nth position in the list.
1423 If DEST is `kill', ITEM will be deleted and its body will be
1424 added to the kill-ring.
1426 If DEST is `delete', ITEM will be deleted.
1428 Visibility of item is preserved.
1430 This function returns, destructively, the new list structure."
1433 ;; Grab full item body minus its bullet.
1442 item-end)))
1443 ;; Change DEST into a buffer position. A trick is needed
1444 ;; when ITEM is meant to be sent at the end of the list.
1445 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1446 ;; nil and insertion point (INS-POINT) to the first line's
1447 ;; end of the last item, we ensure the new item will be
1448 ;; inserted after the last item, and not after any of its
1449 ;; hypothetical sub-items.
1465 ;; Send ITEM at the end of the list.
1473 ;; Store inner overlays (to preserve visibility).
1485 ;; 1. Structure returned by `org-list-insert-item' may not be
1486 ;; accurate, as it cannot see sub-items included in BODY.
1487 ;; Thus, first compute the real structure so far.
1495 ;; 1.1. Remove the item just created in structure.
1497 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1500 struct
1508 new-end
1510 moved-items))
1512 ;; 2. Restore inner overlays.
1517 ;; 3. Eventually delete extra copy of the item and clean marker.
1523 "Outdent items between positions START and END.
1525 STRUCT is the list structure. PARENTS is the alist of items'
1526 parents, as returned by `org-list-parents-alist'.
1528 START is included, END excluded."
1534 ;; Item not yet in zone: keep association.
1536 ;; Item out of zone: follow associations in ACC.
1540 ;; Item has no parent: error
1543 ;; Parent is outdented: keep association.
1547 ;; Parent isn't outdented: reparent to grand-parent.
1549 parent struct parents)))
1555 "Indent items between positions START and END.
1557 STRUCT is the list structure. PARENTS is the alist of parents
1558 and PREVS is the alist of previous items, returned by,
1559 respectively, `org-list-parents-alist' and
1560 `org-list-prevs-alist'.
1562 START is included and END excluded.
1564 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1565 bullets between START and END."
1573 ;; Normalize ordered bullets.
1583 org-list-demote-modify-bullet))))
1590 ;; Item not yet in zone: keep association.
1593 ;; Item out of zone: follow associations in ACC.
1597 ;; Item is in zone...
1599 ;; Check if bullet needs to be changed.
1602 ;; First item indented but not parent: error
1605 ;; First item and parent indented: keep same
1606 ;; parent.
1608 ;; Previous item not indented: reparent to it.
1610 ;; Previous item indented: reparent like it.
1617 \f
1618 ;;; Repairing structures
1621 "Non-nil if list starting at FIRST can have alphabetical bullets.
1623 STRUCT is list structure. PREVS is the alist of previous items,
1624 as returned by `org-list-prevs-alist'."
1628 ;; Pretend that bullets are uppercase and check if alphabet
1629 ;; is sufficient, taking counters into account.
1632 ;; Virtually determine current bullet
1634 ;; Counters are not case-sensitive.
1637 ;; Test if bullet would be over z or Z.
1641 ;; All items checked. All good.
1642 t))))
1645 "Increment BULLET if applicable."
1648 ;; Num bullet: increment it.
1652 nil nil bullet))
1653 ;; Alpha bullet: increment it.
1657 nil nil bullet))
1658 ;; Unordered bullet: leave it.
1662 "Verify and correct bullets in STRUCT.
1663 PREVS is the alist of previous items, as returned by
1664 `org-list-prevs-alist'.
1666 This function modifies STRUCT."
1670 ;; Set bullet of ITEM in STRUCT, depending on the type of
1671 ;; first item of the list, the previous bullet and counter
1672 ;; if any.
1681 item struct
1684 ;; Alpha counter in alpha list: use counter.
1688 ;; Use cond to be sure `string-match' is used in
1689 ;; both cases.
1695 ;; Num counter in a num list: use counter.
1700 ;; No counter: increase, if needed, previous bullet.
1703 ;; Alpha counter at first item: use counter.
1712 ;; Num counter at first item: use counter.
1717 ;; First bullet is alpha uppercase: use "A".
1720 ;; First bullet is alpha lowercase: use "a".
1723 ;; First bullet is num: use "1".
1726 ;; Not an ordered list: keep bullet.
1731 "Verify and correct indentation in STRUCT.
1733 PARENTS is the alist of parents, as returned by
1734 `org-list-parents-alist'.
1736 If numeric optional argument BULLET-SIZE is set, assume all
1737 bullets in list have this length to determine new indentation.
1739 This function modifies STRUCT."
1746 ;; Indent like parent + length of parent's bullet +
1747 ;; sub-list offset.
1753 org-list-indent-offset))
1754 ;; If no parent, indent like top-point.
1759 "Verify and correct checkboxes in STRUCT.
1761 PARENTS is the alist of parents and PREVS is the alist of
1762 previous items, as returned by, respectively,
1763 `org-list-parents-alist' and `org-list-prevs-alist'.
1765 If ORDERED is non-nil, a checkbox can only be checked when every
1766 checkbox before it is checked too. If there was an attempt to
1767 break this rule, the function will return the blocking item. In
1768 all others cases, the return value will be nil.
1770 This function modifies STRUCT."
1780 item struct
1786 ;; Parent has no boxed child: leave box as-is.
1788 parent-list)
1789 ;; 1. List all parents with a checkbox.
1796 all-items)
1797 ;; 2. Sort those parents by decreasing indentation.
1802 ;; 3. For each parent, get all children's checkboxes to determine
1803 ;; and set its checkbox accordingly.
1805 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1810 ;; There are boxes checked after an unchecked one: fix that.
1817 ;; Verify once again the structure, without ORDERED.
1819 ;; Return blocking item.
1823 "Verify and correct each item end position in STRUCT.
1825 This function modifies STRUCT."
1832 ;; To determine real ind of an ending position that is
1833 ;; not at an item, we have to find the item it belongs
1834 ;; to: it is the last item (ITEM-UP), whose ending is
1835 ;; further than the position we're interested in.
1838 ;; Else part is for the bottom point.
1840 end-pos)
1841 end-list)))
1844 struct)
1849 "Apply set difference between STRUCT and OLD-STRUCT to the buffer.
1851 OLD-STRUCT is the structure before any modifications, and STRUCT
1852 the structure to be applied. The function will only modify parts
1853 of the list which have changed.
1855 Initial position of cursor is restored after the changes."
1862 ;; Shift the indentation between END and BEG by DELTA.
1863 ;; Start from the line before END.
1872 ;; Skip inline tasks.
1875 ;; Shift only non-empty lines.
1881 ;; Replace ITEM first line elements with new elements from
1882 ;; STRUCT, if appropriate.
1892 ;; a. Replace bullet
1895 ;; b. Replace checkbox.
1906 ;; c. Indent item to appropriate column.
1911 ;; 1. First get list of items and position endings. We maintain
1912 ;; two alists: ITM-SHIFT, determining indentation shift needed
1913 ;; at item, and END-LIST, a pseudo-alist where key is ending
1914 ;; position and value point.
1927 ;; To determine real ind of an ending position that
1928 ;; is not at an item, we have to find the item it
1929 ;; belongs to: it is the last item (ITEM-UP), whose
1930 ;; ending is further than the position we're
1931 ;; interested in.
1935 ;; 2. Slice the items into parts that should be shifted by the
1936 ;; same amount of indentation. Each slice follow the pattern
1937 ;; (END BEG DELTA). Slices are returned in reverse order.
1940 #'<)
1948 ;; If we're not at an item, there's a child of the
1949 ;; item point belongs to above. Make sure the less
1950 ;; indented line in this slice has the same column
1951 ;; as that child.
1958 ;; Ignore empty lines. Also ignore blocks and
1959 ;; drawers contents.
1967 down t)))
1970 down t)))))
1974 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1975 ;; end to beginning. Take a special action when beginning is
1976 ;; at item bullet.
1983 ;; 4. Go back to initial position and clean marker.
1988 "Correct bullets, checkboxes and indentation in list at point.
1990 STRUCT is the list structure. PARENTS is the alist of parents,
1991 as returned by `org-list-parents-alist'.
1993 When non-nil, optional argument OLD-STRUCT is the reference
1994 structure of the list. It should be provided whenever STRUCT
1995 doesn't correspond anymore to the real list in buffer."
1996 ;; Order of functions matters here: checkboxes and endings need
1997 ;; correct indentation to be set, and indentation needs correct
1998 ;; bullets.
1999 ;;
2000 ;; 0. Save a copy of structure before modifications
2002 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
2003 ;; order to get items endings and bullets properly
2005 ;; 2. Fix each item end to get correct prevs alist.
2007 ;; 3. Get bullets right.
2010 ;; 4. Now get real indentation.
2012 ;; 5. Eventually fix checkboxes.
2014 ;; 6. Apply structure modifications to buffer.
2018 \f
2019 ;;; Misc Tools
2022 "Call FUNCTION on each item of the list at point.
2023 FUNCTION must be called with at least one argument: INIT-VALUE,
2024 that will contain the value returned by the function at the
2025 previous item, plus ARGS extra arguments.
2027 FUNCTION is applied on items in reverse order.
2029 As an example, \(org-apply-on-list \(lambda \(result\) \(1+ result\)\) 0\)
2030 will return the number of items in the current list.
2032 Sublists of the list are skipped. Cursor is always at the
2033 beginning of the item."
2045 value))
2048 "Set visibility of ITEM in STRUCT to VIEW.
2050 Possible values are: `folded', `children' or `subtree'. See
2051 `org-cycle' for more information."
2055 ;; Hide from eol
2057 item-end t)))
2059 ;; First show everything.
2061 ;; Then fold every child.
2066 children)))
2068 ;; Show everything
2073 "Return column at which body of ITEM should start."
2085 2
2089 \f
2090 ;;; Interactive functions
2095 "Go to the beginning of the current item.
2096 Throw an error when not in a list."
2102 "Go to the beginning item of the current list or sublist.
2103 Throw an error when not in a list."
2114 "Go to the end of the current list or sublist.
2115 Throw an error when not in a list."
2126 "Go to the end of the current item.
2127 Throw an error when not in a list."
2137 "Move to the beginning of the previous item.
2138 Throw an error when not in a list. Also throw an error when at
2139 first item, unless `org-list-use-circular-motion' is non-nil."
2155 "Move to the beginning of the next item.
2156 Throw an error when not in a list. Also throw an error when at
2157 last item, unless `org-list-use-circular-motion' is non-nil."
2173 "Move the item at point down, i.e. swap with following item.
2174 Sub-items (items with larger indentation) are considered part of
2175 the item, so this really moves item trees."
2194 "Move the item at point up, i.e. swap with previous item.
2195 Sub-items (items with larger indentation) are considered part of
2196 the item, so this really moves item trees."
2213 "Insert a new item at the current level.
2214 If cursor is before first character after bullet of the item, the
2215 new item will be created before the current one.
2217 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2219 Return t when things worked, nil when we are not in an item, or
2220 item is invisible."
2223 ;; If cursor isn't is a list or if list is invisible, return nil.
2231 ;; Timer list: delegate to `org-timer-item'.
2236 ;; If we're in a description list, ask for the new term.
2250 t)))))
2253 "Fix indentation, bullets and checkboxes in the list at point."
2261 "Cycle through the different itemize/enumerate bullets.
2262 This cycle the entire list level through the sequence:
2264 `-' -> `+' -> `*' -> `1.' -> `1)'
2266 If WHICH is a valid string, use that as the new bullet. If WHICH
2267 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2268 `previous', cycle backwards."
2288 ;; Compute list of possible bullets, depending on context.
2291 ;; *-bullets are not allowed at column 0.
2293 ;; Description items cannot be numbered.
2316 ;; Use a short variation of `org-list-write-struct' as there's
2317 ;; no need to go through all the steps.
2325 "Toggle the checkbox in the current line.
2326 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2327 double prefix, set checkbox to [-].
2329 When there is an active region, toggle status or presence of the
2330 first checkbox there, and make every item inside have the same
2331 status or presence, respectively.
2333 If the cursor is in a headline, apply this to all checkbox items
2334 in the text below the heading, taking as reference the first item
2335 in subtree, ignoring drawers."
2339 block-item
2340 lim-up
2341 lim-down
2349 ;; In a region, start at first item in region.
2359 ;; On an heading, start at first item after drawers and
2360 ;; time-stamps (scheduled, etc.).
2372 ;; Just one item: set SINGLEP flag.
2378 ;; Determine the checkbox going to be applied to all items
2379 ;; within bounds.
2390 ;; When an item is found within bounds, grab the full list at
2391 ;; point structure, then: (1) set check-box of all its items
2392 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2393 ;; whole list, (3) move point after the list.
2407 e struct
2408 ;; If there is no box at item, leave as-is
2409 ;; unless function was called with C-u prefix.
2412 ref-checkbox
2413 cur-box))))
2414 items-to-toggle)
2416 struct parents prevs orderedp))
2417 ;; Report some problems due to ORDERED status of subtree.
2418 ;; If only one box was being checked, throw an error, else,
2419 ;; only signal problems.
2423 "Checkbox blocked because of unchecked box at line %d"
2427 "Checkboxes were removed due to unchecked box at line %d"
2436 "Reset all checkboxes in an entry subtree."
2453 "Update the checkbox statistics in the current section.
2455 This will find all statistic cookies like [57%] and [6/12] and
2456 update them with the current numbers.
2458 With optional prefix argument ALL, do this for the whole buffer."
2479 ;; Return number of checked boxes and boxes of all types
2480 ;; in all structures in STRUCTS. If RECURSIVEP is
2481 ;; non-nil, also count boxes in sub-lists. If ITEM is
2482 ;; nil, count across the whole structure, else count only
2483 ;; across subtree whose ancestor is ITEM.
2498 items))))
2501 cookies-list cache)
2502 ;; Move to start.
2506 ;; Build an alist for each cookie found. The key is the position
2507 ;; at beginning of cookie and values ending position, format of
2508 ;; cookie, number of checked boxes to report and total number of
2509 ;; boxes.
2519 context
2521 quote-block special-block verse-block)))
2537 structs)
2542 structs)
2543 ;; Skip whole list since we have its
2544 ;; structure anyway.
2549 end))))))
2550 ;; Cache count for cookies applying to the same
2551 ;; area. Then return it.
2558 structs
2559 recursivep)))
2561 count))))))
2562 cookies-list))))
2563 ;; Apply alist to buffer.
2579 "Select the face for checkbox statistics.
2580 The face will be `org-done' when all relevant boxes are checked.
2581 Otherwise it will be `org-todo'."
2584 'org-checkbox-statistics-done
2588 'org-checkbox-statistics-done
2592 "Update checkbox statistics unless turned off by user.
2593 With an optional argument ALL, update them in the whole buffer."
2601 "Indent a local list item including its children.
2602 When number ARG is a negative, item will be outdented, otherwise
2603 it will be indented.
2605 If a region is active, all items inside will be moved.
2607 If NO-SUBTREE is non-nil, only indent the item itself, not its
2608 children.
2610 STRUCT is the list structure.
2612 Return t if successful."
2620 ;; Are we going to move the whole list?
2628 t))))
2629 ;; Determine begin and end points of zone to indent. If moving
2630 ;; more than one item, save them for subsequent moves.
2646 ;; Special case: moving top-item with indent rule.
2654 ;; Change bullet if necessary.
2660 ;; Shift every item by OFFSET and fix bullets. Then
2661 ;; apply changes to buffer.
2665 struct)
2668 ;; Forbidden move:
2670 ;; If only one item is moved, it mustn't have a child.
2674 ;; If a subtree or region is moved, the last item
2675 ;; of the subtree mustn't have a child.
2680 struct)))))
2683 ;; Normal shifting
2691 t)
2694 "Outdent a local list item, but not its children.
2695 If a region is active, all items inside will be moved."
2711 "Indent a local list item, but not its children.
2712 If a region is active, all items inside will be moved."
2728 "Outdent a local list item including its children.
2729 If a region is active, all items inside will be moved."
2745 "Indent a local list item including its children.
2746 If a region is active, all items inside will be moved."
2764 "Cycle levels of indentation of an empty item.
2765 The first run indents the item, if applicable. Subsequent runs
2766 outdent it at meaningful levels in the list. When done, item is
2767 put back at its original position with its original bullet.
2769 Return t at each successful move."
2775 ;; Accept empty items or if cycle has already started.
2786 ;; When in the middle of the cycle, try to outdent first. If
2787 ;; it fails, and point is still at initial position, indent.
2788 ;; Else, re-create it at its original position.
2797 ;; Break cycle
2799 ;; If a cycle is starting, remember indentation and bullet,
2800 ;; then try to indent. If it fails, try to outdent.
2806 t))))
2809 "Sort list items.
2810 The cursor may be at any item of the list that should be sorted.
2811 Sublists are not sorted. Checkboxes, if any, are ignored.
2813 Sorting can be alphabetically, numerically, by date/time as given
2814 by a time stamp, by a property or by priority.
2816 Comparing entries ignores case by default. However, with an
2817 optional argument WITH-CASE, the sorting considers case as well.
2819 The command prompts for the sorting type unless it has been given
2820 to the function through the SORTING-TYPE argument, which needs to
2821 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F ?x ?X). Here is the
2822 detailed meaning of each character:
2824 n Numerically, by converting the beginning of the item to a number.
2825 a Alphabetically. Only the first line of item is checked.
2826 t By date/time, either the first active time stamp in the entry, if
2827 any, or by the first inactive one. In a timer list, sort the timers.
2830 Capital letters will reverse the sort order.
2832 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2833 a function to be called with point at the beginning of the
2834 record. It must return either a string or a number that should
2835 serve as the sorting key for that record. It will then use
2836 COMPARE-FUNC to compare entries.
2838 Sorting is done against the visible part of the headlines, it
2839 ignores hidden links."
2890 ;; If it is a timer list, convert timer to seconds
2907 value))
2911 next-record
2912 end-record
2913 value-to-sort
2914 nil
2915 sort-func)
2916 ;; Read and fix list again, as `sort-subr' probably destroyed
2917 ;; its structure.
2923 \f
2924 ;;; Send and receive lists
2927 "Parse the list at point and maybe DELETE it.
2929 Return a list whose car is a symbol of list type, among
2930 `ordered', `unordered' and `descriptive'. Then, each item is
2931 a list whose car is counter, and cdr are strings and other
2932 sub-lists. Inside strings, check-boxes are replaced by
2935 For example, the following list:
2937 1. first item
2938 + sub-item one
2939 + [X] sub-item two
2940 more text in first item
2941 2. [@3] last item
2943 will be parsed as:
2945 \(ordered
2947 \(unordered
2953 Point is left at list end."
2960 out
2963 ;; Return text between BEG and END, trimmed, with
2964 ;; checkboxes replaced.
2975 text)))))
2978 ;; Return a list whose car is list type and cdr a list of
2979 ;; items' body.
2985 ;; Return a list containing counter of item, if any, text
2986 ;; and any sublist inside it.
2992 ;; Get counter number. For alphabetic counter, get
2993 ;; its position in the alphabet.
3004 ;; If item has a child, store text between bullet and
3005 ;; next child, then recursively parse all sublists. At
3006 ;; the end of each sublist, check for the presence of
3007 ;; text belonging to the original item.
3017 ;; Remove children from the list just parsed.
3019 ;; There is a chunk of text belonging to the
3020 ;; item if last child doesn't end where next
3021 ;; child starts or where item ends.
3025 body))))
3028 ;; Store output, take care of cursor position and deletion of
3029 ;; list, then return output.
3036 out))
3039 "Convert the plain list at point into a subtree."
3047 "Insert a radio list template appropriate for this major mode."
3051 name pos)
3062 "Send a transformed version of this list to the receiver position.
3063 With argument MAYBE, fail quietly if no transformation is defined
3064 for this list."
3086 beg)
3090 ;; Find the insertion place
3095 name
3097 nil t)
3110 "Trim line breaks in a list ITEM."
3114 "Convert a LIST parsed through `org-list-parse-list' to other formats.
3115 Valid parameters PARAMS are:
3117 :ustart String to start an unordered list
3118 :uend String to end an unordered list
3120 :ostart String to start an ordered list
3121 :oend String to end an ordered list
3123 :dstart String to start a descriptive list
3124 :dend String to end a descriptive list
3125 :dtstart String to start a descriptive term
3126 :dtend String to end a descriptive term
3127 :ddstart String to start a description
3128 :ddend String to end a description
3130 :splice When set to t, return only list body lines, don't wrap
3131 them into :[u/o]start and :[u/o]end. Default is nil.
3133 :istart String to start a list item.
3134 :icount String to start an item with a counter.
3135 :iend String to end a list item
3136 :isep String to separate items
3137 :lsep String to separate sublists
3138 :csep String to separate text from a sub-list
3140 :cboff String to insert for an unchecked check-box
3141 :cbon String to insert for a checked check-box
3142 :cbtrans String to insert for a check-box in transitional state
3144 :nobr Non-nil means remove line breaks in lists items.
3146 Alternatively, each parameter can also be a form returning
3147 a string. These sexp can use keywords `counter' and `depth',
3148 representing respectively counter associated to the current
3149 item, and depth of the current sub-list, starting at 0.
3150 Obviously, `counter' is only available for parameters applying to
3151 items."
3175 export-sublist ; for byte-compiler
3178 ;; Export an item ITEM of type TYPE, at DEPTH. First
3179 ;; string in item is treated in a special way as it can
3180 ;; bring extra information that needs to be processed.
3186 ;; Stick DTSTART to ISTART by
3187 ;; left-trimming the latter.
3191 istart))
3198 ;; Replace checkbox if any is found.
3206 ;; Replace line breaks if required
3208 ;; Insert descriptive term if TYPE is `descriptive'.
3217 first)))
3228 ;; Export sublist SUB at DEPTH.
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'."
3280 ;; Return the string for the heading, depending on depth D
3281 ;; of current sub-list.
3286 oddeven-level)
3287 ?*)
3290 list
3292 '(:splice t
3299 params))))
3303 ;;; org-list.el ends here