Function: org-sbe

org-sbe is a macro defined in ob-table.el.gz.

Signature

(org-sbe SOURCE-BLOCK &rest VARIABLES)

Documentation

Return the results of calling SOURCE-BLOCK with VARIABLES.

Each element of VARIABLES should be a list of two elements: the first element is the name of the variable and second element is a string of its value.

So this org-sbe construct

 (org-sbe "source-block" (n $2) (m 3))

is the equivalent of the following source code block:

 #+begin_src emacs-lisp :var results=source-block(n=val_at_col_2, m=3) \
     :results silent
 results
 #+end_src

NOTE: The quotation marks around the function name, source-block, are optional.

NOTE: By default, string variable names are interpreted as references to source-code blocks, to force interpretation of a cell's value as a string, prefix the identifier a "$" (e.g.,
"$$2" instead of "$2" or "$@2$2" instead of "@2$2").

NOTE: It is also possible to pass header arguments to the code block. In this case a table cell should hold the string value of the header argument which can then be passed before all variables as shown in the example below.

| 1 | 2 | :file nothing.png | nothing.png |
#+TBLFM: @1$4='(org-sbe test-sbe $3 (x $1) (y $2))

Source Code

;; Defined in /usr/src/emacs/lisp/org/ob-table.el.gz
(defmacro org-sbe (source-block &rest variables)
  "Return the results of calling SOURCE-BLOCK with VARIABLES.

Each element of VARIABLES should be a list of two elements: the
first element is the name of the variable and second element is a
string of its value.

So this `org-sbe' construct

 (org-sbe \"source-block\" (n $2) (m 3))

is the equivalent of the following source code block:

 #+begin_src emacs-lisp :var results=source-block(n=val_at_col_2, m=3) \\
     :results silent
 results
 #+end_src

NOTE: The quotation marks around the function name,
`source-block', are optional.

NOTE: By default, string variable names are interpreted as
references to source-code blocks, to force interpretation of a
cell's value as a string, prefix the identifier a \"$\" (e.g.,
\"$$2\" instead of \"$2\" or \"$@2$2\" instead of \"@2$2\").

NOTE: It is also possible to pass header arguments to the code
block.  In this case a table cell should hold the string value of
the header argument which can then be passed before all variables
as shown in the example below.

| 1 | 2 | :file nothing.png | nothing.png |
#+TBLFM: @1$4=\\='(org-sbe test-sbe $3 (x $1) (y $2))"
  (declare (debug (form form)))
  (let* ((header-args (if (stringp (car variables)) (car variables) ""))
	 (variables (if (stringp (car variables)) (cdr variables) variables)))
    (let* (quote
	   (variables
	    (mapcar
	     (lambda (var)
	       ;; ensure that all cells prefixed with $'s are strings
	       (cons (car var)
		     (delq nil (mapcar
			      (lambda (el)
				(if (eq '$ el)
				    (prog1 nil (setq quote t))
				  (prog1
				      (cond
				       (quote (format "\"%s\"" el))
				       ((stringp el) (org-no-properties el))
				       (t el))
				    (setq quote nil))))
			      (cdr var)))))
	     variables)))
      (unless (stringp source-block)
	(setq source-block (symbol-name source-block)))
      `(let ((result
              (if ,(and source-block (> (length source-block) 0))
                  (let ((params
                         ',(org-babel-parse-header-arguments
                            (concat
                             ":var results="
                             source-block
                             "[" header-args "]"
                             "("
                             (mapconcat
                              (lambda (var-spec)
                                (if (> (length (cdr var-spec)) 1)
                                    (format "%S='%S"
                                            (car var-spec)
                                            (mapcar #'read (cdr var-spec)))
                                  (format "%S=%s"
                                          (car var-spec) (cadr var-spec))))
                              variables ", ")
                             ")"))))
                    (org-babel-execute-src-block
                     nil (list "emacs-lisp" "results" params)
                     '((:results . "silent"))))
                "")))
         (org-trim (if (stringp result) result (format "%S" result)))))))