lisp/ob-exp.el

   1 ;;; ob-exp.el --- Exportation of org-babel source blocks
   2
   3 ;; Copyright (C) 2009-2012  Free Software Foundation, Inc.
   4
   5 ;; Author: Eric Schulte
   6 ;;      Dan Davison
   7 ;; Keywords: literate programming, reproducible research
   8 ;; Homepage: http://orgmode.org
   9
  10 ;; This file is part of GNU Emacs.
  11
  12 ;; GNU Emacs is free software: you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation, either version 3 of the License, or
  15 ;; (at your option) any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  24
  25 ;;; Code:
  26 (require 'ob)
  27 (require 'org-exp-blocks)
  28 (eval-when-compile
  29   (require 'cl))
  30
  31 (defvar obe-marker nil)
  32 (defvar org-current-export-file)
  33 (defvar org-babel-lob-one-liner-regexp)
  34 (defvar org-babel-ref-split-regexp)
  35 (declare-function org-babel-lob-get-info "ob-lob" ())
  36 (declare-function org-babel-eval-wipe-error-buffer "ob-eval" ())
  37 (add-to-list 'org-export-interblocks '(src org-babel-exp-inline-src-blocks))
  38 (add-to-list 'org-export-interblocks '(lob org-babel-exp-lob-one-liners))
  39
  40 (org-export-blocks-add-block '(src org-babel-exp-src-block nil))
  41
  42 (defcustom org-export-babel-evaluate t
  43   "Switch controlling code evaluation during export.
  44 When set to nil no code will be evaluated as part of the export
  45 process."
  46   :group 'org-babel
  47   :type 'boolean)
  48 (put 'org-export-babel-evaluate 'safe-local-variable (lambda (x) (eq x nil)))
  49
  50 (defmacro org-babel-exp-in-export-file (lang &rest body)
  51   (declare (indent 1))
  52   `(let* ((lang-headers (intern (concat "org-babel-default-header-args:" ,lang)))
  53           (heading (nth 4 (ignore-errors (org-heading-components))))
  54           (link (when org-current-export-file
  55                   (org-make-link-string
  56                    (if heading
  57                        (concat org-current-export-file "::" heading)
  58                      org-current-export-file))))
  59           (export-buffer (current-buffer)) results)
  60      (when link
  61        ;; resolve parameters in the original file so that
  62        ;; headline and file-wide parameters are included, attempt
  63        ;; to go to the same heading in the original file
  64        (set-buffer (get-file-buffer org-current-export-file))
  65        (save-restriction
  66          (condition-case nil
  67              (let ((org-link-search-inhibit-query t))
  68                (org-open-link-from-string link))
  69            (error (when heading
  70                     (goto-char (point-min))
  71                     (re-search-forward (regexp-quote heading) nil t))))
  72          (setq results ,@body))
  73        (set-buffer export-buffer)
  74        results)))
  75 (def-edebug-spec org-babel-exp-in-export-file (form body))
  76
  77 (defun org-babel-exp-src-block (body &rest headers)
  78   "Process source block for export.
  79 Depending on the 'export' headers argument in replace the source
  80 code block with...
  81
  82 both ---- display the code and the results
  83
  84 code ---- the default, display the code inside the block but do
  85           not process
  86
  87 results - just like none only the block is run on export ensuring
  88           that it's results are present in the org-mode buffer
  89
  90 none ----- do not display either code or results upon export"
  91   (interactive)
  92   (unless noninteractive (message "org-babel-exp processing..."))
  93   (save-excursion
  94     (goto-char (match-beginning 0))
  95     (let* ((info (org-babel-get-src-block-info 'light))
  96            (lang (nth 0 info))
  97            (raw-params (nth 2 info)) hash)
  98       ;; bail if we couldn't get any info from the block
  99       (when info
 100         ;; if we're actually going to need the parameters
 101         (when (member (cdr (assoc :exports (nth 2 info))) '("both" "results"))
 102           (org-babel-exp-in-export-file lang
 103             (setf (nth 2 info)
 104                   (org-babel-process-params
 105                    (org-babel-merge-params
 106                     org-babel-default-header-args
 107                     (org-babel-params-from-properties lang)
 108                     (if (boundp lang-headers) (eval lang-headers) nil)
 109                     raw-params))))
 110           (setf hash (org-babel-sha1-hash info)))
 111         ;; expand noweb references in the original file
 112         (setf (nth 1 info)
 113               (if (org-babel-noweb-p (nth 2 info) :export)
 114                   (org-babel-expand-noweb-references
 115                    info (get-file-buffer org-current-export-file))
 116                 (nth 1 info)))
 117         (org-babel-exp-do-export info 'block hash)))))
 118
 119 (defun org-babel-exp-inline-src-blocks (start end)
 120   "Process inline source blocks between START and END for export.
 121 See `org-babel-exp-src-block' for export options, currently the
 122 options and are taken from `org-babel-default-inline-header-args'."
 123   (interactive)
 124   (save-excursion
 125     (goto-char start)
 126     (while (and (< (point) end)
 127                 (re-search-forward org-babel-inline-src-block-regexp end t))
 128       (let* ((info (save-match-data (org-babel-parse-inline-src-block-match)))
 129              (params (nth 2 info)))
 130         (save-match-data
 131           (goto-char (match-beginning 2))
 132           (unless (org-babel-in-example-or-verbatim)
 133             ;; expand noweb references in the original file
 134             (setf (nth 1 info)
 135                   (if (org-babel-noweb-p params :export)
 136                       (org-babel-expand-noweb-references
 137                        info (get-file-buffer org-current-export-file))
 138                     (nth 1 info)))
 139             (let ((code-replacement (save-match-data
 140                                       (org-babel-exp-do-export info 'inline))))
 141               (if code-replacement
 142                   (replace-match code-replacement nil nil nil 1)
 143                 (org-babel-examplize-region (match-beginning 1) (match-end 1))
 144                 (forward-char 2)))))))))
 145
 146 (defun org-babel-in-example-or-verbatim ()
 147   "Return true if point is in example or verbatim code.
 148 Example and verbatim code include escaped portions of
 149 an org-mode buffer code that should be treated as normal
 150 org-mode text."
 151   (or (save-match-data
 152         (save-excursion
 153           (goto-char (point-at-bol))
 154           (looking-at "[ \t]*:[ \t]")))
 155       (org-in-verbatim-emphasis)
 156       (org-in-block-p org-list-forbidden-blocks)
 157       (org-between-regexps-p "^[ \t]*#\\+begin_src" "^[ \t]*#\\+end_src")))
 158
 159 (defvar org-babel-default-lob-header-args)
 160 (defun org-babel-exp-lob-one-liners (start end)
 161   "Process Library of Babel calls between START and END for export.
 162 See `org-babel-exp-src-block' for export options. Currently the
 163 options are taken from `org-babel-default-header-args'."
 164   (interactive)
 165   (save-excursion
 166     (goto-char start)
 167     (while (and (< (point) end)
 168                 (re-search-forward org-babel-lob-one-liner-regexp end t))
 169       (unless (org-babel-in-example-or-verbatim)
 170         (let* ((lob-info (org-babel-lob-get-info))
 171                (inlinep (match-string 11))
 172                (inline-start (match-end 11))
 173                (inline-end (match-end 0))
 174                (rep (let ((lob-info (org-babel-lob-get-info)))
 175                       (save-match-data
 176                         (org-babel-exp-do-export
 177                          (list "emacs-lisp" "results"
 178                                (org-babel-merge-params
 179                                 org-babel-default-header-args
 180                                 org-babel-default-lob-header-args
 181                                 (org-babel-params-from-properties)
 182                                 (org-babel-parse-header-arguments
 183                                  (org-babel-clean-text-properties
 184                                   (concat ":var results="
 185                                           (mapconcat #'identity
 186                                                      (butlast lob-info) " ")))))
 187                                "" nil (car (last lob-info)))
 188                          'lob)))))
 189           (setq end (+ end (- (length rep)
 190                               (- (length (match-string 0))
 191                                  (length (or (match-string 11) ""))))))
 192           (if inlinep
 193               (save-excursion
 194                 (goto-char inline-start)
 195                 (delete-region inline-start inline-end)
 196                 (insert rep))
 197             (replace-match rep t t)))))))
 198
 199 (defun org-babel-exp-do-export (info type &optional hash)
 200   "Return a string with the exported content of a code block.
 201 The function respects the value of the :exports header argument."
 202   (flet ((silently () (let ((session (cdr (assoc :session (nth 2 info)))))
 203                         (when (not (and session (equal "none" session)))
 204                           (org-babel-exp-results info type 'silent))))
 205          (clean () (unless (eq type 'inline) (org-babel-remove-result info))))
 206     (case (intern (or (cdr (assoc :exports (nth 2 info))) "code"))
 207       ('none (silently) (clean) "")
 208       ('code (silently) (clean) (org-babel-exp-code info))
 209       ('results (org-babel-exp-results info type nil hash) "")
 210       ('both (org-babel-exp-results info type nil hash)
 211              (org-babel-exp-code info)))))
 212
 213 (defcustom org-babel-exp-code-template
 214   "#+BEGIN_SRC %lang%flags\n%body\n#+END_SRC"
 215   "Template used to export the body of code blocks.
 216 This template may be customized to include additional information
 217 such as the code block name, or the values of particular header
 218 arguments.  The template is filled out using `org-fill-template',
 219 and the following %keys may be used.
 220
 221  lang ------ the language of the code block
 222  name ------ the name of the code block
 223  body ------ the body of the code block
 224  flags ----- the flags passed to the code block
 225
 226 In addition to the keys mentioned above, every header argument
 227 defined for the code block may be used as a key and will be
 228 replaced with its value."
 229   :group 'org-babel
 230   :type 'string)
 231
 232 (defun org-babel-exp-code (info)
 233   "Return the original code block formatted for export."
 234   (org-fill-template
 235    org-babel-exp-code-template
 236    `(("lang"  . ,(nth 0 info))
 237      ("body"  . ,(nth 1 info))
 238      ,@(mapcar (lambda (pair)
 239                  (cons (substring (symbol-name (car pair)) 1)
 240                        (format "%S" (cdr pair))))
 241                (nth 2 info))
 242      ("flags" . ,((lambda (f) (when f (concat " " f))) (nth 3 info)))
 243      ("name"  . ,(or (nth 4 info) "")))))
 244
 245 (defun org-babel-exp-results (info type &optional silent hash)
 246   "Evaluate and return the results of the current code block for export.
 247 Results are prepared in a manner suitable for export by org-mode.
 248 This function is called by `org-babel-exp-do-export'.  The code
 249 block will be evaluated.  Optional argument SILENT can be used to
 250 inhibit insertion of results into the buffer."
 251   (when (and org-export-babel-evaluate
 252              (not (and hash (equal hash (org-babel-current-result-hash)))))
 253     (let ((lang (nth 0 info))
 254           (body (nth 1 info))
 255           (info (copy-sequence info)))
 256       ;; skip code blocks which we can't evaluate
 257       (when (fboundp (intern (concat "org-babel-execute:" lang)))
 258         (org-babel-eval-wipe-error-buffer)
 259         (prog1 nil
 260           (setf (nth 2 info)
 261                 (org-babel-exp-in-export-file lang
 262                   (org-babel-process-params
 263                    (org-babel-merge-params
 264                     (nth 2 info)
 265                     `((:results . ,(if silent "silent" "replace")))))))
 266           (cond
 267            ((equal type 'block)
 268             (org-babel-execute-src-block nil info))
 269            ((equal type 'inline)
 270             ;; position the point on the inline source block allowing
 271             ;; `org-babel-insert-result' to check that the block is
 272             ;; inline
 273             (re-search-backward "[ \f\t\n\r\v]" nil t)
 274             (re-search-forward org-babel-inline-src-block-regexp nil t)
 275             (re-search-backward "src_" nil t)
 276             (org-babel-execute-src-block nil info))
 277            ((equal type 'lob)
 278             (save-excursion
 279               (re-search-backward org-babel-lob-one-liner-regexp nil t)
 280               (org-babel-execute-src-block nil info)))))))))
 281
 282 (provide 'ob-exp)
 283
 284
 285
 286 ;;; ob-exp.el ends here