| blob | a3ea49f5ffe7f4ac392641d2ddde424bad075820 |
1 ;;; org-list.el --- Plain lists for Org-mode
2 ;;
3 ;; Copyright (C) 2004-2012 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Bastien Guerry <bzg AT gnu DOT 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:
132 \f
133 ;;; Configuration variables
136 "Options concerning plain lists in Org-mode."
141 "When t, make TAB cycle visibility on plain list items.
142 Cycling plain lists works only when the cursor is on a plain list
143 item. When the cursor is on an outline heading, plain lists are
144 treated as text. This is the most stable way of handling this,
145 which is why it is the default.
147 When this is the symbol `integrate', then during cycling, plain
148 list items will *temporarily* be interpreted as outline headlines
149 with a level given by 1000+i where i is the indentation of the
150 bullet. This setting can lead to strange effects when switching
152 subtree decides what children should be listed. If that first
154 number, all true children and grand children of the outline
155 heading will be exposed in a children' view."
163 "Default bullet type installed when demoting an item.
164 This is an association list, for each bullet type, this alist will point
165 to the bullet that should be used when this item is demoted.
166 For example,
168 (setq org-list-demote-modify-bullet
171 will make
173 + Movies
174 + Silence of the Lambs
175 + My Cousin Vinny
176 + Books
177 + The Hunt for Red October
178 + The Road to Omaha
180 into
182 + Movies
183 - Silence of the Lambs
184 - My Cousin Vinny
185 + Books
186 - The Hunt for Red October
187 - The Road to Omaha"
205 "The character that makes a line with leading number an ordered list item.
206 Valid values are ?. and ?\). To get both terminators, use t."
213 "Non-nil means single character alphabetical bullets are allowed.
214 Both uppercase and lowercase are handled. Lists with more than
215 26 items will fallback to standard numbering. Alphabetical
222 "A regular expression matching bullets that should have 2 spaces after them.
223 When nil, no bullet will have two spaces after them. When
224 a string, it will be used as a regular expression. When the
225 bullet type of a list is changed, the new bullet type will be
226 matched against this regexp. If it matches, there will be two
227 spaces instead of one after the bullet in each item of the list."
234 "Non-nil means an empty line ends all plain list levels.
235 Otherwise, two of them will be necessary."
242 "Non-nil means apply set of rules when acting on lists.
243 By default, automatic actions are taken when using
248 rules by setting them to nil. Valid rules are:
250 bullet when non-nil, cycling bullet do not allow lists at
251 column 0 to have * as a bullet and descriptions lists
252 to be numbered.
253 checkbox when non-nil, checkbox statistics is updated each time
254 you either insert a new checkbox or toggle a checkbox.
255 indent when non-nil, indenting or outdenting list top-item
256 with its subtree will move the whole list and
257 outdenting a list whose bullet is * to column 0 will
262 :key-type
267 :value-type
271 "Non-nil means commands implying motion in lists should be cyclic.
273 In that case, the item following the last item is the first one,
274 and the item preceding the first item is the last one.
284 "Hook that is run whenever Org thinks checkbox statistics should be updated.
285 This hook runs even if checkbox rule in
286 `org-list-automatic-rules' does not apply, so it can be used to
287 implement alternative ways of collecting statistics
291 "Non-nil means checkbox statistics counts only the state of direct children.
292 When nil, all boxes below the cookie are counted.
293 This can be set to nil on a per-node basis using a COOKIE_DATA property
299 "Maximum indentation for the second line of a description list.
300 When the indentation would be larger than this, it will become
301 5 characters instead."
306 "Additional indentation for sub-items in a list.
307 By setting this to a small number, usually 1 or 2, one can more
308 clearly distinguish sub-items in a list."
315 % END RECEIVE ORGLST %n
317 #+ORGLST: SEND %n org-list-to-latex
318 -
321 @c END RECEIVE ORGLST %n
322 @ignore
323 #+ORGLST: SEND %n org-list-to-texinfo
324 -
327 <!-- END RECEIVE ORGLST %n -->
328 <!--
329 #+ORGLST: SEND %n org-list-to-html
330 -
332 "Templates for radio lists in different major modes.
333 All occurrences of %n in a template will be replaced with the name of the
334 list, obtained by prompting the user."
342 "Names of blocks where lists are not allowed.
346 "Context types where lists will be interpreted during export.
348 Valid types are `drawer', `inlinetask' and `block'. More
349 specifically, type `block' is determined by the variable
353 \f
354 ;;; Predicates and regexps
358 "Regex corresponding to the end of a list.
366 "Matches a list item and puts everything into groups:
367 group 1: bullet
368 group 2: counter
369 group 3: checkbox
373 "Return the correct regular expression for plain lists."
384 "Regexp matching the beginning of a plain list item."
388 "Is point at a list item with REGEXP after bullet?"
397 ;; Ignore counter if any
402 "Is point in a context where lists are allowed?"
406 "Return item beginning position when in a plain list, nil otherwise."
418 ;; Indentation isn't meaningful when point starts at an empty
419 ;; line or an inline task.
422 10000
428 ;; Detect if cursor in amidst `org-list-end-re'. First, count
429 ;; number HL of hard lines it takes, then call `org-in-regexp'
430 ;; to compute its boundaries END-BOUNDS. When point is
431 ;; in-between, move cursor before regexp beginning.
442 ;; Look for an item, less indented that reference line.
447 ;; This is exactly what we want.
450 ;; At upper bound of search or looking at the end of a
451 ;; previous list: search is over.
454 ;; Skip blocks, drawers, inline-tasks, blank lines
464 ;; Text at column 0 cannot belong to a list: stop.
466 ;; Normal text less indented than reference line, take
467 ;; it as new reference.
474 "Is point in a line starting a hand-formatted item?"
480 "Is point at the bullet of a plain list item?"
486 "Is point at a line starting a plain list item with a timer?"
491 "Is point at a description list item?"
495 "Is point at a line starting a plain-list item with a checklet?"
499 "Is point at a line starting a plain-list item with a counter?"
505 \f
506 ;;; Structures and helper functions
509 "Determine context, and its boundaries, around point.
511 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
512 are boundaries and CONTEXT is a symbol among `drawer', `block',
513 `invalid', `inlinetask' and nil.
515 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
521 ;; Get positions of surrounding headings. This is the
522 ;; default context.
527 ;; Is point inside a drawer?
529 ;; Can't use org-drawers-regexp as this function might
530 ;; be called in buffers not in Org mode.
541 lim-down))
544 ;; Is point strictly in a block, and of which type?
555 lim-down))
561 ;; Is point in an inlinetask?
574 ;; Return context boundaries and type.
578 "Return structure of list at point.
580 A list structure is an alist where key is point at item, and
581 values are:
582 1. indentation,
583 2. bullet with trailing whitespace,
584 3. bullet counter, if any,
585 4. checkbox, if any,
586 5. description tag, if any,
587 6. position at item end.
589 Thus the following list, where numbers in parens are
590 point-at-bol:
592 - [X] first item (1)
593 1. sub-item 1 (18)
594 5. [@5] sub-item 2 (34)
595 some other text belonging to first item (55)
596 - last item (97)
597 + tag :: description (109)
598 (131)
600 will get the following structure:
608 Assume point is at an item."
623 ind itm-lst itm-lst-2 end-lst end-lst-2 struct
626 ;; Return association at point.
630 ind
637 ;; Ensure list ends at the first blank line.
641 ;; 1. Read list from starting item to its beginning, and save
642 ;; top item position and indentation in BEG-CELL. Also store
643 ;; ending position of items in END-LST.
651 ;; At upward limit: if we ended at an item, store it,
652 ;; else dismiss useless data recorded above BEG-CELL.
653 ;; Jump to part 2.
661 ;; At a verbatim block, go before its beginning. Move
662 ;; from eol to ensure `previous-single-property-change'
663 ;; will return a value.
668 ;; Looking at a list ending regexp. Dismiss useless
669 ;; data recorded above BEG-CELL. Jump to part 2.
674 ;; Point is at an item. Add data to ITM-LST. It may
675 ;; also end a previous item: save it in END-LST. If
676 ;; ind is less or equal than BEG-CELL and there is no
677 ;; end at this ind or lesser, this item becomes the new
678 ;; BEG-CELL.
684 ;; Skip blocks, drawers, inline tasks, blank lines.
695 ;; From there, point is not at an item. Interpret
696 ;; line's indentation:
697 ;; - text at column 0 is necessarily out of any list.
698 ;; Dismiss data recorded above BEG-CELL. Jump to
699 ;; part 2.
700 ;; - any other case may be an ending position for an
701 ;; hypothetical item above. Store it and proceed.
710 ;; 2. Read list from starting point to its end, that is until we
711 ;; get out of context, or that a non-item line is less or
712 ;; equally indented than BEG-CELL's cdr. Also, store ending
713 ;; position of items in END-LST-2.
720 ;; At downward limit: this is de facto the end of the
721 ;; list. Save point as an ending position, and jump to
722 ;; part 3.
725 ;; At a verbatim block, move to its end. Point is at bol
726 ;; and 'org-example property is set by whole lines:
727 ;; `next-single-property-change' always return a value.
731 ;; Looking at a list ending regexp. Save point as an
732 ;; ending position and jump to part 3.
736 ;; Point is at an item. Add data to ITM-LST-2. It may
737 ;; also end a previous item, so save it in END-LST-2.
741 ;; Skip inline tasks and blank lines along the way
746 ;; Ind is lesser or equal than BEG-CELL's. The list is
747 ;; over: store point as an ending position and jump to
748 ;; part 3.
752 ;; Else, if ind is lesser or equal than previous item's,
753 ;; this is an ending position: store it. In any case,
754 ;; skip block or drawer at point, and move to next line.
766 ;; 3. Associate each item to its end position.
768 ;; 4. Return STRUCT
769 struct)))
772 "Associate proper ending point to items in STRUCT.
774 END-LIST is a pseudo-alist where car is indentation and cdr is
775 ending position.
777 This function modifies STRUCT."
783 ;; Remove end candidates behind current item.
786 ;; Add end position to item assoc.
792 struct)))
795 "Return alist between item and previous item in STRUCT."
797 struct)))
801 struct)))
804 "Return alist between item and parent in STRUCT."
816 ;; A sub-list is over. Find the associated
817 ;; origin in IND-TO-ORI. If it cannot be
818 ;; found (ill-formed list), set its parent as
819 ;; the first item less indented. If there is
820 ;; none, make it a top-level item.
828 ind-to-ori)
831 ;; A sub-list starts. Every item at IND will
832 ;; have previous item as its parent.
837 ;; Another item in the same sub-list: it shares
838 ;; the same parent as the previous item.
843 \f
844 ;;; Accessors
847 "Return the Nth value of KEY in STRUCT."
851 "Set the Nth value of KEY in STRUCT to NEW.
856 "Return indentation of ITEM in STRUCT."
860 "Set indentation of ITEM in STRUCT to IND.
865 "Return bullet of ITEM in STRUCT."
869 "Set bullet of ITEM in STRUCT to BULLET.
874 "Return counter of ITEM in STRUCT."
878 "Return checkbox of ITEM in STRUCT or nil."
882 "Set checkbox of ITEM in STRUCT to CHECKBOX.
887 "Return end position of ITEM in STRUCT."
891 "Return end position of ITEM in STRUCT."
895 "Return point at end of ITEM in STRUCT, before any blank line.
896 Point returned is at end of line."
903 "Return parent of ITEM or nil.
904 STRUCT is the list structure. PARENTS is the alist of parents,
905 as returned by `org-list-parents-alist'."
910 "Non-nil if ITEM has a child.
912 STRUCT is the list structure.
914 Value returned is the position of the first child of ITEM."
919 child-maybe)))
922 "Return next item in same sub-list as ITEM, or nil.
923 STRUCT is the list structure. PREVS is the alist of previous
924 items, as returned by `org-list-prevs-alist'."
928 "Return previous item in same sub-list as ITEM, or nil.
929 STRUCT is the list structure. PREVS is the alist of previous
930 items, as returned by `org-list-prevs-alist'."
934 "List all items having ITEM as a common ancestor, or nil.
935 STRUCT is the list structure."
938 subtree)
943 sub-struct))
947 "List all items in the same sub-list as ITEM.
948 STRUCT is the list structure. PREVS is the alist of previous
949 items, as returned by `org-list-prevs-alist'."
952 before-item after-item)
960 "List all children of ITEM, or nil.
961 STRUCT is the list structure. PARENTS is the alist of parents,
962 as returned by `org-list-parents-alist'."
970 "Return point at beginning of list.
971 STRUCT is the list structure."
975 "Return point at bottom of list.
976 STRUCT is the list structure."
981 "Return point at beginning of sub-list ITEM belongs.
982 STRUCT is the list structure. PREVS is the alist of previous
983 items, as returned by `org-list-prevs-alist'."
987 first-item))
992 "Return point at last item of sub-list ITEM belongs.
993 STRUCT is the list structure. PREVS is the alist of previous
994 items, as returned by `org-list-prevs-alist'."
998 last-item))
1001 "Return point at end of sub-list ITEM belongs.
1002 STRUCT is the list structure. PREVS is the alist of previous
1003 items, as returned by `org-list-prevs-alist'."
1007 "Return the type of the list containing ITEM, as a symbol.
1009 STRUCT is the list structure. PREVS is the alist of previous
1010 items, as returned by `org-list-prevs-alist'.
1012 Possible types are `descriptive', `ordered' and `unordered'. The
1013 type is determined by the first item of the list."
1021 "Return ITEM's sequence number.
1023 STRUCT is the list structure. PREVS is the alist of previous
1024 items, as returned by `org-list-prevs-alist'. PARENTS is the
1025 alist of ancestors, as returned by `org-list-parents-alist'.
1027 Return value is a list of integers. Counters have an impact on
1028 that value."
1032 ;; Return relative sequence number of ITEM in the sub-list
1033 ;; it belongs. STRUCT is the list structure. PREVS is
1034 ;; the alist of previous items.
1043 seq))
1047 ;; Cons each parent relative number into return value (OUT).
1052 ;; Return value.
1053 out)))
1056 \f
1057 ;;; Searching
1060 "Search a string in valid contexts for lists.
1061 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1062 in `re-search-forward'."
1066 ;; 1. No match: return to origin or bound, depending on NOERR.
1069 nil)))
1070 ;; 2. Match in valid context: return point. Else, continue
1071 ;; searching.
1075 "Like `re-search-backward' but stop only where lists are recognized.
1076 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1077 `re-search-backward'."
1082 "Like `re-search-forward' but stop only where lists are recognized.
1083 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1084 `re-search-forward'."
1089 \f
1090 ;;; Methods on structures
1093 "Return BULLET with the correct number of whitespaces.
1094 It determines the number of whitespaces to append by looking at
1095 `org-list-two-spaces-after-bullet-regexp'."
1099 org-list-two-spaces-after-bullet-regexp bullet))
1100 " "
1106 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1108 Blank lines at the end of items are left in place. Item
1109 visibility is preserved. Return the new structure after the
1110 changes.
1112 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1113 to the same sub-list.
1115 This function modifies STRUCT."
1128 ;; Store overlays responsible for visibility status. We
1129 ;; also need to store their boundaries as they will be
1130 ;; removed from buffer.
1138 ;; 1. Move effectively items in buffer.
1142 ;; 2. Now modify struct. No need to re-read the list, the
1143 ;; transformation is just a shift of positions. Some special
1144 ;; attention is required for items ending at END-A and END-B
1145 ;; as empty spaces are not moved there. In others words,
1146 ;; item BEG-A will end with whitespaces that were at the end
1147 ;; of BEG-B and the same applies to BEG-B.
1169 struct)
1171 ;; Restore visibility status, by moving overlays to their new
1172 ;; position.
1184 ;; Return structure.
1185 struct)))
1188 "Return number of blank lines that should separate items in list.
1190 POS is the position of point where `org-list-insert-item' was called.
1192 STRUCT is the list structure. PREVS is the alist of previous
1193 items, as returned by `org-list-prevs-alist'.
1195 Assume point is at item's beginning. If the item is alone, apply
1196 some heuristics to guess the result."
1201 usr-blank
1205 ;; Count blank lines above beginning of line.
1212 ;; Trivial cases where there should be none.
1214 ;; When `org-blank-before-new-entry' says so, it is 1.
1216 ;; `plain-list-item' is 'auto. Count blank lines separating
1217 ;; neighbours items in list.
1220 ;; Is there a next item?
1223 ;; Is there a previous item?
1226 ;; User inserted blank lines, trust him.
1231 usr-blank)
1232 ;; Are there blank lines inside the list so far?
1238 ;; Default choice: no blank line.
1242 "Insert a new list item at POS and return the new structure.
1243 If POS is before first character after bullet of the item, the
1244 new item will be created before the current one.
1246 STRUCT is the list structure. PREVS is the the alist of previous
1247 items, as returned by `org-list-prevs-alist'.
1249 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1250 after the bullet. Cursor will be after this text once the
1251 function ends.
1253 This function modifies STRUCT."
1255 ;; 1. Get information about list: position of point with regards
1256 ;; to item start (BEFOREP), blank lines number separating items
1257 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1265 pos struct prevs))
1266 ;; 2. Build the new item to be created. Concatenate same
1267 ;; bullet as item, checkbox, text AFTER-BULLET if
1268 ;; provided, and text cut from point to end of item
1269 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1270 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1271 ;; between what was cut and what was inserted in buffer
1272 ;; is stored in SIZE-OFFSET.
1276 ind))
1283 ;; If POS is greater than ITEM-END, then point is
1284 ;; in some white lines after the end of the list.
1285 ;; Those must be removed, or they will be left,
1286 ;; stacking up after the list.
1296 text-cut))))
1300 ;; 4. Insert effectively item into buffer.
1304 ;; 5. Add new item to STRUCT.
1308 ;; Before inserted item, positions don't change but
1309 ;; an item ending after insertion has its end shifted
1310 ;; by SIZE-OFFSET.
1313 ;; Trivial cases where current item isn't split in
1314 ;; two. Just shift every item after new one by
1315 ;; ITEM-SIZE.
1319 ;; Item is split in two: elements before POS are just
1320 ;; shifted by ITEM-SIZE. In the case item would end
1321 ;; after split POS, ending is only shifted by
1322 ;; SIZE-OFFSET.
1328 ;; Elements after POS are moved into new item.
1329 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1330 ;; doesn't appear in buffer yet.
1336 (+ end size-offset
1338 ;; Elements at ITEM-END or after are only shifted by
1339 ;; SIZE-OFFSET.
1342 struct)
1345 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1346 ;; exchange ITEM with the next item in list. Position cursor
1347 ;; after bullet, counter, checkbox, and label.
1353 struct)))
1356 "Remove ITEM from the list and return the new structure.
1358 STRUCT is the list structure."
1361 ;; If ITEM ends with the list, delete blank lines
1362 ;; before it.
1367 item)))
1368 ;; Remove item from buffer.
1370 ;; Remove item from structure and shift others items accordingly.
1371 ;; Don't forget to shift also ending position when appropriate.
1389 struct)))))
1392 "Send ITEM to destination DEST.
1394 STRUCT is the list structure.
1396 DEST can have various values.
1398 If DEST is a buffer position, the function will assume it points
1399 to another item in the same list as ITEM, and will move the
1400 latter just before the former.
1402 If DEST is `begin' (respectively `end'), ITEM will be moved at
1403 the beginning (respectively end) of the list it belongs to.
1406 be moved at the Nth position in the list.
1408 If DEST is `kill', ITEM will be deleted and its body will be
1409 added to the kill-ring.
1411 If DEST is `delete', ITEM will be deleted.
1413 Visibility of item is preserved.
1415 This function returns, destructively, the new list structure."
1418 ;; Grab full item body minus its bullet.
1427 item-end)))
1428 ;; Change DEST into a buffer position. A trick is needed
1429 ;; when ITEM is meant to be sent at the end of the list.
1430 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1431 ;; nil and insertion point (INS-POINT) to the first line's
1432 ;; end of the last item, we ensure the new item will be
1433 ;; inserted after the last item, and not after any of its
1434 ;; hypothetical sub-items.
1450 ;; Send ITEM at the end of the list.
1458 ;; Store visibility.
1468 ;; 1. Structure returned by `org-list-insert-item' may not be
1469 ;; accurate, as it cannot see sub-items included in BODY.
1470 ;; Thus, first compute the real structure so far.
1478 ;; 1.1. Remove the item just created in structure.
1480 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1483 struct
1491 new-end
1493 moved-items))
1495 ;; 2. Restore visibility.
1500 visibility)
1501 ;; 3. Eventually delete extra copy of the item and clean marker.
1507 "Outdent items between positions START and END.
1509 STRUCT is the list structure. PARENTS is the alist of items'
1510 parents, as returned by `org-list-parents-alist'.
1512 START is included, END excluded."
1518 ;; Item not yet in zone: keep association.
1520 ;; Item out of zone: follow associations in ACC.
1524 ;; Item has no parent: error
1527 ;; Parent is outdented: keep association.
1531 ;; Parent isn't outdented: reparent to grand-parent.
1533 parent struct parents)))
1539 "Indent items between positions START and END.
1541 STRUCT is the list structure. PARENTS is the alist of parents
1542 and PREVS is the alist of previous items, returned by,
1543 respectively, `org-list-parents-alist' and
1544 `org-list-prevs-alist'.
1546 START is included and END excluded.
1548 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1549 bullets between START and END."
1557 ;; Normalize ordered bullets.
1567 org-list-demote-modify-bullet))))
1574 ;; Item not yet in zone: keep association.
1577 ;; Item out of zone: follow associations in ACC.
1581 ;; Item is in zone...
1583 ;; Check if bullet needs to be changed.
1586 ;; First item indented but not parent: error
1589 ;; First item and parent indented: keep same
1590 ;; parent.
1592 ;; Previous item not indented: reparent to it.
1594 ;; Previous item indented: reparent like it.
1601 \f
1602 ;;; Repairing structures
1605 "Non-nil if list starting at FIRST can have alphabetical bullets.
1607 STRUCT is list structure. PREVS is the alist of previous items,
1608 as returned by `org-list-prevs-alist'."
1612 ;; Pretend that bullets are uppercase and check if alphabet
1613 ;; is sufficient, taking counters into account.
1617 ;; Virtually determine current bullet
1619 ;; Counters are not case-sensitive.
1622 ;; Test if bullet would be over z or Z.
1626 ;; All items checked. All good.
1627 t))))
1630 "Increment BULLET if applicable."
1633 ;; Num bullet: increment it.
1637 nil nil bullet))
1638 ;; Alpha bullet: increment it.
1642 nil nil bullet))
1643 ;; Unordered bullet: leave it.
1647 "Verify and correct bullets in STRUCT.
1648 PREVS is the alist of previous items, as returned by
1649 `org-list-prevs-alist'.
1651 This function modifies STRUCT."
1655 ;; Set bullet of ITEM in STRUCT, depending on the type of
1656 ;; first item of the list, the previous bullet and counter
1657 ;; if any.
1666 item struct
1669 ;; Alpha counter in alpha list: use counter.
1673 ;; Use cond to be sure `string-match' is used in
1674 ;; both cases.
1680 ;; Num counter in a num list: use counter.
1685 ;; No counter: increase, if needed, previous bullet.
1688 ;; Alpha counter at first item: use counter.
1697 ;; Num counter at first item: use counter.
1702 ;; First bullet is alpha uppercase: use "A".
1705 ;; First bullet is alpha lowercase: use "a".
1708 ;; First bullet is num: use "1".
1711 ;; Not an ordered list: keep bullet.
1716 "Verify and correct indentation in STRUCT.
1718 PARENTS is the alist of parents, as returned by
1719 `org-list-parents-alist'.
1721 If numeric optional argument BULLET-SIZE is set, assume all
1722 bullets in list have this length to determine new indentation.
1724 This function modifies STRUCT."
1731 ;; Indent like parent + length of parent's bullet +
1732 ;; sub-list offset.
1738 org-list-indent-offset))
1739 ;; If no parent, indent like top-point.
1744 "Verify and correct checkboxes in STRUCT.
1746 PARENTS is the alist of parents and PREVS is the alist of
1747 previous items, as returned by, respectively,
1748 `org-list-parents-alist' and `org-list-prevs-alist'.
1750 If ORDERED is non-nil, a checkbox can only be checked when every
1751 checkbox before it is checked too. If there was an attempt to
1752 break this rule, the function will return the blocking item. In
1753 all others cases, the return value will be nil.
1755 This function modifies STRUCT."
1765 item struct
1771 ;; Parent has no boxed child: leave box as-is.
1773 parent-list)
1774 ;; 1. List all parents with a checkbox.
1781 all-items)
1782 ;; 2. Sort those parents by decreasing indentation.
1787 ;; 3. For each parent, get all children's checkboxes to determine
1788 ;; and set its checkbox accordingly.
1790 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1795 ;; There are boxes checked after an unchecked one: fix that.
1800 ;; Verify once again the structure, without ORDERED.
1802 ;; Return blocking item.
1806 "Verify and correct each item end position in STRUCT.
1808 This function modifies STRUCT."
1815 ;; To determine real ind of an ending position that is
1816 ;; not at an item, we have to find the item it belongs
1817 ;; to: it is the last item (ITEM-UP), whose ending is
1818 ;; further than the position we're interested in.
1821 ;; Else part is for the bottom point.
1823 end-pos)
1824 end-list)))
1827 struct)
1832 "Apply set difference between STRUCT and OLD-STRUCT to the buffer.
1834 OLD-STRUCT is the structure before any modifications, and STRUCT
1835 the structure to be applied. The function will only modify parts
1836 of the list which have changed.
1838 Initial position of cursor is restored after the changes."
1845 ;; Shift the indentation between END and BEG by DELTA.
1846 ;; Start from the line before END.
1855 ;; Skip inline tasks.
1858 ;; Shift only non-empty lines.
1865 ;; Replace ITEM first line elements with new elements from
1866 ;; STRUCT, if appropriate.
1876 ;; a. Replace bullet
1879 ;; b. Replace checkbox.
1890 ;; c. Indent item to appropriate column.
1895 ;; 1. First get list of items and position endings. We maintain
1896 ;; two alists: ITM-SHIFT, determining indentation shift needed
1897 ;; at item, and END-POS, a pseudo-alist where key is ending
1898 ;; position and value point.
1911 ;; To determine real ind of an ending position that
1912 ;; is not at an item, we have to find the item it
1913 ;; belongs to: it is the last item (ITEM-UP), whose
1914 ;; ending is further than the position we're
1915 ;; interested in.
1919 old-struct)
1920 ;; 2. Slice the items into parts that should be shifted by the
1921 ;; same amount of indentation. The slices are returned in
1922 ;; reverse order so changes modifying buffer do not change
1923 ;; positions they refer to.
1926 '<))
1934 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1935 ;; end to beginning. Take a special action when beginning is
1936 ;; at item bullet.
1943 sliced-struct))
1944 ;; 4. Go back to initial position and clean marker.
1949 "Correct bullets, checkboxes and indentation in list at point.
1951 STRUCT is the list structure. PARENTS is the alist of parents,
1952 as returned by `org-list-parents-alist'.
1954 When non-nil, optional argument OLD-STRUCT is the reference
1955 structure of the list. It should be provided whenever STRUCT
1956 doesn't correspond anymore to the real list in buffer."
1957 ;; Order of functions matters here: checkboxes and endings need
1958 ;; correct indentation to be set, and indentation needs correct
1959 ;; bullets.
1960 ;;
1961 ;; 0. Save a copy of structure before modifications
1963 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1964 ;; order to get items endings and bullets properly
1966 ;; 2. Fix each item end to get correct prevs alist.
1968 ;; 3. Get bullets right.
1971 ;; 4. Now get real indentation.
1973 ;; 5. Eventually fix checkboxes.
1975 ;; 6. Apply structure modifications to buffer.
1979 \f
1980 ;;; Misc Tools
1983 "Call FUNCTION on each item of the list at point.
1984 FUNCTION must be called with at least one argument: INIT-VALUE,
1985 that will contain the value returned by the function at the
1986 previous item, plus ARGS extra arguments.
1988 FUNCTION is applied on items in reverse order.
1990 As an example, \(org-apply-on-list \(lambda \(result\) \(1+ result\)\) 0\)
1991 will return the number of items in the current list.
1993 Sublists of the list are skipped. Cursor is always at the
1994 beginning of the item."
2006 value))
2009 "Set visibility of ITEM in STRUCT to VIEW.
2011 Possible values are: `folded', `children' or `subtree'. See
2012 `org-cycle' for more information."
2016 ;; Hide from eol
2018 item-end t)))
2020 ;; First show everything.
2022 ;; Then fold every child.
2027 children)))
2029 ;; Show everything
2034 "Return column at which body of ITEM should start."
2044 tcol))
2047 \f
2048 ;;; Interactive functions
2053 "Go to the beginning of the current item.
2054 Throw an error when not in a list."
2060 "Go to the beginning item of the current list or sublist.
2061 Throw an error when not in a list."
2072 "Go to the end of the current list or sublist.
2073 Throw an error when not in a list."
2084 "Go to the end of the current item.
2085 Throw an error when not in a list."
2095 "Move to the beginning of the previous item.
2096 Throw an error when not in a list. Also throw an error when at
2097 first item, unless `org-list-use-circular-motion' is non-nil."
2113 "Move to the beginning of the next item.
2114 Throw an error when not in a list. Also throw an error when at
2115 last item, unless `org-list-use-circular-motion' is non-nil."
2131 "Move the item at point down, i.e. swap with following item.
2132 Sub-items (items with larger indentation) are considered part of
2133 the item, so this really moves item trees."
2152 "Move the item at point up, i.e. swap with previous item.
2153 Sub-items (items with larger indentation) are considered part of
2154 the item, so this really moves item trees."
2171 "Insert a new item at the current level.
2172 If cursor is before first character after bullet of the item, the
2173 new item will be created before the current one.
2175 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2177 Return t when things worked, nil when we are not in an item, or
2178 item is invisible."
2181 ;; If cursor isn't is a list or if list is invisible, return nil.
2189 ;; Timer list: delegate to `org-timer-item'.
2194 ;; If we're in a description list, ask for the new term.
2203 t)))))
2206 "Fix indentation, bullets and checkboxes is the list at point."
2214 "Cycle through the different itemize/enumerate bullets.
2215 This cycle the entire list level through the sequence:
2217 `-' -> `+' -> `*' -> `1.' -> `1)'
2219 If WHICH is a valid string, use that as the new bullet. If WHICH
2220 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2221 `previous', cycle backwards."
2242 ;; Compute list of possible bullets, depending on context.
2245 ;; *-bullets are not allowed at column 0.
2248 ;; Description items cannot be numbered.
2271 ;; Use a short variation of `org-list-write-struct' as there's
2272 ;; no need to go through all the steps.
2280 "Toggle the checkbox in the current line.
2281 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2282 double prefix, set checkbox to [-].
2284 When there is an active region, toggle status or presence of the
2285 first checkbox there, and make every item inside have the same
2286 status or presence, respectively.
2288 If the cursor is in a headline, apply this to all checkbox items
2289 in the text below the heading, taking as reference the first item
2290 in subtree, ignoring drawers."
2294 block-item
2295 lim-up
2296 lim-down
2307 ;; In a region, start at first item in region.
2317 ;; On an heading, start at first item after drawers and
2318 ;; time-stamps (scheduled, etc.).
2329 ;; Just one item: set SINGLEP flag.
2335 ;; Determine the checkbox going to be applied to all items
2336 ;; within bounds.
2347 ;; When an item is found within bounds, grab the full list at
2348 ;; point structure, then: (1) set check-box of all its items
2349 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2350 ;; whole list, (3) move point after the list.
2364 e struct
2365 ;; If there is no box at item, leave as-is
2366 ;; unless function was called with C-u prefix.
2369 ref-checkbox
2370 cur-box))))
2371 items-to-toggle)
2373 struct parents prevs orderedp))
2374 ;; Report some problems due to ORDERED status of subtree.
2375 ;; If only one box was being checked, throw an error, else,
2376 ;; only signal problems.
2380 "Checkbox blocked because of unchecked box at line %d"
2384 "Checkboxes were removed due to unchecked box at line %d"
2393 "Reset all checkboxes in an entry subtree."
2410 "Update the checkbox statistics in the current section.
2411 This will find all statistic cookies like [57%] and [6/12] and
2412 update them with the current numbers.
2414 With optional prefix argument ALL, do this for the whole buffer."
2418 (box-re "^[ \t]*\\([-+*]\\|\\([0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2430 ;; Return number of checked boxes and boxes of all types
2431 ;; in all structures in STRUCTS. If RECURSIVEP is
2432 ;; non-nil, also count boxes in sub-lists. If ITEM is
2433 ;; nil, count across the whole structure, else count only
2434 ;; across subtree whose ancestor is ITEM.
2451 items))))
2454 structs)
2457 cookies-list structs-bak box-num)
2459 ;; 1. Build an alist for each cookie found within BOUNDS. The
2460 ;; key will be position at beginning of cookie and values
2461 ;; ending position, format of cookie, and a cell whose car is
2462 ;; number of checked boxes to report, and cdr total number of
2463 ;; boxes.
2473 ;; Cookie is at an heading, but specifically for todo,
2474 ;; not for checkboxes: skip it.
2480 ;; Cookie is at an heading, but all lists before next
2481 ;; heading already have been read. Use data collected
2482 ;; in STRUCTS-BAK. This should only happen when
2483 ;; heading has more than one cookie on it.
2486 backup-end))
2488 ;; Cookie is at a fresh heading. Grab structure of
2489 ;; every list containing a checkbox between point and
2490 ;; next headline, and save them in STRUCTS-BAK.
2494 structs-bak nil)
2501 ;; Cookie is at an item, and we already have list
2502 ;; structure stored in STRUCTS-BAK.
2505 ;; Only lists in no special context are stored.
2508 ;; Cookie is at an item, but we need to compute list
2509 ;; structure.
2515 ;; Else, cookie found is at a wrong place. Skip it.
2517 cookies-list))))
2518 ;; 2. Apply alist to buffer, in reverse order so positions stay
2519 ;; unchanged after cookie modifications.
2534 cookies-list))))
2537 "Select the face for checkbox statistics.
2538 The face will be `org-done' when all relevant boxes are checked.
2539 Otherwise it will be `org-todo'."
2542 'org-checkbox-statistics-done
2546 'org-checkbox-statistics-done
2550 "Update checkbox statistics unless turned off by user.
2551 With an optional argument ALL, update them in the whole buffer."
2559 "Indent a local list item including its children.
2560 When number ARG is a negative, item will be outdented, otherwise
2561 it will be indented.
2563 If a region is active, all items inside will be moved.
2565 If NO-SUBTREE is non-nil, only indent the item itself, not its
2566 children.
2568 STRUCT is the list structure.
2570 Return t if successful."
2578 ;; Are we going to move the whole list?
2586 t))))
2587 ;; Determine begin and end points of zone to indent. If moving
2588 ;; more than one item, save them for subsequent moves.
2604 ;; Special case: moving top-item with indent rule.
2612 ;; Change bullet if necessary.
2618 ;; Shift every item by OFFSET and fix bullets. Then
2619 ;; apply changes to buffer.
2623 struct)
2626 ;; Forbidden move:
2628 ;; If only one item is moved, it mustn't have a child.
2632 ;; If a subtree or region is moved, the last item
2633 ;; of the subtree mustn't have a child.
2638 struct)))))
2641 ;; Normal shifting
2649 t)
2652 "Outdent a local list item, but not its children.
2653 If a region is active, all items inside will be moved."
2669 "Indent a local list item, but not its children.
2670 If a region is active, all items inside will be moved."
2686 "Outdent a local list item including its children.
2687 If a region is active, all items inside will be moved."
2703 "Indent a local list item including its children.
2704 If a region is active, all items inside will be moved."
2721 "Cycle levels of indentation of an empty item.
2722 The first run indents the item, if applicable. Subsequent runs
2723 outdent it at meaningful levels in the list. When done, item is
2724 put back at its original position with its original bullet.
2726 Return t at each successful move."
2732 ;; Accept empty items or if cycle has already started.
2743 ;; When in the middle of the cycle, try to outdent first. If
2744 ;; it fails, and point is still at initial position, indent.
2745 ;; Else, re-create it at its original position.
2754 ;; Break cycle
2756 ;; If a cycle is starting, remember indentation and bullet,
2757 ;; then try to indent. If it fails, try to outdent.
2763 t))))
2766 "Sort list items.
2767 The cursor may be at any item of the list that should be sorted.
2768 Sublists are not sorted. Checkboxes, if any, are ignored.
2770 Sorting can be alphabetically, numerically, by date/time as given
2771 by a time stamp, by a property or by priority.
2773 Comparing entries ignores case by default. However, with an
2774 optional argument WITH-CASE, the sorting considers case as well.
2776 The command prompts for the sorting type unless it has been given
2777 to the function through the SORTING-TYPE argument, which needs to
2778 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
2779 meaning of each character:
2781 n Numerically, by converting the beginning of the item to a number.
2782 a Alphabetically. Only the first line of item is checked.
2783 t By date/time, either the first active time stamp in the entry, if
2784 any, or by the first inactive one. In a timer list, sort the timers.
2786 Capital letters will reverse the sort order.
2788 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2789 a function to be called with point at the beginning of the
2790 record. It must return either a string or a number that should
2791 serve as the sorting key for that record. It will then use
2792 COMPARE-FUNC to compare entries."
2837 ;; If it is a timer list, convert timer to seconds
2850 value))
2854 next-record
2855 end-record
2856 value-to-sort
2857 nil
2858 sort-func)
2859 ;; Read and fix list again, as `sort-subr' probably destroyed
2860 ;; its structure.
2866 \f
2867 ;;; Send and receive lists
2870 "Parse the list at point and maybe DELETE it.
2872 Return a list whose car is a symbol of list type, among
2873 `ordered', `unordered' and `descriptive'. Then, each item is
2874 a list whose car is counter, and cdr are strings and other
2875 sub-lists. Inside strings, check-boxes are replaced by
2878 For example, the following list:
2880 1. first item
2881 + sub-item one
2882 + [X] sub-item two
2883 more text in first item
2884 2. [@3] last item
2886 will be parsed as:
2888 \(ordered
2890 \(unordered
2896 Point is left at list end."
2902 out
2903 parse-item ; for byte-compiler
2906 ;; Return text between BEG and END, trimmed, with
2907 ;; checkboxes replaced.
2918 text)))))
2921 ;; Return a list whose car is list type and cdr a list of
2922 ;; items' body.
2928 ;; Return a list containing counter of item, if any, text
2929 ;; and any sublist inside it.
2935 ;; Get counter number. For alphabetic counter, get
2936 ;; its position in the alphabet.
2947 ;; If item has a child, store text between bullet and
2948 ;; next child, then recursively parse all sublists. At
2949 ;; the end of each sublist, check for the presence of
2950 ;; text belonging to the original item.
2960 ;; Remove children from the list just parsed.
2962 ;; There is a chunk of text belonging to the
2963 ;; item if last child doesn't end where next
2964 ;; child starts or where item ends.
2968 body))))
2971 ;; Store output, take care of cursor position and deletion of
2972 ;; list, then return output.
2979 out))
2982 "Convert the plain list at point into a subtree."
2990 "Insert a radio list template appropriate for this major mode."
2994 name pos)
3005 "Send a transformed version of this list to the receiver position.
3006 With argument MAYBE, fail quietly if no transformation is defined
3007 for this list."
3013 (unless (looking-at "[ \t]*#\\+ORGLST[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
3032 beg txt)
3036 ;; Find the insertion place
3041 name
3055 "Trim line breaks in a list ITEM."
3059 "Convert a LIST parsed through `org-list-parse-list' to other formats.
3060 Valid parameters PARAMS are:
3062 :ustart String to start an unordered list
3063 :uend String to end an unordered list
3065 :ostart String to start an ordered list
3066 :oend String to end an ordered list
3068 :dstart String to start a descriptive list
3069 :dend String to end a descriptive list
3070 :dtstart String to start a descriptive term
3071 :dtend String to end a descriptive term
3072 :ddstart String to start a description
3073 :ddend String to end a description
3075 :splice When set to t, return only list body lines, don't wrap
3076 them into :[u/o]start and :[u/o]end. Default is nil.
3078 :istart String to start a list item.
3079 :icount String to start an item with a counter.
3080 :iend String to end a list item
3081 :isep String to separate items
3082 :lsep String to separate sublists
3083 :csep String to separate text from a sub-list
3085 :cboff String to insert for an unchecked check-box
3086 :cbon String to insert for a checked check-box
3087 :cbtrans String to insert for a check-box in transitional state
3089 :nobr Non-nil means remove line breaks in lists items.
3091 Alternatively, each parameter can also be a form returning
3092 a string. These sexp can use keywords `counter' and `depth',
3093 representing respectively counter associated to the current
3094 item, and depth of the current sub-list, starting at 0.
3095 Obviously, `counter' is only available for parameters applying to
3096 items."
3120 export-sublist ; for byte-compiler
3123 ;; Export an item ITEM of type TYPE, at DEPTH. First
3124 ;; string in item is treated in a special way as it can
3125 ;; bring extra information that needs to be processed.
3131 ;; Stick DTSTART to ISTART by
3132 ;; left-trimming the latter.
3136 istart))
3143 ;; Replace checkbox if any is found.
3151 ;; Replace line breaks if required
3153 ;; Insert descriptive term if TYPE is `descriptive'.
3162 first)))
3173 ;; Export sublist SUB at DEPTH.
3191 "Convert LIST into a LaTeX list.
3192 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3193 with overruling parameters for `org-list-to-generic'."
3195 list
3204 ;; LaTeX increments counter just before
3205 ;; using it, so set it to the desired
3206 ;; value, minus one.
3213 params)))
3216 "Convert LIST into a HTML list.
3217 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3218 with overruling parameters for `org-list-to-generic'."
3220 list
3232 params)))
3235 "Convert LIST into a Texinfo list.
3236 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3237 with overruling parameters for `org-list-to-generic'."
3239 list
3250 params)))
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