| blob | 4485a423f3497e13f5ce5fea6e05159252292bf9 |
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 "A regular expression matching bullets that should have 2 spaces after them.
182 When nil, no bullet will have two spaces after them.
183 When a string, it will be used as a regular expression. When the
184 bullet type of a list is changed, the new bullet type will be
185 matched against this regexp. If it matches, there will be two
186 spaces instead of one after the bullet in each item of the list."
193 "Determine where plain lists should end.
194 Valid values are: `regexp', `indent' or `both'.
196 When set to `regexp', Org will look into two variables,
197 `org-empty-line-terminates-plain-lists' and the more general
198 `org-list-end-regexp', to determine what will end lists.
200 When set to `indent', a list will end whenever a line following
201 an item, but not starting one, is less or equally indented than
202 the first item of the list.
204 When set to `both', each of the preceding methods is applied to
205 determine lists endings. This is the default method."
213 "Non-nil means an empty line ends all plain list levels.
214 This variable only makes sense if `org-list-ending-method' is set
215 to `regexp' or `both'. This is then equivalent to set
221 "Regexp matching the end of all plain list levels.
223 blank lines. `org-empty-line-terminates-plain-lists' has
224 precedence over it."
232 "Non-nil means apply set of rules when acting on lists.
233 By default, automatic actions are taken when using
238 rules by setting them to nil. Valid rules are:
240 bullet when non-nil, cycling bullet do not allow lists at
241 column 0 to have * as a bullet and descriptions lists
242 to be numbered.
243 checkbox when non-nil, checkbox statistics is updated each time
244 you either insert a new checkbox or toggle a checkbox.
245 It also prevents from inserting a checkbox in a
246 description item.
247 indent when non-nil, indenting or outdenting list top-item
248 with its subtree will move the whole list and
249 outdenting a list whose bullet is * to column 0 will
250 change that bullet to -
251 insert when non-nil, trying to insert an item inside a block
252 will insert it right before the block instead of
253 throwing an error."
256 :key-type
262 :value-type
266 "Non-nil means checkbox statistics counts only the state of direct children.
267 When nil, all boxes below the cookie are counted.
268 This can be set to nil on a per-node basis using a COOKIE_DATA property
274 "Maximum indentation for the second line of a description list.
275 When the indentation would be larger than this, it will become
276 5 characters instead."
282 % END RECEIVE ORGLST %n
284 #+ORGLST: SEND %n org-list-to-latex
285 -
288 @c END RECEIVE ORGLST %n
289 @ignore
290 #+ORGLST: SEND %n org-list-to-texinfo
291 -
294 <!-- END RECEIVE ORGLST %n -->
295 <!--
296 #+ORGLST: SEND %n org-list-to-html
297 -
299 "Templates for radio lists in different major modes.
300 All occurrences of %n in a template will be replaced with the name of the
301 list, obtained by prompting the user."
308 "Names of blocks where lists are not allowed.
312 "Context types where lists will be interpreted during export.
314 Valid types are `drawer', `inlinetask' and `block'. More
315 specifically, type `block' is determined by the variable
318 ;;; Internal functions
321 "Return the regex corresponding to the end of a list.
322 It depends on `org-empty-line-terminates-plain-lists'."
325 org-list-end-regexp))
328 "Return the correct regular expression for plain lists.
329 If GENERAL is non-nil, return the general regexp independent of the value
330 of `org-plain-list-ordered-item-terminator'."
348 "Matches a list item and puts everything into groups:
349 group 1: bullet
350 group 2: counter
351 group 3: checkbox
355 "Determine context, and its boundaries, around point.
357 Context will be an alist like (MIN MAX CONTEXT) where MIN and MAX
358 are boundaries and CONTEXT is a symbol among `drawer', `block',
359 `invalid', `inlinetask' and nil.
361 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
366 ;; can't use org-drawers-regexp as this function might be
367 ;; called in buffers not in Org mode
372 ;; compute position of surrounding headings. this is the
373 ;; default context.
382 nil)))
385 ;; Are we strictly inside a drawer?
400 next-head)
402 ;; Are we strictly in a block, and of which type?
419 next-head))
421 org-list-forbidden-blocks)
422 'invalid
424 ;; Are we in an inlinetask?
438 ;; list actual candidates
441 ;; Return the closest context around
445 "Search a string in valid contexts for lists.
446 Arguments SEARCH, RE, BOUND and NOERR are similar to those in
447 `re-search-forward'."
451 ;; 1. No match: return to origin or bound, depending on NOERR.
454 nil)))
455 ;; 2. Match in an `invalid' context: continue searching. Else,
456 ;; return point.
460 "Like `re-search-backward' but stop only where lists are recognized.
461 Arguments REGEXP, BOUND and NOERROR are similar to those used in
462 `re-search-backward'."
467 "Like `re-search-forward' but stop only where lists are recognized.
468 Arguments REGEXP, BOUND and NOERROR are similar to those used in
469 `re-search-forward'."
474 "Is point at a list item with REGEXP after bullet?"
478 ;; Ignore counter if any
484 "Return number of blank lines that should separate items in list.
485 POS is the position at item beginning to be considered. STRUCT is
486 the list structure. PREVS is the alist of previous items. See
487 `org-list-struct-prev-alist'.
489 Assume point is at item's beginning. If the item is alone, apply
490 some heuristics to guess the result."
494 usr-blank)
496 ;; Trivial cases where there should be none.
498 org-empty-line-terminates-plain-lists)
500 ;; When `org-blank-before-new-entry' says so, it is 1.
502 ;; plain-list-item is 'auto. Count blank lines separating
503 ;; neighbours items in list.
506 ;; Is there a next item?
509 ;; Is there a previous item?
512 ;; User inserted blank lines, trust him
518 usr-blank)
519 ;; Are there blank lines inside the item ?
524 ;; No parent: no blank line.
528 "Insert a new list item at POS.
529 If POS is before first character after bullet of the item, the
530 new item will be created before the current one.
532 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
533 after the bullet. Cursor will be after this text once the
534 function ends."
537 ;; 1. Check if a new item can be inserted at point: are we in an
538 ;; invalid block ? Move outside it if `org-list-automatic'
539 ;; rules says so.
546 org-drawer-regexp
557 org-drawer-regexp)))
560 ;; 2. Get information about list: structure, usual helper
561 ;; functions, position of point with regards to item start
562 ;; (BEFOREP), blank lines number separating items (BLANK-NB),
563 ;; position of split (POS) if we're allowed to (SPLIT-LINE-P).
574 item struct prevs))
575 ;; 3. Build the new item to be created. Concatenate same
576 ;; bullet as item, checkbox, text AFTER-BULLET if
577 ;; provided, and text cut from point to end of item
578 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
579 ;; BEFOREP and SPLIT-LINE-P. The difference of size
580 ;; between what was cut and what was inserted in buffer
581 ;; is stored in SIZE-OFFSET.
596 text-cut))
601 ;; 4. Insert effectively item into buffer
606 ;; 5. Add new item to STRUCT.
611 ;; Before inserted item, positions don't change but
612 ;; an item ending after insertion has its end shifted
613 ;; by SIZE-OFFSET.
616 ;; Trivial cases where current item isn't split in
617 ;; two. Just shift every item after new one by
618 ;; ITEM-SIZE.
622 ;; Item is split in two: elements before POS are just
623 ;; shifted by ITEM-SIZE. In the case item would end
624 ;; after split POS, ending is only shifted by
625 ;; SIZE-OFFSET.
631 ;; Elements after POS are moved into new item. Length
632 ;; of ITEM-SEP has to be removed as ITEM-SEP
633 ;; doesn't appear in buffer yet.
639 (+ end size-offset
641 ;; Elements at ITEM-END or after are only shifted by
642 ;; SIZE-OFFSET.
645 struct)
648 struct)
650 ;; 6. If not BEFOREP, new item must appear after ITEM, so
651 ;; exchange ITEM with the next item in list. Position cursor
652 ;; after bullet, counter, checkbox, and label.
662 t)))
668 "Indent a local list item including its children.
669 When number ARG is a negative, item will be outdented, otherwise
670 it will be indented.
672 If a region is active, all items inside will be moved.
674 If NO-SUBTREE is non-nil, only indent the item itself, not its
675 children.
677 STRUCT is the list structure. Return t if successful."
686 ;; Are we going to move the whole list?
693 t))))
694 ;; Determine begin and end points of zone to indent. If moving
695 ;; more than one item, save them for subsequent moves.
711 ;; Special case: moving top-item with indent rule
719 ;; Change bullet if necessary
725 ;; Shift every item by OFFSET and fix bullets. Then
726 ;; apply changes to buffer.
730 struct)
733 ;; Forbidden move:
735 ;; If only one item is moved, it mustn't have a child
739 ;; If a subtree or region is moved, the last item
740 ;; of the subtree mustn't have a child
745 struct)))))
748 ;; Normal shifting
756 t)
758 ;;; Predicates
761 "Return item beginning position when in a plain list, nil otherwise.
762 This checks `org-list-ending-method'."
776 10000
787 ;; Skip blocks, drawers, inline-tasks, blank lines
809 "Is point in a line starting a hand-formatted item?"
814 "Is point at the bullet of a plain list item?"
820 "Is point at a line starting a plain list item with a timer?"
825 "Is point at a description list item?"
829 "Is point at a line starting a plain-list item with a checklet?"
832 ;;; Navigate
837 "Go to the beginning of the current hand-formatted item.
838 If the cursor is not in an item, throw an error."
844 "Go to the beginning item of the current list or sublist.
845 Return an error if not in a list."
855 "Go to the end of the current list or sublist.
856 If the cursor in not in an item, throw an error."
866 "Go to the end of the current hand-formatted item.
867 If the cursor is not in an item, throw an error."
877 "Move to the beginning of the previous item.
878 Item is at the same level in the current plain list. Error if not
879 in a plain list, or if this is the first item in the list."
891 "Move to the beginning of the next item.
892 Item is at the same level in the current plain list. Error if not
893 in a plain list, or if this is the last item in the list."
904 ;;; Manipulate
907 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
908 Blank lines at the end of items are left in place. Return the new
909 structure after the changes.
911 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
912 to the same sub-list.
914 This function modifies STRUCT."
927 ;; 1. Move effectively items in buffer.
931 ;; 2. Now modify struct. No need to re-read the list, the
932 ;; transformation is just a shift of positions. Some special
933 ;; attention is required for items ending at END-A and END-B
934 ;; as empty spaces are not moved there. In others words, item
935 ;; BEG-A will end with whitespaces that were at the end of
936 ;; BEG-B and the same applies to BEG-B.
958 struct)
962 "Move the plain list item at point down, i.e. swap with following item.
963 Subitems (items with larger indentation) are considered part of the item,
964 so this really moves item trees."
979 ;; Use a short variation of `org-list-struct-fix-struct' as
980 ;; there's no need to go through all the steps.
991 "Move the plain list item at point up, i.e. swap with previous item.
992 Subitems (items with larger indentation) are considered part of the item,
993 so this really moves item trees."
1008 ;; Use a short variation of `org-list-struct-fix-struct' as
1009 ;; there's no need to go through all the steps.
1019 "Insert a new item at the current level.
1020 If cursor is before first character after bullet of the item, the
1021 new item will be created before the current one.
1023 If CHECKBOX is non-nil, add a checkbox next to the bullet.
1025 Return t when things worked, nil when we are not in an item, or
1026 item is invisible."
1035 ;; Timer list: delegate to `org-timer-item'.
1037 ;; if we're in a description list, ask for the new term.
1042 ;; Don't insert a checkbox if checkbox rule is applied and it
1043 ;; is a description item.
1048 desc-text))))))
1051 ;;; Structures
1054 "Return structure of list at point.
1056 A list structure is an alist where keys is point at item, and
1057 values are:
1058 1. indentation,
1059 2. bullet with trailing whitespace,
1060 3. bullet counter, if any,
1061 4. checkbox, if any,
1062 5. position at item end,
1063 6. description tag, if any.
1065 Thus the following list, where numbers in parens are
1066 point-at-bol:
1068 - [X] first item (1)
1069 1. sub-item 1 (18)
1070 5. [@5] sub-item 2 (34)
1071 some other text belonging to first item (55)
1072 - last item (97)
1073 + tag :: description (109)
1074 (131)
1076 will get the following structure:
1084 Assume point is at an item."
1098 ind itm-lst itm-lst-2 end-lst end-lst-2 struct
1100 ;; Return an association whose key is point and values are
1101 ;; indentation, bullet string, bullet counter, and
1102 ;; checkbox.
1107 ind
1113 ;; Ensure list ends at the first blank line.
1118 ;; 1. Read list from starting item to its beginning, and save
1119 ;; top item position and indentation in BEG-CELL. Also store
1120 ;; ending position of items in END-LST.
1128 ;; At upward limit: if we ended at an item, store it,
1129 ;; else dimiss useless data recorded above BEG-CELL.
1130 ;; Jump to part 2.
1139 ;; Looking at a list ending regexp. Dismiss useless
1140 ;; data recorded above BEG-CELL. Jump to part 2.
1144 ;; Skip blocks, drawers, inline tasks, blank lines
1145 ;; along the way.
1157 ;; Point is at an item. Add data to ITM-LST. It may
1158 ;; also end a previous item: save it in END-LST. If
1159 ;; ind is less or equal than BEG-CELL and there is no
1160 ;; end at this ind or lesser, this item becomes the
1161 ;; new BEG-CELL.
1170 ;; Point is not at an item. Unless ending method is
1171 ;; `regexp', interpret line's indentation:
1172 ;;
1173 ;; - text at column 0 is necessarily out of any list.
1174 ;; Dismiss data recorded above BEG-CELL. Jump to
1175 ;; part 2.
1176 ;;
1177 ;; - any other case, it can possibly be an ending
1178 ;; position for an item above. Save it and proceed.
1189 ;; 2. Read list from starting point to its end, that is until we
1190 ;; get out of context, or a non-item line is less or equally
1191 ;; indented that BEG-CELL's cdr. Also store ending position
1192 ;; of items in END-LST-2.
1199 ;; At downward limit: this is de facto the end of the
1200 ;; list. Save point as an ending position, and jump to
1201 ;; part 3.
1206 ;; Looking at a list ending regexp. Save point as an
1207 ;; ending position and jump to part 3.
1209 ;; Skip blocks, drawers, inline tasks and blank lines
1210 ;; along the way
1223 ;; Point is at an item. Add data to ITM-LST-2. It may also
1224 ;; end a previous item, so save it in END-LST-2.
1229 ;; Point is not at an item. If ending method is not
1230 ;; `regexp', two situations are of interest:
1231 ;;
1232 ;; - ind is lesser or equal than BEG-CELL's. The list is
1233 ;; over. Store point as an ending position and jump to
1234 ;; part 3.
1235 ;;
1236 ;; - ind is lesser or equal than previous item's. This
1237 ;; is an ending position. Store it and proceed.
1248 ;; 3. Correct ill-formed lists by making sure top item has the
1249 ;; least indentation of the list
1254 struct))
1255 ;; 4. Associate each item to its end pos.
1257 ;; 5. Return STRUCT
1258 struct)))
1261 "Associate proper ending point to items in STRUCT.
1263 END-LIST is a pseudo-alist where car is indentation and cdr is
1264 ending position.
1266 This function modifies STRUCT."
1272 ;; remove end candidates behind current item
1275 ;; add end position to item assoc
1281 struct)))
1284 "Return alist between item and previous item in STRUCT."
1286 struct)))
1290 struct)))
1293 "Return alist between item and parent in STRUCT."
1315 "Return parent of ITEM in STRUCT, or nil.
1316 PARENTS is the alist of items' parent. See
1317 `org-list-struct-parent-alist'."
1322 "Return a non-nil value if ITEM in STRUCT has a child.
1323 Value returned is the position of the first child of ITEM."
1328 child-maybe)))
1331 "Return next item in same sub-list as ITEM in STRUCT, or nil.
1332 PREVS is the alist of previous items. See
1333 `org-list-struct-prev-alist'."
1337 "Return previous item in same sub-list as ITEM in STRUCT, or nil.
1338 PREVS is the alist of previous items. See
1339 `org-list-struct-prev-alist'."
1343 "Return all items with ITEM as a common ancestor or nil.
1344 STRUCT is the list structure considered."
1347 subtree)
1352 sub-struct))
1356 "List of items in the same sub-list as ITEM in STRUCT.
1357 PREVS, when provided, is the alist of previous items. See
1358 `org-list-struct-prev-alist'."
1361 before-item after-item)
1369 "List all children of ITEM in STRUCT, or nil.
1370 PARENTS is the alist of items' parent. See
1371 `org-list-struct-parent-alist'."
1379 "Return point at beginning of list.
1380 STRUCT is the structure of the list."
1384 "Return point at bottom of list.
1385 STRUCT is the structure of the list."
1390 "Return point at beginning of sub-list ITEM belongs.
1391 STRUCT is the structure of the list. PREVS is the alist of
1392 previous items. See `org-list-struct-prev-alist'."
1396 first-item))
1401 "Return point at last item of sub-list ITEM belongs.
1402 STRUCT is the structure of the list. PREVS is the alist of
1403 previous items. See `org-list-struct-prev-alist'."
1407 last-item))
1410 "Return point at end of sub-list ITEM belongs.
1411 STRUCT is the structure of the list. PREVS is the alist of
1412 previous items. See `org-list-struct-prev-alist'."
1416 "Return the Nth value of KEY in STRUCT."
1420 "Set the Nth value of KEY in STRUCT to NEW.
1425 "Return indentation of ITEM in STRUCT."
1429 "Set indentation of ITEM in STRUCT to IND.
1434 "Return bullet of ITEM in STRUCT."
1438 "Set bullet of ITEM in STRUCT to BULLET.
1443 "Return counter of ITEM in STRUCT."
1447 "Return checkbox of ITEM in STRUCT or nil."
1451 "Set checkbox of ITEM in STRUCT to CHECKBOX.
1456 "Return end position of ITEM in STRUCT."
1460 "Return end position of ITEM in STRUCT."
1464 "Return point at end of ITEM in STRUCT, before any blank line.
1465 Point returned is at end of line."
1472 "Verify and correct bullets for every association in STRUCT.
1473 PREVS is the alist of previous items. See
1474 `org-list-struct-prev-alist'.
1476 This function modifies STRUCT."
1485 item struct
1500 "Verify and correct indentation for every association in STRUCT.
1502 PARENTS is the alist of items' parents. See
1503 `org-list-struct-parent-alist'.
1505 If numeric optional argument BULLET-SIZE is set, assume all
1506 bullets in list have this length to determine new indentation.
1508 This function modifies STRUCT."
1515 ;; Indent like parent + length of parent's bullet
1521 ;; If no parent, indent like top-point
1526 "Verify and correct checkboxes for every association in STRUCT.
1528 PARENTS is the alist of items' parents. See
1529 `org-list-struct-parent-alist'. PREVS is the alist of previous
1530 items. See `org-list-struct-prev-alist.
1532 If ORDERED is non-nil, a checkbox can only be checked when every
1533 checkbox before it is checked too. If there was an attempt to
1534 break this rule, the function will return the blocking item. In
1535 all others cases, the return value will be nil.
1537 This function modifies STRUCT."
1547 item struct
1553 ;; parent has no boxed child: leave box as-is
1555 parent-list)
1556 ;; 1. List all parents with a checkbox
1563 all-items)
1564 ;; 2. Sort those parents by decreasing indentation
1569 ;; 3. For each parent, get all children's checkboxes to determine
1570 ;; and set its checkbox accordingly
1572 ;; 4. If ORDERED is set, see if we need to uncheck some boxes
1577 ;; there are boxes checked after an unchecked one: fix that
1582 ;; Verify once again the structure, without ORDERED
1584 ;; return blocking item
1588 "Return STRUCT with correct bullets and indentation.
1589 PARENTS is the alist of items' parents. See
1590 `org-list-struct-parent-alist'."
1591 ;; Order of functions matters here: checkboxes and endings need
1592 ;; correct indentation to be set, and indentation needs correct
1593 ;; bullets.
1594 ;;
1595 ;; 0. Save a copy of structure before modifications
1597 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1598 ;; order to get items endings and bullets properly
1600 ;; 2. Get pseudo-alist of ending positions and sort it by position.
1601 ;; Then associate them to the structure.
1608 ;; to determine real ind of an ending position that is
1609 ;; not at an item, we have to find the item it belongs
1610 ;; to: it is the last item (ITEM-UP), whose ending is
1611 ;; further than the position we're interested in.
1614 ;; else part is for the bottom point
1616 end-pos)
1617 end-list)))
1620 struct)
1623 ;; 3. Get bullets right
1626 ;; 4. Now get real indentation
1628 ;; 5. Eventually fix checkboxes
1630 ;; 6. Apply structure modifications to buffer
1634 "Outdent items between START and END in structure STRUCT.
1636 PARENTS is the alist of items' parents. See
1637 `org-list-struct-parent-alist'.
1639 START is included, END excluded."
1645 ;; Item not yet in zone: keep association
1647 ;; Item out of zone: follow associations in acc
1651 ;; Item has no parent: error
1654 ;; Parent is outdented: keep association
1658 ;; Parent isn't outdented: reparent to grand-parent
1660 parent struct parents)))
1666 "Indent items between START and END in structure STRUCT.
1668 PARENTS is the alist of parents. See
1669 `org-list-struct-parent-alist'. PREVS is the alist of previous
1670 items. See `org-list-struct-prev-alist'.
1672 START is included and END excluded.
1674 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1675 bullets between START and END."
1689 ;; Item not yet in zone: keep association
1692 ;; Item out of zone: follow associations in acc
1696 ;; Item is in zone...
1698 ;; Check if bullet needs to be changed
1701 ;; First item indented but not parent: error
1704 ;; First item and parent indented: keep same parent
1706 ;; Previous item not indented: reparent to it
1708 ;; Previous item indented: reparent like it
1715 "Apply modifications to list so it mirrors STRUCT.
1717 OLD-STRUCT is the structure before any modifications. Thus, the
1718 function is smart enough to modify only parts of buffer which
1719 have changed.
1721 Initial position of cursor is restored after the changes."
1725 ;; Shift the indentation between END and BEG by DELTA.
1726 ;; Start from the line before END.
1739 ;; Replace item first line elements with new elements from
1740 ;; STRUCT, if appropriate.
1750 ;; a. Replace bullet
1753 ;; b. Replace checkbox
1768 ;; c. Indent item to appropriate column
1773 ;; 1. First get list of items and position endings. We maintain
1774 ;; two alists: ITM-SHIFT, determining indentation shift needed
1775 ;; at item, and END-POS, a pseudo-alist where key is ending
1776 ;; position and value point
1789 ;; To determine real ind of an ending position that is
1790 ;; not at an item, we have to find the item it belongs
1791 ;; to: it is the last item (ITEM-UP), whose ending is
1792 ;; further than the position we're interested in.
1796 old-struct)
1797 ;; 2. Slice the items into parts that should be shifted by the
1798 ;; same amount of indentation. The slices are returned in
1799 ;; reverse order so changes modifying buffer do not change
1800 ;; positions they refer to.
1803 '<))
1811 ;; 3. Modify each slice in buffer, from end to beginning, with a
1812 ;; special action when beginning is at item start.
1818 sliced-struct))
1819 ;; 4. Go back to initial position
1822 ;;; Indentation
1825 "Outdent a local list item, but not its children.
1826 If a region is active, all items inside will be moved."
1834 "Indent a local list item, but not its children.
1835 If a region is active, all items inside will be moved."
1843 "Outdent a local list item including its children.
1844 If a region is active, all items inside will be moved."
1858 "Indent a local list item including its children.
1859 If a region is active, all items inside will be moved."
1875 "Cycle levels of indentation of an empty item.
1876 The first run indents the item, if applicable. Subsequents runs
1877 outdent it at meaningful levels in the list. When done, item is
1878 put back at its original position with its original bullet.
1880 Return t at each successful move."
1885 ;; Check that item is really empty
1895 ;; When in the middle of the cycle, try to outdent first. If it
1896 ;; fails, and point is still at initial position, indent. Else,
1897 ;; go back to original position.
1908 ;; Break cycle
1910 ;; If a cycle is starting, remember indentation and bullet,
1911 ;; then try to indent. If it fails, try to outdent.
1917 t))))
1919 ;;; Bullets
1922 "Return the bullet of the item at point.
1923 Assume cursor is at an item."
1929 "Return BULLET with the correct number of whitespaces.
1930 It determines the number of whitespaces to append by looking at
1931 `org-list-two-spaces-after-bullet-regexp'."
1937 " "
1938 ;; Do we need to concat another white space ?
1945 "Increment BULLET if applicable."
1949 nil nil bullet)
1950 bullet))
1953 "Make sure all items are correctly indented, with the right bullet.
1954 This function scans the list at point, along with any sublist."
1962 "Cycle through the different itemize/enumerate bullets.
1963 This cycle the entire list level through the sequence:
1965 `-' -> `+' -> `*' -> `1.' -> `1)'
1967 If WHICH is a valid string, use that as the new bullet. If WHICH
1968 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
1969 `previous', cycle backwards."
1984 ;; Compute list of possible bullets, depending on context
1986 ;; *-bullets are not allowed at column 0
1989 ;; Description items cannot be numbered
2004 ;; Use a short variation of `org-list-struct-fix-struct' as
2005 ;; there's no need to go through all the steps.
2012 ;;; Checkboxes
2015 "Toggle the checkbox in the current line.
2016 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2017 double prefix, set checkbox to [-].
2019 When there is an active region, toggle status or presence of the
2020 first checkbox there, and make every item inside have the
2021 same status or presence, respectively.
2023 If the cursor is in a headline, apply this to all checkbox items
2024 in the text below the heading, taking as reference the first item
2025 in subtree, ignoring drawers."
2029 block-item
2030 lim-up
2031 lim-down
2034 ;; In a region, start at first item in region
2044 ;; On an heading, start at first item after drawers
2053 ;; Just one item: set singlep flag
2059 ;; determine the checkbox going to be applied to all items
2060 ;; within bounds
2071 ;; When an item is found within bounds, grab the full list at
2072 ;; point structure, then: 1. set checkbox of all its items
2073 ;; within bounds to ref-checkbox; 2. fix checkboxes of the whole
2074 ;; list; 3. move point after the list.
2088 e struct
2089 ;; if there is no box at item, leave as-is
2090 ;; unless function was called with C-u prefix
2093 ref-checkbox
2094 cur-box))))
2095 items-to-toggle)
2097 struct parents prevs orderedp))
2098 ;; Report some problems due to ORDERED status of subtree. If
2099 ;; only one box was being checked, throw an error, else,
2100 ;; only signal problems.
2104 "Checkbox blocked because of unchecked box at line %d"
2108 "Checkboxes were removed due to unchecked box at line %d"
2115 "Reset all checkboxes in an entry subtree."
2130 "Hook that is run whenever Org thinks checkbox statistics should be updated.
2131 This hook runs even if checkbox rule in
2132 `org-list-automatic-rules' does not apply, so it can be used to
2133 implement alternative ways of collecting statistics
2137 "Update checkbox statistics unless turned off by user."
2143 "Update the checkbox statistics in the current section.
2144 This will find all statistic cookies like [57%] and [6/12] and
2145 update them with the current numbers.
2147 With optional prefix argument ALL, do this for the whole buffer."
2151 (box-re "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2165 ;; add checked boxes and boxes of all types in all
2166 ;; structures in STRUCTS to c-on and c-all, respectively.
2167 ;; This looks at RECURSIVEP value. If ITEM is nil, count
2168 ;; across the whole structure, else count only across
2169 ;; subtree whose ancestor is ITEM.
2185 items))))
2188 structs))))
2189 cookies-list backup-end structs-backup)
2191 ;; 1. Build an alist for each cookie found within BOUNDS. The
2192 ;; key will be position at beginning of cookie and values
2193 ;; ending position, format of cookie, number of checked boxes
2194 ;; to report, and total number of boxes.
2199 ;; There are two types of cookies: those at headings and those
2200 ;; at list items.
2206 ;; This cookie is at an heading, but specifically for
2207 ;; todo, not for checkboxes: skip it.
2211 ;; This cookie is at an heading. Grab structure of
2212 ;; every list containing a checkbox between point and
2213 ;; next headline, and save them in STRUCTS-BACKUP
2221 ;; This cookie is at an item. Look in STRUCTS-BACKUP
2222 ;; to see if we have the structure of list at point in
2223 ;; it. Else compute the structure.
2231 ;; Build the cookies list, with appropriate information
2235 c-on ; checked boxes
2237 cookies-list))))
2238 ;; 2. Apply alist to buffer, in reverse order so positions stay
2239 ;; unchanged after cookie modifications.
2253 cookies-list))))
2256 "Select the face for checkbox statistics.
2257 The face will be `org-done' when all relevant boxes are checked.
2258 Otherwise it will be `org-todo'."
2261 'org-checkbox-statistics-done
2265 'org-checkbox-statistics-done
2268 ;;; Misc Tools
2271 "Call FUNCTION on each item of the list at point.
2272 FUNCTION must be called with at least one argument: INIT-VALUE,
2273 that will contain the value returned by the function at the
2274 previous item, plus ARGS extra arguments.
2276 FUNCTION is applied on items in reverse order.
2278 As an example, (org-apply-on-list (lambda (result) (1+ result)) 0)
2279 will return the number of items in the current list.
2281 Sublists of the list are skipped. Cursor is always at the
2282 beginning of the item."
2293 value))
2296 "Sort plain list items.
2297 The cursor may be at any item of the list that should be sorted.
2298 Sublists are not sorted. Checkboxes, if any, are ignored.
2300 Sorting can be alphabetically, numerically, by date/time as given by
2301 a time stamp, by a property or by priority.
2303 Comparing entries ignores case by default. However, with an
2304 optional argument WITH-CASE, the sorting considers case as well.
2306 The command prompts for the sorting type unless it has been given
2307 to the function through the SORTING-TYPE argument, which needs to
2308 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
2309 meaning of each character:
2311 n Numerically, by converting the beginning of the item to a number.
2312 a Alphabetically. Only the first line of item is checked.
2313 t By date/time, either the first active time stamp in the entry, if
2314 any, or by the first inactive one. In a timer list, sort the timers.
2316 Capital letters will reverse the sort order.
2318 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a
2319 function to be called with point at the beginning of the record.
2320 It must return either a string or a number that should serve as
2321 the sorting key for that record. It will then use COMPARE-FUNC to
2322 compare entries."
2367 ;; If it is a timer list, convert timer to seconds
2380 value))
2384 next-record
2385 end-record
2386 value-to-sort
2387 nil
2388 sort-func)
2389 ;; Read and fix list again, as `sort-subr' probably destroyed
2390 ;; its structure.
2395 ;;; Send and receive lists
2397 "Parse the list at point and maybe DELETE it.
2399 Return a list whose car is a symbol of list type, among
2400 `ordered', `unordered' and `descriptive'. Then, each item is a
2401 list whose elements are strings and other sub-lists. Inside
2404 For example, the following list:
2406 1. first item
2407 + sub-item one
2408 + [X] sub-item two
2409 more text in first item
2410 2. last item
2412 will be parsed as:
2419 Point is left at list end."
2425 out
2428 ;; determine type of list by getting info on item POS in
2429 ;; STRUCT.
2437 ;; return a list whose car is list type and cdr a list of
2438 ;; items' body.
2444 ;; return a list containing text and any sublist inside
2445 ;; item.
2465 body))))
2470 ;; return text between BEG and END, trimmed, with
2471 ;; checkboxes replaced if BOX is true.
2477 text))
2481 text))))))
2482 ;; store output, take care of cursor position and deletion of
2483 ;; list, then return output.
2491 out))
2494 "Convert the plain list at point into a subtree."
2508 "Convert LIST into subtrees starting at LEVEL."
2517 list)))
2520 "Insert a radio list template appropriate for this major mode."
2524 name pos)
2535 "Send a transformed version of this list to the receiver position.
2536 With argument MAYBE, fail quietly if no transformation is defined for
2537 this list."
2543 (unless (looking-at "[ \t]*#\\+ORGLST[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
2562 beg txt)
2566 ;; Find the insertion place
2571 name
2585 "Convert a LIST parsed through `org-list-parse-list' to other formats.
2586 Valid parameters PARAMS are
2588 :ustart String to start an unordered list
2589 :uend String to end an unordered list
2591 :ostart String to start an ordered list
2592 :oend String to end an ordered list
2594 :dstart String to start a descriptive list
2595 :dend String to end a descriptive list
2596 :dtstart String to start a descriptive term
2597 :dtend String to end a descriptive term
2598 :ddstart String to start a description
2599 :ddend String to end a description
2601 :splice When set to t, return only list body lines, don't wrap
2602 them into :[u/o]start and :[u/o]end. Default is nil.
2604 :istart String to start a list item
2605 :iend String to end a list item
2606 :isep String to separate items
2607 :lsep String to separate sublists
2609 :cboff String to insert for an unchecked checkbox
2610 :cbon String to insert for a checked checkbox"
2632 ;; Export an item ITEM of type TYPE. First string in item
2633 ;; is treated in a special way as it can bring extra
2634 ;; information that needs to be processed.
2640 ;; Replace checkbox if any is found.
2648 ;; Insert descriptive term if TYPE is `descriptive'.
2658 item isep))))))
2661 ;; Export sublist SUB
2674 items lsep)))))))
2678 "Convert LIST into a LaTeX list.
2679 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2680 with overruling parameters for `org-list-to-generic'."
2682 list
2692 params)))
2695 "Convert LIST into a HTML list.
2696 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2697 with overruling parameters for `org-list-to-generic'."
2699 list
2709 params)))
2712 "Convert LIST into a Texinfo list.
2713 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2714 with overruling parameters for `org-list-to-generic'."
2716 list
2726 params)))
2730 ;; arch-tag: 73cf50c1-200f-4d1d-8a53-4e842a5b11c8
2731 ;;; org-list.el ends here