1 ;;; ob-lob.el --- functions supporting the Library of Babel
3 ;; Copyright (C) 2009-2012 Free Software Foundation, Inc.
5 ;; Authors: Eric Schulte
7 ;; Keywords: literate programming, reproducible research
8 ;; Homepage: http://orgmode.org
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
31 (declare-function org-babel-in-example-or-verbatim "ob-exp" nil)
33 (defvar org-babel-library-of-babel nil
34 "Library of source-code blocks.
35 This is an association list. Populate the library by adding
36 files to `org-babel-lob-files'.")
38 (defcustom org-babel-lob-files '()
39 "Files used to populate the `org-babel-library-of-babel'.
40 To add files to this list use the `org-babel-lob-ingest' command."
44 (defvar org-babel-default-lob-header-args '((:exports . "results"))
45 "Default header arguments to use when exporting #+lob/call lines.")
48 (defun org-babel-lob-ingest (&optional file)
49 "Add all named source-blocks defined in FILE to
50 `org-babel-library-of-babel'."
51 (interactive "fFile: ")
52 (let ((lob-ingest-count 0))
53 (org-babel-map-src-blocks file
54 (let* ((info (org-babel-get-src-block-info 'light))
55 (source-name (nth 4 info)))
57 (setq source-name (intern source-name)
58 org-babel-library-of-babel
59 (cons (cons source-name info)
60 (assq-delete-all source-name org-babel-library-of-babel))
61 lob-ingest-count (1+ lob-ingest-count)))))
62 (message "%d src block%s added to Library of Babel"
63 lob-ingest-count (if (> lob-ingest-count 1) "s" ""))
66 (defconst org-babel-block-lob-one-liner-regexp
68 "^\\([ \t]*?\\)#\\+call:[ \t]+\\([^\(\)\n]+?\\)\\(\\[\\(.*\\)\\]\\|\\(\\)\\)"
69 "\(\\([^\n]*?\\)\)\\(\\[.+\\]\\|\\)[ \t]*\\(\\([^\n]*\\)\\)?")
70 "Regexp to match non-inline calls to predefined source block functions.")
72 (defconst org-babel-inline-lob-one-liner-regexp
74 "\\([^\n]*?\\)call_\\([^\(\)\n]+?\\)\\(\\[\\(.*?\\)\\]\\|\\(\\)\\)"
75 "\(\\([^\n]*?\\)\)\\(\\[\\(.*?\\)\\]\\)?")
76 "Regexp to match inline calls to predefined source block functions.")
78 (defconst org-babel-lob-one-liner-regexp
79 (concat "\\(" org-babel-block-lob-one-liner-regexp
80 "\\|" org-babel-inline-lob-one-liner-regexp "\\)")
81 "Regexp to match calls to predefined source block functions.")
83 ;; functions for executing lob one-liners
86 (defun org-babel-lob-execute-maybe ()
87 "Execute a Library of Babel source block, if appropriate.
88 Detect if this is context for a Library Of Babel source block and
89 if so then run the appropriate source block from the Library."
91 (let ((info (org-babel-lob-get-info)))
92 (if (and (nth 0 info) (not (org-babel-in-example-or-verbatim)))
93 (progn (org-babel-lob-execute info) t)
97 (defun org-babel-lob-get-info ()
98 "Return a Library of Babel function call as a string."
99 (flet ((nonempty (a b)
100 (let ((it (match-string a)))
101 (if (= (length it) 0) (match-string b) it))))
102 (let ((case-fold-search t))
104 (beginning-of-line 1)
105 (when (looking-at org-babel-lob-one-liner-regexp)
107 (mapcar #'org-babel-clean-text-properties
111 (if (not (= 0 (length (nonempty 5 14))))
112 (concat "[" (nonempty 5 14) "]") "")
113 (or (nonempty 7 16) "")
114 (or (nonempty 8 19) ""))
116 (list (length (if (= (length (match-string 12)) 0)
117 (match-string 2) (match-string 11))))))))))
119 (defun org-babel-lob-execute (info)
120 "Execute the lob call specified by INFO."
121 (let ((params (org-babel-process-params
122 (org-babel-merge-params
123 org-babel-default-header-args
124 (org-babel-params-from-properties)
125 (org-babel-parse-header-arguments
126 (org-babel-clean-text-properties
127 (concat ":var results="
128 (mapconcat #'identity (butlast info) " "))))))))
129 (org-babel-execute-src-block
130 nil (list "emacs-lisp" "results" params nil nil (nth 2 info)))))
136 ;;; ob-lob.el ends here