| blob | 6d25037a804bc79d5a2136eec3af46a1c38a5e15 |
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 core concept behind lists is their structure. A structure is
31 ;; a snapshot of the list, in the shape of a data tree (see
32 ;; `org-list-struct').
34 ;; Once the list structure is stored, it is possible to make changes
35 ;; on it that will be mirrored to the real list or to get information
36 ;; about the list, using accessors and methods provided in the
37 ;; library. Most of them require the use of one or two helper
38 ;; functions, namely `org-list-parents-alist' and
39 ;; `org-list-prevs-alist'.
41 ;; Structure is eventually applied to the buffer with
42 ;; `org-list-write-struct'. This function repairs (bullets,
43 ;; indentation, checkboxes) the list in the process. It should be
44 ;; called near the end of any function working on structures.
46 ;; Thus, a function applying to lists should usually follow this
47 ;; template:
49 ;; 1. Verify point is in a list and grab item beginning (with the same
50 ;; function `org-in-item-p'). If the function requires the cursor
51 ;; to be at item's bullet, `org-at-item-p' is more selective. It
52 ;; is also possible to move point to the closest item with
53 ;; `org-list-search-backward', or `org-list-search-forward',
54 ;; applied to the function `org-item-beginning-re'.
56 ;; 2. Get list structure with `org-list-struct'.
58 ;; 3. Compute one, or both, helper functions,
59 ;; (`org-list-parents-alist', `org-list-prevs-alist') depending on
60 ;; needed accessors.
62 ;; 4. Proceed with the modifications, using methods and accessors.
64 ;; 5. Verify and apply structure to buffer, using
65 ;; `org-list-write-struct'.
67 ;; 6. If changes made to the list might have modified check-boxes,
68 ;; call `org-update-checkbox-count-maybe'.
70 ;; Computing a structure can be a costly operation on huge lists (a
71 ;; few thousand lines long). Thus, code should follow the rule:
72 ;; "collect once, use many". As a corollary, it is usually a bad idea
73 ;; to use directly an interactive function inside the code, as those,
74 ;; being independant entities, read the whole list structure another
75 ;; time.
77 ;;; Code:
132 \f
133 ;;; Configuration variables
136 "Options concerning plain lists in Org-mode."
141 "When t, make TAB cycle visibility on plain list items.
142 Cycling plain lists works only when the cursor is on a plain list
143 item. When the cursor is on an outline heading, plain lists are
144 treated as text. This is the most stable way of handling this,
145 which is why it is the default.
147 When this is the symbol `integrate', then during cycling, plain
148 list items will *temporarily* be interpreted as outline headlines
149 with a level given by 1000+i where i is the indentation of the
150 bullet. This setting can lead to strange effects when switching
152 subtree decides what children should be listed. If that first
154 number, all true children and grand children of the outline
155 heading will be exposed in a children' view."
163 "Default bullet type installed when demoting an item.
164 This is an association list, for each bullet type, this alist will point
165 to the bullet that should be used when this item is demoted.
166 For example,
168 (setq org-list-demote-modify-bullet
171 will make
173 + Movies
174 + Silence of the Lambs
175 + My Cousin Vinny
176 + Books
177 + The Hunt for Red October
178 + The Road to Omaha
180 into
182 + Movies
183 - Silence of the Lambs
184 - My Cousin Vinny
185 + Books
186 - The Hunt for Red October
187 - The Road to Omaha"
205 "The character that makes a line with leading number an ordered list item.
206 Valid values are ?. and ?\). To get both terminators, use t."
213 "Non-nil means single character alphabetical bullets are allowed.
214 Both uppercase and lowercase are handled. Lists with more than
215 26 items will fallback to standard numbering. Alphabetical
221 "A regular expression matching bullets that should have 2 spaces after them.
222 When nil, no bullet will have two spaces after them. When
223 a string, it will be used as a regular expression. When the
224 bullet type of a list is changed, the new bullet type will be
225 matched against this regexp. If it matches, there will be two
226 spaces instead of one after the bullet in each item of the list."
233 "Determine where plain lists should end.
234 Valid values are: `regexp', `indent' or `both'.
236 When set to `regexp', Org will look into two variables,
237 `org-empty-line-terminates-plain-lists' and the more general
238 `org-list-end-regexp', to determine what will end lists.
240 When set to `indent', a list will end whenever a line following
241 an item, but not starting one, is less or equally indented than
242 the first item of the list.
244 When set to `both', each of the preceding methods is applied to
245 determine lists endings. This is the default method."
253 "Non-nil means an empty line ends all plain list levels.
254 This variable only makes sense if `org-list-ending-method' is set
255 to `regexp' or `both'. This is then equivalent to set
261 "Regexp matching the end of all plain list levels.
263 blank lines. `org-empty-line-terminates-plain-lists' has
264 precedence over it."
271 "Non-nil means apply set of rules when acting on lists.
272 By default, automatic actions are taken when using
277 rules by setting them to nil. Valid rules are:
279 bullet when non-nil, cycling bullet do not allow lists at
280 column 0 to have * as a bullet and descriptions lists
281 to be numbered.
282 checkbox when non-nil, checkbox statistics is updated each time
283 you either insert a new checkbox or toggle a checkbox.
284 It also prevents from inserting a checkbox in a
285 description item.
286 indent when non-nil, indenting or outdenting list top-item
287 with its subtree will move the whole list and
288 outdenting a list whose bullet is * to column 0 will
292 :key-type
297 :value-type
301 "Non-nil means commands implying motion in lists should be cyclic.
303 In that case, the item following the last item is the first one,
304 and the item preceding the first item is the last one.
313 "Hook that is run whenever Org thinks checkbox statistics should be updated.
314 This hook runs even if checkbox rule in
315 `org-list-automatic-rules' does not apply, so it can be used to
316 implement alternative ways of collecting statistics
320 "Non-nil means checkbox statistics counts only the state of direct children.
321 When nil, all boxes below the cookie are counted.
322 This can be set to nil on a per-node basis using a COOKIE_DATA property
328 "Maximum indentation for the second line of a description list.
329 When the indentation would be larger than this, it will become
330 5 characters instead."
335 "Additional indentation for sub-items in a list.
336 By setting this to a small number, usually 1 or 2, one can more
337 clearly distinguish sub-items in a list."
343 % END RECEIVE ORGLST %n
345 #+ORGLST: SEND %n org-list-to-latex
346 -
349 @c END RECEIVE ORGLST %n
350 @ignore
351 #+ORGLST: SEND %n org-list-to-texinfo
352 -
355 <!-- END RECEIVE ORGLST %n -->
356 <!--
357 #+ORGLST: SEND %n org-list-to-html
358 -
360 "Templates for radio lists in different major modes.
361 All occurrences of %n in a template will be replaced with the name of the
362 list, obtained by prompting the user."
370 "Names of blocks where lists are not allowed.
374 "Context types where lists will be interpreted during export.
376 Valid types are `drawer', `inlinetask' and `block'. More
377 specifically, type `block' is determined by the variable
381 \f
382 ;;; Predicates and regexps
386 org-list-end-regexp)
387 "Regex corresponding to the end of a list.
395 "Matches a list item and puts everything into groups:
396 group 1: bullet
397 group 2: counter
398 group 3: checkbox
402 "Return the correct regular expression for plain lists."
413 "Regexp matching the beginning of a plain list item."
417 "Is point at a list item with REGEXP after bullet?"
426 ;; Ignore counter if any
431 "Is point in a context where lists are allowed?"
435 "Return item beginning position when in a plain list, nil otherwise.
436 This checks `org-list-ending-method'."
448 ;; Indentation isn't meaningful when point starts at an empty
449 ;; line or an inline task.
452 10000
458 ;; Detect if cursor in amidst `org-list-end-re'. First, count
459 ;; number HL of hard lines it takes, then call `org-in-regexp'
460 ;; to compute its boundaries END-BOUNDS. When point is
461 ;; in-between, move cursor before regexp beginning.
473 ;; Look for an item, less indented that reference line if
474 ;; `org-list-ending-method' isn't `regexp'.
479 ;; This is exactly what we want.
484 ;; At upper bound of search or looking at the end of a
485 ;; previous list: search is over.
490 ;; Skip blocks, drawers, inline-tasks, blank lines
500 ;; Text at column 0 cannot belong to a list: stop.
502 ;; Normal text less indented than reference line, take
503 ;; it as new reference.
510 "Is point in a line starting a hand-formatted item?"
516 "Is point at the bullet of a plain list item?"
522 "Is point at a line starting a plain list item with a timer?"
527 "Is point at a description list item?"
531 "Is point at a line starting a plain-list item with a checklet?"
535 "Is point at a line starting a plain-list item with a counter?"
541 \f
542 ;;; Structures and helper functions
545 "Determine context, and its boundaries, around point.
547 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
548 are boundaries and CONTEXT is a symbol among `drawer', `block',
549 `invalid', `inlinetask' and nil.
551 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
557 ;; Get positions of surrounding headings. This is the
558 ;; default context.
563 ;; Is point inside a drawer?
565 ;; Can't use org-drawers-regexp as this function might
566 ;; be called in buffers not in Org mode.
577 lim-down))
580 ;; Is point strictly in a block, and of which type?
591 lim-down))
597 ;; Is point in an inlinetask?
610 ;; Return context boundaries and type.
614 "Return structure of list at point.
616 A list structure is an alist where key is point at item, and
617 values are:
618 1. indentation,
619 2. bullet with trailing whitespace,
620 3. bullet counter, if any,
621 4. checkbox, if any,
622 5. description tag, if any,
623 6. position at item end.
625 Thus the following list, where numbers in parens are
626 point-at-bol:
628 - [X] first item (1)
629 1. sub-item 1 (18)
630 5. [@5] sub-item 2 (34)
631 some other text belonging to first item (55)
632 - last item (97)
633 + tag :: description (109)
634 (131)
636 will get the following structure:
644 Assume point is at an item."
659 ind itm-lst itm-lst-2 end-lst end-lst-2 struct
662 ;; Return association at point.
666 ind
673 ;; Ensure list ends at the first blank line.
677 ;; 1. Read list from starting item to its beginning, and save
678 ;; top item position and indentation in BEG-CELL. Also store
679 ;; ending position of items in END-LST.
687 ;; At upward limit: if we ended at an item, store it,
688 ;; else dimiss useless data recorded above BEG-CELL.
689 ;; Jump to part 2.
697 ;; At a verbatim block, go before its beginning. Move
698 ;; from eol to ensure `previous-single-property-change'
699 ;; will return a value.
704 ;; Looking at a list ending regexp. Dismiss useless
705 ;; data recorded above BEG-CELL. Jump to part 2.
711 ;; Point is at an item. Add data to ITM-LST. It may
712 ;; also end a previous item: save it in END-LST. If
713 ;; ind is less or equal than BEG-CELL and there is no
714 ;; end at this ind or lesser, this item becomes the new
715 ;; BEG-CELL.
724 ;; Skip blocks, drawers, inline tasks, blank lines.
735 ;; From there, point is not at an item. Unless ending
736 ;; method is `regexp', interpret line's indentation:
737 ;; - text at column 0 is necessarily out of any list.
738 ;; Dismiss data recorded above BEG-CELL. Jump to
739 ;; part 2.
740 ;; - any other case may be an ending position for an
741 ;; hypothetical item above. Store it and proceed.
751 ;; 2. Read list from starting point to its end, that is until we
752 ;; get out of context, or that a non-item line is less or
753 ;; equally indented than BEG-CELL's cdr. Also, store ending
754 ;; position of items in END-LST-2.
761 ;; At downward limit: this is de facto the end of the
762 ;; list. Save point as an ending position, and jump to
763 ;; part 3.
766 ;; At a verbatim block, move to its end. Point is at bol
767 ;; and 'org-example property is set by whole lines:
768 ;; `next-single-property-change' always return a value.
772 ;; Looking at a list ending regexp. Save point as an
773 ;; ending position and jump to part 3.
778 ;; Point is at an item. Add data to ITM-LST-2. It may
779 ;; also end a previous item, so save it in END-LST-2.
783 ;; Skip inline tasks and blank lines along the way
788 ;; Ind is lesser or equal than BEG-CELL's. The list is
789 ;; over: store point as an ending position and jump to
790 ;; part 3.
795 ;; Else, if ind is lesser or equal than previous item's,
796 ;; this is an ending position: store it. In any case,
797 ;; skip block or drawer at point, and move to next line.
810 ;; 3. Associate each item to its end position.
812 ;; 4. Return STRUCT
813 struct)))
816 "Associate proper ending point to items in STRUCT.
818 END-LIST is a pseudo-alist where car is indentation and cdr is
819 ending position.
821 This function modifies STRUCT."
827 ;; Remove end candidates behind current item.
830 ;; Add end position to item assoc.
836 struct)))
839 "Return alist between item and previous item in STRUCT."
841 struct)))
845 struct)))
848 "Return alist between item and parent in STRUCT."
860 ;; A sub-list is over. Find the associated
861 ;; origin in IND-TO-ORI. If it cannot be
862 ;; found (ill-formed list), set its parent as
863 ;; the first item less indented. If there is
864 ;; none, make it a top-level item.
872 ind-to-ori)
875 ;; A sub-list starts. Every item at IND will
876 ;; have previous item as its parent.
881 ;; Another item in the same sub-list: it shares
882 ;; the same parent as the previous item.
887 \f
888 ;;; Accessors
891 "Return the Nth value of KEY in STRUCT."
895 "Set the Nth value of KEY in STRUCT to NEW.
900 "Return indentation of ITEM in STRUCT."
904 "Set indentation of ITEM in STRUCT to IND.
909 "Return bullet of ITEM in STRUCT."
913 "Set bullet of ITEM in STRUCT to BULLET.
918 "Return counter of ITEM in STRUCT."
922 "Return checkbox of ITEM in STRUCT or nil."
926 "Set checkbox of ITEM in STRUCT to CHECKBOX.
931 "Return end position of ITEM in STRUCT."
935 "Return end position of ITEM in STRUCT."
939 "Return point at end of ITEM in STRUCT, before any blank line.
940 Point returned is at end of line."
947 "Return parent of ITEM or nil.
948 STRUCT is the list structure. PARENTS is the alist of parents,
949 as returned by `org-list-parents-alist'."
954 "Non-nil if ITEM has a child.
956 STRUCT is the list structure.
958 Value returned is the position of the first child of ITEM."
963 child-maybe)))
966 "Return next item in same sub-list as ITEM, or nil.
967 STRUCT is the list structure. PREVS is the alist of previous
968 items, as returned by `org-list-prevs-alist'."
972 "Return previous item in same sub-list as ITEM, or nil.
973 STRUCT is the list structure. PREVS is the alist of previous
974 items, as returned by `org-list-prevs-alist'."
978 "List all items having ITEM as a common ancestor, or nil.
979 STRUCT is the list structure."
982 subtree)
987 sub-struct))
991 "List all items in the same sub-list as ITEM.
992 STRUCT is the list structure. PREVS is the alist of previous
993 items, as returned by `org-list-prevs-alist'."
996 before-item after-item)
1004 "List all children of ITEM, or nil.
1005 STRUCT is the list structure. PARENTS is the alist of parents,
1006 as returned by `org-list-parents-alist'."
1014 "Return point at beginning of list.
1015 STRUCT is the list structure."
1019 "Return point at bottom of list.
1020 STRUCT is the list structure."
1025 "Return point at beginning 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 first-item))
1036 "Return point at last item of sub-list ITEM belongs.
1037 STRUCT is the list structure. PREVS is the alist of previous
1038 items, as returned by `org-list-prevs-alist'."
1042 last-item))
1045 "Return point at end of sub-list ITEM belongs.
1046 STRUCT is the list structure. PREVS is the alist of previous
1047 items, as returned by `org-list-prevs-alist'."
1051 "Return the type of the list containing ITEM, as a symbol.
1053 STRUCT is the list structure. PREVS is the alist of previous
1054 items, as returned by `org-list-prevs-alist'.
1056 Possible types are `descriptive', `ordered' and `unordered'. The
1057 type is determined by the first item of the list."
1065 \f
1066 ;;; Searching
1069 "Search a string in valid contexts for lists.
1070 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1071 in `re-search-forward'."
1075 ;; 1. No match: return to origin or bound, depending on NOERR.
1078 nil)))
1079 ;; 2. Match in valid context: return point. Else, continue
1080 ;; searching.
1084 "Like `re-search-backward' but stop only where lists are recognized.
1085 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1086 `re-search-backward'."
1091 "Like `re-search-forward' but stop only where lists are recognized.
1092 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1093 `re-search-forward'."
1098 \f
1099 ;;; Methods on structures
1102 "Return BULLET with the correct number of whitespaces.
1103 It determines the number of whitespaces to append by looking at
1104 `org-list-two-spaces-after-bullet-regexp'."
1108 org-list-two-spaces-after-bullet-regexp bullet))
1109 " "
1115 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1116 Blank lines at the end of items are left in place. Return the
1117 new structure after the changes.
1119 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1120 to the same sub-list.
1122 This function modifies STRUCT."
1135 ;; 1. Move effectively items in buffer.
1139 ;; 2. Now modify struct. No need to re-read the list, the
1140 ;; transformation is just a shift of positions. Some special
1141 ;; attention is required for items ending at END-A and END-B
1142 ;; as empty spaces are not moved there. In others words,
1143 ;; item BEG-A will end with whitespaces that were at the end
1144 ;; of BEG-B and the same applies to BEG-B.
1166 struct)
1170 "Return number of blank lines that should separate items in list.
1172 POS is the position of point where `org-list-insert-item' was called.
1174 STRUCT is the list structure. PREVS is the alist of previous
1175 items, as returned by `org-list-prevs-alist'.
1177 Assume point is at item's beginning. If the item is alone, apply
1178 some heuristics to guess the result."
1183 usr-blank
1187 ;; Count blank lines above beginning of line.
1194 ;; Trivial cases where there should be none.
1196 org-empty-line-terminates-plain-lists)
1198 ;; When `org-blank-before-new-entry' says so, it is 1.
1200 ;; `plain-list-item' is 'auto. Count blank lines separating
1201 ;; neighbours items in list.
1204 ;; Is there a next item?
1207 ;; Is there a previous item?
1210 ;; User inserted blank lines, trust him.
1215 usr-blank)
1216 ;; Are there blank lines inside the list so far?
1222 ;; Default choice: no blank line.
1226 "Insert a new list item at POS and return the new structure.
1227 If POS is before first character after bullet of the item, the
1228 new item will be created before the current one.
1230 STRUCT is the list structure. PREVS is the the alist of previous
1231 items, as returned by `org-list-prevs-alist'.
1233 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1234 after the bullet. Cursor will be after this text once the
1235 function ends.
1237 This function modifies STRUCT."
1239 ;; 1. Get information about list: position of point with regards
1240 ;; to item start (BEFOREP), blank lines number separating items
1241 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1249 pos struct prevs))
1250 ;; 2. Build the new item to be created. Concatenate same
1251 ;; bullet as item, checkbox, text AFTER-BULLET if
1252 ;; provided, and text cut from point to end of item
1253 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1254 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1255 ;; between what was cut and what was inserted in buffer
1256 ;; is stored in SIZE-OFFSET.
1260 ind))
1267 ;; If POS is greater than ITEM-END, then point is
1268 ;; in some white lines after the end of the list.
1269 ;; Those must be removed, or they will be left,
1270 ;; stacking up after the list.
1280 text-cut))))
1284 ;; 4. Insert effectively item into buffer.
1288 ;; 5. Add new item to STRUCT.
1293 ;; Before inserted item, positions don't change but
1294 ;; an item ending after insertion has its end shifted
1295 ;; by SIZE-OFFSET.
1298 ;; Trivial cases where current item isn't split in
1299 ;; two. Just shift every item after new one by
1300 ;; ITEM-SIZE.
1304 ;; Item is split in two: elements before POS are just
1305 ;; shifted by ITEM-SIZE. In the case item would end
1306 ;; after split POS, ending is only shifted by
1307 ;; SIZE-OFFSET.
1313 ;; Elements after POS are moved into new item.
1314 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1315 ;; doesn't appear in buffer yet.
1321 (+ end size-offset
1323 ;; Elements at ITEM-END or after are only shifted by
1324 ;; SIZE-OFFSET.
1327 struct)
1330 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1331 ;; exchange ITEM with the next item in list. Position cursor
1332 ;; after bullet, counter, checkbox, and label.
1338 struct)))
1341 "Remove ITEM from the list and return the new structure.
1343 STRUCT is the list structure."
1346 ;; If ITEM ends with the list, delete blank lines
1347 ;; before it.
1352 item)))
1353 ;; Remove item from buffer.
1355 ;; Remove item from structure and shift others items accordingly.
1356 ;; Don't forget to shift also ending position when appropriate.
1374 struct)))))
1377 "Send ITEM to destination DEST.
1379 STRUCT is the list structure.
1381 DEST can have various values.
1383 If DEST is a buffer position, the function will assume it points
1384 to another item in the same list as ITEM, and will move the
1385 latter just before the former.
1387 If DEST is `begin' \(respectively `end'\), ITEM will be moved at
1388 the beginning \(respectively end\) of the list it belongs to.
1391 be moved at the Nth position in the list.
1393 If DEST is `kill', ITEM will be deleted and its body will be
1394 added to the kill-ring.
1396 If DEST is `delete', ITEM will be deleted.
1398 This function returns, destructively, the new list structure."
1401 ;; Grab full item body minus its bullet.
1410 item-end)))
1411 ;; Change DEST into a buffer position. A trick is needed
1412 ;; when ITEM is meant to be sent at the end of the list.
1413 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1414 ;; nil and insertion point (INS-POINT) to the first line's
1415 ;; end of the last item, we ensure the new item will be
1416 ;; inserted after the last item, and not after any of its
1417 ;; hypothetical sub-items.
1433 ;; Send ITEM at the end of the list.
1449 ;; 1. Structure returned by `org-list-insert-item' may not be
1450 ;; accurate, as it cannot see sub-items included in BODY.
1451 ;; Thus, first compute the real structure so far.
1459 ;; 1.1. Remove the item just created in structure.
1461 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1464 struct
1472 new-end
1474 moved-items))
1476 ;; 2. Eventually delete extra copy of the item and clean marker.
1483 "Outdent items between positions START and END.
1485 STRUCT is the list structure. PARENTS is the alist of items'
1486 parents, as returned by `org-list-parents-alist'.
1488 START is included, END excluded."
1494 ;; Item not yet in zone: keep association.
1496 ;; Item out of zone: follow associations in ACC.
1500 ;; Item has no parent: error
1503 ;; Parent is outdented: keep association.
1507 ;; Parent isn't outdented: reparent to grand-parent.
1509 parent struct parents)))
1515 "Indent items between positions START and END.
1517 STRUCT is the list structure. PARENTS is the alist of parents
1518 and PREVS is the alist of previous items, returned by,
1519 respectively, `org-list-parents-alist' and
1520 `org-list-prevs-alist'.
1522 START is included and END excluded.
1524 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1525 bullets between START and END."
1539 ;; Item not yet in zone: keep association.
1542 ;; Item out of zone: follow associations in ACC.
1546 ;; Item is in zone...
1548 ;; Check if bullet needs to be changed.
1551 ;; First item indented but not parent: error
1554 ;; First item and parent indented: keep same
1555 ;; parent.
1557 ;; Previous item not indented: reparent to it.
1559 ;; Previous item indented: reparent like it.
1566 \f
1567 ;;; Repairing structures
1570 "Non-nil if list starting at FIRST can have alphabetical bullets.
1572 STRUCT is list structure. PREVS is the alist of previous items,
1573 as returned by `org-list-prevs-alist'."
1577 ;; Pretend that bullets are uppercase and check if alphabet
1578 ;; is sufficient, taking counters into account.
1582 ;; Virtually determine current bullet
1584 ;; Counters are not case-sensitive.
1587 ;; Test if bullet would be over z or Z.
1591 ;; All items checked. All good.
1592 t))))
1595 "Increment BULLET if applicable."
1598 ;; Num bullet: increment it.
1602 nil nil bullet))
1603 ;; Alpha bullet: increment it.
1607 nil nil bullet))
1608 ;; Unordered bullet: leave it.
1612 "Verify and correct bullets in STRUCT.
1613 PREVS is the alist of previous items, as returned by
1614 `org-list-prevs-alist'.
1616 This function modifies STRUCT."
1620 ;; Set bullet of ITEM in STRUCT, depending on the type of
1621 ;; first item of the list, the previous bullet and counter
1622 ;; if any.
1631 item struct
1634 ;; Alpha counter in alpha list: use counter.
1638 ;; Use cond to be sure `string-match' is used in
1639 ;; both cases.
1645 ;; Num counter in a num list: use counter.
1650 ;; No counter: increase, if needed, previous bullet.
1653 ;; Alpha counter at first item: use counter.
1662 ;; Num counter at first item: use counter.
1667 ;; First bullet is alpha uppercase: use "A".
1670 ;; First bullet is alpha lowercase: use "a".
1673 ;; First bullet is num: use "1".
1676 ;; Not an ordered list: keep bullet.
1681 "Verify and correct indentation in STRUCT.
1683 PARENTS is the alist of parents, as returned by
1684 `org-list-parents-alist'.
1686 If numeric optional argument BULLET-SIZE is set, assume all
1687 bullets in list have this length to determine new indentation.
1689 This function modifies STRUCT."
1696 ;; Indent like parent + length of parent's bullet +
1697 ;; sub-list offset.
1703 org-list-indent-offset))
1704 ;; If no parent, indent like top-point.
1709 "Verify and correct checkboxes in STRUCT.
1711 PARENTS is the alist of parents and PREVS is the alist of
1712 previous items, as returned by, respectively,
1713 `org-list-parents-alist' and `org-list-prevs-alist'.
1715 If ORDERED is non-nil, a checkbox can only be checked when every
1716 checkbox before it is checked too. If there was an attempt to
1717 break this rule, the function will return the blocking item. In
1718 all others cases, the return value will be nil.
1720 This function modifies STRUCT."
1730 item struct
1736 ;; Parent has no boxed child: leave box as-is.
1738 parent-list)
1739 ;; 1. List all parents with a checkbox.
1746 all-items)
1747 ;; 2. Sort those parents by decreasing indentation.
1752 ;; 3. For each parent, get all children's checkboxes to determine
1753 ;; and set its checkbox accordingly.
1755 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1760 ;; There are boxes checked after an unchecked one: fix that.
1765 ;; Verify once again the structure, without ORDERED.
1767 ;; Return blocking item.
1771 "Verify and correct each item end position in STRUCT.
1773 This function modifies STRUCT."
1780 ;; To determine real ind of an ending position that is
1781 ;; not at an item, we have to find the item it belongs
1782 ;; to: it is the last item (ITEM-UP), whose ending is
1783 ;; further than the position we're interested in.
1786 ;; Else part is for the bottom point.
1788 end-pos)
1789 end-list)))
1792 struct)
1797 "Apply set difference between STRUCT and OLD-STRUCT to the buffer.
1799 OLD-STRUCT is the structure before any modifications, and STRUCT
1800 the structure to be applied. The function will only modify parts
1801 of the list which have changed.
1803 Initial position of cursor is restored after the changes."
1811 ;; Shift the indentation between END and BEG by DELTA.
1812 ;; Start from the line before END.
1821 ;; Skip inline tasks.
1824 ;; Shift only non-empty lines.
1831 ;; Replace ITEM first line elements with new elements from
1832 ;; STRUCT, if appropriate.
1842 ;; a. Replace bullet
1845 ;; b. Replace checkbox.
1859 ;; c. Indent item to appropriate column.
1864 ;; 1. First get list of items and position endings. We maintain
1865 ;; two alists: ITM-SHIFT, determining indentation shift needed
1866 ;; at item, and END-POS, a pseudo-alist where key is ending
1867 ;; position and value point.
1880 ;; To determine real ind of an ending position that
1881 ;; is not at an item, we have to find the item it
1882 ;; belongs to: it is the last item (ITEM-UP), whose
1883 ;; ending is further than the position we're
1884 ;; interested in.
1888 old-struct)
1889 ;; 2. Slice the items into parts that should be shifted by the
1890 ;; same amount of indentation. The slices are returned in
1891 ;; reverse order so changes modifying buffer do not change
1892 ;; positions they refer to.
1895 '<))
1903 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1904 ;; end to beginning. Take a special action when beginning is
1905 ;; at item bullet.
1912 sliced-struct))
1913 ;; 4. Go back to initial position and clean marker.
1918 "Correct bullets, checkboxes and indentation in list at point.
1919 STRUCT is the list structure. PARENTS is the alist of parents,
1920 as returned by `org-list-parents-alist'."
1921 ;; Order of functions matters here: checkboxes and endings need
1922 ;; correct indentation to be set, and indentation needs correct
1923 ;; bullets.
1924 ;;
1925 ;; 0. Save a copy of structure before modifications
1927 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1928 ;; order to get items endings and bullets properly
1930 ;; 2. Fix each item end to get correct prevs alist.
1932 ;; 3. Get bullets right.
1935 ;; 4. Now get real indentation.
1937 ;; 5. Eventually fix checkboxes.
1939 ;; 6. Apply structure modifications to buffer.
1943 \f
1944 ;;; Misc Tools
1947 "Call FUNCTION on each item of the list at point.
1948 FUNCTION must be called with at least one argument: INIT-VALUE,
1949 that will contain the value returned by the function at the
1950 previous item, plus ARGS extra arguments.
1952 FUNCTION is applied on items in reverse order.
1954 As an example, \(org-apply-on-list \(lambda \(result\) \(1+ result\)\) 0\)
1955 will return the number of items in the current list.
1957 Sublists of the list are skipped. Cursor is always at the
1958 beginning of the item."
1970 value))
1973 "Set visibility of ITEM in STRUCT to VIEW.
1975 Possible values are: `folded', `children' or `subtree'. See
1976 `org-cycle' for more information."
1980 ;; Hide from eol
1982 item-end t)))
1984 ;; First show everything.
1986 ;; Then fold every child.
1991 children)))
1993 ;; Show everything
1998 "Return column at which body of ITEM should start."
2008 tcol))
2011 \f
2012 ;;; Interactive functions
2017 "Go to the beginning of the current item.
2018 Throw an error when not in a list."
2024 "Go to the beginning item of the current list or sublist.
2025 Throw an error when not in a list."
2036 "Go to the end of the current list or sublist.
2037 Throw an error when not in a list."
2048 "Go to the end of the current item.
2049 Throw an error when not in a list."
2059 "Move to the beginning of the previous item.
2060 Throw an error when not in a list. Also throw an error when at
2061 first item, unless `org-list-use-circular-motion' is non-nil."
2077 "Move to the beginning of the next item.
2078 Throw an error when not in a list. Also throw an error when at
2079 last item, unless `org-list-use-circular-motion' is non-nil."
2095 "Move the item at point down, i.e. swap with following item.
2096 Sub-items (items with larger indentation) are considered part of
2097 the item, so this really moves item trees."
2116 "Move the item at point up, i.e. swap with previous item.
2117 Sub-items (items with larger indentation) are considered part of
2118 the item, so this really moves item trees."
2135 "Insert a new item at the current level.
2136 If cursor is before first character after bullet of the item, the
2137 new item will be created before the current one.
2139 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2141 Return t when things worked, nil when we are not in an item, or
2142 item is invisible."
2145 ;; If cursor isn't is a list or if list is invisible, return nil.
2153 ;; Timer list: delegate to `org-timer-item'.
2158 ;; If we're in a description list, ask for the new term.
2161 ;; Don't insert a checkbox if checkbox rule is applied
2162 ;; and it is a description item.
2166 org-list-automatic-rules)))))))
2173 t)))))
2176 "Fix indentation, bullets and checkboxes is the list at point."
2184 "Cycle through the different itemize/enumerate bullets.
2185 This cycle the entire list level through the sequence:
2187 `-' -> `+' -> `*' -> `1.' -> `1)'
2189 If WHICH is a valid string, use that as the new bullet. If WHICH
2190 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2191 `previous', cycle backwards."
2212 ;; Compute list of possible bullets, depending on context.
2215 ;; *-bullets are not allowed at column 0.
2218 ;; Description items cannot be numbered.
2241 ;; Use a short variation of `org-list-write-struct' as there's
2242 ;; no need to go through all the steps.
2250 "Toggle the checkbox in the current line.
2251 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2252 double prefix, set checkbox to [-].
2254 When there is an active region, toggle status or presence of the
2255 first checkbox there, and make every item inside have the same
2256 status or presence, respectively.
2258 If the cursor is in a headline, apply this to all checkbox items
2259 in the text below the heading, taking as reference the first item
2260 in subtree, ignoring drawers."
2264 block-item
2265 lim-up
2266 lim-down
2277 ;; In a region, start at first item in region.
2287 ;; On an heading, start at first item after drawers and
2288 ;; time-stamps (scheduled, etc.).
2299 ;; Just one item: set SINGLEP flag.
2305 ;; Determine the checkbox going to be applied to all items
2306 ;; within bounds.
2317 ;; When an item is found within bounds, grab the full list at
2318 ;; point structure, then: (1) set check-box of all its items
2319 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2320 ;; whole list, (3) move point after the list.
2334 e struct
2335 ;; If there is no box at item, leave as-is
2336 ;; unless function was called with C-u prefix.
2339 ref-checkbox
2340 cur-box))))
2341 items-to-toggle)
2343 struct parents prevs orderedp))
2344 ;; Report some problems due to ORDERED status of subtree.
2345 ;; If only one box was being checked, throw an error, else,
2346 ;; only signal problems.
2350 "Checkbox blocked because of unchecked box at line %d"
2354 "Checkboxes were removed due to unchecked box at line %d"
2363 "Reset all checkboxes in an entry subtree."
2380 "Update the checkbox statistics in the current section.
2381 This will find all statistic cookies like [57%] and [6/12] and
2382 update them with the current numbers.
2384 With optional prefix argument ALL, do this for the whole buffer."
2388 (box-re "^[ \t]*\\([-+*]\\|\\([0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2400 ;; Return number of checked boxes and boxes of all types
2401 ;; in all structures in STRUCTS. If RECURSIVEP is
2402 ;; non-nil, also count boxes in sub-lists. If ITEM is
2403 ;; nil, count across the whole structure, else count only
2404 ;; across subtree whose ancestor is ITEM.
2421 items))))
2424 structs)
2427 cookies-list structs-bak box-num)
2429 ;; 1. Build an alist for each cookie found within BOUNDS. The
2430 ;; key will be position at beginning of cookie and values
2431 ;; ending position, format of cookie, and a cell whose car is
2432 ;; number of checked boxes to report, and cdr total number of
2433 ;; boxes.
2443 ;; Cookie is at an heading, but specifically for todo,
2444 ;; not for checkboxes: skip it.
2450 ;; Cookie is at an heading, but all lists before next
2451 ;; heading already have been read. Use data collected
2452 ;; in STRUCTS-BAK. This should only happen when
2453 ;; heading has more than one cookie on it.
2456 backup-end))
2458 ;; Cookie is at a fresh heading. Grab structure of
2459 ;; every list containing a checkbox between point and
2460 ;; next headline, and save them in STRUCTS-BAK.
2464 structs-bak nil)
2471 ;; Cookie is at an item, and we already have list
2472 ;; structure stored in STRUCTS-BAK.
2475 ;; Only lists in no special context are stored.
2478 ;; Cookie is at an item, but we need to compute list
2479 ;; structure.
2485 ;; Else, cookie found is at a wrong place. Skip it.
2487 cookies-list))))
2488 ;; 2. Apply alist to buffer, in reverse order so positions stay
2489 ;; unchanged after cookie modifications.
2504 cookies-list))))
2507 "Select the face for checkbox statistics.
2508 The face will be `org-done' when all relevant boxes are checked.
2509 Otherwise it will be `org-todo'."
2512 'org-checkbox-statistics-done
2516 'org-checkbox-statistics-done
2520 "Update checkbox statistics unless turned off by user.
2521 With an optional argument ALL, update them in the whole buffer."
2529 "Indent a local list item including its children.
2530 When number ARG is a negative, item will be outdented, otherwise
2531 it will be indented.
2533 If a region is active, all items inside will be moved.
2535 If NO-SUBTREE is non-nil, only indent the item itself, not its
2536 children.
2538 STRUCT is the list structure.
2540 Return t if successful."
2549 ;; Are we going to move the whole list?
2556 t))))
2557 ;; Determine begin and end points of zone to indent. If moving
2558 ;; more than one item, save them for subsequent moves.
2574 ;; Special case: moving top-item with indent rule.
2582 ;; Change bullet if necessary.
2588 ;; Shift every item by OFFSET and fix bullets. Then
2589 ;; apply changes to buffer.
2593 struct)
2596 ;; Forbidden move:
2598 ;; If only one item is moved, it mustn't have a child.
2602 ;; If a subtree or region is moved, the last item
2603 ;; of the subtree mustn't have a child.
2608 struct)))))
2611 ;; Normal shifting
2619 t)
2622 "Outdent a local list item, but not its children.
2623 If a region is active, all items inside will be moved."
2631 "Indent a local list item, but not its children.
2632 If a region is active, all items inside will be moved."
2640 "Outdent a local list item including its children.
2641 If a region is active, all items inside will be moved."
2655 "Indent a local list item including its children.
2656 If a region is active, all items inside will be moved."
2671 "Cycle levels of indentation of an empty item.
2672 The first run indents the item, if applicable. Subsequents runs
2673 outdent it at meaningful levels in the list. When done, item is
2674 put back at its original position with its original bullet.
2676 Return t at each successful move."
2682 ;; Accept empty items or if cycle has already started.
2693 ;; When in the middle of the cycle, try to outdent first. If
2694 ;; it fails, and point is still at initial position, indent.
2695 ;; Else, re-create it at its original position.
2704 ;; Break cycle
2706 ;; If a cycle is starting, remember indentation and bullet,
2707 ;; then try to indent. If it fails, try to outdent.
2713 t))))
2716 "Sort list items.
2717 The cursor may be at any item of the list that should be sorted.
2718 Sublists are not sorted. Checkboxes, if any, are ignored.
2720 Sorting can be alphabetically, numerically, by date/time as given
2721 by a time stamp, by a property or by priority.
2723 Comparing entries ignores case by default. However, with an
2724 optional argument WITH-CASE, the sorting considers case as well.
2726 The command prompts for the sorting type unless it has been given
2727 to the function through the SORTING-TYPE argument, which needs to
2728 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
2729 meaning of each character:
2731 n Numerically, by converting the beginning of the item to a number.
2732 a Alphabetically. Only the first line of item is checked.
2733 t By date/time, either the first active time stamp in the entry, if
2734 any, or by the first inactive one. In a timer list, sort the timers.
2736 Capital letters will reverse the sort order.
2738 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2739 a function to be called with point at the beginning of the
2740 record. It must return either a string or a number that should
2741 serve as the sorting key for that record. It will then use
2742 COMPARE-FUNC to compare entries."
2787 ;; If it is a timer list, convert timer to seconds
2800 value))
2804 next-record
2805 end-record
2806 value-to-sort
2807 nil
2808 sort-func)
2809 ;; Read and fix list again, as `sort-subr' probably destroyed
2810 ;; its structure.
2816 \f
2817 ;;; Send and receive lists
2820 "Parse the list at point and maybe DELETE it.
2822 Return a list whose car is a symbol of list type, among
2823 `ordered', `unordered' and `descriptive'. Then, each item is
2824 a list whose car is counter, and cdr are strings and other
2825 sub-lists. Inside strings, check-boxes are replaced by
2828 For example, the following list:
2830 1. first item
2831 + sub-item one
2832 + [X] sub-item two
2833 more text in first item
2834 2. [@3] last item
2836 will be parsed as:
2838 \(ordered
2840 \(unordered
2846 Point is left at list end."
2852 out
2853 parse-item ; for byte-compiler
2856 ;; Return text between BEG and END, trimmed, with
2857 ;; checkboxes replaced.
2868 text)))))
2871 ;; Return a list whose car is list type and cdr a list of
2872 ;; items' body.
2878 ;; Return a list containing counter of item, if any, text
2879 ;; and any sublist inside it.
2885 ;; Get counter number. For alphabetic counter, get
2886 ;; its position in the alphabet.
2897 ;; If item has a child, store text between bullet and
2898 ;; next child, then recursively parse all sublists. At
2899 ;; the end of each sublist, check for the presence of
2900 ;; text belonging to the original item.
2910 ;; Remove children from the list just parsed.
2912 ;; There is a chunk of text belonging to the
2913 ;; item if last child doesn't end where next
2914 ;; child starts or where item ends.
2918 body))))
2921 ;; Store output, take care of cursor position and deletion of
2922 ;; list, then return output.
2931 out))
2934 "Convert the plain list at point into a subtree."
2942 "Insert a radio list template appropriate for this major mode."
2946 name pos)
2957 "Send a transformed version of this list to the receiver position.
2958 With argument MAYBE, fail quietly if no transformation is defined
2959 for this list."
2965 (unless (looking-at "[ \t]*#\\+ORGLST[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
2984 beg txt)
2988 ;; Find the insertion place
2993 name
3007 "Trim line breaks in a list ITEM."
3011 "Convert a LIST parsed through `org-list-parse-list' to other formats.
3012 Valid parameters PARAMS are:
3014 :ustart String to start an unordered list
3015 :uend String to end an unordered list
3017 :ostart String to start an ordered list
3018 :oend String to end an ordered list
3020 :dstart String to start a descriptive list
3021 :dend String to end a descriptive list
3022 :dtstart String to start a descriptive term
3023 :dtend String to end a descriptive term
3024 :ddstart String to start a description
3025 :ddend String to end a description
3027 :splice When set to t, return only list body lines, don't wrap
3028 them into :[u/o]start and :[u/o]end. Default is nil.
3030 :istart String to start a list item.
3031 :icount String to start an item with a counter.
3032 :iend String to end a list item
3033 :isep String to separate items
3034 :lsep String to separate sublists
3035 :csep String to separate text from a sub-list
3037 :cboff String to insert for an unchecked check-box
3038 :cbon String to insert for a checked check-box
3039 :cbtrans String to insert for a check-box in transitional state
3041 :nobr Non-nil means remove line breaks in lists items.
3043 Alternatively, each parameter can also be a form returning
3044 a string. These sexp can use keywords `counter' and `depth',
3045 reprensenting respectively counter associated to the current
3046 item, and depth of the current sub-list, starting at 0.
3047 Obviously, `counter' is only available for parameters applying to
3048 items."
3072 export-sublist ; for byte-compiler
3075 ;; Export an item ITEM of type TYPE, at DEPTH. First
3076 ;; string in item is treated in a special way as it can
3077 ;; bring extra information that needs to be processed.
3083 ;; Stick DTSTART to ISTART by
3084 ;; left-trimming the latter.
3088 istart))
3095 ;; Replace checkbox if any is found.
3103 ;; Replace line breaks if required
3105 ;; Insert descriptive term if TYPE is `descriptive'.
3114 first)))
3125 ;; Export sublist SUB at DEPTH.
3143 "Convert LIST into a LaTeX list.
3144 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3145 with overruling parameters for `org-list-to-generic'."
3147 list
3156 ;; LaTeX increments counter just before
3157 ;; using it, so set it to the desired
3158 ;; value, minus one.
3165 params)))
3168 "Convert LIST into a HTML list.
3169 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3170 with overruling parameters for `org-list-to-generic'."
3172 list
3184 params)))
3187 "Convert LIST into a Texinfo list.
3188 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3189 with overruling parameters for `org-list-to-generic'."
3191 list
3202 params)))
3205 "Convert LIST into an Org subtree.
3206 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3207 with overruling parameters for `org-list-to-generic'."
3217 ;; Return the string for the heading, depending on depth D
3218 ;; of current sub-list.
3223 oddeven-level)
3224 ?*)
3227 list
3229 '(:splice t
3236 params))))
3240 ;;; org-list.el ends here