org-mode/lisp/org-babel-ref.el

146 lines
5.9 KiB
EmacsLisp
Raw Normal View History

2009-05-24 16:38:01 -04:00
;;; org-babel-ref.el --- org-babel functions for referencing external data
;; Copyright (C) 2009 Eric Schulte, Dan Davison, Austin F. Frank
;; Author: Eric Schulte, Dan Davison, Austin F. Frank
;; 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:
;; Functions for referencing data from the header arguments of a
2009-05-24 16:38:01 -04:00
;; org-babel block. The syntax of such a reference should be
;;
;; #+VAR: variable-name=file:resource-id
;;
;; - variable-name :: the name of the variable to which the value
;; will be assigned
;;
;; - file :: path to the file containing the resource, or omitted if
;; resource is in the current file
;;
2009-05-09 21:28:08 -04:00
;; - resource-id :: the id or name of the resource
;;
;; So an example of a simple src block referencing table data in the
;; same file would be
;;
2009-05-09 21:28:08 -04:00
;; #+TBLNAME: sandbox
;; | 1 | 2 | 3 |
2009-05-24 16:38:01 -04:00
;; | 4 | org-babel | 6 |
2009-05-09 21:28:08 -04:00
;;
;; #+begin_src emacs-lisp :var table=sandbox
;; (message table)
;; #+end_src
;;
;;; Code:
2009-05-24 16:38:01 -04:00
(require 'org-babel)
2009-05-24 16:38:01 -04:00
(defun org-babel-ref-variables (params)
"Takes a parameter alist, and return an alist of variable
names, and the emacs-lisp representation of the related value."
2009-05-24 16:38:01 -04:00
(mapcar #'org-babel-ref-parse
2009-05-09 21:28:08 -04:00
(delq nil (mapcar (lambda (pair) (if (eq (car pair) :var) (cdr pair))) params))))
2009-05-24 16:38:01 -04:00
(defun org-babel-ref-parse (assignment)
"Parse a variable ASSIGNMENT in a header argument. If the
right hand side of the assignment has a literal value return that
value, otherwise interpret as a reference to an external resource
2009-05-24 16:38:01 -04:00
and find it's value using `org-babel-ref-resolve-reference'.
Return a list with two elements. The first element of the list
will be the name of the variable, and the second will be an
emacs-lisp representation of the value of the variable."
(if (string-match "[ \f\t\n\r\v]*\\(.+?\\)[ \f\t\n\r\v]*=[ \f\t\n\r\v]*\\(.+\\)[ \f\t\n\r\v]*" assignment)
(let ((var (match-string 1 assignment))
(ref (match-string 2 assignment)))
(cons (intern var)
2009-05-24 16:38:01 -04:00
(or (org-babel-ref-literal ref)
(org-babel-ref-resolve-reference ref))))))
2009-05-24 16:38:01 -04:00
(defun org-babel-ref-literal (ref)
"Determine if the right side of a header argument variable
assignment is a literal value or is a reference to some external
resource. If REF is literal then return it's value, otherwise
return nil."
2009-05-24 16:38:01 -04:00
(let ((out (org-babel-read ref)))
2009-05-24 13:35:13 -04:00
(if (equal out ref)
(if (string-match "\"\\(.+\\)\"" ref)
(read ref))
out)))
2009-05-24 16:38:01 -04:00
(defun org-babel-ref-resolve-reference (ref)
"Resolve the reference and return it's value"
(save-excursion
(let ((case-fold-search t)
2009-05-24 13:35:13 -04:00
type args new-refere new-referent result)
;; assign any arguments to pass to source block
2009-05-24 13:35:13 -04:00
(when (string-match "^\\(.+?\\)\(\\(.*\\)\)$" ref)
(setq new-refere (match-string 1 ref))
(setq new-referent (match-string 2 ref))
;; (message (format "first second %S -- %S" new-refere new-referent)) ;; debugging
(when (> (length new-refere) 0)
(if (> (length new-referent) 0)
(setq args (mapcar (lambda (ref) (cons :var ref))
2009-05-24 13:35:13 -04:00
(split-string new-referent ",[ \f\t\n\r\v]*"))))
(setq ref new-refere)))
(when (string-match "\\(.+\\):\\(.+\\)" ref)
(find-file (match-string 1 ref))
(setf ref (match-string 2 ref)))
2009-05-09 21:28:08 -04:00
(goto-char (point-min))
(unless (let ((result_regexp (concat "^#\\+\\(TBL\\|RES\\)NAME:[ \t]*"
2009-05-24 13:35:13 -04:00
(regexp-quote ref) "[ \t]*$"))
(regexp (concat "^#\\+SRCNAME:[ \t]*"
2009-05-09 21:28:08 -04:00
(regexp-quote ref) "[ \t]*$")))
(or (re-search-forward result_regexp nil t)
(re-search-forward result_regexp nil t)
(re-search-forward regexp nil t)
2009-05-09 21:28:08 -04:00
(re-search-backward regexp nil t)))
;; ;; TODO: allow searching for names in other buffers
;; (setq id-loc (org-id-find ref 'marker)
;; buffer (marker-buffer id-loc)
;; loc (marker-position id-loc))
;; (move-marker id-loc nil)
(progn (message (format "reference '%s' not found in this buffer" ref))
(error (format "reference '%s' not found in this buffer" ref))))
2009-05-24 16:38:01 -04:00
(while (not (setq type (org-babel-ref-at-ref-p)))
2009-05-09 21:28:08 -04:00
(forward-line 1)
(beginning-of-line)
(if (or (= (point) (point-min)) (= (point) (point-max)))
(error "reference not found")))
(case type
('table
(mapcar (lambda (row)
2009-05-24 16:38:01 -04:00
(mapcar #'org-babel-read row))
(org-table-to-lisp)))
('source-block
2009-05-24 16:38:01 -04:00
(setq result (org-babel-execute-src-block t nil args))
(if (symbolp result) (format "%S" result) result))))))
2009-05-24 16:38:01 -04:00
(defun org-babel-ref-at-ref-p ()
"Return the type of reference located at point or nil of none
of the supported reference types are found. Supported reference
types are tables and source blocks."
(cond ((org-at-table-p) 'table)
((looking-at "^#\\+BEGIN_SRC") 'source-block)))
2009-05-24 16:38:01 -04:00
(provide 'org-babel-ref)
;;; org-babel-ref.el ends here