;;; ob-lisp.el --- Babel Functions for Common Lisp -*- lexical-binding: t; -*- ;; Copyright (C) 2009-2020 Free Software Foundation, Inc. ;; Authors: Joel Boehland ;; Eric Schulte ;; David T. O'Toole ;; Keywords: literate programming, reproducible research ;; Homepage: https://orgmode.org ;; This file is part of GNU Emacs. ;; GNU Emacs is free software: you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by ;; 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, ;; 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. ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . ;;; Commentary: ;;; Support for evaluating Common Lisp code, relies on SLY or SLIME ;;; for all eval. ;;; Requirements: ;; Requires SLY (Sylvester the Cat's Common Lisp IDE) or SLIME ;; (Superior Lisp Interaction Mode for Emacs). See: ;; - https://github.com/capitaomorte/sly ;; - http://common-lisp.net/project/slime/ ;;; Code: (require 'ob) (require 'org-macs) (declare-function sly-eval "ext:sly" (sexp &optional package)) (declare-function slime-eval "ext:slime" (sexp &optional package)) (defvar org-babel-tangle-lang-exts) (add-to-list 'org-babel-tangle-lang-exts '("lisp" . "lisp")) (defvar org-babel-default-header-args:lisp '()) (defvar org-babel-header-args:lisp '((package . :any))) (defcustom org-babel-lisp-eval-fn #'slime-eval "The function to be called to evaluate code on the Lisp side. Valid values include `slime-eval' and `sly-eval'." :group 'org-babel :version "26.1" :package-version '(Org . "9.0") :type 'symbol) (defcustom org-babel-lisp-dir-fmt "(let ((*default-pathname-defaults* #P%S\n)) %%s\n)" "Format string used to wrap code bodies to set the current directory. For example a value of \"(progn ;; %s\\n %%s)\" would ignore the current directory string." :group 'org-babel :version "24.1" :type 'string) (defun org-babel-expand-body:lisp (body params) "Expand BODY according to PARAMS, return the expanded body." (let* ((vars (org-babel--get-vars params)) (result-params (cdr (assq :result-params params))) (print-level nil) (print-length nil) (body (if (null vars) (org-trim body) (concat "(let (" (mapconcat (lambda (var) (format "(%S (quote %S))" (car var) (cdr var))) vars "\n ") ")\n" body ")")))) (if (or (member "code" result-params) (member "pp" result-params)) (format "(pprint %s)" body) body))) (defun org-babel-execute:lisp--legacy (body params) "Execute a block of Common Lisp code with Babel. BODY is the contents of the block, as a string. PARAMS is a property list containing the parameters of the block. This code is supposed to be superseded with the one in `org-babel-execute:lisp--multiple-targets-support' once the neccessary feature gets merged into SLIME." (require (pcase org-babel-lisp-eval-fn (`slime-eval 'slime) (`sly-eval 'sly))) (org-babel-reassemble-table (let ((result (funcall (if (member "output" (cdr (assq :result-params params))) #'car #'cadr) (with-temp-buffer (insert (org-babel-expand-body:lisp body params)) (funcall org-babel-lisp-eval-fn `(swank:eval-and-grab-output ,(let ((dir (if (assq :dir params) (cdr (assq :dir params)) default-directory))) (format (if dir (format org-babel-lisp-dir-fmt dir) "(progn %s\n)") (buffer-substring-no-properties (point-min) (point-max))))) (cdr (assq :package params))))))) (org-babel-result-cond (cdr (assq :result-params params)) (org-strip-quotes result) (condition-case nil (read (org-babel-lisp-vector-to-list result)) (error 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))))) (defconst org-babel-lisp-output-options-to-slime-targets-table ;; we can't reuse slime-output-targets here ;; as this would make slime a requirement ;; even for sly users '(("output" . common-lisp:*standard-output*) ("errors" . common-lisp:*error-output*) ("trace" . common-lisp:*trace-output*)) "Mapping from output-specifying header-args for Lisp code blocks to output targets of Common Lisp function `swank:eval-and-grab-output'.") (defconst org-babel-lisp-output-options (mapcar #'car org-babel-lisp-output-options-to-slime-targets-table) "Keys from `org-babel-lisp-output-options-to-slime-targets-table'. Must be kept in order of their appearance in that table.") (require 'cl-seq) (eval-when-compile (require 'cl-macs)) (cl-defun org-babel-nsubstitute-multiple (alist cl-seq &key (test #'eql)) "Like NSUBSTITUTE but applies all rules from ALIST." (dolist (rule alist cl-seq) (cl-nsubstitute (cdr rule) (car rule) cl-seq :test test))) (defconst org-babel-lisp-newline-string (make-string 1 10)) (eval-when-compile (require 'subr-x)) (defun org-babel-execute:lisp--multiple-targets-support (body params) "Execute a block of Common Lisp code with Babel. BODY is the contents of the block, as a string. PARAMS is a property list containing the parameters of the block." (require (pcase org-babel-lisp-eval-fn (`slime-eval 'slime) (`sly-eval 'sly))) (org-babel-reassemble-table (let* ((result-params (cdr (assq :result-params params))) (output-targets ;; arguably, it is more natural in org-mode ;; to receive all outputs for :results output ;; so that nothing gets sent to the repl buffer, ;; and emit different outputs to different result blocks ;; but for now we preserve compatibility with the old ways (or (org-babel-nsubstitute-multiple org-babel-lisp-output-options-to-slime-targets-table (cl-delete-duplicates (cl-intersection result-params org-babel-lisp-output-options :test #'string-equal) :test #'string-equal) :test #'string-equal) (list 'common-lisp:values))) (results-alist (with-temp-buffer (insert (org-babel-expand-body:lisp body params)) (funcall org-babel-lisp-eval-fn `(swank:eval-and-grab-output ,(let ((dir (if (assq :dir params) (cdr (assq :dir params)) default-directory))) (format (if dir (format org-babel-lisp-dir-fmt dir) "(progn %s\n)") (buffer-substring-no-properties (point-min) (point-max)))) ',output-targets) (cdr (assq :package params))))) (result (string-join (cl-delete "" (org-babel-nsubstitute-multiple results-alist output-targets :test #'eq) :test #'string-equal) org-babel-lisp-newline-string))) (org-babel-result-cond result-params (org-strip-quotes result) (condition-case nil (read (org-babel-lisp-vector-to-list result)) (error 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))))) (defalias 'org-babel-execute:lisp (if (or (not (featurep 'slime)) ;; relevant update to SLIME is in progress ;; 2.28 is an estimation (version< slime-version "2.28")) 'org-babel-execute:lisp--legacy 'org-babel-execute:lisp--multiple-targets-support)) (defun org-babel-lisp-vector-to-list (results) ;; TODO: better would be to replace #(...) with [...] (replace-regexp-in-string "#(" "(" results)) (provide 'ob-lisp) ;;; ob-lisp.el ends here