1 ;;; ob-table.el --- support for calling org-babel functions from tables
3 ;; Copyright (C) 2009-2014 Free Software Foundation, Inc.
5 ;; Author: Eric Schulte
6 ;; Keywords: literate programming, reproducible research
7 ;; Homepage: http://orgmode.org
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;; Should allow calling functions from org-mode tables using the
27 ;; function `sbe' as so...
29 ;; #+begin_src emacs-lisp :results silent
30 ;; (defun fibbd (n) (if (< n 2) 1 (+ (fibbd (- n 1)) (fibbd (- n 2)))))
34 ;; #+begin_src emacs-lisp :var n=2 :results silent
38 ;; | original | fibbd |
39 ;; |----------+--------|
50 ;; #+TBLFM: $2='(sbe 'fibbd (n $1))
55 (defun org-babel-table-truncate-at-newline (string)
56 "Replace newline character with ellipses.
57 If STRING ends in a newline character, then remove the newline
58 character and replace it with ellipses."
59 (if (and (stringp string
) (string-match "[\n\r]\\(.\\)?" string
))
60 (concat (substring string
0 (match-beginning 0))
61 (if (match-string 1 string
) "...")) string
))
63 (defmacro sbe
(source-block &rest variables
) ;FIXME: Namespace prefix!
64 "Return the results of calling SOURCE-BLOCK with VARIABLES.
65 Each element of VARIABLES should be a two
66 element list, whose first element is the name of the variable and
67 second element is a string of its value. The following call to
68 `sbe' would be equivalent to the following source code block.
70 (sbe 'source-block (n $2) (m 3))
72 #+begin_src emacs-lisp :var results=source-block(n=val_at_col_2, m=3) :results silent
76 NOTE: by default string variable names are interpreted as
77 references to source-code blocks, to force interpretation of a
78 cell's value as a string, prefix the identifier a \"$\" (e.g.,
79 \"$$2\" instead of \"$2\" or \"$@2$2\" instead of \"@2$2\").
81 NOTE: it is also possible to pass header arguments to the code
82 block. In this case a table cell should hold the string value of
83 the header argument which can then be passed before all variables
84 as shown in the example below.
86 | 1 | 2 | :file nothing.png | nothing.png |
87 #+TBLFM: @1$4='(sbe test-sbe $3 (x $1) (y $2))"
88 (declare (debug (form form
)))
89 (let* ((header-args (if (stringp (car variables
)) (car variables
) ""))
90 (variables (if (stringp (car variables
)) (cdr variables
) variables
)))
95 ;; ensure that all cells prefixed with $'s are strings
100 (prog1 nil
(setq quote t
))
103 (quote (format "\"%s\"" el
))
104 ((stringp el
) (org-no-properties el
))
109 (unless (stringp source-block
)
110 (setq source-block
(symbol-name source-block
)))
112 (if (and source-block
(> (length source-block
) 0))
114 ;; FIXME: Why `eval'?!?!?
115 (eval `(org-babel-parse-header-arguments
123 (if (> (length (cdr var-spec
)) 1)
126 (mapcar #'read
(cdr var-spec
)))
128 (car var-spec
) (cadr var-spec
))))
131 (org-babel-execute-src-block
132 nil
(list "emacs-lisp" "results" params
)
133 '((:results .
"silent"))))
135 (org-babel-trim (if (stringp result
) result
(format "%S" result
)))))))
141 ;;; ob-table.el ends here