ob-ref.el 9.0 KB

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