| blob | abbaa5f98a7553c6ee40bec4e3c437a8cdc65605 |
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.3
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 ;;; Code:
70 "Options concerning plain lists in Org-mode."
75 "When t, make TAB cycle visibility on plain list items.
76 Cycling plain lists works only when the cursor is on a plain list
77 item. When the cursor is on an outline heading, plain lists are
78 treated as text. This is the most stable way of handling this,
79 which is why it is the default.
81 When this is the symbol `integrate', then during cycling, plain
82 list items will *temporarily* be interpreted as outline headlines
83 with a level given by 1000+i where i is the indentation of the
84 bullet. This setting can lead to strange effects when switching
86 subtree decides what children should be listed. If that first
88 number, all true children and grand children of the outline
89 heading will be exposed in a children' view."
97 "Default bullet type installed when demoting an item.
98 This is an association list, for each bullet type, this alist will point
99 to the bullet that should be used when this item is demoted.
100 For example,
102 (setq org-list-demote-modify-bullet
105 will make
107 + Movies
108 + Silence of the Lambs
109 + My Cousin Vinny
110 + Books
111 + The Hunt for Red October
112 + The Road to Omaha
114 into
116 + Movies
117 - Silence of the Lambs
118 - My Cousin Vinny
119 + Books
120 - The Hunt for Red October
121 - The Road to Omaha"
139 "The character that makes a line with leading number an ordered list item.
140 Valid values are ?. and ?\). To get both terminators, use t. While
141 ?. may look nicer, it creates the danger that a line with leading
142 number may be incorrectly interpreted as an item. ?\) therefore is
143 the safe choice."
150 "A regular expression matching bullets that should have 2 spaces after them.
151 When nil, no bullet will have two spaces after them.
152 When a string, it will be used as a regular expression. When the
153 bullet type of a list is changed, the new bullet type will be
154 matched against this regexp. If it matches, there will be two
155 spaces instead of one after the bullet in each item of the list."
162 "Determine where plain lists should end.
163 Valid values are: `regexp', `indent' or `both'.
165 When set to `regexp', Org will look into two variables,
166 `org-empty-line-terminates-plain-lists' and the more general
167 `org-list-end-regexp', to determine what will end lists. This is
168 the fastest method.
170 When set to `indent', a list will end whenever a line following
171 an item, but not starting one, is less or equally indented than
172 it.
174 When set to `both', each of the preceding methods is applied to
175 determine lists endings. This is the default method."
183 "Non-nil means an empty line ends all plain list levels.
184 This variable only makes sense if `org-list-ending-method' is set
185 to `regexp' or `both'. This is then equivalent to set
191 "Regexp matching the end of all plain list levels.
193 blank lines. `org-empty-line-terminates-plain-lists' has
194 precedence over it."
202 "Non-nil means apply set of rules when acting on lists.
203 By default, automatic actions are taken when using
208 rules by setting them to nil. Valid rules are:
210 bullet when non-nil, cycling bullet do not allow lists at
211 column 0 to have * as a bullet and descriptions lists
212 to be numbered.
213 checkbox when non-nil, checkbox statistics is updated each time
214 you either insert a new checkbox or toggle a checkbox.
215 It also prevents from inserting a checkbox in a
216 description item.
217 indent when non-nil, indenting or outdenting list top-item
218 with its subtree will move the whole list and
219 outdenting a list whose bullet is * to column 0 will
220 change that bullet to -
221 insert when non-nil, trying to insert an item inside a block
222 will insert it right before the block instead of
223 throwing an error."
226 :key-type
232 :value-type
236 "Non-nil means checkbox statistics counts only the state of direct children.
237 When nil, all boxes below the cookie are counted.
238 This can be set to nil on a per-node basis using a COOKIE_DATA property
244 "Maximum indentation for the second line of a description list.
245 When the indentation would be larger than this, it will become
246 5 characters instead."
252 % END RECEIVE ORGLST %n
254 #+ORGLST: SEND %n org-list-to-latex
255 -
258 @c END RECEIVE ORGLST %n
259 @ignore
260 #+ORGLST: SEND %n org-list-to-texinfo
261 -
264 <!-- END RECEIVE ORGLST %n -->
265 <!--
266 #+ORGLST: SEND %n org-list-to-html
267 -
269 "Templates for radio lists in different major modes.
270 All occurrences of %n in a template will be replaced with the name of the
271 list, obtained by prompting the user."
277 ;;; Internal functions
280 "Return the regex corresponding to the end of a list.
281 It depends on `org-empty-line-terminates-plain-lists'."
284 org-list-end-regexp))
287 "Return the correct regular expression for plain lists.
288 If GENERAL is non-nil, return the general regexp independent of the value
289 of `org-plain-list-ordered-item-terminator'."
303 "Find the position of a list ending between MIN and MAX, or nil.
304 This function looks for `org-list-end-re' outside a block.
306 If FIRSTP in non-nil, return the point at the beginning of the
307 nearest valid terminator from MIN. Otherwise, return the point at
308 the end of the nearest terminator from MAX."
313 #'org-search-forward-unenclosed
318 ;; Is there a valid list ending somewhere ?
320 ;; we want to be on the first line of the list ender
324 "Return non-nil value if point is in a block, skipping it on the way.
325 It looks for the boundary of the block in SEARCH direction,
326 stopping at LIMIT."
333 ;; We're in a block: get out of it
337 "Search a string outside blocks and protected places.
338 Arguments SEARCH, RE, BOUND and NOERR are similar to those in
339 `search-forward', `search-backward', `re-search-forward' and
340 `re-search-backward'."
344 ;; 1. No match: return to origin or bound, depending on NOERR.
347 nil)))
348 ;; 2. Match not in block or protected: return point. Else
349 ;; skip the block and carry on.
355 "Like `re-search-backward' but don't stop inside blocks or protected places.
356 Arguments REGEXP, BOUND and NOERROR are similar to those used in
357 `re-search-backward'."
362 "Like `re-search-forward' but don't stop inside blocks or protected places.
363 Arguments REGEXP, BOUND and NOERROR are similar to those used in
364 `re-search-forward'."
369 "Is the cursor inside a plain list?
370 Plain lists are considered ending when a non-blank line is less
371 indented than the previous item within LIMIT."
375 ;; do not start searching inside a block...
377 ;; ... or at a blank line
385 ;; Ensure there is at least an item above
388 org-item-beginning-re limit t))))
405 "Is the cursor inside a plain list?
406 Plain lists end when `org-list-end-regexp' is matched, or at a
407 blank line if `org-empty-line-terminates-plain-lists' is true.
409 Argument LIMIT specifies the upper-bound of the search."
412 ;; Moved to eol so current line can be matched by
413 ;; `org-item-re'.
416 org-item-beginning-re limit t)))
418 last-item-start actual-pos)))
419 ;; We are in a list when we are on an item line or when we can
420 ;; find an item before point and there is no valid list ender
421 ;; between it and the point.
425 "Return point at the top level item in a list.
426 Argument LIMIT specifies the upper-bound of the search.
428 List ending is determined by regexp. See
429 `org-list-ending-method'. for more information."
432 ;; Is there some list above this one ? If so, go to its ending.
433 ;; Otherwise, go back to the heading above or bob.
435 ;; From there, search down our list.
440 "Return point just before list ending.
441 Argument LIMIT specifies the lower-bound of the search.
443 List ending is determined by regexp. See
444 `org-list-ending-method'. for more information."
447 ;; The list ending is either first point matching
448 ;; `org-list-end-re', point at first white-line before next
449 ;; heading, or eob.
453 "Return point at the top level in a list.
454 Argument LIMIT specifies the upper-bound of the search.
456 List ending is determined by indentation of text. See
457 `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
510 ;; Ensure bottom is just after a
511 ;; non-blank line.
522 ;; Again, ensure bottom is just after a
523 ;; non-blank line.
532 "Is point at a list item with REGEXP after bullet?"
536 ;; Ignore counter if any
542 "Return point at the beginning of next item at the same level.
543 Search items using function SEARCH-FUN, from POS to LIMIT. It
544 uses PRE-MOVE before search. Return nil if no item was found."
549 ;; We don't want to match the current line.
551 ;; Skip any sublist on the way
559 "Return number of blank lines that should separate items in list.
560 POS is the position of point to be considered.
562 TOP and BOTTOM are respectively position of list beginning and
563 list ending.
565 Assume point is at item's beginning. If the item is alone, apply
566 some heuristics to guess the result."
570 usr-blank)
572 ;; Trivial cases where there should be none.
574 org-empty-line-terminates-plain-lists)
576 ;; When `org-blank-before-new-entry' says so, it is 1.
578 ;; plain-list-item is 'auto. Count blank lines separating
579 ;; neighbours items in list.
582 ;; Is there a next item?
585 ;; Is there a previous item?
588 ;; User inserted blank lines, trust him
594 usr-blank)
595 ;; Are there blank lines inside the item ?
599 ;; No parent: no blank line.
603 "Insert a new list item at POS.
604 If POS is before first character after bullet of the item, the
605 new item will be created before the current one.
607 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
608 after the bullet. Cursor will be after this text once the
609 function ends."
611 ;; Is point in a special block?
616 ;; Rule in `org-list-automatic-rules' forbids insertion.
618 ;; Else, move before it prior to add a new item.
629 ;; Description item: text starts after colons.
631 ;; At a checkbox: text starts after it.
633 ;; Otherwise, text starts after bullet.
637 true-pos top bottom))
640 ;; insert bullet above item in order to avoid bothering
641 ;; with possible blank lines ending last item.
645 ;; Stay between after-bullet and before text.
649 ;; store bottom: exchanging items doesn't change list
650 ;; bottom point but will modify marker anyway
655 bottom)
656 ;; recompute next-item: last sexp modified list
659 ;; checkbox update might modify bottom point, so use a
660 ;; marker here
667 ;; Can't split item: insert bullet at the end of item.
670 ;; else, insert a new bullet along with everything from point
671 ;; down to last non-blank line of item.
674 ;; Get pos again in case previous command modified line.
681 ;; delete any blank line at and before point.
692 "Indent a local list item including its children.
693 When number ARG is a negative, item will be outdented, otherwise
694 it will be indented.
696 If a region is active, all items inside will be moved.
698 If NO-SUBTREE is non-nil, only indent the item itself, not its
699 children.
701 TOP and BOTTOM are respectively position at item beginning and at
702 item ending.
704 Return t if successful."
716 ;; Are we going to move the whole list?
720 ;; Determine begin and end points of zone to indent. If moving
721 ;; more than one item, ensure we keep them on subsequent moves.
735 ;; Get everything ready
743 ;; Special case: moving top-item with indent rule
750 ;; Change bullet if necessary
755 ;; Shift ancestor
760 ;; Forbidden move
772 ;; Normal shifting
780 ;;; Predicates
783 "Is the cursor inside a plain list?
784 This checks `org-list-ending-method'."
791 prev-head)
802 "Is this item the first item in a plain list?
803 Assume point is at an item.
805 TOP is the position of list's top-item."
813 "Is point in a line starting a hand-formatted item?"
818 "Is point at the bullet of a plain list item?"
824 "Is point at a line starting a plain list item with a timer?"
829 "Is point at a description list item?"
833 "Is point at a line starting a plain-list item with a checklet?"
837 "Is the current checkbox blocked from for being checked now?
838 A checkbox is blocked if all of the following conditions are fulfilled:
840 1. The checkbox is not checked already.
841 2. The current entry has the ORDERED property set.
842 3. There is an unchecked checkbox in this entry before the current line."
848 ;; the box is already checked!
858 ;;; Navigate
860 ;; Every interactive navigation function is derived from a
861 ;; non-interactive one, which doesn't move point, assumes point is
862 ;; already in a list and doesn't compute list boundaries.
864 ;; If you plan to use more than one org-list function is some code,
865 ;; you should therefore first check if point is in a list with
866 ;; `org-in-item-p' or `org-at-item-p', then compute list boundaries
867 ;; with `org-list-top-point' and `org-list-bottom-point', and make use
868 ;; of non-interactive forms.
871 "Return point at the top level in a list.
872 Assume point is in a list."
878 prev-head)
889 "Return point just before list ending.
890 Assume point is in a list."
893 ;; Use default regexp because folding
894 ;; changes OUTLINE-REGEXP.
899 next-head
910 "Return position of current item beginning."
912 ;; possibly match current line
918 "Go to the beginning of the current hand-formatted item.
919 If the cursor is not in an item, throw an error."
926 "Return position of the first item of the current list or sublist.
927 TOP is the position at list beginning."
935 "Go to the beginning item of the current list or sublist.
936 Return an error if not in a list."
943 "Return position at the end of the current list or sublist.
944 BOTTOM is the position at list ending."
954 "Go to the end of the current list or sublist.
955 If the cursor in not in an item, throw an error."
962 "Return position at the end of the current item.
963 BOTTOM is the position at list ending."
968 "Go to the end of the current hand-formatted item.
969 If the cursor is not in an item, throw an error."
976 "Move to the end of the item, stops before the first child if any.
977 BOTTOM is the position at list ending."
985 "Return point at end of item, before any blank line.
986 Point returned is at eol.
988 BOTTOM is the position at list ending."
995 "Return point of the previous item at the same level as POS.
996 Stop searching at LIMIT. Return nil if no item is found."
1001 "Move to the beginning of the previous item.
1002 Item is at the same level in the current plain list. Error if not
1003 in a plain list, or if this is the first item in the list."
1011 "Return point of the next item at the same level as POS.
1012 Stop searching at LIMIT. Return nil if no item is found."
1017 "Move to the beginning of the next item.
1018 Item is at the same level in the current plain list. Error if not
1019 in a plain list, or if this is the last item in the list."
1026 ;;; Manipulate
1029 "Swap item starting at BEG-A with item starting at BEG-B.
1030 Blank lines at the end of items are left in place. Assume BEG-A
1031 is lesser than BEG-B.
1033 BOTTOM is the position at list ending."
1049 "Move the plain list item at point down, i.e. swap with following item.
1050 Subitems (items with larger indentation) are considered part of the item,
1051 so this really moves item trees."
1070 "Move the plain list item at point up, i.e. swap with previous item.
1071 Subitems (items with larger indentation) are considered part of the item,
1072 so this really moves item trees."
1091 "Insert a new item at the current level.
1092 If cursor is before first character after bullet of the item, the
1093 new item will be created before the current one.
1095 If CHECKBOX is non-nil, add a checkbox next to the bullet.
1097 Return t when things worked, nil when we are not in an item, or
1098 item is invisible."
1106 ;; Timer list: delegate to `org-timer-item'.
1108 ;; if we're in a description list, ask for the new term.
1113 ;; Don't insert a checkbox if checkbox rule is applied and it
1114 ;; is a description item.
1119 desc-text)))))
1121 ;;; Structures
1123 ;; The idea behind structures is to avoid moving back and forth in the
1124 ;; buffer on costly operations like indenting or fixing bullets.
1126 ;; It achieves this by taking a snapshot of an interesting part of the
1127 ;; list, in the shape of an alist, using `org-list-struct'.
1129 ;; It then proceeds to changes directly on the alist, with the help of
1130 ;; and `org-list-struct-origins'. When those are done,
1131 ;; `org-list-struct-apply-struct' applies the changes to the buffer.
1134 "Return the structure association at point.
1135 It is a cons-cell whose key is point and values are indentation,
1136 bullet string and bullet counter, if any."
1150 "Return the structure containing the list between BEGIN and END.
1151 A structure is an alist where key is point of item and values
1152 are, in that order, indentation, bullet string and value of
1153 counter, if any. A structure contains every list and sublist that
1154 has items between BEGIN and END along with their common ancestor.
1155 If no such ancestor can be found, the function will add a virtual
1156 ancestor at position 0.
1158 TOP and BOTTOM are respectively the position of list beginning
1159 and list ending.
1161 If OUTDENT is non-nil, it will also grab all of the parent list
1162 and the grand-parent. Setting OUTDENT to t is mandatory when next
1163 change is an outdent."
1171 pre-list post-list)
1173 ;; Find beginning of most outdented list (min list)
1175 org-item-beginning-re top t)
1178 pre-list)))
1179 ;; Now get the parent. If none, add a virtual ancestor
1182 pre-list))
1184 pre-list)))
1185 ;; Find end of min list
1192 post-list)))
1193 ;; Is list is malformed? If some items are less
1194 ;; indented that top-item, add them anyhow.
1198 org-item-beginning-re bottom t)
1200 post-list))))
1202 ;; Here we start: first get the core zone...
1206 ;; ... then, extend it to make it a structure...
1208 ;; ... twice when OUTDENT is non-nil and struct still can be
1209 ;; extended
1212 extended)))))
1215 "Return an alist where key is item's position and value parent's.
1216 STRUCT is the list's structure looked up."
1227 ;; List closing.
1230 ;; needed if top-point is
1231 ;; not the most outdented
1235 ;; New list
1240 ;; Current list going on
1245 "Return parent association of ITEM in STRUCT or nil.
1246 ORIGINS is the alist of parents. See `org-list-struct-origins'."
1251 "Return child association of ITEM in STRUCT or nil."
1257 "Verify and correct bullets for every association in STRUCT.
1258 ORIGINS is the alist of parents. See `org-list-struct-origins'.
1260 This function modifies STRUCT."
1277 bullet))))
1283 ;; Continuing previous list
1288 ;; A new list is starting
1293 acc))))))))
1297 "Verify and correct indentation for every association in STRUCT.
1298 ORIGINS is the alist of parents. See `org-list-struct-origins'.
1300 This function modifies STRUCT."
1308 ;; Indent like parent + length of parent's bullet
1311 ;; If no parent, indent like top-point
1316 "Return STRUCT with correct bullets and indentation.
1317 ORIGINS is the alist of parents. See `org-list-struct-origins'.
1319 Only elements of STRUCT that have changed are returned."
1326 "Outdent items in a structure.
1327 Items are indented when their key is between START, included, and
1328 END, excluded.
1330 ORIGINS is the alist of parents. See `org-list-struct-origins'.
1332 STRUCT is the concerned structure."
1338 ;; Item not yet in zone: keep association
1340 ;; Item out of zone: follow associations in acc
1344 ;; Item has no parent: error
1347 ;; Parent is outdented: keep association
1351 ;; Parent isn't outdented: reparent to grand-parent
1358 "Indent items in a structure.
1359 Items are indented when their key is between START, included, and
1360 END, excluded.
1362 ORIGINS is the alist of parents. See `org-list-struct-origins'.
1364 STRUCT is the concerned structure. It may be modified if
1365 `org-list-demote-modify-bullet' matches bullets between START and
1366 END."
1381 ;; new bullet is stored without space to ensure item
1382 ;; will be modified
1385 new-bul-p
1392 ;; Item not yet in zone: keep association
1395 ;; Item out of zone: follow associations in acc
1399 ;; Item is in zone...
1401 ;; Check if bullet needs to be changed
1404 ;; First item indented but not parent: error
1407 ;; First item and parent indented: keep same parent
1410 ;; Previous item not indented: reparent to it
1413 ;; Previous item indented: reparent like it
1420 "Apply modifications to list so it mirrors STRUCT.
1421 BOTTOM is position at list ending.
1423 Initial position is restored after the changes."
1437 ;; 1. Shift item's body
1441 ;; 2. Replace bullet
1446 ;; 3. Indent item to appropriate column
1453 ;; Remove ancestor if it is left.
1456 struct)))
1457 ;; Apply changes from bottom to top
1461 ;;; Indentation
1464 "What indentation has S due to SPACE and TAB at the beginning of the string?"
1472 i))
1475 "Shift the indentation in current item by DELTA.
1476 Sub-items are not moved.
1478 BOTTOM is position at list ending."
1485 ;; this is not an empty line
1492 "Outdent a local list item, but not its children.
1493 If a region is active, all items inside will be moved."
1499 "Indent a local list item, but not its children.
1500 If a region is active, all items inside will be moved."
1506 "Outdent a local list item including its children.
1507 If a region is active, all items inside will be moved."
1513 "Indent a local list item including its children.
1514 If a region is active, all items inside will be moved."
1521 "Cycle levels of indentation of an empty item.
1522 The first run indent the item, if applicable. Subsequents runs
1523 outdent it at meaningful levels in the list. When done, item is
1524 put back at its original position with its original bullet.
1526 Return t at each successful move."
1533 ;; Check that item is really empty
1540 ;; When in the middle of the cycle, try to outdent first. If it
1541 ;; fails, and point is still at initial position, indent. Else,
1542 ;; go back to original position.
1553 ;; Break cycle
1555 ;; If a cycle is starting, remember indentation and bullet,
1556 ;; then try to indent. If it fails, try to outdent.
1562 t)))
1564 ;;; Bullets
1567 "Return the bullet of the item at point.
1568 Assume cursor is at an item."
1574 "Return BULLET with the correct number of whitespaces.
1575 It determines the number of whitespaces to append by looking at
1576 `org-list-two-spaces-after-bullet-regexp'."
1582 " "
1583 ;; Do we need to concat another white space ?
1590 "Increment BULLET if applicable."
1594 nil nil bullet)
1595 bullet))
1598 "Make sure all items are correctly indented, with the right bullet.
1599 This function scans the list at point, along with any sublist.
1601 If FORCE-BULLET is a string, ensure all items in list share this
1602 bullet, or a logical successor in the case of an ordered list.
1604 When non-nil, TOP and BOTTOM specify respectively position of
1605 list beginning and list ending.
1607 Item's body is not indented, only shifted with the bullet."
1615 fixed-struct)
1627 "Cycle through the different itemize/enumerate bullets.
1628 This cycle the entire list level through the sequence:
1630 `-' -> `+' -> `*' -> `1.' -> `1)'
1632 If WHICH is a valid string, use that as the new bullet. If WHICH
1633 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
1634 'previous, cycle backwards."
1647 ;; *-bullets are not allowed at column 0
1650 ;; Description items cannot be numbered
1667 ;;; Checkboxes
1670 "Toggle the checkbox in the current line.
1671 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
1672 double prefix, set checkbox to [-].
1674 When there is an active region, toggle status or presence of the
1675 first checkbox there, and make every item inside have the
1676 same status or presence, respectively.
1678 If the cursor is in a headline, apply this to all checkbox items
1679 in the text below the heading, taking as reference the first item
1680 in subtree, ignoring drawers."
1682 ;; Bounds is a list of type (beg end single-p) where single-p is t
1683 ;; when `org-toggle-checkbox' is applied to a single item. Only
1684 ;; toggles on single items will return errors.
1696 ;; In this case, reference line is the first item in
1697 ;; subtree outside drawers
1710 ;; marker is needed because deleting or inserting checkboxes
1711 ;; will change bottom point
1728 ;; Ignore counter, if any
1756 "Reset all checkboxes in an entry subtree."
1771 "Hook that is run whenever Org thinks checkbox statistics should be updated.
1772 This hook runs even if checkbox rule in
1773 `org-list-automatic-rules' does not apply, so it can be used to
1774 implement alternative ways of collecting statistics
1778 "Update checkbox statistics unless turned off by user."
1784 "Update the checkbox statistics in the current section.
1785 This will find all statistic cookies like [57%] and [6/12] and update them
1786 with the current numbers. With optional prefix argument ALL, do this for
1787 the whole buffer."
1800 (re-box "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
1801 beg-cookie end-cookie is-percent c-on c-off lim new
1802 curr-ind next-ind continue-from startsearch list-beg list-end
1810 ;; find each statistics cookie
1827 ;; Ensure many cookies in the same list won't imply
1828 ;; computing list boundaries as many times.
1836 c-on 0
1839 ;; find first checkbox for this cookie and gather
1840 ;; statistics from all that are at this indentation level
1856 ;; org-get-next-item goes through list-enders
1857 ;; with proper limit.
1861 org-item-beginning-re lim t)
1865 ;; update cookie
1874 ;; update items checkbox if it has one
1891 "Select the face for checkbox statistics.
1892 The face will be `org-done' when all relevant boxes are checked.
1893 Otherwise it will be `org-todo'."
1896 'org-checkbox-statistics-done
1900 'org-checkbox-statistics-done
1903 ;;; Misc Tools
1906 "Call FUNCTION on each item of the list at point.
1907 FUNCTION must be called with at least one argument: INIT-VALUE,
1908 that will contain the value returned by the function at the
1909 previous item, plus ARGS extra arguments.
1911 As an example, (org-apply-on-list (lambda (result) (1+ result)) 0)
1912 will return the number of items in the current list.
1914 Sublists of the list are skipped. Cursor is always at the
1915 beginning of the item."
1925 value))
1928 "Sort plain list items.
1929 The cursor may be at any item of the list that should be sorted.
1930 Sublists are not sorted. Checkboxes, if any, are ignored.
1932 Sorting can be alphabetically, numerically, by date/time as given by
1933 a time stamp, by a property or by priority.
1935 Comparing entries ignores case by default. However, with an
1936 optional argument WITH-CASE, the sorting considers case as well.
1938 The command prompts for the sorting type unless it has been given
1939 to the function through the SORTING-TYPE argument, which needs to
1940 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
1941 meaning of each character:
1943 n Numerically, by converting the beginning of the item to a number.
1944 a Alphabetically. Only the first line of item is checked.
1945 t By date/time, either the first active time stamp in the entry, if
1946 any, or by the first inactive one. In a timer list, sort the timers.
1948 Capital letters will reverse the sort order.
1950 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a
1951 function to be called with point at the beginning of the record.
1952 It must return either a string or a number that should serve as
1953 the sorting key for that record. It will then use COMPARE-FUNC to
1954 compare entries."
1998 ;; If it is a timer list, convert timer to seconds
2012 value))
2016 begin-record
2017 end-record
2018 value-to-sort
2019 nil
2020 sort-func)
2025 ;;; Send and receive lists
2028 "Parse the list at point and maybe DELETE it.
2029 Return a list containing first level items as strings and
2030 sublevels as a list of strings."
2033 output itemsep ltype)
2047 item)
2049 "CBOFF"
2052 item)))
2068 "Convert the plain list at point into a subtree."
2082 "Convert LIST into subtrees starting at LEVEL."
2091 list)))
2094 "Insert a radio list template appropriate for this major mode."
2098 name pos)
2109 "Send a transformed version of this list to the receiver position.
2110 With argument MAYBE, fail quietly if no transformation is defined for
2111 this list."
2117 (unless (looking-at "[ \t]*#\\+ORGLST[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
2136 beg txt)
2140 ;; Find the insertion place
2145 name
2159 "Convert a LIST parsed through `org-list-parse-list' to other formats.
2160 Valid parameters PARAMS are
2162 :ustart String to start an unordered list
2163 :uend String to end an unordered list
2165 :ostart String to start an ordered list
2166 :oend String to end an ordered list
2168 :dstart String to start a descriptive list
2169 :dend String to end a descriptive list
2170 :dtstart String to start a descriptive term
2171 :dtend String to end a descriptive term
2172 :ddstart String to start a description
2173 :ddend String to end a description
2175 :splice When set to t, return only list body lines, don't wrap
2176 them into :[u/o]start and :[u/o]end. Default is nil.
2178 :istart String to start a list item
2179 :iend String to end a list item
2180 :isep String to separate items
2181 :lsep String to separate sublists
2183 :cboff String to insert for an unchecked checkbox
2184 :cbon String to insert for a checked checkbox"
2211 rtn term defstart defend)
2221 ddend)))
2230 lsep ;; list separator
2232 lsep ;; list separator
2233 )))))
2237 "Convert LIST into a LaTeX list.
2238 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2239 with overruling parameters for `org-list-to-generic'."
2241 list
2251 params)))
2254 "Convert LIST into a HTML list.
2255 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2256 with overruling parameters for `org-list-to-generic'."
2258 list
2268 params)))
2271 "Convert LIST into a Texinfo list.
2272 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2273 with overruling parameters for `org-list-to-generic'."
2275 list
2285 params)))
2289 ;; arch-tag: 73cf50c1-200f-4d1d-8a53-4e842a5b11c8
2290 ;;; org-list.el ends here