| blob | c54c9661b27146868917f33156cde220461a00d4 |
1 ;;; org-list.el --- Plain lists for Org-mode
2 ;;
3 ;; Copyright (C) 2004-2011 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Bastien Guerry <bzg AT gnu DOT org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;;
10 ;; This file is part of GNU Emacs.
11 ;;
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
25 ;;
26 ;;; Commentary:
28 ;; This file contains the code dealing with plain lists in Org-mode.
30 ;; The fundamental idea behind lists work is to use structures.
31 ;; A structure is a snapshot of the list, in the shape of data tree
32 ;; (see `org-list-struct').
34 ;; Once the list structure is stored, it is possible to make changes
35 ;; directly on it or get useful information about the list, with the
36 ;; two helper functions, namely `org-list-parents-alist' and
37 ;; `org-list-prevs-alist', and using accessors or methods.
39 ;; Structure is eventually applied to the buffer with
40 ;; `org-list-write-struct'. This function repairs (bullets,
41 ;; indentation, checkboxes) the structure before applying it. It
42 ;; should be called near the end of any function working on
43 ;; structures.
45 ;; Thus, a function applying to lists should usually follow this
46 ;; template:
48 ;; 1. Verify point is in a list and grab item beginning (with the same
49 ;; function `org-in-item-p'). If the function requires the cursor
50 ;; to be at item's bullet, `org-at-item-p' is more selective. If
51 ;; the cursor is amidst the buffer, it is possible to find the
52 ;; closest item with `org-list-search-backward', or
53 ;; `org-list-search-forward', applied to `org-item-beginning-re'.
55 ;; 2. Get list structure with `org-list-struct'.
57 ;; 3. Compute one, or both, helper functions,
58 ;; (`org-list-parents-alist', `org-list-prevs-alist') depending on
59 ;; needed accessors.
61 ;; 4. Proceed with the modifications, using methods and accessors.
63 ;; 5. Verify and apply structure to buffer, using
64 ;; `org-list-write-struct'. Possibly use
65 ;; `org-update-checkbox-count-maybe' if checkboxes might have been
66 ;; modified.
68 ;; Computing a list structure can be a costly operation on huge lists
69 ;; (a few thousand lines long). Thus, code should follow the rule :
70 ;; "collect once, use many". As a corollary, it is usally a bad idea
71 ;; to use directly an interactive function inside the code, as those,
72 ;; being independant entities, read the whole list structure another
73 ;; time.
75 ;;; Code:
129 ;;; Configuration variables
132 "Options concerning plain lists in Org-mode."
137 "When t, make TAB cycle visibility on plain list items.
138 Cycling plain lists works only when the cursor is on a plain list
139 item. When the cursor is on an outline heading, plain lists are
140 treated as text. This is the most stable way of handling this,
141 which is why it is the default.
143 When this is the symbol `integrate', then during cycling, plain
144 list items will *temporarily* be interpreted as outline headlines
145 with a level given by 1000+i where i is the indentation of the
146 bullet. This setting can lead to strange effects when switching
148 subtree decides what children should be listed. If that first
150 number, all true children and grand children of the outline
151 heading will be exposed in a children' view."
159 "Default bullet type installed when demoting an item.
160 This is an association list, for each bullet type, this alist will point
161 to the bullet that should be used when this item is demoted.
162 For example,
164 (setq org-list-demote-modify-bullet
167 will make
169 + Movies
170 + Silence of the Lambs
171 + My Cousin Vinny
172 + Books
173 + The Hunt for Red October
174 + The Road to Omaha
176 into
178 + Movies
179 - Silence of the Lambs
180 - My Cousin Vinny
181 + Books
182 - The Hunt for Red October
183 - The Road to Omaha"
201 "The character that makes a line with leading number an ordered list item.
202 Valid values are ?. and ?\). To get both terminators, use t."
209 "Non-nil means single character alphabetical bullets are allowed.
210 Both uppercase and lowercase are handled. Lists with more than
211 26 items will fallback to standard numbering. Alphabetical
217 "A regular expression matching bullets that should have 2 spaces after them.
218 When nil, no bullet will have two spaces after them. When
219 a string, it will be used as a regular expression. When the
220 bullet type of a list is changed, the new bullet type will be
221 matched against this regexp. If it matches, there will be two
222 spaces instead of one after the bullet in each item of the list."
229 "Determine where plain lists should end.
230 Valid values are: `regexp', `indent' or `both'.
232 When set to `regexp', Org will look into two variables,
233 `org-empty-line-terminates-plain-lists' and the more general
234 `org-list-end-regexp', to determine what will end lists.
236 When set to `indent', a list will end whenever a line following
237 an item, but not starting one, is less or equally indented than
238 the first item of the list.
240 When set to `both', each of the preceding methods is applied to
241 determine lists endings. This is the default method."
249 "Non-nil means an empty line ends all plain list levels.
250 This variable only makes sense if `org-list-ending-method' is set
251 to `regexp' or `both'. This is then equivalent to set
257 "Regexp matching the end of all plain list levels.
259 blank lines. `org-empty-line-terminates-plain-lists' has
260 precedence over it."
267 "Non-nil means apply set of rules when acting on lists.
268 By default, automatic actions are taken when using
273 rules by setting them to nil. Valid rules are:
275 bullet when non-nil, cycling bullet do not allow lists at
276 column 0 to have * as a bullet and descriptions lists
277 to be numbered.
278 checkbox when non-nil, checkbox statistics is updated each time
279 you either insert a new checkbox or toggle a checkbox.
280 It also prevents from inserting a checkbox in a
281 description item.
282 indent when non-nil, indenting or outdenting list top-item
283 with its subtree will move the whole list and
284 outdenting a list whose bullet is * to column 0 will
288 :key-type
293 :value-type
297 "Non-nil means commands implying motion in lists should be cyclic.
299 In that case, the item following the last item is the first one,
300 and the item preceding the first item is the last one.
309 "Hook that is run whenever Org thinks checkbox statistics should be updated.
310 This hook runs even if checkbox rule in
311 `org-list-automatic-rules' does not apply, so it can be used to
312 implement alternative ways of collecting statistics
316 "Non-nil means checkbox statistics counts only the state of direct children.
317 When nil, all boxes below the cookie are counted.
318 This can be set to nil on a per-node basis using a COOKIE_DATA property
324 "Maximum indentation for the second line of a description list.
325 When the indentation would be larger than this, it will become
326 5 characters instead."
331 "Additional indentation for sub-items in a list.
332 By setting this to a small number, usually 1 or 2, one can more
333 clearly distinguish sub-items in a list."
339 % END RECEIVE ORGLST %n
341 #+ORGLST: SEND %n org-list-to-latex
342 -
345 @c END RECEIVE ORGLST %n
346 @ignore
347 #+ORGLST: SEND %n org-list-to-texinfo
348 -
351 <!-- END RECEIVE ORGLST %n -->
352 <!--
353 #+ORGLST: SEND %n org-list-to-html
354 -
356 "Templates for radio lists in different major modes.
357 All occurrences of %n in a template will be replaced with the name of the
358 list, obtained by prompting the user."
366 "Names of blocks where lists are not allowed.
370 "Context types where lists will be interpreted during export.
372 Valid types are `drawer', `inlinetask' and `block'. More
373 specifically, type `block' is determined by the variable
377 ;;; Predicates and regexps
381 org-list-end-regexp)
382 "Regex corresponding to the end of a list.
390 "Matches a list item and puts everything into groups:
391 group 1: bullet
392 group 2: counter
393 group 3: checkbox
397 "Return the correct regular expression for plain lists."
408 "Regexp matching the beginning of a plain list item."
412 "Is point at a list item with REGEXP after bullet?"
421 ;; Ignore counter if any
426 "Is point in a context where lists are allowed?"
430 "Return item beginning position when in a plain list, nil otherwise.
431 This checks `org-list-ending-method'."
443 ;; Indentation isn't meaningful when point starts at an empty
444 ;; line or an inline task.
447 10000
453 ;; Detect if cursor in amidst `org-list-end-re'. First, count
454 ;; number HL of hard lines it takes, then call `org-in-regexp'
455 ;; to compute its boundaries END-BOUNDS. When point is
456 ;; in-between, move cursor before regexp beginning.
468 ;; Look for an item, less indented that reference line if
469 ;; `org-list-ending-method' isn't `regexp'.
474 ;; This is exactly what we want.
479 ;; At upper bound of search or looking at the end of a
480 ;; previous list: search is over.
485 ;; Skip blocks, drawers, inline-tasks, blank lines
495 ;; Text at column 0 cannot belong to a list: stop.
497 ;; Normal text less indented than reference line, take
498 ;; it as new reference.
505 "Is point in a line starting a hand-formatted item?"
511 "Is point at the bullet of a plain list item?"
517 "Is point at a line starting a plain list item with a timer?"
522 "Is point at a description list item?"
526 "Is point at a line starting a plain-list item with a checklet?"
530 "Is point at a line starting a plain-list item with a counter?"
536 ;;; Structures and helper functions
539 "Determine context, and its boundaries, around point.
541 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
542 are boundaries and CONTEXT is a symbol among `drawer', `block',
543 `invalid', `inlinetask' and nil.
545 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
551 ;; Get positions of surrounding headings. This is the
552 ;; default context.
557 ;; Is point inside a drawer?
559 ;; Can't use org-drawers-regexp as this function might
560 ;; be called in buffers not in Org mode.
571 lim-down))
574 ;; Is point strictly in a block, and of which type?
585 lim-down))
591 ;; Is point in an inlinetask?
604 ;; Return context boundaries and type.
608 "Return structure of list at point.
610 A list structure is an alist where key is point at item, and
611 values are:
612 1. indentation,
613 2. bullet with trailing whitespace,
614 3. bullet counter, if any,
615 4. checkbox, if any,
616 5. description tag, if any,
617 6. position at item end.
619 Thus the following list, where numbers in parens are
620 point-at-bol:
622 - [X] first item (1)
623 1. sub-item 1 (18)
624 5. [@5] sub-item 2 (34)
625 some other text belonging to first item (55)
626 - last item (97)
627 + tag :: description (109)
628 (131)
630 will get the following structure:
638 Assume point is at an item."
653 ind itm-lst itm-lst-2 end-lst end-lst-2 struct
656 ;; Return association at point.
660 ind
667 ;; Ensure list ends at the first blank line.
671 ;; 1. Read list from starting item to its beginning, and save
672 ;; top item position and indentation in BEG-CELL. Also store
673 ;; ending position of items in END-LST.
681 ;; At upward limit: if we ended at an item, store it,
682 ;; else dimiss useless data recorded above BEG-CELL.
683 ;; Jump to part 2.
691 ;; At a verbatim block, go before its beginning. Move
692 ;; from eol to ensure `previous-single-property-change'
693 ;; will return a value.
698 ;; Looking at a list ending regexp. Dismiss useless
699 ;; data recorded above BEG-CELL. Jump to part 2.
705 ;; Point is at an item. Add data to ITM-LST. It may
706 ;; also end a previous item: save it in END-LST. If
707 ;; ind is less or equal than BEG-CELL and there is no
708 ;; end at this ind or lesser, this item becomes the new
709 ;; BEG-CELL.
718 ;; Skip blocks, drawers, inline tasks, blank lines.
729 ;; From there, point is not at an item. Unless ending
730 ;; method is `regexp', interpret line's indentation:
731 ;; - text at column 0 is necessarily out of any list.
732 ;; Dismiss data recorded above BEG-CELL. Jump to
733 ;; part 2.
734 ;; - any other case may be an ending position for an
735 ;; hypothetical item above. Store it and proceed.
745 ;; 2. Read list from starting point to its end, that is until we
746 ;; get out of context, or that a non-item line is less or
747 ;; equally indented than BEG-CELL's cdr. Also, store ending
748 ;; position of items in END-LST-2.
755 ;; At downward limit: this is de facto the end of the
756 ;; list. Save point as an ending position, and jump to
757 ;; part 3.
760 ;; At a verbatim block, move to its end. Point is at bol
761 ;; and 'org-example property is set by whole lines:
762 ;; `next-single-property-change' always return a value.
766 ;; Looking at a list ending regexp. Save point as an
767 ;; ending position and jump to part 3.
772 ;; Point is at an item. Add data to ITM-LST-2. It may
773 ;; also end a previous item, so save it in END-LST-2.
777 ;; Skip inline tasks and blank lines along the way
782 ;; Ind is lesser or equal than BEG-CELL's. The list is
783 ;; over: store point as an ending position and jump to
784 ;; part 3.
789 ;; Else, if ind is lesser or equal than previous item's,
790 ;; this is an ending position: store it. In any case,
791 ;; skip block or drawer at point, and move to next line.
804 ;; 3. Correct ill-formed lists by ensuring top item is the least
805 ;; indented.
812 ;; Trim bullet so item will be seen as different
813 ;; when compared with repaired version.
815 struct))
816 ;; 4. Associate each item to its end pos.
818 ;; 5. Return STRUCT
819 struct)))
822 "Associate proper ending point to items in STRUCT.
824 END-LIST is a pseudo-alist where car is indentation and cdr is
825 ending position.
827 This function modifies STRUCT."
833 ;; Remove end candidates behind current item.
836 ;; Add end position to item assoc.
842 struct)))
845 "Return alist between item and previous item in STRUCT."
847 struct)))
851 struct)))
854 "Return alist between item and parent in STRUCT."
876 ;;; Accessors
879 "Return the Nth value of KEY in STRUCT."
883 "Set the Nth value of KEY in STRUCT to NEW.
888 "Return indentation of ITEM in STRUCT."
892 "Set indentation of ITEM in STRUCT to IND.
897 "Return bullet of ITEM in STRUCT."
901 "Set bullet of ITEM in STRUCT to BULLET.
906 "Return counter of ITEM in STRUCT."
910 "Return checkbox of ITEM in STRUCT or nil."
914 "Set checkbox of ITEM in STRUCT to CHECKBOX.
919 "Return end position of ITEM in STRUCT."
923 "Return end position of ITEM in STRUCT."
927 "Return point at end of ITEM in STRUCT, before any blank line.
928 Point returned is at end of line."
935 "Return parent of ITEM or nil.
936 STRUCT is the list structure. PARENTS is the alist of parents,
937 as returned by `org-list-parents-alist'."
942 "Non-nil if ITEM has a child.
944 STRUCT is the list structure.
946 Value returned is the position of the first child of ITEM."
951 child-maybe)))
954 "Return next item in same sub-list as ITEM, or nil.
955 STRUCT is the list structure. PREVS is the alist of previous
956 items, as returned by `org-list-prevs-alist'."
960 "Return previous item in same sub-list as ITEM, or nil.
961 STRUCT is the list structure. PREVS is the alist of previous
962 items, as returned by `org-list-prevs-alist'."
966 "List all items having ITEM as a common ancestor, or nil.
967 STRUCT is the list structure."
970 subtree)
975 sub-struct))
979 "List all items in the same sub-list as ITEM.
980 STRUCT is the list structure. PREVS is the alist of previous
981 items, as returned by `org-list-prevs-alist'."
984 before-item after-item)
992 "List all children of ITEM, or nil.
993 STRUCT is the list structure. PARENTS is the alist of parents, as
994 returned by `org-list-parents-alist'."
1002 "Return point at beginning of list.
1003 STRUCT is the list structure."
1007 "Return point at bottom of list.
1008 STRUCT is the list structure."
1013 "Return point at beginning of sub-list ITEM belongs.
1014 STRUCT is the list structure. PREVS is the alist of previous
1015 items, as returned by `org-list-prevs-alist'."
1019 first-item))
1024 "Return point at last item of sub-list ITEM belongs.
1025 STRUCT is the list structure. PREVS is the alist of previous
1026 items, as returned by `org-list-prevs-alist'."
1030 last-item))
1033 "Return point at end of sub-list ITEM belongs.
1034 STRUCT is the list structure. PREVS is the alist of previous
1035 items, as returned by `org-list-prevs-alist'."
1039 "Return the type of the list containing ITEM, as a symbol.
1041 STRUCT is the list structure. PREVS is the alist of previous
1042 items, as returned by `org-list-prevs-alist'.
1044 Possible types are `descriptive', `ordered' and `unordered'. The
1045 type is determined by the first item of the list."
1053 ;;; Searching
1056 "Search a string in valid contexts for lists.
1057 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1058 in `re-search-forward'."
1062 ;; 1. No match: return to origin or bound, depending on NOERR.
1065 nil)))
1066 ;; 2. Match in valid context: return point. Else, continue
1067 ;; searching.
1071 "Like `re-search-backward' but stop only where lists are recognized.
1072 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1073 `re-search-backward'."
1078 "Like `re-search-forward' but stop only where lists are recognized.
1079 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1080 `re-search-forward'."
1085 ;;; Methods on structures
1088 "Return BULLET with the correct number of whitespaces.
1089 It determines the number of whitespaces to append by looking at
1090 `org-list-two-spaces-after-bullet-regexp'."
1094 org-list-two-spaces-after-bullet-regexp bullet))
1095 " "
1101 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1102 Blank lines at the end of items are left in place. Return the
1103 new structure after the changes.
1105 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1106 to the same sub-list.
1108 This function modifies STRUCT."
1121 ;; 1. Move effectively items in buffer.
1125 ;; 2. Now modify struct. No need to re-read the list, the
1126 ;; transformation is just a shift of positions. Some special
1127 ;; attention is required for items ending at END-A and END-B
1128 ;; as empty spaces are not moved there. In others words,
1129 ;; item BEG-A will end with whitespaces that were at the end
1130 ;; of BEG-B and the same applies to BEG-B.
1152 struct)
1156 "Return number of blank lines that should separate items in list.
1158 POS is the position of point where `org-list-insert-item' was called.
1160 STRUCT is the list structure. PREVS is the alist of previous
1161 items, as returned by `org-list-prevs-alist'.
1163 Assume point is at item's beginning. If the item is alone, apply
1164 some heuristics to guess the result."
1169 usr-blank
1173 ;; Count blank lines above beginning of line.
1180 ;; Trivial cases where there should be none.
1182 org-empty-line-terminates-plain-lists)
1184 ;; When `org-blank-before-new-entry' says so, it is 1.
1186 ;; `plain-list-item' is 'auto. Count blank lines separating
1187 ;; neighbours items in list.
1190 ;; Is there a next item?
1193 ;; Is there a previous item?
1196 ;; User inserted blank lines, trust him.
1201 usr-blank)
1202 ;; Are there blank lines inside the list so far?
1208 ;; Default choice: no blank line.
1212 "Insert a new list item at POS and return the new structure.
1213 If POS is before first character after bullet of the item, the
1214 new item will be created before the current one.
1216 STRUCT is the list structure. PREVS is the the alist of previous
1217 items, as returned by `org-list-prevs-alist'.
1219 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1220 after the bullet. Cursor will be after this text once the
1221 function ends.
1223 This function modifies STRUCT."
1225 ;; 1. Get information about list: position of point with regards
1226 ;; to item start (BEFOREP), blank lines number separating items
1227 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1235 pos struct prevs))
1236 ;; 2. Build the new item to be created. Concatenate same
1237 ;; bullet as item, checkbox, text AFTER-BULLET if
1238 ;; provided, and text cut from point to end of item
1239 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1240 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1241 ;; between what was cut and what was inserted in buffer
1242 ;; is stored in SIZE-OFFSET.
1246 ind))
1253 ;; If POS is greater than ITEM-END, then point is
1254 ;; in some white lines after the end of the list.
1255 ;; Those must be removed, or they will be left,
1256 ;; stacking up after the list.
1266 text-cut))))
1270 ;; 4. Insert effectively item into buffer.
1274 ;; 5. Add new item to STRUCT.
1279 ;; Before inserted item, positions don't change but
1280 ;; an item ending after insertion has its end shifted
1281 ;; by SIZE-OFFSET.
1284 ;; Trivial cases where current item isn't split in
1285 ;; two. Just shift every item after new one by
1286 ;; ITEM-SIZE.
1290 ;; Item is split in two: elements before POS are just
1291 ;; shifted by ITEM-SIZE. In the case item would end
1292 ;; after split POS, ending is only shifted by
1293 ;; SIZE-OFFSET.
1299 ;; Elements after POS are moved into new item.
1300 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1301 ;; doesn't appear in buffer yet.
1307 (+ end size-offset
1309 ;; Elements at ITEM-END or after are only shifted by
1310 ;; SIZE-OFFSET.
1313 struct)
1316 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1317 ;; exchange ITEM with the next item in list. Position cursor
1318 ;; after bullet, counter, checkbox, and label.
1324 struct)))
1327 "Remove ITEM from the list and return the new structure.
1329 STRUCT is the list structure."
1332 ;; If ITEM ends with the list, delete blank lines
1333 ;; before it.
1338 item)))
1339 ;; Remove item from buffer.
1341 ;; Remove item from structure and shift others items accordingly.
1342 ;; Don't forget to shift also ending position when appropriate.
1360 struct)))))
1363 "Send ITEM to destination DEST.
1365 STRUCT is the list structure.
1367 DEST can have various values.
1369 If DEST is a buffer position, the function will assume it points
1370 to another item in the same list as ITEM, and will move the
1371 latter just before the former.
1373 If DEST is `begin' \(resp. `end'\), ITEM will be moved at the
1374 beginning \(resp. end\) of the list it belongs to.
1377 be moved at the Nth position in the list.
1379 If DEST is `kill', ITEM will be deleted and its body will be
1380 added to the kill-ring.
1382 If DEST is `delete', ITEM will be deleted.
1384 This function returns, destructively, the new list structure."
1387 ;; Grab full item body minus its bullet.
1396 item-end)))
1397 ;; Change DEST into a buffer position. A trick is needed
1398 ;; when ITEM is meant to be sent at the end of the list.
1399 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1400 ;; nil and insertion point (INS-POINT) to the first line's
1401 ;; end of the last item, we ensure the new item will be
1402 ;; inserted after the last item, and not after any of its
1403 ;; hypothetical sub-items.
1419 ;; Send ITEM at the end of the list.
1435 ;; 1. Structure returned by `org-list-insert-item' may not be
1436 ;; accurate, as it cannot see sub-items included in BODY.
1437 ;; Thus, first compute the real structure so far.
1445 ;; 1.1. Remove the item just created in structure.
1447 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1450 struct
1458 new-end
1460 moved-items))
1462 ;; 2. Eventually delete extra copy of the item and clean marker.
1469 "Outdent items between positions START and END.
1471 STRUCT is the list structure. PARENTS is the alist of items'
1472 parents, as returned by `org-list-parents-alist'.
1474 START is included, END excluded."
1480 ;; Item not yet in zone: keep association.
1482 ;; Item out of zone: follow associations in ACC.
1486 ;; Item has no parent: error
1489 ;; Parent is outdented: keep association.
1493 ;; Parent isn't outdented: reparent to grand-parent.
1495 parent struct parents)))
1501 "Indent items between positions START and END.
1503 STRUCT is the list structure. PARENTS is the alist of parents
1504 and PREVS is the alist of previous items, returned by,
1505 respectively, `org-list-parents-alist' and
1506 `org-list-prevs-alist'.
1508 START is included and END excluded.
1510 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1511 bullets between START and END."
1525 ;; Item not yet in zone: keep association.
1528 ;; Item out of zone: follow associations in ACC.
1532 ;; Item is in zone...
1534 ;; Check if bullet needs to be changed.
1537 ;; First item indented but not parent: error
1540 ;; First item and parent indented: keep same
1541 ;; parent.
1543 ;; Previous item not indented: reparent to it.
1545 ;; Previous item indented: reparent like it.
1552 ;;; Repairing structures
1555 "Non-nil if list starting at FIRST can have alphabetical bullets.
1557 STRUCT is list structure. PREVS is the alist of previous items,
1558 as returned by `org-list-prevs-alist'."
1562 ;; Pretend that bullets are uppercase and check if alphabet
1563 ;; is sufficient, taking counters into account.
1567 ;; Virtually determine current bullet
1569 ;; Counters are not case-sensitive.
1572 ;; Test if bullet would be over z or Z.
1576 ;; All items checked. All good.
1577 t))))
1580 "Increment BULLET if applicable."
1583 ;; Num bullet: increment it.
1587 nil nil bullet))
1588 ;; Alpha bullet: increment it.
1592 nil nil bullet))
1593 ;; Unordered bullet: leave it.
1597 "Verify and correct bullets in STRUCT.
1598 PREVS is the alist of previous items, as returned by
1599 `org-list-prevs-alist'.
1601 This function modifies STRUCT."
1605 ;; Set bullet of ITEM in STRUCT, depending on the type of
1606 ;; first item of the list, the previous bullet and counter
1607 ;; if any.
1616 item struct
1619 ;; Alpha counter in alpha list: use counter.
1623 ;; Use cond to be sure `string-match' is used in
1624 ;; both cases.
1630 ;; Num counter in a num list: use counter.
1635 ;; No counter: increase, if needed, previous bullet.
1638 ;; Alpha counter at first item: use counter.
1647 ;; Num counter at first item: use counter.
1652 ;; First bullet is alpha uppercase: use "A".
1655 ;; First bullet is alpha lowercase: use "a".
1658 ;; First bullet is num: use "1".
1661 ;; Not an ordered list: keep bullet.
1666 "Verify and correct indentation in STRUCT.
1668 PARENTS is the alist of parents, as returned by
1669 `org-list-parents-alist'.
1671 If numeric optional argument BULLET-SIZE is set, assume all
1672 bullets in list have this length to determine new indentation.
1674 This function modifies STRUCT."
1681 ;; Indent like parent + length of parent's bullet +
1682 ;; sub-list offset.
1688 org-list-indent-offset))
1689 ;; If no parent, indent like top-point.
1694 "Verify and correct checkboxes in STRUCT.
1696 PARENTS is the alist of parents and PREVS is the alist of
1697 previous items, as returned by, respectively,
1698 `org-list-parents-alist' and `org-list-prevs-alist'.
1700 If ORDERED is non-nil, a checkbox can only be checked when every
1701 checkbox before it is checked too. If there was an attempt to
1702 break this rule, the function will return the blocking item. In
1703 all others cases, the return value will be nil.
1705 This function modifies STRUCT."
1715 item struct
1721 ;; Parent has no boxed child: leave box as-is.
1723 parent-list)
1724 ;; 1. List all parents with a checkbox.
1731 all-items)
1732 ;; 2. Sort those parents by decreasing indentation.
1737 ;; 3. For each parent, get all children's checkboxes to determine
1738 ;; and set its checkbox accordingly.
1740 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1745 ;; There are boxes checked after an unchecked one: fix that.
1750 ;; Verify once again the structure, without ORDERED.
1752 ;; Return blocking item.
1756 "Apply set-difference between STRUCT and OLD-STRUCT to the buffer.
1758 OLD-STRUCT is the structure before any modifications, and STRUCT
1759 the structure to be applied. The function will only modify parts
1760 of the list which have changed.
1762 Initial position of cursor is restored after the changes."
1770 ;; Shift the indentation between END and BEG by DELTA.
1771 ;; Start from the line before END.
1780 ;; Skip inline tasks.
1783 ;; Shift only non-empty lines.
1790 ;; Replace ITEM first line elements with new elements from
1791 ;; STRUCT, if appropriate.
1801 ;; a. Replace bullet
1804 ;; b. Replace checkbox.
1818 ;; c. Indent item to appropriate column.
1823 ;; 1. First get list of items and position endings. We maintain
1824 ;; two alists: ITM-SHIFT, determining indentation shift needed
1825 ;; at item, and END-POS, a pseudo-alist where key is ending
1826 ;; position and value point.
1839 ;; To determine real ind of an ending position that
1840 ;; is not at an item, we have to find the item it
1841 ;; belongs to: it is the last item (ITEM-UP), whose
1842 ;; ending is further than the position we're
1843 ;; interested in.
1847 old-struct)
1848 ;; 2. Slice the items into parts that should be shifted by the
1849 ;; same amount of indentation. The slices are returned in
1850 ;; reverse order so changes modifying buffer do not change
1851 ;; positions they refer to.
1854 '<))
1862 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1863 ;; end to beginning. Take a special action when beginning is
1864 ;; at item bullet.
1871 sliced-struct))
1872 ;; 4. Go back to initial position and clean marker.
1877 "Correct bullets, checkboxes and indentation in list at point.
1878 STRUCT is the list structure. PARENTS is the alist of parents,
1879 as returned by `org-list-parents-alist'."
1880 ;; Order of functions matters here: checkboxes and endings need
1881 ;; correct indentation to be set, and indentation needs correct
1882 ;; bullets.
1883 ;;
1884 ;; 0. Save a copy of structure before modifications
1886 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1887 ;; order to get items endings and bullets properly
1889 ;; 2. Get pseudo-alist of ending positions and sort it by position.
1890 ;; Then associate them to the structure.
1897 ;; To determine real ind of an ending position that is
1898 ;; not at an item, we have to find the item it belongs
1899 ;; to: it is the last item (ITEM-UP), whose ending is
1900 ;; further than the position we're interested in.
1903 ;; Else part is for the bottom point.
1905 end-pos)
1906 end-list)))
1909 struct)
1912 ;; 3. Get bullets right.
1915 ;; 4. Now get real indentation.
1917 ;; 5. Eventually fix checkboxes.
1919 ;; 6. Apply structure modifications to buffer.
1923 ;;; Misc Tools
1926 "Call FUNCTION on each item of the list at point.
1927 FUNCTION must be called with at least one argument: INIT-VALUE,
1928 that will contain the value returned by the function at the
1929 previous item, plus ARGS extra arguments.
1931 FUNCTION is applied on items in reverse order.
1933 As an example, \(org-apply-on-list \(lambda \(result\) \(1+ result\)\) 0\)
1934 will return the number of items in the current list.
1936 Sublists of the list are skipped. Cursor is always at the
1937 beginning of the item."
1949 value))
1952 "Set visibility of ITEM in STRUCT to VIEW.
1954 Possible values are: `folded', `children' or `subtree'. See
1955 `org-cycle' for more information."
1959 ;; Hide from eol
1961 item-end t)))
1963 ;; First show everything.
1965 ;; Then fold every child.
1970 children)))
1972 ;; Show everything
1977 "Return column at which body of ITEM should start."
1987 tcol))
1990 ;;; Interactive functions
1995 "Go to the beginning of the current item.
1996 Throw an error when not in a list."
2002 "Go to the beginning item of the current list or sublist.
2003 Throw an error when not in a list."
2014 "Go to the end of the current list or sublist.
2015 Throw an error when not in a list."
2026 "Go to the end of the current item.
2027 Throw an error when not in a list."
2037 "Move to the beginning of the previous item.
2038 Throw an error when not in a list. Also throw an error when at
2039 first item, unless `org-list-use-circular-motion' is non-nil."
2055 "Move to the beginning of the next item.
2056 Throw an error when not in a list. Also throw an error when at
2057 last item, unless `org-list-use-circular-motion' is non-nil."
2073 "Move the item at point down, i.e. swap with following item.
2074 Sub-items (items with larger indentation) are considered part of
2075 the item, so this really moves item trees."
2094 "Move the item at point up, i.e. swap with previous item.
2095 Sub-items (items with larger indentation) are considered part of
2096 the item, so this really moves item trees."
2113 "Insert a new item at the current level.
2114 If cursor is before first character after bullet of the item, the
2115 new item will be created before the current one.
2117 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2119 Return t when things worked, nil when we are not in an item, or
2120 item is invisible."
2123 ;; If cursor isn't is a list or if list is invisible, return nil.
2131 ;; Timer list: delegate to `org-timer-item'.
2136 ;; If we're in a description list, ask for the new term.
2139 ;; Don't insert a checkbox if checkbox rule is applied
2140 ;; and it is a description item.
2144 org-list-automatic-rules)))))))
2151 t)))))
2154 "Fix indentation, bullets and checkboxes is the list at point."
2162 "Cycle through the different itemize/enumerate bullets.
2163 This cycle the entire list level through the sequence:
2165 `-' -> `+' -> `*' -> `1.' -> `1)'
2167 If WHICH is a valid string, use that as the new bullet. If WHICH
2168 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2169 `previous', cycle backwards."
2190 ;; Compute list of possible bullets, depending on context.
2193 ;; *-bullets are not allowed at column 0.
2196 ;; Description items cannot be numbered.
2219 ;; Use a short variation of `org-list-write-struct' as there's
2220 ;; no need to go through all the steps.
2228 "Toggle the checkbox in the current line.
2229 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2230 double prefix, set checkbox to [-].
2232 When there is an active region, toggle status or presence of the
2233 first checkbox there, and make every item inside have the same
2234 status or presence, respectively.
2236 If the cursor is in a headline, apply this to all checkbox items
2237 in the text below the heading, taking as reference the first item
2238 in subtree, ignoring drawers."
2242 block-item
2243 lim-up
2244 lim-down
2255 ;; In a region, start at first item in region.
2265 ;; On an heading, start at first item after drawers and
2266 ;; time-stamps (scheduled, etc.).
2277 ;; Just one item: set SINGLEP flag.
2283 ;; Determine the checkbox going to be applied to all items
2284 ;; within bounds.
2295 ;; When an item is found within bounds, grab the full list at
2296 ;; point structure, then: (1) set check-box of all its items
2297 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2298 ;; whole list, (3) move point after the list.
2312 e struct
2313 ;; If there is no box at item, leave as-is
2314 ;; unless function was called with C-u prefix.
2317 ref-checkbox
2318 cur-box))))
2319 items-to-toggle)
2321 struct parents prevs orderedp))
2322 ;; Report some problems due to ORDERED status of subtree.
2323 ;; If only one box was being checked, throw an error, else,
2324 ;; only signal problems.
2328 "Checkbox blocked because of unchecked box at line %d"
2332 "Checkboxes were removed due to unchecked box at line %d"
2341 "Reset all checkboxes in an entry subtree."
2358 "Update the checkbox statistics in the current section.
2359 This will find all statistic cookies like [57%] and [6/12] and
2360 update them with the current numbers.
2362 With optional prefix argument ALL, do this for the whole buffer."
2366 (box-re "^[ \t]*\\([-+*]\\|\\([0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2378 ;; Return number of checked boxes and boxes of all types
2379 ;; in all structures in STRUCTS. If RECURSIVEP is
2380 ;; non-nil, also count boxes in sub-lists. If ITEM is
2381 ;; nil, count across the whole structure, else count only
2382 ;; across subtree whose ancestor is ITEM.
2399 items))))
2402 structs)
2405 cookies-list structs-bak box-num)
2407 ;; 1. Build an alist for each cookie found within BOUNDS. The
2408 ;; key will be position at beginning of cookie and values
2409 ;; ending position, format of cookie, and a cell whose car is
2410 ;; number of checked boxes to report, and cdr total number of
2411 ;; boxes.
2421 ;; Cookie is at an heading, but specifically for todo,
2422 ;; not for checkboxes: skip it.
2428 ;; Cookie is at an heading, but all lists before next
2429 ;; heading already have been read. Use data collected
2430 ;; in STRUCTS-BAK. This should only happen when
2431 ;; heading has more than one cookie on it.
2434 backup-end))
2436 ;; Cookie is at a fresh heading. Grab structure of
2437 ;; every list containing a checkbox between point and
2438 ;; next headline, and save them in STRUCTS-BAK.
2442 structs-bak nil)
2449 ;; Cookie is at an item, and we already have list
2450 ;; structure stored in STRUCTS-BAK.
2453 ;; Only lists in no special context are stored.
2456 ;; Cookie is at an item, but we need to compute list
2457 ;; structure.
2463 ;; Else, cookie found is at a wrong place. Skip it.
2465 cookies-list))))
2466 ;; 2. Apply alist to buffer, in reverse order so positions stay
2467 ;; unchanged after cookie modifications.
2482 cookies-list))))
2485 "Select the face for checkbox statistics.
2486 The face will be `org-done' when all relevant boxes are checked.
2487 Otherwise it will be `org-todo'."
2490 'org-checkbox-statistics-done
2494 'org-checkbox-statistics-done
2498 "Update checkbox statistics unless turned off by user."
2506 "Indent a local list item including its children.
2507 When number ARG is a negative, item will be outdented, otherwise
2508 it will be indented.
2510 If a region is active, all items inside will be moved.
2512 If NO-SUBTREE is non-nil, only indent the item itself, not its
2513 children.
2515 STRUCT is the list structure.
2517 Return t if successful."
2526 ;; Are we going to move the whole list?
2533 t))))
2534 ;; Determine begin and end points of zone to indent. If moving
2535 ;; more than one item, save them for subsequent moves.
2551 ;; Special case: moving top-item with indent rule.
2559 ;; Change bullet if necessary.
2565 ;; Shift every item by OFFSET and fix bullets. Then
2566 ;; apply changes to buffer.
2570 struct)
2573 ;; Forbidden move:
2575 ;; If only one item is moved, it mustn't have a child.
2579 ;; If a subtree or region is moved, the last item
2580 ;; of the subtree mustn't have a child.
2585 struct)))))
2588 ;; Normal shifting
2596 t)
2599 "Outdent a local list item, but not its children.
2600 If a region is active, all items inside will be moved."
2608 "Indent a local list item, but not its children.
2609 If a region is active, all items inside will be moved."
2617 "Outdent a local list item including its children.
2618 If a region is active, all items inside will be moved."
2632 "Indent a local list item including its children.
2633 If a region is active, all items inside will be moved."
2648 "Cycle levels of indentation of an empty item.
2649 The first run indents the item, if applicable. Subsequents runs
2650 outdent it at meaningful levels in the list. When done, item is
2651 put back at its original position with its original bullet.
2653 Return t at each successful move."
2659 ;; Accept empty items or if cycle has already started.
2670 ;; When in the middle of the cycle, try to outdent first. If
2671 ;; it fails, and point is still at initial position, indent.
2672 ;; Else, re-create it at its original position.
2681 ;; Break cycle
2683 ;; If a cycle is starting, remember indentation and bullet,
2684 ;; then try to indent. If it fails, try to outdent.
2690 t))))
2693 "Sort list items.
2694 The cursor may be at any item of the list that should be sorted.
2695 Sublists are not sorted. Checkboxes, if any, are ignored.
2697 Sorting can be alphabetically, numerically, by date/time as given
2698 by a time stamp, by a property or by priority.
2700 Comparing entries ignores case by default. However, with an
2701 optional argument WITH-CASE, the sorting considers case as well.
2703 The command prompts for the sorting type unless it has been given
2704 to the function through the SORTING-TYPE argument, which needs to
2705 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
2706 meaning of each character:
2708 n Numerically, by converting the beginning of the item to a number.
2709 a Alphabetically. Only the first line of item is checked.
2710 t By date/time, either the first active time stamp in the entry, if
2711 any, or by the first inactive one. In a timer list, sort the timers.
2713 Capital letters will reverse the sort order.
2715 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2716 a function to be called with point at the beginning of the
2717 record. It must return either a string or a number that should
2718 serve as the sorting key for that record. It will then use
2719 COMPARE-FUNC to compare entries."
2764 ;; If it is a timer list, convert timer to seconds
2777 value))
2781 next-record
2782 end-record
2783 value-to-sort
2784 nil
2785 sort-func)
2786 ;; Read and fix list again, as `sort-subr' probably destroyed
2787 ;; its structure.
2793 ;;; Send and receive lists
2796 "Parse the list at point and maybe DELETE it.
2798 Return a list whose car is a symbol of list type, among
2799 `ordered', `unordered' and `descriptive'. Then, each item is
2800 a list whose car is counter, and cdr are strings and other
2801 sub-lists. Inside strings, check-boxes are replaced by
2804 For example, the following list:
2806 1. first item
2807 + sub-item one
2808 + [X] sub-item two
2809 more text in first item
2810 2. [@3] last item
2812 will be parsed as:
2814 \(ordered
2816 \(unordered
2822 Point is left at list end."
2828 out
2829 parse-item ; for byte-compiler
2832 ;; Return text between BEG and END, trimmed, with
2833 ;; checkboxes replaced.
2844 text)))))
2847 ;; Return a list whose car is list type and cdr a list of
2848 ;; items' body.
2854 ;; Return a list containing counter of item, if any, text
2855 ;; and any sublist inside it.
2861 ;; Get counter number. For alphabetic counter, get
2862 ;; its position in the alphabet.
2873 ;; If item has a child, store text between bullet and
2874 ;; next child, then recursively parse all sublists. At
2875 ;; the end of each sublist, check for the presence of
2876 ;; text belonging to the original item.
2886 ;; Remove children from the list just parsed.
2888 ;; There is a chunk of text belonging to the
2889 ;; item if last child doesn't end where next
2890 ;; child starts or where item ends.
2894 body))))
2897 ;; Store output, take care of cursor position and deletion of
2898 ;; list, then return output.
2907 out))
2910 "Convert the plain list at point into a subtree."
2918 "Insert a radio list template appropriate for this major mode."
2922 name pos)
2933 "Send a transformed version of this list to the receiver position.
2934 With argument MAYBE, fail quietly if no transformation is defined
2935 for this list."
2941 (unless (looking-at "[ \t]*#\\+ORGLST[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
2960 beg txt)
2964 ;; Find the insertion place
2969 name
2983 "Trim line breaks in a list ITEM."
2987 "Convert a LIST parsed through `org-list-parse-list' to other formats.
2988 Valid parameters PARAMS are:
2990 :ustart String to start an unordered list
2991 :uend String to end an unordered list
2993 :ostart String to start an ordered list
2994 :oend String to end an ordered list
2996 :dstart String to start a descriptive list
2997 :dend String to end a descriptive list
2998 :dtstart String to start a descriptive term
2999 :dtend String to end a descriptive term
3000 :ddstart String to start a description
3001 :ddend String to end a description
3003 :splice When set to t, return only list body lines, don't wrap
3004 them into :[u/o]start and :[u/o]end. Default is nil.
3006 :istart String to start a list item.
3007 :icount String to start an item with a counter.
3008 :iend String to end a list item
3009 :isep String to separate items
3010 :lsep String to separate sublists
3011 :csep String to separate text from a sub-list
3013 :cboff String to insert for an unchecked check-box
3014 :cbon String to insert for a checked check-box
3015 :cbtrans String to insert for a check-box in transitional state
3017 :nobr Non-nil means remove line breaks in lists items.
3019 Alternatively, each parameter can also be a form returning
3020 a string. These sexp can use keywords `counter' and `depth',
3021 reprensenting respectively counter associated to the current
3022 item, and depth of the current sub-list, starting at 0.
3023 Obviously, `counter' is only available for parameters applying to
3024 items."
3048 export-sublist ; for byte-compiler
3051 ;; Export an item ITEM of type TYPE, at DEPTH. First
3052 ;; string in item is treated in a special way as it can
3053 ;; bring extra information that needs to be processed.
3059 ;; Stick DTSTART to ISTART by
3060 ;; left-trimming the latter.
3064 istart))
3071 ;; Replace checkbox if any is found.
3079 ;; Replace line breaks if required
3081 ;; Insert descriptive term if TYPE is `descriptive'.
3090 first)))
3101 ;; Export sublist SUB at DEPTH.
3119 "Convert LIST into a LaTeX list.
3120 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3121 with overruling parameters for `org-list-to-generic'."
3123 list
3132 ;; LaTeX increments counter just before
3133 ;; using it, so set it to the desired
3134 ;; value, minus one.
3141 params)))
3144 "Convert LIST into a HTML list.
3145 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3146 with overruling parameters for `org-list-to-generic'."
3148 list
3160 params)))
3163 "Convert LIST into a Texinfo list.
3164 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3165 with overruling parameters for `org-list-to-generic'."
3167 list
3178 params)))
3181 "Convert LIST into an Org subtree.
3182 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3183 with overruling parameters for `org-list-to-generic'."
3193 ;; Return the string for the heading, depending on depth D
3194 ;; of current sub-list.
3199 oddeven-level)
3200 ?*)
3203 list
3205 '(:splice t
3212 params))))
3216 ;;; org-list.el ends here