lisp/ob-exp.el

   1 ;;; ob-exp.el --- Exportation of org-babel source blocks
   2
   3 ;; Copyright (C) 2009-2014 Free Software Foundation, Inc.
   4
   5 ;; Authors: 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-core)
  27 (eval-when-compile
  28   (require 'cl))
  29
  30 (defvar org-current-export-file)
  31 (defvar org-babel-lob-one-liner-regexp)
  32 (defvar org-babel-ref-split-regexp)
  33 (defvar org-list-forbidden-blocks)
  34
  35 (declare-function org-babel-lob-get-info "ob-lob" ())
  36 (declare-function org-babel-eval-wipe-error-buffer "ob-eval" ())
  37 (declare-function org-between-regexps-p "org"
  38                   (start-re end-re &optional lim-up lim-down))
  39 (declare-function org-get-indentation "org" (&optional line))
  40 (declare-function org-heading-components "org" ())
  41 (declare-function org-in-block-p "org" (names))
  42 (declare-function org-in-verbatim-emphasis "org" ())
  43 (declare-function org-link-search "org" (s &optional type avoid-pos stealth))
  44 (declare-function org-fill-template "org" (template alist))
  45 (declare-function org-split-string "org" (string &optional separators))
  46 (declare-function org-element-at-point "org-element" (&optional keep-trail))
  47 (declare-function org-element-context "org-element" ())
  48 (declare-function org-element-property "org-element" (property element))
  49 (declare-function org-element-type "org-element" (element))
  50 (declare-function org-escape-code-in-string "org-src" (s))
  51
  52 (defcustom org-export-babel-evaluate t
  53   "Switch controlling code evaluation during export.
  54 When set to nil no code will be evaluated as part of the export
  55 process.  When set to 'inline-only, only inline code blocks will
  56 be executed."
  57   :group 'org-babel
  58   :version "24.1"
  59   :type '(choice (const :tag "Never" nil)
  60                  (const :tag "Only inline code" inline-only)
  61                  (const :tag "Always" t)))
  62 (put 'org-export-babel-evaluate 'safe-local-variable (lambda (x) (eq x nil)))
  63
  64 (defun org-babel-exp-get-export-buffer ()
  65   "Return the current export buffer if possible."
  66   (cond
  67    ((bufferp org-current-export-file) org-current-export-file)
  68    (org-current-export-file (get-file-buffer org-current-export-file))
  69    ('otherwise
  70     (error "Requested export buffer when `org-current-export-file' is nil"))))
  71
  72 (defvar org-link-search-inhibit-query)
  73
  74 (defmacro org-babel-exp-in-export-file (lang &rest body)
  75   (declare (indent 1))
  76   `(let* ((lang-headers (intern (concat "org-babel-default-header-args:" ,lang)))
  77           (heading (nth 4 (ignore-errors (org-heading-components))))
  78           (export-buffer (current-buffer))
  79           (original-buffer (org-babel-exp-get-export-buffer)) results)
  80      (when original-buffer
  81        ;; resolve parameters in the original file so that
  82        ;; headline and file-wide parameters are included, attempt
  83        ;; to go to the same heading in the original file
  84        (set-buffer original-buffer)
  85        (save-restriction
  86          (when heading
  87            (condition-case nil
  88                (let ((org-link-search-inhibit-query t))
  89                  (org-link-search heading))
  90              (error (when heading
  91                       (goto-char (point-min))
  92                       (re-search-forward (regexp-quote heading) nil t)))))
  93          (setq results ,@body))
  94        (set-buffer export-buffer)
  95        results)))
  96 (def-edebug-spec org-babel-exp-in-export-file (form body))
  97
  98 (defun org-babel-exp-src-block (&rest headers)
  99   "Process source block for export.
 100 Depending on the 'export' headers argument, replace the source
 101 code block like this:
 102
 103 both ---- display the code and the results
 104
 105 code ---- the default, display the code inside the block but do
 106           not process
 107
 108 results - just like none only the block is run on export ensuring
 109           that it's results are present in the org-mode buffer
 110
 111 none ---- do not display either code or results upon export
 112
 113 Assume point is at the beginning of block's starting line."
 114   (interactive)
 115   (unless noninteractive (message "org-babel-exp processing..."))
 116   (save-excursion
 117     (let* ((info (org-babel-get-src-block-info 'light))
 118            (lang (nth 0 info))
 119            (raw-params (nth 2 info)) hash)
 120       ;; bail if we couldn't get any info from the block
 121       (when info
 122         ;; if we're actually going to need the parameters
 123         (when (member (cdr (assoc :exports (nth 2 info))) '("both" "results"))
 124           (org-babel-exp-in-export-file lang
 125             (setf (nth 2 info)
 126                   (org-babel-process-params
 127                    (apply #'org-babel-merge-params
 128                           org-babel-default-header-args
 129                           (if (boundp lang-headers) (eval lang-headers) nil)
 130                           (append (org-babel-params-from-properties lang)
 131                                   (list raw-params))))))
 132           (setf hash (org-babel-sha1-hash info)))
 133         (org-babel-exp-do-export info 'block hash)))))
 134
 135 (defcustom org-babel-exp-call-line-template
 136   ""
 137   "Template used to export call lines.
 138 This template may be customized to include the call line name
 139 with any export markup.  The template is filled out using
 140 `org-fill-template', and the following %keys may be used.
 141
 142  line --- call line
 143
 144 An example value would be \"\\n: call: %line\" to export the call line
 145 wrapped in a verbatim environment.
 146
 147 Note: the results are inserted separately after the contents of
 148 this template."
 149   :group 'org-babel
 150   :type 'string)
 151
 152 (defvar org-babel-default-lob-header-args)
 153 (defun org-babel-exp-process-buffer ()
 154   "Execute all Babel blocks in current buffer."
 155   (interactive)
 156   (save-window-excursion
 157     (save-excursion
 158       (let ((case-fold-search t)
 159             (regexp (concat org-babel-inline-src-block-regexp "\\|"
 160                             org-babel-lob-one-liner-regexp "\\|"
 161                             "^[ \t]*#\\+BEGIN_SRC")))
 162         (goto-char (point-min))
 163         (while (re-search-forward regexp nil t)
 164           (let* ((element (save-excursion
 165                             ;; If match is inline, point is at its
 166                             ;; end.  Move backward so
 167                             ;; `org-element-context' can get the
 168                             ;; object, not the following one.
 169                             (backward-char)
 170                             (save-match-data (org-element-context))))
 171                  (type (org-element-type element))
 172                  (beg-el (org-element-property :begin element))
 173                  (end-el (org-element-property :end element)))
 174             (case type
 175               (inline-src-block
 176                (let* ((info (org-babel-parse-inline-src-block-match))
 177                       (params (nth 2 info)))
 178                  (setf (nth 1 info)
 179                        (if (and (cdr (assoc :noweb params))
 180                                 (string= "yes" (cdr (assoc :noweb params))))
 181                            (org-babel-expand-noweb-references
 182                             info (org-babel-exp-get-export-buffer))
 183                          (nth 1 info)))
 184                  (goto-char beg-el)
 185                  (let ((replacement (org-babel-exp-do-export info 'inline)))
 186                    (if (equal replacement "")
 187                        ;; Replacement code is empty: remove inline src
 188                        ;; block, including extra white space that
 189                        ;; might have been created when inserting
 190                        ;; results.
 191                        (delete-region beg-el
 192                                       (progn (goto-char end-el)
 193                                              (skip-chars-forward " \t")
 194                                              (point)))
 195                      ;; Otherwise: remove inline src block but
 196                      ;; preserve following white spaces.  Then insert
 197                      ;; value.
 198                      (delete-region beg-el
 199                                     (progn (goto-char end-el)
 200                                            (skip-chars-backward " \t")
 201                                            (point)))
 202                      (insert replacement)))))
 203               ((babel-call inline-babel-call)
 204                (let* ((lob-info (org-babel-lob-get-info))
 205                       (results
 206                        (org-babel-exp-do-export
 207                         (list "emacs-lisp" "results"
 208                               (apply #'org-babel-merge-params
 209                                      org-babel-default-header-args
 210                                      org-babel-default-lob-header-args
 211                                      (append
 212                                       (org-babel-params-from-properties)
 213                                       (list
 214                                        (org-babel-parse-header-arguments
 215                                         (org-no-properties
 216                                          (concat
 217                                           ":var results="
 218                                           (mapconcat 'identity
 219                                                      (butlast lob-info 2)
 220                                                      " ")))))))
 221                               "" (nth 3 lob-info) (nth 2 lob-info))
 222                         'lob))
 223                       (rep (org-fill-template
 224                             org-babel-exp-call-line-template
 225                             `(("line"  . ,(nth 0 lob-info))))))
 226                  ;; If replacement is empty, completely remove the
 227                  ;; object/element, including any extra white space
 228                  ;; that might have been created when including
 229                  ;; results.
 230                  (if (equal rep "")
 231                      (delete-region
 232                       beg-el
 233                       (progn (goto-char end-el)
 234                              (if (not (eq type 'babel-call))
 235                                  (progn (skip-chars-forward " \t") (point))
 236                                (skip-chars-forward " \r\t\n")
 237                                (line-beginning-position))))
 238                    ;; Otherwise, preserve following white
 239                    ;; spaces/newlines and then, insert replacement
 240                    ;; string.
 241                    (goto-char beg-el)
 242                    (delete-region beg-el
 243                                   (progn (goto-char end-el)
 244                                          (skip-chars-backward " \r\t\n")
 245                                          (point)))
 246                    (insert rep))))
 247               (src-block
 248                (let* ((match-start (match-beginning 0))
 249                       ;; Make sure we don't remove any blank lines
 250                       ;; after the block when replacing it.
 251                       (block-end (save-excursion
 252                                    (goto-char end-el)
 253                                    (skip-chars-backward " \r\t\n")
 254                                    (line-end-position)))
 255                       (ind (org-get-indentation))
 256                       (headers
 257                        (cons
 258                         (org-element-property :language element)
 259                         (let ((params (org-element-property :parameters element)))
 260                           (and params (org-split-string params "[ \t]+"))))))
 261                  ;; Take care of matched block: compute replacement
 262                  ;; string.  In particular, a nil REPLACEMENT means
 263                  ;; the block should be left as-is while an empty
 264                  ;; string should remove the block.
 265                  (let ((replacement (progn (goto-char match-start)
 266                                            (org-babel-exp-src-block headers))))
 267                    (cond ((not replacement) (goto-char block-end))
 268                          ((equal replacement "")
 269                           (delete-region beg-el end-el))
 270                          (t
 271                           (goto-char match-start)
 272                           (delete-region (point) block-end)
 273                           (insert replacement)
 274                           (if (org-element-property :preserve-indent element)
 275                               ;; Indent only the code block markers.
 276                               (save-excursion (skip-chars-backward " \r\t\n")
 277                                               (indent-line-to ind)
 278                                               (goto-char match-start)
 279                                               (indent-line-to ind))
 280                             ;; Indent everything.
 281                             (indent-rigidly match-start (point) ind))))))))))))))
 282
 283 (defun org-babel-in-example-or-verbatim ()
 284   "Return true if point is in example or verbatim code.
 285 Example and verbatim code include escaped portions of
 286 an org-mode buffer code that should be treated as normal
 287 org-mode text."
 288   (or (save-match-data
 289         (save-excursion
 290           (goto-char (point-at-bol))
 291           (looking-at "[ \t]*:[ \t]")))
 292       (org-in-verbatim-emphasis)
 293       (org-in-block-p org-list-forbidden-blocks)
 294       (org-between-regexps-p "^[ \t]*#\\+begin_src" "^[ \t]*#\\+end_src")))
 295
 296 (defun org-babel-exp-do-export (info type &optional hash)
 297   "Return a string with the exported content of a code block.
 298 The function respects the value of the :exports header argument."
 299   (let ((silently (lambda () (let ((session (cdr (assoc :session (nth 2 info)))))
 300                                (when (not (and session (equal "none" session)))
 301                                  (org-babel-exp-results info type 'silent)))))
 302         (clean (lambda () (unless (eq type 'inline) (org-babel-remove-result info)))))
 303     (case (intern (or (cdr (assoc :exports (nth 2 info))) "code"))
 304       ('none (funcall silently) (funcall clean) "")
 305       ('code (funcall silently) (funcall clean) (org-babel-exp-code info))
 306       ('results (org-babel-exp-results info type nil hash) "")
 307       ('both (org-babel-exp-results info type nil hash)
 308              (org-babel-exp-code info)))))
 309
 310 (defcustom org-babel-exp-code-template
 311   "#+BEGIN_SRC %lang%flags\n%body\n#+END_SRC"
 312   "Template used to export the body of code blocks.
 313 This template may be customized to include additional information
 314 such as the code block name, or the values of particular header
 315 arguments.  The template is filled out using `org-fill-template',
 316 and the following %keys may be used.
 317
 318  lang ------ the language of the code block
 319  name ------ the name of the code block
 320  body ------ the body of the code block
 321  flags ----- the flags passed to the code block
 322
 323 In addition to the keys mentioned above, every header argument
 324 defined for the code block may be used as a key and will be
 325 replaced with its value."
 326   :group 'org-babel
 327   :type 'string)
 328
 329 (defun org-babel-exp-code (info)
 330   "Return the original code block formatted for export."
 331   (setf (nth 1 info)
 332         (if (string= "strip-export" (cdr (assoc :noweb (nth 2 info))))
 333             (replace-regexp-in-string
 334              (org-babel-noweb-wrap) "" (nth 1 info))
 335           (if (org-babel-noweb-p (nth 2 info) :export)
 336               (org-babel-expand-noweb-references
 337                info (org-babel-exp-get-export-buffer))
 338             (nth 1 info))))
 339   (org-fill-template
 340    org-babel-exp-code-template
 341    `(("lang"  . ,(nth 0 info))
 342      ("body"  . ,(org-escape-code-in-string (nth 1 info)))
 343      ,@(mapcar (lambda (pair)
 344                  (cons (substring (symbol-name (car pair)) 1)
 345                        (format "%S" (cdr pair))))
 346                (nth 2 info))
 347      ("flags" . ,(let ((f (nth 3 info))) (when f (concat " " f))))
 348      ("name"  . ,(or (nth 4 info) "")))))
 349
 350 (defun org-babel-exp-results (info type &optional silent hash)
 351   "Evaluate and return the results of the current code block for export.
 352 Results are prepared in a manner suitable for export by org-mode.
 353 This function is called by `org-babel-exp-do-export'.  The code
 354 block will be evaluated.  Optional argument SILENT can be used to
 355 inhibit insertion of results into the buffer."
 356   (when (and (or (eq org-export-babel-evaluate t)
 357                  (and (eq type 'inline)
 358                       (eq org-export-babel-evaluate 'inline-only)))
 359              (not (and hash (equal hash (org-babel-current-result-hash)))))
 360     (let ((lang (nth 0 info))
 361           (body (if (org-babel-noweb-p (nth 2 info) :eval)
 362                     (org-babel-expand-noweb-references
 363                      info (org-babel-exp-get-export-buffer))
 364                   (nth 1 info)))
 365           (info (copy-sequence info))
 366           (org-babel-current-src-block-location (point-marker)))
 367       ;; skip code blocks which we can't evaluate
 368       (when (fboundp (intern (concat "org-babel-execute:" lang)))
 369         (org-babel-eval-wipe-error-buffer)
 370         (prog1 nil
 371           (setf (nth 1 info) body)
 372           (setf (nth 2 info)
 373                 (org-babel-exp-in-export-file lang
 374                   (org-babel-process-params
 375                    (org-babel-merge-params
 376                     (nth 2 info)
 377                     `((:results . ,(if silent "silent" "replace")))))))
 378           (cond
 379            ((equal type 'block)
 380             (org-babel-execute-src-block nil info))
 381            ((equal type 'inline)
 382             ;; position the point on the inline source block allowing
 383             ;; `org-babel-insert-result' to check that the block is
 384             ;; inline
 385             (re-search-backward "[ \f\t\n\r\v]" nil t)
 386             (re-search-forward org-babel-inline-src-block-regexp nil t)
 387             (re-search-backward "src_" nil t)
 388             (org-babel-execute-src-block nil info))
 389            ((equal type 'lob)
 390             (save-excursion
 391               (re-search-backward org-babel-lob-one-liner-regexp nil t)
 392               (let (org-confirm-babel-evaluate)
 393                 (org-babel-execute-src-block nil info))))))))))
 394
 395
 396 (provide 'ob-exp)
 397
 398 ;;; ob-exp.el ends here