| blob | ae6ebf961db591150462100c990c206031571f9b |
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.5
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. A
33 ;; structure is a snapshot of the list, in the shape of data tree (see
34 ;; `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:
130 ;;; Configuration variables
133 "Options concerning plain lists in Org-mode."
138 "When t, make TAB cycle visibility on plain list items.
139 Cycling plain lists works only when the cursor is on a plain list
140 item. When the cursor is on an outline heading, plain lists are
141 treated as text. This is the most stable way of handling this,
142 which is why it is the default.
144 When this is the symbol `integrate', then during cycling, plain
145 list items will *temporarily* be interpreted as outline headlines
146 with a level given by 1000+i where i is the indentation of the
147 bullet. This setting can lead to strange effects when switching
149 subtree decides what children should be listed. If that first
151 number, all true children and grand children of the outline
152 heading will be exposed in a children' view."
160 "Default bullet type installed when demoting an item.
161 This is an association list, for each bullet type, this alist will point
162 to the bullet that should be used when this item is demoted.
163 For example,
165 (setq org-list-demote-modify-bullet
168 will make
170 + Movies
171 + Silence of the Lambs
172 + My Cousin Vinny
173 + Books
174 + The Hunt for Red October
175 + The Road to Omaha
177 into
179 + Movies
180 - Silence of the Lambs
181 - My Cousin Vinny
182 + Books
183 - The Hunt for Red October
184 - The Road to Omaha"
202 "The character that makes a line with leading number an ordered list item.
203 Valid values are ?. and ?\). To get both terminators, use t. While
204 ?. may look nicer, it creates the danger that a line with leading
205 number may be incorrectly interpreted as an item. ?\) therefore is
206 the safe choice."
213 "Non-nil means single character alphabetical bullets are allowed.
214 Both uppercase and lowercase are handled. Lists with more than 26
215 items will fallback to standard numbering. Alphabetical counters
221 "A regular expression matching bullets that should have 2 spaces after them.
222 When nil, no bullet will have two spaces after them.
223 When 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 "Hook that is run whenever Org thinks checkbox statistics should be updated.
302 This hook runs even if checkbox rule in
303 `org-list-automatic-rules' does not apply, so it can be used to
304 implement alternative ways of collecting statistics
308 "Non-nil means checkbox statistics counts only the state of direct children.
309 When nil, all boxes below the cookie are counted.
310 This can be set to nil on a per-node basis using a COOKIE_DATA property
316 "Maximum indentation for the second line of a description list.
317 When the indentation would be larger than this, it will become
318 5 characters instead."
324 % END RECEIVE ORGLST %n
326 #+ORGLST: SEND %n org-list-to-latex
327 -
330 @c END RECEIVE ORGLST %n
331 @ignore
332 #+ORGLST: SEND %n org-list-to-texinfo
333 -
336 <!-- END RECEIVE ORGLST %n -->
337 <!--
338 #+ORGLST: SEND %n org-list-to-html
339 -
341 "Templates for radio lists in different major modes.
342 All occurrences of %n in a template will be replaced with the name of the
343 list, obtained by prompting the user."
350 "Names of blocks where lists are not allowed.
354 "Context types where lists will be interpreted during export.
356 Valid types are `drawer', `inlinetask' and `block'. More
357 specifically, type `block' is determined by the variable
361 ;;; Predicates and regexps
365 org-list-end-regexp)
366 "Regex corresponding to the end of a list.
374 "Matches a list item and puts everything into groups:
375 group 1: bullet
376 group 2: counter
377 group 3: checkbox
381 "Return the correct regular expression for plain lists."
392 "Regexp matching the beginning of a plain list item."
396 "Is point at a list item with REGEXP after bullet?"
405 ;; Ignore counter if any
410 "Non-nil if point is in a valid block.
411 Invalid blocks are referring to `org-list-forbidden-blocks'."
421 "Return item beginning position when in a plain list, nil otherwise.
422 This checks `org-list-ending-method'."
434 ;; Indentation isn't meaningful when point starts at an empty
435 ;; line or an inline task.
438 10000
444 ;; Detect if cursor in amidst `org-list-end-re'. First, count
445 ;; number HL of hard lines it takes, then call `org-in-regexp'
446 ;; to compute its boundaries END-BOUNDS. When point is
447 ;; in-between, move cursor before regexp beginning.
459 ;; Look for an item, less indented that reference line if
460 ;; `org-list-ending-method' isn't `regexp'.
465 ;; This is exactly what we want.
470 ;; At upper bound of search or looking at the end of a
471 ;; previous list: search is over.
476 ;; Skip blocks, drawers, inline-tasks, blank lines
486 ;; Text at column 0 cannot belong to a list: stop.
488 ;; Normal text less indented than reference line, take
489 ;; it as new reference.
496 "Is point in a line starting a hand-formatted item?"
502 "Is point at the bullet of a plain list item?"
508 "Is point at a line starting a plain list item with a timer?"
513 "Is point at a description list item?"
517 "Is point at a line starting a plain-list item with a checklet?"
521 "Is point at a line starting a plain-list item with a counter?"
527 ;;; Structures and helper functions
530 "Determine context, and its boundaries, around point.
532 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
533 are boundaries and CONTEXT is a symbol among `drawer', `block',
534 `invalid', `inlinetask' and nil.
536 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
542 ;; Get positions of surrounding headings. This is the
543 ;; default context.
548 ;; Is point inside a drawer?
550 ;; Can't use org-drawers-regexp as this function
551 ;; might be called in buffers not in Org mode
562 lim-down))
565 ;; Is point strictly in a block, and of which type?
576 lim-down))
582 ;; Is point in an inlinetask?
595 ;; Return context boundaries and type.
599 "Return structure of list at point.
601 A list structure is an alist where key is point at item, and
602 values are:
603 1. indentation,
604 2. bullet with trailing whitespace,
605 3. bullet counter, if any,
606 4. checkbox, if any,
607 5. description tag, if any,
608 6. position at item end.
610 Thus the following list, where numbers in parens are
611 point-at-bol:
613 - [X] first item (1)
614 1. sub-item 1 (18)
615 5. [@5] sub-item 2 (34)
616 some other text belonging to first item (55)
617 - last item (97)
618 + tag :: description (109)
619 (131)
621 will get the following structure:
629 Assume point is at an item."
644 ind itm-lst itm-lst-2 end-lst end-lst-2 struct
647 ;; Return association at point.
651 ind
658 ;; Ensure list ends at the first blank line.
662 ;; 1. Read list from starting item to its beginning, and save
663 ;; top item position and indentation in BEG-CELL. Also store
664 ;; ending position of items in END-LST.
672 ;; At upward limit: if we ended at an item, store it,
673 ;; else dimiss useless data recorded above BEG-CELL.
674 ;; Jump to part 2.
682 ;; At a verbatim block, go before its beginning. Move
683 ;; from eol to ensure `previous-single-property-change'
684 ;; will return a value.
689 ;; Looking at a list ending regexp. Dismiss useless
690 ;; data recorded above BEG-CELL. Jump to part 2.
696 ;; Point is at an item. Add data to ITM-LST. It may
697 ;; also end a previous item: save it in END-LST. If ind
698 ;; is less or equal than BEG-CELL and there is no end
699 ;; at this ind or lesser, this item becomes the new
700 ;; BEG-CELL.
709 ;; Skip blocks, drawers, inline tasks, blank lines.
720 ;; From there, point is not at an item. Unless ending
721 ;; method is `regexp', interpret line's indentation:
722 ;; - text at column 0 is necessarily out of any list.
723 ;; Dismiss data recorded above BEG-CELL. Jump to
724 ;; part 2.
725 ;; - any other case may be an ending position for an
726 ;; hypothetical item above. Store it and proceed.
736 ;; 2. Read list from starting point to its end, that is until we
737 ;; get out of context, or that a non-item line is less or
738 ;; equally indented than BEG-CELL's cdr. Also, store ending
739 ;; position of items in END-LST-2.
746 ;; At downward limit: this is de facto the end of the
747 ;; list. Save point as an ending position, and jump to
748 ;; part 3.
751 ;; At a verbatim block, move to its end. Point is at bol
752 ;; and 'org-example property is set by whole lines:
753 ;; `next-single-property-change' always return a value.
757 ;; Looking at a list ending regexp. Save point as an
758 ;; ending position and jump to part 3.
763 ;; Point is at an item. Add data to ITM-LST-2. It may also
764 ;; end a previous item, so save it in END-LST-2.
768 ;; Skip inline tasks and blank lines along the way
773 ;; Ind is lesser or equal than BEG-CELL's. The list is
774 ;; over: store point as an ending position and jump to
775 ;; part 3.
780 ;; Else, if ind is lesser or equal than previous item's,
781 ;; this is an ending position: store it. In any case,
782 ;; skip block or drawer at point, and move to next line.
795 ;; 3. Correct ill-formed lists by ensuring top item is the least
796 ;; indented.
803 ;; Trim bullet so item will be seen as different
804 ;; when compared with repaired version.
806 struct))
807 ;; 4. Associate each item to its end pos.
809 ;; 5. Return STRUCT
810 struct)))
813 "Associate proper ending point to items in STRUCT.
815 END-LIST is a pseudo-alist where car is indentation and cdr is
816 ending position.
818 This function modifies STRUCT."
824 ;; Remove end candidates behind current item
827 ;; Add end position to item assoc
833 struct)))
836 "Return alist between item and previous item in STRUCT."
838 struct)))
842 struct)))
845 "Return alist between item and parent in STRUCT."
867 ;;; Accessors
870 "Return the Nth value of KEY in STRUCT."
874 "Set the Nth value of KEY in STRUCT to NEW.
879 "Return indentation of ITEM in STRUCT."
883 "Set indentation of ITEM in STRUCT to IND.
888 "Return bullet of ITEM in STRUCT."
892 "Set bullet of ITEM in STRUCT to BULLET.
897 "Return counter of ITEM in STRUCT."
901 "Return checkbox of ITEM in STRUCT or nil."
905 "Set checkbox of ITEM in STRUCT to CHECKBOX.
910 "Return end position of ITEM in STRUCT."
914 "Return end position of ITEM in STRUCT."
918 "Return point at end of ITEM in STRUCT, before any blank line.
919 Point returned is at end of line."
926 "Return parent of ITEM or nil.
927 STRUCT is the list structure. PARENTS is the alist of parents, as
928 returned by `org-list-parents-alist'."
933 "Non-nil if ITEM has a child.
935 STRUCT is the list structure.
937 Value returned is the position of the first child of ITEM."
942 child-maybe)))
945 "Return next item in same sub-list as ITEM, or nil.
946 STRUCT is the list structure. PREVS is the alist of previous
947 items, as returned by `org-list-prevs-alist'."
951 "Return previous item in same sub-list as ITEM, or nil.
952 STRUCT is the list structure. PREVS is the alist of previous
953 items, as returned by `org-list-prevs-alist'."
957 "List all items having ITEM as a common ancestor, or nil.
958 STRUCT is the list structure."
961 subtree)
966 sub-struct))
970 "List all items in the same sub-list as ITEM.
971 STRUCT is the list structure. PREVS is the alist of previous
972 items, as returned by `org-list-prevs-alist'."
975 before-item after-item)
983 "List all children of ITEM, or nil.
984 STRUCT is the list structure. PARENTS is the alist of parents, as
985 returned by `org-list-parents-alist'."
993 "Return point at beginning of list.
994 STRUCT is the list structure."
998 "Return point at bottom of list.
999 STRUCT is the list structure."
1004 "Return point at beginning of sub-list ITEM belongs.
1005 STRUCT is the list structure. PREVS is the alist of previous
1006 items, as returned by `org-list-prevs-alist'."
1010 first-item))
1015 "Return point at last item of sub-list ITEM belongs.
1016 STRUCT is the list structure. PREVS is the alist of previous
1017 items, as returned by `org-list-prevs-alist'."
1021 last-item))
1024 "Return point at end of sub-list ITEM belongs.
1025 STRUCT is the list structure. PREVS is the alist of previous
1026 items, as returned by `org-list-prevs-alist'."
1030 "Return the type of the list containing ITEM, as a symbol.
1032 STRUCT is the list structure. PREVS is the alist of previous
1033 items, as returned by `org-list-prevs-alist'.
1035 Possible types are `descriptive', `ordered' and `unordered'. The
1036 type is determined by the first item of the list."
1044 ;;; Searching
1047 "Search a string in valid contexts for lists.
1048 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1049 in `re-search-forward'."
1053 ;; 1. No match: return to origin or bound, depending on NOERR.
1056 nil)))
1057 ;; 2. Match in valid context: return point. Else, continue
1058 ;; searching.
1062 "Like `re-search-backward' but stop only where lists are recognized.
1063 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1064 `re-search-backward'."
1069 "Like `re-search-forward' but stop only where lists are recognized.
1070 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1071 `re-search-forward'."
1076 ;;; Methods on structures
1079 "Return BULLET with the correct number of whitespaces.
1080 It determines the number of whitespaces to append by looking at
1081 `org-list-two-spaces-after-bullet-regexp'."
1085 org-list-two-spaces-after-bullet-regexp bullet))
1086 " "
1092 "Return number of blank lines that should separate items in list.
1094 POS is the position of point where `org-list-insert-item' was called.
1096 STRUCT is the list structure. PREVS is the alist of previous
1097 items, as returned by `org-list-prevs-alist'.
1099 Assume point is at item's beginning. If the item is alone, apply
1100 some heuristics to guess the result."
1105 usr-blank)
1107 ;; Trivial cases where there should be none.
1109 org-empty-line-terminates-plain-lists)
1111 ;; When `org-blank-before-new-entry' says so, it is 1.
1113 ;; plain-list-item is 'auto. Count blank lines separating
1114 ;; neighbours items in list.
1117 ;; Is there a next item?
1120 ;; Is there a previous item?
1123 ;; User inserted blank lines, trust him
1129 usr-blank)
1130 ;; Are there blank lines inside the item ?
1135 ;; No parent: no blank line.
1139 "Insert a new list item at POS and return the new structure.
1140 If POS is before first character after bullet of the item, the
1141 new item will be created before the current one.
1143 STRUCT is the list structure. PREVS is the the alist of previous
1144 items, as returned by `org-list-prevs-alist'.
1146 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1147 after the bullet. Cursor will be after this text once the
1148 function ends.
1150 This function modifies STRUCT."
1152 ;; 1. Get information about list: structure, usual helper
1153 ;; functions, position of point with regards to item start
1154 ;; (BEFOREP), blank lines number separating items (BLANK-NB),
1155 ;; position of split (POS) if we're allowed to (SPLIT-LINE-P).
1163 pos struct prevs))
1164 ;; 2. Build the new item to be created. Concatenate same
1165 ;; bullet as item, checkbox, text AFTER-BULLET if
1166 ;; provided, and text cut from point to end of item
1167 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1168 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1169 ;; between what was cut and what was inserted in buffer
1170 ;; is stored in SIZE-OFFSET.
1174 ind))
1188 text-cut))
1193 ;; 4. Insert effectively item into buffer
1197 ;; 5. Add new item to STRUCT.
1202 ;; Before inserted item, positions don't change but
1203 ;; an item ending after insertion has its end shifted
1204 ;; by SIZE-OFFSET.
1207 ;; Trivial cases where current item isn't split in
1208 ;; two. Just shift every item after new one by
1209 ;; ITEM-SIZE.
1213 ;; Item is split in two: elements before POS are just
1214 ;; shifted by ITEM-SIZE. In the case item would end
1215 ;; after split POS, ending is only shifted by
1216 ;; SIZE-OFFSET.
1222 ;; Elements after POS are moved into new item. Length
1223 ;; of ITEM-SEP has to be removed as ITEM-SEP
1224 ;; doesn't appear in buffer yet.
1230 (+ end size-offset
1232 ;; Elements at ITEM-END or after are only shifted by
1233 ;; SIZE-OFFSET.
1236 struct)
1239 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1240 ;; exchange ITEM with the next item in list. Position cursor
1241 ;; after bullet, counter, checkbox, and label.
1247 struct)))
1250 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1251 Blank lines at the end of items are left in place. Return the new
1252 structure after the changes.
1254 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1255 to the same sub-list.
1257 This function modifies STRUCT."
1270 ;; 1. Move effectively items in buffer.
1274 ;; 2. Now modify struct. No need to re-read the list, the
1275 ;; transformation is just a shift of positions. Some special
1276 ;; attention is required for items ending at END-A and END-B
1277 ;; as empty spaces are not moved there. In others words, item
1278 ;; BEG-A will end with whitespaces that were at the end of
1279 ;; BEG-B and the same applies to BEG-B.
1301 struct)
1305 "Outdent items between positions START and END.
1307 STRUCT is the list structure. PARENTS is the alist of items'
1308 parents, as returned by `org-list-parents-alist'.
1310 START is included, END excluded."
1316 ;; Item not yet in zone: keep association
1318 ;; Item out of zone: follow associations in acc
1322 ;; Item has no parent: error
1325 ;; Parent is outdented: keep association
1329 ;; Parent isn't outdented: reparent to grand-parent
1331 parent struct parents)))
1337 "Indent items between positions START and END.
1339 STRUCT is the list structure. PARENTS is the alist of parents and
1340 PREVS is the alist of previous items, returned by, respectively,
1341 `org-list-parents-alist' and `org-list-prevs-alist'.
1343 START is included and END excluded.
1345 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1346 bullets between START and END."
1360 ;; Item not yet in zone: keep association
1363 ;; Item out of zone: follow associations in acc
1367 ;; Item is in zone...
1369 ;; Check if bullet needs to be changed
1372 ;; First item indented but not parent: error
1375 ;; First item and parent indented: keep same parent
1377 ;; Previous item not indented: reparent to it
1379 ;; Previous item indented: reparent like it
1386 ;;; Repairing structures
1389 "Non-nil if list starting at FIRST can have alphabetical bullets.
1391 STRUCT is list structure. PREVS is the alist of previous items,
1392 as returned by `org-list-prevs-alist'."
1396 ;; Pretend that bullets are uppercase and check if alphabet
1397 ;; is sufficient, taking counters into account.
1401 ;; Virtually determine current bullet
1403 ;; Counters are not case-sensitive.
1406 ;; Test if bullet would be over z or Z.
1410 ;; All items checked. All good.
1411 t))))
1414 "Increment BULLET if applicable."
1417 ;; Num bullet: increment it.
1421 nil nil bullet))
1422 ;; Alpha bullet: increment it.
1426 nil nil bullet))
1427 ;; Unordered bullet: leave it.
1431 "Verify and correct bullets in STRUCT.
1432 PREVS is the alist of previous items, as returned by
1433 `org-list-prevs-alist'.
1435 This function modifies STRUCT."
1439 ;; Set bullet of ITEM in STRUCT, depending on the type of
1440 ;; first item of the list, the previous bullet and counter
1441 ;; if any.
1450 item struct
1453 ;; Alpha counter in alpha list: use counter.
1457 ;; Use cond to be sure `string-match' is used in
1458 ;; both cases.
1464 ;; Num counter in a num list: use counter.
1469 ;; No counter: increase, if needed, previous bullet.
1472 ;; Alpha counter at first item: use counter.
1481 ;; Num counter at first item: use counter.
1486 ;; First bullet is alpha uppercase: use "A".
1489 ;; First bullet is alpha lowercase: use "a".
1492 ;; First bullet is num: use "1".
1495 ;; Not an ordered list: keep bullet.
1500 "Verify and correct indentation in STRUCT.
1502 PARENTS is the alist of parents, as returned by
1503 `org-list-parents-alist'.
1505 If numeric optional argument BULLET-SIZE is set, assume all
1506 bullets in list have this length to determine new indentation.
1508 This function modifies STRUCT."
1515 ;; Indent like parent + length of parent's bullet
1521 ;; If no parent, indent like top-point
1526 "Verify and correct checkboxes in STRUCT.
1528 PARENTS is the alist of parents and PREVS is the alist of
1529 previous items, as returned by, respectively,
1530 `org-list-parents-alist' and `org-list-prevs-alist'.
1532 If ORDERED is non-nil, a checkbox can only be checked when every
1533 checkbox before it is checked too. If there was an attempt to
1534 break this rule, the function will return the blocking item. In
1535 all others cases, the return value will be nil.
1537 This function modifies STRUCT."
1547 item struct
1553 ;; parent has no boxed child: leave box as-is
1555 parent-list)
1556 ;; 1. List all parents with a checkbox
1563 all-items)
1564 ;; 2. Sort those parents by decreasing indentation
1569 ;; 3. For each parent, get all children's checkboxes to determine
1570 ;; and set its checkbox accordingly
1572 ;; 4. If ORDERED is set, see if we need to uncheck some boxes
1577 ;; there are boxes checked after an unchecked one: fix that
1582 ;; Verify once again the structure, without ORDERED
1584 ;; return blocking item
1588 "Apply set-difference between STRUCT and OLD-STRUCT to the buffer.
1590 OLD-STRUCT is the structure before any modifications, and STRUCT
1591 the structure to be applied. The function will only modify parts
1592 of the list which have changed.
1594 Initial position of cursor is restored after the changes."
1602 ;; Shift the indentation between END and BEG by DELTA.
1603 ;; Start from the line before END.
1612 ;; Skip inline tasks
1615 ;; Shift only non-empty lines
1622 ;; Replace ITEM first line elements with new elements from
1623 ;; STRUCT, if appropriate.
1633 ;; a. Replace bullet
1636 ;; b. Replace checkbox
1650 ;; c. Indent item to appropriate column
1655 ;; 1. First get list of items and position endings. We maintain
1656 ;; two alists: ITM-SHIFT, determining indentation shift needed
1657 ;; at item, and END-POS, a pseudo-alist where key is ending
1658 ;; position and value point
1671 ;; To determine real ind of an ending position that is
1672 ;; not at an item, we have to find the item it belongs
1673 ;; to: it is the last item (ITEM-UP), whose ending is
1674 ;; further than the position we're 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, as
1709 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: 1. set checkbox of all its items
2133 ;; within bounds to ref-checkbox; 2. fix checkboxes of the whole
2134 ;; list; 3. move point after the list.
2148 e struct
2149 ;; if there is no box at item, leave as-is
2150 ;; unless function was called with C-u prefix
2153 ref-checkbox
2154 cur-box))))
2155 items-to-toggle)
2157 struct parents prevs orderedp))
2158 ;; Report some problems due to ORDERED status of subtree. If
2159 ;; only one box was being checked, throw an error, else,
2160 ;; only signal problems.
2164 "Checkbox blocked because of unchecked box at line %d"
2168 "Checkboxes were removed due to unchecked box at line %d"
2175 "Reset all checkboxes in an entry subtree."
2190 "Update the checkbox statistics in the current section.
2191 This will find all statistic cookies like [57%] and [6/12] and
2192 update them with the current numbers.
2194 With optional prefix argument ALL, do this for the whole buffer."
2198 (box-re "^[ \t]*\\([-+*]\\|\\([0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2210 ;; Return number of checked boxes and boxes of all types
2211 ;; in all structures in STRUCTS. If RECURSIVEP is non-nil,
2212 ;; also count boxes in sub-lists. If ITEM is nil, count
2213 ;; across the whole structure, else count only across
2214 ;; subtree whose ancestor is ITEM.
2231 items))))
2234 structs)
2237 cookies-list structs-bak box-num)
2239 ;; 1. Build an alist for each cookie found within BOUNDS. The
2240 ;; key will be position at beginning of cookie and values
2241 ;; ending position, format of cookie, and a cell whose car is
2242 ;; number of checked boxes to report, and cdr total number of
2243 ;; boxes.
2253 ;; Cookie is at an heading, but specifically for todo,
2254 ;; not for checkboxes: skip it.
2260 ;; Cookie is at an heading, but all lists before next
2261 ;; heading already have been read. Use data collected
2262 ;; in STRUCTS-BAK. This should only happen when heading
2263 ;; has more than one cookie on it.
2266 backup-end))
2268 ;; Cookie is at a fresh heading. Grab structure of
2269 ;; every list containing a checkbox between point and
2270 ;; next headline, and save them in STRUCTS-BAK.
2280 ;; Cookie is at an item, and we already have list
2281 ;; structure stored in STRUCTS-BAK.
2284 ;; Only lists in no special context are stored.
2287 ;; Cookie is at an item, but we need to compute list
2288 ;; structure.
2294 ;; Else, cookie found is at a wrong place. Skip it.
2296 cookies-list))))
2297 ;; 2. Apply alist to buffer, in reverse order so positions stay
2298 ;; unchanged after cookie modifications.
2312 cookies-list))))
2315 "Select the face for checkbox statistics.
2316 The face will be `org-done' when all relevant boxes are checked.
2317 Otherwise it will be `org-todo'."
2320 'org-checkbox-statistics-done
2324 'org-checkbox-statistics-done
2328 "Update checkbox statistics unless turned off by user."
2336 "Indent a local list item including its children.
2337 When number ARG is a negative, item will be outdented, otherwise
2338 it will be indented.
2340 If a region is active, all items inside will be moved.
2342 If NO-SUBTREE is non-nil, only indent the item itself, not its
2343 children.
2345 STRUCT is the list structure.
2347 Return t if successful."
2356 ;; Are we going to move the whole list?
2363 t))))
2364 ;; Determine begin and end points of zone to indent. If moving
2365 ;; more than one item, save them for subsequent moves.
2381 ;; Special case: moving top-item with indent rule
2389 ;; Change bullet if necessary
2395 ;; Shift every item by OFFSET and fix bullets. Then
2396 ;; apply changes to buffer.
2400 struct)
2403 ;; Forbidden move:
2405 ;; If only one item is moved, it mustn't have a child
2409 ;; If a subtree or region is moved, the last item
2410 ;; of the subtree mustn't have a child
2415 struct)))))
2418 ;; Normal shifting
2426 t)
2429 "Outdent a local list item, but not its children.
2430 If a region is active, all items inside will be moved."
2438 "Indent a local list item, but not its children.
2439 If a region is active, all items inside will be moved."
2447 "Outdent a local list item including its children.
2448 If a region is active, all items inside will be moved."
2462 "Indent a local list item including its children.
2463 If a region is active, all items inside will be moved."
2478 "Cycle levels of indentation of an empty item.
2479 The first run indents the item, if applicable. Subsequents runs
2480 outdent it at meaningful levels in the list. When done, item is
2481 put back at its original position with its original bullet.
2483 Return t at each successful move."
2489 ;; Accept empty items or if cycle has already started.
2500 ;; When in the middle of the cycle, try to outdent first. If it
2501 ;; fails, and point is still at initial position, indent. Else,
2502 ;; go back to original position.
2511 ;; Break cycle
2513 ;; If a cycle is starting, remember indentation and bullet,
2514 ;; then try to indent. If it fails, try to outdent.
2520 t))))
2523 "Sort list items.
2524 The cursor may be at any item of the list that should be sorted.
2525 Sublists are not sorted. Checkboxes, if any, are ignored.
2527 Sorting can be alphabetically, numerically, by date/time as given by
2528 a time stamp, by a property or by priority.
2530 Comparing entries ignores case by default. However, with an
2531 optional argument WITH-CASE, the sorting considers case as well.
2533 The command prompts for the sorting type unless it has been given
2534 to the function through the SORTING-TYPE argument, which needs to
2535 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
2536 meaning of each character:
2538 n Numerically, by converting the beginning of the item to a number.
2539 a Alphabetically. Only the first line of item is checked.
2540 t By date/time, either the first active time stamp in the entry, if
2541 any, or by the first inactive one. In a timer list, sort the timers.
2543 Capital letters will reverse the sort order.
2545 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a
2546 function to be called with point at the beginning of the record.
2547 It must return either a string or a number that should serve as
2548 the sorting key for that record. It will then use COMPARE-FUNC to
2549 compare entries."
2594 ;; If it is a timer list, convert timer to seconds
2607 value))
2611 next-record
2612 end-record
2613 value-to-sort
2614 nil
2615 sort-func)
2616 ;; Read and fix list again, as `sort-subr' probably destroyed
2617 ;; its structure.
2623 ;;; Send and receive lists
2626 "Parse the list at point and maybe DELETE it.
2628 Return a list whose car is a symbol of list type, among
2629 `ordered', `unordered' and `descriptive'. Then, each item is a
2630 list whose car is counter, and cdr are strings and other
2634 For example, the following list:
2636 1. first item
2637 + sub-item one
2638 + [X] sub-item two
2639 more text in first item
2640 2. [@3] last item
2642 will be parsed as:
2644 \(ordered
2646 \(unordered
2652 Point is left at list end."
2658 out
2659 parse-item ; for byte-compiler
2662 ;; Return text between BEG and END, trimmed, with
2663 ;; checkboxes replaced.
2670 text)))))
2673 ;; Return a list whose car is list type and cdr a list of
2674 ;; items' body.
2680 ;; Return a list containing counter of item, if any, text
2681 ;; and any sublist inside it.
2687 ;; Get counter number. For alphabetic counter, get
2688 ;; its position in the alphabet.
2699 ;; If item has a child, store text between bullet and
2700 ;; next child, then recursively parse all sublists. At
2701 ;; the end of each sublist, check for the presence of
2702 ;; text belonging to the original item.
2712 ;; Remove children from the list just parsed.
2714 ;; There is a chunk of text belonging to the
2715 ;; item if last child doesn't end where next
2716 ;; child starts or where item ends.
2720 body))))
2723 ;; Store output, take care of cursor position and deletion of
2724 ;; list, then return output.
2732 out))
2735 "Convert the plain list at point into a subtree."
2743 "Insert a radio list template appropriate for this major mode."
2747 name pos)
2758 "Send a transformed version of this list to the receiver position.
2759 With argument MAYBE, fail quietly if no transformation is defined for
2760 this list."
2766 (unless (looking-at "[ \t]*#\\+ORGLST[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
2785 beg txt)
2789 ;; Find the insertion place
2794 name
2808 "Convert a LIST parsed through `org-list-parse-list' to other formats.
2809 Valid parameters PARAMS are
2811 :ustart String to start an unordered list
2812 :uend String to end an unordered list
2814 :ostart String to start an ordered list
2815 :oend String to end an ordered list
2817 :dstart String to start a descriptive list
2818 :dend String to end a descriptive list
2819 :dtstart String to start a descriptive term
2820 :dtend String to end a descriptive term
2821 :ddstart String to start a description
2822 :ddend String to end a description
2824 :splice When set to t, return only list body lines, don't wrap
2825 them into :[u/o]start and :[u/o]end. Default is nil.
2827 :istart String to start a list item.
2828 :icount String to start an item with a counter.
2829 :iend String to end a list item
2830 :isep String to separate items
2831 :lsep String to separate sublists
2832 :csep String to separate text from a sub-list
2834 :cboff String to insert for an unchecked checkbox
2835 :cbon String to insert for a checked checkbox
2837 Alternatively, each parameter can also be a form returning a
2838 string. These sexp can use keywords `counter' and `depth',
2839 reprensenting respectively counter associated to the current
2840 item, and depth of the current sub-list, starting at 0.
2841 Obviously, `counter' is only available for parameters applying to
2842 items."
2864 export-sublist ; for byte-compiler
2867 ;; Export an item ITEM of type TYPE, at DEPTH. First string
2868 ;; in item is treated in a special way as it can bring
2869 ;; extra information that needs to be processed.
2875 ;; Stick DTSTART to ISTART by
2876 ;; left-trimming the latter.
2880 istart))
2887 ;; Replace checkbox if any is found.
2895 ;; Insert descriptive term if TYPE is `descriptive'.
2904 first)))
2915 ;; Export sublist SUB at DEPTH
2933 "Convert LIST into a LaTeX list.
2934 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2935 with overruling parameters for `org-list-to-generic'."
2937 list
2947 enum counter)
2951 params)))
2954 "Convert LIST into a HTML list.
2955 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2956 with overruling parameters for `org-list-to-generic'."
2958 list
2969 params)))
2972 "Convert LIST into a Texinfo list.
2973 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2974 with overruling parameters for `org-list-to-generic'."
2976 list
2986 params)))
2989 "Convert LIST into an Org subtree.
2990 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2991 with overruling parameters for `org-list-to-generic'."
3001 ;; Return the string for the heading, depending on depth D
3002 ;; of current sub-list.
3007 oddeven-level)
3008 ?*)
3011 list
3013 '(:splice t
3020 params))))
3024 ;; arch-tag: 73cf50c1-200f-4d1d-8a53-4e842a5b11c8
3025 ;;; org-list.el ends here