| blob | 1b3c5093ff1f15dddb02b023830b4a1ac9324b22 |
1 ;;; org-list.el --- Plain lists for Org-mode
2 ;;
3 ;; Copyright (C) 2004-2013 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:
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."
223 "Non-nil means single character alphabetical bullets are allowed.
225 Both uppercase and lowercase are handled. Lists with more than
226 26 items will fallback to standard numbering. Alphabetical
229 This variable needs to be set before org.el is loaded. If you
230 need to make a change while Emacs is running, use the customize
231 interface or run the following code, where VALUE stands for the
232 new value of the variable, after updating it:
243 "A regular expression matching bullets that should have 2 spaces after them.
244 When nil, no bullet will have two spaces after them. When
245 a string, it will be used as a regular expression. When the
246 bullet type of a list is changed, the new bullet type will be
247 matched against this regexp. If it matches, there will be two
248 spaces instead of one after the bullet in each item of the list."
257 "Non-nil means an empty line ends all plain list levels.
258 Otherwise, two of them will be necessary."
264 "Non-nil means apply set of rules when acting on lists.
265 By default, automatic actions are taken when using
270 rules by setting them to nil. Valid rules are:
272 checkbox when non-nil, checkbox statistics is updated each time
273 you either insert a new checkbox or toggle a checkbox.
274 indent when non-nil, indenting or outdenting list top-item
275 with its subtree will move the whole list and
276 outdenting a list whose bullet is * to column 0 will
281 :key-type
285 :value-type
289 "Non-nil means commands implying motion in lists should be cyclic.
291 In that case, the item following the last item is the first one,
292 and the item preceding the first item is the last one.
302 "Hook that is run whenever Org thinks checkbox statistics should be updated.
303 This hook runs even if checkbox rule in
304 `org-list-automatic-rules' does not apply, so it can be used to
305 implement alternative ways of collecting statistics
311 "Non-nil means checkbox statistics counts only the state of direct children.
312 When nil, all boxes below the cookie are counted.
313 This can be set to nil on a per-node basis using a COOKIE_DATA property
321 "Maximum indentation for the second line of a description list.
322 When the indentation would be larger than this, it will become
323 5 characters instead."
328 "Additional indentation for sub-items in a list.
329 By setting this to a small number, usually 1 or 2, one can more
330 clearly distinguish sub-items in a list."
337 % END RECEIVE ORGLST %n
339 #+ORGLST: SEND %n org-list-to-latex
340 -
343 @c END RECEIVE ORGLST %n
344 @ignore
345 #+ORGLST: SEND %n org-list-to-texinfo
346 -
349 <!-- END RECEIVE ORGLST %n -->
350 <!--
351 #+ORGLST: SEND %n org-list-to-html
352 -
354 "Templates for radio lists in different major modes.
355 All occurrences of %n in a template will be replaced with the name of the
356 list, obtained by prompting the user."
364 "Names of blocks where lists are not allowed.
368 "Context types where lists will be interpreted during export.
370 Valid types are `drawer', `inlinetask' and `block'. More
371 specifically, type `block' is determined by the variable
375 \f
376 ;;; Predicates and regexps
380 "Regex corresponding to the end of a list.
388 "Matches a list item and puts everything into groups:
389 group 1: bullet
390 group 2: counter
391 group 3: checkbox
395 "Return the correct regular expression for plain lists."
406 "Regexp matching the beginning of a plain list item."
410 "Is point at a list item with REGEXP after bullet?"
419 ;; Ignore counter if any
424 "Is point in a context where lists are allowed?"
428 "Return item beginning position when in a plain list, nil otherwise."
440 ;; Indentation isn't meaningful when point starts at an empty
441 ;; line or an inline task.
444 10000
450 ;; Detect if cursor in amidst `org-list-end-re'. First, count
451 ;; number HL of hard lines it takes, then call `org-in-regexp'
452 ;; to compute its boundaries END-BOUNDS. When point is
453 ;; in-between, move cursor before regexp beginning.
464 ;; Look for an item, less indented that reference line.
469 ;; This is exactly what we want.
472 ;; At upper bound of search or looking at the end of a
473 ;; previous list: search is over.
476 ;; Skip blocks, drawers, inline-tasks, blank lines
486 ;; Text at column 0 cannot belong to a list: stop.
488 ;; Normal text less indented than reference line, take
489 ;; it as new reference.
496 "Is point in a line starting a hand-formatted item?"
502 "Is point at the bullet of a plain list item?"
508 "Is point at a line starting a plain list item with a timer?"
513 "Is point at a description list item?"
517 "Is point at a line starting a plain-list item with a checklet?"
521 "Is point at a line starting a plain-list item with a counter?"
527 \f
528 ;;; Structures and helper functions
531 "Determine context, and its boundaries, around point.
533 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
534 are boundaries and CONTEXT is a symbol among `drawer', `block',
535 `invalid', `inlinetask' and nil.
537 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
543 ;; Get positions of surrounding headings. This is the
544 ;; default context.
549 ;; Is point inside a drawer?
551 ;; Can't use org-drawers-regexp as this function might
552 ;; be called in buffers not in Org mode.
563 lim-down))
566 ;; Is point strictly in a block, and of which type?
577 lim-down))
583 ;; Is point in an inlinetask?
596 ;; Return context boundaries and type.
600 "Return structure of list at point.
602 A list structure is an alist where key is point at item, and
603 values are:
604 1. indentation,
605 2. bullet with trailing whitespace,
606 3. bullet counter, if any,
607 4. checkbox, if any,
608 5. description tag, if any,
609 6. position at item end.
611 Thus the following list, where numbers in parens are
612 point-at-bol:
614 - [X] first item (1)
615 1. sub-item 1 (18)
616 5. [@5] sub-item 2 (34)
617 some other text belonging to first item (55)
618 - last item (97)
619 + tag :: description (109)
620 (131)
622 will get the following structure:
630 Assume point is at an item."
645 ind itm-lst itm-lst-2 end-lst end-lst-2 struct
648 ;; Return association at point.
653 ind
654 bullet
657 ;; Description tag.
662 ;; Ensure list ends at the first blank line.
666 ;; 1. Read list from starting item to its beginning, and save
667 ;; top item position and indentation in BEG-CELL. Also store
668 ;; ending position of items in END-LST.
675 ;; At upward limit: if we ended at an item, store it,
676 ;; else dismiss useless data recorded above BEG-CELL.
677 ;; Jump to part 2.
684 ;; Looking at a list ending regexp. Dismiss useless
685 ;; data recorded above BEG-CELL. Jump to part 2.
690 ;; Point is at an item. Add data to ITM-LST. It may
691 ;; also end a previous item: save it in END-LST. If
692 ;; ind is less or equal than BEG-CELL and there is no
693 ;; end at this ind or lesser, this item becomes the new
694 ;; BEG-CELL.
700 ;; Skip blocks, drawers, inline tasks, blank lines.
711 ;; From there, point is not at an item. Interpret
712 ;; line's indentation:
713 ;; - text at column 0 is necessarily out of any list.
714 ;; Dismiss data recorded above BEG-CELL. Jump to
715 ;; part 2.
716 ;; - any other case may be an ending position for an
717 ;; hypothetical item above. Store it and proceed.
726 ;; 2. Read list from starting point to its end, that is until we
727 ;; get out of context, or that a non-item line is less or
728 ;; equally indented than BEG-CELL's cdr. Also, store ending
729 ;; position of items in END-LST-2.
735 ;; At downward limit: this is de facto the end of the
736 ;; list. Save point as an ending position, and jump to
737 ;; part 3.
740 ;; Looking at a list ending regexp. Save point as an
741 ;; ending position and jump to part 3.
745 ;; Point is at an item. Add data to ITM-LST-2. It may
746 ;; also end a previous item, so save it in END-LST-2.
750 ;; Skip inline tasks and blank lines along the way
755 ;; Ind is lesser or equal than BEG-CELL's. The list is
756 ;; over: store point as an ending position and jump to
757 ;; part 3.
761 ;; Else, if ind is lesser or equal than previous item's,
762 ;; this is an ending position: store it. In any case,
763 ;; skip block or drawer at point, and move to next line.
775 ;; 3. Associate each item to its end position.
777 ;; 4. Return STRUCT
778 struct)))
781 "Associate proper ending point to items in STRUCT.
783 END-LIST is a pseudo-alist where car is indentation and cdr is
784 ending position.
786 This function modifies STRUCT."
792 ;; Remove end candidates behind current item.
795 ;; Add end position to item assoc.
801 struct)))
804 "Return alist between item and previous item in STRUCT."
806 struct)))
810 struct)))
813 "Return alist between item and parent in STRUCT."
825 ;; A sub-list is over. Find the associated
826 ;; origin in IND-TO-ORI. If it cannot be
827 ;; found (ill-formed list), set its parent as
828 ;; the first item less indented. If there is
829 ;; none, make it a top-level item.
837 ind-to-ori)
840 ;; A sub-list starts. Every item at IND will
841 ;; have previous item as its parent.
846 ;; Another item in the same sub-list: it shares
847 ;; the same parent as the previous item.
852 \f
853 ;;; Accessors
856 "Return the Nth value of KEY in STRUCT."
860 "Set the Nth value of KEY in STRUCT to NEW.
865 "Return indentation of ITEM in STRUCT."
869 "Set indentation of ITEM in STRUCT to IND.
874 "Return bullet of ITEM in STRUCT."
878 "Set bullet of ITEM in STRUCT to BULLET.
883 "Return counter of ITEM in STRUCT."
887 "Return checkbox of ITEM in STRUCT or nil."
891 "Set checkbox of ITEM in STRUCT to CHECKBOX.
896 "Return end position of ITEM in STRUCT."
900 "Return end position of ITEM in STRUCT."
904 "Return point at end of ITEM in STRUCT, before any blank line.
905 Point returned is at end of line."
912 "Return parent of ITEM or nil.
913 STRUCT is the list structure. PARENTS is the alist of parents,
914 as returned by `org-list-parents-alist'."
919 "Non-nil if ITEM has a child.
921 STRUCT is the list structure.
923 Value returned is the position of the first child of ITEM."
928 child-maybe)))
931 "Return next item in same sub-list as ITEM, or nil.
932 STRUCT is the list structure. PREVS is the alist of previous
933 items, as returned by `org-list-prevs-alist'."
937 "Return previous item in same sub-list as ITEM, or nil.
938 STRUCT is the list structure. PREVS is the alist of previous
939 items, as returned by `org-list-prevs-alist'."
943 "List all items having ITEM as a common ancestor, or nil.
944 STRUCT is the list structure."
947 subtree)
952 sub-struct))
956 "List all items in the same sub-list as ITEM.
957 STRUCT is the list structure. PREVS is the alist of previous
958 items, as returned by `org-list-prevs-alist'."
961 before-item after-item)
969 "List all children of ITEM, or nil.
970 STRUCT is the list structure. PARENTS is the alist of parents,
971 as returned by `org-list-parents-alist'."
979 "Return point at beginning of list.
980 STRUCT is the list structure."
984 "Return point at bottom of list.
985 STRUCT is the list structure."
990 "Return point at beginning of sub-list ITEM belongs.
991 STRUCT is the list structure. PREVS is the alist of previous
992 items, as returned by `org-list-prevs-alist'."
996 first-item))
1001 "Return point at last item 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 last-item))
1010 "Return point at end of sub-list ITEM belongs.
1011 STRUCT is the list structure. PREVS is the alist of previous
1012 items, as returned by `org-list-prevs-alist'."
1016 "Return the type of the list containing ITEM, as a symbol.
1018 STRUCT is the list structure. PREVS is the alist of previous
1019 items, as returned by `org-list-prevs-alist'.
1021 Possible types are `descriptive', `ordered' and `unordered'. The
1022 type is determined by the first item of the list."
1030 "Return ITEM's sequence number.
1032 STRUCT is the list structure. PREVS is the alist of previous
1033 items, as returned by `org-list-prevs-alist'. PARENTS is the
1034 alist of ancestors, as returned by `org-list-parents-alist'.
1036 Return value is a list of integers. Counters have an impact on
1037 that value."
1041 ;; Return relative sequence number of ITEM in the sub-list
1042 ;; it belongs. STRUCT is the list structure. PREVS is
1043 ;; the alist of previous items.
1052 seq))
1056 ;; Cons each parent relative number into return value (OUT).
1061 ;; Return value.
1062 out)))
1065 \f
1066 ;;; Searching
1069 "Search a string in valid contexts for lists.
1070 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1071 in `re-search-forward'."
1075 ;; 1. No match: return to origin or bound, depending on NOERR.
1078 nil)))
1079 ;; 2. Match in valid context: return point. Else, continue
1080 ;; searching.
1084 "Like `re-search-backward' but stop only where lists are recognized.
1085 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1086 `re-search-backward'."
1091 "Like `re-search-forward' but stop only where lists are recognized.
1092 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1093 `re-search-forward'."
1098 \f
1099 ;;; Methods on structures
1102 "Return BULLET with the correct number of whitespaces.
1103 It determines the number of whitespaces to append by looking at
1104 `org-list-two-spaces-after-bullet-regexp'."
1108 org-list-two-spaces-after-bullet-regexp bullet))
1109 " "
1113 bullet))))
1116 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1118 Blank lines at the end of items are left in place. Item
1119 visibility is preserved. Return the new structure after the
1120 changes.
1122 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1123 to the same sub-list.
1125 This function modifies STRUCT."
1138 ;; Store overlays responsible for visibility status. We
1139 ;; also need to store their boundaries as they will be
1140 ;; removed from buffer.
1148 ;; 1. Move effectively items in buffer.
1152 ;; 2. Now modify struct. No need to re-read the list, the
1153 ;; transformation is just a shift of positions. Some special
1154 ;; attention is required for items ending at END-A and END-B
1155 ;; as empty spaces are not moved there. In others words,
1156 ;; item BEG-A will end with whitespaces that were at the end
1157 ;; of BEG-B and the same applies to BEG-B.
1179 struct)
1181 ;; Restore visibility status, by moving overlays to their new
1182 ;; position.
1194 ;; Return structure.
1195 struct)))
1198 "Return number of blank lines that should separate items in list.
1200 POS is the position of point where `org-list-insert-item' was called.
1202 STRUCT is the list structure. PREVS is the alist of previous
1203 items, as returned by `org-list-prevs-alist'.
1205 Assume point is at item's beginning. If the item is alone, apply
1206 some heuristics to guess the result."
1211 usr-blank
1215 ;; Count blank lines above beginning of line.
1222 ;; Trivial cases where there should be none.
1224 ;; When `org-blank-before-new-entry' says so, it is 1.
1226 ;; `plain-list-item' is 'auto. Count blank lines separating
1227 ;; neighbours items in list.
1230 ;; Is there a next item?
1233 ;; Is there a previous item?
1236 ;; User inserted blank lines, trust him.
1241 usr-blank)
1242 ;; Are there blank lines inside the list so far?
1245 ;; Do not use `org-list-search-forward' so blank lines
1246 ;; in blocks can be counted in.
1250 ;; Default choice: no blank line.
1254 "Insert a new list item at POS and return the new structure.
1255 If POS is before first character after bullet of the item, the
1256 new item will be created before the current one.
1258 STRUCT is the list structure. PREVS is the the alist of previous
1259 items, as returned by `org-list-prevs-alist'.
1261 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1262 after the bullet. Cursor will be after this text once the
1263 function ends.
1265 This function modifies STRUCT."
1267 ;; 1. Get information about list: position of point with regards
1268 ;; to item start (BEFOREP), blank lines number separating items
1269 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1276 ;; Do not count tag in a non-descriptive list.
1284 pos struct prevs))
1285 ;; 2. Build the new item to be created. Concatenate same
1286 ;; bullet as item, checkbox, text AFTER-BULLET if
1287 ;; provided, and text cut from point to end of item
1288 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1289 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1290 ;; between what was cut and what was inserted in buffer
1291 ;; is stored in SIZE-OFFSET.
1295 ind))
1302 ;; If POS is greater than ITEM-END, then point is
1303 ;; in some white lines after the end of the list.
1304 ;; Those must be removed, or they will be left,
1305 ;; stacking up after the list.
1315 text-cut))))
1319 ;; 4. Insert effectively item into buffer.
1323 ;; 5. Add new item to STRUCT.
1327 ;; Before inserted item, positions don't change but
1328 ;; an item ending after insertion has its end shifted
1329 ;; by SIZE-OFFSET.
1332 ;; Trivial cases where current item isn't split in
1333 ;; two. Just shift every item after new one by
1334 ;; ITEM-SIZE.
1338 ;; Item is split in two: elements before POS are just
1339 ;; shifted by ITEM-SIZE. In the case item would end
1340 ;; after split POS, ending is only shifted by
1341 ;; SIZE-OFFSET.
1347 ;; Elements after POS are moved into new item.
1348 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1349 ;; doesn't appear in buffer yet.
1355 (+ end size-offset
1357 ;; Elements at ITEM-END or after are only shifted by
1358 ;; SIZE-OFFSET.
1361 struct)
1364 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1365 ;; exchange ITEM with the next item in list. Position cursor
1366 ;; after bullet, counter, checkbox, and label.
1372 struct)))
1375 "Remove ITEM from the list and return the new structure.
1377 STRUCT is the list structure."
1380 ;; If ITEM ends with the list, delete blank lines
1381 ;; before it.
1386 item)))
1387 ;; Remove item from buffer.
1389 ;; Remove item from structure and shift others items accordingly.
1390 ;; Don't forget to shift also ending position when appropriate.
1408 struct)))))
1411 "Send ITEM to destination DEST.
1413 STRUCT is the list structure.
1415 DEST can have various values.
1417 If DEST is a buffer position, the function will assume it points
1418 to another item in the same list as ITEM, and will move the
1419 latter just before the former.
1421 If DEST is `begin' (respectively `end'), ITEM will be moved at
1422 the beginning (respectively end) of the list it belongs to.
1425 be moved at the Nth position in the list.
1427 If DEST is `kill', ITEM will be deleted and its body will be
1428 added to the kill-ring.
1430 If DEST is `delete', ITEM will be deleted.
1432 Visibility of item is preserved.
1434 This function returns, destructively, the new list structure."
1437 ;; Grab full item body minus its bullet.
1446 item-end)))
1447 ;; Change DEST into a buffer position. A trick is needed
1448 ;; when ITEM is meant to be sent at the end of the list.
1449 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1450 ;; nil and insertion point (INS-POINT) to the first line's
1451 ;; end of the last item, we ensure the new item will be
1452 ;; inserted after the last item, and not after any of its
1453 ;; hypothetical sub-items.
1469 ;; Send ITEM at the end of the list.
1477 ;; Store visibility.
1487 ;; 1. Structure returned by `org-list-insert-item' may not be
1488 ;; accurate, as it cannot see sub-items included in BODY.
1489 ;; Thus, first compute the real structure so far.
1497 ;; 1.1. Remove the item just created in structure.
1499 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1502 struct
1510 new-end
1512 moved-items))
1514 ;; 2. Restore visibility.
1519 visibility)
1520 ;; 3. Eventually delete extra copy of the item and clean marker.
1526 "Outdent items between positions START and END.
1528 STRUCT is the list structure. PARENTS is the alist of items'
1529 parents, as returned by `org-list-parents-alist'.
1531 START is included, END excluded."
1537 ;; Item not yet in zone: keep association.
1539 ;; Item out of zone: follow associations in ACC.
1543 ;; Item has no parent: error
1546 ;; Parent is outdented: keep association.
1550 ;; Parent isn't outdented: reparent to grand-parent.
1552 parent struct parents)))
1558 "Indent items between positions START and END.
1560 STRUCT is the list structure. PARENTS is the alist of parents
1561 and PREVS is the alist of previous items, returned by,
1562 respectively, `org-list-parents-alist' and
1563 `org-list-prevs-alist'.
1565 START is included and END excluded.
1567 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1568 bullets between START and END."
1576 ;; Normalize ordered bullets.
1586 org-list-demote-modify-bullet))))
1593 ;; Item not yet in zone: keep association.
1596 ;; Item out of zone: follow associations in ACC.
1600 ;; Item is in zone...
1602 ;; Check if bullet needs to be changed.
1605 ;; First item indented but not parent: error
1608 ;; First item and parent indented: keep same
1609 ;; parent.
1611 ;; Previous item not indented: reparent to it.
1613 ;; Previous item indented: reparent like it.
1620 \f
1621 ;;; Repairing structures
1624 "Non-nil if list starting at FIRST can have alphabetical bullets.
1626 STRUCT is list structure. PREVS is the alist of previous items,
1627 as returned by `org-list-prevs-alist'."
1631 ;; Pretend that bullets are uppercase and check if alphabet
1632 ;; is sufficient, taking counters into account.
1636 ;; Virtually determine current bullet
1638 ;; Counters are not case-sensitive.
1641 ;; Test if bullet would be over z or Z.
1645 ;; All items checked. All good.
1646 t))))
1649 "Increment BULLET if applicable."
1652 ;; Num bullet: increment it.
1656 nil nil bullet))
1657 ;; Alpha bullet: increment it.
1661 nil nil bullet))
1662 ;; Unordered bullet: leave it.
1666 "Verify and correct bullets in STRUCT.
1667 PREVS is the alist of previous items, as returned by
1668 `org-list-prevs-alist'.
1670 This function modifies STRUCT."
1674 ;; Set bullet of ITEM in STRUCT, depending on the type of
1675 ;; first item of the list, the previous bullet and counter
1676 ;; if any.
1685 item struct
1688 ;; Alpha counter in alpha list: use counter.
1692 ;; Use cond to be sure `string-match' is used in
1693 ;; both cases.
1699 ;; Num counter in a num list: use counter.
1704 ;; No counter: increase, if needed, previous bullet.
1707 ;; Alpha counter at first item: use counter.
1716 ;; Num counter at first item: use counter.
1721 ;; First bullet is alpha uppercase: use "A".
1724 ;; First bullet is alpha lowercase: use "a".
1727 ;; First bullet is num: use "1".
1730 ;; Not an ordered list: keep bullet.
1735 "Verify and correct indentation in STRUCT.
1737 PARENTS is the alist of parents, as returned by
1738 `org-list-parents-alist'.
1740 If numeric optional argument BULLET-SIZE is set, assume all
1741 bullets in list have this length to determine new indentation.
1743 This function modifies STRUCT."
1750 ;; Indent like parent + length of parent's bullet +
1751 ;; sub-list offset.
1757 org-list-indent-offset))
1758 ;; If no parent, indent like top-point.
1763 "Verify and correct checkboxes in STRUCT.
1765 PARENTS is the alist of parents and PREVS is the alist of
1766 previous items, as returned by, respectively,
1767 `org-list-parents-alist' and `org-list-prevs-alist'.
1769 If ORDERED is non-nil, a checkbox can only be checked when every
1770 checkbox before it is checked too. If there was an attempt to
1771 break this rule, the function will return the blocking item. In
1772 all others cases, the return value will be nil.
1774 This function modifies STRUCT."
1784 item struct
1790 ;; Parent has no boxed child: leave box as-is.
1792 parent-list)
1793 ;; 1. List all parents with a checkbox.
1800 all-items)
1801 ;; 2. Sort those parents by decreasing indentation.
1806 ;; 3. For each parent, get all children's checkboxes to determine
1807 ;; and set its checkbox accordingly.
1809 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1814 ;; There are boxes checked after an unchecked one: fix that.
1821 ;; Verify once again the structure, without ORDERED.
1823 ;; Return blocking item.
1827 "Verify and correct each item end position in STRUCT.
1829 This function modifies STRUCT."
1836 ;; To determine real ind of an ending position that is
1837 ;; not at an item, we have to find the item it belongs
1838 ;; to: it is the last item (ITEM-UP), whose ending is
1839 ;; further than the position we're interested in.
1842 ;; Else part is for the bottom point.
1844 end-pos)
1845 end-list)))
1848 struct)
1853 "Apply set difference between STRUCT and OLD-STRUCT to the buffer.
1855 OLD-STRUCT is the structure before any modifications, and STRUCT
1856 the structure to be applied. The function will only modify parts
1857 of the list which have changed.
1859 Initial position of cursor is restored after the changes."
1866 ;; Shift the indentation between END and BEG by DELTA. If
1867 ;; MAX-IND is non-nil, ensure that no line will be indented
1868 ;; more than that number. Start from the line before END.
1877 ;; Skip inline tasks.
1880 ;; Shift only non-empty lines.
1888 ;; Replace ITEM first line elements with new elements from
1889 ;; STRUCT, if appropriate.
1899 ;; a. Replace bullet
1902 ;; b. Replace checkbox.
1913 ;; c. Indent item to appropriate column.
1918 ;; 1. First get list of items and position endings. We maintain
1919 ;; two alists: ITM-SHIFT, determining indentation shift needed
1920 ;; at item, and END-LIST, a pseudo-alist where key is ending
1921 ;; position and value point.
1934 ;; To determine real ind of an ending position that
1935 ;; is not at an item, we have to find the item it
1936 ;; belongs to: it is the last item (ITEM-UP), whose
1937 ;; ending is further than the position we're
1938 ;; interested in.
1942 ;; 2. Slice the items into parts that should be shifted by the
1943 ;; same amount of indentation. Each slice follow the pattern
1944 ;; (END BEG DELTA MAX-IND-OR-NIL). Slices are returned in
1945 ;; reverse order.
1948 '<))
1955 ;; If we're not at an item, there's a child of the item
1956 ;; point belongs to above. Make sure this slice isn't
1957 ;; moved within that child by specifying a maximum
1958 ;; indentation.
1962 org-list-indent-offset))))
1964 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1965 ;; end to beginning. Take a special action when beginning is
1966 ;; at item bullet.
1974 ;; 4. Go back to initial position and clean marker.
1979 "Correct bullets, checkboxes and indentation in list at point.
1981 STRUCT is the list structure. PARENTS is the alist of parents,
1982 as returned by `org-list-parents-alist'.
1984 When non-nil, optional argument OLD-STRUCT is the reference
1985 structure of the list. It should be provided whenever STRUCT
1986 doesn't correspond anymore to the real list in buffer."
1987 ;; Order of functions matters here: checkboxes and endings need
1988 ;; correct indentation to be set, and indentation needs correct
1989 ;; bullets.
1990 ;;
1991 ;; 0. Save a copy of structure before modifications
1993 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1994 ;; order to get items endings and bullets properly
1996 ;; 2. Fix each item end to get correct prevs alist.
1998 ;; 3. Get bullets right.
2001 ;; 4. Now get real indentation.
2003 ;; 5. Eventually fix checkboxes.
2005 ;; 6. Apply structure modifications to buffer.
2009 \f
2010 ;;; Misc Tools
2013 "Call FUNCTION on each item of the list at point.
2014 FUNCTION must be called with at least one argument: INIT-VALUE,
2015 that will contain the value returned by the function at the
2016 previous item, plus ARGS extra arguments.
2018 FUNCTION is applied on items in reverse order.
2020 As an example, \(org-apply-on-list \(lambda \(result\) \(1+ result\)\) 0\)
2021 will return the number of items in the current list.
2023 Sublists of the list are skipped. Cursor is always at the
2024 beginning of the item."
2036 value))
2039 "Set visibility of ITEM in STRUCT to VIEW.
2041 Possible values are: `folded', `children' or `subtree'. See
2042 `org-cycle' for more information."
2046 ;; Hide from eol
2048 item-end t)))
2050 ;; First show everything.
2052 ;; Then fold every child.
2057 children)))
2059 ;; Show everything
2064 "Return column at which body of ITEM should start."
2074 tcol))
2077 \f
2078 ;;; Interactive functions
2083 "Go to the beginning of the current item.
2084 Throw an error when not in a list."
2090 "Go to the beginning item of the current list or sublist.
2091 Throw an error when not in a list."
2102 "Go to the end of the current list or sublist.
2103 Throw an error when not in a list."
2114 "Go to the end of the current item.
2115 Throw an error when not in a list."
2125 "Move to the beginning of the previous item.
2126 Throw an error when not in a list. Also throw an error when at
2127 first item, unless `org-list-use-circular-motion' is non-nil."
2143 "Move to the beginning of the next item.
2144 Throw an error when not in a list. Also throw an error when at
2145 last item, unless `org-list-use-circular-motion' is non-nil."
2161 "Move the item at point down, i.e. swap with following item.
2162 Sub-items (items with larger indentation) are considered part of
2163 the item, so this really moves item trees."
2182 "Move the item at point up, i.e. swap with previous item.
2183 Sub-items (items with larger indentation) are considered part of
2184 the item, so this really moves item trees."
2201 "Insert a new item at the current level.
2202 If cursor is before first character after bullet of the item, the
2203 new item will be created before the current one.
2205 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2207 Return t when things worked, nil when we are not in an item, or
2208 item is invisible."
2211 ;; If cursor isn't is a list or if list is invisible, return nil.
2219 ;; Timer list: delegate to `org-timer-item'.
2224 ;; If we're in a description list, ask for the new term.
2238 t)))))
2241 "Fix indentation, bullets and checkboxes is the list at point."
2249 "Cycle through the different itemize/enumerate bullets.
2250 This cycle the entire list level through the sequence:
2252 `-' -> `+' -> `*' -> `1.' -> `1)'
2254 If WHICH is a valid string, use that as the new bullet. If WHICH
2255 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2256 `previous', cycle backwards."
2276 ;; Compute list of possible bullets, depending on context.
2279 ;; *-bullets are not allowed at column 0.
2281 ;; Description items cannot be numbered.
2304 ;; Use a short variation of `org-list-write-struct' as there's
2305 ;; no need to go through all the steps.
2313 "Toggle the checkbox in the current line.
2314 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2315 double prefix, set checkbox to [-].
2317 When there is an active region, toggle status or presence of the
2318 first checkbox there, and make every item inside have the same
2319 status or presence, respectively.
2321 If the cursor is in a headline, apply this to all checkbox items
2322 in the text below the heading, taking as reference the first item
2323 in subtree, ignoring drawers."
2327 block-item
2328 lim-up
2329 lim-down
2340 ;; In a region, start at first item in region.
2350 ;; On an heading, start at first item after drawers and
2351 ;; time-stamps (scheduled, etc.).
2362 ;; Just one item: set SINGLEP flag.
2368 ;; Determine the checkbox going to be applied to all items
2369 ;; within bounds.
2380 ;; When an item is found within bounds, grab the full list at
2381 ;; point structure, then: (1) set check-box of all its items
2382 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2383 ;; whole list, (3) move point after the list.
2397 e struct
2398 ;; If there is no box at item, leave as-is
2399 ;; unless function was called with C-u prefix.
2402 ref-checkbox
2403 cur-box))))
2404 items-to-toggle)
2406 struct parents prevs orderedp))
2407 ;; Report some problems due to ORDERED status of subtree.
2408 ;; If only one box was being checked, throw an error, else,
2409 ;; only signal problems.
2413 "Checkbox blocked because of unchecked box at line %d"
2417 "Checkboxes were removed due to unchecked box at line %d"
2426 "Reset all checkboxes in an entry subtree."
2443 "Update the checkbox statistics in the current section.
2444 This will find all statistic cookies like [57%] and [6/12] and
2445 update them with the current numbers.
2447 With optional prefix argument ALL, do this for the whole buffer."
2451 (box-re "^[ \t]*\\([-+*]\\|\\([0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2463 ;; Return number of checked boxes and boxes of all types
2464 ;; in all structures in STRUCTS. If RECURSIVEP is
2465 ;; non-nil, also count boxes in sub-lists. If ITEM is
2466 ;; nil, count across the whole structure, else count only
2467 ;; across subtree whose ancestor is ITEM.
2484 items))))
2487 structs)
2490 cookies-list structs-bak box-num)
2492 ;; 1. Build an alist for each cookie found within BOUNDS. The
2493 ;; key will be position at beginning of cookie and values
2494 ;; ending position, format of cookie, and a cell whose car is
2495 ;; number of checked boxes to report, and cdr total number of
2496 ;; boxes.
2506 ;; Cookie is at an heading, but specifically for todo,
2507 ;; not for checkboxes: skip it.
2513 ;; Cookie is at an heading, but all lists before next
2514 ;; heading already have been read. Use data collected
2515 ;; in STRUCTS-BAK. This should only happen when
2516 ;; heading has more than one cookie on it.
2519 backup-end))
2521 ;; Cookie is at a fresh heading. Grab structure of
2522 ;; every list containing a checkbox between point and
2523 ;; next headline, and save them in STRUCTS-BAK.
2527 structs-bak nil)
2534 ;; Cookie is at an item, and we already have list
2535 ;; structure stored in STRUCTS-BAK.
2538 ;; Only lists in no special context are stored.
2541 ;; Cookie is at an item, but we need to compute list
2542 ;; structure.
2548 ;; Else, cookie found is at a wrong place. Skip it.
2550 cookies-list))))
2551 ;; 2. Apply alist to buffer, in reverse order so positions stay
2552 ;; unchanged after cookie modifications.
2567 cookies-list))))
2570 "Select the face for checkbox statistics.
2571 The face will be `org-done' when all relevant boxes are checked.
2572 Otherwise it will be `org-todo'."
2575 'org-checkbox-statistics-done
2579 'org-checkbox-statistics-done
2583 "Update checkbox statistics unless turned off by user.
2584 With an optional argument ALL, update them in the whole buffer."
2592 "Indent a local list item including its children.
2593 When number ARG is a negative, item will be outdented, otherwise
2594 it will be indented.
2596 If a region is active, all items inside will be moved.
2598 If NO-SUBTREE is non-nil, only indent the item itself, not its
2599 children.
2601 STRUCT is the list structure.
2603 Return t if successful."
2611 ;; Are we going to move the whole list?
2619 t))))
2620 ;; Determine begin and end points of zone to indent. If moving
2621 ;; more than one item, save them for subsequent moves.
2637 ;; Special case: moving top-item with indent rule.
2645 ;; Change bullet if necessary.
2651 ;; Shift every item by OFFSET and fix bullets. Then
2652 ;; apply changes to buffer.
2656 struct)
2659 ;; Forbidden move:
2661 ;; If only one item is moved, it mustn't have a child.
2665 ;; If a subtree or region is moved, the last item
2666 ;; of the subtree mustn't have a child.
2671 struct)))))
2674 ;; Normal shifting
2682 t)
2685 "Outdent a local list item, but not its children.
2686 If a region is active, all items inside will be moved."
2702 "Indent a local list item, but not its children.
2703 If a region is active, all items inside will be moved."
2719 "Outdent a local list item including its children.
2720 If a region is active, all items inside will be moved."
2736 "Indent a local list item including its children.
2737 If a region is active, all items inside will be moved."
2754 "Cycle levels of indentation of an empty item.
2755 The first run indents the item, if applicable. Subsequent runs
2756 outdent it at meaningful levels in the list. When done, item is
2757 put back at its original position with its original bullet.
2759 Return t at each successful move."
2765 ;; Accept empty items or if cycle has already started.
2776 ;; When in the middle of the cycle, try to outdent first. If
2777 ;; it fails, and point is still at initial position, indent.
2778 ;; Else, re-create it at its original position.
2787 ;; Break cycle
2789 ;; If a cycle is starting, remember indentation and bullet,
2790 ;; then try to indent. If it fails, try to outdent.
2796 t))))
2799 "Sort list items.
2800 The cursor may be at any item of the list that should be sorted.
2801 Sublists are not sorted. Checkboxes, if any, are ignored.
2803 Sorting can be alphabetically, numerically, by date/time as given
2804 by a time stamp, by a property or by priority.
2806 Comparing entries ignores case by default. However, with an
2807 optional argument WITH-CASE, the sorting considers case as well.
2809 The command prompts for the sorting type unless it has been given
2810 to the function through the SORTING-TYPE argument, which needs to
2811 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F ?x ?X). Here is the
2812 detailed meaning of each character:
2814 n Numerically, by converting the beginning of the item to a number.
2815 a Alphabetically. Only the first line of item is checked.
2816 t By date/time, either the first active time stamp in the entry, if
2817 any, or by the first inactive one. In a timer list, sort the timers.
2820 Capital letters will reverse the sort order.
2822 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2823 a function to be called with point at the beginning of the
2824 record. It must return either a string or a number that should
2825 serve as the sorting key for that record. It will then use
2826 COMPARE-FUNC to compare entries.
2828 Sorting is done against the visible part of the headlines, it
2829 ignores hidden links."
2880 ;; If it is a timer list, convert timer to seconds
2897 value))
2901 next-record
2902 end-record
2903 value-to-sort
2904 nil
2905 sort-func)
2906 ;; Read and fix list again, as `sort-subr' probably destroyed
2907 ;; its structure.
2913 \f
2914 ;;; Send and receive lists
2917 "Parse the list at point and maybe DELETE it.
2919 Return a list whose car is a symbol of list type, among
2920 `ordered', `unordered' and `descriptive'. Then, each item is
2921 a list whose car is counter, and cdr are strings and other
2922 sub-lists. Inside strings, check-boxes are replaced by
2925 For example, the following list:
2927 1. first item
2928 + sub-item one
2929 + [X] sub-item two
2930 more text in first item
2931 2. [@3] last item
2933 will be parsed as:
2935 \(ordered
2937 \(unordered
2943 Point is left at list end."
2949 out
2950 parse-item ; for byte-compiler
2953 ;; Return text between BEG and END, trimmed, with
2954 ;; checkboxes replaced.
2965 text)))))
2968 ;; Return a list whose car is list type and cdr a list of
2969 ;; items' body.
2975 ;; Return a list containing counter of item, if any, text
2976 ;; and any sublist inside it.
2982 ;; Get counter number. For alphabetic counter, get
2983 ;; its position in the alphabet.
2994 ;; If item has a child, store text between bullet and
2995 ;; next child, then recursively parse all sublists. At
2996 ;; the end of each sublist, check for the presence of
2997 ;; text belonging to the original item.
3007 ;; Remove children from the list just parsed.
3009 ;; There is a chunk of text belonging to the
3010 ;; item if last child doesn't end where next
3011 ;; child starts or where item ends.
3015 body))))
3018 ;; Store output, take care of cursor position and deletion of
3019 ;; list, then return output.
3026 out))
3029 "Convert the plain list at point into a subtree."
3037 "Insert a radio list template appropriate for this major mode."
3041 name pos)
3052 "Send a transformed version of this list to the receiver position.
3053 With argument MAYBE, fail quietly if no transformation is defined
3054 for this list."
3076 beg txt)
3080 ;; Find the insertion place
3085 name
3099 "Trim line breaks in a list ITEM."
3103 "Convert a LIST parsed through `org-list-parse-list' to other formats.
3104 Valid parameters PARAMS are:
3106 :ustart String to start an unordered list
3107 :uend String to end an unordered list
3109 :ostart String to start an ordered list
3110 :oend String to end an ordered list
3112 :dstart String to start a descriptive list
3113 :dend String to end a descriptive list
3114 :dtstart String to start a descriptive term
3115 :dtend String to end a descriptive term
3116 :ddstart String to start a description
3117 :ddend String to end a description
3119 :splice When set to t, return only list body lines, don't wrap
3120 them into :[u/o]start and :[u/o]end. Default is nil.
3122 :istart String to start a list item.
3123 :icount String to start an item with a counter.
3124 :iend String to end a list item
3125 :isep String to separate items
3126 :lsep String to separate sublists
3127 :csep String to separate text from a sub-list
3129 :cboff String to insert for an unchecked check-box
3130 :cbon String to insert for a checked check-box
3131 :cbtrans String to insert for a check-box in transitional state
3133 :nobr Non-nil means remove line breaks in lists items.
3135 Alternatively, each parameter can also be a form returning
3136 a string. These sexp can use keywords `counter' and `depth',
3137 representing respectively counter associated to the current
3138 item, and depth of the current sub-list, starting at 0.
3139 Obviously, `counter' is only available for parameters applying to
3140 items."
3164 export-sublist ; for byte-compiler
3167 ;; Export an item ITEM of type TYPE, at DEPTH. First
3168 ;; string in item is treated in a special way as it can
3169 ;; bring extra information that needs to be processed.
3175 ;; Stick DTSTART to ISTART by
3176 ;; left-trimming the latter.
3180 istart))
3187 ;; Replace checkbox if any is found.
3195 ;; Replace line breaks if required
3197 ;; Insert descriptive term if TYPE is `descriptive'.
3206 first)))
3217 ;; Export sublist SUB at DEPTH.
3235 "Convert LIST into a LaTeX list.
3236 LIST is as string representing the list to transform, as Org
3237 syntax. Return converted list as a string."
3242 "Convert LIST into a HTML list.
3243 LIST is as string representing the list to transform, as Org
3244 syntax. Return converted list as a string."
3249 "Convert LIST into a Texinfo list.
3250 LIST is as string representing the list to transform, as Org
3251 syntax. Return converted list as a string."
3256 "Convert LIST into an Org subtree.
3257 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3258 with overruling parameters for `org-list-to-generic'."
3268 ;; Return the string for the heading, depending on depth D
3269 ;; of current sub-list.
3274 oddeven-level)
3275 ?*)
3278 list
3280 '(:splice t
3287 params))))
3291 ;;; org-list.el ends here