lisp/org/ob-scheme.el

   1 ;;; ob-scheme.el --- org-babel functions for Scheme
   2
   3 ;; Copyright (C) 2010-2011 Free Software Foundation
   4
   5 ;; Author: Eric Schulte
   6 ;; Keywords: literate programming, reproducible research, scheme
   7 ;; Homepage: http://orgmode.org
   8 ;; Version: 7.7
   9
  10 ;; This file is part of GNU Emacs.
  11
  12 ;; GNU Emacs is free software: you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation, either version 3 of the License, or
  15 ;; (at your option) any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  24
  25 ;;; Commentary:
  26
  27 ;; Now working with SBCL for both session and external evaluation.
  28 ;;
  29 ;; This certainly isn't optimally robust, but it seems to be working
  30 ;; for the basic use cases.
  31
  32 ;;; Requirements:
  33
  34 ;; - a working scheme implementation
  35 ;;   (e.g. guile http://www.gnu.org/software/guile/guile.html)
  36 ;;
  37 ;; - for session based evaluation cmuscheme.el is required which is
  38 ;;   included in Emacs
  39
  40 ;;; Code:
  41 (require 'ob)
  42 (require 'ob-ref)
  43 (require 'ob-comint)
  44 (require 'ob-eval)
  45 (eval-when-compile (require 'cl))
  46
  47 (declare-function run-scheme "ext:cmuscheme" (cmd))
  48
  49 (defvar org-babel-default-header-args:scheme '()
  50   "Default header arguments for scheme code blocks.")
  51
  52 (defvar org-babel-scheme-eoe "org-babel-scheme-eoe"
  53   "String to indicate that evaluation has completed.")
  54
  55 (defcustom org-babel-scheme-cmd "guile"
  56   "Name of command used to evaluate scheme blocks."
  57   :group 'org-babel
  58   :type 'string)
  59
  60 (defun org-babel-expand-body:scheme (body params)
  61   "Expand BODY according to PARAMS, return the expanded body."
  62   (let ((vars (mapcar #'cdr (org-babel-get-header params :var))))
  63     (if (> (length vars) 0)
  64         (concat "(let ("
  65                 (mapconcat
  66                  (lambda (var) (format "%S" (print `(,(car var) ',(cdr var)))))
  67                  vars "\n      ")
  68                 ")\n" body ")")
  69       body)))
  70
  71 (defvar scheme-program-name)
  72 (defun org-babel-execute:scheme (body params)
  73   "Execute a block of Scheme code with org-babel.
  74 This function is called by `org-babel-execute-src-block'"
  75   (let* ((result-type (cdr (assoc :result-type params)))
  76          (org-babel-scheme-cmd (or (cdr (assoc :scheme params))
  77                                    org-babel-scheme-cmd))
  78          (full-body (org-babel-expand-body:scheme body params)))
  79     (read
  80      (if (not (string= (cdr (assoc :session params)) "none"))
  81          ;; session evaluation
  82          (let ((session (org-babel-prep-session:scheme
  83                          (cdr (assoc :session params)) params)))
  84            (org-babel-comint-with-output
  85                (session (format "%S" org-babel-scheme-eoe) t body)
  86              (mapc
  87               (lambda (line)
  88                 (insert (org-babel-chomp line)) (comint-send-input nil t))
  89               (list body (format "%S" org-babel-scheme-eoe)))))
  90        ;; external evaluation
  91        (let ((script-file (org-babel-temp-file "scheme-script-")))
  92          (with-temp-file script-file
  93            (insert
  94             ;; return the value or the output
  95             (if (string= result-type "value")
  96                 (format "(display %s)" full-body)
  97               full-body)))
  98          (org-babel-eval
  99           (format "%s %s" org-babel-scheme-cmd
 100                   (org-babel-process-file-name script-file)) ""))))))
 101
 102 (defun org-babel-prep-session:scheme (session params)
 103   "Prepare SESSION according to the header arguments specified in PARAMS."
 104   (let* ((session (org-babel-scheme-initiate-session session))
 105          (vars (mapcar #'cdr (org-babel-get-header params :var)))
 106          (var-lines
 107           (mapcar
 108            (lambda (var) (format "%S" (print `(define ,(car var) ',(cdr var)))))
 109            vars)))
 110     (when session
 111       (org-babel-comint-in-buffer session
 112         (sit-for .5) (goto-char (point-max))
 113         (mapc (lambda (var)
 114                 (insert var) (comint-send-input nil t)
 115                 (org-babel-comint-wait-for-output session)
 116                 (sit-for .1) (goto-char (point-max))) var-lines)))
 117     session))
 118
 119 (defun org-babel-scheme-initiate-session (&optional session)
 120   "If there is not a current inferior-process-buffer in SESSION
 121 then create.  Return the initialized session."
 122   (require 'cmuscheme)
 123   (unless (string= session "none")
 124     (let ((session-buffer (save-window-excursion
 125                             (run-scheme org-babel-scheme-cmd)
 126                             (rename-buffer session)
 127                             (current-buffer))))
 128       (if (org-babel-comint-buffer-livep session-buffer)
 129           (progn (sit-for .25) session-buffer)
 130         (sit-for .5)
 131         (org-babel-scheme-initiate-session session)))))
 132
 133 (provide 'ob-scheme)
 134
 135
 136
 137 ;;; ob-scheme.el ends here