lisp/ob-lob.el

   1 ;;; ob-lob.el --- functions supporting the Library of Babel
   2
   3 ;; Copyright (C) 2009, 2010  Free Software Foundation, Inc.
   4
   5 ;; Author: Eric Schulte, Dan Davison
   6 ;; Keywords: literate programming, reproducible research
   7 ;; Homepage: http://orgmode.org
   8 ;; Version: 7.01
   9
  10 ;; This file is part of GNU Emacs.
  11
  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.
  16
  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.
  21
  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/>.
  24
  25 ;;; Commentary:
  26
  27 ;; See the online documentation for more information
  28 ;;
  29 ;;   http://orgmode.org/worg/org-contrib/babel/
  30
  31 ;;; Code:
  32 (require 'ob)
  33 (require 'ob-table)
  34
  35 (defvar org-babel-library-of-babel nil
  36   "Library of source-code blocks.
  37 This is an association list.  Populate the library by adding
  38 files to `org-babel-lob-files'.")
  39
  40 (defcustom org-babel-lob-files '()
  41   "Files used to populate the `org-babel-library-of-babel'.
  42 To add files to this list use the `org-babel-lob-ingest' command."
  43   :group 'org-babel
  44   :type 'list)
  45
  46 ;;;###autoload
  47 (defun org-babel-lob-ingest (&optional file)
  48   "Add all source-blocks defined in FILE to `org-babel-library-of-babel'."
  49   (interactive "f")
  50   (org-babel-map-src-blocks file
  51     (let* ((info (org-babel-get-src-block-info))
  52            (source-name (intern (nth 4 info))))
  53       (when source-name
  54         (setq org-babel-library-of-babel
  55               (cons (cons source-name info)
  56                     (assq-delete-all source-name org-babel-library-of-babel)))))))
  57
  58 (defconst org-babel-lob-call-aliases '("lob" "call")
  59   "Aliases to call a source block function.
  60 If you change the value of this variable then your files may
  61   become unusable by other org-babel users, and vice versa.")
  62
  63 (defconst org-babel-lob-one-liner-regexp
  64   (concat "^\\([ \t]*\\)#\\+\\(?:"
  65           (mapconcat #'regexp-quote org-babel-lob-call-aliases "\\|")
  66           "\\):[ \t]+\\([^\(\)\n]+\\)\(\\([^\n]*\\)\)[ \t]*\\([^\n]*\\)")
  67   "Regexp to match calls to predefined source block functions.")
  68
  69 ;; functions for executing lob one-liners
  70 ;;;###autoload
  71 (defun org-babel-lob-execute-maybe ()
  72   "Execute a Library of Babel source block, if appropriate.
  73 Detect if this is context for a Library Of Babel source block and
  74 if so then run the appropriate source block from the Library."
  75   (interactive)
  76   (let ((info (org-babel-lob-get-info)))
  77     (if (nth 0 info) (progn (org-babel-lob-execute info) t) nil)))
  78
  79 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-babel-lob-execute-maybe)
  80
  81 ;;;###autoload
  82 (defun org-babel-lob-get-info ()
  83   "Return a Library of Babel function call as a string.
  84
  85 This function is analogous to org-babel-get-src-block-name. For
  86 both functions, after they are called, (match-string 1) matches
  87 the function name, and (match-string 2) matches the function
  88 arguments inside the parentheses. I think perhaps these functions
  89 should be renamed to bring out this similarity, perhaps involving
  90 the word 'call'."
  91   (let ((case-fold-search t))
  92     (save-excursion
  93       (beginning-of-line 1)
  94       (if (looking-at org-babel-lob-one-liner-regexp)
  95           (append (mapcar #'org-babel-clean-text-properties
  96                           (list (format "%s(%s)" (match-string 2) (match-string 3))
  97                                 (match-string 4)))
  98                   (list (length (match-string 1))))))))
  99
 100 (defun org-babel-lob-execute (info)
 101   "Execute the lob call specified by INFO."
 102   (let ((params (org-babel-merge-params
 103                  org-babel-default-header-args
 104                  (org-babel-params-from-buffer)
 105                  (org-babel-params-from-properties)
 106                  (org-babel-parse-header-arguments
 107                   (org-babel-clean-text-properties
 108                    (concat ":var results=" (mapconcat #'identity (butlast info) " ")))))))
 109     (org-babel-execute-src-block
 110      nil (list "emacs-lisp" "results" params nil nil (nth 2 info)))))
 111
 112 (provide 'ob-lob)
 113
 114 ;; arch-tag: ce0712c9-2147-4019-ba3f-42341b8b474b
 115
 116 ;;; ob-lob.el ends here