| blob | 7402f2fae1f6319f3f95b84e32b321bbf312ff1c |
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.
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:
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. While
207 ?. may look nicer, it creates the danger that a line with leading
208 number may be incorrectly interpreted as an item. ?\) therefore is
209 the safe choice."
216 "Non-nil means single character alphabetical bullets are allowed.
217 Both uppercase and lowercase are handled. Lists with more than
218 26 items will fallback to standard numbering. Alphabetical
224 "A regular expression matching bullets that should have 2 spaces after them.
225 When nil, no bullet will have two spaces after them. When
226 a string, it will be used as a regular expression. When the
227 bullet type of a list is changed, the new bullet type will be
228 matched against this regexp. If it matches, there will be two
229 spaces instead of one after the bullet in each item of the list."
236 "Determine where plain lists should end.
237 Valid values are: `regexp', `indent' or `both'.
239 When set to `regexp', Org will look into two variables,
240 `org-empty-line-terminates-plain-lists' and the more general
241 `org-list-end-regexp', to determine what will end lists.
243 When set to `indent', a list will end whenever a line following
244 an item, but not starting one, is less or equally indented than
245 the first item of the list.
247 When set to `both', each of the preceding methods is applied to
248 determine lists endings. This is the default method."
256 "Non-nil means an empty line ends all plain list levels.
257 This variable only makes sense if `org-list-ending-method' is set
258 to `regexp' or `both'. This is then equivalent to set
264 "Regexp matching the end of all plain list levels.
266 blank lines. `org-empty-line-terminates-plain-lists' has
267 precedence over it."
274 "Non-nil means apply set of rules when acting on lists.
275 By default, automatic actions are taken when using
280 rules by setting them to nil. Valid rules are:
282 bullet when non-nil, cycling bullet do not allow lists at
283 column 0 to have * as a bullet and descriptions lists
284 to be numbered.
285 checkbox when non-nil, checkbox statistics is updated each time
286 you either insert a new checkbox or toggle a checkbox.
287 It also prevents from inserting a checkbox in a
288 description item.
289 indent when non-nil, indenting or outdenting list top-item
290 with its subtree will move the whole list and
291 outdenting a list whose bullet is * to column 0 will
295 :key-type
300 :value-type
304 "Hook that is run whenever Org thinks checkbox statistics should be updated.
305 This hook runs even if checkbox rule in
306 `org-list-automatic-rules' does not apply, so it can be used to
307 implement alternative ways of collecting statistics
311 "Non-nil means checkbox statistics counts only the state of direct children.
312 When nil, all boxes below the cookie are counted.
313 This can be set to nil on a per-node basis using a COOKIE_DATA property
319 "Maximum indentation for the second line of a description list.
320 When the indentation would be larger than this, it will become
321 5 characters instead."
327 % END RECEIVE ORGLST %n
329 #+ORGLST: SEND %n org-list-to-latex
330 -
333 @c END RECEIVE ORGLST %n
334 @ignore
335 #+ORGLST: SEND %n org-list-to-texinfo
336 -
339 <!-- END RECEIVE ORGLST %n -->
340 <!--
341 #+ORGLST: SEND %n org-list-to-html
342 -
344 "Templates for radio lists in different major modes.
345 All occurrences of %n in a template will be replaced with the name of the
346 list, obtained by prompting the user."
353 "Names of blocks where lists are not allowed.
357 "Context types where lists will be interpreted during export.
359 Valid types are `drawer', `inlinetask' and `block'. More
360 specifically, type `block' is determined by the variable
364 ;;; Predicates and regexps
368 org-list-end-regexp)
369 "Regex corresponding to the end of a list.
377 "Matches a list item and puts everything into groups:
378 group 1: bullet
379 group 2: counter
380 group 3: checkbox
384 "Return the correct regular expression for plain lists."
395 "Regexp matching the beginning of a plain list item."
399 "Is point at a list item with REGEXP after bullet?"
408 ;; Ignore counter if any
413 "Non-nil if point is in a valid block.
414 Invalid blocks are referring to `org-list-forbidden-blocks'."
424 "Return item beginning position when in a plain list, nil otherwise.
425 This checks `org-list-ending-method'."
437 ;; Indentation isn't meaningful when point starts at an empty
438 ;; line or an inline task.
441 10000
447 ;; Detect if cursor in amidst `org-list-end-re'. First, count
448 ;; number HL of hard lines it takes, then call `org-in-regexp'
449 ;; to compute its boundaries END-BOUNDS. When point is
450 ;; in-between, move cursor before regexp beginning.
462 ;; Look for an item, less indented that reference line if
463 ;; `org-list-ending-method' isn't `regexp'.
468 ;; This is exactly what we want.
473 ;; At upper bound of search or looking at the end of a
474 ;; previous list: search is over.
479 ;; Skip blocks, drawers, inline-tasks, blank lines
489 ;; Text at column 0 cannot belong to a list: stop.
491 ;; Normal text less indented than reference line, take
492 ;; it as new reference.
499 "Is point in a line starting a hand-formatted item?"
505 "Is point at the bullet of a plain list item?"
511 "Is point at a line starting a plain list item with a timer?"
516 "Is point at a description list item?"
520 "Is point at a line starting a plain-list item with a checklet?"
524 "Is point at a line starting a plain-list item with a counter?"
530 ;;; Structures and helper functions
533 "Determine context, and its boundaries, around point.
535 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
536 are boundaries and CONTEXT is a symbol among `drawer', `block',
537 `invalid', `inlinetask' and nil.
539 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
545 ;; Get positions of surrounding headings. This is the
546 ;; default context.
551 ;; Is point inside a drawer?
553 ;; Can't use org-drawers-regexp as this function might
554 ;; be called in buffers not in Org mode.
565 lim-down))
568 ;; Is point strictly in a block, and of which type?
579 lim-down))
585 ;; Is point in an inlinetask?
598 ;; Return context boundaries and type.
602 "Return structure of list at point.
604 A list structure is an alist where key is point at item, and
605 values are:
606 1. indentation,
607 2. bullet with trailing whitespace,
608 3. bullet counter, if any,
609 4. checkbox, if any,
610 5. description tag, if any,
611 6. position at item end.
613 Thus the following list, where numbers in parens are
614 point-at-bol:
616 - [X] first item (1)
617 1. sub-item 1 (18)
618 5. [@5] sub-item 2 (34)
619 some other text belonging to first item (55)
620 - last item (97)
621 + tag :: description (109)
622 (131)
624 will get the following structure:
632 Assume point is at an item."
647 ind itm-lst itm-lst-2 end-lst end-lst-2 struct
650 ;; Return association at point.
654 ind
661 ;; Ensure list ends at the first blank line.
665 ;; 1. Read list from starting item to its beginning, and save
666 ;; top item position and indentation in BEG-CELL. Also store
667 ;; ending position of items in END-LST.
675 ;; At upward limit: if we ended at an item, store it,
676 ;; else dimiss useless data recorded above BEG-CELL.
677 ;; Jump to part 2.
685 ;; At a verbatim block, go before its beginning. Move
686 ;; from eol to ensure `previous-single-property-change'
687 ;; will return a value.
692 ;; Looking at a list ending regexp. Dismiss useless
693 ;; data recorded above BEG-CELL. Jump to part 2.
699 ;; Point is at an item. Add data to ITM-LST. It may
700 ;; also end a previous item: save it in END-LST. If
701 ;; ind is less or equal than BEG-CELL and there is no
702 ;; end at this ind or lesser, this item becomes the new
703 ;; BEG-CELL.
712 ;; Skip blocks, drawers, inline tasks, blank lines.
723 ;; From there, point is not at an item. Unless ending
724 ;; method is `regexp', interpret line's indentation:
725 ;; - text at column 0 is necessarily out of any list.
726 ;; Dismiss data recorded above BEG-CELL. Jump to
727 ;; part 2.
728 ;; - any other case may be an ending position for an
729 ;; hypothetical item above. Store it and proceed.
739 ;; 2. Read list from starting point to its end, that is until we
740 ;; get out of context, or that a non-item line is less or
741 ;; equally indented than BEG-CELL's cdr. Also, store ending
742 ;; position of items in END-LST-2.
749 ;; At downward limit: this is de facto the end of the
750 ;; list. Save point as an ending position, and jump to
751 ;; part 3.
754 ;; At a verbatim block, move to its end. Point is at bol
755 ;; and 'org-example property is set by whole lines:
756 ;; `next-single-property-change' always return a value.
760 ;; Looking at a list ending regexp. Save point as an
761 ;; ending position and jump to part 3.
766 ;; Point is at an item. Add data to ITM-LST-2. It may
767 ;; also end a previous item, so save it in END-LST-2.
771 ;; Skip inline tasks and blank lines along the way
776 ;; Ind is lesser or equal than BEG-CELL's. The list is
777 ;; over: store point as an ending position and jump to
778 ;; part 3.
783 ;; Else, if ind is lesser or equal than previous item's,
784 ;; this is an ending position: store it. In any case,
785 ;; skip block or drawer at point, and move to next line.
798 ;; 3. Correct ill-formed lists by ensuring top item is the least
799 ;; indented.
806 ;; Trim bullet so item will be seen as different
807 ;; when compared with repaired version.
809 struct))
810 ;; 4. Associate each item to its end pos.
812 ;; 5. 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."
870 ;;; Accessors
873 "Return the Nth value of KEY in STRUCT."
877 "Set the Nth value of KEY in STRUCT to NEW.
882 "Return indentation of ITEM in STRUCT."
886 "Set indentation of ITEM in STRUCT to IND.
891 "Return bullet of ITEM in STRUCT."
895 "Set bullet of ITEM in STRUCT to BULLET.
900 "Return counter of ITEM in STRUCT."
904 "Return checkbox of ITEM in STRUCT or nil."
908 "Set checkbox of ITEM in STRUCT to CHECKBOX.
913 "Return end position of ITEM in STRUCT."
917 "Return end position of ITEM in STRUCT."
921 "Return point at end of ITEM in STRUCT, before any blank line.
922 Point returned is at end of line."
929 "Return parent of ITEM or nil.
930 STRUCT is the list structure. PARENTS is the alist of parents,
931 as returned by `org-list-parents-alist'."
936 "Non-nil if ITEM has a child.
938 STRUCT is the list structure.
940 Value returned is the position of the first child of ITEM."
945 child-maybe)))
948 "Return next item in same sub-list as ITEM, or nil.
949 STRUCT is the list structure. PREVS is the alist of previous
950 items, as returned by `org-list-prevs-alist'."
954 "Return previous item in same sub-list as ITEM, or nil.
955 STRUCT is the list structure. PREVS is the alist of previous
956 items, as returned by `org-list-prevs-alist'."
960 "List all items having ITEM as a common ancestor, or nil.
961 STRUCT is the list structure."
964 subtree)
969 sub-struct))
973 "List all items in the same sub-list as ITEM.
974 STRUCT is the list structure. PREVS is the alist of previous
975 items, as returned by `org-list-prevs-alist'."
978 before-item after-item)
986 "List all children of ITEM, or nil.
987 STRUCT is the list structure. PARENTS is the alist of parents, as
988 returned by `org-list-parents-alist'."
996 "Return point at beginning of list.
997 STRUCT is the list structure."
1001 "Return point at bottom of list.
1002 STRUCT is the list structure."
1007 "Return point at beginning of sub-list ITEM belongs.
1008 STRUCT is the list structure. PREVS is the alist of previous
1009 items, as returned by `org-list-prevs-alist'."
1013 first-item))
1018 "Return point at last item of sub-list ITEM belongs.
1019 STRUCT is the list structure. PREVS is the alist of previous
1020 items, as returned by `org-list-prevs-alist'."
1024 last-item))
1027 "Return point at end of sub-list ITEM belongs.
1028 STRUCT is the list structure. PREVS is the alist of previous
1029 items, as returned by `org-list-prevs-alist'."
1033 "Return the type of the list containing ITEM, as a symbol.
1035 STRUCT is the list structure. PREVS is the alist of previous
1036 items, as returned by `org-list-prevs-alist'.
1038 Possible types are `descriptive', `ordered' and `unordered'. The
1039 type is determined by the first item of the list."
1047 ;;; Searching
1050 "Search a string in valid contexts for lists.
1051 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1052 in `re-search-forward'."
1056 ;; 1. No match: return to origin or bound, depending on NOERR.
1059 nil)))
1060 ;; 2. Match in valid context: return point. Else, continue
1061 ;; searching.
1065 "Like `re-search-backward' but stop only where lists are recognized.
1066 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1067 `re-search-backward'."
1072 "Like `re-search-forward' but stop only where lists are recognized.
1073 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1074 `re-search-forward'."
1079 ;;; Methods on structures
1082 "Return BULLET with the correct number of whitespaces.
1083 It determines the number of whitespaces to append by looking at
1084 `org-list-two-spaces-after-bullet-regexp'."
1088 org-list-two-spaces-after-bullet-regexp bullet))
1089 " "
1095 "Return number of blank lines that should separate items in list.
1097 POS is the position of point where `org-list-insert-item' was called.
1099 STRUCT is the list structure. PREVS is the alist of previous
1100 items, as returned by `org-list-prevs-alist'.
1102 Assume point is at item's beginning. If the item is alone, apply
1103 some heuristics to guess the result."
1108 usr-blank)
1110 ;; Trivial cases where there should be none.
1112 org-empty-line-terminates-plain-lists)
1114 ;; When `org-blank-before-new-entry' says so, it is 1.
1116 ;; `plain-list-item' is 'auto. Count blank lines separating
1117 ;; neighbours items in list.
1120 ;; Is there a next item?
1123 ;; Is there a previous item?
1126 ;; User inserted blank lines, trust him.
1132 usr-blank)
1133 ;; Are there blank lines inside the item?
1138 ;; No parent: no blank line.
1142 "Insert a new list item at POS and return the new structure.
1143 If POS is before first character after bullet of the item, the
1144 new item will be created before the current one.
1146 STRUCT is the list structure. PREVS is the the alist of previous
1147 items, as returned by `org-list-prevs-alist'.
1149 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1150 after the bullet. Cursor will be after this text once the
1151 function ends.
1153 This function modifies STRUCT."
1155 ;; 1. Get information about list: structure, usual helper
1156 ;; functions, position of point with regards to item start
1157 ;; (BEFOREP), blank lines number separating items (BLANK-NB),
1158 ;; position of split (POS) if we're allowed to (SPLIT-LINE-P).
1166 pos struct prevs))
1167 ;; 2. Build the new item to be created. Concatenate same
1168 ;; bullet as item, checkbox, text AFTER-BULLET if
1169 ;; provided, and text cut from point to end of item
1170 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1171 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1172 ;; between what was cut and what was inserted in buffer
1173 ;; is stored in SIZE-OFFSET.
1177 ind))
1191 text-cut))
1196 ;; 4. Insert effectively item into buffer.
1200 ;; 5. Add new item to STRUCT.
1205 ;; Before inserted item, positions don't change but
1206 ;; an item ending after insertion has its end shifted
1207 ;; by SIZE-OFFSET.
1210 ;; Trivial cases where current item isn't split in
1211 ;; two. Just shift every item after new one by
1212 ;; ITEM-SIZE.
1216 ;; Item is split in two: elements before POS are just
1217 ;; shifted by ITEM-SIZE. In the case item would end
1218 ;; after split POS, ending is only shifted by
1219 ;; SIZE-OFFSET.
1225 ;; Elements after POS are moved into new item.
1226 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1227 ;; doesn't appear in buffer yet.
1233 (+ end size-offset
1235 ;; Elements at ITEM-END or after are only shifted by
1236 ;; SIZE-OFFSET.
1239 struct)
1242 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1243 ;; exchange ITEM with the next item in list. Position cursor
1244 ;; after bullet, counter, checkbox, and label.
1250 struct)))
1253 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1254 Blank lines at the end of items are left in place. Return the
1255 new structure after the changes.
1257 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1258 to the same sub-list.
1260 This function modifies STRUCT."
1273 ;; 1. Move effectively items in buffer.
1277 ;; 2. Now modify struct. No need to re-read the list, the
1278 ;; transformation is just a shift of positions. Some special
1279 ;; attention is required for items ending at END-A and END-B
1280 ;; as empty spaces are not moved there. In others words,
1281 ;; item BEG-A will end with whitespaces that were at the end
1282 ;; of BEG-B and the same applies to BEG-B.
1304 struct)
1308 "Outdent items between positions START and END.
1310 STRUCT is the list structure. PARENTS is the alist of items'
1311 parents, as returned by `org-list-parents-alist'.
1313 START is included, END excluded."
1319 ;; Item not yet in zone: keep association.
1321 ;; Item out of zone: follow associations in ACC.
1325 ;; Item has no parent: error
1328 ;; Parent is outdented: keep association.
1332 ;; Parent isn't outdented: reparent to grand-parent.
1334 parent struct parents)))
1340 "Indent items between positions START and END.
1342 STRUCT is the list structure. PARENTS is the alist of parents
1343 and PREVS is the alist of previous items, returned by,
1344 respectively, `org-list-parents-alist' and
1345 `org-list-prevs-alist'.
1347 START is included and END excluded.
1349 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1350 bullets between START and END."
1364 ;; Item not yet in zone: keep association.
1367 ;; Item out of zone: follow associations in ACC.
1371 ;; Item is in zone...
1373 ;; Check if bullet needs to be changed.
1376 ;; First item indented but not parent: error
1379 ;; First item and parent indented: keep same
1380 ;; parent.
1382 ;; Previous item not indented: reparent to it.
1384 ;; Previous item indented: reparent like it.
1391 ;;; Repairing structures
1394 "Non-nil if list starting at FIRST can have alphabetical bullets.
1396 STRUCT is list structure. PREVS is the alist of previous items,
1397 as returned by `org-list-prevs-alist'."
1401 ;; Pretend that bullets are uppercase and check if alphabet
1402 ;; is sufficient, taking counters into account.
1406 ;; Virtually determine current bullet
1408 ;; Counters are not case-sensitive.
1411 ;; Test if bullet would be over z or Z.
1415 ;; All items checked. All good.
1416 t))))
1419 "Increment BULLET if applicable."
1422 ;; Num bullet: increment it.
1426 nil nil bullet))
1427 ;; Alpha bullet: increment it.
1431 nil nil bullet))
1432 ;; Unordered bullet: leave it.
1436 "Verify and correct bullets in STRUCT.
1437 PREVS is the alist of previous items, as returned by
1438 `org-list-prevs-alist'.
1440 This function modifies STRUCT."
1444 ;; Set bullet of ITEM in STRUCT, depending on the type of
1445 ;; first item of the list, the previous bullet and counter
1446 ;; if any.
1455 item struct
1458 ;; Alpha counter in alpha list: use counter.
1462 ;; Use cond to be sure `string-match' is used in
1463 ;; both cases.
1469 ;; Num counter in a num list: use counter.
1474 ;; No counter: increase, if needed, previous bullet.
1477 ;; Alpha counter at first item: use counter.
1486 ;; Num counter at first item: use counter.
1491 ;; First bullet is alpha uppercase: use "A".
1494 ;; First bullet is alpha lowercase: use "a".
1497 ;; First bullet is num: use "1".
1500 ;; Not an ordered list: keep bullet.
1505 "Verify and correct indentation in STRUCT.
1507 PARENTS is the alist of parents, as returned by
1508 `org-list-parents-alist'.
1510 If numeric optional argument BULLET-SIZE is set, assume all
1511 bullets in list have this length to determine new indentation.
1513 This function modifies STRUCT."
1520 ;; Indent like parent + length of parent's bullet.
1526 ;; If no parent, indent like top-point.
1531 "Verify and correct checkboxes in STRUCT.
1533 PARENTS is the alist of parents and PREVS is the alist of
1534 previous items, as returned by, respectively,
1535 `org-list-parents-alist' and `org-list-prevs-alist'.
1537 If ORDERED is non-nil, a checkbox can only be checked when every
1538 checkbox before it is checked too. If there was an attempt to
1539 break this rule, the function will return the blocking item. In
1540 all others cases, the return value will be nil.
1542 This function modifies STRUCT."
1552 item struct
1558 ;; Parent has no boxed child: leave box as-is.
1560 parent-list)
1561 ;; 1. List all parents with a checkbox.
1568 all-items)
1569 ;; 2. Sort those parents by decreasing indentation.
1574 ;; 3. For each parent, get all children's checkboxes to determine
1575 ;; and set its checkbox accordingly.
1577 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1582 ;; There are boxes checked after an unchecked one: fix that.
1587 ;; Verify once again the structure, without ORDERED.
1589 ;; Return blocking item.
1593 "Apply set-difference between STRUCT and OLD-STRUCT to the buffer.
1595 OLD-STRUCT is the structure before any modifications, and STRUCT
1596 the structure to be applied. The function will only modify parts
1597 of the list which have changed.
1599 Initial position of cursor is restored after the changes."
1607 ;; Shift the indentation between END and BEG by DELTA.
1608 ;; Start from the line before END.
1617 ;; Skip inline tasks.
1620 ;; Shift only non-empty lines.
1627 ;; Replace ITEM first line elements with new elements from
1628 ;; STRUCT, if appropriate.
1638 ;; a. Replace bullet
1641 ;; b. Replace checkbox.
1655 ;; c. Indent item to appropriate column.
1660 ;; 1. First get list of items and position endings. We maintain
1661 ;; two alists: ITM-SHIFT, determining indentation shift needed
1662 ;; at item, and END-POS, a pseudo-alist where key is ending
1663 ;; position and value point.
1676 ;; To determine real ind of an ending position that
1677 ;; is not at an item, we have to find the item it
1678 ;; belongs to: it is the last item (ITEM-UP), whose
1679 ;; ending is further than the position we're
1680 ;; interested in.
1684 old-struct)
1685 ;; 2. Slice the items into parts that should be shifted by the
1686 ;; same amount of indentation. The slices are returned in
1687 ;; reverse order so changes modifying buffer do not change
1688 ;; positions they refer to.
1691 '<))
1699 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1700 ;; end to beginning. Take a special action when beginning is
1701 ;; at item bullet.
1708 sliced-struct))
1709 ;; 4. Go back to initial position.
1713 "Correct bullets, checkboxes and indentation in list at point.
1714 STRUCT is the list structure. PARENTS is the alist of parents,
1715 as returned by `org-list-parents-alist'."
1716 ;; Order of functions matters here: checkboxes and endings need
1717 ;; correct indentation to be set, and indentation needs correct
1718 ;; bullets.
1719 ;;
1720 ;; 0. Save a copy of structure before modifications
1722 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1723 ;; order to get items endings and bullets properly
1725 ;; 2. Get pseudo-alist of ending positions and sort it by position.
1726 ;; Then associate them to the structure.
1733 ;; To determine real ind of an ending position that is
1734 ;; not at an item, we have to find the item it belongs
1735 ;; to: it is the last item (ITEM-UP), whose ending is
1736 ;; further than the position we're interested in.
1739 ;; Else part is for the bottom point.
1741 end-pos)
1742 end-list)))
1745 struct)
1748 ;; 3. Get bullets right.
1751 ;; 4. Now get real indentation.
1753 ;; 5. Eventually fix checkboxes.
1755 ;; 6. Apply structure modifications to buffer.
1759 ;;; Misc Tools
1762 "Call FUNCTION on each item of the list at point.
1763 FUNCTION must be called with at least one argument: INIT-VALUE,
1764 that will contain the value returned by the function at the
1765 previous item, plus ARGS extra arguments.
1767 FUNCTION is applied on items in reverse order.
1769 As an example, \(org-apply-on-list \(lambda \(result\) \(1+ result\)\) 0\)
1770 will return the number of items in the current list.
1772 Sublists of the list are skipped. Cursor is always at the
1773 beginning of the item."
1784 value))
1787 "Set visibility of ITEM in STRUCT to VIEW.
1789 Possible values are: `folded', `children' or `subtree'. See
1790 `org-cycle' for more information."
1794 ;; Hide from eol
1796 item-end t)))
1798 ;; First show everything.
1800 ;; Then fold every child.
1805 children)))
1807 ;; Show everything
1812 "Return column at which body of ITEM should start."
1822 tcol))
1825 ;;; Interactive functions
1830 "Go to the beginning of the current item.
1831 Throw an error when not in a list."
1837 "Go to the beginning item of the current list or sublist.
1838 Throw an error when not in a list."
1849 "Go to the end of the current list or sublist.
1850 Throw an error when not in a list."
1861 "Go to the end of the current item.
1862 Throw an error when not in a list."
1872 "Move to the beginning of the previous item.
1873 Throw an error when not in a list, or at first item."
1885 "Move to the beginning of the next item.
1886 Throw an error when not in a plain list, or at last item."
1898 "Move the item at point down, i.e. swap with following item.
1899 Subitems (items with larger indentation) are considered part of
1900 the item, so this really moves item trees."
1915 ;; Use a short variation of `org-list-write-struct' as there's
1916 ;; no need to go through all the steps.
1927 "Move the item at point up, i.e. swap with previous item.
1928 Subitems (items with larger indentation) are considered part of
1929 the item, so this really moves item trees."
1944 ;; Use a short variation of `org-list-write-struct' as there's
1945 ;; no need to go through all the steps.
1955 "Insert a new item at the current level.
1956 If cursor is before first character after bullet of the item, the
1957 new item will be created before the current one.
1959 If CHECKBOX is non-nil, add a checkbox next to the bullet.
1961 Return t when things worked, nil when we are not in an item, or
1962 item is invisible."
1965 ;; If cursor isn't is a list or if list is invisible, return nil.
1973 ;; Timer list: delegate to `org-timer-item'.
1978 ;; If we're in a description list, ask for the new term.
1981 ;; Don't insert a checkbox if checkbox rule is applied
1982 ;; and it is a description item.
1986 org-list-automatic-rules)))))))
1993 t)))))
1996 "Fix indentation, bullets and checkboxes is the list at point."
2004 "Cycle through the different itemize/enumerate bullets.
2005 This cycle the entire list level through the sequence:
2007 `-' -> `+' -> `*' -> `1.' -> `1)'
2009 If WHICH is a valid string, use that as the new bullet. If WHICH
2010 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2011 `previous', cycle backwards."
2032 ;; Compute list of possible bullets, depending on context.
2035 ;; *-bullets are not allowed at column 0.
2038 ;; Description items cannot be numbered.
2061 ;; Use a short variation of `org-list-write-struct' as there's
2062 ;; no need to go through all the steps.
2070 "Toggle the checkbox in the current line.
2071 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2072 double prefix, set checkbox to [-].
2074 When there is an active region, toggle status or presence of the
2075 first checkbox there, and make every item inside have the same
2076 status or presence, respectively.
2078 If the cursor is in a headline, apply this to all checkbox items
2079 in the text below the heading, taking as reference the first item
2080 in subtree, ignoring drawers."
2084 block-item
2085 lim-up
2086 lim-down
2097 ;; In a region, start at first item in region.
2107 ;; On an heading, start at first item after drawers and
2108 ;; time-stamps (scheduled, etc.).
2119 ;; Just one item: set SINGLEP flag.
2125 ;; Determine the checkbox going to be applied to all items
2126 ;; within bounds.
2137 ;; When an item is found within bounds, grab the full list at
2138 ;; point structure, then:
2139 ;; 1. set check-box of all its items within bounds to
2140 ;; REF-CHECKBOX;
2141 ;; 2. fix check-boxes of the whole list; 3. move point after the
2142 ;; list.
2156 e struct
2157 ;; If there is no box at item, leave as-is
2158 ;; unless function was called with C-u prefix.
2161 ref-checkbox
2162 cur-box))))
2163 items-to-toggle)
2165 struct parents prevs orderedp))
2166 ;; Report some problems due to ORDERED status of subtree.
2167 ;; If only one box was being checked, throw an error, else,
2168 ;; only signal problems.
2172 "Checkbox blocked because of unchecked box at line %d"
2176 "Checkboxes were removed due to unchecked box at line %d"
2183 "Reset all checkboxes in an entry subtree."
2200 "Update the checkbox statistics in the current section.
2201 This will find all statistic cookies like [57%] and [6/12] and
2202 update them with the current numbers.
2204 With optional prefix argument ALL, do this for the whole buffer."
2208 (box-re "^[ \t]*\\([-+*]\\|\\([0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2220 ;; Return number of checked boxes and boxes of all types
2221 ;; in all structures in STRUCTS. If RECURSIVEP is
2222 ;; non-nil, also count boxes in sub-lists. If ITEM is
2223 ;; nil, count across the whole structure, else count only
2224 ;; across subtree whose ancestor is ITEM.
2241 items))))
2244 structs)
2247 cookies-list structs-bak box-num)
2249 ;; 1. Build an alist for each cookie found within BOUNDS. The
2250 ;; key will be position at beginning of cookie and values
2251 ;; ending position, format of cookie, and a cell whose car is
2252 ;; number of checked boxes to report, and cdr total number of
2253 ;; boxes.
2263 ;; Cookie is at an heading, but specifically for todo,
2264 ;; not for checkboxes: skip it.
2270 ;; Cookie is at an heading, but all lists before next
2271 ;; heading already have been read. Use data collected
2272 ;; in STRUCTS-BAK. This should only happen when
2273 ;; heading has more than one cookie on it.
2276 backup-end))
2278 ;; Cookie is at a fresh heading. Grab structure of
2279 ;; every list containing a checkbox between point and
2280 ;; next headline, and save them in STRUCTS-BAK.
2284 structs-bak nil)
2291 ;; Cookie is at an item, and we already have list
2292 ;; structure stored in STRUCTS-BAK.
2295 ;; Only lists in no special context are stored.
2298 ;; Cookie is at an item, but we need to compute list
2299 ;; structure.
2305 ;; Else, cookie found is at a wrong place. Skip it.
2307 cookies-list))))
2308 ;; 2. Apply alist to buffer, in reverse order so positions stay
2309 ;; unchanged after cookie modifications.
2324 cookies-list))))
2327 "Select the face for checkbox statistics.
2328 The face will be `org-done' when all relevant boxes are checked.
2329 Otherwise it will be `org-todo'."
2332 'org-checkbox-statistics-done
2336 'org-checkbox-statistics-done
2340 "Update checkbox statistics unless turned off by user."
2348 "Indent a local list item including its children.
2349 When number ARG is a negative, item will be outdented, otherwise
2350 it will be indented.
2352 If a region is active, all items inside will be moved.
2354 If NO-SUBTREE is non-nil, only indent the item itself, not its
2355 children.
2357 STRUCT is the list structure.
2359 Return t if successful."
2368 ;; Are we going to move the whole list?
2375 t))))
2376 ;; Determine begin and end points of zone to indent. If moving
2377 ;; more than one item, save them for subsequent moves.
2393 ;; Special case: moving top-item with indent rule.
2401 ;; Change bullet if necessary.
2407 ;; Shift every item by OFFSET and fix bullets. Then
2408 ;; apply changes to buffer.
2412 struct)
2415 ;; Forbidden move:
2417 ;; If only one item is moved, it mustn't have a child.
2421 ;; If a subtree or region is moved, the last item
2422 ;; of the subtree mustn't have a child.
2427 struct)))))
2430 ;; Normal shifting
2438 t)
2441 "Outdent a local list item, but not its children.
2442 If a region is active, all items inside will be moved."
2450 "Indent a local list item, but not its children.
2451 If a region is active, all items inside will be moved."
2459 "Outdent a local list item including its children.
2460 If a region is active, all items inside will be moved."
2474 "Indent a local list item including its children.
2475 If a region is active, all items inside will be moved."
2490 "Cycle levels of indentation of an empty item.
2491 The first run indents the item, if applicable. Subsequents runs
2492 outdent it at meaningful levels in the list. When done, item is
2493 put back at its original position with its original bullet.
2495 Return t at each successful move."
2501 ;; Accept empty items or if cycle has already started.
2512 ;; When in the middle of the cycle, try to outdent first. If
2513 ;; it fails, and point is still at initial position, indent.
2514 ;; Else, re-create it at its original position.
2523 ;; Break cycle
2525 ;; If a cycle is starting, remember indentation and bullet,
2526 ;; then try to indent. If it fails, try to outdent.
2532 t))))
2535 "Sort list items.
2536 The cursor may be at any item of the list that should be sorted.
2537 Sublists are not sorted. Checkboxes, if any, are ignored.
2539 Sorting can be alphabetically, numerically, by date/time as given
2540 by a time stamp, by a property or by priority.
2542 Comparing entries ignores case by default. However, with an
2543 optional argument WITH-CASE, the sorting considers case as well.
2545 The command prompts for the sorting type unless it has been given
2546 to the function through the SORTING-TYPE argument, which needs to
2547 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
2548 meaning of each character:
2550 n Numerically, by converting the beginning of the item to a number.
2551 a Alphabetically. Only the first line of item is checked.
2552 t By date/time, either the first active time stamp in the entry, if
2553 any, or by the first inactive one. In a timer list, sort the timers.
2555 Capital letters will reverse the sort order.
2557 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2558 a function to be called with point at the beginning of the
2559 record. It must return either a string or a number that should
2560 serve as the sorting key for that record. It will then use
2561 COMPARE-FUNC to compare entries."
2606 ;; If it is a timer list, convert timer to seconds
2619 value))
2623 next-record
2624 end-record
2625 value-to-sort
2626 nil
2627 sort-func)
2628 ;; Read and fix list again, as `sort-subr' probably destroyed
2629 ;; its structure.
2635 ;;; Send and receive lists
2638 "Parse the list at point and maybe DELETE it.
2640 Return a list whose car is a symbol of list type, among
2641 `ordered', `unordered' and `descriptive'. Then, each item is
2642 a list whose car is counter, and cdr are strings and other
2643 sub-lists. Inside strings, check-boxes are replaced by
2646 For example, the following list:
2648 1. first item
2649 + sub-item one
2650 + [X] sub-item two
2651 more text in first item
2652 2. [@3] last item
2654 will be parsed as:
2656 \(ordered
2658 \(unordered
2664 Point is left at list end."
2670 out
2671 parse-item ; for byte-compiler
2674 ;; Return text between BEG and END, trimmed, with
2675 ;; checkboxes replaced.
2686 text)))))
2689 ;; Return a list whose car is list type and cdr a list of
2690 ;; items' body.
2696 ;; Return a list containing counter of item, if any, text
2697 ;; and any sublist inside it.
2703 ;; Get counter number. For alphabetic counter, get
2704 ;; its position in the alphabet.
2715 ;; If item has a child, store text between bullet and
2716 ;; next child, then recursively parse all sublists. At
2717 ;; the end of each sublist, check for the presence of
2718 ;; text belonging to the original item.
2728 ;; Remove children from the list just parsed.
2730 ;; There is a chunk of text belonging to the
2731 ;; item if last child doesn't end where next
2732 ;; child starts or where item ends.
2736 body))))
2739 ;; Store output, take care of cursor position and deletion of
2740 ;; list, then return output.
2748 out))
2751 "Convert the plain list at point into a subtree."
2759 "Insert a radio list template appropriate for this major mode."
2763 name pos)
2774 "Send a transformed version of this list to the receiver position.
2775 With argument MAYBE, fail quietly if no transformation is defined
2776 for this list."
2782 (unless (looking-at "[ \t]*#\\+ORGLST[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
2801 beg txt)
2805 ;; Find the insertion place
2810 name
2824 "Convert a LIST parsed through `org-list-parse-list' to other formats.
2825 Valid parameters PARAMS are:
2827 :ustart String to start an unordered list
2828 :uend String to end an unordered list
2830 :ostart String to start an ordered list
2831 :oend String to end an ordered list
2833 :dstart String to start a descriptive list
2834 :dend String to end a descriptive list
2835 :dtstart String to start a descriptive term
2836 :dtend String to end a descriptive term
2837 :ddstart String to start a description
2838 :ddend String to end a description
2840 :splice When set to t, return only list body lines, don't wrap
2841 them into :[u/o]start and :[u/o]end. Default is nil.
2843 :istart String to start a list item.
2844 :icount String to start an item with a counter.
2845 :iend String to end a list item
2846 :isep String to separate items
2847 :lsep String to separate sublists
2848 :csep String to separate text from a sub-list
2850 :cboff String to insert for an unchecked check-box
2851 :cbon String to insert for a checked check-box
2852 :cbtrans String to insert for a check-box in transitional state
2854 Alternatively, each parameter can also be a form returning
2855 a string. These sexp can use keywords `counter' and `depth',
2856 reprensenting respectively counter associated to the current
2857 item, and depth of the current sub-list, starting at 0.
2858 Obviously, `counter' is only available for parameters applying to
2859 items."
2882 export-sublist ; for byte-compiler
2885 ;; Export an item ITEM of type TYPE, at DEPTH. First
2886 ;; string in item is treated in a special way as it can
2887 ;; bring extra information that needs to be processed.
2893 ;; Stick DTSTART to ISTART by
2894 ;; left-trimming the latter.
2898 istart))
2905 ;; Replace checkbox if any is found.
2913 ;; Insert descriptive term if TYPE is `descriptive'.
2922 first)))
2933 ;; Export sublist SUB at DEPTH.
2951 "Convert LIST into a LaTeX list.
2952 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2953 with overruling parameters for `org-list-to-generic'."
2955 list
2964 ;; LaTeX increments counter just before
2965 ;; using it, so set it to the desired
2966 ;; value, minus one.
2973 params)))
2976 "Convert LIST into a HTML list.
2977 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2978 with overruling parameters for `org-list-to-generic'."
2980 list
2992 params)))
2995 "Convert LIST into a Texinfo list.
2996 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2997 with overruling parameters for `org-list-to-generic'."
2999 list
3010 params)))
3013 "Convert LIST into an Org subtree.
3014 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3015 with overruling parameters for `org-list-to-generic'."
3025 ;; Return the string for the heading, depending on depth D
3026 ;; of current sub-list.
3031 oddeven-level)
3032 ?*)
3035 list
3037 '(:splice t
3044 params))))
3048 ;; arch-tag: 73cf50c1-200f-4d1d-8a53-4e842a5b11c8
3049 ;;; org-list.el ends here