1 ;;; org-exp-blocks.el --- pre-process blocks when exporting org files
3 ;; Copyright (C) 2009-2012 Free Software Foundation, Inc.
5 ;; Author: Eric Schulte
7 ;; This file is part of GNU Emacs.
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.
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.
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/>.
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.
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
37 ;; #+begin_ditaa blue.png -r -S
47 ;;; Currently Implemented Block Types
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) .
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/
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.
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'.
78 (defun org-export-blocks-set (var value
)
79 "Set the value of `org-export-blocks' and install fontification."
83 (setq org-protecting-blocks
84 (delete (symbol-name (car spec
))
85 org-protecting-blocks
))
86 (add-to-list 'org-protecting-blocks
87 (symbol-name (car spec
)))))
90 (defcustom org-export-blocks
91 '((export-comment org-export-blocks-format-comment t
)
92 (ditaa org-export-blocks-format-ditaa nil
)
93 (dot org-export-blocks-format-dot nil
))
94 "Use this alist to associate block types with block exporting functions.
95 The type of a block is determined by the text immediately
96 following the '#+BEGIN_' portion of the block header. Each block
97 export function should accept three arguments."
98 :group
'org-export-general
101 (symbol :tag
"Block name")
102 (function :tag
"Block formatter")
103 (boolean :tag
"Fontify content as Org syntax")))
104 :set
'org-export-blocks-set
)
106 (defun org-export-blocks-add-block (block-spec)
107 "Add a new block type to `org-export-blocks'.
108 BLOCK-SPEC should be a three element list the first element of
109 which should indicate the name of the block, the second element
110 should be the formatting function called by
111 `org-export-blocks-preprocess' and the third element a flag
112 indicating whether these types of blocks should be fontified in
113 org-mode buffers (see `org-protecting-blocks'). For example the
114 BLOCK-SPEC for ditaa blocks is as follows.
116 (ditaa org-export-blocks-format-ditaa nil)"
117 (unless (member block-spec org-export-blocks
)
118 (setq org-export-blocks
(cons block-spec org-export-blocks
))
119 (org-export-blocks-set 'org-export-blocks org-export-blocks
)))
121 (defcustom org-export-interblocks
123 "Use this a-list to associate block types with block exporting functions.
124 The type of a block is determined by the text immediately
125 following the '#+BEGIN_' portion of the block header. Each block
126 export function should accept three arguments."
127 :group
'org-export-general
130 (defcustom org-export-blocks-witheld
132 "List of block types (see `org-export-blocks') which should not be exported."
133 :group
'org-export-general
136 (defcustom org-export-blocks-postblock-hook nil
137 "Run after blocks have been processed with `org-export-blocks-preprocess'."
138 :group
'org-export-general
142 (defun org-export-blocks-html-quote (body &optional open close
)
143 "Protect BODY from org html export.
144 The optional OPEN and CLOSE tags will be inserted around BODY."
149 body
(if (string-match "\n$" body
) "" "\n")
153 (defun org-export-blocks-latex-quote (body &optional open close
)
154 "Protect BODY from org latex export.
155 The optional OPEN and CLOSE tags will be inserted around BODY."
159 body
(if (string-match "\n$" body
) "" "\n")
163 (defun org-export-blocks-preprocess ()
164 "Export all blocks according to the `org-export-blocks' block export alist.
165 Does not export block types specified in specified in BLOCKS
166 which defaults to the value of `org-export-blocks-witheld'."
168 (save-window-excursion
169 (let ((case-fold-search t
)
171 matched indentation type func
172 start end body headers preserve-indent progress-marker
)
173 (flet ((interblock (start end
)
174 (mapcar (lambda (pair) (funcall (second pair
) start end
))
175 org-export-interblocks
)))
176 (goto-char (point-min))
178 (let ((beg-re "^\\([ \t]*\\)#\\+begin_\\(\\S-+\\)[ \t]*\\(.*\\)?[\r\n]"))
179 (while (re-search-forward beg-re nil t
)
180 (let* ((match-start (copy-marker (match-beginning 0)))
181 (body-start (copy-marker (match-end 0)))
182 (indentation (length (match-string 1)))
183 (inner-re (format "^[ \t]*#\\+\\(begin\\|end\\)_%s"
184 (regexp-quote (downcase (match-string 2)))))
185 (type (intern (downcase (match-string 2))))
186 (headers (save-match-data
187 (org-split-string (match-string 3) "[ \t]+")))
189 (preserve-indent (or org-src-preserve-indentation
190 (member "-i" headers
)))
192 (while (and (not (zerop balanced
))
193 (re-search-forward inner-re nil t
))
194 (if (string= (downcase (match-string 1)) "end")
197 (when (not (zerop balanced
))
198 (error "unbalanced begin/end_%s blocks with %S"
199 type
(buffer-substring match-start
(point))))
200 (setq match-end
(copy-marker (match-end 0)))
201 (unless preserve-indent
202 (setq body
(save-match-data (org-remove-indentation
204 body-start
(match-beginning 0))))))
205 (unless (memq type types
) (setq types
(cons type types
)))
206 (save-match-data (interblock start match-start
))
207 (when (setq func
(cadr (assoc type org-export-blocks
)))
208 (let ((replacement (save-match-data
209 (if (memq type org-export-blocks-witheld
) ""
210 (apply func body headers
)))))
212 (delete-region match-start match-end
)
213 (goto-char match-start
) (insert replacement
)
214 (unless preserve-indent
215 (indent-code-rigidly match-start
(point) indentation
)))))
217 (set-marker match-start nil
)
218 (set-marker body-start nil
)
219 (set-marker match-end nil
))
220 (setq start
(point))))
221 (interblock start
(point-max))
222 (run-hooks 'org-export-blocks-postblock-hook
)))))
224 ;;================================================================================
225 ;; type specific functions
227 ;;--------------------------------------------------------------------------------
228 ;; ditaa: create images from ASCII art using the ditaa utility
229 (defcustom org-ditaa-jar-path
(expand-file-name
231 (file-name-as-directory
234 (file-name-as-directory
237 (file-name-directory (org-find-library-name "org")))))))
238 "Path to the ditaa jar executable."
242 (defvar org-export-current-backend
) ; dynamically bound in org-exp.el
243 (defun org-export-blocks-format-ditaa (body &rest headers
)
244 "DEPRECATED: use begin_src ditaa code blocks
246 Pass block BODY to the ditaa utility creating an image.
247 Specify the path at which the image should be saved as the first
248 element of headers, any additional elements of headers will be
249 passed to the ditaa utility as command line arguments."
250 (message "begin_ditaa blocks are DEPRECATED, use begin_src blocks")
251 (let* ((args (if (cdr headers
) (mapconcat 'identity
(cdr headers
) " ")))
252 (data-file (make-temp-file "org-ditaa"))
254 (set-text-properties 0 (length body
) nil body
)
255 (sha1 (prin1-to-string (list body args
)))))
256 (raw-out-file (if headers
(car headers
)))
257 (out-file-parts (if (string-match "\\(.+\\)\\.\\([^\\.]+\\)$" raw-out-file
)
258 (cons (match-string 1 raw-out-file
)
259 (match-string 2 raw-out-file
))
260 (cons raw-out-file
"png")))
261 (out-file (concat (car out-file-parts
) "_" hash
"." (cdr out-file-parts
))))
262 (unless (file-exists-p org-ditaa-jar-path
)
263 (error (format "Could not find ditaa.jar at %s" org-ditaa-jar-path
)))
264 (setq body
(if (string-match "^\\([^:\\|:[^ ]\\)" body
)
266 (mapconcat (lambda (x) (substring x
(if (> (length x
) 1) 2 1)))
267 (org-split-string body
"\n")
271 ((member org-export-current-backend
'(html latex docbook
))
272 (unless (file-exists-p out-file
)
273 (mapc ;; remove old hashed versions of this file
275 (when (and (string-match (concat (regexp-quote (car out-file-parts
))
276 "_\\([[:alnum:]]+\\)\\."
277 (regexp-quote (cdr out-file-parts
)))
279 (= (length (match-string 1 out-file
)) 40))
280 (delete-file (expand-file-name file
281 (file-name-directory out-file
)))))
282 (directory-files (or (file-name-directory out-file
)
284 (with-temp-file data-file
(insert body
))
285 (message (concat "java -jar " org-ditaa-jar-path
" " args
" " data-file
" " out-file
))
286 (shell-command (concat "java -jar " org-ditaa-jar-path
" " args
" " data-file
" " out-file
)))
287 (format "\n[[file:%s]]\n" out-file
))
289 "\n#+BEGIN_EXAMPLE\n"
290 body
(if (string-match "\n$" body
) "" "\n")
292 (message "begin_ditaa blocks are DEPRECATED, use begin_src blocks"))))
294 ;;--------------------------------------------------------------------------------
295 ;; dot: create graphs using the dot graphing language
296 ;; (require the dot executable to be in your path)
297 (defun org-export-blocks-format-dot (body &rest headers
)
298 "DEPRECATED: use \"#+begin_src dot\" code blocks
300 Pass block BODY to the dot graphing utility creating an image.
301 Specify the path at which the image should be saved as the first
302 element of headers, any additional elements of headers will be
303 passed to the dot utility as command line arguments. Don't
304 forget to specify the output type for the dot command, so if you
305 are exporting to a file with a name like 'image.png' you should
306 include a '-Tpng' argument, and your block should look like the
309 #+begin_dot models.png -Tpng
310 digraph data_relationships {
311 \"data_requirement\" [shape=Mrecord, label=\"{DataRequirement|description\lformat\l}\"]
312 \"data_product\" [shape=Mrecord, label=\"{DataProduct|name\lversion\lpoc\lformat\l}\"]
313 \"data_requirement\" -> \"data_product\"
316 (message "begin_dot blocks are DEPRECATED, use begin_src blocks")
317 (let* ((args (if (cdr headers
) (mapconcat 'identity
(cdr headers
) " ")))
318 (data-file (make-temp-file "org-ditaa"))
320 (set-text-properties 0 (length body
) nil body
)
321 (sha1 (prin1-to-string (list body args
)))))
322 (raw-out-file (if headers
(car headers
)))
323 (out-file-parts (if (string-match "\\(.+\\)\\.\\([^\\.]+\\)$" raw-out-file
)
324 (cons (match-string 1 raw-out-file
)
325 (match-string 2 raw-out-file
))
326 (cons raw-out-file
"png")))
327 (out-file (concat (car out-file-parts
) "_" hash
"." (cdr out-file-parts
))))
330 ((member org-export-current-backend
'(html latex docbook
))
331 (unless (file-exists-p out-file
)
332 (mapc ;; remove old hashed versions of this file
334 (when (and (string-match (concat (regexp-quote (car out-file-parts
))
335 "_\\([[:alnum:]]+\\)\\."
336 (regexp-quote (cdr out-file-parts
)))
338 (= (length (match-string 1 out-file
)) 40))
339 (delete-file (expand-file-name file
340 (file-name-directory out-file
)))))
341 (directory-files (or (file-name-directory out-file
)
343 (with-temp-file data-file
(insert body
))
344 (message (concat "dot " data-file
" " args
" -o " out-file
))
345 (shell-command (concat "dot " data-file
" " args
" -o " out-file
)))
346 (format "\n[[file:%s]]\n" out-file
))
348 "\n#+BEGIN_EXAMPLE\n"
349 body
(if (string-match "\n$" body
) "" "\n")
351 (message "begin_dot blocks are DEPRECATED, use begin_src blocks"))))
353 ;;--------------------------------------------------------------------------------
354 ;; comment: export comments in author-specific css-stylable divs
355 (defun org-export-blocks-format-comment (body &rest headers
)
356 "Format comment BODY by OWNER and return it formatted for export.
357 Currently, this only does something for HTML export, for all
358 other backends, it converts the comment into an EXAMPLE segment."
359 (let ((owner (if headers
(car headers
)))
360 (title (if (cdr headers
) (mapconcat 'identity
(cdr headers
) " "))))
362 ((eq org-export-current-backend
'html
) ;; We are exporting to HTML
363 (concat "#+BEGIN_HTML\n"
364 "<div class=\"org-comment\""
365 (if owner
(format " id=\"org-comment-%s\" " owner
))
367 (if owner
(concat "<b>" owner
"</b> ") "")
368 (if (and title
(> (length title
) 0)) (concat " -- " title
"<br/>\n") "<br/>\n")
376 (t ;; This is not HTML, so just make it an example.
377 (concat "#+BEGIN_EXAMPLE\n"
378 (if title
(concat "Title:" title
"\n") "")
379 (if owner
(concat "By:" owner
"\n") "")
381 (if (string-match "\n\\'" body
) "" "\n")
382 "#+END_EXAMPLE\n")))))
384 (provide 'org-exp-blocks
)
386 ;;; org-exp-blocks.el ends here