lisp/ob-table.el

   1 ;;; ob-table.el --- support for calling org-babel functions from tables
   2
   3 ;; Copyright (C) 2009-2011  Free Software Foundation, Inc.
   4
   5 ;; Author: Eric Schulte
   6 ;; Keywords: literate programming, reproducible research
   7 ;; Homepage: http://orgmode.org
   8
   9 ;; This file is part of GNU Emacs.
  10
  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.
  15
  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.
  20
  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/>.
  23
  24 ;;; Commentary:
  25
  26 ;; Should allow calling functions from org-mode tables using the
  27 ;; function `sbe' as so...
  28
  29 ;; #+begin_src emacs-lisp :results silent
  30 ;;   (defun fibbd (n) (if (< n 2) 1 (+ (fibbd (- n 1)) (fibbd (- n 2)))))
  31 ;; #+end_src
  32
  33 ;; #+name: fibbd
  34 ;; #+begin_src emacs-lisp :var n=2 :results silent
  35 ;; (fibbd n)
  36 ;; #+end_src
  37
  38 ;; | original | fibbd  |
  39 ;; |----------+--------|
  40 ;; |        0 |        |
  41 ;; |        1 |        |
  42 ;; |        2 |        |
  43 ;; |        3 |        |
  44 ;; |        4 |        |
  45 ;; |        5 |        |
  46 ;; |        6 |        |
  47 ;; |        7 |        |
  48 ;; |        8 |        |
  49 ;; |        9 |        |
  50 ;; #+TBLFM: $2='(sbe 'fibbd (n $1))
  51
  52 ;;; Code:
  53 (require 'ob)
  54
  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))
  62
  63 (defmacro sbe (source-block &rest variables)
  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.
  69
  70  (sbe 'source-block (n $2) (m 3))
  71
  72 #+begin_src emacs-lisp :var results=source-block(n=val_at_col_2, m=3) :results silent
  73 results
  74 #+end_src
  75
  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 with two \"$\"s
  79 rather than a single \"$\" (i.e. \"$$2\" instead of \"$2\" in the
  80 example above.
  81
  82 NOTE: it is also possible to pass header arguments to the code
  83 block.  In this case a table cell should hold the string value of
  84 the header argument which can then be passed before all variables
  85 as shown in the example below.
  86
  87 | 1 | 2 | :file nothing.png | nothing.png |
  88 #+TBLFM: @1$4='(sbe test-sbe $3 (x $1) (y $2))"
  89   (let* ((header-args (if (stringp (car variables)) (car variables) ""))
  90          (variables (if (stringp (car variables)) (cdr variables) variables)))
  91     (let* (quote
  92            (variables
  93             (mapcar
  94              (lambda (var)
  95                ;; ensure that all cells prefixed with $'s are strings
  96                (cons (car var)
  97                      (delq nil (mapcar
  98                                 (lambda (el)
  99                                   (if (eq '$ el)
 100                                       (setq quote t)
 101                                     (prog1 (if quote
 102                                                (format "\"%s\"" el)
 103                                              (org-babel-clean-text-properties el))
 104                                       (setq quote nil))))
 105                                 (cdr var)))))
 106              variables)))
 107       (unless (stringp source-block)
 108         (setq source-block (symbol-name source-block)))
 109       ((lambda (result)
 110          (org-babel-trim (if (stringp result) result (format "%S" result))))
 111        (if (and source-block (> (length source-block) 0))
 112            (let ((params
 113                   (eval `(org-babel-parse-header-arguments
 114                           (concat
 115                            ":var results="
 116                            ,source-block
 117                            "[" ,header-args "]"
 118                            "("
 119                            (mapconcat
 120                             (lambda (var-spec)
 121                               (if (> (length (cdr var-spec)) 1)
 122                                   (format "%S='%S"
 123                                           (car var-spec)
 124                                           (mapcar #'read (cdr var-spec)))
 125                                 (format "%S=%s"
 126                                         (car var-spec) (cadr var-spec))))
 127                             ',variables ", ")
 128                            ")")))))
 129              (org-babel-execute-src-block
 130               nil (list "emacs-lisp" "results" params)
 131               '((:results . "silent"))))
 132          "")))))
 133 (def-edebug-spec sbe (form form))
 134
 135 (provide 'ob-table)
 136
 137
 138
 139 ;;; ob-table.el ends here