| blob | 08c733acc6f60f126c2890389f662ee846e011ad |
1 ;;; org-list.el --- Plain lists for Org-mode
2 ;;
3 ;; Copyright (C) 2004-2011 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Bastien Guerry <bzg AT altern DOT org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 7.4
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
29 ;; This file contains the code dealing with plain lists in Org-mode.
31 ;;; Code:
69 "Options concerning plain lists in Org-mode."
74 "When t, make TAB cycle visibility on plain list items.
75 Cycling plain lists works only when the cursor is on a plain list
76 item. When the cursor is on an outline heading, plain lists are
77 treated as text. This is the most stable way of handling this,
78 which is why it is the default.
80 When this is the symbol `integrate', then during cycling, plain
81 list items will *temporarily* be interpreted as outline headlines
82 with a level given by 1000+i where i is the indentation of the
83 bullet. This setting can lead to strange effects when switching
85 subtree decides what children should be listed. If that first
87 number, all true children and grand children of the outline
88 heading will be exposed in a children' view."
96 "Default bullet type installed when demoting an item.
97 This is an association list, for each bullet type, this alist will point
98 to the bullet that should be used when this item is demoted.
99 For example,
101 (setq org-list-demote-modify-bullet
104 will make
106 + Movies
107 + Silence of the Lambs
108 + My Cousin Vinny
109 + Books
110 + The Hunt for Red October
111 + The Road to Omaha
113 into
115 + Movies
116 - Silence of the Lambs
117 - My Cousin Vinny
118 + Books
119 - The Hunt for Red October
120 - The Road to Omaha"
138 "The character that makes a line with leading number an ordered list item.
139 Valid values are ?. and ?\). To get both terminators, use t. While
140 ?. may look nicer, it creates the danger that a line with leading
141 number may be incorrectly interpreted as an item. ?\) therefore is
142 the safe choice."
149 "A regular expression matching bullets that should have 2 spaces after them.
150 When nil, no bullet will have two spaces after them.
151 When a string, it will be used as a regular expression. When the
152 bullet type of a list is changed, the new bullet type will be
153 matched against this regexp. If it matches, there will be two
154 spaces instead of one after the bullet in each item of the list."
161 "Determine where plain lists should end.
162 Valid values are: `regexp', `indent' or `both'.
164 When set to `regexp', Org will look into two variables,
165 `org-empty-line-terminates-plain-lists' and the more general
166 `org-list-end-regexp', to determine what will end lists. This is
167 the fastest method.
169 When set to `indent', a list will end whenever a line following
170 an item, but not starting one, is less or equally indented than
171 it.
173 When set to `both', each of the preceding methods is applied to
174 determine lists endings. This is the default method."
182 "Non-nil means an empty line ends all plain list levels.
183 This variable only makes sense if `org-list-ending-method' is set
184 to `regexp' or `both'. This is then equivalent to set
190 "Regexp matching the end of all plain list levels.
192 blank lines. `org-empty-line-terminates-plain-lists' has
193 precedence over it."
201 "Non-nil means apply set of rules when acting on lists.
202 By default, automatic actions are taken when using
207 rules by setting them to nil. Valid rules are:
209 bullet when non-nil, cycling bullet do not allow lists at
210 column 0 to have * as a bullet and descriptions lists
211 to be numbered.
212 checkbox when non-nil, checkbox statistics is updated each time
213 you either insert a new checkbox or toggle a checkbox.
214 It also prevents from inserting a checkbox in a
215 description item.
216 indent when non-nil, indenting or outdenting list top-item
217 with its subtree will move the whole list and
218 outdenting a list whose bullet is * to column 0 will
219 change that bullet to -
220 insert when non-nil, trying to insert an item inside a block
221 will insert it right before the block instead of
222 throwing an error."
225 :key-type
231 :value-type
235 "Non-nil means checkbox statistics counts only the state of direct children.
236 When nil, all boxes below the cookie are counted.
237 This can be set to nil on a per-node basis using a COOKIE_DATA property
243 "Maximum indentation for the second line of a description list.
244 When the indentation would be larger than this, it will become
245 5 characters instead."
251 % END RECEIVE ORGLST %n
253 #+ORGLST: SEND %n org-list-to-latex
254 -
257 @c END RECEIVE ORGLST %n
258 @ignore
259 #+ORGLST: SEND %n org-list-to-texinfo
260 -
263 <!-- END RECEIVE ORGLST %n -->
264 <!--
265 #+ORGLST: SEND %n org-list-to-html
266 -
268 "Templates for radio lists in different major modes.
269 All occurrences of %n in a template will be replaced with the name of the
270 list, obtained by prompting the user."
276 ;;; Internal functions
279 "Return the regex corresponding to the end of a list.
280 It depends on `org-empty-line-terminates-plain-lists'."
283 org-list-end-regexp))
286 "Return the correct regular expression for plain lists.
287 If GENERAL is non-nil, return the general regexp independent of the value
288 of `org-plain-list-ordered-item-terminator'."
302 "Find the position of a list ending between MIN and MAX, or nil.
303 This function looks for `org-list-end-re' outside a block.
305 If FIRSTP in non-nil, return the point at the beginning of the
306 nearest valid terminator from MIN. Otherwise, return the point at
307 the end of the nearest terminator from MAX."
312 #'org-search-forward-unenclosed
317 ;; Is there a valid list ending somewhere ?
319 ;; we want to be on the first line of the list ender
323 "Return non-nil value if point is in a block, skipping it on the way.
324 It looks for the boundary of the block in SEARCH direction,
325 stopping at LIMIT."
332 ;; We're in a block: get out of it
336 "Search a string outside blocks and protected places.
337 Arguments SEARCH, RE, BOUND and NOERR are similar to those in
338 `search-forward', `search-backward', `re-search-forward' and
339 `re-search-backward'."
343 ;; 1. No match: return to origin or bound, depending on NOERR.
346 nil)))
347 ;; 2. Match not in block or protected: return point. Else
348 ;; skip the block and carry on.
354 "Like `re-search-backward' but don't stop inside blocks or protected places.
355 Arguments REGEXP, BOUND and NOERROR are similar to those used in
356 `re-search-backward'."
361 "Like `re-search-forward' but don't stop inside blocks or protected places.
362 Arguments REGEXP, BOUND and NOERROR are similar to those used in
363 `re-search-forward'."
368 "Is the cursor inside a plain list?
369 Plain lists are considered ending when a non-blank line is less
370 indented than the previous item within LIMIT."
374 ;; do not start searching inside a block...
376 ;; ... or at a blank line
384 ;; Ensure there is at least an item above
387 org-item-beginning-re limit t))))
404 "Is the cursor inside a plain list?
405 Plain lists end when `org-list-end-regexp' is matched, or at a
406 blank line if `org-empty-line-terminates-plain-lists' is true.
408 Argument LIMIT specifies the upper-bound of the search."
411 ;; Moved to eol so current line can be matched by
412 ;; `org-item-re'.
415 org-item-beginning-re limit t)))
417 last-item-start actual-pos)))
418 ;; We are in a list when we are on an item line or when we can
419 ;; find an item before point and there is no valid list ender
420 ;; between it and the point.
424 "Return point at the top level item in a list.
425 Argument LIMIT specifies the upper-bound of the search.
427 List ending is determined by regexp. See
428 `org-list-ending-method'. for more information."
431 ;; Is there some list above this one ? If so, go to its ending.
432 ;; Otherwise, go back to the heading above or bob.
434 ;; From there, search down our list.
439 "Return point just before list ending.
440 Argument LIMIT specifies the lower-bound of the search.
442 List ending is determined by regexp. See
443 `org-list-ending-method'. for more information."
446 ;; The list ending is either first point matching
447 ;; `org-list-end-re', point at first white-line before next
448 ;; heading, or eob.
452 "Return point at the top level in a list.
453 Argument LIMIT specifies the upper-bound of the search.
455 List ending is determined by indentation of text. See
456 `org-list-ending-method'. for more information."
473 item-ref)))
489 "Return point just before list ending or nil if not in a list.
490 Argument LIMIT specifies the lower-bound of the search.
492 List ending is determined by the indentation of text. See
493 `org-list-ending-method' for more information."
499 ;; do not start inside a block
511 ;; Ensure bottom is just after a
512 ;; non-blank line.
523 ;; Again, ensure bottom is just after a
524 ;; non-blank line.
533 "Is point at a list item with REGEXP after bullet?"
537 ;; Ignore counter if any
543 "Return point at the beginning of next item at the same level.
544 Search items using function SEARCH-FUN, from POS to LIMIT. It
545 uses PRE-MOVE before search. Return nil if no item was found."
550 ;; We don't want to match the current line.
552 ;; Skip any sublist on the way
560 "Return number of blank lines that should separate items in list.
561 POS is the position of point to be considered.
563 TOP and BOTTOM are respectively position of list beginning and
564 list ending.
566 Assume point is at item's beginning. If the item is alone, apply
567 some heuristics to guess the result."
571 usr-blank)
573 ;; Trivial cases where there should be none.
575 org-empty-line-terminates-plain-lists)
577 ;; When `org-blank-before-new-entry' says so, it is 1.
579 ;; plain-list-item is 'auto. Count blank lines separating
580 ;; neighbours items in list.
583 ;; Is there a next item?
586 ;; Is there a previous item?
589 ;; User inserted blank lines, trust him
595 usr-blank)
596 ;; Are there blank lines inside the item ?
600 ;; No parent: no blank line.
604 "Insert a new list item at POS.
605 If POS is before first character after bullet of the item, the
606 new item will be created before the current one.
608 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
609 after the bullet. Cursor will be after this text once the
610 function ends."
612 ;; Is point in a special block?
617 ;; Rule in `org-list-automatic-rules' forbids insertion.
619 ;; Else, move before it prior to add a new item.
630 ;; Description item: text starts after colons.
632 ;; At a checkbox: text starts after it.
634 ;; Otherwise, text starts after bullet.
638 true-pos top bottom))
641 ;; insert bullet above item in order to avoid bothering
642 ;; with possible blank lines ending last item.
646 ;; Stay between after-bullet and before text.
650 ;; store bottom: exchanging items doesn't change list
651 ;; bottom point but will modify marker anyway
656 bottom)
657 ;; recompute next-item: last sexp modified list
660 ;; checkbox update might modify bottom point, so use a
661 ;; marker here
668 ;; Can't split item: insert bullet at the end of item.
671 ;; else, insert a new bullet along with everything from point
672 ;; down to last non-blank line of item.
675 ;; Get pos again in case previous command modified line.
682 ;; delete any blank line at and before point.
693 "Indent a local list item including its children.
694 When number ARG is a negative, item will be outdented, otherwise
695 it will be indented.
697 If a region is active, all items inside will be moved.
699 If NO-SUBTREE is non-nil, only indent the item itself, not its
700 children.
702 TOP and BOTTOM are respectively position at item beginning and at
703 item ending.
705 Return t if successful."
717 ;; Are we going to move the whole list?
721 ;; Determine begin and end points of zone to indent. If moving
722 ;; more than one item, ensure we keep them on subsequent moves.
736 ;; Get everything ready
744 ;; Special case: moving top-item with indent rule
751 ;; Change bullet if necessary
756 ;; Shift ancestor
761 ;; Forbidden move
773 ;; Normal shifting
781 ;;; Predicates
784 "Is the cursor inside a plain list?
785 This checks `org-list-ending-method'."
792 prev-head)
803 "Is this item the first item in a plain list?
804 Assume point is at an item.
806 TOP is the position of list's top-item."
814 "Is point in a line starting a hand-formatted item?"
819 "Is point at the bullet of a plain list item?"
825 "Is point at a line starting a plain list item with a timer?"
830 "Is point at a description list item?"
834 "Is point at a line starting a plain-list item with a checklet?"
838 "Is the current checkbox blocked from for being checked now?
839 A checkbox is blocked if all of the following conditions are fulfilled:
841 1. The checkbox is not checked already.
842 2. The current entry has the ORDERED property set.
843 3. There is an unchecked checkbox in this entry before the current line."
849 ;; the box is already checked!
859 ;;; Navigate
861 ;; Every interactive navigation function is derived from a
862 ;; non-interactive one, which doesn't move point, assumes point is
863 ;; already in a list and doesn't compute list boundaries.
865 ;; If you plan to use more than one org-list function is some code,
866 ;; you should therefore first check if point is in a list with
867 ;; `org-in-item-p' or `org-at-item-p', then compute list boundaries
868 ;; with `org-list-top-point' and `org-list-bottom-point', and make use
869 ;; of non-interactive forms.
872 "Return point at the top level in a list.
873 Assume point is in a list."
879 prev-head)
890 "Return point just before list ending.
891 Assume point is in a list."
894 ;; Use default regexp because folding
895 ;; changes OUTLINE-REGEXP.
900 next-head
911 "Return position of current item beginning."
913 ;; possibly match current line
919 "Go to the beginning of the current hand-formatted item.
920 If the cursor is not in an item, throw an error."
927 "Return position of the first item of the current list or sublist.
928 TOP is the position at list beginning."
936 "Go to the beginning item of the current list or sublist.
937 Return an error if not in a list."
944 "Return position at the end of the current list or sublist.
945 BOTTOM is the position at list ending."
955 "Go to the end of the current list or sublist.
956 If the cursor in not in an item, throw an error."
963 "Return position at the end of the current item.
964 BOTTOM is the position at list ending."
969 "Go to the end of the current hand-formatted item.
970 If the cursor is not in an item, throw an error."
977 "Move to the end of the item, stops before the first child if any.
978 BOTTOM is the position at list ending."
986 "Return point at end of item, before any blank line.
987 Point returned is at eol.
989 BOTTOM is the position at list ending."
996 "Return point of the previous item at the same level as POS.
997 Stop searching at LIMIT. Return nil if no item is found."
1002 "Move to the beginning of the previous item.
1003 Item is at the same level in the current plain list. Error if not
1004 in a plain list, or if this is the first item in the list."
1012 "Return point of the next item at the same level as POS.
1013 Stop searching at LIMIT. Return nil if no item is found."
1018 "Move to the beginning of the next item.
1019 Item is at the same level in the current plain list. Error if not
1020 in a plain list, or if this is the last item in the list."
1027 ;;; Manipulate
1030 "Swap item starting at BEG-A with item starting at BEG-B.
1031 Blank lines at the end of items are left in place. Assume BEG-A
1032 is lesser than BEG-B.
1034 BOTTOM is the position at list ending."
1050 "Move the plain list item at point down, i.e. swap with following item.
1051 Subitems (items with larger indentation) are considered part of the item,
1052 so this really moves item trees."
1071 "Move the plain list item at point up, i.e. swap with previous item.
1072 Subitems (items with larger indentation) are considered part of the item,
1073 so this really moves item trees."
1092 "Insert a new item at the current level.
1093 If cursor is before first character after bullet of the item, the
1094 new item will be created before the current one.
1096 If CHECKBOX is non-nil, add a checkbox next to the bullet.
1098 Return t when things worked, nil when we are not in an item, or
1099 item is invisible."
1107 ;; Timer list: delegate to `org-timer-item'.
1109 ;; if we're in a description list, ask for the new term.
1114 ;; Don't insert a checkbox if checkbox rule is applied and it
1115 ;; is a description item.
1120 desc-text)))))
1122 ;;; Structures
1124 ;; The idea behind structures is to avoid moving back and forth in the
1125 ;; buffer on costly operations like indenting or fixing bullets.
1127 ;; It achieves this by taking a snapshot of an interesting part of the
1128 ;; list, in the shape of an alist, using `org-list-struct'.
1130 ;; It then proceeds to changes directly on the alist, with the help of
1131 ;; and `org-list-struct-origins'. When those are done,
1132 ;; `org-list-struct-apply-struct' applies the changes to the buffer.
1135 "Return the structure association at point.
1136 It is a cons-cell whose key is point and values are indentation,
1137 bullet string and bullet counter, if any."
1151 "Return the structure containing the list between BEGIN and END.
1152 A structure is an alist where key is point of item and values
1153 are, in that order, indentation, bullet string and value of
1154 counter, if any. A structure contains every list and sublist that
1155 has items between BEGIN and END along with their common ancestor.
1156 If no such ancestor can be found, the function will add a virtual
1157 ancestor at position 0.
1159 TOP and BOTTOM are respectively the position of list beginning
1160 and list ending.
1162 If OUTDENT is non-nil, it will also grab all of the parent list
1163 and the grand-parent. Setting OUTDENT to t is mandatory when next
1164 change is an outdent."
1172 pre-list post-list)
1174 ;; Find beginning of most outdented list (min list)
1176 org-item-beginning-re top t)
1179 pre-list)))
1180 ;; Now get the parent. If none, add a virtual ancestor
1183 pre-list))
1185 pre-list)))
1186 ;; Find end of min list
1193 post-list)))
1194 ;; Is list is malformed? If some items are less
1195 ;; indented that top-item, add them anyhow.
1199 org-item-beginning-re bottom t)
1201 post-list))))
1203 ;; Here we start: first get the core zone...
1207 ;; ... then, extend it to make it a structure...
1209 ;; ... twice when OUTDENT is non-nil and struct still can be
1210 ;; extended
1213 extended)))))
1216 "Return an alist where key is item's position and value parent's.
1217 STRUCT is the list's structure looked up."
1228 ;; List closing.
1231 ;; needed if top-point is
1232 ;; not the most outdented
1236 ;; New list
1241 ;; Current list going on
1246 "Return parent association of ITEM in STRUCT or nil.
1247 ORIGINS is the alist of parents. See `org-list-struct-origins'."
1252 "Return child association of ITEM in STRUCT or nil."
1258 "Verify and correct bullets for every association in STRUCT.
1259 ORIGINS is the alist of parents. See `org-list-struct-origins'.
1261 This function modifies STRUCT."
1278 bullet))))
1284 ;; Continuing previous list
1289 ;; A new list is starting
1294 acc))))))))
1298 "Verify and correct indentation for every association in STRUCT.
1299 ORIGINS is the alist of parents. See `org-list-struct-origins'.
1301 This function modifies STRUCT."
1309 ;; Indent like parent + length of parent's bullet
1312 ;; If no parent, indent like top-point
1317 "Return STRUCT with correct bullets and indentation.
1318 ORIGINS is the alist of parents. See `org-list-struct-origins'.
1320 Only elements of STRUCT that have changed are returned."
1327 "Outdent items in a structure.
1328 Items are indented when their key is between START, included, and
1329 END, excluded.
1331 ORIGINS is the alist of parents. See `org-list-struct-origins'.
1333 STRUCT is the concerned structure."
1339 ;; Item not yet in zone: keep association
1341 ;; Item out of zone: follow associations in acc
1345 ;; Item has no parent: error
1348 ;; Parent is outdented: keep association
1352 ;; Parent isn't outdented: reparent to grand-parent
1359 "Indent items in a structure.
1360 Items are indented when their key is between START, included, and
1361 END, excluded.
1363 ORIGINS is the alist of parents. See `org-list-struct-origins'.
1365 STRUCT is the concerned structure. It may be modified if
1366 `org-list-demote-modify-bullet' matches bullets between START and
1367 END."
1382 ;; new bullet is stored without space to ensure item
1383 ;; will be modified
1386 new-bul-p
1393 ;; Item not yet in zone: keep association
1396 ;; Item out of zone: follow associations in acc
1400 ;; Item is in zone...
1402 ;; Check if bullet needs to be changed
1405 ;; First item indented but not parent: error
1408 ;; First item and parent indented: keep same parent
1411 ;; Previous item not indented: reparent to it
1414 ;; Previous item indented: reparent like it
1421 "Apply modifications to list so it mirrors STRUCT.
1422 BOTTOM is position at list ending.
1424 Initial position is restored after the changes."
1438 ;; 1. Shift item's body
1442 ;; 2. Replace bullet
1447 ;; 3. Indent item to appropriate column
1454 ;; Remove ancestor if it is left.
1457 struct)))
1458 ;; Apply changes from bottom to top
1462 ;;; Indentation
1465 "What indentation has S due to SPACE and TAB at the beginning of the string?"
1473 i))
1476 "Shift the indentation in current item by DELTA.
1477 Sub-items are not moved.
1479 BOTTOM is position at list ending."
1486 ;; this is not an empty line
1493 "Outdent a local list item, but not its children.
1494 If a region is active, all items inside will be moved."
1500 "Indent a local list item, but not its children.
1501 If a region is active, all items inside will be moved."
1507 "Outdent a local list item including its children.
1508 If a region is active, all items inside will be moved."
1514 "Indent a local list item including its children.
1515 If a region is active, all items inside will be moved."
1522 "Cycle levels of indentation of an empty item.
1523 The first run indent the item, if applicable. Subsequents runs
1524 outdent it at meaningful levels in the list. When done, item is
1525 put back at its original position with its original bullet.
1527 Return t at each successful move."
1534 ;; Check that item is really empty
1541 ;; When in the middle of the cycle, try to outdent first. If it
1542 ;; fails, and point is still at initial position, indent. Else,
1543 ;; go back to original position.
1554 ;; Break cycle
1556 ;; If a cycle is starting, remember indentation and bullet,
1557 ;; then try to indent. If it fails, try to outdent.
1563 t)))
1565 ;;; Bullets
1568 "Return the bullet of the item at point.
1569 Assume cursor is at an item."
1575 "Return BULLET with the correct number of whitespaces.
1576 It determines the number of whitespaces to append by looking at
1577 `org-list-two-spaces-after-bullet-regexp'."
1583 " "
1584 ;; Do we need to concat another white space ?
1591 "Increment BULLET if applicable."
1595 nil nil bullet)
1596 bullet))
1599 "Make sure all items are correctly indented, with the right bullet.
1600 This function scans the list at point, along with any sublist.
1602 If FORCE-BULLET is a string, ensure all items in list share this
1603 bullet, or a logical successor in the case of an ordered list.
1605 When non-nil, TOP and BOTTOM specify respectively position of
1606 list beginning and list ending.
1608 Item's body is not indented, only shifted with the bullet."
1616 fixed-struct)
1628 "Cycle through the different itemize/enumerate bullets.
1629 This cycle the entire list level through the sequence:
1631 `-' -> `+' -> `*' -> `1.' -> `1)'
1633 If WHICH is a valid string, use that as the new bullet. If WHICH
1634 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
1635 'previous, cycle backwards."
1648 ;; *-bullets are not allowed at column 0
1651 ;; Description items cannot be numbered
1668 ;;; Checkboxes
1671 "Toggle the checkbox in the current line.
1672 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
1673 double prefix, set checkbox to [-].
1675 When there is an active region, toggle status or presence of the
1676 first checkbox there, and make every item inside have the
1677 same status or presence, respectively.
1679 If the cursor is in a headline, apply this to all checkbox items
1680 in the text below the heading, taking as reference the first item
1681 in subtree, ignoring drawers."
1683 ;; Bounds is a list of type (beg end single-p) where single-p is t
1684 ;; when `org-toggle-checkbox' is applied to a single item. Only
1685 ;; toggles on single items will return errors.
1697 ;; In this case, reference line is the first item in
1698 ;; subtree outside drawers
1711 ;; marker is needed because deleting or inserting checkboxes
1712 ;; will change bottom point
1729 ;; Ignore counter, if any
1757 "Reset all checkboxes in an entry subtree."
1772 "Hook that is run whenever Org thinks checkbox statistics should be updated.
1773 This hook runs even if checkbox rule in
1774 `org-list-automatic-rules' does not apply, so it can be used to
1775 implement alternative ways of collecting statistics
1779 "Update checkbox statistics unless turned off by user."
1785 "Update the checkbox statistics in the current section.
1786 This will find all statistic cookies like [57%] and [6/12] and update them
1787 with the current numbers. With optional prefix argument ALL, do this for
1788 the whole buffer."
1801 (re-box "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
1802 beg-cookie end-cookie is-percent c-on c-off lim new
1803 curr-ind next-ind continue-from startsearch list-beg list-end
1811 ;; find each statistics cookie
1828 ;; Ensure many cookies in the same list won't imply
1829 ;; computing list boundaries as many times.
1837 c-on 0
1840 ;; find first checkbox for this cookie and gather
1841 ;; statistics from all that are at this indentation level
1857 ;; org-get-next-item goes through list-enders
1858 ;; with proper limit.
1862 org-item-beginning-re lim t)
1866 ;; update cookie
1875 ;; update items checkbox if it has one
1892 "Select the face for checkbox statistics.
1893 The face will be `org-done' when all relevant boxes are checked.
1894 Otherwise it will be `org-todo'."
1897 'org-checkbox-statistics-done
1901 'org-checkbox-statistics-done
1904 ;;; Misc Tools
1907 "Call FUNCTION on each item of the list at point.
1908 FUNCTION must be called with at least one argument: INIT-VALUE,
1909 that will contain the value returned by the function at the
1910 previous item, plus ARGS extra arguments.
1912 As an example, (org-apply-on-list (lambda (result) (1+ result)) 0)
1913 will return the number of items in the current list.
1915 Sublists of the list are skipped. Cursor is always at the
1916 beginning of the item."
1926 value))
1929 "Sort plain list items.
1930 The cursor may be at any item of the list that should be sorted.
1931 Sublists are not sorted. Checkboxes, if any, are ignored.
1933 Sorting can be alphabetically, numerically, by date/time as given by
1934 a time stamp, by a property or by priority.
1936 Comparing entries ignores case by default. However, with an
1937 optional argument WITH-CASE, the sorting considers case as well.
1939 The command prompts for the sorting type unless it has been given
1940 to the function through the SORTING-TYPE argument, which needs to
1941 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
1942 meaning of each character:
1944 n Numerically, by converting the beginning of the item to a number.
1945 a Alphabetically. Only the first line of item is checked.
1946 t By date/time, either the first active time stamp in the entry, if
1947 any, or by the first inactive one. In a timer list, sort the timers.
1949 Capital letters will reverse the sort order.
1951 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a
1952 function to be called with point at the beginning of the record.
1953 It must return either a string or a number that should serve as
1954 the sorting key for that record. It will then use COMPARE-FUNC to
1955 compare entries."
1999 ;; If it is a timer list, convert timer to seconds
2013 value))
2017 begin-record
2018 end-record
2019 value-to-sort
2020 nil
2021 sort-func)
2026 ;;; Send and receive lists
2029 "Parse the list at point and maybe DELETE it.
2030 Return a list containing first level items as strings and
2031 sublevels as a list of strings."
2034 output itemsep ltype)
2048 item)
2050 "CBOFF"
2053 item)))
2069 "Convert the plain list at point into a subtree."
2083 "Convert LIST into subtrees starting at LEVEL."
2092 list)))
2095 "Insert a radio list template appropriate for this major mode."
2099 name pos)
2110 "Send a transformed version of this list to the receiver position.
2111 With argument MAYBE, fail quietly if no transformation is defined for
2112 this list."
2118 (unless (looking-at "[ \t]*#\\+ORGLST[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
2137 beg txt)
2141 ;; Find the insertion place
2146 name
2160 "Convert a LIST parsed through `org-list-parse-list' to other formats.
2161 Valid parameters PARAMS are
2163 :ustart String to start an unordered list
2164 :uend String to end an unordered list
2166 :ostart String to start an ordered list
2167 :oend String to end an ordered list
2169 :dstart String to start a descriptive list
2170 :dend String to end a descriptive list
2171 :dtstart String to start a descriptive term
2172 :dtend String to end a descriptive term
2173 :ddstart String to start a description
2174 :ddend String to end a description
2176 :splice When set to t, return only list body lines, don't wrap
2177 them into :[u/o]start and :[u/o]end. Default is nil.
2179 :istart String to start a list item
2180 :iend String to end a list item
2181 :isep String to separate items
2182 :lsep String to separate sublists
2184 :cboff String to insert for an unchecked checkbox
2185 :cbon String to insert for a checked checkbox"
2212 rtn term defstart defend)
2222 ddend)))
2231 lsep ;; list separator
2233 lsep ;; list separator
2234 )))))
2238 "Convert LIST into a LaTeX list.
2239 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2240 with overruling parameters for `org-list-to-generic'."
2242 list
2252 params)))
2255 "Convert LIST into a HTML list.
2256 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2257 with overruling parameters for `org-list-to-generic'."
2259 list
2269 params)))
2272 "Convert LIST into a Texinfo list.
2273 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2274 with overruling parameters for `org-list-to-generic'."
2276 list
2286 params)))
2290 ;;; org-list.el ends here