| blob | 516022455aef3e6154b58db84d00f72aed61f601 |
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.5
11 ;;
12 ;; This file is part of GNU Emacs.
13 ;;
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
27 ;;
28 ;;; Commentary:
30 ;; This file contains the code dealing with plain lists in Org-mode.
32 ;; The fundamental idea behind lists work is to use structures. A
33 ;; structure is a snapshot of the list, in the shape of data tree (see
34 ;; `org-list-struct').
36 ;; Once the list structure is stored, it is possible to make changes
37 ;; directly on it or get useful information about the list, with the
38 ;; two helper functions, namely `org-list-parents-alist' and
39 ;; `org-list-prevs-alist', and using accessors or methods.
41 ;; Structure is eventually applied to the buffer with
42 ;; `org-list-write-struct'. This function repairs (bullets,
43 ;; indentation, checkboxes) the structure before applying it. It
44 ;; should be called near the end of any function working on
45 ;; structures.
47 ;; Thus, a function applying to lists should usually follow this
48 ;; template:
50 ;; 1. Verify point is in a list and grab item beginning (with the same
51 ;; function `org-in-item-p'). If the function requires the cursor
52 ;; to be at item's bullet, `org-at-item-p' is more selective. If
53 ;; the cursor is amidst the buffer, it is possible to find the
54 ;; closest item with `org-list-search-backward', or
55 ;; `org-list-search-forward', applied to `org-item-beginning-re'.
57 ;; 2. Get list structure with `org-list-struct'.
59 ;; 3. Compute one, or both, helper functions,
60 ;; (`org-list-parents-alist', `org-list-prevs-alist') depending on
61 ;; needed accessors.
63 ;; 4. Proceed with the modifications, using methods and accessors.
65 ;; 5. Verify and apply structure to buffer, using
66 ;; `org-list-write-struct'. Possibly use
67 ;; `org-update-checkbox-count-maybe' if checkboxes might have been
68 ;; modified.
70 ;; Computing a list structure can be a costly operation on huge lists
71 ;; (a few thousand lines long). Thus, code should follow the rule :
72 ;; "collect once, use many". As a corollary, it is usally a bad idea
73 ;; to use directly an interactive function inside the code, as those,
74 ;; being independant entities, read the whole list structure another
75 ;; time.
77 ;;; Code:
132 ;;; Configuration variables
135 "Options concerning plain lists in Org-mode."
140 "When t, make TAB cycle visibility on plain list items.
141 Cycling plain lists works only when the cursor is on a plain list
142 item. When the cursor is on an outline heading, plain lists are
143 treated as text. This is the most stable way of handling this,
144 which is why it is the default.
146 When this is the symbol `integrate', then during cycling, plain
147 list items will *temporarily* be interpreted as outline headlines
148 with a level given by 1000+i where i is the indentation of the
149 bullet. This setting can lead to strange effects when switching
151 subtree decides what children should be listed. If that first
153 number, all true children and grand children of the outline
154 heading will be exposed in a children' view."
162 "Default bullet type installed when demoting an item.
163 This is an association list, for each bullet type, this alist will point
164 to the bullet that should be used when this item is demoted.
165 For example,
167 (setq org-list-demote-modify-bullet
170 will make
172 + Movies
173 + Silence of the Lambs
174 + My Cousin Vinny
175 + Books
176 + The Hunt for Red October
177 + The Road to Omaha
179 into
181 + Movies
182 - Silence of the Lambs
183 - My Cousin Vinny
184 + Books
185 - The Hunt for Red October
186 - The Road to Omaha"
204 "The character that makes a line with leading number an ordered list item.
205 Valid values are ?. and ?\). To get both terminators, use t. While
206 ?. may look nicer, it creates the danger that a line with leading
207 number may be incorrectly interpreted as an item. ?\) therefore is
208 the safe choice."
215 "Non-nil means single character alphabetical bullets are allowed.
216 Both uppercase and lowercase are handled. Lists with more than 26
217 items will fallback to standard numbering. Alphabetical counters
223 "A regular expression matching bullets that should have 2 spaces after them.
224 When nil, no bullet will have two spaces after them.
225 When a string, it will be used as a regular expression. When the
226 bullet type of a list is changed, the new bullet type will be
227 matched against this regexp. If it matches, there will be two
228 spaces instead of one after the bullet in each item of the list."
235 "Determine where plain lists should end.
236 Valid values are: `regexp', `indent' or `both'.
238 When set to `regexp', Org will look into two variables,
239 `org-empty-line-terminates-plain-lists' and the more general
240 `org-list-end-regexp', to determine what will end lists.
242 When set to `indent', a list will end whenever a line following
243 an item, but not starting one, is less or equally indented than
244 the first item of the list.
246 When set to `both', each of the preceding methods is applied to
247 determine lists endings. This is the default method."
255 "Non-nil means an empty line ends all plain list levels.
256 This variable only makes sense if `org-list-ending-method' is set
257 to `regexp' or `both'. This is then equivalent to set
263 "Regexp matching the end of all plain list levels.
265 blank lines. `org-empty-line-terminates-plain-lists' has
266 precedence over it."
273 "Non-nil means apply set of rules when acting on lists.
274 By default, automatic actions are taken when using
279 rules by setting them to nil. Valid rules are:
281 bullet when non-nil, cycling bullet do not allow lists at
282 column 0 to have * as a bullet and descriptions lists
283 to be numbered.
284 checkbox when non-nil, checkbox statistics is updated each time
285 you either insert a new checkbox or toggle a checkbox.
286 It also prevents from inserting a checkbox in a
287 description item.
288 indent when non-nil, indenting or outdenting list top-item
289 with its subtree will move the whole list and
290 outdenting a list whose bullet is * to column 0 will
294 :key-type
299 :value-type
303 "Hook that is run whenever Org thinks checkbox statistics should be updated.
304 This hook runs even if checkbox rule in
305 `org-list-automatic-rules' does not apply, so it can be used to
306 implement alternative ways of collecting statistics
310 "Non-nil means checkbox statistics counts only the state of direct children.
311 When nil, all boxes below the cookie are counted.
312 This can be set to nil on a per-node basis using a COOKIE_DATA property
318 "Maximum indentation for the second line of a description list.
319 When the indentation would be larger than this, it will become
320 5 characters instead."
326 % END RECEIVE ORGLST %n
328 #+ORGLST: SEND %n org-list-to-latex
329 -
332 @c END RECEIVE ORGLST %n
333 @ignore
334 #+ORGLST: SEND %n org-list-to-texinfo
335 -
338 <!-- END RECEIVE ORGLST %n -->
339 <!--
340 #+ORGLST: SEND %n org-list-to-html
341 -
343 "Templates for radio lists in different major modes.
344 All occurrences of %n in a template will be replaced with the name of the
345 list, obtained by prompting the user."
352 "Names of blocks where lists are not allowed.
356 "Context types where lists will be interpreted during export.
358 Valid types are `drawer', `inlinetask' and `block'. More
359 specifically, type `block' is determined by the variable
363 ;;; Predicates and regexps
367 org-list-end-regexp)
368 "Regex corresponding to the end of a list.
376 "Matches a list item and puts everything into groups:
377 group 1: bullet
378 group 2: counter
379 group 3: checkbox
383 "Return the correct regular expression for plain lists."
394 "Regexp matching the beginning of a plain list item."
398 "Is point at a list item with REGEXP after bullet?"
407 ;; Ignore counter if any
412 "Non-nil if point is in a valid block.
413 Invalid blocks are referring to `org-list-forbidden-blocks'."
423 "Return item beginning position when in a plain list, nil otherwise.
424 This checks `org-list-ending-method'."
436 ;; Indentation isn't meaningful when point starts at an empty
437 ;; line or an inline task.
440 10000
446 ;; Detect if cursor in amidst `org-list-end-re'. First, count
447 ;; number HL of hard lines it takes, then call `org-in-regexp'
448 ;; to compute its boundaries END-BOUNDS. When point is
449 ;; in-between, move cursor before regexp beginning.
461 ;; Look for an item, less indented that reference line if
462 ;; `org-list-ending-method' isn't `regexp'.
467 ;; This is exactly what we want.
472 ;; At upper bound of search or looking at the end of a
473 ;; previous list: search is over.
478 ;; Skip blocks, drawers, inline-tasks, blank lines
488 ;; Text at column 0 cannot belong to a list: stop.
490 ;; Normal text less indented than reference line, take
491 ;; it as new reference.
498 "Is point in a line starting a hand-formatted item?"
504 "Is point at the bullet of a plain list item?"
510 "Is point at a line starting a plain list item with a timer?"
515 "Is point at a description list item?"
519 "Is point at a line starting a plain-list item with a checklet?"
523 "Is point at a line starting a plain-list item with a counter?"
529 ;;; Structures and helper functions
532 "Determine context, and its boundaries, around point.
534 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
535 are boundaries and CONTEXT is a symbol among `drawer', `block',
536 `invalid', `inlinetask' and nil.
538 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
544 ;; Get positions of surrounding headings. This is the
545 ;; default context.
550 ;; Is point inside a drawer?
552 ;; Can't use org-drawers-regexp as this function
553 ;; might be called in buffers not in Org mode
564 lim-down))
567 ;; Is point strictly in a block, and of which type?
578 lim-down))
584 ;; Is point in an inlinetask?
597 ;; Return context boundaries and type.
601 "Return structure of list at point.
603 A list structure is an alist where key is point at item, and
604 values are:
605 1. indentation,
606 2. bullet with trailing whitespace,
607 3. bullet counter, if any,
608 4. checkbox, if any,
609 5. description tag, if any,
610 6. position at item end.
612 Thus the following list, where numbers in parens are
613 point-at-bol:
615 - [X] first item (1)
616 1. sub-item 1 (18)
617 5. [@5] sub-item 2 (34)
618 some other text belonging to first item (55)
619 - last item (97)
620 + tag :: description (109)
621 (131)
623 will get the following structure:
631 Assume point is at an item."
646 ind itm-lst itm-lst-2 end-lst end-lst-2 struct
649 ;; Return association at point.
653 ind
660 ;; Ensure list ends at the first blank line.
664 ;; 1. Read list from starting item to its beginning, and save
665 ;; top item position and indentation in BEG-CELL. Also store
666 ;; ending position of items in END-LST.
674 ;; At upward limit: if we ended at an item, store it,
675 ;; else dimiss useless data recorded above BEG-CELL.
676 ;; Jump to part 2.
684 ;; At a verbatim block, go before its beginning. Move
685 ;; from eol to ensure `previous-single-property-change'
686 ;; will return a value.
691 ;; Looking at a list ending regexp. Dismiss useless
692 ;; data recorded above BEG-CELL. Jump to part 2.
698 ;; Point is at an item. Add data to ITM-LST. It may
699 ;; also end a previous item: save it in END-LST. If ind
700 ;; is less or equal than BEG-CELL and there is no end
701 ;; at this ind or lesser, this item becomes the new
702 ;; BEG-CELL.
711 ;; Skip blocks, drawers, inline tasks, blank lines.
722 ;; From there, point is not at an item. Unless ending
723 ;; method is `regexp', interpret line's indentation:
724 ;; - text at column 0 is necessarily out of any list.
725 ;; Dismiss data recorded above BEG-CELL. Jump to
726 ;; part 2.
727 ;; - any other case may be an ending position for an
728 ;; hypothetical item above. Store it and proceed.
738 ;; 2. Read list from starting point to its end, that is until we
739 ;; get out of context, or that a non-item line is less or
740 ;; equally indented than BEG-CELL's cdr. Also, store ending
741 ;; position of items in END-LST-2.
748 ;; At downward limit: this is de facto the end of the
749 ;; list. Save point as an ending position, and jump to
750 ;; part 3.
753 ;; At a verbatim block, move to its end. Point is at bol
754 ;; and 'org-example property is set by whole lines:
755 ;; `next-single-property-change' always return a value.
759 ;; Looking at a list ending regexp. Save point as an
760 ;; ending position and jump to part 3.
765 ;; Point is at an item. Add data to ITM-LST-2. It may also
766 ;; end a previous item, so save it in END-LST-2.
770 ;; Skip inline tasks and blank lines along the way
775 ;; Ind is lesser or equal than BEG-CELL's. The list is
776 ;; over: store point as an ending position and jump to
777 ;; part 3.
782 ;; Else, if ind is lesser or equal than previous item's,
783 ;; this is an ending position: store it. In any case,
784 ;; skip block or drawer at point, and move to next line.
797 ;; 3. Correct ill-formed lists by ensuring top item is the least
798 ;; indented.
805 ;; Trim bullet so item will be seen as different
806 ;; when compared with repaired version.
808 struct))
809 ;; 4. Associate each item to its end pos.
811 ;; 5. Return STRUCT
812 struct)))
815 "Associate proper ending point to items in STRUCT.
817 END-LIST is a pseudo-alist where car is indentation and cdr is
818 ending position.
820 This function modifies STRUCT."
826 ;; Remove end candidates behind current item
829 ;; Add end position to item assoc
835 struct)))
838 "Return alist between item and previous item in STRUCT."
840 struct)))
844 struct)))
847 "Return alist between item and parent in STRUCT."
869 ;;; Accessors
872 "Return the Nth value of KEY in STRUCT."
876 "Set the Nth value of KEY in STRUCT to NEW.
881 "Return indentation of ITEM in STRUCT."
885 "Set indentation of ITEM in STRUCT to IND.
890 "Return bullet of ITEM in STRUCT."
894 "Set bullet of ITEM in STRUCT to BULLET.
899 "Return counter of ITEM in STRUCT."
903 "Return checkbox of ITEM in STRUCT or nil."
907 "Set checkbox of ITEM in STRUCT to CHECKBOX.
912 "Return end position of ITEM in STRUCT."
916 "Return end position of ITEM in STRUCT."
920 "Return point at end of ITEM in STRUCT, before any blank line.
921 Point returned is at end of line."
928 "Return parent of ITEM or nil.
929 STRUCT is the list structure. PARENTS is the alist of parents, as
930 returned by `org-list-parents-alist'."
935 "Non-nil if ITEM has a child.
937 STRUCT is the list structure.
939 Value returned is the position of the first child of ITEM."
944 child-maybe)))
947 "Return next item in same sub-list as ITEM, or nil.
948 STRUCT is the list structure. PREVS is the alist of previous
949 items, as returned by `org-list-prevs-alist'."
953 "Return previous item in same sub-list as ITEM, or nil.
954 STRUCT is the list structure. PREVS is the alist of previous
955 items, as returned by `org-list-prevs-alist'."
959 "List all items having ITEM as a common ancestor, or nil.
960 STRUCT is the list structure."
963 subtree)
968 sub-struct))
972 "List all items in the same sub-list as ITEM.
973 STRUCT is the list structure. PREVS is the alist of previous
974 items, as returned by `org-list-prevs-alist'."
977 before-item after-item)
985 "List all children of ITEM, or nil.
986 STRUCT is the list structure. PARENTS is the alist of parents, as
987 returned by `org-list-parents-alist'."
995 "Return point at beginning of list.
996 STRUCT is the list structure."
1000 "Return point at bottom of list.
1001 STRUCT is the list structure."
1006 "Return point at beginning of sub-list ITEM belongs.
1007 STRUCT is the list structure. PREVS is the alist of previous
1008 items, as returned by `org-list-prevs-alist'."
1012 first-item))
1017 "Return point at last item of sub-list ITEM belongs.
1018 STRUCT is the list structure. PREVS is the alist of previous
1019 items, as returned by `org-list-prevs-alist'."
1023 last-item))
1026 "Return point at end of sub-list ITEM belongs.
1027 STRUCT is the list structure. PREVS is the alist of previous
1028 items, as returned by `org-list-prevs-alist'."
1032 "Return the type of the list containing ITEM, as a symbol.
1034 STRUCT is the list structure. PREVS is the alist of previous
1035 items, as returned by `org-list-prevs-alist'.
1037 Possible types are `descriptive', `ordered' and `unordered'. The
1038 type is determined by the first item of the list."
1046 ;;; Searching
1049 "Search a string in valid contexts for lists.
1050 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1051 in `re-search-forward'."
1055 ;; 1. No match: return to origin or bound, depending on NOERR.
1058 nil)))
1059 ;; 2. Match in valid context: return point. Else, continue
1060 ;; searching.
1064 "Like `re-search-backward' but stop only where lists are recognized.
1065 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1066 `re-search-backward'."
1071 "Like `re-search-forward' but stop only where lists are recognized.
1072 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1073 `re-search-forward'."
1078 ;;; Methods on structures
1081 "Return BULLET with the correct number of whitespaces.
1082 It determines the number of whitespaces to append by looking at
1083 `org-list-two-spaces-after-bullet-regexp'."
1087 org-list-two-spaces-after-bullet-regexp bullet))
1088 " "
1094 "Return number of blank lines that should separate items in list.
1096 POS is the position of point where `org-list-insert-item' was called.
1098 STRUCT is the list structure. PREVS is the alist of previous
1099 items, as returned by `org-list-prevs-alist'.
1101 Assume point is at item's beginning. If the item is alone, apply
1102 some heuristics to guess the result."
1107 usr-blank)
1109 ;; Trivial cases where there should be none.
1111 org-empty-line-terminates-plain-lists)
1113 ;; When `org-blank-before-new-entry' says so, it is 1.
1115 ;; plain-list-item is 'auto. Count blank lines separating
1116 ;; neighbours items in list.
1119 ;; Is there a next item?
1122 ;; Is there a previous item?
1125 ;; User inserted blank lines, trust him
1131 usr-blank)
1132 ;; Are there blank lines inside the item ?
1137 ;; No parent: no blank line.
1141 "Insert a new list item at POS and return the new structure.
1142 If POS is before first character after bullet of the item, the
1143 new item will be created before the current one.
1145 STRUCT is the list structure. PREVS is the the alist of previous
1146 items, as returned by `org-list-prevs-alist'.
1148 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1149 after the bullet. Cursor will be after this text once the
1150 function ends.
1152 This function modifies STRUCT."
1154 ;; 1. Get information about list: structure, usual helper
1155 ;; functions, position of point with regards to item start
1156 ;; (BEFOREP), blank lines number separating items (BLANK-NB),
1157 ;; position of split (POS) if we're allowed to (SPLIT-LINE-P).
1165 pos struct prevs))
1166 ;; 2. Build the new item to be created. Concatenate same
1167 ;; bullet as item, checkbox, text AFTER-BULLET if
1168 ;; provided, and text cut from point to end of item
1169 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1170 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1171 ;; between what was cut and what was inserted in buffer
1172 ;; is stored in SIZE-OFFSET.
1176 ind))
1190 text-cut))
1195 ;; 4. Insert effectively item into buffer
1199 ;; 5. Add new item to STRUCT.
1204 ;; Before inserted item, positions don't change but
1205 ;; an item ending after insertion has its end shifted
1206 ;; by SIZE-OFFSET.
1209 ;; Trivial cases where current item isn't split in
1210 ;; two. Just shift every item after new one by
1211 ;; ITEM-SIZE.
1215 ;; Item is split in two: elements before POS are just
1216 ;; shifted by ITEM-SIZE. In the case item would end
1217 ;; after split POS, ending is only shifted by
1218 ;; SIZE-OFFSET.
1224 ;; Elements after POS are moved into new item. Length
1225 ;; of ITEM-SEP has to be removed as ITEM-SEP
1226 ;; doesn't appear in buffer yet.
1232 (+ end size-offset
1234 ;; Elements at ITEM-END or after are only shifted by
1235 ;; SIZE-OFFSET.
1238 struct)
1241 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1242 ;; exchange ITEM with the next item in list. Position cursor
1243 ;; after bullet, counter, checkbox, and label.
1249 struct)))
1252 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1253 Blank lines at the end of items are left in place. Return the new
1254 structure after the changes.
1256 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1257 to the same sub-list.
1259 This function modifies STRUCT."
1272 ;; 1. Move effectively items in buffer.
1276 ;; 2. Now modify struct. No need to re-read the list, the
1277 ;; transformation is just a shift of positions. Some special
1278 ;; attention is required for items ending at END-A and END-B
1279 ;; as empty spaces are not moved there. In others words, item
1280 ;; BEG-A will end with whitespaces that were at the end of
1281 ;; BEG-B and the same applies to BEG-B.
1303 struct)
1307 "Outdent items between positions START and END.
1309 STRUCT is the list structure. PARENTS is the alist of items'
1310 parents, as returned by `org-list-parents-alist'.
1312 START is included, END excluded."
1318 ;; Item not yet in zone: keep association
1320 ;; Item out of zone: follow associations in acc
1324 ;; Item has no parent: error
1327 ;; Parent is outdented: keep association
1331 ;; Parent isn't outdented: reparent to grand-parent
1333 parent struct parents)))
1339 "Indent items between positions START and END.
1341 STRUCT is the list structure. PARENTS is the alist of parents and
1342 PREVS is the alist of previous items, returned by, respectively,
1343 `org-list-parents-alist' and `org-list-prevs-alist'.
1345 START is included and END excluded.
1347 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1348 bullets between START and END."
1362 ;; Item not yet in zone: keep association
1365 ;; Item out of zone: follow associations in acc
1369 ;; Item is in zone...
1371 ;; Check if bullet needs to be changed
1374 ;; First item indented but not parent: error
1377 ;; First item and parent indented: keep same parent
1379 ;; Previous item not indented: reparent to it
1381 ;; Previous item indented: reparent like it
1388 ;;; Repairing structures
1391 "Non-nil if list starting at FIRST can have alphabetical bullets.
1393 STRUCT is list structure. PREVS is the alist of previous items,
1394 as returned by `org-list-prevs-alist'."
1398 ;; Pretend that bullets are uppercase and check if alphabet
1399 ;; is sufficient, taking counters into account.
1403 ;; Virtually determine current bullet
1405 ;; Counters are not case-sensitive.
1408 ;; Test if bullet would be over z or Z.
1412 ;; All items checked. All good.
1413 t))))
1416 "Increment BULLET if applicable."
1419 ;; Num bullet: increment it.
1423 nil nil bullet))
1424 ;; Alpha bullet: increment it.
1428 nil nil bullet))
1429 ;; Unordered bullet: leave it.
1433 "Verify and correct bullets in STRUCT.
1434 PREVS is the alist of previous items, as returned by
1435 `org-list-prevs-alist'.
1437 This function modifies STRUCT."
1441 ;; Set bullet of ITEM in STRUCT, depending on the type of
1442 ;; first item of the list, the previous bullet and counter
1443 ;; if any.
1452 item struct
1455 ;; Alpha counter in alpha list: use counter.
1459 ;; Use cond to be sure `string-match' is used in
1460 ;; both cases.
1466 ;; Num counter in a num list: use counter.
1471 ;; No counter: increase, if needed, previous bullet.
1474 ;; Alpha counter at first item: use counter.
1483 ;; Num counter at first item: use counter.
1488 ;; First bullet is alpha uppercase: use "A".
1491 ;; First bullet is alpha lowercase: use "a".
1494 ;; First bullet is num: use "1".
1497 ;; Not an ordered list: keep bullet.
1502 "Verify and correct indentation in STRUCT.
1504 PARENTS is the alist of parents, as returned by
1505 `org-list-parents-alist'.
1507 If numeric optional argument BULLET-SIZE is set, assume all
1508 bullets in list have this length to determine new indentation.
1510 This function modifies STRUCT."
1517 ;; Indent like parent + length of parent's bullet
1523 ;; If no parent, indent like top-point
1528 "Verify and correct checkboxes in STRUCT.
1530 PARENTS is the alist of parents and PREVS is the alist of
1531 previous items, as returned by, respectively,
1532 `org-list-parents-alist' and `org-list-prevs-alist'.
1534 If ORDERED is non-nil, a checkbox can only be checked when every
1535 checkbox before it is checked too. If there was an attempt to
1536 break this rule, the function will return the blocking item. In
1537 all others cases, the return value will be nil.
1539 This function modifies STRUCT."
1549 item struct
1555 ;; parent has no boxed child: leave box as-is
1557 parent-list)
1558 ;; 1. List all parents with a checkbox
1565 all-items)
1566 ;; 2. Sort those parents by decreasing indentation
1571 ;; 3. For each parent, get all children's checkboxes to determine
1572 ;; and set its checkbox accordingly
1574 ;; 4. If ORDERED is set, see if we need to uncheck some boxes
1579 ;; there are boxes checked after an unchecked one: fix that
1584 ;; Verify once again the structure, without ORDERED
1586 ;; return blocking item
1590 "Apply set-difference between STRUCT and OLD-STRUCT to the buffer.
1592 OLD-STRUCT is the structure before any modifications, and STRUCT
1593 the structure to be applied. The function will only modify parts
1594 of the list which have changed.
1596 Initial position of cursor is restored after the changes."
1604 ;; Shift the indentation between END and BEG by DELTA.
1605 ;; Start from the line before END.
1614 ;; Skip inline tasks
1617 ;; Shift only non-empty lines
1624 ;; Replace ITEM first line elements with new elements from
1625 ;; STRUCT, if appropriate.
1635 ;; a. Replace bullet
1638 ;; b. Replace checkbox
1652 ;; c. Indent item to appropriate column
1657 ;; 1. First get list of items and position endings. We maintain
1658 ;; two alists: ITM-SHIFT, determining indentation shift needed
1659 ;; at item, and END-POS, a pseudo-alist where key is ending
1660 ;; position and value point
1673 ;; To determine real ind of an ending position that is
1674 ;; not at an item, we have to find the item it belongs
1675 ;; to: it is the last item (ITEM-UP), whose ending is
1676 ;; further than the position we're interested in.
1680 old-struct)
1681 ;; 2. Slice the items into parts that should be shifted by the
1682 ;; same amount of indentation. The slices are returned in
1683 ;; reverse order so changes modifying buffer do not change
1684 ;; positions they refer to.
1687 '<))
1695 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1696 ;; end to beginning. Take a special action when beginning is
1697 ;; at item bullet.
1704 sliced-struct))
1705 ;; 4. Go back to initial position
1709 "Correct bullets, checkboxes and indentation in list at point.
1710 STRUCT is the list structure. PARENTS is the alist of parents, as
1711 returned by `org-list-parents-alist'."
1712 ;; Order of functions matters here: checkboxes and endings need
1713 ;; correct indentation to be set, and indentation needs correct
1714 ;; bullets.
1715 ;;
1716 ;; 0. Save a copy of structure before modifications
1718 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1719 ;; order to get items endings and bullets properly
1721 ;; 2. Get pseudo-alist of ending positions and sort it by position.
1722 ;; Then associate them to the structure.
1729 ;; To determine real ind of an ending position that is
1730 ;; not at an item, we have to find the item it belongs
1731 ;; to: it is the last item (ITEM-UP), whose ending is
1732 ;; further than the position we're interested in.
1735 ;; Else part is for the bottom point
1737 end-pos)
1738 end-list)))
1741 struct)
1744 ;; 3. Get bullets right
1747 ;; 4. Now get real indentation
1749 ;; 5. Eventually fix checkboxes
1751 ;; 6. Apply structure modifications to buffer
1755 ;;; Misc Tools
1758 "Call FUNCTION on each item of the list at point.
1759 FUNCTION must be called with at least one argument: INIT-VALUE,
1760 that will contain the value returned by the function at the
1761 previous item, plus ARGS extra arguments.
1763 FUNCTION is applied on items in reverse order.
1765 As an example, \(org-apply-on-list \(lambda \(result\) \(1+ result\)\) 0\)
1766 will return the number of items in the current list.
1768 Sublists of the list are skipped. Cursor is always at the
1769 beginning of the item."
1780 value))
1783 "Set visibility of ITEM in STRUCT to VIEW.
1785 Possible values are: `folded', `children' or `subtree'. See
1786 `org-cycle' for more information."
1790 ;; Hide from eol
1792 item-end t)))
1794 ;; First show everything.
1796 ;; Then fold every child.
1801 children)))
1803 ;; Show everything
1808 "Return column at which body of ITEM should start."
1818 tcol))
1821 ;;; Interactive functions
1826 "Go to the beginning of the current item.
1827 Throw an error when not in a list."
1833 "Go to the beginning item of the current list or sublist.
1834 Throw an error when not in a list."
1845 "Go to the end of the current list or sublist.
1846 Throw an error when not in a list."
1857 "Go to the end of the current item.
1858 Throw an error when not in a list."
1868 "Move to the beginning of the previous item.
1869 Throw an error when not in a list, or at first item."
1881 "Move to the beginning of the next item.
1882 Throw an error when not in a plain list, or at last item."
1894 "Move the item at point down, i.e. swap with following item.
1895 Subitems (items with larger indentation) are considered part of
1896 the item, so this really moves item trees."
1911 ;; Use a short variation of `org-list-write-struct' as there's
1912 ;; no need to go through all the steps.
1923 "Move the item at point up, i.e. swap with previous item.
1924 Subitems (items with larger indentation) are considered part of
1925 the item, so this really moves item trees."
1940 ;; Use a short variation of `org-list-write-struct' as there's
1941 ;; no need to go through all the steps.
1951 "Insert a new item at the current level.
1952 If cursor is before first character after bullet of the item, the
1953 new item will be created before the current one.
1955 If CHECKBOX is non-nil, add a checkbox next to the bullet.
1957 Return t when things worked, nil when we are not in an item, or
1958 item is invisible."
1961 ;; If cursor isn't is a list or if list is invisible, return nil.
1969 ;; Timer list: delegate to `org-timer-item'.
1974 ;; If we're in a description list, ask for the new term.
1977 ;; Don't insert a checkbox if checkbox rule is applied
1978 ;; and it is a description item.
1982 org-list-automatic-rules)))))))
1989 t)))))
1992 "Fix indentation, bullets and checkboxes is the list at point."
2000 "Cycle through the different itemize/enumerate bullets.
2001 This cycle the entire list level through the sequence:
2003 `-' -> `+' -> `*' -> `1.' -> `1)'
2005 If WHICH is a valid string, use that as the new bullet. If WHICH
2006 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2007 `previous', cycle backwards."
2028 ;; Compute list of possible bullets, depending on context
2031 ;; *-bullets are not allowed at column 0
2034 ;; Description items cannot be numbered
2057 ;; Use a short variation of `org-list-write-struct' as there's
2058 ;; no need to go through all the steps.
2066 "Toggle the checkbox in the current line.
2067 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2068 double prefix, set checkbox to [-].
2070 When there is an active region, toggle status or presence of the
2071 first checkbox there, and make every item inside have the same
2072 status or presence, respectively.
2074 If the cursor is in a headline, apply this to all checkbox items
2075 in the text below the heading, taking as reference the first item
2076 in subtree, ignoring drawers."
2080 block-item
2081 lim-up
2082 lim-down
2093 ;; In a region, start at first item in region
2103 ;; On an heading, start at first item after drawers and
2104 ;; time-stamps (scheduled, etc.)
2115 ;; Just one item: set singlep flag
2121 ;; Determine the checkbox going to be applied to all items
2122 ;; within bounds
2133 ;; When an item is found within bounds, grab the full list at
2134 ;; point structure, then: 1. set checkbox of all its items
2135 ;; within bounds to ref-checkbox; 2. fix checkboxes of the whole
2136 ;; list; 3. move point after the list.
2150 e struct
2151 ;; if there is no box at item, leave as-is
2152 ;; unless function was called with C-u prefix
2155 ref-checkbox
2156 cur-box))))
2157 items-to-toggle)
2159 struct parents prevs orderedp))
2160 ;; Report some problems due to ORDERED status of subtree. If
2161 ;; only one box was being checked, throw an error, else,
2162 ;; only signal problems.
2166 "Checkbox blocked because of unchecked box at line %d"
2170 "Checkboxes were removed due to unchecked box at line %d"
2177 "Reset all checkboxes in an entry subtree."
2192 "Update the checkbox statistics in the current section.
2193 This will find all statistic cookies like [57%] and [6/12] and
2194 update them with the current numbers.
2196 With optional prefix argument ALL, do this for the whole buffer."
2200 (box-re "^[ \t]*\\([-+*]\\|\\([0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2212 ;; Return number of checked boxes and boxes of all types
2213 ;; in all structures in STRUCTS. If RECURSIVEP is non-nil,
2214 ;; also count boxes in sub-lists. If ITEM is nil, count
2215 ;; across the whole structure, else count only across
2216 ;; subtree whose ancestor is ITEM.
2233 items))))
2236 structs)
2239 cookies-list structs-bak box-num)
2241 ;; 1. Build an alist for each cookie found within BOUNDS. The
2242 ;; key will be position at beginning of cookie and values
2243 ;; ending position, format of cookie, and a cell whose car is
2244 ;; number of checked boxes to report, and cdr total number of
2245 ;; boxes.
2255 ;; Cookie is at an heading, but specifically for todo,
2256 ;; not for checkboxes: skip it.
2262 ;; Cookie is at an heading, but all lists before next
2263 ;; heading already have been read. Use data collected
2264 ;; in STRUCTS-BAK. This should only happen when heading
2265 ;; has more than one cookie on it.
2268 backup-end))
2270 ;; Cookie is at a fresh heading. Grab structure of
2271 ;; every list containing a checkbox between point and
2272 ;; next headline, and save them in STRUCTS-BAK.
2282 ;; Cookie is at an item, and we already have list
2283 ;; structure stored in STRUCTS-BAK.
2286 ;; Only lists in no special context are stored.
2289 ;; Cookie is at an item, but we need to compute list
2290 ;; structure.
2296 ;; Else, cookie found is at a wrong place. Skip it.
2298 cookies-list))))
2299 ;; 2. Apply alist to buffer, in reverse order so positions stay
2300 ;; unchanged after cookie modifications.
2315 cookies-list))))
2318 "Select the face for checkbox statistics.
2319 The face will be `org-done' when all relevant boxes are checked.
2320 Otherwise it will be `org-todo'."
2323 'org-checkbox-statistics-done
2327 'org-checkbox-statistics-done
2331 "Update checkbox statistics unless turned off by user."
2339 "Indent a local list item including its children.
2340 When number ARG is a negative, item will be outdented, otherwise
2341 it will be indented.
2343 If a region is active, all items inside will be moved.
2345 If NO-SUBTREE is non-nil, only indent the item itself, not its
2346 children.
2348 STRUCT is the list structure.
2350 Return t if successful."
2359 ;; Are we going to move the whole list?
2366 t))))
2367 ;; Determine begin and end points of zone to indent. If moving
2368 ;; more than one item, save them for subsequent moves.
2384 ;; Special case: moving top-item with indent rule
2392 ;; Change bullet if necessary
2398 ;; Shift every item by OFFSET and fix bullets. Then
2399 ;; apply changes to buffer.
2403 struct)
2406 ;; Forbidden move:
2408 ;; If only one item is moved, it mustn't have a child
2412 ;; If a subtree or region is moved, the last item
2413 ;; of the subtree mustn't have a child
2418 struct)))))
2421 ;; Normal shifting
2429 t)
2432 "Outdent a local list item, but not its children.
2433 If a region is active, all items inside will be moved."
2441 "Indent a local list item, but not its children.
2442 If a region is active, all items inside will be moved."
2450 "Outdent a local list item including its children.
2451 If a region is active, all items inside will be moved."
2465 "Indent a local list item including its children.
2466 If a region is active, all items inside will be moved."
2481 "Cycle levels of indentation of an empty item.
2482 The first run indents the item, if applicable. Subsequents runs
2483 outdent it at meaningful levels in the list. When done, item is
2484 put back at its original position with its original bullet.
2486 Return t at each successful move."
2492 ;; Accept empty items or if cycle has already started.
2503 ;; When in the middle of the cycle, try to outdent first. If it
2504 ;; fails, and point is still at initial position, indent. Else,
2505 ;; go back to original position.
2514 ;; Break cycle
2516 ;; If a cycle is starting, remember indentation and bullet,
2517 ;; then try to indent. If it fails, try to outdent.
2523 t))))
2526 "Sort list items.
2527 The cursor may be at any item of the list that should be sorted.
2528 Sublists are not sorted. Checkboxes, if any, are ignored.
2530 Sorting can be alphabetically, numerically, by date/time as given by
2531 a time stamp, by a property or by priority.
2533 Comparing entries ignores case by default. However, with an
2534 optional argument WITH-CASE, the sorting considers case as well.
2536 The command prompts for the sorting type unless it has been given
2537 to the function through the SORTING-TYPE argument, which needs to
2538 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
2539 meaning of each character:
2541 n Numerically, by converting the beginning of the item to a number.
2542 a Alphabetically. Only the first line of item is checked.
2543 t By date/time, either the first active time stamp in the entry, if
2544 any, or by the first inactive one. In a timer list, sort the timers.
2546 Capital letters will reverse the sort order.
2548 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a
2549 function to be called with point at the beginning of the record.
2550 It must return either a string or a number that should serve as
2551 the sorting key for that record. It will then use COMPARE-FUNC to
2552 compare entries."
2597 ;; If it is a timer list, convert timer to seconds
2610 value))
2614 next-record
2615 end-record
2616 value-to-sort
2617 nil
2618 sort-func)
2619 ;; Read and fix list again, as `sort-subr' probably destroyed
2620 ;; its structure.
2626 ;;; Send and receive lists
2629 "Parse the list at point and maybe DELETE it.
2631 Return a list whose car is a symbol of list type, among
2632 `ordered', `unordered' and `descriptive'. Then, each item is a
2633 list whose car is counter, and cdr are strings and other
2637 For example, the following list:
2639 1. first item
2640 + sub-item one
2641 + [X] sub-item two
2642 more text in first item
2643 2. [@3] last item
2645 will be parsed as:
2647 \(ordered
2649 \(unordered
2655 Point is left at list end."
2661 out
2662 parse-item ; for byte-compiler
2665 ;; Return text between BEG and END, trimmed, with
2666 ;; checkboxes replaced.
2673 text)))))
2676 ;; Return a list whose car is list type and cdr a list of
2677 ;; items' body.
2683 ;; Return a list containing counter of item, if any, text
2684 ;; and any sublist inside it.
2690 ;; Get counter number. For alphabetic counter, get
2691 ;; its position in the alphabet.
2702 ;; If item has a child, store text between bullet and
2703 ;; next child, then recursively parse all sublists. At
2704 ;; the end of each sublist, check for the presence of
2705 ;; text belonging to the original item.
2715 ;; Remove children from the list just parsed.
2717 ;; There is a chunk of text belonging to the
2718 ;; item if last child doesn't end where next
2719 ;; child starts or where item ends.
2723 body))))
2726 ;; Store output, take care of cursor position and deletion of
2727 ;; list, then return output.
2735 out))
2738 "Convert the plain list at point into a subtree."
2746 "Insert a radio list template appropriate for this major mode."
2750 name pos)
2761 "Send a transformed version of this list to the receiver position.
2762 With argument MAYBE, fail quietly if no transformation is defined for
2763 this list."
2769 (unless (looking-at "[ \t]*#\\+ORGLST[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
2788 beg txt)
2792 ;; Find the insertion place
2797 name
2811 "Convert a LIST parsed through `org-list-parse-list' to other formats.
2812 Valid parameters PARAMS are
2814 :ustart String to start an unordered list
2815 :uend String to end an unordered list
2817 :ostart String to start an ordered list
2818 :oend String to end an ordered list
2820 :dstart String to start a descriptive list
2821 :dend String to end a descriptive list
2822 :dtstart String to start a descriptive term
2823 :dtend String to end a descriptive term
2824 :ddstart String to start a description
2825 :ddend String to end a description
2827 :splice When set to t, return only list body lines, don't wrap
2828 them into :[u/o]start and :[u/o]end. Default is nil.
2830 :istart String to start a list item.
2831 :icount String to start an item with a counter.
2832 :iend String to end a list item
2833 :isep String to separate items
2834 :lsep String to separate sublists
2835 :csep String to separate text from a sub-list
2837 :cboff String to insert for an unchecked checkbox
2838 :cbon String to insert for a checked checkbox
2840 Alternatively, each parameter can also be a form returning a
2841 string. These sexp can use keywords `counter' and `depth',
2842 reprensenting respectively counter associated to the current
2843 item, and depth of the current sub-list, starting at 0.
2844 Obviously, `counter' is only available for parameters applying to
2845 items."
2867 export-sublist ; for byte-compiler
2870 ;; Export an item ITEM of type TYPE, at DEPTH. First string
2871 ;; in item is treated in a special way as it can bring
2872 ;; extra information that needs to be processed.
2878 ;; Stick DTSTART to ISTART by
2879 ;; left-trimming the latter.
2883 istart))
2890 ;; Replace checkbox if any is found.
2898 ;; Insert descriptive term if TYPE is `descriptive'.
2907 first)))
2918 ;; Export sublist SUB at DEPTH
2936 "Convert LIST into a LaTeX list.
2937 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2938 with overruling parameters for `org-list-to-generic'."
2940 list
2949 ;; LaTeX increments counter just before
2950 ;; using it, so set it to the desired
2951 ;; value, minus one.
2957 params)))
2960 "Convert LIST into a HTML list.
2961 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2962 with overruling parameters for `org-list-to-generic'."
2964 list
2975 params)))
2978 "Convert LIST into a Texinfo list.
2979 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2980 with overruling parameters for `org-list-to-generic'."
2982 list
2992 params)))
2995 "Convert LIST into an Org subtree.
2996 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2997 with overruling parameters for `org-list-to-generic'."
3007 ;; Return the string for the heading, depending on depth D
3008 ;; of current sub-list.
3013 oddeven-level)
3014 ?*)
3017 list
3019 '(:splice t
3026 params))))
3030 ;; arch-tag: 73cf50c1-200f-4d1d-8a53-4e842a5b11c8
3031 ;;; org-list.el ends here