| blob | 2caecff275ffc0659e0353e3f026ba173e6180db |
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
221 "A regular expression matching bullets that should have 2 spaces after them.
222 When nil, no bullet will have two spaces after them. When
223 a string, it will be used as a regular expression. When the
224 bullet type of a list is changed, the new bullet type will be
225 matched against this regexp. If it matches, there will be two
226 spaces instead of one after the bullet in each item of the list."
233 "Non-nil means an empty line ends all plain list levels.
234 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 bullet when non-nil, cycling bullet do not allow lists at
250 column 0 to have * as a bullet and descriptions lists
251 to be numbered.
252 checkbox when non-nil, checkbox statistics is updated each time
253 you either insert a new checkbox or toggle a checkbox.
254 It also prevents from inserting a checkbox in a
255 description item.
256 indent when non-nil, indenting or outdenting list top-item
257 with its subtree will move the whole list and
258 outdenting a list whose bullet is * to column 0 will
262 :key-type
267 :value-type
271 "Non-nil means commands implying motion in lists should be cyclic.
273 In that case, the item following the last item is the first one,
274 and the item preceding the first item is the last one.
283 "Hook that is run whenever Org thinks checkbox statistics should be updated.
284 This hook runs even if checkbox rule in
285 `org-list-automatic-rules' does not apply, so it can be used to
286 implement alternative ways of collecting statistics
290 "Non-nil means checkbox statistics counts only the state of direct children.
291 When nil, all boxes below the cookie are counted.
292 This can be set to nil on a per-node basis using a COOKIE_DATA property
298 "Maximum indentation for the second line of a description list.
299 When the indentation would be larger than this, it will become
300 5 characters instead."
305 "Additional indentation for sub-items in a list.
306 By setting this to a small number, usually 1 or 2, one can more
307 clearly distinguish sub-items in a list."
313 % END RECEIVE ORGLST %n
315 #+ORGLST: SEND %n org-list-to-latex
316 -
319 @c END RECEIVE ORGLST %n
320 @ignore
321 #+ORGLST: SEND %n org-list-to-texinfo
322 -
325 <!-- END RECEIVE ORGLST %n -->
326 <!--
327 #+ORGLST: SEND %n org-list-to-html
328 -
330 "Templates for radio lists in different major modes.
331 All occurrences of %n in a template will be replaced with the name of the
332 list, obtained by prompting the user."
340 "Names of blocks where lists are not allowed.
344 "Context types where lists will be interpreted during export.
346 Valid types are `drawer', `inlinetask' and `block'. More
347 specifically, type `block' is determined by the variable
351 \f
352 ;;; Predicates and regexps
356 "Regex corresponding to the end of a list.
364 "Matches a list item and puts everything into groups:
365 group 1: bullet
366 group 2: counter
367 group 3: checkbox
371 "Return the correct regular expression for plain lists."
382 "Regexp matching the beginning of a plain list item."
386 "Is point at a list item with REGEXP after bullet?"
395 ;; Ignore counter if any
400 "Is point in a context where lists are allowed?"
404 "Return item beginning position when in a plain list, nil otherwise."
416 ;; Indentation isn't meaningful when point starts at an empty
417 ;; line or an inline task.
420 10000
426 ;; Detect if cursor in amidst `org-list-end-re'. First, count
427 ;; number HL of hard lines it takes, then call `org-in-regexp'
428 ;; to compute its boundaries END-BOUNDS. When point is
429 ;; in-between, move cursor before regexp beginning.
440 ;; Look for an item, less indented that reference line.
445 ;; This is exactly what we want.
448 ;; At upper bound of search or looking at the end of a
449 ;; previous list: search is over.
452 ;; Skip blocks, drawers, inline-tasks, blank lines
462 ;; Text at column 0 cannot belong to a list: stop.
464 ;; Normal text less indented than reference line, take
465 ;; it as new reference.
472 "Is point in a line starting a hand-formatted item?"
478 "Is point at the bullet of a plain list item?"
484 "Is point at a line starting a plain list item with a timer?"
489 "Is point at a description list item?"
493 "Is point at a line starting a plain-list item with a checklet?"
497 "Is point at a line starting a plain-list item with a counter?"
503 \f
504 ;;; Structures and helper functions
507 "Determine context, and its boundaries, around point.
509 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
510 are boundaries and CONTEXT is a symbol among `drawer', `block',
511 `invalid', `inlinetask' and nil.
513 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
519 ;; Get positions of surrounding headings. This is the
520 ;; default context.
525 ;; Is point inside a drawer?
527 ;; Can't use org-drawers-regexp as this function might
528 ;; be called in buffers not in Org mode.
539 lim-down))
542 ;; Is point strictly in a block, and of which type?
553 lim-down))
559 ;; Is point in an inlinetask?
572 ;; Return context boundaries and type.
576 "Return structure of list at point.
578 A list structure is an alist where key is point at item, and
579 values are:
580 1. indentation,
581 2. bullet with trailing whitespace,
582 3. bullet counter, if any,
583 4. checkbox, if any,
584 5. description tag, if any,
585 6. position at item end.
587 Thus the following list, where numbers in parens are
588 point-at-bol:
590 - [X] first item (1)
591 1. sub-item 1 (18)
592 5. [@5] sub-item 2 (34)
593 some other text belonging to first item (55)
594 - last item (97)
595 + tag :: description (109)
596 (131)
598 will get the following structure:
606 Assume point is at an item."
621 ind itm-lst itm-lst-2 end-lst end-lst-2 struct
624 ;; Return association at point.
628 ind
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 \f
1020 ;;; Searching
1023 "Search a string in valid contexts for lists.
1024 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1025 in `re-search-forward'."
1029 ;; 1. No match: return to origin or bound, depending on NOERR.
1032 nil)))
1033 ;; 2. Match in valid context: return point. Else, continue
1034 ;; searching.
1038 "Like `re-search-backward' but stop only where lists are recognized.
1039 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1040 `re-search-backward'."
1045 "Like `re-search-forward' but stop only where lists are recognized.
1046 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1047 `re-search-forward'."
1052 \f
1053 ;;; Methods on structures
1056 "Return BULLET with the correct number of whitespaces.
1057 It determines the number of whitespaces to append by looking at
1058 `org-list-two-spaces-after-bullet-regexp'."
1062 org-list-two-spaces-after-bullet-regexp bullet))
1063 " "
1069 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1070 Blank lines at the end of items are left in place. Return the
1071 new structure after the changes.
1073 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1074 to the same sub-list.
1076 This function modifies STRUCT."
1089 ;; 1. Move effectively items in buffer.
1093 ;; 2. Now modify struct. No need to re-read the list, the
1094 ;; transformation is just a shift of positions. Some special
1095 ;; attention is required for items ending at END-A and END-B
1096 ;; as empty spaces are not moved there. In others words,
1097 ;; item BEG-A will end with whitespaces that were at the end
1098 ;; of BEG-B and the same applies to BEG-B.
1120 struct)
1124 "Return number of blank lines that should separate items in list.
1126 POS is the position of point where `org-list-insert-item' was called.
1128 STRUCT is the list structure. PREVS is the alist of previous
1129 items, as returned by `org-list-prevs-alist'.
1131 Assume point is at item's beginning. If the item is alone, apply
1132 some heuristics to guess the result."
1137 usr-blank
1141 ;; Count blank lines above beginning of line.
1148 ;; Trivial cases where there should be none.
1150 ;; When `org-blank-before-new-entry' says so, it is 1.
1152 ;; `plain-list-item' is 'auto. Count blank lines separating
1153 ;; neighbours items in list.
1156 ;; Is there a next item?
1159 ;; Is there a previous item?
1162 ;; User inserted blank lines, trust him.
1167 usr-blank)
1168 ;; Are there blank lines inside the list so far?
1174 ;; Default choice: no blank line.
1178 "Insert a new list item at POS and return the new structure.
1179 If POS is before first character after bullet of the item, the
1180 new item will be created before the current one.
1182 STRUCT is the list structure. PREVS is the the alist of previous
1183 items, as returned by `org-list-prevs-alist'.
1185 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1186 after the bullet. Cursor will be after this text once the
1187 function ends.
1189 This function modifies STRUCT."
1191 ;; 1. Get information about list: position of point with regards
1192 ;; to item start (BEFOREP), blank lines number separating items
1193 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1201 pos struct prevs))
1202 ;; 2. Build the new item to be created. Concatenate same
1203 ;; bullet as item, checkbox, text AFTER-BULLET if
1204 ;; provided, and text cut from point to end of item
1205 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1206 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1207 ;; between what was cut and what was inserted in buffer
1208 ;; is stored in SIZE-OFFSET.
1212 ind))
1219 ;; If POS is greater than ITEM-END, then point is
1220 ;; in some white lines after the end of the list.
1221 ;; Those must be removed, or they will be left,
1222 ;; stacking up after the list.
1232 text-cut))))
1236 ;; 4. Insert effectively item into buffer.
1240 ;; 5. Add new item to STRUCT.
1245 ;; Before inserted item, positions don't change but
1246 ;; an item ending after insertion has its end shifted
1247 ;; by SIZE-OFFSET.
1250 ;; Trivial cases where current item isn't split in
1251 ;; two. Just shift every item after new one by
1252 ;; ITEM-SIZE.
1256 ;; Item is split in two: elements before POS are just
1257 ;; shifted by ITEM-SIZE. In the case item would end
1258 ;; after split POS, ending is only shifted by
1259 ;; SIZE-OFFSET.
1265 ;; Elements after POS are moved into new item.
1266 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1267 ;; doesn't appear in buffer yet.
1273 (+ end size-offset
1275 ;; Elements at ITEM-END or after are only shifted by
1276 ;; SIZE-OFFSET.
1279 struct)
1282 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1283 ;; exchange ITEM with the next item in list. Position cursor
1284 ;; after bullet, counter, checkbox, and label.
1290 struct)))
1293 "Remove ITEM from the list and return the new structure.
1295 STRUCT is the list structure."
1298 ;; If ITEM ends with the list, delete blank lines
1299 ;; before it.
1304 item)))
1305 ;; Remove item from buffer.
1307 ;; Remove item from structure and shift others items accordingly.
1308 ;; Don't forget to shift also ending position when appropriate.
1326 struct)))))
1329 "Send ITEM to destination DEST.
1331 STRUCT is the list structure.
1333 DEST can have various values.
1335 If DEST is a buffer position, the function will assume it points
1336 to another item in the same list as ITEM, and will move the
1337 latter just before the former.
1339 If DEST is `begin' \(respectively `end'\), ITEM will be moved at
1340 the beginning \(respectively end\) of the list it belongs to.
1343 be moved at the Nth position in the list.
1345 If DEST is `kill', ITEM will be deleted and its body will be
1346 added to the kill-ring.
1348 If DEST is `delete', ITEM will be deleted.
1350 This function returns, destructively, the new list structure."
1353 ;; Grab full item body minus its bullet.
1362 item-end)))
1363 ;; Change DEST into a buffer position. A trick is needed
1364 ;; when ITEM is meant to be sent at the end of the list.
1365 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1366 ;; nil and insertion point (INS-POINT) to the first line's
1367 ;; end of the last item, we ensure the new item will be
1368 ;; inserted after the last item, and not after any of its
1369 ;; hypothetical sub-items.
1385 ;; Send ITEM at the end of the list.
1401 ;; 1. Structure returned by `org-list-insert-item' may not be
1402 ;; accurate, as it cannot see sub-items included in BODY.
1403 ;; Thus, first compute the real structure so far.
1411 ;; 1.1. Remove the item just created in structure.
1413 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1416 struct
1424 new-end
1426 moved-items))
1428 ;; 2. Eventually delete extra copy of the item and clean marker.
1435 "Outdent items between positions START and END.
1437 STRUCT is the list structure. PARENTS is the alist of items'
1438 parents, as returned by `org-list-parents-alist'.
1440 START is included, END excluded."
1446 ;; Item not yet in zone: keep association.
1448 ;; Item out of zone: follow associations in ACC.
1452 ;; Item has no parent: error
1455 ;; Parent is outdented: keep association.
1459 ;; Parent isn't outdented: reparent to grand-parent.
1461 parent struct parents)))
1467 "Indent items between positions START and END.
1469 STRUCT is the list structure. PARENTS is the alist of parents
1470 and PREVS is the alist of previous items, returned by,
1471 respectively, `org-list-parents-alist' and
1472 `org-list-prevs-alist'.
1474 START is included and END excluded.
1476 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1477 bullets between START and END."
1491 ;; Item not yet in zone: keep association.
1494 ;; Item out of zone: follow associations in ACC.
1498 ;; Item is in zone...
1500 ;; Check if bullet needs to be changed.
1503 ;; First item indented but not parent: error
1506 ;; First item and parent indented: keep same
1507 ;; parent.
1509 ;; Previous item not indented: reparent to it.
1511 ;; Previous item indented: reparent like it.
1518 \f
1519 ;;; Repairing structures
1522 "Non-nil if list starting at FIRST can have alphabetical bullets.
1524 STRUCT is list structure. PREVS is the alist of previous items,
1525 as returned by `org-list-prevs-alist'."
1529 ;; Pretend that bullets are uppercase and check if alphabet
1530 ;; is sufficient, taking counters into account.
1534 ;; Virtually determine current bullet
1536 ;; Counters are not case-sensitive.
1539 ;; Test if bullet would be over z or Z.
1543 ;; All items checked. All good.
1544 t))))
1547 "Increment BULLET if applicable."
1550 ;; Num bullet: increment it.
1554 nil nil bullet))
1555 ;; Alpha bullet: increment it.
1559 nil nil bullet))
1560 ;; Unordered bullet: leave it.
1564 "Verify and correct bullets in STRUCT.
1565 PREVS is the alist of previous items, as returned by
1566 `org-list-prevs-alist'.
1568 This function modifies STRUCT."
1572 ;; Set bullet of ITEM in STRUCT, depending on the type of
1573 ;; first item of the list, the previous bullet and counter
1574 ;; if any.
1583 item struct
1586 ;; Alpha counter in alpha list: use counter.
1590 ;; Use cond to be sure `string-match' is used in
1591 ;; both cases.
1597 ;; Num counter in a num list: use counter.
1602 ;; No counter: increase, if needed, previous bullet.
1605 ;; Alpha counter at first item: use counter.
1614 ;; Num counter at first item: use counter.
1619 ;; First bullet is alpha uppercase: use "A".
1622 ;; First bullet is alpha lowercase: use "a".
1625 ;; First bullet is num: use "1".
1628 ;; Not an ordered list: keep bullet.
1633 "Verify and correct indentation in STRUCT.
1635 PARENTS is the alist of parents, as returned by
1636 `org-list-parents-alist'.
1638 If numeric optional argument BULLET-SIZE is set, assume all
1639 bullets in list have this length to determine new indentation.
1641 This function modifies STRUCT."
1648 ;; Indent like parent + length of parent's bullet +
1649 ;; sub-list offset.
1655 org-list-indent-offset))
1656 ;; If no parent, indent like top-point.
1661 "Verify and correct checkboxes in STRUCT.
1663 PARENTS is the alist of parents and PREVS is the alist of
1664 previous items, as returned by, respectively,
1665 `org-list-parents-alist' and `org-list-prevs-alist'.
1667 If ORDERED is non-nil, a checkbox can only be checked when every
1668 checkbox before it is checked too. If there was an attempt to
1669 break this rule, the function will return the blocking item. In
1670 all others cases, the return value will be nil.
1672 This function modifies STRUCT."
1682 item struct
1688 ;; Parent has no boxed child: leave box as-is.
1690 parent-list)
1691 ;; 1. List all parents with a checkbox.
1698 all-items)
1699 ;; 2. Sort those parents by decreasing indentation.
1704 ;; 3. For each parent, get all children's checkboxes to determine
1705 ;; and set its checkbox accordingly.
1707 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1712 ;; There are boxes checked after an unchecked one: fix that.
1717 ;; Verify once again the structure, without ORDERED.
1719 ;; Return blocking item.
1723 "Verify and correct each item end position in STRUCT.
1725 This function modifies STRUCT."
1732 ;; To determine real ind of an ending position that is
1733 ;; not at an item, we have to find the item it belongs
1734 ;; to: it is the last item (ITEM-UP), whose ending is
1735 ;; further than the position we're interested in.
1738 ;; Else part is for the bottom point.
1740 end-pos)
1741 end-list)))
1744 struct)
1749 "Apply set difference between STRUCT and OLD-STRUCT to the buffer.
1751 OLD-STRUCT is the structure before any modifications, and STRUCT
1752 the structure to be applied. The function will only modify parts
1753 of the list which have changed.
1755 Initial position of cursor is restored after the changes."
1763 ;; Shift the indentation between END and BEG by DELTA.
1764 ;; Start from the line before END.
1773 ;; Skip inline tasks.
1776 ;; Shift only non-empty lines.
1783 ;; Replace ITEM first line elements with new elements from
1784 ;; STRUCT, if appropriate.
1794 ;; a. Replace bullet
1797 ;; b. Replace checkbox.
1811 ;; c. Indent item to appropriate column.
1816 ;; 1. First get list of items and position endings. We maintain
1817 ;; two alists: ITM-SHIFT, determining indentation shift needed
1818 ;; at item, and END-POS, a pseudo-alist where key is ending
1819 ;; position and value point.
1832 ;; To determine real ind of an ending position that
1833 ;; is not at an item, we have to find the item it
1834 ;; belongs to: it is the last item (ITEM-UP), whose
1835 ;; ending is further than the position we're
1836 ;; interested in.
1840 old-struct)
1841 ;; 2. Slice the items into parts that should be shifted by the
1842 ;; same amount of indentation. The slices are returned in
1843 ;; reverse order so changes modifying buffer do not change
1844 ;; positions they refer to.
1847 '<))
1855 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1856 ;; end to beginning. Take a special action when beginning is
1857 ;; at item bullet.
1864 sliced-struct))
1865 ;; 4. Go back to initial position and clean marker.
1870 "Correct bullets, checkboxes and indentation in list at point.
1872 STRUCT is the list structure. PARENTS is the alist of parents,
1873 as returned by `org-list-parents-alist'.
1875 When non-nil, optional argument OLD-STRUCT is the reference
1876 structure of the list. It should be provided whenever STRUCT
1877 doesn't correspond anymore to the real list in buffer."
1878 ;; Order of functions matters here: checkboxes and endings need
1879 ;; correct indentation to be set, and indentation needs correct
1880 ;; bullets.
1881 ;;
1882 ;; 0. Save a copy of structure before modifications
1884 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1885 ;; order to get items endings and bullets properly
1887 ;; 2. Fix each item end to get correct prevs alist.
1889 ;; 3. Get bullets right.
1892 ;; 4. Now get real indentation.
1894 ;; 5. Eventually fix checkboxes.
1896 ;; 6. Apply structure modifications to buffer.
1900 \f
1901 ;;; Misc Tools
1904 "Call FUNCTION on each item of the list at point.
1905 FUNCTION must be called with at least one argument: INIT-VALUE,
1906 that will contain the value returned by the function at the
1907 previous item, plus ARGS extra arguments.
1909 FUNCTION is applied on items in reverse order.
1911 As an example, \(org-apply-on-list \(lambda \(result\) \(1+ result\)\) 0\)
1912 will return the number of items in the current list.
1914 Sublists of the list are skipped. Cursor is always at the
1915 beginning of the item."
1927 value))
1930 "Set visibility of ITEM in STRUCT to VIEW.
1932 Possible values are: `folded', `children' or `subtree'. See
1933 `org-cycle' for more information."
1937 ;; Hide from eol
1939 item-end t)))
1941 ;; First show everything.
1943 ;; Then fold every child.
1948 children)))
1950 ;; Show everything
1955 "Return column at which body of ITEM should start."
1965 tcol))
1968 \f
1969 ;;; Interactive functions
1974 "Go to the beginning of the current item.
1975 Throw an error when not in a list."
1981 "Go to the beginning item of the current list or sublist.
1982 Throw an error when not in a list."
1993 "Go to the end of the current list or sublist.
1994 Throw an error when not in a list."
2005 "Go to the end of the current item.
2006 Throw an error when not in a list."
2016 "Move to the beginning of the previous item.
2017 Throw an error when not in a list. Also throw an error when at
2018 first item, unless `org-list-use-circular-motion' is non-nil."
2034 "Move to the beginning of the next item.
2035 Throw an error when not in a list. Also throw an error when at
2036 last item, unless `org-list-use-circular-motion' is non-nil."
2052 "Move the item at point down, i.e. swap with following item.
2053 Sub-items (items with larger indentation) are considered part of
2054 the item, so this really moves item trees."
2073 "Move the item at point up, i.e. swap with previous item.
2074 Sub-items (items with larger indentation) are considered part of
2075 the item, so this really moves item trees."
2092 "Insert a new item at the current level.
2093 If cursor is before first character after bullet of the item, the
2094 new item will be created before the current one.
2096 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2098 Return t when things worked, nil when we are not in an item, or
2099 item is invisible."
2102 ;; If cursor isn't is a list or if list is invisible, return nil.
2110 ;; Timer list: delegate to `org-timer-item'.
2115 ;; If we're in a description list, ask for the new term.
2118 ;; Don't insert a checkbox if checkbox rule is applied
2119 ;; and it is a description item.
2123 org-list-automatic-rules)))))))
2130 t)))))
2133 "Fix indentation, bullets and checkboxes is the list at point."
2141 "Cycle through the different itemize/enumerate bullets.
2142 This cycle the entire list level through the sequence:
2144 `-' -> `+' -> `*' -> `1.' -> `1)'
2146 If WHICH is a valid string, use that as the new bullet. If WHICH
2147 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2148 `previous', cycle backwards."
2169 ;; Compute list of possible bullets, depending on context.
2172 ;; *-bullets are not allowed at column 0.
2175 ;; Description items cannot be numbered.
2198 ;; Use a short variation of `org-list-write-struct' as there's
2199 ;; no need to go through all the steps.
2207 "Toggle the checkbox in the current line.
2208 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2209 double prefix, set checkbox to [-].
2211 When there is an active region, toggle status or presence of the
2212 first checkbox there, and make every item inside have the same
2213 status or presence, respectively.
2215 If the cursor is in a headline, apply this to all checkbox items
2216 in the text below the heading, taking as reference the first item
2217 in subtree, ignoring drawers."
2221 block-item
2222 lim-up
2223 lim-down
2234 ;; In a region, start at first item in region.
2244 ;; On an heading, start at first item after drawers and
2245 ;; time-stamps (scheduled, etc.).
2256 ;; Just one item: set SINGLEP flag.
2262 ;; Determine the checkbox going to be applied to all items
2263 ;; within bounds.
2274 ;; When an item is found within bounds, grab the full list at
2275 ;; point structure, then: (1) set check-box of all its items
2276 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2277 ;; whole list, (3) move point after the list.
2291 e struct
2292 ;; If there is no box at item, leave as-is
2293 ;; unless function was called with C-u prefix.
2296 ref-checkbox
2297 cur-box))))
2298 items-to-toggle)
2300 struct parents prevs orderedp))
2301 ;; Report some problems due to ORDERED status of subtree.
2302 ;; If only one box was being checked, throw an error, else,
2303 ;; only signal problems.
2307 "Checkbox blocked because of unchecked box at line %d"
2311 "Checkboxes were removed due to unchecked box at line %d"
2320 "Reset all checkboxes in an entry subtree."
2337 "Update the checkbox statistics in the current section.
2338 This will find all statistic cookies like [57%] and [6/12] and
2339 update them with the current numbers.
2341 With optional prefix argument ALL, do this for the whole buffer."
2345 (box-re "^[ \t]*\\([-+*]\\|\\([0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2357 ;; Return number of checked boxes and boxes of all types
2358 ;; in all structures in STRUCTS. If RECURSIVEP is
2359 ;; non-nil, also count boxes in sub-lists. If ITEM is
2360 ;; nil, count across the whole structure, else count only
2361 ;; across subtree whose ancestor is ITEM.
2378 items))))
2381 structs)
2384 cookies-list structs-bak box-num)
2386 ;; 1. Build an alist for each cookie found within BOUNDS. The
2387 ;; key will be position at beginning of cookie and values
2388 ;; ending position, format of cookie, and a cell whose car is
2389 ;; number of checked boxes to report, and cdr total number of
2390 ;; boxes.
2400 ;; Cookie is at an heading, but specifically for todo,
2401 ;; not for checkboxes: skip it.
2407 ;; Cookie is at an heading, but all lists before next
2408 ;; heading already have been read. Use data collected
2409 ;; in STRUCTS-BAK. This should only happen when
2410 ;; heading has more than one cookie on it.
2413 backup-end))
2415 ;; Cookie is at a fresh heading. Grab structure of
2416 ;; every list containing a checkbox between point and
2417 ;; next headline, and save them in STRUCTS-BAK.
2421 structs-bak nil)
2428 ;; Cookie is at an item, and we already have list
2429 ;; structure stored in STRUCTS-BAK.
2432 ;; Only lists in no special context are stored.
2435 ;; Cookie is at an item, but we need to compute list
2436 ;; structure.
2442 ;; Else, cookie found is at a wrong place. Skip it.
2444 cookies-list))))
2445 ;; 2. Apply alist to buffer, in reverse order so positions stay
2446 ;; unchanged after cookie modifications.
2461 cookies-list))))
2464 "Select the face for checkbox statistics.
2465 The face will be `org-done' when all relevant boxes are checked.
2466 Otherwise it will be `org-todo'."
2469 'org-checkbox-statistics-done
2473 'org-checkbox-statistics-done
2477 "Update checkbox statistics unless turned off by user.
2478 With an optional argument ALL, update them in the whole buffer."
2486 "Indent a local list item including its children.
2487 When number ARG is a negative, item will be outdented, otherwise
2488 it will be indented.
2490 If a region is active, all items inside will be moved.
2492 If NO-SUBTREE is non-nil, only indent the item itself, not its
2493 children.
2495 STRUCT is the list structure.
2497 Return t if successful."
2506 ;; Are we going to move the whole list?
2513 t))))
2514 ;; Determine begin and end points of zone to indent. If moving
2515 ;; more than one item, save them for subsequent moves.
2531 ;; Special case: moving top-item with indent rule.
2539 ;; Change bullet if necessary.
2545 ;; Shift every item by OFFSET and fix bullets. Then
2546 ;; apply changes to buffer.
2550 struct)
2553 ;; Forbidden move:
2555 ;; If only one item is moved, it mustn't have a child.
2559 ;; If a subtree or region is moved, the last item
2560 ;; of the subtree mustn't have a child.
2565 struct)))))
2568 ;; Normal shifting
2576 t)
2579 "Outdent a local list item, but not its children.
2580 If a region is active, all items inside will be moved."
2588 "Indent a local list item, but not its children.
2589 If a region is active, all items inside will be moved."
2597 "Outdent a local list item including its children.
2598 If a region is active, all items inside will be moved."
2612 "Indent a local list item including its children.
2613 If a region is active, all items inside will be moved."
2628 "Cycle levels of indentation of an empty item.
2629 The first run indents the item, if applicable. Subsequent runs
2630 outdent it at meaningful levels in the list. When done, item is
2631 put back at its original position with its original bullet.
2633 Return t at each successful move."
2639 ;; Accept empty items or if cycle has already started.
2650 ;; When in the middle of the cycle, try to outdent first. If
2651 ;; it fails, and point is still at initial position, indent.
2652 ;; Else, re-create it at its original position.
2661 ;; Break cycle
2663 ;; If a cycle is starting, remember indentation and bullet,
2664 ;; then try to indent. If it fails, try to outdent.
2670 t))))
2673 "Sort list items.
2674 The cursor may be at any item of the list that should be sorted.
2675 Sublists are not sorted. Checkboxes, if any, are ignored.
2677 Sorting can be alphabetically, numerically, by date/time as given
2678 by a time stamp, by a property or by priority.
2680 Comparing entries ignores case by default. However, with an
2681 optional argument WITH-CASE, the sorting considers case as well.
2683 The command prompts for the sorting type unless it has been given
2684 to the function through the SORTING-TYPE argument, which needs to
2685 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
2686 meaning of each character:
2688 n Numerically, by converting the beginning of the item to a number.
2689 a Alphabetically. Only the first line of item is checked.
2690 t By date/time, either the first active time stamp in the entry, if
2691 any, or by the first inactive one. In a timer list, sort the timers.
2693 Capital letters will reverse the sort order.
2695 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2696 a function to be called with point at the beginning of the
2697 record. It must return either a string or a number that should
2698 serve as the sorting key for that record. It will then use
2699 COMPARE-FUNC to compare entries."
2744 ;; If it is a timer list, convert timer to seconds
2757 value))
2761 next-record
2762 end-record
2763 value-to-sort
2764 nil
2765 sort-func)
2766 ;; Read and fix list again, as `sort-subr' probably destroyed
2767 ;; its structure.
2773 \f
2774 ;;; Send and receive lists
2777 "Parse the list at point and maybe DELETE it.
2779 Return a list whose car is a symbol of list type, among
2780 `ordered', `unordered' and `descriptive'. Then, each item is
2781 a list whose car is counter, and cdr are strings and other
2782 sub-lists. Inside strings, check-boxes are replaced by
2785 For example, the following list:
2787 1. first item
2788 + sub-item one
2789 + [X] sub-item two
2790 more text in first item
2791 2. [@3] last item
2793 will be parsed as:
2795 \(ordered
2797 \(unordered
2803 Point is left at list end."
2809 out
2810 parse-item ; for byte-compiler
2813 ;; Return text between BEG and END, trimmed, with
2814 ;; checkboxes replaced.
2825 text)))))
2828 ;; Return a list whose car is list type and cdr a list of
2829 ;; items' body.
2835 ;; Return a list containing counter of item, if any, text
2836 ;; and any sublist inside it.
2842 ;; Get counter number. For alphabetic counter, get
2843 ;; its position in the alphabet.
2854 ;; If item has a child, store text between bullet and
2855 ;; next child, then recursively parse all sublists. At
2856 ;; the end of each sublist, check for the presence of
2857 ;; text belonging to the original item.
2867 ;; Remove children from the list just parsed.
2869 ;; There is a chunk of text belonging to the
2870 ;; item if last child doesn't end where next
2871 ;; child starts or where item ends.
2875 body))))
2878 ;; Store output, take care of cursor position and deletion of
2879 ;; list, then return output.
2886 out))
2889 "Convert the plain list at point into a subtree."
2897 "Insert a radio list template appropriate for this major mode."
2901 name pos)
2912 "Send a transformed version of this list to the receiver position.
2913 With argument MAYBE, fail quietly if no transformation is defined
2914 for this list."
2920 (unless (looking-at "[ \t]*#\\+ORGLST[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
2939 beg txt)
2943 ;; Find the insertion place
2948 name
2962 "Trim line breaks in a list ITEM."
2966 "Convert a LIST parsed through `org-list-parse-list' to other formats.
2967 Valid parameters PARAMS are:
2969 :ustart String to start an unordered list
2970 :uend String to end an unordered list
2972 :ostart String to start an ordered list
2973 :oend String to end an ordered list
2975 :dstart String to start a descriptive list
2976 :dend String to end a descriptive list
2977 :dtstart String to start a descriptive term
2978 :dtend String to end a descriptive term
2979 :ddstart String to start a description
2980 :ddend String to end a description
2982 :splice When set to t, return only list body lines, don't wrap
2983 them into :[u/o]start and :[u/o]end. Default is nil.
2985 :istart String to start a list item.
2986 :icount String to start an item with a counter.
2987 :iend String to end a list item
2988 :isep String to separate items
2989 :lsep String to separate sublists
2990 :csep String to separate text from a sub-list
2992 :cboff String to insert for an unchecked check-box
2993 :cbon String to insert for a checked check-box
2994 :cbtrans String to insert for a check-box in transitional state
2996 :nobr Non-nil means remove line breaks in lists items.
2998 Alternatively, each parameter can also be a form returning
2999 a string. These sexp can use keywords `counter' and `depth',
3000 representing respectively counter associated to the current
3001 item, and depth of the current sub-list, starting at 0.
3002 Obviously, `counter' is only available for parameters applying to
3003 items."
3027 export-sublist ; for byte-compiler
3030 ;; Export an item ITEM of type TYPE, at DEPTH. First
3031 ;; string in item is treated in a special way as it can
3032 ;; bring extra information that needs to be processed.
3038 ;; Stick DTSTART to ISTART by
3039 ;; left-trimming the latter.
3043 istart))
3050 ;; Replace checkbox if any is found.
3058 ;; Replace line breaks if required
3060 ;; Insert descriptive term if TYPE is `descriptive'.
3069 first)))
3080 ;; Export sublist SUB at DEPTH.
3098 "Convert LIST into a LaTeX list.
3099 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3100 with overruling parameters for `org-list-to-generic'."
3102 list
3111 ;; LaTeX increments counter just before
3112 ;; using it, so set it to the desired
3113 ;; value, minus one.
3120 params)))
3123 "Convert LIST into a HTML list.
3124 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3125 with overruling parameters for `org-list-to-generic'."
3127 list
3139 params)))
3142 "Convert LIST into a Texinfo list.
3143 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3144 with overruling parameters for `org-list-to-generic'."
3146 list
3157 params)))
3160 "Convert LIST into an Org subtree.
3161 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3162 with overruling parameters for `org-list-to-generic'."
3172 ;; Return the string for the heading, depending on depth D
3173 ;; of current sub-list.
3178 oddeven-level)
3179 ?*)
3182 list
3184 '(:splice t
3191 params))))
3195 ;;; org-list.el ends here