| blob | 1b362f2e3644ca42288fc4efb4d9b92eeb512636 |
1 ;;; org-list.el --- Plain lists for Org-mode
2 ;;
3 ;; Copyright (C) 2004-2012 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Bastien Guerry <bzg AT gnu DOT org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;;
10 ;; This file is part of GNU Emacs.
11 ;;
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
25 ;;
26 ;;; Commentary:
28 ;; This file contains the code dealing with plain lists in Org-mode.
30 ;; The core concept behind lists is their structure. A structure is
31 ;; a snapshot of the list, in the shape of a data tree (see
32 ;; `org-list-struct').
34 ;; Once the list structure is stored, it is possible to make changes
35 ;; on it that will be mirrored to the real list or to get information
36 ;; about the list, using accessors and methods provided in the
37 ;; library. Most of them require the use of one or two helper
38 ;; functions, namely `org-list-parents-alist' and
39 ;; `org-list-prevs-alist'.
41 ;; Structure is eventually applied to the buffer with
42 ;; `org-list-write-struct'. This function repairs (bullets,
43 ;; indentation, checkboxes) the list in the process. It should be
44 ;; called near the end of any function working on structures.
46 ;; Thus, a function applying to lists should usually follow this
47 ;; template:
49 ;; 1. Verify point is in a list and grab item beginning (with the same
50 ;; function `org-in-item-p'). If the function requires the cursor
51 ;; to be at item's bullet, `org-at-item-p' is more selective. It
52 ;; is also possible to move point to the closest item with
53 ;; `org-list-search-backward', or `org-list-search-forward',
54 ;; applied to the function `org-item-beginning-re'.
56 ;; 2. Get list structure with `org-list-struct'.
58 ;; 3. Compute one, or both, helper functions,
59 ;; (`org-list-parents-alist', `org-list-prevs-alist') depending on
60 ;; needed accessors.
62 ;; 4. Proceed with the modifications, using methods and accessors.
64 ;; 5. Verify and apply structure to buffer, using
65 ;; `org-list-write-struct'.
67 ;; 6. If changes made to the list might have modified check-boxes,
68 ;; call `org-update-checkbox-count-maybe'.
70 ;; Computing a structure can be a costly operation on huge lists (a
71 ;; few thousand lines long). Thus, code should follow the rule:
72 ;; "collect once, use many". As a corollary, it is usually a bad idea
73 ;; to use directly an interactive function inside the code, as those,
74 ;; being independent entities, read the whole list structure another
75 ;; time.
77 ;;; Code:
132 \f
133 ;;; Configuration variables
136 "Options concerning plain lists in Org-mode."
141 "When t, make TAB cycle visibility on plain list items.
142 Cycling plain lists works only when the cursor is on a plain list
143 item. When the cursor is on an outline heading, plain lists are
144 treated as text. This is the most stable way of handling this,
145 which is why it is the default.
147 When this is the symbol `integrate', then during cycling, plain
148 list items will *temporarily* be interpreted as outline headlines
149 with a level given by 1000+i where i is the indentation of the
150 bullet. This setting can lead to strange effects when switching
152 subtree decides what children should be listed. If that first
154 number, all true children and grand children of the outline
155 heading will be exposed in a children' view."
163 "Default bullet type installed when demoting an item.
164 This is an association list, for each bullet type, this alist will point
165 to the bullet that should be used when this item is demoted.
166 For example,
168 (setq org-list-demote-modify-bullet
171 will make
173 + Movies
174 + Silence of the Lambs
175 + My Cousin Vinny
176 + Books
177 + The Hunt for Red October
178 + The Road to Omaha
180 into
182 + Movies
183 - Silence of the Lambs
184 - My Cousin Vinny
185 + Books
186 - The Hunt for Red October
187 - The Road to Omaha"
205 "The character that makes a line with leading number an ordered list item.
206 Valid values are ?. and ?\). To get both terminators, use t."
213 "Non-nil means single character alphabetical bullets are allowed.
214 Both uppercase and lowercase are handled. Lists with more than
215 26 items will fallback to standard numbering. Alphabetical
222 "A regular expression matching bullets that should have 2 spaces after them.
223 When nil, no bullet will have two spaces after them. When
224 a string, it will be used as a regular expression. When the
225 bullet type of a list is changed, the new bullet type will be
226 matched against this regexp. If it matches, there will be two
227 spaces instead of one after the bullet in each item of the list."
234 "Non-nil means an empty line ends all plain list levels.
235 Otherwise, two of them will be necessary."
242 "Non-nil means apply set of rules when acting on lists.
243 By default, automatic actions are taken when using
248 rules by setting them to nil. Valid rules are:
250 bullet when non-nil, cycling bullet do not allow lists at
251 column 0 to have * as a bullet and descriptions lists
252 to be numbered.
253 checkbox when non-nil, checkbox statistics is updated each time
254 you either insert a new checkbox or toggle a checkbox.
255 It also prevents from inserting a checkbox in a
256 description item.
257 indent when non-nil, indenting or outdenting list top-item
258 with its subtree will move the whole list and
259 outdenting a list whose bullet is * to column 0 will
264 :key-type
269 :value-type
273 "Non-nil means commands implying motion in lists should be cyclic.
275 In that case, the item following the last item is the first one,
276 and the item preceding the first item is the last one.
286 "Hook that is run whenever Org thinks checkbox statistics should be updated.
287 This hook runs even if checkbox rule in
288 `org-list-automatic-rules' does not apply, so it can be used to
289 implement alternative ways of collecting statistics
293 "Non-nil means checkbox statistics counts only the state of direct children.
294 When nil, all boxes below the cookie are counted.
295 This can be set to nil on a per-node basis using a COOKIE_DATA property
301 "Maximum indentation for the second line of a description list.
302 When the indentation would be larger than this, it will become
303 5 characters instead."
308 "Additional indentation for sub-items in a list.
309 By setting this to a small number, usually 1 or 2, one can more
310 clearly distinguish sub-items in a list."
317 % END RECEIVE ORGLST %n
319 #+ORGLST: SEND %n org-list-to-latex
320 -
323 @c END RECEIVE ORGLST %n
324 @ignore
325 #+ORGLST: SEND %n org-list-to-texinfo
326 -
329 <!-- END RECEIVE ORGLST %n -->
330 <!--
331 #+ORGLST: SEND %n org-list-to-html
332 -
334 "Templates for radio lists in different major modes.
335 All occurrences of %n in a template will be replaced with the name of the
336 list, obtained by prompting the user."
344 "Names of blocks where lists are not allowed.
348 "Context types where lists will be interpreted during export.
350 Valid types are `drawer', `inlinetask' and `block'. More
351 specifically, type `block' is determined by the variable
355 \f
356 ;;; Predicates and regexps
360 "Regex corresponding to the end of a list.
368 "Matches a list item and puts everything into groups:
369 group 1: bullet
370 group 2: counter
371 group 3: checkbox
375 "Return the correct regular expression for plain lists."
386 "Regexp matching the beginning of a plain list item."
390 "Is point at a list item with REGEXP after bullet?"
399 ;; Ignore counter if any
404 "Is point in a context where lists are allowed?"
408 "Return item beginning position when in a plain list, nil otherwise."
420 ;; Indentation isn't meaningful when point starts at an empty
421 ;; line or an inline task.
424 10000
430 ;; Detect if cursor in amidst `org-list-end-re'. First, count
431 ;; number HL of hard lines it takes, then call `org-in-regexp'
432 ;; to compute its boundaries END-BOUNDS. When point is
433 ;; in-between, move cursor before regexp beginning.
444 ;; Look for an item, less indented that reference line.
449 ;; This is exactly what we want.
452 ;; At upper bound of search or looking at the end of a
453 ;; previous list: search is over.
456 ;; Skip blocks, drawers, inline-tasks, blank lines
466 ;; Text at column 0 cannot belong to a list: stop.
468 ;; Normal text less indented than reference line, take
469 ;; it as new reference.
476 "Is point in a line starting a hand-formatted item?"
482 "Is point at the bullet of a plain list item?"
488 "Is point at a line starting a plain list item with a timer?"
493 "Is point at a description list item?"
497 "Is point at a line starting a plain-list item with a checklet?"
501 "Is point at a line starting a plain-list item with a counter?"
507 \f
508 ;;; Structures and helper functions
511 "Determine context, and its boundaries, around point.
513 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
514 are boundaries and CONTEXT is a symbol among `drawer', `block',
515 `invalid', `inlinetask' and nil.
517 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
523 ;; Get positions of surrounding headings. This is the
524 ;; default context.
529 ;; Is point inside a drawer?
531 ;; Can't use org-drawers-regexp as this function might
532 ;; be called in buffers not in Org mode.
543 lim-down))
546 ;; Is point strictly in a block, and of which type?
557 lim-down))
563 ;; Is point in an inlinetask?
576 ;; Return context boundaries and type.
580 "Return structure of list at point.
582 A list structure is an alist where key is point at item, and
583 values are:
584 1. indentation,
585 2. bullet with trailing whitespace,
586 3. bullet counter, if any,
587 4. checkbox, if any,
588 5. description tag, if any,
589 6. position at item end.
591 Thus the following list, where numbers in parens are
592 point-at-bol:
594 - [X] first item (1)
595 1. sub-item 1 (18)
596 5. [@5] sub-item 2 (34)
597 some other text belonging to first item (55)
598 - last item (97)
599 + tag :: description (109)
600 (131)
602 will get the following structure:
610 Assume point is at an item."
625 ind itm-lst itm-lst-2 end-lst end-lst-2 struct
628 ;; Return association at point.
632 ind
639 ;; Ensure list ends at the first blank line.
643 ;; 1. Read list from starting item to its beginning, and save
644 ;; top item position and indentation in BEG-CELL. Also store
645 ;; ending position of items in END-LST.
653 ;; At upward limit: if we ended at an item, store it,
654 ;; else dismiss useless data recorded above BEG-CELL.
655 ;; Jump to part 2.
663 ;; At a verbatim block, go before its beginning. Move
664 ;; from eol to ensure `previous-single-property-change'
665 ;; will return a value.
670 ;; Looking at a list ending regexp. Dismiss useless
671 ;; data recorded above BEG-CELL. Jump to part 2.
676 ;; Point is at an item. Add data to ITM-LST. It may
677 ;; also end a previous item: save it in END-LST. If
678 ;; ind is less or equal than BEG-CELL and there is no
679 ;; end at this ind or lesser, this item becomes the new
680 ;; BEG-CELL.
687 ;; Skip blocks, drawers, inline tasks, blank lines.
698 ;; From there, point is not at an item. Interpret
699 ;; line's indentation:
700 ;; - text at column 0 is necessarily out of any list.
701 ;; Dismiss data recorded above BEG-CELL. Jump to
702 ;; part 2.
703 ;; - any other case may be an ending position for an
704 ;; hypothetical item above. Store it and proceed.
713 ;; 2. Read list from starting point to its end, that is until we
714 ;; get out of context, or that a non-item line is less or
715 ;; equally indented than BEG-CELL's cdr. Also, store ending
716 ;; position of items in END-LST-2.
723 ;; At downward limit: this is de facto the end of the
724 ;; list. Save point as an ending position, and jump to
725 ;; part 3.
728 ;; At a verbatim block, move to its end. Point is at bol
729 ;; and 'org-example property is set by whole lines:
730 ;; `next-single-property-change' always return a value.
734 ;; Looking at a list ending regexp. Save point as an
735 ;; ending position and jump to part 3.
739 ;; Point is at an item. Add data to ITM-LST-2. It may
740 ;; also end a previous item, so save it in END-LST-2.
744 ;; Skip inline tasks and blank lines along the way
749 ;; Ind is lesser or equal than BEG-CELL's. The list is
750 ;; over: store point as an ending position and jump to
751 ;; part 3.
755 ;; Else, if ind is lesser or equal than previous item's,
756 ;; this is an ending position: store it. In any case,
757 ;; skip block or drawer at point, and move to next line.
769 ;; 3. Associate each item to its end position.
771 ;; 4. Return STRUCT
772 struct)))
775 "Associate proper ending point to items in STRUCT.
777 END-LIST is a pseudo-alist where car is indentation and cdr is
778 ending position.
780 This function modifies STRUCT."
786 ;; Remove end candidates behind current item.
789 ;; Add end position to item assoc.
795 struct)))
798 "Return alist between item and previous item in STRUCT."
800 struct)))
804 struct)))
807 "Return alist between item and parent in STRUCT."
819 ;; A sub-list is over. Find the associated
820 ;; origin in IND-TO-ORI. If it cannot be
821 ;; found (ill-formed list), set its parent as
822 ;; the first item less indented. If there is
823 ;; none, make it a top-level item.
831 ind-to-ori)
834 ;; A sub-list starts. Every item at IND will
835 ;; have previous item as its parent.
840 ;; Another item in the same sub-list: it shares
841 ;; the same parent as the previous item.
846 \f
847 ;;; Accessors
850 "Return the Nth value of KEY in STRUCT."
854 "Set the Nth value of KEY in STRUCT to NEW.
859 "Return indentation of ITEM in STRUCT."
863 "Set indentation of ITEM in STRUCT to IND.
868 "Return bullet of ITEM in STRUCT."
872 "Set bullet of ITEM in STRUCT to BULLET.
877 "Return counter of ITEM in STRUCT."
881 "Return checkbox of ITEM in STRUCT or nil."
885 "Set checkbox of ITEM in STRUCT to CHECKBOX.
890 "Return end position of ITEM in STRUCT."
894 "Return end position of ITEM in STRUCT."
898 "Return point at end of ITEM in STRUCT, before any blank line.
899 Point returned is at end of line."
906 "Return parent of ITEM or nil.
907 STRUCT is the list structure. PARENTS is the alist of parents,
908 as returned by `org-list-parents-alist'."
913 "Non-nil if ITEM has a child.
915 STRUCT is the list structure.
917 Value returned is the position of the first child of ITEM."
922 child-maybe)))
925 "Return next item in same sub-list as ITEM, or nil.
926 STRUCT is the list structure. PREVS is the alist of previous
927 items, as returned by `org-list-prevs-alist'."
931 "Return previous item in same sub-list as ITEM, or nil.
932 STRUCT is the list structure. PREVS is the alist of previous
933 items, as returned by `org-list-prevs-alist'."
937 "List all items having ITEM as a common ancestor, or nil.
938 STRUCT is the list structure."
941 subtree)
946 sub-struct))
950 "List all items in the same sub-list as ITEM.
951 STRUCT is the list structure. PREVS is the alist of previous
952 items, as returned by `org-list-prevs-alist'."
955 before-item after-item)
963 "List all children of ITEM, or nil.
964 STRUCT is the list structure. PARENTS is the alist of parents,
965 as returned by `org-list-parents-alist'."
973 "Return point at beginning of list.
974 STRUCT is the list structure."
978 "Return point at bottom of list.
979 STRUCT is the list structure."
984 "Return point at beginning of sub-list ITEM belongs.
985 STRUCT is the list structure. PREVS is the alist of previous
986 items, as returned by `org-list-prevs-alist'."
990 first-item))
995 "Return point at last item of sub-list ITEM belongs.
996 STRUCT is the list structure. PREVS is the alist of previous
997 items, as returned by `org-list-prevs-alist'."
1001 last-item))
1004 "Return point at end of sub-list ITEM belongs.
1005 STRUCT is the list structure. PREVS is the alist of previous
1006 items, as returned by `org-list-prevs-alist'."
1010 "Return the type of the list containing ITEM, as a symbol.
1012 STRUCT is the list structure. PREVS is the alist of previous
1013 items, as returned by `org-list-prevs-alist'.
1015 Possible types are `descriptive', `ordered' and `unordered'. The
1016 type is determined by the first item of the list."
1024 \f
1025 ;;; Searching
1028 "Search a string in valid contexts for lists.
1029 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1030 in `re-search-forward'."
1034 ;; 1. No match: return to origin or bound, depending on NOERR.
1037 nil)))
1038 ;; 2. Match in valid context: return point. Else, continue
1039 ;; searching.
1043 "Like `re-search-backward' but stop only where lists are recognized.
1044 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1045 `re-search-backward'."
1050 "Like `re-search-forward' but stop only where lists are recognized.
1051 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1052 `re-search-forward'."
1057 \f
1058 ;;; Methods on structures
1061 "Return BULLET with the correct number of whitespaces.
1062 It determines the number of whitespaces to append by looking at
1063 `org-list-two-spaces-after-bullet-regexp'."
1067 org-list-two-spaces-after-bullet-regexp bullet))
1068 " "
1074 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1075 Blank lines at the end of items are left in place. Return the
1076 new structure after the changes.
1078 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1079 to the same sub-list.
1081 This function modifies STRUCT."
1094 ;; 1. Move effectively items in buffer.
1098 ;; 2. Now modify struct. No need to re-read the list, the
1099 ;; transformation is just a shift of positions. Some special
1100 ;; attention is required for items ending at END-A and END-B
1101 ;; as empty spaces are not moved there. In others words,
1102 ;; item BEG-A will end with whitespaces that were at the end
1103 ;; of BEG-B and the same applies to BEG-B.
1125 struct)
1129 "Return number of blank lines that should separate items in list.
1131 POS is the position of point where `org-list-insert-item' was called.
1133 STRUCT is the list structure. PREVS is the alist of previous
1134 items, as returned by `org-list-prevs-alist'.
1136 Assume point is at item's beginning. If the item is alone, apply
1137 some heuristics to guess the result."
1142 usr-blank
1146 ;; Count blank lines above beginning of line.
1153 ;; Trivial cases where there should be none.
1155 ;; When `org-blank-before-new-entry' says so, it is 1.
1157 ;; `plain-list-item' is 'auto. Count blank lines separating
1158 ;; neighbours items in list.
1161 ;; Is there a next item?
1164 ;; Is there a previous item?
1167 ;; User inserted blank lines, trust him.
1172 usr-blank)
1173 ;; Are there blank lines inside the list so far?
1179 ;; Default choice: no blank line.
1183 "Insert a new list item at POS and return the new structure.
1184 If POS is before first character after bullet of the item, the
1185 new item will be created before the current one.
1187 STRUCT is the list structure. PREVS is the the alist of previous
1188 items, as returned by `org-list-prevs-alist'.
1190 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1191 after the bullet. Cursor will be after this text once the
1192 function ends.
1194 This function modifies STRUCT."
1196 ;; 1. Get information about list: position of point with regards
1197 ;; to item start (BEFOREP), blank lines number separating items
1198 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1206 pos struct prevs))
1207 ;; 2. Build the new item to be created. Concatenate same
1208 ;; bullet as item, checkbox, text AFTER-BULLET if
1209 ;; provided, and text cut from point to end of item
1210 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1211 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1212 ;; between what was cut and what was inserted in buffer
1213 ;; is stored in SIZE-OFFSET.
1217 ind))
1224 ;; If POS is greater than ITEM-END, then point is
1225 ;; in some white lines after the end of the list.
1226 ;; Those must be removed, or they will be left,
1227 ;; stacking up after the list.
1237 text-cut))))
1241 ;; 4. Insert effectively item into buffer.
1245 ;; 5. Add new item to STRUCT.
1250 ;; Before inserted item, positions don't change but
1251 ;; an item ending after insertion has its end shifted
1252 ;; by SIZE-OFFSET.
1255 ;; Trivial cases where current item isn't split in
1256 ;; two. Just shift every item after new one by
1257 ;; ITEM-SIZE.
1261 ;; Item is split in two: elements before POS are just
1262 ;; shifted by ITEM-SIZE. In the case item would end
1263 ;; after split POS, ending is only shifted by
1264 ;; SIZE-OFFSET.
1270 ;; Elements after POS are moved into new item.
1271 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1272 ;; doesn't appear in buffer yet.
1278 (+ end size-offset
1280 ;; Elements at ITEM-END or after are only shifted by
1281 ;; SIZE-OFFSET.
1284 struct)
1287 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1288 ;; exchange ITEM with the next item in list. Position cursor
1289 ;; after bullet, counter, checkbox, and label.
1295 struct)))
1298 "Remove ITEM from the list and return the new structure.
1300 STRUCT is the list structure."
1303 ;; If ITEM ends with the list, delete blank lines
1304 ;; before it.
1309 item)))
1310 ;; Remove item from buffer.
1312 ;; Remove item from structure and shift others items accordingly.
1313 ;; Don't forget to shift also ending position when appropriate.
1331 struct)))))
1334 "Send ITEM to destination DEST.
1336 STRUCT is the list structure.
1338 DEST can have various values.
1340 If DEST is a buffer position, the function will assume it points
1341 to another item in the same list as ITEM, and will move the
1342 latter just before the former.
1344 If DEST is `begin' \(respectively `end'\), ITEM will be moved at
1345 the beginning \(respectively end\) of the list it belongs to.
1348 be moved at the Nth position in the list.
1350 If DEST is `kill', ITEM will be deleted and its body will be
1351 added to the kill-ring.
1353 If DEST is `delete', ITEM will be deleted.
1355 This function returns, destructively, the new list structure."
1358 ;; Grab full item body minus its bullet.
1367 item-end)))
1368 ;; Change DEST into a buffer position. A trick is needed
1369 ;; when ITEM is meant to be sent at the end of the list.
1370 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1371 ;; nil and insertion point (INS-POINT) to the first line's
1372 ;; end of the last item, we ensure the new item will be
1373 ;; inserted after the last item, and not after any of its
1374 ;; hypothetical sub-items.
1390 ;; Send ITEM at the end of the list.
1406 ;; 1. Structure returned by `org-list-insert-item' may not be
1407 ;; accurate, as it cannot see sub-items included in BODY.
1408 ;; Thus, first compute the real structure so far.
1416 ;; 1.1. Remove the item just created in structure.
1418 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1421 struct
1429 new-end
1431 moved-items))
1433 ;; 2. Eventually delete extra copy of the item and clean marker.
1440 "Outdent items between positions START and END.
1442 STRUCT is the list structure. PARENTS is the alist of items'
1443 parents, as returned by `org-list-parents-alist'.
1445 START is included, END excluded."
1451 ;; Item not yet in zone: keep association.
1453 ;; Item out of zone: follow associations in ACC.
1457 ;; Item has no parent: error
1460 ;; Parent is outdented: keep association.
1464 ;; Parent isn't outdented: reparent to grand-parent.
1466 parent struct parents)))
1472 "Indent items between positions START and END.
1474 STRUCT is the list structure. PARENTS is the alist of parents
1475 and PREVS is the alist of previous items, returned by,
1476 respectively, `org-list-parents-alist' and
1477 `org-list-prevs-alist'.
1479 START is included and END excluded.
1481 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1482 bullets between START and END."
1496 ;; Item not yet in zone: keep association.
1499 ;; Item out of zone: follow associations in ACC.
1503 ;; Item is in zone...
1505 ;; Check if bullet needs to be changed.
1508 ;; First item indented but not parent: error
1511 ;; First item and parent indented: keep same
1512 ;; parent.
1514 ;; Previous item not indented: reparent to it.
1516 ;; Previous item indented: reparent like it.
1523 \f
1524 ;;; Repairing structures
1527 "Non-nil if list starting at FIRST can have alphabetical bullets.
1529 STRUCT is list structure. PREVS is the alist of previous items,
1530 as returned by `org-list-prevs-alist'."
1534 ;; Pretend that bullets are uppercase and check if alphabet
1535 ;; is sufficient, taking counters into account.
1539 ;; Virtually determine current bullet
1541 ;; Counters are not case-sensitive.
1544 ;; Test if bullet would be over z or Z.
1548 ;; All items checked. All good.
1549 t))))
1552 "Increment BULLET if applicable."
1555 ;; Num bullet: increment it.
1559 nil nil bullet))
1560 ;; Alpha bullet: increment it.
1564 nil nil bullet))
1565 ;; Unordered bullet: leave it.
1569 "Verify and correct bullets in STRUCT.
1570 PREVS is the alist of previous items, as returned by
1571 `org-list-prevs-alist'.
1573 This function modifies STRUCT."
1577 ;; Set bullet of ITEM in STRUCT, depending on the type of
1578 ;; first item of the list, the previous bullet and counter
1579 ;; if any.
1588 item struct
1591 ;; Alpha counter in alpha list: use counter.
1595 ;; Use cond to be sure `string-match' is used in
1596 ;; both cases.
1602 ;; Num counter in a num list: use counter.
1607 ;; No counter: increase, if needed, previous bullet.
1610 ;; Alpha counter at first item: use counter.
1619 ;; Num counter at first item: use counter.
1624 ;; First bullet is alpha uppercase: use "A".
1627 ;; First bullet is alpha lowercase: use "a".
1630 ;; First bullet is num: use "1".
1633 ;; Not an ordered list: keep bullet.
1638 "Verify and correct indentation in STRUCT.
1640 PARENTS is the alist of parents, as returned by
1641 `org-list-parents-alist'.
1643 If numeric optional argument BULLET-SIZE is set, assume all
1644 bullets in list have this length to determine new indentation.
1646 This function modifies STRUCT."
1653 ;; Indent like parent + length of parent's bullet +
1654 ;; sub-list offset.
1660 org-list-indent-offset))
1661 ;; If no parent, indent like top-point.
1666 "Verify and correct checkboxes in STRUCT.
1668 PARENTS is the alist of parents and PREVS is the alist of
1669 previous items, as returned by, respectively,
1670 `org-list-parents-alist' and `org-list-prevs-alist'.
1672 If ORDERED is non-nil, a checkbox can only be checked when every
1673 checkbox before it is checked too. If there was an attempt to
1674 break this rule, the function will return the blocking item. In
1675 all others cases, the return value will be nil.
1677 This function modifies STRUCT."
1687 item struct
1693 ;; Parent has no boxed child: leave box as-is.
1695 parent-list)
1696 ;; 1. List all parents with a checkbox.
1703 all-items)
1704 ;; 2. Sort those parents by decreasing indentation.
1709 ;; 3. For each parent, get all children's checkboxes to determine
1710 ;; and set its checkbox accordingly.
1712 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1717 ;; There are boxes checked after an unchecked one: fix that.
1722 ;; Verify once again the structure, without ORDERED.
1724 ;; Return blocking item.
1728 "Verify and correct each item end position in STRUCT.
1730 This function modifies STRUCT."
1737 ;; To determine real ind of an ending position that is
1738 ;; not at an item, we have to find the item it belongs
1739 ;; to: it is the last item (ITEM-UP), whose ending is
1740 ;; further than the position we're interested in.
1743 ;; Else part is for the bottom point.
1745 end-pos)
1746 end-list)))
1749 struct)
1754 "Apply set difference between STRUCT and OLD-STRUCT to the buffer.
1756 OLD-STRUCT is the structure before any modifications, and STRUCT
1757 the structure to be applied. The function will only modify parts
1758 of the list which have changed.
1760 Initial position of cursor is restored after the changes."
1768 ;; Shift the indentation between END and BEG by DELTA.
1769 ;; Start from the line before END.
1778 ;; Skip inline tasks.
1781 ;; Shift only non-empty lines.
1788 ;; Replace ITEM first line elements with new elements from
1789 ;; STRUCT, if appropriate.
1799 ;; a. Replace bullet
1802 ;; b. Replace checkbox.
1816 ;; c. Indent item to appropriate column.
1821 ;; 1. First get list of items and position endings. We maintain
1822 ;; two alists: ITM-SHIFT, determining indentation shift needed
1823 ;; at item, and END-POS, a pseudo-alist where key is ending
1824 ;; position and value point.
1837 ;; To determine real ind of an ending position that
1838 ;; is not at an item, we have to find the item it
1839 ;; belongs to: it is the last item (ITEM-UP), whose
1840 ;; ending is further than the position we're
1841 ;; interested in.
1845 old-struct)
1846 ;; 2. Slice the items into parts that should be shifted by the
1847 ;; same amount of indentation. The slices are returned in
1848 ;; reverse order so changes modifying buffer do not change
1849 ;; positions they refer to.
1852 '<))
1860 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1861 ;; end to beginning. Take a special action when beginning is
1862 ;; at item bullet.
1869 sliced-struct))
1870 ;; 4. Go back to initial position and clean marker.
1875 "Correct bullets, checkboxes and indentation in list at point.
1877 STRUCT is the list structure. PARENTS is the alist of parents,
1878 as returned by `org-list-parents-alist'.
1880 When non-nil, optional argument OLD-STRUCT is the reference
1881 structure of the list. It should be provided whenever STRUCT
1882 doesn't correspond anymore to the real list in buffer."
1883 ;; Order of functions matters here: checkboxes and endings need
1884 ;; correct indentation to be set, and indentation needs correct
1885 ;; bullets.
1886 ;;
1887 ;; 0. Save a copy of structure before modifications
1889 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1890 ;; order to get items endings and bullets properly
1892 ;; 2. Fix each item end to get correct prevs alist.
1894 ;; 3. Get bullets right.
1897 ;; 4. Now get real indentation.
1899 ;; 5. Eventually fix checkboxes.
1901 ;; 6. Apply structure modifications to buffer.
1905 \f
1906 ;;; Misc Tools
1909 "Call FUNCTION on each item of the list at point.
1910 FUNCTION must be called with at least one argument: INIT-VALUE,
1911 that will contain the value returned by the function at the
1912 previous item, plus ARGS extra arguments.
1914 FUNCTION is applied on items in reverse order.
1916 As an example, \(org-apply-on-list \(lambda \(result\) \(1+ result\)\) 0\)
1917 will return the number of items in the current list.
1919 Sublists of the list are skipped. Cursor is always at the
1920 beginning of the item."
1932 value))
1935 "Set visibility of ITEM in STRUCT to VIEW.
1937 Possible values are: `folded', `children' or `subtree'. See
1938 `org-cycle' for more information."
1942 ;; Hide from eol
1944 item-end t)))
1946 ;; First show everything.
1948 ;; Then fold every child.
1953 children)))
1955 ;; Show everything
1960 "Return column at which body of ITEM should start."
1970 tcol))
1973 \f
1974 ;;; Interactive functions
1979 "Go to the beginning of the current item.
1980 Throw an error when not in a list."
1986 "Go to the beginning item of the current list or sublist.
1987 Throw an error when not in a list."
1998 "Go to the end of the current list or sublist.
1999 Throw an error when not in a list."
2010 "Go to the end of the current item.
2011 Throw an error when not in a list."
2021 "Move to the beginning of the previous item.
2022 Throw an error when not in a list. Also throw an error when at
2023 first item, unless `org-list-use-circular-motion' is non-nil."
2039 "Move to the beginning of the next item.
2040 Throw an error when not in a list. Also throw an error when at
2041 last item, unless `org-list-use-circular-motion' is non-nil."
2057 "Move the item at point down, i.e. swap with following item.
2058 Sub-items (items with larger indentation) are considered part of
2059 the item, so this really moves item trees."
2078 "Move the item at point up, i.e. swap with previous item.
2079 Sub-items (items with larger indentation) are considered part of
2080 the item, so this really moves item trees."
2097 "Insert a new item at the current level.
2098 If cursor is before first character after bullet of the item, the
2099 new item will be created before the current one.
2101 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2103 Return t when things worked, nil when we are not in an item, or
2104 item is invisible."
2107 ;; If cursor isn't is a list or if list is invisible, return nil.
2115 ;; Timer list: delegate to `org-timer-item'.
2120 ;; If we're in a description list, ask for the new term.
2123 ;; Don't insert a checkbox if checkbox rule is applied
2124 ;; and it is a description item.
2128 org-list-automatic-rules)))))))
2135 t)))))
2138 "Mark the current list.
2139 If this is a sublist, only mark the sublist."
2150 "Fix indentation, bullets and checkboxes is the list at point."
2158 "Cycle through the different itemize/enumerate bullets.
2159 This cycle the entire list level through the sequence:
2161 `-' -> `+' -> `*' -> `1.' -> `1)'
2163 If WHICH is a valid string, use that as the new bullet. If WHICH
2164 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2165 `previous', cycle backwards."
2186 ;; Compute list of possible bullets, depending on context.
2189 ;; *-bullets are not allowed at column 0.
2192 ;; Description items cannot be numbered.
2215 ;; Use a short variation of `org-list-write-struct' as there's
2216 ;; no need to go through all the steps.
2224 "Toggle the checkbox in the current line.
2225 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2226 double prefix, set checkbox to [-].
2228 When there is an active region, toggle status or presence of the
2229 first checkbox there, and make every item inside have the same
2230 status or presence, respectively.
2232 If the cursor is in a headline, apply this to all checkbox items
2233 in the text below the heading, taking as reference the first item
2234 in subtree, ignoring drawers."
2238 block-item
2239 lim-up
2240 lim-down
2251 ;; In a region, start at first item in region.
2261 ;; On an heading, start at first item after drawers and
2262 ;; time-stamps (scheduled, etc.).
2273 ;; Just one item: set SINGLEP flag.
2279 ;; Determine the checkbox going to be applied to all items
2280 ;; within bounds.
2291 ;; When an item is found within bounds, grab the full list at
2292 ;; point structure, then: (1) set check-box of all its items
2293 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2294 ;; whole list, (3) move point after the list.
2308 e struct
2309 ;; If there is no box at item, leave as-is
2310 ;; unless function was called with C-u prefix.
2313 ref-checkbox
2314 cur-box))))
2315 items-to-toggle)
2317 struct parents prevs orderedp))
2318 ;; Report some problems due to ORDERED status of subtree.
2319 ;; If only one box was being checked, throw an error, else,
2320 ;; only signal problems.
2324 "Checkbox blocked because of unchecked box at line %d"
2328 "Checkboxes were removed due to unchecked box at line %d"
2337 "Reset all checkboxes in an entry subtree."
2354 "Update the checkbox statistics in the current section.
2355 This will find all statistic cookies like [57%] and [6/12] and
2356 update them with the current numbers.
2358 With optional prefix argument ALL, do this for the whole buffer."
2362 (box-re "^[ \t]*\\([-+*]\\|\\([0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2374 ;; Return number of checked boxes and boxes of all types
2375 ;; in all structures in STRUCTS. If RECURSIVEP is
2376 ;; non-nil, also count boxes in sub-lists. If ITEM is
2377 ;; nil, count across the whole structure, else count only
2378 ;; across subtree whose ancestor is ITEM.
2395 items))))
2398 structs)
2401 cookies-list structs-bak box-num)
2403 ;; 1. Build an alist for each cookie found within BOUNDS. The
2404 ;; key will be position at beginning of cookie and values
2405 ;; ending position, format of cookie, and a cell whose car is
2406 ;; number of checked boxes to report, and cdr total number of
2407 ;; boxes.
2417 ;; Cookie is at an heading, but specifically for todo,
2418 ;; not for checkboxes: skip it.
2424 ;; Cookie is at an heading, but all lists before next
2425 ;; heading already have been read. Use data collected
2426 ;; in STRUCTS-BAK. This should only happen when
2427 ;; heading has more than one cookie on it.
2430 backup-end))
2432 ;; Cookie is at a fresh heading. Grab structure of
2433 ;; every list containing a checkbox between point and
2434 ;; next headline, and save them in STRUCTS-BAK.
2438 structs-bak nil)
2445 ;; Cookie is at an item, and we already have list
2446 ;; structure stored in STRUCTS-BAK.
2449 ;; Only lists in no special context are stored.
2452 ;; Cookie is at an item, but we need to compute list
2453 ;; structure.
2459 ;; Else, cookie found is at a wrong place. Skip it.
2461 cookies-list))))
2462 ;; 2. Apply alist to buffer, in reverse order so positions stay
2463 ;; unchanged after cookie modifications.
2478 cookies-list))))
2481 "Select the face for checkbox statistics.
2482 The face will be `org-done' when all relevant boxes are checked.
2483 Otherwise it will be `org-todo'."
2486 'org-checkbox-statistics-done
2490 'org-checkbox-statistics-done
2494 "Update checkbox statistics unless turned off by user.
2495 With an optional argument ALL, update them in the whole buffer."
2503 "Indent a local list item including its children.
2504 When number ARG is a negative, item will be outdented, otherwise
2505 it will be indented.
2507 If a region is active, all items inside will be moved.
2509 If NO-SUBTREE is non-nil, only indent the item itself, not its
2510 children.
2512 STRUCT is the list structure.
2514 Return t if successful."
2523 ;; Are we going to move the whole list?
2530 t))))
2531 ;; Determine begin and end points of zone to indent. If moving
2532 ;; more than one item, save them for subsequent moves.
2548 ;; Special case: moving top-item with indent rule.
2556 ;; Change bullet if necessary.
2562 ;; Shift every item by OFFSET and fix bullets. Then
2563 ;; apply changes to buffer.
2567 struct)
2570 ;; Forbidden move:
2572 ;; If only one item is moved, it mustn't have a child.
2576 ;; If a subtree or region is moved, the last item
2577 ;; of the subtree mustn't have a child.
2582 struct)))))
2585 ;; Normal shifting
2593 t)
2596 "Outdent a local list item, but not its children.
2597 If a region is active, all items inside will be moved."
2605 "Indent a local list item, but not its children.
2606 If a region is active, all items inside will be moved."
2614 "Outdent a local list item including its children.
2615 If a region is active, all items inside will be moved."
2629 "Indent a local list item including its children.
2630 If a region is active, all items inside will be moved."
2645 "Cycle levels of indentation of an empty item.
2646 The first run indents the item, if applicable. Subsequent runs
2647 outdent it at meaningful levels in the list. When done, item is
2648 put back at its original position with its original bullet.
2650 Return t at each successful move."
2656 ;; Accept empty items or if cycle has already started.
2667 ;; When in the middle of the cycle, try to outdent first. If
2668 ;; it fails, and point is still at initial position, indent.
2669 ;; Else, re-create it at its original position.
2678 ;; Break cycle
2680 ;; If a cycle is starting, remember indentation and bullet,
2681 ;; then try to indent. If it fails, try to outdent.
2687 t))))
2690 "Sort list items.
2691 The cursor may be at any item of the list that should be sorted.
2692 Sublists are not sorted. Checkboxes, if any, are ignored.
2694 Sorting can be alphabetically, numerically, by date/time as given
2695 by a time stamp, by a property or by priority.
2697 Comparing entries ignores case by default. However, with an
2698 optional argument WITH-CASE, the sorting considers case as well.
2700 The command prompts for the sorting type unless it has been given
2701 to the function through the SORTING-TYPE argument, which needs to
2702 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
2703 meaning of each character:
2705 n Numerically, by converting the beginning of the item to a number.
2706 a Alphabetically. Only the first line of item is checked.
2707 t By date/time, either the first active time stamp in the entry, if
2708 any, or by the first inactive one. In a timer list, sort the timers.
2710 Capital letters will reverse the sort order.
2712 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2713 a function to be called with point at the beginning of the
2714 record. It must return either a string or a number that should
2715 serve as the sorting key for that record. It will then use
2716 COMPARE-FUNC to compare entries."
2761 ;; If it is a timer list, convert timer to seconds
2774 value))
2778 next-record
2779 end-record
2780 value-to-sort
2781 nil
2782 sort-func)
2783 ;; Read and fix list again, as `sort-subr' probably destroyed
2784 ;; its structure.
2790 \f
2791 ;;; Send and receive lists
2794 "Parse the list at point and maybe DELETE it.
2796 Return a list whose car is a symbol of list type, among
2797 `ordered', `unordered' and `descriptive'. Then, each item is
2798 a list whose car is counter, and cdr are strings and other
2799 sub-lists. Inside strings, check-boxes are replaced by
2802 For example, the following list:
2804 1. first item
2805 + sub-item one
2806 + [X] sub-item two
2807 more text in first item
2808 2. [@3] last item
2810 will be parsed as:
2812 \(ordered
2814 \(unordered
2820 Point is left at list end."
2826 out
2827 parse-item ; for byte-compiler
2830 ;; Return text between BEG and END, trimmed, with
2831 ;; checkboxes replaced.
2842 text)))))
2845 ;; Return a list whose car is list type and cdr a list of
2846 ;; items' body.
2852 ;; Return a list containing counter of item, if any, text
2853 ;; and any sublist inside it.
2859 ;; Get counter number. For alphabetic counter, get
2860 ;; its position in the alphabet.
2871 ;; If item has a child, store text between bullet and
2872 ;; next child, then recursively parse all sublists. At
2873 ;; the end of each sublist, check for the presence of
2874 ;; text belonging to the original item.
2884 ;; Remove children from the list just parsed.
2886 ;; There is a chunk of text belonging to the
2887 ;; item if last child doesn't end where next
2888 ;; child starts or where item ends.
2892 body))))
2895 ;; Store output, take care of cursor position and deletion of
2896 ;; list, then return output.
2903 out))
2906 "Convert the plain list at point into a subtree."
2914 "Insert a radio list template appropriate for this major mode."
2918 name pos)
2929 "Send a transformed version of this list to the receiver position.
2930 With argument MAYBE, fail quietly if no transformation is defined
2931 for this list."
2937 (unless (looking-at "[ \t]*#\\+ORGLST[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
2956 beg txt)
2960 ;; Find the insertion place
2965 name
2979 "Trim line breaks in a list ITEM."
2983 "Convert a LIST parsed through `org-list-parse-list' to other formats.
2984 Valid parameters PARAMS are:
2986 :ustart String to start an unordered list
2987 :uend String to end an unordered list
2989 :ostart String to start an ordered list
2990 :oend String to end an ordered list
2992 :dstart String to start a descriptive list
2993 :dend String to end a descriptive list
2994 :dtstart String to start a descriptive term
2995 :dtend String to end a descriptive term
2996 :ddstart String to start a description
2997 :ddend String to end a description
2999 :splice When set to t, return only list body lines, don't wrap
3000 them into :[u/o]start and :[u/o]end. Default is nil.
3002 :istart String to start a list item.
3003 :icount String to start an item with a counter.
3004 :iend String to end a list item
3005 :isep String to separate items
3006 :lsep String to separate sublists
3007 :csep String to separate text from a sub-list
3009 :cboff String to insert for an unchecked check-box
3010 :cbon String to insert for a checked check-box
3011 :cbtrans String to insert for a check-box in transitional state
3013 :nobr Non-nil means remove line breaks in lists items.
3015 Alternatively, each parameter can also be a form returning
3016 a string. These sexp can use keywords `counter' and `depth',
3017 representing respectively counter associated to the current
3018 item, and depth of the current sub-list, starting at 0.
3019 Obviously, `counter' is only available for parameters applying to
3020 items."
3044 export-sublist ; for byte-compiler
3047 ;; Export an item ITEM of type TYPE, at DEPTH. First
3048 ;; string in item is treated in a special way as it can
3049 ;; bring extra information that needs to be processed.
3055 ;; Stick DTSTART to ISTART by
3056 ;; left-trimming the latter.
3060 istart))
3067 ;; Replace checkbox if any is found.
3075 ;; Replace line breaks if required
3077 ;; Insert descriptive term if TYPE is `descriptive'.
3086 first)))
3097 ;; Export sublist SUB at DEPTH.
3115 "Convert LIST into a LaTeX list.
3116 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3117 with overruling parameters for `org-list-to-generic'."
3119 list
3128 ;; LaTeX increments counter just before
3129 ;; using it, so set it to the desired
3130 ;; value, minus one.
3137 params)))
3140 "Convert LIST into a HTML list.
3141 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3142 with overruling parameters for `org-list-to-generic'."
3144 list
3156 params)))
3159 "Convert LIST into a Texinfo list.
3160 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3161 with overruling parameters for `org-list-to-generic'."
3163 list
3174 params)))
3177 "Convert LIST into an Org subtree.
3178 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3179 with overruling parameters for `org-list-to-generic'."
3189 ;; Return the string for the heading, depending on depth D
3190 ;; of current sub-list.
3195 oddeven-level)
3196 ?*)
3199 list
3201 '(:splice t
3208 params))))
3212 ;;; org-list.el ends here