emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
blob 32f7bd3eb4517c217f2ce81def1539bde0aa8994 5329 bytes (raw)
name: lisp/ob-lisp.el 	 # note: path name is non-authoritative(*)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
;;; ob-lisp.el --- Babel Functions for Common Lisp   -*- lexical-binding: t; -*-

;; Copyright (C) 2009-2024 Free Software Foundation, Inc.

;; Authors: Joel Boehland
;;	 Eric Schulte
;;	 David T. O'Toole <dto@gnu.org>
;; Keywords: literate programming, reproducible research
;; URL: 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 <https://www.gnu.org/licenses/>.

;;; 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
;; - https://common-lisp.net/project/slime/

;;; Code:

(require 'org-macs)
(org-assert-version)

(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 nil)
(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)
         (prologue (cdr (assq :prologue params)))
         (epilogue (cdr (assq :epilogue params)))
	 (body (if (null vars) (org-trim body)
		 (concat "(let ("
			 (mapconcat
			  (lambda (var)
			    (format "(%S (quote %S))" (car var) (cdr var)))
			  vars "\n      ")
			 ")\n"
                         (and prologue (concat prologue "\n"))
                         body
                         (and epilogue (concat "\n" epilogue "\n"))
                         ")"))))
    (if (or (member "code" result-params)
	    (member "pp" result-params))
	(format "(pprint %s)" body)
      body)))

(defun org-babel-execute:lisp (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."
  (let (eval-and-grab-output)
    (pcase org-babel-lisp-eval-fn
      (`slime-eval (org-require-package 'slime "SLIME")
                   (setq eval-and-grab-output 'swank:eval-and-grab-output))
      (`sly-eval (org-require-package 'sly "SLY")
                 (setq eval-and-grab-output 'slynk:eval-and-grab-output)))
    (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
                                `(,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))))))

(defun org-babel-lisp-vector-to-list (results)
  "Convert #(...) values in RESULTS string into a (...) list."
  ;; TODO: better would be to replace #(...) with [...]
  (replace-regexp-in-string "#(" "(" results))

(provide 'ob-lisp)

;;; ob-lisp.el ends here

debug log:

solving 32f7bd3eb ...
found 32f7bd3eb in https://yhetil.org/orgmode/CA+G3_PMxLb63QWNtQoQm0kAp4Dg+AQS8sRvgV_NL97Qx_O_wBg@mail.gmail.com/
found 0e416ad9f in https://git.savannah.gnu.org/cgit/emacs/org-mode.git
preparing index
index prepared:
100644 0e416ad9f43806955f35cea3ceb0140abb90d166	lisp/ob-lisp.el

applying [1/1] https://yhetil.org/orgmode/CA+G3_PMxLb63QWNtQoQm0kAp4Dg+AQS8sRvgV_NL97Qx_O_wBg@mail.gmail.com/
diff --git a/lisp/ob-lisp.el b/lisp/ob-lisp.el
index 0e416ad9f..32f7bd3eb 100644

Checking patch lisp/ob-lisp.el...
Applied patch lisp/ob-lisp.el cleanly.

index at:
100644 32f7bd3eb4517c217f2ce81def1539bde0aa8994	lisp/ob-lisp.el

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).