| blob | 47a76c6393a7b3122d3bd572c9da54c7e49a5d87 |
1 ;;; org-list.el --- Plain lists for Org-mode
2 ;;
3 ;; Copyright (C) 2004-2012 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 core concept behind lists is their structure. A structure is
31 ;; a snapshot of the list, in the shape of a data tree (see
32 ;; `org-list-struct').
34 ;; Once the list structure is stored, it is possible to make changes
35 ;; on it that will be mirrored to the real list or to get information
36 ;; about the list, using accessors and methods provided in the
37 ;; library. Most of them require the use of one or two helper
38 ;; functions, namely `org-list-parents-alist' and
39 ;; `org-list-prevs-alist'.
41 ;; Structure is eventually applied to the buffer with
42 ;; `org-list-write-struct'. This function repairs (bullets,
43 ;; indentation, checkboxes) the list in the process. It should be
44 ;; called near the end of any function working on structures.
46 ;; Thus, a function applying to lists should usually follow this
47 ;; template:
49 ;; 1. Verify point is in a list and grab item beginning (with the same
50 ;; function `org-in-item-p'). If the function requires the cursor
51 ;; to be at item's bullet, `org-at-item-p' is more selective. It
52 ;; is also possible to move point to the closest item with
53 ;; `org-list-search-backward', or `org-list-search-forward',
54 ;; applied to the function `org-item-beginning-re'.
56 ;; 2. Get list structure with `org-list-struct'.
58 ;; 3. Compute one, or both, helper functions,
59 ;; (`org-list-parents-alist', `org-list-prevs-alist') depending on
60 ;; needed accessors.
62 ;; 4. Proceed with the modifications, using methods and accessors.
64 ;; 5. Verify and apply structure to buffer, using
65 ;; `org-list-write-struct'.
67 ;; 6. If changes made to the list might have modified check-boxes,
68 ;; call `org-update-checkbox-count-maybe'.
70 ;; Computing a structure can be a costly operation on huge lists (a
71 ;; few thousand lines long). Thus, code should follow the rule:
72 ;; "collect once, use many". As a corollary, it is usually a bad idea
73 ;; to use directly an interactive function inside the code, as those,
74 ;; being independent entities, read the whole list structure another
75 ;; time.
77 ;;; Code:
132 \f
133 ;;; Configuration variables
136 "Options concerning plain lists in Org-mode."
141 "When t, make TAB cycle visibility on plain list items.
142 Cycling plain lists works only when the cursor is on a plain list
143 item. When the cursor is on an outline heading, plain lists are
144 treated as text. This is the most stable way of handling this,
145 which is why it is the default.
147 When this is the symbol `integrate', then during cycling, plain
148 list items will *temporarily* be interpreted as outline headlines
149 with a level given by 1000+i where i is the indentation of the
150 bullet. This setting can lead to strange effects when switching
152 subtree decides what children should be listed. If that first
154 number, all true children and grand children of the outline
155 heading will be exposed in a children' view."
163 "Default bullet type installed when demoting an item.
164 This is an association list, for each bullet type, this alist will point
165 to the bullet that should be used when this item is demoted.
166 For example,
168 (setq org-list-demote-modify-bullet
171 will make
173 + Movies
174 + Silence of the Lambs
175 + My Cousin Vinny
176 + Books
177 + The Hunt for Red October
178 + The Road to Omaha
180 into
182 + Movies
183 - Silence of the Lambs
184 - My Cousin Vinny
185 + Books
186 - The Hunt for Red October
187 - The Road to Omaha"
205 "The character that makes a line with leading number an ordered list item.
206 Valid values are ?. and ?\). To get both terminators, use t."
213 "Non-nil means single character alphabetical bullets are allowed.
214 Both uppercase and lowercase are handled. Lists with more than
215 26 items will fallback to standard numbering. Alphabetical
222 "A regular expression matching bullets that should have 2 spaces after them.
223 When nil, no bullet will have two spaces after them. When
224 a string, it will be used as a regular expression. When the
225 bullet type of a list is changed, the new bullet type will be
226 matched against this regexp. If it matches, there will be two
227 spaces instead of one after the bullet in each item of the list."
234 "Non-nil means an empty line ends all plain list levels.
235 Otherwise, two of them will be necessary."
242 "Non-nil means apply set of rules when acting on lists.
243 By default, automatic actions are taken when using
248 rules by setting them to nil. Valid rules are:
250 bullet when non-nil, cycling bullet do not allow lists at
251 column 0 to have * as a bullet and descriptions lists
252 to be numbered.
253 checkbox when non-nil, checkbox statistics is updated each time
254 you either insert a new checkbox or toggle a checkbox.
255 It also prevents from inserting a checkbox in a
256 description item.
257 indent when non-nil, indenting or outdenting list top-item
258 with its subtree will move the whole list and
259 outdenting a list whose bullet is * to column 0 will
264 :key-type
269 :value-type
273 "Non-nil means commands implying motion in lists should be cyclic.
275 In that case, the item following the last item is the first one,
276 and the item preceding the first item is the last one.
286 "Hook that is run whenever Org thinks checkbox statistics should be updated.
287 This hook runs even if checkbox rule in
288 `org-list-automatic-rules' does not apply, so it can be used to
289 implement alternative ways of collecting statistics
293 "Non-nil means checkbox statistics counts only the state of direct children.
294 When nil, all boxes below the cookie are counted.
295 This can be set to nil on a per-node basis using a COOKIE_DATA property
301 "Maximum indentation for the second line of a description list.
302 When the indentation would be larger than this, it will become
303 5 characters instead."
308 "Additional indentation for sub-items in a list.
309 By setting this to a small number, usually 1 or 2, one can more
310 clearly distinguish sub-items in a list."
317 % END RECEIVE ORGLST %n
319 #+ORGLST: SEND %n org-list-to-latex
320 -
323 @c END RECEIVE ORGLST %n
324 @ignore
325 #+ORGLST: SEND %n org-list-to-texinfo
326 -
329 <!-- END RECEIVE ORGLST %n -->
330 <!--
331 #+ORGLST: SEND %n org-list-to-html
332 -
334 "Templates for radio lists in different major modes.
335 All occurrences of %n in a template will be replaced with the name of the
336 list, obtained by prompting the user."
344 "Names of blocks where lists are not allowed.
348 "Context types where lists will be interpreted during export.
350 Valid types are `drawer', `inlinetask' and `block'. More
351 specifically, type `block' is determined by the variable
355 \f
356 ;;; Predicates and regexps
360 "Regex corresponding to the end of a list.
368 "Matches a list item and puts everything into groups:
369 group 1: bullet
370 group 2: counter
371 group 3: checkbox
375 "Return the correct regular expression for plain lists."
386 "Regexp matching the beginning of a plain list item."
390 "Is point at a list item with REGEXP after bullet?"
399 ;; Ignore counter if any
404 "Is point in a context where lists are allowed?"
408 "Return item beginning position when in a plain list, nil otherwise."
420 ;; Indentation isn't meaningful when point starts at an empty
421 ;; line or an inline task.
424 10000
430 ;; Detect if cursor in amidst `org-list-end-re'. First, count
431 ;; number HL of hard lines it takes, then call `org-in-regexp'
432 ;; to compute its boundaries END-BOUNDS. When point is
433 ;; in-between, move cursor before regexp beginning.
444 ;; Look for an item, less indented that reference line.
449 ;; This is exactly what we want.
452 ;; At upper bound of search or looking at the end of a
453 ;; previous list: search is over.
456 ;; Skip blocks, drawers, inline-tasks, blank lines
466 ;; Text at column 0 cannot belong to a list: stop.
468 ;; Normal text less indented than reference line, take
469 ;; it as new reference.
476 "Is point in a line starting a hand-formatted item?"
482 "Is point at the bullet of a plain list item?"
488 "Is point at a line starting a plain list item with a timer?"
493 "Is point at a description list item?"
497 "Is point at a line starting a plain-list item with a checklet?"
501 "Is point at a line starting a plain-list item with a counter?"
507 \f
508 ;;; Structures and helper functions
511 "Determine context, and its boundaries, around point.
513 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
514 are boundaries and CONTEXT is a symbol among `drawer', `block',
515 `invalid', `inlinetask' and nil.
517 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
523 ;; Get positions of surrounding headings. This is the
524 ;; default context.
529 ;; Is point inside a drawer?
531 ;; Can't use org-drawers-regexp as this function might
532 ;; be called in buffers not in Org mode.
543 lim-down))
546 ;; Is point strictly in a block, and of which type?
557 lim-down))
563 ;; Is point in an inlinetask?
576 ;; Return context boundaries and type.
580 "Return structure of list at point.
582 A list structure is an alist where key is point at item, and
583 values are:
584 1. indentation,
585 2. bullet with trailing whitespace,
586 3. bullet counter, if any,
587 4. checkbox, if any,
588 5. description tag, if any,
589 6. position at item end.
591 Thus the following list, where numbers in parens are
592 point-at-bol:
594 - [X] first item (1)
595 1. sub-item 1 (18)
596 5. [@5] sub-item 2 (34)
597 some other text belonging to first item (55)
598 - last item (97)
599 + tag :: description (109)
600 (131)
602 will get the following structure:
610 Assume point is at an item."
625 ind itm-lst itm-lst-2 end-lst end-lst-2 struct
628 ;; Return association at point.
632 ind
639 ;; Ensure list ends at the first blank line.
643 ;; 1. Read list from starting item to its beginning, and save
644 ;; top item position and indentation in BEG-CELL. Also store
645 ;; ending position of items in END-LST.
653 ;; At upward limit: if we ended at an item, store it,
654 ;; else dismiss useless data recorded above BEG-CELL.
655 ;; Jump to part 2.
663 ;; At a verbatim block, go before its beginning. Move
664 ;; from eol to ensure `previous-single-property-change'
665 ;; will return a value.
670 ;; Looking at a list ending regexp. Dismiss useless
671 ;; data recorded above BEG-CELL. Jump to part 2.
676 ;; Point is at an item. Add data to ITM-LST. It may
677 ;; also end a previous item: save it in END-LST. If
678 ;; ind is less or equal than BEG-CELL and there is no
679 ;; end at this ind or lesser, this item becomes the new
680 ;; BEG-CELL.
687 ;; Skip blocks, drawers, inline tasks, blank lines.
698 ;; From there, point is not at an item. Interpret
699 ;; line's indentation:
700 ;; - text at column 0 is necessarily out of any list.
701 ;; Dismiss data recorded above BEG-CELL. Jump to
702 ;; part 2.
703 ;; - any other case may be an ending position for an
704 ;; hypothetical item above. Store it and proceed.
713 ;; 2. Read list from starting point to its end, that is until we
714 ;; get out of context, or that a non-item line is less or
715 ;; equally indented than BEG-CELL's cdr. Also, store ending
716 ;; position of items in END-LST-2.
723 ;; At downward limit: this is de facto the end of the
724 ;; list. Save point as an ending position, and jump to
725 ;; part 3.
728 ;; At a verbatim block, move to its end. Point is at bol
729 ;; and 'org-example property is set by whole lines:
730 ;; `next-single-property-change' always return a value.
734 ;; Looking at a list ending regexp. Save point as an
735 ;; ending position and jump to part 3.
739 ;; Point is at an item. Add data to ITM-LST-2. It may
740 ;; also end a previous item, so save it in END-LST-2.
744 ;; Skip inline tasks and blank lines along the way
749 ;; Ind is lesser or equal than BEG-CELL's. The list is
750 ;; over: store point as an ending position and jump to
751 ;; part 3.
755 ;; Else, if ind is lesser or equal than previous item's,
756 ;; this is an ending position: store it. In any case,
757 ;; skip block or drawer at point, and move to next line.
769 ;; 3. Associate each item to its end position.
771 ;; 4. Return STRUCT
772 struct)))
775 "Associate proper ending point to items in STRUCT.
777 END-LIST is a pseudo-alist where car is indentation and cdr is
778 ending position.
780 This function modifies STRUCT."
786 ;; Remove end candidates behind current item.
789 ;; Add end position to item assoc.
795 struct)))
798 "Return alist between item and previous item in STRUCT."
800 struct)))
804 struct)))
807 "Return alist between item and parent in STRUCT."
819 ;; A sub-list is over. Find the associated
820 ;; origin in IND-TO-ORI. If it cannot be
821 ;; found (ill-formed list), set its parent as
822 ;; the first item less indented. If there is
823 ;; none, make it a top-level item.
831 ind-to-ori)
834 ;; A sub-list starts. Every item at IND will
835 ;; have previous item as its parent.
840 ;; Another item in the same sub-list: it shares
841 ;; the same parent as the previous item.
846 \f
847 ;;; Accessors
850 "Return the Nth value of KEY in STRUCT."
854 "Set the Nth value of KEY in STRUCT to NEW.
859 "Return indentation of ITEM in STRUCT."
863 "Set indentation of ITEM in STRUCT to IND.
868 "Return bullet of ITEM in STRUCT."
872 "Set bullet of ITEM in STRUCT to BULLET.
877 "Return counter of ITEM in STRUCT."
881 "Return checkbox of ITEM in STRUCT or nil."
885 "Set checkbox of ITEM in STRUCT to CHECKBOX.
890 "Return end position of ITEM in STRUCT."
894 "Return end position of ITEM in STRUCT."
898 "Return point at end of ITEM in STRUCT, before any blank line.
899 Point returned is at end of line."
906 "Return parent of ITEM or nil.
907 STRUCT is the list structure. PARENTS is the alist of parents,
908 as returned by `org-list-parents-alist'."
913 "Non-nil if ITEM has a child.
915 STRUCT is the list structure.
917 Value returned is the position of the first child of ITEM."
922 child-maybe)))
925 "Return next item in same sub-list as ITEM, or nil.
926 STRUCT is the list structure. PREVS is the alist of previous
927 items, as returned by `org-list-prevs-alist'."
931 "Return previous item in same sub-list as ITEM, or nil.
932 STRUCT is the list structure. PREVS is the alist of previous
933 items, as returned by `org-list-prevs-alist'."
937 "List all items having ITEM as a common ancestor, or nil.
938 STRUCT is the list structure."
941 subtree)
946 sub-struct))
950 "List all items in the same sub-list as ITEM.
951 STRUCT is the list structure. PREVS is the alist of previous
952 items, as returned by `org-list-prevs-alist'."
955 before-item after-item)
963 "List all children of ITEM, or nil.
964 STRUCT is the list structure. PARENTS is the alist of parents,
965 as returned by `org-list-parents-alist'."
973 "Return point at beginning of list.
974 STRUCT is the list structure."
978 "Return point at bottom of list.
979 STRUCT is the list structure."
984 "Return point at beginning of sub-list ITEM belongs.
985 STRUCT is the list structure. PREVS is the alist of previous
986 items, as returned by `org-list-prevs-alist'."
990 first-item))
995 "Return point at last item of sub-list ITEM belongs.
996 STRUCT is the list structure. PREVS is the alist of previous
997 items, as returned by `org-list-prevs-alist'."
1001 last-item))
1004 "Return point at end of sub-list ITEM belongs.
1005 STRUCT is the list structure. PREVS is the alist of previous
1006 items, as returned by `org-list-prevs-alist'."
1010 "Return the type of the list containing ITEM, as a symbol.
1012 STRUCT is the list structure. PREVS is the alist of previous
1013 items, as returned by `org-list-prevs-alist'.
1015 Possible types are `descriptive', `ordered' and `unordered'. The
1016 type is determined by the first item of the list."
1024 "Return ITEM's sequence number.
1026 STRUCT is the list structure. PREVS is the alist of previous
1027 items, as returned by `org-list-prevs-alist'. PARENTS is the
1028 alist of ancestors, as returned by `org-list-parents-alist'.
1030 Return value is a list of integers. Counters have an impact on
1031 that value."
1035 ;; Return relative sequence number of ITEM in the sub-list
1036 ;; it belongs. STRUCT is the list structure. PREVS is
1037 ;; the alist of previous items.
1046 seq))
1050 ;; Cons each parent relative number into return value (OUT).
1055 ;; Return value.
1056 out)))
1059 \f
1060 ;;; Searching
1063 "Search a string in valid contexts for lists.
1064 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1065 in `re-search-forward'."
1069 ;; 1. No match: return to origin or bound, depending on NOERR.
1072 nil)))
1073 ;; 2. Match in valid context: return point. Else, continue
1074 ;; searching.
1078 "Like `re-search-backward' but stop only where lists are recognized.
1079 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1080 `re-search-backward'."
1085 "Like `re-search-forward' but stop only where lists are recognized.
1086 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1087 `re-search-forward'."
1092 \f
1093 ;;; Methods on structures
1096 "Return BULLET with the correct number of whitespaces.
1097 It determines the number of whitespaces to append by looking at
1098 `org-list-two-spaces-after-bullet-regexp'."
1102 org-list-two-spaces-after-bullet-regexp bullet))
1103 " "
1109 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1110 Blank lines at the end of items are left in place. Return the
1111 new structure after the changes.
1113 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1114 to the same sub-list.
1116 This function modifies STRUCT."
1129 ;; 1. Move effectively items in buffer.
1133 ;; 2. Now modify struct. No need to re-read the list, the
1134 ;; transformation is just a shift of positions. Some special
1135 ;; attention is required for items ending at END-A and END-B
1136 ;; as empty spaces are not moved there. In others words,
1137 ;; item BEG-A will end with whitespaces that were at the end
1138 ;; of BEG-B and the same applies to BEG-B.
1160 struct)
1164 "Return number of blank lines that should separate items in list.
1166 POS is the position of point where `org-list-insert-item' was called.
1168 STRUCT is the list structure. PREVS is the alist of previous
1169 items, as returned by `org-list-prevs-alist'.
1171 Assume point is at item's beginning. If the item is alone, apply
1172 some heuristics to guess the result."
1177 usr-blank
1181 ;; Count blank lines above beginning of line.
1188 ;; Trivial cases where there should be none.
1190 ;; When `org-blank-before-new-entry' says so, it is 1.
1192 ;; `plain-list-item' is 'auto. Count blank lines separating
1193 ;; neighbours items in list.
1196 ;; Is there a next item?
1199 ;; Is there a previous item?
1202 ;; User inserted blank lines, trust him.
1207 usr-blank)
1208 ;; Are there blank lines inside the list so far?
1214 ;; Default choice: no blank line.
1218 "Insert a new list item at POS and return the new structure.
1219 If POS is before first character after bullet of the item, the
1220 new item will be created before the current one.
1222 STRUCT is the list structure. PREVS is the the alist of previous
1223 items, as returned by `org-list-prevs-alist'.
1225 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1226 after the bullet. Cursor will be after this text once the
1227 function ends.
1229 This function modifies STRUCT."
1231 ;; 1. Get information about list: position of point with regards
1232 ;; to item start (BEFOREP), blank lines number separating items
1233 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1241 pos struct prevs))
1242 ;; 2. Build the new item to be created. Concatenate same
1243 ;; bullet as item, checkbox, text AFTER-BULLET if
1244 ;; provided, and text cut from point to end of item
1245 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1246 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1247 ;; between what was cut and what was inserted in buffer
1248 ;; is stored in SIZE-OFFSET.
1252 ind))
1259 ;; If POS is greater than ITEM-END, then point is
1260 ;; in some white lines after the end of the list.
1261 ;; Those must be removed, or they will be left,
1262 ;; stacking up after the list.
1272 text-cut))))
1276 ;; 4. Insert effectively item into buffer.
1280 ;; 5. Add new item to STRUCT.
1284 ;; Before inserted item, positions don't change but
1285 ;; an item ending after insertion has its end shifted
1286 ;; by SIZE-OFFSET.
1289 ;; Trivial cases where current item isn't split in
1290 ;; two. Just shift every item after new one by
1291 ;; ITEM-SIZE.
1295 ;; Item is split in two: elements before POS are just
1296 ;; shifted by ITEM-SIZE. In the case item would end
1297 ;; after split POS, ending is only shifted by
1298 ;; SIZE-OFFSET.
1304 ;; Elements after POS are moved into new item.
1305 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1306 ;; doesn't appear in buffer yet.
1312 (+ end size-offset
1314 ;; Elements at ITEM-END or after are only shifted by
1315 ;; SIZE-OFFSET.
1318 struct)
1321 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1322 ;; exchange ITEM with the next item in list. Position cursor
1323 ;; after bullet, counter, checkbox, and label.
1329 struct)))
1332 "Remove ITEM from the list and return the new structure.
1334 STRUCT is the list structure."
1337 ;; If ITEM ends with the list, delete blank lines
1338 ;; before it.
1343 item)))
1344 ;; Remove item from buffer.
1346 ;; Remove item from structure and shift others items accordingly.
1347 ;; Don't forget to shift also ending position when appropriate.
1365 struct)))))
1368 "Send ITEM to destination DEST.
1370 STRUCT is the list structure.
1372 DEST can have various values.
1374 If DEST is a buffer position, the function will assume it points
1375 to another item in the same list as ITEM, and will move the
1376 latter just before the former.
1378 If DEST is `begin' \(respectively `end'\), ITEM will be moved at
1379 the beginning \(respectively end\) of the list it belongs to.
1382 be moved at the Nth position in the list.
1384 If DEST is `kill', ITEM will be deleted and its body will be
1385 added to the kill-ring.
1387 If DEST is `delete', ITEM will be deleted.
1389 This function returns, destructively, the new list structure."
1392 ;; Grab full item body minus its bullet.
1401 item-end)))
1402 ;; Change DEST into a buffer position. A trick is needed
1403 ;; when ITEM is meant to be sent at the end of the list.
1404 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1405 ;; nil and insertion point (INS-POINT) to the first line's
1406 ;; end of the last item, we ensure the new item will be
1407 ;; inserted after the last item, and not after any of its
1408 ;; hypothetical sub-items.
1424 ;; Send ITEM at the end of the list.
1440 ;; 1. Structure returned by `org-list-insert-item' may not be
1441 ;; accurate, as it cannot see sub-items included in BODY.
1442 ;; Thus, first compute the real structure so far.
1450 ;; 1.1. Remove the item just created in structure.
1452 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1455 struct
1463 new-end
1465 moved-items))
1467 ;; 2. Eventually delete extra copy of the item and clean marker.
1474 "Outdent items between positions START and END.
1476 STRUCT is the list structure. PARENTS is the alist of items'
1477 parents, as returned by `org-list-parents-alist'.
1479 START is included, END excluded."
1485 ;; Item not yet in zone: keep association.
1487 ;; Item out of zone: follow associations in ACC.
1491 ;; Item has no parent: error
1494 ;; Parent is outdented: keep association.
1498 ;; Parent isn't outdented: reparent to grand-parent.
1500 parent struct parents)))
1506 "Indent items between positions START and END.
1508 STRUCT is the list structure. PARENTS is the alist of parents
1509 and PREVS is the alist of previous items, returned by,
1510 respectively, `org-list-parents-alist' and
1511 `org-list-prevs-alist'.
1513 START is included and END excluded.
1515 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1516 bullets between START and END."
1530 ;; Item not yet in zone: keep association.
1533 ;; Item out of zone: follow associations in ACC.
1537 ;; Item is in zone...
1539 ;; Check if bullet needs to be changed.
1542 ;; First item indented but not parent: error
1545 ;; First item and parent indented: keep same
1546 ;; parent.
1548 ;; Previous item not indented: reparent to it.
1550 ;; Previous item indented: reparent like it.
1557 \f
1558 ;;; Repairing structures
1561 "Non-nil if list starting at FIRST can have alphabetical bullets.
1563 STRUCT is list structure. PREVS is the alist of previous items,
1564 as returned by `org-list-prevs-alist'."
1568 ;; Pretend that bullets are uppercase and check if alphabet
1569 ;; is sufficient, taking counters into account.
1573 ;; Virtually determine current bullet
1575 ;; Counters are not case-sensitive.
1578 ;; Test if bullet would be over z or Z.
1582 ;; All items checked. All good.
1583 t))))
1586 "Increment BULLET if applicable."
1589 ;; Num bullet: increment it.
1593 nil nil bullet))
1594 ;; Alpha bullet: increment it.
1598 nil nil bullet))
1599 ;; Unordered bullet: leave it.
1603 "Verify and correct bullets in STRUCT.
1604 PREVS is the alist of previous items, as returned by
1605 `org-list-prevs-alist'.
1607 This function modifies STRUCT."
1611 ;; Set bullet of ITEM in STRUCT, depending on the type of
1612 ;; first item of the list, the previous bullet and counter
1613 ;; if any.
1622 item struct
1625 ;; Alpha counter in alpha list: use counter.
1629 ;; Use cond to be sure `string-match' is used in
1630 ;; both cases.
1636 ;; Num counter in a num list: use counter.
1641 ;; No counter: increase, if needed, previous bullet.
1644 ;; Alpha counter at first item: use counter.
1653 ;; Num counter at first item: use counter.
1658 ;; First bullet is alpha uppercase: use "A".
1661 ;; First bullet is alpha lowercase: use "a".
1664 ;; First bullet is num: use "1".
1667 ;; Not an ordered list: keep bullet.
1672 "Verify and correct indentation in STRUCT.
1674 PARENTS is the alist of parents, as returned by
1675 `org-list-parents-alist'.
1677 If numeric optional argument BULLET-SIZE is set, assume all
1678 bullets in list have this length to determine new indentation.
1680 This function modifies STRUCT."
1687 ;; Indent like parent + length of parent's bullet +
1688 ;; sub-list offset.
1694 org-list-indent-offset))
1695 ;; If no parent, indent like top-point.
1700 "Verify and correct checkboxes in STRUCT.
1702 PARENTS is the alist of parents and PREVS is the alist of
1703 previous items, as returned by, respectively,
1704 `org-list-parents-alist' and `org-list-prevs-alist'.
1706 If ORDERED is non-nil, a checkbox can only be checked when every
1707 checkbox before it is checked too. If there was an attempt to
1708 break this rule, the function will return the blocking item. In
1709 all others cases, the return value will be nil.
1711 This function modifies STRUCT."
1721 item struct
1727 ;; Parent has no boxed child: leave box as-is.
1729 parent-list)
1730 ;; 1. List all parents with a checkbox.
1737 all-items)
1738 ;; 2. Sort those parents by decreasing indentation.
1743 ;; 3. For each parent, get all children's checkboxes to determine
1744 ;; and set its checkbox accordingly.
1746 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1751 ;; There are boxes checked after an unchecked one: fix that.
1756 ;; Verify once again the structure, without ORDERED.
1758 ;; Return blocking item.
1762 "Verify and correct each item end position in STRUCT.
1764 This function modifies STRUCT."
1771 ;; To determine real ind of an ending position that is
1772 ;; not at an item, we have to find the item it belongs
1773 ;; to: it is the last item (ITEM-UP), whose ending is
1774 ;; further than the position we're interested in.
1777 ;; Else part is for the bottom point.
1779 end-pos)
1780 end-list)))
1783 struct)
1788 "Apply set difference between STRUCT and OLD-STRUCT to the buffer.
1790 OLD-STRUCT is the structure before any modifications, and STRUCT
1791 the structure to be applied. The function will only modify parts
1792 of the list which have changed.
1794 Initial position of cursor is restored after the changes."
1802 ;; Shift the indentation between END and BEG by DELTA.
1803 ;; Start from the line before END.
1812 ;; Skip inline tasks.
1815 ;; Shift only non-empty lines.
1822 ;; Replace ITEM first line elements with new elements from
1823 ;; STRUCT, if appropriate.
1833 ;; a. Replace bullet
1836 ;; b. Replace checkbox.
1850 ;; c. Indent item to appropriate column.
1855 ;; 1. First get list of items and position endings. We maintain
1856 ;; two alists: ITM-SHIFT, determining indentation shift needed
1857 ;; at item, and END-POS, a pseudo-alist where key is ending
1858 ;; position and value point.
1871 ;; To determine real ind of an ending position that
1872 ;; is not at an item, we have to find the item it
1873 ;; belongs to: it is the last item (ITEM-UP), whose
1874 ;; ending is further than the position we're
1875 ;; interested in.
1879 old-struct)
1880 ;; 2. Slice the items into parts that should be shifted by the
1881 ;; same amount of indentation. The slices are returned in
1882 ;; reverse order so changes modifying buffer do not change
1883 ;; positions they refer to.
1886 '<))
1894 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1895 ;; end to beginning. Take a special action when beginning is
1896 ;; at item bullet.
1903 sliced-struct))
1904 ;; 4. Go back to initial position and clean marker.
1909 "Correct bullets, checkboxes and indentation in list at point.
1911 STRUCT is the list structure. PARENTS is the alist of parents,
1912 as returned by `org-list-parents-alist'.
1914 When non-nil, optional argument OLD-STRUCT is the reference
1915 structure of the list. It should be provided whenever STRUCT
1916 doesn't correspond anymore to the real list in buffer."
1917 ;; Order of functions matters here: checkboxes and endings need
1918 ;; correct indentation to be set, and indentation needs correct
1919 ;; bullets.
1920 ;;
1921 ;; 0. Save a copy of structure before modifications
1923 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1924 ;; order to get items endings and bullets properly
1926 ;; 2. Fix each item end to get correct prevs alist.
1928 ;; 3. Get bullets right.
1931 ;; 4. Now get real indentation.
1933 ;; 5. Eventually fix checkboxes.
1935 ;; 6. Apply structure modifications to buffer.
1939 \f
1940 ;;; Misc Tools
1943 "Call FUNCTION on each item of the list at point.
1944 FUNCTION must be called with at least one argument: INIT-VALUE,
1945 that will contain the value returned by the function at the
1946 previous item, plus ARGS extra arguments.
1948 FUNCTION is applied on items in reverse order.
1950 As an example, \(org-apply-on-list \(lambda \(result\) \(1+ result\)\) 0\)
1951 will return the number of items in the current list.
1953 Sublists of the list are skipped. Cursor is always at the
1954 beginning of the item."
1966 value))
1969 "Set visibility of ITEM in STRUCT to VIEW.
1971 Possible values are: `folded', `children' or `subtree'. See
1972 `org-cycle' for more information."
1976 ;; Hide from eol
1978 item-end t)))
1980 ;; First show everything.
1982 ;; Then fold every child.
1987 children)))
1989 ;; Show everything
1994 "Return column at which body of ITEM should start."
2004 tcol))
2007 \f
2008 ;;; Interactive functions
2013 "Go to the beginning of the current item.
2014 Throw an error when not in a list."
2020 "Go to the beginning item of the current list or sublist.
2021 Throw an error when not in a list."
2032 "Go to the end of the current list or sublist.
2033 Throw an error when not in a list."
2044 "Go to the end of the current item.
2045 Throw an error when not in a list."
2055 "Move to the beginning of the previous item.
2056 Throw an error when not in a list. Also throw an error when at
2057 first item, unless `org-list-use-circular-motion' is non-nil."
2073 "Move to the beginning of the next item.
2074 Throw an error when not in a list. Also throw an error when at
2075 last item, unless `org-list-use-circular-motion' is non-nil."
2091 "Move the item at point down, i.e. swap with following item.
2092 Sub-items (items with larger indentation) are considered part of
2093 the item, so this really moves item trees."
2112 "Move the item at point up, i.e. swap with previous item.
2113 Sub-items (items with larger indentation) are considered part of
2114 the item, so this really moves item trees."
2131 "Insert a new item at the current level.
2132 If cursor is before first character after bullet of the item, the
2133 new item will be created before the current one.
2135 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2137 Return t when things worked, nil when we are not in an item, or
2138 item is invisible."
2141 ;; If cursor isn't is a list or if list is invisible, return nil.
2149 ;; Timer list: delegate to `org-timer-item'.
2154 ;; If we're in a description list, ask for the new term.
2157 ;; Don't insert a checkbox if checkbox rule is applied
2158 ;; and it is a description item.
2162 org-list-automatic-rules)))))))
2169 t)))))
2172 "Mark the current list.
2173 If this is a sublist, only mark the sublist."
2184 "Fix indentation, bullets and checkboxes is the list at point."
2192 "Cycle through the different itemize/enumerate bullets.
2193 This cycle the entire list level through the sequence:
2195 `-' -> `+' -> `*' -> `1.' -> `1)'
2197 If WHICH is a valid string, use that as the new bullet. If WHICH
2198 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2199 `previous', cycle backwards."
2220 ;; Compute list of possible bullets, depending on context.
2223 ;; *-bullets are not allowed at column 0.
2226 ;; Description items cannot be numbered.
2249 ;; Use a short variation of `org-list-write-struct' as there's
2250 ;; no need to go through all the steps.
2258 "Toggle the checkbox in the current line.
2259 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2260 double prefix, set checkbox to [-].
2262 When there is an active region, toggle status or presence of the
2263 first checkbox there, and make every item inside have the same
2264 status or presence, respectively.
2266 If the cursor is in a headline, apply this to all checkbox items
2267 in the text below the heading, taking as reference the first item
2268 in subtree, ignoring drawers."
2272 block-item
2273 lim-up
2274 lim-down
2285 ;; In a region, start at first item in region.
2295 ;; On an heading, start at first item after drawers and
2296 ;; time-stamps (scheduled, etc.).
2307 ;; Just one item: set SINGLEP flag.
2313 ;; Determine the checkbox going to be applied to all items
2314 ;; within bounds.
2325 ;; When an item is found within bounds, grab the full list at
2326 ;; point structure, then: (1) set check-box of all its items
2327 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2328 ;; whole list, (3) move point after the list.
2342 e struct
2343 ;; If there is no box at item, leave as-is
2344 ;; unless function was called with C-u prefix.
2347 ref-checkbox
2348 cur-box))))
2349 items-to-toggle)
2351 struct parents prevs orderedp))
2352 ;; Report some problems due to ORDERED status of subtree.
2353 ;; If only one box was being checked, throw an error, else,
2354 ;; only signal problems.
2358 "Checkbox blocked because of unchecked box at line %d"
2362 "Checkboxes were removed due to unchecked box at line %d"
2371 "Reset all checkboxes in an entry subtree."
2388 "Update the checkbox statistics in the current section.
2389 This will find all statistic cookies like [57%] and [6/12] and
2390 update them with the current numbers.
2392 With optional prefix argument ALL, do this for the whole buffer."
2396 (box-re "^[ \t]*\\([-+*]\\|\\([0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2408 ;; Return number of checked boxes and boxes of all types
2409 ;; in all structures in STRUCTS. If RECURSIVEP is
2410 ;; non-nil, also count boxes in sub-lists. If ITEM is
2411 ;; nil, count across the whole structure, else count only
2412 ;; across subtree whose ancestor is ITEM.
2429 items))))
2432 structs)
2435 cookies-list structs-bak box-num)
2437 ;; 1. Build an alist for each cookie found within BOUNDS. The
2438 ;; key will be position at beginning of cookie and values
2439 ;; ending position, format of cookie, and a cell whose car is
2440 ;; number of checked boxes to report, and cdr total number of
2441 ;; boxes.
2451 ;; Cookie is at an heading, but specifically for todo,
2452 ;; not for checkboxes: skip it.
2458 ;; Cookie is at an heading, but all lists before next
2459 ;; heading already have been read. Use data collected
2460 ;; in STRUCTS-BAK. This should only happen when
2461 ;; heading has more than one cookie on it.
2464 backup-end))
2466 ;; Cookie is at a fresh heading. Grab structure of
2467 ;; every list containing a checkbox between point and
2468 ;; next headline, and save them in STRUCTS-BAK.
2472 structs-bak nil)
2479 ;; Cookie is at an item, and we already have list
2480 ;; structure stored in STRUCTS-BAK.
2483 ;; Only lists in no special context are stored.
2486 ;; Cookie is at an item, but we need to compute list
2487 ;; structure.
2493 ;; Else, cookie found is at a wrong place. Skip it.
2495 cookies-list))))
2496 ;; 2. Apply alist to buffer, in reverse order so positions stay
2497 ;; unchanged after cookie modifications.
2512 cookies-list))))
2515 "Select the face for checkbox statistics.
2516 The face will be `org-done' when all relevant boxes are checked.
2517 Otherwise it will be `org-todo'."
2520 'org-checkbox-statistics-done
2524 'org-checkbox-statistics-done
2528 "Update checkbox statistics unless turned off by user.
2529 With an optional argument ALL, update them in the whole buffer."
2537 "Indent a local list item including its children.
2538 When number ARG is a negative, item will be outdented, otherwise
2539 it will be indented.
2541 If a region is active, all items inside will be moved.
2543 If NO-SUBTREE is non-nil, only indent the item itself, not its
2544 children.
2546 STRUCT is the list structure.
2548 Return t if successful."
2557 ;; Are we going to move the whole list?
2564 t))))
2565 ;; Determine begin and end points of zone to indent. If moving
2566 ;; more than one item, save them for subsequent moves.
2582 ;; Special case: moving top-item with indent rule.
2590 ;; Change bullet if necessary.
2596 ;; Shift every item by OFFSET and fix bullets. Then
2597 ;; apply changes to buffer.
2601 struct)
2604 ;; Forbidden move:
2606 ;; If only one item is moved, it mustn't have a child.
2610 ;; If a subtree or region is moved, the last item
2611 ;; of the subtree mustn't have a child.
2616 struct)))))
2619 ;; Normal shifting
2627 t)
2630 "Outdent a local list item, but not its children.
2631 If a region is active, all items inside will be moved."
2639 "Indent a local list item, but not its children.
2640 If a region is active, all items inside will be moved."
2648 "Outdent a local list item including its children.
2649 If a region is active, all items inside will be moved."
2663 "Indent a local list item including its children.
2664 If a region is active, all items inside will be moved."
2679 "Cycle levels of indentation of an empty item.
2680 The first run indents the item, if applicable. Subsequent runs
2681 outdent it at meaningful levels in the list. When done, item is
2682 put back at its original position with its original bullet.
2684 Return t at each successful move."
2690 ;; Accept empty items or if cycle has already started.
2701 ;; When in the middle of the cycle, try to outdent first. If
2702 ;; it fails, and point is still at initial position, indent.
2703 ;; Else, re-create it at its original position.
2712 ;; Break cycle
2714 ;; If a cycle is starting, remember indentation and bullet,
2715 ;; then try to indent. If it fails, try to outdent.
2721 t))))
2724 "Sort list items.
2725 The cursor may be at any item of the list that should be sorted.
2726 Sublists are not sorted. Checkboxes, if any, are ignored.
2728 Sorting can be alphabetically, numerically, by date/time as given
2729 by a time stamp, by a property or by priority.
2731 Comparing entries ignores case by default. However, with an
2732 optional argument WITH-CASE, the sorting considers case as well.
2734 The command prompts for the sorting type unless it has been given
2735 to the function through the SORTING-TYPE argument, which needs to
2736 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
2737 meaning of each character:
2739 n Numerically, by converting the beginning of the item to a number.
2740 a Alphabetically. Only the first line of item is checked.
2741 t By date/time, either the first active time stamp in the entry, if
2742 any, or by the first inactive one. In a timer list, sort the timers.
2744 Capital letters will reverse the sort order.
2746 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2747 a function to be called with point at the beginning of the
2748 record. It must return either a string or a number that should
2749 serve as the sorting key for that record. It will then use
2750 COMPARE-FUNC to compare entries."
2795 ;; If it is a timer list, convert timer to seconds
2808 value))
2812 next-record
2813 end-record
2814 value-to-sort
2815 nil
2816 sort-func)
2817 ;; Read and fix list again, as `sort-subr' probably destroyed
2818 ;; its structure.
2824 \f
2825 ;;; Send and receive lists
2828 "Parse the list at point and maybe DELETE it.
2830 Return a list whose car is a symbol of list type, among
2831 `ordered', `unordered' and `descriptive'. Then, each item is
2832 a list whose car is counter, and cdr are strings and other
2833 sub-lists. Inside strings, check-boxes are replaced by
2836 For example, the following list:
2838 1. first item
2839 + sub-item one
2840 + [X] sub-item two
2841 more text in first item
2842 2. [@3] last item
2844 will be parsed as:
2846 \(ordered
2848 \(unordered
2854 Point is left at list end."
2860 out
2861 parse-item ; for byte-compiler
2864 ;; Return text between BEG and END, trimmed, with
2865 ;; checkboxes replaced.
2876 text)))))
2879 ;; Return a list whose car is list type and cdr a list of
2880 ;; items' body.
2886 ;; Return a list containing counter of item, if any, text
2887 ;; and any sublist inside it.
2893 ;; Get counter number. For alphabetic counter, get
2894 ;; its position in the alphabet.
2905 ;; If item has a child, store text between bullet and
2906 ;; next child, then recursively parse all sublists. At
2907 ;; the end of each sublist, check for the presence of
2908 ;; text belonging to the original item.
2918 ;; Remove children from the list just parsed.
2920 ;; There is a chunk of text belonging to the
2921 ;; item if last child doesn't end where next
2922 ;; child starts or where item ends.
2926 body))))
2929 ;; Store output, take care of cursor position and deletion of
2930 ;; list, then return output.
2937 out))
2940 "Convert the plain list at point into a subtree."
2948 "Insert a radio list template appropriate for this major mode."
2952 name pos)
2963 "Send a transformed version of this list to the receiver position.
2964 With argument MAYBE, fail quietly if no transformation is defined
2965 for this list."
2971 (unless (looking-at "[ \t]*#\\+ORGLST[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
2990 beg txt)
2994 ;; Find the insertion place
2999 name
3013 "Trim line breaks in a list ITEM."
3017 "Convert a LIST parsed through `org-list-parse-list' to other formats.
3018 Valid parameters PARAMS are:
3020 :ustart String to start an unordered list
3021 :uend String to end an unordered list
3023 :ostart String to start an ordered list
3024 :oend String to end an ordered list
3026 :dstart String to start a descriptive list
3027 :dend String to end a descriptive list
3028 :dtstart String to start a descriptive term
3029 :dtend String to end a descriptive term
3030 :ddstart String to start a description
3031 :ddend String to end a description
3033 :splice When set to t, return only list body lines, don't wrap
3034 them into :[u/o]start and :[u/o]end. Default is nil.
3036 :istart String to start a list item.
3037 :icount String to start an item with a counter.
3038 :iend String to end a list item
3039 :isep String to separate items
3040 :lsep String to separate sublists
3041 :csep String to separate text from a sub-list
3043 :cboff String to insert for an unchecked check-box
3044 :cbon String to insert for a checked check-box
3045 :cbtrans String to insert for a check-box in transitional state
3047 :nobr Non-nil means remove line breaks in lists items.
3049 Alternatively, each parameter can also be a form returning
3050 a string. These sexp can use keywords `counter' and `depth',
3051 representing respectively counter associated to the current
3052 item, and depth of the current sub-list, starting at 0.
3053 Obviously, `counter' is only available for parameters applying to
3054 items."
3078 export-sublist ; for byte-compiler
3081 ;; Export an item ITEM of type TYPE, at DEPTH. First
3082 ;; string in item is treated in a special way as it can
3083 ;; bring extra information that needs to be processed.
3089 ;; Stick DTSTART to ISTART by
3090 ;; left-trimming the latter.
3094 istart))
3101 ;; Replace checkbox if any is found.
3109 ;; Replace line breaks if required
3111 ;; Insert descriptive term if TYPE is `descriptive'.
3120 first)))
3131 ;; Export sublist SUB at DEPTH.
3149 "Convert LIST into a LaTeX list.
3150 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3151 with overruling parameters for `org-list-to-generic'."
3153 list
3162 ;; LaTeX increments counter just before
3163 ;; using it, so set it to the desired
3164 ;; value, minus one.
3171 params)))
3174 "Convert LIST into a HTML list.
3175 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3176 with overruling parameters for `org-list-to-generic'."
3178 list
3190 params)))
3193 "Convert LIST into a Texinfo list.
3194 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3195 with overruling parameters for `org-list-to-generic'."
3197 list
3208 params)))
3211 "Convert LIST into an Org subtree.
3212 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3213 with overruling parameters for `org-list-to-generic'."
3223 ;; Return the string for the heading, depending on depth D
3224 ;; of current sub-list.
3229 oddeven-level)
3230 ?*)
3233 list
3235 '(:splice t
3242 params))))
3246 ;;; org-list.el ends here