;;; ob-ref.el --- org-babel functions for referencing external data
-;; Copyright (C) 2009, 2010 Free Software Foundation, Inc.
+;; Copyright (C) 2009-2011 Free Software Foundation, Inc.
;; Author: Eric Schulte
;; Dan Davison
;; Keywords: literate programming, reproducible research
;; Homepage: http://orgmode.org
-;; Version: 7.3
+;; Version: 7.7
;; This file is part of GNU Emacs.
(declare-function org-remove-if-not "org" (predicate seq))
(declare-function org-at-table-p "org" (&optional table-type))
(declare-function org-count "org" (CL-ITEM CL-SEQ))
+(declare-function org-at-item-p "org-list" ())
+(declare-function org-narrow-to-subtree "org" ())
+(declare-function org-id-find-id-in-file "org-id" (id file &optional markerp))
+(declare-function org-show-context "org" (&optional key))
(defvar org-babel-ref-split-regexp
"[ \f\t\n\r\v]*\\(.+?\\)[ \f\t\n\r\v]*=[ \f\t\n\r\v]*\\(.+\\)[ \f\t\n\r\v]*")
(let ((var (match-string 1 assignment))
(ref (match-string 2 assignment)))
(cons (intern var)
- ((lambda (val)
- (if (equal :ob-must-be-reference val)
- (org-babel-ref-resolve ref) val))
- (org-babel-ref-literal ref))))))
-
-(defun org-babel-ref-literal (ref)
- "Return the value of REF if it is a literal value.
-Determine if the right side of a header argument variable
-assignment is a literal value or is a reference to some external
-resource. REF should be a string of the right hand side of the
-assignment. If REF is literal then return it's value, otherwise
-return nil."
- (let ((out (org-babel-read ref)))
- (if (equal out ref)
- (if (string-match "^\".+\"$" ref)
- (read ref)
- :ob-must-be-reference)
- out)))
+ (let ((out (org-babel-read ref)))
+ (if (equal out ref)
+ (if (string-match "^\".*\"$" ref)
+ (read ref)
+ (org-babel-ref-resolve ref))
+ out))))))
+
+(defun org-babel-ref-goto-headline-id (id)
+ (goto-char (point-min))
+ (let ((rx (regexp-quote id)))
+ (or (re-search-forward
+ (concat "^[ \t]*:CUSTOM_ID:[ \t]+" rx "[ \t]*$") nil t)
+ (let* ((file (org-id-find-id-file id))
+ (m (when file (org-id-find-id-in-file id file 'marker))))
+ (when (and file m)
+ (message "file:%S" file)
+ (switch-to-buffer (marker-buffer m))
+ (goto-char m)
+ (move-marker m nil)
+ (org-show-context)
+ t)))))
+
+(defun org-babel-ref-headline-body ()
+ (save-restriction
+ (org-narrow-to-subtree)
+ (buffer-substring
+ (save-excursion (goto-char (point-min))
+ (forward-line 1)
+ (when (looking-at "[ \t]*:PROPERTIES:")
+ (re-search-forward ":END:" nil)
+ (forward-char))
+ (point))
+ (point-max))))
(defvar org-babel-library-of-babel)
(defun org-babel-ref-resolve (ref)
"Resolve the reference REF and return its value."
+ (save-window-excursion
(save-excursion
(let ((case-fold-search t)
- type args new-refere new-referent result lob-info split-file split-ref
- index index-row index-col)
+ type args new-refere new-header-args new-referent result
+ lob-info split-file split-ref index index-row index-col id)
;; if ref is indexed grab the indices -- beware nested indices
- (when (and (string-match "\\[\\(.+\\)\\]" ref)
+ (when (and (string-match "\\[\\([^\\[]+\\)\\]$" ref)
(let ((str (substring ref 0 (match-beginning 0))))
(= (org-count ?( str) (org-count ?) str))))
(setq index (match-string 1 ref))
(setq ref (substring ref 0 (match-beginning 0))))
;; assign any arguments to pass to source block
- (when (string-match "^\\(.+?\\)\(\\(.*\\)\)$" ref)
- (setq new-refere (match-string 1 ref))
- (setq new-referent (match-string 2 ref))
+ (when (string-match
+ "^\\(.+?\\)\\(\\[\\(.*\\)\\]\\|\\(\\)\\)\(\\(.*\\)\)$" ref)
+ (setq new-refere (match-string 1 ref))
+ (setq new-header-args (match-string 3 ref))
+ (setq new-referent (match-string 5 ref))
(when (> (length new-refere) 0)
- (if (> (length new-referent) 0)
- (setq args (mapcar (lambda (ref) (cons :var ref))
- (org-babel-ref-split-args new-referent))))
+ (when (> (length new-referent) 0)
+ (setq args (mapcar (lambda (ref) (cons :var ref))
+ (org-babel-ref-split-args new-referent))))
+ (when (> (length new-header-args) 0)
+ (setq args (append (org-babel-parse-header-arguments
+ new-header-args) args)))
(setq ref new-refere)))
(when (string-match "^\\(.+\\):\\(.+\\)$" ref)
(setq split-file (match-string 1 ref))
(save-restriction
(widen)
(goto-char (point-min))
- (if (let ((result_regexp (concat "^[ \t]*#\\+\\(TBLNAME\\|RESNAME"
- "\\|RESULTS\\):[ \t]*"
- (regexp-quote ref) "[ \t]*$"))
- (regexp (concat org-babel-src-name-regexp
- (regexp-quote ref) "\\(\(.*\)\\)?" "[ \t]*$")))
+ (if (let* ((rx (regexp-quote ref))
+ (res-rx (concat org-babel-result-regexp rx "[ \t]*$"))
+ (src-rx (concat org-babel-src-name-regexp
+ rx "\\(\(.*\)\\)?" "[ \t]*$")))
;; goto ref in the current buffer
(or (and (not args)
- (or (re-search-forward result_regexp nil t)
- (re-search-backward result_regexp nil t)))
- (re-search-forward regexp nil t)
- (re-search-backward regexp nil t)
+ (or (re-search-forward res-rx nil t)
+ (re-search-backward res-rx nil t)))
+ (re-search-forward src-rx nil t)
+ (re-search-backward src-rx nil t)
+ ;; check for local or global headlines by id
+ (setq id (org-babel-ref-goto-headline-id ref))
;; check the Library of Babel
(setq lob-info (cdr (assoc (intern ref)
org-babel-library-of-babel)))))
- (unless lob-info (goto-char (match-beginning 0)))
+ (unless (or lob-info id) (goto-char (match-beginning 0)))
;; ;; 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)
(error "reference '%s' not found in this buffer" ref))
- (if lob-info
- (setq type 'lob)
- (while (not (setq type (org-babel-ref-at-ref-p)))
- (forward-line 1)
- (beginning-of-line)
- (if (or (= (point) (point-min)) (= (point) (point-max)))
- (error "reference not found"))))
+ (cond
+ (lob-info (setq type 'lob))
+ (id (setq type 'id))
+ (t (while (not (setq type (org-babel-ref-at-ref-p)))
+ (forward-line 1)
+ (beginning-of-line)
+ (if (or (= (point) (point-min)) (= (point) (point-max)))
+ (error "reference not found")))))
(let ((params (append args '((:results . "silent")))))
(setq result
(case type
- ('results-line (org-babel-read-result))
- ('table (org-babel-read-table))
- ('file (org-babel-read-link))
- ('source-block (org-babel-execute-src-block nil nil params))
- ('lob (org-babel-execute-src-block nil lob-info params)))))
+ (results-line (org-babel-read-result))
+ (table (org-babel-read-table))
+ (list (org-babel-read-list))
+ (file (org-babel-read-link))
+ (source-block (org-babel-execute-src-block nil nil params))
+ (lob (org-babel-execute-src-block
+ nil lob-info params))
+ (id (org-babel-ref-headline-body)))))
(if (symbolp result)
(format "%S" result)
(if (and index (listp result))
(org-babel-ref-index-list index result)
- result))))))
+ result)))))))
(defun org-babel-ref-index-list (index lis)
"Return the subset of LIS indexed by INDEX.
(open (ls) (if (and (listp ls) (= (length ls) 1)) (car ls) ls)))
(open
(mapcar
- (lambda (sub-lis) (org-babel-ref-index-list remainder sub-lis))
+ (lambda (sub-lis)
+ (if (listp sub-lis)
+ (org-babel-ref-index-list remainder sub-lis)
+ sub-lis))
(if (or (= 0 (length portion)) (string-match ind-re portion))
(mapcar
(lambda (n) (nth n lis))
(cond
((string= holder ",")
(when (= depth 0)
- (setq return (reverse (cons (substring buffer 0 -1) return)))
+ (setq return (cons (substring buffer 0 -1) return))
(setq buffer "")))
((or (string= holder "(") (string= holder "[")) (setq depth (+ depth 1)))
((or (string= holder ")") (string= holder "]")) (setq depth (- depth 1)))))
Return nil if none of the supported reference types are found.
Supported reference types are tables and source blocks."
(cond ((org-at-table-p) 'table)
+ ((org-at-item-p) 'list)
((looking-at "^[ \t]*#\\+BEGIN_SRC") 'source-block)
((looking-at org-bracket-link-regexp) 'file)
((looking-at org-babel-result-regexp) 'results-line)))
(provide 'ob-ref)
-;; arch-tag: ace4a4f4-ea38-4dac-8fe6-6f52fcc43b6d
+
;;; ob-ref.el ends here