| blob | a86c145a9ee0b4af77c0e5aaaef10b069fafcd93 |
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 altern DOT org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 7.7
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
29 ;; This file contains the code dealing with plain lists in Org-mode.
31 ;; The fundamental idea behind lists work is to use structures.
32 ;; A structure is a snapshot of the list, in the shape of data tree
33 ;; (see `org-list-struct').
35 ;; Once the list structure is stored, it is possible to make changes
36 ;; directly on it or get useful information about the list, with the
37 ;; two helper functions, namely `org-list-parents-alist' and
38 ;; `org-list-prevs-alist', and using accessors or methods.
40 ;; Structure is eventually applied to the buffer with
41 ;; `org-list-write-struct'. This function repairs (bullets,
42 ;; indentation, checkboxes) the structure before applying it. It
43 ;; should be called near the end of any function working on
44 ;; 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. If
52 ;; the cursor is amidst the buffer, it is possible to find the
53 ;; closest item with `org-list-search-backward', or
54 ;; `org-list-search-forward', applied to `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'. Possibly use
66 ;; `org-update-checkbox-count-maybe' if checkboxes might have been
67 ;; modified.
69 ;; Computing a list structure can be a costly operation on huge lists
70 ;; (a few thousand lines long). Thus, code should follow the rule :
71 ;; "collect once, use many". As a corollary, it is usally a bad idea
72 ;; to use directly an interactive function inside the code, as those,
73 ;; being independent entities, read the whole list structure another
74 ;; time.
76 ;;; Code:
131 ;;; Configuration variables
134 "Options concerning plain lists in Org-mode."
139 "When t, make TAB cycle visibility on plain list items.
140 Cycling plain lists works only when the cursor is on a plain list
141 item. When the cursor is on an outline heading, plain lists are
142 treated as text. This is the most stable way of handling this,
143 which is why it is the default.
145 When this is the symbol `integrate', then during cycling, plain
146 list items will *temporarily* be interpreted as outline headlines
147 with a level given by 1000+i where i is the indentation of the
148 bullet. This setting can lead to strange effects when switching
150 subtree decides what children should be listed. If that first
152 number, all true children and grand children of the outline
153 heading will be exposed in a children' view."
161 "Default bullet type installed when demoting an item.
162 This is an association list, for each bullet type, this alist will point
163 to the bullet that should be used when this item is demoted.
164 For example,
166 (setq org-list-demote-modify-bullet
169 will make
171 + Movies
172 + Silence of the Lambs
173 + My Cousin Vinny
174 + Books
175 + The Hunt for Red October
176 + The Road to Omaha
178 into
180 + Movies
181 - Silence of the Lambs
182 - My Cousin Vinny
183 + Books
184 - The Hunt for Red October
185 - The Road to Omaha"
203 "The character that makes a line with leading number an ordered list item.
204 Valid values are ?. and ?\). To get both terminators, use t."
211 "Non-nil means single character alphabetical bullets are allowed.
212 Both uppercase and lowercase are handled. Lists with more than
213 26 items will fallback to standard numbering. Alphabetical
219 "A regular expression matching bullets that should have 2 spaces after them.
220 When nil, no bullet will have two spaces after them. When
221 a string, it will be used as a regular expression. When the
222 bullet type of a list is changed, the new bullet type will be
223 matched against this regexp. If it matches, there will be two
224 spaces instead of one after the bullet in each item of the list."
231 "Determine where plain lists should end.
232 Valid values are: `regexp', `indent' or `both'.
234 When set to `regexp', Org will look into two variables,
235 `org-empty-line-terminates-plain-lists' and the more general
236 `org-list-end-regexp', to determine what will end lists.
238 When set to `indent', a list will end whenever a line following
239 an item, but not starting one, is less or equally indented than
240 the first item of the list.
242 When set to `both', each of the preceding methods is applied to
243 determine lists endings. This is the default method."
251 "Non-nil means an empty line ends all plain list levels.
252 This variable only makes sense if `org-list-ending-method' is set
253 to `regexp' or `both'. This is then equivalent to set
259 "Regexp matching the end of all plain list levels.
261 blank lines. `org-empty-line-terminates-plain-lists' has
262 precedence over it."
269 "Non-nil means apply set of rules when acting on lists.
270 By default, automatic actions are taken when using
275 rules by setting them to nil. Valid rules are:
277 bullet when non-nil, cycling bullet do not allow lists at
278 column 0 to have * as a bullet and descriptions lists
279 to be numbered.
280 checkbox when non-nil, checkbox statistics is updated each time
281 you either insert a new checkbox or toggle a checkbox.
282 It also prevents from inserting a checkbox in a
283 description item.
284 indent when non-nil, indenting or outdenting list top-item
285 with its subtree will move the whole list and
286 outdenting a list whose bullet is * to column 0 will
290 :key-type
295 :value-type
299 "Non-nil means commands implying motion in lists should be cyclic.
301 In that case, the item following the last item is the first one,
302 and the item preceding the first item is the last one.
311 "Hook that is run whenever Org thinks checkbox statistics should be updated.
312 This hook runs even if checkbox rule in
313 `org-list-automatic-rules' does not apply, so it can be used to
314 implement alternative ways of collecting statistics
318 "Non-nil means checkbox statistics counts only the state of direct children.
319 When nil, all boxes below the cookie are counted.
320 This can be set to nil on a per-node basis using a COOKIE_DATA property
326 "Maximum indentation for the second line of a description list.
327 When the indentation would be larger than this, it will become
328 5 characters instead."
333 "Additional indentation for sub-items in a list.
334 By setting this to a small number, usually 1 or 2, one can more
335 clearly distinguish sub-items in a list."
341 % END RECEIVE ORGLST %n
343 #+ORGLST: SEND %n org-list-to-latex
344 -
347 @c END RECEIVE ORGLST %n
348 @ignore
349 #+ORGLST: SEND %n org-list-to-texinfo
350 -
353 <!-- END RECEIVE ORGLST %n -->
354 <!--
355 #+ORGLST: SEND %n org-list-to-html
356 -
358 "Templates for radio lists in different major modes.
359 All occurrences of %n in a template will be replaced with the name of the
360 list, obtained by prompting the user."
368 "Names of blocks where lists are not allowed.
372 "Context types where lists will be interpreted during export.
374 Valid types are `drawer', `inlinetask' and `block'. More
375 specifically, type `block' is determined by the variable
379 ;;; Predicates and regexps
383 org-list-end-regexp)
384 "Regex corresponding to the end of a list.
392 "Matches a list item and puts everything into groups:
393 group 1: bullet
394 group 2: counter
395 group 3: checkbox
399 "Return the correct regular expression for plain lists."
410 "Regexp matching the beginning of a plain list item."
414 "Is point at a list item with REGEXP after bullet?"
423 ;; Ignore counter if any
428 "Is point in a context where lists are allowed?"
432 "Return item beginning position when in a plain list, nil otherwise.
433 This checks `org-list-ending-method'."
445 ;; Indentation isn't meaningful when point starts at an empty
446 ;; line or an inline task.
449 10000
455 ;; Detect if cursor in amidst `org-list-end-re'. First, count
456 ;; number HL of hard lines it takes, then call `org-in-regexp'
457 ;; to compute its boundaries END-BOUNDS. When point is
458 ;; in-between, move cursor before regexp beginning.
470 ;; Look for an item, less indented that reference line if
471 ;; `org-list-ending-method' isn't `regexp'.
476 ;; This is exactly what we want.
481 ;; At upper bound of search or looking at the end of a
482 ;; previous list: search is over.
487 ;; Skip blocks, drawers, inline-tasks, blank lines
497 ;; Text at column 0 cannot belong to a list: stop.
499 ;; Normal text less indented than reference line, take
500 ;; it as new reference.
507 "Is point in a line starting a hand-formatted item?"
513 "Is point at the bullet of a plain list item?"
519 "Is point at a line starting a plain list item with a timer?"
524 "Is point at a description list item?"
528 "Is point at a line starting a plain-list item with a checklet?"
532 "Is point at a line starting a plain-list item with a counter?"
538 ;;; Structures and helper functions
541 "Determine context, and its boundaries, around point.
543 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
544 are boundaries and CONTEXT is a symbol among `drawer', `block',
545 `invalid', `inlinetask' and nil.
547 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
553 ;; Get positions of surrounding headings. This is the
554 ;; default context.
559 ;; Is point inside a drawer?
561 ;; Can't use org-drawers-regexp as this function might
562 ;; be called in buffers not in Org mode.
573 lim-down))
576 ;; Is point strictly in a block, and of which type?
587 lim-down))
593 ;; Is point in an inlinetask?
606 ;; Return context boundaries and type.
610 "Return structure of list at point.
612 A list structure is an alist where key is point at item, and
613 values are:
614 1. indentation,
615 2. bullet with trailing whitespace,
616 3. bullet counter, if any,
617 4. checkbox, if any,
618 5. description tag, if any,
619 6. position at item end.
621 Thus the following list, where numbers in parens are
622 point-at-bol:
624 - [X] first item (1)
625 1. sub-item 1 (18)
626 5. [@5] sub-item 2 (34)
627 some other text belonging to first item (55)
628 - last item (97)
629 + tag :: description (109)
630 (131)
632 will get the following structure:
640 Assume point is at an item."
655 ind itm-lst itm-lst-2 end-lst end-lst-2 struct
658 ;; Return association at point.
662 ind
669 ;; Ensure list ends at the first blank line.
673 ;; 1. Read list from starting item to its beginning, and save
674 ;; top item position and indentation in BEG-CELL. Also store
675 ;; ending position of items in END-LST.
683 ;; At upward limit: if we ended at an item, store it,
684 ;; else dismiss useless data recorded above BEG-CELL.
685 ;; Jump to part 2.
693 ;; At a verbatim block, go before its beginning. Move
694 ;; from eol to ensure `previous-single-property-change'
695 ;; will return a value.
700 ;; Looking at a list ending regexp. Dismiss useless
701 ;; data recorded above BEG-CELL. Jump to part 2.
707 ;; Point is at an item. Add data to ITM-LST. It may
708 ;; also end a previous item: save it in END-LST. If
709 ;; ind is less or equal than BEG-CELL and there is no
710 ;; end at this ind or lesser, this item becomes the new
711 ;; BEG-CELL.
720 ;; Skip blocks, drawers, inline tasks, blank lines.
731 ;; From there, point is not at an item. Unless ending
732 ;; method is `regexp', interpret line's indentation:
733 ;; - text at column 0 is necessarily out of any list.
734 ;; Dismiss data recorded above BEG-CELL. Jump to
735 ;; part 2.
736 ;; - any other case may be an ending position for an
737 ;; hypothetical item above. Store it and proceed.
747 ;; 2. Read list from starting point to its end, that is until we
748 ;; get out of context, or that a non-item line is less or
749 ;; equally indented than BEG-CELL's cdr. Also, store ending
750 ;; position of items in END-LST-2.
757 ;; At downward limit: this is de facto the end of the
758 ;; list. Save point as an ending position, and jump to
759 ;; part 3.
762 ;; At a verbatim block, move to its end. Point is at bol
763 ;; and 'org-example property is set by whole lines:
764 ;; `next-single-property-change' always return a value.
768 ;; Looking at a list ending regexp. Save point as an
769 ;; ending position and jump to part 3.
774 ;; Point is at an item. Add data to ITM-LST-2. It may
775 ;; also end a previous item, so save it in END-LST-2.
779 ;; Skip inline tasks and blank lines along the way
784 ;; Ind is lesser or equal than BEG-CELL's. The list is
785 ;; over: store point as an ending position and jump to
786 ;; part 3.
791 ;; Else, if ind is lesser or equal than previous item's,
792 ;; this is an ending position: store it. In any case,
793 ;; skip block or drawer at point, and move to next line.
806 ;; 3. Correct ill-formed lists by ensuring top item is the least
807 ;; indented.
814 ;; Trim bullet so item will be seen as different
815 ;; when compared with repaired version.
817 struct))
818 ;; 4. Associate each item to its end pos.
820 ;; 5. Return STRUCT
821 struct)))
824 "Associate proper ending point to items in STRUCT.
826 END-LIST is a pseudo-alist where car is indentation and cdr is
827 ending position.
829 This function modifies STRUCT."
835 ;; Remove end candidates behind current item.
838 ;; Add end position to item assoc.
844 struct)))
847 "Return alist between item and previous item in STRUCT."
849 struct)))
853 struct)))
856 "Return alist between item and parent in STRUCT."
878 ;;; Accessors
881 "Return the Nth value of KEY in STRUCT."
885 "Set the Nth value of KEY in STRUCT to NEW.
890 "Return indentation of ITEM in STRUCT."
894 "Set indentation of ITEM in STRUCT to IND.
899 "Return bullet of ITEM in STRUCT."
903 "Set bullet of ITEM in STRUCT to BULLET.
908 "Return counter of ITEM in STRUCT."
912 "Return checkbox of ITEM in STRUCT or nil."
916 "Set checkbox of ITEM in STRUCT to CHECKBOX.
921 "Return end position of ITEM in STRUCT."
925 "Return end position of ITEM in STRUCT."
929 "Return point at end of ITEM in STRUCT, before any blank line.
930 Point returned is at end of line."
937 "Return parent of ITEM or nil.
938 STRUCT is the list structure. PARENTS is the alist of parents,
939 as returned by `org-list-parents-alist'."
944 "Non-nil if ITEM has a child.
946 STRUCT is the list structure.
948 Value returned is the position of the first child of ITEM."
953 child-maybe)))
956 "Return next item in same sub-list as ITEM, or nil.
957 STRUCT is the list structure. PREVS is the alist of previous
958 items, as returned by `org-list-prevs-alist'."
962 "Return previous item in same sub-list as ITEM, or nil.
963 STRUCT is the list structure. PREVS is the alist of previous
964 items, as returned by `org-list-prevs-alist'."
968 "List all items having ITEM as a common ancestor, or nil.
969 STRUCT is the list structure."
972 subtree)
977 sub-struct))
981 "List all items in the same sub-list as ITEM.
982 STRUCT is the list structure. PREVS is the alist of previous
983 items, as returned by `org-list-prevs-alist'."
986 before-item after-item)
994 "List all children of ITEM, or nil.
995 STRUCT is the list structure. PARENTS is the alist of parents, as
996 returned by `org-list-parents-alist'."
1004 "Return point at beginning of list.
1005 STRUCT is the list structure."
1009 "Return point at bottom of list.
1010 STRUCT is the list structure."
1015 "Return point at beginning of sub-list ITEM belongs.
1016 STRUCT is the list structure. PREVS is the alist of previous
1017 items, as returned by `org-list-prevs-alist'."
1021 first-item))
1026 "Return point at last item of sub-list ITEM belongs.
1027 STRUCT is the list structure. PREVS is the alist of previous
1028 items, as returned by `org-list-prevs-alist'."
1032 last-item))
1035 "Return point at end of sub-list ITEM belongs.
1036 STRUCT is the list structure. PREVS is the alist of previous
1037 items, as returned by `org-list-prevs-alist'."
1041 "Return the type of the list containing ITEM, as a symbol.
1043 STRUCT is the list structure. PREVS is the alist of previous
1044 items, as returned by `org-list-prevs-alist'.
1046 Possible types are `descriptive', `ordered' and `unordered'. The
1047 type is determined by the first item of the list."
1055 ;;; Searching
1058 "Search a string in valid contexts for lists.
1059 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1060 in `re-search-forward'."
1064 ;; 1. No match: return to origin or bound, depending on NOERR.
1067 nil)))
1068 ;; 2. Match in valid context: return point. Else, continue
1069 ;; searching.
1073 "Like `re-search-backward' but stop only where lists are recognized.
1074 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1075 `re-search-backward'."
1080 "Like `re-search-forward' but stop only where lists are recognized.
1081 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1082 `re-search-forward'."
1087 ;;; Methods on structures
1090 "Return BULLET with the correct number of whitespaces.
1091 It determines the number of whitespaces to append by looking at
1092 `org-list-two-spaces-after-bullet-regexp'."
1096 org-list-two-spaces-after-bullet-regexp bullet))
1097 " "
1103 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1104 Blank lines at the end of items are left in place. Return the
1105 new structure after the changes.
1107 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1108 to the same sub-list.
1110 This function modifies STRUCT."
1123 ;; 1. Move effectively items in buffer.
1127 ;; 2. Now modify struct. No need to re-read the list, the
1128 ;; transformation is just a shift of positions. Some special
1129 ;; attention is required for items ending at END-A and END-B
1130 ;; as empty spaces are not moved there. In others words,
1131 ;; item BEG-A will end with whitespaces that were at the end
1132 ;; of BEG-B and the same applies to BEG-B.
1154 struct)
1158 "Return number of blank lines that should separate items in list.
1160 POS is the position of point where `org-list-insert-item' was called.
1162 STRUCT is the list structure. PREVS is the alist of previous
1163 items, as returned by `org-list-prevs-alist'.
1165 Assume point is at item's beginning. If the item is alone, apply
1166 some heuristics to guess the result."
1171 usr-blank)
1173 ;; Trivial cases where there should be none.
1175 org-empty-line-terminates-plain-lists)
1177 ;; When `org-blank-before-new-entry' says so, it is 1.
1179 ;; `plain-list-item' is 'auto. Count blank lines separating
1180 ;; neighboring items in list.
1183 ;; Is there a next item?
1186 ;; Is there a previous item?
1189 ;; User inserted blank lines, trust him.
1195 usr-blank)
1196 ;; Are there blank lines inside the list so far?
1202 ;; Default choice: no blank line.
1206 "Insert a new list item at POS and return the new structure.
1207 If POS is before first character after bullet of the item, the
1208 new item will be created before the current one.
1210 STRUCT is the list structure. PREVS is the alist of previous
1211 items, as returned by `org-list-prevs-alist'.
1213 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1214 after the bullet. Cursor will be after this text once the
1215 function ends.
1217 This function modifies STRUCT."
1219 ;; 1. Get information about list: position of point with regards
1220 ;; to item start (BEFOREP), blank lines number separating items
1221 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1229 pos struct prevs))
1230 ;; 2. Build the new item to be created. Concatenate same
1231 ;; bullet as item, checkbox, text AFTER-BULLET if
1232 ;; provided, and text cut from point to end of item
1233 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1234 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1235 ;; between what was cut and what was inserted in buffer
1236 ;; is stored in SIZE-OFFSET.
1240 ind))
1247 ;; If POS is greater than ITEM-END, then point is
1248 ;; in some white lines after the end of the list.
1249 ;; Those must be removed, or they will be left,
1250 ;; stacking up after the list.
1260 text-cut))))
1264 ;; 4. Insert effectively item into buffer.
1268 ;; 5. Add new item to STRUCT.
1273 ;; Before inserted item, positions don't change but
1274 ;; an item ending after insertion has its end shifted
1275 ;; by SIZE-OFFSET.
1278 ;; Trivial cases where current item isn't split in
1279 ;; two. Just shift every item after new one by
1280 ;; ITEM-SIZE.
1284 ;; Item is split in two: elements before POS are just
1285 ;; shifted by ITEM-SIZE. In the case item would end
1286 ;; after split POS, ending is only shifted by
1287 ;; SIZE-OFFSET.
1293 ;; Elements after POS are moved into new item.
1294 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1295 ;; doesn't appear in buffer yet.
1301 (+ end size-offset
1303 ;; Elements at ITEM-END or after are only shifted by
1304 ;; SIZE-OFFSET.
1307 struct)
1310 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1311 ;; exchange ITEM with the next item in list. Position cursor
1312 ;; after bullet, counter, checkbox, and label.
1318 struct)))
1321 "Remove ITEM from the list and return the new structure.
1323 STRUCT is the list structure."
1326 ;; If ITEM ends with the list, delete blank lines
1327 ;; before it.
1332 item)))
1333 ;; Remove item from buffer.
1335 ;; Remove item from structure and shift others items accordingly.
1336 ;; Don't forget to shift also ending position when appropriate.
1354 struct)))))
1357 "Send ITEM to destination DEST.
1359 STRUCT is the list structure.
1361 DEST can have various values.
1363 If DEST is a buffer position, the function will assume it points
1364 to another item in the same list as ITEM, and will move the
1365 latter just before the former.
1367 If DEST is `begin' \(resp. `end'\), ITEM will be moved at the
1368 beginning \(resp. end\) of the list it belongs to.
1371 be moved at the Nth position in the list.
1373 If DEST is `kill', ITEM will be deleted and its body will be
1374 added to the kill-ring.
1376 If DEST is `delete', ITEM will be deleted.
1378 This function returns, destructively, the new list structure."
1381 ;; Grab full item body minus its bullet.
1390 item-end)))
1391 ;; Change DEST into a buffer position. A trick is needed
1392 ;; when ITEM is meant to be sent at the end of the list.
1393 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1394 ;; nil and insertion point (INS-POINT) to the first line's
1395 ;; end of the last item, we ensure the new item will be
1396 ;; inserted after the last item, and not after any of its
1397 ;; hypothetical sub-items.
1413 ;; Send ITEM at the end of the list.
1429 ;; 1. Structure returned by `org-list-insert-item' may not be
1430 ;; accurate, as it cannot see sub-items included in BODY.
1431 ;; Thus, first compute the real structure so far.
1439 ;; 1.1. Remove the item just created in structure.
1441 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1444 struct
1452 new-end
1454 moved-items))
1456 ;; 2. Eventually delete extra copy of the item and clean marker.
1463 "Outdent items between positions START and END.
1465 STRUCT is the list structure. PARENTS is the alist of items'
1466 parents, as returned by `org-list-parents-alist'.
1468 START is included, END excluded."
1474 ;; Item not yet in zone: keep association.
1476 ;; Item out of zone: follow associations in ACC.
1480 ;; Item has no parent: error
1483 ;; Parent is outdented: keep association.
1487 ;; Parent isn't outdented: reparent to grand-parent.
1489 parent struct parents)))
1495 "Indent items between positions START and END.
1497 STRUCT is the list structure. PARENTS is the alist of parents
1498 and PREVS is the alist of previous items, returned by,
1499 respectively, `org-list-parents-alist' and
1500 `org-list-prevs-alist'.
1502 START is included and END excluded.
1504 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1505 bullets between START and END."
1519 ;; Item not yet in zone: keep association.
1522 ;; Item out of zone: follow associations in ACC.
1526 ;; Item is in zone...
1528 ;; Check if bullet needs to be changed.
1531 ;; First item indented but not parent: error
1534 ;; First item and parent indented: keep same
1535 ;; parent.
1537 ;; Previous item not indented: reparent to it.
1539 ;; Previous item indented: reparent like it.
1546 ;;; Repairing structures
1549 "Non-nil if list starting at FIRST can have alphabetical bullets.
1551 STRUCT is list structure. PREVS is the alist of previous items,
1552 as returned by `org-list-prevs-alist'."
1556 ;; Pretend that bullets are uppercase and check if alphabet
1557 ;; is sufficient, taking counters into account.
1561 ;; Virtually determine current bullet
1563 ;; Counters are not case-sensitive.
1566 ;; Test if bullet would be over z or Z.
1570 ;; All items checked. All good.
1571 t))))
1574 "Increment BULLET if applicable."
1577 ;; Num bullet: increment it.
1581 nil nil bullet))
1582 ;; Alpha bullet: increment it.
1586 nil nil bullet))
1587 ;; Unordered bullet: leave it.
1591 "Verify and correct bullets in STRUCT.
1592 PREVS is the alist of previous items, as returned by
1593 `org-list-prevs-alist'.
1595 This function modifies STRUCT."
1599 ;; Set bullet of ITEM in STRUCT, depending on the type of
1600 ;; first item of the list, the previous bullet and counter
1601 ;; if any.
1610 item struct
1613 ;; Alpha counter in alpha list: use counter.
1617 ;; Use cond to be sure `string-match' is used in
1618 ;; both cases.
1624 ;; Num counter in a num list: use counter.
1629 ;; No counter: increase, if needed, previous bullet.
1632 ;; Alpha counter at first item: use counter.
1641 ;; Num counter at first item: use counter.
1646 ;; First bullet is alpha uppercase: use "A".
1649 ;; First bullet is alpha lowercase: use "a".
1652 ;; First bullet is num: use "1".
1655 ;; Not an ordered list: keep bullet.
1660 "Verify and correct indentation in STRUCT.
1662 PARENTS is the alist of parents, as returned by
1663 `org-list-parents-alist'.
1665 If numeric optional argument BULLET-SIZE is set, assume all
1666 bullets in list have this length to determine new indentation.
1668 This function modifies STRUCT."
1675 ;; Indent like parent + length of parent's bullet +
1676 ;; sub-list offset.
1682 org-list-indent-offset))
1683 ;; If no parent, indent like top-point.
1688 "Verify and correct checkboxes in STRUCT.
1690 PARENTS is the alist of parents and PREVS is the alist of
1691 previous items, as returned by, respectively,
1692 `org-list-parents-alist' and `org-list-prevs-alist'.
1694 If ORDERED is non-nil, a checkbox can only be checked when every
1695 checkbox before it is checked too. If there was an attempt to
1696 break this rule, the function will return the blocking item. In
1697 all others cases, the return value will be nil.
1699 This function modifies STRUCT."
1709 item struct
1715 ;; Parent has no boxed child: leave box as-is.
1717 parent-list)
1718 ;; 1. List all parents with a checkbox.
1725 all-items)
1726 ;; 2. Sort those parents by decreasing indentation.
1731 ;; 3. For each parent, get all children's checkboxes to determine
1732 ;; and set its checkbox accordingly.
1734 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1739 ;; There are boxes checked after an unchecked one: fix that.
1744 ;; Verify once again the structure, without ORDERED.
1746 ;; Return blocking item.
1750 "Apply set-difference between STRUCT and OLD-STRUCT to the buffer.
1752 OLD-STRUCT is the structure before any modifications, and STRUCT
1753 the structure to be applied. The function will only modify parts
1754 of the list which have changed.
1756 Initial position of cursor is restored after the changes."
1764 ;; Shift the indentation between END and BEG by DELTA.
1765 ;; Start from the line before END.
1774 ;; Skip inline tasks.
1777 ;; Shift only non-empty lines.
1784 ;; Replace ITEM first line elements with new elements from
1785 ;; STRUCT, if appropriate.
1795 ;; a. Replace bullet
1798 ;; b. Replace checkbox.
1807 ;; (goto-char (or (match-end 2) (match-end 1)))
1808 ;; (skip-chars-backward " \t")
1814 ;; c. Indent item to appropriate column.
1819 ;; 1. First get list of items and position endings. We maintain
1820 ;; two alists: ITM-SHIFT, determining indentation shift needed
1821 ;; at item, and END-POS, a pseudo-alist where key is ending
1822 ;; position and value point.
1835 ;; To determine real ind of an ending position that
1836 ;; is not at an item, we have to find the item it
1837 ;; belongs to: it is the last item (ITEM-UP), whose
1838 ;; ending is further than the position we're
1839 ;; interested in.
1843 old-struct)
1844 ;; 2. Slice the items into parts that should be shifted by the
1845 ;; same amount of indentation. The slices are returned in
1846 ;; reverse order so changes modifying buffer do not change
1847 ;; positions they refer to.
1850 '<))
1858 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1859 ;; end to beginning. Take a special action when beginning is
1860 ;; at item bullet.
1867 sliced-struct))
1868 ;; 4. Go back to initial position and clean marker.
1873 "Correct bullets, checkboxes and indentation in list at point.
1874 STRUCT is the list structure. PARENTS is the alist of parents,
1875 as returned by `org-list-parents-alist'."
1876 ;; Order of functions matters here: checkboxes and endings need
1877 ;; correct indentation to be set, and indentation needs correct
1878 ;; bullets.
1879 ;;
1880 ;; 0. Save a copy of structure before modifications
1882 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1883 ;; order to get items endings and bullets properly
1885 ;; 2. Get pseudo-alist of ending positions and sort it by position.
1886 ;; Then associate them to the structure.
1893 ;; To determine real ind of an ending position that is
1894 ;; not at an item, we have to find the item it belongs
1895 ;; to: it is the last item (ITEM-UP), whose ending is
1896 ;; further than the position we're interested in.
1899 ;; Else part is for the bottom point.
1901 end-pos)
1902 end-list)))
1905 struct)
1908 ;; 3. Get bullets right.
1911 ;; 4. Now get real indentation.
1913 ;; 5. Eventually fix checkboxes.
1915 ;; 6. Apply structure modifications to buffer.
1919 ;;; Misc Tools
1922 "Call FUNCTION on each item of the list at point.
1923 FUNCTION must be called with at least one argument: INIT-VALUE,
1924 that will contain the value returned by the function at the
1925 previous item, plus ARGS extra arguments.
1927 FUNCTION is applied on items in reverse order.
1929 As an example, \(org-apply-on-list \(lambda \(result\) \(1+ result\)\) 0\)
1930 will return the number of items in the current list.
1932 Sublists of the list are skipped. Cursor is always at the
1933 beginning of the item."
1945 value))
1948 "Set visibility of ITEM in STRUCT to VIEW.
1950 Possible values are: `folded', `children' or `subtree'. See
1951 `org-cycle' for more information."
1955 ;; Hide from eol
1957 item-end t)))
1959 ;; First show everything.
1961 ;; Then fold every child.
1966 children)))
1968 ;; Show everything
1973 "Return column at which body of ITEM should start."
1983 tcol))
1986 ;;; Interactive functions
1991 "Go to the beginning of the current item.
1992 Throw an error when not in a list."
1998 "Go to the beginning item of the current list or sublist.
1999 Throw an error when not in a list."
2010 "Go to the end of the current list or sublist.
2011 Throw an error when not in a list."
2022 "Go to the end of the current item.
2023 Throw an error when not in a list."
2033 "Move to the beginning of the previous item.
2034 Throw an error when not in a list. Also throw an error when at
2035 first item, unless `org-list-use-circular-motion' is non-nil."
2051 "Move to the beginning of the next item.
2052 Throw an error when not in a list. Also throw an error when at
2053 last item, unless `org-list-use-circular-motion' is non-nil."
2069 "Move the item at point down, i.e. swap with following item.
2070 Sub-items (items with larger indentation) are considered part of
2071 the item, so this really moves item trees."
2090 "Move the item at point up, i.e. swap with previous item.
2091 Sub-items (items with larger indentation) are considered part of
2092 the item, so this really moves item trees."
2109 "Insert a new item at the current level.
2110 If cursor is before first character after bullet of the item, the
2111 new item will be created before the current one.
2113 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2115 Return t when things worked, nil when we are not in an item, or
2116 item is invisible."
2119 ;; If cursor isn't is a list or if list is invisible, return nil.
2127 ;; Timer list: delegate to `org-timer-item'.
2132 ;; If we're in a description list, ask for the new term.
2135 ;; Don't insert a checkbox if checkbox rule is applied
2136 ;; and it is a description item.
2140 org-list-automatic-rules)))))))
2147 t)))))
2150 "Fix indentation, bullets and checkboxes is the list at point."
2158 "Cycle through the different itemize/enumerate bullets.
2159 This cycle the entire list level through the sequence:
2161 `-' -> `+' -> `*' -> `1.' -> `1)'
2163 If WHICH is a valid string, use that as the new bullet. If WHICH
2164 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2165 `previous', cycle backwards."
2186 ;; Compute list of possible bullets, depending on context.
2189 ;; *-bullets are not allowed at column 0.
2192 ;; Description items cannot be numbered.
2215 ;; Use a short variation of `org-list-write-struct' as there's
2216 ;; no need to go through all the steps.
2224 "Toggle the checkbox in the current line.
2225 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2226 double prefix, set checkbox to [-].
2228 When there is an active region, toggle status or presence of the
2229 first checkbox there, and make every item inside have the same
2230 status or presence, respectively.
2232 If the cursor is in a headline, apply this to all checkbox items
2233 in the text below the heading, taking as reference the first item
2234 in subtree, ignoring drawers."
2238 block-item
2239 lim-up
2240 lim-down
2251 ;; In a region, start at first item in region.
2261 ;; On an heading, start at first item after drawers and
2262 ;; time-stamps (scheduled, etc.).
2273 ;; Just one item: set SINGLEP flag.
2279 ;; Determine the checkbox going to be applied to all items
2280 ;; within bounds.
2291 ;; When an item is found within bounds, grab the full list at
2292 ;; point structure, then: (1) set check-box of all its items
2293 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2294 ;; whole list, (3) move point after the list.
2308 e struct
2309 ;; If there is no box at item, leave as-is
2310 ;; unless function was called with C-u prefix.
2313 ref-checkbox
2314 cur-box))))
2315 items-to-toggle)
2317 struct parents prevs orderedp))
2318 ;; Report some problems due to ORDERED status of subtree.
2319 ;; If only one box was being checked, throw an error, else,
2320 ;; only signal problems.
2324 "Checkbox blocked because of unchecked box at line %d"
2328 "Checkboxes were removed due to unchecked box at line %d"
2337 "Reset all checkboxes in an entry subtree."
2354 "Update the checkbox statistics in the current section.
2355 This will find all statistic cookies like [57%] and [6/12] and
2356 update them with the current numbers.
2358 With optional prefix argument ALL, do this for the whole buffer."
2362 (box-re "^[ \t]*\\([-+*]\\|\\([0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2374 ;; Return number of checked boxes and boxes of all types
2375 ;; in all structures in STRUCTS. If RECURSIVEP is
2376 ;; non-nil, also count boxes in sub-lists. If ITEM is
2377 ;; nil, count across the whole structure, else count only
2378 ;; across subtree whose ancestor is ITEM.
2395 items))))
2398 structs)
2401 cookies-list structs-bak box-num)
2403 ;; 1. Build an alist for each cookie found within BOUNDS. The
2404 ;; key will be position at beginning of cookie and values
2405 ;; ending position, format of cookie, and a cell whose car is
2406 ;; number of checked boxes to report, and cdr total number of
2407 ;; boxes.
2417 ;; Cookie is at an heading, but specifically for todo,
2418 ;; not for checkboxes: skip it.
2424 ;; Cookie is at an heading, but all lists before next
2425 ;; heading already have been read. Use data collected
2426 ;; in STRUCTS-BAK. This should only happen when
2427 ;; heading has more than one cookie on it.
2430 backup-end))
2432 ;; Cookie is at a fresh heading. Grab structure of
2433 ;; every list containing a checkbox between point and
2434 ;; next headline, and save them in STRUCTS-BAK.
2438 structs-bak nil)
2445 ;; Cookie is at an item, and we already have list
2446 ;; structure stored in STRUCTS-BAK.
2449 ;; Only lists in no special context are stored.
2452 ;; Cookie is at an item, but we need to compute list
2453 ;; structure.
2459 ;; Else, cookie found is at a wrong place. Skip it.
2461 cookies-list))))
2462 ;; 2. Apply alist to buffer, in reverse order so positions stay
2463 ;; unchanged after cookie modifications.
2478 cookies-list))))
2481 "Select the face for checkbox statistics.
2482 The face will be `org-done' when all relevant boxes are checked.
2483 Otherwise it will be `org-todo'."
2486 'org-checkbox-statistics-done
2490 'org-checkbox-statistics-done
2494 "Update checkbox statistics unless turned off by user."
2502 "Indent a local list item including its children.
2503 When number ARG is a negative, item will be outdented, otherwise
2504 it will be indented.
2506 If a region is active, all items inside will be moved.
2508 If NO-SUBTREE is non-nil, only indent the item itself, not its
2509 children.
2511 STRUCT is the list structure.
2513 Return t if successful."
2522 ;; Are we going to move the whole list?
2529 t))))
2530 ;; Determine begin and end points of zone to indent. If moving
2531 ;; more than one item, save them for subsequent moves.
2547 ;; Special case: moving top-item with indent rule.
2555 ;; Change bullet if necessary.
2561 ;; Shift every item by OFFSET and fix bullets. Then
2562 ;; apply changes to buffer.
2566 struct)
2569 ;; Forbidden move:
2571 ;; If only one item is moved, it mustn't have a child.
2575 ;; If a subtree or region is moved, the last item
2576 ;; of the subtree mustn't have a child.
2581 struct)))))
2584 ;; Normal shifting
2592 t)
2595 "Outdent a local list item, but not its children.
2596 If a region is active, all items inside will be moved."
2604 "Indent a local list item, but not its children.
2605 If a region is active, all items inside will be moved."
2613 "Outdent a local list item including its children.
2614 If a region is active, all items inside will be moved."
2628 "Indent a local list item including its children.
2629 If a region is active, all items inside will be moved."
2644 "Cycle levels of indentation of an empty item.
2645 The first run indents the item, if applicable. Subsequent runs
2646 outdent it at meaningful levels in the list. When done, item is
2647 put back at its original position with its original bullet.
2649 Return t at each successful move."
2655 ;; Accept empty items or if cycle has already started.
2666 ;; When in the middle of the cycle, try to outdent first. If
2667 ;; it fails, and point is still at initial position, indent.
2668 ;; Else, re-create it at its original position.
2677 ;; Break cycle
2679 ;; If a cycle is starting, remember indentation and bullet,
2680 ;; then try to indent. If it fails, try to outdent.
2686 t))))
2689 "Sort list items.
2690 The cursor may be at any item of the list that should be sorted.
2691 Sublists are not sorted. Checkboxes, if any, are ignored.
2693 Sorting can be alphabetically, numerically, by date/time as given
2694 by a time stamp, by a property or by priority.
2696 Comparing entries ignores case by default. However, with an
2697 optional argument WITH-CASE, the sorting considers case as well.
2699 The command prompts for the sorting type unless it has been given
2700 to the function through the SORTING-TYPE argument, which needs to
2701 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
2702 meaning of each character:
2704 n Numerically, by converting the beginning of the item to a number.
2705 a Alphabetically. Only the first line of item is checked.
2706 t By date/time, either the first active time stamp in the entry, if
2707 any, or by the first inactive one. In a timer list, sort the timers.
2709 Capital letters will reverse the sort order.
2711 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2712 a function to be called with point at the beginning of the
2713 record. It must return either a string or a number that should
2714 serve as the sorting key for that record. It will then use
2715 COMPARE-FUNC to compare entries."
2760 ;; If it is a timer list, convert timer to seconds
2773 value))
2777 next-record
2778 end-record
2779 value-to-sort
2780 nil
2781 sort-func)
2782 ;; Read and fix list again, as `sort-subr' probably destroyed
2783 ;; its structure.
2789 ;;; Send and receive lists
2792 "Parse the list at point and maybe DELETE it.
2794 Return a list whose car is a symbol of list type, among
2795 `ordered', `unordered' and `descriptive'. Then, each item is
2796 a list whose car is counter, and cdr are strings and other
2797 sub-lists. Inside strings, check-boxes are replaced by
2800 For example, the following list:
2802 1. first item
2803 + sub-item one
2804 + [X] sub-item two
2805 more text in first item
2806 2. [@3] last item
2808 will be parsed as:
2810 \(ordered
2812 \(unordered
2818 Point is left at list end."
2824 out
2825 parse-item ; for byte-compiler
2828 ;; Return text between BEG and END, trimmed, with
2829 ;; checkboxes replaced.
2840 text)))))
2843 ;; Return a list whose car is list type and cdr a list of
2844 ;; items' body.
2850 ;; Return a list containing counter of item, if any, text
2851 ;; and any sublist inside it.
2857 ;; Get counter number. For alphabetic counter, get
2858 ;; its position in the alphabet.
2869 ;; If item has a child, store text between bullet and
2870 ;; next child, then recursively parse all sublists. At
2871 ;; the end of each sublist, check for the presence of
2872 ;; text belonging to the original item.
2882 ;; Remove children from the list just parsed.
2884 ;; There is a chunk of text belonging to the
2885 ;; item if last child doesn't end where next
2886 ;; child starts or where item ends.
2890 body))))
2893 ;; Store output, take care of cursor position and deletion of
2894 ;; list, then return output.
2903 out))
2906 "Convert the plain list at point into a subtree."
2914 "Insert a radio list template appropriate for this major mode."
2918 name pos)
2929 "Send a transformed version of this list to the receiver position.
2930 With argument MAYBE, fail quietly if no transformation is defined
2931 for this list."
2937 (unless (looking-at "[ \t]*#\\+ORGLST[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
2956 beg txt)
2960 ;; Find the insertion place
2965 name
2979 "Convert a LIST parsed through `org-list-parse-list' to other formats.
2980 Valid parameters PARAMS are:
2982 :ustart String to start an unordered list
2983 :uend String to end an unordered list
2985 :ostart String to start an ordered list
2986 :oend String to end an ordered list
2988 :dstart String to start a descriptive list
2989 :dend String to end a descriptive list
2990 :dtstart String to start a descriptive term
2991 :dtend String to end a descriptive term
2992 :ddstart String to start a description
2993 :ddend String to end a description
2995 :splice When set to t, return only list body lines, don't wrap
2996 them into :[u/o]start and :[u/o]end. Default is nil.
2998 :istart String to start a list item.
2999 :icount String to start an item with a counter.
3000 :iend String to end a list item
3001 :isep String to separate items
3002 :lsep String to separate sublists
3003 :csep String to separate text from a sub-list
3005 :cboff String to insert for an unchecked check-box
3006 :cbon String to insert for a checked check-box
3007 :cbtrans String to insert for a check-box in transitional state
3009 Alternatively, each parameter can also be a form returning
3010 a string. These sexp can use keywords `counter' and `depth',
3011 representing respectively counter associated to the current
3012 item, and depth of the current sub-list, starting at 0.
3013 Obviously, `counter' is only available for parameters applying to
3014 items."
3037 export-sublist ; for byte-compiler
3040 ;; Export an item ITEM of type TYPE, at DEPTH. First
3041 ;; string in item is treated in a special way as it can
3042 ;; bring extra information that needs to be processed.
3048 ;; Stick DTSTART to ISTART by
3049 ;; left-trimming the latter.
3053 istart))
3060 ;; Replace checkbox if any is found.
3068 ;; Insert descriptive term if TYPE is `descriptive'.
3077 first)))
3088 ;; Export sublist SUB at DEPTH.
3106 "Convert LIST into a LaTeX list.
3107 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3108 with overruling parameters for `org-list-to-generic'."
3110 list
3119 ;; LaTeX increments counter just before
3120 ;; using it, so set it to the desired
3121 ;; value, minus one.
3128 params)))
3131 "Convert LIST into a HTML list.
3132 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3133 with overruling parameters for `org-list-to-generic'."
3135 list
3147 params)))
3150 "Convert LIST into a Texinfo list.
3151 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3152 with overruling parameters for `org-list-to-generic'."
3154 list
3165 params)))
3168 "Convert LIST into an Org subtree.
3169 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3170 with overruling parameters for `org-list-to-generic'."
3180 ;; Return the string for the heading, depending on depth D
3181 ;; of current sub-list.
3186 oddeven-level)
3187 ?*)
3190 list
3192 '(:splice t
3199 params))))
3204 ;;; org-list.el ends here