ob-lob.el 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138
  1. ;;; ob-lob.el --- functions supporting the Library of Babel
  2. ;; Copyright (C) 2009-2012 Free Software Foundation, Inc.
  3. ;; Author: Eric Schulte
  4. ;; Dan Davison
  5. ;; Keywords: literate programming, reproducible research
  6. ;; Homepage: http://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 <http://www.gnu.org/licenses/>.
  18. ;;; Code:
  19. (eval-when-compile
  20. (require 'cl))
  21. (require 'ob)
  22. (require 'ob-table)
  23. (declare-function org-babel-in-example-or-verbatim "ob-exp" nil)
  24. (defvar org-babel-library-of-babel nil
  25. "Library of source-code blocks.
  26. This is an association list. Populate the library by adding
  27. files to `org-babel-lob-files'.")
  28. (defcustom org-babel-lob-files '()
  29. "Files used to populate the `org-babel-library-of-babel'.
  30. To add files to this list use the `org-babel-lob-ingest' command."
  31. :group 'org-babel
  32. :version "24.1"
  33. :type 'list)
  34. (defvar org-babel-default-lob-header-args '((:exports . "results"))
  35. "Default header arguments to use when exporting #+lob/call lines.")
  36. ;;;###autoload
  37. (defun org-babel-lob-ingest (&optional file)
  38. "Add all named source-blocks defined in FILE to
  39. `org-babel-library-of-babel'."
  40. (interactive "fFile: ")
  41. (let ((lob-ingest-count 0))
  42. (org-babel-map-src-blocks file
  43. (let* ((info (org-babel-get-src-block-info 'light))
  44. (source-name (nth 4 info)))
  45. (when source-name
  46. (setq source-name (intern source-name)
  47. org-babel-library-of-babel
  48. (cons (cons source-name info)
  49. (assq-delete-all source-name org-babel-library-of-babel))
  50. lob-ingest-count (1+ lob-ingest-count)))))
  51. (message "%d src block%s added to Library of Babel"
  52. lob-ingest-count (if (> lob-ingest-count 1) "s" ""))
  53. lob-ingest-count))
  54. (defconst org-babel-block-lob-one-liner-regexp
  55. (concat
  56. "^\\([ \t]*\\)#\\+call:[ \t]+\\([^\(\)\n]+?\\)\\(\\[\\(.*\\)\\]\\|\\(\\)\\)"
  57. "\(\\([^\n]*\\)\)\\(\\[.+\\]\\|\\)[ \t]*\\(\\([^\n]*\\)\\)?")
  58. "Regexp to match non-inline calls to predefined source block functions.")
  59. (defconst org-babel-inline-lob-one-liner-regexp
  60. (concat
  61. "\\([^\n]*\\)call_\\([^\(\)\n]+?\\)\\(\\[\\(.*\\)\\]\\|\\(\\)\\)"
  62. "\(\\([^\n]*\\)\)\\(\\[\\(.*?\\)\\]\\)?")
  63. "Regexp to match inline calls to predefined source block functions.")
  64. (defconst org-babel-lob-one-liner-regexp
  65. (concat "\\(" org-babel-block-lob-one-liner-regexp
  66. "\\|" org-babel-inline-lob-one-liner-regexp "\\)")
  67. "Regexp to match calls to predefined source block functions.")
  68. ;; functions for executing lob one-liners
  69. ;;;###autoload
  70. (defun org-babel-lob-execute-maybe ()
  71. "Execute a Library of Babel source block, if appropriate.
  72. Detect if this is context for a Library Of Babel source block and
  73. if so then run the appropriate source block from the Library."
  74. (interactive)
  75. (let ((info (org-babel-lob-get-info)))
  76. (if (and (nth 0 info) (not (org-babel-in-example-or-verbatim)))
  77. (progn (org-babel-lob-execute info) t)
  78. nil)))
  79. ;;;###autoload
  80. (defun org-babel-lob-get-info ()
  81. "Return a Library of Babel function call as a string."
  82. (flet ((nonempty (a b)
  83. (let ((it (match-string a)))
  84. (if (= (length it) 0) (match-string b) it))))
  85. (let ((case-fold-search t))
  86. (save-excursion
  87. (beginning-of-line 1)
  88. (when (looking-at org-babel-lob-one-liner-regexp)
  89. (append
  90. (mapcar #'org-babel-clean-text-properties
  91. (list
  92. (format "%s%s(%s)%s"
  93. (nonempty 3 12)
  94. (if (not (= 0 (length (nonempty 5 13))))
  95. (concat "[" (nonempty 5 13) "]") "")
  96. (or (nonempty 7 16) "")
  97. (or (nonempty 8 19) ""))
  98. (nonempty 9 18)))
  99. (list (length (if (= (length (match-string 12)) 0)
  100. (match-string 2) (match-string 11))))))))))
  101. (defun org-babel-lob-execute (info)
  102. "Execute the lob call specified by INFO."
  103. (let ((params (org-babel-process-params
  104. (org-babel-merge-params
  105. org-babel-default-header-args
  106. (org-babel-params-from-properties)
  107. (org-babel-parse-header-arguments
  108. (org-babel-clean-text-properties
  109. (concat ":var results="
  110. (mapconcat #'identity (butlast info) " "))))))))
  111. (org-babel-execute-src-block
  112. nil (list "emacs-lisp" "results" params nil nil (nth 2 info)))))
  113. (provide 'ob-lob)
  114. ;;; ob-lob.el ends here