contrib/babel/lisp/org-babel-exp.el

   1 ;;; org-babel-exp.el --- Exportation of org-babel source blocks
   2
   3 ;; Copyright (C) 2009 Eric Schulte, Dan Davison
   4
   5 ;; Author: Eric Schulte, Dan Davison
   6 ;; Keywords: literate programming, reproducible research
   7 ;; Homepage: http://orgmode.org
   8 ;; Version: 0.01
   9
  10 ;;; License:
  11
  12 ;; This program 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, or (at your option)
  15 ;; any later version.
  16 ;;
  17 ;; This program 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; see the file COPYING.  If not, write to the
  24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  25 ;; Boston, MA 02110-1301, USA.
  26
  27 ;;; Commentary:
  28
  29 ;; for more information see the comments in org-babel.el
  30
  31 ;;; Code:
  32 (require 'org-babel)
  33 (require 'org-exp-blocks)
  34 (org-export-blocks-add-block '(src org-babel-exp-src-blocks nil))
  35 (add-to-list 'org-export-interblocks '(src org-babel-exp-inline-src-blocks))
  36 (add-to-list 'org-export-interblocks '(lob org-babel-exp-lob-one-liners))
  37
  38 (defvar org-babel-function-def-export-keyword "function"
  39   "When exporting a source block function, this keyword will
  40 appear in the exported version in the place of source name
  41 line. A source block is considered to be a source block function
  42 if the source name is present and is followed by a parenthesized
  43 argument list. The parentheses may be empty or contain
  44 whitespace. An example is the following which generates n random
  45 (uniform) numbers.
  46
  47 #+source: rand(n)
  48 #+begin_src R
  49   runif(n)
  50 #+end_src
  51 ")
  52
  53 (defvar org-babel-function-def-export-indent 4
  54   "When exporting a source block function, the block contents
  55 will be indented by this many characters. See
  56 `org-babel-function-def-export-name' for the definition of a
  57 source block function.")
  58
  59 (defvar obe-marker nil)
  60
  61 (defun org-babel-exp-src-blocks (body &rest headers)
  62   "Process src block for export.  Depending on the 'export'
  63 headers argument in replace the source code block with...
  64
  65 both ---- display the code and the results
  66
  67 code ---- the default, display the code inside the block but do
  68           not process
  69
  70 results - just like none only the block is run on export ensuring
  71           that it's results are present in the org-mode buffer
  72
  73 none ----- do not display either code or results upon export"
  74   (interactive)
  75   (message "org-babel-exp processing...")
  76   (or (and (re-search-backward org-babel-src-block-regexp progress-marker t)
  77            (setq progress-marker (match-end 0))
  78            (org-babel-exp-do-export (org-babel-get-src-block-info) 'block))
  79       (save-excursion
  80         (forward-line 0)
  81         (and (org-babel-where-is-src-block-head)
  82              (goto-char (org-babel-where-is-src-block-head))
  83              (org-babel-exp-do-export (org-babel-get-src-block-info) 'block)))
  84       (and (re-search-backward org-block-regexp progress-marker t)
  85            (setq progress-marker (match-end 0))
  86            (match-string 0))
  87       (error "Unmatched block [bug in `org-babel-exp-src-blocks'].")))
  88
  89 (defun org-babel-exp-inline-src-blocks (start end)
  90   "Process inline src blocks between START and END for export.
  91 See `org-babel-exp-src-blocks' for export options, currently the
  92 options and are taken from `org-babel-defualt-inline-header-args'."
  93   (interactive)
  94   (save-excursion
  95     (goto-char start)
  96     (while (and (< (point) end)
  97                 (re-search-forward org-babel-inline-src-block-regexp end t))
  98       (let* ((info (save-match-data (org-babel-parse-inline-src-block-match)))
  99              (replacement (save-match-data
 100                             (org-babel-exp-do-export info 'inline))))
 101         (setq end (+ end (- (length replacement) (length (match-string 1)))))
 102         (replace-match replacement t t nil 1)))))
 103
 104 (defun org-babel-exp-lob-one-liners (start end)
 105   "Process #+lob (Library of Babel) calls between START and END for export.
 106 See `org-babel-exp-src-blocks' for export options. Currently the
 107 options are taken from `org-babel-default-header-args'."
 108   (interactive)
 109   (let (replacement)
 110     (save-excursion
 111       (goto-char start)
 112       (while (and (< (point) end)
 113                   (re-search-forward org-babel-lob-one-liner-regexp nil t))
 114         (setq replacement
 115               (save-match-data
 116                 (org-babel-exp-do-export
 117                  (list "emacs-lisp" "results"
 118                        (org-babel-merge-params
 119                         org-babel-default-header-args
 120                         (org-babel-parse-header-arguments
 121                          (org-babel-clean-text-properties
 122                           (concat ":var results="
 123                                   (mapconcat #'identity (org-babel-lob-get-info) " "))))))
 124                  'lob)))
 125         (setq end (+ end (- (length replacement) (length (match-string 0)))))
 126         (replace-match replacement t t)))))
 127
 128 (defun org-babel-exp-do-export (info type)
 129   (case (intern (or (cdr (assoc :exports (third info))) "code"))
 130     ('none "")
 131     ('code (org-babel-exp-code info type))
 132     ('results (org-babel-exp-results info type))
 133     ('both (concat (org-babel-exp-code info type)
 134                    "\n\n"
 135                    (org-babel-exp-results info type)))))
 136
 137 (defun org-babel-exp-code (info type)
 138   (let ((lang (first info))
 139         (body (second info))
 140         (switches (fourth info))
 141         (name (fifth info))
 142         (args (sixth info))
 143         (function-def-line ""))
 144     (case type
 145       ('inline (format "=%s=" (second info)))
 146       ('block
 147           (let ((str (format "#+BEGIN_SRC %s %s\n%s%s#+END_SRC\n" lang switches body
 148                         (if (string-match "\n$" body) "" "\n"))))
 149             (add-text-properties 0 (length str) (list 'org-caption name) str)
 150             str))
 151       ('lob (save-excursion
 152               (re-search-backward org-babel-lob-one-liner-regexp)
 153               (format "#+BEGIN_SRC org-babel-lob\n%s\n#+END_SRC"
 154                       (first (org-babel-lob-get-info))))))))
 155
 156 (defun org-babel-exp-results (info type)
 157   (let ((lang (first info))
 158         (body (second info))
 159         (params
 160          ;; lets ensure that we lookup references in the original file
 161          (mapcar (lambda (pair)
 162                    (if (and org-current-export-file
 163                             (eq (car pair) :var)
 164                             (string-match org-babel-ref-split-regexp (cdr pair)))
 165                        `(:var . ,(concat (match-string 1 (cdr pair))
 166                                          "=" org-current-export-file
 167                                          ":" (match-string 2 (cdr pair))))
 168                      pair))
 169                  (third info))))
 170     (case type
 171       ('inline
 172         (let ((raw (org-babel-execute-src-block
 173                     nil info '((:results . "silent"))))
 174               (result-params (split-string (cdr (assoc :results params)))))
 175           (cond ;; respect the value of the :results header argument
 176            ((member "file" result-params)
 177             (org-babel-result-to-file raw))
 178            ((or (member "raw" result-params) (member "org" result-params))
 179             raw)
 180            ((member "code" result-params)
 181             (format "src_%s{%s}" lang raw))
 182            (t
 183             (if (stringp raw)
 184                 (if (= 0 (length raw)) "=(no results)="
 185                   (format "=%s=" raw))
 186               (format "=%S=" raw))))))
 187       ('block
 188           (org-babel-execute-src-block
 189            nil nil (org-babel-merge-params params '((:results . "replace"))))
 190         "")
 191       ('lob
 192           (save-excursion
 193             (re-search-backward org-babel-lob-one-liner-regexp nil t)
 194             (org-babel-execute-src-block
 195              nil (list lang body (org-babel-merge-params params '((:results . "replace"))))) "")))))
 196
 197 (provide 'org-babel-exp)
 198 ;;; org-babel-exp.el ends here