| blob | 2339c4d1bc1d4c6ce6c85d3d38a71f64a87daef9 |
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.7
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."
212 "Non-nil means single character alphabetical bullets are allowed.
213 Both uppercase and lowercase are handled. Lists with more than
214 26 items will fallback to standard numbering. Alphabetical
220 "A regular expression matching bullets that should have 2 spaces after them.
221 When nil, no bullet will have two spaces after them. When
222 a string, it will be used as a regular expression. When the
223 bullet type of a list is changed, the new bullet type will be
224 matched against this regexp. If it matches, there will be two
225 spaces instead of one after the bullet in each item of the list."
232 "Determine where plain lists should end.
233 Valid values are: `regexp', `indent' or `both'.
235 When set to `regexp', Org will look into two variables,
236 `org-empty-line-terminates-plain-lists' and the more general
237 `org-list-end-regexp', to determine what will end lists.
239 When set to `indent', a list will end whenever a line following
240 an item, but not starting one, is less or equally indented than
241 the first item of the list.
243 When set to `both', each of the preceding methods is applied to
244 determine lists endings. This is the default method."
252 "Non-nil means an empty line ends all plain list levels.
253 This variable only makes sense if `org-list-ending-method' is set
254 to `regexp' or `both'. This is then equivalent to set
260 "Regexp matching the end of all plain list levels.
262 blank lines. `org-empty-line-terminates-plain-lists' has
263 precedence over it."
270 "Non-nil means apply set of rules when acting on lists.
271 By default, automatic actions are taken when using
276 rules by setting them to nil. Valid rules are:
278 bullet when non-nil, cycling bullet do not allow lists at
279 column 0 to have * as a bullet and descriptions lists
280 to be numbered.
281 checkbox when non-nil, checkbox statistics is updated each time
282 you either insert a new checkbox or toggle a checkbox.
283 It also prevents from inserting a checkbox in a
284 description item.
285 indent when non-nil, indenting or outdenting list top-item
286 with its subtree will move the whole list and
287 outdenting a list whose bullet is * to column 0 will
291 :key-type
296 :value-type
300 "Non-nil means commands implying motion in lists should be cyclic.
302 In that case, the item following the last item is the first one,
303 and the item preceding the first item is the last one.
312 "Hook that is run whenever Org thinks checkbox statistics should be updated.
313 This hook runs even if checkbox rule in
314 `org-list-automatic-rules' does not apply, so it can be used to
315 implement alternative ways of collecting statistics
319 "Non-nil means checkbox statistics counts only the state of direct children.
320 When nil, all boxes below the cookie are counted.
321 This can be set to nil on a per-node basis using a COOKIE_DATA property
327 "Maximum indentation for the second line of a description list.
328 When the indentation would be larger than this, it will become
329 5 characters instead."
334 "Additional indentation for sub-items in a list.
335 By setting this to a small number, usually 1 or 2, one can more
336 clearly distinguish sub-items in a list."
342 % END RECEIVE ORGLST %n
344 #+ORGLST: SEND %n org-list-to-latex
345 -
348 @c END RECEIVE ORGLST %n
349 @ignore
350 #+ORGLST: SEND %n org-list-to-texinfo
351 -
354 <!-- END RECEIVE ORGLST %n -->
355 <!--
356 #+ORGLST: SEND %n org-list-to-html
357 -
359 "Templates for radio lists in different major modes.
360 All occurrences of %n in a template will be replaced with the name of the
361 list, obtained by prompting the user."
369 "Names of blocks where lists are not allowed.
373 "Context types where lists will be interpreted during export.
375 Valid types are `drawer', `inlinetask' and `block'. More
376 specifically, type `block' is determined by the variable
380 ;;; Predicates and regexps
384 org-list-end-regexp)
385 "Regex corresponding to the end of a list.
393 "Matches a list item and puts everything into groups:
394 group 1: bullet
395 group 2: counter
396 group 3: checkbox
400 "Return the correct regular expression for plain lists."
411 "Regexp matching the beginning of a plain list item."
415 "Is point at a list item with REGEXP after bullet?"
424 ;; Ignore counter if any
429 "Is point in a context where lists are allowed?"
433 "Return item beginning position when in a plain list, nil otherwise.
434 This checks `org-list-ending-method'."
446 ;; Indentation isn't meaningful when point starts at an empty
447 ;; line or an inline task.
450 10000
456 ;; Detect if cursor in amidst `org-list-end-re'. First, count
457 ;; number HL of hard lines it takes, then call `org-in-regexp'
458 ;; to compute its boundaries END-BOUNDS. When point is
459 ;; in-between, move cursor before regexp beginning.
471 ;; Look for an item, less indented that reference line if
472 ;; `org-list-ending-method' isn't `regexp'.
477 ;; This is exactly what we want.
482 ;; At upper bound of search or looking at the end of a
483 ;; previous list: search is over.
488 ;; Skip blocks, drawers, inline-tasks, blank lines
498 ;; Text at column 0 cannot belong to a list: stop.
500 ;; Normal text less indented than reference line, take
501 ;; it as new reference.
508 "Is point in a line starting a hand-formatted item?"
514 "Is point at the bullet of a plain list item?"
520 "Is point at a line starting a plain list item with a timer?"
525 "Is point at a description list item?"
529 "Is point at a line starting a plain-list item with a checklet?"
533 "Is point at a line starting a plain-list item with a counter?"
539 ;;; Structures and helper functions
542 "Determine context, and its boundaries, around point.
544 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
545 are boundaries and CONTEXT is a symbol among `drawer', `block',
546 `invalid', `inlinetask' and nil.
548 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
554 ;; Get positions of surrounding headings. This is the
555 ;; default context.
560 ;; Is point inside a drawer?
562 ;; Can't use org-drawers-regexp as this function might
563 ;; be called in buffers not in Org mode.
574 lim-down))
577 ;; Is point strictly in a block, and of which type?
588 lim-down))
594 ;; Is point in an inlinetask?
607 ;; Return context boundaries and type.
611 "Return structure of list at point.
613 A list structure is an alist where key is point at item, and
614 values are:
615 1. indentation,
616 2. bullet with trailing whitespace,
617 3. bullet counter, if any,
618 4. checkbox, if any,
619 5. description tag, if any,
620 6. position at item end.
622 Thus the following list, where numbers in parens are
623 point-at-bol:
625 - [X] first item (1)
626 1. sub-item 1 (18)
627 5. [@5] sub-item 2 (34)
628 some other text belonging to first item (55)
629 - last item (97)
630 + tag :: description (109)
631 (131)
633 will get the following structure:
641 Assume point is at an item."
656 ind itm-lst itm-lst-2 end-lst end-lst-2 struct
659 ;; Return association at point.
663 ind
670 ;; Ensure list ends at the first blank line.
674 ;; 1. Read list from starting item to its beginning, and save
675 ;; top item position and indentation in BEG-CELL. Also store
676 ;; ending position of items in END-LST.
684 ;; At upward limit: if we ended at an item, store it,
685 ;; else dimiss useless data recorded above BEG-CELL.
686 ;; Jump to part 2.
694 ;; At a verbatim block, go before its beginning. Move
695 ;; from eol to ensure `previous-single-property-change'
696 ;; will return a value.
701 ;; Looking at a list ending regexp. Dismiss useless
702 ;; data recorded above BEG-CELL. Jump to part 2.
708 ;; Point is at an item. Add data to ITM-LST. It may
709 ;; also end a previous item: save it in END-LST. If
710 ;; ind is less or equal than BEG-CELL and there is no
711 ;; end at this ind or lesser, this item becomes the new
712 ;; BEG-CELL.
721 ;; Skip blocks, drawers, inline tasks, blank lines.
732 ;; From there, point is not at an item. Unless ending
733 ;; method is `regexp', interpret line's indentation:
734 ;; - text at column 0 is necessarily out of any list.
735 ;; Dismiss data recorded above BEG-CELL. Jump to
736 ;; part 2.
737 ;; - any other case may be an ending position for an
738 ;; hypothetical item above. Store it and proceed.
748 ;; 2. Read list from starting point to its end, that is until we
749 ;; get out of context, or that a non-item line is less or
750 ;; equally indented than BEG-CELL's cdr. Also, store ending
751 ;; position of items in END-LST-2.
758 ;; At downward limit: this is de facto the end of the
759 ;; list. Save point as an ending position, and jump to
760 ;; part 3.
763 ;; At a verbatim block, move to its end. Point is at bol
764 ;; and 'org-example property is set by whole lines:
765 ;; `next-single-property-change' always return a value.
769 ;; Looking at a list ending regexp. Save point as an
770 ;; ending position and jump to part 3.
775 ;; Point is at an item. Add data to ITM-LST-2. It may
776 ;; also end a previous item, so save it in END-LST-2.
780 ;; Skip inline tasks and blank lines along the way
785 ;; Ind is lesser or equal than BEG-CELL's. The list is
786 ;; over: store point as an ending position and jump to
787 ;; part 3.
792 ;; Else, if ind is lesser or equal than previous item's,
793 ;; this is an ending position: store it. In any case,
794 ;; skip block or drawer at point, and move to next line.
807 ;; 3. Correct ill-formed lists by ensuring top item is the least
808 ;; indented.
815 ;; Trim bullet so item will be seen as different
816 ;; when compared with repaired version.
818 struct))
819 ;; 4. Associate each item to its end pos.
821 ;; 5. Return STRUCT
822 struct)))
825 "Associate proper ending point to items in STRUCT.
827 END-LIST is a pseudo-alist where car is indentation and cdr is
828 ending position.
830 This function modifies STRUCT."
836 ;; Remove end candidates behind current item.
839 ;; Add end position to item assoc.
845 struct)))
848 "Return alist between item and previous item in STRUCT."
850 struct)))
854 struct)))
857 "Return alist between item and parent in STRUCT."
879 ;;; Accessors
882 "Return the Nth value of KEY in STRUCT."
886 "Set the Nth value of KEY in STRUCT to NEW.
891 "Return indentation of ITEM in STRUCT."
895 "Set indentation of ITEM in STRUCT to IND.
900 "Return bullet of ITEM in STRUCT."
904 "Set bullet of ITEM in STRUCT to BULLET.
909 "Return counter of ITEM in STRUCT."
913 "Return checkbox of ITEM in STRUCT or nil."
917 "Set checkbox of ITEM in STRUCT to CHECKBOX.
922 "Return end position of ITEM in STRUCT."
926 "Return end position of ITEM in STRUCT."
930 "Return point at end of ITEM in STRUCT, before any blank line.
931 Point returned is at end of line."
938 "Return parent of ITEM or nil.
939 STRUCT is the list structure. PARENTS is the alist of parents,
940 as returned by `org-list-parents-alist'."
945 "Non-nil if ITEM has a child.
947 STRUCT is the list structure.
949 Value returned is the position of the first child of ITEM."
954 child-maybe)))
957 "Return next item in same sub-list as ITEM, or nil.
958 STRUCT is the list structure. PREVS is the alist of previous
959 items, as returned by `org-list-prevs-alist'."
963 "Return previous item in same sub-list as ITEM, or nil.
964 STRUCT is the list structure. PREVS is the alist of previous
965 items, as returned by `org-list-prevs-alist'."
969 "List all items having ITEM as a common ancestor, or nil.
970 STRUCT is the list structure."
973 subtree)
978 sub-struct))
982 "List all items in the same sub-list as ITEM.
983 STRUCT is the list structure. PREVS is the alist of previous
984 items, as returned by `org-list-prevs-alist'."
987 before-item after-item)
995 "List all children of ITEM, or nil.
996 STRUCT is the list structure. PARENTS is the alist of parents, as
997 returned by `org-list-parents-alist'."
1005 "Return point at beginning of list.
1006 STRUCT is the list structure."
1010 "Return point at bottom of list.
1011 STRUCT is the list structure."
1016 "Return point at beginning of sub-list ITEM belongs.
1017 STRUCT is the list structure. PREVS is the alist of previous
1018 items, as returned by `org-list-prevs-alist'."
1022 first-item))
1027 "Return point at last item 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 last-item))
1036 "Return point at end of sub-list ITEM belongs.
1037 STRUCT is the list structure. PREVS is the alist of previous
1038 items, as returned by `org-list-prevs-alist'."
1042 "Return the type of the list containing ITEM, as a symbol.
1044 STRUCT is the list structure. PREVS is the alist of previous
1045 items, as returned by `org-list-prevs-alist'.
1047 Possible types are `descriptive', `ordered' and `unordered'. The
1048 type is determined by the first item of the list."
1056 ;;; Searching
1059 "Search a string in valid contexts for lists.
1060 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1061 in `re-search-forward'."
1065 ;; 1. No match: return to origin or bound, depending on NOERR.
1068 nil)))
1069 ;; 2. Match in valid context: return point. Else, continue
1070 ;; searching.
1074 "Like `re-search-backward' but stop only where lists are recognized.
1075 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1076 `re-search-backward'."
1081 "Like `re-search-forward' but stop only where lists are recognized.
1082 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1083 `re-search-forward'."
1088 ;;; Methods on structures
1091 "Return BULLET with the correct number of whitespaces.
1092 It determines the number of whitespaces to append by looking at
1093 `org-list-two-spaces-after-bullet-regexp'."
1097 org-list-two-spaces-after-bullet-regexp bullet))
1098 " "
1104 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1105 Blank lines at the end of items are left in place. Return the
1106 new structure after the changes.
1108 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1109 to the same sub-list.
1111 This function modifies STRUCT."
1124 ;; 1. Move effectively items in buffer.
1128 ;; 2. Now modify struct. No need to re-read the list, the
1129 ;; transformation is just a shift of positions. Some special
1130 ;; attention is required for items ending at END-A and END-B
1131 ;; as empty spaces are not moved there. In others words,
1132 ;; item BEG-A will end with whitespaces that were at the end
1133 ;; of BEG-B and the same applies to BEG-B.
1155 struct)
1159 "Return number of blank lines that should separate items in list.
1161 POS is the position of point where `org-list-insert-item' was called.
1163 STRUCT is the list structure. PREVS is the alist of previous
1164 items, as returned by `org-list-prevs-alist'.
1166 Assume point is at item's beginning. If the item is alone, apply
1167 some heuristics to guess the result."
1172 usr-blank)
1174 ;; Trivial cases where there should be none.
1176 org-empty-line-terminates-plain-lists)
1178 ;; When `org-blank-before-new-entry' says so, it is 1.
1180 ;; `plain-list-item' is 'auto. Count blank lines separating
1181 ;; neighbours items in list.
1184 ;; Is there a next item?
1187 ;; Is there a previous item?
1190 ;; User inserted blank lines, trust him.
1196 usr-blank)
1197 ;; Are there blank lines inside the list so far?
1203 ;; Default choice: no blank line.
1207 "Insert a new list item at POS and return the new structure.
1208 If POS is before first character after bullet of the item, the
1209 new item will be created before the current one.
1211 STRUCT is the list structure. PREVS is the the alist of previous
1212 items, as returned by `org-list-prevs-alist'.
1214 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1215 after the bullet. Cursor will be after this text once the
1216 function ends.
1218 This function modifies STRUCT."
1220 ;; 1. Get information about list: position of point with regards
1221 ;; to item start (BEFOREP), blank lines number separating items
1222 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1230 pos struct prevs))
1231 ;; 2. Build the new item to be created. Concatenate same
1232 ;; bullet as item, checkbox, text AFTER-BULLET if
1233 ;; provided, and text cut from point to end of item
1234 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1235 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1236 ;; between what was cut and what was inserted in buffer
1237 ;; is stored in SIZE-OFFSET.
1241 ind))
1248 ;; If POS is greater than ITEM-END, then point is
1249 ;; in some white lines after the end of the list.
1250 ;; Those must be removed, or they will be left,
1251 ;; stacking up after the list.
1261 text-cut))))
1265 ;; 4. Insert effectively item into buffer.
1269 ;; 5. Add new item to STRUCT.
1274 ;; Before inserted item, positions don't change but
1275 ;; an item ending after insertion has its end shifted
1276 ;; by SIZE-OFFSET.
1279 ;; Trivial cases where current item isn't split in
1280 ;; two. Just shift every item after new one by
1281 ;; ITEM-SIZE.
1285 ;; Item is split in two: elements before POS are just
1286 ;; shifted by ITEM-SIZE. In the case item would end
1287 ;; after split POS, ending is only shifted by
1288 ;; SIZE-OFFSET.
1294 ;; Elements after POS are moved into new item.
1295 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1296 ;; doesn't appear in buffer yet.
1302 (+ end size-offset
1304 ;; Elements at ITEM-END or after are only shifted by
1305 ;; SIZE-OFFSET.
1308 struct)
1311 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1312 ;; exchange ITEM with the next item in list. Position cursor
1313 ;; after bullet, counter, checkbox, and label.
1319 struct)))
1322 "Remove ITEM from the list and return the new structure.
1324 STRUCT is the list structure."
1327 ;; If ITEM ends with the list, delete blank lines
1328 ;; before it.
1333 item)))
1334 ;; Remove item from buffer.
1336 ;; Remove item from structure and shift others items accordingly.
1337 ;; Don't forget to shift also ending position when appropriate.
1355 struct)))))
1358 "Send ITEM to destination DEST.
1360 STRUCT is the list structure.
1362 DEST can have various values.
1364 If DEST is a buffer position, the function will assume it points
1365 to another item in the same list as ITEM, and will move the
1366 latter just before the former.
1368 If DEST is `begin' \(resp. `end'\), ITEM will be moved at the
1369 beginning \(resp. end\) of the list it belongs to.
1372 be moved at the Nth position in the list.
1374 If DEST is `kill', ITEM will be deleted and its body will be
1375 added to the kill-ring.
1377 If DEST is `delete', ITEM will be deleted.
1379 This function returns, destructively, the new list structure."
1382 ;; Grab full item body minus its bullet.
1391 item-end)))
1392 ;; Change DEST into a buffer position. A trick is needed
1393 ;; when ITEM is meant to be sent at the end of the list.
1394 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1395 ;; nil and insertion point (INS-POINT) to the first line's
1396 ;; end of the last item, we ensure the new item will be
1397 ;; inserted after the last item, and not after any of its
1398 ;; hypothetical sub-items.
1414 ;; Send ITEM at the end of the list.
1430 ;; 1. Structure returned by `org-list-insert-item' may not be
1431 ;; accurate, as it cannot see sub-items included in BODY.
1432 ;; Thus, first compute the real structure so far.
1440 ;; 1.1. Remove the item just created in structure.
1442 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1445 struct
1453 new-end
1455 moved-items))
1457 ;; 2. Eventually delete extra copy of the item and clean marker.
1464 "Outdent items between positions START and END.
1466 STRUCT is the list structure. PARENTS is the alist of items'
1467 parents, as returned by `org-list-parents-alist'.
1469 START is included, END excluded."
1475 ;; Item not yet in zone: keep association.
1477 ;; Item out of zone: follow associations in ACC.
1481 ;; Item has no parent: error
1484 ;; Parent is outdented: keep association.
1488 ;; Parent isn't outdented: reparent to grand-parent.
1490 parent struct parents)))
1496 "Indent items between positions START and END.
1498 STRUCT is the list structure. PARENTS is the alist of parents
1499 and PREVS is the alist of previous items, returned by,
1500 respectively, `org-list-parents-alist' and
1501 `org-list-prevs-alist'.
1503 START is included and END excluded.
1505 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1506 bullets between START and END."
1520 ;; Item not yet in zone: keep association.
1523 ;; Item out of zone: follow associations in ACC.
1527 ;; Item is in zone...
1529 ;; Check if bullet needs to be changed.
1532 ;; First item indented but not parent: error
1535 ;; First item and parent indented: keep same
1536 ;; parent.
1538 ;; Previous item not indented: reparent to it.
1540 ;; Previous item indented: reparent like it.
1547 ;;; Repairing structures
1550 "Non-nil if list starting at FIRST can have alphabetical bullets.
1552 STRUCT is list structure. PREVS is the alist of previous items,
1553 as returned by `org-list-prevs-alist'."
1557 ;; Pretend that bullets are uppercase and check if alphabet
1558 ;; is sufficient, taking counters into account.
1562 ;; Virtually determine current bullet
1564 ;; Counters are not case-sensitive.
1567 ;; Test if bullet would be over z or Z.
1571 ;; All items checked. All good.
1572 t))))
1575 "Increment BULLET if applicable."
1578 ;; Num bullet: increment it.
1582 nil nil bullet))
1583 ;; Alpha bullet: increment it.
1587 nil nil bullet))
1588 ;; Unordered bullet: leave it.
1592 "Verify and correct bullets in STRUCT.
1593 PREVS is the alist of previous items, as returned by
1594 `org-list-prevs-alist'.
1596 This function modifies STRUCT."
1600 ;; Set bullet of ITEM in STRUCT, depending on the type of
1601 ;; first item of the list, the previous bullet and counter
1602 ;; if any.
1611 item struct
1614 ;; Alpha counter in alpha list: use counter.
1618 ;; Use cond to be sure `string-match' is used in
1619 ;; both cases.
1625 ;; Num counter in a num list: use counter.
1630 ;; No counter: increase, if needed, previous bullet.
1633 ;; Alpha counter at first item: use counter.
1642 ;; Num counter at first item: use counter.
1647 ;; First bullet is alpha uppercase: use "A".
1650 ;; First bullet is alpha lowercase: use "a".
1653 ;; First bullet is num: use "1".
1656 ;; Not an ordered list: keep bullet.
1661 "Verify and correct indentation in STRUCT.
1663 PARENTS is the alist of parents, as returned by
1664 `org-list-parents-alist'.
1666 If numeric optional argument BULLET-SIZE is set, assume all
1667 bullets in list have this length to determine new indentation.
1669 This function modifies STRUCT."
1676 ;; Indent like parent + length of parent's bullet +
1677 ;; sub-list offset.
1683 org-list-indent-offset))
1684 ;; If no parent, indent like top-point.
1689 "Verify and correct checkboxes in STRUCT.
1691 PARENTS is the alist of parents and PREVS is the alist of
1692 previous items, as returned by, respectively,
1693 `org-list-parents-alist' and `org-list-prevs-alist'.
1695 If ORDERED is non-nil, a checkbox can only be checked when every
1696 checkbox before it is checked too. If there was an attempt to
1697 break this rule, the function will return the blocking item. In
1698 all others cases, the return value will be nil.
1700 This function modifies STRUCT."
1710 item struct
1716 ;; Parent has no boxed child: leave box as-is.
1718 parent-list)
1719 ;; 1. List all parents with a checkbox.
1726 all-items)
1727 ;; 2. Sort those parents by decreasing indentation.
1732 ;; 3. For each parent, get all children's checkboxes to determine
1733 ;; and set its checkbox accordingly.
1735 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1740 ;; There are boxes checked after an unchecked one: fix that.
1745 ;; Verify once again the structure, without ORDERED.
1747 ;; Return blocking item.
1751 "Apply set-difference between STRUCT and OLD-STRUCT to the buffer.
1753 OLD-STRUCT is the structure before any modifications, and STRUCT
1754 the structure to be applied. The function will only modify parts
1755 of the list which have changed.
1757 Initial position of cursor is restored after the changes."
1765 ;; Shift the indentation between END and BEG by DELTA.
1766 ;; Start from the line before END.
1775 ;; Skip inline tasks.
1778 ;; Shift only non-empty lines.
1785 ;; Replace ITEM first line elements with new elements from
1786 ;; STRUCT, if appropriate.
1796 ;; a. Replace bullet
1799 ;; b. Replace checkbox.
1808 ;; (goto-char (or (match-end 2) (match-end 1)))
1809 ;; (skip-chars-backward " \t")
1815 ;; c. Indent item to appropriate column.
1820 ;; 1. First get list of items and position endings. We maintain
1821 ;; two alists: ITM-SHIFT, determining indentation shift needed
1822 ;; at item, and END-POS, a pseudo-alist where key is ending
1823 ;; position and value point.
1836 ;; To determine real ind of an ending position that
1837 ;; is not at an item, we have to find the item it
1838 ;; belongs to: it is the last item (ITEM-UP), whose
1839 ;; ending is further than the position we're
1840 ;; interested in.
1844 old-struct)
1845 ;; 2. Slice the items into parts that should be shifted by the
1846 ;; same amount of indentation. The slices are returned in
1847 ;; reverse order so changes modifying buffer do not change
1848 ;; positions they refer to.
1851 '<))
1859 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1860 ;; end to beginning. Take a special action when beginning is
1861 ;; at item bullet.
1868 sliced-struct))
1869 ;; 4. Go back to initial position and clean marker.
1874 "Correct bullets, checkboxes and indentation in list at point.
1875 STRUCT is the list structure. PARENTS is the alist of parents,
1876 as returned by `org-list-parents-alist'."
1877 ;; Order of functions matters here: checkboxes and endings need
1878 ;; correct indentation to be set, and indentation needs correct
1879 ;; bullets.
1880 ;;
1881 ;; 0. Save a copy of structure before modifications
1883 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1884 ;; order to get items endings and bullets properly
1886 ;; 2. Get pseudo-alist of ending positions and sort it by position.
1887 ;; Then associate them to the structure.
1894 ;; To determine real ind of an ending position that is
1895 ;; not at an item, we have to find the item it belongs
1896 ;; to: it is the last item (ITEM-UP), whose ending is
1897 ;; further than the position we're interested in.
1900 ;; Else part is for the bottom point.
1902 end-pos)
1903 end-list)))
1906 struct)
1909 ;; 3. Get bullets right.
1912 ;; 4. Now get real indentation.
1914 ;; 5. Eventually fix checkboxes.
1916 ;; 6. Apply structure modifications to buffer.
1920 ;;; Misc Tools
1923 "Call FUNCTION on each item of the list at point.
1924 FUNCTION must be called with at least one argument: INIT-VALUE,
1925 that will contain the value returned by the function at the
1926 previous item, plus ARGS extra arguments.
1928 FUNCTION is applied on items in reverse order.
1930 As an example, \(org-apply-on-list \(lambda \(result\) \(1+ result\)\) 0\)
1931 will return the number of items in the current list.
1933 Sublists of the list are skipped. Cursor is always at the
1934 beginning of the item."
1946 value))
1949 "Set visibility of ITEM in STRUCT to VIEW.
1951 Possible values are: `folded', `children' or `subtree'. See
1952 `org-cycle' for more information."
1956 ;; Hide from eol
1958 item-end t)))
1960 ;; First show everything.
1962 ;; Then fold every child.
1967 children)))
1969 ;; Show everything
1974 "Return column at which body of ITEM should start."
1984 tcol))
1987 ;;; Interactive functions
1992 "Go to the beginning of the current item.
1993 Throw an error when not in a list."
1999 "Go to the beginning item of the current list or sublist.
2000 Throw an error when not in a list."
2011 "Go to the end of the current list or sublist.
2012 Throw an error when not in a list."
2023 "Go to the end of the current item.
2024 Throw an error when not in a list."
2034 "Move to the beginning of the previous item.
2035 Throw an error when not in a list. Also throw an error when at
2036 first item, unless `org-list-use-circular-motion' is non-nil."
2052 "Move to the beginning of the next item.
2053 Throw an error when not in a list. Also throw an error when at
2054 last item, unless `org-list-use-circular-motion' is non-nil."
2070 "Move the item at point down, i.e. swap with following item.
2071 Sub-items (items with larger indentation) are considered part of
2072 the item, so this really moves item trees."
2091 "Move the item at point up, i.e. swap with previous item.
2092 Sub-items (items with larger indentation) are considered part of
2093 the item, so this really moves item trees."
2110 "Insert a new item at the current level.
2111 If cursor is before first character after bullet of the item, the
2112 new item will be created before the current one.
2114 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2116 Return t when things worked, nil when we are not in an item, or
2117 item is invisible."
2120 ;; If cursor isn't is a list or if list is invisible, return nil.
2128 ;; Timer list: delegate to `org-timer-item'.
2133 ;; If we're in a description list, ask for the new term.
2136 ;; Don't insert a checkbox if checkbox rule is applied
2137 ;; and it is a description item.
2141 org-list-automatic-rules)))))))
2148 t)))))
2151 "Fix indentation, bullets and checkboxes is the list at point."
2159 "Cycle through the different itemize/enumerate bullets.
2160 This cycle the entire list level through the sequence:
2162 `-' -> `+' -> `*' -> `1.' -> `1)'
2164 If WHICH is a valid string, use that as the new bullet. If WHICH
2165 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2166 `previous', cycle backwards."
2187 ;; Compute list of possible bullets, depending on context.
2190 ;; *-bullets are not allowed at column 0.
2193 ;; Description items cannot be numbered.
2216 ;; Use a short variation of `org-list-write-struct' as there's
2217 ;; no need to go through all the steps.
2225 "Toggle the checkbox in the current line.
2226 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2227 double prefix, set checkbox to [-].
2229 When there is an active region, toggle status or presence of the
2230 first checkbox there, and make every item inside have the same
2231 status or presence, respectively.
2233 If the cursor is in a headline, apply this to all checkbox items
2234 in the text below the heading, taking as reference the first item
2235 in subtree, ignoring drawers."
2239 block-item
2240 lim-up
2241 lim-down
2252 ;; In a region, start at first item in region.
2262 ;; On an heading, start at first item after drawers and
2263 ;; time-stamps (scheduled, etc.).
2274 ;; Just one item: set SINGLEP flag.
2280 ;; Determine the checkbox going to be applied to all items
2281 ;; within bounds.
2292 ;; When an item is found within bounds, grab the full list at
2293 ;; point structure, then: (1) set check-box of all its items
2294 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2295 ;; whole list, (3) move point after the list.
2309 e struct
2310 ;; If there is no box at item, leave as-is
2311 ;; unless function was called with C-u prefix.
2314 ref-checkbox
2315 cur-box))))
2316 items-to-toggle)
2318 struct parents prevs orderedp))
2319 ;; Report some problems due to ORDERED status of subtree.
2320 ;; If only one box was being checked, throw an error, else,
2321 ;; only signal problems.
2325 "Checkbox blocked because of unchecked box at line %d"
2329 "Checkboxes were removed due to unchecked box at line %d"
2338 "Reset all checkboxes in an entry subtree."
2355 "Update the checkbox statistics in the current section.
2356 This will find all statistic cookies like [57%] and [6/12] and
2357 update them with the current numbers.
2359 With optional prefix argument ALL, do this for the whole buffer."
2363 (box-re "^[ \t]*\\([-+*]\\|\\([0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2375 ;; Return number of checked boxes and boxes of all types
2376 ;; in all structures in STRUCTS. If RECURSIVEP is
2377 ;; non-nil, also count boxes in sub-lists. If ITEM is
2378 ;; nil, count across the whole structure, else count only
2379 ;; across subtree whose ancestor is ITEM.
2396 items))))
2399 structs)
2402 cookies-list structs-bak box-num)
2404 ;; 1. Build an alist for each cookie found within BOUNDS. The
2405 ;; key will be position at beginning of cookie and values
2406 ;; ending position, format of cookie, and a cell whose car is
2407 ;; number of checked boxes to report, and cdr total number of
2408 ;; boxes.
2418 ;; Cookie is at an heading, but specifically for todo,
2419 ;; not for checkboxes: skip it.
2425 ;; Cookie is at an heading, but all lists before next
2426 ;; heading already have been read. Use data collected
2427 ;; in STRUCTS-BAK. This should only happen when
2428 ;; heading has more than one cookie on it.
2431 backup-end))
2433 ;; Cookie is at a fresh heading. Grab structure of
2434 ;; every list containing a checkbox between point and
2435 ;; next headline, and save them in STRUCTS-BAK.
2439 structs-bak nil)
2446 ;; Cookie is at an item, and we already have list
2447 ;; structure stored in STRUCTS-BAK.
2450 ;; Only lists in no special context are stored.
2453 ;; Cookie is at an item, but we need to compute list
2454 ;; structure.
2460 ;; Else, cookie found is at a wrong place. Skip it.
2462 cookies-list))))
2463 ;; 2. Apply alist to buffer, in reverse order so positions stay
2464 ;; unchanged after cookie modifications.
2479 cookies-list))))
2482 "Select the face for checkbox statistics.
2483 The face will be `org-done' when all relevant boxes are checked.
2484 Otherwise it will be `org-todo'."
2487 'org-checkbox-statistics-done
2491 'org-checkbox-statistics-done
2495 "Update checkbox statistics unless turned off by user."
2503 "Indent a local list item including its children.
2504 When number ARG is a negative, item will be outdented, otherwise
2505 it will be indented.
2507 If a region is active, all items inside will be moved.
2509 If NO-SUBTREE is non-nil, only indent the item itself, not its
2510 children.
2512 STRUCT is the list structure.
2514 Return t if successful."
2523 ;; Are we going to move the whole list?
2530 t))))
2531 ;; Determine begin and end points of zone to indent. If moving
2532 ;; more than one item, save them for subsequent moves.
2548 ;; Special case: moving top-item with indent rule.
2556 ;; Change bullet if necessary.
2562 ;; Shift every item by OFFSET and fix bullets. Then
2563 ;; apply changes to buffer.
2567 struct)
2570 ;; Forbidden move:
2572 ;; If only one item is moved, it mustn't have a child.
2576 ;; If a subtree or region is moved, the last item
2577 ;; of the subtree mustn't have a child.
2582 struct)))))
2585 ;; Normal shifting
2593 t)
2596 "Outdent a local list item, but not its children.
2597 If a region is active, all items inside will be moved."
2605 "Indent a local list item, but not its children.
2606 If a region is active, all items inside will be moved."
2614 "Outdent a local list item including its children.
2615 If a region is active, all items inside will be moved."
2629 "Indent a local list item including its children.
2630 If a region is active, all items inside will be moved."
2645 "Cycle levels of indentation of an empty item.
2646 The first run indents the item, if applicable. Subsequents runs
2647 outdent it at meaningful levels in the list. When done, item is
2648 put back at its original position with its original bullet.
2650 Return t at each successful move."
2656 ;; Accept empty items or if cycle has already started.
2667 ;; When in the middle of the cycle, try to outdent first. If
2668 ;; it fails, and point is still at initial position, indent.
2669 ;; Else, re-create it at its original position.
2678 ;; Break cycle
2680 ;; If a cycle is starting, remember indentation and bullet,
2681 ;; then try to indent. If it fails, try to outdent.
2687 t))))
2690 "Sort list items.
2691 The cursor may be at any item of the list that should be sorted.
2692 Sublists are not sorted. Checkboxes, if any, are ignored.
2694 Sorting can be alphabetically, numerically, by date/time as given
2695 by a time stamp, by a property or by priority.
2697 Comparing entries ignores case by default. However, with an
2698 optional argument WITH-CASE, the sorting considers case as well.
2700 The command prompts for the sorting type unless it has been given
2701 to the function through the SORTING-TYPE argument, which needs to
2702 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
2703 meaning of each character:
2705 n Numerically, by converting the beginning of the item to a number.
2706 a Alphabetically. Only the first line of item is checked.
2707 t By date/time, either the first active time stamp in the entry, if
2708 any, or by the first inactive one. In a timer list, sort the timers.
2710 Capital letters will reverse the sort order.
2712 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2713 a function to be called with point at the beginning of the
2714 record. It must return either a string or a number that should
2715 serve as the sorting key for that record. It will then use
2716 COMPARE-FUNC to compare entries."
2761 ;; If it is a timer list, convert timer to seconds
2774 value))
2778 next-record
2779 end-record
2780 value-to-sort
2781 nil
2782 sort-func)
2783 ;; Read and fix list again, as `sort-subr' probably destroyed
2784 ;; its structure.
2790 ;;; Send and receive lists
2793 "Parse the list at point and maybe DELETE it.
2795 Return a list whose car is a symbol of list type, among
2796 `ordered', `unordered' and `descriptive'. Then, each item is
2797 a list whose car is counter, and cdr are strings and other
2798 sub-lists. Inside strings, check-boxes are replaced by
2801 For example, the following list:
2803 1. first item
2804 + sub-item one
2805 + [X] sub-item two
2806 more text in first item
2807 2. [@3] last item
2809 will be parsed as:
2811 \(ordered
2813 \(unordered
2819 Point is left at list end."
2825 out
2826 parse-item ; for byte-compiler
2829 ;; Return text between BEG and END, trimmed, with
2830 ;; checkboxes replaced.
2841 text)))))
2844 ;; Return a list whose car is list type and cdr a list of
2845 ;; items' body.
2851 ;; Return a list containing counter of item, if any, text
2852 ;; and any sublist inside it.
2858 ;; Get counter number. For alphabetic counter, get
2859 ;; its position in the alphabet.
2870 ;; If item has a child, store text between bullet and
2871 ;; next child, then recursively parse all sublists. At
2872 ;; the end of each sublist, check for the presence of
2873 ;; text belonging to the original item.
2883 ;; Remove children from the list just parsed.
2885 ;; There is a chunk of text belonging to the
2886 ;; item if last child doesn't end where next
2887 ;; child starts or where item ends.
2891 body))))
2894 ;; Store output, take care of cursor position and deletion of
2895 ;; list, then return output.
2904 out))
2907 "Convert the plain list at point into a subtree."
2915 "Insert a radio list template appropriate for this major mode."
2919 name pos)
2930 "Send a transformed version of this list to the receiver position.
2931 With argument MAYBE, fail quietly if no transformation is defined
2932 for this list."
2938 (unless (looking-at "[ \t]*#\\+ORGLST[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
2957 beg txt)
2961 ;; Find the insertion place
2966 name
2980 "Convert a LIST parsed through `org-list-parse-list' to other formats.
2981 Valid parameters PARAMS are:
2983 :ustart String to start an unordered list
2984 :uend String to end an unordered list
2986 :ostart String to start an ordered list
2987 :oend String to end an ordered list
2989 :dstart String to start a descriptive list
2990 :dend String to end a descriptive list
2991 :dtstart String to start a descriptive term
2992 :dtend String to end a descriptive term
2993 :ddstart String to start a description
2994 :ddend String to end a description
2996 :splice When set to t, return only list body lines, don't wrap
2997 them into :[u/o]start and :[u/o]end. Default is nil.
2999 :istart String to start a list item.
3000 :icount String to start an item with a counter.
3001 :iend String to end a list item
3002 :isep String to separate items
3003 :lsep String to separate sublists
3004 :csep String to separate text from a sub-list
3006 :cboff String to insert for an unchecked check-box
3007 :cbon String to insert for a checked check-box
3008 :cbtrans String to insert for a check-box in transitional state
3010 Alternatively, each parameter can also be a form returning
3011 a string. These sexp can use keywords `counter' and `depth',
3012 reprensenting respectively counter associated to the current
3013 item, and depth of the current sub-list, starting at 0.
3014 Obviously, `counter' is only available for parameters applying to
3015 items."
3038 export-sublist ; for byte-compiler
3041 ;; Export an item ITEM of type TYPE, at DEPTH. First
3042 ;; string in item is treated in a special way as it can
3043 ;; bring extra information that needs to be processed.
3049 ;; Stick DTSTART to ISTART by
3050 ;; left-trimming the latter.
3054 istart))
3061 ;; Replace checkbox if any is found.
3069 ;; Insert descriptive term if TYPE is `descriptive'.
3078 first)))
3089 ;; Export sublist SUB at DEPTH.
3107 "Convert LIST into a LaTeX list.
3108 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3109 with overruling parameters for `org-list-to-generic'."
3111 list
3120 ;; LaTeX increments counter just before
3121 ;; using it, so set it to the desired
3122 ;; value, minus one.
3129 params)))
3132 "Convert LIST into a HTML list.
3133 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3134 with overruling parameters for `org-list-to-generic'."
3136 list
3148 params)))
3151 "Convert LIST into a Texinfo list.
3152 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3153 with overruling parameters for `org-list-to-generic'."
3155 list
3166 params)))
3169 "Convert LIST into an Org subtree.
3170 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3171 with overruling parameters for `org-list-to-generic'."
3181 ;; Return the string for the heading, depending on depth D
3182 ;; of current sub-list.
3187 oddeven-level)
3188 ?*)
3191 list
3193 '(:splice t
3200 params))))
3204 ;; arch-tag: 73cf50c1-200f-4d1d-8a53-4e842a5b11c8
3205 ;;; org-list.el ends here