| blob | 882ce3d245ac89a6fe6d8f1ddc98d6d6bccd87e1 |
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.
686 ;; Skip blocks, drawers, inline tasks, blank lines.
697 ;; From there, point is not at an item. Interpret
698 ;; line's indentation:
699 ;; - text at column 0 is necessarily out of any list.
700 ;; Dismiss data recorded above BEG-CELL. Jump to
701 ;; part 2.
702 ;; - any other case may be an ending position for an
703 ;; hypothetical item above. Store it and proceed.
712 ;; 2. Read list from starting point to its end, that is until we
713 ;; get out of context, or that a non-item line is less or
714 ;; equally indented than BEG-CELL's cdr. Also, store ending
715 ;; position of items in END-LST-2.
722 ;; At downward limit: this is de facto the end of the
723 ;; list. Save point as an ending position, and jump to
724 ;; part 3.
727 ;; At a verbatim block, move to its end. Point is at bol
728 ;; and 'org-example property is set by whole lines:
729 ;; `next-single-property-change' always return a value.
733 ;; Looking at a list ending regexp. Save point as an
734 ;; ending position and jump to part 3.
738 ;; Point is at an item. Add data to ITM-LST-2. It may
739 ;; also end a previous item, so save it in END-LST-2.
743 ;; Skip inline tasks and blank lines along the way
748 ;; Ind is lesser or equal than BEG-CELL's. The list is
749 ;; over: store point as an ending position and jump to
750 ;; part 3.
754 ;; Else, if ind is lesser or equal than previous item's,
755 ;; this is an ending position: store it. In any case,
756 ;; skip block or drawer at point, and move to next line.
768 ;; 3. Associate each item to its end position.
770 ;; 4. Return STRUCT
771 struct)))
774 "Associate proper ending point to items in STRUCT.
776 END-LIST is a pseudo-alist where car is indentation and cdr is
777 ending position.
779 This function modifies STRUCT."
785 ;; Remove end candidates behind current item.
788 ;; Add end position to item assoc.
794 struct)))
797 "Return alist between item and previous item in STRUCT."
799 struct)))
803 struct)))
806 "Return alist between item and parent in STRUCT."
818 ;; A sub-list is over. Find the associated
819 ;; origin in IND-TO-ORI. If it cannot be
820 ;; found (ill-formed list), set its parent as
821 ;; the first item less indented. If there is
822 ;; none, make it a top-level item.
830 ind-to-ori)
833 ;; A sub-list starts. Every item at IND will
834 ;; have previous item as its parent.
839 ;; Another item in the same sub-list: it shares
840 ;; the same parent as the previous item.
845 \f
846 ;;; Accessors
849 "Return the Nth value of KEY in STRUCT."
853 "Set the Nth value of KEY in STRUCT to NEW.
858 "Return indentation of ITEM in STRUCT."
862 "Set indentation of ITEM in STRUCT to IND.
867 "Return bullet of ITEM in STRUCT."
871 "Set bullet of ITEM in STRUCT to BULLET.
876 "Return counter of ITEM in STRUCT."
880 "Return checkbox of ITEM in STRUCT or nil."
884 "Set checkbox of ITEM in STRUCT to CHECKBOX.
889 "Return end position of ITEM in STRUCT."
893 "Return end position of ITEM in STRUCT."
897 "Return point at end of ITEM in STRUCT, before any blank line.
898 Point returned is at end of line."
905 "Return parent of ITEM or nil.
906 STRUCT is the list structure. PARENTS is the alist of parents,
907 as returned by `org-list-parents-alist'."
912 "Non-nil if ITEM has a child.
914 STRUCT is the list structure.
916 Value returned is the position of the first child of ITEM."
921 child-maybe)))
924 "Return next item in same sub-list as ITEM, or nil.
925 STRUCT is the list structure. PREVS is the alist of previous
926 items, as returned by `org-list-prevs-alist'."
930 "Return previous item in same sub-list as ITEM, or nil.
931 STRUCT is the list structure. PREVS is the alist of previous
932 items, as returned by `org-list-prevs-alist'."
936 "List all items having ITEM as a common ancestor, or nil.
937 STRUCT is the list structure."
940 subtree)
945 sub-struct))
949 "List all items in the same sub-list as ITEM.
950 STRUCT is the list structure. PREVS is the alist of previous
951 items, as returned by `org-list-prevs-alist'."
954 before-item after-item)
962 "List all children of ITEM, or nil.
963 STRUCT is the list structure. PARENTS is the alist of parents,
964 as returned by `org-list-parents-alist'."
972 "Return point at beginning of list.
973 STRUCT is the list structure."
977 "Return point at bottom of list.
978 STRUCT is the list structure."
983 "Return point at beginning of sub-list ITEM belongs.
984 STRUCT is the list structure. PREVS is the alist of previous
985 items, as returned by `org-list-prevs-alist'."
989 first-item))
994 "Return point at last item of sub-list ITEM belongs.
995 STRUCT is the list structure. PREVS is the alist of previous
996 items, as returned by `org-list-prevs-alist'."
1000 last-item))
1003 "Return point at end of sub-list ITEM belongs.
1004 STRUCT is the list structure. PREVS is the alist of previous
1005 items, as returned by `org-list-prevs-alist'."
1009 "Return the type of the list containing ITEM, as a symbol.
1011 STRUCT is the list structure. PREVS is the alist of previous
1012 items, as returned by `org-list-prevs-alist'.
1014 Possible types are `descriptive', `ordered' and `unordered'. The
1015 type is determined by the first item of the list."
1023 "Return ITEM's sequence number.
1025 STRUCT is the list structure. PREVS is the alist of previous
1026 items, as returned by `org-list-prevs-alist'. PARENTS is the
1027 alist of ancestors, as returned by `org-list-parents-alist'.
1029 Return value is a list of integers. Counters have an impact on
1030 that value."
1034 ;; Return relative sequence number of ITEM in the sub-list
1035 ;; it belongs. STRUCT is the list structure. PREVS is
1036 ;; the alist of previous items.
1045 seq))
1049 ;; Cons each parent relative number into return value (OUT).
1054 ;; Return value.
1055 out)))
1058 \f
1059 ;;; Searching
1062 "Search a string in valid contexts for lists.
1063 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1064 in `re-search-forward'."
1068 ;; 1. No match: return to origin or bound, depending on NOERR.
1071 nil)))
1072 ;; 2. Match in valid context: return point. Else, continue
1073 ;; searching.
1077 "Like `re-search-backward' but stop only where lists are recognized.
1078 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1079 `re-search-backward'."
1084 "Like `re-search-forward' but stop only where lists are recognized.
1085 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1086 `re-search-forward'."
1091 \f
1092 ;;; Methods on structures
1095 "Return BULLET with the correct number of whitespaces.
1096 It determines the number of whitespaces to append by looking at
1097 `org-list-two-spaces-after-bullet-regexp'."
1101 org-list-two-spaces-after-bullet-regexp bullet))
1102 " "
1108 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1109 Blank lines at the end of items are left in place. Return the
1110 new structure after the changes.
1112 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1113 to the same sub-list.
1115 This function modifies STRUCT."
1128 ;; 1. Move effectively items in buffer.
1132 ;; 2. Now modify struct. No need to re-read the list, the
1133 ;; transformation is just a shift of positions. Some special
1134 ;; attention is required for items ending at END-A and END-B
1135 ;; as empty spaces are not moved there. In others words,
1136 ;; item BEG-A will end with whitespaces that were at the end
1137 ;; of BEG-B and the same applies to BEG-B.
1159 struct)
1163 "Return number of blank lines that should separate items in list.
1165 POS is the position of point where `org-list-insert-item' was called.
1167 STRUCT is the list structure. PREVS is the alist of previous
1168 items, as returned by `org-list-prevs-alist'.
1170 Assume point is at item's beginning. If the item is alone, apply
1171 some heuristics to guess the result."
1176 usr-blank
1180 ;; Count blank lines above beginning of line.
1187 ;; Trivial cases where there should be none.
1189 ;; When `org-blank-before-new-entry' says so, it is 1.
1191 ;; `plain-list-item' is 'auto. Count blank lines separating
1192 ;; neighbours items in list.
1195 ;; Is there a next item?
1198 ;; Is there a previous item?
1201 ;; User inserted blank lines, trust him.
1206 usr-blank)
1207 ;; Are there blank lines inside the list so far?
1213 ;; Default choice: no blank line.
1217 "Insert a new list item at POS and return the new structure.
1218 If POS is before first character after bullet of the item, the
1219 new item will be created before the current one.
1221 STRUCT is the list structure. PREVS is the the alist of previous
1222 items, as returned by `org-list-prevs-alist'.
1224 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1225 after the bullet. Cursor will be after this text once the
1226 function ends.
1228 This function modifies STRUCT."
1230 ;; 1. Get information about list: position of point with regards
1231 ;; to item start (BEFOREP), blank lines number separating items
1232 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1240 pos struct prevs))
1241 ;; 2. Build the new item to be created. Concatenate same
1242 ;; bullet as item, checkbox, text AFTER-BULLET if
1243 ;; provided, and text cut from point to end of item
1244 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1245 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1246 ;; between what was cut and what was inserted in buffer
1247 ;; is stored in SIZE-OFFSET.
1251 ind))
1258 ;; If POS is greater than ITEM-END, then point is
1259 ;; in some white lines after the end of the list.
1260 ;; Those must be removed, or they will be left,
1261 ;; stacking up after the list.
1271 text-cut))))
1275 ;; 4. Insert effectively item into buffer.
1279 ;; 5. Add new item to STRUCT.
1283 ;; Before inserted item, positions don't change but
1284 ;; an item ending after insertion has its end shifted
1285 ;; by SIZE-OFFSET.
1288 ;; Trivial cases where current item isn't split in
1289 ;; two. Just shift every item after new one by
1290 ;; ITEM-SIZE.
1294 ;; Item is split in two: elements before POS are just
1295 ;; shifted by ITEM-SIZE. In the case item would end
1296 ;; after split POS, ending is only shifted by
1297 ;; SIZE-OFFSET.
1303 ;; Elements after POS are moved into new item.
1304 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1305 ;; doesn't appear in buffer yet.
1311 (+ end size-offset
1313 ;; Elements at ITEM-END or after are only shifted by
1314 ;; SIZE-OFFSET.
1317 struct)
1320 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1321 ;; exchange ITEM with the next item in list. Position cursor
1322 ;; after bullet, counter, checkbox, and label.
1328 struct)))
1331 "Remove ITEM from the list and return the new structure.
1333 STRUCT is the list structure."
1336 ;; If ITEM ends with the list, delete blank lines
1337 ;; before it.
1342 item)))
1343 ;; Remove item from buffer.
1345 ;; Remove item from structure and shift others items accordingly.
1346 ;; Don't forget to shift also ending position when appropriate.
1364 struct)))))
1367 "Send ITEM to destination DEST.
1369 STRUCT is the list structure.
1371 DEST can have various values.
1373 If DEST is a buffer position, the function will assume it points
1374 to another item in the same list as ITEM, and will move the
1375 latter just before the former.
1377 If DEST is `begin' \(respectively `end'\), ITEM will be moved at
1378 the beginning \(respectively end\) of the list it belongs to.
1381 be moved at the Nth position in the list.
1383 If DEST is `kill', ITEM will be deleted and its body will be
1384 added to the kill-ring.
1386 If DEST is `delete', ITEM will be deleted.
1388 This function returns, destructively, the new list structure."
1391 ;; Grab full item body minus its bullet.
1400 item-end)))
1401 ;; Change DEST into a buffer position. A trick is needed
1402 ;; when ITEM is meant to be sent at the end of the list.
1403 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1404 ;; nil and insertion point (INS-POINT) to the first line's
1405 ;; end of the last item, we ensure the new item will be
1406 ;; inserted after the last item, and not after any of its
1407 ;; hypothetical sub-items.
1423 ;; Send ITEM at the end of the list.
1439 ;; 1. Structure returned by `org-list-insert-item' may not be
1440 ;; accurate, as it cannot see sub-items included in BODY.
1441 ;; Thus, first compute the real structure so far.
1449 ;; 1.1. Remove the item just created in structure.
1451 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1454 struct
1462 new-end
1464 moved-items))
1466 ;; 2. Eventually delete extra copy of the item and clean marker.
1473 "Outdent items between positions START and END.
1475 STRUCT is the list structure. PARENTS is the alist of items'
1476 parents, as returned by `org-list-parents-alist'.
1478 START is included, END excluded."
1484 ;; Item not yet in zone: keep association.
1486 ;; Item out of zone: follow associations in ACC.
1490 ;; Item has no parent: error
1493 ;; Parent is outdented: keep association.
1497 ;; Parent isn't outdented: reparent to grand-parent.
1499 parent struct parents)))
1505 "Indent items between positions START and END.
1507 STRUCT is the list structure. PARENTS is the alist of parents
1508 and PREVS is the alist of previous items, returned by,
1509 respectively, `org-list-parents-alist' and
1510 `org-list-prevs-alist'.
1512 START is included and END excluded.
1514 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1515 bullets between START and END."
1523 ;; Normalize ordered bullets.
1533 org-list-demote-modify-bullet))))
1540 ;; Item not yet in zone: keep association.
1543 ;; Item out of zone: follow associations in ACC.
1547 ;; Item is in zone...
1549 ;; Check if bullet needs to be changed.
1552 ;; First item indented but not parent: error
1555 ;; First item and parent indented: keep same
1556 ;; parent.
1558 ;; Previous item not indented: reparent to it.
1560 ;; Previous item indented: reparent like it.
1567 \f
1568 ;;; Repairing structures
1571 "Non-nil if list starting at FIRST can have alphabetical bullets.
1573 STRUCT is list structure. PREVS is the alist of previous items,
1574 as returned by `org-list-prevs-alist'."
1578 ;; Pretend that bullets are uppercase and check if alphabet
1579 ;; is sufficient, taking counters into account.
1583 ;; Virtually determine current bullet
1585 ;; Counters are not case-sensitive.
1588 ;; Test if bullet would be over z or Z.
1592 ;; All items checked. All good.
1593 t))))
1596 "Increment BULLET if applicable."
1599 ;; Num bullet: increment it.
1603 nil nil bullet))
1604 ;; Alpha bullet: increment it.
1608 nil nil bullet))
1609 ;; Unordered bullet: leave it.
1613 "Verify and correct bullets in STRUCT.
1614 PREVS is the alist of previous items, as returned by
1615 `org-list-prevs-alist'.
1617 This function modifies STRUCT."
1621 ;; Set bullet of ITEM in STRUCT, depending on the type of
1622 ;; first item of the list, the previous bullet and counter
1623 ;; if any.
1632 item struct
1635 ;; Alpha counter in alpha list: use counter.
1639 ;; Use cond to be sure `string-match' is used in
1640 ;; both cases.
1646 ;; Num counter in a num list: use counter.
1651 ;; No counter: increase, if needed, previous bullet.
1654 ;; Alpha counter at first item: use counter.
1663 ;; Num counter at first item: use counter.
1668 ;; First bullet is alpha uppercase: use "A".
1671 ;; First bullet is alpha lowercase: use "a".
1674 ;; First bullet is num: use "1".
1677 ;; Not an ordered list: keep bullet.
1682 "Verify and correct indentation in STRUCT.
1684 PARENTS is the alist of parents, as returned by
1685 `org-list-parents-alist'.
1687 If numeric optional argument BULLET-SIZE is set, assume all
1688 bullets in list have this length to determine new indentation.
1690 This function modifies STRUCT."
1697 ;; Indent like parent + length of parent's bullet +
1698 ;; sub-list offset.
1704 org-list-indent-offset))
1705 ;; If no parent, indent like top-point.
1710 "Verify and correct checkboxes in STRUCT.
1712 PARENTS is the alist of parents and PREVS is the alist of
1713 previous items, as returned by, respectively,
1714 `org-list-parents-alist' and `org-list-prevs-alist'.
1716 If ORDERED is non-nil, a checkbox can only be checked when every
1717 checkbox before it is checked too. If there was an attempt to
1718 break this rule, the function will return the blocking item. In
1719 all others cases, the return value will be nil.
1721 This function modifies STRUCT."
1731 item struct
1737 ;; Parent has no boxed child: leave box as-is.
1739 parent-list)
1740 ;; 1. List all parents with a checkbox.
1747 all-items)
1748 ;; 2. Sort those parents by decreasing indentation.
1753 ;; 3. For each parent, get all children's checkboxes to determine
1754 ;; and set its checkbox accordingly.
1756 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1761 ;; There are boxes checked after an unchecked one: fix that.
1766 ;; Verify once again the structure, without ORDERED.
1768 ;; Return blocking item.
1772 "Verify and correct each item end position in STRUCT.
1774 This function modifies STRUCT."
1781 ;; To determine real ind of an ending position that is
1782 ;; not at an item, we have to find the item it belongs
1783 ;; to: it is the last item (ITEM-UP), whose ending is
1784 ;; further than the position we're interested in.
1787 ;; Else part is for the bottom point.
1789 end-pos)
1790 end-list)))
1793 struct)
1798 "Apply set difference between STRUCT and OLD-STRUCT to the buffer.
1800 OLD-STRUCT is the structure before any modifications, and STRUCT
1801 the structure to be applied. The function will only modify parts
1802 of the list which have changed.
1804 Initial position of cursor is restored after the changes."
1812 ;; Shift the indentation between END and BEG by DELTA.
1813 ;; Start from the line before END.
1822 ;; Skip inline tasks.
1825 ;; Shift only non-empty lines.
1832 ;; Replace ITEM first line elements with new elements from
1833 ;; STRUCT, if appropriate.
1843 ;; a. Replace bullet
1846 ;; b. Replace checkbox.
1860 ;; c. Indent item to appropriate column.
1865 ;; 1. First get list of items and position endings. We maintain
1866 ;; two alists: ITM-SHIFT, determining indentation shift needed
1867 ;; at item, and END-POS, a pseudo-alist where key is ending
1868 ;; position and value point.
1881 ;; To determine real ind of an ending position that
1882 ;; is not at an item, we have to find the item it
1883 ;; belongs to: it is the last item (ITEM-UP), whose
1884 ;; ending is further than the position we're
1885 ;; interested in.
1889 old-struct)
1890 ;; 2. Slice the items into parts that should be shifted by the
1891 ;; same amount of indentation. The slices are returned in
1892 ;; reverse order so changes modifying buffer do not change
1893 ;; positions they refer to.
1896 '<))
1904 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1905 ;; end to beginning. Take a special action when beginning is
1906 ;; at item bullet.
1913 sliced-struct))
1914 ;; 4. Go back to initial position and clean marker.
1919 "Correct bullets, checkboxes and indentation in list at point.
1921 STRUCT is the list structure. PARENTS is the alist of parents,
1922 as returned by `org-list-parents-alist'.
1924 When non-nil, optional argument OLD-STRUCT is the reference
1925 structure of the list. It should be provided whenever STRUCT
1926 doesn't correspond anymore to the real list in buffer."
1927 ;; Order of functions matters here: checkboxes and endings need
1928 ;; correct indentation to be set, and indentation needs correct
1929 ;; bullets.
1930 ;;
1931 ;; 0. Save a copy of structure before modifications
1933 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1934 ;; order to get items endings and bullets properly
1936 ;; 2. Fix each item end to get correct prevs alist.
1938 ;; 3. Get bullets right.
1941 ;; 4. Now get real indentation.
1943 ;; 5. Eventually fix checkboxes.
1945 ;; 6. Apply structure modifications to buffer.
1949 \f
1950 ;;; Misc Tools
1953 "Call FUNCTION on each item of the list at point.
1954 FUNCTION must be called with at least one argument: INIT-VALUE,
1955 that will contain the value returned by the function at the
1956 previous item, plus ARGS extra arguments.
1958 FUNCTION is applied on items in reverse order.
1960 As an example, \(org-apply-on-list \(lambda \(result\) \(1+ result\)\) 0\)
1961 will return the number of items in the current list.
1963 Sublists of the list are skipped. Cursor is always at the
1964 beginning of the item."
1976 value))
1979 "Set visibility of ITEM in STRUCT to VIEW.
1981 Possible values are: `folded', `children' or `subtree'. See
1982 `org-cycle' for more information."
1986 ;; Hide from eol
1988 item-end t)))
1990 ;; First show everything.
1992 ;; Then fold every child.
1997 children)))
1999 ;; Show everything
2004 "Return column at which body of ITEM should start."
2014 tcol))
2017 \f
2018 ;;; Interactive functions
2023 "Go to the beginning of the current item.
2024 Throw an error when not in a list."
2030 "Go to the beginning item of the current list or sublist.
2031 Throw an error when not in a list."
2042 "Go to the end of the current list or sublist.
2043 Throw an error when not in a list."
2054 "Go to the end of the current item.
2055 Throw an error when not in a list."
2065 "Move to the beginning of the previous item.
2066 Throw an error when not in a list. Also throw an error when at
2067 first item, unless `org-list-use-circular-motion' is non-nil."
2083 "Move to the beginning of the next item.
2084 Throw an error when not in a list. Also throw an error when at
2085 last item, unless `org-list-use-circular-motion' is non-nil."
2101 "Move the item at point down, i.e. swap with following item.
2102 Sub-items (items with larger indentation) are considered part of
2103 the item, so this really moves item trees."
2122 "Move the item at point up, i.e. swap with previous item.
2123 Sub-items (items with larger indentation) are considered part of
2124 the item, so this really moves item trees."
2141 "Insert a new item at the current level.
2142 If cursor is before first character after bullet of the item, the
2143 new item will be created before the current one.
2145 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2147 Return t when things worked, nil when we are not in an item, or
2148 item is invisible."
2151 ;; If cursor isn't is a list or if list is invisible, return nil.
2159 ;; Timer list: delegate to `org-timer-item'.
2164 ;; If we're in a description list, ask for the new term.
2167 ;; Don't insert a checkbox if checkbox rule is applied
2168 ;; and it is a description item.
2172 org-list-automatic-rules)))))))
2179 t)))))
2182 "Mark the current list.
2183 If this is a sublist, only mark the sublist."
2194 "Fix indentation, bullets and checkboxes is the list at point."
2202 "Cycle through the different itemize/enumerate bullets.
2203 This cycle the entire list level through the sequence:
2205 `-' -> `+' -> `*' -> `1.' -> `1)'
2207 If WHICH is a valid string, use that as the new bullet. If WHICH
2208 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2209 `previous', cycle backwards."
2230 ;; Compute list of possible bullets, depending on context.
2233 ;; *-bullets are not allowed at column 0.
2236 ;; Description items cannot be numbered.
2259 ;; Use a short variation of `org-list-write-struct' as there's
2260 ;; no need to go through all the steps.
2268 "Toggle the checkbox in the current line.
2269 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2270 double prefix, set checkbox to [-].
2272 When there is an active region, toggle status or presence of the
2273 first checkbox there, and make every item inside have the same
2274 status or presence, respectively.
2276 If the cursor is in a headline, apply this to all checkbox items
2277 in the text below the heading, taking as reference the first item
2278 in subtree, ignoring drawers."
2282 block-item
2283 lim-up
2284 lim-down
2295 ;; In a region, start at first item in region.
2305 ;; On an heading, start at first item after drawers and
2306 ;; time-stamps (scheduled, etc.).
2317 ;; Just one item: set SINGLEP flag.
2323 ;; Determine the checkbox going to be applied to all items
2324 ;; within bounds.
2335 ;; When an item is found within bounds, grab the full list at
2336 ;; point structure, then: (1) set check-box of all its items
2337 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2338 ;; whole list, (3) move point after the list.
2352 e struct
2353 ;; If there is no box at item, leave as-is
2354 ;; unless function was called with C-u prefix.
2357 ref-checkbox
2358 cur-box))))
2359 items-to-toggle)
2361 struct parents prevs orderedp))
2362 ;; Report some problems due to ORDERED status of subtree.
2363 ;; If only one box was being checked, throw an error, else,
2364 ;; only signal problems.
2368 "Checkbox blocked because of unchecked box at line %d"
2372 "Checkboxes were removed due to unchecked box at line %d"
2381 "Reset all checkboxes in an entry subtree."
2398 "Update the checkbox statistics in the current section.
2399 This will find all statistic cookies like [57%] and [6/12] and
2400 update them with the current numbers.
2402 With optional prefix argument ALL, do this for the whole buffer."
2406 (box-re "^[ \t]*\\([-+*]\\|\\([0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2418 ;; Return number of checked boxes and boxes of all types
2419 ;; in all structures in STRUCTS. If RECURSIVEP is
2420 ;; non-nil, also count boxes in sub-lists. If ITEM is
2421 ;; nil, count across the whole structure, else count only
2422 ;; across subtree whose ancestor is ITEM.
2439 items))))
2442 structs)
2445 cookies-list structs-bak box-num)
2447 ;; 1. Build an alist for each cookie found within BOUNDS. The
2448 ;; key will be position at beginning of cookie and values
2449 ;; ending position, format of cookie, and a cell whose car is
2450 ;; number of checked boxes to report, and cdr total number of
2451 ;; boxes.
2461 ;; Cookie is at an heading, but specifically for todo,
2462 ;; not for checkboxes: skip it.
2468 ;; Cookie is at an heading, but all lists before next
2469 ;; heading already have been read. Use data collected
2470 ;; in STRUCTS-BAK. This should only happen when
2471 ;; heading has more than one cookie on it.
2474 backup-end))
2476 ;; Cookie is at a fresh heading. Grab structure of
2477 ;; every list containing a checkbox between point and
2478 ;; next headline, and save them in STRUCTS-BAK.
2482 structs-bak nil)
2489 ;; Cookie is at an item, and we already have list
2490 ;; structure stored in STRUCTS-BAK.
2493 ;; Only lists in no special context are stored.
2496 ;; Cookie is at an item, but we need to compute list
2497 ;; structure.
2503 ;; Else, cookie found is at a wrong place. Skip it.
2505 cookies-list))))
2506 ;; 2. Apply alist to buffer, in reverse order so positions stay
2507 ;; unchanged after cookie modifications.
2522 cookies-list))))
2525 "Select the face for checkbox statistics.
2526 The face will be `org-done' when all relevant boxes are checked.
2527 Otherwise it will be `org-todo'."
2530 'org-checkbox-statistics-done
2534 'org-checkbox-statistics-done
2538 "Update checkbox statistics unless turned off by user.
2539 With an optional argument ALL, update them in the whole buffer."
2547 "Indent a local list item including its children.
2548 When number ARG is a negative, item will be outdented, otherwise
2549 it will be indented.
2551 If a region is active, all items inside will be moved.
2553 If NO-SUBTREE is non-nil, only indent the item itself, not its
2554 children.
2556 STRUCT is the list structure.
2558 Return t if successful."
2566 ;; Are we going to move the whole list?
2574 t))))
2575 ;; Determine begin and end points of zone to indent. If moving
2576 ;; more than one item, save them for subsequent moves.
2592 ;; Special case: moving top-item with indent rule.
2600 ;; Change bullet if necessary.
2606 ;; Shift every item by OFFSET and fix bullets. Then
2607 ;; apply changes to buffer.
2611 struct)
2614 ;; Forbidden move:
2616 ;; If only one item is moved, it mustn't have a child.
2620 ;; If a subtree or region is moved, the last item
2621 ;; of the subtree mustn't have a child.
2626 struct)))))
2629 ;; Normal shifting
2637 t)
2640 "Outdent a local list item, but not its children.
2641 If a region is active, all items inside will be moved."
2657 "Indent a local list item, but not its children.
2658 If a region is active, all items inside will be moved."
2674 "Outdent a local list item including its children.
2675 If a region is active, all items inside will be moved."
2691 "Indent a local list item including its children.
2692 If a region is active, all items inside will be moved."
2709 "Cycle levels of indentation of an empty item.
2710 The first run indents the item, if applicable. Subsequent runs
2711 outdent it at meaningful levels in the list. When done, item is
2712 put back at its original position with its original bullet.
2714 Return t at each successful move."
2720 ;; Accept empty items or if cycle has already started.
2731 ;; When in the middle of the cycle, try to outdent first. If
2732 ;; it fails, and point is still at initial position, indent.
2733 ;; Else, re-create it at its original position.
2742 ;; Break cycle
2744 ;; If a cycle is starting, remember indentation and bullet,
2745 ;; then try to indent. If it fails, try to outdent.
2751 t))))
2754 "Sort list items.
2755 The cursor may be at any item of the list that should be sorted.
2756 Sublists are not sorted. Checkboxes, if any, are ignored.
2758 Sorting can be alphabetically, numerically, by date/time as given
2759 by a time stamp, by a property or by priority.
2761 Comparing entries ignores case by default. However, with an
2762 optional argument WITH-CASE, the sorting considers case as well.
2764 The command prompts for the sorting type unless it has been given
2765 to the function through the SORTING-TYPE argument, which needs to
2766 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
2767 meaning of each character:
2769 n Numerically, by converting the beginning of the item to a number.
2770 a Alphabetically. Only the first line of item is checked.
2771 t By date/time, either the first active time stamp in the entry, if
2772 any, or by the first inactive one. In a timer list, sort the timers.
2774 Capital letters will reverse the sort order.
2776 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2777 a function to be called with point at the beginning of the
2778 record. It must return either a string or a number that should
2779 serve as the sorting key for that record. It will then use
2780 COMPARE-FUNC to compare entries."
2825 ;; If it is a timer list, convert timer to seconds
2838 value))
2842 next-record
2843 end-record
2844 value-to-sort
2845 nil
2846 sort-func)
2847 ;; Read and fix list again, as `sort-subr' probably destroyed
2848 ;; its structure.
2854 \f
2855 ;;; Send and receive lists
2858 "Parse the list at point and maybe DELETE it.
2860 Return a list whose car is a symbol of list type, among
2861 `ordered', `unordered' and `descriptive'. Then, each item is
2862 a list whose car is counter, and cdr are strings and other
2863 sub-lists. Inside strings, check-boxes are replaced by
2866 For example, the following list:
2868 1. first item
2869 + sub-item one
2870 + [X] sub-item two
2871 more text in first item
2872 2. [@3] last item
2874 will be parsed as:
2876 \(ordered
2878 \(unordered
2884 Point is left at list end."
2890 out
2891 parse-item ; for byte-compiler
2894 ;; Return text between BEG and END, trimmed, with
2895 ;; checkboxes replaced.
2906 text)))))
2909 ;; Return a list whose car is list type and cdr a list of
2910 ;; items' body.
2916 ;; Return a list containing counter of item, if any, text
2917 ;; and any sublist inside it.
2923 ;; Get counter number. For alphabetic counter, get
2924 ;; its position in the alphabet.
2935 ;; If item has a child, store text between bullet and
2936 ;; next child, then recursively parse all sublists. At
2937 ;; the end of each sublist, check for the presence of
2938 ;; text belonging to the original item.
2948 ;; Remove children from the list just parsed.
2950 ;; There is a chunk of text belonging to the
2951 ;; item if last child doesn't end where next
2952 ;; child starts or where item ends.
2956 body))))
2959 ;; Store output, take care of cursor position and deletion of
2960 ;; list, then return output.
2967 out))
2970 "Convert the plain list at point into a subtree."
2978 "Insert a radio list template appropriate for this major mode."
2982 name pos)
2993 "Send a transformed version of this list to the receiver position.
2994 With argument MAYBE, fail quietly if no transformation is defined
2995 for this list."
3001 (unless (looking-at "[ \t]*#\\+ORGLST[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
3020 beg txt)
3024 ;; Find the insertion place
3029 name
3043 "Trim line breaks in a list ITEM."
3047 "Convert a LIST parsed through `org-list-parse-list' to other formats.
3048 Valid parameters PARAMS are:
3050 :ustart String to start an unordered list
3051 :uend String to end an unordered list
3053 :ostart String to start an ordered list
3054 :oend String to end an ordered list
3056 :dstart String to start a descriptive list
3057 :dend String to end a descriptive list
3058 :dtstart String to start a descriptive term
3059 :dtend String to end a descriptive term
3060 :ddstart String to start a description
3061 :ddend String to end a description
3063 :splice When set to t, return only list body lines, don't wrap
3064 them into :[u/o]start and :[u/o]end. Default is nil.
3066 :istart String to start a list item.
3067 :icount String to start an item with a counter.
3068 :iend String to end a list item
3069 :isep String to separate items
3070 :lsep String to separate sublists
3071 :csep String to separate text from a sub-list
3073 :cboff String to insert for an unchecked check-box
3074 :cbon String to insert for a checked check-box
3075 :cbtrans String to insert for a check-box in transitional state
3077 :nobr Non-nil means remove line breaks in lists items.
3079 Alternatively, each parameter can also be a form returning
3080 a string. These sexp can use keywords `counter' and `depth',
3081 representing respectively counter associated to the current
3082 item, and depth of the current sub-list, starting at 0.
3083 Obviously, `counter' is only available for parameters applying to
3084 items."
3108 export-sublist ; for byte-compiler
3111 ;; Export an item ITEM of type TYPE, at DEPTH. First
3112 ;; string in item is treated in a special way as it can
3113 ;; bring extra information that needs to be processed.
3119 ;; Stick DTSTART to ISTART by
3120 ;; left-trimming the latter.
3124 istart))
3131 ;; Replace checkbox if any is found.
3139 ;; Replace line breaks if required
3141 ;; Insert descriptive term if TYPE is `descriptive'.
3150 first)))
3161 ;; Export sublist SUB at DEPTH.
3179 "Convert LIST into a LaTeX list.
3180 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3181 with overruling parameters for `org-list-to-generic'."
3183 list
3192 ;; LaTeX increments counter just before
3193 ;; using it, so set it to the desired
3194 ;; value, minus one.
3201 params)))
3204 "Convert LIST into a HTML list.
3205 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3206 with overruling parameters for `org-list-to-generic'."
3208 list
3220 params)))
3223 "Convert LIST into a Texinfo list.
3224 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3225 with overruling parameters for `org-list-to-generic'."
3227 list
3238 params)))
3241 "Convert LIST into an Org subtree.
3242 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3243 with overruling parameters for `org-list-to-generic'."
3253 ;; Return the string for the heading, depending on depth D
3254 ;; of current sub-list.
3259 oddeven-level)
3260 ?*)
3263 list
3265 '(:splice t
3272 params))))
3276 ;;; org-list.el ends here