| blob | b5d83520d3217d26728b8dbd04c8ceb77b8245f0 |
1 ;;; org-list.el --- Plain lists for Org-mode
2 ;;
3 ;; Copyright (C) 2004-2013 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:
139 \f
140 ;;; Configuration variables
143 "Options concerning plain lists in Org-mode."
148 "When t, make TAB cycle visibility on plain list items.
149 Cycling plain lists works only when the cursor is on a plain list
150 item. When the cursor is on an outline heading, plain lists are
151 treated as text. This is the most stable way of handling this,
152 which is why it is the default.
154 When this is the symbol `integrate', then integrate plain list
155 items when cycling, as if they were children of outline headings.
157 This setting can lead to strange effects when switching visibility
160 plain list item with an implied large level number, all true
161 children and grand children of the outline heading will be
162 exposed in a children' view."
170 "Default bullet type installed when demoting an item.
171 This is an association list, for each bullet type, this alist will point
172 to the bullet that should be used when this item is demoted.
173 For example,
175 (setq org-list-demote-modify-bullet
178 will make
180 + Movies
181 + Silence of the Lambs
182 + My Cousin Vinny
183 + Books
184 + The Hunt for Red October
185 + The Road to Omaha
187 into
189 + Movies
190 - Silence of the Lambs
191 - My Cousin Vinny
192 + Books
193 - The Hunt for Red October
194 - The Road to Omaha"
212 "The character that makes a line with leading number an ordered list item.
213 Valid values are ?. and ?\). To get both terminators, use t."
220 "Non-nil means single character alphabetical bullets are allowed.
221 Both uppercase and lowercase are handled. Lists with more than
222 26 items will fallback to standard numbering. Alphabetical
229 "A regular expression matching bullets that should have 2 spaces after them.
230 When nil, no bullet will have two spaces after them. When
231 a string, it will be used as a regular expression. When the
232 bullet type of a list is changed, the new bullet type will be
233 matched against this regexp. If it matches, there will be two
234 spaces instead of one after the bullet in each item of the list."
241 "Non-nil means an empty line ends all plain list levels.
242 Otherwise, two of them will be necessary."
248 "Non-nil means apply set of rules when acting on lists.
249 By default, automatic actions are taken when using
254 rules by setting them to nil. Valid rules are:
256 checkbox when non-nil, checkbox statistics is updated each time
257 you either insert a new checkbox or toggle a checkbox.
258 indent when non-nil, indenting or outdenting list top-item
259 with its subtree will move the whole list and
260 outdenting a list whose bullet is * to column 0 will
265 :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.
633 ind
634 bullet
637 ;; Description tag.
642 ;; Ensure list ends at the first blank line.
646 ;; 1. Read list from starting item to its beginning, and save
647 ;; top item position and indentation in BEG-CELL. Also store
648 ;; ending position of items in END-LST.
655 ;; At upward limit: if we ended at an item, store it,
656 ;; else dismiss useless data recorded above BEG-CELL.
657 ;; Jump to part 2.
664 ;; Looking at a list ending regexp. Dismiss useless
665 ;; data recorded above BEG-CELL. Jump to part 2.
670 ;; Point is at an item. Add data to ITM-LST. It may
671 ;; also end a previous item: save it in END-LST. If
672 ;; ind is less or equal than BEG-CELL and there is no
673 ;; end at this ind or lesser, this item becomes the new
674 ;; BEG-CELL.
680 ;; Skip blocks, drawers, inline tasks, blank lines.
691 ;; From there, point is not at an item. Interpret
692 ;; line's indentation:
693 ;; - text at column 0 is necessarily out of any list.
694 ;; Dismiss data recorded above BEG-CELL. Jump to
695 ;; part 2.
696 ;; - any other case may be an ending position for an
697 ;; hypothetical item above. Store it and proceed.
706 ;; 2. Read list from starting point to its end, that is until we
707 ;; get out of context, or that a non-item line is less or
708 ;; equally indented than BEG-CELL's cdr. Also, store ending
709 ;; position of items in END-LST-2.
715 ;; At downward limit: this is de facto the end of the
716 ;; list. Save point as an ending position, and jump to
717 ;; part 3.
720 ;; Looking at a list ending regexp. Save point as an
721 ;; ending position and jump to part 3.
725 ;; Point is at an item. Add data to ITM-LST-2. It may
726 ;; also end a previous item, so save it in END-LST-2.
730 ;; Skip inline tasks and blank lines along the way
735 ;; Ind is lesser or equal than BEG-CELL's. The list is
736 ;; over: store point as an ending position and jump to
737 ;; part 3.
741 ;; Else, if ind is lesser or equal than previous item's,
742 ;; this is an ending position: store it. In any case,
743 ;; skip block or drawer at point, and move to next line.
755 ;; 3. Associate each item to its end position.
757 ;; 4. Return STRUCT
758 struct)))
761 "Associate proper ending point to items in STRUCT.
763 END-LIST is a pseudo-alist where car is indentation and cdr is
764 ending position.
766 This function modifies STRUCT."
772 ;; Remove end candidates behind current item.
775 ;; Add end position to item assoc.
781 struct)))
784 "Return alist between item and previous item in STRUCT."
786 struct)))
790 struct)))
793 "Return alist between item and parent in STRUCT."
805 ;; A sub-list is over. Find the associated
806 ;; origin in IND-TO-ORI. If it cannot be
807 ;; found (ill-formed list), set its parent as
808 ;; the first item less indented. If there is
809 ;; none, make it a top-level item.
817 ind-to-ori)
820 ;; A sub-list starts. Every item at IND will
821 ;; have previous item as its parent.
826 ;; Another item in the same sub-list: it shares
827 ;; the same parent as the previous item.
832 \f
833 ;;; Accessors
836 "Return the Nth value of KEY in STRUCT."
840 "Set the Nth value of KEY in STRUCT to NEW.
845 "Return indentation of ITEM in STRUCT."
849 "Set indentation of ITEM in STRUCT to IND.
854 "Return bullet of ITEM in STRUCT."
858 "Set bullet of ITEM in STRUCT to BULLET.
863 "Return counter of ITEM in STRUCT."
867 "Return checkbox of ITEM in STRUCT or nil."
871 "Set checkbox of ITEM in STRUCT to CHECKBOX.
876 "Return end position of ITEM in STRUCT."
880 "Return end position of ITEM in STRUCT."
884 "Return point at end of ITEM in STRUCT, before any blank line.
885 Point returned is at end of line."
892 "Return parent of ITEM or nil.
893 STRUCT is the list structure. PARENTS is the alist of parents,
894 as returned by `org-list-parents-alist'."
899 "Non-nil if ITEM has a child.
901 STRUCT is the list structure.
903 Value returned is the position of the first child of ITEM."
908 child-maybe)))
911 "Return next item in same sub-list as ITEM, or nil.
912 STRUCT is the list structure. PREVS is the alist of previous
913 items, as returned by `org-list-prevs-alist'."
917 "Return previous item in same sub-list as ITEM, or nil.
918 STRUCT is the list structure. PREVS is the alist of previous
919 items, as returned by `org-list-prevs-alist'."
923 "List all items having ITEM as a common ancestor, or nil.
924 STRUCT is the list structure."
927 subtree)
932 sub-struct))
936 "List all items in the same sub-list as ITEM.
937 STRUCT is the list structure. PREVS is the alist of previous
938 items, as returned by `org-list-prevs-alist'."
941 before-item after-item)
949 "List all children of ITEM, or nil.
950 STRUCT is the list structure. PARENTS is the alist of parents,
951 as returned by `org-list-parents-alist'."
959 "Return point at beginning of list.
960 STRUCT is the list structure."
964 "Return point at bottom of list.
965 STRUCT is the list structure."
970 "Return point at beginning of sub-list ITEM belongs.
971 STRUCT is the list structure. PREVS is the alist of previous
972 items, as returned by `org-list-prevs-alist'."
976 first-item))
981 "Return point at last item of sub-list ITEM belongs.
982 STRUCT is the list structure. PREVS is the alist of previous
983 items, as returned by `org-list-prevs-alist'."
987 last-item))
990 "Return point at end of sub-list ITEM belongs.
991 STRUCT is the list structure. PREVS is the alist of previous
992 items, as returned by `org-list-prevs-alist'."
996 "Return the type of the list containing ITEM, as a symbol.
998 STRUCT is the list structure. PREVS is the alist of previous
999 items, as returned by `org-list-prevs-alist'.
1001 Possible types are `descriptive', `ordered' and `unordered'. The
1002 type is determined by the first item of the list."
1010 "Return ITEM's sequence number.
1012 STRUCT is the list structure. PREVS is the alist of previous
1013 items, as returned by `org-list-prevs-alist'. PARENTS is the
1014 alist of ancestors, as returned by `org-list-parents-alist'.
1016 Return value is a list of integers. Counters have an impact on
1017 that value."
1021 ;; Return relative sequence number of ITEM in the sub-list
1022 ;; it belongs. STRUCT is the list structure. PREVS is
1023 ;; the alist of previous items.
1032 seq))
1036 ;; Cons each parent relative number into return value (OUT).
1041 ;; Return value.
1042 out)))
1045 \f
1046 ;;; Searching
1049 "Search a string in valid contexts for lists.
1050 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1051 in `re-search-forward'."
1055 ;; 1. No match: return to origin or bound, depending on NOERR.
1058 nil)))
1059 ;; 2. Match in valid context: return point. Else, continue
1060 ;; searching.
1064 "Like `re-search-backward' but stop only where lists are recognized.
1065 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1066 `re-search-backward'."
1071 "Like `re-search-forward' but stop only where lists are recognized.
1072 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1073 `re-search-forward'."
1078 \f
1079 ;;; Methods on structures
1082 "Return BULLET with the correct number of whitespaces.
1083 It determines the number of whitespaces to append by looking at
1084 `org-list-two-spaces-after-bullet-regexp'."
1088 org-list-two-spaces-after-bullet-regexp bullet))
1089 " "
1093 bullet))))
1096 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1098 Blank lines at the end of items are left in place. Item
1099 visibility is preserved. Return the new structure after the
1100 changes.
1102 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1103 to the same sub-list.
1105 This function modifies STRUCT."
1118 ;; Store overlays responsible for visibility status. We
1119 ;; also need to store their boundaries as they will be
1120 ;; removed from buffer.
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)
1161 ;; Restore visibility status, by moving overlays to their new
1162 ;; position.
1174 ;; Return structure.
1175 struct)))
1178 "Return number of blank lines that should separate items in list.
1180 POS is the position of point where `org-list-insert-item' was called.
1182 STRUCT is the list structure. PREVS is the alist of previous
1183 items, as returned by `org-list-prevs-alist'.
1185 Assume point is at item's beginning. If the item is alone, apply
1186 some heuristics to guess the result."
1191 usr-blank
1195 ;; Count blank lines above beginning of line.
1202 ;; Trivial cases where there should be none.
1204 ;; When `org-blank-before-new-entry' says so, it is 1.
1206 ;; `plain-list-item' is 'auto. Count blank lines separating
1207 ;; neighbours items in list.
1210 ;; Is there a next item?
1213 ;; Is there a previous item?
1216 ;; User inserted blank lines, trust him.
1221 usr-blank)
1222 ;; Are there blank lines inside the list so far?
1225 ;; Do not use `org-list-search-forward' so blank lines
1226 ;; in blocks can be counted in.
1230 ;; Default choice: no blank line.
1234 "Insert a new list item at POS and return the new structure.
1235 If POS is before first character after bullet of the item, the
1236 new item will be created before the current one.
1238 STRUCT is the list structure. PREVS is the the alist of previous
1239 items, as returned by `org-list-prevs-alist'.
1241 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1242 after the bullet. Cursor will be after this text once the
1243 function ends.
1245 This function modifies STRUCT."
1247 ;; 1. Get information about list: position of point with regards
1248 ;; to item start (BEFOREP), blank lines number separating items
1249 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1256 ;; Do not count tag in a non-descriptive list.
1264 pos struct prevs))
1265 ;; 2. Build the new item to be created. Concatenate same
1266 ;; bullet as item, checkbox, text AFTER-BULLET if
1267 ;; provided, and text cut from point to end of item
1268 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1269 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1270 ;; between what was cut and what was inserted in buffer
1271 ;; is stored in SIZE-OFFSET.
1275 ind))
1282 ;; If POS is greater than ITEM-END, then point is
1283 ;; in some white lines after the end of the list.
1284 ;; Those must be removed, or they will be left,
1285 ;; stacking up after the list.
1295 text-cut))))
1299 ;; 4. Insert effectively item into buffer.
1303 ;; 5. Add new item to STRUCT.
1307 ;; Before inserted item, positions don't change but
1308 ;; an item ending after insertion has its end shifted
1309 ;; by SIZE-OFFSET.
1312 ;; Trivial cases where current item isn't split in
1313 ;; two. Just shift every item after new one by
1314 ;; ITEM-SIZE.
1318 ;; Item is split in two: elements before POS are just
1319 ;; shifted by ITEM-SIZE. In the case item would end
1320 ;; after split POS, ending is only shifted by
1321 ;; SIZE-OFFSET.
1327 ;; Elements after POS are moved into new item.
1328 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1329 ;; doesn't appear in buffer yet.
1335 (+ end size-offset
1337 ;; Elements at ITEM-END or after are only shifted by
1338 ;; SIZE-OFFSET.
1341 struct)
1344 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1345 ;; exchange ITEM with the next item in list. Position cursor
1346 ;; after bullet, counter, checkbox, and label.
1352 struct)))
1355 "Remove ITEM from the list and return the new structure.
1357 STRUCT is the list structure."
1360 ;; If ITEM ends with the list, delete blank lines
1361 ;; before it.
1366 item)))
1367 ;; Remove item from buffer.
1369 ;; Remove item from structure and shift others items accordingly.
1370 ;; Don't forget to shift also ending position when appropriate.
1388 struct)))))
1391 "Send ITEM to destination DEST.
1393 STRUCT is the list structure.
1395 DEST can have various values.
1397 If DEST is a buffer position, the function will assume it points
1398 to another item in the same list as ITEM, and will move the
1399 latter just before the former.
1401 If DEST is `begin' (respectively `end'), ITEM will be moved at
1402 the beginning (respectively end) of the list it belongs to.
1405 be moved at the Nth position in the list.
1407 If DEST is `kill', ITEM will be deleted and its body will be
1408 added to the kill-ring.
1410 If DEST is `delete', ITEM will be deleted.
1412 Visibility of item is preserved.
1414 This function returns, destructively, the new list structure."
1417 ;; Grab full item body minus its bullet.
1426 item-end)))
1427 ;; Change DEST into a buffer position. A trick is needed
1428 ;; when ITEM is meant to be sent at the end of the list.
1429 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1430 ;; nil and insertion point (INS-POINT) to the first line's
1431 ;; end of the last item, we ensure the new item will be
1432 ;; inserted after the last item, and not after any of its
1433 ;; hypothetical sub-items.
1449 ;; Send ITEM at the end of the list.
1457 ;; Store visibility.
1467 ;; 1. Structure returned by `org-list-insert-item' may not be
1468 ;; accurate, as it cannot see sub-items included in BODY.
1469 ;; Thus, first compute the real structure so far.
1477 ;; 1.1. Remove the item just created in structure.
1479 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1482 struct
1490 new-end
1492 moved-items))
1494 ;; 2. Restore visibility.
1499 visibility)
1500 ;; 3. Eventually delete extra copy of the item and clean marker.
1506 "Outdent items between positions START and END.
1508 STRUCT is the list structure. PARENTS is the alist of items'
1509 parents, as returned by `org-list-parents-alist'.
1511 START is included, END excluded."
1517 ;; Item not yet in zone: keep association.
1519 ;; Item out of zone: follow associations in ACC.
1523 ;; Item has no parent: error
1526 ;; Parent is outdented: keep association.
1530 ;; Parent isn't outdented: reparent to grand-parent.
1532 parent struct parents)))
1538 "Indent items between positions START and END.
1540 STRUCT is the list structure. PARENTS is the alist of parents
1541 and PREVS is the alist of previous items, returned by,
1542 respectively, `org-list-parents-alist' and
1543 `org-list-prevs-alist'.
1545 START is included and END excluded.
1547 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1548 bullets between START and END."
1556 ;; Normalize ordered bullets.
1566 org-list-demote-modify-bullet))))
1573 ;; Item not yet in zone: keep association.
1576 ;; Item out of zone: follow associations in ACC.
1580 ;; Item is in zone...
1582 ;; Check if bullet needs to be changed.
1585 ;; First item indented but not parent: error
1588 ;; First item and parent indented: keep same
1589 ;; parent.
1591 ;; Previous item not indented: reparent to it.
1593 ;; Previous item indented: reparent like it.
1600 \f
1601 ;;; Repairing structures
1604 "Non-nil if list starting at FIRST can have alphabetical bullets.
1606 STRUCT is list structure. PREVS is the alist of previous items,
1607 as returned by `org-list-prevs-alist'."
1611 ;; Pretend that bullets are uppercase and check if alphabet
1612 ;; is sufficient, taking counters into account.
1616 ;; Virtually determine current bullet
1618 ;; Counters are not case-sensitive.
1621 ;; Test if bullet would be over z or Z.
1625 ;; All items checked. All good.
1626 t))))
1629 "Increment BULLET if applicable."
1632 ;; Num bullet: increment it.
1636 nil nil bullet))
1637 ;; Alpha bullet: increment it.
1641 nil nil bullet))
1642 ;; Unordered bullet: leave it.
1646 "Verify and correct bullets in STRUCT.
1647 PREVS is the alist of previous items, as returned by
1648 `org-list-prevs-alist'.
1650 This function modifies STRUCT."
1654 ;; Set bullet of ITEM in STRUCT, depending on the type of
1655 ;; first item of the list, the previous bullet and counter
1656 ;; if any.
1665 item struct
1668 ;; Alpha counter in alpha list: use counter.
1672 ;; Use cond to be sure `string-match' is used in
1673 ;; both cases.
1679 ;; Num counter in a num list: use counter.
1684 ;; No counter: increase, if needed, previous bullet.
1687 ;; Alpha counter at first item: use counter.
1696 ;; Num counter at first item: use counter.
1701 ;; First bullet is alpha uppercase: use "A".
1704 ;; First bullet is alpha lowercase: use "a".
1707 ;; First bullet is num: use "1".
1710 ;; Not an ordered list: keep bullet.
1715 "Verify and correct indentation in STRUCT.
1717 PARENTS is the alist of parents, as returned by
1718 `org-list-parents-alist'.
1720 If numeric optional argument BULLET-SIZE is set, assume all
1721 bullets in list have this length to determine new indentation.
1723 This function modifies STRUCT."
1730 ;; Indent like parent + length of parent's bullet +
1731 ;; sub-list offset.
1737 org-list-indent-offset))
1738 ;; If no parent, indent like top-point.
1743 "Verify and correct checkboxes in STRUCT.
1745 PARENTS is the alist of parents and PREVS is the alist of
1746 previous items, as returned by, respectively,
1747 `org-list-parents-alist' and `org-list-prevs-alist'.
1749 If ORDERED is non-nil, a checkbox can only be checked when every
1750 checkbox before it is checked too. If there was an attempt to
1751 break this rule, the function will return the blocking item. In
1752 all others cases, the return value will be nil.
1754 This function modifies STRUCT."
1764 item struct
1770 ;; Parent has no boxed child: leave box as-is.
1772 parent-list)
1773 ;; 1. List all parents with a checkbox.
1780 all-items)
1781 ;; 2. Sort those parents by decreasing indentation.
1786 ;; 3. For each parent, get all children's checkboxes to determine
1787 ;; and set its checkbox accordingly.
1789 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1794 ;; There are boxes checked after an unchecked one: fix that.
1801 ;; Verify once again the structure, without ORDERED.
1803 ;; Return blocking item.
1807 "Verify and correct each item end position in STRUCT.
1809 This function modifies STRUCT."
1816 ;; To determine real ind of an ending position that is
1817 ;; not at an item, we have to find the item it belongs
1818 ;; to: it is the last item (ITEM-UP), whose ending is
1819 ;; further than the position we're interested in.
1822 ;; Else part is for the bottom point.
1824 end-pos)
1825 end-list)))
1828 struct)
1833 "Apply set difference between STRUCT and OLD-STRUCT to the buffer.
1835 OLD-STRUCT is the structure before any modifications, and STRUCT
1836 the structure to be applied. The function will only modify parts
1837 of the list which have changed.
1839 Initial position of cursor is restored after the changes."
1846 ;; Shift the indentation between END and BEG by DELTA.
1847 ;; Start from the line before END.
1856 ;; Skip inline tasks.
1859 ;; Shift only non-empty lines.
1866 ;; Replace ITEM first line elements with new elements from
1867 ;; STRUCT, if appropriate.
1877 ;; a. Replace bullet
1880 ;; b. Replace checkbox.
1891 ;; c. Indent item to appropriate column.
1896 ;; 1. First get list of items and position endings. We maintain
1897 ;; two alists: ITM-SHIFT, determining indentation shift needed
1898 ;; at item, and END-POS, a pseudo-alist where key is ending
1899 ;; position and value point.
1912 ;; To determine real ind of an ending position that
1913 ;; is not at an item, we have to find the item it
1914 ;; belongs to: it is the last item (ITEM-UP), whose
1915 ;; ending is further than the position we're
1916 ;; interested in.
1920 old-struct)
1921 ;; 2. Slice the items into parts that should be shifted by the
1922 ;; same amount of indentation. The slices are returned in
1923 ;; reverse order so changes modifying buffer do not change
1924 ;; positions they refer to.
1927 '<))
1935 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1936 ;; end to beginning. Take a special action when beginning is
1937 ;; at item bullet.
1944 sliced-struct))
1945 ;; 4. Go back to initial position and clean marker.
1950 "Correct bullets, checkboxes and indentation in list at point.
1952 STRUCT is the list structure. PARENTS is the alist of parents,
1953 as returned by `org-list-parents-alist'.
1955 When non-nil, optional argument OLD-STRUCT is the reference
1956 structure of the list. It should be provided whenever STRUCT
1957 doesn't correspond anymore to the real list in buffer."
1958 ;; Order of functions matters here: checkboxes and endings need
1959 ;; correct indentation to be set, and indentation needs correct
1960 ;; bullets.
1961 ;;
1962 ;; 0. Save a copy of structure before modifications
1964 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1965 ;; order to get items endings and bullets properly
1967 ;; 2. Fix each item end to get correct prevs alist.
1969 ;; 3. Get bullets right.
1972 ;; 4. Now get real indentation.
1974 ;; 5. Eventually fix checkboxes.
1976 ;; 6. Apply structure modifications to buffer.
1980 \f
1981 ;;; Misc Tools
1984 "Call FUNCTION on each item of the list at point.
1985 FUNCTION must be called with at least one argument: INIT-VALUE,
1986 that will contain the value returned by the function at the
1987 previous item, plus ARGS extra arguments.
1989 FUNCTION is applied on items in reverse order.
1991 As an example, \(org-apply-on-list \(lambda \(result\) \(1+ result\)\) 0\)
1992 will return the number of items in the current list.
1994 Sublists of the list are skipped. Cursor is always at the
1995 beginning of the item."
2007 value))
2010 "Set visibility of ITEM in STRUCT to VIEW.
2012 Possible values are: `folded', `children' or `subtree'. See
2013 `org-cycle' for more information."
2017 ;; Hide from eol
2019 item-end t)))
2021 ;; First show everything.
2023 ;; Then fold every child.
2028 children)))
2030 ;; Show everything
2035 "Return column at which body of ITEM should start."
2045 tcol))
2048 \f
2049 ;;; Interactive functions
2054 "Go to the beginning of the current item.
2055 Throw an error when not in a list."
2061 "Go to the beginning item of the current list or sublist.
2062 Throw an error when not in a list."
2073 "Go to the end of the current list or sublist.
2074 Throw an error when not in a list."
2085 "Go to the end of the current item.
2086 Throw an error when not in a list."
2096 "Move to the beginning of the previous item.
2097 Throw an error when not in a list. Also throw an error when at
2098 first item, unless `org-list-use-circular-motion' is non-nil."
2114 "Move to the beginning of the next item.
2115 Throw an error when not in a list. Also throw an error when at
2116 last item, unless `org-list-use-circular-motion' is non-nil."
2132 "Move the item at point down, i.e. swap with following item.
2133 Sub-items (items with larger indentation) are considered part of
2134 the item, so this really moves item trees."
2153 "Move the item at point up, i.e. swap with previous item.
2154 Sub-items (items with larger indentation) are considered part of
2155 the item, so this really moves item trees."
2172 "Insert a new item at the current level.
2173 If cursor is before first character after bullet of the item, the
2174 new item will be created before the current one.
2176 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2178 Return t when things worked, nil when we are not in an item, or
2179 item is invisible."
2182 ;; If cursor isn't is a list or if list is invisible, return nil.
2190 ;; Timer list: delegate to `org-timer-item'.
2195 ;; If we're in a description list, ask for the new term.
2209 t)))))
2212 "Fix indentation, bullets and checkboxes is the list at point."
2220 "Cycle through the different itemize/enumerate bullets.
2221 This cycle the entire list level through the sequence:
2223 `-' -> `+' -> `*' -> `1.' -> `1)'
2225 If WHICH is a valid string, use that as the new bullet. If WHICH
2226 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2227 `previous', cycle backwards."
2247 ;; Compute list of possible bullets, depending on context.
2250 ;; *-bullets are not allowed at column 0.
2252 ;; Description items cannot be numbered.
2275 ;; Use a short variation of `org-list-write-struct' as there's
2276 ;; no need to go through all the steps.
2284 "Toggle the checkbox in the current line.
2285 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2286 double prefix, set checkbox to [-].
2288 When there is an active region, toggle status or presence of the
2289 first checkbox there, and make every item inside have the same
2290 status or presence, respectively.
2292 If the cursor is in a headline, apply this to all checkbox items
2293 in the text below the heading, taking as reference the first item
2294 in subtree, ignoring drawers."
2298 block-item
2299 lim-up
2300 lim-down
2311 ;; In a region, start at first item in region.
2321 ;; On an heading, start at first item after drawers and
2322 ;; time-stamps (scheduled, etc.).
2333 ;; Just one item: set SINGLEP flag.
2339 ;; Determine the checkbox going to be applied to all items
2340 ;; within bounds.
2351 ;; When an item is found within bounds, grab the full list at
2352 ;; point structure, then: (1) set check-box of all its items
2353 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2354 ;; whole list, (3) move point after the list.
2368 e struct
2369 ;; If there is no box at item, leave as-is
2370 ;; unless function was called with C-u prefix.
2373 ref-checkbox
2374 cur-box))))
2375 items-to-toggle)
2377 struct parents prevs orderedp))
2378 ;; Report some problems due to ORDERED status of subtree.
2379 ;; If only one box was being checked, throw an error, else,
2380 ;; only signal problems.
2384 "Checkbox blocked because of unchecked box at line %d"
2388 "Checkboxes were removed due to unchecked box at line %d"
2397 "Reset all checkboxes in an entry subtree."
2414 "Update the checkbox statistics in the current section.
2415 This will find all statistic cookies like [57%] and [6/12] and
2416 update them with the current numbers.
2418 With optional prefix argument ALL, do this for the whole buffer."
2422 (box-re "^[ \t]*\\([-+*]\\|\\([0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2434 ;; Return number of checked boxes and boxes of all types
2435 ;; in all structures in STRUCTS. If RECURSIVEP is
2436 ;; non-nil, also count boxes in sub-lists. If ITEM is
2437 ;; nil, count across the whole structure, else count only
2438 ;; across subtree whose ancestor is ITEM.
2455 items))))
2458 structs)
2461 cookies-list structs-bak box-num)
2463 ;; 1. Build an alist for each cookie found within BOUNDS. The
2464 ;; key will be position at beginning of cookie and values
2465 ;; ending position, format of cookie, and a cell whose car is
2466 ;; number of checked boxes to report, and cdr total number of
2467 ;; boxes.
2477 ;; Cookie is at an heading, but specifically for todo,
2478 ;; not for checkboxes: skip it.
2484 ;; Cookie is at an heading, but all lists before next
2485 ;; heading already have been read. Use data collected
2486 ;; in STRUCTS-BAK. This should only happen when
2487 ;; heading has more than one cookie on it.
2490 backup-end))
2492 ;; Cookie is at a fresh heading. Grab structure of
2493 ;; every list containing a checkbox between point and
2494 ;; next headline, and save them in STRUCTS-BAK.
2498 structs-bak nil)
2505 ;; Cookie is at an item, and we already have list
2506 ;; structure stored in STRUCTS-BAK.
2509 ;; Only lists in no special context are stored.
2512 ;; Cookie is at an item, but we need to compute list
2513 ;; structure.
2519 ;; Else, cookie found is at a wrong place. Skip it.
2521 cookies-list))))
2522 ;; 2. Apply alist to buffer, in reverse order so positions stay
2523 ;; unchanged after cookie modifications.
2538 cookies-list))))
2541 "Select the face for checkbox statistics.
2542 The face will be `org-done' when all relevant boxes are checked.
2543 Otherwise it will be `org-todo'."
2546 'org-checkbox-statistics-done
2550 'org-checkbox-statistics-done
2554 "Update checkbox statistics unless turned off by user.
2555 With an optional argument ALL, update them in the whole buffer."
2563 "Indent a local list item including its children.
2564 When number ARG is a negative, item will be outdented, otherwise
2565 it will be indented.
2567 If a region is active, all items inside will be moved.
2569 If NO-SUBTREE is non-nil, only indent the item itself, not its
2570 children.
2572 STRUCT is the list structure.
2574 Return t if successful."
2582 ;; Are we going to move the whole list?
2590 t))))
2591 ;; Determine begin and end points of zone to indent. If moving
2592 ;; more than one item, save them for subsequent moves.
2608 ;; Special case: moving top-item with indent rule.
2616 ;; Change bullet if necessary.
2622 ;; Shift every item by OFFSET and fix bullets. Then
2623 ;; apply changes to buffer.
2627 struct)
2630 ;; Forbidden move:
2632 ;; If only one item is moved, it mustn't have a child.
2636 ;; If a subtree or region is moved, the last item
2637 ;; of the subtree mustn't have a child.
2642 struct)))))
2645 ;; Normal shifting
2653 t)
2656 "Outdent a local list item, but not its children.
2657 If a region is active, all items inside will be moved."
2673 "Indent a local list item, but not its children.
2674 If a region is active, all items inside will be moved."
2690 "Outdent a local list item including its children.
2691 If a region is active, all items inside will be moved."
2707 "Indent a local list item including its children.
2708 If a region is active, all items inside will be moved."
2725 "Cycle levels of indentation of an empty item.
2726 The first run indents the item, if applicable. Subsequent runs
2727 outdent it at meaningful levels in the list. When done, item is
2728 put back at its original position with its original bullet.
2730 Return t at each successful move."
2736 ;; Accept empty items or if cycle has already started.
2747 ;; When in the middle of the cycle, try to outdent first. If
2748 ;; it fails, and point is still at initial position, indent.
2749 ;; Else, re-create it at its original position.
2758 ;; Break cycle
2760 ;; If a cycle is starting, remember indentation and bullet,
2761 ;; then try to indent. If it fails, try to outdent.
2767 t))))
2770 "Sort list items.
2771 The cursor may be at any item of the list that should be sorted.
2772 Sublists are not sorted. Checkboxes, if any, are ignored.
2774 Sorting can be alphabetically, numerically, by date/time as given
2775 by a time stamp, by a property or by priority.
2777 Comparing entries ignores case by default. However, with an
2778 optional argument WITH-CASE, the sorting considers case as well.
2780 The command prompts for the sorting type unless it has been given
2781 to the function through the SORTING-TYPE argument, which needs to
2782 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
2783 meaning of each character:
2785 n Numerically, by converting the beginning of the item to a number.
2786 a Alphabetically. Only the first line of item is checked.
2787 t By date/time, either the first active time stamp in the entry, if
2788 any, or by the first inactive one. In a timer list, sort the timers.
2790 Capital letters will reverse the sort order.
2792 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2793 a function to be called with point at the beginning of the
2794 record. It must return either a string or a number that should
2795 serve as the sorting key for that record. It will then use
2796 COMPARE-FUNC to compare entries.
2798 Sorting is done against the visible part of the headlines, it
2799 ignores hidden links."
2849 ;; If it is a timer list, convert timer to seconds
2862 value))
2866 next-record
2867 end-record
2868 value-to-sort
2869 nil
2870 sort-func)
2871 ;; Read and fix list again, as `sort-subr' probably destroyed
2872 ;; its structure.
2878 \f
2879 ;;; Send and receive lists
2882 "Parse the list at point and maybe DELETE it.
2884 Return a list whose car is a symbol of list type, among
2885 `ordered', `unordered' and `descriptive'. Then, each item is
2886 a list whose car is counter, and cdr are strings and other
2887 sub-lists. Inside strings, check-boxes are replaced by
2890 For example, the following list:
2892 1. first item
2893 + sub-item one
2894 + [X] sub-item two
2895 more text in first item
2896 2. [@3] last item
2898 will be parsed as:
2900 \(ordered
2902 \(unordered
2908 Point is left at list end."
2914 out
2915 parse-item ; for byte-compiler
2918 ;; Return text between BEG and END, trimmed, with
2919 ;; checkboxes replaced.
2930 text)))))
2933 ;; Return a list whose car is list type and cdr a list of
2934 ;; items' body.
2940 ;; Return a list containing counter of item, if any, text
2941 ;; and any sublist inside it.
2947 ;; Get counter number. For alphabetic counter, get
2948 ;; its position in the alphabet.
2959 ;; If item has a child, store text between bullet and
2960 ;; next child, then recursively parse all sublists. At
2961 ;; the end of each sublist, check for the presence of
2962 ;; text belonging to the original item.
2972 ;; Remove children from the list just parsed.
2974 ;; There is a chunk of text belonging to the
2975 ;; item if last child doesn't end where next
2976 ;; child starts or where item ends.
2980 body))))
2983 ;; Store output, take care of cursor position and deletion of
2984 ;; list, then return output.
2991 out))
2994 "Convert the plain list at point into a subtree."
3002 "Insert a radio list template appropriate for this major mode."
3006 name pos)
3017 "Send a transformed version of this list to the receiver position.
3018 With argument MAYBE, fail quietly if no transformation is defined
3019 for this list."
3041 beg txt)
3045 ;; Find the insertion place
3050 name
3064 "Trim line breaks in a list ITEM."
3068 "Convert a LIST parsed through `org-list-parse-list' to other formats.
3069 Valid parameters PARAMS are:
3071 :ustart String to start an unordered list
3072 :uend String to end an unordered list
3074 :ostart String to start an ordered list
3075 :oend String to end an ordered list
3077 :dstart String to start a descriptive list
3078 :dend String to end a descriptive list
3079 :dtstart String to start a descriptive term
3080 :dtend String to end a descriptive term
3081 :ddstart String to start a description
3082 :ddend String to end a description
3084 :splice When set to t, return only list body lines, don't wrap
3085 them into :[u/o]start and :[u/o]end. Default is nil.
3087 :istart String to start a list item.
3088 :icount String to start an item with a counter.
3089 :iend String to end a list item
3090 :isep String to separate items
3091 :lsep String to separate sublists
3092 :csep String to separate text from a sub-list
3094 :cboff String to insert for an unchecked check-box
3095 :cbon String to insert for a checked check-box
3096 :cbtrans String to insert for a check-box in transitional state
3098 :nobr Non-nil means remove line breaks in lists items.
3100 Alternatively, each parameter can also be a form returning
3101 a string. These sexp can use keywords `counter' and `depth',
3102 representing respectively counter associated to the current
3103 item, and depth of the current sub-list, starting at 0.
3104 Obviously, `counter' is only available for parameters applying to
3105 items."
3129 export-sublist ; for byte-compiler
3132 ;; Export an item ITEM of type TYPE, at DEPTH. First
3133 ;; string in item is treated in a special way as it can
3134 ;; bring extra information that needs to be processed.
3140 ;; Stick DTSTART to ISTART by
3141 ;; left-trimming the latter.
3145 istart))
3152 ;; Replace checkbox if any is found.
3160 ;; Replace line breaks if required
3162 ;; Insert descriptive term if TYPE is `descriptive'.
3171 first)))
3182 ;; Export sublist SUB at DEPTH.
3200 "Convert LIST into a LaTeX list.
3201 LIST is as string representing the list to transform, as Org
3202 syntax. Return converted list as a string."
3207 "Convert LIST into a HTML list.
3208 LIST is as string representing the list to transform, as Org
3209 syntax. Return converted list as a string."
3214 "Convert LIST into a Texinfo list.
3215 LIST is as string representing the list to transform, as Org
3216 syntax. Return converted list as a string."
3221 "Convert LIST into an Org subtree.
3222 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3223 with overruling parameters for `org-list-to-generic'."
3233 ;; Return the string for the heading, depending on depth D
3234 ;; of current sub-list.
3239 oddeven-level)
3240 ?*)
3243 list
3245 '(:splice t
3252 params))))
3256 ;;; org-list.el ends here