lisp/org-exp-blocks.el

   1 ;;; org-exp-blocks.el --- pre-process blocks when exporting org files
   2
   3 ;; Copyright (C) 2009-2012 Free Software Foundation, Inc.
   4
   5 ;; Author: Eric Schulte
   6
   7 ;; This file is part of GNU Emacs.
   8 ;;
   9 ;; GNU Emacs is free software: you can redistribute it and/or modify
  10 ;; it under the terms of the GNU General Public License as published by
  11 ;; the Free Software Foundation, either version 3 of the License, or
  12 ;; (at your option) any later version.
  13
  14 ;; GNU Emacs is distributed in the hope that it will be useful,
  15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 ;; GNU General Public License for more details.
  18
  19 ;; You should have received a copy of the GNU General Public License
  20 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  21
  22 ;;; Commentary:
  23 ;;
  24 ;; This is a utility for pre-processing blocks in org files before
  25 ;; export using the `org-export-preprocess-hook'.  It can be used for
  26 ;; exporting new types of blocks from org-mode files and also for
  27 ;; changing the default export behavior of existing org-mode blocks.
  28 ;; The `org-export-blocks' and `org-export-interblocks' variables can
  29 ;; be used to control how blocks and the spaces between blocks
  30 ;; respectively are processed upon export.
  31 ;;
  32 ;; The type of a block is defined as the string following =#+begin_=,
  33 ;; so for example the following block would be of type ditaa.  Note
  34 ;; that both upper or lower case are allowed in =#+BEGIN_= and
  35 ;; =#+END_=.
  36 ;;
  37 ;; #+begin_ditaa blue.png -r -S
  38 ;; +---------+
  39 ;; | cBLU    |
  40 ;; |         |
  41 ;; |    +----+
  42 ;; |    |cPNK|
  43 ;; |    |    |
  44 ;; +----+----+
  45 ;; #+end_ditaa
  46 ;;
  47 ;;; Currently Implemented Block Types
  48 ;;
  49 ;; ditaa :: (DEPRECATED--use "#+begin_src ditaa" code blocks) Convert
  50 ;;          ascii pictures to actual images using ditaa
  51 ;;          http://ditaa.sourceforge.net/.  To use this set
  52 ;;          `org-ditaa-jar-path' to the path to ditaa.jar on your
  53 ;;          system (should be set automatically in most cases) .
  54 ;;
  55 ;; dot :: (DEPRECATED--use "#+begin_src dot" code blocks) Convert
  56 ;;        graphs defined using the dot graphing language to images
  57 ;;        using the dot utility.  For information on dot see
  58 ;;        http://www.graphviz.org/
  59 ;;
  60 ;; export-comment :: Wrap comments with titles and author information,
  61 ;;            in their own divs with author-specific ids allowing for
  62 ;;            css coloring of comments based on the author.
  63 ;;
  64 ;;; Adding new blocks
  65 ;;
  66 ;; When adding a new block type first define a formatting function
  67 ;; along the same lines as `org-export-blocks-format-dot' and then use
  68 ;; `org-export-blocks-add-block' to add your block type to
  69 ;; `org-export-blocks'.
  70
  71 ;;; Code:
  72
  73 (eval-when-compile
  74   (require 'cl))
  75 (require 'find-func)
  76 (require 'org-compat)
  77
  78 (declare-function org-split-string "org" (string &optional separators))
  79 (declare-function org-remove-indentation "org" (code &optional n))
  80
  81 (defvar org-protecting-blocks nil) ; From org.el
  82
  83 (defun org-export-blocks-set (var value)
  84   "Set the value of `org-export-blocks' and install fontification."
  85   (set var value)
  86   (mapc (lambda (spec)
  87           (if (nth 2 spec)
  88               (setq org-protecting-blocks
  89                     (delete (symbol-name (car spec))
  90                             org-protecting-blocks))
  91             (add-to-list 'org-protecting-blocks
  92                          (symbol-name (car spec)))))
  93         value))
  94
  95 (defcustom org-export-blocks
  96   '((export-comment org-export-blocks-format-comment t)
  97     (ditaa org-export-blocks-format-ditaa nil)
  98     (dot org-export-blocks-format-dot nil))
  99   "Use this alist to associate block types with block exporting functions.
 100 The type of a block is determined by the text immediately
 101 following the '#+BEGIN_' portion of the block header.  Each block
 102 export function should accept three arguments."
 103   :group 'org-export-general
 104   :type '(repeat
 105           (list
 106            (symbol :tag "Block name")
 107            (function :tag "Block formatter")
 108            (boolean :tag "Fontify content as Org syntax")))
 109   :set 'org-export-blocks-set)
 110
 111 (defun org-export-blocks-add-block (block-spec)
 112   "Add a new block type to `org-export-blocks'.
 113 BLOCK-SPEC should be a three element list the first element of
 114 which should indicate the name of the block, the second element
 115 should be the formatting function called by
 116 `org-export-blocks-preprocess' and the third element a flag
 117 indicating whether these types of blocks should be fontified in
 118 org-mode buffers (see `org-protecting-blocks').  For example the
 119 BLOCK-SPEC for ditaa blocks is as follows.
 120
 121   (ditaa org-export-blocks-format-ditaa nil)"
 122   (unless (member block-spec org-export-blocks)
 123     (setq org-export-blocks (cons block-spec org-export-blocks))
 124     (org-export-blocks-set 'org-export-blocks org-export-blocks)))
 125
 126 (defcustom org-export-interblocks
 127   '()
 128   "Use this a-list to associate block types with block exporting functions.
 129 The type of a block is determined by the text immediately
 130 following the '#+BEGIN_' portion of the block header.  Each block
 131 export function should accept three arguments."
 132   :group 'org-export-general
 133   :type 'alist)
 134
 135 (defcustom org-export-blocks-witheld
 136   '(hidden)
 137   "List of block types (see `org-export-blocks') which should not be exported."
 138   :group 'org-export-general
 139   :type 'list)
 140
 141 (defcustom org-export-blocks-postblock-hook nil
 142   "Run after blocks have been processed with `org-export-blocks-preprocess'."
 143   :group 'org-export-general
 144   :version "24.1"
 145   :type 'hook)
 146
 147 (defun org-export-blocks-html-quote (body &optional open close)
 148   "Protect BODY from org html export.
 149 The optional OPEN and CLOSE tags will be inserted around BODY."
 150   (concat
 151    "\n#+BEGIN_HTML\n"
 152    (or open "")
 153    body (if (string-match "\n$" body) "" "\n")
 154    (or close "")
 155    "#+END_HTML\n"))
 156
 157 (defun org-export-blocks-latex-quote (body &optional open close)
 158   "Protect BODY from org latex export.
 159 The optional OPEN and CLOSE tags will be inserted around BODY."
 160   (concat
 161    "\n#+BEGIN_LaTeX\n"
 162    (or open "")
 163    body (if (string-match "\n$" body) "" "\n")
 164    (or close "")
 165    "#+END_LaTeX\n"))
 166
 167 (defvar org-src-preserve-indentation)     ; From org-src.el
 168 (defun org-export-blocks-preprocess ()
 169   "Export all blocks according to the `org-export-blocks' block export alist.
 170 Does not export block types specified in specified in BLOCKS
 171 which defaults to the value of `org-export-blocks-witheld'."
 172   (interactive)
 173   (save-window-excursion
 174     (let ((case-fold-search t)
 175           (interblock (lambda (start end)
 176                         (mapcar (lambda (pair) (funcall (second pair) start end))
 177                                 org-export-interblocks)))
 178           matched indentation type types func
 179           start end body headers preserve-indent progress-marker)
 180       (goto-char (point-min))
 181       (setq start (point))
 182       (let ((beg-re "^\\([ \t]*\\)#\\+begin_\\(\\S-+\\)[ \t]*\\(.*\\)?[\r\n]"))
 183         (while (re-search-forward beg-re nil t)
 184           (let* ((match-start (copy-marker (match-beginning 0)))
 185                  (body-start (copy-marker (match-end 0)))
 186                  (indentation (length (match-string 1)))
 187                  (inner-re (format "^[ \t]*#\\+\\(begin\\|end\\)_%s"
 188                                    (regexp-quote (downcase (match-string 2)))))
 189                  (type (intern (downcase (match-string 2))))
 190                  (headers (save-match-data
 191                             (org-split-string (match-string 3) "[ \t]+")))
 192                  (balanced 1)
 193                  (preserve-indent (or org-src-preserve-indentation
 194                                       (member "-i" headers)))
 195                  match-end)
 196             (while (and (not (zerop balanced))
 197                         (re-search-forward inner-re nil t))
 198               (if (string= (downcase (match-string 1)) "end")
 199                   (decf balanced)
 200                 (incf balanced)))
 201             (when (not (zerop balanced))
 202               (error "Unbalanced begin/end_%s blocks with %S"
 203                      type (buffer-substring match-start (point))))
 204             (setq match-end (copy-marker (match-end 0)))
 205             (unless preserve-indent
 206               (setq body (save-match-data (org-remove-indentation
 207                                            (buffer-substring
 208                                             body-start (match-beginning 0))))))
 209             (unless (memq type types) (setq types (cons type types)))
 210             (save-match-data (funcall interblock start match-start))
 211             (when (setq func (cadr (assoc type org-export-blocks)))
 212               (let ((replacement (save-match-data
 213                                    (if (memq type org-export-blocks-witheld) ""
 214                                      (apply func body headers)))))
 215                 ;; ;; un-comment this code after the org-element merge
 216                 ;; (save-match-data
 217                 ;;   (when (and replacement (string= replacement ""))
 218                 ;;     (delete-region
 219                 ;;      (car (org-element-collect-affiliated-keyword))
 220                 ;;      match-start)))
 221                 (when replacement
 222                   (delete-region match-start match-end)
 223                   (goto-char match-start) (insert replacement)
 224                   (if preserve-indent
 225                       ;; indent only the code block markers
 226                       (save-excursion
 227                         (indent-line-to indentation) ; indent end_block
 228                         (goto-char match-start)
 229                         (indent-line-to indentation))   ; indent begin_block
 230                     ;; indent everything
 231                     (indent-code-rigidly match-start (point) indentation)))))
 232             ;; cleanup markers
 233             (set-marker match-start nil)
 234             (set-marker body-start nil)
 235             (set-marker match-end nil))
 236           (setq start (point))))
 237       (funcall interblock start (point-max))
 238       (run-hooks 'org-export-blocks-postblock-hook))))
 239
 240 ;;================================================================================
 241 ;; type specific functions
 242
 243 ;;--------------------------------------------------------------------------------
 244 ;; ditaa: create images from ASCII art using the ditaa utility
 245 (defcustom org-ditaa-jar-path (expand-file-name
 246                                "ditaa.jar"
 247                                (file-name-as-directory
 248                                 (expand-file-name
 249                                  "scripts"
 250                                  (file-name-as-directory
 251                                   (expand-file-name
 252                                    "../contrib"
 253                                    (file-name-directory (org-find-library-dir "org")))))))
 254   "Path to the ditaa jar executable."
 255   :group 'org-babel
 256   :type 'string)
 257
 258 (defvar org-export-current-backend) ; dynamically bound in org-exp.el
 259 (defun org-export-blocks-format-ditaa (body &rest headers)
 260   "DEPRECATED: use begin_src ditaa code blocks
 261
 262 Pass block BODY to the ditaa utility creating an image.
 263 Specify the path at which the image should be saved as the first
 264 element of headers, any additional elements of headers will be
 265 passed to the ditaa utility as command line arguments."
 266   (message "begin_ditaa blocks are DEPRECATED, use begin_src blocks")
 267   (let* ((args (if (cdr headers) (mapconcat 'identity (cdr headers) " ")))
 268          (data-file (make-temp-file "org-ditaa"))
 269          (hash (progn
 270                  (set-text-properties 0 (length body) nil body)
 271                  (sha1 (prin1-to-string (list body args)))))
 272          (raw-out-file (if headers (car headers)))
 273          (out-file-parts (if (string-match "\\(.+\\)\\.\\([^\\.]+\\)$" raw-out-file)
 274                              (cons (match-string 1 raw-out-file)
 275                                    (match-string 2 raw-out-file))
 276                            (cons raw-out-file "png")))
 277          (out-file (concat (car out-file-parts) "_" hash "." (cdr out-file-parts))))
 278     (unless (file-exists-p org-ditaa-jar-path)
 279       (error (format "Could not find ditaa.jar at %s" org-ditaa-jar-path)))
 280     (setq body (if (string-match "^\\([^:\\|:[^ ]\\)" body)
 281                    body
 282                  (mapconcat (lambda (x) (substring x (if (> (length x) 1) 2 1)))
 283                             (org-split-string body "\n")
 284                             "\n")))
 285     (prog1
 286         (cond
 287          ((member org-export-current-backend '(html latex docbook))
 288           (unless (file-exists-p out-file)
 289             (mapc ;; remove old hashed versions of this file
 290              (lambda (file)
 291                (when (and (string-match (concat (regexp-quote (car out-file-parts))
 292                                                 "_\\([[:alnum:]]+\\)\\."
 293                                                 (regexp-quote (cdr out-file-parts)))
 294                                         file)
 295                           (= (length (match-string 1 out-file)) 40))
 296                  (delete-file (expand-file-name file
 297                                                 (file-name-directory out-file)))))
 298              (directory-files (or (file-name-directory out-file)
 299                                   default-directory)))
 300             (with-temp-file data-file (insert body))
 301             (message (concat "java -jar " org-ditaa-jar-path " " args " " data-file " " out-file))
 302             (shell-command (concat "java -jar " org-ditaa-jar-path " " args " " data-file " " out-file)))
 303           (format "\n[[file:%s]]\n" out-file))
 304          (t (concat
 305              "\n#+BEGIN_EXAMPLE\n"
 306              body (if (string-match "\n$" body) "" "\n")
 307              "#+END_EXAMPLE\n")))
 308       (message "begin_ditaa blocks are DEPRECATED, use begin_src blocks"))))
 309
 310 ;;--------------------------------------------------------------------------------
 311 ;; dot: create graphs using the dot graphing language
 312 ;;      (require the dot executable to be in your path)
 313 (defun org-export-blocks-format-dot (body &rest headers)
 314   "DEPRECATED: use \"#+begin_src dot\" code blocks
 315
 316 Pass block BODY to the dot graphing utility creating an image.
 317 Specify the path at which the image should be saved as the first
 318 element of headers, any additional elements of headers will be
 319 passed to the dot utility as command line arguments.  Don't
 320 forget to specify the output type for the dot command, so if you
 321 are exporting to a file with a name like 'image.png' you should
 322 include a '-Tpng' argument, and your block should look like the
 323 following.
 324
 325 #+begin_dot models.png -Tpng
 326 digraph data_relationships {
 327   \"data_requirement\" [shape=Mrecord, label=\"{DataRequirement|description\lformat\l}\"]
 328   \"data_product\" [shape=Mrecord, label=\"{DataProduct|name\lversion\lpoc\lformat\l}\"]
 329   \"data_requirement\" -> \"data_product\"
 330 }
 331 #+end_dot"
 332   (message "begin_dot blocks are DEPRECATED, use begin_src blocks")
 333   (let* ((args (if (cdr headers) (mapconcat 'identity (cdr headers) " ")))
 334          (data-file (make-temp-file "org-ditaa"))
 335          (hash (progn
 336                  (set-text-properties 0 (length body) nil body)
 337                  (sha1 (prin1-to-string (list body args)))))
 338          (raw-out-file (if headers (car headers)))
 339          (out-file-parts (if (string-match "\\(.+\\)\\.\\([^\\.]+\\)$" raw-out-file)
 340                              (cons (match-string 1 raw-out-file)
 341                                    (match-string 2 raw-out-file))
 342                            (cons raw-out-file "png")))
 343          (out-file (concat (car out-file-parts) "_" hash "." (cdr out-file-parts))))
 344     (prog1
 345         (cond
 346          ((member org-export-current-backend '(html latex docbook))
 347           (unless (file-exists-p out-file)
 348             (mapc ;; remove old hashed versions of this file
 349              (lambda (file)
 350                (when (and (string-match (concat (regexp-quote (car out-file-parts))
 351                                                 "_\\([[:alnum:]]+\\)\\."
 352                                                 (regexp-quote (cdr out-file-parts)))
 353                                         file)
 354                           (= (length (match-string 1 out-file)) 40))
 355                  (delete-file (expand-file-name file
 356                                                 (file-name-directory out-file)))))
 357              (directory-files (or (file-name-directory out-file)
 358                                   default-directory)))
 359             (with-temp-file data-file (insert body))
 360             (message (concat "dot " data-file " " args " -o " out-file))
 361             (shell-command (concat "dot " data-file " " args " -o " out-file)))
 362           (format "\n[[file:%s]]\n" out-file))
 363          (t (concat
 364              "\n#+BEGIN_EXAMPLE\n"
 365              body (if (string-match "\n$" body) "" "\n")
 366              "#+END_EXAMPLE\n")))
 367       (message "begin_dot blocks are DEPRECATED, use begin_src blocks"))))
 368
 369 ;;--------------------------------------------------------------------------------
 370 ;; comment: export comments in author-specific css-stylable divs
 371 (defun org-export-blocks-format-comment (body &rest headers)
 372   "Format comment BODY by OWNER and return it formatted for export.
 373 Currently, this only does something for HTML export, for all
 374 other backends, it converts the comment into an EXAMPLE segment."
 375   (let ((owner (if headers (car headers)))
 376         (title (if (cdr headers) (mapconcat 'identity (cdr headers) " "))))
 377     (cond
 378      ((eq org-export-current-backend 'html) ;; We are exporting to HTML
 379       (concat "#+BEGIN_HTML\n"
 380               "<div class=\"org-comment\""
 381               (if owner (format " id=\"org-comment-%s\" " owner))
 382               ">\n"
 383               (if owner (concat "<b>" owner "</b> ") "")
 384               (if (and title (> (length title) 0)) (concat " -- " title "<br/>\n") "<br/>\n")
 385               "<p>\n"
 386               "#+END_HTML\n"
 387               body
 388               "\n#+BEGIN_HTML\n"
 389               "</p>\n"
 390               "</div>\n"
 391               "#+END_HTML\n"))
 392      (t ;; This is not HTML, so just make it an example.
 393       (concat "#+BEGIN_EXAMPLE\n"
 394               (if title (concat "Title:" title "\n") "")
 395               (if owner (concat "By:" owner "\n") "")
 396               body
 397               (if (string-match "\n\\'" body) "" "\n")
 398               "#+END_EXAMPLE\n")))))
 399
 400 (provide 'org-exp-blocks)
 401
 402 ;;; org-exp-blocks.el ends here