| blob | b42a5e150cb886788fa038fcd7f7f1f7df7b5c4c |
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.4
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'."
522 ;; Compute position of surrounding headings. This is the
523 ;; default context.
531 nil))))
534 ;; Is point inside a drawer?
538 ;; Can't use org-drawers-regexp as this function
539 ;; might be called in buffers not in Org mode
549 next-head))
552 ;; Is point strictly in a block, and of which type?
564 next-head))
569 ;; Is point in an inlinetask?
583 ;; List actual candidates
585 ;; Return the closest context around
589 "Return structure of list at point.
591 A list structure is an alist where key is point at item, and
592 values are:
593 1. indentation,
594 2. bullet with trailing whitespace,
595 3. bullet counter, if any,
596 4. checkbox, if any,
597 5. position at item end,
598 6. description tag, if any.
600 Thus the following list, where numbers in parens are
601 point-at-bol:
603 - [X] first item (1)
604 1. sub-item 1 (18)
605 5. [@5] sub-item 2 (34)
606 some other text belonging to first item (55)
607 - last item (97)
608 + tag :: description (109)
609 (131)
611 will get the following structure:
619 Assume point is at an item."
634 ind itm-lst itm-lst-2 end-lst end-lst-2 struct
637 ;; Return association at point.
641 ind
648 ;; Ensure list ends at the first blank line.
652 ;; 1. Read list from starting item to its beginning, and save
653 ;; top item position and indentation in BEG-CELL. Also store
654 ;; ending position of items in END-LST.
662 ;; At upward limit: if we ended at an item, store it,
663 ;; else dimiss useless data recorded above BEG-CELL.
664 ;; Jump to part 2.
672 ;; At a verbatim block, go before its beginning. Move
673 ;; from eol to ensure `previous-single-property-change'
674 ;; will return a value.
679 ;; Looking at a list ending regexp. Dismiss useless
680 ;; data recorded above BEG-CELL. Jump to part 2.
686 ;; Skip blocks, drawers, inline tasks, blank lines
687 ;; along the way.
699 ;; Point is at an item. Add data to ITM-LST. It may
700 ;; also end a previous item: save it in END-LST. If
701 ;; ind is less or equal than BEG-CELL and there is no
702 ;; end at this ind or lesser, this item becomes the
703 ;; new BEG-CELL.
711 ;; From there, point is not at an item. Unless ending
712 ;; method is `regexp', interpret line's indentation:
713 ;; - text at column 0 is necessarily out of any list.
714 ;; Dismiss data recorded above BEG-CELL. Jump to
715 ;; part 2.
716 ;; - any other case, it can possibly be an ending
717 ;; position for an item above. Save it and proceed.
727 ;; 2. Read list from starting point to its end, that is until we
728 ;; get out of context, or a non-item line is less or equally
729 ;; indented that BEG-CELL's cdr. Also store ending position
730 ;; of items in END-LST-2.
737 ;; At downward limit: this is de facto the end of the
738 ;; list. Save point as an ending position, and jump to
739 ;; part 3.
742 ;; At a verbatim block, move to its end. Point is at bol
743 ;; and 'org-example property is set by whole lines:
744 ;; `next-single-property-change' always return a value.
748 ;; Looking at a list ending regexp. Save point as an
749 ;; ending position and jump to part 3.
753 ;; Skip blocks, drawers, inline tasks and blank lines
754 ;; along the way
766 ;; Point is at an item. Add data to ITM-LST-2. It may also
767 ;; end a previous item, so save it in END-LST-2.
771 ;; From there, point is not at an item. If ending method
772 ;; is not `regexp', two situations are of interest:
773 ;; - ind is lesser or equal than BEG-CELL's. The list is
774 ;; over. Store point as an ending position and jump to
775 ;; part 3.
776 ;; - ind is lesser or equal than previous item's. This
777 ;; is an ending position. Store it and proceed.
788 ;; 3. Correct ill-formed lists by ensuring top item is the least
789 ;; indented.
796 ;; Modify bullet to be sure item will be modified
798 struct))
799 ;; 4. Associate each item to its end pos.
801 ;; 5. Return STRUCT
802 struct)))
805 "Associate proper ending point to items in STRUCT.
807 END-LIST is a pseudo-alist where car is indentation and cdr is
808 ending position.
810 This function modifies STRUCT."
816 ;; Remove end candidates behind current item
819 ;; Add end position to item assoc
825 struct)))
828 "Return alist between item and previous item in STRUCT."
830 struct)))
834 struct)))
837 "Return alist between item and parent in STRUCT."
859 ;;; Accessors
862 "Return the Nth value of KEY in STRUCT."
866 "Set the Nth value of KEY in STRUCT to NEW.
871 "Return indentation of ITEM in STRUCT."
875 "Set indentation of ITEM in STRUCT to IND.
880 "Return bullet of ITEM in STRUCT."
884 "Set bullet of ITEM in STRUCT to BULLET.
889 "Return counter of ITEM in STRUCT."
893 "Return checkbox of ITEM in STRUCT or nil."
897 "Set checkbox of ITEM in STRUCT to CHECKBOX.
902 "Return end position of ITEM in STRUCT."
906 "Return end position of ITEM in STRUCT."
910 "Return point at end of ITEM in STRUCT, before any blank line.
911 Point returned is at end of line."
918 "Return parent of ITEM or nil.
919 STRUCT is the list structure. PARENTS is the alist of parents, as
920 returned by `org-list-parents-alist'."
925 "Non-nil if ITEM has a child.
927 STRUCT is the list structure.
929 Value returned is the position of the first child of ITEM."
934 child-maybe)))
937 "Return next item in same sub-list as ITEM, or nil.
938 STRUCT is the list structure. PREVS is the alist of previous
939 items, as returned by `org-list-prevs-alist'."
943 "Return previous item in same sub-list as ITEM, or nil.
944 STRUCT is the list structure. PREVS is the alist of previous
945 items, as returned by `org-list-prevs-alist'."
949 "List all items having ITEM as a common ancestor, or nil.
950 STRUCT is the list structure."
953 subtree)
958 sub-struct))
962 "List all items in the same sub-list as ITEM.
963 STRUCT is the list structure. PREVS is the alist of previous
964 items, as returned by `org-list-prevs-alist'."
967 before-item after-item)
975 "List all children of ITEM, or nil.
976 STRUCT is the list structure. PARENTS is the alist of parents, as
977 returned by `org-list-parents-alist'."
985 "Return point at beginning of list.
986 STRUCT is the list structure."
990 "Return point at bottom of list.
991 STRUCT is the list structure."
996 "Return point at beginning of sub-list ITEM belongs.
997 STRUCT is the list structure. PREVS is the alist of previous
998 items, as returned by `org-list-prevs-alist'."
1002 first-item))
1007 "Return point at last item 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 last-item))
1016 "Return point at end of sub-list ITEM belongs.
1017 STRUCT is the list structure. PREVS is the alist of previous
1018 items, as returned by `org-list-prevs-alist'."
1022 "Return the type of the list containing ITEM, as a symbol.
1024 STRUCT is the list structure. PREVS is the alist of previous
1025 items, as returned by `org-list-prevs-alist'.
1027 Possible types are `descriptive', `ordered' and `unordered'. The
1028 type is determined by the first item of the list."
1036 ;;; Searching
1039 "Search a string in valid contexts for lists.
1040 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1041 in `re-search-forward'."
1045 ;; 1. No match: return to origin or bound, depending on NOERR.
1048 nil)))
1049 ;; 2. Match in an `invalid' context: continue searching. Else,
1050 ;; return point.
1054 "Like `re-search-backward' but stop only where lists are recognized.
1055 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1056 `re-search-backward'."
1061 "Like `re-search-forward' but stop only where lists are recognized.
1062 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1063 `re-search-forward'."
1068 ;;; Methods on structures
1071 "Return BULLET with the correct number of whitespaces.
1072 It determines the number of whitespaces to append by looking at
1073 `org-list-two-spaces-after-bullet-regexp'."
1077 org-list-two-spaces-after-bullet-regexp bullet))
1078 " "
1084 "Return number of blank lines that should separate items in list.
1086 POS is the position at item beginning to be considered.
1088 STRUCT is the list structure. PREVS is the alist of previous
1089 items, as returned by `org-list-prevs-alist'.
1091 Assume point is at item's beginning. If the item is alone, apply
1092 some heuristics to guess the result."
1096 usr-blank)
1098 ;; Trivial cases where there should be none.
1100 org-empty-line-terminates-plain-lists)
1102 ;; When `org-blank-before-new-entry' says so, it is 1.
1104 ;; plain-list-item is 'auto. Count blank lines separating
1105 ;; neighbours items in list.
1108 ;; Is there a next item?
1111 ;; Is there a previous item?
1114 ;; User inserted blank lines, trust him
1120 usr-blank)
1121 ;; Are there blank lines inside the item ?
1126 ;; No parent: no blank line.
1130 "Insert a new list item at POS and return the new structure.
1131 If POS is before first character after bullet of the item, the
1132 new item will be created before the current one.
1134 STRUCT is the list structure. PREVS is the the alist of previous
1135 items, as returned by `org-list-prevs-alist'.
1137 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1138 after the bullet. Cursor will be after this text once the
1139 function ends.
1141 This function modifies STRUCT."
1143 ;; 1. Get information about list: structure, usual helper
1144 ;; functions, position of point with regards to item start
1145 ;; (BEFOREP), blank lines number separating items (BLANK-NB),
1146 ;; position of split (POS) if we're allowed to (SPLIT-LINE-P).
1154 item struct prevs))
1155 ;; 2. Build the new item to be created. Concatenate same
1156 ;; bullet as item, checkbox, text AFTER-BULLET if
1157 ;; provided, and text cut from point to end of item
1158 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1159 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1160 ;; between what was cut and what was inserted in buffer
1161 ;; is stored in SIZE-OFFSET.
1164 ind-ref
1179 text-cut))
1184 ;; 4. Insert effectively item into buffer
1188 ;; 5. Add new item to STRUCT.
1193 ;; Before inserted item, positions don't change but
1194 ;; an item ending after insertion has its end shifted
1195 ;; by SIZE-OFFSET.
1198 ;; Trivial cases where current item isn't split in
1199 ;; two. Just shift every item after new one by
1200 ;; ITEM-SIZE.
1204 ;; Item is split in two: elements before POS are just
1205 ;; shifted by ITEM-SIZE. In the case item would end
1206 ;; after split POS, ending is only shifted by
1207 ;; SIZE-OFFSET.
1213 ;; Elements after POS are moved into new item. Length
1214 ;; of ITEM-SEP has to be removed as ITEM-SEP
1215 ;; doesn't appear in buffer yet.
1221 (+ end size-offset
1223 ;; Elements at ITEM-END or after are only shifted by
1224 ;; SIZE-OFFSET.
1227 struct)
1230 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1231 ;; exchange ITEM with the next item in list. Position cursor
1232 ;; after bullet, counter, checkbox, and label.
1238 struct)))
1241 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1242 Blank lines at the end of items are left in place. Return the new
1243 structure after the changes.
1245 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1246 to the same sub-list.
1248 This function modifies STRUCT."
1261 ;; 1. Move effectively items in buffer.
1265 ;; 2. Now modify struct. No need to re-read the list, the
1266 ;; transformation is just a shift of positions. Some special
1267 ;; attention is required for items ending at END-A and END-B
1268 ;; as empty spaces are not moved there. In others words, item
1269 ;; BEG-A will end with whitespaces that were at the end of
1270 ;; BEG-B and the same applies to BEG-B.
1292 struct)
1296 "Outdent items between positions START and END.
1298 STRUCT is the list structure. PARENTS is the alist of items'
1299 parents, as returned by `org-list-parents-alist'.
1301 START is included, END excluded."
1307 ;; Item not yet in zone: keep association
1309 ;; Item out of zone: follow associations in acc
1313 ;; Item has no parent: error
1316 ;; Parent is outdented: keep association
1320 ;; Parent isn't outdented: reparent to grand-parent
1322 parent struct parents)))
1328 "Indent items between positions START and END.
1330 STRUCT is the list structure. PARENTS is the alist of parents and
1331 PREVS is the alist of previous items, returned by, respectively,
1332 `org-list-parents-alist' and `org-list-prevs-alist'.
1334 START is included and END excluded.
1336 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1337 bullets between START and END."
1351 ;; Item not yet in zone: keep association
1354 ;; Item out of zone: follow associations in acc
1358 ;; Item is in zone...
1360 ;; Check if bullet needs to be changed
1363 ;; First item indented but not parent: error
1366 ;; First item and parent indented: keep same parent
1368 ;; Previous item not indented: reparent to it
1370 ;; Previous item indented: reparent like it
1377 ;;; Repairing structures
1380 "Non-nil if list starting at FIRST can have alphabetical bullets.
1382 STRUCT is list structure. PREVS is the alist of previous items,
1383 as returned by `org-list-prevs-alist'."
1387 ;; Pretend that bullets are uppercase and check if alphabet
1388 ;; is sufficient, taking counters into account.
1392 ;; Virtually determine current bullet
1394 ;; Counters are not case-sensitive.
1397 ;; Test if bullet would be over z or Z.
1401 ;; All items checked. All good.
1402 t))))
1405 "Increment BULLET if applicable."
1408 ;; Num bullet: increment it.
1412 nil nil bullet))
1413 ;; Alpha bullet: increment it.
1417 nil nil bullet))
1418 ;; Unordered bullet: leave it.
1422 "Verify and correct bullets in STRUCT.
1423 PREVS is the alist of previous items, as returned by
1424 `org-list-prevs-alist'.
1426 This function modifies STRUCT."
1430 ;; Set bullet of ITEM in STRUCT, depending on the type of
1431 ;; first item of the list, the previous bullet and counter
1432 ;; if any.
1441 item struct
1444 ;; Alpha counter in alpha list: use counter.
1448 ;; Use cond to be sure `string-match' is used in
1449 ;; both cases.
1455 ;; Num counter in a num list: use counter.
1460 ;; No counter: increase, if needed, previous bullet.
1463 ;; Alpha counter at first item: use counter.
1472 ;; Num counter at first item: use counter.
1477 ;; First bullet is alpha uppercase: use "A".
1480 ;; First bullet is alpha lowercase: use "a".
1483 ;; First bullet is num: use "1".
1486 ;; Not an ordered list: keep bullet.
1491 "Verify and correct indentation in STRUCT.
1493 PARENTS is the alist of parents, as returned by
1494 `org-list-parents-alist'.
1496 If numeric optional argument BULLET-SIZE is set, assume all
1497 bullets in list have this length to determine new indentation.
1499 This function modifies STRUCT."
1506 ;; Indent like parent + length of parent's bullet
1512 ;; If no parent, indent like top-point
1517 "Verify and correct checkboxes in STRUCT.
1519 PARENTS is the alist of parents and PREVS is the alist of
1520 previous items, as returned by, respectively,
1521 `org-list-parents-alist' and `org-list-prevs-alist'.
1523 If ORDERED is non-nil, a checkbox can only be checked when every
1524 checkbox before it is checked too. If there was an attempt to
1525 break this rule, the function will return the blocking item. In
1526 all others cases, the return value will be nil.
1528 This function modifies STRUCT."
1538 item struct
1544 ;; parent has no boxed child: leave box as-is
1546 parent-list)
1547 ;; 1. List all parents with a checkbox
1554 all-items)
1555 ;; 2. Sort those parents by decreasing indentation
1560 ;; 3. For each parent, get all children's checkboxes to determine
1561 ;; and set its checkbox accordingly
1563 ;; 4. If ORDERED is set, see if we need to uncheck some boxes
1568 ;; there are boxes checked after an unchecked one: fix that
1573 ;; Verify once again the structure, without ORDERED
1575 ;; return blocking item
1579 "Apply set-difference between STRUCT and OLD-STRUCT to the buffer.
1581 OLD-STRUCT is the structure before any modifications, and STRUCT
1582 the structure to be applied. The function will only modify parts
1583 of the list which have changed.
1585 Initial position of cursor is restored after the changes."
1593 ;; Shift the indentation between END and BEG by DELTA.
1594 ;; Start from the line before END.
1603 ;; Skip inline tasks
1606 ;; Shift only non-empty lines
1613 ;; Replace ITEM first line elements with new elements from
1614 ;; STRUCT, if appropriate.
1624 ;; a. Replace bullet
1627 ;; b. Replace checkbox
1641 ;; c. Indent item to appropriate column
1646 ;; 1. First get list of items and position endings. We maintain
1647 ;; two alists: ITM-SHIFT, determining indentation shift needed
1648 ;; at item, and END-POS, a pseudo-alist where key is ending
1649 ;; position and value point
1662 ;; To determine real ind of an ending position that is
1663 ;; not at an item, we have to find the item it belongs
1664 ;; to: it is the last item (ITEM-UP), whose ending is
1665 ;; further than the position we're interested in.
1669 old-struct)
1670 ;; 2. Slice the items into parts that should be shifted by the
1671 ;; same amount of indentation. The slices are returned in
1672 ;; reverse order so changes modifying buffer do not change
1673 ;; positions they refer to.
1676 '<))
1684 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1685 ;; end to beginning. Take a special action when beginning is
1686 ;; at item bullet.
1693 sliced-struct))
1694 ;; 4. Go back to initial position
1698 "Correct bullets, checkboxes and indentation in list at point.
1699 STRUCT is the list structure. PARENTS is the alist of parents, as
1700 returned by `org-list-parents-alist'."
1701 ;; Order of functions matters here: checkboxes and endings need
1702 ;; correct indentation to be set, and indentation needs correct
1703 ;; bullets.
1704 ;;
1705 ;; 0. Save a copy of structure before modifications
1707 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1708 ;; order to get items endings and bullets properly
1710 ;; 2. Get pseudo-alist of ending positions and sort it by position.
1711 ;; Then associate them to the structure.
1718 ;; To determine real ind of an ending position that is
1719 ;; not at an item, we have to find the item it belongs
1720 ;; to: it is the last item (ITEM-UP), whose ending is
1721 ;; further than the position we're interested in.
1724 ;; Else part is for the bottom point
1726 end-pos)
1727 end-list)))
1730 struct)
1733 ;; 3. Get bullets right
1736 ;; 4. Now get real indentation
1738 ;; 5. Eventually fix checkboxes
1740 ;; 6. Apply structure modifications to buffer
1744 ;;; Misc Tools
1747 "Call FUNCTION on each item of the list at point.
1748 FUNCTION must be called with at least one argument: INIT-VALUE,
1749 that will contain the value returned by the function at the
1750 previous item, plus ARGS extra arguments.
1752 FUNCTION is applied on items in reverse order.
1754 As an example, \(org-apply-on-list \(lambda \(result\) \(1+ result\)\) 0\)
1755 will return the number of items in the current list.
1757 Sublists of the list are skipped. Cursor is always at the
1758 beginning of the item."
1769 value))
1772 "Set visibility of ITEM in STRUCT to VIEW.
1774 Possible values are: `folded', `children' or `subtree'. See
1775 `org-cycle' for more information."
1779 ;; Hide from eol
1781 item-end t)))
1783 ;; First show everything.
1785 ;; Then fold every child.
1790 children)))
1792 ;; Show everything
1797 "Return column at which body of ITEM should start."
1807 tcol))
1810 ;;; Interactive functions
1815 "Go to the beginning of the current item.
1816 Throw an error when not in a list."
1822 "Go to the beginning item of the current list or sublist.
1823 Throw an error when not in a list."
1834 "Go to the end of the current list or sublist.
1835 Throw an error when not in a list."
1846 "Go to the end of the current item.
1847 Throw an error when not in a list."
1857 "Move to the beginning of the previous item.
1858 Throw an error when not in a list, or at first item."
1870 "Move to the beginning of the next item.
1871 Throw an error when not in a plain list, or at last item."
1883 "Move the item at point down, i.e. swap with following item.
1884 Subitems (items with larger indentation) are considered part of
1885 the item, so this really moves item trees."
1900 ;; Use a short variation of `org-list-write-struct' as there's
1901 ;; no need to go through all the steps.
1912 "Move the item at point up, i.e. swap with previous item.
1913 Subitems (items with larger indentation) are considered part of
1914 the item, so this really moves item trees."
1929 ;; Use a short variation of `org-list-write-struct' as there's
1930 ;; no need to go through all the steps.
1940 "Insert a new item at the current level.
1941 If cursor is before first character after bullet of the item, the
1942 new item will be created before the current one.
1944 If CHECKBOX is non-nil, add a checkbox next to the bullet.
1946 Return t when things worked, nil when we are not in an item, or
1947 item is invisible."
1950 ;; If cursor isn't is a list or if list is invisible, return nil.
1958 ;; Timer list: delegate to `org-timer-item'.
1963 ;; If we're in a description list, ask for the new term.
1966 ;; Don't insert a checkbox if checkbox rule is applied
1967 ;; and it is a description item.
1971 org-list-automatic-rules)))))))
1978 t)))))
1981 "Fix indentation, bullets and checkboxes is the list at point."
1989 "Cycle through the different itemize/enumerate bullets.
1990 This cycle the entire list level through the sequence:
1992 `-' -> `+' -> `*' -> `1.' -> `1)'
1994 If WHICH is a valid string, use that as the new bullet. If WHICH
1995 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
1996 `previous', cycle backwards."
2017 ;; Compute list of possible bullets, depending on context
2020 ;; *-bullets are not allowed at column 0
2023 ;; Description items cannot be numbered
2046 ;; Use a short variation of `org-list-write-struct' as there's
2047 ;; no need to go through all the steps.
2055 "Toggle the checkbox in the current line.
2056 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2057 double prefix, set checkbox to [-].
2059 When there is an active region, toggle status or presence of the
2060 first checkbox there, and make every item inside have the same
2061 status or presence, respectively.
2063 If the cursor is in a headline, apply this to all checkbox items
2064 in the text below the heading, taking as reference the first item
2065 in subtree, ignoring drawers."
2069 block-item
2070 lim-up
2071 lim-down
2074 ;; In a region, start at first item in region
2084 ;; On an heading, start at first item after drawers
2093 ;; Just one item: set singlep flag
2099 ;; Determine the checkbox going to be applied to all items
2100 ;; within bounds
2111 ;; When an item is found within bounds, grab the full list at
2112 ;; point structure, then: 1. set checkbox of all its items
2113 ;; within bounds to ref-checkbox; 2. fix checkboxes of the whole
2114 ;; list; 3. move point after the list.
2128 e struct
2129 ;; if there is no box at item, leave as-is
2130 ;; unless function was called with C-u prefix
2133 ref-checkbox
2134 cur-box))))
2135 items-to-toggle)
2137 struct parents prevs orderedp))
2138 ;; Report some problems due to ORDERED status of subtree. If
2139 ;; only one box was being checked, throw an error, else,
2140 ;; only signal problems.
2144 "Checkbox blocked because of unchecked box at line %d"
2148 "Checkboxes were removed due to unchecked box at line %d"
2155 "Reset all checkboxes in an entry subtree."
2170 "Update the checkbox statistics in the current section.
2171 This will find all statistic cookies like [57%] and [6/12] and
2172 update them with the current numbers.
2174 With optional prefix argument ALL, do this for the whole buffer."
2178 (box-re "^[ \t]*\\([-+*]\\|\\([0-9]+\\|[A-Za-z]\\)[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
2190 ;; Return number of checked boxes and boxes of all types
2191 ;; in all structures in STRUCTS. If RECURSIVEP is non-nil,
2192 ;; also count boxes in sub-lists. If ITEM is nil, count
2193 ;; across the whole structure, else count only across
2194 ;; subtree whose ancestor is ITEM.
2211 items))))
2214 structs)
2217 cookies-list structs-bak box-num)
2219 ;; 1. Build an alist for each cookie found within BOUNDS. The
2220 ;; key will be position at beginning of cookie and values
2221 ;; ending position, format of cookie, and a cell whose car is
2222 ;; number of checked boxes to report, and cdr total number of
2223 ;; boxes.
2233 ;; Cookie is at an heading, but specifically for todo,
2234 ;; not for checkboxes: skip it.
2240 ;; Cookie is at an heading, but all lists before next
2241 ;; heading already have been read. Use data collected
2242 ;; in STRUCTS-BAK. This should only happen when heading
2243 ;; has more than one cookie on it.
2246 backup-end))
2248 ;; Cookie is at a fresh heading. Grab structure of
2249 ;; every list containing a checkbox between point and
2250 ;; next headline, and save them in STRUCTS-BAK.
2260 ;; Cookie is at an item, and we already have list
2261 ;; structure stored in STRUCTS-BAK.
2264 ;; Only lists in no special context are stored.
2267 ;; Cookie is at an item, but we need to compute list
2268 ;; structure.
2274 ;; Else, cookie found is at a wrong place. Skip it.
2276 cookies-list))))
2277 ;; 2. Apply alist to buffer, in reverse order so positions stay
2278 ;; unchanged after cookie modifications.
2292 cookies-list))))
2295 "Select the face for checkbox statistics.
2296 The face will be `org-done' when all relevant boxes are checked.
2297 Otherwise it will be `org-todo'."
2300 'org-checkbox-statistics-done
2304 'org-checkbox-statistics-done
2308 "Update checkbox statistics unless turned off by user."
2316 "Indent a local list item including its children.
2317 When number ARG is a negative, item will be outdented, otherwise
2318 it will be indented.
2320 If a region is active, all items inside will be moved.
2322 If NO-SUBTREE is non-nil, only indent the item itself, not its
2323 children.
2325 STRUCT is the list structure.
2327 Return t if successful."
2336 ;; Are we going to move the whole list?
2343 t))))
2344 ;; Determine begin and end points of zone to indent. If moving
2345 ;; more than one item, save them for subsequent moves.
2361 ;; Special case: moving top-item with indent rule
2369 ;; Change bullet if necessary
2375 ;; Shift every item by OFFSET and fix bullets. Then
2376 ;; apply changes to buffer.
2380 struct)
2383 ;; Forbidden move:
2385 ;; If only one item is moved, it mustn't have a child
2389 ;; If a subtree or region is moved, the last item
2390 ;; of the subtree mustn't have a child
2395 struct)))))
2398 ;; Normal shifting
2406 t)
2409 "Outdent a local list item, but not its children.
2410 If a region is active, all items inside will be moved."
2418 "Indent a local list item, but not its children.
2419 If a region is active, all items inside will be moved."
2427 "Outdent a local list item including its children.
2428 If a region is active, all items inside will be moved."
2442 "Indent a local list item including its children.
2443 If a region is active, all items inside will be moved."
2458 "Cycle levels of indentation of an empty item.
2459 The first run indents the item, if applicable. Subsequents runs
2460 outdent it at meaningful levels in the list. When done, item is
2461 put back at its original position with its original bullet.
2463 Return t at each successful move."
2469 ;; Accept empty items or if cycle has already started.
2480 ;; When in the middle of the cycle, try to outdent first. If it
2481 ;; fails, and point is still at initial position, indent. Else,
2482 ;; go back to original position.
2491 ;; Break cycle
2493 ;; If a cycle is starting, remember indentation and bullet,
2494 ;; then try to indent. If it fails, try to outdent.
2500 t))))
2503 "Sort list items.
2504 The cursor may be at any item of the list that should be sorted.
2505 Sublists are not sorted. Checkboxes, if any, are ignored.
2507 Sorting can be alphabetically, numerically, by date/time as given by
2508 a time stamp, by a property or by priority.
2510 Comparing entries ignores case by default. However, with an
2511 optional argument WITH-CASE, the sorting considers case as well.
2513 The command prompts for the sorting type unless it has been given
2514 to the function through the SORTING-TYPE argument, which needs to
2515 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
2516 meaning of each character:
2518 n Numerically, by converting the beginning of the item to a number.
2519 a Alphabetically. Only the first line of item is checked.
2520 t By date/time, either the first active time stamp in the entry, if
2521 any, or by the first inactive one. In a timer list, sort the timers.
2523 Capital letters will reverse the sort order.
2525 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a
2526 function to be called with point at the beginning of the record.
2527 It must return either a string or a number that should serve as
2528 the sorting key for that record. It will then use COMPARE-FUNC to
2529 compare entries."
2574 ;; If it is a timer list, convert timer to seconds
2587 value))
2591 next-record
2592 end-record
2593 value-to-sort
2594 nil
2595 sort-func)
2596 ;; Read and fix list again, as `sort-subr' probably destroyed
2597 ;; its structure.
2603 ;;; Send and receive lists
2606 "Parse the list at point and maybe DELETE it.
2608 Return a list whose car is a symbol of list type, among
2609 `ordered', `unordered' and `descriptive'. Then, each item is a
2610 list whose car is counter, and cdr are strings and other
2614 For example, the following list:
2616 1. first item
2617 + sub-item one
2618 + [X] sub-item two
2619 more text in first item
2620 2. [@3] last item
2622 will be parsed as:
2624 \(ordered
2626 \(unordered
2632 Point is left at list end."
2638 out
2639 parse-item ; for byte-compiler
2642 ;; Return text between BEG and END, trimmed, with
2643 ;; checkboxes replaced.
2650 text)))))
2653 ;; Return a list whose car is list type and cdr a list of
2654 ;; items' body.
2660 ;; Return a list containing counter of item, if any, text
2661 ;; and any sublist inside it.
2667 ;; Get counter number. For alphabetic counter, get
2668 ;; its position in the alphabet.
2679 ;; If item has a child, store text between bullet and
2680 ;; next child, then recursively parse all sublists. At
2681 ;; the end of each sublist, check for the presence of
2682 ;; text belonging to the original item.
2692 ;; Remove children from the list just parsed.
2694 ;; There is a chunk of text belonging to the
2695 ;; item if last child doesn't end where next
2696 ;; child starts or where item ends.
2700 body))))
2703 ;; Store output, take care of cursor position and deletion of
2704 ;; list, then return output.
2712 out))
2715 "Convert the plain list at point into a subtree."
2723 "Insert a radio list template appropriate for this major mode."
2727 name pos)
2738 "Send a transformed version of this list to the receiver position.
2739 With argument MAYBE, fail quietly if no transformation is defined for
2740 this list."
2746 (unless (looking-at "[ \t]*#\\+ORGLST[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
2765 beg txt)
2769 ;; Find the insertion place
2774 name
2788 "Convert a LIST parsed through `org-list-parse-list' to other formats.
2789 Valid parameters PARAMS are
2791 :ustart String to start an unordered list
2792 :uend String to end an unordered list
2794 :ostart String to start an ordered list
2795 :oend String to end an ordered list
2797 :dstart String to start a descriptive list
2798 :dend String to end a descriptive list
2799 :dtstart String to start a descriptive term
2800 :dtend String to end a descriptive term
2801 :ddstart String to start a description
2802 :ddend String to end a description
2804 :splice When set to t, return only list body lines, don't wrap
2805 them into :[u/o]start and :[u/o]end. Default is nil.
2807 :istart String to start a list item.
2808 :icount String to start an item with a counter.
2809 :iend String to end a list item
2810 :isep String to separate items
2811 :lsep String to separate sublists
2812 :csep String to separate text from a sub-list
2814 :cboff String to insert for an unchecked checkbox
2815 :cbon String to insert for a checked checkbox
2817 Alternatively, each parameter can also be a form returning a
2818 string. These sexp can use keywords `counter' and `depth',
2819 reprensenting respectively counter associated to the current
2820 item, and depth of the current sub-list, starting at 0.
2821 Obviously, `counter' is only available for parameters applying to
2822 items."
2844 export-sublist ; for byte-compiler
2847 ;; Export an item ITEM of type TYPE, at DEPTH. First string
2848 ;; in item is treated in a special way as it can bring
2849 ;; extra information that needs to be processed.
2861 ;; Replace checkbox if any is found.
2869 ;; Insert descriptive term if TYPE is `descriptive'.
2884 ;; Export sublist SUB at DEPTH
2902 "Convert LIST into a LaTeX list.
2903 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2904 with overruling parameters for `org-list-to-generic'."
2906 list
2916 enum counter)
2920 params)))
2923 "Convert LIST into a HTML list.
2924 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2925 with overruling parameters for `org-list-to-generic'."
2927 list
2938 params)))
2941 "Convert LIST into a Texinfo list.
2942 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2943 with overruling parameters for `org-list-to-generic'."
2945 list
2955 params)))
2958 "Convert LIST into an Org subtree.
2959 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
2960 with overruling parameters for `org-list-to-generic'."
2970 ;; Return the string for the heading, depending on depth D
2971 ;; of current sub-list.
2976 ?*)
2979 list
2981 '(:splice t
2988 params))))
2992 ;; arch-tag: 73cf50c1-200f-4d1d-8a53-4e842a5b11c8
2993 ;;; org-list.el ends here