| blob | d97e8b44d9fb010fff60c73ba9dfe121128b521b |
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."
241 "Non-nil means apply set of rules when acting on lists.
242 By default, automatic actions are taken when using
247 rules by setting them to nil. Valid rules are:
249 checkbox when non-nil, checkbox statistics is updated each time
250 you either insert a new checkbox or toggle a checkbox.
251 indent when non-nil, indenting or outdenting list top-item
252 with its subtree will move the whole list and
253 outdenting a list whose bullet is * to column 0 will
258 :key-type
262 :value-type
266 "Non-nil means commands implying motion in lists should be cyclic.
268 In that case, the item following the last item is the first one,
269 and the item preceding the first item is the last one.
279 "Hook that is run whenever Org thinks checkbox statistics should be updated.
280 This hook runs even if checkbox rule in
281 `org-list-automatic-rules' does not apply, so it can be used to
282 implement alternative ways of collecting statistics
286 "Non-nil means checkbox statistics counts only the state of direct children.
287 When nil, all boxes below the cookie are counted.
288 This can be set to nil on a per-node basis using a COOKIE_DATA property
294 "Maximum indentation for the second line of a description list.
295 When the indentation would be larger than this, it will become
296 5 characters instead."
301 "Additional indentation for sub-items in a list.
302 By setting this to a small number, usually 1 or 2, one can more
303 clearly distinguish sub-items in a list."
310 % END RECEIVE ORGLST %n
312 #+ORGLST: SEND %n org-list-to-latex
313 -
316 @c END RECEIVE ORGLST %n
317 @ignore
318 #+ORGLST: SEND %n org-list-to-texinfo
319 -
322 <!-- END RECEIVE ORGLST %n -->
323 <!--
324 #+ORGLST: SEND %n org-list-to-html
325 -
327 "Templates for radio lists in different major modes.
328 All occurrences of %n in a template will be replaced with the name of the
329 list, obtained by prompting the user."
337 "Names of blocks where lists are not allowed.
341 "Context types where lists will be interpreted during export.
343 Valid types are `drawer', `inlinetask' and `block'. More
344 specifically, type `block' is determined by the variable
348 \f
349 ;;; Predicates and regexps
353 "Regex corresponding to the end of a list.
361 "Matches a list item and puts everything into groups:
362 group 1: bullet
363 group 2: counter
364 group 3: checkbox
368 "Return the correct regular expression for plain lists."
379 "Regexp matching the beginning of a plain list item."
383 "Is point at a list item with REGEXP after bullet?"
392 ;; Ignore counter if any
397 "Is point in a context where lists are allowed?"
401 "Return item beginning position when in a plain list, nil otherwise."
413 ;; Indentation isn't meaningful when point starts at an empty
414 ;; line or an inline task.
417 10000
423 ;; Detect if cursor in amidst `org-list-end-re'. First, count
424 ;; number HL of hard lines it takes, then call `org-in-regexp'
425 ;; to compute its boundaries END-BOUNDS. When point is
426 ;; in-between, move cursor before regexp beginning.
437 ;; Look for an item, less indented that reference line.
442 ;; This is exactly what we want.
445 ;; At upper bound of search or looking at the end of a
446 ;; previous list: search is over.
449 ;; Skip blocks, drawers, inline-tasks, blank lines
459 ;; Text at column 0 cannot belong to a list: stop.
461 ;; Normal text less indented than reference line, take
462 ;; it as new reference.
469 "Is point in a line starting a hand-formatted item?"
475 "Is point at the bullet of a plain list item?"
481 "Is point at a line starting a plain list item with a timer?"
486 "Is point at a description list item?"
490 "Is point at a line starting a plain-list item with a checklet?"
494 "Is point at a line starting a plain-list item with a counter?"
500 \f
501 ;;; Structures and helper functions
504 "Determine context, and its boundaries, around point.
506 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
507 are boundaries and CONTEXT is a symbol among `drawer', `block',
508 `invalid', `inlinetask' and nil.
510 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
516 ;; Get positions of surrounding headings. This is the
517 ;; default context.
522 ;; Is point inside a drawer?
524 ;; Can't use org-drawers-regexp as this function might
525 ;; be called in buffers not in Org mode.
536 lim-down))
539 ;; Is point strictly in a block, and of which type?
550 lim-down))
556 ;; Is point in an inlinetask?
569 ;; Return context boundaries and type.
573 "Return structure of list at point.
575 A list structure is an alist where key is point at item, and
576 values are:
577 1. indentation,
578 2. bullet with trailing whitespace,
579 3. bullet counter, if any,
580 4. checkbox, if any,
581 5. description tag, if any,
582 6. position at item end.
584 Thus the following list, where numbers in parens are
585 point-at-bol:
587 - [X] first item (1)
588 1. sub-item 1 (18)
589 5. [@5] sub-item 2 (34)
590 some other text belonging to first item (55)
591 - last item (97)
592 + tag :: description (109)
593 (131)
595 will get the following structure:
603 Assume point is at an item."
618 ind itm-lst itm-lst-2 end-lst end-lst-2 struct
621 ;; Return association at point.
626 ind
627 bullet
630 ;; Description tag.
635 ;; Ensure list ends at the first blank line.
639 ;; 1. Read list from starting item to its beginning, and save
640 ;; top item position and indentation in BEG-CELL. Also store
641 ;; ending position of items in END-LST.
649 ;; At upward limit: if we ended at an item, store it,
650 ;; else dismiss useless data recorded above BEG-CELL.
651 ;; Jump to part 2.
659 ;; At a verbatim block, go before its beginning. Move
660 ;; from eol to ensure `previous-single-property-change'
661 ;; will return a value.
666 ;; Looking at a list ending regexp. Dismiss useless
667 ;; data recorded above BEG-CELL. Jump to part 2.
672 ;; Point is at an item. Add data to ITM-LST. It may
673 ;; also end a previous item: save it in END-LST. If
674 ;; ind is less or equal than BEG-CELL and there is no
675 ;; end at this ind or lesser, this item becomes the new
676 ;; BEG-CELL.
682 ;; Skip blocks, drawers, inline tasks, blank lines.
693 ;; From there, point is not at an item. Interpret
694 ;; line's indentation:
695 ;; - text at column 0 is necessarily out of any list.
696 ;; Dismiss data recorded above BEG-CELL. Jump to
697 ;; part 2.
698 ;; - any other case may be an ending position for an
699 ;; hypothetical item above. Store it and proceed.
708 ;; 2. Read list from starting point to its end, that is until we
709 ;; get out of context, or that a non-item line is less or
710 ;; equally indented than BEG-CELL's cdr. Also, store ending
711 ;; position of items in END-LST-2.
718 ;; At downward limit: this is de facto the end of the
719 ;; list. Save point as an ending position, and jump to
720 ;; part 3.
723 ;; At a verbatim block, move to its end. Point is at bol
724 ;; and 'org-example property is set by whole lines:
725 ;; `next-single-property-change' always return a value.
729 ;; Looking at a list ending regexp. Save point as an
730 ;; ending position and jump to part 3.
734 ;; Point is at an item. Add data to ITM-LST-2. It may
735 ;; also end a previous item, so save it in END-LST-2.
739 ;; Skip inline tasks and blank lines along the way
744 ;; Ind is lesser or equal than BEG-CELL's. The list is
745 ;; over: store point as an ending position and jump to
746 ;; part 3.
750 ;; Else, if ind is lesser or equal than previous item's,
751 ;; this is an ending position: store it. In any case,
752 ;; skip block or drawer at point, and move to next line.
764 ;; 3. Associate each item to its end position.
766 ;; 4. Return STRUCT
767 struct)))
770 "Associate proper ending point to items in STRUCT.
772 END-LIST is a pseudo-alist where car is indentation and cdr is
773 ending position.
775 This function modifies STRUCT."
781 ;; Remove end candidates behind current item.
784 ;; Add end position to item assoc.
790 struct)))
793 "Return alist between item and previous item in STRUCT."
795 struct)))
799 struct)))
802 "Return alist between item and parent in STRUCT."
814 ;; A sub-list is over. Find the associated
815 ;; origin in IND-TO-ORI. If it cannot be
816 ;; found (ill-formed list), set its parent as
817 ;; the first item less indented. If there is
818 ;; none, make it a top-level item.
826 ind-to-ori)
829 ;; A sub-list starts. Every item at IND will
830 ;; have previous item as its parent.
835 ;; Another item in the same sub-list: it shares
836 ;; the same parent as the previous item.
841 \f
842 ;;; Accessors
845 "Return the Nth value of KEY in STRUCT."
849 "Set the Nth value of KEY in STRUCT to NEW.
854 "Return indentation of ITEM in STRUCT."
858 "Set indentation of ITEM in STRUCT to IND.
863 "Return bullet of ITEM in STRUCT."
867 "Set bullet of ITEM in STRUCT to BULLET.
872 "Return counter of ITEM in STRUCT."
876 "Return checkbox of ITEM in STRUCT or nil."
880 "Set checkbox of ITEM in STRUCT to CHECKBOX.
885 "Return end position of ITEM in STRUCT."
889 "Return end position of ITEM in STRUCT."
893 "Return point at end of ITEM in STRUCT, before any blank line.
894 Point returned is at end of line."
901 "Return parent of ITEM or nil.
902 STRUCT is the list structure. PARENTS is the alist of parents,
903 as returned by `org-list-parents-alist'."
908 "Non-nil if ITEM has a child.
910 STRUCT is the list structure.
912 Value returned is the position of the first child of ITEM."
917 child-maybe)))
920 "Return next item in same sub-list as ITEM, or nil.
921 STRUCT is the list structure. PREVS is the alist of previous
922 items, as returned by `org-list-prevs-alist'."
926 "Return previous item in same sub-list as ITEM, or nil.
927 STRUCT is the list structure. PREVS is the alist of previous
928 items, as returned by `org-list-prevs-alist'."
932 "List all items having ITEM as a common ancestor, or nil.
933 STRUCT is the list structure."
936 subtree)
941 sub-struct))
945 "List all items in the same sub-list as ITEM.
946 STRUCT is the list structure. PREVS is the alist of previous
947 items, as returned by `org-list-prevs-alist'."
950 before-item after-item)
958 "List all children of ITEM, or nil.
959 STRUCT is the list structure. PARENTS is the alist of parents,
960 as returned by `org-list-parents-alist'."
968 "Return point at beginning of list.
969 STRUCT is the list structure."
973 "Return point at bottom of list.
974 STRUCT is the list structure."
979 "Return point at beginning of sub-list ITEM belongs.
980 STRUCT is the list structure. PREVS is the alist of previous
981 items, as returned by `org-list-prevs-alist'."
985 first-item))
990 "Return point at last item 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 last-item))
999 "Return point at end of sub-list ITEM belongs.
1000 STRUCT is the list structure. PREVS is the alist of previous
1001 items, as returned by `org-list-prevs-alist'."
1005 "Return the type of the list containing ITEM, as a symbol.
1007 STRUCT is the list structure. PREVS is the alist of previous
1008 items, as returned by `org-list-prevs-alist'.
1010 Possible types are `descriptive', `ordered' and `unordered'. The
1011 type is determined by the first item of the list."
1019 "Return ITEM's sequence number.
1021 STRUCT is the list structure. PREVS is the alist of previous
1022 items, as returned by `org-list-prevs-alist'. PARENTS is the
1023 alist of ancestors, as returned by `org-list-parents-alist'.
1025 Return value is a list of integers. Counters have an impact on
1026 that value."
1030 ;; Return relative sequence number of ITEM in the sub-list
1031 ;; it belongs. STRUCT is the list structure. PREVS is
1032 ;; the alist of previous items.
1041 seq))
1045 ;; Cons each parent relative number into return value (OUT).
1050 ;; Return value.
1051 out)))
1054 \f
1055 ;;; Searching
1058 "Search a string in valid contexts for lists.
1059 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1060 in `re-search-forward'."
1064 ;; 1. No match: return to origin or bound, depending on NOERR.
1067 nil)))
1068 ;; 2. Match in valid context: return point. Else, continue
1069 ;; searching.
1073 "Like `re-search-backward' but stop only where lists are recognized.
1074 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1075 `re-search-backward'."
1080 "Like `re-search-forward' but stop only where lists are recognized.
1081 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1082 `re-search-forward'."
1087 \f
1088 ;;; Methods on structures
1091 "Return BULLET with the correct number of whitespaces.
1092 It determines the number of whitespaces to append by looking at
1093 `org-list-two-spaces-after-bullet-regexp'."
1097 org-list-two-spaces-after-bullet-regexp bullet))
1098 " "
1104 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1106 Blank lines at the end of items are left in place. Item
1107 visibility is preserved. Return the new structure after the
1108 changes.
1110 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1111 to the same sub-list.
1113 This function modifies STRUCT."
1126 ;; Store overlays responsible for visibility status. We
1127 ;; also need to store their boundaries as they will be
1128 ;; removed from buffer.
1136 ;; 1. Move effectively items in buffer.
1140 ;; 2. Now modify struct. No need to re-read the list, the
1141 ;; transformation is just a shift of positions. Some special
1142 ;; attention is required for items ending at END-A and END-B
1143 ;; as empty spaces are not moved there. In others words,
1144 ;; item BEG-A will end with whitespaces that were at the end
1145 ;; of BEG-B and the same applies to BEG-B.
1167 struct)
1169 ;; Restore visibility status, by moving overlays to their new
1170 ;; position.
1182 ;; Return structure.
1183 struct)))
1186 "Return number of blank lines that should separate items in list.
1188 POS is the position of point where `org-list-insert-item' was called.
1190 STRUCT is the list structure. PREVS is the alist of previous
1191 items, as returned by `org-list-prevs-alist'.
1193 Assume point is at item's beginning. If the item is alone, apply
1194 some heuristics to guess the result."
1199 usr-blank
1203 ;; Count blank lines above beginning of line.
1210 ;; Trivial cases where there should be none.
1212 ;; When `org-blank-before-new-entry' says so, it is 1.
1214 ;; `plain-list-item' is 'auto. Count blank lines separating
1215 ;; neighbours items in list.
1218 ;; Is there a next item?
1221 ;; Is there a previous item?
1224 ;; User inserted blank lines, trust him.
1229 usr-blank)
1230 ;; Are there blank lines inside the list so far?
1236 ;; Default choice: no blank line.
1240 "Insert a new list item at POS and return the new structure.
1241 If POS is before first character after bullet of the item, the
1242 new item will be created before the current one.
1244 STRUCT is the list structure. PREVS is the the alist of previous
1245 items, as returned by `org-list-prevs-alist'.
1247 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1248 after the bullet. Cursor will be after this text once the
1249 function ends.
1251 This function modifies STRUCT."
1253 ;; 1. Get information about list: position of point with regards
1254 ;; to item start (BEFOREP), blank lines number separating items
1255 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1262 ;; Do not count tag in a non-descriptive list.
1270 pos struct prevs))
1271 ;; 2. Build the new item to be created. Concatenate same
1272 ;; bullet as item, checkbox, text AFTER-BULLET if
1273 ;; provided, and text cut from point to end of item
1274 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1275 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1276 ;; between what was cut and what was inserted in buffer
1277 ;; is stored in SIZE-OFFSET.
1281 ind))
1288 ;; If POS is greater than ITEM-END, then point is
1289 ;; in some white lines after the end of the list.
1290 ;; Those must be removed, or they will be left,
1291 ;; stacking up after the list.
1301 text-cut))))
1305 ;; 4. Insert effectively item into buffer.
1309 ;; 5. Add new item to STRUCT.
1313 ;; Before inserted item, positions don't change but
1314 ;; an item ending after insertion has its end shifted
1315 ;; by SIZE-OFFSET.
1318 ;; Trivial cases where current item isn't split in
1319 ;; two. Just shift every item after new one by
1320 ;; ITEM-SIZE.
1324 ;; Item is split in two: elements before POS are just
1325 ;; shifted by ITEM-SIZE. In the case item would end
1326 ;; after split POS, ending is only shifted by
1327 ;; SIZE-OFFSET.
1333 ;; Elements after POS are moved into new item.
1334 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1335 ;; doesn't appear in buffer yet.
1341 (+ end size-offset
1343 ;; Elements at ITEM-END or after are only shifted by
1344 ;; SIZE-OFFSET.
1347 struct)
1350 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1351 ;; exchange ITEM with the next item in list. Position cursor
1352 ;; after bullet, counter, checkbox, and label.
1358 struct)))
1361 "Remove ITEM from the list and return the new structure.
1363 STRUCT is the list structure."
1366 ;; If ITEM ends with the list, delete blank lines
1367 ;; before it.
1372 item)))
1373 ;; Remove item from buffer.
1375 ;; Remove item from structure and shift others items accordingly.
1376 ;; Don't forget to shift also ending position when appropriate.
1394 struct)))))
1397 "Send ITEM to destination DEST.
1399 STRUCT is the list structure.
1401 DEST can have various values.
1403 If DEST is a buffer position, the function will assume it points
1404 to another item in the same list as ITEM, and will move the
1405 latter just before the former.
1407 If DEST is `begin' (respectively `end'), ITEM will be moved at
1408 the beginning (respectively end) of the list it belongs to.
1411 be moved at the Nth position in the list.
1413 If DEST is `kill', ITEM will be deleted and its body will be
1414 added to the kill-ring.
1416 If DEST is `delete', ITEM will be deleted.
1418 Visibility of item is preserved.
1420 This function returns, destructively, the new list structure."
1423 ;; Grab full item body minus its bullet.
1432 item-end)))
1433 ;; Change DEST into a buffer position. A trick is needed
1434 ;; when ITEM is meant to be sent at the end of the list.
1435 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1436 ;; nil and insertion point (INS-POINT) to the first line's
1437 ;; end of the last item, we ensure the new item will be
1438 ;; inserted after the last item, and not after any of its
1439 ;; hypothetical sub-items.
1455 ;; Send ITEM at the end of the list.
1463 ;; Store visibility.
1473 ;; 1. Structure returned by `org-list-insert-item' may not be
1474 ;; accurate, as it cannot see sub-items included in BODY.
1475 ;; Thus, first compute the real structure so far.
1483 ;; 1.1. Remove the item just created in structure.
1485 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1488 struct
1496 new-end
1498 moved-items))
1500 ;; 2. Restore visibility.
1505 visibility)
1506 ;; 3. Eventually delete extra copy of the item and clean marker.
1512 "Outdent items between positions START and END.
1514 STRUCT is the list structure. PARENTS is the alist of items'
1515 parents, as returned by `org-list-parents-alist'.
1517 START is included, END excluded."
1523 ;; Item not yet in zone: keep association.
1525 ;; Item out of zone: follow associations in ACC.
1529 ;; Item has no parent: error
1532 ;; Parent is outdented: keep association.
1536 ;; Parent isn't outdented: reparent to grand-parent.
1538 parent struct parents)))
1544 "Indent items between positions START and END.
1546 STRUCT is the list structure. PARENTS is the alist of parents
1547 and PREVS is the alist of previous items, returned by,
1548 respectively, `org-list-parents-alist' and
1549 `org-list-prevs-alist'.
1551 START is included and END excluded.
1553 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1554 bullets between START and END."
1562 ;; Normalize ordered bullets.
1572 org-list-demote-modify-bullet))))
1579 ;; Item not yet in zone: keep association.
1582 ;; Item out of zone: follow associations in ACC.
1586 ;; Item is in zone...
1588 ;; Check if bullet needs to be changed.
1591 ;; First item indented but not parent: error
1594 ;; First item and parent indented: keep same
1595 ;; parent.
1597 ;; Previous item not indented: reparent to it.
1599 ;; Previous item indented: reparent like it.
1606 \f
1607 ;;; Repairing structures
1610 "Non-nil if list starting at FIRST can have alphabetical bullets.
1612 STRUCT is list structure. PREVS is the alist of previous items,
1613 as returned by `org-list-prevs-alist'."
1617 ;; Pretend that bullets are uppercase and check if alphabet
1618 ;; is sufficient, taking counters into account.
1622 ;; Virtually determine current bullet
1624 ;; Counters are not case-sensitive.
1627 ;; Test if bullet would be over z or Z.
1631 ;; All items checked. All good.
1632 t))))
1635 "Increment BULLET if applicable."
1638 ;; Num bullet: increment it.
1642 nil nil bullet))
1643 ;; Alpha bullet: increment it.
1647 nil nil bullet))
1648 ;; Unordered bullet: leave it.
1652 "Verify and correct bullets in STRUCT.
1653 PREVS is the alist of previous items, as returned by
1654 `org-list-prevs-alist'.
1656 This function modifies STRUCT."
1660 ;; Set bullet of ITEM in STRUCT, depending on the type of
1661 ;; first item of the list, the previous bullet and counter
1662 ;; if any.
1671 item struct
1674 ;; Alpha counter in alpha list: use counter.
1678 ;; Use cond to be sure `string-match' is used in
1679 ;; both cases.
1685 ;; Num counter in a num list: use counter.
1690 ;; No counter: increase, if needed, previous bullet.
1693 ;; Alpha counter at first item: use counter.
1702 ;; Num counter at first item: use counter.
1707 ;; First bullet is alpha uppercase: use "A".
1710 ;; First bullet is alpha lowercase: use "a".
1713 ;; First bullet is num: use "1".
1716 ;; Not an ordered list: keep bullet.
1721 "Verify and correct indentation in STRUCT.
1723 PARENTS is the alist of parents, as returned by
1724 `org-list-parents-alist'.
1726 If numeric optional argument BULLET-SIZE is set, assume all
1727 bullets in list have this length to determine new indentation.
1729 This function modifies STRUCT."
1736 ;; Indent like parent + length of parent's bullet +
1737 ;; sub-list offset.
1743 org-list-indent-offset))
1744 ;; If no parent, indent like top-point.
1749 "Verify and correct checkboxes in STRUCT.
1751 PARENTS is the alist of parents and PREVS is the alist of
1752 previous items, as returned by, respectively,
1753 `org-list-parents-alist' and `org-list-prevs-alist'.
1755 If ORDERED is non-nil, a checkbox can only be checked when every
1756 checkbox before it is checked too. If there was an attempt to
1757 break this rule, the function will return the blocking item. In
1758 all others cases, the return value will be nil.
1760 This function modifies STRUCT."
1770 item struct
1776 ;; Parent has no boxed child: leave box as-is.
1778 parent-list)
1779 ;; 1. List all parents with a checkbox.
1786 all-items)
1787 ;; 2. Sort those parents by decreasing indentation.
1792 ;; 3. For each parent, get all children's checkboxes to determine
1793 ;; and set its checkbox accordingly.
1795 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1800 ;; There are boxes checked after an unchecked one: fix that.
1805 ;; Verify once again the structure, without ORDERED.
1807 ;; Return blocking item.
1811 "Verify and correct each item end position in STRUCT.
1813 This function modifies STRUCT."
1820 ;; To determine real ind of an ending position that is
1821 ;; not at an item, we have to find the item it belongs
1822 ;; to: it is the last item (ITEM-UP), whose ending is
1823 ;; further than the position we're interested in.
1826 ;; Else part is for the bottom point.
1828 end-pos)
1829 end-list)))
1832 struct)
1837 "Apply set difference between STRUCT and OLD-STRUCT to the buffer.
1839 OLD-STRUCT is the structure before any modifications, and STRUCT
1840 the structure to be applied. The function will only modify parts
1841 of the list which have changed.
1843 Initial position of cursor is restored after the changes."
1850 ;; Shift the indentation between END and BEG by DELTA.
1851 ;; Start from the line before END.
1860 ;; Skip inline tasks.
1863 ;; Shift only non-empty lines.
1870 ;; Replace ITEM first line elements with new elements from
1871 ;; STRUCT, if appropriate.
1881 ;; a. Replace bullet
1884 ;; b. Replace checkbox.
1895 ;; c. Indent item to appropriate column.
1900 ;; 1. First get list of items and position endings. We maintain
1901 ;; two alists: ITM-SHIFT, determining indentation shift needed
1902 ;; at item, and END-POS, a pseudo-alist where key is ending
1903 ;; position and value point.
1916 ;; To determine real ind of an ending position that
1917 ;; is not at an item, we have to find the item it
1918 ;; belongs to: it is the last item (ITEM-UP), whose
1919 ;; ending is further than the position we're
1920 ;; interested in.
1924 old-struct)
1925 ;; 2. Slice the items into parts that should be shifted by the
1926 ;; same amount of indentation. The slices are returned in
1927 ;; reverse order so changes modifying buffer do not change
1928 ;; positions they refer to.
1931 '<))
1939 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1940 ;; end to beginning. Take a special action when beginning is
1941 ;; at item bullet.
1948 sliced-struct))
1949 ;; 4. Go back to initial position and clean marker.
1954 "Correct bullets, checkboxes and indentation in list at point.
1956 STRUCT is the list structure. PARENTS is the alist of parents,
1957 as returned by `org-list-parents-alist'.
1959 When non-nil, optional argument OLD-STRUCT is the reference
1960 structure of the list. It should be provided whenever STRUCT
1961 doesn't correspond anymore to the real list in buffer."
1962 ;; Order of functions matters here: checkboxes and endings need
1963 ;; correct indentation to be set, and indentation needs correct
1964 ;; bullets.
1965 ;;
1966 ;; 0. Save a copy of structure before modifications
1968 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1969 ;; order to get items endings and bullets properly
1971 ;; 2. Fix each item end to get correct prevs alist.
1973 ;; 3. Get bullets right.
1976 ;; 4. Now get real indentation.
1978 ;; 5. Eventually fix checkboxes.
1980 ;; 6. Apply structure modifications to buffer.
1984 \f
1985 ;;; Misc Tools
1988 "Call FUNCTION on each item of the list at point.
1989 FUNCTION must be called with at least one argument: INIT-VALUE,
1990 that will contain the value returned by the function at the
1991 previous item, plus ARGS extra arguments.
1993 FUNCTION is applied on items in reverse order.
1995 As an example, \(org-apply-on-list \(lambda \(result\) \(1+ result\)\) 0\)
1996 will return the number of items in the current list.
1998 Sublists of the list are skipped. Cursor is always at the
1999 beginning of the item."
2011 value))
2014 "Set visibility of ITEM in STRUCT to VIEW.
2016 Possible values are: `folded', `children' or `subtree'. See
2017 `org-cycle' for more information."
2021 ;; Hide from eol
2023 item-end t)))
2025 ;; First show everything.
2027 ;; Then fold every child.
2032 children)))
2034 ;; Show everything
2039 "Return column at which body of ITEM should start."
2049 tcol))
2052 \f
2053 ;;; Interactive functions
2058 "Go to the beginning of the current item.
2059 Throw an error when not in a list."
2065 "Go to the beginning item of the current list or sublist.
2066 Throw an error when not in a list."
2077 "Go to the end of the current list or sublist.
2078 Throw an error when not in a list."
2089 "Go to the end of the current item.
2090 Throw an error when not in a list."
2100 "Move to the beginning of the previous item.
2101 Throw an error when not in a list. Also throw an error when at
2102 first item, unless `org-list-use-circular-motion' is non-nil."
2118 "Move to the beginning of the next item.
2119 Throw an error when not in a list. Also throw an error when at
2120 last item, unless `org-list-use-circular-motion' is non-nil."
2136 "Move the item at point down, i.e. swap with following item.
2137 Sub-items (items with larger indentation) are considered part of
2138 the item, so this really moves item trees."
2157 "Move the item at point up, i.e. swap with previous item.
2158 Sub-items (items with larger indentation) are considered part of
2159 the item, so this really moves item trees."
2176 "Insert a new item at the current level.
2177 If cursor is before first character after bullet of the item, the
2178 new item will be created before the current one.
2180 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2182 Return t when things worked, nil when we are not in an item, or
2183 item is invisible."
2186 ;; If cursor isn't is a list or if list is invisible, return nil.
2194 ;; Timer list: delegate to `org-timer-item'.
2199 ;; If we're in a description list, ask for the new term.
2213 t)))))
2216 "Fix indentation, bullets and checkboxes is the list at point."
2224 "Cycle through the different itemize/enumerate bullets.
2225 This cycle the entire list level through the sequence:
2227 `-' -> `+' -> `*' -> `1.' -> `1)'
2229 If WHICH is a valid string, use that as the new bullet. If WHICH
2230 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2231 `previous', cycle backwards."
2251 ;; Compute list of possible bullets, depending on context.
2254 ;; *-bullets are not allowed at column 0.
2256 ;; Description items cannot be numbered.
2279 ;; Use a short variation of `org-list-write-struct' as there's
2280 ;; no need to go through all the steps.
2288 "Toggle the checkbox in the current line.
2289 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2290 double prefix, set checkbox to [-].
2292 When there is an active region, toggle status or presence of the
2293 first checkbox there, and make every item inside have the same
2294 status or presence, respectively.
2296 If the cursor is in a headline, apply this to all checkbox items
2297 in the text below the heading, taking as reference the first item
2298 in subtree, ignoring drawers."
2302 block-item
2303 lim-up
2304 lim-down
2315 ;; In a region, start at first item in region.
2325 ;; On an heading, start at first item after drawers and
2326 ;; time-stamps (scheduled, etc.).
2337 ;; Just one item: set SINGLEP flag.
2343 ;; Determine the checkbox going to be applied to all items
2344 ;; within bounds.
2355 ;; When an item is found within bounds, grab the full list at
2356 ;; point structure, then: (1) set check-box of all its items
2357 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2358 ;; whole list, (3) move point after the list.
2372 e struct
2373 ;; If there is no box at item, leave as-is
2374 ;; unless function was called with C-u prefix.
2377 ref-checkbox
2378 cur-box))))
2379 items-to-toggle)
2381 struct parents prevs orderedp))
2382 ;; Report some problems due to ORDERED status of subtree.
2383 ;; If only one box was being checked, throw an error, else,
2384 ;; only signal problems.
2388 "Checkbox blocked because of unchecked box at line %d"
2392 "Checkboxes were removed due to unchecked box at line %d"
2401 "Reset all checkboxes in an entry subtree."
2418 "Update the checkbox statistics in the current section.
2419 This will find all statistic cookies like [57%] and [6/12] and
2420 update them with the current numbers.
2422 With optional prefix argument ALL, do this for the whole buffer."
2426 (box-re "^[ \t]*\\([-+*]\\|\\([0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2438 ;; Return number of checked boxes and boxes of all types
2439 ;; in all structures in STRUCTS. If RECURSIVEP is
2440 ;; non-nil, also count boxes in sub-lists. If ITEM is
2441 ;; nil, count across the whole structure, else count only
2442 ;; across subtree whose ancestor is ITEM.
2459 items))))
2462 structs)
2465 cookies-list structs-bak box-num)
2467 ;; 1. Build an alist for each cookie found within BOUNDS. The
2468 ;; key will be position at beginning of cookie and values
2469 ;; ending position, format of cookie, and a cell whose car is
2470 ;; number of checked boxes to report, and cdr total number of
2471 ;; boxes.
2481 ;; Cookie is at an heading, but specifically for todo,
2482 ;; not for checkboxes: skip it.
2488 ;; Cookie is at an heading, but all lists before next
2489 ;; heading already have been read. Use data collected
2490 ;; in STRUCTS-BAK. This should only happen when
2491 ;; heading has more than one cookie on it.
2494 backup-end))
2496 ;; Cookie is at a fresh heading. Grab structure of
2497 ;; every list containing a checkbox between point and
2498 ;; next headline, and save them in STRUCTS-BAK.
2502 structs-bak nil)
2509 ;; Cookie is at an item, and we already have list
2510 ;; structure stored in STRUCTS-BAK.
2513 ;; Only lists in no special context are stored.
2516 ;; Cookie is at an item, but we need to compute list
2517 ;; structure.
2523 ;; Else, cookie found is at a wrong place. Skip it.
2525 cookies-list))))
2526 ;; 2. Apply alist to buffer, in reverse order so positions stay
2527 ;; unchanged after cookie modifications.
2542 cookies-list))))
2545 "Select the face for checkbox statistics.
2546 The face will be `org-done' when all relevant boxes are checked.
2547 Otherwise it will be `org-todo'."
2550 'org-checkbox-statistics-done
2554 'org-checkbox-statistics-done
2558 "Update checkbox statistics unless turned off by user.
2559 With an optional argument ALL, update them in the whole buffer."
2567 "Indent a local list item including its children.
2568 When number ARG is a negative, item will be outdented, otherwise
2569 it will be indented.
2571 If a region is active, all items inside will be moved.
2573 If NO-SUBTREE is non-nil, only indent the item itself, not its
2574 children.
2576 STRUCT is the list structure.
2578 Return t if successful."
2586 ;; Are we going to move the whole list?
2594 t))))
2595 ;; Determine begin and end points of zone to indent. If moving
2596 ;; more than one item, save them for subsequent moves.
2612 ;; Special case: moving top-item with indent rule.
2620 ;; Change bullet if necessary.
2626 ;; Shift every item by OFFSET and fix bullets. Then
2627 ;; apply changes to buffer.
2631 struct)
2634 ;; Forbidden move:
2636 ;; If only one item is moved, it mustn't have a child.
2640 ;; If a subtree or region is moved, the last item
2641 ;; of the subtree mustn't have a child.
2646 struct)))))
2649 ;; Normal shifting
2657 t)
2660 "Outdent a local list item, but not its children.
2661 If a region is active, all items inside will be moved."
2677 "Indent a local list item, but not its children.
2678 If a region is active, all items inside will be moved."
2694 "Outdent a local list item including its children.
2695 If a region is active, all items inside will be moved."
2711 "Indent a local list item including its children.
2712 If a region is active, all items inside will be moved."
2729 "Cycle levels of indentation of an empty item.
2730 The first run indents the item, if applicable. Subsequent runs
2731 outdent it at meaningful levels in the list. When done, item is
2732 put back at its original position with its original bullet.
2734 Return t at each successful move."
2740 ;; Accept empty items or if cycle has already started.
2751 ;; When in the middle of the cycle, try to outdent first. If
2752 ;; it fails, and point is still at initial position, indent.
2753 ;; Else, re-create it at its original position.
2762 ;; Break cycle
2764 ;; If a cycle is starting, remember indentation and bullet,
2765 ;; then try to indent. If it fails, try to outdent.
2771 t))))
2774 "Sort list items.
2775 The cursor may be at any item of the list that should be sorted.
2776 Sublists are not sorted. Checkboxes, if any, are ignored.
2778 Sorting can be alphabetically, numerically, by date/time as given
2779 by a time stamp, by a property or by priority.
2781 Comparing entries ignores case by default. However, with an
2782 optional argument WITH-CASE, the sorting considers case as well.
2784 The command prompts for the sorting type unless it has been given
2785 to the function through the SORTING-TYPE argument, which needs to
2786 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
2787 meaning of each character:
2789 n Numerically, by converting the beginning of the item to a number.
2790 a Alphabetically. Only the first line of item is checked.
2791 t By date/time, either the first active time stamp in the entry, if
2792 any, or by the first inactive one. In a timer list, sort the timers.
2794 Capital letters will reverse the sort order.
2796 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2797 a function to be called with point at the beginning of the
2798 record. It must return either a string or a number that should
2799 serve as the sorting key for that record. It will then use
2800 COMPARE-FUNC to compare entries."
2847 ;; If it is a timer list, convert timer to seconds
2860 value))
2864 next-record
2865 end-record
2866 value-to-sort
2867 nil
2868 sort-func)
2869 ;; Read and fix list again, as `sort-subr' probably destroyed
2870 ;; its structure.
2876 \f
2877 ;;; Send and receive lists
2880 "Parse the list at point and maybe DELETE it.
2882 Return a list whose car is a symbol of list type, among
2883 `ordered', `unordered' and `descriptive'. Then, each item is
2884 a list whose car is counter, and cdr are strings and other
2885 sub-lists. Inside strings, check-boxes are replaced by
2888 For example, the following list:
2890 1. first item
2891 + sub-item one
2892 + [X] sub-item two
2893 more text in first item
2894 2. [@3] last item
2896 will be parsed as:
2898 \(ordered
2900 \(unordered
2906 Point is left at list end."
2912 out
2913 parse-item ; for byte-compiler
2916 ;; Return text between BEG and END, trimmed, with
2917 ;; checkboxes replaced.
2928 text)))))
2931 ;; Return a list whose car is list type and cdr a list of
2932 ;; items' body.
2938 ;; Return a list containing counter of item, if any, text
2939 ;; and any sublist inside it.
2945 ;; Get counter number. For alphabetic counter, get
2946 ;; its position in the alphabet.
2957 ;; If item has a child, store text between bullet and
2958 ;; next child, then recursively parse all sublists. At
2959 ;; the end of each sublist, check for the presence of
2960 ;; text belonging to the original item.
2970 ;; Remove children from the list just parsed.
2972 ;; There is a chunk of text belonging to the
2973 ;; item if last child doesn't end where next
2974 ;; child starts or where item ends.
2978 body))))
2981 ;; Store output, take care of cursor position and deletion of
2982 ;; list, then return output.
2989 out))
2992 "Convert the plain list at point into a subtree."
3000 "Insert a radio list template appropriate for this major mode."
3004 name pos)
3015 "Send a transformed version of this list to the receiver position.
3016 With argument MAYBE, fail quietly if no transformation is defined
3017 for this list."
3023 (unless (looking-at "[ \t]*#\\+ORGLST[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
3042 beg txt)
3046 ;; Find the insertion place
3051 name
3065 "Trim line breaks in a list ITEM."
3069 "Convert a LIST parsed through `org-list-parse-list' to other formats.
3070 Valid parameters PARAMS are:
3072 :ustart String to start an unordered list
3073 :uend String to end an unordered list
3075 :ostart String to start an ordered list
3076 :oend String to end an ordered list
3078 :dstart String to start a descriptive list
3079 :dend String to end a descriptive list
3080 :dtstart String to start a descriptive term
3081 :dtend String to end a descriptive term
3082 :ddstart String to start a description
3083 :ddend String to end a description
3085 :splice When set to t, return only list body lines, don't wrap
3086 them into :[u/o]start and :[u/o]end. Default is nil.
3088 :istart String to start a list item.
3089 :icount String to start an item with a counter.
3090 :iend String to end a list item
3091 :isep String to separate items
3092 :lsep String to separate sublists
3093 :csep String to separate text from a sub-list
3095 :cboff String to insert for an unchecked check-box
3096 :cbon String to insert for a checked check-box
3097 :cbtrans String to insert for a check-box in transitional state
3099 :nobr Non-nil means remove line breaks in lists items.
3101 Alternatively, each parameter can also be a form returning
3102 a string. These sexp can use keywords `counter' and `depth',
3103 representing respectively counter associated to the current
3104 item, and depth of the current sub-list, starting at 0.
3105 Obviously, `counter' is only available for parameters applying to
3106 items."
3130 export-sublist ; for byte-compiler
3133 ;; Export an item ITEM of type TYPE, at DEPTH. First
3134 ;; string in item is treated in a special way as it can
3135 ;; bring extra information that needs to be processed.
3141 ;; Stick DTSTART to ISTART by
3142 ;; left-trimming the latter.
3146 istart))
3153 ;; Replace checkbox if any is found.
3161 ;; Replace line breaks if required
3163 ;; Insert descriptive term if TYPE is `descriptive'.
3172 first)))
3183 ;; Export sublist SUB at DEPTH.
3201 "Convert LIST into a LaTeX list.
3202 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3203 with overruling parameters for `org-list-to-generic'."
3205 list
3214 ;; LaTeX increments counter just before
3215 ;; using it, so set it to the desired
3216 ;; value, minus one.
3223 params)))
3226 "Convert LIST into a HTML list.
3227 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3228 with overruling parameters for `org-list-to-generic'."
3230 list
3242 params)))
3245 "Convert LIST into a Texinfo list.
3246 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3247 with overruling parameters for `org-list-to-generic'."
3249 list
3260 params)))
3263 "Convert LIST into an Org subtree.
3264 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3265 with overruling parameters for `org-list-to-generic'."
3275 ;; Return the string for the heading, depending on depth D
3276 ;; of current sub-list.
3281 oddeven-level)
3282 ?*)
3285 list
3287 '(:splice t
3294 params))))
3298 ;;; org-list.el ends here