| blob | 7078f8055ea9e1bafb5f7f4b749aacfab79b468b |
1 ;;; org-list.el --- Plain lists for Org-mode
2 ;;
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 ;; Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Bastien Guerry <bzg AT altern DOT org>
8 ;; Keywords: outlines, hypermedia, calendar, wp
9 ;; Homepage: http://orgmode.org
10 ;; Version: 7.6
11 ;;
12 ;; This file is part of GNU Emacs.
13 ;;
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
27 ;;
28 ;;; Commentary:
30 ;; This file contains the code dealing with plain lists in Org-mode.
32 ;; The fundamental idea behind lists work is to use structures.
33 ;; A structure is a snapshot of the list, in the shape of data tree
34 ;; (see `org-list-struct').
36 ;; Once the list structure is stored, it is possible to make changes
37 ;; directly on it or get useful information about the list, with the
38 ;; two helper functions, namely `org-list-parents-alist' and
39 ;; `org-list-prevs-alist', and using accessors or methods.
41 ;; Structure is eventually applied to the buffer with
42 ;; `org-list-write-struct'. This function repairs (bullets,
43 ;; indentation, checkboxes) the structure before applying it. It
44 ;; should be called near the end of any function working on
45 ;; structures.
47 ;; Thus, a function applying to lists should usually follow this
48 ;; template:
50 ;; 1. Verify point is in a list and grab item beginning (with the same
51 ;; function `org-in-item-p'). If the function requires the cursor
52 ;; to be at item's bullet, `org-at-item-p' is more selective. If
53 ;; the cursor is amidst the buffer, it is possible to find the
54 ;; closest item with `org-list-search-backward', or
55 ;; `org-list-search-forward', applied to `org-item-beginning-re'.
57 ;; 2. Get list structure with `org-list-struct'.
59 ;; 3. Compute one, or both, helper functions,
60 ;; (`org-list-parents-alist', `org-list-prevs-alist') depending on
61 ;; needed accessors.
63 ;; 4. Proceed with the modifications, using methods and accessors.
65 ;; 5. Verify and apply structure to buffer, using
66 ;; `org-list-write-struct'. Possibly use
67 ;; `org-update-checkbox-count-maybe' if checkboxes might have been
68 ;; modified.
70 ;; Computing a list structure can be a costly operation on huge lists
71 ;; (a few thousand lines long). Thus, code should follow the rule :
72 ;; "collect once, use many". As a corollary, it is usally 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 ;;; Configuration variables
135 "Options concerning plain lists in Org-mode."
140 "When t, make TAB cycle visibility on plain list items.
141 Cycling plain lists works only when the cursor is on a plain list
142 item. When the cursor is on an outline heading, plain lists are
143 treated as text. This is the most stable way of handling this,
144 which is why it is the default.
146 When this is the symbol `integrate', then during cycling, plain
147 list items will *temporarily* be interpreted as outline headlines
148 with a level given by 1000+i where i is the indentation of the
149 bullet. This setting can lead to strange effects when switching
151 subtree decides what children should be listed. If that first
153 number, all true children and grand children of the outline
154 heading will be exposed in a children' view."
162 "Default bullet type installed when demoting an item.
163 This is an association list, for each bullet type, this alist will point
164 to the bullet that should be used when this item is demoted.
165 For example,
167 (setq org-list-demote-modify-bullet
170 will make
172 + Movies
173 + Silence of the Lambs
174 + My Cousin Vinny
175 + Books
176 + The Hunt for Red October
177 + The Road to Omaha
179 into
181 + Movies
182 - Silence of the Lambs
183 - My Cousin Vinny
184 + Books
185 - The Hunt for Red October
186 - The Road to Omaha"
204 "The character that makes a line with leading number an ordered list item.
205 Valid values are ?. and ?\). To get both terminators, use t. While
206 ?. may look nicer, it creates the danger that a line with leading
207 number may be incorrectly interpreted as an item. ?\) therefore is
208 the safe choice."
215 "Non-nil means single character alphabetical bullets are allowed.
216 Both uppercase and lowercase are handled. Lists with more than
217 26 items will fallback to standard numbering. Alphabetical
223 "A regular expression matching bullets that should have 2 spaces after them.
224 When nil, no bullet will have two spaces after them. When
225 a string, it will be used as a regular expression. When the
226 bullet type of a list is changed, the new bullet type will be
227 matched against this regexp. If it matches, there will be two
228 spaces instead of one after the bullet in each item of the list."
235 "Determine where plain lists should end.
236 Valid values are: `regexp', `indent' or `both'.
238 When set to `regexp', Org will look into two variables,
239 `org-empty-line-terminates-plain-lists' and the more general
240 `org-list-end-regexp', to determine what will end lists.
242 When set to `indent', a list will end whenever a line following
243 an item, but not starting one, is less or equally indented than
244 the first item of the list.
246 When set to `both', each of the preceding methods is applied to
247 determine lists endings. This is the default method."
255 "Non-nil means an empty line ends all plain list levels.
256 This variable only makes sense if `org-list-ending-method' is set
257 to `regexp' or `both'. This is then equivalent to set
263 "Regexp matching the end of all plain list levels.
265 blank lines. `org-empty-line-terminates-plain-lists' has
266 precedence over it."
273 "Non-nil means apply set of rules when acting on lists.
274 By default, automatic actions are taken when using
279 rules by setting them to nil. Valid rules are:
281 bullet when non-nil, cycling bullet do not allow lists at
282 column 0 to have * as a bullet and descriptions lists
283 to be numbered.
284 checkbox when non-nil, checkbox statistics is updated each time
285 you either insert a new checkbox or toggle a checkbox.
286 It also prevents from inserting a checkbox in a
287 description item.
288 indent when non-nil, indenting or outdenting list top-item
289 with its subtree will move the whole list and
290 outdenting a list whose bullet is * to column 0 will
294 :key-type
299 :value-type
303 "Hook that is run whenever Org thinks checkbox statistics should be updated.
304 This hook runs even if checkbox rule in
305 `org-list-automatic-rules' does not apply, so it can be used to
306 implement alternative ways of collecting statistics
310 "Non-nil means checkbox statistics counts only the state of direct children.
311 When nil, all boxes below the cookie are counted.
312 This can be set to nil on a per-node basis using a COOKIE_DATA property
318 "Maximum indentation for the second line of a description list.
319 When the indentation would be larger than this, it will become
320 5 characters instead."
326 % END RECEIVE ORGLST %n
328 #+ORGLST: SEND %n org-list-to-latex
329 -
332 @c END RECEIVE ORGLST %n
333 @ignore
334 #+ORGLST: SEND %n org-list-to-texinfo
335 -
338 <!-- END RECEIVE ORGLST %n -->
339 <!--
340 #+ORGLST: SEND %n org-list-to-html
341 -
343 "Templates for radio lists in different major modes.
344 All occurrences of %n in a template will be replaced with the name of the
345 list, obtained by prompting the user."
352 "Names of blocks where lists are not allowed.
356 "Context types where lists will be interpreted during export.
358 Valid types are `drawer', `inlinetask' and `block'. More
359 specifically, type `block' is determined by the variable
363 ;;; Predicates and regexps
367 org-list-end-regexp)
368 "Regex corresponding to the end of a list.
376 "Matches a list item and puts everything into groups:
377 group 1: bullet
378 group 2: counter
379 group 3: checkbox
383 "Return the correct regular expression for plain lists."
394 "Regexp matching the beginning of a plain list item."
398 "Is point at a list item with REGEXP after bullet?"
407 ;; Ignore counter if any
412 "Is point in a context where lists are allowed?"
416 "Return item beginning position when in a plain list, nil otherwise.
417 This checks `org-list-ending-method'."
429 ;; Indentation isn't meaningful when point starts at an empty
430 ;; line or an inline task.
433 10000
439 ;; Detect if cursor in amidst `org-list-end-re'. First, count
440 ;; number HL of hard lines it takes, then call `org-in-regexp'
441 ;; to compute its boundaries END-BOUNDS. When point is
442 ;; in-between, move cursor before regexp beginning.
454 ;; Look for an item, less indented that reference line if
455 ;; `org-list-ending-method' isn't `regexp'.
460 ;; This is exactly what we want.
465 ;; At upper bound of search or looking at the end of a
466 ;; previous list: search is over.
471 ;; Skip blocks, drawers, inline-tasks, blank lines
481 ;; Text at column 0 cannot belong to a list: stop.
483 ;; Normal text less indented than reference line, take
484 ;; it as new reference.
491 "Is point in a line starting a hand-formatted item?"
497 "Is point at the bullet of a plain list item?"
503 "Is point at a line starting a plain list item with a timer?"
508 "Is point at a description list item?"
512 "Is point at a line starting a plain-list item with a checklet?"
516 "Is point at a line starting a plain-list item with a counter?"
522 ;;; Structures and helper functions
525 "Determine context, and its boundaries, around point.
527 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
528 are boundaries and CONTEXT is a symbol among `drawer', `block',
529 `invalid', `inlinetask' and nil.
531 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
537 ;; Get positions of surrounding headings. This is the
538 ;; default context.
543 ;; Is point inside a drawer?
545 ;; Can't use org-drawers-regexp as this function might
546 ;; be called in buffers not in Org mode.
557 lim-down))
560 ;; Is point strictly in a block, and of which type?
571 lim-down))
577 ;; Is point in an inlinetask?
590 ;; Return context boundaries and type.
594 "Return structure of list at point.
596 A list structure is an alist where key is point at item, and
597 values are:
598 1. indentation,
599 2. bullet with trailing whitespace,
600 3. bullet counter, if any,
601 4. checkbox, if any,
602 5. description tag, if any,
603 6. position at item end.
605 Thus the following list, where numbers in parens are
606 point-at-bol:
608 - [X] first item (1)
609 1. sub-item 1 (18)
610 5. [@5] sub-item 2 (34)
611 some other text belonging to first item (55)
612 - last item (97)
613 + tag :: description (109)
614 (131)
616 will get the following structure:
624 Assume point is at an item."
639 ind itm-lst itm-lst-2 end-lst end-lst-2 struct
642 ;; Return association at point.
646 ind
653 ;; Ensure list ends at the first blank line.
657 ;; 1. Read list from starting item to its beginning, and save
658 ;; top item position and indentation in BEG-CELL. Also store
659 ;; ending position of items in END-LST.
667 ;; At upward limit: if we ended at an item, store it,
668 ;; else dimiss useless data recorded above BEG-CELL.
669 ;; Jump to part 2.
677 ;; At a verbatim block, go before its beginning. Move
678 ;; from eol to ensure `previous-single-property-change'
679 ;; will return a value.
684 ;; Looking at a list ending regexp. Dismiss useless
685 ;; data recorded above BEG-CELL. Jump to part 2.
691 ;; Point is at an item. Add data to ITM-LST. It may
692 ;; also end a previous item: save it in END-LST. If
693 ;; ind is less or equal than BEG-CELL and there is no
694 ;; end at this ind or lesser, this item becomes the new
695 ;; BEG-CELL.
704 ;; Skip blocks, drawers, inline tasks, blank lines.
715 ;; From there, point is not at an item. Unless ending
716 ;; method is `regexp', interpret line's indentation:
717 ;; - text at column 0 is necessarily out of any list.
718 ;; Dismiss data recorded above BEG-CELL. Jump to
719 ;; part 2.
720 ;; - any other case may be an ending position for an
721 ;; hypothetical item above. Store it and proceed.
731 ;; 2. Read list from starting point to its end, that is until we
732 ;; get out of context, or that a non-item line is less or
733 ;; equally indented than BEG-CELL's cdr. Also, store ending
734 ;; position of items in END-LST-2.
741 ;; At downward limit: this is de facto the end of the
742 ;; list. Save point as an ending position, and jump to
743 ;; part 3.
746 ;; At a verbatim block, move to its end. Point is at bol
747 ;; and 'org-example property is set by whole lines:
748 ;; `next-single-property-change' always return a value.
752 ;; Looking at a list ending regexp. Save point as an
753 ;; ending position and jump to part 3.
758 ;; Point is at an item. Add data to ITM-LST-2. It may
759 ;; also end a previous item, so save it in END-LST-2.
763 ;; Skip inline tasks and blank lines along the way
768 ;; Ind is lesser or equal than BEG-CELL's. The list is
769 ;; over: store point as an ending position and jump to
770 ;; part 3.
775 ;; Else, if ind is lesser or equal than previous item's,
776 ;; this is an ending position: store it. In any case,
777 ;; skip block or drawer at point, and move to next line.
790 ;; 3. Correct ill-formed lists by ensuring top item is the least
791 ;; indented.
798 ;; Trim bullet so item will be seen as different
799 ;; when compared with repaired version.
801 struct))
802 ;; 4. Associate each item to its end pos.
804 ;; 5. Return STRUCT
805 struct)))
808 "Associate proper ending point to items in STRUCT.
810 END-LIST is a pseudo-alist where car is indentation and cdr is
811 ending position.
813 This function modifies STRUCT."
819 ;; Remove end candidates behind current item.
822 ;; Add end position to item assoc.
828 struct)))
831 "Return alist between item and previous item in STRUCT."
833 struct)))
837 struct)))
840 "Return alist between item and parent in STRUCT."
862 ;;; Accessors
865 "Return the Nth value of KEY in STRUCT."
869 "Set the Nth value of KEY in STRUCT to NEW.
874 "Return indentation of ITEM in STRUCT."
878 "Set indentation of ITEM in STRUCT to IND.
883 "Return bullet of ITEM in STRUCT."
887 "Set bullet of ITEM in STRUCT to BULLET.
892 "Return counter of ITEM in STRUCT."
896 "Return checkbox of ITEM in STRUCT or nil."
900 "Set checkbox of ITEM in STRUCT to CHECKBOX.
905 "Return end position of ITEM in STRUCT."
909 "Return end position of ITEM in STRUCT."
913 "Return point at end of ITEM in STRUCT, before any blank line.
914 Point returned is at end of line."
921 "Return parent of ITEM or nil.
922 STRUCT is the list structure. PARENTS is the alist of parents,
923 as returned by `org-list-parents-alist'."
928 "Non-nil if ITEM has a child.
930 STRUCT is the list structure.
932 Value returned is the position of the first child of ITEM."
937 child-maybe)))
940 "Return next item in same sub-list as ITEM, or nil.
941 STRUCT is the list structure. PREVS is the alist of previous
942 items, as returned by `org-list-prevs-alist'."
946 "Return previous item in same sub-list as ITEM, or nil.
947 STRUCT is the list structure. PREVS is the alist of previous
948 items, as returned by `org-list-prevs-alist'."
952 "List all items having ITEM as a common ancestor, or nil.
953 STRUCT is the list structure."
956 subtree)
961 sub-struct))
965 "List all items in the same sub-list as ITEM.
966 STRUCT is the list structure. PREVS is the alist of previous
967 items, as returned by `org-list-prevs-alist'."
970 before-item after-item)
978 "List all children of ITEM, or nil.
979 STRUCT is the list structure. PARENTS is the alist of parents, as
980 returned by `org-list-parents-alist'."
988 "Return point at beginning of list.
989 STRUCT is the list structure."
993 "Return point at bottom of list.
994 STRUCT is the list structure."
999 "Return point at beginning of sub-list ITEM belongs.
1000 STRUCT is the list structure. PREVS is the alist of previous
1001 items, as returned by `org-list-prevs-alist'."
1005 first-item))
1010 "Return point at last item of sub-list ITEM belongs.
1011 STRUCT is the list structure. PREVS is the alist of previous
1012 items, as returned by `org-list-prevs-alist'."
1016 last-item))
1019 "Return point at end of sub-list ITEM belongs.
1020 STRUCT is the list structure. PREVS is the alist of previous
1021 items, as returned by `org-list-prevs-alist'."
1025 "Return the type of the list containing ITEM, as a symbol.
1027 STRUCT is the list structure. PREVS is the alist of previous
1028 items, as returned by `org-list-prevs-alist'.
1030 Possible types are `descriptive', `ordered' and `unordered'. The
1031 type is determined by the first item of the list."
1039 ;;; Searching
1042 "Search a string in valid contexts for lists.
1043 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1044 in `re-search-forward'."
1048 ;; 1. No match: return to origin or bound, depending on NOERR.
1051 nil)))
1052 ;; 2. Match in valid context: return point. Else, continue
1053 ;; searching.
1057 "Like `re-search-backward' but stop only where lists are recognized.
1058 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1059 `re-search-backward'."
1064 "Like `re-search-forward' but stop only where lists are recognized.
1065 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1066 `re-search-forward'."
1071 ;;; Methods on structures
1074 "Return BULLET with the correct number of whitespaces.
1075 It determines the number of whitespaces to append by looking at
1076 `org-list-two-spaces-after-bullet-regexp'."
1080 org-list-two-spaces-after-bullet-regexp bullet))
1081 " "
1087 "Return number of blank lines that should separate items in list.
1089 POS is the position of point where `org-list-insert-item' was called.
1091 STRUCT is the list structure. PREVS is the alist of previous
1092 items, as returned by `org-list-prevs-alist'.
1094 Assume point is at item's beginning. If the item is alone, apply
1095 some heuristics to guess the result."
1100 usr-blank)
1102 ;; Trivial cases where there should be none.
1104 org-empty-line-terminates-plain-lists)
1106 ;; When `org-blank-before-new-entry' says so, it is 1.
1108 ;; `plain-list-item' is 'auto. Count blank lines separating
1109 ;; neighbours items in list.
1112 ;; Is there a next item?
1115 ;; Is there a previous item?
1118 ;; User inserted blank lines, trust him.
1124 usr-blank)
1125 ;; Are there blank lines inside the item?
1130 ;; No parent: no blank line.
1134 "Insert a new list item at POS and return the new structure.
1135 If POS is before first character after bullet of the item, the
1136 new item will be created before the current one.
1138 STRUCT is the list structure. PREVS is the the alist of previous
1139 items, as returned by `org-list-prevs-alist'.
1141 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1142 after the bullet. Cursor will be after this text once the
1143 function ends.
1145 This function modifies STRUCT."
1147 ;; 1. Get information about list: structure, usual helper
1148 ;; functions, position of point with regards to item start
1149 ;; (BEFOREP), blank lines number separating items (BLANK-NB),
1150 ;; position of split (POS) if we're allowed to (SPLIT-LINE-P).
1158 pos struct prevs))
1159 ;; 2. Build the new item to be created. Concatenate same
1160 ;; bullet as item, checkbox, text AFTER-BULLET if
1161 ;; provided, and text cut from point to end of item
1162 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1163 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1164 ;; between what was cut and what was inserted in buffer
1165 ;; is stored in SIZE-OFFSET.
1169 ind))
1183 text-cut))
1188 ;; 4. Insert effectively item into buffer.
1192 ;; 5. Add new item to STRUCT.
1197 ;; Before inserted item, positions don't change but
1198 ;; an item ending after insertion has its end shifted
1199 ;; by SIZE-OFFSET.
1202 ;; Trivial cases where current item isn't split in
1203 ;; two. Just shift every item after new one by
1204 ;; ITEM-SIZE.
1208 ;; Item is split in two: elements before POS are just
1209 ;; shifted by ITEM-SIZE. In the case item would end
1210 ;; after split POS, ending is only shifted by
1211 ;; SIZE-OFFSET.
1217 ;; Elements after POS are moved into new item.
1218 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1219 ;; doesn't appear in buffer yet.
1225 (+ end size-offset
1227 ;; Elements at ITEM-END or after are only shifted by
1228 ;; SIZE-OFFSET.
1231 struct)
1234 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1235 ;; exchange ITEM with the next item in list. Position cursor
1236 ;; after bullet, counter, checkbox, and label.
1242 struct)))
1245 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1246 Blank lines at the end of items are left in place. Return the
1247 new structure after the changes.
1249 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1250 to the same sub-list.
1252 This function modifies STRUCT."
1265 ;; 1. Move effectively items in buffer.
1269 ;; 2. Now modify struct. No need to re-read the list, the
1270 ;; transformation is just a shift of positions. Some special
1271 ;; attention is required for items ending at END-A and END-B
1272 ;; as empty spaces are not moved there. In others words,
1273 ;; item BEG-A will end with whitespaces that were at the end
1274 ;; of BEG-B and the same applies to BEG-B.
1296 struct)
1300 "Outdent items between positions START and END.
1302 STRUCT is the list structure. PARENTS is the alist of items'
1303 parents, as returned by `org-list-parents-alist'.
1305 START is included, END excluded."
1311 ;; Item not yet in zone: keep association.
1313 ;; Item out of zone: follow associations in ACC.
1317 ;; Item has no parent: error
1320 ;; Parent is outdented: keep association.
1324 ;; Parent isn't outdented: reparent to grand-parent.
1326 parent struct parents)))
1332 "Indent items between positions START and END.
1334 STRUCT is the list structure. PARENTS is the alist of parents
1335 and PREVS is the alist of previous items, returned by,
1336 respectively, `org-list-parents-alist' and
1337 `org-list-prevs-alist'.
1339 START is included and END excluded.
1341 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1342 bullets between START and END."
1356 ;; Item not yet in zone: keep association.
1359 ;; Item out of zone: follow associations in ACC.
1363 ;; Item is in zone...
1365 ;; Check if bullet needs to be changed.
1368 ;; First item indented but not parent: error
1371 ;; First item and parent indented: keep same
1372 ;; parent.
1374 ;; Previous item not indented: reparent to it.
1376 ;; Previous item indented: reparent like it.
1383 ;;; Repairing structures
1386 "Non-nil if list starting at FIRST can have alphabetical bullets.
1388 STRUCT is list structure. PREVS is the alist of previous items,
1389 as returned by `org-list-prevs-alist'."
1393 ;; Pretend that bullets are uppercase and check if alphabet
1394 ;; is sufficient, taking counters into account.
1398 ;; Virtually determine current bullet
1400 ;; Counters are not case-sensitive.
1403 ;; Test if bullet would be over z or Z.
1407 ;; All items checked. All good.
1408 t))))
1411 "Increment BULLET if applicable."
1414 ;; Num bullet: increment it.
1418 nil nil bullet))
1419 ;; Alpha bullet: increment it.
1423 nil nil bullet))
1424 ;; Unordered bullet: leave it.
1428 "Verify and correct bullets in STRUCT.
1429 PREVS is the alist of previous items, as returned by
1430 `org-list-prevs-alist'.
1432 This function modifies STRUCT."
1436 ;; Set bullet of ITEM in STRUCT, depending on the type of
1437 ;; first item of the list, the previous bullet and counter
1438 ;; if any.
1447 item struct
1450 ;; Alpha counter in alpha list: use counter.
1454 ;; Use cond to be sure `string-match' is used in
1455 ;; both cases.
1461 ;; Num counter in a num list: use counter.
1466 ;; No counter: increase, if needed, previous bullet.
1469 ;; Alpha counter at first item: use counter.
1478 ;; Num counter at first item: use counter.
1483 ;; First bullet is alpha uppercase: use "A".
1486 ;; First bullet is alpha lowercase: use "a".
1489 ;; First bullet is num: use "1".
1492 ;; Not an ordered list: keep bullet.
1497 "Verify and correct indentation in STRUCT.
1499 PARENTS is the alist of parents, as returned by
1500 `org-list-parents-alist'.
1502 If numeric optional argument BULLET-SIZE is set, assume all
1503 bullets in list have this length to determine new indentation.
1505 This function modifies STRUCT."
1512 ;; Indent like parent + length of parent's bullet.
1518 ;; If no parent, indent like top-point.
1523 "Verify and correct checkboxes in STRUCT.
1525 PARENTS is the alist of parents and PREVS is the alist of
1526 previous items, as returned by, respectively,
1527 `org-list-parents-alist' and `org-list-prevs-alist'.
1529 If ORDERED is non-nil, a checkbox can only be checked when every
1530 checkbox before it is checked too. If there was an attempt to
1531 break this rule, the function will return the blocking item. In
1532 all others cases, the return value will be nil.
1534 This function modifies STRUCT."
1544 item struct
1550 ;; Parent has no boxed child: leave box as-is.
1552 parent-list)
1553 ;; 1. List all parents with a checkbox.
1560 all-items)
1561 ;; 2. Sort those parents by decreasing indentation.
1566 ;; 3. For each parent, get all children's checkboxes to determine
1567 ;; and set its checkbox accordingly.
1569 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1574 ;; There are boxes checked after an unchecked one: fix that.
1579 ;; Verify once again the structure, without ORDERED.
1581 ;; Return blocking item.
1585 "Apply set-difference between STRUCT and OLD-STRUCT to the buffer.
1587 OLD-STRUCT is the structure before any modifications, and STRUCT
1588 the structure to be applied. The function will only modify parts
1589 of the list which have changed.
1591 Initial position of cursor is restored after the changes."
1599 ;; Shift the indentation between END and BEG by DELTA.
1600 ;; Start from the line before END.
1609 ;; Skip inline tasks.
1612 ;; Shift only non-empty lines.
1619 ;; Replace ITEM first line elements with new elements from
1620 ;; STRUCT, if appropriate.
1630 ;; a. Replace bullet
1633 ;; b. Replace checkbox.
1642 ;; (goto-char (or (match-end 2) (match-end 1)))
1643 ;; (skip-chars-backward " \t")
1649 ;; c. Indent item to appropriate column.
1654 ;; 1. First get list of items and position endings. We maintain
1655 ;; two alists: ITM-SHIFT, determining indentation shift needed
1656 ;; at item, and END-POS, a pseudo-alist where key is ending
1657 ;; position and value point.
1670 ;; To determine real ind of an ending position that
1671 ;; is not at an item, we have to find the item it
1672 ;; belongs to: it is the last item (ITEM-UP), whose
1673 ;; ending is further than the position we're
1674 ;; interested in.
1678 old-struct)
1679 ;; 2. Slice the items into parts that should be shifted by the
1680 ;; same amount of indentation. The slices are returned in
1681 ;; reverse order so changes modifying buffer do not change
1682 ;; positions they refer to.
1685 '<))
1693 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1694 ;; end to beginning. Take a special action when beginning is
1695 ;; at item bullet.
1702 sliced-struct))
1703 ;; 4. Go back to initial position.
1707 "Correct bullets, checkboxes and indentation in list at point.
1708 STRUCT is the list structure. PARENTS is the alist of parents,
1709 as returned by `org-list-parents-alist'."
1710 ;; Order of functions matters here: checkboxes and endings need
1711 ;; correct indentation to be set, and indentation needs correct
1712 ;; bullets.
1713 ;;
1714 ;; 0. Save a copy of structure before modifications
1716 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1717 ;; order to get items endings and bullets properly
1719 ;; 2. Get pseudo-alist of ending positions and sort it by position.
1720 ;; Then associate them to the structure.
1727 ;; To determine real ind of an ending position that is
1728 ;; not at an item, we have to find the item it belongs
1729 ;; to: it is the last item (ITEM-UP), whose ending is
1730 ;; further than the position we're interested in.
1733 ;; Else part is for the bottom point.
1735 end-pos)
1736 end-list)))
1739 struct)
1742 ;; 3. Get bullets right.
1745 ;; 4. Now get real indentation.
1747 ;; 5. Eventually fix checkboxes.
1749 ;; 6. Apply structure modifications to buffer.
1753 ;;; Misc Tools
1756 "Call FUNCTION on each item of the list at point.
1757 FUNCTION must be called with at least one argument: INIT-VALUE,
1758 that will contain the value returned by the function at the
1759 previous item, plus ARGS extra arguments.
1761 FUNCTION is applied on items in reverse order.
1763 As an example, \(org-apply-on-list \(lambda \(result\) \(1+ result\)\) 0\)
1764 will return the number of items in the current list.
1766 Sublists of the list are skipped. Cursor is always at the
1767 beginning of the item."
1778 value))
1781 "Set visibility of ITEM in STRUCT to VIEW.
1783 Possible values are: `folded', `children' or `subtree'. See
1784 `org-cycle' for more information."
1788 ;; Hide from eol
1790 item-end t)))
1792 ;; First show everything.
1794 ;; Then fold every child.
1799 children)))
1801 ;; Show everything
1806 "Return column at which body of ITEM should start."
1816 tcol))
1819 ;;; Interactive functions
1824 "Go to the beginning of the current item.
1825 Throw an error when not in a list."
1831 "Go to the beginning item of the current list or sublist.
1832 Throw an error when not in a list."
1843 "Go to the end of the current list or sublist.
1844 Throw an error when not in a list."
1855 "Go to the end of the current item.
1856 Throw an error when not in a list."
1866 "Move to the beginning of the previous item.
1867 Throw an error when not in a list, or at first item."
1879 "Move to the beginning of the next item.
1880 Throw an error when not in a plain list, or at last item."
1892 "Move the item at point down, i.e. swap with following item.
1893 Subitems (items with larger indentation) are considered part of
1894 the item, so this really moves item trees."
1909 ;; Use a short variation of `org-list-write-struct' as there's
1910 ;; no need to go through all the steps.
1921 "Move the item at point up, i.e. swap with previous item.
1922 Subitems (items with larger indentation) are considered part of
1923 the item, so this really moves item trees."
1938 ;; Use a short variation of `org-list-write-struct' as there's
1939 ;; no need to go through all the steps.
1949 "Insert a new item at the current level.
1950 If cursor is before first character after bullet of the item, the
1951 new item will be created before the current one.
1953 If CHECKBOX is non-nil, add a checkbox next to the bullet.
1955 Return t when things worked, nil when we are not in an item, or
1956 item is invisible."
1959 ;; If cursor isn't is a list or if list is invisible, return nil.
1967 ;; Timer list: delegate to `org-timer-item'.
1972 ;; If we're in a description list, ask for the new term.
1975 ;; Don't insert a checkbox if checkbox rule is applied
1976 ;; and it is a description item.
1980 org-list-automatic-rules)))))))
1987 t)))))
1990 "Fix indentation, bullets and checkboxes is the list at point."
1998 "Cycle through the different itemize/enumerate bullets.
1999 This cycle the entire list level through the sequence:
2001 `-' -> `+' -> `*' -> `1.' -> `1)'
2003 If WHICH is a valid string, use that as the new bullet. If WHICH
2004 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2005 `previous', cycle backwards."
2026 ;; Compute list of possible bullets, depending on context.
2029 ;; *-bullets are not allowed at column 0.
2032 ;; Description items cannot be numbered.
2055 ;; Use a short variation of `org-list-write-struct' as there's
2056 ;; no need to go through all the steps.
2064 "Toggle the checkbox in the current line.
2065 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2066 double prefix, set checkbox to [-].
2068 When there is an active region, toggle status or presence of the
2069 first checkbox there, and make every item inside have the same
2070 status or presence, respectively.
2072 If the cursor is in a headline, apply this to all checkbox items
2073 in the text below the heading, taking as reference the first item
2074 in subtree, ignoring drawers."
2078 block-item
2079 lim-up
2080 lim-down
2091 ;; In a region, start at first item in region.
2101 ;; On an heading, start at first item after drawers and
2102 ;; time-stamps (scheduled, etc.).
2113 ;; Just one item: set SINGLEP flag.
2119 ;; Determine the checkbox going to be applied to all items
2120 ;; within bounds.
2131 ;; When an item is found within bounds, grab the full list at
2132 ;; point structure, then:
2133 ;; 1. set check-box of all its items within bounds to
2134 ;; REF-CHECKBOX;
2135 ;; 2. fix check-boxes of the whole list; 3. move point after the
2136 ;; list.
2150 e struct
2151 ;; If there is no box at item, leave as-is
2152 ;; unless function was called with C-u prefix.
2155 ref-checkbox
2156 cur-box))))
2157 items-to-toggle)
2159 struct parents prevs orderedp))
2160 ;; Report some problems due to ORDERED status of subtree.
2161 ;; If only one box was being checked, throw an error, else,
2162 ;; only signal problems.
2166 "Checkbox blocked because of unchecked box at line %d"
2170 "Checkboxes were removed due to unchecked box at line %d"
2177 "Reset all checkboxes in an entry subtree."
2194 "Update the checkbox statistics in the current section.
2195 This will find all statistic cookies like [57%] and [6/12] and
2196 update them with the current numbers.
2198 With optional prefix argument ALL, do this for the whole buffer."
2202 (box-re "^[ \t]*\\([-+*]\\|\\([0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2214 ;; Return number of checked boxes and boxes of all types
2215 ;; in all structures in STRUCTS. If RECURSIVEP is
2216 ;; non-nil, also count boxes in sub-lists. If ITEM is
2217 ;; nil, count across the whole structure, else count only
2218 ;; across subtree whose ancestor is ITEM.
2235 items))))
2238 structs)
2241 cookies-list structs-bak box-num)
2243 ;; 1. Build an alist for each cookie found within BOUNDS. The
2244 ;; key will be position at beginning of cookie and values
2245 ;; ending position, format of cookie, and a cell whose car is
2246 ;; number of checked boxes to report, and cdr total number of
2247 ;; boxes.
2257 ;; Cookie is at an heading, but specifically for todo,
2258 ;; not for checkboxes: skip it.
2264 ;; Cookie is at an heading, but all lists before next
2265 ;; heading already have been read. Use data collected
2266 ;; in STRUCTS-BAK. This should only happen when
2267 ;; heading has more than one cookie on it.
2270 backup-end))
2272 ;; Cookie is at a fresh heading. Grab structure of
2273 ;; every list containing a checkbox between point and
2274 ;; next headline, and save them in STRUCTS-BAK.
2278 structs-bak nil)
2285 ;; Cookie is at an item, and we already have list
2286 ;; structure stored in STRUCTS-BAK.
2289 ;; Only lists in no special context are stored.
2292 ;; Cookie is at an item, but we need to compute list
2293 ;; structure.
2299 ;; Else, cookie found is at a wrong place. Skip it.
2301 cookies-list))))
2302 ;; 2. Apply alist to buffer, in reverse order so positions stay
2303 ;; unchanged after cookie modifications.
2318 cookies-list))))
2321 "Select the face for checkbox statistics.
2322 The face will be `org-done' when all relevant boxes are checked.
2323 Otherwise it will be `org-todo'."
2326 'org-checkbox-statistics-done
2330 'org-checkbox-statistics-done
2334 "Update checkbox statistics unless turned off by user."
2342 "Indent a local list item including its children.
2343 When number ARG is a negative, item will be outdented, otherwise
2344 it will be indented.
2346 If a region is active, all items inside will be moved.
2348 If NO-SUBTREE is non-nil, only indent the item itself, not its
2349 children.
2351 STRUCT is the list structure.
2353 Return t if successful."
2362 ;; Are we going to move the whole list?
2369 t))))
2370 ;; Determine begin and end points of zone to indent. If moving
2371 ;; more than one item, save them for subsequent moves.
2387 ;; Special case: moving top-item with indent rule.
2395 ;; Change bullet if necessary.
2401 ;; Shift every item by OFFSET and fix bullets. Then
2402 ;; apply changes to buffer.
2406 struct)
2409 ;; Forbidden move:
2411 ;; If only one item is moved, it mustn't have a child.
2415 ;; If a subtree or region is moved, the last item
2416 ;; of the subtree mustn't have a child.
2421 struct)))))
2424 ;; Normal shifting
2432 t)
2435 "Outdent a local list item, but not its children.
2436 If a region is active, all items inside will be moved."
2444 "Indent a local list item, but not its children.
2445 If a region is active, all items inside will be moved."
2453 "Outdent a local list item including its children.
2454 If a region is active, all items inside will be moved."
2468 "Indent a local list item including its children.
2469 If a region is active, all items inside will be moved."
2484 "Cycle levels of indentation of an empty item.
2485 The first run indents the item, if applicable. Subsequents runs
2486 outdent it at meaningful levels in the list. When done, item is
2487 put back at its original position with its original bullet.
2489 Return t at each successful move."
2495 ;; Accept empty items or if cycle has already started.
2506 ;; When in the middle of the cycle, try to outdent first. If
2507 ;; it fails, and point is still at initial position, indent.
2508 ;; Else, re-create it at its original position.
2517 ;; Break cycle
2519 ;; If a cycle is starting, remember indentation and bullet,
2520 ;; then try to indent. If it fails, try to outdent.
2526 t))))
2529 "Sort list items.
2530 The cursor may be at any item of the list that should be sorted.
2531 Sublists are not sorted. Checkboxes, if any, are ignored.
2533 Sorting can be alphabetically, numerically, by date/time as given
2534 by a time stamp, by a property or by priority.
2536 Comparing entries ignores case by default. However, with an
2537 optional argument WITH-CASE, the sorting considers case as well.
2539 The command prompts for the sorting type unless it has been given
2540 to the function through the SORTING-TYPE argument, which needs to
2541 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
2542 meaning of each character:
2544 n Numerically, by converting the beginning of the item to a number.
2545 a Alphabetically. Only the first line of item is checked.
2546 t By date/time, either the first active time stamp in the entry, if
2547 any, or by the first inactive one. In a timer list, sort the timers.
2549 Capital letters will reverse the sort order.
2551 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2552 a function to be called with point at the beginning of the
2553 record. It must return either a string or a number that should
2554 serve as the sorting key for that record. It will then use
2555 COMPARE-FUNC to compare entries."
2600 ;; If it is a timer list, convert timer to seconds
2613 value))
2617 next-record
2618 end-record
2619 value-to-sort
2620 nil
2621 sort-func)
2622 ;; Read and fix list again, as `sort-subr' probably destroyed
2623 ;; its structure.
2629 ;;; Send and receive lists
2632 "Parse the list at point and maybe DELETE it.
2634 Return a list whose car is a symbol of list type, among
2635 `ordered', `unordered' and `descriptive'. Then, each item is
2636 a list whose car is counter, and cdr are strings and other
2637 sub-lists. Inside strings, check-boxes are replaced by
2640 For example, the following list:
2642 1. first item
2643 + sub-item one
2644 + [X] sub-item two
2645 more text in first item
2646 2. [@3] last item
2648 will be parsed as:
2650 \(ordered
2652 \(unordered
2658 Point is left at list end."
2664 out
2665 parse-item ; for byte-compiler
2668 ;; Return text between BEG and END, trimmed, with
2669 ;; checkboxes replaced.
2680 text)))))
2683 ;; Return a list whose car is list type and cdr a list of
2684 ;; items' body.
2690 ;; Return a list containing counter of item, if any, text
2691 ;; and any sublist inside it.
2697 ;; Get counter number. For alphabetic counter, get
2698 ;; its position in the alphabet.
2709 ;; If item has a child, store text between bullet and
2710 ;; next child, then recursively parse all sublists. At
2711 ;; the end of each sublist, check for the presence of
2712 ;; text belonging to the original item.
2722 ;; Remove children from the list just parsed.
2724 ;; There is a chunk of text belonging to the
2725 ;; item if last child doesn't end where next
2726 ;; child starts or where item ends.
2730 body))))
2733 ;; Store output, take care of cursor position and deletion of
2734 ;; list, then return output.
2742 out))
2745 "Convert the plain list at point into a subtree."
2753 "Insert a radio list template appropriate for this major mode."
2757 name pos)
2768 "Send a transformed version of this list to the receiver position.
2769 With argument MAYBE, fail quietly if no transformation is defined
2770 for this list."
2776 (unless (looking-at "[ \t]*#\\+ORGLST[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
2795 beg txt)
2799 ;; Find the insertion place
2804 name
2818 "Convert a LIST parsed through `org-list-parse-list' to other formats.
2819 Valid parameters PARAMS are:
2821 :ustart String to start an unordered list
2822 :uend String to end an unordered list
2824 :ostart String to start an ordered list
2825 :oend String to end an ordered list
2827 :dstart String to start a descriptive list
2828 :dend String to end a descriptive list
2829 :dtstart String to start a descriptive term
2830 :dtend String to end a descriptive term
2831 :ddstart String to start a description
2832 :ddend String to end a description
2834 :splice When set to t, return only list body lines, don't wrap
2835 them into :[u/o]start and :[u/o]end. Default is nil.
2837 :istart String to start a list item.
2838 :icount String to start an item with a counter.
2839 :iend String to end a list item
2840 :isep String to separate items
2841 :lsep String to separate sublists
2842 :csep String to separate text from a sub-list
2844 :cboff String to insert for an unchecked check-box
2845 :cbon String to insert for a checked check-box
2846 :cbtrans String to insert for a check-box in transitional state
2848 Alternatively, each parameter can also be a form returning
2849 a string. These sexp can use keywords `counter' and `depth',
2850 reprensenting respectively counter associated to the current
2851 item, and depth of the current sub-list, starting at 0.
2852 Obviously, `counter' is only available for parameters applying to
2853 items."
2876 export-sublist ; for byte-compiler
2879 ;; Export an item ITEM of type TYPE, at DEPTH. First
2880 ;; string in item is treated in a special way as it can
2881 ;; bring extra information that needs to be processed.
2887 ;; Stick DTSTART to ISTART by
2888 ;; left-trimming the latter.
2892 istart))
2899 ;; Replace checkbox if any is found.
2907 ;; Insert descriptive term if TYPE is `descriptive'.
2916 first)))
2927 ;; Export sublist SUB at DEPTH.
2945 "Convert LIST into a LaTeX list.
2946 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2947 with overruling parameters for `org-list-to-generic'."
2949 list
2958 ;; LaTeX increments counter just before
2959 ;; using it, so set it to the desired
2960 ;; value, minus one.
2967 params)))
2970 "Convert LIST into a HTML list.
2971 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2972 with overruling parameters for `org-list-to-generic'."
2974 list
2986 params)))
2989 "Convert LIST into a Texinfo list.
2990 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2991 with overruling parameters for `org-list-to-generic'."
2993 list
3004 params)))
3007 "Convert LIST into an Org subtree.
3008 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3009 with overruling parameters for `org-list-to-generic'."
3019 ;; Return the string for the heading, depending on depth D
3020 ;; of current sub-list.
3025 oddeven-level)
3026 ?*)
3029 list
3031 '(:splice t
3038 params))))
3042 ;; arch-tag: 73cf50c1-200f-4d1d-8a53-4e842a5b11c8
3043 ;;; org-list.el ends here