| blob | 1906d95730c33c196b88bcf04f41271b2968a932 |
1 ;;; org-list.el --- Plain lists for Org-mode
2 ;;
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 ;; Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Bastien Guerry <bzg AT altern DOT org>
8 ;; Keywords: outlines, hypermedia, calendar, wp
9 ;; Homepage: http://orgmode.org
10 ;; Version: 7.5
11 ;;
12 ;; This file is part of GNU Emacs.
13 ;;
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
27 ;;
28 ;;; Commentary:
30 ;; This file contains the code dealing with plain lists in Org-mode.
32 ;; The fundamental idea behind lists work is to use structures. A
33 ;; structure is a snapshot of the list, in the shape of data tree (see
34 ;; `org-list-struct').
36 ;; Once the list structure is stored, it is possible to make changes
37 ;; directly on it or get useful information about the list, with the
38 ;; two helper functions, namely `org-list-parents-alist' and
39 ;; `org-list-prevs-alist', and using accessors or methods.
41 ;; Structure is eventually applied to the buffer with
42 ;; `org-list-write-struct'. This function repairs (bullets,
43 ;; indentation, checkboxes) the structure before applying it. It
44 ;; should be called near the end of any function working on
45 ;; structures.
47 ;; Thus, a function applying to lists should usually follow this
48 ;; template:
50 ;; 1. Verify point is in a list and grab item beginning (with the same
51 ;; function `org-in-item-p'). If the function requires the cursor
52 ;; to be at item's bullet, `org-at-item-p' is more selective. If
53 ;; the cursor is amidst the buffer, it is possible to find the
54 ;; closest item with `org-list-search-backward', or
55 ;; `org-list-search-forward', applied to `org-item-beginning-re'.
57 ;; 2. Get list structure with `org-list-struct'.
59 ;; 3. Compute one, or both, helper functions,
60 ;; (`org-list-parents-alist', `org-list-prevs-alist') depending on
61 ;; needed accessors.
63 ;; 4. Proceed with the modifications, using methods and accessors.
65 ;; 5. Verify and apply structure to buffer, using
66 ;; `org-list-write-struct'. Possibly use
67 ;; `org-update-checkbox-count-maybe' if checkboxes might have been
68 ;; modified.
70 ;; Computing a list structure can be a costly operation on huge lists
71 ;; (a few thousand lines long). Thus, code should follow the rule :
72 ;; "collect once, use many". As a corollary, it is usally a bad idea
73 ;; to use directly an interactive function inside the code, as those,
74 ;; being independant entities, read the whole list structure another
75 ;; time.
77 ;;; Code:
128 ;;; Configuration variables
131 "Options concerning plain lists in Org-mode."
136 "When t, make TAB cycle visibility on plain list items.
137 Cycling plain lists works only when the cursor is on a plain list
138 item. When the cursor is on an outline heading, plain lists are
139 treated as text. This is the most stable way of handling this,
140 which is why it is the default.
142 When this is the symbol `integrate', then during cycling, plain
143 list items will *temporarily* be interpreted as outline headlines
144 with a level given by 1000+i where i is the indentation of the
145 bullet. This setting can lead to strange effects when switching
147 subtree decides what children should be listed. If that first
149 number, all true children and grand children of the outline
150 heading will be exposed in a children' view."
158 "Default bullet type installed when demoting an item.
159 This is an association list, for each bullet type, this alist will point
160 to the bullet that should be used when this item is demoted.
161 For example,
163 (setq org-list-demote-modify-bullet
166 will make
168 + Movies
169 + Silence of the Lambs
170 + My Cousin Vinny
171 + Books
172 + The Hunt for Red October
173 + The Road to Omaha
175 into
177 + Movies
178 - Silence of the Lambs
179 - My Cousin Vinny
180 + Books
181 - The Hunt for Red October
182 - The Road to Omaha"
200 "The character that makes a line with leading number an ordered list item.
201 Valid values are ?. and ?\). To get both terminators, use t. While
202 ?. may look nicer, it creates the danger that a line with leading
203 number may be incorrectly interpreted as an item. ?\) therefore is
204 the safe choice."
211 "Non-nil means single character alphabetical bullets are allowed.
212 Both uppercase and lowercase are handled. Lists with more than 26
213 items will fallback to standard numbering. Alphabetical counters
219 "A regular expression matching bullets that should have 2 spaces after them.
220 When nil, no bullet will have two spaces after them.
221 When a string, it will be used as a regular expression. When the
222 bullet type of a list is changed, the new bullet type will be
223 matched against this regexp. If it matches, there will be two
224 spaces instead of one after the bullet in each item of the list."
231 "Determine where plain lists should end.
232 Valid values are: `regexp', `indent' or `both'.
234 When set to `regexp', Org will look into two variables,
235 `org-empty-line-terminates-plain-lists' and the more general
236 `org-list-end-regexp', to determine what will end lists.
238 When set to `indent', a list will end whenever a line following
239 an item, but not starting one, is less or equally indented than
240 the first item of the list.
242 When set to `both', each of the preceding methods is applied to
243 determine lists endings. This is the default method."
251 "Non-nil means an empty line ends all plain list levels.
252 This variable only makes sense if `org-list-ending-method' is set
253 to `regexp' or `both'. This is then equivalent to set
259 "Regexp matching the end of all plain list levels.
261 blank lines. `org-empty-line-terminates-plain-lists' has
262 precedence over it."
269 "Non-nil means apply set of rules when acting on lists.
270 By default, automatic actions are taken when using
275 rules by setting them to nil. Valid rules are:
277 bullet when non-nil, cycling bullet do not allow lists at
278 column 0 to have * as a bullet and descriptions lists
279 to be numbered.
280 checkbox when non-nil, checkbox statistics is updated each time
281 you either insert a new checkbox or toggle a checkbox.
282 It also prevents from inserting a checkbox in a
283 description item.
284 indent when non-nil, indenting or outdenting list top-item
285 with its subtree will move the whole list and
286 outdenting a list whose bullet is * to column 0 will
290 :key-type
295 :value-type
299 "Hook that is run whenever Org thinks checkbox statistics should be updated.
300 This hook runs even if checkbox rule in
301 `org-list-automatic-rules' does not apply, so it can be used to
302 implement alternative ways of collecting statistics
306 "Non-nil means checkbox statistics counts only the state of direct children.
307 When nil, all boxes below the cookie are counted.
308 This can be set to nil on a per-node basis using a COOKIE_DATA property
314 "Maximum indentation for the second line of a description list.
315 When the indentation would be larger than this, it will become
316 5 characters instead."
322 % END RECEIVE ORGLST %n
324 #+ORGLST: SEND %n org-list-to-latex
325 -
328 @c END RECEIVE ORGLST %n
329 @ignore
330 #+ORGLST: SEND %n org-list-to-texinfo
331 -
334 <!-- END RECEIVE ORGLST %n -->
335 <!--
336 #+ORGLST: SEND %n org-list-to-html
337 -
339 "Templates for radio lists in different major modes.
340 All occurrences of %n in a template will be replaced with the name of the
341 list, obtained by prompting the user."
348 "Names of blocks where lists are not allowed.
352 "Context types where lists will be interpreted during export.
354 Valid types are `drawer', `inlinetask' and `block'. More
355 specifically, type `block' is determined by the variable
359 ;;; Predicates and regexps
363 org-list-end-regexp)
364 "Regex corresponding to the end of a list.
372 "Matches a list item and puts everything into groups:
373 group 1: bullet
374 group 2: counter
375 group 3: checkbox
379 "Return the correct regular expression for plain lists."
390 "Regexp matching the beginning of a plain list item."
394 "Is point at a list item with REGEXP after bullet?"
398 ;; Ignore counter if any
404 "Return item beginning position when in a plain list, nil otherwise.
405 This checks `org-list-ending-method'."
414 ;; Indentation isn't meaningful when point starts at an empty
415 ;; line or an inline task.
418 10000
424 ;; Detect if cursor in amidst `org-list-end-re'. First, count
425 ;; number HL of hard lines it takes, then call `org-in-regexp'
426 ;; to compute its boundaries END-BOUNDS. When point is
427 ;; in-between, move cursor before regexp beginning.
439 ;; Look for an item, less indented that reference line if
440 ;; `org-list-ending-method' isn't `regexp'.
445 ;; This is exactly what we want.
450 ;; At upper bound of search or looking at the end of a
451 ;; 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?"
483 "Is point at the bullet of a plain list item?"
489 "Is point at a line starting a plain list item with a timer?"
494 "Is point at a description list item?"
498 "Is point at a line starting a plain-list item with a checklet?"
502 "Is point at a line starting a plain-list item with a counter?"
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
532 ;; might 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. position at item end,
589 6. description tag, if any.
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 dimiss 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.
677 ;; Skip blocks, drawers, inline tasks, blank lines
678 ;; along the way.
690 ;; Point is at an item. Add data to ITM-LST. It may
691 ;; also end a previous item: save it in END-LST. If
692 ;; ind is less or equal than BEG-CELL and there is no
693 ;; end at this ind or lesser, this item becomes the
694 ;; new BEG-CELL.
702 ;; From there, point is not at an item. Unless ending
703 ;; method is `regexp', interpret line's indentation:
704 ;; - text at column 0 is necessarily out of any list.
705 ;; Dismiss data recorded above BEG-CELL. Jump to
706 ;; part 2.
707 ;; - any other case, it can possibly be an ending
708 ;; position for an item above. Save it and proceed.
718 ;; 2. Read list from starting point to its end, that is until we
719 ;; get out of context, or a non-item line is less or equally
720 ;; indented that BEG-CELL's cdr. Also store ending position
721 ;; of items in END-LST-2.
728 ;; At downward limit: this is de facto the end of the
729 ;; list. Save point as an ending position, and jump to
730 ;; part 3.
733 ;; At a verbatim block, move to its end. Point is at bol
734 ;; and 'org-example property is set by whole lines:
735 ;; `next-single-property-change' always return a value.
739 ;; Looking at a list ending regexp. Save point as an
740 ;; ending position and jump to part 3.
744 ;; Skip blocks, drawers, inline tasks and blank lines
745 ;; along the way
757 ;; Point is at an item. Add data to ITM-LST-2. It may also
758 ;; end a previous item, so save it in END-LST-2.
762 ;; From there, point is not at an item. If ending method
763 ;; is not `regexp', two situations are of interest:
764 ;; - ind is lesser or equal than BEG-CELL's. The list is
765 ;; over. Store point as an ending position and jump to
766 ;; part 3.
767 ;; - ind is lesser or equal than previous item's. This
768 ;; is an ending position. Store it and proceed.
779 ;; 3. Correct ill-formed lists by ensuring top item is the least
780 ;; indented.
787 ;; Modify bullet to be sure item will be modified
789 struct))
790 ;; 4. Associate each item to its end pos.
792 ;; 5. Return STRUCT
793 struct)))
796 "Associate proper ending point to items in STRUCT.
798 END-LIST is a pseudo-alist where car is indentation and cdr is
799 ending position.
801 This function modifies STRUCT."
807 ;; Remove end candidates behind current item
810 ;; Add end position to item assoc
816 struct)))
819 "Return alist between item and previous item in STRUCT."
821 struct)))
825 struct)))
828 "Return alist between item and parent in STRUCT."
850 ;;; Accessors
853 "Return the Nth value of KEY in STRUCT."
857 "Set the Nth value of KEY in STRUCT to NEW.
862 "Return indentation of ITEM in STRUCT."
866 "Set indentation of ITEM in STRUCT to IND.
871 "Return bullet of ITEM in STRUCT."
875 "Set bullet of ITEM in STRUCT to BULLET.
880 "Return counter of ITEM in STRUCT."
884 "Return checkbox of ITEM in STRUCT or nil."
888 "Set checkbox of ITEM in STRUCT to CHECKBOX.
893 "Return end position of ITEM in STRUCT."
897 "Return end position of ITEM in STRUCT."
901 "Return point at end of ITEM in STRUCT, before any blank line.
902 Point returned is at end of line."
909 "Return parent of ITEM or nil.
910 STRUCT is the list structure. PARENTS is the alist of parents, as
911 returned by `org-list-parents-alist'."
916 "Non-nil if ITEM has a child.
918 STRUCT is the list structure.
920 Value returned is the position of the first child of ITEM."
925 child-maybe)))
928 "Return next item in same sub-list as ITEM, or nil.
929 STRUCT is the list structure. PREVS is the alist of previous
930 items, as returned by `org-list-prevs-alist'."
934 "Return previous item in same sub-list as ITEM, or nil.
935 STRUCT is the list structure. PREVS is the alist of previous
936 items, as returned by `org-list-prevs-alist'."
940 "List all items having ITEM as a common ancestor, or nil.
941 STRUCT is the list structure."
944 subtree)
949 sub-struct))
953 "List all items in the same sub-list as ITEM.
954 STRUCT is the list structure. PREVS is the alist of previous
955 items, as returned by `org-list-prevs-alist'."
958 before-item after-item)
966 "List all children of ITEM, or nil.
967 STRUCT is the list structure. PARENTS is the alist of parents, as
968 returned by `org-list-parents-alist'."
976 "Return point at beginning of list.
977 STRUCT is the list structure."
981 "Return point at bottom of list.
982 STRUCT is the list structure."
987 "Return point at beginning of sub-list ITEM belongs.
988 STRUCT is the list structure. PREVS is the alist of previous
989 items, as returned by `org-list-prevs-alist'."
993 first-item))
998 "Return point at last item of sub-list ITEM belongs.
999 STRUCT is the list structure. PREVS is the alist of previous
1000 items, as returned by `org-list-prevs-alist'."
1004 last-item))
1007 "Return point at end of sub-list ITEM belongs.
1008 STRUCT is the list structure. PREVS is the alist of previous
1009 items, as returned by `org-list-prevs-alist'."
1013 "Return the type of the list containing ITEM, as a symbol.
1015 STRUCT is the list structure. PREVS is the alist of previous
1016 items, as returned by `org-list-prevs-alist'.
1018 Possible types are `descriptive', `ordered' and `unordered'. The
1019 type is determined by the first item of the list."
1027 ;;; Searching
1030 "Search a string in valid contexts for lists.
1031 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1032 in `re-search-forward'."
1036 ;; 1. No match: return to origin or bound, depending on NOERR.
1039 nil)))
1040 ;; 2. Match in an `invalid' context: continue searching. Else,
1041 ;; return point.
1045 "Like `re-search-backward' but stop only where lists are recognized.
1046 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1047 `re-search-backward'."
1052 "Like `re-search-forward' but stop only where lists are recognized.
1053 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1054 `re-search-forward'."
1059 ;;; Methods on structures
1062 "Return BULLET with the correct number of whitespaces.
1063 It determines the number of whitespaces to append by looking at
1064 `org-list-two-spaces-after-bullet-regexp'."
1068 org-list-two-spaces-after-bullet-regexp bullet))
1069 " "
1075 "Return number of blank lines that should separate items in list.
1077 POS is the position at item beginning to be considered.
1079 STRUCT is the list structure. PREVS is the alist of previous
1080 items, as returned by `org-list-prevs-alist'.
1082 Assume point is at item's beginning. If the item is alone, apply
1083 some heuristics to guess the result."
1087 usr-blank)
1089 ;; Trivial cases where there should be none.
1091 org-empty-line-terminates-plain-lists)
1093 ;; When `org-blank-before-new-entry' says so, it is 1.
1095 ;; plain-list-item is 'auto. Count blank lines separating
1096 ;; neighbours items in list.
1099 ;; Is there a next item?
1102 ;; Is there a previous item?
1105 ;; User inserted blank lines, trust him
1111 usr-blank)
1112 ;; Are there blank lines inside the item ?
1117 ;; No parent: no blank line.
1121 "Insert a new list item at POS and return the new structure.
1122 If POS is before first character after bullet of the item, the
1123 new item will be created before the current one.
1125 STRUCT is the list structure. PREVS is the the alist of previous
1126 items, as returned by `org-list-prevs-alist'.
1128 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1129 after the bullet. Cursor will be after this text once the
1130 function ends.
1132 This function modifies STRUCT."
1134 ;; 1. Get information about list: structure, usual helper
1135 ;; functions, position of point with regards to item start
1136 ;; (BEFOREP), blank lines number separating items (BLANK-NB),
1137 ;; position of split (POS) if we're allowed to (SPLIT-LINE-P).
1145 item struct prevs))
1146 ;; 2. Build the new item to be created. Concatenate same
1147 ;; bullet as item, checkbox, text AFTER-BULLET if
1148 ;; provided, and text cut from point to end of item
1149 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1150 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1151 ;; between what was cut and what was inserted in buffer
1152 ;; is stored in SIZE-OFFSET.
1155 ind-ref
1170 text-cut))
1175 ;; 4. Insert effectively item into buffer
1179 ;; 5. Add new item to STRUCT.
1184 ;; Before inserted item, positions don't change but
1185 ;; an item ending after insertion has its end shifted
1186 ;; by SIZE-OFFSET.
1189 ;; Trivial cases where current item isn't split in
1190 ;; two. Just shift every item after new one by
1191 ;; ITEM-SIZE.
1195 ;; Item is split in two: elements before POS are just
1196 ;; shifted by ITEM-SIZE. In the case item would end
1197 ;; after split POS, ending is only shifted by
1198 ;; SIZE-OFFSET.
1204 ;; Elements after POS are moved into new item. Length
1205 ;; of ITEM-SEP has to be removed as ITEM-SEP
1206 ;; doesn't appear in buffer yet.
1212 (+ end size-offset
1214 ;; Elements at ITEM-END or after are only shifted by
1215 ;; SIZE-OFFSET.
1218 struct)
1221 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1222 ;; exchange ITEM with the next item in list. Position cursor
1223 ;; after bullet, counter, checkbox, and label.
1229 struct)))
1232 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1233 Blank lines at the end of items are left in place. Return the new
1234 structure after the changes.
1236 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1237 to the same sub-list.
1239 This function modifies STRUCT."
1252 ;; 1. Move effectively items in buffer.
1256 ;; 2. Now modify struct. No need to re-read the list, the
1257 ;; transformation is just a shift of positions. Some special
1258 ;; attention is required for items ending at END-A and END-B
1259 ;; as empty spaces are not moved there. In others words, item
1260 ;; BEG-A will end with whitespaces that were at the end of
1261 ;; BEG-B and the same applies to BEG-B.
1283 struct)
1287 "Outdent items between positions START and END.
1289 STRUCT is the list structure. PARENTS is the alist of items'
1290 parents, as returned by `org-list-parents-alist'.
1292 START is included, END excluded."
1298 ;; Item not yet in zone: keep association
1300 ;; Item out of zone: follow associations in acc
1304 ;; Item has no parent: error
1307 ;; Parent is outdented: keep association
1311 ;; Parent isn't outdented: reparent to grand-parent
1313 parent struct parents)))
1319 "Indent items between positions START and END.
1321 STRUCT is the list structure. PARENTS is the alist of parents and
1322 PREVS is the alist of previous items, returned by, respectively,
1323 `org-list-parents-alist' and `org-list-prevs-alist'.
1325 START is included and END excluded.
1327 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1328 bullets between START and END."
1342 ;; Item not yet in zone: keep association
1345 ;; Item out of zone: follow associations in acc
1349 ;; Item is in zone...
1351 ;; Check if bullet needs to be changed
1354 ;; First item indented but not parent: error
1357 ;; First item and parent indented: keep same parent
1359 ;; Previous item not indented: reparent to it
1361 ;; Previous item indented: reparent like it
1368 ;;; Repairing structures
1371 "Non-nil if list starting at FIRST can have alphabetical bullets.
1373 STRUCT is list structure. PREVS is the alist of previous items,
1374 as returned by `org-list-prevs-alist'."
1378 ;; Pretend that bullets are uppercase and check if alphabet
1379 ;; is sufficient, taking counters into account.
1383 ;; Virtually determine current bullet
1385 ;; Counters are not case-sensitive.
1388 ;; Test if bullet would be over z or Z.
1392 ;; All items checked. All good.
1393 t))))
1396 "Increment BULLET if applicable."
1399 ;; Num bullet: increment it.
1403 nil nil bullet))
1404 ;; Alpha bullet: increment it.
1408 nil nil bullet))
1409 ;; Unordered bullet: leave it.
1413 "Verify and correct bullets in STRUCT.
1414 PREVS is the alist of previous items, as returned by
1415 `org-list-prevs-alist'.
1417 This function modifies STRUCT."
1421 ;; Set bullet of ITEM in STRUCT, depending on the type of
1422 ;; first item of the list, the previous bullet and counter
1423 ;; if any.
1432 item struct
1435 ;; Alpha counter in alpha list: use counter.
1439 ;; Use cond to be sure `string-match' is used in
1440 ;; both cases.
1446 ;; Num counter in a num list: use counter.
1451 ;; No counter: increase, if needed, previous bullet.
1454 ;; Alpha counter at first item: use counter.
1463 ;; Num counter at first item: use counter.
1468 ;; First bullet is alpha uppercase: use "A".
1471 ;; First bullet is alpha lowercase: use "a".
1474 ;; First bullet is num: use "1".
1477 ;; Not an ordered list: keep bullet.
1482 "Verify and correct indentation in STRUCT.
1484 PARENTS is the alist of parents, as returned by
1485 `org-list-parents-alist'.
1487 If numeric optional argument BULLET-SIZE is set, assume all
1488 bullets in list have this length to determine new indentation.
1490 This function modifies STRUCT."
1497 ;; Indent like parent + length of parent's bullet
1503 ;; If no parent, indent like top-point
1508 "Verify and correct checkboxes in STRUCT.
1510 PARENTS is the alist of parents and PREVS is the alist of
1511 previous items, as returned by, respectively,
1512 `org-list-parents-alist' and `org-list-prevs-alist'.
1514 If ORDERED is non-nil, a checkbox can only be checked when every
1515 checkbox before it is checked too. If there was an attempt to
1516 break this rule, the function will return the blocking item. In
1517 all others cases, the return value will be nil.
1519 This function modifies STRUCT."
1529 item struct
1535 ;; parent has no boxed child: leave box as-is
1537 parent-list)
1538 ;; 1. List all parents with a checkbox
1545 all-items)
1546 ;; 2. Sort those parents by decreasing indentation
1551 ;; 3. For each parent, get all children's checkboxes to determine
1552 ;; and set its checkbox accordingly
1554 ;; 4. If ORDERED is set, see if we need to uncheck some boxes
1559 ;; there are boxes checked after an unchecked one: fix that
1564 ;; Verify once again the structure, without ORDERED
1566 ;; return blocking item
1570 "Apply set-difference between STRUCT and OLD-STRUCT to the buffer.
1572 OLD-STRUCT is the structure before any modifications, and STRUCT
1573 the structure to be applied. The function will only modify parts
1574 of the list which have changed.
1576 Initial position of cursor is restored after the changes."
1584 ;; Shift the indentation between END and BEG by DELTA.
1585 ;; Start from the line before END.
1594 ;; Skip inline tasks
1597 ;; Shift only non-empty lines
1604 ;; Replace ITEM first line elements with new elements from
1605 ;; STRUCT, if appropriate.
1615 ;; a. Replace bullet
1618 ;; b. Replace checkbox
1632 ;; c. Indent item to appropriate column
1637 ;; 1. First get list of items and position endings. We maintain
1638 ;; two alists: ITM-SHIFT, determining indentation shift needed
1639 ;; at item, and END-POS, a pseudo-alist where key is ending
1640 ;; position and value point
1653 ;; To determine real ind of an ending position that is
1654 ;; not at an item, we have to find the item it belongs
1655 ;; to: it is the last item (ITEM-UP), whose ending is
1656 ;; further than the position we're interested in.
1660 old-struct)
1661 ;; 2. Slice the items into parts that should be shifted by the
1662 ;; same amount of indentation. The slices are returned in
1663 ;; reverse order so changes modifying buffer do not change
1664 ;; positions they refer to.
1667 '<))
1675 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1676 ;; end to beginning. Take a special action when beginning is
1677 ;; at item bullet.
1684 sliced-struct))
1685 ;; 4. Go back to initial position
1689 "Correct bullets, checkboxes and indentation in list at point.
1690 STRUCT is the list structure. PARENTS is the alist of parents, as
1691 returned by `org-list-parents-alist'."
1692 ;; Order of functions matters here: checkboxes and endings need
1693 ;; correct indentation to be set, and indentation needs correct
1694 ;; bullets.
1695 ;;
1696 ;; 0. Save a copy of structure before modifications
1698 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1699 ;; order to get items endings and bullets properly
1701 ;; 2. Get pseudo-alist of ending positions and sort it by position.
1702 ;; Then associate them to the structure.
1709 ;; To determine real ind of an ending position that is
1710 ;; not at an item, we have to find the item it belongs
1711 ;; to: it is the last item (ITEM-UP), whose ending is
1712 ;; further than the position we're interested in.
1715 ;; Else part is for the bottom point
1717 end-pos)
1718 end-list)))
1721 struct)
1724 ;; 3. Get bullets right
1727 ;; 4. Now get real indentation
1729 ;; 5. Eventually fix checkboxes
1731 ;; 6. Apply structure modifications to buffer
1735 ;;; Misc Tools
1738 "Call FUNCTION on each item of the list at point.
1739 FUNCTION must be called with at least one argument: INIT-VALUE,
1740 that will contain the value returned by the function at the
1741 previous item, plus ARGS extra arguments.
1743 FUNCTION is applied on items in reverse order.
1745 As an example, \(org-apply-on-list \(lambda \(result\) \(1+ result\)\) 0\)
1746 will return the number of items in the current list.
1748 Sublists of the list are skipped. Cursor is always at the
1749 beginning of the item."
1760 value))
1763 "Set visibility of ITEM in STRUCT to VIEW.
1765 Possible values are: `folded', `children' or `subtree'. See
1766 `org-cycle' for more information."
1770 ;; Hide from eol
1772 item-end t)))
1774 ;; First show everything.
1776 ;; Then fold every child.
1781 children)))
1783 ;; Show everything
1788 "Return column at which body of ITEM should start."
1798 tcol))
1801 ;;; Interactive functions
1806 "Go to the beginning of the current item.
1807 Throw an error when not in a list."
1813 "Go to the beginning item of the current list or sublist.
1814 Throw an error when not in a list."
1825 "Go to the end of the current list or sublist.
1826 Throw an error when not in a list."
1837 "Go to the end of the current item.
1838 Throw an error when not in a list."
1848 "Move to the beginning of the previous item.
1849 Throw an error when not in a list, or at first item."
1861 "Move to the beginning of the next item.
1862 Throw an error when not in a plain list, or at last item."
1874 "Move the item at point down, i.e. swap with following item.
1875 Subitems (items with larger indentation) are considered part of
1876 the item, so this really moves item trees."
1891 ;; Use a short variation of `org-list-write-struct' as there's
1892 ;; no need to go through all the steps.
1903 "Move the item at point up, i.e. swap with previous item.
1904 Subitems (items with larger indentation) are considered part of
1905 the item, so this really moves item trees."
1920 ;; Use a short variation of `org-list-write-struct' as there's
1921 ;; no need to go through all the steps.
1931 "Insert a new item at the current level.
1932 If cursor is before first character after bullet of the item, the
1933 new item will be created before the current one.
1935 If CHECKBOX is non-nil, add a checkbox next to the bullet.
1937 Return t when things worked, nil when we are not in an item, or
1938 item is invisible."
1941 ;; If cursor isn't is a list or if list is invisible, return nil.
1949 ;; Timer list: delegate to `org-timer-item'.
1954 ;; If we're in a description list, ask for the new term.
1957 ;; Don't insert a checkbox if checkbox rule is applied
1958 ;; and it is a description item.
1962 org-list-automatic-rules)))))))
1969 t)))))
1972 "Fix indentation, bullets and checkboxes is the list at point."
1980 "Cycle through the different itemize/enumerate bullets.
1981 This cycle the entire list level through the sequence:
1983 `-' -> `+' -> `*' -> `1.' -> `1)'
1985 If WHICH is a valid string, use that as the new bullet. If WHICH
1986 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
1987 `previous', cycle backwards."
2008 ;; Compute list of possible bullets, depending on context
2011 ;; *-bullets are not allowed at column 0
2014 ;; Description items cannot be numbered
2037 ;; Use a short variation of `org-list-write-struct' as there's
2038 ;; no need to go through all the steps.
2046 "Toggle the checkbox in the current line.
2047 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2048 double prefix, set checkbox to [-].
2050 When there is an active region, toggle status or presence of the
2051 first checkbox there, and make every item inside have the same
2052 status or presence, respectively.
2054 If the cursor is in a headline, apply this to all checkbox items
2055 in the text below the heading, taking as reference the first item
2056 in subtree, ignoring drawers."
2060 block-item
2061 lim-up
2062 lim-down
2065 ;; In a region, start at first item in region
2075 ;; On an heading, start at first item after drawers
2084 ;; Just one item: set singlep flag
2090 ;; Determine the checkbox going to be applied to all items
2091 ;; within bounds
2102 ;; When an item is found within bounds, grab the full list at
2103 ;; point structure, then: 1. set checkbox of all its items
2104 ;; within bounds to ref-checkbox; 2. fix checkboxes of the whole
2105 ;; list; 3. move point after the list.
2119 e struct
2120 ;; if there is no box at item, leave as-is
2121 ;; unless function was called with C-u prefix
2124 ref-checkbox
2125 cur-box))))
2126 items-to-toggle)
2128 struct parents prevs orderedp))
2129 ;; Report some problems due to ORDERED status of subtree. If
2130 ;; only one box was being checked, throw an error, else,
2131 ;; only signal problems.
2135 "Checkbox blocked because of unchecked box at line %d"
2139 "Checkboxes were removed due to unchecked box at line %d"
2146 "Reset all checkboxes in an entry subtree."
2161 "Update the checkbox statistics in the current section.
2162 This will find all statistic cookies like [57%] and [6/12] and
2163 update them with the current numbers.
2165 With optional prefix argument ALL, do this for the whole buffer."
2169 (box-re "^[ \t]*\\([-+*]\\|\\([0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2181 ;; Return number of checked boxes and boxes of all types
2182 ;; in all structures in STRUCTS. If RECURSIVEP is non-nil,
2183 ;; also count boxes in sub-lists. If ITEM is nil, count
2184 ;; across the whole structure, else count only across
2185 ;; subtree whose ancestor is ITEM.
2202 items))))
2205 structs)
2208 cookies-list structs-bak box-num)
2210 ;; 1. Build an alist for each cookie found within BOUNDS. The
2211 ;; key will be position at beginning of cookie and values
2212 ;; ending position, format of cookie, and a cell whose car is
2213 ;; number of checked boxes to report, and cdr total number of
2214 ;; boxes.
2224 ;; Cookie is at an heading, but specifically for todo,
2225 ;; not for checkboxes: skip it.
2231 ;; Cookie is at an heading, but all lists before next
2232 ;; heading already have been read. Use data collected
2233 ;; in STRUCTS-BAK. This should only happen when heading
2234 ;; has more than one cookie on it.
2237 backup-end))
2239 ;; Cookie is at a fresh heading. Grab structure of
2240 ;; every list containing a checkbox between point and
2241 ;; next headline, and save them in STRUCTS-BAK.
2251 ;; Cookie is at an item, and we already have list
2252 ;; structure stored in STRUCTS-BAK.
2255 ;; Only lists in no special context are stored.
2258 ;; Cookie is at an item, but we need to compute list
2259 ;; structure.
2265 ;; Else, cookie found is at a wrong place. Skip it.
2267 cookies-list))))
2268 ;; 2. Apply alist to buffer, in reverse order so positions stay
2269 ;; unchanged after cookie modifications.
2283 cookies-list))))
2286 "Select the face for checkbox statistics.
2287 The face will be `org-done' when all relevant boxes are checked.
2288 Otherwise it will be `org-todo'."
2291 'org-checkbox-statistics-done
2295 'org-checkbox-statistics-done
2299 "Update checkbox statistics unless turned off by user."
2307 "Indent a local list item including its children.
2308 When number ARG is a negative, item will be outdented, otherwise
2309 it will be indented.
2311 If a region is active, all items inside will be moved.
2313 If NO-SUBTREE is non-nil, only indent the item itself, not its
2314 children.
2316 STRUCT is the list structure.
2318 Return t if successful."
2327 ;; Are we going to move the whole list?
2334 t))))
2335 ;; Determine begin and end points of zone to indent. If moving
2336 ;; more than one item, save them for subsequent moves.
2352 ;; Special case: moving top-item with indent rule
2360 ;; Change bullet if necessary
2366 ;; Shift every item by OFFSET and fix bullets. Then
2367 ;; apply changes to buffer.
2371 struct)
2374 ;; Forbidden move:
2376 ;; If only one item is moved, it mustn't have a child
2380 ;; If a subtree or region is moved, the last item
2381 ;; of the subtree mustn't have a child
2386 struct)))))
2389 ;; Normal shifting
2397 t)
2400 "Outdent a local list item, but not its children.
2401 If a region is active, all items inside will be moved."
2409 "Indent a local list item, but not its children.
2410 If a region is active, all items inside will be moved."
2418 "Outdent a local list item including its children.
2419 If a region is active, all items inside will be moved."
2433 "Indent a local list item including its children.
2434 If a region is active, all items inside will be moved."
2449 "Cycle levels of indentation of an empty item.
2450 The first run indents the item, if applicable. Subsequents runs
2451 outdent it at meaningful levels in the list. When done, item is
2452 put back at its original position with its original bullet.
2454 Return t at each successful move."
2460 ;; Accept empty items or if cycle has already started.
2471 ;; When in the middle of the cycle, try to outdent first. If it
2472 ;; fails, and point is still at initial position, indent. Else,
2473 ;; go back to original position.
2482 ;; Break cycle
2484 ;; If a cycle is starting, remember indentation and bullet,
2485 ;; then try to indent. If it fails, try to outdent.
2491 t))))
2494 "Sort list items.
2495 The cursor may be at any item of the list that should be sorted.
2496 Sublists are not sorted. Checkboxes, if any, are ignored.
2498 Sorting can be alphabetically, numerically, by date/time as given by
2499 a time stamp, by a property or by priority.
2501 Comparing entries ignores case by default. However, with an
2502 optional argument WITH-CASE, the sorting considers case as well.
2504 The command prompts for the sorting type unless it has been given
2505 to the function through the SORTING-TYPE argument, which needs to
2506 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
2507 meaning of each character:
2509 n Numerically, by converting the beginning of the item to a number.
2510 a Alphabetically. Only the first line of item is checked.
2511 t By date/time, either the first active time stamp in the entry, if
2512 any, or by the first inactive one. In a timer list, sort the timers.
2514 Capital letters will reverse the sort order.
2516 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a
2517 function to be called with point at the beginning of the record.
2518 It must return either a string or a number that should serve as
2519 the sorting key for that record. It will then use COMPARE-FUNC to
2520 compare entries."
2565 ;; If it is a timer list, convert timer to seconds
2578 value))
2582 next-record
2583 end-record
2584 value-to-sort
2585 nil
2586 sort-func)
2587 ;; Read and fix list again, as `sort-subr' probably destroyed
2588 ;; its structure.
2594 ;;; Send and receive lists
2597 "Parse the list at point and maybe DELETE it.
2599 Return a list whose car is a symbol of list type, among
2600 `ordered', `unordered' and `descriptive'. Then, each item is a
2601 list whose car is counter, and cdr are strings and other
2605 For example, the following list:
2607 1. first item
2608 + sub-item one
2609 + [X] sub-item two
2610 more text in first item
2611 2. [@3] last item
2613 will be parsed as:
2615 \(ordered
2617 \(unordered
2623 Point is left at list end."
2629 out
2630 parse-item ; for byte-compiler
2633 ;; Return text between BEG and END, trimmed, with
2634 ;; checkboxes replaced.
2641 text)))))
2644 ;; Return a list whose car is list type and cdr a list of
2645 ;; items' body.
2651 ;; Return a list containing counter of item, if any, text
2652 ;; and any sublist inside it.
2658 ;; Get counter number. For alphabetic counter, get
2659 ;; its position in the alphabet.
2670 ;; If item has a child, store text between bullet and
2671 ;; next child, then recursively parse all sublists. At
2672 ;; the end of each sublist, check for the presence of
2673 ;; text belonging to the original item.
2683 ;; Remove children from the list just parsed.
2685 ;; There is a chunk of text belonging to the
2686 ;; item if last child doesn't end where next
2687 ;; child starts or where item ends.
2691 body))))
2694 ;; Store output, take care of cursor position and deletion of
2695 ;; list, then return output.
2703 out))
2706 "Convert the plain list at point into a subtree."
2714 "Insert a radio list template appropriate for this major mode."
2718 name pos)
2729 "Send a transformed version of this list to the receiver position.
2730 With argument MAYBE, fail quietly if no transformation is defined for
2731 this list."
2737 (unless (looking-at "[ \t]*#\\+ORGLST[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
2756 beg txt)
2760 ;; Find the insertion place
2765 name
2779 "Convert a LIST parsed through `org-list-parse-list' to other formats.
2780 Valid parameters PARAMS are
2782 :ustart String to start an unordered list
2783 :uend String to end an unordered list
2785 :ostart String to start an ordered list
2786 :oend String to end an ordered list
2788 :dstart String to start a descriptive list
2789 :dend String to end a descriptive list
2790 :dtstart String to start a descriptive term
2791 :dtend String to end a descriptive term
2792 :ddstart String to start a description
2793 :ddend String to end a description
2795 :splice When set to t, return only list body lines, don't wrap
2796 them into :[u/o]start and :[u/o]end. Default is nil.
2798 :istart String to start a list item.
2799 :icount String to start an item with a counter.
2800 :iend String to end a list item
2801 :isep String to separate items
2802 :lsep String to separate sublists
2803 :csep String to separate text from a sub-list
2805 :cboff String to insert for an unchecked checkbox
2806 :cbon String to insert for a checked checkbox
2808 Alternatively, each parameter can also be a form returning a
2809 string. These sexp can use keywords `counter' and `depth',
2810 reprensenting respectively counter associated to the current
2811 item, and depth of the current sub-list, starting at 0.
2812 Obviously, `counter' is only available for parameters applying to
2813 items."
2835 export-sublist ; for byte-compiler
2838 ;; Export an item ITEM of type TYPE, at DEPTH. First string
2839 ;; in item is treated in a special way as it can bring
2840 ;; extra information that needs to be processed.
2852 ;; Replace checkbox if any is found.
2860 ;; Insert descriptive term if TYPE is `descriptive'.
2875 ;; Export sublist SUB at DEPTH
2893 "Convert LIST into a LaTeX list.
2894 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2895 with overruling parameters for `org-list-to-generic'."
2897 list
2907 enum counter)
2911 params)))
2914 "Convert LIST into a HTML list.
2915 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2916 with overruling parameters for `org-list-to-generic'."
2918 list
2929 params)))
2932 "Convert LIST into a Texinfo list.
2933 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2934 with overruling parameters for `org-list-to-generic'."
2936 list
2946 params)))
2949 "Convert LIST into an Org subtree.
2950 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2951 with overruling parameters for `org-list-to-generic'."
2961 ;; Return the string for the heading, depending on depth D
2962 ;; of current sub-list.
2967 ?*)
2970 list
2972 '(:splice t
2979 params))))
2983 ;; arch-tag: 73cf50c1-200f-4d1d-8a53-4e842a5b11c8
2984 ;;; org-list.el ends here