lisp/muse-publish.el

   1 ;;; muse-publish.el --- base publishing implementation
   2
   3 ;; Copyright (C) 2004, 2005, 2006 Free Software Foundation, Inc.
   4
   5 ;; This file is part of Emacs Muse.  It is not part of GNU Emacs.
   6
   7 ;; Emacs Muse is free software; you can redistribute it and/or modify
   8 ;; it under the terms of the GNU General Public License as published
   9 ;; by the Free Software Foundation; either version 2, or (at your
  10 ;; option) any later version.
  11
  12 ;; Emacs Muse is distributed in the hope that it will be useful, but
  13 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
  14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 ;; General Public License for more details.
  16
  17 ;; You should have received a copy of the GNU General Public License
  18 ;; along with Emacs Muse; see the file COPYING.  If not, write to the
  19 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  20 ;; Boston, MA 02110-1301, USA.
  21
  22 ;;; Commentary:
  23
  24 ;;; Contributors:
  25
  26 ;; Yann Hodique (yann DOT hodique AT gmail DOT com) fixed an
  27 ;; unnecessary URL description transform in `muse-publish-url'.
  28
  29 ;; Peter K. Lee (saint AT corenova DOT com) provided the
  30 ;; `muse-style-elements-list' function.
  31
  32 ;; Jim Ottaway (j DOT ottaway AT lse DOT ac DOT uk) provided a
  33 ;; reference implementation for nested lists.
  34
  35 ;;; Code:
  36
  37 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  38 ;;
  39 ;; Muse Publishing
  40 ;;
  41 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  42
  43 (require 'muse)
  44 (require 'muse-regexps)
  45
  46 (defgroup muse-publish nil
  47   "Options controlling the general behavior of Muse publishing."
  48   :group 'muse)
  49
  50 (defcustom muse-before-publish-hook nil
  51   "A hook run in the buffer to be published, before it is done."
  52   :type 'hook
  53   :group 'muse-publish)
  54
  55 (defcustom muse-after-publish-hook nil
  56   "A hook run in the buffer to be published, after it is done."
  57   :type 'hook
  58   :group 'muse-publish)
  59
  60 (defcustom muse-publish-url-transforms
  61   '(muse-resolve-url)
  62   "A list of functions used to prepare URLs for publication.
  63 Each is passed the URL.  The transformed URL should be returned."
  64   :type 'hook
  65   :options '(muse-resolve-url)
  66   :group 'muse-publish)
  67
  68 (defcustom muse-publish-desc-transforms nil
  69   "A list of functions used to prepare URL desciptions for publication.
  70 Each is passed the description.  The modified description should
  71 be returned."
  72   :type 'hook
  73   :group 'muse-publish)
  74
  75 (defcustom muse-publish-comments-p nil
  76   "If nil, remove comments before publishing.
  77 If non-nil, publish comments using the markup of the current style."
  78   :type 'boolean
  79   :group 'muse-publish)
  80
  81 (defcustom muse-publish-report-threshhold 100000
  82   "If a file is this size or larger, report publishing progress."
  83   :type 'integer
  84   :group 'muse-publish)
  85
  86 (defcustom muse-publish-markup-regexps
  87   `(;; Remove leading and trailing whitespace from the file
  88     (1000 "\\(\\`\n+\\|\n+\\'\\)" 0 "")
  89
  90     ;; Remove trailing whitespace from all lines
  91     (1100 ,(concat "[" muse-regexp-blank "]+$") 0 "")
  92
  93     ;; Handle any leading #directives
  94     (1200 "\\`#\\([a-zA-Z-]+\\)\\s-+\\(.+\\)\n+" 0 directive)
  95
  96     ;; markup tags
  97     (1300 muse-tag-regexp 0 tag)
  98
  99     ;; commented lines
 100     (1350 "^;\\s-+\\(.+\\)" 0 comment)
 101
 102     ;; prevent emphasis characters in explicit links from being marked
 103     (1400 muse-explicit-link-regexp 0 muse-publish-mark-noemphasis)
 104
 105     ;; define anchor points
 106     (1500 "^\\(\\W*\\)#\\(\\S-+\\)\\s-*" 0 anchor)
 107
 108     ;; emphasized or literal text
 109     (1600 ,(concat "\\(^\\|[-[" muse-regexp-blank
 110                    "<('`\"\n]\\)\\(=[^=" muse-regexp-blank
 111                    "\n]\\|_[^_" muse-regexp-blank
 112                    "\n]\\|\\*+[^*" muse-regexp-blank
 113                    "\n]\\)")
 114           2 word)
 115
 116     ;; headings, outline-mode style
 117     (1700 "^\\(\\*+\\)\\s-+" 0 heading)
 118
 119     ;; ellipses
 120     (1800 "\\.\\.\\.\\." 0 enddots)
 121     (1850 "\\.\\.\\." 0 dots)
 122
 123     ;; horizontal rule, or section separator
 124     (1900 "^----+" 0 rule)
 125
 126     ;; non-breaking space
 127     (1950 "~~" 0 no-break-space)
 128
 129     ;; beginning of footnotes section
 130     (2000 "^Footnotes:?\\s-*" 0 fn-sep)
 131     ;; footnote definition/reference (def if at beginning of line)
 132     (2100 "\\[\\([1-9][0-9]*\\)\\]" 0 footnote)
 133
 134     ;; unnumbered List items begin with a -.  numbered list items
 135     ;; begin with number and a period.  definition lists have a
 136     ;; leading term separated from the body with ::.  centered
 137     ;; paragraphs begin with at least six columns of whitespace; any
 138     ;; other whitespace at the beginning indicates a blockquote.  The
 139     ;; reason all of these rules are handled here, is so that
 140     ;; blockquote detection doesn't interfere with indented list
 141     ;; members.
 142
 143     (2200 ,(format muse-list-item-regexp (concat "[" muse-regexp-blank "]*"))
 144           0 list)
 145
 146     (2400 ,(concat "^\\([" muse-regexp-blank "]+\\).+") 0 quote)
 147
 148     (2500 ,(concat "\\(^\\|[" muse-regexp-blank "]+\\)--\\($\\|["
 149                    muse-regexp-blank "]+\\)")
 150           0 emdash)
 151
 152     ;; "verse" text is indicated the same way as a quoted e-mail
 153     ;; response: "> text", where text may contain initial whitespace
 154     ;; (see below).
 155     (2600 ,(concat "^[" muse-regexp-blank "]*> ") 0 verse)
 156
 157     ;; simple table markup is supported, nothing fancy.  use | to
 158     ;; separate cells, || to separate header cells, and ||| for footer
 159     ;; cells
 160     (2700 ,(concat "\\(\\([" muse-regexp-blank "]*\n\\)?"
 161                    "\\(" muse-table-line-regexp "\\(?:\n\\|\\'\\)\\)\\)+")
 162           0 table)
 163
 164     ;; replace links in the buffer (links to other pages)
 165     (2900 muse-explicit-link-regexp 0 link)
 166
 167     ;; bare URLs
 168     (3000 muse-url-regexp 0 url)
 169
 170     ;; bare email addresses
 171     (3500
 172      "\\([^[]\\)[-a-zA-Z0-9._]+@\\([-a-zA-z0-9_]+\\.\\)+[a-zA-Z0-9]+" 0 email)
 173     )
 174   "List of markup rules for publishing a page with Muse.
 175 The rules given in this variable are invoked first, followed by
 176 whatever rules are specified by the current style.
 177
 178 Each member of the list is either a function, or a list of the form:
 179
 180   (REGEXP/SYMBOL TEXT-BEGIN-GROUP REPLACEMENT-TEXT/FUNCTION/SYMBOL)
 181
 182 REGEXP is a regular expression, or symbol whose value is a regular
 183 expression, which is searched for using `re-search-forward'.
 184 TEXT-BEGIN-GROUP is the matching group within that regexp which
 185 denotes the beginning of the actual text to be marked up.
 186 REPLACEMENT-TEXT is a string that will be passed to `replace-match'.
 187 If it is not a string, but a function, it will be called to determine
 188 what the replacement text should be (it must return a string).  If it
 189 is a symbol, the value of that symbol should be a string.
 190
 191 The replacements are done in order, one rule at a time.  Writing
 192 the regular expressions can be a tricky business.  Note that case
 193 is never ignored.  `case-fold-search' is always bound to nil
 194 while processing the markup rules."
 195   :type '(repeat (choice
 196                   (list :tag "Markup rule"
 197                         integer
 198                         (choice regexp symbol)
 199                         integer
 200                         (choice string function symbol))
 201                   function))
 202   :group 'muse-publish)
 203
 204 (defcustom muse-publish-markup-functions
 205   '((directive . muse-publish-markup-directive)
 206     (comment   . muse-publish-markup-comment)
 207     (anchor    . muse-publish-markup-anchor)
 208     (tag       . muse-publish-markup-tag)
 209     (word      . muse-publish-markup-word)
 210     (emdash    . muse-publish-markup-emdash)
 211     (enddots   . muse-publish-markup-enddots)
 212     (dots      . muse-publish-markup-dots)
 213     (rule      . muse-publish-markup-rule)
 214     (no-break-space . muse-publish-markup-no-break-space)
 215     (heading   . muse-publish-markup-heading)
 216     (footnote  . muse-publish-markup-footnote)
 217     (fn-sep    . muse-publish-markup-fn-sep)
 218     (list      . muse-publish-markup-list)
 219     (quote     . muse-publish-markup-quote)
 220     (verse     . muse-publish-markup-verse)
 221     (table     . muse-publish-markup-table)
 222     (email     . muse-publish-markup-email)
 223     (link      . muse-publish-markup-link)
 224     (url       . muse-publish-markup-url))
 225   "An alist of style types to custom functions for that kind of text.
 226
 227 Each member of the list is of the form:
 228
 229   (SYMBOL FUNCTION)
 230
 231 SYMBOL describes the type of text to associate with this rule.
 232 `muse-publish-markup-regexps' maps regexps to these symbols.
 233
 234 FUNCTION is the function to use to mark up this kind of rule if
 235 no suitable function is found through the :functions tag of the
 236 current style."
 237   :type '(alist :key-type symbol :value-type function)
 238   :group 'muse-publish)
 239
 240 (defcustom muse-publish-markup-tags
 241   '(("contents" nil t   muse-publish-contents-tag)
 242     ("verse"    t   nil muse-publish-verse-tag)
 243     ("example"  t   nil muse-publish-example-tag)
 244     ("code"     t   nil muse-publish-code-tag)
 245     ("quote"    t   nil muse-publish-quote-tag)
 246     ("literal"  t   nil muse-publish-mark-read-only)
 247     ("verbatim" t   nil muse-publish-verbatim-tag)
 248     ("lisp"     t   nil muse-publish-lisp-tag)
 249     ("class"    t   t   muse-publish-class-tag)
 250     ("command"  t   t   muse-publish-command-tag)
 251     ("comment"  t   nil muse-publish-comment-tag))
 252   "A list of tag specifications, for specially marking up text.
 253 XML-style tags are the best way to add custom markup to Muse.
 254 This is easily accomplished by customizing this list of markup tags.
 255
 256 For each entry, the name of the tag is given, whether it expects
 257 a closing tag and/or an optional set of attributes, and a
 258 function that performs whatever action is desired within the
 259 delimited region.
 260
 261 The tags themselves are deleted during publishing, before the
 262 function is called.  The function is called with three arguments,
 263 the beginning and end of the region surrounded by the tags.  If
 264 properties are allowed, they are passed as a third argument in
 265 the form of an alist.  The `end' argument to the function is
 266 always a marker.
 267
 268 Point is always at the beginning of the region within the tags, when
 269 the function is called.  Wherever point is when the function finishes
 270 is where tag markup will resume.
 271
 272 These tag rules are processed once at the beginning of markup, and
 273 once at the end, to catch any tags which may have been inserted
 274 in-between."
 275   :type '(repeat (list (string :tag "Markup tag")
 276                        (boolean :tag "Expect closing tag" :value t)
 277                        (boolean :tag "Parse attributes" :value nil)
 278                        function))
 279   :group 'muse-publish)
 280
 281 (defcustom muse-publish-markup-specials nil
 282   "A table of characters which must be represented specially."
 283   :type '(alist :key-type character :value-type string)
 284   :group 'muse-publish)
 285
 286 (defvar muse-publishing-p nil
 287   "Set to t while a page is being published.")
 288 (defvar muse-batch-publishing-p nil
 289   "Set to t while a page is being batch published.")
 290 (defvar muse-publishing-styles nil
 291   "The publishing styles that Muse recognizes.
 292 This is automatically generated when loading publishing styles.")
 293 (defvar muse-publishing-current-file nil
 294   "The file that is currently being published.")
 295 (defvar muse-publishing-current-output-path nil
 296   "The path where the current file will be published to.")
 297 (defvar muse-publishing-current-style nil
 298   "The style of the file that is currently being published.")
 299 (defvar muse-publishing-directives nil
 300   "An alist of publishing directives from the top of a file.")
 301 (defvar muse-publish-generate-contents nil
 302   "Non-nil if a table of contents should be generated.
 303 If non-nil, it is a cons cell specifying (MARKER . DEPTH), to
 304 tell where the <contents> was seen, and to what depth the
 305 contents were requested.")
 306 (defvar muse-publishing-last-position nil
 307   "Last position of the point when publishing.
 308 This is used to make sure that publishing doesn't get stalled.")
 309
 310 ;; Functions for handling style information
 311
 312 (defsubst muse-style (&optional style)
 313   "Resolve the given STYLE into a Muse style, if it is a string."
 314   (if (null style)
 315       muse-publishing-current-style
 316     (if (stringp style)
 317         (assoc style muse-publishing-styles)
 318       (muse-assert (consp style))
 319       style)))
 320
 321 (defun muse-define-style (name &rest elements)
 322   (let ((entry (assoc name muse-publishing-styles)))
 323     (if entry
 324         (setcdr entry elements)
 325       (setq muse-publishing-styles
 326             (cons (append (list name) elements)
 327                   muse-publishing-styles)))))
 328
 329 (defun muse-derive-style (new-name base-name &rest elements)
 330   (apply 'muse-define-style new-name
 331          (append elements (list :base base-name))))
 332
 333 (defsubst muse-get-keyword (keyword list &optional direct)
 334   (let ((value (cadr (memq keyword list))))
 335     (if (and (not direct) (symbolp value))
 336         (symbol-value value)
 337       value)))
 338
 339 (defun muse-style-elements-list (elem &optional style)
 340   "Return a list all references to ELEM in STYLE, including base styles.
 341 If STYLE is not specified, use current style."
 342   (let (base elements)
 343     (while style
 344       (setq style (muse-style style))
 345       (setq elements (append elements
 346                              (muse-get-keyword elem style)))
 347       (setq style (muse-get-keyword :base style)))
 348     elements))
 349
 350 (defsubst muse-style-element (elem &optional style direct)
 351   "Search for ELEM in STYLE, including base styles.
 352 If STYLE is not specified, use current style."
 353   (setq style (muse-style style))
 354   (let ((value (muse-get-keyword elem style direct)))
 355     (if value
 356         value
 357       (let ((base (muse-get-keyword :base style)))
 358         (if base
 359             (muse-style-element elem base direct))))))
 360
 361 (defun muse-find-markup-element (keyword ident style)
 362   (let ((def (assq ident (muse-style-element keyword style))))
 363     (if def
 364         (cdr def)
 365       (let ((base (muse-style-element :base style)))
 366         (if base
 367             (muse-find-markup-element keyword ident base))))))
 368
 369 (defun muse-markup-text (ident &rest args)
 370   "Insert ARGS into the text markup associated with IDENT.
 371 If the markup text has sections like %N%, this will be replaced
 372 with the N-1th argument in ARGS.  After that, `format' is applied
 373 to the text with ARGS as parameters."
 374   (let ((text (muse-find-markup-element :strings ident (muse-style))))
 375     (if (and text args)
 376         (progn
 377           (let (start repl-text)
 378             (while (setq start (string-match "%\\([1-9][0-9]*\\)%" text start))
 379               ;; escape '%' in the argument text, since we will be
 380               ;; using format on it
 381               (setq repl-text (muse-replace-regexp-in-string
 382                                "%" "%%"
 383                                (nth (1- (string-to-number
 384                                          (match-string 1 text))) args)
 385                                t t)
 386                     start (+ start (length repl-text))
 387                     text (replace-match repl-text t t text))))
 388           (apply 'format text args))
 389       (or text ""))))
 390
 391 (defun muse-insert-markup (&rest args)
 392   (let ((beg (point)))
 393     (apply 'insert args)
 394     (muse-publish-mark-read-only beg (point))))
 395
 396 (defun muse-find-markup-tag (keyword tagname style)
 397   (let ((def (assoc tagname (muse-style-element keyword style))))
 398     (or def
 399         (let ((base (muse-style-element :base style)))
 400           (if base
 401               (muse-find-markup-tag keyword tagname base))))))
 402
 403 (defsubst muse-markup-tag-info (tagname &rest args)
 404   (let ((tag-info (muse-find-markup-tag :tags tagname (muse-style))))
 405     (or tag-info
 406         (assoc (match-string 1) muse-publish-markup-tags))))
 407
 408 (defsubst muse-markup-function (category)
 409   (let ((func (muse-find-markup-element :functions category (muse-style))))
 410     (or func
 411         (cdr (assq category muse-publish-markup-functions)))))
 412
 413 ;; Publishing routines
 414
 415 (defun muse-publish-markup (name rules)
 416   (let* ((case-fold-search nil)
 417          (inhibit-read-only t)
 418          (limit (* (length rules) (point-max)))
 419          (verbose (and muse-publish-report-threshhold
 420                        (> (point-max) muse-publish-report-threshhold)))
 421          (base 0))
 422     (while rules
 423       (goto-char (point-min))
 424       (let ((regexp (nth 1 (car rules)))
 425             (group (nth 2 (car rules)))
 426             (repl (nth 3 (car rules)))
 427             pos)
 428         (setq muse-publishing-last-position nil)
 429         (if (symbolp regexp)
 430             (setq regexp (symbol-value regexp)))
 431         (if (and verbose (not muse-batch-publishing-p))
 432             (message "Publishing %s...%d%%" name
 433                      (* (/ (float (+ (point) base)) limit) 100)))
 434         (while (and regexp (setq pos (re-search-forward regexp nil t)))
 435           (if (and verbose (not muse-batch-publishing-p))
 436               (message "Publishing %s...%d%%" name
 437                        (* (/ (float (+ (point) base)) limit) 100)))
 438           (unless (and (> (- (match-end 0) (match-beginning 0)) 0)
 439                        (get-text-property (match-beginning group) 'read-only))
 440             (let* (func
 441                    (text (cond
 442                           ((and (symbolp repl)
 443                                 (setq func (muse-markup-function repl)))
 444                            (funcall func))
 445                           ((functionp repl)
 446                            (funcall repl))
 447                           ((symbolp repl)
 448                            (symbol-value repl))
 449                           (t repl))))
 450               (if (stringp text)
 451                   (replace-match text t))))
 452           (if (and muse-publishing-last-position
 453                    (= pos muse-publishing-last-position))
 454               (if (eobp)
 455                   (setq regexp nil)
 456                 (forward-char 1)))
 457           (setq muse-publishing-last-position pos)))
 458       (setq rules (cdr rules)
 459             base (+ base (point-max))))
 460     (if (and verbose (not muse-batch-publishing-p))
 461         (message "Publishing %s...done" name))))
 462
 463 (defun muse-insert-file-or-string (file-or-string &optional title)
 464   (let ((beg (point)) end)
 465     (if (and (not (string-equal file-or-string ""))
 466              (file-readable-p file-or-string))
 467         (setq end (+ beg (cadr (insert-file-contents file-or-string))))
 468       (insert file-or-string)
 469       (setq end (point)))
 470     (save-restriction
 471       (narrow-to-region beg end)
 472       (remove-text-properties (point-min) (point-max)
 473                               '(read-only nil rear-nonsticky nil))
 474       (goto-char (point-min))
 475       (muse-publish-markup (or title "")
 476                            '((100 "<\\(lisp\\)>" 0
 477                               muse-publish-markup-tag))))))
 478
 479 (defun muse-style-run-hooks (keyword style &rest args)
 480   (catch 'handled
 481     (while (and style
 482                 (setq style (muse-style style)))
 483       (let ((func (muse-get-keyword keyword style t)))
 484         (when (and func
 485                    (apply func args))
 486           (throw 'handled t)))
 487       (setq style (muse-style-element :base style)))))
 488
 489 (defun muse-publish-markup-region (beg end title style)
 490   "Apply the given STYLE's markup rules to the given region."
 491   (save-restriction
 492     (narrow-to-region beg end)
 493     (muse-style-run-hooks :before style)
 494     (muse-publish-markup
 495      title
 496      (sort (copy-alist (append muse-publish-markup-regexps
 497                                (muse-style-elements-list :regexps style)))
 498            (function
 499             (lambda (l r)
 500               (< (car l) (car r))))))
 501     (muse-style-run-hooks :before-end style)
 502     (muse-publish-escape-specials (point-min) (point-max) nil 'document)))
 503
 504 (defun muse-publish-markup-buffer (title style)
 505   "Apply the given STYLE's markup rules to the current buffer."
 506   (setq style (muse-style style))
 507   (let ((style-header (muse-style-element :header style))
 508         (style-footer (muse-style-element :footer style))
 509         (muse-publishing-current-style style)
 510         (muse-publishing-directives
 511          (list (cons "title" title)
 512                (cons "author" (user-full-name))
 513                (cons "date" (format-time-string
 514                              "%B %e, %Y"
 515                              (nth 5 (file-attributes
 516                                      muse-publishing-current-file))))))
 517         (muse-publishing-p t)
 518         (inhibit-read-only t))
 519     (run-hooks 'muse-update-values-hook)
 520     (run-hooks 'muse-before-publish-hook)
 521     (muse-publish-markup-region (point-min) (point-max) title style)
 522     (goto-char (point-min))
 523     (when style-header
 524       (muse-insert-file-or-string style-header title))
 525     (goto-char (point-max))
 526     (when style-footer
 527       (muse-insert-file-or-string style-footer title))
 528     (muse-style-run-hooks :after style)
 529     (run-hooks 'muse-after-publish-hook)))
 530
 531 (defun muse-publish-markup-string (string &optional style)
 532   "Markup STRING using the given STYLE's markup rules."
 533   (setq style (muse-style style))
 534   (muse-with-temp-buffer
 535     (insert string)
 536     (let ((muse-publishing-current-style style)
 537           (muse-publishing-p t))
 538       (muse-publish-markup "*string*" (muse-style-element :rules style)))
 539     (buffer-string)))
 540
 541 ;; Commands for publishing files
 542
 543 (defsubst muse-publish-get-style ()
 544   (if (= 1 (length muse-publishing-styles))
 545       (car muse-publishing-styles)
 546     (assoc (completing-read "Publish with style: "
 547                             muse-publishing-styles nil t)
 548            muse-publishing-styles)))
 549
 550 (defsubst muse-publish-get-output-dir (style)
 551   (let ((default-directory (or (muse-style-element :path style)
 552                                default-directory)))
 553     (muse-read-directory-name "Publish to directory: " nil default-directory)))
 554
 555 (defsubst muse-publish-get-info ()
 556   (let ((style (muse-publish-get-style)))
 557     (list style (muse-publish-get-output-dir style)
 558           current-prefix-arg)))
 559
 560 (defsubst muse-publish-output-name (&optional file style)
 561   (setq style (muse-style style))
 562   (concat (muse-style-element :prefix style)
 563           (muse-page-name file)
 564           (muse-style-element :suffix style)))
 565
 566 (defsubst muse-publish-output-file (file &optional output-dir style)
 567   (setq style (muse-style style))
 568   (if output-dir
 569       (expand-file-name (muse-publish-output-name file style) output-dir)
 570     (concat (file-name-directory file)
 571             (muse-publish-output-name file style))))
 572
 573 (defsubst muse-publish-link-name (&optional file style)
 574   (setq style (muse-style style))
 575   (concat (muse-style-element :prefix style)
 576           (muse-page-name file)
 577           (or (muse-style-element :link-suffix style)
 578               (muse-style-element :suffix style))))
 579
 580 (defsubst muse-publish-link-file (file &optional output-dir style)
 581   (setq style (muse-style style))
 582   (if output-dir
 583       (expand-file-name (muse-publish-link-name file style) output-dir)
 584     (concat (file-name-directory file)
 585             (muse-publish-link-name file style))))
 586
 587 ;;;###autoload
 588 (defun muse-publish-file (file style &optional output-dir force)
 589   "Publish the given FILE in a particular STYLE to OUTPUT-DIR.
 590 If the argument FORCE is nil, each file is only published if it is
 591 newer than the published version.  If the argument FORCE is non-nil,
 592 the file is published no matter what."
 593   (interactive (cons (read-file-name "Publish file: ")
 594                      (muse-publish-get-info)))
 595   (let ((style-name style))
 596     (setq style (muse-style style))
 597     (unless style
 598       (error "There is no style '%s' defined." style-name)))
 599   (let* ((output-path (muse-publish-output-file file output-dir style))
 600          (output-suffix (muse-style-element :osuffix style))
 601          (muse-publishing-current-file file)
 602          (muse-publishing-current-output-path output-path)
 603          (target (if output-suffix
 604                      (concat (file-name-sans-extension output-path)
 605                              output-suffix)
 606                    output-path))
 607          (threshhold (nth 7 (file-attributes file))))
 608     (if (not threshhold)
 609         (message "Please save %s before publishing" file)
 610       (when (or force (file-newer-than-file-p file target))
 611         (if (and muse-publish-report-threshhold
 612                  (> threshhold
 613                     muse-publish-report-threshhold))
 614             (message "Publishing %s ..." file))
 615         (muse-with-temp-buffer
 616           (insert-file-contents file)
 617           (muse-publish-markup-buffer (muse-page-name file) style)
 618           (let ((backup-inhibited t))
 619             (write-file output-path))
 620           (muse-style-run-hooks :final style file output-path target))
 621         t))))
 622
 623 ;;;###autoload
 624 (defun muse-publish-this-file (style output-dir &optional force)
 625   "Publish the page in the current file."
 626   (interactive (muse-publish-get-info))
 627   (unless (muse-publish-file buffer-file-name style output-dir force)
 628     (message (concat "The published version is up-to-date; use"
 629                      " C-u C-c C-t to force an update."))))
 630
 631 (defun muse-batch-publish-files ()
 632   "Publish Muse files in batch mode."
 633   (let ((muse-batch-publishing-p t)
 634         style output-dir)
 635     (setq style (car command-line-args-left)
 636           command-line-args-left (cdr command-line-args-left)
 637           output-dir (car command-line-args-left)
 638           output-dir
 639           (if (string-match "\\`--output-dir=" output-dir)
 640               (prog1
 641                   (substring output-dir (match-end 0))
 642                 (setq command-line-args-left (cdr command-line-args-left)))))
 643     (setq auto-mode-alist
 644           (delete (cons (concat "\\." muse-file-extension "\\'")
 645                         'muse-mode-choose-mode)
 646                   auto-mode-alist))
 647     (dolist (file command-line-args-left)
 648       (muse-publish-file file style output-dir t))))
 649
 650 ;; Default publishing rules
 651
 652 (defun muse-publish-section-close (depth)
 653   "Seach forward for the closing tag of given DEPTH."
 654   (let (not-end)
 655     (save-excursion
 656       (while (and (setq not-end (re-search-forward
 657                                  (concat "^\\*\\{1," (number-to-string depth)
 658                                          "\\}\\s-+")
 659                                  nil t))
 660                   (get-text-property (match-beginning 0) 'read-only)))
 661       (if not-end
 662           (forward-line 0)
 663         (goto-char (point-max)))
 664       (cond ((not (eq (char-before) ?\n))
 665              (insert "\n\n"))
 666             ((not (eq (char-before (1- (point))) ?\n))
 667              (insert "\n")))
 668       (muse-insert-markup (muse-markup-text 'section-close depth))
 669       (insert "\n"))))
 670
 671 (defun muse-publish-markup-directive (&optional name value)
 672   (unless name (setq name (match-string 1)))
 673   (unless value (setq value (match-string 2)))
 674   (let ((elem (assoc name muse-publishing-directives)))
 675     (if elem
 676         (setcdr elem value)
 677       (setq muse-publishing-directives
 678             (cons (cons name value)
 679                   muse-publishing-directives))))
 680   ;; Make sure we don't ever try to move the point forward (past the
 681   ;; beginning of buffer) while we're still searching for directives.
 682   (setq muse-publishing-last-position nil)
 683   (delete-region (match-beginning 0) (match-end 0)))
 684
 685 (defsubst muse-publishing-directive (name)
 686   (cdr (assoc name muse-publishing-directives)))
 687
 688 (defun muse-publish-markup-anchor ()
 689   (unless (get-text-property (match-end 1) 'noemphasis)
 690     (let ((text (muse-markup-text 'anchor (match-string 2))))
 691       (unless (string= text "")
 692         (save-match-data
 693           (skip-chars-forward (concat muse-regexp-blank "\n"))
 694           (muse-insert-markup text)))
 695       (match-string 1))))
 696
 697 (defun muse-publish-markup-comment ()
 698   (if (null muse-publish-comments-p)
 699       ""
 700     (goto-char (match-end 0))
 701     (muse-insert-markup (muse-markup-text 'comment-end))
 702     (muse-publish-mark-read-only (match-beginning 1) (match-end 1))
 703     (delete-region (match-beginning 0) (match-beginning 1))
 704     (goto-char (match-beginning 0))
 705     (muse-insert-markup (muse-markup-text 'comment-begin))))
 706
 707 (defun muse-publish-markup-tag ()
 708   (let ((tag-info (muse-markup-tag-info (match-string 1))))
 709     (when (and tag-info
 710                (not (get-text-property (match-beginning 0) 'read-only)))
 711       (let ((closed-tag (match-string 3))
 712             (start (match-beginning 0))
 713             (beg (point))
 714             end attrs)
 715         (when (nth 2 tag-info)
 716           (let ((attrstr (match-string 2)))
 717             (while (and attrstr
 718                         (string-match (concat "\\([^"
 719                                               muse-regexp-blank
 720                                               "=\n]+\\)\\(=\"\\"
 721                                               "([^\"]+\\)\"\\)?")
 722                                       attrstr))
 723               (let ((attr (cons (downcase
 724                                  (muse-match-string-no-properties 1 attrstr))
 725                                 (muse-match-string-no-properties 3 attrstr))))
 726                 (setq attrstr (replace-match "" t t attrstr))
 727                 (if attrs
 728                     (nconc attrs (list attr))
 729                   (setq attrs (list attr)))))))
 730         (if (and (cadr tag-info) (not closed-tag))
 731             (if (search-forward (concat "</" (car tag-info) ">") nil t)
 732                 (delete-region (match-beginning 0) (point))
 733               (setq tag-info nil)))
 734         (when tag-info
 735           (setq end (point-marker))
 736           (delete-region start beg)
 737           (goto-char start)
 738           (let ((args (list start end)))
 739             (if (nth 2 tag-info)
 740                 (nconc args (list attrs)))
 741             (apply (nth 3 tag-info) args))))))
 742   nil)
 743
 744 (defun muse-publish-escape-specials (beg end &optional ignore-read-only context)
 745   "Escape specials from BEG to END using style-specific :specials.
 746 If IGNORE-READ-ONLY is non-nil, ignore the read-only property.
 747 CONTEXT is used to figure out what kind of specials to escape.
 748
 749 The following contexts exist in Muse.
 750 'underline  _underlined text_
 751 'literal    =monospaced text= or <code> region (monospaced, escaped)
 752 'emphasis   *emphasized text*
 753 'email      email@example.com
 754 'url        http://example.com
 755 'url-desc   [[...][description of an extended link]]
 756 'example    <example> region (monospaced, block context, escaped)
 757 'verbatim   <verbatim> region (escaped)
 758 'document   normal text"
 759   (let ((specials (muse-style-element :specials nil t)))
 760     (cond ((functionp specials)
 761            (setq specials (funcall specials context)))
 762           ((symbolp specials)
 763            (setq specials (symbol-value specials))))
 764     (if (functionp specials)
 765         (funcall specials beg end ignore-read-only)
 766       (save-excursion
 767         (save-restriction
 768         (narrow-to-region beg end)
 769         (goto-char (point-min))
 770         (while (< (point) (point-max))
 771           (if (and (not ignore-read-only)
 772                    (get-text-property (point) 'read-only))
 773               (goto-char (or (next-single-property-change (point) 'read-only)
 774                              (point-max)))
 775             (let ((repl (or (assoc (char-after) specials)
 776                             (assoc (char-after)
 777                                    muse-publish-markup-specials))))
 778               (if (null repl)
 779                   (forward-char 1)
 780                 (delete-char 1)
 781                 (insert-before-markers (cdr repl)))))))))))
 782
 783 (defun muse-publish-markup-word ()
 784   (let* ((beg (match-beginning 2))
 785          (end (1- (match-end 2)))
 786          (leader (buffer-substring-no-properties beg end))
 787          open-tag close-tag mark-read-only loc context)
 788     (cond
 789      ((string= leader "_")
 790       (setq context 'underline
 791             open-tag (muse-markup-text 'begin-underline)
 792             close-tag (muse-markup-text 'end-underline)))
 793      ((string= leader "=")
 794       (setq context 'literal
 795             open-tag (muse-markup-text 'begin-literal)
 796             close-tag (muse-markup-text 'end-literal))
 797       (setq mark-read-only t))
 798      (t
 799       (let ((l (length leader)))
 800         (setq context 'emphasis)
 801         (cond
 802          ((= l 1) (setq open-tag (muse-markup-text 'begin-emph)
 803                         close-tag (muse-markup-text 'end-emph)))
 804          ((= l 2) (setq open-tag (muse-markup-text 'begin-more-emph)
 805                         close-tag (muse-markup-text 'end-more-emph)))
 806          ((= l 3) (setq open-tag (muse-markup-text 'begin-most-emph)
 807                         close-tag (muse-markup-text 'end-most-emph)))
 808          (t (setq context nil))))))
 809     (if (and context
 810              (not (get-text-property beg 'noemphasis))
 811              (setq loc (search-forward leader nil t))
 812              (or (eobp) (not (eq (char-syntax (char-after loc)) ?w)))
 813              (not (eq (char-syntax (char-before (point))) ?\ ))
 814              (not (get-text-property (point) 'noemphasis)))
 815         (progn
 816           (replace-match "")
 817           (delete-region beg end)
 818           (setq end (point-marker))
 819           (muse-insert-markup close-tag)
 820           (goto-char beg)
 821           (muse-insert-markup open-tag)
 822           (setq beg (point))
 823           (when mark-read-only
 824             (muse-publish-escape-specials beg end t context)
 825             (muse-publish-mark-read-only beg end)))
 826       (backward-char))
 827     nil))
 828
 829 (defun muse-publish-markup-emdash ()
 830   (let ((prespace (match-string 1))
 831         (postspace (match-string 2)))
 832     (delete-region (match-beginning 0) (match-end 0))
 833     (muse-insert-markup (muse-markup-text 'emdash prespace postspace))
 834     (when (eq (char-after) ?\<)
 835       (insert ?\n))))
 836
 837 (defun muse-publish-markup-enddots ()
 838   (unless (get-text-property (match-beginning 0) 'noemphasis)
 839     (delete-region (match-beginning 0) (match-end 0))
 840     (muse-insert-markup (muse-markup-text 'enddots))))
 841
 842 (defun muse-publish-markup-dots ()
 843   (unless (get-text-property (match-beginning 0) 'noemphasis)
 844     (delete-region (match-beginning 0) (match-end 0))
 845     (muse-insert-markup (muse-markup-text 'dots))))
 846
 847 (defun muse-publish-markup-rule ()
 848   (unless (get-text-property (match-beginning 0) 'noemphasis)
 849     (delete-region (match-beginning 0) (match-end 0))
 850     (muse-insert-markup (muse-markup-text 'rule))))
 851
 852 (defun muse-publish-markup-no-break-space ()
 853   (unless (get-text-property (match-beginning 0) 'noemphasis)
 854     (delete-region (match-beginning 0) (match-end 0))
 855     (muse-insert-markup (muse-markup-text 'no-break-space))))
 856
 857 (defun muse-publish-markup-heading ()
 858   (let* ((len (length (match-string 1)))
 859          (start (muse-markup-text
 860                  (cond ((= len 1) 'section)
 861                        ((= len 2) 'subsection)
 862                        ((= len 3) 'subsubsection)
 863                        (t 'section-other))
 864                  len))
 865          (end   (muse-markup-text
 866                  (cond ((= len 1) 'section-end)
 867                        ((= len 2) 'subsection-end)
 868                        ((= len 3) 'subsubsection-end)
 869                        (t 'section-other-end))
 870                  len)))
 871     (delete-region (match-beginning 0) (match-end 0))
 872     (muse-insert-markup start)
 873     (end-of-line)
 874     (when end
 875       (muse-insert-markup end))
 876     (muse-publish-section-close len)))
 877
 878 (defvar muse-publish-footnotes nil)
 879
 880 (defun muse-publish-markup-footnote ()
 881   "Scan ahead and snarf up the footnote body"
 882   (cond
 883    ((get-text-property (match-beginning 0) 'noemphasis)
 884     nil)
 885    ((= (muse-line-beginning-position) (match-beginning 0))
 886     "")
 887    (t
 888     (let ((footnote (save-match-data
 889                       (string-to-number (match-string 1))))
 890           footnotemark)
 891       (delete-region (match-beginning 0) (match-end 0))
 892       (save-excursion
 893         (when (re-search-forward (format "^\\[%d\\]\\s-+" footnote) nil t)
 894           (let* ((start (match-beginning 0))
 895                  (beg (goto-char (match-end 0)))
 896                  (end (save-excursion
 897                         (if (search-forward "\n\n" nil t)
 898                             (copy-marker (match-beginning 0))
 899                           (goto-char (point-max))
 900                           (skip-chars-backward "\n")
 901                           (point-marker)))))
 902             (while (re-search-forward
 903                     (concat "^[" muse-regexp-blank "]+\\([^\n]\\)")
 904                     end t)
 905               (replace-match "\\1" t))
 906             (let ((footnotemark-cmd (muse-markup-text 'footnotemark))
 907                   (footnotemark-end-cmd (muse-markup-text 'footnotemark-end)))
 908               (if (string= "" footnotemark-cmd)
 909                   (setq footnotemark
 910                         (concat (muse-markup-text 'footnote)
 911                                 (buffer-substring-no-properties beg end)
 912                                 (muse-markup-text 'footnote-end)))
 913                 (setq footnotemark (format footnotemark-cmd footnote
 914                                            footnotemark-end-cmd))
 915                 (unless muse-publish-footnotes
 916                   (set (make-local-variable 'muse-publish-footnotes)
 917                        (make-vector 256 nil)))
 918                 (unless (aref muse-publish-footnotes footnote)
 919                   (setq footnotemark
 920                         (concat
 921                          footnotemark
 922                          (concat (format (muse-markup-text 'footnotetext)
 923                                          footnote)
 924                                  (buffer-substring-no-properties beg end)
 925                                  (muse-markup-text 'footnotetext-end))))
 926                   (aset muse-publish-footnotes footnote footnotemark))))
 927             (goto-char end)
 928             (skip-chars-forward "\n")
 929             (delete-region start (point)))))
 930       (muse-insert-markup (or footnotemark footnote))))))
 931
 932 (defun muse-publish-markup-fn-sep ()
 933   (delete-region (match-beginning 0) (match-end 0))
 934   (muse-insert-markup (muse-markup-text 'fn-sep)))
 935
 936 (defun muse-insert-markup-end-list (&rest args)
 937   (let ((beg (point)))
 938     (apply 'insert args)
 939     (add-text-properties beg (point) '(end-list t))
 940     (muse-publish-mark-read-only beg (point))))
 941
 942 (defun muse-publish-surround-dl (indent post-indent)
 943   (let* ((beg-item (muse-markup-text 'begin-dl-item))
 944          (end-item (muse-markup-text 'end-dl-item))
 945          (beg-ddt (muse-markup-text 'begin-ddt)) ;; term
 946          (end-ddt (muse-markup-text 'end-ddt))
 947          (beg-dde (muse-markup-text 'begin-dde)) ;; definition
 948          (end-dde (muse-markup-text 'end-dde))
 949          (continue t)
 950          def-on-same-line beg)
 951     (while continue
 952       ;; envelope this as one term+definitions unit -- HTML does not
 953       ;; need this, but DocBook and Muse's custom XML format do
 954       (muse-insert-markup beg-item)
 955       (when (looking-at muse-dl-term-regexp)
 956         ;; find the term and wrap it with published markup
 957         (setq beg (point))
 958         (goto-char (match-end 1))
 959         (delete-region (point) (match-end 0))
 960         (muse-insert-markup-end-list end-ddt)
 961         ;; if definition is immediately after term, move to next line
 962         (unless (eq (char-after) ?\n)
 963           (insert ?\n))
 964         (save-excursion
 965           (goto-char beg)
 966           (delete-region (point) (match-beginning 1))
 967           (muse-insert-markup beg-ddt)))
 968       (setq beg (point)
 969             ;; move past current item
 970             continue (muse-forward-list-item 'dl-term indent))
 971       (save-restriction
 972         (narrow-to-region beg (point))
 973         (goto-char (point-min))
 974         ;; publish each definition that we find, defaulting to an
 975         ;; empty definition if none are found
 976         (muse-publish-surround-text beg-dde end-dde
 977          (lambda (indent)
 978            (muse-forward-list-item 'dl-entry indent))
 979          nil nil t)
 980         (goto-char (point-max))
 981         (skip-chars-backward (concat muse-regexp-blank "\n"))
 982         (muse-insert-markup-end-list end-item)
 983         (when continue
 984           (goto-char (point-max)))))))
 985
 986 (defun muse-publish-surround-text (beg-tag end-tag move-func &optional indent post-indent determine-indent)
 987   (let ((continue t)
 988         (list-item (format muse-list-item-regexp
 989                            (concat "[" muse-regexp-blank "]*")))
 990         init-indent beg)
 991     (unless indent
 992       (setq indent (concat "[" muse-regexp-blank "]+")))
 993     (if post-indent
 994         (setq post-indent (concat " \\{0," (number-to-string post-indent)
 995                                   "\\}"))
 996       (setq post-indent ""))
 997     (while continue
 998       (muse-insert-markup beg-tag)
 999       (setq beg (point)
1000             ;; move past current item; continue is non-nil if there
1001             ;; are more like items to be processed
1002             continue (funcall move-func indent))
1003       (save-restriction
1004         (when determine-indent
1005           ;; if the caller doesn't know how much indentation
1006           ;; to use, figure it out ourselves
1007           (if (not continue)
1008               (setq indent "")
1009             (save-match-data
1010               ;; snarf all leading whitespace
1011               (let ((this-indent (and (match-beginning 2)
1012                                       (buffer-substring (match-beginning 1)
1013                                                         (match-beginning 2)))))
1014                 (when (and this-indent
1015                            (not (string= this-indent "")))
1016                   (setq indent this-indent
1017                         determine-indent nil))))))
1018         (when continue
1019           ;; remove list markup if we encountered another item of the
1020           ;; same type
1021           (replace-match "" t t nil 1))
1022         (narrow-to-region beg (point))
1023         ;; narrow to current item
1024         (goto-char (point-min))
1025         (forward-line 1)
1026         (let ((list-nested nil)
1027               (indent-found nil)
1028               (post-indent post-indent))
1029           (while (< (point) (point-max))
1030             (when (looking-at list-item)
1031               ;; if we encounter a list item, allow no post-indent
1032               ;; space
1033               (setq list-nested t))
1034             (when (looking-at (concat indent "\\("
1035                                       (or (and list-nested "")
1036                                           post-indent)
1037                                       "\\)"))
1038               ;; if list is not nested, remove indentation
1039               (unless indent-found
1040                 (setq post-indent (match-string 1)
1041                       indent-found t))
1042               (replace-match ""))
1043             (forward-line 1)))
1044         (skip-chars-backward (concat muse-regexp-blank "\n"))
1045         (muse-insert-markup-end-list end-tag)
1046         (when continue
1047           (goto-char (point-max)))))))
1048
1049 (defun muse-publish-markup-list ()
1050   "Markup a list entry.
1051 The reason this function is so funky, is to prevent text properties
1052 like read-only from being inadvertently deleted."
1053   (let* ((str (match-string 1))
1054          (type (muse-list-item-type str))
1055          (indent (buffer-substring (muse-line-beginning-position)
1056                                    (match-beginning 1)))
1057          (post-indent (length str))
1058          (last (match-beginning 0)))
1059     (cond
1060      ((eq type 'ul)
1061       (unless (eq (char-after (match-end 1)) ?-)
1062         (delete-region (match-beginning 0) (match-end 0))
1063         (muse-insert-markup (muse-markup-text 'begin-uli))
1064         (save-excursion
1065           (muse-publish-surround-text
1066            (muse-markup-text 'begin-uli-item)
1067            (muse-markup-text 'end-uli-item)
1068            (lambda (indent)
1069              (muse-forward-list-item 'ul indent))
1070            indent post-indent)
1071           (muse-insert-markup-end-list (muse-markup-text 'end-uli)))
1072         (forward-line 1)))
1073      ((eq type 'ol)
1074       (delete-region (match-beginning 0) (match-end 0))
1075       (muse-insert-markup (muse-markup-text 'begin-oli))
1076       (save-excursion
1077         (muse-publish-surround-text
1078          (muse-markup-text 'begin-oli-item)
1079          (muse-markup-text 'end-oli-item)
1080          (lambda (indent)
1081            (muse-forward-list-item 'ol indent))
1082          indent post-indent)
1083         (muse-insert-markup-end-list (muse-markup-text 'end-oli)))
1084       (forward-line 1))
1085      ((not (string= (match-string 2) ""))
1086       ;; must have an initial term
1087       (goto-char (match-beginning 0))
1088       (muse-insert-markup (muse-markup-text 'begin-dl))
1089       (save-excursion
1090         (muse-publish-surround-dl indent post-indent)
1091         (muse-insert-markup-end-list (muse-markup-text 'end-dl)))
1092       (forward-line 1))))
1093   nil)
1094
1095 (defun muse-publish-markup-quote ()
1096   "Markup a quoted paragraph.
1097 The reason this function is so funky, is to prevent text properties
1098 like read-only from being inadvertently deleted."
1099   (let* ((ws (match-string 1))
1100          (centered (>= (string-width ws) 6))
1101          (begin-elem (if centered 'begin-center 'begin-quote-item))
1102          (end-elem (if centered 'end-center 'end-quote-item)))
1103     (replace-match "" t t nil 1)
1104     (unless centered
1105       (muse-insert-markup (muse-markup-text 'begin-quote)))
1106     (muse-publish-surround-text (muse-markup-text begin-elem)
1107                                 (muse-markup-text end-elem)
1108                                 (function (lambda (indent)
1109                                             (muse-forward-paragraph)
1110                                             nil)))
1111     (unless centered
1112       (muse-insert-markup (muse-markup-text 'end-quote)))))
1113
1114 (defun muse-publish-markup-leading-space (markup-space multiple)
1115   (let (count)
1116     (when (and markup-space
1117                (>= (setq count (skip-chars-forward " ")) 0))
1118       (delete-region (muse-line-beginning-position) (point))
1119       (while (> count 0)
1120         (muse-insert-markup markup-space)
1121         (setq count (- count multiple))))))
1122
1123 (defun muse-publish-markup-verse ()
1124   (let ((leader (match-string 0)))
1125     (goto-char (match-beginning 0))
1126     (muse-insert-markup (muse-markup-text 'begin-verse))
1127     (while (looking-at leader)
1128       (replace-match "")
1129       (muse-publish-markup-leading-space (muse-markup-text 'verse-space) 2)
1130       (let ((beg (point)))
1131         (end-of-line)
1132         (cond
1133          ((bolp)
1134           (let ((text (muse-markup-text 'empty-verse-line)))
1135             (when text (muse-insert-markup text))))
1136          ((save-excursion
1137             (save-match-data
1138               (forward-line 1)
1139               (or (looking-at (concat leader "["
1140                                       muse-regexp-blank
1141                                       "]*$"))
1142                   (not (looking-at leader)))))
1143           (let ((begin-text (muse-markup-text 'begin-last-stanza-line))
1144                 (end-text (muse-markup-text 'end-last-stanza-line)))
1145             (when end-text (muse-insert-markup end-text))
1146             (goto-char beg)
1147             (when begin-text (muse-insert-markup begin-text))
1148             (end-of-line)))
1149          (t
1150           (let ((begin-text (muse-markup-text 'begin-verse-line))
1151                 (end-text (muse-markup-text 'end-verse-line)))
1152             (when end-text (muse-insert-markup end-text))
1153             (goto-char beg)
1154             (when begin-text (muse-insert-markup begin-text))
1155             (end-of-line))))
1156         (forward-line 1))))
1157   (muse-insert-markup (muse-markup-text 'end-verse))
1158   (insert ?\n))
1159
1160 (defun muse-publish-table-fields (beg end)
1161   "Parse given region as a table, returning a cons cell.
1162 The car is the length of the longest row.
1163
1164 The cdr is a list of the fields of the table, with the first
1165 element indicating the type of the row:
1166   1: body, 2: header, 3: footer.
1167
1168 The existing region will be removed, except for initial blank lines."
1169   (unless (muse-publishing-directive "disable-tables")
1170     (let ((longest 0)
1171           (left 0)
1172           fields field-list)
1173       (save-restriction
1174         (narrow-to-region beg end)
1175         (goto-char (point-min))
1176         (while (looking-at (concat "^[" muse-regexp-blank "]*$"))
1177           (forward-line 1))
1178         (setq beg (point))
1179         (while (= left 0)
1180           (when (looking-at muse-table-line-regexp)
1181             (setq fields (cons (length (match-string 1))
1182                                (split-string (match-string 0)
1183                                              muse-table-field-regexp))
1184                   field-list (cons fields field-list)
1185                   longest (max (length fields) longest)))
1186           (setq left (forward-line 1))))
1187       (delete-region beg end)
1188       (if (= longest 0)
1189           (cons 0 nil)
1190         (cons (1- longest) (nreverse field-list))))))
1191
1192 (defun muse-publish-markup-table ()
1193   "Style does not support tables.")
1194
1195 (defun muse-publish-escape-specials-in-string (string &optional context)
1196   "Escape specials in STRING using style-specific :specials.
1197 CONTEXT is used to figure out what kind of specials to escape.
1198
1199 See the documentation of the `muse-publish-escape-specials'
1200 function for the list of available contexts."
1201   (unless string
1202     (setq string ""))
1203   (let ((specials (muse-style-element :specials nil t)))
1204     (cond ((functionp specials)
1205            (setq specials (funcall specials context)))
1206           ((symbolp specials)
1207            (setq specials (symbol-value specials))))
1208     (if (functionp specials)
1209         (funcall specials string)
1210       (apply (function concat)
1211              (mapcar
1212               (lambda (ch)
1213                 (let (repl)
1214                   (setq repl (or (assoc ch specials)
1215                                  (assoc ch muse-publish-markup-specials)))
1216                   (if (null repl)
1217                       (char-to-string ch)
1218                     (cdr repl))))
1219               (append string nil))))))
1220
1221 (defun muse-publish-markup-email ()
1222   (let* ((beg (match-end 1))
1223          (addr (buffer-substring-no-properties beg (match-end 0))))
1224     (setq addr (muse-publish-escape-specials-in-string addr 'email))
1225     (goto-char beg)
1226     (delete-region beg (match-end 0))
1227     (if (or (eq (char-before (match-beginning 0)) ?\")
1228             (eq (char-after (match-end 0)) ?\"))
1229         (insert addr)
1230       (insert (format (muse-markup-text 'email-addr) addr addr)))
1231     (muse-publish-mark-read-only beg (point))))
1232
1233 (defun muse-publish-classify-url (target)
1234   "Transform anchors and get published name, if TARGET is a page.
1235 The return value is a cons cell.  The car is the type of link,
1236 the cadr is the page name, and the cddr is the anchor."
1237   (save-match-data
1238     (cond ((or (null target) (string= target ""))
1239            nil)
1240           ((string-match muse-url-regexp target)
1241            (cons 'url (cons target nil)))
1242           ((string-match muse-image-regexp target)
1243            (cons 'image (cons target nil)))
1244           ((string-match muse-file-regexp target)
1245            (cons 'file (cons target nil)))
1246           ((string-match "#" target)
1247            (if (eq (aref target 0) ?\#)
1248               (cons 'anchor-ref (cons nil (substring target 1)))
1249              (cons 'link-and-anchor
1250                    (cons (muse-publish-link-name
1251                           (substring target 0 (match-beginning 0)))
1252                          (substring target (match-end 0))))))
1253           (t
1254            (cons 'link (cons (muse-publish-link-name target) nil))))))
1255
1256 (defun muse-publish-url (url &optional desc explicit)
1257   "Resolve a URL into its final <a href> form."
1258   (let ((orig-url url)
1259         type anchor)
1260     (dolist (transform muse-publish-url-transforms)
1261       (setq url (save-match-data (when url (funcall transform url explicit)))))
1262     (dolist (transform muse-publish-desc-transforms)
1263       (setq desc (save-match-data
1264                    (when desc (funcall transform desc explicit)))))
1265     (when desc
1266       (setq desc (muse-publish-escape-specials-in-string desc 'url-desc)))
1267     (setq orig-url
1268           (muse-publish-escape-specials-in-string orig-url 'url-desc))
1269     (let ((target (muse-publish-classify-url url)))
1270       (setq type (car target)
1271             url (muse-publish-escape-specials-in-string (cadr target) 'url)
1272             anchor (muse-publish-escape-specials-in-string
1273                     (cddr target) 'url)))
1274     (cond ((eq type 'anchor-ref)
1275            (muse-markup-text 'anchor-ref anchor (or desc orig-url)))
1276           ((string= url "")
1277            desc)
1278           ((eq type 'image)
1279            (if desc
1280                (muse-markup-text 'image-with-desc url desc)
1281              (muse-markup-text 'image-link url)))
1282           ((eq type 'link-and-anchor)
1283            (muse-markup-text 'link-and-anchor url anchor
1284                              (or desc orig-url)))
1285           ((and desc (string-match muse-image-regexp desc))
1286            (muse-markup-text 'url-with-image url desc))
1287           ((eq type 'link)
1288            (muse-markup-text 'link url (or desc orig-url)))
1289           (t
1290            (or (and desc
1291                     (let ((text (muse-markup-text 'url-and-desc url desc)))
1292                       (and (not (string= text ""))
1293                            text)))
1294                (muse-markup-text 'url url (or desc orig-url)))))))
1295
1296 (defun muse-publish-insert-url (url &optional desc explicit)
1297   "Resolve a URL into its final <a href> form."
1298   (delete-region (match-beginning 0) (match-end 0))
1299   (let ((text (muse-publish-url url desc explicit)))
1300     (when text
1301       (muse-insert-markup text))))
1302
1303 (defun muse-publish-markup-link ()
1304   (let (desc explicit link)
1305     (setq explicit (save-match-data
1306                      (if (string-match muse-explicit-link-regexp
1307                                        (match-string 0))
1308                          t nil)))
1309     (setq desc (if explicit (match-string 2) (match-string 0)))
1310     (setq link (if explicit
1311                    (muse-handle-explicit-link (match-string 1))
1312                  (muse-handle-implicit-link (match-string 0))))
1313     (when (and link
1314                (or explicit
1315                    (not (or (eq (char-before (match-beginning 0)) ?\")
1316                             (eq (char-after (match-end 0)) ?\")))))
1317       (muse-publish-insert-url link desc explicit))))
1318
1319 (defun muse-publish-markup-url ()
1320   (unless (or (eq (char-before (match-beginning 0)) ?\")
1321               (eq (char-after (match-end 0)) ?\"))
1322     (muse-publish-insert-url (match-string 0))))
1323
1324 ;; Default publishing tags
1325
1326 (defun muse-publish-contents-tag (beg end attrs)
1327   (set (make-local-variable 'muse-publish-generate-contents)
1328        (cons (copy-marker (point) t)
1329              (let ((depth (cdr (assoc "depth" attrs))))
1330                (or (and depth (string-to-number depth)) 2)))))
1331
1332 (defun muse-publish-verse-tag (beg end)
1333   (save-excursion
1334     (save-restriction
1335       (narrow-to-region beg end)
1336       (goto-char (point-min))
1337       (while (eq ?\  (char-syntax (char-after)))
1338         (delete-char 1))
1339       (while (< (point) (point-max))
1340         (insert "> ")
1341         (forward-line))
1342       (if (eq ?\  (char-syntax (char-before)))
1343           (delete-char -1)))))
1344
1345 (defun muse-publish-mark-read-only (beg end)
1346   "Add read-only properties to the given region."
1347   (add-text-properties beg end '(rear-nonsticky (read-only) read-only t))
1348   nil)
1349
1350 (defun muse-publish-mark-noemphasis (&optional beg end)
1351   "Make sure that no emphasis characters are interpreted within
1352 the given region.  If a region is not specified, use the 0th
1353 match data to determine it.
1354
1355 This is usually applied to extended links."
1356   (unless beg (setq beg (match-beginning 0)))
1357   (unless end (setq end (match-end 0)))
1358   (add-text-properties beg end '(noemphasis t))
1359   nil)
1360
1361 (defun muse-publish-quote-tag (beg end)
1362   (save-excursion
1363     (save-restriction
1364       (narrow-to-region beg end)
1365       (muse-insert-markup (muse-markup-text 'begin-quote))
1366       (muse-publish-surround-text (muse-markup-text 'begin-quote-item)
1367                                   (muse-markup-text 'end-quote-item)
1368                                   (function (lambda (indent)
1369                                               (muse-forward-paragraph)
1370                                               (goto-char (match-end 0))
1371                                               (< (point) (point-max)))))
1372       (muse-insert-markup (muse-markup-text 'end-quote)))))
1373
1374 (defun muse-publish-code-tag (beg end)
1375   (muse-publish-escape-specials beg end nil 'literal)
1376   (goto-char beg)
1377   (insert (muse-markup-text 'begin-literal))
1378   (goto-char end)
1379   (insert (muse-markup-text 'end-literal))
1380   (muse-publish-mark-read-only beg (point)))
1381
1382 (defun muse-publish-example-tag (beg end)
1383   (muse-publish-escape-specials beg end nil 'example)
1384   (goto-char beg)
1385   (insert (muse-markup-text 'begin-example))
1386   (goto-char end)
1387   (insert (muse-markup-text 'end-example))
1388   (muse-publish-mark-read-only beg (point)))
1389
1390 (defun muse-publish-verbatim-tag (beg end)
1391   (muse-publish-escape-specials beg end nil 'verbatim)
1392   (muse-publish-mark-read-only beg end))
1393
1394 (defalias 'muse-publish-class-tag 'ignore)
1395
1396 (defun muse-publish-lisp-tag (beg end)
1397   (save-excursion
1398     (let ((str (muse-eval-lisp
1399                 (prog1
1400                     (concat "(progn "
1401                             (buffer-substring-no-properties beg end)
1402                             ")")
1403                   (delete-region beg end)))))
1404       (set-text-properties 0 (length str) nil str)
1405       (insert str))))
1406
1407 (defun muse-publish-command-tag (beg end attrs)
1408   (while (looking-at "\\s-*$")
1409     (forward-line))
1410   (let ((interp (cdr (assoc "interp" attrs))))
1411     (if (null interp)
1412         (shell-command
1413          (prog1
1414              (buffer-substring-no-properties (point) end)
1415            (delete-region beg end)) t)
1416       (shell-command-on-region beg end interp t t))
1417     (muse-publish-mark-read-only beg (point))))
1418
1419 (defun muse-publish-comment-tag (beg end)
1420   (if (null muse-publish-comments-p)
1421       (delete-region beg end)
1422     (goto-char end)
1423     (muse-insert-markup (muse-markup-text 'comment-end))
1424     (muse-publish-mark-read-only beg end)
1425     (goto-char beg)
1426     (muse-insert-markup (muse-markup-text 'comment-begin))))
1427
1428 ;; Miscellaneous helper functions
1429
1430 (defun muse-publish-strip-tags (string)
1431   "Remove all tags from the string."
1432   (while (string-match "<.*?>" string)
1433     (setq string (replace-match "" nil t string)))
1434   string)
1435
1436 (defun muse-publish-markup-type (category default-func)
1437   (let ((rule (muse-find-markup-element :overrides category (muse-style))))
1438     (funcall (or rule default-func))))
1439
1440 (defun muse-published-buffer-contents (buffer)
1441   (with-current-buffer buffer
1442     (goto-char (point-min))
1443     (let ((beg (and (search-forward "Emacs Muse begins here")
1444                     (muse-line-end-position)))
1445           (end (and (search-forward "Emacs Muse ends here")
1446                     (muse-line-beginning-position))))
1447       (buffer-substring-no-properties beg end))))
1448
1449 (defun muse-published-contents (file)
1450   (when (file-readable-p file)
1451     (muse-with-temp-buffer
1452       (insert-file-contents file)
1453       (muse-published-buffer-contents (current-buffer)))))
1454
1455 (defun muse-publish-transform-output
1456   (file temp-file output-path name gen-func &rest cleanup-exts)
1457   "Transform the given TEMP-FILE into the OUTPUT-PATH, using GEN-FUNC."
1458   (setq file (muse-page-name file))
1459   (message "Generating %s output for %s..." name file)
1460   (if (not (funcall gen-func temp-file output-path))
1461       (message "Generating %s from %s...failed" name file)
1462     (message "Generating %s output for %s...done" name file)
1463     (muse-delete-file-if-exists temp-file)
1464     (dolist (ext cleanup-exts)
1465       (muse-delete-file-if-exists
1466        (expand-file-name (concat file ext)
1467                          (file-name-directory output-path))))
1468     (message "Wrote %s" output-path)))
1469
1470 (defun muse-publish-read-only (string)
1471   (let ((end (1- (length string))))
1472     (add-text-properties 0 end
1473                          '(rear-nonsticky (read-only) read-only t)
1474                          string)
1475     string))
1476
1477 (provide 'muse-publish)
1478
1479 ;;; muse-publish.el ends here