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
7 ;; Version: 3.02.90 (3.03 RC1)
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.
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,
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
48 (defvar muse-version
"3.02.90"
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."
57 (message muse-version
)))
60 "Options controlling the behavior of Muse.
61 The markup used by Muse is intended to be very friendly to people
65 (defvar muse-under-windows-p
(memq system-type
'(ms-dos windows-nt
)))
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
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
92 (delete (cons (concat "\\." (symbol-value sym
) "\\'")
93 'muse-mode-choose-mode
)
96 ;; associate .muse with muse-mode
97 (when (and (featurep 'muse-mode
)
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
)))
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."
116 (const :tag
"None" nil
)
118 :set
'muse-update-file-extension
121 (defun muse-update-ignored-extensions-regexp (sym val
)
122 "Update the value of `muse-ignored-extensions-regexp'."
125 (setq muse-ignored-extensions-regexp
127 (regexp-quote (or muse-file-extension
"")) "\\|"
128 (mapconcat 'identity val
"\\|")
130 (setq muse-ignored-extensions-regexp
131 (if muse-file-extension
132 (concat "\\.\\(" muse-file-extension
"\\)\\'")
135 (add-hook 'muse-update-values-hook
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.
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
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
)
165 (require 'muse-protocols
)
167 ;;; Return an list of known wiki names and the files they represent.
169 (defsubst muse-delete-file-if-exists
(file)
170 (when (file-exists-p 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
)))))
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
)
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."
194 (unless (and name
(not (string= name
"")))
195 (setq name
(muse-current-file)))
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
)
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
)
210 (let ((buf (get-buffer-create "*Muse warnings*")))
211 (with-current-buffer buf
212 (goto-char (point-max))
213 (insert "Warning (muse): " message
)
219 (defun muse-eval-lisp (form)
220 "Evaluate the given form and return the result as a string."
224 (let ((object (eval (read form
))))
226 ((stringp object
) object
)
228 (not (eq object nil
)))
229 (let ((string (pp-to-string object
)))
230 (substring string
0 (1- (length string
)))))
232 (number-to-string object
))
235 (pp-to-string object
))))
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*")))
250 (with-current-buffer ,temp-buffer
253 (with-current-buffer ,temp-buffer
256 (if (and (boundp 'muse-batch-publishing-p
)
257 muse-batch-publishing-p
)
259 (message "%s: Error occured: %s"
260 (muse-page-name) err
)
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 ;; The following code was extracted from cl
277 (defun muse-const-expr-p (x)
279 (or (eq (car x
) 'quote
)
280 (and (memq (car x
) '(function function
*))
281 (or (symbolp (nth 1 x
))
282 (and (eq (and (consp (nth 1 x
))
283 (car (nth 1 x
))) 'lambda
) 'func
)))))
284 ((symbolp x
) (and (memq x
'(nil t
)) t
))
287 (put 'muse-assertion-failed
'error-conditions
'(error))
288 (put 'muse-assertion-failed
'error-message
"Assertion failed")
290 (defun muse-list* (arg &rest rest
)
291 "Return a new list with specified args as elements, cons'd to last arg.
292 Thus, `(list* A B C D)' is equivalent to `(nconc (list A B C) D)', or to
293 `(cons A (cons B (cons C D)))'."
294 (cond ((not rest
) arg
)
295 ((not (cdr rest
)) (cons arg
(car rest
)))
296 (t (let* ((n (length rest
))
297 (copy (copy-sequence rest
))
298 (last (nthcdr (- n
2) copy
)))
299 (setcdr last
(car (cdr last
)))
302 (defmacro muse-assert
(form &optional show-args string
&rest args
)
303 "Verify that FORM returns non-nil; signal an error if not.
304 Second arg SHOW-ARGS means to include arguments of FORM in message.
305 Other args STRING and ARGS... are arguments to be passed to `error'.
306 They are not evaluated unless the assertion fails. If STRING is
307 omitted, a default message listing FORM itself is used."
313 (and (not (muse-const-expr-p x
)) x
)))
318 (muse-list* 'error string
(append sargs args
))
319 (list 'signal
'(quote muse-assertion-failed
)
320 (muse-list* 'list
(list 'quote form
) sargs
))))
323 ;; Compatibility functions
325 (defun muse-looking-back (regexp &optional limit
)
326 (if (fboundp 'looking-back
)
327 (looking-back regexp limit
)
329 (re-search-backward (concat "\\(?:" regexp
"\\)\\=") limit t
))))
331 (defun muse-line-end-position (&optional n
)
332 (if (fboundp 'line-end-position
)
333 (line-end-position n
)
334 (save-excursion (end-of-line n
) (point))))
336 (defun muse-line-beginning-position (&optional n
)
337 (if (fboundp 'line-beginning-position
)
338 (line-beginning-position n
)
339 (save-excursion (beginning-of-line n
) (point))))
341 (defun muse-match-string-no-properties (num &optional string
)
342 (if (fboundp 'match-string-no-properties
)
343 (match-string-no-properties num string
)
344 (match-string num string
)))
346 (defun muse-replace-regexp-in-string (regexp replacement text
&optional fixedcase literal
)
347 "Replace REGEXP with REPLACEMENT in TEXT.
348 If fourth arg FIXEDCASE is non-nil, do not alter case of replacement text.
349 If fifth arg LITERAL is non-nil, insert REPLACEMENT literally."
351 ((fboundp 'replace-in-string
)
352 (replace-in-string text regexp replacement literal
))
353 ((fboundp 'replace-regexp-in-string
)
354 (replace-regexp-in-string regexp replacement text fixedcase literal
))
355 (t (let ((repl-len (length replacement
))
357 (while (setq start
(string-match regexp text start
))
358 (setq start
(+ start repl-len
)
359 text
(replace-match replacement fixedcase literal text
))))
362 (defun muse-add-to-invisibility-spec (element)
363 "Add ELEMENT to `buffer-invisibility-spec'.
364 See documentation for `buffer-invisibility-spec' for the kind of elements
366 (if (fboundp 'add-to-invisibility-spec
)
367 (add-to-invisibility-spec element
)
368 (if (eq buffer-invisibility-spec t
)
369 (setq buffer-invisibility-spec
(list t
)))
370 (setq buffer-invisibility-spec
371 (cons element buffer-invisibility-spec
))))
373 (defun muse-read-directory-name (prompt &optional dir default-dirname mustmatch initial
)
374 "Read directory name - see `read-file-name' for details."
375 (if (fboundp 'read-directory-name
)
376 (read-directory-name prompt dir default-dirname mustmatch initial
)
378 (setq dir default-directory
))
379 (read-file-name prompt dir
(or default-dirname
380 (if initial
(expand-file-name initial dir
)
384 ;; Set face globally in a predictable fashion
385 (defun muse-copy-face (old new
)
386 "Copy face OLD to NEW."
387 (if (featurep 'xemacs
)
388 (copy-face old new
'all
)
389 (copy-face old new
)))
391 ;; Widget compatibility functions
393 (defun muse-widget-type-value-create (widget)
394 "Convert and instantiate the value of the :type attribute of WIDGET.
395 Store the newly created widget in the :children attribute.
397 The value of the :type attribute should be an unconverted widget type."
398 (let ((value (widget-get widget
:value
))
399 (type (widget-get widget
:type
)))
400 (widget-put widget
:children
401 (list (widget-create-child-value widget
402 (widget-convert type
)
405 (defun muse-widget-child-value-get (widget)
406 "Get the value of the first member of :children in WIDGET."
407 (widget-value (car (widget-get widget
:children
))))
409 (defun muse-widget-type-match (widget value
)
410 "Non-nil if the :type value of WIDGET matches VALUE.
412 The value of the :type attribute should be an unconverted widget type."
413 (widget-apply (widget-convert (widget-get widget
:type
)) :match value
))
415 ;; Link-handling functions and variables
417 (defun muse-get-link (&optional target
)
418 "Based on the match data, retrieve the link.
419 Use TARGET to get the string, if it is specified."
420 (muse-match-string-no-properties 1 target
))
422 (defun muse-get-link-desc (&optional target
)
423 "Based on the match data, retrieve the link description.
424 Use TARGET to get the string, if it is specified."
425 (muse-match-string-no-properties 2 target
))
427 (defun muse-link-escape (text)
428 "Escape characters in TEXT that conflict with the explicit link
432 (muse-replace-regexp-in-string "\\[" "%5B" text t t
)
433 (muse-replace-regexp-in-string "\\]" "%5D" text t t
)
437 (defun muse-link-unescape (text)
438 "Un-escape characters in TEXT that conflict with the explicit
442 (muse-replace-regexp-in-string "%5B" "[" text t t
)
443 (muse-replace-regexp-in-string "%5D" "]" text t t
)
447 (defun muse-handle-url (&optional string
)
448 "If STRING or point has a URL, match and return it."
449 (if (if string
(string-match muse-url-regexp string
)
450 (looking-at muse-url-regexp
))
451 (match-string 0 string
)))
453 (defcustom muse-implicit-link-functions
'(muse-handle-url)
454 "A list of functions to handle an implicit link.
455 An implicit link is one that is not surrounded by brackets.
457 By default, Muse handles URLs only.
458 If you want to handle WikiWords, load muse-wiki.el."
460 :options
'(muse-handle-url)
463 (defun muse-handle-implicit-link (&optional link
)
464 "Handle implicit links. If LINK is not specified, look at point.
465 An implicit link is one that is not surrounded by brackets.
466 By default, Muse handles URLs only.
467 If you want to handle WikiWords, load muse-wiki.el.
469 This function modifies the match data so that match 1 is the
470 link. Match 2 will usually be nil, unless the description is
471 embedded in the text of the buffer.
473 The match data is restored after each unsuccessful handler
474 function call. If LINK is specified, only restore at very end.
476 This behavior is needed because the part of the buffer that
477 `muse-implicit-link-regexp' matches must be narrowed to the part
478 that is an accepted link."
479 (let ((funcs muse-implicit-link-functions
)
481 (data (match-data t
)))
483 (setq res
(funcall (car funcs
) link
))
486 (unless link
(set-match-data data
))
487 (setq funcs
(cdr funcs
))))
488 (when link
(set-match-data data
))
491 (defcustom muse-explicit-link-functions nil
492 "A list of functions to handle an explicit link.
493 An explicit link is one [[like][this]] or [[this]]."
497 (defun muse-handle-explicit-link (&optional link
)
498 "Handle explicit links. If LINK is not specified, look at point.
499 An explicit link is one that looks [[like][this]] or [[this]].
501 This function modifies the match data so that match 1 is the link
502 and match 2 is the description. Perhaps someday match 3 might be
503 the text to use for the alt element of an <a> or <img> tag.
505 The match data is saved. If no handlers are able to process
506 LINK, return LINK (if specified) or the 1st match string. If
507 LINK is not specified, it is assumed that Muse has matched
508 against `muse-explicit-link-regexp' before calling this
510 (let ((funcs muse-explicit-link-functions
)
514 (setq res
(funcall (car funcs
) link
))
517 (setq funcs
(cdr funcs
)))))
521 (or link
(muse-get-link))))))
523 ;; Movement functions
525 (defun muse-list-item-type (str)
526 "Determine the type of list given STR.
527 Returns either 'ul, 'ol, 'dl-term, or 'dl-entry."
528 (cond ((or (string= str
"")
531 ((and (= (aref str
0) ?\
)
535 (string-match (concat "\\`[" muse-regexp-blank
"][0-9]+\\.") str
))
538 (not (string-match (concat "\\`[" muse-regexp-blank
"]*::") str
)))
539 ;; if str is not any kind of list, it will be interpreted as
544 (defun muse-list-item-critical-point (&optional offset
)
545 "Figure out where the important markup character for the
546 currently-matched list item is.
548 If OFFSET is specified, it is the number of groupings outside of
549 the contents of `muse-list-item-regexp'."
550 (unless offset
(setq offset
0))
551 (if (match-end (+ offset
2))
552 ;; at a definition list
553 (match-end (+ offset
2))
554 ;; at a different kind of list
555 (match-beginning (+ offset
1))))
557 (defun muse-forward-paragraph (&optional pattern
)
558 "Move forward safely by one paragraph, or according to PATTERN."
559 (when (get-text-property (point) 'end-list
)
560 (goto-char (next-single-property-change (point) 'end-list
)))
561 (setq pattern
(if pattern
562 (concat "^\\(?:" pattern
"\\|\n\\|\\'\\)")
563 "^\\s-*\\(\n\\|\\'\\)"))
564 (let ((next-list-end (or (next-single-property-change (point) 'end-list
)
567 (if (re-search-forward pattern nil t
)
568 (goto-char (match-beginning 0))
569 (goto-char (point-max)))
570 (when (> (point) next-list-end
)
571 (goto-char next-list-end
))))
573 (defun muse-forward-list-item-1 (type empty-line indented-line
)
574 "Determine whether a nested list item is after point."
575 (if (match-beginning 1)
576 ;; if we are given a dl entry, skip past everything on the same
577 ;; level, except for other dl entries
578 (and (eq type
'dl-entry
)
579 (not (eq (char-after (match-beginning 2)) ?\
:)))
580 ;; blank line encountered with no list item on the same
585 (and (looking-at indented-line
)
586 (not (looking-at empty-line
))))
587 ;; found that this blank line is followed by some
588 ;; indentation, plus other text, so we'll keep
594 (defun muse-forward-list-item (type indent
&optional no-skip-nested
)
595 "Move forward to the next item of TYPE.
596 Return non-nil if successful, nil otherwise.
597 The beginning indentation is given by INDENT.
599 If NO-SKIP-NESTED is non-nil, do not skip past nested items.
600 Note that if you desire this behavior, you will also need to
601 provide a very liberal INDENT value, such as
602 \(concat \"[\" muse-regexp-blank \"]*\")."
603 (let* ((list-item (format muse-list-item-regexp indent
))
604 (empty-line (concat "^[" muse-regexp-blank
"]*\n"))
605 (indented-line (concat "^" indent
"[" muse-regexp-blank
"]"))
606 (list-pattern (concat "\\(?:" empty-line
"\\)?"
607 "\\(" list-item
"\\)")))
609 (muse-forward-paragraph list-pattern
)
610 ;; make sure we don't go past boundary
611 (and (not (or (get-text-property (point) 'end-list
)
612 (>= (point) (point-max))))
613 ;; move past markup that is part of another construct
614 (or (and (match-beginning 1)
615 (or (get-text-property
616 (muse-list-item-critical-point 1) 'muse-link
)
618 (muse-list-item-critical-point 1) 'face
)))
620 (and (not no-skip-nested
)
621 (muse-forward-list-item-1 type empty-line
623 (cond ((or (get-text-property (point) 'end-list
)
624 (>= (point) (point-max)))
625 ;; at a list boundary, so stop
627 ((and (match-string 2)
628 (eq type
(muse-list-item-type (match-string 2))))
629 ;; same type, so indicate that there are more items to be
631 (goto-char (match-beginning 1)))
633 (when (match-beginning 1)
634 (goto-char (match-beginning 1)))
635 ;; move to just before foreign list item markup
640 ;;; muse.el ends here