mirror/org-mode
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs/org-mode.git synced 2024-11-30 08:08:26 +00:00
Code
504b497b7f
org-mode/lisp/org-list.el

2748 lines
100 KiB
EmacsLisp
Raw Blame History

;;; org-list.el --- Plain lists for Org-mode
;;
;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010
;; Free Software Foundation, Inc.
;;
;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Bastien Guerry <bzg AT altern DOT org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
;; Version: 7.4
;;
;; This file is part of GNU Emacs.
;;
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;
;;; Commentary:
;; This file contains the code dealing with plain lists in Org-mode.
;; The fundamental idea behind lists work is to use structures. A
;; structure is a snapshot of the list, in the shape of data tree (see
;; `org-list-struct').
;; Once the list structure is stored, it is possible to make changes
;; directly on it or get useful information on the list, with helper
;; functions `org-list-struct-parent-alist' and
;; `org-list-struct-prev-alist', and using accessors provided in the
;; file.
;; Structure is repaired with `org-list-struct-fix-struct'. Then
;; changes are applied to buffer with `org-list-struct-apply-struct'.
;; So any function working on plain lists should follow this template:
;; 1. Verify point is in a list and grab item beginning (with the same
;; function `org-in-item-p') ;
;; 2. Get list structure ;
;; 3. Compute one, or both, helper functions depending on required
;; accessors ;
;; 4. Proceed with the modifications ;
;; 5. Then fix the structure one last time and apply it on buffer.
;; It is usally a bad idea to use directly an interactive function
;; inside a function, as those read the whole list structure another
;; time.
;;; Code:
(eval-when-compile
(require 'cl))
(require 'org-macs)
(require 'org-compat)
(defvar org-blank-before-new-entry)
(defvar org-M-RET-may-split-line)
(defvar org-complex-heading-regexp)
(defvar org-odd-levels-only)
(defvar org-outline-regexp)
(defvar org-ts-regexp)
(defvar org-ts-regexp-both)
(declare-function org-at-heading-p "org" (&optional ignored))
(declare-function org-back-over-empty-lines "org" ())
(declare-function org-back-to-heading "org" (&optional invisible-ok))
(declare-function org-combine-plists "org" (&rest plists))
(declare-function org-entry-get "org"
(pom property &optional inherit literal-nil))
(declare-function org-get-indentation "org" (&optional line))
(declare-function org-icompleting-read "org" (&rest args))
(declare-function org-in-regexps-block-p "org"
(start-re end-re &optional bound))
(declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
(declare-function org-inlinetask-goto-end "org-inlinetask" ())
(declare-function org-inlinetask-in-task-p "org-inlinetask" ())
(declare-function org-invisible-p "org" ())
(declare-function org-level-increment "org" ())
(declare-function org-narrow-to-subtree "org" ())
(declare-function org-on-heading-p "org" (&optional invisible-ok))
(declare-function org-remove-if "org" (predicate seq))
(declare-function org-show-subtree "org" ())
(declare-function org-time-string-to-seconds "org" (s))
(declare-function org-timer-hms-to-secs "org-timer" (hms))
(declare-function org-timer-item "org-timer" (&optional arg))
(declare-function org-trim "org" (s))
(declare-function org-uniquify "org" (list))
(declare-function outline-next-heading "outline" ())
(declare-function outline-previous-heading "outline" ())
(defgroup org-plain-lists nil
"Options concerning plain lists in Org-mode."
:tag "Org Plain lists"
:group 'org-structure)
(defcustom org-cycle-include-plain-lists t
"When t, make TAB cycle visibility on plain list items.
Cycling plain lists works only when the cursor is on a plain list
item. When the cursor is on an outline heading, plain lists are
treated as text. This is the most stable way of handling this,
which is why it is the default.
When this is the symbol `integrate', then during cycling, plain
list items will *temporarily* be interpreted as outline headlines
with a level given by 1000+i where i is the indentation of the
bullet. This setting can lead to strange effects when switching
visibility to `children', because the first \"child\" in a
subtree decides what children should be listed. If that first
\"child\" is a plain list item with an implied large level
number, all true children and grand children of the outline
heading will be exposed in a children' view."
:group 'org-plain-lists
:type '(choice
(const :tag "Never" nil)
(const :tag "With cursor in plain list (recommended)" t)
(const :tag "As children of outline headings" integrate)))
(defcustom org-list-demote-modify-bullet nil
"Default bullet type installed when demoting an item.
This is an association list, for each bullet type, this alist will point
to the bullet that should be used when this item is demoted.
For example,
(setq org-list-demote-modify-bullet
'((\"+\" . \"-\") (\"-\" . \"+\") (\"*\" . \"+\")))
will make
+ Movies
+ Silence of the Lambs
+ My Cousin Vinny
+ Books
+ The Hunt for Red October
+ The Road to Omaha
into
+ Movies
- Silence of the Lambs
- My Cousin Vinny
+ Books
- The Hunt for Red October
- The Road to Omaha"
:group 'org-plain-lists
:type '(repeat
(cons
(choice :tag "If the current bullet is "
(const "-")
(const "+")
(const "*")
(const "1.")
(const "1)"))
(choice :tag "demotion will change it to"
(const "-")
(const "+")
(const "*")
(const "1.")
(const "1)")))))
(defcustom org-plain-list-ordered-item-terminator t
"The character that makes a line with leading number an ordered list item.
Valid values are ?. and ?\). To get both terminators, use t. While
?. may look nicer, it creates the danger that a line with leading
number may be incorrectly interpreted as an item. ?\) therefore is
the safe choice."
:group 'org-plain-lists
:type '(choice (const :tag "dot like in \"2.\"" ?.)
(const :tag "paren like in \"2)\"" ?\))
(const :tab "both" t)))
(defcustom org-list-two-spaces-after-bullet-regexp nil
"A regular expression matching bullets that should have 2 spaces after them.
When nil, no bullet will have two spaces after them.
When a string, it will be used as a regular expression. When the
bullet type of a list is changed, the new bullet type will be
matched against this regexp. If it matches, there will be two
spaces instead of one after the bullet in each item of the list."
:group 'org-plain-lists
:type '(choice
(const :tag "never" nil)
(regexp)))
(defcustom org-list-ending-method 'both
"Determine where plain lists should end.
Valid values are: `regexp', `indent' or `both'.
When set to `regexp', Org will look into two variables,
`org-empty-line-terminates-plain-lists' and the more general
`org-list-end-regexp', to determine what will end lists.
When set to `indent', a list will end whenever a line following
an item, but not starting one, is less or equally indented than
the first item of the list.
When set to `both', each of the preceding methods is applied to
determine lists endings. This is the default method."
:group 'org-plain-lists
:type '(choice
(const :tag "With a regexp defining ending" regexp)
(const :tag "With indentation of regular (no bullet) text" indent)
(const :tag "With both methods" both)))
(defcustom org-empty-line-terminates-plain-lists nil
"Non-nil means an empty line ends all plain list levels.
This variable only makes sense if `org-list-ending-method' is set
to `regexp' or `both'. This is then equivalent to set
`org-list-end-regexp' to \"^[ \\t]*$\"."
:group 'org-plain-lists
:type 'boolean)
(defcustom org-list-end-regexp "^[ \t]*\n[ \t]*\n"
"Regexp matching the end of all plain list levels.
It must start with \"^\" and end with \"\\n\". It defaults to 2
blank lines. `org-empty-line-terminates-plain-lists' has
precedence over it."
:group 'org-plain-lists
:type 'string)
(defcustom org-list-automatic-rules '((bullet . t)
(checkbox . t)
(indent . t)
(insert . t))
"Non-nil means apply set of rules when acting on lists.
By default, automatic actions are taken when using
\\[org-meta-return], \\[org-metaright], \\[org-metaleft],
\\[org-shiftmetaright], \\[org-shiftmetaleft],
\\[org-ctrl-c-minus], \\[org-toggle-checkbox] or
\\[org-insert-todo-heading]. You can disable individually these
rules by setting them to nil. Valid rules are:
bullet when non-nil, cycling bullet do not allow lists at
column 0 to have * as a bullet and descriptions lists
to be numbered.
checkbox when non-nil, checkbox statistics is updated each time
you either insert a new checkbox or toggle a checkbox.
It also prevents from inserting a checkbox in a
description item.
indent when non-nil, indenting or outdenting list top-item
with its subtree will move the whole list and
outdenting a list whose bullet is * to column 0 will
change that bullet to -
insert when non-nil, trying to insert an item inside a block
will insert it right before the block instead of
throwing an error."
:group 'org-plain-lists
:type '(alist :tag "Sets of rules"
:key-type
(choice
(const :tag "Bullet" bullet)
(const :tag "Checkbox" checkbox)
(const :tag "Indent" indent)
(const :tag "Insert" insert))
:value-type
(boolean :tag "Activate" :value t)))
(defcustom org-hierarchical-checkbox-statistics t
"Non-nil means checkbox statistics counts only the state of direct children.
When nil, all boxes below the cookie are counted.
This can be set to nil on a per-node basis using a COOKIE_DATA property
with the word \"recursive\" in the value."
:group 'org-plain-lists
:type 'boolean)
(defcustom org-description-max-indent 20
"Maximum indentation for the second line of a description list.
When the indentation would be larger than this, it will become
5 characters instead."
:group 'org-plain-lists
:type 'integer)
(defcustom org-list-radio-list-templates
'((latex-mode "% BEGIN RECEIVE ORGLST %n
% END RECEIVE ORGLST %n
\\begin{comment}
#+ORGLST: SEND %n org-list-to-latex
-
\\end{comment}\n")
(texinfo-mode "@c BEGIN RECEIVE ORGLST %n
@c END RECEIVE ORGLST %n
@ignore
#+ORGLST: SEND %n org-list-to-texinfo
-
@end ignore\n")
(html-mode "<!-- BEGIN RECEIVE ORGLST %n -->
<!-- END RECEIVE ORGLST %n -->
<!--
#+ORGLST: SEND %n org-list-to-html
-
-->\n"))
"Templates for radio lists in different major modes.
All occurrences of %n in a template will be replaced with the name of the
list, obtained by prompting the user."
:group 'org-plain-lists
:type '(repeat
(list (symbol :tag "Major mode")
(string :tag "Format"))))
;;; Internal functions
(defconst org-list-blocks '("EXAMPLE" "VERSE" "SRC")
"Names of blocks where lists are not allowed.")
(defun org-list-end-re ()
"Return the regex corresponding to the end of a list.
It depends on `org-empty-line-terminates-plain-lists'."
(if org-empty-line-terminates-plain-lists
"^[ \t]*\n"
org-list-end-regexp))
(defun org-item-re (&optional general)
"Return the correct regular expression for plain lists.
If GENERAL is non-nil, return the general regexp independent of the value
of `org-plain-list-ordered-item-terminator'."
(cond
((or general (eq org-plain-list-ordered-item-terminator t))
"\\([ \t]*\\([-+]\\|\\([0-9]+[.)]\\)\\)\\|[ \t]+\\*\\)\\([ \t]+\\|$\\)")
((= org-plain-list-ordered-item-terminator ?.)
"\\([ \t]*\\([-+]\\|\\([0-9]+\\.\\)\\)\\|[ \t]+\\*\\)\\([ \t]+\\|$\\)")
((= org-plain-list-ordered-item-terminator ?\))
"\\([ \t]*\\([-+]\\|\\([0-9]+)\\)\\)\\|[ \t]+\\*\\)\\([ \t]+\\|$\\)")
(t (error "Invalid value of `org-plain-list-ordered-item-terminator'"))))
(defconst org-item-beginning-re (concat "^" (org-item-re))
"Regexp matching the beginning of a plain list item.")
(defconst org-list-full-item-re
(concat "^[ \t]*\\(\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\)"
"\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\)\\]\\)?"
"\\(?:\\(\\[[ X-]\\]\\)[ \t]+\\)?"
"\\(?:\\(.*\\)[ \t]+::[ \t]+\\)?")
"Matches a list item and puts everything into groups:
group 1: bullet
group 2: counter
group 3: checkbox
group 4: description tag")
(defun org-list-context ()
"Determine context, and its boundaries, around point.
Context is determined by reading `org-context' text property if
applicable, or looking at Org syntax around.
Context will be an alist like (MIN MAX CONTEXT) where MIN and MAX
are boundaries and CONTEXT is a symbol among nil, `drawer',
`block', `invalid' and `inlinetask'.
Symbols `block' and `invalid' refer to `org-list-blocks'."
(save-match-data
(let* ((origin (point))
(context-prop (get-text-property origin 'org-context)))
(if context-prop
(list
(or (previous-single-property-change
(min (1+ (point)) (point-max)) 'org-context) (point-min))
(or (next-single-property-change origin 'org-context) (point-max))
(cond
((equal (downcase context-prop) "inlinetask") 'inlinetask)
((member (upcase context-prop) org-list-blocks) 'invalid)
(t 'block)))
(save-excursion
(beginning-of-line)
(let* ((outline-regexp (org-get-limited-outline-regexp))
;; can't use org-drawers-regexp as this function might be
;; called in buffers not in Org mode
(drawers-re (concat "^[ \t]*:\\("
(mapconcat 'regexp-quote org-drawers "\\|")
"\\):[ \t]*$"))
(case-fold-search t)
;; compute position of surrounding headings. this is the
;; default context.
(heading
(save-excursion
(list
(or (and (org-at-heading-p) (point-at-bol))
(outline-previous-heading)
(point-min))
(or (outline-next-heading)
(point-max))
nil)))
(prev-head (car heading))
(next-head (nth 1 heading))
;; Are we strictly inside a drawer?
(drawerp
(when (and (org-in-regexps-block-p
drawers-re "^[ \t]*:END:" prev-head)
(save-excursion
(beginning-of-line)
(and (not (looking-at drawers-re))
(not (looking-at "^[ \t]*:END:")))))
(save-excursion
(list
(progn
(re-search-backward drawers-re prev-head t)
(1+ (point-at-eol)))
(if (re-search-forward "^[ \t]*:END:" next-head t)
(1- (point-at-bol))
next-head)
'drawer))))
;; Are we strictly in a block, and of which type?
(blockp
(save-excursion
(when (and (org-in-regexps-block-p
"^[ \t]*#\\+begin_" "^[ \t]*#\\+end_" prev-head)
(save-excursion
(beginning-of-line)
(not (looking-at
"^[ \t]*#\\+\\(begin\\|end\\)_"))))
(list
(progn
(re-search-backward
"^[ \t]*#\\+begin_\\(\\S-+\\)" prev-head t)
(1+ (point-at-eol)))
(save-match-data
(if (re-search-forward "^[ \t]*#\\+end_" next-head t)
(1- (point-at-bol))
next-head))
(if (member (upcase (match-string 1)) org-list-blocks)
'invalid
'block)))))
;; Are we in an inlinetask?
(inlinetaskp
(when (and (featurep 'org-inlinetask)
(org-inlinetask-in-task-p)
(not (looking-at "^\\*+")))
(save-excursion
(list
(progn (org-inlinetask-goto-beginning)
(1+ (point-at-eol)))
(progn
(org-inlinetask-goto-end)
(forward-line -1)
(1- (point-at-bol)))
'inlinetask))))
;; list actual candidates
(context-list
(delq nil (list heading drawerp blockp inlinetaskp))))
;; Return the closest context around
(assq (apply 'max (mapcar 'car context-list)) context-list)))))))
(defun org-list-search-unenclosed-generic (search re bound noerr)
"Search a string outside blocks and protected places.
Arguments SEARCH, RE, BOUND and NOERR are similar to those in
`search-forward', `search-backward', `re-search-forward' and
`re-search-backward'."
(catch 'exit
(let ((origin (point)))
(while t
;; 1. No match: return to origin or bound, depending on NOERR.
(unless (funcall search re bound noerr)
(throw 'exit (and (goto-char (if (memq noerr '(t nil)) origin bound))
nil)))
;; 2. Match not in block or protected: return point. Else
;; skip the block and carry on.
(unless (or (get-text-property (match-beginning 0) 'org-protected)
(org-list-maybe-skip-block search bound))
(throw 'exit (point)))))))
(defun org-search-backward-unenclosed (regexp &optional bound noerror)
"Like `re-search-backward' but don't stop inside blocks or protected places.
Arguments REGEXP, BOUND and NOERROR are similar to those used in
`re-search-backward'."
(org-list-search-unenclosed-generic
#'re-search-backward regexp (or bound (point-min)) noerror))
(defun org-search-forward-unenclosed (regexp &optional bound noerror)
"Like `re-search-forward' but don't stop inside blocks or protected places.
Arguments REGEXP, BOUND and NOERROR are similar to those used in
`re-search-forward'."
(org-list-search-unenclosed-generic
#'re-search-forward regexp (or bound (point-max)) noerror))
(defun org-list-at-regexp-after-bullet-p (regexp)
"Is point at a list item with REGEXP after bullet?"
(and (org-at-item-p)
(save-excursion
(goto-char (match-end 0))
;; Ignore counter if any
(when (looking-at "\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?")
(goto-char (match-end 0)))
(looking-at regexp))))
(defun org-list-separating-blank-lines-number (pos struct prevs)
"Return number of blank lines that should separate items in list.
POS is the position at item beginning to be considered. STRUCT is
the list structure. PREVS is the alist of previous items. See
`org-list-struct-prev-alist'.
Assume point is at item's beginning. If the item is alone, apply
some heuristics to guess the result."
(save-excursion
(let ((insert-blank-p
(cdr (assq 'plain-list-item org-blank-before-new-entry)))
usr-blank)
(cond
;; Trivial cases where there should be none.
((or (and (not (eq org-list-ending-method 'indent))
org-empty-line-terminates-plain-lists)
(not insert-blank-p)) 0)
;; When `org-blank-before-new-entry' says so, it is 1.
((eq insert-blank-p t) 1)
;; plain-list-item is 'auto. Count blank lines separating
;; neighbours items in list.
(t (let ((next-p (org-list-get-next-item (point) struct prevs)))
(cond
;; Is there a next item?
(next-p (goto-char next-p)
(org-back-over-empty-lines))
;; Is there a previous item?
((org-list-get-prev-item (point) struct prevs)
(org-back-over-empty-lines))
;; User inserted blank lines, trust him
((and (> pos (org-list-get-item-end-before-blank pos struct))
(> (save-excursion
(goto-char pos)
(skip-chars-backward " \t")
(setq usr-blank (org-back-over-empty-lines))) 0))
usr-blank)
;; Are there blank lines inside the item ?
((save-excursion
(org-search-forward-unenclosed
"^[ \t]*$" (org-list-get-item-end-before-blank pos struct) t))
1)
;; No parent: no blank line.
(t 0))))))))
(defun org-list-insert-item-generic (pos &optional checkbox after-bullet)
"Insert a new list item at POS.
If POS is before first character after bullet of the item, the
new item will be created before the current one.
Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
after the bullet. Cursor will be after this text once the
function ends."
(let ((case-fold-search t))
(goto-char pos)
;; 1. Check if a new item can be inserted at point: are we in an
;; invalid block ? Move outside it if `org-list-automatic'
;; rules says so.
(when (or (eq (nth 2 (org-list-context)) 'invalid)
(save-excursion
(beginning-of-line)
(or (looking-at "^[ \t]*#\\+\\(begin\\|end\\)_")
(looking-at (concat
"\\("
org-drawer-regexp
"\\|^[ \t]*:END:[ \t]*$\\)"))
(and (featurep 'org-inlinetask)
(looking-at (org-inlinetask-outline-regexp))))))
(if (not (cdr (assq 'insert org-list-automatic-rules)))
(error "Cannot insert item inside a block")
(end-of-line)
(if (string-match "^\\*+[ \t]+" (match-string 0))
(org-inlinetask-goto-beginning)
(let ((block-start (if (string-match "#\\+" (match-string 0))
"^[ \t]*#\\+begin_"
org-drawer-regexp)))
(re-search-backward block-start nil t)))
(end-of-line 0)))
;; 2. Get information about list: structure, usual helper
;; functions, position of point with regards to item start
;; (BEFOREP), blank lines number separating items (BLANK-NB),
;; position of split (POS) if we're allowed to (SPLIT-LINE-P).
(let* ((pos (point))
(item (goto-char (org-get-item-beginning)))
(struct (org-list-struct))
(prevs (org-list-struct-prev-alist struct))
(item-end (org-list-get-item-end item struct))
(item-end-no-blank (org-list-get-item-end-before-blank item struct))
(beforep (and (looking-at org-list-full-item-re)
(<= pos (match-end 0))))
(split-line-p (org-get-alist-option org-M-RET-may-split-line 'item))
(blank-nb (org-list-separating-blank-lines-number
item struct prevs))
;; 3. Build the new item to be created. Concatenate same
;; bullet as item, checkbox, text AFTER-BULLET if
;; provided, and text cut from point to end of item
;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
;; BEFOREP and SPLIT-LINE-P. The difference of size
;; between what was cut and what was inserted in buffer
;; is stored in SIZE-OFFSET.
(ind (org-list-get-ind item struct))
(bullet (org-list-bullet-string (org-list-get-bullet item struct)))
(box (when checkbox "[ ]"))
(text-cut
(and (not beforep) split-line-p
(progn
(goto-char pos)
(skip-chars-backward " \r\t\n")
(setq pos (point))
(delete-and-extract-region pos item-end-no-blank))))
(body (concat bullet (when box (concat box " ")) after-bullet
(or (and text-cut
(if (string-match "\\`[ \t]+" text-cut)
(replace-match "" t t text-cut)
text-cut))
"")))
(item-sep (make-string (1+ blank-nb) ?\n))
(item-size (+ ind (length body) (length item-sep)))
(size-offset (- item-size (length text-cut))))
;; 4. Insert effectively item into buffer
(goto-char item)
(org-indent-to-column ind)
(insert body)
(insert item-sep)
;; 5. Add new item to STRUCT.
(mapc (lambda (e)
(let ((p (car e))
(end (nth 6 e)))
(cond
;; Before inserted item, positions don't change but
;; an item ending after insertion has its end shifted
;; by SIZE-OFFSET.
((< p item)
(when (> end item) (setcar (nthcdr 6 e) (+ end size-offset))))
;; Trivial cases where current item isn't split in
;; two. Just shift every item after new one by
;; ITEM-SIZE.
((or beforep (not split-line-p))
(setcar e (+ p item-size))
(setcar (nthcdr 6 e) (+ end item-size)))
;; Item is split in two: elements before POS are just
;; shifted by ITEM-SIZE. In the case item would end
;; after split POS, ending is only shifted by
;; SIZE-OFFSET.
((< p pos)
(setcar e (+ p item-size))
(if (< end pos)
(setcar (nthcdr 6 e) (+ end item-size))
(setcar (nthcdr 6 e) (+ end size-offset))))
;; Elements after POS are moved into new item. Length
;; of ITEM-SEP has to be removed as ITEM-SEP
;; doesn't appear in buffer yet.
((< p item-end)
(setcar e (+ p size-offset (- item pos (length item-sep))))
(if (= end item-end)
(setcar (nthcdr 6 e) (+ item item-size))
(setcar (nthcdr 6 e)
(+ end size-offset
(- item pos (length item-sep))))))
;; Elements at ITEM-END or after are only shifted by
;; SIZE-OFFSET.
(t (setcar e (+ p size-offset))
(setcar (nthcdr 6 e) (+ end size-offset))))))
struct)
(setq struct (sort
(cons (list item ind bullet nil box nil (+ item item-size))
struct)
(lambda (e1 e2) (< (car e1) (car e2)))))
;; 6. If not BEFOREP, new item must appear after ITEM, so
;; exchange ITEM with the next item in list. Position cursor
;; after bullet, counter, checkbox, and label.
(if beforep
(goto-char item)
(setq struct (org-list-exchange-items item (+ item item-size) struct))
(goto-char (org-list-get-next-item
item struct (org-list-struct-prev-alist struct))))
(org-list-struct-fix-struct struct (org-list-struct-parent-alist struct))
(when checkbox (org-update-checkbox-count-maybe))
(looking-at org-list-full-item-re)
(goto-char (match-end 0))
t)))
(defvar org-last-indent-begin-marker (make-marker))
(defvar org-last-indent-end-marker (make-marker))
(defun org-list-indent-item-generic (arg no-subtree struct)
"Indent a local list item including its children.
When number ARG is a negative, item will be outdented, otherwise
it will be indented.
If a region is active, all items inside will be moved.
If NO-SUBTREE is non-nil, only indent the item itself, not its
children.
STRUCT is the list structure. Return t if successful."
(save-excursion
(beginning-of-line)
(let* ((regionp (org-region-active-p))
(rbeg (and regionp (region-beginning)))
(rend (and regionp (region-end)))
(top (org-list-get-top-point struct))
(parents (org-list-struct-parent-alist struct))
(prevs (org-list-struct-prev-alist struct))
;; Are we going to move the whole list?
(specialp
(and (= top (point))
(cdr (assq 'indent org-list-automatic-rules))
(if no-subtree
(error
"First item of list cannot move without its subtree")
t))))
;; Determine begin and end points of zone to indent. If moving
;; more than one item, save them for subsequent moves.
(unless (and (memq last-command '(org-shiftmetaright org-shiftmetaleft))
(memq this-command '(org-shiftmetaright org-shiftmetaleft)))
(if regionp
(progn
(set-marker org-last-indent-begin-marker rbeg)
(set-marker org-last-indent-end-marker rend))
(set-marker org-last-indent-begin-marker (point))
(set-marker org-last-indent-end-marker
(cond
(specialp (org-list-get-bottom-point struct))
(no-subtree (1+ (point)))
(t (org-list-get-item-end (point) struct))))))
(let* ((beg (marker-position org-last-indent-begin-marker))
(end (marker-position org-last-indent-end-marker)))
(cond
;; Special case: moving top-item with indent rule
(specialp
(let* ((level-skip (org-level-increment))
(offset (if (< arg 0) (- level-skip) level-skip))
(top-ind (org-list-get-ind beg struct))
(old-struct (mapcar (lambda (e) (copy-alist e)) struct)))
(if (< (+ top-ind offset) 0)
(error "Cannot outdent beyond margin")
;; Change bullet if necessary
(when (and (= (+ top-ind offset) 0)
(string-match "*"
(org-list-get-bullet beg struct)))
(org-list-set-bullet beg struct
(org-list-bullet-string "-")))
;; Shift every item by OFFSET and fix bullets. Then
;; apply changes to buffer.
(mapc (lambda (e)
(let ((ind (org-list-get-ind (car e) struct)))
(org-list-set-ind (car e) struct (+ ind offset))))
struct)
(org-list-struct-fix-bul struct prevs)
(org-list-struct-apply-struct struct old-struct))))
;; Forbidden move:
((and (< arg 0)
;; If only one item is moved, it mustn't have a child
(or (and no-subtree
(not regionp)
(org-list-has-child-p beg struct))
;; If a subtree or region is moved, the last item
;; of the subtree mustn't have a child
(let ((last-item (caar
(reverse
(org-remove-if
(lambda (e) (>= (car e) end))
struct)))))
(org-list-has-child-p last-item struct))))
(error "Cannot outdent an item without its children"))
;; Normal shifting
(t
(let* ((new-parents
(if (< arg 0)
(org-list-struct-outdent beg end struct parents)
(org-list-struct-indent beg end struct parents prevs))))
(org-list-struct-fix-struct struct new-parents))
(org-update-checkbox-count-maybe))))))
t)
;;; Predicates
(defun org-in-item-p ()
"Return item beginning position when in a plain list, nil otherwise.
This checks `org-list-ending-method'."
(save-excursion
(beginning-of-line)
(unless (or (let ((outline-regexp org-outline-regexp)) (org-at-heading-p))
(and (not (eq org-list-ending-method 'indent))
(looking-at (org-list-end-re))
(progn (forward-line -1) (looking-at (org-list-end-re)))))
(or (and (org-at-item-p) (point-at-bol))
(let* ((case-fold-search t)
(context (org-list-context))
(lim-up (car context))
(inlinetask-re (and (featurep 'org-inlinetask)
(org-inlinetask-outline-regexp)))
(ind-ref (if (looking-at "^[ \t]*$")
10000
(org-get-indentation))))
(catch 'exit
(while t
(let ((ind (org-get-indentation)))
(cond
((<= (point) lim-up)
(throw 'exit (and (org-at-item-p) (< ind ind-ref) (point))))
((and (not (eq org-list-ending-method 'indent))
(looking-at (org-list-end-re)))
(throw 'exit nil))
;; Skip blocks, drawers, inline-tasks, blank lines
((looking-at "^[ \t]*#\\+end_")
(re-search-backward "^[ \t]*#\\+begin_" nil t))
((looking-at "^[ \t]*:END:")
(re-search-backward org-drawer-regexp nil t)
(beginning-of-line))
((and inlinetask-re (looking-at inlinetask-re))
(org-inlinetask-goto-beginning)
(forward-line -1))
((looking-at "^[ \t]*$")
(forward-line -1))
((< ind ind-ref)
(if (org-at-item-p)
(throw 'exit (point))
(setq ind-ref ind)
(forward-line -1)))
(t (if (and (eq org-list-ending-method 'regexp)
(org-at-item-p))
(throw 'exit (point))
(forward-line -1))))))))))))
(defun org-at-item-p ()
"Is point in a line starting a hand-formatted item?"
(save-excursion
(beginning-of-line) (looking-at org-item-beginning-re)))
(defun org-at-item-bullet-p ()
"Is point at the bullet of a plain list item?"
(and (org-at-item-p)
(not (member (char-after) '(?\ ?\t)))
(< (point) (match-end 0))))
(defun org-at-item-timer-p ()
"Is point at a line starting a plain list item with a timer?"
(org-list-at-regexp-after-bullet-p
"\\([0-9]+:[0-9]+:[0-9]+\\)[ \t]+::[ \t]+"))
(defun org-at-item-description-p ()
"Is point at a description list item?"
(org-list-at-regexp-after-bullet-p "\\(\\S-.+\\)[ \t]+::[ \t]+"))
(defun org-at-item-checkbox-p ()
"Is point at a line starting a plain-list item with a checklet?"
(org-list-at-regexp-after-bullet-p "\\(\\[[- X]\\]\\)[ \t]+"))
;;; Navigate
(defalias 'org-list-get-item-begin 'org-in-item-p)
(defun org-beginning-of-item ()
"Go to the beginning of the current hand-formatted item.
If the cursor is not in an item, throw an error."
(interactive)
(let ((begin (org-in-item-p)))
(if begin (goto-char begin) (error "Not in an item"))))
(defun org-beginning-of-item-list ()
"Go to the beginning item of the current list or sublist.
Return an error if not in a list."
(interactive)
(let ((begin (org-in-item-p)))
(if (not begin)
(error "Not in an item")
(goto-char begin)
(let ((struct (org-list-struct)))
(goto-char (org-list-get-list-begin begin (org-list-struct)))))))
(defun org-end-of-item-list ()
"Go to the end of the current list or sublist.
If the cursor in not in an item, throw an error."
(interactive)
(let ((begin (org-in-item-p)))
(if (not begin)
(error "Not in an item")
(goto-char begin)
(let ((struct (org-list-struct)))
(goto-char (org-list-get-list-end begin (org-list-struct)))))))
(defun org-end-of-item ()
"Go to the end of the current hand-formatted item.
If the cursor is not in an item, throw an error."
(interactive)
(let ((begin (org-in-item-p)))
(if (not begin)
(error "Not in an item")
(goto-char begin)
(let ((struct (org-list-struct)))
(goto-char (org-list-get-item-end begin struct))))))
(defun org-previous-item ()
"Move to the beginning of the previous item.
Item is at the same level in the current plain list. Error if not
in a plain list, or if this is the first item in the list."
(interactive)
(let ((begin (org-in-item-p)))
(if (not begin)
(error "Not in an item")
(goto-char begin)
(let* ((struct (org-list-struct))
(prevs (org-list-struct-prev-alist struct))
(prevp (org-list-get-prev-item begin struct prevs)))
(if prevp (goto-char prevp) (error "On first item"))))))
(defun org-next-item ()
"Move to the beginning of the next item.
Item is at the same level in the current plain list. Error if not
in a plain list, or if this is the last item in the list."
(interactive)
(let ((begin (org-in-item-p)))
(if (not begin)
(error "Not in an item")
(goto-char begin)
(let* ((struct (org-list-struct))
(prevs (org-list-struct-prev-alist struct))
(prevp (org-list-get-next-item begin struct prevs)))
(if prevp (goto-char prevp) (error "On last item"))))))
;;; Manipulate
(defun org-list-exchange-items (beg-A beg-B struct)
"Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
Blank lines at the end of items are left in place. Return the new
structure after the changes.
Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
to the same sub-list.
This function modifies STRUCT."
(save-excursion
(let* ((end-A-no-blank (org-list-get-item-end-before-blank beg-A struct))
(end-B-no-blank (org-list-get-item-end-before-blank beg-B struct))
(end-A (org-list-get-item-end beg-A struct))
(end-B (org-list-get-item-end beg-B struct))
(size-A (- end-A-no-blank beg-A))
(size-B (- end-B-no-blank beg-B))
(body-A (buffer-substring beg-A end-A-no-blank))
(body-B (buffer-substring beg-B end-B-no-blank))
(between-A-no-blank-and-B (buffer-substring end-A-no-blank beg-B))
(sub-A (cons beg-A (org-list-get-subtree beg-A struct)))
(sub-B (cons beg-B (org-list-get-subtree beg-B struct))))
;; 1. Move effectively items in buffer.
(goto-char beg-A)
(delete-region beg-A end-B-no-blank)
(insert (concat body-B between-A-no-blank-and-B body-A))
;; 2. Now modify struct. No need to re-read the list, the
;; transformation is just a shift of positions. Some special
;; attention is required for items ending at END-A and END-B
;; as empty spaces are not moved there. In others words, item
;; BEG-A will end with whitespaces that were at the end of
;; BEG-B and the same applies to BEG-B.
(mapc (lambda (e)
(let ((pos (car e)))
(cond
((< pos beg-A))
((memq pos sub-A)
(let ((end-e (nth 6 e)))
(setcar e (+ pos (- end-B-no-blank end-A-no-blank)))
(setcar (nthcdr 6 e)
(+ end-e (- end-B-no-blank end-A-no-blank)))
(when (= end-e end-A) (setcar (nthcdr 6 e) end-B))))
((memq pos sub-B)
(let ((end-e (nth 6 e)))
(setcar e (- (+ pos beg-A) beg-B))
(setcar (nthcdr 6 e) (+ end-e (- beg-A beg-B)))
(when (= end-e end-B)
(setcar (nthcdr 6 e)
(+ beg-A size-B (- end-A end-A-no-blank))))))
((< pos beg-B)
(let ((end-e (nth 6 e)))
(setcar e (+ pos (- size-B size-A)))
(setcar (nthcdr 6 e) (+ end-e (- size-B size-A))))))))
struct)
(sort struct (lambda (e1 e2) (< (car e1) (car e2)))))))
(defun org-move-item-down ()
"Move the plain list item at point down, i.e. swap with following item.
Subitems (items with larger indentation) are considered part of the item,
so this really moves item trees."
(interactive)
(unless (org-at-item-p) (error "Not at an item"))
(let* ((pos (point))
(col (current-column))
(actual-item (point-at-bol))
(struct (org-list-struct))
(prevs (org-list-struct-prev-alist struct))
(next-item (org-list-get-next-item (point-at-bol) struct prevs)))
(if (not next-item)
(progn
(goto-char pos)
(error "Cannot move this item further down"))
(setq struct
(org-list-exchange-items actual-item next-item struct))
;; Use a short variation of `org-list-struct-fix-struct' as
;; there's no need to go through all the steps.
(let ((old-struct (mapcar (lambda (e) (copy-alist e)) struct))
(prevs (org-list-struct-prev-alist struct))
(parents (org-list-struct-parent-alist struct)))
(org-list-struct-fix-bul struct prevs)
(org-list-struct-fix-ind struct parents)
(org-list-struct-apply-struct struct old-struct)
(goto-char (org-list-get-next-item (point-at-bol) struct prevs)))
(org-move-to-column col))))
(defun org-move-item-up ()
"Move the plain list item at point up, i.e. swap with previous item.
Subitems (items with larger indentation) are considered part of the item,
so this really moves item trees."
(interactive)
(unless (org-at-item-p) (error "Not at an item"))
(let* ((pos (point))
(col (current-column))
(actual-item (point-at-bol))
(struct (org-list-struct))
(prevs (org-list-struct-prev-alist struct))
(prev-item (org-list-get-prev-item (point-at-bol) struct prevs)))
(if (not prev-item)
(progn
(goto-char pos)
(error "Cannot move this item further up"))
(setq struct
(org-list-exchange-items prev-item actual-item struct))
;; Use a short variation of `org-list-struct-fix-struct' as
;; there's no need to go through all the steps.
(let ((old-struct (mapcar (lambda (e) (copy-alist e)) struct))
(prevs (org-list-struct-prev-alist struct))
(parents (org-list-struct-parent-alist struct)))
(org-list-struct-fix-bul struct prevs)
(org-list-struct-fix-ind struct parents)
(org-list-struct-apply-struct struct old-struct))
(org-move-to-column col))))
(defun org-insert-item (&optional checkbox)
"Insert a new item at the current level.
If cursor is before first character after bullet of the item, the
new item will be created before the current one.
If CHECKBOX is non-nil, add a checkbox next to the bullet.
Return t when things worked, nil when we are not in an item, or
item is invisible."
(let ((itemp (org-in-item-p)))
(unless (or (not itemp)
(save-excursion
(goto-char itemp)
(org-invisible-p)))
(if (save-excursion
(goto-char itemp)
(org-at-item-timer-p))
;; Timer list: delegate to `org-timer-item'.
(progn (org-timer-item) t)
;; if we're in a description list, ask for the new term.
(let ((desc-text (when (save-excursion
(and (goto-char itemp)
(org-at-item-description-p)))
(concat (read-string "Term: ") " :: "))))
;; Don't insert a checkbox if checkbox rule is applied and it
;; is a description item.
(org-list-insert-item-generic
(point) (and checkbox
(or (not desc-text)
(not (cdr (assq 'checkbox org-list-automatic-rules)))))
desc-text))))))
;;; Structures
(defun org-list-struct ()
"Return structure of list at point.
A list structure is an alist where keys is point at item, and
values are:
1. indentation,
2. bullet with trailing whitespace,
3. bullet counter, if any,
4. checkbox, if any,
5. position at item end,
6. description tag, if any.
Thus the following list, where numbers in parens are
point-at-bol:
- [X] first item (1)
1. sub-item 1 (18)
5. [@5] sub-item 2 (34)
some other text belonging to first item (55)
- last item (97)
+ tag :: description (109)
(131)
will get the following structure:
\(\(1 0 \"- \" nil [X] nil 97)
\(18 2 \"1. \" nil nil nil 34\)
\(34 2 \"5. \" \"5\" nil nil 55\)
\(97 0 \"- \" nil nil nil 131\)
\(109 2 \"+ \" nil nil \"tag\" 131\)
Assume point is at an item."
(save-excursion
(beginning-of-line)
(let* ((case-fold-search t)
(context (org-list-context))
(lim-up (car context))
(lim-down (nth 1 context))
(text-min-ind 10000)
(drawers-re (concat "^[ \t]*:\\("
(mapconcat 'regexp-quote org-drawers "\\|")
"\\):[ \t]*$"))
(inlinetask-re (and (featurep 'org-inlinetask)
(org-inlinetask-outline-regexp)))
(beg-cell (cons (point) (org-get-indentation)))
ind itm-lst itm-lst-2 end-lst end-lst-2 struct
(assoc-at-point
;; Return an association whose key is point and values are
;; indentation, bullet string, bullet counter, and
;; checkbox.
(function
(lambda (ind)
(looking-at org-list-full-item-re)
(list (point)
ind
(match-string-no-properties 1) ; bullet
(match-string-no-properties 2) ; counter
(match-string-no-properties 3) ; checkbox
(match-string-no-properties 4))))) ; description tag
(end-before-blank
;; Ensure list ends at the first blank line.
(function
(lambda ()
(skip-chars-backward " \r\t\n")
(min (1+ (point-at-eol)) lim-down)))))
;; 1. Read list from starting item to its beginning, and save
;; top item position and indentation in BEG-CELL. Also store
;; ending position of items in END-LST.
(save-excursion
(catch 'exit
(while t
(let ((ind (org-get-indentation)))
(cond
((<= (point) lim-up)
;; At upward limit: if we ended at an item, store it,
;; else dimiss useless data recorded above BEG-CELL.
;; Jump to part 2.
(throw 'exit
(setq itm-lst
(if (not (org-at-item-p))
(memq (assq (car beg-cell) itm-lst) itm-lst)
(setq beg-cell (cons (point) ind))
(cons (funcall assoc-at-point ind) itm-lst)))))
((and (not (eq org-list-ending-method 'indent))
(looking-at (org-list-end-re)))
;; Looking at a list ending regexp. Dismiss useless
;; data recorded above BEG-CELL. Jump to part 2.
(throw 'exit
(setq itm-lst
(memq (assq (car beg-cell) itm-lst) itm-lst))))
;; Skip blocks, drawers, inline tasks, blank lines
;; along the way.
((looking-at "^[ \t]*#\\+end_")
(re-search-backward "^[ \t]*#\\+begin_" nil t))
((looking-at "^[ \t]*:END:")
(re-search-backward drawers-re nil t)
(beginning-of-line))
((and inlinetask-re (looking-at inlinetask-re))
(org-inlinetask-goto-beginning)
(forward-line -1))
((looking-at "^[ \t]*$")
(forward-line -1))
((org-at-item-p)
;; Point is at an item. Add data to ITM-LST. It may
;; also end a previous item: save it in END-LST. If
;; ind is less or equal than BEG-CELL and there is no
;; end at this ind or lesser, this item becomes the
;; new BEG-CELL.
(setq itm-lst (cons (funcall assoc-at-point ind) itm-lst)
end-lst (cons (cons ind (point-at-bol)) end-lst))
(when (or (and (eq org-list-ending-method 'regexp)
(<= ind (cdr beg-cell)))
(< ind text-min-ind))
(setq beg-cell (cons (point-at-bol) ind)))
(forward-line -1))
(t
;; Point is not at an item. Unless ending method is
;; `regexp', interpret line's indentation:
;;
;; - text at column 0 is necessarily out of any list.
;; Dismiss data recorded above BEG-CELL. Jump to
;; part 2.
;;
;; - any other case, it can possibly be an ending
;; position for an item above. Save it and proceed.
(cond
((eq org-list-ending-method 'regexp))
((= ind 0)
(throw 'exit
(setq itm-lst
(memq (assq (car beg-cell) itm-lst) itm-lst))))
(t
(when (< ind text-min-ind) (setq text-min-ind ind))
(setq end-lst (cons (cons ind (point-at-bol)) end-lst))))
(forward-line -1)))))))
;; 2. Read list from starting point to its end, that is until we
;; get out of context, or a non-item line is less or equally
;; indented that BEG-CELL's cdr. Also store ending position
;; of items in END-LST-2.
(catch 'exit
(while t
(let ((ind (org-get-indentation)))
(cond
((>= (point) lim-down)
;; At downward limit: this is de facto the end of the
;; list. Save point as an ending position, and jump to
;; part 3.
(throw 'exit
(setq end-lst-2
(cons
(cons 0 (funcall end-before-blank)) end-lst-2))))
((and (not (eq org-list-ending-method 'regexp))
(looking-at (org-list-end-re)))
;; Looking at a list ending regexp. Save point as an
;; ending position and jump to part 3.
(throw 'exit
(setq end-lst-2
(cons (cons ind (point-at-bol)) end-lst-2))))
;; Skip blocks, drawers, inline tasks and blank lines
;; along the way
((looking-at "^[ \t]*#\\+begin_")
(re-search-forward "^[ \t]*#\\+end_")
(forward-line 1))
((looking-at drawers-re)
(re-search-forward "^[ \t]*:END:" nil t)
(forward-line 1))
((and inlinetask-re (looking-at inlinetask-re))
(org-inlinetask-goto-end)
(forward-line 1))
((looking-at "^[ \t]*$")
(forward-line 1))
((org-at-item-p)
;; Point is at an item. Add data to ITM-LST-2. It may also
;; end a previous item, so save it in END-LST-2.
(setq itm-lst-2 (cons (funcall assoc-at-point ind) itm-lst-2)
end-lst-2 (cons (cons ind (point-at-bol)) end-lst-2))
(forward-line 1))
(t
;; Point is not at an item. If ending method is not
;; `regexp', two situations are of interest:
;;
;; - ind is lesser or equal than BEG-CELL's. The list is
;; over. Store point as an ending position and jump to
;; part 3.
;;
;; - ind is lesser or equal than previous item's. This
;; is an ending position. Store it and proceed.
(cond
((eq org-list-ending-method 'regexp))
((<= ind (cdr beg-cell))
(setq end-lst-2
(cons (cons ind (funcall end-before-blank)) end-lst-2))
(throw 'exit nil))
((<= ind (nth 1 (car itm-lst-2)))
(setq end-lst-2 (cons (cons ind (point-at-bol)) end-lst-2))))
(forward-line 1))))))
(setq struct (append itm-lst (cdr (nreverse itm-lst-2))))
(setq end-lst (append end-lst (cdr (nreverse end-lst-2))))
;; 3. Correct ill-formed lists by making sure top item has the
;; least indentation of the list
(let ((min-ind (nth 1 (car struct))))
(mapc (lambda (item)
(let ((ind (nth 1 item)))
(when (< ind min-ind) (setcar (cdr item) min-ind))))
struct))
;; 4. Associate each item to its end pos.
(org-list-struct-assoc-end struct end-lst)
;; 5. Return STRUCT
struct)))
(defun org-list-struct-assoc-end (struct end-list)
"Associate proper ending point to items in STRUCT.
END-LIST is a pseudo-alist where car is indentation and cdr is
ending position.
This function modifies STRUCT."
(let ((endings end-list))
(mapc
(lambda (elt)
(let ((pos (car elt))
(ind (nth 1 elt)))
;; remove end candidates behind current item
(while (or (<= (cdar endings) pos))
(pop endings))
;; add end position to item assoc
(let ((old-end (nthcdr 6 elt))
(new-end (assoc-default ind endings '<=)))
(if old-end
(setcar old-end new-end)
(setcdr elt (append (cdr elt) (list new-end)))))))
struct)))
(defun org-list-struct-prev-alist (struct)
"Return alist between item and previous item in STRUCT."
(let ((item-end-alist (mapcar (lambda (e) (cons (car e) (nth 6 e)))
struct)))
(mapcar (lambda (e)
(let ((prev (car (rassq (car e) item-end-alist))))
(cons (car e) prev)))
struct)))
(defun org-list-struct-parent-alist (struct)
"Return alist between item and parent in STRUCT."
(let ((ind-to-ori (list (list (nth 1 (car struct)))))
(prev-pos (list (caar struct))))
(cons prev-pos
(mapcar (lambda (item)
(let ((pos (car item))
(ind (nth 1 item))
(prev-ind (caar ind-to-ori)))
(setq prev-pos (cons pos prev-pos))
(cond
((> prev-ind ind)
(setq ind-to-ori
(member (assq ind ind-to-ori) ind-to-ori))
(cons pos (cdar ind-to-ori)))
((< prev-ind ind)
(let ((origin (nth 1 prev-pos)))
(setq ind-to-ori (cons (cons ind origin) ind-to-ori))
(cons pos origin)))
(t (cons pos (cdar ind-to-ori))))))
(cdr struct)))))
(defun org-list-get-parent (item struct parents)
"Return parent of ITEM in STRUCT, or nil.
PARENTS is the alist of items' parent. See
`org-list-struct-parent-alist'."
(let ((parents (or parents (org-list-struct-parent-alist struct))))
(cdr (assq item parents))))
(defun org-list-has-child-p (item struct)
"Return a non-nil value if ITEM in STRUCT has a child.
Value returned is the position of the first child of ITEM."
(let ((ind (org-list-get-ind item struct))
(child-maybe (car (nth 1 (member (assq item struct) struct)))))
(when (and child-maybe
(< ind (org-list-get-ind child-maybe struct)))
child-maybe)))
(defun org-list-get-next-item (item struct prevs)
"Return next item in same sub-list as ITEM in STRUCT, or nil.
PREVS is the alist of previous items. See
`org-list-struct-prev-alist'."
(car (rassq item prevs)))
(defun org-list-get-prev-item (item struct prevs)
"Return previous item in same sub-list as ITEM in STRUCT, or nil.
PREVS is the alist of previous items. See
`org-list-struct-prev-alist'."
(cdr (assq item prevs)))
(defun org-list-get-subtree (item struct)
"Return all items with ITEM as a common ancestor or nil.
STRUCT is the list structure considered."
(let* ((item-end (org-list-get-item-end item struct))
(sub-struct (cdr (member (assq item struct) struct)))
subtree)
(catch 'exit
(mapc (lambda (e) (let ((pos (car e)))
(if (< pos item-end)
(setq subtree (cons pos subtree))
(throw 'exit nil))))
sub-struct))
(nreverse subtree)))
(defun org-list-get-all-items (item struct prevs)
"List of items in the same sub-list as ITEM in STRUCT.
PREVS, when provided, is the alist of previous items. See
`org-list-struct-prev-alist'."
(let ((prev-item item)
(next-item item)
before-item after-item)
(while (setq prev-item (org-list-get-prev-item prev-item struct prevs))
(push prev-item before-item))
(while (setq next-item (org-list-get-next-item next-item struct prevs))
(push next-item after-item))
(append before-item (list item) (nreverse after-item))))
(defun org-list-get-children (item struct parents)
"List all children of ITEM in STRUCT, or nil.
PARENTS is the alist of items' parent. See
`org-list-struct-parent-alist'."
(let (all)
(while (setq child (car (rassq item parents)))
(setq parents (cdr (member (assq child parents) parents))
all (cons child all)))
(nreverse all)))
(defun org-list-get-top-point (struct)
"Return point at beginning of list.
STRUCT is the structure of the list."
(caar struct))
(defun org-list-get-bottom-point (struct)
"Return point at bottom of list.
STRUCT is the structure of the list."
(apply 'max
(mapcar (lambda (e) (org-list-get-item-end (car e) struct)) struct)))
(defun org-list-get-list-begin (item struct prevs)
"Return point at beginning of sub-list ITEM belongs.
STRUCT is the structure of the list. PREVS is the alist of
previous items. See `org-list-struct-prev-alist'."
(let ((first-item item) prev-item)
(while (setq prev-item (org-list-get-prev-item first-item struct prevs))
(setq first-item prev-item))
first-item))
(defalias 'org-list-get-first-item 'org-list-get-list-begin)
(defun org-list-get-last-item (item struct prevs)
"Return point at last item of sub-list ITEM belongs.
STRUCT is the structure of the list. PREVS is the alist of
previous items. See `org-list-struct-prev-alist'."
(let ((last-item item) next-item)
(while (setq next-item (org-list-get-next-item last-item struct prevs))
(setq last-item next-item))
last-item))
(defun org-list-get-list-end (item struct prevs)
"Return point at end of sub-list ITEM belongs.
STRUCT is the structure of the list. PREVS is the alist of
previous items. See `org-list-struct-prev-alist'."
(org-list-get-item-end (org-list-get-list-last item struct prevs) struct))
(defun org-list-get-nth (n key struct)
"Return the Nth value of KEY in STRUCT."
(nth n (assq key struct)))
(defun org-list-set-nth (n key struct new)
"Set the Nth value of KEY in STRUCT to NEW.
\nThis function modifies STRUCT."
(setcar (nthcdr n (assq key struct)) new))
(defun org-list-get-ind (item struct)
"Return indentation of ITEM in STRUCT."
(org-list-get-nth 1 item struct))
(defun org-list-set-ind (item struct ind)
"Set indentation of ITEM in STRUCT to IND.
\nThis function modifies STRUCT."
(org-list-set-nth 1 item struct ind))
(defun org-list-get-bullet (item struct)
"Return bullet of ITEM in STRUCT."
(org-list-get-nth 2 item struct))
(defun org-list-set-bullet (item struct bullet)
"Set bullet of ITEM in STRUCT to BULLET.
\nThis function modifies STRUCT."
(org-list-set-nth 2 item struct bullet))
(defun org-list-get-counter (item struct)
"Return counter of ITEM in STRUCT."
(org-list-get-nth 3 item struct))
(defun org-list-get-checkbox (item struct)
"Return checkbox of ITEM in STRUCT or nil."
(org-list-get-nth 4 item struct))
(defun org-list-set-checkbox (item struct checkbox)
"Set checkbox of ITEM in STRUCT to CHECKBOX.
\nThis function modifies STRUCT."
(org-list-set-nth 4 item struct checkbox))
(defun org-list-get-tag (item struct)
"Return end position of ITEM in STRUCT."
(org-list-get-nth 5 item struct))
(defun org-list-get-item-end (item struct)
"Return end position of ITEM in STRUCT."
(org-list-get-nth 6 item struct))
(defun org-list-get-item-end-before-blank (item struct)
"Return point at end of ITEM in STRUCT, before any blank line.
Point returned is at end of line."
(save-excursion
(goto-char (org-list-get-item-end item struct))
(skip-chars-backward " \r\t\n")
(point-at-eol)))
(defun org-list-struct-fix-bul (struct prevs)
"Verify and correct bullets for every association in STRUCT.
PREVS is the alist of previous items. See
`org-list-struct-prev-alist'.
This function modifies STRUCT."
(let ((fix-bul
(function
(lambda (item)
(let* ((prev (org-list-get-prev-item item struct prevs))
(prev-bul (and prev (org-list-get-bullet prev struct)))
(counter (org-list-get-counter item struct))
(bullet (org-list-get-bullet item struct)))
(org-list-set-bullet
item struct
(org-list-bullet-string
(cond
((and prev (string-match "[0-9]+" prev-bul) counter)
(replace-match counter nil nil prev-bul))
(prev
(org-list-inc-bullet-maybe (org-list-get-bullet prev struct)))
((and (string-match "[0-9]+" bullet) counter)
(replace-match counter nil nil bullet))
((string-match "[0-9]+" bullet)
(replace-match "1" nil nil bullet))
(t bullet)))))))))
(mapc fix-bul (mapcar 'car struct))))
(defun org-list-struct-fix-ind (struct parents &optional bullet-size)
"Verify and correct indentation for every association in STRUCT.
PARENTS is the alist of items' parents. See
`org-list-struct-parent-alist'.
If numeric optional argument BULLET-SIZE is set, assume all
bullets in list have this length to determine new indentation.
This function modifies STRUCT."
(let* ((ancestor (org-list-get-top-point struct))
(top-ind (org-list-get-ind ancestor struct))
(new-ind
(lambda (item)
(let ((parent (org-list-get-parent item struct parents)))
(if parent
;; Indent like parent + length of parent's bullet
(org-list-set-ind
item struct (+ (or bullet-size
(length
(org-list-get-bullet parent struct)))
(org-list-get-ind parent struct)))
;; If no parent, indent like top-point
(org-list-set-ind item struct top-ind))))))
(mapc new-ind (mapcar 'car (cdr struct)))))
(defun org-list-struct-fix-box (struct parents prevs &optional ordered)
"Verify and correct checkboxes for every association in STRUCT.
PARENTS is the alist of items' parents. See
`org-list-struct-parent-alist'. PREVS is the alist of previous
items. See `org-list-struct-prev-alist.
If ORDERED is non-nil, a checkbox can only be checked when every
checkbox before it is checked too. If there was an attempt to
break this rule, the function will return the blocking item. In
all others cases, the return value will be nil.
This function modifies STRUCT."
(let ((all-items (mapcar 'car struct))
(set-parent-box
(function
(lambda (item)
(let* ((box-list
(mapcar (lambda (child)
(org-list-get-checkbox child struct))
(org-list-get-children item struct parents))))
(org-list-set-checkbox
item struct
(cond
((and (member "[ ]" box-list) (member "[X]" box-list)) "[-]")
((member "[-]" box-list) "[-]")
((member "[X]" box-list) "[X]")
((member "[ ]" box-list) "[ ]")
;; parent has no boxed child: leave box as-is
(t (org-list-get-checkbox item struct))))))))
parent-list)
;; 1. List all parents with a checkbox
(mapc
(lambda (e)
(let* ((parent (org-list-get-parent e struct parents))
(parent-box-p (org-list-get-checkbox parent struct)))
(when (and parent-box-p (not (memq parent parent-list)))
(setq parent-list (cons parent parent-list)))))
all-items)
;; 2. Sort those parents by decreasing indentation
(setq parent-list (sort parent-list
(lambda (e1 e2)
(> (org-list-get-ind e1 struct)
(org-list-get-ind e2 struct)))))
;; 3. For each parent, get all children's checkboxes to determine
;; and set its checkbox accordingly
(mapc set-parent-box parent-list)
;; 4. If ORDERED is set, see if we need to uncheck some boxes
(when ordered
(let* ((box-list
(mapcar (lambda (e) (org-list-get-checkbox e struct)) all-items))
(after-unchecked (member "[ ]" box-list)))
;; there are boxes checked after an unchecked one: fix that
(when (member "[X]" after-unchecked)
(let ((index (- (length struct) (length after-unchecked))))
(mapc (lambda (e) (org-list-set-checkbox e struct "[ ]"))
(nthcdr index all-items))
;; Verify once again the structure, without ORDERED
(org-list-struct-fix-box struct parents prevs nil)
;; return blocking item
(nth index all-items)))))))
(defun org-list-struct-fix-struct (struct parents)
"Return STRUCT with correct bullets and indentation.
PARENTS is the alist of items' parents. See
`org-list-struct-parent-alist'."
;; Order of functions matters here: checkboxes and endings need
;; correct indentation to be set, and indentation needs correct
;; bullets.
;;
;; 0. Save a copy of structure before modifications
(let ((old-struct (mapcar (lambda (e) (copy-alist e)) struct)))
;; 1. Set a temporary, but coherent with PARENTS, indentation in
;; order to get items endings and bullets properly
(org-list-struct-fix-ind struct parents 2)
;; 2. Get pseudo-alist of ending positions and sort it by position.
;; Then associate them to the structure.
(let (end-list acc-end)
(mapc (lambda (e)
(let* ((pos (car e))
(ind-pos (org-list-get-ind pos struct))
(end-pos (org-list-get-item-end pos struct)))
(unless (assq end-pos struct)
;; to determine real ind of an ending position that is
;; not at an item, we have to find the item it belongs
;; to: it is the last item (ITEM-UP), whose ending is
;; further than the position we're interested in.
(let ((item-up (assoc-default end-pos acc-end '>)))
(setq end-list
(append
(list (cons
(if item-up
(+ (org-list-get-ind item-up struct) 2)
0) ; this case is for the bottom point
end-pos))
end-list))))
(setq end-list (append (list (cons ind-pos pos)) end-list))
(setq acc-end (cons (cons end-pos pos) acc-end))))
struct)
(setq end-list (sort end-list (lambda (e1 e2) (< (cdr e1) (cdr e2)))))
(org-list-struct-assoc-end struct end-list))
;; 3. Get bullets right
(let ((prevs (org-list-struct-prev-alist struct)))
(org-list-struct-fix-bul struct prevs)
;; 4. Now get real indentation
(org-list-struct-fix-ind struct parents)
;; 5. Eventually fix checkboxes
(org-list-struct-fix-box struct parents prevs))
;; 6. Apply structure modifications to buffer
(org-list-struct-apply-struct struct old-struct)))
(defun org-list-struct-outdent (start end struct parents)
"Outdent items between START and END in structure STRUCT.
PARENTS is the alist of items' parents. See
`org-list-struct-parent-alist'.
START is included, END excluded."
(let* (acc
(out (lambda (cell)
(let* ((item (car cell))
(parent (cdr cell)))
(cond
;; Item not yet in zone: keep association
((< item start) cell)
;; Item out of zone: follow associations in acc
((>= item end)
(let ((convert (and parent (assq parent acc))))
(if convert (cons item (cdr convert)) cell)))
;; Item has no parent: error
((not parent)
(error "Cannot outdent top-level items"))
;; Parent is outdented: keep association
((>= parent start)
(setq acc (cons (cons parent item) acc)) cell)
(t
;; Parent isn't outdented: reparent to grand-parent
(let ((grand-parent (org-list-get-parent
parent struct parents)))
(setq acc (cons (cons parent item) acc))
(cons item grand-parent))))))))
(mapcar out parents)))
(defun org-list-struct-indent (start end struct parents prevs)
"Indent items between START and END in structure STRUCT.
PARENTS is the alist of parents. See
`org-list-struct-parent-alist'. PREVS is the alist of previous
items. See `org-list-struct-prev-alist'.
START is included and END excluded.
STRUCT may be modified if `org-list-demote-modify-bullet' matches
bullets between START and END."
(let* (acc
(set-assoc (lambda (cell) (setq acc (cons cell acc)) cell))
(change-bullet-maybe
(function
(lambda (item)
(let* ((bul (org-trim (org-list-get-bullet item struct)))
(new-bul-p (cdr (assoc bul org-list-demote-modify-bullet))))
(when new-bul-p (org-list-set-bullet item struct new-bul-p))))))
(ind
(lambda (cell)
(let* ((item (car cell))
(parent (cdr cell)))
(cond
;; Item not yet in zone: keep association
((< item start) cell)
((>= item end)
;; Item out of zone: follow associations in acc
(let ((convert (assq parent acc)))
(if convert (cons item (cdr convert)) cell)))
(t
;; Item is in zone...
(let ((prev (org-list-get-prev-item item struct prevs)))
;; Check if bullet needs to be changed
(funcall change-bullet-maybe item)
(cond
;; First item indented but not parent: error
((and (not prev) (< parent start))
(error "Cannot indent the first item of a list"))
;; First item and parent indented: keep same parent
((not prev) (funcall set-assoc cell))
;; Previous item not indented: reparent to it
((< prev start) (funcall set-assoc (cons item prev)))
;; Previous item indented: reparent like it
(t
(funcall set-assoc (cons item
(cdr (assq prev acc)))))))))))))
(mapcar ind parents)))
(defun org-list-struct-apply-struct (struct old-struct)
"Apply modifications to list so it mirrors STRUCT.
OLD-STRUCT is the structure before any modifications. Thus, the
function is smart enough to modify only parts of buffer which
have changed.
Initial position of cursor is restored after the changes."
(let* ((pos (copy-marker (point)))
(shift-body-ind
(function
;; Shift the indentation between END and BEG by DELTA.
;; Start from the line before END.
(lambda (end beg delta)
(unless (= delta 0)
(goto-char end)
(forward-line -1)
(while (or (> (point) beg)
(and (= (point) beg) (not (org-at-item-p))))
(when (org-looking-at-p "^[ \t]*\\S-")
(let ((i (org-get-indentation)))
(org-indent-line-to (+ i delta))))
(forward-line -1))))))
(modify-item
(function
;; Replace item first line elements with new elements from
;; STRUCT, if appropriate.
(lambda (item)
(goto-char item)
(let* ((new-ind (org-list-get-ind item struct))
(old-ind (org-list-get-ind item old-struct))
(new-bul (org-list-bullet-string
(org-list-get-bullet item struct)))
(old-bul (org-list-get-bullet item old-struct))
(new-box (org-list-get-checkbox item struct)))
(looking-at org-list-full-item-re)
;; a. Replace bullet
(unless (equal old-bul new-bul)
(replace-match new-bul nil nil nil 1))
;; b. Replace checkbox
(cond
((and new-box
(save-match-data (org-at-item-description-p))
(cdr (assq 'checkbox org-list-automatic-rules)))
(message "Cannot add a checkbox to a description list item"))
((equal (match-string 3) new-box))
((and (match-string 3) new-box)
(replace-match new-box nil nil nil 3))
((match-string 3)
(goto-char (or (match-end 2) (match-end 1)))
(looking-at "\\[[ X-]\\][ \t]+")
(replace-match ""))
(t (goto-char (or (match-end 2) (match-end 1)))
(insert (concat new-box " "))))
;; c. Indent item to appropriate column
(unless (= new-ind old-ind)
(delete-region (goto-char (point-at-bol))
(progn (skip-chars-forward " \t") (point)))
(indent-to new-ind)))))))
;; 1. First get list of items and position endings. We maintain
;; two alists: ITM-SHIFT, determining indentation shift needed
;; at item, and END-POS, a pseudo-alist where key is ending
;; position and value point
(let (end-list acc-end itm-shift all-ends sliced-struct)
(mapc (lambda (e)
(let* ((pos (car e))
(ind-pos (org-list-get-ind pos struct))
(ind-old (org-list-get-ind pos old-struct))
(bul-pos (org-list-get-bullet pos struct))
(bul-old (org-list-get-bullet pos old-struct))
(ind-shift (- (+ ind-pos (length bul-pos))
(+ ind-old (length bul-old))))
(end-pos (org-list-get-item-end pos old-struct)))
(setq itm-shift (cons (cons pos ind-shift) itm-shift))
(unless (assq end-pos old-struct)
;; To determine real ind of an ending position that is
;; not at an item, we have to find the item it belongs
;; to: it is the last item (ITEM-UP), whose ending is
;; further than the position we're interested in.
(let ((item-up (assoc-default end-pos acc-end '>)))
(setq end-list (append
(list (cons end-pos item-up)) end-list))))
(setq acc-end (cons (cons end-pos pos) acc-end))))
old-struct)
;; 2. Slice the items into parts that should be shifted by the
;; same amount of indentation. The slices are returned in
;; reverse order so changes modifying buffer do not change
;; positions they refer to.
(setq all-ends (sort (append (mapcar 'car itm-shift)
(org-uniquify (mapcar 'car end-list)))
'<))
(while (cdr all-ends)
(let* ((up (pop all-ends))
(down (car all-ends))
(ind (if (assq up struct)
(cdr (assq up itm-shift))
(cdr (assq (cdr (assq up end-list)) itm-shift)))))
(setq sliced-struct (cons (list down up ind) sliced-struct))))
;; 3. Modify each slice in buffer, from end to beginning, with a
;; special action when beginning is at item start.
(mapc (lambda (e)
(apply shift-body-ind e)
(let ((beg (nth 1 e)))
(when (assq beg struct)
(funcall modify-item beg))))
sliced-struct))
;; 4. Go back to initial position
(goto-char pos)))
;;; Indentation
(defun org-outdent-item ()
"Outdent a local list item, but not its children.
If a region is active, all items inside will be moved."
(interactive)
(if (org-at-item-p)
(let ((struct (org-list-struct)))
(org-list-indent-item-generic -1 t struct))
(error "Not at an item")))
(defun org-indent-item ()
"Indent a local list item, but not its children.
If a region is active, all items inside will be moved."
(interactive)
(if (org-at-item-p)
(let ((struct (org-list-struct)))
(org-list-indent-item-generic 1 t struct))
(error "Not at an item")))
(defun org-outdent-item-tree ()
"Outdent a local list item including its children.
If a region is active, all items inside will be moved."
(interactive)
(let ((regionp (org-region-active-p)))
(cond
((or (org-at-item-p)
(and (org-region-active-p)
(goto-char (region-beginning))
(org-at-item-p)))
(let ((struct (org-list-struct)))
(org-list-indent-item-generic -1 nil struct)))
(regionp (error "Region not starting at an item"))
(t (error "Not at an item")))))
(defun org-indent-item-tree ()
"Indent a local list item including its children.
If a region is active, all items inside will be moved."
(interactive)
(interactive)
(let ((regionp (org-region-active-p)))
(cond
((or (org-at-item-p)
(and (org-region-active-p)
(goto-char (region-beginning))
(org-at-item-p)))
(let ((struct (org-list-struct)))
(org-list-indent-item-generic 1 nil struct)))
(regionp (error "Region not starting at an item"))
(t (error "Not at an item")))))
(defvar org-tab-ind-state)
(defun org-cycle-item-indentation ()
"Cycle levels of indentation of an empty item.
The first run indents the item, if applicable. Subsequents runs
outdent it at meaningful levels in the list. When done, item is
put back at its original position with its original bullet.
Return t at each successful move."
(when (org-at-item-p)
(let* ((org-adapt-indentation nil)
(struct (org-list-struct))
(ind (org-list-get-ind (point-at-bol) struct)))
;; Check that item is really empty
(when (and (save-excursion
(beginning-of-line)
(looking-at org-list-full-item-re))
(>= (match-end 0) (save-excursion
(goto-char (org-list-get-item-end
(point-at-bol) struct))
(skip-chars-backward " \r\t\n")
(point))))
(setq this-command 'org-cycle-item-indentation)
;; When in the middle of the cycle, try to outdent first. If it
;; fails, and point is still at initial position, indent. Else,
;; go back to original position.
(if (eq last-command 'org-cycle-item-indentation)
(cond
((ignore-errors (org-list-indent-item-generic -1 t struct)))
((and (= ind (car org-tab-ind-state))
(ignore-errors (org-list-indent-item-generic 1 t struct))))
(t (back-to-indentation)
(org-indent-to-column (car org-tab-ind-state))
(looking-at "\\S-+")
(replace-match (cdr org-tab-ind-state))
(end-of-line)
;; Break cycle
(setq this-command 'identity)))
;; If a cycle is starting, remember indentation and bullet,
;; then try to indent. If it fails, try to outdent.
(setq org-tab-ind-state (cons ind (org-get-bullet)))
(cond
((ignore-errors (org-list-indent-item-generic 1 t struct)))
((ignore-errors (org-list-indent-item-generic -1 t struct)))
(t (error "Cannot move item"))))
t))))
;;; Bullets
(defun org-get-bullet ()
"Return the bullet of the item at point.
Assume cursor is at an item."
(save-excursion
(beginning-of-line)
(and (looking-at "[ \t]*\\(\\S-+\\)") (match-string 1))))
(defun org-list-bullet-string (bullet)
"Return BULLET with the correct number of whitespaces.
It determines the number of whitespaces to append by looking at
`org-list-two-spaces-after-bullet-regexp'."
(save-match-data
(string-match "\\S-+\\([ \t]*\\)" bullet)
(replace-match
(save-match-data
(concat
" "
;; Do we need to concat another white space ?
(when (and org-list-two-spaces-after-bullet-regexp
(string-match org-list-two-spaces-after-bullet-regexp bullet))
" ")))
nil nil bullet 1)))
(defun org-list-inc-bullet-maybe (bullet)
"Increment BULLET if applicable."
(if (string-match "[0-9]+" bullet)
(replace-match
(number-to-string (1+ (string-to-number (match-string 0 bullet))))
nil nil bullet)
bullet))
(defun org-list-repair ()
"Make sure all items are correctly indented, with the right bullet.
This function scans the list at point, along with any sublist."
(interactive)
(unless (org-at-item-p) (error "This is not a list"))
(let* ((struct (org-list-struct))
(parents (org-list-struct-parent-alist struct)))
(org-list-struct-fix-struct struct parents)))
(defun org-cycle-list-bullet (&optional which)
"Cycle through the different itemize/enumerate bullets.
This cycle the entire list level through the sequence:
`-' -> `+' -> `*' -> `1.' -> `1)'
If WHICH is a valid string, use that as the new bullet. If WHICH
is an integer, 0 means `-', 1 means `+' etc. If WHICH is
`previous', cycle backwards."
(interactive "P")
(unless (org-at-item-p) (error "This is not a list"))
(save-excursion
(beginning-of-line)
(let* ((struct (org-list-struct))
(parents (org-list-struct-parent-alist struct))
(prevs (org-list-struct-prev-alist struct))
(list-beg (org-list-get-list-begin (point) struct prevs))
(bullet (org-list-get-bullet list-beg struct))
(current (cond
((string-match "\\." bullet) "1.")
((string-match ")" bullet) "1)")
(t (org-trim bullet))))
(bullet-rule-p (cdr (assq 'bullet org-list-automatic-rules)))
;; Compute list of possible bullets, depending on context
(bullet-list (append '("-" "+" )
;; *-bullets are not allowed at column 0
(unless (and bullet-rule-p
(looking-at "\\S-")) '("*"))
;; Description items cannot be numbered
(unless (and bullet-rule-p
(or (eq org-plain-list-ordered-item-terminator ?\))
(org-at-item-description-p))) '("1."))
(unless (and bullet-rule-p
(or (eq org-plain-list-ordered-item-terminator ?.)
(org-at-item-description-p))) '("1)"))))
(len (length bullet-list))
(item-index (- len (length (member current bullet-list))))
(get-value (lambda (index) (nth (mod index len) bullet-list)))
(new (cond
((member which bullet-list) which)
((numberp which) (funcall get-value which))
((eq 'previous which) (funcall get-value (1- item-index)))
(t (funcall get-value (1+ item-index))))))
;; Use a short variation of `org-list-struct-fix-struct' as
;; there's no need to go through all the steps.
(let ((old-struct (mapcar (lambda (e) (copy-alist e)) struct)))
(org-list-set-bullet list-beg struct (org-list-bullet-string new))
(org-list-struct-fix-bul struct prevs)
(org-list-struct-fix-ind struct parents)
(org-list-struct-apply-struct struct old-struct)))))
;;; Checkboxes
(defun org-toggle-checkbox (&optional toggle-presence)
"Toggle the checkbox in the current line.
With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
double prefix, set checkbox to [-].
When there is an active region, toggle status or presence of the
first checkbox there, and make every item inside have the
same status or presence, respectively.
If the cursor is in a headline, apply this to all checkbox items
in the text below the heading, taking as reference the first item
in subtree, ignoring drawers."
(interactive "P")
(save-excursion
(let* (singlep
block-item
lim-up
lim-down
(orderedp (ignore-errors (org-entry-get nil "ORDERED")))
(bounds
;; In a region, start at first item in region
(cond
((org-region-active-p)
(let ((limit (region-end)))
(goto-char (region-beginning))
(if (org-search-forward-unenclosed org-item-beginning-re
limit t)
(setq lim-up (point-at-bol))
(error "No item in region"))
(setq lim-down (copy-marker limit))))
((org-on-heading-p)
;; On an heading, start at first item after drawers
(let ((limit (save-excursion (outline-next-heading) (point))))
(forward-line 1)
(when (looking-at org-drawer-regexp)
(re-search-forward "^[ \t]*:END:" limit nil))
(if (org-search-forward-unenclosed org-item-beginning-re
limit t)
(setq lim-up (point-at-bol))
(error "No item in subtree"))
(setq lim-down (copy-marker limit))))
;; Just one item: set singlep flag
((org-at-item-p)
(setq singlep t)
(setq lim-up (point-at-bol)
lim-down (point-at-eol)))
(t (error "Not at an item or heading, and no active region"))))
;; determine the checkbox going to be applied to all items
;; within bounds
(ref-checkbox
(progn
(goto-char lim-up)
(let ((cbox (and (org-at-item-checkbox-p) (match-string 1))))
(cond
((equal toggle-presence '(16)) "[-]")
((equal toggle-presence '(4))
(unless cbox "[ ]"))
((equal "[ ]" cbox) "[X]")
(t "[ ]"))))))
;; When an item is found within bounds, grab the full list at
;; point structure, then: 1. set checkbox of all its items
;; within bounds to ref-checkbox; 2. fix checkboxes of the whole
;; list; 3. move point after the list.
(goto-char lim-up)
(while (and (< (point) lim-down)
(org-search-forward-unenclosed
org-item-beginning-re lim-down 'move))
(let* ((struct (org-list-struct))
(struct-copy (mapcar (lambda (e) (copy-alist e)) struct))
(parents (org-list-struct-parent-alist struct))
(prevs (org-list-struct-prev-alist struct))
(bottom (copy-marker (org-list-get-bottom-point struct)))
(items-to-toggle (org-remove-if
(lambda (e) (or (< e lim-up) (> e lim-down)))
(mapcar 'car (cdr struct)))))
(mapc (lambda (e) (org-list-set-checkbox
e struct
;; if there is no box at item, leave as-is
;; unless function was called with C-u prefix
(let ((cur-box (org-list-get-checkbox e struct)))
(if (or cur-box (equal toggle-presence '(4)))
ref-checkbox
cur-box))))
items-to-toggle)
(setq block-item (org-list-struct-fix-box
struct parents prevs orderedp))
;; Report some problems due to ORDERED status of subtree. If
;; only one box was being checked, throw an error, else,
;; only signal problems.
(cond
((and singlep block-item (> lim-up block-item))
(error
"Checkbox blocked because of unchecked box at line %d"
(org-current-line block-item)))
(block-item
(message
"Checkboxes were removed due to unchecked box at line %d"
(org-current-line block-item))))
(goto-char bottom)
(org-list-struct-apply-struct struct struct-copy))))
(org-update-checkbox-count-maybe)))
(defun org-reset-checkbox-state-subtree ()
"Reset all checkboxes in an entry subtree."
(interactive "*")
(save-restriction
(save-excursion
(org-narrow-to-subtree)
(org-show-subtree)
(goto-char (point-min))
(let ((end (point-max)))
(while (< (point) end)
(when (org-at-item-checkbox-p)
(replace-match "[ ]" t t nil 1))
(beginning-of-line 2))))
(org-update-checkbox-count-maybe)))
(defvar org-checkbox-statistics-hook nil
"Hook that is run whenever Org thinks checkbox statistics should be updated.
This hook runs even if checkbox rule in
`org-list-automatic-rules' does not apply, so it can be used to
implement alternative ways of collecting statistics
information.")
(defun org-update-checkbox-count-maybe ()
"Update checkbox statistics unless turned off by user."
(when (cdr (assq 'checkbox org-list-automatic-rules))
(org-update-checkbox-count))
(run-hooks 'org-checkbox-statistics-hook))
(defun org-update-checkbox-count (&optional all)
"Update the checkbox statistics in the current section.
This will find all statistic cookies like [57%] and [6/12] and
update them with the current numbers.
With optional prefix argument ALL, do this for the whole buffer."
(interactive "P")
(save-excursion
(let ((cookie-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
(box-re "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)")
(recursivep
(or (not org-hierarchical-checkbox-statistics)
(string-match "\\<recursive\\>"
(or (ignore-errors
(org-entry-get nil "COOKIE_DATA"))
""))))
(bounds (if all
(cons (point-min) (point-max))
(cons (or (ignore-errors (org-back-to-heading) (point))
(point-min))
(save-excursion (outline-next-heading) (point)))))
(count-boxes
(function
;; add checked boxes and boxes of all types in all
;; structures in STRUCTS to c-on and c-all, respectively.
;; This looks at RECURSIVEP value. If ITEM is nil, count
;; across the whole structure, else count only across
;; subtree whose ancestor is ITEM.
(lambda (item structs)
(mapc
(lambda (s)
(let* ((pre (org-list-struct-prev-alist s))
(par (org-list-struct-parent-alist s))
(items
(if recursivep
(or (and item (org-list-get-subtree item s))
(mapcar 'car s))
(or (and item (org-list-get-children item s par))
(org-list-get-all-items
(org-list-get-top-point s) s pre))))
(cookies (delq nil (mapcar
(lambda (e)
(org-list-get-checkbox e s))
items))))
(setq c-all (+ (length cookies) c-all)
c-on (+ (org-count "[X]" cookies) c-on))))
structs))))
cookies-list backup-end structs-backup)
(goto-char (car bounds))
;; 1. Build an alist for each cookie found within BOUNDS. The
;; key will be position at beginning of cookie and values
;; ending position, format of cookie, number of checked boxes
;; to report, and total number of boxes.
(while (re-search-forward cookie-re (cdr bounds) t)
(save-excursion
(let ((c-on 0) (c-all 0))
(save-match-data
;; There are two types of cookies: those at headings and those
;; at list items.
(cond
((and (org-on-heading-p)
(string-match "\\<todo\\>"
(downcase
(or (org-entry-get nil "COOKIE_DATA") "")))))
;; This cookie is at an heading, but specifically for
;; todo, not for checkboxes: skip it.
((org-on-heading-p)
(setq backup-end (save-excursion
(outline-next-heading) (point)))
;; This cookie is at an heading. Grab structure of
;; every list containing a checkbox between point and
;; next headline, and save them in STRUCTS-BACKUP
(while (org-search-forward-unenclosed box-re backup-end 'move)
(let* ((struct (org-list-struct))
(bottom (org-list-get-bottom-point struct)))
(setq structs-backup (cons struct structs-backup))
(goto-char bottom)))
(funcall count-boxes nil structs-backup))
((org-at-item-p)
;; This cookie is at an item. Look in STRUCTS-BACKUP
;; to see if we have the structure of list at point in
;; it. Else compute the structure.
(let ((item (point-at-bol)))
(if (and backup-end (< item backup-end))
(funcall count-boxes item structs-backup)
(let ((struct (org-list-struct)))
(setq end-entry (org-list-get-bottom-point struct)
structs-backup (list struct)))
(funcall count-boxes item structs-backup))))))
;; Build the cookies list, with appropriate information
(setq cookies-list (cons (list (match-beginning 1) ; cookie start
(match-end 1) ; cookie end
(match-beginning 2) ; percent?
c-on ; checked boxes
c-all) ; total boxes
cookies-list)))))
;; 2. Apply alist to buffer, in reverse order so positions stay
;; unchanged after cookie modifications.
(mapc (lambda (cookie)
(let* ((beg (car cookie))
(end (nth 1 cookie))
(percentp (nth 2 cookie))
(checked (nth 3 cookie))
(total (nth 4 cookie))
(new (if percentp
(format "[%d%%]" (/ (* 100 checked)
(max 1 total)))
(format "[%d/%d]" checked total))))
(goto-char beg)
(insert new)
(delete-region (point) (+ (point) (- end beg)))))
cookies-list))))
(defun org-get-checkbox-statistics-face ()
"Select the face for checkbox statistics.
The face will be `org-done' when all relevant boxes are checked.
Otherwise it will be `org-todo'."
(if (match-end 1)
(if (equal (match-string 1) "100%")
'org-checkbox-statistics-done
'org-checkbox-statistics-todo)
(if (and (> (match-end 2) (match-beginning 2))
(equal (match-string 2) (match-string 3)))
'org-checkbox-statistics-done
'org-checkbox-statistics-todo)))
;;; Misc Tools
(defun org-apply-on-list (function init-value &rest args)
"Call FUNCTION on each item of the list at point.
FUNCTION must be called with at least one argument: INIT-VALUE,
that will contain the value returned by the function at the
previous item, plus ARGS extra arguments.
FUNCTION is applied on items in reverse order.
As an example, (org-apply-on-list (lambda (result) (1+ result)) 0)
will return the number of items in the current list.
Sublists of the list are skipped. Cursor is always at the
beginning of the item."
(let* ((struct (org-list-struct))
(prevs (org-list-struct-prev-alist struct))
(item (copy-marker (point-at-bol)))
(all (org-list-get-all-items (marker-position item) struct prevs))
(value init-value))
(mapc (lambda (e)
(goto-char e)
(setq value (apply function value args)))
(nreverse all))
(goto-char item)
value))
(defun org-sort-list (&optional with-case sorting-type getkey-func compare-func)
"Sort plain list items.
The cursor may be at any item of the list that should be sorted.
Sublists are not sorted. Checkboxes, if any, are ignored.
Sorting can be alphabetically, numerically, by date/time as given by
a time stamp, by a property or by priority.
Comparing entries ignores case by default. However, with an
optional argument WITH-CASE, the sorting considers case as well.
The command prompts for the sorting type unless it has been given
to the function through the SORTING-TYPE argument, which needs to
be a character, \(?n ?N ?a ?A ?t ?T ?f ?F). Here is the precise
meaning of each character:
n Numerically, by converting the beginning of the item to a number.
a Alphabetically. Only the first line of item is checked.
t By date/time, either the first active time stamp in the entry, if
any, or by the first inactive one. In a timer list, sort the timers.
Capital letters will reverse the sort order.
If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a
function to be called with point at the beginning of the record.
It must return either a string or a number that should serve as
the sorting key for that record. It will then use COMPARE-FUNC to
compare entries."
(interactive "P")
(let* ((case-func (if with-case 'identity 'downcase))
(struct (org-list-struct))
(prevs (org-list-struct-prev-alist struct))
(start (org-list-get-list-begin (point-at-bol) struct prevs))
(end (org-list-get-list-end (point-at-bol) struct prevs))
(sorting-type
(progn
(message
"Sort plain list: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:")
(read-char-exclusive)))
(getkey-func (and (= (downcase sorting-type) ?f)
(org-icompleting-read "Sort using function: "
obarray 'fboundp t nil nil)
(intern getkey-func))))
(message "Sorting items...")
(save-restriction
(narrow-to-region start end)
(goto-char (point-min))
(let* ((dcst (downcase sorting-type))
(case-fold-search nil)
(now (current-time))
(sort-func (cond
((= dcst ?a) 'string<)
((= dcst ?f) compare-func)
((= dcst ?t) '<)
(t nil)))
(next-record (lambda ()
(skip-chars-forward " \r\t\n")
(beginning-of-line)))
(end-record (lambda ()
(goto-char (org-list-get-item-end (point) struct))))
(value-to-sort
(lambda ()
(when (looking-at "[ \t]*[-+*0-9.)]+\\([ \t]+\\[[- X]\\]\\)?[ \t]+")
(cond
((= dcst ?n)
(string-to-number (buffer-substring (match-end 0)
(point-at-eol))))
((= dcst ?a)
(buffer-substring (match-end 0) (point-at-eol)))
((= dcst ?t)
(cond
;; If it is a timer list, convert timer to seconds
((org-at-item-timer-p)
(org-timer-hms-to-secs (match-string 1)))
((or (org-search-forward-unenclosed org-ts-regexp
(point-at-eol) t)
(org-search-forward-unenclosed org-ts-regexp-both
(point-at-eol) t))
(org-time-string-to-seconds (match-string 0)))
(t (org-float-time now))))
((= dcst ?f)
(if getkey-func
(let ((value (funcall getkey-func)))
(if (stringp value)
(funcall case-func value)
value))
(error "Invalid key function `%s'" getkey-func)))
(t (error "Invalid sorting type `%c'" sorting-type)))))))
(sort-subr (/= dcst sorting-type)
next-record
end-record
value-to-sort
nil
sort-func)
(org-list-repair nil)
(run-hooks 'org-after-sorting-entries-or-items-hook)
(message "Sorting items...done")))))
;;; Send and receive lists
(defun org-list-parse-list (&optional delete)
"Parse the list at point and maybe DELETE it.
Return a list whose car is a symbol of list type, among
`ordered', `unordered' and `descriptive'. Then, each item is a
list whose elements are strings and other sub-lists. Inside
strings, checkboxes are replaced by \"[CBON]\" and \"[CBOFF]\".
For example, the following list:
1. first item
+ sub-item one
+ [X] sub-item two
more text in first item
2. last item
will be parsed as:
\(ordered \(\"first item\"
\(unordered \(\"sub-item one\"\) \(\"[CBON] sub-item two\"\)\)
\"more text in first item\"\)
\(\"last item\"\)\)
Point is left at list end."
(let* ((struct (org-list-struct))
(prevs (org-list-struct-prev-alist struct))
(parents (org-list-struct-parent-alist struct))
(top (org-list-get-top-point struct))
(bottom (org-list-get-bottom-point struct))
out
(get-list-type
(function
;; determine type of list by getting info on item POS in
;; STRUCT.
(lambda (pos struct)
(cond ((string-match "[0-9]" (org-list-get-bullet pos struct))
'ordered)
((org-list-get-tag pos struct) 'descriptive)
(t 'unordered)))))
(parse-sublist
(function
;; return a list whose car is list type and cdr a list of
;; items' body.
(lambda (e)
(cons (funcall get-list-type (car e) struct)
(mapcar parse-item e)))))
(parse-item
(function
;; return a list containing text and any sublist inside
;; item.
(lambda (e)
(let ((start (save-excursion
(goto-char e)
(looking-at org-item-beginning-re)
(match-end 0)))
(childp (org-list-has-child-p e struct))
(end (org-list-get-item-end e struct)))
(if childp
(let* ((children (org-list-get-children e struct parents))
(body (list (funcall get-text start childp t))))
(while children
(let* ((first (car children))
(sub (org-list-get-all-items first struct prevs))
(last-c (car (last sub)))
(last-end (org-list-get-item-end last-c struct)))
(push (funcall parse-sublist sub) body)
(setq children (cdr (member last-c children)))
(unless (= (or (car children) end) last-end)
(push (funcall get-text last-end (or (car children) end) nil)
body))))
(nreverse body))
(list (funcall get-text start end t)))))))
(get-text
(function
;; return text between BEG and END, trimmed, with
;; checkboxes replaced if BOX is true.
(lambda (beg end box)
(let ((text (org-trim (buffer-substring beg end))))
(if (and box
(string-match
"^\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\[\\([xX ]\\)\\]"
text))
(replace-match
(if (equal (match-string 1 text) " ") "CBOFF" "CBON")
t nil text 1)
text))))))
;; store output, take care of cursor position and deletion of
;; list, then return output.
(setq out (funcall parse-sublist (org-list-get-all-items top struct prevs)))
(goto-char top)
(when delete
(delete-region top bottom)
(when (and (not (eq org-list-ending-method 'indent))
(looking-at (org-list-end-re)))
(replace-match "\n")))
out))
(defun org-list-make-subtree ()
"Convert the plain list at point into a subtree."
(interactive)
(if (not (org-in-item-p))
(error "Not in a list")
(let ((list (org-list-parse-list t)) nstars)
(save-excursion
(if (ignore-errors
(org-back-to-heading))
(progn (looking-at org-complex-heading-regexp)
(setq nstars (length (match-string 1))))
(setq nstars 0)))
(org-list-make-subtrees list (1+ nstars)))))
(defun org-list-make-subtrees (list level)
"Convert LIST into subtrees starting at LEVEL."
(if (symbolp (car list))
(org-list-make-subtrees (cdr list) level)
(mapcar (lambda (item)
(if (stringp item)
(insert (make-string
(if org-odd-levels-only
(1- (* 2 level)) level) ?*) " " item "\n")
(org-list-make-subtrees item (1+ level))))
list)))
(defun org-list-insert-radio-list ()
"Insert a radio list template appropriate for this major mode."
(interactive)
(let* ((e (assq major-mode org-list-radio-list-templates))
(txt (nth 1 e))
name pos)
(unless e (error "No radio list setup defined for %s" major-mode))
(setq name (read-string "List name: "))
(while (string-match "%n" txt)
(setq txt (replace-match name t t txt)))
(or (bolp) (insert "\n"))
(setq pos (point))
(insert txt)
(goto-char pos)))
(defun org-list-send-list (&optional maybe)
"Send a transformed version of this list to the receiver position.
With argument MAYBE, fail quietly if no transformation is defined for
this list."
(interactive)
(catch 'exit
(unless (org-at-item-p) (error "Not at a list item"))
(save-excursion
(re-search-backward "#\\+ORGLST" nil t)
(unless (looking-at "[ \t]*#\\+ORGLST[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
(if maybe
(throw 'exit nil)
(error "Don't know how to transform this list"))))
(let* ((name (match-string 1))
(transform (intern (match-string 2)))
(bottom-point
(save-excursion
(re-search-forward
"\\(\\\\end{comment}\\|@end ignore\\|-->\\)" nil t)
(match-beginning 0)))
(top-point
(progn
(re-search-backward "#\\+ORGLST" nil t)
(re-search-forward org-item-beginning-re bottom-point t)
(match-beginning 0)))
(list (save-restriction
(narrow-to-region top-point bottom-point)
(org-list-parse-list)))
beg txt)
(unless (fboundp transform)
(error "No such transformation function %s" transform))
(let ((txt (funcall transform list)))
;; Find the insertion place
(save-excursion
(goto-char (point-min))
(unless (re-search-forward
(concat "BEGIN RECEIVE ORGLST +"
name
"\\([ \t]\\|$\\)") nil t)
(error "Don't know where to insert translated list"))
(goto-char (match-beginning 0))
(beginning-of-line 2)
(setq beg (point))
(unless (re-search-forward (concat "END RECEIVE ORGLST +" name) nil t)
(error "Cannot find end of insertion region"))
(delete-region beg (point-at-bol))
(goto-char beg)
(insert txt "\n")))
(message "List converted and installed at receiver location"))))
(defun org-list-to-generic (list params)
"Convert a LIST parsed through `org-list-parse-list' to other formats.
Valid parameters PARAMS are
:ustart String to start an unordered list
:uend String to end an unordered list
:ostart String to start an ordered list
:oend String to end an ordered list
:dstart String to start a descriptive list
:dend String to end a descriptive list
:dtstart String to start a descriptive term
:dtend String to end a descriptive term
:ddstart String to start a description
:ddend String to end a description
:splice When set to t, return only list body lines, don't wrap
them into :[u/o]start and :[u/o]end. Default is nil.
:istart String to start a list item
:iend String to end a list item
:isep String to separate items
:lsep String to separate sublists
:cboff String to insert for an unchecked checkbox
:cbon String to insert for a checked checkbox"
(interactive)
(let* ((p params) sublist
(splicep (plist-get p :splice))
(ostart (plist-get p :ostart))
(oend (plist-get p :oend))
(ustart (plist-get p :ustart))
(uend (plist-get p :uend))
(dstart (plist-get p :dstart))
(dend (plist-get p :dend))
(dtstart (plist-get p :dtstart))
(dtend (plist-get p :dtend))
(ddstart (plist-get p :ddstart))
(ddend (plist-get p :ddend))
(istart (plist-get p :istart))
(iend (plist-get p :iend))
(isep (plist-get p :isep))
(lsep (plist-get p :lsep))
(cbon (plist-get p :cbon))
(cboff (plist-get p :cboff))
(export-item
(function
;; Export an item ITEM of type TYPE. First string in item
;; is treated in a special way as it can bring extra
;; information that needs to be processed.
(lambda (item type)
(let ((fmt (if (eq type 'descriptive)
(concat (org-trim istart) "%s" ddend iend isep)
(concat istart "%s" iend isep)))
(first (car item)))
;; Replace checkbox if any is found.
(cond
((string-match "\\[CBON\\]" first)
(setq first (replace-match cbon t t first)))
((string-match "\\[CBOFF\\]" first)
(setq first (replace-match cboff t t first)))
((string-match "\\[-\\]" first)
(setq first (replace-match "$\\boxminus$" t t first))))
;; Insert descriptive term if TYPE is `descriptive'.
(when (and (eq type 'descriptive)
(string-match "^\\(.*\\)[ \t]+::" first))
(setq first (concat
dtstart (org-trim (match-string 1 first)) dtend
ddstart (org-trim (substring first (match-end 0))))))
(setcar item first)
(format fmt (mapconcat
(lambda (e)
(if (stringp e) e (funcall export-sublist e)))
item isep))))))
(export-sublist
(function
;; Export sublist SUB
(lambda (sub)
(let* ((type (car sub))
(items (cdr sub))
(fmt (cond
(splicep "%s")
((eq type 'ordered)
(concat ostart "\n%s" oend))
((eq type 'descriptive)
(concat dstart "\n%s" dend))
(t (concat ustart "\n%s" uend)))))
(format fmt (mapconcat
(lambda (e) (funcall export-item e type))
items lsep)))))))
(concat (funcall export-sublist list) "\n")))
(defun org-list-to-latex (list &optional params)
"Convert LIST into a LaTeX list.
LIST is as returned by `org-list-parse-list'. PARAMS is a property list
with overruling parameters for `org-list-to-generic'."
(org-list-to-generic
list
(org-combine-plists
'(:splicep nil :ostart "\\begin{enumerate}" :oend "\\end{enumerate}"
:ustart "\\begin{itemize}" :uend "\\end{itemize}"
:dstart "\\begin{description}" :dend "\\end{description}"
:dtstart "[" :dtend "] "
:ddstart "" :ddend ""
:istart "\\item " :iend ""
:isep "\n" :lsep "\n"
:cbon "\\texttt{[X]}" :cboff "\\texttt{[ ]}")
params)))
(defun org-list-to-html (list &optional params)
"Convert LIST into a HTML list.
LIST is as returned by `org-list-parse-list'. PARAMS is a property list
with overruling parameters for `org-list-to-generic'."
(org-list-to-generic
list
(org-combine-plists
'(:splicep nil :ostart "<ol>" :oend "</ol>"
:ustart "<ul>" :uend "</ul>"
:dstart "<dl>" :dend "</dl>"
:dtstart "<dt>" :dtend "</dt>"
:ddstart "<dd>" :ddend "</dd>"
:istart "<li>" :iend "</li>"
:isep "\n" :lsep "\n"
:cbon "<code>[X]</code>" :cboff "<code>[ ]</code>")
params)))
(defun org-list-to-texinfo (list &optional params)
"Convert LIST into a Texinfo list.
LIST is as returned by `org-list-parse-list'. PARAMS is a property list
with overruling parameters for `org-list-to-generic'."
(org-list-to-generic
list
(org-combine-plists
'(:splicep nil :ostart "@itemize @minus" :oend "@end itemize"
:ustart "@enumerate" :uend "@end enumerate"
:dstart "@table @asis" :dend "@end table"
:dtstart " " :dtend "\n"
:ddstart "" :ddend ""
:istart "@item\n" :iend ""
:isep "\n" :lsep "\n"
:cbon "@code{[X]}" :cboff "@code{[ ]}")
params)))
(provide 'org-list)
;; arch-tag: 73cf50c1-200f-4d1d-8a53-4e842a5b11c8
;;; org-list.el ends here
View Git Blame Copy Permalink