| blob | 9c178e119d187a2597f34bf1796d7ed8c1132e21 |
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:
129 ;;; Configuration variables
132 "Options concerning plain lists in Org-mode."
137 "When t, make TAB cycle visibility on plain list items.
138 Cycling plain lists works only when the cursor is on a plain list
139 item. When the cursor is on an outline heading, plain lists are
140 treated as text. This is the most stable way of handling this,
141 which is why it is the default.
143 When this is the symbol `integrate', then during cycling, plain
144 list items will *temporarily* be interpreted as outline headlines
145 with a level given by 1000+i where i is the indentation of the
146 bullet. This setting can lead to strange effects when switching
148 subtree decides what children should be listed. If that first
150 number, all true children and grand children of the outline
151 heading will be exposed in a children' view."
159 "Default bullet type installed when demoting an item.
160 This is an association list, for each bullet type, this alist will point
161 to the bullet that should be used when this item is demoted.
162 For example,
164 (setq org-list-demote-modify-bullet
167 will make
169 + Movies
170 + Silence of the Lambs
171 + My Cousin Vinny
172 + Books
173 + The Hunt for Red October
174 + The Road to Omaha
176 into
178 + Movies
179 - Silence of the Lambs
180 - My Cousin Vinny
181 + Books
182 - The Hunt for Red October
183 - The Road to Omaha"
201 "The character that makes a line with leading number an ordered list item.
202 Valid values are ?. and ?\). To get both terminators, use t. While
203 ?. may look nicer, it creates the danger that a line with leading
204 number may be incorrectly interpreted as an item. ?\) therefore is
205 the safe choice."
212 "Non-nil means single character alphabetical bullets are allowed.
213 Both uppercase and lowercase are handled. Lists with more than 26
214 items will fallback to standard numbering. Alphabetical counters
220 "A regular expression matching bullets that should have 2 spaces after them.
221 When nil, no bullet will have two spaces after them.
222 When a string, it will be used as a regular expression. When the
223 bullet type of a list is changed, the new bullet type will be
224 matched against this regexp. If it matches, there will be two
225 spaces instead of one after the bullet in each item of the list."
232 "Determine where plain lists should end.
233 Valid values are: `regexp', `indent' or `both'.
235 When set to `regexp', Org will look into two variables,
236 `org-empty-line-terminates-plain-lists' and the more general
237 `org-list-end-regexp', to determine what will end lists.
239 When set to `indent', a list will end whenever a line following
240 an item, but not starting one, is less or equally indented than
241 the first item of the list.
243 When set to `both', each of the preceding methods is applied to
244 determine lists endings. This is the default method."
252 "Non-nil means an empty line ends all plain list levels.
253 This variable only makes sense if `org-list-ending-method' is set
254 to `regexp' or `both'. This is then equivalent to set
260 "Regexp matching the end of all plain list levels.
262 blank lines. `org-empty-line-terminates-plain-lists' has
263 precedence over it."
270 "Non-nil means apply set of rules when acting on lists.
271 By default, automatic actions are taken when using
276 rules by setting them to nil. Valid rules are:
278 bullet when non-nil, cycling bullet do not allow lists at
279 column 0 to have * as a bullet and descriptions lists
280 to be numbered.
281 checkbox when non-nil, checkbox statistics is updated each time
282 you either insert a new checkbox or toggle a checkbox.
283 It also prevents from inserting a checkbox in a
284 description item.
285 indent when non-nil, indenting or outdenting list top-item
286 with its subtree will move the whole list and
287 outdenting a list whose bullet is * to column 0 will
291 :key-type
296 :value-type
300 "Hook that is run whenever Org thinks checkbox statistics should be updated.
301 This hook runs even if checkbox rule in
302 `org-list-automatic-rules' does not apply, so it can be used to
303 implement alternative ways of collecting statistics
307 "Non-nil means checkbox statistics counts only the state of direct children.
308 When nil, all boxes below the cookie are counted.
309 This can be set to nil on a per-node basis using a COOKIE_DATA property
315 "Maximum indentation for the second line of a description list.
316 When the indentation would be larger than this, it will become
317 5 characters instead."
323 % END RECEIVE ORGLST %n
325 #+ORGLST: SEND %n org-list-to-latex
326 -
329 @c END RECEIVE ORGLST %n
330 @ignore
331 #+ORGLST: SEND %n org-list-to-texinfo
332 -
335 <!-- END RECEIVE ORGLST %n -->
336 <!--
337 #+ORGLST: SEND %n org-list-to-html
338 -
340 "Templates for radio lists in different major modes.
341 All occurrences of %n in a template will be replaced with the name of the
342 list, obtained by prompting the user."
349 "Names of blocks where lists are not allowed.
353 "Context types where lists will be interpreted during export.
355 Valid types are `drawer', `inlinetask' and `block'. More
356 specifically, type `block' is determined by the variable
360 ;;; Predicates and regexps
364 org-list-end-regexp)
365 "Regex corresponding to the end of a list.
373 "Matches a list item and puts everything into groups:
374 group 1: bullet
375 group 2: counter
376 group 3: checkbox
380 "Return the correct regular expression for plain lists."
391 "Regexp matching the beginning of a plain list item."
395 "Is point at a list item with REGEXP after bullet?"
404 ;; Ignore counter if any
409 "Non-nil if point is in a valid block.
410 Invalid blocks are referring to `org-list-forbidden-blocks'."
420 "Return item beginning position when in a plain list, nil otherwise.
421 This checks `org-list-ending-method'."
433 ;; Indentation isn't meaningful when point starts at an empty
434 ;; line or an inline task.
437 10000
443 ;; Detect if cursor in amidst `org-list-end-re'. First, count
444 ;; number HL of hard lines it takes, then call `org-in-regexp'
445 ;; to compute its boundaries END-BOUNDS. When point is
446 ;; in-between, move cursor before regexp beginning.
458 ;; Look for an item, less indented that reference line if
459 ;; `org-list-ending-method' isn't `regexp'.
464 ;; This is exactly what we want.
469 ;; At upper bound of search or looking at the end of a
470 ;; previous list: search is over.
475 ;; Skip blocks, drawers, inline-tasks, blank lines
485 ;; Text at column 0 cannot belong to a list: stop.
487 ;; Normal text less indented than reference line, take
488 ;; it as new reference.
495 "Is point in a line starting a hand-formatted item?"
501 "Is point at the bullet of a plain list item?"
507 "Is point at a line starting a plain list item with a timer?"
512 "Is point at a description list item?"
516 "Is point at a line starting a plain-list item with a checklet?"
520 "Is point at a line starting a plain-list item with a counter?"
526 ;;; Structures and helper functions
529 "Determine context, and its boundaries, around point.
531 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
532 are boundaries and CONTEXT is a symbol among `drawer', `block',
533 `invalid', `inlinetask' and nil.
535 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
541 ;; Get positions of surrounding headings. This is the
542 ;; default context.
547 ;; Is point inside a drawer?
549 ;; Can't use org-drawers-regexp as this function
550 ;; might be called in buffers not in Org mode
561 lim-down))
564 ;; Is point strictly in a block, and of which type?
575 lim-down))
581 ;; Is point in an inlinetask?
594 ;; Return context boundaries and type.
598 "Return structure of list at point.
600 A list structure is an alist where key is point at item, and
601 values are:
602 1. indentation,
603 2. bullet with trailing whitespace,
604 3. bullet counter, if any,
605 4. checkbox, if any,
606 5. description tag, if any,
607 6. position at item end.
609 Thus the following list, where numbers in parens are
610 point-at-bol:
612 - [X] first item (1)
613 1. sub-item 1 (18)
614 5. [@5] sub-item 2 (34)
615 some other text belonging to first item (55)
616 - last item (97)
617 + tag :: description (109)
618 (131)
620 will get the following structure:
628 Assume point is at an item."
643 ind itm-lst itm-lst-2 end-lst end-lst-2 struct
646 ;; Return association at point.
650 ind
657 ;; Ensure list ends at the first blank line.
661 ;; 1. Read list from starting item to its beginning, and save
662 ;; top item position and indentation in BEG-CELL. Also store
663 ;; ending position of items in END-LST.
671 ;; At upward limit: if we ended at an item, store it,
672 ;; else dimiss useless data recorded above BEG-CELL.
673 ;; Jump to part 2.
681 ;; At a verbatim block, go before its beginning. Move
682 ;; from eol to ensure `previous-single-property-change'
683 ;; will return a value.
688 ;; Looking at a list ending regexp. Dismiss useless
689 ;; data recorded above BEG-CELL. Jump to part 2.
695 ;; Point is at an item. Add data to ITM-LST. It may
696 ;; also end a previous item: save it in END-LST. If ind
697 ;; is less or equal than BEG-CELL and there is no end
698 ;; at this ind or lesser, this item becomes the new
699 ;; BEG-CELL.
708 ;; Skip blocks, drawers, inline tasks, blank lines.
719 ;; From there, point is not at an item. Unless ending
720 ;; method is `regexp', interpret line's indentation:
721 ;; - text at column 0 is necessarily out of any list.
722 ;; Dismiss data recorded above BEG-CELL. Jump to
723 ;; part 2.
724 ;; - any other case may be an ending position for an
725 ;; hypothetical item above. Store it and proceed.
735 ;; 2. Read list from starting point to its end, that is until we
736 ;; get out of context, or that a non-item line is less or
737 ;; equally indented than BEG-CELL's cdr. Also, store ending
738 ;; position of items in END-LST-2.
745 ;; At downward limit: this is de facto the end of the
746 ;; list. Save point as an ending position, and jump to
747 ;; part 3.
750 ;; At a verbatim block, move to its end. Point is at bol
751 ;; and 'org-example property is set by whole lines:
752 ;; `next-single-property-change' always return a value.
756 ;; Looking at a list ending regexp. Save point as an
757 ;; ending position and jump to part 3.
762 ;; Point is at an item. Add data to ITM-LST-2. It may also
763 ;; end a previous item, so save it in END-LST-2.
767 ;; Skip inline tasks and blank lines along the way
772 ;; Ind is lesser or equal than BEG-CELL's. The list is
773 ;; over: store point as an ending position and jump to
774 ;; part 3.
779 ;; Else, if ind is lesser or equal than previous item's,
780 ;; this is an ending position: store it. In any case,
781 ;; skip block or drawer at point, and move to next line.
794 ;; 3. Correct ill-formed lists by ensuring top item is the least
795 ;; indented.
802 ;; Trim bullet so item will be seen as different
803 ;; when compared with repaired version.
805 struct))
806 ;; 4. Associate each item to its end pos.
808 ;; 5. Return STRUCT
809 struct)))
812 "Associate proper ending point to items in STRUCT.
814 END-LIST is a pseudo-alist where car is indentation and cdr is
815 ending position.
817 This function modifies STRUCT."
823 ;; Remove end candidates behind current item
826 ;; Add end position to item assoc
832 struct)))
835 "Return alist between item and previous item in STRUCT."
837 struct)))
841 struct)))
844 "Return alist between item and parent in STRUCT."
866 ;;; Accessors
869 "Return the Nth value of KEY in STRUCT."
873 "Set the Nth value of KEY in STRUCT to NEW.
878 "Return indentation of ITEM in STRUCT."
882 "Set indentation of ITEM in STRUCT to IND.
887 "Return bullet of ITEM in STRUCT."
891 "Set bullet of ITEM in STRUCT to BULLET.
896 "Return counter of ITEM in STRUCT."
900 "Return checkbox of ITEM in STRUCT or nil."
904 "Set checkbox of ITEM in STRUCT to CHECKBOX.
909 "Return end position of ITEM in STRUCT."
913 "Return end position of ITEM in STRUCT."
917 "Return point at end of ITEM in STRUCT, before any blank line.
918 Point returned is at end of line."
925 "Return parent of ITEM or nil.
926 STRUCT is the list structure. PARENTS is the alist of parents, as
927 returned by `org-list-parents-alist'."
932 "Non-nil if ITEM has a child.
934 STRUCT is the list structure.
936 Value returned is the position of the first child of ITEM."
941 child-maybe)))
944 "Return next item in same sub-list as ITEM, or nil.
945 STRUCT is the list structure. PREVS is the alist of previous
946 items, as returned by `org-list-prevs-alist'."
950 "Return previous item in same sub-list as ITEM, or nil.
951 STRUCT is the list structure. PREVS is the alist of previous
952 items, as returned by `org-list-prevs-alist'."
956 "List all items having ITEM as a common ancestor, or nil.
957 STRUCT is the list structure."
960 subtree)
965 sub-struct))
969 "List all items in the same sub-list as ITEM.
970 STRUCT is the list structure. PREVS is the alist of previous
971 items, as returned by `org-list-prevs-alist'."
974 before-item after-item)
982 "List all children of ITEM, or nil.
983 STRUCT is the list structure. PARENTS is the alist of parents, as
984 returned by `org-list-parents-alist'."
992 "Return point at beginning of list.
993 STRUCT is the list structure."
997 "Return point at bottom of list.
998 STRUCT is the list structure."
1003 "Return point at beginning of sub-list ITEM belongs.
1004 STRUCT is the list structure. PREVS is the alist of previous
1005 items, as returned by `org-list-prevs-alist'."
1009 first-item))
1014 "Return point at last item of sub-list ITEM belongs.
1015 STRUCT is the list structure. PREVS is the alist of previous
1016 items, as returned by `org-list-prevs-alist'."
1020 last-item))
1023 "Return point at end of sub-list ITEM belongs.
1024 STRUCT is the list structure. PREVS is the alist of previous
1025 items, as returned by `org-list-prevs-alist'."
1029 "Return the type of the list containing ITEM, as a symbol.
1031 STRUCT is the list structure. PREVS is the alist of previous
1032 items, as returned by `org-list-prevs-alist'.
1034 Possible types are `descriptive', `ordered' and `unordered'. The
1035 type is determined by the first item of the list."
1043 ;;; Searching
1046 "Search a string in valid contexts for lists.
1047 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1048 in `re-search-forward'."
1052 ;; 1. No match: return to origin or bound, depending on NOERR.
1055 nil)))
1056 ;; 2. Match in valid context: return point. Else, continue
1057 ;; searching.
1061 "Like `re-search-backward' but stop only where lists are recognized.
1062 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1063 `re-search-backward'."
1068 "Like `re-search-forward' but stop only where lists are recognized.
1069 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1070 `re-search-forward'."
1075 ;;; Methods on structures
1078 "Return BULLET with the correct number of whitespaces.
1079 It determines the number of whitespaces to append by looking at
1080 `org-list-two-spaces-after-bullet-regexp'."
1084 org-list-two-spaces-after-bullet-regexp bullet))
1085 " "
1091 "Return number of blank lines that should separate items in list.
1093 POS is the position at item beginning to be considered.
1095 STRUCT is the list structure. PREVS is the alist of previous
1096 items, as returned by `org-list-prevs-alist'.
1098 Assume point is at item's beginning. If the item is alone, apply
1099 some heuristics to guess the result."
1103 usr-blank)
1105 ;; Trivial cases where there should be none.
1107 org-empty-line-terminates-plain-lists)
1109 ;; When `org-blank-before-new-entry' says so, it is 1.
1111 ;; plain-list-item is 'auto. Count blank lines separating
1112 ;; neighbours items in list.
1115 ;; Is there a next item?
1118 ;; Is there a previous item?
1121 ;; User inserted blank lines, trust him
1127 usr-blank)
1128 ;; Are there blank lines inside the item ?
1133 ;; No parent: no blank line.
1137 "Insert a new list item at POS and return the new structure.
1138 If POS is before first character after bullet of the item, the
1139 new item will be created before the current one.
1141 STRUCT is the list structure. PREVS is the the alist of previous
1142 items, as returned by `org-list-prevs-alist'.
1144 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1145 after the bullet. Cursor will be after this text once the
1146 function ends.
1148 This function modifies STRUCT."
1150 ;; 1. Get information about list: structure, usual helper
1151 ;; functions, position of point with regards to item start
1152 ;; (BEFOREP), blank lines number separating items (BLANK-NB),
1153 ;; position of split (POS) if we're allowed to (SPLIT-LINE-P).
1161 item struct prevs))
1162 ;; 2. Build the new item to be created. Concatenate same
1163 ;; bullet as item, checkbox, text AFTER-BULLET if
1164 ;; provided, and text cut from point to end of item
1165 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1166 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1167 ;; between what was cut and what was inserted in buffer
1168 ;; is stored in SIZE-OFFSET.
1172 ind))
1186 text-cut))
1191 ;; 4. Insert effectively item into buffer
1195 ;; 5. Add new item to STRUCT.
1200 ;; Before inserted item, positions don't change but
1201 ;; an item ending after insertion has its end shifted
1202 ;; by SIZE-OFFSET.
1205 ;; Trivial cases where current item isn't split in
1206 ;; two. Just shift every item after new one by
1207 ;; ITEM-SIZE.
1211 ;; Item is split in two: elements before POS are just
1212 ;; shifted by ITEM-SIZE. In the case item would end
1213 ;; after split POS, ending is only shifted by
1214 ;; SIZE-OFFSET.
1220 ;; Elements after POS are moved into new item. Length
1221 ;; of ITEM-SEP has to be removed as ITEM-SEP
1222 ;; doesn't appear in buffer yet.
1228 (+ end size-offset
1230 ;; Elements at ITEM-END or after are only shifted by
1231 ;; SIZE-OFFSET.
1234 struct)
1237 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1238 ;; exchange ITEM with the next item in list. Position cursor
1239 ;; after bullet, counter, checkbox, and label.
1245 struct)))
1248 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1249 Blank lines at the end of items are left in place. Return the new
1250 structure after the changes.
1252 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1253 to the same sub-list.
1255 This function modifies STRUCT."
1268 ;; 1. Move effectively items in buffer.
1272 ;; 2. Now modify struct. No need to re-read the list, the
1273 ;; transformation is just a shift of positions. Some special
1274 ;; attention is required for items ending at END-A and END-B
1275 ;; as empty spaces are not moved there. In others words, item
1276 ;; BEG-A will end with whitespaces that were at the end of
1277 ;; BEG-B and the same applies to BEG-B.
1299 struct)
1303 "Outdent items between positions START and END.
1305 STRUCT is the list structure. PARENTS is the alist of items'
1306 parents, as returned by `org-list-parents-alist'.
1308 START is included, END excluded."
1314 ;; Item not yet in zone: keep association
1316 ;; Item out of zone: follow associations in acc
1320 ;; Item has no parent: error
1323 ;; Parent is outdented: keep association
1327 ;; Parent isn't outdented: reparent to grand-parent
1329 parent struct parents)))
1335 "Indent items between positions START and END.
1337 STRUCT is the list structure. PARENTS is the alist of parents and
1338 PREVS is the alist of previous items, returned by, respectively,
1339 `org-list-parents-alist' and `org-list-prevs-alist'.
1341 START is included and END excluded.
1343 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1344 bullets between START and END."
1358 ;; Item not yet in zone: keep association
1361 ;; Item out of zone: follow associations in acc
1365 ;; Item is in zone...
1367 ;; Check if bullet needs to be changed
1370 ;; First item indented but not parent: error
1373 ;; First item and parent indented: keep same parent
1375 ;; Previous item not indented: reparent to it
1377 ;; Previous item indented: reparent like it
1384 ;;; Repairing structures
1387 "Non-nil if list starting at FIRST can have alphabetical bullets.
1389 STRUCT is list structure. PREVS is the alist of previous items,
1390 as returned by `org-list-prevs-alist'."
1394 ;; Pretend that bullets are uppercase and check if alphabet
1395 ;; is sufficient, taking counters into account.
1399 ;; Virtually determine current bullet
1401 ;; Counters are not case-sensitive.
1404 ;; Test if bullet would be over z or Z.
1408 ;; All items checked. All good.
1409 t))))
1412 "Increment BULLET if applicable."
1415 ;; Num bullet: increment it.
1419 nil nil bullet))
1420 ;; Alpha bullet: increment it.
1424 nil nil bullet))
1425 ;; Unordered bullet: leave it.
1429 "Verify and correct bullets in STRUCT.
1430 PREVS is the alist of previous items, as returned by
1431 `org-list-prevs-alist'.
1433 This function modifies STRUCT."
1437 ;; Set bullet of ITEM in STRUCT, depending on the type of
1438 ;; first item of the list, the previous bullet and counter
1439 ;; if any.
1448 item struct
1451 ;; Alpha counter in alpha list: use counter.
1455 ;; Use cond to be sure `string-match' is used in
1456 ;; both cases.
1462 ;; Num counter in a num list: use counter.
1467 ;; No counter: increase, if needed, previous bullet.
1470 ;; Alpha counter at first item: use counter.
1479 ;; Num counter at first item: use counter.
1484 ;; First bullet is alpha uppercase: use "A".
1487 ;; First bullet is alpha lowercase: use "a".
1490 ;; First bullet is num: use "1".
1493 ;; Not an ordered list: keep bullet.
1498 "Verify and correct indentation in STRUCT.
1500 PARENTS is the alist of parents, as returned by
1501 `org-list-parents-alist'.
1503 If numeric optional argument BULLET-SIZE is set, assume all
1504 bullets in list have this length to determine new indentation.
1506 This function modifies STRUCT."
1513 ;; Indent like parent + length of parent's bullet
1519 ;; If no parent, indent like top-point
1524 "Verify and correct checkboxes in STRUCT.
1526 PARENTS is the alist of parents and PREVS is the alist of
1527 previous items, as returned by, respectively,
1528 `org-list-parents-alist' and `org-list-prevs-alist'.
1530 If ORDERED is non-nil, a checkbox can only be checked when every
1531 checkbox before it is checked too. If there was an attempt to
1532 break this rule, the function will return the blocking item. In
1533 all others cases, the return value will be nil.
1535 This function modifies STRUCT."
1545 item struct
1551 ;; parent has no boxed child: leave box as-is
1553 parent-list)
1554 ;; 1. List all parents with a checkbox
1561 all-items)
1562 ;; 2. Sort those parents by decreasing indentation
1567 ;; 3. For each parent, get all children's checkboxes to determine
1568 ;; and set its checkbox accordingly
1570 ;; 4. If ORDERED is set, see if we need to uncheck some boxes
1575 ;; there are boxes checked after an unchecked one: fix that
1580 ;; Verify once again the structure, without ORDERED
1582 ;; return blocking item
1586 "Apply set-difference between STRUCT and OLD-STRUCT to the buffer.
1588 OLD-STRUCT is the structure before any modifications, and STRUCT
1589 the structure to be applied. The function will only modify parts
1590 of the list which have changed.
1592 Initial position of cursor is restored after the changes."
1600 ;; Shift the indentation between END and BEG by DELTA.
1601 ;; Start from the line before END.
1610 ;; Skip inline tasks
1613 ;; Shift only non-empty lines
1620 ;; Replace ITEM first line elements with new elements from
1621 ;; STRUCT, if appropriate.
1631 ;; a. Replace bullet
1634 ;; b. Replace checkbox
1648 ;; c. Indent item to appropriate column
1653 ;; 1. First get list of items and position endings. We maintain
1654 ;; two alists: ITM-SHIFT, determining indentation shift needed
1655 ;; at item, and END-POS, a pseudo-alist where key is ending
1656 ;; position and value point
1669 ;; To determine real ind of an ending position that is
1670 ;; not at an item, we have to find the item it belongs
1671 ;; to: it is the last item (ITEM-UP), whose ending is
1672 ;; further than the position we're interested in.
1676 old-struct)
1677 ;; 2. Slice the items into parts that should be shifted by the
1678 ;; same amount of indentation. The slices are returned in
1679 ;; reverse order so changes modifying buffer do not change
1680 ;; positions they refer to.
1683 '<))
1691 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1692 ;; end to beginning. Take a special action when beginning is
1693 ;; at item bullet.
1700 sliced-struct))
1701 ;; 4. Go back to initial position
1705 "Correct bullets, checkboxes and indentation in list at point.
1706 STRUCT is the list structure. PARENTS is the alist of parents, as
1707 returned by `org-list-parents-alist'."
1708 ;; Order of functions matters here: checkboxes and endings need
1709 ;; correct indentation to be set, and indentation needs correct
1710 ;; bullets.
1711 ;;
1712 ;; 0. Save a copy of structure before modifications
1714 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1715 ;; order to get items endings and bullets properly
1717 ;; 2. Get pseudo-alist of ending positions and sort it by position.
1718 ;; Then associate them to the structure.
1725 ;; To determine real ind of an ending position that is
1726 ;; not at an item, we have to find the item it belongs
1727 ;; to: it is the last item (ITEM-UP), whose ending is
1728 ;; further than the position we're interested in.
1731 ;; Else part is for the bottom point
1733 end-pos)
1734 end-list)))
1737 struct)
1740 ;; 3. Get bullets right
1743 ;; 4. Now get real indentation
1745 ;; 5. Eventually fix checkboxes
1747 ;; 6. Apply structure modifications to buffer
1751 ;;; Misc Tools
1754 "Call FUNCTION on each item of the list at point.
1755 FUNCTION must be called with at least one argument: INIT-VALUE,
1756 that will contain the value returned by the function at the
1757 previous item, plus ARGS extra arguments.
1759 FUNCTION is applied on items in reverse order.
1761 As an example, \(org-apply-on-list \(lambda \(result\) \(1+ result\)\) 0\)
1762 will return the number of items in the current list.
1764 Sublists of the list are skipped. Cursor is always at the
1765 beginning of the item."
1776 value))
1779 "Set visibility of ITEM in STRUCT to VIEW.
1781 Possible values are: `folded', `children' or `subtree'. See
1782 `org-cycle' for more information."
1786 ;; Hide from eol
1788 item-end t)))
1790 ;; First show everything.
1792 ;; Then fold every child.
1797 children)))
1799 ;; Show everything
1804 "Return column at which body of ITEM should start."
1814 tcol))
1817 ;;; Interactive functions
1822 "Go to the beginning of the current item.
1823 Throw an error when not in a list."
1829 "Go to the beginning item of the current list or sublist.
1830 Throw an error when not in a list."
1841 "Go to the end of the current list or sublist.
1842 Throw an error when not in a list."
1853 "Go to the end of the current item.
1854 Throw an error when not in a list."
1864 "Move to the beginning of the previous item.
1865 Throw an error when not in a list, or at first item."
1877 "Move to the beginning of the next item.
1878 Throw an error when not in a plain list, or at last item."
1890 "Move the item at point down, i.e. swap with following item.
1891 Subitems (items with larger indentation) are considered part of
1892 the item, so this really moves item trees."
1907 ;; Use a short variation of `org-list-write-struct' as there's
1908 ;; no need to go through all the steps.
1919 "Move the item at point up, i.e. swap with previous item.
1920 Subitems (items with larger indentation) are considered part of
1921 the item, so this really moves item trees."
1936 ;; Use a short variation of `org-list-write-struct' as there's
1937 ;; no need to go through all the steps.
1947 "Insert a new item at the current level.
1948 If cursor is before first character after bullet of the item, the
1949 new item will be created before the current one.
1951 If CHECKBOX is non-nil, add a checkbox next to the bullet.
1953 Return t when things worked, nil when we are not in an item, or
1954 item is invisible."
1957 ;; If cursor isn't is a list or if list is invisible, return nil.
1965 ;; Timer list: delegate to `org-timer-item'.
1970 ;; If we're in a description list, ask for the new term.
1973 ;; Don't insert a checkbox if checkbox rule is applied
1974 ;; and it is a description item.
1978 org-list-automatic-rules)))))))
1985 t)))))
1988 "Fix indentation, bullets and checkboxes is the list at point."
1996 "Cycle through the different itemize/enumerate bullets.
1997 This cycle the entire list level through the sequence:
1999 `-' -> `+' -> `*' -> `1.' -> `1)'
2001 If WHICH is a valid string, use that as the new bullet. If WHICH
2002 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2003 `previous', cycle backwards."
2024 ;; Compute list of possible bullets, depending on context
2027 ;; *-bullets are not allowed at column 0
2030 ;; Description items cannot be numbered
2053 ;; Use a short variation of `org-list-write-struct' as there's
2054 ;; no need to go through all the steps.
2062 "Toggle the checkbox in the current line.
2063 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2064 double prefix, set checkbox to [-].
2066 When there is an active region, toggle status or presence of the
2067 first checkbox there, and make every item inside have the same
2068 status or presence, respectively.
2070 If the cursor is in a headline, apply this to all checkbox items
2071 in the text below the heading, taking as reference the first item
2072 in subtree, ignoring drawers."
2076 block-item
2077 lim-up
2078 lim-down
2089 ;; In a region, start at first item in region
2099 ;; On an heading, start at first item after drawers and
2100 ;; time-stamps (scheduled, etc.)
2111 ;; Just one item: set singlep flag
2117 ;; Determine the checkbox going to be applied to all items
2118 ;; within bounds
2129 ;; When an item is found within bounds, grab the full list at
2130 ;; point structure, then: 1. set checkbox of all its items
2131 ;; within bounds to ref-checkbox; 2. fix checkboxes of the whole
2132 ;; list; 3. move point after the list.
2146 e struct
2147 ;; if there is no box at item, leave as-is
2148 ;; unless function was called with C-u prefix
2151 ref-checkbox
2152 cur-box))))
2153 items-to-toggle)
2155 struct parents prevs orderedp))
2156 ;; Report some problems due to ORDERED status of subtree. If
2157 ;; only one box was being checked, throw an error, else,
2158 ;; only signal problems.
2162 "Checkbox blocked because of unchecked box at line %d"
2166 "Checkboxes were removed due to unchecked box at line %d"
2173 "Reset all checkboxes in an entry subtree."
2188 "Update the checkbox statistics in the current section.
2189 This will find all statistic cookies like [57%] and [6/12] and
2190 update them with the current numbers.
2192 With optional prefix argument ALL, do this for the whole buffer."
2196 (box-re "^[ \t]*\\([-+*]\\|\\([0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2208 ;; Return number of checked boxes and boxes of all types
2209 ;; in all structures in STRUCTS. If RECURSIVEP is non-nil,
2210 ;; also count boxes in sub-lists. If ITEM is nil, count
2211 ;; across the whole structure, else count only across
2212 ;; subtree whose ancestor is ITEM.
2229 items))))
2232 structs)
2235 cookies-list structs-bak box-num)
2237 ;; 1. Build an alist for each cookie found within BOUNDS. The
2238 ;; key will be position at beginning of cookie and values
2239 ;; ending position, format of cookie, and a cell whose car is
2240 ;; number of checked boxes to report, and cdr total number of
2241 ;; boxes.
2251 ;; Cookie is at an heading, but specifically for todo,
2252 ;; not for checkboxes: skip it.
2258 ;; Cookie is at an heading, but all lists before next
2259 ;; heading already have been read. Use data collected
2260 ;; in STRUCTS-BAK. This should only happen when heading
2261 ;; has more than one cookie on it.
2264 backup-end))
2266 ;; Cookie is at a fresh heading. Grab structure of
2267 ;; every list containing a checkbox between point and
2268 ;; next headline, and save them in STRUCTS-BAK.
2278 ;; Cookie is at an item, and we already have list
2279 ;; structure stored in STRUCTS-BAK.
2282 ;; Only lists in no special context are stored.
2285 ;; Cookie is at an item, but we need to compute list
2286 ;; structure.
2292 ;; Else, cookie found is at a wrong place. Skip it.
2294 cookies-list))))
2295 ;; 2. Apply alist to buffer, in reverse order so positions stay
2296 ;; unchanged after cookie modifications.
2310 cookies-list))))
2313 "Select the face for checkbox statistics.
2314 The face will be `org-done' when all relevant boxes are checked.
2315 Otherwise it will be `org-todo'."
2318 'org-checkbox-statistics-done
2322 'org-checkbox-statistics-done
2326 "Update checkbox statistics unless turned off by user."
2334 "Indent a local list item including its children.
2335 When number ARG is a negative, item will be outdented, otherwise
2336 it will be indented.
2338 If a region is active, all items inside will be moved.
2340 If NO-SUBTREE is non-nil, only indent the item itself, not its
2341 children.
2343 STRUCT is the list structure.
2345 Return t if successful."
2354 ;; Are we going to move the whole list?
2361 t))))
2362 ;; Determine begin and end points of zone to indent. If moving
2363 ;; more than one item, save them for subsequent moves.
2379 ;; Special case: moving top-item with indent rule
2387 ;; Change bullet if necessary
2393 ;; Shift every item by OFFSET and fix bullets. Then
2394 ;; apply changes to buffer.
2398 struct)
2401 ;; Forbidden move:
2403 ;; If only one item is moved, it mustn't have a child
2407 ;; If a subtree or region is moved, the last item
2408 ;; of the subtree mustn't have a child
2413 struct)))))
2416 ;; Normal shifting
2424 t)
2427 "Outdent a local list item, but not its children.
2428 If a region is active, all items inside will be moved."
2436 "Indent a local list item, but not its children.
2437 If a region is active, all items inside will be moved."
2445 "Outdent a local list item including its children.
2446 If a region is active, all items inside will be moved."
2460 "Indent a local list item including its children.
2461 If a region is active, all items inside will be moved."
2476 "Cycle levels of indentation of an empty item.
2477 The first run indents the item, if applicable. Subsequents runs
2478 outdent it at meaningful levels in the list. When done, item is
2479 put back at its original position with its original bullet.
2481 Return t at each successful move."
2487 ;; Accept empty items or if cycle has already started.
2498 ;; When in the middle of the cycle, try to outdent first. If it
2499 ;; fails, and point is still at initial position, indent. Else,
2500 ;; go back to original position.
2509 ;; Break cycle
2511 ;; If a cycle is starting, remember indentation and bullet,
2512 ;; then try to indent. If it fails, try to outdent.
2518 t))))
2521 "Sort list items.
2522 The cursor may be at any item of the list that should be sorted.
2523 Sublists are not sorted. Checkboxes, if any, are ignored.
2525 Sorting can be alphabetically, numerically, by date/time as given by
2526 a time stamp, by a property or by priority.
2528 Comparing entries ignores case by default. However, with an
2529 optional argument WITH-CASE, the sorting considers case as well.
2531 The command prompts for the sorting type unless it has been given
2532 to the function through the SORTING-TYPE argument, which needs to
2533 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
2534 meaning of each character:
2536 n Numerically, by converting the beginning of the item to a number.
2537 a Alphabetically. Only the first line of item is checked.
2538 t By date/time, either the first active time stamp in the entry, if
2539 any, or by the first inactive one. In a timer list, sort the timers.
2541 Capital letters will reverse the sort order.
2543 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a
2544 function to be called with point at the beginning of the record.
2545 It must return either a string or a number that should serve as
2546 the sorting key for that record. It will then use COMPARE-FUNC to
2547 compare entries."
2592 ;; If it is a timer list, convert timer to seconds
2605 value))
2609 next-record
2610 end-record
2611 value-to-sort
2612 nil
2613 sort-func)
2614 ;; Read and fix list again, as `sort-subr' probably destroyed
2615 ;; its structure.
2621 ;;; Send and receive lists
2624 "Parse the list at point and maybe DELETE it.
2626 Return a list whose car is a symbol of list type, among
2627 `ordered', `unordered' and `descriptive'. Then, each item is a
2628 list whose car is counter, and cdr are strings and other
2632 For example, the following list:
2634 1. first item
2635 + sub-item one
2636 + [X] sub-item two
2637 more text in first item
2638 2. [@3] last item
2640 will be parsed as:
2642 \(ordered
2644 \(unordered
2650 Point is left at list end."
2656 out
2657 parse-item ; for byte-compiler
2660 ;; Return text between BEG and END, trimmed, with
2661 ;; checkboxes replaced.
2668 text)))))
2671 ;; Return a list whose car is list type and cdr a list of
2672 ;; items' body.
2678 ;; Return a list containing counter of item, if any, text
2679 ;; and any sublist inside it.
2685 ;; Get counter number. For alphabetic counter, get
2686 ;; its position in the alphabet.
2697 ;; If item has a child, store text between bullet and
2698 ;; next child, then recursively parse all sublists. At
2699 ;; the end of each sublist, check for the presence of
2700 ;; text belonging to the original item.
2710 ;; Remove children from the list just parsed.
2712 ;; There is a chunk of text belonging to the
2713 ;; item if last child doesn't end where next
2714 ;; child starts or where item ends.
2718 body))))
2721 ;; Store output, take care of cursor position and deletion of
2722 ;; list, then return output.
2730 out))
2733 "Convert the plain list at point into a subtree."
2741 "Insert a radio list template appropriate for this major mode."
2745 name pos)
2756 "Send a transformed version of this list to the receiver position.
2757 With argument MAYBE, fail quietly if no transformation is defined for
2758 this list."
2764 (unless (looking-at "[ \t]*#\\+ORGLST[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
2783 beg txt)
2787 ;; Find the insertion place
2792 name
2806 "Convert a LIST parsed through `org-list-parse-list' to other formats.
2807 Valid parameters PARAMS are
2809 :ustart String to start an unordered list
2810 :uend String to end an unordered list
2812 :ostart String to start an ordered list
2813 :oend String to end an ordered list
2815 :dstart String to start a descriptive list
2816 :dend String to end a descriptive list
2817 :dtstart String to start a descriptive term
2818 :dtend String to end a descriptive term
2819 :ddstart String to start a description
2820 :ddend String to end a description
2822 :splice When set to t, return only list body lines, don't wrap
2823 them into :[u/o]start and :[u/o]end. Default is nil.
2825 :istart String to start a list item.
2826 :icount String to start an item with a counter.
2827 :iend String to end a list item
2828 :isep String to separate items
2829 :lsep String to separate sublists
2830 :csep String to separate text from a sub-list
2832 :cboff String to insert for an unchecked checkbox
2833 :cbon String to insert for a checked checkbox
2835 Alternatively, each parameter can also be a form returning a
2836 string. These sexp can use keywords `counter' and `depth',
2837 reprensenting respectively counter associated to the current
2838 item, and depth of the current sub-list, starting at 0.
2839 Obviously, `counter' is only available for parameters applying to
2840 items."
2862 export-sublist ; for byte-compiler
2865 ;; Export an item ITEM of type TYPE, at DEPTH. First string
2866 ;; in item is treated in a special way as it can bring
2867 ;; extra information that needs to be processed.
2873 ;; Stick DTSTART to ISTART by
2874 ;; left-trimming the latter.
2878 istart))
2885 ;; Replace checkbox if any is found.
2893 ;; Insert descriptive term if TYPE is `descriptive'.
2902 first)))
2913 ;; Export sublist SUB at DEPTH
2931 "Convert LIST into a LaTeX list.
2932 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2933 with overruling parameters for `org-list-to-generic'."
2935 list
2945 enum counter)
2949 params)))
2952 "Convert LIST into a HTML list.
2953 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2954 with overruling parameters for `org-list-to-generic'."
2956 list
2967 params)))
2970 "Convert LIST into a Texinfo list.
2971 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2972 with overruling parameters for `org-list-to-generic'."
2974 list
2984 params)))
2987 "Convert LIST into an Org subtree.
2988 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2989 with overruling parameters for `org-list-to-generic'."
2999 ;; Return the string for the heading, depending on depth D
3000 ;; of current sub-list.
3005 ?*)
3008 list
3010 '(:splice t
3017 params))))
3021 ;; arch-tag: 73cf50c1-200f-4d1d-8a53-4e842a5b11c8
3022 ;;; org-list.el ends here