2015-10-26 00:56:00 +00:00
|
|
|
;;; ob-emacs-lisp.el --- Babel Functions for Emacs-lisp Code -*- lexical-binding: t; -*-
|
2009-03-23 23:07:02 +00:00
|
|
|
|
2024-01-02 01:47:10 +00:00
|
|
|
;; Copyright (C) 2009-2024 Free Software Foundation, Inc.
|
2009-03-23 23:07:02 +00:00
|
|
|
|
2009-03-29 22:08:53 +00:00
|
|
|
;; Author: Eric Schulte
|
2009-03-23 23:07:02 +00:00
|
|
|
;; Keywords: literate programming, reproducible research
|
2021-09-26 07:44:29 +00:00
|
|
|
;; URL: https://orgmode.org
|
2009-03-23 23:07:02 +00:00
|
|
|
|
2010-06-25 16:32:35 +00:00
|
|
|
;; This file is part of GNU Emacs.
|
2009-03-23 23:07:02 +00:00
|
|
|
|
2010-06-25 16:32:35 +00:00
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
2009-03-23 23:07:02 +00:00
|
|
|
;; it under the terms of the GNU General Public License as published by
|
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,
|
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.
|
2010-06-25 16:32:35 +00:00
|
|
|
|
2009-03-23 23:07:02 +00:00
|
|
|
;; You should have received a copy of the GNU General Public License
|
2017-09-13 22:52:52 +00:00
|
|
|
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
|
2009-03-23 23:07:02 +00:00
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
2009-09-13 16:07:31 +00:00
|
|
|
;; Org-Babel support for evaluating emacs-lisp code
|
2009-03-23 23:07:02 +00:00
|
|
|
|
|
|
|
;;; Code:
|
2018-10-01 19:33:49 +00:00
|
|
|
|
2022-08-04 13:53:05 +00:00
|
|
|
(require 'org-macs)
|
|
|
|
(org-assert-version)
|
|
|
|
|
2018-10-01 19:33:49 +00: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 23:07:02 +00:00
|
|
|
|
2016-04-18 17:55:34 +00:00
|
|
|
(defconst org-babel-header-args:emacs-lisp '((lexical . :any))
|
|
|
|
"Emacs-lisp specific header arguments.")
|
|
|
|
|
2016-04-20 21:45:32 +00:00
|
|
|
(defvar org-babel-default-header-args:emacs-lisp '((:lexical . "no"))
|
2016-04-18 17:55:34 +00:00
|
|
|
"Default arguments for evaluating an emacs-lisp source block.
|
|
|
|
|
2018-09-20 09:23:49 +00:00
|
|
|
A value of \"yes\" or t causes source blocks to be eval'd using
|
2016-04-20 21:45:32 +00:00
|
|
|
lexical scoping. It can also be an alist mapping symbols to
|
2019-03-14 10:24:33 +00: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-19 01:06:34 +00:00
|
|
|
|
2010-10-16 03:35:45 +00:00
|
|
|
(defun org-babel-expand-body:emacs-lisp (body params)
|
2010-06-12 00:12:15 +00:00
|
|
|
"Expand BODY according to PARAMS, return the expanded body."
|
2017-07-23 20:41:27 +00:00
|
|
|
(let ((vars (org-babel--get-vars params))
|
|
|
|
(print-level nil)
|
2023-10-19 08:58:17 +00:00
|
|
|
(print-length nil)
|
|
|
|
(prologue (cdr (assq :prologue params)))
|
|
|
|
(epilogue (cdr (assq :epilogue params))))
|
2017-07-23 20:41:27 +00:00
|
|
|
(if (null vars) (concat body "\n")
|
2023-10-19 08:58:17 +00:00
|
|
|
(format "(let (%s)\n%s%s%s\n)"
|
2017-07-23 20:41:27 +00:00
|
|
|
(mapconcat
|
|
|
|
(lambda (var)
|
2022-10-06 11:43:45 +00:00
|
|
|
(format "%S" `(,(car var) ',(cdr var))))
|
2017-07-23 20:41:27 +00:00
|
|
|
vars "\n ")
|
2023-10-19 08:58:17 +00:00
|
|
|
(if prologue (concat prologue "\n ") "")
|
|
|
|
body
|
|
|
|
(if epilogue (concat "\n " epilogue "\n") "")))))
|
2010-04-20 06:07:46 +00:00
|
|
|
|
2009-07-08 04:06:14 +00:00
|
|
|
(defun org-babel-execute:emacs-lisp (body params)
|
2023-09-09 10:57:02 +00:00
|
|
|
"Execute emacs-lisp code BODY according to PARAMS."
|
2020-09-07 05:37:19 +00:00
|
|
|
(let* ((lexical (cdr (assq :lexical params)))
|
|
|
|
(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))
|
|
|
|
(org-babel-emacs-lisp-lexical lexical))))
|
|
|
|
(org-babel-result-cond result-params
|
|
|
|
(let ((print-level nil)
|
|
|
|
(print-length nil))
|
|
|
|
(if (or (member "scalar" result-params)
|
|
|
|
(member "verbatim" result-params))
|
|
|
|
(format "%S" result)
|
|
|
|
(format "%s" result)))
|
|
|
|
(org-babel-reassemble-table
|
|
|
|
result
|
|
|
|
(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 22:22:25 +00:00
|
|
|
|
2019-03-14 10:24:33 +00: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
|
2023-09-09 10:57:02 +00:00
|
|
|
corresponding :lexical source block argument provide in the INFO
|
|
|
|
channel, as returned by `org-babel-get-src-block-info'."
|
2019-03-14 10:24:33 +00:00
|
|
|
(setq lexical-binding
|
|
|
|
(org-babel-emacs-lisp-lexical
|
|
|
|
(org-babel-read
|
|
|
|
(cdr (assq :lexical (nth 2 info)))))))
|
|
|
|
|
2016-02-14 15:14:30 +00:00
|
|
|
(org-babel-make-language-alias "elisp" "emacs-lisp")
|
|
|
|
|
2010-06-15 00:28:09 +00:00
|
|
|
(provide 'ob-emacs-lisp)
|
2010-06-25 16:32:35 +00:00
|
|
|
|
2010-06-11 23:02:42 +00:00
|
|
|
;;; ob-emacs-lisp.el ends here
|