177 lines
6.4 KiB
EmacsLisp
177 lines
6.4 KiB
EmacsLisp
;;; ob-lob.el --- Functions Supporting the Library of Babel -*- lexical-binding: t; -*-
|
|
|
|
;; Copyright (C) 2009-2024 Free Software Foundation, Inc.
|
|
|
|
;; Authors: Eric Schulte
|
|
;; Dan Davison
|
|
;; Keywords: literate programming, reproducible research
|
|
;; URL: https://orgmode.org
|
|
|
|
;; This file is part of GNU Emacs.
|
|
|
|
;; GNU Emacs 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 of the License, or
|
|
;; (at your option) any later version.
|
|
|
|
;; GNU Emacs 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. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
;;; Commentary:
|
|
|
|
;;; Code:
|
|
|
|
(require 'org-macs)
|
|
(org-assert-version)
|
|
|
|
(require 'cl-lib)
|
|
(require 'ob-core)
|
|
(require 'ob-table)
|
|
|
|
(declare-function org-babel-ref-split-args "ob-ref" (arg-string))
|
|
(declare-function org-element-at-point "org-element" (&optional pom cached-only))
|
|
(declare-function org-element-context "org-element" (&optional element))
|
|
(declare-function org-element-property "org-element-ast" (property node))
|
|
(declare-function org-element-type "org-element-ast" (node &optional anonymous))
|
|
|
|
(defvar org-babel-library-of-babel nil
|
|
"Library of source-code blocks.
|
|
This is an association list. Populate the library by calling
|
|
`org-babel-lob-ingest' on files containing source blocks.")
|
|
|
|
(defvar org-babel-default-lob-header-args '((:exports . "results"))
|
|
"Default header arguments to use when exporting Babel calls.
|
|
By default, a Babel call inherits its arguments from the source
|
|
block being called. Header arguments defined in this variable
|
|
take precedence over these. It is useful for properties that
|
|
should not be inherited from a source block.")
|
|
|
|
(defun org-babel-lob-ingest (&optional file)
|
|
"Add all named source blocks defined in FILE to `org-babel-library-of-babel'."
|
|
(interactive "fFile: ")
|
|
(let ((lob-ingest-count 0))
|
|
(org-babel-map-src-blocks file
|
|
(let* ((info (org-babel-get-src-block-info 'no-eval))
|
|
(source-name (nth 4 info)))
|
|
(when source-name
|
|
(setf (nth 1 info)
|
|
(if (org-babel-noweb-p (nth 2 info) :eval)
|
|
(org-babel-expand-noweb-references info)
|
|
(nth 1 info)))
|
|
(let ((source (intern source-name)))
|
|
(setq org-babel-library-of-babel
|
|
(cons (cons source info)
|
|
(assq-delete-all source org-babel-library-of-babel))))
|
|
(cl-incf lob-ingest-count))))
|
|
(message "%d source block%s added to Library of Babel"
|
|
lob-ingest-count (if (> lob-ingest-count 1) "s" ""))
|
|
lob-ingest-count))
|
|
|
|
;; Functions for executing lob one-liners.
|
|
|
|
;;;###autoload
|
|
(defun org-babel-lob-execute-maybe ()
|
|
"Execute a Library of Babel source block, if appropriate.
|
|
Detect if this is context for a Library Of Babel source block and
|
|
if so then run the appropriate source block from the Library."
|
|
(interactive)
|
|
(let* ((datum (org-element-context))
|
|
(info (org-babel-lob-get-info datum)))
|
|
(when info
|
|
(org-babel-execute-src-block nil info nil (org-element-type datum))
|
|
t)))
|
|
|
|
(defun org-babel-lob--src-info (ref)
|
|
"Return internal representation for Babel data referenced as REF.
|
|
REF is a string. This function looks into the current document
|
|
for a Babel call or source block. If none is found, it looks
|
|
after REF in the Library of Babel."
|
|
(let ((name ref)
|
|
(file nil))
|
|
;; Extract the remote file, if specified in the reference.
|
|
(when (string-match "\\`\\(.+\\):\\(.+\\)\\'" ref)
|
|
(setq file (match-string 1 ref))
|
|
(setq name (match-string 2 ref)))
|
|
;; During export, look into the pristine copy of the document
|
|
;; being exported instead of the current one, which could miss
|
|
;; some data.
|
|
(with-current-buffer (cond (file (find-file-noselect file t))
|
|
(org-babel-exp-reference-buffer)
|
|
(t (current-buffer)))
|
|
(org-with-point-at 1
|
|
(catch :found
|
|
(let ((case-fold-search t)
|
|
(regexp (org-babel-named-data-regexp-for-name name)))
|
|
(while (re-search-forward regexp nil t)
|
|
(let ((element (org-element-at-point)))
|
|
(when (equal name (org-element-property :name element))
|
|
(throw :found
|
|
(pcase (org-element-type element)
|
|
(`src-block (org-babel-get-src-block-info t element))
|
|
(`babel-call (org-babel-lob-get-info element))
|
|
;; Non-executable data found. Since names
|
|
;; are supposed to be unique throughout
|
|
;; a document, bail out.
|
|
(_ nil))))))
|
|
(cdr (assoc-string ref org-babel-library-of-babel))))))))
|
|
|
|
;;;###autoload
|
|
(defun org-babel-lob-get-info (&optional datum no-eval)
|
|
"Return internal representation for Library of Babel function call.
|
|
|
|
Consider DATUM, when provided, or element at point otherwise.
|
|
|
|
When optional argument NO-EVAL is non-nil, Babel does not resolve
|
|
remote variable references; a process which could likely result
|
|
in the execution of other code blocks, and do not evaluate Lisp
|
|
values in parameters.
|
|
|
|
Return nil when not on an appropriate location. Otherwise return
|
|
a list compatible with `org-babel-get-src-block-info', which
|
|
see."
|
|
(let* ((context (or datum (org-element-context)))
|
|
(type (org-element-type context))
|
|
(reference (org-element-property :call context)))
|
|
(when (memq type '(babel-call inline-babel-call))
|
|
(pcase (org-babel-lob--src-info reference)
|
|
(`(,language ,body ,header ,_ ,_ ,_ ,coderef)
|
|
(let ((begin (org-element-property (if (eq type 'inline-babel-call)
|
|
:begin
|
|
:post-affiliated)
|
|
context)))
|
|
(list language
|
|
body
|
|
(apply #'org-babel-merge-params
|
|
header
|
|
org-babel-default-lob-header-args
|
|
(append
|
|
(org-with-point-at begin
|
|
(org-babel-params-from-properties language no-eval))
|
|
(list
|
|
(org-babel-parse-header-arguments
|
|
(org-element-property :inside-header context) no-eval)
|
|
(let ((args (org-element-property :arguments context)))
|
|
(and args
|
|
(mapcar (lambda (ref) (cons :var ref))
|
|
(org-babel-ref-split-args args))))
|
|
(org-babel-parse-header-arguments
|
|
(org-element-property :end-header context) no-eval))))
|
|
nil
|
|
(org-element-property :name context)
|
|
begin
|
|
coderef)))
|
|
(_ nil)))))
|
|
|
|
(provide 'ob-lob)
|
|
|
|
;; Local variables:
|
|
;; generated-autoload-file: "org-loaddefs.el"
|
|
;; End:
|
|
|
|
;;; ob-lob.el ends here
|