2010-06-25 16:20:39 +00:00
|
|
|
;;; ob-lob.el --- functions supporting the Library of Babel
|
2009-06-13 00:26:28 +00:00
|
|
|
|
2012-03-17 15:31:04 +00:00
|
|
|
;; Copyright (C) 2009-2012 Free Software Foundation, Inc.
|
2009-06-13 00:26:28 +00:00
|
|
|
|
2012-04-01 22:53:28 +00:00
|
|
|
;; Authors: Eric Schulte
|
|
|
|
;; Dan Davison
|
2009-06-13 00:26:28 +00:00
|
|
|
;; Keywords: literate programming, reproducible research
|
|
|
|
;; Homepage: http://orgmode.org
|
|
|
|
|
2010-06-25 16:20:39 +00:00
|
|
|
;; This file is part of GNU Emacs.
|
2009-06-13 00:26:28 +00:00
|
|
|
|
2010-06-25 16:20:39 +00:00
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
2009-06-13 00:26:28 +00:00
|
|
|
;; it under the terms of the GNU General Public License as published by
|
2010-06-25 16:20:39 +00:00
|
|
|
;; 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,
|
2009-06-13 00:26:28 +00:00
|
|
|
;; 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.
|
2010-06-25 16:20:39 +00:00
|
|
|
|
2009-06-13 00:26:28 +00:00
|
|
|
;; You should have received a copy of the GNU General Public License
|
2010-06-25 16:20:39 +00:00
|
|
|
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
|
2009-06-13 00:26:28 +00:00
|
|
|
|
|
|
|
;;; Code:
|
2011-06-27 00:13:14 +00:00
|
|
|
(eval-when-compile
|
|
|
|
(require 'cl))
|
2010-06-11 23:02:42 +00:00
|
|
|
(require 'ob)
|
|
|
|
(require 'ob-table)
|
2009-06-14 14:54:55 +00:00
|
|
|
|
2011-11-15 15:38:41 +00:00
|
|
|
(declare-function org-babel-in-example-or-verbatim "ob-exp" nil)
|
|
|
|
|
2009-06-14 21:10:04 +00:00
|
|
|
(defvar org-babel-library-of-babel nil
|
2010-07-13 23:20:08 +00:00
|
|
|
"Library of source-code blocks.
|
|
|
|
This is an association list. Populate the library by adding
|
|
|
|
files to `org-babel-lob-files'.")
|
2009-06-14 21:10:04 +00:00
|
|
|
|
|
|
|
(defcustom org-babel-lob-files '()
|
2010-07-13 23:20:08 +00:00
|
|
|
"Files used to populate the `org-babel-library-of-babel'.
|
|
|
|
To add files to this list use the `org-babel-lob-ingest' command."
|
2009-06-14 21:10:04 +00:00
|
|
|
:group 'org-babel
|
2012-04-03 11:11:32 +00:00
|
|
|
:version "24.1"
|
2009-06-14 21:10:04 +00:00
|
|
|
:type 'list)
|
|
|
|
|
2011-06-24 20:53:25 +00:00
|
|
|
(defvar org-babel-default-lob-header-args '((:exports . "results"))
|
|
|
|
"Default header arguments to use when exporting #+lob/call lines.")
|
|
|
|
|
2010-06-23 18:24:33 +00:00
|
|
|
;;;###autoload
|
2009-06-14 21:10:04 +00:00
|
|
|
(defun org-babel-lob-ingest (&optional file)
|
2010-10-12 10:52:29 +00:00
|
|
|
"Add all named source-blocks defined in FILE to
|
|
|
|
`org-babel-library-of-babel'."
|
2011-01-31 19:33:09 +00:00
|
|
|
(interactive "fFile: ")
|
2010-10-12 10:52:29 +00:00
|
|
|
(let ((lob-ingest-count 0))
|
|
|
|
(org-babel-map-src-blocks file
|
2010-10-15 15:13:51 +00:00
|
|
|
(let* ((info (org-babel-get-src-block-info 'light))
|
2010-10-12 10:52:29 +00:00
|
|
|
(source-name (nth 4 info)))
|
|
|
|
(when source-name
|
|
|
|
(setq source-name (intern source-name)
|
|
|
|
org-babel-library-of-babel
|
|
|
|
(cons (cons source-name info)
|
|
|
|
(assq-delete-all source-name org-babel-library-of-babel))
|
|
|
|
lob-ingest-count (1+ lob-ingest-count)))))
|
|
|
|
(message "%d src block%s added to Library of Babel"
|
2010-10-16 00:42:26 +00:00
|
|
|
lob-ingest-count (if (> lob-ingest-count 1) "s" ""))
|
|
|
|
lob-ingest-count))
|
2009-06-14 21:10:04 +00:00
|
|
|
|
2011-06-24 21:44:28 +00:00
|
|
|
(defconst org-babel-block-lob-one-liner-regexp
|
2010-07-20 18:40:57 +00:00
|
|
|
(concat
|
2012-03-01 20:04:15 +00:00
|
|
|
"^\\([ \t]*?\\)#\\+call:[ \t]+\\([^\(\)\n]+?\\)\\(\\[\\(.*\\)\\]\\|\\(\\)\\)"
|
|
|
|
"\(\\([^\n]*?\\)\)\\(\\[.+\\]\\|\\)[ \t]*\\(\\([^\n]*\\)\\)?")
|
2011-06-24 21:44:28 +00:00
|
|
|
"Regexp to match non-inline calls to predefined source block functions.")
|
|
|
|
|
|
|
|
(defconst org-babel-inline-lob-one-liner-regexp
|
|
|
|
(concat
|
2012-03-01 20:04:15 +00:00
|
|
|
"\\([^\n]*?\\)call_\\([^\(\)\n]+?\\)\\(\\[\\(.*?\\)\\]\\|\\(\\)\\)"
|
|
|
|
"\(\\([^\n]*?\\)\)\\(\\[\\(.*?\\)\\]\\)?")
|
2011-06-24 21:44:28 +00:00
|
|
|
"Regexp to match inline calls to predefined source block functions.")
|
|
|
|
|
|
|
|
(defconst org-babel-lob-one-liner-regexp
|
|
|
|
(concat "\\(" org-babel-block-lob-one-liner-regexp
|
|
|
|
"\\|" org-babel-inline-lob-one-liner-regexp "\\)")
|
2010-07-13 23:20:08 +00:00
|
|
|
"Regexp to match calls to predefined source block functions.")
|
2009-06-14 21:10:04 +00:00
|
|
|
|
2011-08-01 21:45:58 +00:00
|
|
|
;; functions for executing lob one-liners
|
2011-11-09 21:35:04 +00:00
|
|
|
|
2010-06-23 18:24:33 +00:00
|
|
|
;;;###autoload
|
2009-06-14 14:54:55 +00:00
|
|
|
(defun org-babel-lob-execute-maybe ()
|
2010-07-13 23:20:08 +00:00
|
|
|
"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."
|
2009-06-14 14:54:55 +00:00
|
|
|
(interactive)
|
|
|
|
(let ((info (org-babel-lob-get-info)))
|
2011-11-09 02:42:59 +00:00
|
|
|
(if (and (nth 0 info) (not (org-babel-in-example-or-verbatim)))
|
|
|
|
(progn (org-babel-lob-execute info) t)
|
|
|
|
nil)))
|
2009-06-14 14:54:55 +00:00
|
|
|
|
2010-06-23 18:24:33 +00:00
|
|
|
;;;###autoload
|
2009-06-14 14:54:55 +00:00
|
|
|
(defun org-babel-lob-get-info ()
|
2010-08-19 13:31:19 +00:00
|
|
|
"Return a Library of Babel function call as a string."
|
2011-06-24 21:44:28 +00:00
|
|
|
(flet ((nonempty (a b)
|
|
|
|
(let ((it (match-string a)))
|
|
|
|
(if (= (length it) 0) (match-string b) it))))
|
|
|
|
(let ((case-fold-search t))
|
|
|
|
(save-excursion
|
|
|
|
(beginning-of-line 1)
|
|
|
|
(when (looking-at org-babel-lob-one-liner-regexp)
|
|
|
|
(append
|
2012-03-28 00:05:36 +00:00
|
|
|
(mapcar #'org-babel-clean-text-properties
|
2010-07-20 18:40:57 +00:00
|
|
|
(list
|
2010-11-07 14:39:05 +00:00
|
|
|
(format "%s%s(%s)%s"
|
2011-06-24 21:44:28 +00:00
|
|
|
(nonempty 3 12)
|
2012-03-26 17:34:19 +00:00
|
|
|
(if (not (= 0 (length (nonempty 5 14))))
|
|
|
|
(concat "[" (nonempty 5 14) "]") "")
|
2011-06-25 21:25:18 +00:00
|
|
|
(or (nonempty 7 16) "")
|
2011-06-25 22:06:28 +00:00
|
|
|
(or (nonempty 8 19) ""))
|
|
|
|
(nonempty 9 18)))
|
2011-06-26 00:56:40 +00:00
|
|
|
(list (length (if (= (length (match-string 12)) 0)
|
|
|
|
(match-string 2) (match-string 11))))))))))
|
2012-03-28 00:05:36 +00:00
|
|
|
|
2009-06-14 14:54:55 +00:00
|
|
|
(defun org-babel-lob-execute (info)
|
2010-06-12 00:12:15 +00:00
|
|
|
"Execute the lob call specified by INFO."
|
2010-10-16 18:14:20 +00:00
|
|
|
(let ((params (org-babel-process-params
|
2010-10-16 16:02:57 +00:00
|
|
|
(org-babel-merge-params
|
|
|
|
org-babel-default-header-args
|
|
|
|
(org-babel-params-from-properties)
|
|
|
|
(org-babel-parse-header-arguments
|
|
|
|
(org-babel-clean-text-properties
|
|
|
|
(concat ":var results="
|
|
|
|
(mapconcat #'identity (butlast info) " "))))))))
|
2010-06-10 21:36:08 +00:00
|
|
|
(org-babel-execute-src-block
|
2010-06-13 01:26:08 +00:00
|
|
|
nil (list "emacs-lisp" "results" params nil nil (nth 2 info)))))
|
2009-06-14 14:54:55 +00:00
|
|
|
|
2010-06-11 23:02:42 +00:00
|
|
|
(provide 'ob-lob)
|
2010-06-25 16:20:39 +00:00
|
|
|
|
2011-08-15 18:04:38 +00:00
|
|
|
|
2010-06-25 16:20:39 +00:00
|
|
|
|
2010-06-11 23:02:42 +00:00
|
|
|
;;; ob-lob.el ends here
|