| blob | 4498280ac771b28c05b04b482f561bd379c33a37 |
1 ;;; org-list.el --- Plain lists for Org-mode
2 ;;
3 ;; Copyright (C) 2004-2012 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Bastien Guerry <bzg AT gnu DOT org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;;
10 ;; This file is part of GNU Emacs.
11 ;;
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
25 ;;
26 ;;; Commentary:
28 ;; This file contains the code dealing with plain lists in Org-mode.
30 ;; The core concept behind lists is their structure. A structure is
31 ;; a snapshot of the list, in the shape of a data tree (see
32 ;; `org-list-struct').
34 ;; Once the list structure is stored, it is possible to make changes
35 ;; on it that will be mirrored to the real list or to get information
36 ;; about the list, using accessors and methods provided in the
37 ;; library. Most of them require the use of one or two helper
38 ;; functions, namely `org-list-parents-alist' and
39 ;; `org-list-prevs-alist'.
41 ;; Structure is eventually applied to the buffer with
42 ;; `org-list-write-struct'. This function repairs (bullets,
43 ;; indentation, checkboxes) the list in the process. It should be
44 ;; called near the end of any function working on structures.
46 ;; Thus, a function applying to lists should usually follow this
47 ;; template:
49 ;; 1. Verify point is in a list and grab item beginning (with the same
50 ;; function `org-in-item-p'). If the function requires the cursor
51 ;; to be at item's bullet, `org-at-item-p' is more selective. It
52 ;; is also possible to move point to the closest item with
53 ;; `org-list-search-backward', or `org-list-search-forward',
54 ;; applied to the function `org-item-beginning-re'.
56 ;; 2. Get list structure with `org-list-struct'.
58 ;; 3. Compute one, or both, helper functions,
59 ;; (`org-list-parents-alist', `org-list-prevs-alist') depending on
60 ;; needed accessors.
62 ;; 4. Proceed with the modifications, using methods and accessors.
64 ;; 5. Verify and apply structure to buffer, using
65 ;; `org-list-write-struct'.
67 ;; 6. If changes made to the list might have modified check-boxes,
68 ;; call `org-update-checkbox-count-maybe'.
70 ;; Computing a structure can be a costly operation on huge lists (a
71 ;; few thousand lines long). Thus, code should follow the rule:
72 ;; "collect once, use many". As a corollary, it is usually a bad idea
73 ;; to use directly an interactive function inside the code, as those,
74 ;; being independent entities, read the whole list structure another
75 ;; time.
77 ;;; Code:
132 \f
133 ;;; Configuration variables
136 "Options concerning plain lists in Org-mode."
141 "When t, make TAB cycle visibility on plain list items.
142 Cycling plain lists works only when the cursor is on a plain list
143 item. When the cursor is on an outline heading, plain lists are
144 treated as text. This is the most stable way of handling this,
145 which is why it is the default.
147 When this is the symbol `integrate', then during cycling, plain
148 list items will *temporarily* be interpreted as outline headlines
149 with a level given by 1000+i where i is the indentation of the
150 bullet. This setting can lead to strange effects when switching
152 subtree decides what children should be listed. If that first
154 number, all true children and grand children of the outline
155 heading will be exposed in a children' view."
163 "Default bullet type installed when demoting an item.
164 This is an association list, for each bullet type, this alist will point
165 to the bullet that should be used when this item is demoted.
166 For example,
168 (setq org-list-demote-modify-bullet
171 will make
173 + Movies
174 + Silence of the Lambs
175 + My Cousin Vinny
176 + Books
177 + The Hunt for Red October
178 + The Road to Omaha
180 into
182 + Movies
183 - Silence of the Lambs
184 - My Cousin Vinny
185 + Books
186 - The Hunt for Red October
187 - The Road to Omaha"
205 "The character that makes a line with leading number an ordered list item.
206 Valid values are ?. and ?\). To get both terminators, use t."
213 "Non-nil means single character alphabetical bullets are allowed.
214 Both uppercase and lowercase are handled. Lists with more than
215 26 items will fallback to standard numbering. Alphabetical
222 "A regular expression matching bullets that should have 2 spaces after them.
223 When nil, no bullet will have two spaces after them. When
224 a string, it will be used as a regular expression. When the
225 bullet type of a list is changed, the new bullet type will be
226 matched against this regexp. If it matches, there will be two
227 spaces instead of one after the bullet in each item of the list."
234 "Non-nil means an empty line ends all plain list levels.
235 Otherwise, two of them will be necessary."
242 "Non-nil means apply set of rules when acting on lists.
243 By default, automatic actions are taken when using
248 rules by setting them to nil. Valid rules are:
250 bullet when non-nil, cycling bullet do not allow lists at
251 column 0 to have * as a bullet and descriptions lists
252 to be numbered.
253 checkbox when non-nil, checkbox statistics is updated each time
254 you either insert a new checkbox or toggle a checkbox.
255 It also prevents from inserting a checkbox in a
256 description item.
257 indent when non-nil, indenting or outdenting list top-item
258 with its subtree will move the whole list and
259 outdenting a list whose bullet is * to column 0 will
264 :key-type
269 :value-type
273 "Non-nil means commands implying motion in lists should be cyclic.
275 In that case, the item following the last item is the first one,
276 and the item preceding the first item is the last one.
286 "Hook that is run whenever Org thinks checkbox statistics should be updated.
287 This hook runs even if checkbox rule in
288 `org-list-automatic-rules' does not apply, so it can be used to
289 implement alternative ways of collecting statistics
293 "Non-nil means checkbox statistics counts only the state of direct children.
294 When nil, all boxes below the cookie are counted.
295 This can be set to nil on a per-node basis using a COOKIE_DATA property
301 "Maximum indentation for the second line of a description list.
302 When the indentation would be larger than this, it will become
303 5 characters instead."
308 "Additional indentation for sub-items in a list.
309 By setting this to a small number, usually 1 or 2, one can more
310 clearly distinguish sub-items in a list."
317 % END RECEIVE ORGLST %n
319 #+ORGLST: SEND %n org-list-to-latex
320 -
323 @c END RECEIVE ORGLST %n
324 @ignore
325 #+ORGLST: SEND %n org-list-to-texinfo
326 -
329 <!-- END RECEIVE ORGLST %n -->
330 <!--
331 #+ORGLST: SEND %n org-list-to-html
332 -
334 "Templates for radio lists in different major modes.
335 All occurrences of %n in a template will be replaced with the name of the
336 list, obtained by prompting the user."
344 "Names of blocks where lists are not allowed.
348 "Context types where lists will be interpreted during export.
350 Valid types are `drawer', `inlinetask' and `block'. More
351 specifically, type `block' is determined by the variable
355 \f
356 ;;; Predicates and regexps
360 "Regex corresponding to the end of a list.
368 "Matches a list item and puts everything into groups:
369 group 1: bullet
370 group 2: counter
371 group 3: checkbox
375 "Return the correct regular expression for plain lists."
386 "Regexp matching the beginning of a plain list item."
390 "Is point at a list item with REGEXP after bullet?"
399 ;; Ignore counter if any
404 "Is point in a context where lists are allowed?"
408 "Return item beginning position when in a plain list, nil otherwise."
420 ;; Indentation isn't meaningful when point starts at an empty
421 ;; line or an inline task.
424 10000
430 ;; Detect if cursor in amidst `org-list-end-re'. First, count
431 ;; number HL of hard lines it takes, then call `org-in-regexp'
432 ;; to compute its boundaries END-BOUNDS. When point is
433 ;; in-between, move cursor before regexp beginning.
444 ;; Look for an item, less indented that reference line.
449 ;; This is exactly what we want.
452 ;; At upper bound of search or looking at the end of a
453 ;; previous list: search is over.
456 ;; Skip blocks, drawers, inline-tasks, blank lines
466 ;; Text at column 0 cannot belong to a list: stop.
468 ;; Normal text less indented than reference line, take
469 ;; it as new reference.
476 "Is point in a line starting a hand-formatted item?"
482 "Is point at the bullet of a plain list item?"
488 "Is point at a line starting a plain list item with a timer?"
493 "Is point at a description list item?"
497 "Is point at a line starting a plain-list item with a checklet?"
501 "Is point at a line starting a plain-list item with a counter?"
507 \f
508 ;;; Structures and helper functions
511 "Determine context, and its boundaries, around point.
513 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
514 are boundaries and CONTEXT is a symbol among `drawer', `block',
515 `invalid', `inlinetask' and nil.
517 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
523 ;; Get positions of surrounding headings. This is the
524 ;; default context.
529 ;; Is point inside a drawer?
531 ;; Can't use org-drawers-regexp as this function might
532 ;; be called in buffers not in Org mode.
543 lim-down))
546 ;; Is point strictly in a block, and of which type?
557 lim-down))
563 ;; Is point in an inlinetask?
576 ;; Return context boundaries and type.
580 "Return structure of list at point.
582 A list structure is an alist where key is point at item, and
583 values are:
584 1. indentation,
585 2. bullet with trailing whitespace,
586 3. bullet counter, if any,
587 4. checkbox, if any,
588 5. description tag, if any,
589 6. position at item end.
591 Thus the following list, where numbers in parens are
592 point-at-bol:
594 - [X] first item (1)
595 1. sub-item 1 (18)
596 5. [@5] sub-item 2 (34)
597 some other text belonging to first item (55)
598 - last item (97)
599 + tag :: description (109)
600 (131)
602 will get the following structure:
610 Assume point is at an item."
625 ind itm-lst itm-lst-2 end-lst end-lst-2 struct
628 ;; Return association at point.
632 ind
639 ;; Ensure list ends at the first blank line.
643 ;; 1. Read list from starting item to its beginning, and save
644 ;; top item position and indentation in BEG-CELL. Also store
645 ;; ending position of items in END-LST.
653 ;; At upward limit: if we ended at an item, store it,
654 ;; else dismiss useless data recorded above BEG-CELL.
655 ;; Jump to part 2.
663 ;; At a verbatim block, go before its beginning. Move
664 ;; from eol to ensure `previous-single-property-change'
665 ;; will return a value.
670 ;; Looking at a list ending regexp. Dismiss useless
671 ;; data recorded above BEG-CELL. Jump to part 2.
676 ;; Point is at an item. Add data to ITM-LST. It may
677 ;; also end a previous item: save it in END-LST. If
678 ;; ind is less or equal than BEG-CELL and there is no
679 ;; end at this ind or lesser, this item becomes the new
680 ;; BEG-CELL.
686 ;; Skip blocks, drawers, inline tasks, blank lines.
697 ;; From there, point is not at an item. Interpret
698 ;; line's indentation:
699 ;; - text at column 0 is necessarily out of any list.
700 ;; Dismiss data recorded above BEG-CELL. Jump to
701 ;; part 2.
702 ;; - any other case may be an ending position for an
703 ;; hypothetical item above. Store it and proceed.
712 ;; 2. Read list from starting point to its end, that is until we
713 ;; get out of context, or that a non-item line is less or
714 ;; equally indented than BEG-CELL's cdr. Also, store ending
715 ;; position of items in END-LST-2.
722 ;; At downward limit: this is de facto the end of the
723 ;; list. Save point as an ending position, and jump to
724 ;; part 3.
727 ;; At a verbatim block, move to its end. Point is at bol
728 ;; and 'org-example property is set by whole lines:
729 ;; `next-single-property-change' always return a value.
733 ;; Looking at a list ending regexp. Save point as an
734 ;; ending position and jump to part 3.
738 ;; Point is at an item. Add data to ITM-LST-2. It may
739 ;; also end a previous item, so save it in END-LST-2.
743 ;; Skip inline tasks and blank lines along the way
748 ;; Ind is lesser or equal than BEG-CELL's. The list is
749 ;; over: store point as an ending position and jump to
750 ;; part 3.
754 ;; Else, if ind is lesser or equal than previous item's,
755 ;; this is an ending position: store it. In any case,
756 ;; skip block or drawer at point, and move to next line.
768 ;; 3. Associate each item to its end position.
770 ;; 4. Return STRUCT
771 struct)))
774 "Associate proper ending point to items in STRUCT.
776 END-LIST is a pseudo-alist where car is indentation and cdr is
777 ending position.
779 This function modifies STRUCT."
785 ;; Remove end candidates behind current item.
788 ;; Add end position to item assoc.
794 struct)))
797 "Return alist between item and previous item in STRUCT."
799 struct)))
803 struct)))
806 "Return alist between item and parent in STRUCT."
818 ;; A sub-list is over. Find the associated
819 ;; origin in IND-TO-ORI. If it cannot be
820 ;; found (ill-formed list), set its parent as
821 ;; the first item less indented. If there is
822 ;; none, make it a top-level item.
830 ind-to-ori)
833 ;; A sub-list starts. Every item at IND will
834 ;; have previous item as its parent.
839 ;; Another item in the same sub-list: it shares
840 ;; the same parent as the previous item.
845 \f
846 ;;; Accessors
849 "Return the Nth value of KEY in STRUCT."
853 "Set the Nth value of KEY in STRUCT to NEW.
858 "Return indentation of ITEM in STRUCT."
862 "Set indentation of ITEM in STRUCT to IND.
867 "Return bullet of ITEM in STRUCT."
871 "Set bullet of ITEM in STRUCT to BULLET.
876 "Return counter of ITEM in STRUCT."
880 "Return checkbox of ITEM in STRUCT or nil."
884 "Set checkbox of ITEM in STRUCT to CHECKBOX.
889 "Return end position of ITEM in STRUCT."
893 "Return end position of ITEM in STRUCT."
897 "Return point at end of ITEM in STRUCT, before any blank line.
898 Point returned is at end of line."
905 "Return parent of ITEM or nil.
906 STRUCT is the list structure. PARENTS is the alist of parents,
907 as returned by `org-list-parents-alist'."
912 "Non-nil if ITEM has a child.
914 STRUCT is the list structure.
916 Value returned is the position of the first child of ITEM."
921 child-maybe)))
924 "Return next item in same sub-list as ITEM, or nil.
925 STRUCT is the list structure. PREVS is the alist of previous
926 items, as returned by `org-list-prevs-alist'."
930 "Return previous item in same sub-list as ITEM, or nil.
931 STRUCT is the list structure. PREVS is the alist of previous
932 items, as returned by `org-list-prevs-alist'."
936 "List all items having ITEM as a common ancestor, or nil.
937 STRUCT is the list structure."
940 subtree)
945 sub-struct))
949 "List all items in the same sub-list as ITEM.
950 STRUCT is the list structure. PREVS is the alist of previous
951 items, as returned by `org-list-prevs-alist'."
954 before-item after-item)
962 "List all children of ITEM, or nil.
963 STRUCT is the list structure. PARENTS is the alist of parents,
964 as returned by `org-list-parents-alist'."
972 "Return point at beginning of list.
973 STRUCT is the list structure."
977 "Return point at bottom of list.
978 STRUCT is the list structure."
983 "Return point at beginning of sub-list ITEM belongs.
984 STRUCT is the list structure. PREVS is the alist of previous
985 items, as returned by `org-list-prevs-alist'."
989 first-item))
994 "Return point at last item of sub-list ITEM belongs.
995 STRUCT is the list structure. PREVS is the alist of previous
996 items, as returned by `org-list-prevs-alist'."
1000 last-item))
1003 "Return point at end of sub-list ITEM belongs.
1004 STRUCT is the list structure. PREVS is the alist of previous
1005 items, as returned by `org-list-prevs-alist'."
1009 "Return the type of the list containing ITEM, as a symbol.
1011 STRUCT is the list structure. PREVS is the alist of previous
1012 items, as returned by `org-list-prevs-alist'.
1014 Possible types are `descriptive', `ordered' and `unordered'. The
1015 type is determined by the first item of the list."
1023 \f
1024 ;;; Searching
1027 "Search a string in valid contexts for lists.
1028 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1029 in `re-search-forward'."
1033 ;; 1. No match: return to origin or bound, depending on NOERR.
1036 nil)))
1037 ;; 2. Match in valid context: return point. Else, continue
1038 ;; searching.
1042 "Like `re-search-backward' but stop only where lists are recognized.
1043 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1044 `re-search-backward'."
1049 "Like `re-search-forward' but stop only where lists are recognized.
1050 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1051 `re-search-forward'."
1056 \f
1057 ;;; Methods on structures
1060 "Return BULLET with the correct number of whitespaces.
1061 It determines the number of whitespaces to append by looking at
1062 `org-list-two-spaces-after-bullet-regexp'."
1066 org-list-two-spaces-after-bullet-regexp bullet))
1067 " "
1073 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1074 Blank lines at the end of items are left in place. Return the
1075 new structure after the changes.
1077 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1078 to the same sub-list.
1080 This function modifies STRUCT."
1093 ;; 1. Move effectively items in buffer.
1097 ;; 2. Now modify struct. No need to re-read the list, the
1098 ;; transformation is just a shift of positions. Some special
1099 ;; attention is required for items ending at END-A and END-B
1100 ;; as empty spaces are not moved there. In others words,
1101 ;; item BEG-A will end with whitespaces that were at the end
1102 ;; of BEG-B and the same applies to BEG-B.
1124 struct)
1128 "Return number of blank lines that should separate items in list.
1130 POS is the position of point where `org-list-insert-item' was called.
1132 STRUCT is the list structure. PREVS is the alist of previous
1133 items, as returned by `org-list-prevs-alist'.
1135 Assume point is at item's beginning. If the item is alone, apply
1136 some heuristics to guess the result."
1141 usr-blank
1145 ;; Count blank lines above beginning of line.
1152 ;; Trivial cases where there should be none.
1154 ;; When `org-blank-before-new-entry' says so, it is 1.
1156 ;; `plain-list-item' is 'auto. Count blank lines separating
1157 ;; neighbours items in list.
1160 ;; Is there a next item?
1163 ;; Is there a previous item?
1166 ;; User inserted blank lines, trust him.
1171 usr-blank)
1172 ;; Are there blank lines inside the list so far?
1178 ;; Default choice: no blank line.
1182 "Insert a new list item at POS and return the new structure.
1183 If POS is before first character after bullet of the item, the
1184 new item will be created before the current one.
1186 STRUCT is the list structure. PREVS is the the alist of previous
1187 items, as returned by `org-list-prevs-alist'.
1189 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1190 after the bullet. Cursor will be after this text once the
1191 function ends.
1193 This function modifies STRUCT."
1195 ;; 1. Get information about list: position of point with regards
1196 ;; to item start (BEFOREP), blank lines number separating items
1197 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1205 pos struct prevs))
1206 ;; 2. Build the new item to be created. Concatenate same
1207 ;; bullet as item, checkbox, text AFTER-BULLET if
1208 ;; provided, and text cut from point to end of item
1209 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1210 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1211 ;; between what was cut and what was inserted in buffer
1212 ;; is stored in SIZE-OFFSET.
1216 ind))
1223 ;; If POS is greater than ITEM-END, then point is
1224 ;; in some white lines after the end of the list.
1225 ;; Those must be removed, or they will be left,
1226 ;; stacking up after the list.
1236 text-cut))))
1240 ;; 4. Insert effectively item into buffer.
1244 ;; 5. Add new item to STRUCT.
1249 ;; Before inserted item, positions don't change but
1250 ;; an item ending after insertion has its end shifted
1251 ;; by SIZE-OFFSET.
1254 ;; Trivial cases where current item isn't split in
1255 ;; two. Just shift every item after new one by
1256 ;; ITEM-SIZE.
1260 ;; Item is split in two: elements before POS are just
1261 ;; shifted by ITEM-SIZE. In the case item would end
1262 ;; after split POS, ending is only shifted by
1263 ;; SIZE-OFFSET.
1269 ;; Elements after POS are moved into new item.
1270 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1271 ;; doesn't appear in buffer yet.
1277 (+ end size-offset
1279 ;; Elements at ITEM-END or after are only shifted by
1280 ;; SIZE-OFFSET.
1283 struct)
1286 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1287 ;; exchange ITEM with the next item in list. Position cursor
1288 ;; after bullet, counter, checkbox, and label.
1294 struct)))
1297 "Remove ITEM from the list and return the new structure.
1299 STRUCT is the list structure."
1302 ;; If ITEM ends with the list, delete blank lines
1303 ;; before it.
1308 item)))
1309 ;; Remove item from buffer.
1311 ;; Remove item from structure and shift others items accordingly.
1312 ;; Don't forget to shift also ending position when appropriate.
1330 struct)))))
1333 "Send ITEM to destination DEST.
1335 STRUCT is the list structure.
1337 DEST can have various values.
1339 If DEST is a buffer position, the function will assume it points
1340 to another item in the same list as ITEM, and will move the
1341 latter just before the former.
1343 If DEST is `begin' \(respectively `end'\), ITEM will be moved at
1344 the beginning \(respectively end\) of the list it belongs to.
1347 be moved at the Nth position in the list.
1349 If DEST is `kill', ITEM will be deleted and its body will be
1350 added to the kill-ring.
1352 If DEST is `delete', ITEM will be deleted.
1354 This function returns, destructively, the new list structure."
1357 ;; Grab full item body minus its bullet.
1366 item-end)))
1367 ;; Change DEST into a buffer position. A trick is needed
1368 ;; when ITEM is meant to be sent at the end of the list.
1369 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1370 ;; nil and insertion point (INS-POINT) to the first line's
1371 ;; end of the last item, we ensure the new item will be
1372 ;; inserted after the last item, and not after any of its
1373 ;; hypothetical sub-items.
1389 ;; Send ITEM at the end of the list.
1405 ;; 1. Structure returned by `org-list-insert-item' may not be
1406 ;; accurate, as it cannot see sub-items included in BODY.
1407 ;; Thus, first compute the real structure so far.
1415 ;; 1.1. Remove the item just created in structure.
1417 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1420 struct
1428 new-end
1430 moved-items))
1432 ;; 2. Eventually delete extra copy of the item and clean marker.
1439 "Outdent items between positions START and END.
1441 STRUCT is the list structure. PARENTS is the alist of items'
1442 parents, as returned by `org-list-parents-alist'.
1444 START is included, END excluded."
1450 ;; Item not yet in zone: keep association.
1452 ;; Item out of zone: follow associations in ACC.
1456 ;; Item has no parent: error
1459 ;; Parent is outdented: keep association.
1463 ;; Parent isn't outdented: reparent to grand-parent.
1465 parent struct parents)))
1471 "Indent items between positions START and END.
1473 STRUCT is the list structure. PARENTS is the alist of parents
1474 and PREVS is the alist of previous items, returned by,
1475 respectively, `org-list-parents-alist' and
1476 `org-list-prevs-alist'.
1478 START is included and END excluded.
1480 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1481 bullets between START and END."
1489 ;; Normalize ordered bullets.
1499 org-list-demote-modify-bullet))))
1506 ;; Item not yet in zone: keep association.
1509 ;; Item out of zone: follow associations in ACC.
1513 ;; Item is in zone...
1515 ;; Check if bullet needs to be changed.
1518 ;; First item indented but not parent: error
1521 ;; First item and parent indented: keep same
1522 ;; parent.
1524 ;; Previous item not indented: reparent to it.
1526 ;; Previous item indented: reparent like it.
1533 \f
1534 ;;; Repairing structures
1537 "Non-nil if list starting at FIRST can have alphabetical bullets.
1539 STRUCT is list structure. PREVS is the alist of previous items,
1540 as returned by `org-list-prevs-alist'."
1544 ;; Pretend that bullets are uppercase and check if alphabet
1545 ;; is sufficient, taking counters into account.
1549 ;; Virtually determine current bullet
1551 ;; Counters are not case-sensitive.
1554 ;; Test if bullet would be over z or Z.
1558 ;; All items checked. All good.
1559 t))))
1562 "Increment BULLET if applicable."
1565 ;; Num bullet: increment it.
1569 nil nil bullet))
1570 ;; Alpha bullet: increment it.
1574 nil nil bullet))
1575 ;; Unordered bullet: leave it.
1579 "Verify and correct bullets in STRUCT.
1580 PREVS is the alist of previous items, as returned by
1581 `org-list-prevs-alist'.
1583 This function modifies STRUCT."
1587 ;; Set bullet of ITEM in STRUCT, depending on the type of
1588 ;; first item of the list, the previous bullet and counter
1589 ;; if any.
1598 item struct
1601 ;; Alpha counter in alpha list: use counter.
1605 ;; Use cond to be sure `string-match' is used in
1606 ;; both cases.
1612 ;; Num counter in a num list: use counter.
1617 ;; No counter: increase, if needed, previous bullet.
1620 ;; Alpha counter at first item: use counter.
1629 ;; Num counter at first item: use counter.
1634 ;; First bullet is alpha uppercase: use "A".
1637 ;; First bullet is alpha lowercase: use "a".
1640 ;; First bullet is num: use "1".
1643 ;; Not an ordered list: keep bullet.
1648 "Verify and correct indentation in STRUCT.
1650 PARENTS is the alist of parents, as returned by
1651 `org-list-parents-alist'.
1653 If numeric optional argument BULLET-SIZE is set, assume all
1654 bullets in list have this length to determine new indentation.
1656 This function modifies STRUCT."
1663 ;; Indent like parent + length of parent's bullet +
1664 ;; sub-list offset.
1670 org-list-indent-offset))
1671 ;; If no parent, indent like top-point.
1676 "Verify and correct checkboxes in STRUCT.
1678 PARENTS is the alist of parents and PREVS is the alist of
1679 previous items, as returned by, respectively,
1680 `org-list-parents-alist' and `org-list-prevs-alist'.
1682 If ORDERED is non-nil, a checkbox can only be checked when every
1683 checkbox before it is checked too. If there was an attempt to
1684 break this rule, the function will return the blocking item. In
1685 all others cases, the return value will be nil.
1687 This function modifies STRUCT."
1697 item struct
1703 ;; Parent has no boxed child: leave box as-is.
1705 parent-list)
1706 ;; 1. List all parents with a checkbox.
1713 all-items)
1714 ;; 2. Sort those parents by decreasing indentation.
1719 ;; 3. For each parent, get all children's checkboxes to determine
1720 ;; and set its checkbox accordingly.
1722 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1727 ;; There are boxes checked after an unchecked one: fix that.
1732 ;; Verify once again the structure, without ORDERED.
1734 ;; Return blocking item.
1738 "Verify and correct each item end position in STRUCT.
1740 This function modifies STRUCT."
1747 ;; To determine real ind of an ending position that is
1748 ;; not at an item, we have to find the item it belongs
1749 ;; to: it is the last item (ITEM-UP), whose ending is
1750 ;; further than the position we're interested in.
1753 ;; Else part is for the bottom point.
1755 end-pos)
1756 end-list)))
1759 struct)
1764 "Apply set difference between STRUCT and OLD-STRUCT to the buffer.
1766 OLD-STRUCT is the structure before any modifications, and STRUCT
1767 the structure to be applied. The function will only modify parts
1768 of the list which have changed.
1770 Initial position of cursor is restored after the changes."
1778 ;; Shift the indentation between END and BEG by DELTA.
1779 ;; Start from the line before END.
1788 ;; Skip inline tasks.
1791 ;; Shift only non-empty lines.
1798 ;; Replace ITEM first line elements with new elements from
1799 ;; STRUCT, if appropriate.
1809 ;; a. Replace bullet
1812 ;; b. Replace checkbox.
1826 ;; c. Indent item to appropriate column.
1831 ;; 1. First get list of items and position endings. We maintain
1832 ;; two alists: ITM-SHIFT, determining indentation shift needed
1833 ;; at item, and END-POS, a pseudo-alist where key is ending
1834 ;; position and value point.
1847 ;; To determine real ind of an ending position that
1848 ;; is not at an item, we have to find the item it
1849 ;; belongs to: it is the last item (ITEM-UP), whose
1850 ;; ending is further than the position we're
1851 ;; interested in.
1855 old-struct)
1856 ;; 2. Slice the items into parts that should be shifted by the
1857 ;; same amount of indentation. The slices are returned in
1858 ;; reverse order so changes modifying buffer do not change
1859 ;; positions they refer to.
1862 '<))
1870 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1871 ;; end to beginning. Take a special action when beginning is
1872 ;; at item bullet.
1879 sliced-struct))
1880 ;; 4. Go back to initial position and clean marker.
1885 "Correct bullets, checkboxes and indentation in list at point.
1887 STRUCT is the list structure. PARENTS is the alist of parents,
1888 as returned by `org-list-parents-alist'.
1890 When non-nil, optional argument OLD-STRUCT is the reference
1891 structure of the list. It should be provided whenever STRUCT
1892 doesn't correspond anymore to the real list in buffer."
1893 ;; Order of functions matters here: checkboxes and endings need
1894 ;; correct indentation to be set, and indentation needs correct
1895 ;; bullets.
1896 ;;
1897 ;; 0. Save a copy of structure before modifications
1899 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1900 ;; order to get items endings and bullets properly
1902 ;; 2. Fix each item end to get correct prevs alist.
1904 ;; 3. Get bullets right.
1907 ;; 4. Now get real indentation.
1909 ;; 5. Eventually fix checkboxes.
1911 ;; 6. Apply structure modifications to buffer.
1915 \f
1916 ;;; Misc Tools
1919 "Call FUNCTION on each item of the list at point.
1920 FUNCTION must be called with at least one argument: INIT-VALUE,
1921 that will contain the value returned by the function at the
1922 previous item, plus ARGS extra arguments.
1924 FUNCTION is applied on items in reverse order.
1926 As an example, \(org-apply-on-list \(lambda \(result\) \(1+ result\)\) 0\)
1927 will return the number of items in the current list.
1929 Sublists of the list are skipped. Cursor is always at the
1930 beginning of the item."
1942 value))
1945 "Set visibility of ITEM in STRUCT to VIEW.
1947 Possible values are: `folded', `children' or `subtree'. See
1948 `org-cycle' for more information."
1952 ;; Hide from eol
1954 item-end t)))
1956 ;; First show everything.
1958 ;; Then fold every child.
1963 children)))
1965 ;; Show everything
1970 "Return column at which body of ITEM should start."
1980 tcol))
1983 \f
1984 ;;; Interactive functions
1989 "Go to the beginning of the current item.
1990 Throw an error when not in a list."
1996 "Go to the beginning item of the current list or sublist.
1997 Throw an error when not in a list."
2008 "Go to the end of the current list or sublist.
2009 Throw an error when not in a list."
2020 "Go to the end of the current item.
2021 Throw an error when not in a list."
2031 "Move to the beginning of the previous item.
2032 Throw an error when not in a list. Also throw an error when at
2033 first item, unless `org-list-use-circular-motion' is non-nil."
2049 "Move to the beginning of the next item.
2050 Throw an error when not in a list. Also throw an error when at
2051 last item, unless `org-list-use-circular-motion' is non-nil."
2067 "Move the item at point down, i.e. swap with following item.
2068 Sub-items (items with larger indentation) are considered part of
2069 the item, so this really moves item trees."
2088 "Move the item at point up, i.e. swap with previous item.
2089 Sub-items (items with larger indentation) are considered part of
2090 the item, so this really moves item trees."
2107 "Insert a new item at the current level.
2108 If cursor is before first character after bullet of the item, the
2109 new item will be created before the current one.
2111 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2113 Return t when things worked, nil when we are not in an item, or
2114 item is invisible."
2117 ;; If cursor isn't is a list or if list is invisible, return nil.
2125 ;; Timer list: delegate to `org-timer-item'.
2130 ;; If we're in a description list, ask for the new term.
2133 ;; Don't insert a checkbox if checkbox rule is applied
2134 ;; and it is a description item.
2138 org-list-automatic-rules)))))))
2145 t)))))
2148 "Fix indentation, bullets and checkboxes is the list at point."
2156 "Cycle through the different itemize/enumerate bullets.
2157 This cycle the entire list level through the sequence:
2159 `-' -> `+' -> `*' -> `1.' -> `1)'
2161 If WHICH is a valid string, use that as the new bullet. If WHICH
2162 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2163 `previous', cycle backwards."
2184 ;; Compute list of possible bullets, depending on context.
2187 ;; *-bullets are not allowed at column 0.
2190 ;; Description items cannot be numbered.
2213 ;; Use a short variation of `org-list-write-struct' as there's
2214 ;; no need to go through all the steps.
2222 "Toggle the checkbox in the current line.
2223 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2224 double prefix, set checkbox to [-].
2226 When there is an active region, toggle status or presence of the
2227 first checkbox there, and make every item inside have the same
2228 status or presence, respectively.
2230 If the cursor is in a headline, apply this to all checkbox items
2231 in the text below the heading, taking as reference the first item
2232 in subtree, ignoring drawers."
2236 block-item
2237 lim-up
2238 lim-down
2249 ;; In a region, start at first item in region.
2259 ;; On an heading, start at first item after drawers and
2260 ;; time-stamps (scheduled, etc.).
2271 ;; Just one item: set SINGLEP flag.
2277 ;; Determine the checkbox going to be applied to all items
2278 ;; within bounds.
2289 ;; When an item is found within bounds, grab the full list at
2290 ;; point structure, then: (1) set check-box of all its items
2291 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2292 ;; whole list, (3) move point after the list.
2306 e struct
2307 ;; If there is no box at item, leave as-is
2308 ;; unless function was called with C-u prefix.
2311 ref-checkbox
2312 cur-box))))
2313 items-to-toggle)
2315 struct parents prevs orderedp))
2316 ;; Report some problems due to ORDERED status of subtree.
2317 ;; If only one box was being checked, throw an error, else,
2318 ;; only signal problems.
2322 "Checkbox blocked because of unchecked box at line %d"
2326 "Checkboxes were removed due to unchecked box at line %d"
2335 "Reset all checkboxes in an entry subtree."
2352 "Update the checkbox statistics in the current section.
2353 This will find all statistic cookies like [57%] and [6/12] and
2354 update them with the current numbers.
2356 With optional prefix argument ALL, do this for the whole buffer."
2360 (box-re "^[ \t]*\\([-+*]\\|\\([0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2372 ;; Return number of checked boxes and boxes of all types
2373 ;; in all structures in STRUCTS. If RECURSIVEP is
2374 ;; non-nil, also count boxes in sub-lists. If ITEM is
2375 ;; nil, count across the whole structure, else count only
2376 ;; across subtree whose ancestor is ITEM.
2393 items))))
2396 structs)
2399 cookies-list structs-bak box-num)
2401 ;; 1. Build an alist for each cookie found within BOUNDS. The
2402 ;; key will be position at beginning of cookie and values
2403 ;; ending position, format of cookie, and a cell whose car is
2404 ;; number of checked boxes to report, and cdr total number of
2405 ;; boxes.
2415 ;; Cookie is at an heading, but specifically for todo,
2416 ;; not for checkboxes: skip it.
2422 ;; Cookie is at an heading, but all lists before next
2423 ;; heading already have been read. Use data collected
2424 ;; in STRUCTS-BAK. This should only happen when
2425 ;; heading has more than one cookie on it.
2428 backup-end))
2430 ;; Cookie is at a fresh heading. Grab structure of
2431 ;; every list containing a checkbox between point and
2432 ;; next headline, and save them in STRUCTS-BAK.
2436 structs-bak nil)
2443 ;; Cookie is at an item, and we already have list
2444 ;; structure stored in STRUCTS-BAK.
2447 ;; Only lists in no special context are stored.
2450 ;; Cookie is at an item, but we need to compute list
2451 ;; structure.
2457 ;; Else, cookie found is at a wrong place. Skip it.
2459 cookies-list))))
2460 ;; 2. Apply alist to buffer, in reverse order so positions stay
2461 ;; unchanged after cookie modifications.
2476 cookies-list))))
2479 "Select the face for checkbox statistics.
2480 The face will be `org-done' when all relevant boxes are checked.
2481 Otherwise it will be `org-todo'."
2484 'org-checkbox-statistics-done
2488 'org-checkbox-statistics-done
2492 "Update checkbox statistics unless turned off by user.
2493 With an optional argument ALL, update them in the whole buffer."
2501 "Indent a local list item including its children.
2502 When number ARG is a negative, item will be outdented, otherwise
2503 it will be indented.
2505 If a region is active, all items inside will be moved.
2507 If NO-SUBTREE is non-nil, only indent the item itself, not its
2508 children.
2510 STRUCT is the list structure.
2512 Return t if successful."
2520 ;; Are we going to move the whole list?
2528 t))))
2529 ;; Determine begin and end points of zone to indent. If moving
2530 ;; more than one item, save them for subsequent moves.
2546 ;; Special case: moving top-item with indent rule.
2554 ;; Change bullet if necessary.
2560 ;; Shift every item by OFFSET and fix bullets. Then
2561 ;; apply changes to buffer.
2565 struct)
2568 ;; Forbidden move:
2570 ;; If only one item is moved, it mustn't have a child.
2574 ;; If a subtree or region is moved, the last item
2575 ;; of the subtree mustn't have a child.
2580 struct)))))
2583 ;; Normal shifting
2591 t)
2594 "Outdent a local list item, but not its children.
2595 If a region is active, all items inside will be moved."
2611 "Indent a local list item, but not its children.
2612 If a region is active, all items inside will be moved."
2628 "Outdent a local list item including its children.
2629 If a region is active, all items inside will be moved."
2645 "Indent a local list item including its children.
2646 If a region is active, all items inside will be moved."
2663 "Cycle levels of indentation of an empty item.
2664 The first run indents the item, if applicable. Subsequent runs
2665 outdent it at meaningful levels in the list. When done, item is
2666 put back at its original position with its original bullet.
2668 Return t at each successful move."
2674 ;; Accept empty items or if cycle has already started.
2685 ;; When in the middle of the cycle, try to outdent first. If
2686 ;; it fails, and point is still at initial position, indent.
2687 ;; Else, re-create it at its original position.
2696 ;; Break cycle
2698 ;; If a cycle is starting, remember indentation and bullet,
2699 ;; then try to indent. If it fails, try to outdent.
2705 t))))
2708 "Sort list items.
2709 The cursor may be at any item of the list that should be sorted.
2710 Sublists are not sorted. Checkboxes, if any, are ignored.
2712 Sorting can be alphabetically, numerically, by date/time as given
2713 by a time stamp, by a property or by priority.
2715 Comparing entries ignores case by default. However, with an
2716 optional argument WITH-CASE, the sorting considers case as well.
2718 The command prompts for the sorting type unless it has been given
2719 to the function through the SORTING-TYPE argument, which needs to
2720 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
2721 meaning of each character:
2723 n Numerically, by converting the beginning of the item to a number.
2724 a Alphabetically. Only the first line of item is checked.
2725 t By date/time, either the first active time stamp in the entry, if
2726 any, or by the first inactive one. In a timer list, sort the timers.
2728 Capital letters will reverse the sort order.
2730 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2731 a function to be called with point at the beginning of the
2732 record. It must return either a string or a number that should
2733 serve as the sorting key for that record. It will then use
2734 COMPARE-FUNC to compare entries."
2779 ;; If it is a timer list, convert timer to seconds
2792 value))
2796 next-record
2797 end-record
2798 value-to-sort
2799 nil
2800 sort-func)
2801 ;; Read and fix list again, as `sort-subr' probably destroyed
2802 ;; its structure.
2808 \f
2809 ;;; Send and receive lists
2812 "Parse the list at point and maybe DELETE it.
2814 Return a list whose car is a symbol of list type, among
2815 `ordered', `unordered' and `descriptive'. Then, each item is
2816 a list whose car is counter, and cdr are strings and other
2817 sub-lists. Inside strings, check-boxes are replaced by
2820 For example, the following list:
2822 1. first item
2823 + sub-item one
2824 + [X] sub-item two
2825 more text in first item
2826 2. [@3] last item
2828 will be parsed as:
2830 \(ordered
2832 \(unordered
2838 Point is left at list end."
2844 out
2845 parse-item ; for byte-compiler
2848 ;; Return text between BEG and END, trimmed, with
2849 ;; checkboxes replaced.
2860 text)))))
2863 ;; Return a list whose car is list type and cdr a list of
2864 ;; items' body.
2870 ;; Return a list containing counter of item, if any, text
2871 ;; and any sublist inside it.
2877 ;; Get counter number. For alphabetic counter, get
2878 ;; its position in the alphabet.
2889 ;; If item has a child, store text between bullet and
2890 ;; next child, then recursively parse all sublists. At
2891 ;; the end of each sublist, check for the presence of
2892 ;; text belonging to the original item.
2902 ;; Remove children from the list just parsed.
2904 ;; There is a chunk of text belonging to the
2905 ;; item if last child doesn't end where next
2906 ;; child starts or where item ends.
2910 body))))
2913 ;; Store output, take care of cursor position and deletion of
2914 ;; list, then return output.
2921 out))
2924 "Convert the plain list at point into a subtree."
2932 "Insert a radio list template appropriate for this major mode."
2936 name pos)
2947 "Send a transformed version of this list to the receiver position.
2948 With argument MAYBE, fail quietly if no transformation is defined
2949 for this list."
2955 (unless (looking-at "[ \t]*#\\+ORGLST[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
2974 beg txt)
2978 ;; Find the insertion place
2983 name
2997 "Trim line breaks in a list ITEM."
3001 "Convert a LIST parsed through `org-list-parse-list' to other formats.
3002 Valid parameters PARAMS are:
3004 :ustart String to start an unordered list
3005 :uend String to end an unordered list
3007 :ostart String to start an ordered list
3008 :oend String to end an ordered list
3010 :dstart String to start a descriptive list
3011 :dend String to end a descriptive list
3012 :dtstart String to start a descriptive term
3013 :dtend String to end a descriptive term
3014 :ddstart String to start a description
3015 :ddend String to end a description
3017 :splice When set to t, return only list body lines, don't wrap
3018 them into :[u/o]start and :[u/o]end. Default is nil.
3020 :istart String to start a list item.
3021 :icount String to start an item with a counter.
3022 :iend String to end a list item
3023 :isep String to separate items
3024 :lsep String to separate sublists
3025 :csep String to separate text from a sub-list
3027 :cboff String to insert for an unchecked check-box
3028 :cbon String to insert for a checked check-box
3029 :cbtrans String to insert for a check-box in transitional state
3031 :nobr Non-nil means remove line breaks in lists items.
3033 Alternatively, each parameter can also be a form returning
3034 a string. These sexp can use keywords `counter' and `depth',
3035 representing respectively counter associated to the current
3036 item, and depth of the current sub-list, starting at 0.
3037 Obviously, `counter' is only available for parameters applying to
3038 items."
3062 export-sublist ; for byte-compiler
3065 ;; Export an item ITEM of type TYPE, at DEPTH. First
3066 ;; string in item is treated in a special way as it can
3067 ;; bring extra information that needs to be processed.
3073 ;; Stick DTSTART to ISTART by
3074 ;; left-trimming the latter.
3078 istart))
3085 ;; Replace checkbox if any is found.
3093 ;; Replace line breaks if required
3095 ;; Insert descriptive term if TYPE is `descriptive'.
3104 first)))
3115 ;; Export sublist SUB at DEPTH.
3133 "Convert LIST into a LaTeX list.
3134 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3135 with overruling parameters for `org-list-to-generic'."
3137 list
3146 ;; LaTeX increments counter just before
3147 ;; using it, so set it to the desired
3148 ;; value, minus one.
3155 params)))
3158 "Convert LIST into a HTML list.
3159 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3160 with overruling parameters for `org-list-to-generic'."
3162 list
3174 params)))
3177 "Convert LIST into a Texinfo list.
3178 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3179 with overruling parameters for `org-list-to-generic'."
3181 list
3192 params)))
3195 "Convert LIST into an Org subtree.
3196 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3197 with overruling parameters for `org-list-to-generic'."
3207 ;; Return the string for the heading, depending on depth D
3208 ;; of current sub-list.
3213 oddeven-level)
3214 ?*)
3217 list
3219 '(:splice t
3226 params))))
3230 ;;; org-list.el ends here