| blob | 5f7963bb246943053a009833108d3152bfc620f5 |
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.
528 "Is point at a list item with REGEXP after bullet?"
532 ;; Ignore counter if any
538 "Return point at the beginning of next item at the same level.
539 Search items using function SEARCH-FUN, from POS to LIMIT. It
540 uses PRE-MOVE before search. Return nil if no item was found."
545 ;; We don't want to match the current line.
547 ;; Skip any sublist on the way
555 "Return number of blank lines that should separate items in list.
556 POS is the position of point to be considered.
558 TOP and BOTTOM are respectively position of list beginning and
559 list ending.
561 Assume point is at item's beginning. If the item is alone, apply
562 some heuristics to guess the result."
566 usr-blank)
568 ;; Trivial cases where there should be none.
570 org-empty-line-terminates-plain-lists)
572 ;; When `org-blank-before-new-entry' says so, it is 1.
574 ;; plain-list-item is 'auto. Count blank lines separating
575 ;; neighbours items in list.
578 ;; Is there a next item?
581 ;; Is there a previous item?
584 ;; User inserted blank lines, trust him
590 usr-blank)
591 ;; Are there blank lines inside the item ?
595 ;; No parent: no blank line.
599 "Insert a new list item at POS.
600 If POS is before first character after bullet of the item, the
601 new item will be created before the current one.
603 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
604 after the bullet. Cursor will be after this text once the
605 function ends."
607 ;; Is point in a special block?
612 ;; Rule in `org-list-automatic-rules' forbids insertion.
614 ;; Else, move before it prior to add a new item.
625 ;; Description item: text starts after colons.
627 ;; At a checkbox: text starts after it.
629 ;; Otherwise, text starts after bullet.
633 true-pos top bottom))
636 ;; insert bullet above item in order to avoid bothering
637 ;; with possible blank lines ending last item.
641 ;; Stay between after-bullet and before text.
645 ;; store bottom: exchanging items doesn't change list
646 ;; bottom point but will modify marker anyway
651 bottom)
652 ;; recompute next-item: last sexp modified list
655 ;; checkbox update might modify bottom point, so use a
656 ;; marker here
663 ;; Can't split item: insert bullet at the end of item.
666 ;; else, insert a new bullet along with everything from point
667 ;; down to last non-blank line of item.
670 ;; Get pos again in case previous command modified line.
677 ;; delete any blank line at and before point.
688 "Indent a local list item including its children.
689 When number ARG is a negative, item will be outdented, otherwise
690 it will be indented.
692 If a region is active, all items inside will be moved.
694 If NO-SUBTREE is non-nil, only indent the item itself, not its
695 children.
697 TOP and BOTTOM are respectively position at item beginning and at
698 item ending.
700 Return t if successful."
712 ;; Are we going to move the whole list?
716 ;; Determine begin and end points of zone to indent. If moving
717 ;; more than one item, ensure we keep them on subsequent moves.
731 ;; Get everything ready
739 ;; Special case: moving top-item with indent rule
746 ;; Change bullet if necessary
751 ;; Shift ancestor
756 ;; Forbidden move
768 ;; Normal shifting
776 ;;; Predicates
779 "Is the cursor inside a plain list?
780 This checks `org-list-ending-method'."
787 prev-head)
798 "Is this item the first item in a plain list?
799 Assume point is at an item.
801 TOP is the position of list's top-item."
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?"
833 "Is the current checkbox blocked from for being checked now?
834 A checkbox is blocked if all of the following conditions are fulfilled:
836 1. The checkbox is not checked already.
837 2. The current entry has the ORDERED property set.
838 3. There is an unchecked checkbox in this entry before the current line."
844 ;; the box is already checked!
854 ;;; Navigate
856 ;; Every interactive navigation function is derived from a
857 ;; non-interactive one, which doesn't move point, assumes point is
858 ;; already in a list and doesn't compute list boundaries.
860 ;; If you plan to use more than one org-list function is some code,
861 ;; you should therefore first check if point is in a list with
862 ;; `org-in-item-p' or `org-at-item-p', then compute list boundaries
863 ;; with `org-list-top-point' and `org-list-bottom-point', and make use
864 ;; of non-interactive forms.
867 "Return point at the top level in a list.
868 Assume point is in a list."
874 prev-head)
885 "Return point just before list ending.
886 Assume point is in a list."
889 ;; Use default regexp because folding
890 ;; changes OUTLINE-REGEXP.
895 next-head
906 "Return position of current item beginning."
908 ;; possibly match current line
914 "Go to the beginning of the current hand-formatted item.
915 If the cursor is not in an item, throw an error."
922 "Return position of the first item of the current list or sublist.
923 TOP is the position at list beginning."
931 "Go to the beginning item of the current list or sublist.
932 Return an error if not in a list."
939 "Return position at the end of the current list or sublist.
940 BOTTOM is the position at list ending."
950 "Go to the end of the current list or sublist.
951 If the cursor in not in an item, throw an error."
958 "Return position at the end of the current item.
959 BOTTOM is the position at list ending."
964 "Go to the end of the current hand-formatted item.
965 If the cursor is not in an item, throw an error."
972 "Move to the end of the item, stops before the first child if any.
973 BOTTOM is the position at list ending."
981 "Return point at end of item, before any blank line.
982 Point returned is at eol.
984 BOTTOM is the position at list ending."
991 "Return point of the previous item at the same level as POS.
992 Stop searching at LIMIT. Return nil if no item is found."
997 "Move to the beginning of the previous item.
998 Item is at the same level in the current plain list. Error if not
999 in a plain list, or if this is the first item in the list."
1007 "Return point of the next item at the same level as POS.
1008 Stop searching at LIMIT. Return nil if no item is found."
1013 "Move to the beginning of the next item.
1014 Item is at the same level in the current plain list. Error if not
1015 in a plain list, or if this is the last item in the list."
1022 ;;; Manipulate
1025 "Swap item starting at BEG-A with item starting at BEG-B.
1026 Blank lines at the end of items are left in place. Assume BEG-A
1027 is lesser than BEG-B.
1029 BOTTOM is the position at list ending."
1045 "Move the plain list item at point down, i.e. swap with following item.
1046 Subitems (items with larger indentation) are considered part of the item,
1047 so this really moves item trees."
1066 "Move the plain list item at point up, i.e. swap with previous item.
1067 Subitems (items with larger indentation) are considered part of the item,
1068 so this really moves item trees."
1087 "Insert a new item at the current level.
1088 If cursor is before first character after bullet of the item, the
1089 new item will be created before the current one.
1091 If CHECKBOX is non-nil, add a checkbox next to the bullet.
1093 Return t when things worked, nil when we are not in an item, or
1094 item is invisible."
1102 ;; Timer list: delegate to `org-timer-item'.
1104 ;; if we're in a description list, ask for the new term.
1109 ;; Don't insert a checkbox if checkbox rule is applied and it
1110 ;; is a description item.
1115 desc-text)))))
1117 ;;; Structures
1119 ;; The idea behind structures is to avoid moving back and forth in the
1120 ;; buffer on costly operations like indenting or fixing bullets.
1122 ;; It achieves this by taking a snapshot of an interesting part of the
1123 ;; list, in the shape of an alist, using `org-list-struct'.
1125 ;; It then proceeds to changes directly on the alist, with the help of
1126 ;; and `org-list-struct-origins'. When those are done,
1127 ;; `org-list-struct-apply-struct' applies the changes to the buffer.
1130 "Return the structure association at point.
1131 It is a cons-cell whose key is point and values are indentation,
1132 bullet string and bullet counter, if any."
1146 "Return the structure containing the list between BEGIN and END.
1147 A structure is an alist where key is point of item and values
1148 are, in that order, indentation, bullet string and value of
1149 counter, if any. A structure contains every list and sublist that
1150 has items between BEGIN and END along with their common ancestor.
1151 If no such ancestor can be found, the function will add a virtual
1152 ancestor at position 0.
1154 TOP and BOTTOM are respectively the position of list beginning
1155 and list ending.
1157 If OUTDENT is non-nil, it will also grab all of the parent list
1158 and the grand-parent. Setting OUTDENT to t is mandatory when next
1159 change is an outdent."
1167 pre-list post-list)
1169 ;; Find beginning of most outdented list (min list)
1171 org-item-beginning-re top t)
1174 pre-list)))
1175 ;; Now get the parent. If none, add a virtual ancestor
1178 pre-list))
1180 pre-list)))
1181 ;; Find end of min list
1188 post-list)))
1189 ;; Is list is malformed? If some items are less
1190 ;; indented that top-item, add them anyhow.
1194 org-item-beginning-re bottom t)
1196 post-list))))
1198 ;; Here we start: first get the core zone...
1202 ;; ... then, extend it to make it a structure...
1204 ;; ... twice when OUTDENT is non-nil and struct still can be
1205 ;; extended
1208 extended)))))
1211 "Return an alist where key is item's position and value parent's.
1212 STRUCT is the list's structure looked up."
1223 ;; List closing.
1226 ;; needed if top-point is
1227 ;; not the most outdented
1231 ;; New list
1236 ;; Current list going on
1241 "Return parent association of ITEM in STRUCT or nil.
1242 ORIGINS is the alist of parents. See `org-list-struct-origins'."
1247 "Return child association of ITEM in STRUCT or nil."
1253 "Verify and correct bullets for every association in STRUCT.
1254 ORIGINS is the alist of parents. See `org-list-struct-origins'.
1256 This function modifies STRUCT."
1273 bullet))))
1279 ;; Continuing previous list
1284 ;; A new list is starting
1289 acc))))))))
1293 "Verify and correct indentation for every association in STRUCT.
1294 ORIGINS is the alist of parents. See `org-list-struct-origins'.
1296 This function modifies STRUCT."
1304 ;; Indent like parent + length of parent's bullet
1307 ;; If no parent, indent like top-point
1312 "Return STRUCT with correct bullets and indentation.
1313 ORIGINS is the alist of parents. See `org-list-struct-origins'.
1315 Only elements of STRUCT that have changed are returned."
1322 "Outdent items in a structure.
1323 Items are indented when their key is between START, included, and
1324 END, excluded.
1326 ORIGINS is the alist of parents. See `org-list-struct-origins'.
1328 STRUCT is the concerned structure."
1334 ;; Item not yet in zone: keep association
1336 ;; Item out of zone: follow associations in acc
1340 ;; Item has no parent: error
1343 ;; Parent is outdented: keep association
1347 ;; Parent isn't outdented: reparent to grand-parent
1354 "Indent items in a structure.
1355 Items are indented when their key is between START, included, and
1356 END, excluded.
1358 ORIGINS is the alist of parents. See `org-list-struct-origins'.
1360 STRUCT is the concerned structure. It may be modified if
1361 `org-list-demote-modify-bullet' matches bullets between START and
1362 END."
1377 ;; new bullet is stored without space to ensure item
1378 ;; will be modified
1381 new-bul-p
1388 ;; Item not yet in zone: keep association
1391 ;; Item out of zone: follow associations in acc
1395 ;; Item is in zone...
1397 ;; Check if bullet needs to be changed
1400 ;; First item indented but not parent: error
1403 ;; First item and parent indented: keep same parent
1406 ;; Previous item not indented: reparent to it
1409 ;; Previous item indented: reparent like it
1416 "Apply modifications to list so it mirrors STRUCT.
1417 BOTTOM is position at list ending.
1419 Initial position is restored after the changes."
1433 ;; 1. Shift item's body
1437 ;; 2. Replace bullet
1442 ;; 3. Indent item to appropriate column
1449 ;; Remove ancestor if it is left.
1452 struct)))
1453 ;; Apply changes from bottom to top
1457 ;;; Indentation
1460 "What indentation has S due to SPACE and TAB at the beginning of the string?"
1468 i))
1471 "Shift the indentation in current item by DELTA.
1472 Sub-items are not moved.
1474 BOTTOM is position at list ending."
1481 ;; this is not an empty line
1488 "Outdent a local list item, but not its children.
1489 If a region is active, all items inside will be moved."
1495 "Indent a local list item, but not its children.
1496 If a region is active, all items inside will be moved."
1502 "Outdent a local list item including its children.
1503 If a region is active, all items inside will be moved."
1509 "Indent a local list item including its children.
1510 If a region is active, all items inside will be moved."
1517 "Cycle levels of indentation of an empty item.
1518 The first run indent the item, if applicable. Subsequents runs
1519 outdent it at meaningful levels in the list. When done, item is
1520 put back at its original position with its original bullet.
1522 Return t at each successful move."
1529 ;; Check that item is really empty
1536 ;; When in the middle of the cycle, try to outdent first. If it
1537 ;; fails, and point is still at initial position, indent. Else,
1538 ;; go back to original position.
1549 ;; Break cycle
1551 ;; If a cycle is starting, remember indentation and bullet,
1552 ;; then try to indent. If it fails, try to outdent.
1558 t)))
1560 ;;; Bullets
1563 "Return the bullet of the item at point.
1564 Assume cursor is at an item."
1570 "Return BULLET with the correct number of whitespaces.
1571 It determines the number of whitespaces to append by looking at
1572 `org-list-two-spaces-after-bullet-regexp'."
1578 " "
1579 ;; Do we need to concat another white space ?
1586 "Increment BULLET if applicable."
1590 nil nil bullet)
1591 bullet))
1594 "Make sure all items are correctly indented, with the right bullet.
1595 This function scans the list at point, along with any sublist.
1597 If FORCE-BULLET is a string, ensure all items in list share this
1598 bullet, or a logical successor in the case of an ordered list.
1600 When non-nil, TOP and BOTTOM specify respectively position of
1601 list beginning and list ending.
1603 Item's body is not indented, only shifted with the bullet."
1611 fixed-struct)
1623 "Cycle through the different itemize/enumerate bullets.
1624 This cycle the entire list level through the sequence:
1626 `-' -> `+' -> `*' -> `1.' -> `1)'
1628 If WHICH is a valid string, use that as the new bullet. If WHICH
1629 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
1630 'previous, cycle backwards."
1642 ;; *-bullets are not allowed at column 0
1645 ;; Description items cannot be numbered
1662 ;;; Checkboxes
1665 "Toggle the checkbox in the current line.
1666 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
1667 double prefix, set checkbox to [-].
1669 When there is an active region, toggle status or presence of the
1670 first checkbox there, and make every item inside have the
1671 same status or presence, respectively.
1673 If the cursor is in a headline, apply this to all checkbox items
1674 in the text below the heading, taking as reference the first item
1675 in subtree, ignoring drawers."
1677 ;; Bounds is a list of type (beg end single-p) where single-p is t
1678 ;; when `org-toggle-checkbox' is applied to a single item. Only
1679 ;; toggles on single items will return errors.
1691 ;; In this case, reference line is the first item in
1692 ;; subtree outside drawers
1705 ;; marker is needed because deleting or inserting checkboxes
1706 ;; will change bottom point
1723 ;; Ignore counter, if any
1751 "Reset all checkboxes in an entry subtree."
1766 "Hook that is run whenever Org thinks checkbox statistics should be updated.
1767 This hook runs even if checkbox rule in
1768 `org-list-automatic-rules' does not apply, so it can be used to
1769 implement alternative ways of collecting statistics
1773 "Update checkbox statistics unless turned off by user."
1779 "Update the checkbox statistics in the current section.
1780 This will find all statistic cookies like [57%] and [6/12] and update them
1781 with the current numbers. With optional prefix argument ALL, do this for
1782 the whole buffer."
1795 (re-box "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
1796 beg-cookie end-cookie is-percent c-on c-off lim new
1797 curr-ind next-ind continue-from startsearch list-beg list-end
1805 ;; find each statistics cookie
1822 ;; Ensure many cookies in the same list won't imply
1823 ;; computing list boundaries as many times.
1831 c-on 0
1834 ;; find first checkbox for this cookie and gather
1835 ;; statistics from all that are at this indentation level
1851 ;; org-get-next-item goes through list-enders
1852 ;; with proper limit.
1856 org-item-beginning-re lim t)
1860 ;; update cookie
1869 ;; update items checkbox if it has one
1886 "Select the face for checkbox statistics.
1887 The face will be `org-done' when all relevant boxes are checked.
1888 Otherwise it will be `org-todo'."
1891 'org-checkbox-statistics-done
1895 'org-checkbox-statistics-done
1898 ;;; Misc Tools
1901 "Call FUNCTION on each item of the list at point.
1902 FUNCTION must be called with at least one argument: INIT-VALUE,
1903 that will contain the value returned by the function at the
1904 previous item, plus ARGS extra arguments.
1906 As an example, (org-apply-on-list (lambda (result) (1+ result)) 0)
1907 will return the number of items in the current list.
1909 Sublists of the list are skipped. Cursor is always at the
1910 beginning of the item."
1920 value))
1923 "Sort plain list items.
1924 The cursor may be at any item of the list that should be sorted.
1925 Sublists are not sorted. Checkboxes, if any, are ignored.
1927 Sorting can be alphabetically, numerically, by date/time as given by
1928 a time stamp, by a property or by priority.
1930 Comparing entries ignores case by default. However, with an
1931 optional argument WITH-CASE, the sorting considers case as well.
1933 The command prompts for the sorting type unless it has been given
1934 to the function through the SORTING-TYPE argument, which needs to
1935 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
1936 meaning of each character:
1938 n Numerically, by converting the beginning of the item to a number.
1939 a Alphabetically. Only the first line of item is checked.
1940 t By date/time, either the first active time stamp in the entry, if
1941 any, or by the first inactive one. In a timer list, sort the timers.
1943 Capital letters will reverse the sort order.
1945 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a
1946 function to be called with point at the beginning of the record.
1947 It must return either a string or a number that should serve as
1948 the sorting key for that record. It will then use COMPARE-FUNC to
1949 compare entries."
1993 ;; If it is a timer list, convert timer to seconds
2007 value))
2011 begin-record
2012 end-record
2013 value-to-sort
2014 nil
2015 sort-func)
2020 ;;; Send and receive lists
2023 "Parse the list at point and maybe DELETE it.
2024 Return a list containing first level items as strings and
2025 sublevels as a list of strings."
2028 output itemsep ltype)
2042 item)
2044 "CBOFF"
2047 item)))
2063 "Convert the plain list at point into a subtree."
2077 "Convert LIST into subtrees starting at LEVEL."
2086 list)))
2089 "Insert a radio list template appropriate for this major mode."
2093 name pos)
2104 "Send a transformed version of this list to the receiver position.
2105 With argument MAYBE, fail quietly if no transformation is defined for
2106 this list."
2112 (unless (looking-at "[ \t]*#\\+ORGLST[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
2131 beg txt)
2135 ;; Find the insertion place
2140 name
2154 "Convert a LIST parsed through `org-list-parse-list' to other formats.
2155 Valid parameters PARAMS are
2157 :ustart String to start an unordered list
2158 :uend String to end an unordered list
2160 :ostart String to start an ordered list
2161 :oend String to end an ordered list
2163 :dstart String to start a descriptive list
2164 :dend String to end a descriptive list
2165 :dtstart String to start a descriptive term
2166 :dtend String to end a descriptive term
2167 :ddstart String to start a description
2168 :ddend String to end a description
2170 :splice When set to t, return only list body lines, don't wrap
2171 them into :[u/o]start and :[u/o]end. Default is nil.
2173 :istart String to start a list item
2174 :iend String to end a list item
2175 :isep String to separate items
2176 :lsep String to separate sublists
2178 :cboff String to insert for an unchecked checkbox
2179 :cbon String to insert for a checked checkbox"
2206 rtn term defstart defend)
2216 ddend)))
2225 lsep ;; list separator
2227 lsep ;; list separator
2228 )))))
2232 "Convert LIST into a LaTeX list.
2233 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2234 with overruling parameters for `org-list-to-generic'."
2236 list
2246 params)))
2249 "Convert LIST into a HTML list.
2250 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2251 with overruling parameters for `org-list-to-generic'."
2253 list
2263 params)))
2266 "Convert LIST into a Texinfo list.
2267 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2268 with overruling parameters for `org-list-to-generic'."
2270 list
2280 params)))
2284 ;; arch-tag: 73cf50c1-200f-4d1d-8a53-4e842a5b11c8
2285 ;;; org-list.el ends here