| blob | 8f34802258f9006943793ed97583fe789d9f764e |
1 ;;; org-list.el --- Plain lists for Org-mode
2 ;;
3 ;; Copyright (C) 2004-2011 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 fundamental idea behind lists work is to use structures.
31 ;; A structure is a snapshot of the list, in the shape of data tree
32 ;; (see `org-list-struct').
34 ;; Once the list structure is stored, it is possible to make changes
35 ;; directly on it or get useful information about the list, with the
36 ;; two helper functions, namely `org-list-parents-alist' and
37 ;; `org-list-prevs-alist', and using accessors or methods.
39 ;; Structure is eventually applied to the buffer with
40 ;; `org-list-write-struct'. This function repairs (bullets,
41 ;; indentation, checkboxes) the structure before applying it. It
42 ;; should be called near the end of any function working on
43 ;; structures.
45 ;; Thus, a function applying to lists should usually follow this
46 ;; template:
48 ;; 1. Verify point is in a list and grab item beginning (with the same
49 ;; function `org-in-item-p'). If the function requires the cursor
50 ;; to be at item's bullet, `org-at-item-p' is more selective. If
51 ;; the cursor is amidst the buffer, it is possible to find the
52 ;; closest item with `org-list-search-backward', or
53 ;; `org-list-search-forward', applied to `org-item-beginning-re'.
55 ;; 2. Get list structure with `org-list-struct'.
57 ;; 3. Compute one, or both, helper functions,
58 ;; (`org-list-parents-alist', `org-list-prevs-alist') depending on
59 ;; needed accessors.
61 ;; 4. Proceed with the modifications, using methods and accessors.
63 ;; 5. Verify and apply structure to buffer, using
64 ;; `org-list-write-struct'. Possibly use
65 ;; `org-update-checkbox-count-maybe' if checkboxes might have been
66 ;; modified.
68 ;; Computing a list structure can be a costly operation on huge lists
69 ;; (a few thousand lines long). Thus, code should follow the rule :
70 ;; "collect once, use many". As a corollary, it is usally a bad idea
71 ;; to use directly an interactive function inside the code, as those,
72 ;; being independant entities, read the whole list structure another
73 ;; time.
75 ;;; Code:
130 ;;; Configuration variables
133 "Options concerning plain lists in Org-mode."
138 "When t, make TAB cycle visibility on plain list items.
139 Cycling plain lists works only when the cursor is on a plain list
140 item. When the cursor is on an outline heading, plain lists are
141 treated as text. This is the most stable way of handling this,
142 which is why it is the default.
144 When this is the symbol `integrate', then during cycling, plain
145 list items will *temporarily* be interpreted as outline headlines
146 with a level given by 1000+i where i is the indentation of the
147 bullet. This setting can lead to strange effects when switching
149 subtree decides what children should be listed. If that first
151 number, all true children and grand children of the outline
152 heading will be exposed in a children' view."
160 "Default bullet type installed when demoting an item.
161 This is an association list, for each bullet type, this alist will point
162 to the bullet that should be used when this item is demoted.
163 For example,
165 (setq org-list-demote-modify-bullet
168 will make
170 + Movies
171 + Silence of the Lambs
172 + My Cousin Vinny
173 + Books
174 + The Hunt for Red October
175 + The Road to Omaha
177 into
179 + Movies
180 - Silence of the Lambs
181 - My Cousin Vinny
182 + Books
183 - The Hunt for Red October
184 - The Road to Omaha"
202 "The character that makes a line with leading number an ordered list item.
203 Valid values are ?. and ?\). To get both terminators, use t."
210 "Non-nil means single character alphabetical bullets are allowed.
211 Both uppercase and lowercase are handled. Lists with more than
212 26 items will fallback to standard numbering. Alphabetical
218 "A regular expression matching bullets that should have 2 spaces after them.
219 When nil, no bullet will have two spaces after them. When
220 a string, it will be used as a regular expression. When the
221 bullet type of a list is changed, the new bullet type will be
222 matched against this regexp. If it matches, there will be two
223 spaces instead of one after the bullet in each item of the list."
230 "Determine where plain lists should end.
231 Valid values are: `regexp', `indent' or `both'.
233 When set to `regexp', Org will look into two variables,
234 `org-empty-line-terminates-plain-lists' and the more general
235 `org-list-end-regexp', to determine what will end lists.
237 When set to `indent', a list will end whenever a line following
238 an item, but not starting one, is less or equally indented than
239 the first item of the list.
241 When set to `both', each of the preceding methods is applied to
242 determine lists endings. This is the default method."
250 "Non-nil means an empty line ends all plain list levels.
251 This variable only makes sense if `org-list-ending-method' is set
252 to `regexp' or `both'. This is then equivalent to set
258 "Regexp matching the end of all plain list levels.
260 blank lines. `org-empty-line-terminates-plain-lists' has
261 precedence over it."
268 "Non-nil means apply set of rules when acting on lists.
269 By default, automatic actions are taken when using
274 rules by setting them to nil. Valid rules are:
276 bullet when non-nil, cycling bullet do not allow lists at
277 column 0 to have * as a bullet and descriptions lists
278 to be numbered.
279 checkbox when non-nil, checkbox statistics is updated each time
280 you either insert a new checkbox or toggle a checkbox.
281 It also prevents from inserting a checkbox in a
282 description item.
283 indent when non-nil, indenting or outdenting list top-item
284 with its subtree will move the whole list and
285 outdenting a list whose bullet is * to column 0 will
289 :key-type
294 :value-type
298 "Non-nil means commands implying motion in lists should be cyclic.
300 In that case, the item following the last item is the first one,
301 and the item preceding the first item is the last one.
310 "Hook that is run whenever Org thinks checkbox statistics should be updated.
311 This hook runs even if checkbox rule in
312 `org-list-automatic-rules' does not apply, so it can be used to
313 implement alternative ways of collecting statistics
317 "Non-nil means checkbox statistics counts only the state of direct children.
318 When nil, all boxes below the cookie are counted.
319 This can be set to nil on a per-node basis using a COOKIE_DATA property
325 "Maximum indentation for the second line of a description list.
326 When the indentation would be larger than this, it will become
327 5 characters instead."
332 "Additional indentation for sub-items in a list.
333 By setting this to a small number, usually 1 or 2, one can more
334 clearly distinguish sub-items in a list."
340 % END RECEIVE ORGLST %n
342 #+ORGLST: SEND %n org-list-to-latex
343 -
346 @c END RECEIVE ORGLST %n
347 @ignore
348 #+ORGLST: SEND %n org-list-to-texinfo
349 -
352 <!-- END RECEIVE ORGLST %n -->
353 <!--
354 #+ORGLST: SEND %n org-list-to-html
355 -
357 "Templates for radio lists in different major modes.
358 All occurrences of %n in a template will be replaced with the name of the
359 list, obtained by prompting the user."
367 "Names of blocks where lists are not allowed.
371 "Context types where lists will be interpreted during export.
373 Valid types are `drawer', `inlinetask' and `block'. More
374 specifically, type `block' is determined by the variable
378 ;;; Predicates and regexps
382 org-list-end-regexp)
383 "Regex corresponding to the end of a list.
391 "Matches a list item and puts everything into groups:
392 group 1: bullet
393 group 2: counter
394 group 3: checkbox
398 "Return the correct regular expression for plain lists."
409 "Regexp matching the beginning of a plain list item."
413 "Is point at a list item with REGEXP after bullet?"
422 ;; Ignore counter if any
427 "Is point in a context where lists are allowed?"
431 "Return item beginning position when in a plain list, nil otherwise.
432 This checks `org-list-ending-method'."
444 ;; Indentation isn't meaningful when point starts at an empty
445 ;; line or an inline task.
448 10000
454 ;; Detect if cursor in amidst `org-list-end-re'. First, count
455 ;; number HL of hard lines it takes, then call `org-in-regexp'
456 ;; to compute its boundaries END-BOUNDS. When point is
457 ;; in-between, move cursor before regexp beginning.
469 ;; Look for an item, less indented that reference line if
470 ;; `org-list-ending-method' isn't `regexp'.
475 ;; This is exactly what we want.
480 ;; At upper bound of search or looking at the end of a
481 ;; previous list: search is over.
486 ;; Skip blocks, drawers, inline-tasks, blank lines
496 ;; Text at column 0 cannot belong to a list: stop.
498 ;; Normal text less indented than reference line, take
499 ;; it as new reference.
506 "Is point in a line starting a hand-formatted item?"
512 "Is point at the bullet of a plain list item?"
518 "Is point at a line starting a plain list item with a timer?"
523 "Is point at a description list item?"
527 "Is point at a line starting a plain-list item with a checklet?"
531 "Is point at a line starting a plain-list item with a counter?"
537 ;;; Structures and helper functions
540 "Determine context, and its boundaries, around point.
542 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
543 are boundaries and CONTEXT is a symbol among `drawer', `block',
544 `invalid', `inlinetask' and nil.
546 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
552 ;; Get positions of surrounding headings. This is the
553 ;; default context.
558 ;; Is point inside a drawer?
560 ;; Can't use org-drawers-regexp as this function might
561 ;; be called in buffers not in Org mode.
572 lim-down))
575 ;; Is point strictly in a block, and of which type?
586 lim-down))
592 ;; Is point in an inlinetask?
605 ;; Return context boundaries and type.
609 "Return structure of list at point.
611 A list structure is an alist where key is point at item, and
612 values are:
613 1. indentation,
614 2. bullet with trailing whitespace,
615 3. bullet counter, if any,
616 4. checkbox, if any,
617 5. description tag, if any,
618 6. position at item end.
620 Thus the following list, where numbers in parens are
621 point-at-bol:
623 - [X] first item (1)
624 1. sub-item 1 (18)
625 5. [@5] sub-item 2 (34)
626 some other text belonging to first item (55)
627 - last item (97)
628 + tag :: description (109)
629 (131)
631 will get the following structure:
639 Assume point is at an item."
654 ind itm-lst itm-lst-2 end-lst end-lst-2 struct
657 ;; Return association at point.
661 ind
668 ;; Ensure list ends at the first blank line.
672 ;; 1. Read list from starting item to its beginning, and save
673 ;; top item position and indentation in BEG-CELL. Also store
674 ;; ending position of items in END-LST.
682 ;; At upward limit: if we ended at an item, store it,
683 ;; else dimiss useless data recorded above BEG-CELL.
684 ;; Jump to part 2.
692 ;; At a verbatim block, go before its beginning. Move
693 ;; from eol to ensure `previous-single-property-change'
694 ;; will return a value.
699 ;; Looking at a list ending regexp. Dismiss useless
700 ;; data recorded above BEG-CELL. Jump to part 2.
706 ;; Point is at an item. Add data to ITM-LST. It may
707 ;; also end a previous item: save it in END-LST. If
708 ;; ind is less or equal than BEG-CELL and there is no
709 ;; end at this ind or lesser, this item becomes the new
710 ;; BEG-CELL.
719 ;; Skip blocks, drawers, inline tasks, blank lines.
730 ;; From there, point is not at an item. Unless ending
731 ;; method is `regexp', interpret line's indentation:
732 ;; - text at column 0 is necessarily out of any list.
733 ;; Dismiss data recorded above BEG-CELL. Jump to
734 ;; part 2.
735 ;; - any other case may be an ending position for an
736 ;; hypothetical item above. Store it and proceed.
746 ;; 2. Read list from starting point to its end, that is until we
747 ;; get out of context, or that a non-item line is less or
748 ;; equally indented than BEG-CELL's cdr. Also, store ending
749 ;; position of items in END-LST-2.
756 ;; At downward limit: this is de facto the end of the
757 ;; list. Save point as an ending position, and jump to
758 ;; part 3.
761 ;; At a verbatim block, move to its end. Point is at bol
762 ;; and 'org-example property is set by whole lines:
763 ;; `next-single-property-change' always return a value.
767 ;; Looking at a list ending regexp. Save point as an
768 ;; ending position and jump to part 3.
773 ;; Point is at an item. Add data to ITM-LST-2. It may
774 ;; also end a previous item, so save it in END-LST-2.
778 ;; Skip inline tasks and blank lines along the way
783 ;; Ind is lesser or equal than BEG-CELL's. The list is
784 ;; over: store point as an ending position and jump to
785 ;; part 3.
790 ;; Else, if ind is lesser or equal than previous item's,
791 ;; this is an ending position: store it. In any case,
792 ;; skip block or drawer at point, and move to next line.
805 ;; 3. Correct ill-formed lists by ensuring top item is the least
806 ;; indented.
813 ;; Trim bullet so item will be seen as different
814 ;; when compared with repaired version.
816 struct))
817 ;; 4. Associate each item to its end pos.
819 ;; 5. Return STRUCT
820 struct)))
823 "Associate proper ending point to items in STRUCT.
825 END-LIST is a pseudo-alist where car is indentation and cdr is
826 ending position.
828 This function modifies STRUCT."
834 ;; Remove end candidates behind current item.
837 ;; Add end position to item assoc.
843 struct)))
846 "Return alist between item and previous item in STRUCT."
848 struct)))
852 struct)))
855 "Return alist between item and parent in STRUCT."
877 ;;; Accessors
880 "Return the Nth value of KEY in STRUCT."
884 "Set the Nth value of KEY in STRUCT to NEW.
889 "Return indentation of ITEM in STRUCT."
893 "Set indentation of ITEM in STRUCT to IND.
898 "Return bullet of ITEM in STRUCT."
902 "Set bullet of ITEM in STRUCT to BULLET.
907 "Return counter of ITEM in STRUCT."
911 "Return checkbox of ITEM in STRUCT or nil."
915 "Set checkbox of ITEM in STRUCT to CHECKBOX.
920 "Return end position of ITEM in STRUCT."
924 "Return end position of ITEM in STRUCT."
928 "Return point at end of ITEM in STRUCT, before any blank line.
929 Point returned is at end of line."
936 "Return parent of ITEM or nil.
937 STRUCT is the list structure. PARENTS is the alist of parents,
938 as returned by `org-list-parents-alist'."
943 "Non-nil if ITEM has a child.
945 STRUCT is the list structure.
947 Value returned is the position of the first child of ITEM."
952 child-maybe)))
955 "Return next item in same sub-list as ITEM, or nil.
956 STRUCT is the list structure. PREVS is the alist of previous
957 items, as returned by `org-list-prevs-alist'."
961 "Return previous item in same sub-list as ITEM, or nil.
962 STRUCT is the list structure. PREVS is the alist of previous
963 items, as returned by `org-list-prevs-alist'."
967 "List all items having ITEM as a common ancestor, or nil.
968 STRUCT is the list structure."
971 subtree)
976 sub-struct))
980 "List all items in the same sub-list as ITEM.
981 STRUCT is the list structure. PREVS is the alist of previous
982 items, as returned by `org-list-prevs-alist'."
985 before-item after-item)
993 "List all children of ITEM, or nil.
994 STRUCT is the list structure. PARENTS is the alist of parents, as
995 returned by `org-list-parents-alist'."
1003 "Return point at beginning of list.
1004 STRUCT is the list structure."
1008 "Return point at bottom of list.
1009 STRUCT is the list structure."
1014 "Return point at beginning of sub-list ITEM belongs.
1015 STRUCT is the list structure. PREVS is the alist of previous
1016 items, as returned by `org-list-prevs-alist'."
1020 first-item))
1025 "Return point at last item of sub-list ITEM belongs.
1026 STRUCT is the list structure. PREVS is the alist of previous
1027 items, as returned by `org-list-prevs-alist'."
1031 last-item))
1034 "Return point at end of sub-list ITEM belongs.
1035 STRUCT is the list structure. PREVS is the alist of previous
1036 items, as returned by `org-list-prevs-alist'."
1040 "Return the type of the list containing ITEM, as a symbol.
1042 STRUCT is the list structure. PREVS is the alist of previous
1043 items, as returned by `org-list-prevs-alist'.
1045 Possible types are `descriptive', `ordered' and `unordered'. The
1046 type is determined by the first item of the list."
1054 ;;; Searching
1057 "Search a string in valid contexts for lists.
1058 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1059 in `re-search-forward'."
1063 ;; 1. No match: return to origin or bound, depending on NOERR.
1066 nil)))
1067 ;; 2. Match in valid context: return point. Else, continue
1068 ;; searching.
1072 "Like `re-search-backward' but stop only where lists are recognized.
1073 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1074 `re-search-backward'."
1079 "Like `re-search-forward' but stop only where lists are recognized.
1080 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1081 `re-search-forward'."
1086 ;;; Methods on structures
1089 "Return BULLET with the correct number of whitespaces.
1090 It determines the number of whitespaces to append by looking at
1091 `org-list-two-spaces-after-bullet-regexp'."
1095 org-list-two-spaces-after-bullet-regexp bullet))
1096 " "
1102 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1103 Blank lines at the end of items are left in place. Return the
1104 new structure after the changes.
1106 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1107 to the same sub-list.
1109 This function modifies STRUCT."
1122 ;; 1. Move effectively items in buffer.
1126 ;; 2. Now modify struct. No need to re-read the list, the
1127 ;; transformation is just a shift of positions. Some special
1128 ;; attention is required for items ending at END-A and END-B
1129 ;; as empty spaces are not moved there. In others words,
1130 ;; item BEG-A will end with whitespaces that were at the end
1131 ;; of BEG-B and the same applies to BEG-B.
1153 struct)
1157 "Return number of blank lines that should separate items in list.
1159 POS is the position of point where `org-list-insert-item' was called.
1161 STRUCT is the list structure. PREVS is the alist of previous
1162 items, as returned by `org-list-prevs-alist'.
1164 Assume point is at item's beginning. If the item is alone, apply
1165 some heuristics to guess the result."
1170 usr-blank)
1172 ;; Trivial cases where there should be none.
1174 org-empty-line-terminates-plain-lists)
1176 ;; When `org-blank-before-new-entry' says so, it is 1.
1178 ;; `plain-list-item' is 'auto. Count blank lines separating
1179 ;; neighbours items in list.
1182 ;; Is there a next item?
1185 ;; Is there a previous item?
1188 ;; User inserted blank lines, trust him.
1194 usr-blank)
1195 ;; Are there blank lines inside the list so far?
1201 ;; Default choice: no blank line.
1205 "Insert a new list item at POS and return the new structure.
1206 If POS is before first character after bullet of the item, the
1207 new item will be created before the current one.
1209 STRUCT is the list structure. PREVS is the the alist of previous
1210 items, as returned by `org-list-prevs-alist'.
1212 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1213 after the bullet. Cursor will be after this text once the
1214 function ends.
1216 This function modifies STRUCT."
1218 ;; 1. Get information about list: position of point with regards
1219 ;; to item start (BEFOREP), blank lines number separating items
1220 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1228 pos struct prevs))
1229 ;; 2. Build the new item to be created. Concatenate same
1230 ;; bullet as item, checkbox, text AFTER-BULLET if
1231 ;; provided, and text cut from point to end of item
1232 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1233 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1234 ;; between what was cut and what was inserted in buffer
1235 ;; is stored in SIZE-OFFSET.
1239 ind))
1246 ;; If POS is greater than ITEM-END, then point is
1247 ;; in some white lines after the end of the list.
1248 ;; Those must be removed, or they will be left,
1249 ;; stacking up after the list.
1259 text-cut))))
1263 ;; 4. Insert effectively item into buffer.
1267 ;; 5. Add new item to STRUCT.
1272 ;; Before inserted item, positions don't change but
1273 ;; an item ending after insertion has its end shifted
1274 ;; by SIZE-OFFSET.
1277 ;; Trivial cases where current item isn't split in
1278 ;; two. Just shift every item after new one by
1279 ;; ITEM-SIZE.
1283 ;; Item is split in two: elements before POS are just
1284 ;; shifted by ITEM-SIZE. In the case item would end
1285 ;; after split POS, ending is only shifted by
1286 ;; SIZE-OFFSET.
1292 ;; Elements after POS are moved into new item.
1293 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1294 ;; doesn't appear in buffer yet.
1300 (+ end size-offset
1302 ;; Elements at ITEM-END or after are only shifted by
1303 ;; SIZE-OFFSET.
1306 struct)
1309 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1310 ;; exchange ITEM with the next item in list. Position cursor
1311 ;; after bullet, counter, checkbox, and label.
1317 struct)))
1320 "Remove ITEM from the list and return the new structure.
1322 STRUCT is the list structure."
1325 ;; If ITEM ends with the list, delete blank lines
1326 ;; before it.
1331 item)))
1332 ;; Remove item from buffer.
1334 ;; Remove item from structure and shift others items accordingly.
1335 ;; Don't forget to shift also ending position when appropriate.
1353 struct)))))
1356 "Send ITEM to destination DEST.
1358 STRUCT is the list structure.
1360 DEST can have various values.
1362 If DEST is a buffer position, the function will assume it points
1363 to another item in the same list as ITEM, and will move the
1364 latter just before the former.
1366 If DEST is `begin' \(resp. `end'\), ITEM will be moved at the
1367 beginning \(resp. end\) of the list it belongs to.
1370 be moved at the Nth position in the list.
1372 If DEST is `kill', ITEM will be deleted and its body will be
1373 added to the kill-ring.
1375 If DEST is `delete', ITEM will be deleted.
1377 This function returns, destructively, the new list structure."
1380 ;; Grab full item body minus its bullet.
1389 item-end)))
1390 ;; Change DEST into a buffer position. A trick is needed
1391 ;; when ITEM is meant to be sent at the end of the list.
1392 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1393 ;; nil and insertion point (INS-POINT) to the first line's
1394 ;; end of the last item, we ensure the new item will be
1395 ;; inserted after the last item, and not after any of its
1396 ;; hypothetical sub-items.
1412 ;; Send ITEM at the end of the list.
1428 ;; 1. Structure returned by `org-list-insert-item' may not be
1429 ;; accurate, as it cannot see sub-items included in BODY.
1430 ;; Thus, first compute the real structure so far.
1438 ;; 1.1. Remove the item just created in structure.
1440 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1443 struct
1451 new-end
1453 moved-items))
1455 ;; 2. Eventually delete extra copy of the item and clean marker.
1462 "Outdent items between positions START and END.
1464 STRUCT is the list structure. PARENTS is the alist of items'
1465 parents, as returned by `org-list-parents-alist'.
1467 START is included, END excluded."
1473 ;; Item not yet in zone: keep association.
1475 ;; Item out of zone: follow associations in ACC.
1479 ;; Item has no parent: error
1482 ;; Parent is outdented: keep association.
1486 ;; Parent isn't outdented: reparent to grand-parent.
1488 parent struct parents)))
1494 "Indent items between positions START and END.
1496 STRUCT is the list structure. PARENTS is the alist of parents
1497 and PREVS is the alist of previous items, returned by,
1498 respectively, `org-list-parents-alist' and
1499 `org-list-prevs-alist'.
1501 START is included and END excluded.
1503 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1504 bullets between START and END."
1518 ;; Item not yet in zone: keep association.
1521 ;; Item out of zone: follow associations in ACC.
1525 ;; Item is in zone...
1527 ;; Check if bullet needs to be changed.
1530 ;; First item indented but not parent: error
1533 ;; First item and parent indented: keep same
1534 ;; parent.
1536 ;; Previous item not indented: reparent to it.
1538 ;; Previous item indented: reparent like it.
1545 ;;; Repairing structures
1548 "Non-nil if list starting at FIRST can have alphabetical bullets.
1550 STRUCT is list structure. PREVS is the alist of previous items,
1551 as returned by `org-list-prevs-alist'."
1555 ;; Pretend that bullets are uppercase and check if alphabet
1556 ;; is sufficient, taking counters into account.
1560 ;; Virtually determine current bullet
1562 ;; Counters are not case-sensitive.
1565 ;; Test if bullet would be over z or Z.
1569 ;; All items checked. All good.
1570 t))))
1573 "Increment BULLET if applicable."
1576 ;; Num bullet: increment it.
1580 nil nil bullet))
1581 ;; Alpha bullet: increment it.
1585 nil nil bullet))
1586 ;; Unordered bullet: leave it.
1590 "Verify and correct bullets in STRUCT.
1591 PREVS is the alist of previous items, as returned by
1592 `org-list-prevs-alist'.
1594 This function modifies STRUCT."
1598 ;; Set bullet of ITEM in STRUCT, depending on the type of
1599 ;; first item of the list, the previous bullet and counter
1600 ;; if any.
1609 item struct
1612 ;; Alpha counter in alpha list: use counter.
1616 ;; Use cond to be sure `string-match' is used in
1617 ;; both cases.
1623 ;; Num counter in a num list: use counter.
1628 ;; No counter: increase, if needed, previous bullet.
1631 ;; Alpha counter at first item: use counter.
1640 ;; Num counter at first item: use counter.
1645 ;; First bullet is alpha uppercase: use "A".
1648 ;; First bullet is alpha lowercase: use "a".
1651 ;; First bullet is num: use "1".
1654 ;; Not an ordered list: keep bullet.
1659 "Verify and correct indentation in STRUCT.
1661 PARENTS is the alist of parents, as returned by
1662 `org-list-parents-alist'.
1664 If numeric optional argument BULLET-SIZE is set, assume all
1665 bullets in list have this length to determine new indentation.
1667 This function modifies STRUCT."
1674 ;; Indent like parent + length of parent's bullet +
1675 ;; sub-list offset.
1681 org-list-indent-offset))
1682 ;; If no parent, indent like top-point.
1687 "Verify and correct checkboxes in STRUCT.
1689 PARENTS is the alist of parents and PREVS is the alist of
1690 previous items, as returned by, respectively,
1691 `org-list-parents-alist' and `org-list-prevs-alist'.
1693 If ORDERED is non-nil, a checkbox can only be checked when every
1694 checkbox before it is checked too. If there was an attempt to
1695 break this rule, the function will return the blocking item. In
1696 all others cases, the return value will be nil.
1698 This function modifies STRUCT."
1708 item struct
1714 ;; Parent has no boxed child: leave box as-is.
1716 parent-list)
1717 ;; 1. List all parents with a checkbox.
1724 all-items)
1725 ;; 2. Sort those parents by decreasing indentation.
1730 ;; 3. For each parent, get all children's checkboxes to determine
1731 ;; and set its checkbox accordingly.
1733 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1738 ;; There are boxes checked after an unchecked one: fix that.
1743 ;; Verify once again the structure, without ORDERED.
1745 ;; Return blocking item.
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.
1871 STRUCT is the list structure. PARENTS is the alist of parents,
1872 as returned by `org-list-parents-alist'."
1873 ;; Order of functions matters here: checkboxes and endings need
1874 ;; correct indentation to be set, and indentation needs correct
1875 ;; bullets.
1876 ;;
1877 ;; 0. Save a copy of structure before modifications
1879 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1880 ;; order to get items endings and bullets properly
1882 ;; 2. Get pseudo-alist of ending positions and sort it by position.
1883 ;; Then associate them to the structure.
1890 ;; To determine real ind of an ending position that is
1891 ;; not at an item, we have to find the item it belongs
1892 ;; to: it is the last item (ITEM-UP), whose ending is
1893 ;; further than the position we're interested in.
1896 ;; Else part is for the bottom point.
1898 end-pos)
1899 end-list)))
1902 struct)
1905 ;; 3. Get bullets right.
1908 ;; 4. Now get real indentation.
1910 ;; 5. Eventually fix checkboxes.
1912 ;; 6. Apply structure modifications to buffer.
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 ;;; Interactive functions
1988 "Go to the beginning of the current item.
1989 Throw an error when not in a list."
1995 "Go to the beginning item of the current list or sublist.
1996 Throw an error when not in a list."
2007 "Go to the end of the current list or sublist.
2008 Throw an error when not in a list."
2019 "Go to the end of the current item.
2020 Throw an error when not in a list."
2030 "Move to the beginning of the previous item.
2031 Throw an error when not in a list. Also throw an error when at
2032 first item, unless `org-list-use-circular-motion' is non-nil."
2048 "Move to the beginning of the next item.
2049 Throw an error when not in a list. Also throw an error when at
2050 last item, unless `org-list-use-circular-motion' is non-nil."
2066 "Move the item at point down, i.e. swap with following item.
2067 Sub-items (items with larger indentation) are considered part of
2068 the item, so this really moves item trees."
2087 "Move the item at point up, i.e. swap with previous item.
2088 Sub-items (items with larger indentation) are considered part of
2089 the item, so this really moves item trees."
2106 "Insert a new item at the current level.
2107 If cursor is before first character after bullet of the item, the
2108 new item will be created before the current one.
2110 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2112 Return t when things worked, nil when we are not in an item, or
2113 item is invisible."
2116 ;; If cursor isn't is a list or if list is invisible, return nil.
2124 ;; Timer list: delegate to `org-timer-item'.
2129 ;; If we're in a description list, ask for the new term.
2132 ;; Don't insert a checkbox if checkbox rule is applied
2133 ;; and it is a description item.
2137 org-list-automatic-rules)))))))
2144 t)))))
2147 "Fix indentation, bullets and checkboxes is the list at point."
2155 "Cycle through the different itemize/enumerate bullets.
2156 This cycle the entire list level through the sequence:
2158 `-' -> `+' -> `*' -> `1.' -> `1)'
2160 If WHICH is a valid string, use that as the new bullet. If WHICH
2161 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2162 `previous', cycle backwards."
2183 ;; Compute list of possible bullets, depending on context.
2186 ;; *-bullets are not allowed at column 0.
2189 ;; Description items cannot be numbered.
2212 ;; Use a short variation of `org-list-write-struct' as there's
2213 ;; no need to go through all the steps.
2221 "Toggle the checkbox in the current line.
2222 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2223 double prefix, set checkbox to [-].
2225 When there is an active region, toggle status or presence of the
2226 first checkbox there, and make every item inside have the same
2227 status or presence, respectively.
2229 If the cursor is in a headline, apply this to all checkbox items
2230 in the text below the heading, taking as reference the first item
2231 in subtree, ignoring drawers."
2235 block-item
2236 lim-up
2237 lim-down
2248 ;; In a region, start at first item in region.
2258 ;; On an heading, start at first item after drawers and
2259 ;; time-stamps (scheduled, etc.).
2270 ;; Just one item: set SINGLEP flag.
2276 ;; Determine the checkbox going to be applied to all items
2277 ;; within bounds.
2288 ;; When an item is found within bounds, grab the full list at
2289 ;; point structure, then: (1) set check-box of all its items
2290 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2291 ;; whole list, (3) move point after the list.
2305 e struct
2306 ;; If there is no box at item, leave as-is
2307 ;; unless function was called with C-u prefix.
2310 ref-checkbox
2311 cur-box))))
2312 items-to-toggle)
2314 struct parents prevs orderedp))
2315 ;; Report some problems due to ORDERED status of subtree.
2316 ;; If only one box was being checked, throw an error, else,
2317 ;; only signal problems.
2321 "Checkbox blocked because of unchecked box at line %d"
2325 "Checkboxes were removed due to unchecked box at line %d"
2334 "Reset all checkboxes in an entry subtree."
2351 "Update the checkbox statistics in the current section.
2352 This will find all statistic cookies like [57%] and [6/12] and
2353 update them with the current numbers.
2355 With optional prefix argument ALL, do this for the whole buffer."
2359 (box-re "^[ \t]*\\([-+*]\\|\\([0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2371 ;; Return number of checked boxes and boxes of all types
2372 ;; in all structures in STRUCTS. If RECURSIVEP is
2373 ;; non-nil, also count boxes in sub-lists. If ITEM is
2374 ;; nil, count across the whole structure, else count only
2375 ;; across subtree whose ancestor is ITEM.
2392 items))))
2395 structs)
2398 cookies-list structs-bak box-num)
2400 ;; 1. Build an alist for each cookie found within BOUNDS. The
2401 ;; key will be position at beginning of cookie and values
2402 ;; ending position, format of cookie, and a cell whose car is
2403 ;; number of checked boxes to report, and cdr total number of
2404 ;; boxes.
2414 ;; Cookie is at an heading, but specifically for todo,
2415 ;; not for checkboxes: skip it.
2421 ;; Cookie is at an heading, but all lists before next
2422 ;; heading already have been read. Use data collected
2423 ;; in STRUCTS-BAK. This should only happen when
2424 ;; heading has more than one cookie on it.
2427 backup-end))
2429 ;; Cookie is at a fresh heading. Grab structure of
2430 ;; every list containing a checkbox between point and
2431 ;; next headline, and save them in STRUCTS-BAK.
2435 structs-bak nil)
2442 ;; Cookie is at an item, and we already have list
2443 ;; structure stored in STRUCTS-BAK.
2446 ;; Only lists in no special context are stored.
2449 ;; Cookie is at an item, but we need to compute list
2450 ;; structure.
2456 ;; Else, cookie found is at a wrong place. Skip it.
2458 cookies-list))))
2459 ;; 2. Apply alist to buffer, in reverse order so positions stay
2460 ;; unchanged after cookie modifications.
2475 cookies-list))))
2478 "Select the face for checkbox statistics.
2479 The face will be `org-done' when all relevant boxes are checked.
2480 Otherwise it will be `org-todo'."
2483 'org-checkbox-statistics-done
2487 'org-checkbox-statistics-done
2491 "Update checkbox statistics unless turned off by user."
2499 "Indent a local list item including its children.
2500 When number ARG is a negative, item will be outdented, otherwise
2501 it will be indented.
2503 If a region is active, all items inside will be moved.
2505 If NO-SUBTREE is non-nil, only indent the item itself, not its
2506 children.
2508 STRUCT is the list structure.
2510 Return t if successful."
2519 ;; Are we going to move the whole list?
2526 t))))
2527 ;; Determine begin and end points of zone to indent. If moving
2528 ;; more than one item, save them for subsequent moves.
2544 ;; Special case: moving top-item with indent rule.
2552 ;; Change bullet if necessary.
2558 ;; Shift every item by OFFSET and fix bullets. Then
2559 ;; apply changes to buffer.
2563 struct)
2566 ;; Forbidden move:
2568 ;; If only one item is moved, it mustn't have a child.
2572 ;; If a subtree or region is moved, the last item
2573 ;; of the subtree mustn't have a child.
2578 struct)))))
2581 ;; Normal shifting
2589 t)
2592 "Outdent a local list item, but not its children.
2593 If a region is active, all items inside will be moved."
2601 "Indent a local list item, but not its children.
2602 If a region is active, all items inside will be moved."
2610 "Outdent a local list item including its children.
2611 If a region is active, all items inside will be moved."
2625 "Indent a local list item including its children.
2626 If a region is active, all items inside will be moved."
2641 "Cycle levels of indentation of an empty item.
2642 The first run indents the item, if applicable. Subsequents runs
2643 outdent it at meaningful levels in the list. When done, item is
2644 put back at its original position with its original bullet.
2646 Return t at each successful move."
2652 ;; Accept empty items or if cycle has already started.
2663 ;; When in the middle of the cycle, try to outdent first. If
2664 ;; it fails, and point is still at initial position, indent.
2665 ;; Else, re-create it at its original position.
2674 ;; Break cycle
2676 ;; If a cycle is starting, remember indentation and bullet,
2677 ;; then try to indent. If it fails, try to outdent.
2683 t))))
2686 "Sort list items.
2687 The cursor may be at any item of the list that should be sorted.
2688 Sublists are not sorted. Checkboxes, if any, are ignored.
2690 Sorting can be alphabetically, numerically, by date/time as given
2691 by a time stamp, by a property or by priority.
2693 Comparing entries ignores case by default. However, with an
2694 optional argument WITH-CASE, the sorting considers case as well.
2696 The command prompts for the sorting type unless it has been given
2697 to the function through the SORTING-TYPE argument, which needs to
2698 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
2699 meaning of each character:
2701 n Numerically, by converting the beginning of the item to a number.
2702 a Alphabetically. Only the first line of item is checked.
2703 t By date/time, either the first active time stamp in the entry, if
2704 any, or by the first inactive one. In a timer list, sort the timers.
2706 Capital letters will reverse the sort order.
2708 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2709 a function to be called with point at the beginning of the
2710 record. It must return either a string or a number that should
2711 serve as the sorting key for that record. It will then use
2712 COMPARE-FUNC to compare entries."
2757 ;; If it is a timer list, convert timer to seconds
2770 value))
2774 next-record
2775 end-record
2776 value-to-sort
2777 nil
2778 sort-func)
2779 ;; Read and fix list again, as `sort-subr' probably destroyed
2780 ;; its structure.
2786 ;;; Send and receive lists
2789 "Parse the list at point and maybe DELETE it.
2791 Return a list whose car is a symbol of list type, among
2792 `ordered', `unordered' and `descriptive'. Then, each item is
2793 a list whose car is counter, and cdr are strings and other
2794 sub-lists. Inside strings, check-boxes are replaced by
2797 For example, the following list:
2799 1. first item
2800 + sub-item one
2801 + [X] sub-item two
2802 more text in first item
2803 2. [@3] last item
2805 will be parsed as:
2807 \(ordered
2809 \(unordered
2815 Point is left at list end."
2821 out
2822 parse-item ; for byte-compiler
2825 ;; Return text between BEG and END, trimmed, with
2826 ;; checkboxes replaced.
2837 text)))))
2840 ;; Return a list whose car is list type and cdr a list of
2841 ;; items' body.
2847 ;; Return a list containing counter of item, if any, text
2848 ;; and any sublist inside it.
2854 ;; Get counter number. For alphabetic counter, get
2855 ;; its position in the alphabet.
2866 ;; If item has a child, store text between bullet and
2867 ;; next child, then recursively parse all sublists. At
2868 ;; the end of each sublist, check for the presence of
2869 ;; text belonging to the original item.
2879 ;; Remove children from the list just parsed.
2881 ;; There is a chunk of text belonging to the
2882 ;; item if last child doesn't end where next
2883 ;; child starts or where item ends.
2887 body))))
2890 ;; Store output, take care of cursor position and deletion of
2891 ;; list, then return output.
2900 out))
2903 "Convert the plain list at point into a subtree."
2911 "Insert a radio list template appropriate for this major mode."
2915 name pos)
2926 "Send a transformed version of this list to the receiver position.
2927 With argument MAYBE, fail quietly if no transformation is defined
2928 for this list."
2934 (unless (looking-at "[ \t]*#\\+ORGLST[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
2953 beg txt)
2957 ;; Find the insertion place
2962 name
2976 "Trim line breaks in a list ITEM."
2980 "Convert a LIST parsed through `org-list-parse-list' to other formats.
2981 Valid parameters PARAMS are:
2983 :ustart String to start an unordered list
2984 :uend String to end an unordered list
2986 :ostart String to start an ordered list
2987 :oend String to end an ordered list
2989 :dstart String to start a descriptive list
2990 :dend String to end a descriptive list
2991 :dtstart String to start a descriptive term
2992 :dtend String to end a descriptive term
2993 :ddstart String to start a description
2994 :ddend String to end a description
2996 :splice When set to t, return only list body lines, don't wrap
2997 them into :[u/o]start and :[u/o]end. Default is nil.
2999 :istart String to start a list item.
3000 :icount String to start an item with a counter.
3001 :iend String to end a list item
3002 :isep String to separate items
3003 :lsep String to separate sublists
3004 :csep String to separate text from a sub-list
3006 :cboff String to insert for an unchecked check-box
3007 :cbon String to insert for a checked check-box
3008 :cbtrans String to insert for a check-box in transitional state
3010 :nobr Non-nil means remove line breaks in lists items.
3012 Alternatively, each parameter can also be a form returning
3013 a string. These sexp can use keywords `counter' and `depth',
3014 reprensenting respectively counter associated to the current
3015 item, and depth of the current sub-list, starting at 0.
3016 Obviously, `counter' is only available for parameters applying to
3017 items."
3041 export-sublist ; for byte-compiler
3044 ;; Export an item ITEM of type TYPE, at DEPTH. First
3045 ;; string in item is treated in a special way as it can
3046 ;; bring extra information that needs to be processed.
3052 ;; Stick DTSTART to ISTART by
3053 ;; left-trimming the latter.
3057 istart))
3064 ;; Replace checkbox if any is found.
3072 ;; Replace line breaks if required
3074 ;; Insert descriptive term if TYPE is `descriptive'.
3083 first)))
3094 ;; Export sublist SUB at DEPTH.
3112 "Convert LIST into a LaTeX list.
3113 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3114 with overruling parameters for `org-list-to-generic'."
3116 list
3125 ;; LaTeX increments counter just before
3126 ;; using it, so set it to the desired
3127 ;; value, minus one.
3134 params)))
3137 "Convert LIST into a HTML list.
3138 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3139 with overruling parameters for `org-list-to-generic'."
3141 list
3153 params)))
3156 "Convert LIST into a Texinfo list.
3157 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3158 with overruling parameters for `org-list-to-generic'."
3160 list
3171 params)))
3174 "Convert LIST into an Org subtree.
3175 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3176 with overruling parameters for `org-list-to-generic'."
3186 ;; Return the string for the heading, depending on depth D
3187 ;; of current sub-list.
3192 oddeven-level)
3193 ?*)
3196 list
3198 '(:splice t
3205 params))))
3209 ;;; org-list.el ends here