Trim whitespace from table fields.
[muse-el.git] / lisp / muse.el
blob2dafa8a1fc9e52881c7d3a4e601167062ab530b7
1 ;;; muse.el --- an authoring and publishing tool for Emacs
3 ;; Copyright (C) 2004, 2005, 2006 Free Software Foundation, Inc.
5 ;; Emacs Lisp Archive Entry
6 ;; Filename: muse.el
7 ;; Version: 3.02.91 (3.03 RC2)
8 ;; Date: Fri 7-Apr-2006
9 ;; Keywords: hypermedia
10 ;; Author: John Wiegley (johnw AT gnu DOT org)
11 ;; Maintainer: Michael Olson (mwolson AT gnu DOT org)
12 ;; Description: An authoring and publishing tool for Emacs
13 ;; URL: http://www.mwolson.org/projects/EmacsMuse.html
14 ;; Compatibility: Emacs21 XEmacs21 Emacs22
16 ;; This file is part of Emacs Muse. It is not part of GNU Emacs.
18 ;; Emacs Muse is free software; you can redistribute it and/or modify
19 ;; it under the terms of the GNU General Public License as published
20 ;; by the Free Software Foundation; either version 2, or (at your
21 ;; option) any later version.
23 ;; Emacs Muse is distributed in the hope that it will be useful, but
24 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
25 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
26 ;; General Public License for more details.
28 ;; You should have received a copy of the GNU General Public License
29 ;; along with Emacs Muse; see the file COPYING. If not, write to the
30 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
31 ;; Boston, MA 02110-1301, USA.
33 ;;; Commentary:
35 ;; Muse is a tool for easily authoring and publishing documents. It
36 ;; allows for rapid prototyping of hyperlinked text, which may then be
37 ;; exported to multiple output formats -- such as HTML, LaTeX,
38 ;; Texinfo, etc.
40 ;; The markup rules used by Muse are intended to be very friendly to
41 ;; people familiar with Emacs. See the included manual for more
42 ;; information.
44 ;;; Contributors:
46 ;;; Code:
48 (defvar muse-version "3.02.91"
49 "The version of Muse currently loaded")
51 (defun muse-version (&optional insert)
52 "Display the version of Muse that is currently loaded.
53 If INSERT is non-nil, insert the text instead of displaying it."
54 (interactive "P")
55 (if insert
56 (insert muse-version)
57 (message muse-version)))
59 (defgroup muse nil
60 "Options controlling the behavior of Muse.
61 The markup used by Muse is intended to be very friendly to people
62 familiar with Emacs."
63 :group 'hypermedia)
65 (defvar muse-under-windows-p (memq system-type '(ms-dos windows-nt)))
67 (require 'wid-edit)
68 (require 'muse-regexps)
70 (defvar muse-update-values-hook nil
71 "Hook for values that are automatically generated.
72 This is to be used by add-on modules for Muse.
73 It is run just before colorizing or publishing a buffer.")
75 ;; Default file extension
77 (eval-when-compile
78 (defvar muse-ignored-extensions))
80 (defvar muse-ignored-extensions-regexp nil
81 "A regexp of extensions to omit from the ending of a Muse page name.
82 This is autogenerated from `muse-ignored-extensions'.")
84 (defun muse-update-file-extension (sym val)
85 "Update the value of `muse-file-extension'."
86 (when (and (featurep 'muse-mode)
87 (boundp sym) (stringp (symbol-value sym))
88 (or (not (stringp val))
89 (not (string= (symbol-value sym) val))))
90 ;; remove old auto-mode-alist association
91 (setq auto-mode-alist
92 (delete (cons (concat "\\." (symbol-value sym) "\\'")
93 'muse-mode-choose-mode)
94 auto-mode-alist)))
95 (set sym val)
96 ;; associate .muse with muse-mode
97 (when (and (featurep 'muse-mode)
98 (stringp val)
99 (or (not (stringp (symbol-value sym)))
100 (not (string= (symbol-value sym) val))))
101 (add-to-list 'auto-mode-alist
102 (cons (concat "\\." val "\\'")
103 'muse-mode-choose-mode)))
104 ;; update the ignored extensions regexp
105 (when (and (fboundp 'muse-update-ignored-extensions-regexp)
106 (or (not (stringp (symbol-value sym)))
107 (not (stringp val))
108 (not (string= (symbol-value sym) val))))
109 (muse-update-ignored-extensions-regexp
110 'muse-ignored-extensions muse-ignored-extensions)))
112 (defcustom muse-file-extension "muse"
113 "File extension of Muse files. Omit the period at the beginning.
114 If you don't want Muse files to have an extension, set this to nil."
115 :type '(choice
116 (const :tag "None" nil)
117 (string))
118 :set 'muse-update-file-extension
119 :group 'muse)
121 (defun muse-update-ignored-extensions-regexp (sym val)
122 "Update the value of `muse-ignored-extensions-regexp'."
123 (set sym val)
124 (if val
125 (setq muse-ignored-extensions-regexp
126 (concat "\\.\\("
127 (regexp-quote (or muse-file-extension "")) "\\|"
128 (mapconcat 'identity val "\\|")
129 "\\)\\'"))
130 (setq muse-ignored-extensions-regexp
131 (if muse-file-extension
132 (concat "\\.\\(" muse-file-extension "\\)\\'")
133 nil))))
135 (add-hook 'muse-update-values-hook
136 (lambda ()
137 (muse-update-ignored-extensions-regexp
138 'muse-ignored-extensions muse-ignored-extensions)))
140 (defcustom muse-ignored-extensions '("bz2" "gz" "[Zz]")
141 "A list of extensions to omit from the ending of a Muse page name.
142 These are regexps.
144 Don't put a period at the beginning of each extension unless you
145 understand that it is part of a regexp."
146 :type '(repeat (regexp :tag "Extension"))
147 :set 'muse-update-ignored-extensions-regexp
148 :group 'muse)
150 (add-to-list 'auto-mode-alist
151 (cons (concat "\\." muse-file-extension "\\'")
152 'muse-mode-choose-mode))
154 (defun muse-update-file-extension-after-init ()
155 ;; This is short, but it has to be a function, otherwise Emacs21
156 ;; does not load it properly when running after-init-hook
157 (muse-update-file-extension 'muse-file-extension muse-file-extension))
159 ;; Once the user's init file has been processed, determine whether
160 ;; they want a file extension
161 (add-hook 'after-init-hook 'muse-update-file-extension-after-init)
163 ;; URL protocols
165 (require 'muse-protocols)
167 ;; Helper functions
169 (defsubst muse-delete-file-if-exists (file)
170 (when (file-exists-p file)
171 (delete-file file)
172 (message "Removed %s" file)))
174 (defsubst muse-time-less-p (t1 t2)
175 "Say whether time T1 is less than time T2."
176 (or (< (car t1) (car t2))
177 (and (= (car t1) (car t2))
178 (< (nth 1 t1) (nth 1 t2)))))
180 (eval-when-compile
181 (defvar muse-publishing-current-file nil))
183 (defun muse-current-file ()
184 "Return the name of the currently visited or published file."
185 (or (and (boundp 'muse-publishing-current-file)
186 muse-publishing-current-file)
187 (buffer-file-name)
188 (concat default-directory (buffer-name))))
190 (defun muse-page-name (&optional name)
191 "Return the canonical form of a Muse page name.
192 All this means is that certain extensions, like .gz, are removed."
193 (save-match-data
194 (unless (and name (not (string= name "")))
195 (setq name (muse-current-file)))
196 (if name
197 (let ((page (file-name-nondirectory name)))
198 (if (and muse-ignored-extensions-regexp
199 (string-match muse-ignored-extensions-regexp page))
200 (replace-match "" t t page)
201 page)))))
203 (defun muse-display-warning (message)
204 "Display the given MESSAGE as a warning."
205 (if (fboundp 'display-warning)
206 (display-warning 'muse message
207 (if (featurep 'xemacs)
208 'warning
209 :warning))
210 (let ((buf (get-buffer-create "*Muse warnings*")))
211 (with-current-buffer buf
212 (goto-char (point-max))
213 (insert "Warning (muse): " message)
214 (unless (bolp)
215 (newline)))
216 (display-buffer buf)
217 (sit-for 0))))
219 (defun muse-eval-lisp (form)
220 "Evaluate the given form and return the result as a string."
221 (require 'pp)
222 (save-match-data
223 (condition-case err
224 (let ((object (eval (read form))))
225 (cond
226 ((stringp object) object)
227 ((and (listp object)
228 (not (eq object nil)))
229 (let ((string (pp-to-string object)))
230 (substring string 0 (1- (length string)))))
231 ((numberp object)
232 (number-to-string object))
233 ((eq object nil) "")
235 (pp-to-string object))))
236 (error
237 (muse-display-warning (format "%s: Error evaluating %s: %s"
238 (muse-page-name) form err))
239 "; INVALID LISP CODE"))))
241 (defmacro muse-with-temp-buffer (&rest body)
242 "Create a temporary buffer, and evaluate BODY there like `progn'.
243 See also `with-temp-file' and `with-output-to-string'.
244 Unlike `with-temp-buffer', this will never attempt to save the temp buffer.
245 It is meant to be used along with `insert-file-contents'."
246 (let ((temp-buffer (make-symbol "temp-buffer")))
247 `(let ((,temp-buffer (generate-new-buffer " *muse-temp*")))
248 (unwind-protect
249 (if debug-on-error
250 (with-current-buffer ,temp-buffer
251 ,@body)
252 (condition-case err
253 (with-current-buffer ,temp-buffer
254 ,@body)
255 (error
256 (if (and (boundp 'muse-batch-publishing-p)
257 muse-batch-publishing-p)
258 (progn
259 (message "%s: Error occured: %s"
260 (muse-page-name) err)
261 (backtrace))
262 (muse-display-warning
263 (format (concat "An error occurred while publishing"
264 " %s: %s\n\nSet debug-on-error to"
265 " `t' if you would like a backtrace.")
266 (muse-page-name) err))))))
267 (when (buffer-live-p ,temp-buffer)
268 (with-current-buffer ,temp-buffer
269 (set-buffer-modified-p nil))
270 (unless debug-on-error (kill-buffer ,temp-buffer)))))))
272 (put 'muse-with-temp-buffer 'lisp-indent-function 0)
273 (put 'muse-with-temp-buffer 'edebug-form-spec '(body))
275 (defun muse-collect-alist (list element &optional test)
276 "Collect items from LIST whose car is equal to ELEMENT.
277 If TEST is specified, use it to compare ELEMENT."
278 (unless test (setq test 'equal))
279 (let ((items nil))
280 (dolist (item list)
281 (when (funcall test element (car item))
282 (setq items (cons item items))))
283 items))
285 (defmacro muse-sort-with-closure (list predicate closure)
286 "Sort LIST, stably, comparing elements using PREDICATE.
287 Returns the sorted list. LIST is modified by side effects.
288 PREDICATE is called with two elements of list and CLOSURE.
289 PREDICATE should return non-nil if the first element should sort
290 before the second."
291 `(sort ,list (lambda (a b) (funcall ,predicate a b ,closure))))
293 (put 'muse-sort-with-closure 'lisp-indent-function 0)
294 (put 'muse-sort-with-closure 'edebug-form-spec '(form function-form form))
296 (defun muse-sort-by-rating (rated-list &optional test)
297 "Sort RATED-LIST according to the rating of each element.
298 The rating is stripped out in the returned list.
299 Default sorting is highest-first.
301 If TEST if specified, use it to sort the list."
302 (unless test (setq test '>))
303 (mapcar (function cdr)
304 (muse-sort-with-closure
305 rated-list
306 (lambda (a b closure)
307 (let ((na (numberp (car a)))
308 (nb (numberp (car b))))
309 (cond ((and na nb) (funcall closure (car a) (car b)))
310 (na (not nb))
311 (t nil))))
312 test)))
314 (defun muse-escape-specials-in-string (specials string &optional reverse)
315 "Apply the transformations in SPECIALS to STRING.
317 The transforms should form a fully reversible and non-ambiguous
318 syntax when STRING is parsed from left to right.
320 If REVERSE is specified, reverse an already-escaped string."
321 (let ((rules (mapcar (lambda (rule)
322 (cons (regexp-quote (if reverse
323 (cdr rule)
324 (car rule)))
325 (if reverse (car rule) (cdr rule))))
326 specials)))
327 (with-temp-buffer
328 (insert string)
329 (goto-char (point-min))
330 (save-match-data
331 (while (not (eobp))
332 (unless (catch 'found
333 (dolist (rule rules)
334 (when (looking-at (car rule))
335 (replace-match (cdr rule) t t)
336 (throw 'found t))))
337 (forward-char))))
338 (buffer-string))))
340 (defun muse-trim-whitespace (string)
341 "Return a version of STRING with no initial nor trailing whitespace."
342 (muse-replace-regexp-in-string
343 (concat "\\`[" muse-regexp-blank "]+\\|[" muse-regexp-blank "]+\\'")
344 "" string))
346 ;; The following code was extracted from cl
348 (defun muse-const-expr-p (x)
349 (cond ((consp x)
350 (or (eq (car x) 'quote)
351 (and (memq (car x) '(function function*))
352 (or (symbolp (nth 1 x))
353 (and (eq (and (consp (nth 1 x))
354 (car (nth 1 x))) 'lambda) 'func)))))
355 ((symbolp x) (and (memq x '(nil t)) t))
356 (t t)))
358 (put 'muse-assertion-failed 'error-conditions '(error))
359 (put 'muse-assertion-failed 'error-message "Assertion failed")
361 (defun muse-list* (arg &rest rest)
362 "Return a new list with specified args as elements, cons'd to last arg.
363 Thus, `(list* A B C D)' is equivalent to `(nconc (list A B C) D)', or to
364 `(cons A (cons B (cons C D)))'."
365 (cond ((not rest) arg)
366 ((not (cdr rest)) (cons arg (car rest)))
367 (t (let* ((n (length rest))
368 (copy (copy-sequence rest))
369 (last (nthcdr (- n 2) copy)))
370 (setcdr last (car (cdr last)))
371 (cons arg copy)))))
373 (defmacro muse-assert (form &optional show-args string &rest args)
374 "Verify that FORM returns non-nil; signal an error if not.
375 Second arg SHOW-ARGS means to include arguments of FORM in message.
376 Other args STRING and ARGS... are arguments to be passed to `error'.
377 They are not evaluated unless the assertion fails. If STRING is
378 omitted, a default message listing FORM itself is used."
379 (let ((sargs
380 (and show-args
381 (delq nil (mapcar
382 (function
383 (lambda (x)
384 (and (not (muse-const-expr-p x)) x)))
385 (cdr form))))))
386 (list 'progn
387 (list 'or form
388 (if string
389 (muse-list* 'error string (append sargs args))
390 (list 'signal '(quote muse-assertion-failed)
391 (muse-list* 'list (list 'quote form) sargs))))
392 nil)))
394 ;; Compatibility functions
396 (defun muse-looking-back (regexp &optional limit)
397 (if (fboundp 'looking-back)
398 (looking-back regexp limit)
399 (save-excursion
400 (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t))))
402 (defun muse-line-end-position (&optional n)
403 (if (fboundp 'line-end-position)
404 (line-end-position n)
405 (save-excursion (end-of-line n) (point))))
407 (defun muse-line-beginning-position (&optional n)
408 (if (fboundp 'line-beginning-position)
409 (line-beginning-position n)
410 (save-excursion (beginning-of-line n) (point))))
412 (defun muse-match-string-no-properties (num &optional string)
413 (if (fboundp 'match-string-no-properties)
414 (match-string-no-properties num string)
415 (match-string num string)))
417 (defun muse-replace-regexp-in-string (regexp replacement text &optional fixedcase literal)
418 "Replace REGEXP with REPLACEMENT in TEXT.
420 Return a new string containing the replacements.
422 If fourth arg FIXEDCASE is non-nil, do not alter case of replacement text.
423 If fifth arg LITERAL is non-nil, insert REPLACEMENT literally."
424 (cond
425 ((fboundp 'replace-in-string)
426 (replace-in-string text regexp replacement literal))
427 ((fboundp 'replace-regexp-in-string)
428 (replace-regexp-in-string regexp replacement text fixedcase literal))
429 (t (let ((repl-len (length replacement))
430 start)
431 (save-match-data
432 (while (setq start (string-match regexp text start))
433 (setq start (+ start repl-len)
434 text (replace-match replacement fixedcase literal text)))))
435 text)))
437 (defun muse-add-to-invisibility-spec (element)
438 "Add ELEMENT to `buffer-invisibility-spec'.
439 See documentation for `buffer-invisibility-spec' for the kind of elements
440 that can be added."
441 (if (fboundp 'add-to-invisibility-spec)
442 (add-to-invisibility-spec element)
443 (if (eq buffer-invisibility-spec t)
444 (setq buffer-invisibility-spec (list t)))
445 (setq buffer-invisibility-spec
446 (cons element buffer-invisibility-spec))))
448 (defun muse-read-directory-name (prompt &optional dir default-dirname mustmatch initial)
449 "Read directory name - see `read-file-name' for details."
450 (if (fboundp 'read-directory-name)
451 (read-directory-name prompt dir default-dirname mustmatch initial)
452 (unless dir
453 (setq dir default-directory))
454 (read-file-name prompt dir (or default-dirname
455 (if initial (expand-file-name initial dir)
456 dir))
457 mustmatch initial)))
459 (defun muse-file-remote-p (file)
460 "Test whether FILE specifies a location on a remote system.
461 Return non-nil if the location is indeed remote.
463 For example, the filename \"/user@host:/foo\" specifies a location
464 on the system \"/user@host:\"."
465 (cond ((fboundp 'file-remote-p)
466 (file-remote-p file))
467 ((fboundp 'tramp-handle-file-remote-p)
468 (tramp-handle-file-remote-p file))
469 ((and (boundp 'ange-ftp-name-format)
470 (string-match ange-ftp-name-format file))
472 (t nil)))
474 ;; Set face globally in a predictable fashion
475 (defun muse-copy-face (old new)
476 "Copy face OLD to NEW."
477 (if (featurep 'xemacs)
478 (copy-face old new 'all)
479 (copy-face old new)))
481 ;; Widget compatibility functions
483 (defun muse-widget-type-value-create (widget)
484 "Convert and instantiate the value of the :type attribute of WIDGET.
485 Store the newly created widget in the :children attribute.
487 The value of the :type attribute should be an unconverted widget type."
488 (let ((value (widget-get widget :value))
489 (type (widget-get widget :type)))
490 (widget-put widget :children
491 (list (widget-create-child-value widget
492 (widget-convert type)
493 value)))))
495 (defun muse-widget-child-value-get (widget)
496 "Get the value of the first member of :children in WIDGET."
497 (widget-value (car (widget-get widget :children))))
499 (defun muse-widget-type-match (widget value)
500 "Non-nil if the :type value of WIDGET matches VALUE.
502 The value of the :type attribute should be an unconverted widget type."
503 (widget-apply (widget-convert (widget-get widget :type)) :match value))
505 ;; Link-handling functions and variables
507 (defun muse-get-link (&optional target)
508 "Based on the match data, retrieve the link.
509 Use TARGET to get the string, if it is specified."
510 (muse-match-string-no-properties 1 target))
512 (defun muse-get-link-desc (&optional target)
513 "Based on the match data, retrieve the link description.
514 Use TARGET to get the string, if it is specified."
515 (muse-match-string-no-properties 2 target))
517 (defvar muse-link-specials
518 '(("[" . "%5B")
519 ("]" . "%5D")
520 ("%" . "%%"))
521 "Syntax used for escaping and unescaping links.
522 This allows brackets to occur in explicit links as long as you
523 use the standard Muse functions to create them.")
525 (defun muse-link-escape (text)
526 "Escape characters in TEXT that conflict with the explicit link
527 regexp."
528 (when (stringp text)
529 (muse-escape-specials-in-string muse-link-specials text)))
531 (defun muse-link-unescape (text)
532 "Un-escape characters in TEXT that conflict with the explicit
533 link regexp."
534 (when (stringp text)
535 (muse-escape-specials-in-string muse-link-specials text t)))
537 (defun muse-handle-url (&optional string)
538 "If STRING or point has a URL, match and return it."
539 (if (if string (string-match muse-url-regexp string)
540 (looking-at muse-url-regexp))
541 (match-string 0 string)))
543 (defcustom muse-implicit-link-functions '(muse-handle-url)
544 "A list of functions to handle an implicit link.
545 An implicit link is one that is not surrounded by brackets.
547 By default, Muse handles URLs only.
548 If you want to handle WikiWords, load muse-wiki.el."
549 :type 'hook
550 :options '(muse-handle-url)
551 :group 'muse)
553 (defun muse-handle-implicit-link (&optional link)
554 "Handle implicit links. If LINK is not specified, look at point.
555 An implicit link is one that is not surrounded by brackets.
556 By default, Muse handles URLs only.
557 If you want to handle WikiWords, load muse-wiki.el.
559 This function modifies the match data so that match 1 is the
560 link. Match 2 will usually be nil, unless the description is
561 embedded in the text of the buffer.
563 The match data is restored after each unsuccessful handler
564 function call. If LINK is specified, only restore at very end.
566 This behavior is needed because the part of the buffer that
567 `muse-implicit-link-regexp' matches must be narrowed to the part
568 that is an accepted link."
569 (let ((funcs muse-implicit-link-functions)
570 (res nil)
571 (data (match-data t)))
572 (while funcs
573 (setq res (funcall (car funcs) link))
574 (if res
575 (setq funcs nil)
576 (unless link (set-match-data data))
577 (setq funcs (cdr funcs))))
578 (when link (set-match-data data))
579 res))
581 (defcustom muse-explicit-link-functions nil
582 "A list of functions to handle an explicit link.
583 An explicit link is one [[like][this]] or [[this]]."
584 :type 'hook
585 :group 'muse)
587 (defun muse-handle-explicit-link (&optional link)
588 "Handle explicit links. If LINK is not specified, look at point.
589 An explicit link is one that looks [[like][this]] or [[this]].
591 This function modifies the match data so that match 1 is the link
592 and match 2 is the description. Perhaps someday match 3 might be
593 the text to use for the alt element of an <a> or <img> tag.
595 The match data is saved. If no handlers are able to process
596 LINK, return LINK (if specified) or the 1st match string. If
597 LINK is not specified, it is assumed that Muse has matched
598 against `muse-explicit-link-regexp' before calling this
599 function."
600 (let ((funcs muse-explicit-link-functions)
601 (res nil))
602 (save-match-data
603 (while funcs
604 (setq res (funcall (car funcs) link))
605 (if res
606 (setq funcs nil)
607 (setq funcs (cdr funcs)))))
608 (muse-link-unescape
609 (if res
611 (or link (muse-get-link))))))
613 ;; Movement functions
615 (defun muse-list-item-type (str)
616 "Determine the type of list given STR.
617 Returns either 'ul, 'ol, 'dl-term, or 'dl-entry."
618 (cond ((or (string= str "")
619 (< (length str) 2))
620 nil)
621 ((and (= (aref str 0) ?\ )
622 (= (aref str 1) ?-))
623 'ul)
624 ((save-match-data
625 (string-match (concat "\\`[" muse-regexp-blank "][0-9]+\\.") str))
626 'ol)
627 ((save-match-data
628 (not (string-match (concat "\\`[" muse-regexp-blank "]*::") str)))
629 ;; if str is not any kind of list, it will be interpreted as
630 ;; a dl-term
631 'dl-term)
632 (t 'dl-entry)))
634 (defun muse-list-item-critical-point (&optional offset)
635 "Figure out where the important markup character for the
636 currently-matched list item is.
638 If OFFSET is specified, it is the number of groupings outside of
639 the contents of `muse-list-item-regexp'."
640 (unless offset (setq offset 0))
641 (if (match-end (+ offset 2))
642 ;; at a definition list
643 (match-end (+ offset 2))
644 ;; at a different kind of list
645 (match-beginning (+ offset 1))))
647 (defun muse-forward-paragraph (&optional pattern)
648 "Move forward safely by one paragraph, or according to PATTERN."
649 (when (get-text-property (point) 'end-list)
650 (goto-char (next-single-property-change (point) 'end-list)))
651 (setq pattern (if pattern
652 (concat "^\\(?:" pattern "\\|\n\\|\\'\\)")
653 "^\\s-*\\(\n\\|\\'\\)"))
654 (let ((next-list-end (or (next-single-property-change (point) 'end-list)
655 (point-max))))
656 (forward-line 1)
657 (if (re-search-forward pattern nil t)
658 (goto-char (match-beginning 0))
659 (goto-char (point-max)))
660 (when (> (point) next-list-end)
661 (goto-char next-list-end))))
663 (defun muse-forward-list-item-1 (type empty-line indented-line)
664 "Determine whether a nested list item is after point."
665 (if (match-beginning 1)
666 ;; if we are given a dl entry, skip past everything on the same
667 ;; level, except for other dl entries
668 (and (eq type 'dl-entry)
669 (not (eq (char-after (match-beginning 2)) ?\:)))
670 ;; blank line encountered with no list item on the same
671 ;; level after it
672 (let ((beg (point)))
673 (forward-line 1)
674 (if (save-match-data
675 (and (looking-at indented-line)
676 (not (looking-at empty-line))))
677 ;; found that this blank line is followed by some
678 ;; indentation, plus other text, so we'll keep
679 ;; going
681 (goto-char beg)
682 nil))))
684 (defun muse-forward-list-item (type indent &optional no-skip-nested)
685 "Move forward to the next item of TYPE.
686 Return non-nil if successful, nil otherwise.
687 The beginning indentation is given by INDENT.
689 If NO-SKIP-NESTED is non-nil, do not skip past nested items.
690 Note that if you desire this behavior, you will also need to
691 provide a very liberal INDENT value, such as
692 \(concat \"[\" muse-regexp-blank \"]*\")."
693 (let* ((list-item (format muse-list-item-regexp indent))
694 (empty-line (concat "^[" muse-regexp-blank "]*\n"))
695 (indented-line (concat "^" indent "[" muse-regexp-blank "]"))
696 (list-pattern (concat "\\(?:" empty-line "\\)?"
697 "\\(" list-item "\\)")))
698 (while (progn
699 (muse-forward-paragraph list-pattern)
700 ;; make sure we don't go past boundary
701 (and (not (or (get-text-property (point) 'end-list)
702 (>= (point) (point-max))))
703 ;; move past markup that is part of another construct
704 (or (and (match-beginning 1)
705 (or (get-text-property
706 (muse-list-item-critical-point 1) 'muse-link)
707 (get-text-property
708 (muse-list-item-critical-point 1) 'face)))
709 ;; skip nested items
710 (and (not no-skip-nested)
711 (muse-forward-list-item-1 type empty-line
712 indented-line))))))
713 (cond ((or (get-text-property (point) 'end-list)
714 (>= (point) (point-max)))
715 ;; at a list boundary, so stop
716 nil)
717 ((and (match-string 2)
718 (eq type (muse-list-item-type (match-string 2))))
719 ;; same type, so indicate that there are more items to be
720 ;; parsed
721 (goto-char (match-beginning 1)))
723 (when (match-beginning 1)
724 (goto-char (match-beginning 1)))
725 ;; move to just before foreign list item markup
726 nil))))
728 (provide 'muse)
730 ;;; muse.el ends here