2009-05-24 20:38:01 +00:00
|
|
|
;;; org-babel-exp.el --- Exportation of org-babel source blocks
|
2009-04-23 22:48:22 +00:00
|
|
|
|
|
|
|
;; Copyright (C) 2009 Eric Schulte
|
|
|
|
|
|
|
|
;; Author: Eric Schulte
|
|
|
|
;; Keywords: literate programming, reproducible research
|
|
|
|
;; Homepage: http://orgmode.org
|
|
|
|
;; Version: 0.01
|
|
|
|
|
|
|
|
;;; License:
|
|
|
|
|
|
|
|
;; This program is free software; you can redistribute it and/or modify
|
|
|
|
;; it under the terms of the GNU General Public License as published by
|
|
|
|
;; the Free Software Foundation; either version 3, or (at your option)
|
|
|
|
;; any later version.
|
|
|
|
;;
|
|
|
|
;; This program is distributed in the hope that it will be useful,
|
|
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
;; GNU General Public License for more details.
|
|
|
|
;;
|
|
|
|
;; You should have received a copy of the GNU General Public License
|
|
|
|
;; along with GNU Emacs; see the file COPYING. If not, write to the
|
|
|
|
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
|
|
;; Boston, MA 02110-1301, USA.
|
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
2009-05-24 20:38:01 +00:00
|
|
|
;; for more information see the comments in org-babel.el
|
2009-04-23 22:48:22 +00:00
|
|
|
|
|
|
|
;;; Code:
|
2009-05-24 20:38:01 +00:00
|
|
|
(require 'org-babel)
|
2009-04-26 20:29:59 +00:00
|
|
|
(require 'org-exp-blocks)
|
2009-08-17 18:19:25 +00:00
|
|
|
(org-export-blocks-add-block '(src org-babel-exp-src-blocks nil))
|
2009-05-24 20:38:01 +00:00
|
|
|
(add-to-list 'org-export-interblocks '(src org-babel-exp-inline-src-blocks))
|
2009-10-24 16:39:05 +00:00
|
|
|
(add-to-list 'org-export-interblocks '(lob org-babel-exp-lob-one-liners))
|
2009-04-23 22:48:22 +00:00
|
|
|
|
2009-05-24 20:38:01 +00:00
|
|
|
(defun org-babel-exp-src-blocks (body &rest headers)
|
2009-04-23 22:48:22 +00:00
|
|
|
"Process src block for export. Depending on the 'export'
|
|
|
|
headers argument in replace the source code block with...
|
|
|
|
|
2009-08-17 18:19:25 +00:00
|
|
|
both ---- display the code and the results
|
2009-04-23 22:48:22 +00:00
|
|
|
|
2009-08-17 18:19:25 +00:00
|
|
|
code ---- the default, display the code inside the block but do
|
|
|
|
not process
|
2009-04-23 22:48:22 +00:00
|
|
|
|
2009-09-01 21:42:14 +00:00
|
|
|
results - just like none only the block is run on export ensuring
|
|
|
|
that it's results are present in the org-mode buffer
|
2009-04-23 22:48:22 +00:00
|
|
|
|
|
|
|
none ----- do not display either code or results upon export"
|
|
|
|
(interactive)
|
2009-05-24 20:38:01 +00:00
|
|
|
(unless headers (error "org-babel can't process a source block without knowing the source code"))
|
2009-08-17 18:19:25 +00:00
|
|
|
(message "org-babel-exp processing...")
|
2009-09-01 21:30:39 +00:00
|
|
|
(let* ((lang (car headers))
|
|
|
|
(lang-headers (intern (concat "org-babel-default-header-args:" lang)))
|
|
|
|
(params (org-babel-merge-params
|
|
|
|
org-babel-default-header-args
|
|
|
|
(if (boundp lang-headers) (eval lang-headers) nil)
|
2009-09-12 18:14:09 +00:00
|
|
|
(org-babel-params-from-properties)
|
2009-09-01 21:30:39 +00:00
|
|
|
(org-babel-parse-header-arguments
|
|
|
|
(mapconcat #'identity (cdr headers) " ")))))
|
2009-10-23 21:12:02 +00:00
|
|
|
(org-babel-exp-do-export lang body params 'block)))
|
2009-04-26 20:29:59 +00:00
|
|
|
|
2009-05-24 20:38:01 +00:00
|
|
|
(defun org-babel-exp-inline-src-blocks (start end)
|
2009-04-26 20:29:59 +00:00
|
|
|
"Process inline src blocks between START and END for export.
|
2009-05-24 20:38:01 +00:00
|
|
|
See `org-babel-exp-src-blocks' for export options, currently the
|
|
|
|
options and are taken from `org-babel-defualt-inline-header-args'."
|
2009-04-26 20:29:59 +00:00
|
|
|
(interactive)
|
|
|
|
(save-excursion
|
|
|
|
(goto-char start)
|
2009-10-22 03:12:58 +00:00
|
|
|
(while (and (< (point) end)
|
|
|
|
(re-search-forward org-babel-inline-src-block-regexp end t))
|
2009-05-24 20:38:01 +00:00
|
|
|
(let* ((info (save-match-data (org-babel-parse-inline-src-block-match)))
|
2009-04-26 20:29:59 +00:00
|
|
|
(replacement (save-match-data
|
2009-10-22 03:12:58 +00:00
|
|
|
(org-babel-exp-do-export
|
2009-10-23 21:12:02 +00:00
|
|
|
(first info) (second info) (third info) 'inline))))
|
2009-10-25 00:26:00 +00:00
|
|
|
(setq end (+ end (- (length replacement) (length (match-string 0)))))
|
2009-04-26 20:29:59 +00:00
|
|
|
(replace-match replacement t t)))))
|
|
|
|
|
2009-10-24 16:39:05 +00:00
|
|
|
(defun org-babel-exp-lob-one-liners (start end)
|
|
|
|
"Process #+lob (Library of Babel) calls between START and END for export.
|
|
|
|
See `org-babel-exp-src-blocks' for export options. Currently the
|
|
|
|
options are taken from `org-babel-default-header-args'."
|
|
|
|
(interactive)
|
|
|
|
(let (replacement)
|
|
|
|
(save-excursion
|
|
|
|
(goto-char start)
|
|
|
|
(while (and (< (point) end)
|
|
|
|
(re-search-forward org-babel-lob-one-liner-regexp nil t))
|
|
|
|
(setq replacement
|
|
|
|
(save-match-data
|
|
|
|
(org-babel-exp-do-export
|
|
|
|
"emacs-lisp" "results"
|
|
|
|
(org-babel-merge-params
|
|
|
|
org-babel-default-header-args
|
|
|
|
(org-babel-parse-header-arguments
|
|
|
|
(org-babel-clean-text-properties
|
|
|
|
(concat ":var results="
|
|
|
|
(mapconcat #'identity (org-babel-lob-get-info) " ")))))
|
|
|
|
'lob)))
|
|
|
|
(setq end (+ end (- (length replacement) (length (match-string 0)))))
|
|
|
|
(replace-match replacement t t)))))
|
|
|
|
|
2009-10-23 21:12:02 +00:00
|
|
|
(defun org-babel-exp-do-export (lang body params type)
|
2009-05-11 16:57:21 +00:00
|
|
|
(case (intern (or (cdr (assoc :exports params)) "code"))
|
2009-08-17 18:19:25 +00:00
|
|
|
('none "")
|
2009-10-25 21:13:38 +00:00
|
|
|
('code (org-babel-exp-code lang body params type))
|
|
|
|
('results (org-babel-exp-results lang body params type))
|
|
|
|
('both (concat (org-babel-exp-code lang body params type)
|
2009-08-17 18:19:25 +00:00
|
|
|
"\n\n"
|
2009-10-25 21:13:38 +00:00
|
|
|
(org-babel-exp-results lang body params type)))))
|
2009-04-23 22:48:22 +00:00
|
|
|
|
2009-10-25 21:13:38 +00:00
|
|
|
(defun org-babel-exp-code (lang body params type)
|
2009-10-24 16:39:05 +00:00
|
|
|
(case type
|
|
|
|
('inline (format "=%s=" body))
|
|
|
|
('block (format "#+BEGIN_SRC %s\n%s%s\n#+END_SRC" lang body
|
|
|
|
(if (string-match "\n$" body) "" "\n")))
|
|
|
|
('lob (save-excursion
|
|
|
|
(re-search-backward org-babel-lob-one-liner-regexp)
|
2009-10-25 16:41:03 +00:00
|
|
|
(format "#+BEGIN_SRC org-babel-lob\n%s\n#+END_SRC"
|
|
|
|
(first (org-babel-lob-get-info)))))))
|
2009-04-23 22:48:22 +00:00
|
|
|
|
2009-10-25 21:13:38 +00:00
|
|
|
(defun org-babel-exp-results (lang body params type)
|
2009-10-23 17:52:49 +00:00
|
|
|
(let ((params
|
|
|
|
;; lets ensure that we lookup references in the original file
|
|
|
|
(mapcar (lambda (pair)
|
|
|
|
(if (and (eq (car pair) :var)
|
|
|
|
(string-match org-babel-ref-split-regexp (cdr pair)))
|
|
|
|
`(:var . ,(concat (match-string 1 (cdr pair))
|
|
|
|
"=" org-current-export-file
|
|
|
|
":" (match-string 2 (cdr pair))))
|
|
|
|
pair)) params)))
|
2009-10-23 21:12:02 +00:00
|
|
|
(case type
|
|
|
|
('inline
|
2009-10-23 17:52:49 +00:00
|
|
|
(let ((raw (org-babel-execute-src-block
|
2009-10-23 18:00:49 +00:00
|
|
|
nil (list lang body params) '((:results . "silent"))))
|
|
|
|
(result-params (split-string (cdr (assoc :results params)))))
|
|
|
|
(cond ;; respect the value of the :results header argument
|
|
|
|
((member "file" result-params)
|
|
|
|
(org-babel-result-to-file raw))
|
|
|
|
((or (member "raw" result-params) (member "org" result-params))
|
|
|
|
raw)
|
|
|
|
((member "code" result-params)
|
|
|
|
(format "src_%s{%s}" lang raw))
|
|
|
|
(t
|
2009-10-27 01:34:07 +00:00
|
|
|
(if (stringp raw)
|
|
|
|
(if (= 0 (length raw)) "=(no results)="
|
|
|
|
(format "=%s=" raw))
|
|
|
|
(format "=%S=" raw))))))
|
2009-10-23 21:12:02 +00:00
|
|
|
('block
|
|
|
|
(save-excursion ;; org-exp-blocks places us at the end of the block
|
|
|
|
(re-search-backward org-babel-src-block-regexp nil t)
|
|
|
|
(org-babel-execute-src-block
|
2009-10-24 16:39:05 +00:00
|
|
|
nil nil (org-babel-merge-params params '((:results . "replace")))) ""))
|
|
|
|
('lob
|
|
|
|
(save-excursion
|
|
|
|
(re-search-backward org-babel-lob-one-liner-regexp nil t)
|
|
|
|
(org-babel-execute-src-block
|
|
|
|
nil (list lang body (org-babel-merge-params params '((:results . "replace"))))) "")))))
|
2009-09-12 18:14:09 +00:00
|
|
|
|
2009-05-24 20:38:01 +00:00
|
|
|
(provide 'org-babel-exp)
|
|
|
|
;;; org-babel-exp.el ends here
|