2015-10-25 20:56:00 -04:00
|
|
|
;;; ob-emacs-lisp.el --- Babel Functions for Emacs-lisp Code -*- lexical-binding: t; -*-
|
2009-03-23 19:07:02 -04:00
|
|
|
|
2020-01-01 13:38:46 -05:00
|
|
|
;; Copyright (C) 2009-2020 Free Software Foundation, Inc.
|
2009-03-23 19:07:02 -04:00
|
|
|
|
2009-03-29 18:08:53 -04:00
|
|
|
;; Author: Eric Schulte
|
2009-03-23 19:07:02 -04:00
|
|
|
;; Keywords: literate programming, reproducible research
|
2018-01-16 11:22:00 -05:00
|
|
|
;; Homepage: https://orgmode.org
|
2009-03-23 19:07:02 -04:00
|
|
|
|
2010-06-25 12:32:35 -04:00
|
|
|
;; This file is part of GNU Emacs.
|
2009-03-23 19:07:02 -04:00
|
|
|
|
2010-06-25 12:32:35 -04:00
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
2009-03-23 19:07:02 -04:00
|
|
|
;; it under the terms of the GNU General Public License as published by
|
2010-06-25 12:32:35 -04: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-03-23 19:07:02 -04: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 12:32:35 -04:00
|
|
|
|
2009-03-23 19:07:02 -04:00
|
|
|
;; You should have received a copy of the GNU General Public License
|
2017-09-13 18:52:52 -04:00
|
|
|
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
|
2009-03-23 19:07:02 -04:00
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
2009-09-13 12:07:31 -04:00
|
|
|
;; Org-Babel support for evaluating emacs-lisp code
|
2009-03-23 19:07:02 -04:00
|
|
|
|
|
|
|
;;; Code:
|
2018-10-01 15:33:49 -04:00
|
|
|
|
|
|
|
(require 'ob-core)
|
|
|
|
|
|
|
|
(declare-function org-babel--get-vars "ob" (params))
|
|
|
|
(declare-function org-babel-result-cond "ob" (result-params scalar-form &rest table-forms))
|
|
|
|
(declare-function org-babel-reassemble-table "ob" (table colnames rownames))
|
|
|
|
(declare-function org-babel-pick-name "ob" (names selector))
|
2009-03-23 19:07:02 -04:00
|
|
|
|
2016-04-18 13:55:34 -04:00
|
|
|
(defconst org-babel-header-args:emacs-lisp '((lexical . :any))
|
|
|
|
"Emacs-lisp specific header arguments.")
|
|
|
|
|
2016-04-20 17:45:32 -04:00
|
|
|
(defvar org-babel-default-header-args:emacs-lisp '((:lexical . "no"))
|
2016-04-18 13:55:34 -04:00
|
|
|
"Default arguments for evaluating an emacs-lisp source block.
|
|
|
|
|
2018-09-20 05:23:49 -04:00
|
|
|
A value of \"yes\" or t causes source blocks to be eval'd using
|
2016-04-20 17:45:32 -04:00
|
|
|
lexical scoping. It can also be an alist mapping symbols to
|
2019-03-14 06:24:33 -04:00
|
|
|
their value. It is used both as the optional LEXICAL argument to
|
|
|
|
`eval', and as the value for `lexical-binding' in buffers created
|
|
|
|
by `org-edit-src-code'.")
|
2010-04-18 21:06:34 -04:00
|
|
|
|
2010-10-15 23:35:45 -04:00
|
|
|
(defun org-babel-expand-body:emacs-lisp (body params)
|
2010-06-11 20:12:15 -04:00
|
|
|
"Expand BODY according to PARAMS, return the expanded body."
|
2017-07-23 16:41:27 -04:00
|
|
|
(let ((vars (org-babel--get-vars params))
|
|
|
|
(print-level nil)
|
|
|
|
(print-length nil))
|
|
|
|
(if (null vars) (concat body "\n")
|
|
|
|
(format "(let (%s)\n%s\n)"
|
|
|
|
(mapconcat
|
|
|
|
(lambda (var)
|
|
|
|
(format "%S" (print `(,(car var) ',(cdr var)))))
|
|
|
|
vars "\n ")
|
|
|
|
body))))
|
2010-04-20 02:07:46 -04:00
|
|
|
|
2009-07-08 00:06:14 -04:00
|
|
|
(defun org-babel-execute:emacs-lisp (body params)
|
2010-07-13 19:04:47 -04:00
|
|
|
"Execute a block of emacs-lisp code with Babel."
|
2009-10-20 09:24:15 -04:00
|
|
|
(save-window-excursion
|
2016-04-18 13:55:34 -04:00
|
|
|
(let* ((lexical (cdr (assq :lexical params)))
|
2017-07-23 16:41:27 -04:00
|
|
|
(result-params (cdr (assq :result-params params)))
|
|
|
|
(body (format (if (member "output" result-params)
|
|
|
|
"(with-output-to-string %s\n)"
|
|
|
|
"(progn %s\n)")
|
|
|
|
(org-babel-expand-body:emacs-lisp body params)))
|
|
|
|
(result (eval (read (if (or (member "code" result-params)
|
|
|
|
(member "pp" result-params))
|
|
|
|
(concat "(pp " body ")")
|
|
|
|
body))
|
2019-03-14 06:24:33 -04:00
|
|
|
(org-babel-emacs-lisp-lexical lexical))))
|
2017-07-23 16:41:27 -04:00
|
|
|
(org-babel-result-cond result-params
|
Backport changes from Emacs revs 115081 and 115082
2013-11-12 Stefan Monnier <monnier@iro.umontreal.ca>
Address some byte-compiler warnings.
* ob-abc.el (org-babel-expand-body:abc): Use dolist.
(org-babel-execute:abc): Fix regexp quoting.
* ob-calc.el (org--var-syms): Rename from `var-syms'.
* ob-lilypond.el (ly-compile-lilyfile): Remove redundant let-binding.
* ob-table.el (sbe): Move debug declaration.
* org-clock.el (org--msg-extra): Rename from `msg-extra'.
* org.el (org-version): Avoid var name starting with _.
(org-inhibit-startup, org-called-with-limited-levels)
(org-link-search-inhibit-query, org-time-was-given)
(org-end-time-was-given, org-def, org-defdecode, org-with-time):
* org-colview.el (org-agenda-overriding-columns-format):
* org-agenda.el (org-agenda-multi, org-depend-tag-blocked)
(org-agenda-show-log-scoped):
* ob-python.el (py-which-bufname, python-shell-buffer-name):
* ob-haskell.el (org-export-copy-to-kill-ring):
* ob-exp.el (org-link-search-inhibit-query):
* ob-R.el (ess-eval-visibly-p):
* ob-core.el (org-src-window-setup): Declare before use.
(org-babel-expand-noweb-references): Remove unused `blocks-in-buffer'.
* ox-odt.el (org-odt-hfy-face-to-css):
* org-src.el (org-src-associate-babel-session, org-src-get-lang-mode):
* org-bibtex.el (org-bibtex-get, org-bibtex-ask, org-bibtex)
(org-bibtex-check):
* ob-tangle.el (org-babel-tangle, org-babel-spec-to-string)
(org-babel-tangle-single-block, org-babel-tangle-comment-links):
* ob-table.el (sbe):
* ob-sqlite.el (org-babel-sqlite-expand-vars):
* ob-sql.el (org-babel-sql-expand-vars):
* ob-shen.el (org-babel-execute:shen):
* ob-sh.el (org-babel-execute:sh, org-babel-sh-evaluate):
* ob-scala.el (org-babel-scala-evaluate):
* ob-ruby.el (org-babel-ruby-table-or-string)
(org-babel-ruby-evaluate):
* ob-python.el (org-babel-python-table-or-string)
(org-babel-python-evaluate-external-process)
(org-babel-python-evaluate-session):
* ob-picolisp.el (org-babel-execute:picolisp):
* ob-perl.el (org-babel-perl-evaluate):
* ob-maxima.el (org-babel-execute:maxima):
* ob-lisp.el (org-babel-execute:lisp):
* ob-java.el (org-babel-execute:java):
* ob-io.el (org-babel-io-evaluate):
* ob-haskell.el (org-babel-execute:haskell):
* ob-fortran.el (org-babel-execute:fortran):
* ob-exp.el (org-babel-exp-code):
* ob-emacs-lisp.el (org-babel-execute:emacs-lisp):
* ob-ditaa.el (org-babel-execute:ditaa):
* ob-core.el (org-babel-execute-src-block, org-babel-sha1-hash)
(org-babel-parse-header-arguments, org-babel-reassemble-table)
(org-babel-goto-src-block-head, org-babel-mark-block)
(org-babel-expand-noweb-references, org-babel-script-escape)
(org-babel-process-file-name):
* ob-clojure.el (org-babel-execute:clojure):
* ob-calc.el (org-babel-execute:calc):
* ob-awk.el (org-babel-execute:awk):
* ob-abc.el (org-babel-execute:abc):
* ob-R.el (org-babel-expand-body:R):
* ob-C.el (org-babel-C-execute): Avoid deprecated ((lambda) ...).
2013-11-12 Glenn Morris <rgm@gnu.org>
* ox-html.el (org-html-scripts): Add 2013 to copyright years.
(org-html-infojs-template): Copyright holder to FSF.
2013-11-12 14:57:31 -05:00
|
|
|
(let ((print-level nil)
|
|
|
|
(print-length nil))
|
2017-07-23 16:41:27 -04:00
|
|
|
(if (or (member "scalar" result-params)
|
|
|
|
(member "verbatim" result-params))
|
Backport changes from Emacs revs 115081 and 115082
2013-11-12 Stefan Monnier <monnier@iro.umontreal.ca>
Address some byte-compiler warnings.
* ob-abc.el (org-babel-expand-body:abc): Use dolist.
(org-babel-execute:abc): Fix regexp quoting.
* ob-calc.el (org--var-syms): Rename from `var-syms'.
* ob-lilypond.el (ly-compile-lilyfile): Remove redundant let-binding.
* ob-table.el (sbe): Move debug declaration.
* org-clock.el (org--msg-extra): Rename from `msg-extra'.
* org.el (org-version): Avoid var name starting with _.
(org-inhibit-startup, org-called-with-limited-levels)
(org-link-search-inhibit-query, org-time-was-given)
(org-end-time-was-given, org-def, org-defdecode, org-with-time):
* org-colview.el (org-agenda-overriding-columns-format):
* org-agenda.el (org-agenda-multi, org-depend-tag-blocked)
(org-agenda-show-log-scoped):
* ob-python.el (py-which-bufname, python-shell-buffer-name):
* ob-haskell.el (org-export-copy-to-kill-ring):
* ob-exp.el (org-link-search-inhibit-query):
* ob-R.el (ess-eval-visibly-p):
* ob-core.el (org-src-window-setup): Declare before use.
(org-babel-expand-noweb-references): Remove unused `blocks-in-buffer'.
* ox-odt.el (org-odt-hfy-face-to-css):
* org-src.el (org-src-associate-babel-session, org-src-get-lang-mode):
* org-bibtex.el (org-bibtex-get, org-bibtex-ask, org-bibtex)
(org-bibtex-check):
* ob-tangle.el (org-babel-tangle, org-babel-spec-to-string)
(org-babel-tangle-single-block, org-babel-tangle-comment-links):
* ob-table.el (sbe):
* ob-sqlite.el (org-babel-sqlite-expand-vars):
* ob-sql.el (org-babel-sql-expand-vars):
* ob-shen.el (org-babel-execute:shen):
* ob-sh.el (org-babel-execute:sh, org-babel-sh-evaluate):
* ob-scala.el (org-babel-scala-evaluate):
* ob-ruby.el (org-babel-ruby-table-or-string)
(org-babel-ruby-evaluate):
* ob-python.el (org-babel-python-table-or-string)
(org-babel-python-evaluate-external-process)
(org-babel-python-evaluate-session):
* ob-picolisp.el (org-babel-execute:picolisp):
* ob-perl.el (org-babel-perl-evaluate):
* ob-maxima.el (org-babel-execute:maxima):
* ob-lisp.el (org-babel-execute:lisp):
* ob-java.el (org-babel-execute:java):
* ob-io.el (org-babel-io-evaluate):
* ob-haskell.el (org-babel-execute:haskell):
* ob-fortran.el (org-babel-execute:fortran):
* ob-exp.el (org-babel-exp-code):
* ob-emacs-lisp.el (org-babel-execute:emacs-lisp):
* ob-ditaa.el (org-babel-execute:ditaa):
* ob-core.el (org-babel-execute-src-block, org-babel-sha1-hash)
(org-babel-parse-header-arguments, org-babel-reassemble-table)
(org-babel-goto-src-block-head, org-babel-mark-block)
(org-babel-expand-noweb-references, org-babel-script-escape)
(org-babel-process-file-name):
* ob-clojure.el (org-babel-execute:clojure):
* ob-calc.el (org-babel-execute:calc):
* ob-awk.el (org-babel-execute:awk):
* ob-abc.el (org-babel-execute:abc):
* ob-R.el (org-babel-expand-body:R):
* ob-C.el (org-babel-C-execute): Avoid deprecated ((lambda) ...).
2013-11-12 Glenn Morris <rgm@gnu.org>
* ox-html.el (org-html-scripts): Add 2013 to copyright years.
(org-html-infojs-template): Copyright holder to FSF.
2013-11-12 14:57:31 -05:00
|
|
|
(format "%S" result)
|
|
|
|
(format "%s" result)))
|
|
|
|
(org-babel-reassemble-table
|
|
|
|
result
|
2016-09-22 13:45:15 -04:00
|
|
|
(org-babel-pick-name (cdr (assq :colname-names params))
|
|
|
|
(cdr (assq :colnames params)))
|
|
|
|
(org-babel-pick-name (cdr (assq :rowname-names params))
|
|
|
|
(cdr (assq :rownames params))))))))
|
2009-11-10 17:22:25 -05:00
|
|
|
|
2019-03-14 06:24:33 -04:00
|
|
|
(defun org-babel-emacs-lisp-lexical (lexical)
|
|
|
|
"Interpret :lexical source block argument.
|
|
|
|
Convert LEXICAL into the form appropriate for `lexical-binding'
|
|
|
|
and the LEXICAL argument to `eval'."
|
|
|
|
(if (listp lexical)
|
|
|
|
lexical
|
|
|
|
(not (null (member lexical '("yes" "t"))))))
|
|
|
|
|
|
|
|
(defun org-babel-edit-prep:emacs-lisp (info)
|
|
|
|
"Set `lexical-binding' in Org edit buffer.
|
|
|
|
Set `lexical-binding' in Org edit buffer according to the
|
|
|
|
corresponding :lexical source block argument."
|
|
|
|
(setq lexical-binding
|
|
|
|
(org-babel-emacs-lisp-lexical
|
|
|
|
(org-babel-read
|
|
|
|
(cdr (assq :lexical (nth 2 info)))))))
|
|
|
|
|
2016-02-14 10:14:30 -05:00
|
|
|
(org-babel-make-language-alias "elisp" "emacs-lisp")
|
|
|
|
|
2010-06-14 20:28:09 -04:00
|
|
|
(provide 'ob-emacs-lisp)
|
2010-06-25 12:32:35 -04:00
|
|
|
|
2011-08-15 14:04:38 -04:00
|
|
|
|
2010-06-25 12:32:35 -04:00
|
|
|
|
2010-06-11 19:02:42 -04:00
|
|
|
;;; ob-emacs-lisp.el ends here
|