ob-ref.el 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250
  1. ;;; ob-ref.el --- Babel Functions for Referencing External Data -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2009-2017 Free Software Foundation, Inc.
  3. ;; Authors: Eric Schulte
  4. ;; Dan Davison
  5. ;; Keywords: literate programming, reproducible research
  6. ;; Homepage: http://orgmode.org
  7. ;; This file is part of GNU Emacs.
  8. ;; GNU Emacs is free software: you can redistribute it and/or modify
  9. ;; it under the terms of the GNU General Public License as published by
  10. ;; the Free Software Foundation, either version 3 of the License, or
  11. ;; (at your option) any later version.
  12. ;; GNU Emacs is distributed in the hope that it will be useful,
  13. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15. ;; GNU General Public License for more details.
  16. ;; You should have received a copy of the GNU General Public License
  17. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  18. ;;; Commentary:
  19. ;; Functions for referencing data from the header arguments of a
  20. ;; org-babel block. The syntax of such a reference should be
  21. ;; #+VAR: variable-name=file:resource-id
  22. ;; - variable-name :: the name of the variable to which the value
  23. ;; will be assigned
  24. ;; - file :: path to the file containing the resource, or omitted if
  25. ;; resource is in the current file
  26. ;; - resource-id :: the id or name of the resource
  27. ;; So an example of a simple src block referencing table data in the
  28. ;; same file would be
  29. ;; #+NAME: sandbox
  30. ;; | 1 | 2 | 3 |
  31. ;; | 4 | org-babel | 6 |
  32. ;;
  33. ;; #+begin_src emacs-lisp :var table=sandbox
  34. ;; (message table)
  35. ;; #+end_src
  36. ;;; Code:
  37. (require 'ob-core)
  38. (require 'cl-lib)
  39. (declare-function org-babel-lob-get-info "ob-lob" (&optional datum))
  40. (declare-function org-element-at-point "org-element" ())
  41. (declare-function org-element-property "org-element" (property element))
  42. (declare-function org-element-type "org-element" (element))
  43. (declare-function org-end-of-meta-data "org" (&optional full))
  44. (declare-function org-find-property "org" (property &optional value))
  45. (declare-function org-id-find-id-file "org-id" (id))
  46. (declare-function org-id-find-id-in-file "org-id" (id file &optional markerp))
  47. (declare-function org-in-commented-heading-p "org" (&optional no-inheritance))
  48. (declare-function org-narrow-to-subtree "org" ())
  49. (declare-function org-show-context "org" (&optional key))
  50. (declare-function org-trim "org" (s &optional keep-lead))
  51. (defvar org-babel-ref-split-regexp
  52. "[ \f\t\n\r\v]*\\(.+?\\)[ \f\t\n\r\v]*=[ \f\t\n\r\v]*\\(.+\\)[ \f\t\n\r\v]*")
  53. (defvar org-babel-update-intermediate nil
  54. "Update the in-buffer results of code blocks executed to resolve references.")
  55. (defun org-babel-ref-parse (assignment)
  56. "Parse a variable ASSIGNMENT in a header argument.
  57. If the right hand side of the assignment has a literal value
  58. return that value, otherwise interpret as a reference to an
  59. external resource and find its value using
  60. `org-babel-ref-resolve'. Return a list with two elements. The
  61. first element of the list will be the name of the variable, and
  62. the second will be an emacs-lisp representation of the value of
  63. the variable."
  64. (when (string-match org-babel-ref-split-regexp assignment)
  65. (let ((var (match-string 1 assignment))
  66. (ref (match-string 2 assignment)))
  67. (cons (intern var)
  68. (let ((out (save-excursion
  69. (when org-babel-current-src-block-location
  70. (goto-char (if (markerp org-babel-current-src-block-location)
  71. (marker-position org-babel-current-src-block-location)
  72. org-babel-current-src-block-location)))
  73. (org-babel-read ref))))
  74. (if (equal out ref)
  75. (if (and (string-prefix-p "\"" ref)
  76. (string-suffix-p "\"" ref))
  77. (read ref)
  78. (org-babel-ref-resolve ref))
  79. out))))))
  80. (defun org-babel-ref-goto-headline-id (id)
  81. (or (let ((h (org-find-property "CUSTOM_ID" id)))
  82. (when h (goto-char h)))
  83. (let* ((file (org-id-find-id-file id))
  84. (m (when file (org-id-find-id-in-file id file 'marker))))
  85. (when (and file m)
  86. (message "file:%S" file)
  87. (pop-to-buffer-same-window (marker-buffer m))
  88. (goto-char m)
  89. (move-marker m nil)
  90. (org-show-context)
  91. t))))
  92. (defun org-babel-ref-headline-body ()
  93. (save-restriction
  94. (org-narrow-to-subtree)
  95. (buffer-substring
  96. (save-excursion (goto-char (point-min))
  97. (org-end-of-meta-data)
  98. (point))
  99. (point-max))))
  100. (defvar org-babel-library-of-babel)
  101. (defun org-babel-ref-resolve (ref)
  102. "Resolve the reference REF and return its value."
  103. (save-window-excursion
  104. (with-current-buffer (or org-babel-exp-reference-buffer (current-buffer))
  105. (save-excursion
  106. (let ((case-fold-search t)
  107. args new-refere new-header-args new-referent split-file split-ref
  108. index)
  109. ;; if ref is indexed grab the indices -- beware nested indices
  110. (when (and (string-match "\\[\\([^\\[]+\\)\\]$" ref)
  111. (let ((str (substring ref 0 (match-beginning 0))))
  112. (= (cl-count ?( str) (cl-count ?) str))))
  113. (setq index (match-string 1 ref))
  114. (setq ref (substring ref 0 (match-beginning 0))))
  115. ;; assign any arguments to pass to source block
  116. (when (string-match
  117. "^\\(.+?\\)\\(\\[\\(.*\\)\\]\\|\\(\\)\\)(\\(.*\\))$" ref)
  118. (setq new-refere (match-string 1 ref))
  119. (setq new-header-args (match-string 3 ref))
  120. (setq new-referent (match-string 5 ref))
  121. (when (> (length new-refere) 0)
  122. (when (> (length new-referent) 0)
  123. (setq args (mapcar (lambda (ref) (cons :var ref))
  124. (org-babel-ref-split-args new-referent))))
  125. (when (> (length new-header-args) 0)
  126. (setq args (append (org-babel-parse-header-arguments
  127. new-header-args) args)))
  128. (setq ref new-refere)))
  129. (when (string-match "^\\(.+\\):\\(.+\\)$" ref)
  130. (setq split-file (match-string 1 ref))
  131. (setq split-ref (match-string 2 ref))
  132. (find-file split-file)
  133. (setq ref split-ref))
  134. (org-with-wide-buffer
  135. (goto-char (point-min))
  136. (let* ((params (append args '((:results . "silent"))))
  137. (regexp (org-babel-named-data-regexp-for-name ref))
  138. (result
  139. (catch :found
  140. ;; Check for code blocks or named data.
  141. (while (re-search-forward regexp nil t)
  142. ;; Ignore COMMENTed headings and orphaned
  143. ;; affiliated keywords.
  144. (unless (org-in-commented-heading-p)
  145. (let ((e (org-element-at-point)))
  146. (when (equal (org-element-property :name e) ref)
  147. (goto-char
  148. (org-element-property :post-affiliated e))
  149. (pcase (org-element-type e)
  150. (`babel-call
  151. (throw :found
  152. (org-babel-execute-src-block
  153. nil (org-babel-lob-get-info e) params)))
  154. (`src-block
  155. (throw :found
  156. (org-babel-execute-src-block
  157. nil nil
  158. (and
  159. (not org-babel-update-intermediate)
  160. params))))
  161. ((and (let v (org-babel-read-element e))
  162. (guard v))
  163. (throw :found v))
  164. (_ (error "Reference not found")))))))
  165. ;; Check for local or global headlines by ID.
  166. (when (org-babel-ref-goto-headline-id ref)
  167. (throw :found (org-babel-ref-headline-body)))
  168. ;; Check the Library of Babel.
  169. (let ((info (cdr (assq (intern ref)
  170. org-babel-library-of-babel))))
  171. (when info
  172. (throw :found
  173. (org-babel-execute-src-block nil info params))))
  174. (error "Reference `%s' not found in this buffer" ref))))
  175. (cond
  176. ((symbolp result) (format "%S" result))
  177. ((and index (listp result))
  178. (org-babel-ref-index-list index result))
  179. (t result)))))))))
  180. (defun org-babel-ref-index-list (index lis)
  181. "Return the subset of LIS indexed by INDEX.
  182. Indices are 0 based and negative indices count from the end of
  183. LIS, so 0 references the first element of LIS and -1 references
  184. the last. If INDEX is separated by \",\"s then each \"portion\"
  185. is assumed to index into the next deepest nesting or dimension.
  186. A valid \"portion\" can consist of either an integer index, two
  187. integers separated by a \":\" in which case the entire range is
  188. returned, or an empty string or \"*\" both of which are
  189. interpreted to mean the entire range and as such are equivalent
  190. to \"0:-1\"."
  191. (if (and (> (length index) 0) (string-match "^\\([^,]*\\),?" index))
  192. (let* ((ind-re "\\(\\([-[:digit:]]+\\):\\([-[:digit:]]+\\)\\|\\*\\)")
  193. (lgth (length lis))
  194. (portion (match-string 1 index))
  195. (remainder (substring index (match-end 0)))
  196. (wrap (lambda (num) (if (< num 0) (+ lgth num) num)))
  197. (open (lambda (ls) (if (and (listp ls) (= (length ls) 1)) (car ls) ls))))
  198. (funcall
  199. open
  200. (mapcar
  201. (lambda (sub-lis)
  202. (if (listp sub-lis)
  203. (org-babel-ref-index-list remainder sub-lis)
  204. sub-lis))
  205. (if (or (= 0 (length portion)) (string-match ind-re portion))
  206. (mapcar
  207. (lambda (n) (nth n lis))
  208. (apply 'org-number-sequence
  209. (if (and (> (length portion) 0) (match-string 2 portion))
  210. (list
  211. (funcall wrap (string-to-number (match-string 2 portion)))
  212. (funcall wrap (string-to-number (match-string 3 portion))))
  213. (list (funcall wrap 0) (funcall wrap -1)))))
  214. (list (nth (funcall wrap (string-to-number portion)) lis))))))
  215. lis))
  216. (defun org-babel-ref-split-args (arg-string)
  217. "Split ARG-STRING into top-level arguments of balanced parenthesis."
  218. (mapcar #'org-trim (org-babel-balanced-split arg-string 44)))
  219. (provide 'ob-ref)
  220. ;;; ob-ref.el ends here