mirror/org-mode
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs/org-mode.git synced 2024-12-03 08:30:03 +00:00
Code
78cdf14939
org-mode/lisp/ob-emacs-lisp.el

80 lines
2.7 KiB
EmacsLisp
Raw Normal View History

updating require and provide boilerplate for new ob* files
2010-06-11 23:02:42 +00:00
;;; ob-emacs-lisp.el --- org-babel functions for emacs-lisp code evaluation
adding support for emacs-lisp blocks
2009-03-23 23:07:02 +00:00
Copyright, license, and header fixes. Thanks to Glenn Morris for this fix in Emacs trunk.
2012-01-05 08:43:21 +00:00
;; Copyright (C) 2009-2012 Free Software Foundation, Inc.
adding support for emacs-lisp blocks
2009-03-23 23:07:02 +00:00
cleanup and small misc re-organizations
2009-03-29 22:08:53 +00:00
;; Author: Eric Schulte
adding support for emacs-lisp blocks
2009-03-23 23:07:02 +00:00
;; Keywords: literate programming, reproducible research
;; Homepage: http://orgmode.org
babel: assigning copyright to the FSF for babel language files
2010-06-25 16:32:35 +00:00
;; This file is part of GNU Emacs.
adding support for emacs-lisp blocks
2009-03-23 23:07:02 +00:00
babel: assigning copyright to the FSF for babel language files
2010-06-25 16:32:35 +00:00
;; GNU Emacs is free software: you can redistribute it and/or modify
adding support for emacs-lisp blocks
2009-03-23 23:07:02 +00:00
;; it under the terms of the GNU General Public License as published by
babel: assigning copyright to the FSF for babel language files
2010-06-25 16:32:35 +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,
adding support for emacs-lisp blocks
2009-03-23 23:07:02 +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.
babel: assigning copyright to the FSF for babel language files
2010-06-25 16:32:35 +00:00
adding support for emacs-lisp blocks
2009-03-23 23:07:02 +00:00
;; You should have received a copy of the GNU General Public License
babel: assigning copyright to the FSF for babel language files
2010-06-25 16:32:35 +00:00
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
adding support for emacs-lisp blocks
2009-03-23 23:07:02 +00:00
;;; Commentary:
renaming the org-babel-lisp file to org-babel-emacs-lisp
2009-09-13 16:07:31 +00:00
;; Org-Babel support for evaluating emacs-lisp code
adding support for emacs-lisp blocks
2009-03-23 23:07:02 +00:00
;;; Code:
updating require and provide boilerplate for new ob* files
2010-06-11 23:02:42 +00:00
(require 'ob)
Fix some more Org `check-declare' issues. * ob.el: Require org when compiling. (org-save-outline-visibility): Remove macro declaration. * ob-emacs-lisp.el: Require ob-comint when compiling, for macros. Remove unnecessary/macro declarations. * org-docview.el: Require doc-view when compiling. (doc-view-goto-page): Autoload rather than declaring. (doc-view-current-page): Remove macro declaration. * ob.el (tramp-compat-make-temp-file, org-edit-src-code) (org-entry-get, org-table-import): Fix declarations. (org-match-string-no-properties): Remove declaration. * ob-sh.el (org-babel-comint-in-buffer) (org-babel-comint-wait-for-output, org-babel-comint-buffer-livep) (org-babel-comint-with-output): Remove unnecessary declarations. * ob-R.el (orgtbl-to-tsv): Fix declaration. * org-list.el (org-entry-get): Fix declaration.
2010-08-27 20:35:09 +00:00
(eval-when-compile (require 'ob-comint))
adding support for emacs-lisp blocks
2009-03-23 23:07:02 +00:00
babel: added row/col-name support to all applicable languages
2010-04-19 01:06:34 +00:00
(defvar org-babel-default-header-args:emacs-lisp
babel: flip default values of :hlines header arg
2010-04-20 22:27:33 +00:00
'((:hlines . "yes") (:colnames . "no"))
More docstring edits
2010-07-13 23:04:47 +00:00
"Default arguments for evaluating an emacs-lisp source block.")
babel: added row/col-name support to all applicable languages
2010-04-19 01:06:34 +00:00
babel: declaring functions and variables for the compiler
2010-06-13 00:11:36 +00:00
(declare-function orgtbl-to-generic "org-table" (table params))
removing obsoleted optional third argument from org-babel-expand-body:LANG * lisp/ob-C.el (org-babel-expand-body:c++): removing obsoleted optional third argument (org-babel-expand-body:c++): removing obsoleted optional third argument (org-babel-C-expand): removing obsoleted optional third argument * lisp/ob-R.el: (org-babel-expand-body:R): removing obsoleted optional third argument (org-babel-execute:R): removing obsoleted optional third argument (org-babel-R-variable-assignments): removing obsoleted optional third argument * lisp/ob-asymptote.el: (org-babel-expand-body:asymptote): removing obsoleted optional third argument (org-babel-execute:asymptote): removing obsoleted optional third argument * lisp/ob-clojure.el: (org-babel-expand-body:clojure): removing obsoleted optional third argument (org-babel-execute:clojure): removing obsoleted optional third argument * lisp/ob-css.el: (org-babel-expand-body:css): removing obsoleted optional third argument * lisp/ob-ditaa.el: (org-babel-expand-body:ditaa): removing obsoleted optional third argument * lisp/ob-dot.el: (org-babel-expand-body:dot): removing obsoleted optional third argument (org-babel-execute:dot): removing obsoleted optional third argument * lisp/ob-emacs-lisp.el: (org-babel-expand-body:emacs-lisp): removing obsoleted optional third argument (org-babel-execute:emacs-lisp): removing obsoleted optional third argument * lisp/ob-gnuplot.el: (org-babel-expand-body:gnuplot): removing obsoleted optional third argument * lisp/ob-haskell.el: (org-babel-expand-body:haskell): removing obsoleted optional third argument (org-babel-execute:haskell): removing obsoleted optional third argument (org-babel-load-session:haskell): removing obsoleted optional third (org-babel-prep-session:haskell): removing obsoleted optional third * lisp/ob-js.el: (org-babel-expand-body:js): removing obsoleted optional third argument (org-babel-execute:js): removing obsoleted optional third argument * lisp/ob-latex.el: (org-babel-expand-body:latex): removing obsoleted optional third argument * lisp/ob-lisp.el: (org-babel-expand-body:lisp): removing obsoleted optional third argument (org-babel-execute:lisp): removing obsoleted optional third argument * lisp/ob-mscgen.el: (org-babel-expand-body:mscgen): removing obsoleted optional third argument * lisp/ob-ocaml.el: (org-babel-expand-body:ocaml): removing obsoleted optional third argument (org-babel-execute:ocaml): removing obsoleted optional third argument * lisp/ob-octave.el: (org-babel-expand-body:matlab): removing obsoleted optional third argument (org-babel-expand-body:octave): removing obsoleted optional third argument (org-babel-execute:octave): removing obsoleted optional third argument (org-babel-octave-variable-assignments): removing obsoleted optional third * lisp/ob-org.el: (org-babel-expand-body:org): removing obsoleted optional third argument * lisp/ob-perl.el: (org-babel-expand-body:perl): removing obsoleted optional third argument (org-babel-execute:perl): removing obsoleted optional third argument * lisp/ob-plantuml.el: (org-babel-expand-body:plantuml): removing obsoleted optional third argument * lisp/ob-python.el: (org-babel-expand-body:python): removing obsoleted optional third argument (org-babel-execute:python): removing obsoleted optional third argument (org-babel-python-variable-assignments): removing obsoleted optional third * lisp/ob-ruby.el: (org-babel-expand-body:ruby): removing obsoleted optional third argument (org-babel-execute:ruby): removing obsoleted optional third argument * lisp/ob-sass.el: (org-babel-expand-body:sass): removing obsoleted optional third argument * lisp/ob-scheme.el: (org-babel-expand-body:scheme): removing obsoleted optional third argument (org-babel-execute:scheme): removing obsoleted optional third argument * lisp/ob-screen.el: (org-babel-expand-body:screen): removing obsoleted optional third argument * lisp/ob-sh.el: (org-babel-expand-body:sh): removing obsoleted optional third argument (org-babel-execute:sh): removing obsoleted optional third argument (org-babel-sh-variable-assignments): removing obsoleted optional third * lisp/ob-sql.el: (org-babel-expand-body:sql): removing obsoleted optional third argument * lisp/ob-sqlite.el: (org-babel-expand-body:sqlite): removing obsoleted optional third argument (org-babel-execute:sqlite): removing obsoleted optional third argument * lisp/ob.el: (org-babel-expand-body:generic): removing obsoleted optional third argument
2010-10-16 03:35:45 +00:00
(defun org-babel-expand-body:emacs-lisp (body params)
ensuring the existence of a complete first sentence in the documentation of each babel function
2010-06-12 00:12:15 +00:00
"Expand BODY according to PARAMS, return the expanded body."
babel:removing calls to ob-process-params, and updating use of results * lisp/ob-C.el (org-babel-C-execute): removing call to org-babel-process-params which should no longer be called from within a language file * lisp/ob-R.el (org-babel-execute:R): removing call to org-babel-process-params which should no longer be called from within a language file (org-babel-R-variable-assignments): removing call to org-babel-process-params which should no longer be called from within a language file * lisp/ob-asymptote.el (org-babel-execute:asymptote): removing call to org-babel-process-params which should no longer be called from within a language file * lisp/ob-clojure.el (org-babel-execute:clojure): removing call to org-babel-process-params which should no longer be called from within a language file * lisp/ob-dot.el (org-babel-execute:dot): removing call to org-babel-process-params which should no longer be called from within a language file * lisp/ob-emacs-lisp.el (org-babel-expand-body:emacs-lisp): removing call to org-babel-process-params which should no longer be called from within a language file (org-babel-execute:emacs-lisp): removing call to org-babel-process-params which should no longer be called from within a language file * lisp/ob-haskell.el (org-babel-execute:haskell): removing call to org-babel-process-params which should no longer be called from within a language file * lisp/ob-js.el (org-babel-execute:js): removing call to org-babel-process-params which should no longer be called from within a language file * lisp/ob-lisp.el (org-babel-execute:lisp): removing call to org-babel-process-params which should no longer be called from within a language file * lisp/ob-ocaml.el (org-babel-execute:ocaml): removing call to org-babel-process-params which should no longer be called from within a language file * lisp/ob-octave.el (org-babel-execute:octave): removing call to org-babel-process-params which should no longer be called from within a language file * lisp/ob-perl.el (org-babel-execute:perl): removing call to org-babel-process-params which should no longer be called from within a language file * lisp/ob-python.el (org-babel-execute:python): removing call to org-babel-process-params which should no longer be called from within a language file * lisp/ob-ruby.el (org-babel-execute:ruby): removing call to org-babel-process-params which should no longer be called from within a language file * lisp/ob-scheme.el (org-babel-execute:scheme): removing call to org-babel-process-params which should no longer be called from within a language file * lisp/ob-screen.el (org-babel-execute:screen): removing call to org-babel-process-params which should no longer be called from within a language file (org-babel-prep-session:screen): removing call to org-babel-process-params which should no longer be called from within a language file * lisp/ob-sh.el (org-babel-execute:sh): removing call to org-babel-process-params which should no longer be called from within a language file * lisp/ob-sql.el (org-babel-execute:sql): removing call to org-babel-process-params which should no longer be called from within a language file * ob-haskell.el (org-babel-execute:haskell): Remove reference to processed params * ob-clojure.el (org-babel-execute:clojure): Remove reference to processed params * ob-R.el (org-babel-execute:R): Remove reference to processed params
2010-10-21 11:52:24 +00:00
(let* ((vars (mapcar #'cdr (org-babel-get-header params :var)))
(result-params (cdr (assoc :result-params params)))
org-babel-expand-body:emacs-lisp
2010-04-20 06:07:46 +00:00
(print-level nil) (print-length nil)
babel: ob-emacs-lisp and ob-clojure now only wrap bodies in `let' forms when variables are present
2010-04-24 15:21:14 +00:00
(body (if (> (length vars) 0)
Massive code clean-up. Delete trailing whitespaces. Indent all sexps correctly. Sentences end with double spaces.
2012-08-11 17:10:44 +00:00
(concat "(let ("
(mapconcat
(lambda (var)
(format "%S" (print `(,(car var) ',(cdr var)))))
vars "\n ")
")\n" body "\n)")
Bug fix in ob-emacs-lisp.el. * lisp/ob-emacs-lisp.el: A comment on the last line of an emacs-lisp code block would cause an error when the block is was executed. This fix cures this behaviour. * testing/lisp/test-ob-emacs-lisp.el: Regression tests for the above fix.
2012-01-05 18:00:12 +00:00
(concat body "\n"))))
babel: ob-emacs-lisp and ob-clojure now only wrap bodies in `let' forms when variables are present
2010-04-24 15:21:14 +00:00
(if (or (member "code" result-params)
(member "pp" result-params))
(concat "(pp " body ")") body)))
org-babel-expand-body:emacs-lisp
2010-04-20 06:07:46 +00:00
Revert "Altering org-babel-execute:emacs-lisp in accordance with preceding changes." This reverts commit d8001facab6ffa844ed5f042facd26268c9aec8c. Going back to original plan of simply passing (cmd body params) to the org-babel-execute:LANG functions. The benefit of this is that languages will have access to the full params list. A downside is that code parsing the params list and referencing variables is currently duplicated across the languages, so perhaps we can aim to reduce that code duplication at some point.
2009-07-08 04:06:14 +00:00
(defun org-babel-execute:emacs-lisp (body params)
More docstring edits
2010-07-13 23:04:47 +00:00
"Execute a block of emacs-lisp code with Babel."
org-babel: ensure that result is returned when using :results output One half of this patch is a revert of c167a4ac32fe769e7906ea9acafddce958daddb1. These changes are necessary so that :results output works correctly with #+lob calls. For example the following example did not work: -------------------------------------------------- 3. :results output org -> doesn't work with #+lob: -------------------------------------------------- \#+srcname: randthree(n,max) \#+begin_src ruby number = n maximum = max puts "* Random numbers\n" + "Here are some random numbers: " + (1..number).collect {|x| (rand * maximum).ceil }.join(", ") + "." \#+end_src \#+lob: randthree(n=3,max=10) :results output org
2009-10-20 13:24:15 +00:00
(save-window-excursion
ob-emacs-lisp: respect the ":results scalar" header argument combination * lisp/ob-emacs-lisp.el (org-babel-execute:emacs-lisp): Respect the ":results scalar" header argument combination.
2011-06-19 23:06:55 +00:00
((lambda (result)
org-babel-result-cond - unified handling of results * lisp/ob.el (org-babel-result-cond): This function should now be used by all language backends to handle the processing of raw code block output into scalar results, table results, or ignored results depending on the value of result-params. * lisp/ob-C.el (org-babel-C-execute): Use org-babel-result-cond. * lisp/ob-R.el (org-babel-R-evaluate-external-process): Use org-babel-result-cond. (org-babel-R-evaluate-session): Use org-babel-result-cond. * lisp/ob-awk.el (org-babel-execute:awk): Use org-babel-result-cond. * lisp/ob-clojure.el (org-babel-execute:clojure): Use org-babel-result-cond. * lisp/ob-emacs-lisp.el (org-babel-execute:emacs-lisp): Use org-babel-result-cond. * lisp/ob-fortran.el (org-babel-execute:fortran): Use org-babel-result-cond. * lisp/ob-io.el (org-babel-io-evaluate): Use org-babel-result-cond. * lisp/ob-java.el (org-babel-execute:java): Use org-babel-result-cond. * lisp/ob-lisp.el (org-babel-execute:lisp): Use org-babel-result-cond. * lisp/ob-maxima.el (org-babel-execute:maxima): Use org-babel-result-cond. * lisp/ob-picolisp.el (org-babel-execute:picolisp): Use org-babel-result-cond. * lisp/ob-python.el (org-babel-python-evaluate-external-process): Use org-babel-result-cond. (org-babel-python-evaluate-session): Use org-babel-result-cond. * lisp/ob-scala.el (org-babel-scala-evaluate): Use org-babel-result-cond. * lisp/ob-sh.el (org-babel-sh-evaluate): Use org-babel-result-cond. * lisp/ob-shen.el (org-babel-execute:shen): Use org-babel-result-cond. * lisp/ob-sql.el (org-babel-execute:sql): Use org-babel-result-cond. * lisp/ob-sqlite.el (org-babel-execute:sqlite): Use org-babel-result-cond.
2012-11-19 01:02:09 +00:00
(org-babel-result-cond (cdr (assoc :result-params params))
(let ((print-level nil)
(print-length nil))
(format "%S" result))
ob-emacs-lisp: respect the ":results scalar" header argument combination * lisp/ob-emacs-lisp.el (org-babel-execute:emacs-lisp): Respect the ":results scalar" header argument combination.
2011-06-19 23:06:55 +00:00
(org-babel-reassemble-table
result
(org-babel-pick-name (cdr (assoc :colname-names params))
(cdr (assoc :colnames params)))
(org-babel-pick-name (cdr (assoc :rowname-names params))
(cdr (assoc :rownames params))))))
ob-emacs-lisp: now supports :results output * lisp/ob-emacs-lisp.el (org-babel-execute:emacs-lisp): Now supports ":results output".
2011-04-10 22:29:14 +00:00
(eval (read (format (if (member "output"
(cdr (assoc :result-params params)))
"(with-output-to-string %s)"
"(progn %s)")
ob-emacs-lisp: respect the ":results scalar" header argument combination * lisp/ob-emacs-lisp.el (org-babel-execute:emacs-lisp): Respect the ":results scalar" header argument combination.
2011-06-19 23:06:55 +00:00
(org-babel-expand-body:emacs-lisp body params)))))))
org-babel: language specific files using cleaner parameter passing
2009-11-10 22:22:25 +00:00
fixes
2010-06-15 00:28:09 +00:00
(provide 'ob-emacs-lisp)
babel: assigning copyright to the FSF for babel language files
2010-06-25 16:32:35 +00:00
Remove arch-tag at the bottom of files.
2011-08-15 18:04:38 +00:00
babel: assigning copyright to the FSF for babel language files
2010-06-25 16:32:35 +00:00
updating require and provide boilerplate for new ob* files
2010-06-11 23:02:42 +00:00
;;; ob-emacs-lisp.el ends here
Copy Permalink