| blob | 91467ce00f0a56fd29294d925857c189e56db51c |
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.4
11 ;;
12 ;; This file is part of GNU Emacs.
13 ;;
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
27 ;;
28 ;;; Commentary:
30 ;; This file contains the code dealing with plain lists in Org-mode.
32 ;; The fundamental idea behind lists work is to use structures. A
33 ;; structure is a snapshot of the list, in the shape of data tree (see
34 ;; `org-list-struct').
36 ;; Once the list structure is stored, it is possible to make changes
37 ;; directly on it or get useful information on the list, with helper
38 ;; functions `org-list-struct-parent-alist' and
39 ;; `org-list-struct-prev-alist', and using accessors provided in the
40 ;; file.
42 ;; Structure is repaired with `org-list-struct-fix-struct'. Then
43 ;; changes are applied to buffer with `org-list-struct-apply-struct'.
45 ;; So any function working on plain lists should follow this template:
46 ;; 1. Verify point is in a list and grab item beginning (with the same
47 ;; function `org-in-item-p') ;
48 ;; 2. Get list structure ;
49 ;; 3. Compute one, or both, helper functions depending on required
50 ;; accessors ;
51 ;; 4. Proceed with the modifications ;
52 ;; 5. Then fix the structure one last time and apply it on buffer.
54 ;; It is usally a bad idea to use directly an interactive function
55 ;; inside a function, as those read the whole list structure another
56 ;; time.
58 ;;; Code:
101 "Options concerning plain lists in Org-mode."
106 "When t, make TAB cycle visibility on plain list items.
107 Cycling plain lists works only when the cursor is on a plain list
108 item. When the cursor is on an outline heading, plain lists are
109 treated as text. This is the most stable way of handling this,
110 which is why it is the default.
112 When this is the symbol `integrate', then during cycling, plain
113 list items will *temporarily* be interpreted as outline headlines
114 with a level given by 1000+i where i is the indentation of the
115 bullet. This setting can lead to strange effects when switching
117 subtree decides what children should be listed. If that first
119 number, all true children and grand children of the outline
120 heading will be exposed in a children' view."
128 "Default bullet type installed when demoting an item.
129 This is an association list, for each bullet type, this alist will point
130 to the bullet that should be used when this item is demoted.
131 For example,
133 (setq org-list-demote-modify-bullet
136 will make
138 + Movies
139 + Silence of the Lambs
140 + My Cousin Vinny
141 + Books
142 + The Hunt for Red October
143 + The Road to Omaha
145 into
147 + Movies
148 - Silence of the Lambs
149 - My Cousin Vinny
150 + Books
151 - The Hunt for Red October
152 - The Road to Omaha"
170 "The character that makes a line with leading number an ordered list item.
171 Valid values are ?. and ?\). To get both terminators, use t. While
172 ?. may look nicer, it creates the danger that a line with leading
173 number may be incorrectly interpreted as an item. ?\) therefore is
174 the safe choice."
181 "Non-nil means single character alphabetical bullets are allowed.
182 Both uppercase and lowercase are handled. Lists with more than 26
183 items will fallback to standard numbering."
188 "A regular expression matching bullets that should have 2 spaces after them.
189 When nil, no bullet will have two spaces after them.
190 When a string, it will be used as a regular expression. When the
191 bullet type of a list is changed, the new bullet type will be
192 matched against this regexp. If it matches, there will be two
193 spaces instead of one after the bullet in each item of the list."
200 "Determine where plain lists should end.
201 Valid values are: `regexp', `indent' or `both'.
203 When set to `regexp', Org will look into two variables,
204 `org-empty-line-terminates-plain-lists' and the more general
205 `org-list-end-regexp', to determine what will end lists.
207 When set to `indent', a list will end whenever a line following
208 an item, but not starting one, is less or equally indented than
209 the first item of the list.
211 When set to `both', each of the preceding methods is applied to
212 determine lists endings. This is the default method."
220 "Non-nil means an empty line ends all plain list levels.
221 This variable only makes sense if `org-list-ending-method' is set
222 to `regexp' or `both'. This is then equivalent to set
228 "Regexp matching the end of all plain list levels.
230 blank lines. `org-empty-line-terminates-plain-lists' has
231 precedence over it."
238 "Non-nil means apply set of rules when acting on lists.
239 By default, automatic actions are taken when using
244 rules by setting them to nil. Valid rules are:
246 bullet when non-nil, cycling bullet do not allow lists at
247 column 0 to have * as a bullet and descriptions lists
248 to be numbered.
249 checkbox when non-nil, checkbox statistics is updated each time
250 you either insert a new checkbox or toggle a checkbox.
251 It also prevents from inserting a checkbox in a
252 description item.
253 indent when non-nil, indenting or outdenting list top-item
254 with its subtree will move the whole list and
255 outdenting a list whose bullet is * to column 0 will
259 :key-type
265 :value-type
269 "Non-nil means checkbox statistics counts only the state of direct children.
270 When nil, all boxes below the cookie are counted.
271 This can be set to nil on a per-node basis using a COOKIE_DATA property
277 "Maximum indentation for the second line of a description list.
278 When the indentation would be larger than this, it will become
279 5 characters instead."
285 % END RECEIVE ORGLST %n
287 #+ORGLST: SEND %n org-list-to-latex
288 -
291 @c END RECEIVE ORGLST %n
292 @ignore
293 #+ORGLST: SEND %n org-list-to-texinfo
294 -
297 <!-- END RECEIVE ORGLST %n -->
298 <!--
299 #+ORGLST: SEND %n org-list-to-html
300 -
302 "Templates for radio lists in different major modes.
303 All occurrences of %n in a template will be replaced with the name of the
304 list, obtained by prompting the user."
311 "Names of blocks where lists are not allowed.
315 "Context types where lists will be interpreted during export.
317 Valid types are `drawer', `inlinetask' and `block'. More
318 specifically, type `block' is determined by the variable
321 ;;; Internal functions
325 org-list-end-regexp)
326 "Regex corresponding to the end of a list.
330 "Return the correct regular expression for plain lists."
341 "Regexp matching the beginning of a plain list item."
349 "Matches a list item and puts everything into groups:
350 group 1: bullet
351 group 2: counter
352 group 3: checkbox
356 "Determine context, and its boundaries, around point.
358 Context will be an alist like (MIN MAX CONTEXT) where MIN and MAX
359 are boundaries and CONTEXT is a symbol among `drawer', `block',
360 `invalid', `inlinetask' and nil.
362 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
367 ;; Can't use org-drawers-regexp as this function might be
368 ;; called in buffers not in Org mode
373 ;; Compute position of surrounding headings. This is the
374 ;; default context.
383 nil)))
386 ;; Is point inside a drawer?
401 next-head)
403 ;; Is point strictly in a block, and of which type?
420 next-head))
422 org-list-forbidden-blocks)
423 'invalid
425 ;; Is point in an inlinetask?
439 ;; List actual candidates
442 ;; Return the closest context around
446 "Search a string in valid contexts for lists.
447 Arguments SEARCH, RE, BOUND and NOERR are similar to those in
448 `re-search-forward'."
452 ;; 1. No match: return to origin or bound, depending on NOERR.
455 nil)))
456 ;; 2. Match in an `invalid' context: continue searching. Else,
457 ;; return point.
461 "Like `re-search-backward' but stop only where lists are recognized.
462 Arguments REGEXP, BOUND and NOERROR are similar to those used in
463 `re-search-backward'."
468 "Like `re-search-forward' but stop only where lists are recognized.
469 Arguments REGEXP, BOUND and NOERROR are similar to those used in
470 `re-search-forward'."
475 "Is point at a list item with REGEXP after bullet?"
479 ;; Ignore counter if any
485 "Return number of blank lines that should separate items in list.
486 POS is the position at item beginning to be considered. STRUCT is
487 the list structure. PREVS is the alist of previous items. See
488 `org-list-struct-prev-alist'.
490 Assume point is at item's beginning. If the item is alone, apply
491 some heuristics to guess the result."
495 usr-blank)
497 ;; Trivial cases where there should be none.
499 org-empty-line-terminates-plain-lists)
501 ;; When `org-blank-before-new-entry' says so, it is 1.
503 ;; plain-list-item is 'auto. Count blank lines separating
504 ;; neighbours items in list.
507 ;; Is there a next item?
510 ;; Is there a previous item?
513 ;; User inserted blank lines, trust him
519 usr-blank)
520 ;; Are there blank lines inside the item ?
525 ;; No parent: no blank line.
529 "Insert a new list item at POS.
530 If POS is before first character after bullet of the item, the
531 new item will be created before the current one.
533 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
534 after the bullet. Cursor will be after this text once the
535 function ends."
537 ;; 1. Get information about list: structure, usual helper
538 ;; functions, position of point with regards to item start
539 ;; (BEFOREP), blank lines number separating items (BLANK-NB),
540 ;; position of split (POS) if we're allowed to (SPLIT-LINE-P).
551 item struct prevs))
552 ;; 2. Build the new item to be created. Concatenate same
553 ;; bullet as item, checkbox, text AFTER-BULLET if
554 ;; provided, and text cut from point to end of item
555 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
556 ;; BEFOREP and SPLIT-LINE-P. The difference of size
557 ;; between what was cut and what was inserted in buffer
558 ;; is stored in SIZE-OFFSET.
573 text-cut))
578 ;; 4. Insert effectively item into buffer
583 ;; 5. Add new item to STRUCT.
588 ;; Before inserted item, positions don't change but
589 ;; an item ending after insertion has its end shifted
590 ;; by SIZE-OFFSET.
593 ;; Trivial cases where current item isn't split in
594 ;; two. Just shift every item after new one by
595 ;; ITEM-SIZE.
599 ;; Item is split in two: elements before POS are just
600 ;; shifted by ITEM-SIZE. In the case item would end
601 ;; after split POS, ending is only shifted by
602 ;; SIZE-OFFSET.
608 ;; Elements after POS are moved into new item. Length
609 ;; of ITEM-SEP has to be removed as ITEM-SEP
610 ;; doesn't appear in buffer yet.
616 (+ end size-offset
618 ;; Elements at ITEM-END or after are only shifted by
619 ;; SIZE-OFFSET.
622 struct)
625 struct)
627 ;; 6. If not BEFOREP, new item must appear after ITEM, so
628 ;; exchange ITEM with the next item in list. Position cursor
629 ;; after bullet, counter, checkbox, and label.
639 t)))
645 "Indent a local list item including its children.
646 When number ARG is a negative, item will be outdented, otherwise
647 it will be indented.
649 If a region is active, all items inside will be moved.
651 If NO-SUBTREE is non-nil, only indent the item itself, not its
652 children.
654 STRUCT is the list structure. Return t if successful."
663 ;; Are we going to move the whole list?
670 t))))
671 ;; Determine begin and end points of zone to indent. If moving
672 ;; more than one item, save them for subsequent moves.
688 ;; Special case: moving top-item with indent rule
696 ;; Change bullet if necessary
702 ;; Shift every item by OFFSET and fix bullets. Then
703 ;; apply changes to buffer.
707 struct)
710 ;; Forbidden move:
712 ;; If only one item is moved, it mustn't have a child
716 ;; If a subtree or region is moved, the last item
717 ;; of the subtree mustn't have a child
722 struct)))))
725 ;; Normal shifting
733 t)
735 ;;; Predicates
738 "Return item beginning position when in a plain list, nil otherwise.
739 This checks `org-list-ending-method'."
753 10000
764 ;; Skip blocks, drawers, inline-tasks, blank lines
786 "Is point in a line starting a hand-formatted item?"
790 "Is point at the bullet of a plain list item?"
796 "Is point at a line starting a plain list item with a timer?"
801 "Is point at a description list item?"
805 "Is point at a line starting a plain-list item with a checklet?"
809 "Is point at a line starting a plain-list item with a counter?"
814 ;;; Navigate
819 "Go to the beginning of the current hand-formatted item.
820 If the cursor is not in an item, throw an error."
826 "Go to the beginning item of the current list or sublist.
827 Return an error if not in a list."
838 "Go to the end of the current list or sublist.
839 If the cursor in not in an item, throw an error."
850 "Go to the end of the current hand-formatted item.
851 If the cursor is not in an item, throw an error."
861 "Move to the beginning of the previous item.
862 Item is at the same level in the current plain list. Error if not
863 in a plain list, or if this is the first item in the list."
875 "Move to the beginning of the next item.
876 Item is at the same level in the current plain list. Error if not
877 in a plain list, or if this is the last item in the list."
888 ;;; Manipulate
891 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
892 Blank lines at the end of items are left in place. Return the new
893 structure after the changes.
895 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
896 to the same sub-list.
898 This function modifies STRUCT."
911 ;; 1. Move effectively items in buffer.
915 ;; 2. Now modify struct. No need to re-read the list, the
916 ;; transformation is just a shift of positions. Some special
917 ;; attention is required for items ending at END-A and END-B
918 ;; as empty spaces are not moved there. In others words, item
919 ;; BEG-A will end with whitespaces that were at the end of
920 ;; BEG-B and the same applies to BEG-B.
942 struct)
946 "Move the plain list item at point down, i.e. swap with following item.
947 Subitems (items with larger indentation) are considered part of the item,
948 so this really moves item trees."
963 ;; Use a short variation of `org-list-struct-fix-struct' as
964 ;; there's no need to go through all the steps.
975 "Move the plain list item at point up, i.e. swap with previous item.
976 Subitems (items with larger indentation) are considered part of the item,
977 so this really moves item trees."
992 ;; Use a short variation of `org-list-struct-fix-struct' as
993 ;; there's no need to go through all the steps.
1003 "Insert a new item at the current level.
1004 If cursor is before first character after bullet of the item, the
1005 new item will be created before the current one.
1007 If CHECKBOX is non-nil, add a checkbox next to the bullet.
1009 Return t when things worked, nil when we are not in an item, or
1010 item is invisible."
1019 ;; Timer list: delegate to `org-timer-item'.
1021 ;; if we're in a description list, ask for the new term.
1026 ;; Don't insert a checkbox if checkbox rule is applied and it
1027 ;; is a description item.
1032 desc-text))))))
1035 ;;; Structures
1038 "Return structure of list at point.
1040 A list structure is an alist where keys is point at item, and
1041 values are:
1042 1. indentation,
1043 2. bullet with trailing whitespace,
1044 3. bullet counter, if any,
1045 4. checkbox, if any,
1046 5. position at item end,
1047 6. description tag, if any.
1049 Thus the following list, where numbers in parens are
1050 point-at-bol:
1052 - [X] first item (1)
1053 1. sub-item 1 (18)
1054 5. [@5] sub-item 2 (34)
1055 some other text belonging to first item (55)
1056 - last item (97)
1057 + tag :: description (109)
1058 (131)
1060 will get the following structure:
1068 Assume point is at an item."
1082 ind itm-lst itm-lst-2 end-lst end-lst-2 struct
1084 ;; Return an association whose key is point and values are
1085 ;; indentation, bullet string, bullet counter, and
1086 ;; checkbox.
1091 ind
1097 ;; Ensure list ends at the first blank line.
1102 ;; 1. Read list from starting item to its beginning, and save
1103 ;; top item position and indentation in BEG-CELL. Also store
1104 ;; ending position of items in END-LST.
1112 ;; At upward limit: if we ended at an item, store it,
1113 ;; else dimiss useless data recorded above BEG-CELL.
1114 ;; Jump to part 2.
1123 ;; Looking at a list ending regexp. Dismiss useless
1124 ;; data recorded above BEG-CELL. Jump to part 2.
1128 ;; Skip blocks, drawers, inline tasks, blank lines
1129 ;; along the way.
1141 ;; Point is at an item. Add data to ITM-LST. It may
1142 ;; also end a previous item: save it in END-LST. If
1143 ;; ind is less or equal than BEG-CELL and there is no
1144 ;; end at this ind or lesser, this item becomes the
1145 ;; new BEG-CELL.
1154 ;; Point is not at an item. Unless ending method is
1155 ;; `regexp', interpret line's indentation:
1156 ;;
1157 ;; - text at column 0 is necessarily out of any list.
1158 ;; Dismiss data recorded above BEG-CELL. Jump to
1159 ;; part 2.
1160 ;;
1161 ;; - any other case, it can possibly be an ending
1162 ;; position for an item above. Save it and proceed.
1173 ;; 2. Read list from starting point to its end, that is until we
1174 ;; get out of context, or a non-item line is less or equally
1175 ;; indented that BEG-CELL's cdr. Also store ending position
1176 ;; of items in END-LST-2.
1183 ;; At downward limit: this is de facto the end of the
1184 ;; list. Save point as an ending position, and jump to
1185 ;; part 3.
1190 ;; Looking at a list ending regexp. Save point as an
1191 ;; ending position and jump to part 3.
1193 ;; Skip blocks, drawers, inline tasks and blank lines
1194 ;; along the way
1206 ;; Point is at an item. Add data to ITM-LST-2. It may also
1207 ;; end a previous item, so save it in END-LST-2.
1212 ;; Point is not at an item. If ending method is not
1213 ;; `regexp', two situations are of interest:
1214 ;;
1215 ;; - ind is lesser or equal than BEG-CELL's. The list is
1216 ;; over. Store point as an ending position and jump to
1217 ;; part 3.
1218 ;;
1219 ;; - ind is lesser or equal than previous item's. This
1220 ;; is an ending position. Store it and proceed.
1231 ;; 3. Correct ill-formed lists by making sure top item has the
1232 ;; least indentation of the list
1237 struct))
1238 ;; 4. Associate each item to its end pos.
1240 ;; 5. Return STRUCT
1241 struct)))
1244 "Associate proper ending point to items in STRUCT.
1246 END-LIST is a pseudo-alist where car is indentation and cdr is
1247 ending position.
1249 This function modifies STRUCT."
1255 ;; Remove end candidates behind current item
1258 ;; Add end position to item assoc
1264 struct)))
1267 "Return alist between item and previous item in STRUCT."
1269 struct)))
1273 struct)))
1276 "Return alist between item and parent in STRUCT."
1298 "Return parent of ITEM in STRUCT, or nil.
1299 PARENTS is the alist of items' parent. See
1300 `org-list-struct-parent-alist'."
1305 "Return a non-nil value if ITEM in STRUCT has a child.
1306 Value returned is the position of the first child of ITEM."
1311 child-maybe)))
1314 "Return next item in same sub-list as ITEM in STRUCT, or nil.
1315 PREVS is the alist of previous items. See
1316 `org-list-struct-prev-alist'."
1320 "Return previous item in same sub-list as ITEM in STRUCT, or nil.
1321 PREVS is the alist of previous items. See
1322 `org-list-struct-prev-alist'."
1326 "Return all items with ITEM as a common ancestor or nil.
1327 STRUCT is the list structure considered."
1330 subtree)
1335 sub-struct))
1339 "List of items in the same sub-list as ITEM in STRUCT.
1340 PREVS is the alist of previous items. See
1341 `org-list-struct-prev-alist'."
1344 before-item after-item)
1352 "List all children of ITEM in STRUCT, or nil.
1353 PARENTS is the alist of items' parent. See
1354 `org-list-struct-parent-alist'."
1362 "Return point at beginning of list.
1363 STRUCT is the structure of the list."
1367 "Return point at bottom of list.
1368 STRUCT is the structure of the list."
1373 "Return point at beginning of sub-list ITEM belongs.
1374 STRUCT is the structure of the list. PREVS is the alist of
1375 previous items. See `org-list-struct-prev-alist'."
1379 first-item))
1384 "Return point at last item of sub-list ITEM belongs.
1385 STRUCT is the structure of the list. PREVS is the alist of
1386 previous items. See `org-list-struct-prev-alist'."
1390 last-item))
1393 "Return point at end of sub-list ITEM belongs.
1394 STRUCT is the structure of the list. PREVS is the alist of
1395 previous items. See `org-list-struct-prev-alist'."
1399 "Return the type of the list containing ITEM as a symbol.
1401 STRUCT is the structure of the list, as returned by
1402 `org-list-struct'. PREVS is the alist of previous items. See
1403 `org-list-struct-prev-alist'.
1405 Possible types are `descriptive', `ordered' and `unordered'. The
1406 type is determined by the first item of the list."
1414 "Return the Nth value of KEY in STRUCT."
1418 "Set the Nth value of KEY in STRUCT to NEW.
1423 "Return indentation of ITEM in STRUCT."
1427 "Set indentation of ITEM in STRUCT to IND.
1432 "Return bullet of ITEM in STRUCT."
1436 "Set bullet of ITEM in STRUCT to BULLET.
1441 "Return counter of ITEM in STRUCT."
1445 "Return checkbox of ITEM in STRUCT or nil."
1449 "Set checkbox of ITEM in STRUCT to CHECKBOX.
1454 "Return end position of ITEM in STRUCT."
1458 "Return end position of ITEM in STRUCT."
1462 "Return point at end of ITEM in STRUCT, before any blank line.
1463 Point returned is at end of line."
1470 "Verify and correct bullets for every association in STRUCT.
1471 PREVS is the alist of previous items. See
1472 `org-list-struct-prev-alist'.
1474 This function modifies STRUCT."
1478 ;; Set bullet of ITEM in STRUCT, depending on the type of
1479 ;; first item of the list, the previous bullet and counter
1480 ;; if any.
1489 item struct
1492 ;; Alpha counter in alpha list: use counter.
1496 ;; Use cond to be sure `string-match' is used in
1497 ;; both cases.
1503 ;; Num counter in a num list: use counter.
1508 ;; No counter: increase, if needed, previous bullet.
1511 ;; Alpha counter at first item: use counter.
1520 ;; Num counter at first item: use counter.
1525 ;; First bullet is alpha uppercase: use "A".
1528 ;; First bullet is alpha lowercase: use "a".
1531 ;; First bullet is num: use "1".
1534 ;; Not an ordered list: keep bullet.
1539 "Verify and correct indentation for every association in STRUCT.
1541 PARENTS is the alist of items' parents. See
1542 `org-list-struct-parent-alist'.
1544 If numeric optional argument BULLET-SIZE is set, assume all
1545 bullets in list have this length to determine new indentation.
1547 This function modifies STRUCT."
1554 ;; Indent like parent + length of parent's bullet
1560 ;; If no parent, indent like top-point
1565 "Verify and correct checkboxes for every association in STRUCT.
1567 PARENTS is the alist of items' parents. See
1568 `org-list-struct-parent-alist'. PREVS is the alist of previous
1569 items. See `org-list-struct-prev-alist.
1571 If ORDERED is non-nil, a checkbox can only be checked when every
1572 checkbox before it is checked too. If there was an attempt to
1573 break this rule, the function will return the blocking item. In
1574 all others cases, the return value will be nil.
1576 This function modifies STRUCT."
1586 item struct
1592 ;; parent has no boxed child: leave box as-is
1594 parent-list)
1595 ;; 1. List all parents with a checkbox
1602 all-items)
1603 ;; 2. Sort those parents by decreasing indentation
1608 ;; 3. For each parent, get all children's checkboxes to determine
1609 ;; and set its checkbox accordingly
1611 ;; 4. If ORDERED is set, see if we need to uncheck some boxes
1616 ;; there are boxes checked after an unchecked one: fix that
1621 ;; Verify once again the structure, without ORDERED
1623 ;; return blocking item
1627 "Return STRUCT with correct bullets and indentation.
1628 PARENTS is the alist of items' parents. See
1629 `org-list-struct-parent-alist'."
1630 ;; Order of functions matters here: checkboxes and endings need
1631 ;; correct indentation to be set, and indentation needs correct
1632 ;; bullets.
1633 ;;
1634 ;; 0. Save a copy of structure before modifications
1636 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1637 ;; order to get items endings and bullets properly
1639 ;; 2. Get pseudo-alist of ending positions and sort it by position.
1640 ;; Then associate them to the structure.
1647 ;; to determine real ind of an ending position that is
1648 ;; not at an item, we have to find the item it belongs
1649 ;; to: it is the last item (ITEM-UP), whose ending is
1650 ;; further than the position we're interested in.
1653 ;; else part is for the bottom point
1655 end-pos)
1656 end-list)))
1659 struct)
1662 ;; 3. Get bullets right
1665 ;; 4. Now get real indentation
1667 ;; 5. Eventually fix checkboxes
1669 ;; 6. Apply structure modifications to buffer
1673 "Outdent items between START and END in structure STRUCT.
1675 PARENTS is the alist of items' parents. See
1676 `org-list-struct-parent-alist'.
1678 START is included, END excluded."
1684 ;; Item not yet in zone: keep association
1686 ;; Item out of zone: follow associations in acc
1690 ;; Item has no parent: error
1693 ;; Parent is outdented: keep association
1697 ;; Parent isn't outdented: reparent to grand-parent
1699 parent struct parents)))
1705 "Indent items between START and END in structure STRUCT.
1707 PARENTS is the alist of parents. See
1708 `org-list-struct-parent-alist'. PREVS is the alist of previous
1709 items. See `org-list-struct-prev-alist'.
1711 START is included and END excluded.
1713 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1714 bullets between START and END."
1728 ;; Item not yet in zone: keep association
1731 ;; Item out of zone: follow associations in acc
1735 ;; Item is in zone...
1737 ;; Check if bullet needs to be changed
1740 ;; First item indented but not parent: error
1743 ;; First item and parent indented: keep same parent
1745 ;; Previous item not indented: reparent to it
1747 ;; Previous item indented: reparent like it
1754 "Apply modifications to list so it mirrors STRUCT.
1756 OLD-STRUCT is the structure before any modifications. Thus, the
1757 function is smart enough to modify only parts of buffer which
1758 have changed.
1760 Initial position of cursor is restored after the changes."
1764 ;; Shift the indentation between END and BEG by DELTA.
1765 ;; Start from the line before END.
1778 ;; Replace item first line elements with new elements from
1779 ;; STRUCT, if appropriate.
1789 ;; a. Replace bullet
1792 ;; b. Replace checkbox
1807 ;; c. Indent item to appropriate column
1812 ;; 1. First get list of items and position endings. We maintain
1813 ;; two alists: ITM-SHIFT, determining indentation shift needed
1814 ;; at item, and END-POS, a pseudo-alist where key is ending
1815 ;; position and value point
1828 ;; To determine real ind of an ending position that is
1829 ;; not at an item, we have to find the item it belongs
1830 ;; to: it is the last item (ITEM-UP), whose ending is
1831 ;; further than the position we're interested in.
1835 old-struct)
1836 ;; 2. Slice the items into parts that should be shifted by the
1837 ;; same amount of indentation. The slices are returned in
1838 ;; reverse order so changes modifying buffer do not change
1839 ;; positions they refer to.
1842 '<))
1850 ;; 3. Modify each slice in buffer, from end to beginning, with a
1851 ;; special action when beginning is at item start.
1857 sliced-struct))
1858 ;; 4. Go back to initial position
1861 ;;; Indentation
1864 "Outdent a local list item, but not its children.
1865 If a region is active, all items inside will be moved."
1873 "Indent a local list item, but not its children.
1874 If a region is active, all items inside will be moved."
1882 "Outdent a local list item including its children.
1883 If a region is active, all items inside will be moved."
1897 "Indent a local list item including its children.
1898 If a region is active, all items inside will be moved."
1913 "Cycle levels of indentation of an empty item.
1914 The first run indents the item, if applicable. Subsequents runs
1915 outdent it at meaningful levels in the list. When done, item is
1916 put back at its original position with its original bullet.
1918 Return t at each successful move."
1923 ;; Check that item is really empty
1933 ;; When in the middle of the cycle, try to outdent first. If it
1934 ;; fails, and point is still at initial position, indent. Else,
1935 ;; go back to original position.
1946 ;; Break cycle
1948 ;; If a cycle is starting, remember indentation and bullet,
1949 ;; then try to indent. If it fails, try to outdent.
1955 t))))
1957 ;;; Bullets
1960 "Return the bullet of the item at point.
1961 Assume cursor is at an item."
1967 "Return BULLET with the correct number of whitespaces.
1968 It determines the number of whitespaces to append by looking at
1969 `org-list-two-spaces-after-bullet-regexp'."
1975 " "
1976 ;; Do we need to concat another white space ?
1983 "Can list starting at FIRST use alphabetical bullets?
1985 STRUCT is list structure. See `org-list-struct'. PREVS is the
1986 alist of previous items. See `org-list-struct-prev-alist'."
1990 ;; Pretend that bullets are uppercase and checked if
1991 ;; alphabet is sufficient, taking counters into account.
1995 ;; Virtually determine current bullet
1997 ;; Counters are not case-sensitive.
2000 ;; Test if bullet would be over z or Z.
2004 ;; All items checked. All good.
2005 t))))
2008 "Increment BULLET if applicable."
2011 ;; Num bullet: increment it.
2015 nil nil bullet))
2016 ;; Alpha bullet: increment it.
2020 nil nil bullet))
2021 ;; Unordered bullet: leave it.
2025 "Make sure all items are correctly indented, with the right bullet.
2026 This function scans the list at point, along with any sublist."
2034 "Cycle through the different itemize/enumerate bullets.
2035 This cycle the entire list level through the sequence:
2037 `-' -> `+' -> `*' -> `1.' -> `1)'
2039 If WHICH is a valid string, use that as the new bullet. If WHICH
2040 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2041 `previous', cycle backwards."
2062 ;; Compute list of possible bullets, depending on context
2065 ;; *-bullets are not allowed at column 0
2068 ;; Description items cannot be numbered
2091 ;; Use a short variation of `org-list-struct-fix-struct' as
2092 ;; there's no need to go through all the steps.
2099 ;;; Checkboxes
2102 "Toggle the checkbox in the current line.
2103 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2104 double prefix, set checkbox to [-].
2106 When there is an active region, toggle status or presence of the
2107 first checkbox there, and make every item inside have the
2108 same status or presence, respectively.
2110 If the cursor is in a headline, apply this to all checkbox items
2111 in the text below the heading, taking as reference the first item
2112 in subtree, ignoring drawers."
2116 block-item
2117 lim-up
2118 lim-down
2121 ;; In a region, start at first item in region
2131 ;; On an heading, start at first item after drawers
2140 ;; Just one item: set singlep flag
2146 ;; Determine the checkbox going to be applied to all items
2147 ;; within bounds
2158 ;; When an item is found within bounds, grab the full list at
2159 ;; point structure, then: 1. set checkbox of all its items
2160 ;; within bounds to ref-checkbox; 2. fix checkboxes of the whole
2161 ;; list; 3. move point after the list.
2175 e struct
2176 ;; if there is no box at item, leave as-is
2177 ;; unless function was called with C-u prefix
2180 ref-checkbox
2181 cur-box))))
2182 items-to-toggle)
2184 struct parents prevs orderedp))
2185 ;; Report some problems due to ORDERED status of subtree. If
2186 ;; only one box was being checked, throw an error, else,
2187 ;; only signal problems.
2191 "Checkbox blocked because of unchecked box at line %d"
2195 "Checkboxes were removed due to unchecked box at line %d"
2202 "Reset all checkboxes in an entry subtree."
2217 "Hook that is run whenever Org thinks checkbox statistics should be updated.
2218 This hook runs even if checkbox rule in
2219 `org-list-automatic-rules' does not apply, so it can be used to
2220 implement alternative ways of collecting statistics
2224 "Update checkbox statistics unless turned off by user."
2230 "Update the checkbox statistics in the current section.
2231 This will find all statistic cookies like [57%] and [6/12] and
2232 update them with the current numbers.
2234 With optional prefix argument ALL, do this for the whole buffer."
2238 (box-re "^[ \t]*\\([-+*]\\|\\([0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2252 ;; Return number of checked boxes and boxes of all types
2253 ;; in all structures in STRUCTS. If RECURSIVEP is non-nil,
2254 ;; also count boxes in sub-lists. If ITEM is nil, count
2255 ;; across the whole structure, else count only across
2256 ;; subtree whose ancestor is ITEM.
2273 items))))
2276 structs)
2279 cookies-list structs-bak box-num)
2281 ;; 1. Build an alist for each cookie found within BOUNDS. The
2282 ;; key will be position at beginning of cookie and values
2283 ;; ending position, format of cookie, and a cell whose car is
2284 ;; number of checked boxes to report, and cdr total number of
2285 ;; boxes.
2295 ;; Cookie is at an heading, but specifically for todo,
2296 ;; not for checkboxes: skip it.
2302 ;; Cookie is at an heading, but all lists before next
2303 ;; heading already have been read. Use data collected
2304 ;; in STRUCTS-BAK. This should only happen when heading
2305 ;; has more than one cookie on it.
2308 backup-end))
2310 ;; Cookie is at a fresh heading. Grab structure of
2311 ;; every list containing a checkbox between point and
2312 ;; next headline, and save them in STRUCTS-BAK.
2322 ;; Cookie is at an item, and we already have list
2323 ;; structure stored in STRUCTS-BAK.
2327 ;; Cookie is at an item, but we need to compute list
2328 ;; structure.
2334 ;; Else, cookie found is at a wrong place. Skip it.
2336 cookies-list))))
2337 ;; 2. Apply alist to buffer, in reverse order so positions stay
2338 ;; unchanged after cookie modifications.
2352 cookies-list))))
2355 "Select the face for checkbox statistics.
2356 The face will be `org-done' when all relevant boxes are checked.
2357 Otherwise it will be `org-todo'."
2360 'org-checkbox-statistics-done
2364 'org-checkbox-statistics-done
2367 ;;; Misc Tools
2370 "Call FUNCTION on each item of the list at point.
2371 FUNCTION must be called with at least one argument: INIT-VALUE,
2372 that will contain the value returned by the function at the
2373 previous item, plus ARGS extra arguments.
2375 FUNCTION is applied on items in reverse order.
2377 As an example, (org-apply-on-list (lambda (result) (1+ result)) 0)
2378 will return the number of items in the current list.
2380 Sublists of the list are skipped. Cursor is always at the
2381 beginning of the item."
2392 value))
2395 "Sort plain list items.
2396 The cursor may be at any item of the list that should be sorted.
2397 Sublists are not sorted. Checkboxes, if any, are ignored.
2399 Sorting can be alphabetically, numerically, by date/time as given by
2400 a time stamp, by a property or by priority.
2402 Comparing entries ignores case by default. However, with an
2403 optional argument WITH-CASE, the sorting considers case as well.
2405 The command prompts for the sorting type unless it has been given
2406 to the function through the SORTING-TYPE argument, which needs to
2407 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
2408 meaning of each character:
2410 n Numerically, by converting the beginning of the item to a number.
2411 a Alphabetically. Only the first line of item is checked.
2412 t By date/time, either the first active time stamp in the entry, if
2413 any, or by the first inactive one. In a timer list, sort the timers.
2415 Capital letters will reverse the sort order.
2417 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a
2418 function to be called with point at the beginning of the record.
2419 It must return either a string or a number that should serve as
2420 the sorting key for that record. It will then use COMPARE-FUNC to
2421 compare entries."
2466 ;; If it is a timer list, convert timer to seconds
2479 value))
2483 next-record
2484 end-record
2485 value-to-sort
2486 nil
2487 sort-func)
2488 ;; Read and fix list again, as `sort-subr' probably destroyed
2489 ;; its structure.
2494 ;;; Send and receive lists
2496 "Parse the list at point and maybe DELETE it.
2498 Return a list whose car is a symbol of list type, among
2499 `ordered', `unordered' and `descriptive'. Then, each item is a
2500 list whose car is counter, and cdr are strings and other
2504 For example, the following list:
2506 1. first item
2507 + sub-item one
2508 + [X] sub-item two
2509 more text in first item
2510 2. [@3] last item
2512 will be parsed as:
2514 \(ordered
2516 \(unordered
2522 Point is left at list end."
2528 out
2531 ;; Return text between BEG and END, trimmed, with
2532 ;; checkboxes replaced.
2539 text)))))
2542 ;; Return a list whose car is list type and cdr a list of
2543 ;; items' body.
2549 ;; Return a list containing conter of item, if any, text
2550 ;; and any sublist inside it.
2556 ;; Get counter number. For alphabetic counter, get
2557 ;; its position in the alphabet.
2568 ;; If item has a child, store text between bullet and
2569 ;; next child, then recursively parse all sublists. At
2570 ;; the end of each sublist, check for the presence of
2571 ;; text belonging to the original item.
2581 ;; Remove children from the list just parsed.
2583 ;; There is a chunk of text belonging to the
2584 ;; item if last child doesn't end where next
2585 ;; child starts or where item ends.
2589 body))))
2592 ;; Store output, take care of cursor position and deletion of
2593 ;; list, then return output.
2601 out))
2604 "Convert the plain list at point into a subtree."
2617 "Convert LIST into subtrees starting at LEVEL."
2626 list)))
2629 "Insert a radio list template appropriate for this major mode."
2633 name pos)
2644 "Send a transformed version of this list to the receiver position.
2645 With argument MAYBE, fail quietly if no transformation is defined for
2646 this list."
2652 (unless (looking-at "[ \t]*#\\+ORGLST[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
2671 beg txt)
2675 ;; Find the insertion place
2680 name
2694 "Convert a LIST parsed through `org-list-parse-list' to other formats.
2695 Valid parameters PARAMS are
2697 :ustart String to start an unordered list
2698 :uend String to end an unordered list
2700 :ostart String to start an ordered list
2701 :oend String to end an ordered list
2703 :dstart String to start a descriptive list
2704 :dend String to end a descriptive list
2705 :dtstart String to start a descriptive term
2706 :dtend String to end a descriptive term
2707 :ddstart String to start a description
2708 :ddend String to end a description
2710 :splice When set to t, return only list body lines, don't wrap
2711 them into :[u/o]start and :[u/o]end. Default is nil.
2713 :istart String to start a list item.
2714 :icount String to start an item with a counter.
2715 :iend String to end a list item
2716 :isep String to separate items
2717 :lsep String to separate sublists
2719 :cboff String to insert for an unchecked checkbox
2720 :cbon String to insert for a checked checkbox
2722 Alternatively, each parameter can also be a form returning a
2723 string. These sexp can use keywords `counter' and `depth',
2724 reprensenting respectively counter associated to the current
2725 item, and depth of the current sub-list, starting at 0.
2726 Obviously, `counter' is only available for parameters applying to
2727 items."
2750 ;; Export an item ITEM of type TYPE, at DEPTH. First string
2751 ;; in item is treated in a special way as it can bring
2752 ;; extra information that needs to be processed.
2763 ;; Replace checkbox if any is found.
2771 ;; Insert descriptive term if TYPE is `descriptive'.
2775 'eval
2783 item isep))))))
2786 ;; Export sublist SUB at DEPTH
2799 items lsep)))))))
2803 "Convert LIST into a LaTeX list.
2804 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2805 with overruling parameters for `org-list-to-generic'."
2807 list
2818 enum counter)
2822 params)))
2825 "Convert LIST into a HTML list.
2826 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2827 with overruling parameters for `org-list-to-generic'."
2829 list
2840 params)))
2843 "Convert LIST into a Texinfo list.
2844 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2845 with overruling parameters for `org-list-to-generic'."
2847 list
2858 params)))
2862 ;; arch-tag: 73cf50c1-200f-4d1d-8a53-4e842a5b11c8
2863 ;;; org-list.el ends here