| blob | 0dbe590f3896ac2b55e19ecdbe6eecc99143eafd |
1 ;;; org-list.el --- Plain lists for Org-mode
2 ;;
3 ;; Copyright (C) 2004-2014 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:
139 \f
140 ;;; Configuration variables
143 "Options concerning plain lists in Org-mode."
148 "When t, make TAB cycle visibility on plain list items.
149 Cycling plain lists works only when the cursor is on a plain list
150 item. When the cursor is on an outline heading, plain lists are
151 treated as text. This is the most stable way of handling this,
152 which is why it is the default.
154 When this is the symbol `integrate', then integrate plain list
155 items when cycling, as if they were children of outline headings.
157 This setting can lead to strange effects when switching visibility
160 plain list item with an implied large level number, all true
161 children and grand children of the outline heading will be
162 exposed in a children' view."
171 "Default bullet type installed when demoting an item.
172 This is an association list, for each bullet type, this alist will point
173 to the bullet that should be used when this item is demoted.
174 For example,
176 (setq org-list-demote-modify-bullet
179 will make
181 + Movies
182 + Silence of the Lambs
183 + My Cousin Vinny
184 + Books
185 + The Hunt for Red October
186 + The Road to Omaha
188 into
190 + Movies
191 - Silence of the Lambs
192 - My Cousin Vinny
193 + Books
194 - The Hunt for Red October
195 - The Road to Omaha"
213 "The character that makes a line with leading number an ordered list item.
214 Valid values are ?. and ?\). To get both terminators, use t.
216 This variable needs to be set before org.el is loaded. If you
217 need to make a change while Emacs is running, use the customize
218 interface or run the following code after updating it:
231 "Non-nil means single character alphabetical bullets are allowed.
233 Both uppercase and lowercase are handled. Lists with more than
234 26 items will fallback to standard numbering. Alphabetical
237 This variable needs to be set before org.el is loaded. If you
238 need to make a change while Emacs is running, use the customize
239 interface or run the following code after updating it:
249 "A regular expression matching bullets that should have 2 spaces after them.
250 When nil, no bullet will have two spaces after them. When
251 a string, it will be used as a regular expression. When the
252 bullet type of a list is changed, the new bullet type will be
253 matched against this regexp. If it matches, there will be two
254 spaces instead of one after the bullet in each item of the list."
263 "Non-nil means an empty line ends all plain list levels.
264 Otherwise, two of them will be necessary."
270 "Non-nil means apply set of rules when acting on lists.
271 By default, automatic actions are taken when using
276 rules by setting them to nil. Valid rules are:
278 checkbox when non-nil, checkbox statistics is updated each time
279 you either insert a new checkbox or toggle a checkbox.
280 indent when non-nil, indenting or outdenting list top-item
281 with its subtree will move the whole list and
282 outdenting a list whose bullet is * to column 0 will
287 :key-type
291 :value-type
295 "Non-nil means commands implying motion in lists should be cyclic.
297 In that case, the item following the last item is the first one,
298 and the item preceding the first item is the last one.
308 "Hook that is run whenever Org thinks checkbox statistics should be updated.
309 This hook runs even if checkbox rule in
310 `org-list-automatic-rules' does not apply, so it can be used to
311 implement alternative ways of collecting statistics
317 "Non-nil means checkbox statistics counts only the state of direct children.
318 When nil, all boxes below the cookie are counted.
319 This can be set to nil on a per-node basis using a COOKIE_DATA property
327 "Maximum indentation for the second line of a description list.
328 When the indentation would be larger than this, it will become
329 5 characters instead."
334 "Additional indentation for sub-items in a list.
335 By setting this to a small number, usually 1 or 2, one can more
336 clearly distinguish sub-items in a list."
343 % END RECEIVE ORGLST %n
345 #+ORGLST: SEND %n org-list-to-latex
346 -
349 @c END RECEIVE ORGLST %n
350 @ignore
351 #+ORGLST: SEND %n org-list-to-texinfo
352 -
355 <!-- END RECEIVE ORGLST %n -->
356 <!--
357 #+ORGLST: SEND %n org-list-to-html
358 -
360 "Templates for radio lists in different major modes.
361 All occurrences of %n in a template will be replaced with the name of the
362 list, obtained by prompting the user."
370 "Names of blocks where lists are not allowed.
374 "Context types where lists will be interpreted during export.
376 Valid types are `drawer', `inlinetask' and `block'. More
377 specifically, type `block' is determined by the variable
381 \f
382 ;;; Predicates and regexps
386 "Regex corresponding to the end of a list.
394 "Matches a list item and puts everything into groups:
395 group 1: bullet
396 group 2: counter
397 group 3: checkbox
401 "Return the correct regular expression for plain lists."
412 "Regexp matching the beginning of a plain list item."
416 "Is point at a list item with REGEXP after bullet?"
425 ;; Ignore counter if any
430 "Is point in a context where lists are allowed?"
434 "Return item beginning position when in a plain list, nil otherwise."
443 ;; Indentation isn't meaningful when point starts at an empty
444 ;; line or an inline task.
447 10000
453 ;; Detect if cursor in amidst `org-list-end-re'. First, count
454 ;; number HL of hard lines it takes, then call `org-in-regexp'
455 ;; to compute its boundaries END-BOUNDS. When point is
456 ;; in-between, move cursor before regexp beginning.
467 ;; Look for an item, less indented that reference line.
472 ;; This is exactly what we want.
475 ;; At upper bound of search or looking at the end of a
476 ;; previous list: search is over.
479 ;; Skip blocks, drawers, inline-tasks, blank lines
489 ;; Text at column 0 cannot belong to a list: stop.
491 ;; Normal text less indented than reference line, take
492 ;; it as new reference.
499 "Is point in a line starting a hand-formatted item?"
505 "Is point at the bullet of a plain list item?"
511 "Is point at a line starting a plain list item with a timer?"
516 "Is point at a description list item?"
520 "Is point at a line starting a plain-list item with a checklet?"
524 "Is point at a line starting a plain-list item with a counter?"
530 \f
531 ;;; Structures and helper functions
534 "Determine context, and its boundaries, around point.
536 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
537 are boundaries and CONTEXT is a symbol among `drawer', `block',
538 `invalid', `inlinetask' and nil.
540 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
546 ;; Get positions of surrounding headings. This is the
547 ;; default context.
552 ;; Is point inside a drawer?
562 lim-down))
565 ;; Is point strictly in a block, and of which type?
576 lim-down))
582 ;; Is point in an inlinetask?
595 ;; Return context boundaries and type.
599 "Return structure of list at point.
601 A list structure is an alist where key is point at item, and
602 values are:
603 1. indentation,
604 2. bullet with trailing whitespace,
605 3. bullet counter, if any,
606 4. checkbox, if any,
607 5. description tag, if any,
608 6. position at item end.
610 Thus the following list, where numbers in parens are
611 point-at-bol:
613 - [X] first item (1)
614 1. sub-item 1 (18)
615 5. [@5] sub-item 2 (34)
616 some other text belonging to first item (55)
617 - last item (97)
618 + tag :: description (109)
619 (131)
621 will get the following structure:
629 Assume point is at an item."
641 ind itm-lst itm-lst-2 end-lst end-lst-2 struct
644 ;; Return association at point.
649 ind
650 bullet
653 ;; Description tag.
658 ;; Ensure list ends at the first blank line.
662 ;; 1. Read list from starting item to its beginning, and save
663 ;; top item position and indentation in BEG-CELL. Also store
664 ;; ending position of items in END-LST.
671 ;; At upward limit: if we ended at an item, store it,
672 ;; else dismiss useless data recorded above BEG-CELL.
673 ;; Jump to part 2.
680 ;; Looking at a list ending regexp. Dismiss useless
681 ;; data recorded above BEG-CELL. Jump to part 2.
686 ;; Point is at an item. Add data to ITM-LST. It may
687 ;; also end a previous item: save it in END-LST. If
688 ;; ind is less or equal than BEG-CELL and there is no
689 ;; end at this ind or lesser, this item becomes the new
690 ;; BEG-CELL.
696 ;; Skip blocks, drawers, inline tasks, blank lines.
707 ;; From there, point is not at an item. Interpret
708 ;; line's indentation:
709 ;; - text at column 0 is necessarily out of any list.
710 ;; Dismiss data recorded above BEG-CELL. Jump to
711 ;; part 2.
712 ;; - any other case may be an ending position for an
713 ;; hypothetical item above. Store it and proceed.
722 ;; 2. Read list from starting point to its end, that is until we
723 ;; get out of context, or that a non-item line is less or
724 ;; equally indented than BEG-CELL's cdr. Also, store ending
725 ;; position of items in END-LST-2.
731 ;; At downward limit: this is de facto the end of the
732 ;; list. Save point as an ending position, and jump to
733 ;; part 3.
736 ;; Looking at a list ending regexp. Save point as an
737 ;; ending position and jump to part 3.
741 ;; Point is at an item. Add data to ITM-LST-2. It may
742 ;; also end a previous item, so save it in END-LST-2.
746 ;; Skip inline tasks and blank lines along the way
751 ;; Ind is lesser or equal than BEG-CELL's. The list is
752 ;; over: store point as an ending position and jump to
753 ;; part 3.
757 ;; Else, if ind is lesser or equal than previous item's,
758 ;; this is an ending position: store it. In any case,
759 ;; skip block or drawer at point, and move to next line.
771 ;; 3. Associate each item to its end position.
773 ;; 4. Return STRUCT
774 struct)))
777 "Associate proper ending point to items in STRUCT.
779 END-LIST is a pseudo-alist where car is indentation and cdr is
780 ending position.
782 This function modifies STRUCT."
788 ;; Remove end candidates behind current item.
791 ;; Add end position to item assoc.
797 struct)))
800 "Return alist between item and previous item in STRUCT."
802 struct)))
806 struct)))
809 "Return alist between item and parent in STRUCT."
821 ;; A sub-list is over. Find the associated
822 ;; origin in IND-TO-ORI. If it cannot be
823 ;; found (ill-formed list), set its parent as
824 ;; the first item less indented. If there is
825 ;; none, make it a top-level item.
833 ind-to-ori)
836 ;; A sub-list starts. Every item at IND will
837 ;; have previous item as its parent.
842 ;; Another item in the same sub-list: it shares
843 ;; the same parent as the previous item.
848 \f
849 ;;; Accessors
852 "Return the Nth value of KEY in STRUCT."
856 "Set the Nth value of KEY in STRUCT to NEW.
861 "Return indentation of ITEM in STRUCT."
865 "Set indentation of ITEM in STRUCT to IND.
870 "Return bullet of ITEM in STRUCT."
874 "Set bullet of ITEM in STRUCT to BULLET.
879 "Return counter of ITEM in STRUCT."
883 "Return checkbox of ITEM in STRUCT or nil."
887 "Set checkbox of ITEM in STRUCT to CHECKBOX.
892 "Return end position of ITEM in STRUCT."
896 "Return end position of ITEM in STRUCT."
900 "Return point at end of ITEM in STRUCT, before any blank line.
901 Point returned is at end of line."
908 "Return parent of ITEM or nil.
909 STRUCT is the list structure. PARENTS is the alist of parents,
910 as returned by `org-list-parents-alist'."
915 "Non-nil if ITEM has a child.
917 STRUCT is the list structure.
919 Value returned is the position of the first child of ITEM."
924 child-maybe)))
927 "Return next item in same sub-list as ITEM, or nil.
928 STRUCT is the list structure. PREVS is the alist of previous
929 items, as returned by `org-list-prevs-alist'."
933 "Return previous item in same sub-list as ITEM, or nil.
934 STRUCT is the list structure. PREVS is the alist of previous
935 items, as returned by `org-list-prevs-alist'."
939 "List all items having ITEM as a common ancestor, or nil.
940 STRUCT is the list structure."
943 subtree)
948 sub-struct))
952 "List all items in the same sub-list as ITEM.
953 STRUCT is the list structure. PREVS is the alist of previous
954 items, as returned by `org-list-prevs-alist'."
957 before-item after-item)
965 "List all children of ITEM, or nil.
966 STRUCT is the list structure. PARENTS is the alist of parents,
967 as returned by `org-list-parents-alist'."
975 "Return point at beginning of list.
976 STRUCT is the list structure."
980 "Return point at bottom of list.
981 STRUCT is the list structure."
986 "Return point at beginning of sub-list ITEM belongs.
987 STRUCT is the list structure. PREVS is the alist of previous
988 items, as returned by `org-list-prevs-alist'."
992 first-item))
997 "Return point at last item of sub-list ITEM belongs.
998 STRUCT is the list structure. PREVS is the alist of previous
999 items, as returned by `org-list-prevs-alist'."
1003 last-item))
1006 "Return point at end of sub-list ITEM belongs.
1007 STRUCT is the list structure. PREVS is the alist of previous
1008 items, as returned by `org-list-prevs-alist'."
1012 "Return the type of the list containing ITEM, as a symbol.
1014 STRUCT is the list structure. PREVS is the alist of previous
1015 items, as returned by `org-list-prevs-alist'.
1017 Possible types are `descriptive', `ordered' and `unordered'. The
1018 type is determined by the first item of the list."
1026 "Return ITEM's sequence number.
1028 STRUCT is the list structure. PREVS is the alist of previous
1029 items, as returned by `org-list-prevs-alist'. PARENTS is the
1030 alist of ancestors, as returned by `org-list-parents-alist'.
1032 Return value is a list of integers. Counters have an impact on
1033 that value."
1037 ;; Return relative sequence number of ITEM in the sub-list
1038 ;; it belongs. STRUCT is the list structure. PREVS is
1039 ;; the alist of previous items.
1048 seq))
1052 ;; Cons each parent relative number into return value (OUT).
1057 ;; Return value.
1058 out)))
1061 \f
1062 ;;; Searching
1065 "Search a string in valid contexts for lists.
1066 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1067 in `re-search-forward'."
1071 ;; 1. No match: return to origin or bound, depending on NOERR.
1074 nil)))
1075 ;; 2. Match in valid context: return point. Else, continue
1076 ;; searching.
1080 "Like `re-search-backward' but stop only where lists are recognized.
1081 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1082 `re-search-backward'."
1087 "Like `re-search-forward' but stop only where lists are recognized.
1088 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1089 `re-search-forward'."
1094 \f
1095 ;;; Methods on structures
1098 "Return BULLET with the correct number of whitespaces.
1099 It determines the number of whitespaces to append by looking at
1100 `org-list-two-spaces-after-bullet-regexp'."
1104 org-list-two-spaces-after-bullet-regexp bullet))
1105 " "
1109 bullet))))
1112 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1114 Blank lines at the end of items are left in place. Item
1115 visibility is preserved. Return the new structure after the
1116 changes.
1118 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1119 to the same sub-list.
1121 This function modifies STRUCT."
1134 ;; Store overlays responsible for visibility status. We
1135 ;; also need to store their boundaries as they will be
1136 ;; removed from buffer.
1144 ;; 1. Move effectively items in buffer.
1148 ;; 2. Now modify struct. No need to re-read the list, the
1149 ;; transformation is just a shift of positions. Some special
1150 ;; attention is required for items ending at END-A and END-B
1151 ;; as empty spaces are not moved there. In others words,
1152 ;; item BEG-A will end with whitespaces that were at the end
1153 ;; of BEG-B and the same applies to BEG-B.
1175 struct)
1177 ;; Restore visibility status, by moving overlays to their new
1178 ;; position.
1190 ;; Return structure.
1191 struct)))
1194 "Return number of blank lines that should separate items in list.
1196 POS is the position of point where `org-list-insert-item' was called.
1198 STRUCT is the list structure. PREVS is the alist of previous
1199 items, as returned by `org-list-prevs-alist'.
1201 Assume point is at item's beginning. If the item is alone, apply
1202 some heuristics to guess the result."
1207 usr-blank
1211 ;; Count blank lines above beginning of line.
1218 ;; Trivial cases where there should be none.
1220 ;; When `org-blank-before-new-entry' says so, it is 1.
1222 ;; `plain-list-item' is 'auto. Count blank lines separating
1223 ;; neighbors' items in list.
1226 ;; Is there a next item?
1229 ;; Is there a previous item?
1232 ;; User inserted blank lines, trust him.
1237 usr-blank)
1238 ;; Are there blank lines inside the list so far?
1241 ;; Do not use `org-list-search-forward' so blank lines
1242 ;; in blocks can be counted in.
1246 ;; Default choice: no blank line.
1250 "Insert a new list item at POS and return the new structure.
1251 If POS is before first character after bullet of the item, the
1252 new item will be created before the current one.
1254 STRUCT is the list structure. PREVS is the alist of previous
1255 items, as returned by `org-list-prevs-alist'.
1257 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1258 after the bullet. Cursor will be after this text once the
1259 function ends.
1261 This function modifies STRUCT."
1263 ;; 1. Get information about list: position of point with regards
1264 ;; to item start (BEFOREP), blank lines number separating items
1265 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1272 ;; Do not count 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 visibility.
1483 ;; 1. Structure returned by `org-list-insert-item' may not be
1484 ;; accurate, as it cannot see sub-items included in BODY.
1485 ;; Thus, first compute the real structure so far.
1493 ;; 1.1. Remove the item just created in structure.
1495 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1498 struct
1506 new-end
1508 moved-items))
1510 ;; 2. Restore visibility.
1515 visibility)
1516 ;; 3. Eventually delete extra copy of the item and clean marker.
1522 "Outdent items between positions START and END.
1524 STRUCT is the list structure. PARENTS is the alist of items'
1525 parents, as returned by `org-list-parents-alist'.
1527 START is included, END excluded."
1533 ;; Item not yet in zone: keep association.
1535 ;; Item out of zone: follow associations in ACC.
1539 ;; Item has no parent: error
1542 ;; Parent is outdented: keep association.
1546 ;; Parent isn't outdented: reparent to grand-parent.
1548 parent struct parents)))
1554 "Indent items between positions START and END.
1556 STRUCT is the list structure. PARENTS is the alist of parents
1557 and PREVS is the alist of previous items, returned by,
1558 respectively, `org-list-parents-alist' and
1559 `org-list-prevs-alist'.
1561 START is included and END excluded.
1563 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1564 bullets between START and END."
1572 ;; Normalize ordered bullets.
1582 org-list-demote-modify-bullet))))
1589 ;; Item not yet in zone: keep association.
1592 ;; Item out of zone: follow associations in ACC.
1596 ;; Item is in zone...
1598 ;; Check if bullet needs to be changed.
1601 ;; First item indented but not parent: error
1604 ;; First item and parent indented: keep same
1605 ;; parent.
1607 ;; Previous item not indented: reparent to it.
1609 ;; Previous item indented: reparent like it.
1616 \f
1617 ;;; Repairing structures
1620 "Non-nil if list starting at FIRST can have alphabetical bullets.
1622 STRUCT is list structure. PREVS is the alist of previous items,
1623 as returned by `org-list-prevs-alist'."
1627 ;; Pretend that bullets are uppercase and check if alphabet
1628 ;; is sufficient, taking counters into account.
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. If
1863 ;; MAX-IND is non-nil, ensure that no line will be indented
1864 ;; more than that number. Start from the line before END.
1873 ;; Skip inline tasks.
1876 ;; Shift only non-empty lines.
1884 ;; Replace ITEM first line elements with new elements from
1885 ;; STRUCT, if appropriate.
1895 ;; a. Replace bullet
1898 ;; b. Replace checkbox.
1909 ;; c. Indent item to appropriate column.
1914 ;; 1. First get list of items and position endings. We maintain
1915 ;; two alists: ITM-SHIFT, determining indentation shift needed
1916 ;; at item, and END-LIST, a pseudo-alist where key is ending
1917 ;; position and value point.
1930 ;; To determine real ind of an ending position that
1931 ;; is not at an item, we have to find the item it
1932 ;; belongs to: it is the last item (ITEM-UP), whose
1933 ;; ending is further than the position we're
1934 ;; interested in.
1938 ;; 2. Slice the items into parts that should be shifted by the
1939 ;; same amount of indentation. Each slice follow the pattern
1940 ;; (END BEG DELTA MAX-IND-OR-NIL). Slices are returned in
1941 ;; reverse order.
1944 '<))
1951 ;; If we're not at an item, there's a child of the item
1952 ;; point belongs to above. Make sure this slice isn't
1953 ;; moved within that child by specifying a maximum
1954 ;; indentation.
1958 org-list-indent-offset))))
1960 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1961 ;; end to beginning. Take a special action when beginning is
1962 ;; at item bullet.
1970 ;; 4. Go back to initial position and clean marker.
1975 "Correct bullets, checkboxes and indentation in list at point.
1977 STRUCT is the list structure. PARENTS is the alist of parents,
1978 as returned by `org-list-parents-alist'.
1980 When non-nil, optional argument OLD-STRUCT is the reference
1981 structure of the list. It should be provided whenever STRUCT
1982 doesn't correspond anymore to the real list in buffer."
1983 ;; Order of functions matters here: checkboxes and endings need
1984 ;; correct indentation to be set, and indentation needs correct
1985 ;; bullets.
1986 ;;
1987 ;; 0. Save a copy of structure before modifications
1989 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1990 ;; order to get items endings and bullets properly
1992 ;; 2. Fix each item end to get correct prevs alist.
1994 ;; 3. Get bullets right.
1997 ;; 4. Now get real indentation.
1999 ;; 5. Eventually fix checkboxes.
2001 ;; 6. Apply structure modifications to buffer.
2005 \f
2006 ;;; Misc Tools
2009 "Call FUNCTION on each item of the list at point.
2010 FUNCTION must be called with at least one argument: INIT-VALUE,
2011 that will contain the value returned by the function at the
2012 previous item, plus ARGS extra arguments.
2014 FUNCTION is applied on items in reverse order.
2016 As an example, \(org-apply-on-list \(lambda \(result\) \(1+ result\)\) 0\)
2017 will return the number of items in the current list.
2019 Sublists of the list are skipped. Cursor is always at the
2020 beginning of the item."
2032 value))
2035 "Set visibility of ITEM in STRUCT to VIEW.
2037 Possible values are: `folded', `children' or `subtree'. See
2038 `org-cycle' for more information."
2042 ;; Hide from eol
2044 item-end t)))
2046 ;; First show everything.
2048 ;; Then fold every child.
2053 children)))
2055 ;; Show everything
2060 "Return column at which body of ITEM should start."
2072 2
2076 \f
2077 ;;; Interactive functions
2082 "Go to the beginning of the current item.
2083 Throw an error when not in a list."
2089 "Go to the beginning item of the current list or sublist.
2090 Throw an error when not in a list."
2101 "Go to the end of the current list or sublist.
2102 Throw an error when not in a list."
2113 "Go to the end of the current item.
2114 Throw an error when not in a list."
2124 "Move to the beginning of the previous item.
2125 Throw an error when not in a list. Also throw an error when at
2126 first item, unless `org-list-use-circular-motion' is non-nil."
2142 "Move to the beginning of the next item.
2143 Throw an error when not in a list. Also throw an error when at
2144 last item, unless `org-list-use-circular-motion' is non-nil."
2160 "Move the item at point down, i.e. swap with following item.
2161 Sub-items (items with larger indentation) are considered part of
2162 the item, so this really moves item trees."
2181 "Move the item at point up, i.e. swap with previous item.
2182 Sub-items (items with larger indentation) are considered part of
2183 the item, so this really moves item trees."
2200 "Insert a new item at the current level.
2201 If cursor is before first character after bullet of the item, the
2202 new item will be created before the current one.
2204 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2206 Return t when things worked, nil when we are not in an item, or
2207 item is invisible."
2210 ;; If cursor isn't is a list or if list is invisible, return nil.
2218 ;; Timer list: delegate to `org-timer-item'.
2223 ;; If we're in a description list, ask for the new term.
2237 t)))))
2240 "Fix indentation, bullets and checkboxes in the list at point."
2248 "Cycle through the different itemize/enumerate bullets.
2249 This cycle the entire list level through the sequence:
2251 `-' -> `+' -> `*' -> `1.' -> `1)'
2253 If WHICH is a valid string, use that as the new bullet. If WHICH
2254 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2255 `previous', cycle backwards."
2275 ;; Compute list of possible bullets, depending on context.
2278 ;; *-bullets are not allowed at column 0.
2280 ;; Description items cannot be numbered.
2303 ;; Use a short variation of `org-list-write-struct' as there's
2304 ;; no need to go through all the steps.
2312 "Toggle the checkbox in the current line.
2313 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2314 double prefix, set checkbox to [-].
2316 When there is an active region, toggle status or presence of the
2317 first checkbox there, and make every item inside have the same
2318 status or presence, respectively.
2320 If the cursor is in a headline, apply this to all checkbox items
2321 in the text below the heading, taking as reference the first item
2322 in subtree, ignoring drawers."
2326 block-item
2327 lim-up
2328 lim-down
2336 ;; In a region, start at first item in region.
2346 ;; On an heading, start at first item after drawers and
2347 ;; time-stamps (scheduled, etc.).
2359 ;; Just one item: set SINGLEP flag.
2365 ;; Determine the checkbox going to be applied to all items
2366 ;; within bounds.
2377 ;; When an item is found within bounds, grab the full list at
2378 ;; point structure, then: (1) set check-box of all its items
2379 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2380 ;; whole list, (3) move point after the list.
2394 e struct
2395 ;; If there is no box at item, leave as-is
2396 ;; unless function was called with C-u prefix.
2399 ref-checkbox
2400 cur-box))))
2401 items-to-toggle)
2403 struct parents prevs orderedp))
2404 ;; Report some problems due to ORDERED status of subtree.
2405 ;; If only one box was being checked, throw an error, else,
2406 ;; only signal problems.
2410 "Checkbox blocked because of unchecked box at line %d"
2414 "Checkboxes were removed due to unchecked box at line %d"
2423 "Reset all checkboxes in an entry subtree."
2440 "Update the checkbox statistics in the current section.
2441 This will find all statistic cookies like [57%] and [6/12] and
2442 update them with the current numbers.
2444 With optional prefix argument ALL, do this for the whole buffer."
2448 (box-re "^[ \t]*\\([-+*]\\|\\([0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2460 ;; Return number of checked boxes and boxes of all types
2461 ;; in all structures in STRUCTS. If RECURSIVEP is
2462 ;; non-nil, also count boxes in sub-lists. If ITEM is
2463 ;; nil, count across the whole structure, else count only
2464 ;; across subtree whose ancestor is ITEM.
2481 items))))
2484 structs)
2487 cookies-list structs-bak box-num)
2489 ;; 1. Build an alist for each cookie found within BOUNDS. The
2490 ;; key will be position at beginning of cookie and values
2491 ;; ending position, format of cookie, and a cell whose car is
2492 ;; number of checked boxes to report, and cdr total number of
2493 ;; boxes.
2503 ;; Cookie is at an heading, but specifically for todo,
2504 ;; not for checkboxes: skip it.
2510 ;; Cookie is at an heading, but all lists before next
2511 ;; heading already have been read. Use data collected
2512 ;; in STRUCTS-BAK. This should only happen when
2513 ;; heading has more than one cookie on it.
2516 backup-end))
2518 ;; Cookie is at a fresh heading. Grab structure of
2519 ;; every list containing a checkbox between point and
2520 ;; next headline, and save them in STRUCTS-BAK.
2524 structs-bak nil)
2531 ;; Cookie is at an item, and we already have list
2532 ;; structure stored in STRUCTS-BAK.
2535 ;; Only lists in no special context are stored.
2538 ;; Cookie is at an item, but we need to compute list
2539 ;; structure.
2545 ;; Else, cookie found is at a wrong place. Skip it.
2547 cookies-list))))
2548 ;; 2. Apply alist to buffer, in reverse order so positions stay
2549 ;; unchanged after cookie modifications.
2564 cookies-list))))
2567 "Select the face for checkbox statistics.
2568 The face will be `org-done' when all relevant boxes are checked.
2569 Otherwise it will be `org-todo'."
2572 'org-checkbox-statistics-done
2576 'org-checkbox-statistics-done
2580 "Update checkbox statistics unless turned off by user.
2581 With an optional argument ALL, update them in the whole buffer."
2589 "Indent a local list item including its children.
2590 When number ARG is a negative, item will be outdented, otherwise
2591 it will be indented.
2593 If a region is active, all items inside will be moved.
2595 If NO-SUBTREE is non-nil, only indent the item itself, not its
2596 children.
2598 STRUCT is the list structure.
2600 Return t if successful."
2608 ;; Are we going to move the whole list?
2616 t))))
2617 ;; Determine begin and end points of zone to indent. If moving
2618 ;; more than one item, save them for subsequent moves.
2634 ;; Special case: moving top-item with indent rule.
2642 ;; Change bullet if necessary.
2648 ;; Shift every item by OFFSET and fix bullets. Then
2649 ;; apply changes to buffer.
2653 struct)
2656 ;; Forbidden move:
2658 ;; If only one item is moved, it mustn't have a child.
2662 ;; If a subtree or region is moved, the last item
2663 ;; of the subtree mustn't have a child.
2668 struct)))))
2671 ;; Normal shifting
2679 t)
2682 "Outdent a local list item, but not its children.
2683 If a region is active, all items inside will be moved."
2699 "Indent a local list item, but not its children.
2700 If a region is active, all items inside will be moved."
2716 "Outdent a local list item including its children.
2717 If a region is active, all items inside will be moved."
2733 "Indent a local list item including its children.
2734 If a region is active, all items inside will be moved."
2751 "Cycle levels of indentation of an empty item.
2752 The first run indents the item, if applicable. Subsequent runs
2753 outdent it at meaningful levels in the list. When done, item is
2754 put back at its original position with its original bullet.
2756 Return t at each successful move."
2762 ;; Accept empty items or if cycle has already started.
2773 ;; When in the middle of the cycle, try to outdent first. If
2774 ;; it fails, and point is still at initial position, indent.
2775 ;; Else, re-create it at its original position.
2784 ;; Break cycle
2786 ;; If a cycle is starting, remember indentation and bullet,
2787 ;; then try to indent. If it fails, try to outdent.
2793 t))))
2796 "Sort list items.
2797 The cursor may be at any item of the list that should be sorted.
2798 Sublists are not sorted. Checkboxes, if any, are ignored.
2800 Sorting can be alphabetically, numerically, by date/time as given
2801 by a time stamp, by a property or by priority.
2803 Comparing entries ignores case by default. However, with an
2804 optional argument WITH-CASE, the sorting considers case as well.
2806 The command prompts for the sorting type unless it has been given
2807 to the function through the SORTING-TYPE argument, which needs to
2808 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F ?x ?X). Here is the
2809 detailed meaning of each character:
2811 n Numerically, by converting the beginning of the item to a number.
2812 a Alphabetically. Only the first line of item is checked.
2813 t By date/time, either the first active time stamp in the entry, if
2814 any, or by the first inactive one. In a timer list, sort the timers.
2817 Capital letters will reverse the sort order.
2819 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2820 a function to be called with point at the beginning of the
2821 record. It must return either a string or a number that should
2822 serve as the sorting key for that record. It will then use
2823 COMPARE-FUNC to compare entries.
2825 Sorting is done against the visible part of the headlines, it
2826 ignores hidden links."
2877 ;; If it is a timer list, convert timer to seconds
2894 value))
2898 next-record
2899 end-record
2900 value-to-sort
2901 nil
2902 sort-func)
2903 ;; Read and fix list again, as `sort-subr' probably destroyed
2904 ;; its structure.
2910 \f
2911 ;;; Send and receive lists
2914 "Parse the list at point and maybe DELETE it.
2916 Return a list whose car is a symbol of list type, among
2917 `ordered', `unordered' and `descriptive'. Then, each item is
2918 a list whose car is counter, and cdr are strings and other
2919 sub-lists. Inside strings, check-boxes are replaced by
2922 For example, the following list:
2924 1. first item
2925 + sub-item one
2926 + [X] sub-item two
2927 more text in first item
2928 2. [@3] last item
2930 will be parsed as:
2932 \(ordered
2934 \(unordered
2940 Point is left at list end."
2946 out
2947 parse-item ; for byte-compiler
2950 ;; Return text between BEG and END, trimmed, with
2951 ;; checkboxes replaced.
2962 text)))))
2965 ;; Return a list whose car is list type and cdr a list of
2966 ;; items' body.
2972 ;; Return a list containing counter of item, if any, text
2973 ;; and any sublist inside it.
2979 ;; Get counter number. For alphabetic counter, get
2980 ;; its position in the alphabet.
2991 ;; If item has a child, store text between bullet and
2992 ;; next child, then recursively parse all sublists. At
2993 ;; the end of each sublist, check for the presence of
2994 ;; text belonging to the original item.
3004 ;; Remove children from the list just parsed.
3006 ;; There is a chunk of text belonging to the
3007 ;; item if last child doesn't end where next
3008 ;; child starts or where item ends.
3012 body))))
3015 ;; Store output, take care of cursor position and deletion of
3016 ;; list, then return output.
3023 out))
3026 "Convert the plain list at point into a subtree."
3034 "Insert a radio list template appropriate for this major mode."
3038 name pos)
3049 "Send a transformed version of this list to the receiver position.
3050 With argument MAYBE, fail quietly if no transformation is defined
3051 for this list."
3073 beg txt)
3077 ;; Find the insertion place
3082 name
3096 "Trim line breaks in a list ITEM."
3100 "Convert a LIST parsed through `org-list-parse-list' to other formats.
3101 Valid parameters PARAMS are:
3103 :ustart String to start an unordered list
3104 :uend String to end an unordered list
3106 :ostart String to start an ordered list
3107 :oend String to end an ordered list
3109 :dstart String to start a descriptive list
3110 :dend String to end a descriptive list
3111 :dtstart String to start a descriptive term
3112 :dtend String to end a descriptive term
3113 :ddstart String to start a description
3114 :ddend String to end a description
3116 :splice When set to t, return only list body lines, don't wrap
3117 them into :[u/o]start and :[u/o]end. Default is nil.
3119 :istart String to start a list item.
3120 :icount String to start an item with a counter.
3121 :iend String to end a list item
3122 :isep String to separate items
3123 :lsep String to separate sublists
3124 :csep String to separate text from a sub-list
3126 :cboff String to insert for an unchecked check-box
3127 :cbon String to insert for a checked check-box
3128 :cbtrans String to insert for a check-box in transitional state
3130 :nobr Non-nil means remove line breaks in lists items.
3132 Alternatively, each parameter can also be a form returning
3133 a string. These sexp can use keywords `counter' and `depth',
3134 representing respectively counter associated to the current
3135 item, and depth of the current sub-list, starting at 0.
3136 Obviously, `counter' is only available for parameters applying to
3137 items."
3161 export-sublist ; for byte-compiler
3164 ;; Export an item ITEM of type TYPE, at DEPTH. First
3165 ;; string in item is treated in a special way as it can
3166 ;; bring extra information that needs to be processed.
3172 ;; Stick DTSTART to ISTART by
3173 ;; left-trimming the latter.
3177 istart))
3184 ;; Replace checkbox if any is found.
3192 ;; Replace line breaks if required
3194 ;; Insert descriptive term if TYPE is `descriptive'.
3203 first)))
3214 ;; Export sublist SUB at DEPTH.
3232 "Convert LIST into a LaTeX list.
3233 LIST is as string representing the list to transform, as Org
3234 syntax. Return converted list as a string."
3239 "Convert LIST into a HTML list.
3240 LIST is as string representing the list to transform, as Org
3241 syntax. Return converted list as a string."
3246 "Convert LIST into a Texinfo 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 an Org subtree.
3254 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3255 with overruling parameters for `org-list-to-generic'."
3265 ;; Return the string for the heading, depending on depth D
3266 ;; of current sub-list.
3271 oddeven-level)
3272 ?*)
3275 list
3277 '(:splice t
3284 params))))
3288 ;;; org-list.el ends here