lisp/ob-picolisp.el

   1 ;;; ob-picolisp.el --- org-babel functions for picolisp evaluation
   2
   3 ;; Copyright (C) 2010-2012  Free Software Foundation, Inc.
   4
   5 ;; Authors: Thorsten Jolitz
   6 ;;       Eric Schulte
   7 ;; Keywords: literate programming, reproducible research
   8 ;; Homepage: http://orgmode.org
   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 ;; This library enables the use of PicoLisp in the multi-language
  28 ;; programming framework Org-Babel. PicoLisp is a minimal yet
  29 ;; fascinating lisp dialect and a highly productive application
  30 ;; framework for web-based client-server applications on top of
  31 ;; object-oriented databases. A good way to learn PicoLisp is to first
  32 ;; read Paul Grahams essay "The hundred year language"
  33 ;; (http://www.paulgraham.com/hundred.html) and then study the various
  34 ;; documents and essays published in the PicoLisp wiki
  35 ;; (http://picolisp.com/5000/-2.html). PicoLisp is included in some
  36 ;; GNU/Linux Distributions, and can be downloaded here:
  37 ;; http://software-lab.de/down.html. It ships with a picolisp-mode and
  38 ;; a inferior-picolisp-mode for Emacs (to be found in the /lib/el/
  39 ;; directory).
  40
  41 ;; Although it might seem more natural to use Emacs Lisp for most
  42 ;; Lisp-based programming tasks inside Org-Mode, an Emacs library
  43 ;; written in Emacs Lisp, PicoLisp has at least two outstanding
  44 ;; features that make it a valuable addition to Org-Babel:
  45
  46 ;; PicoLisp _is_ an object-oriented database with a Prolog-based query
  47 ;; language implemented in PicoLisp (Pilog). Database objects are
  48 ;; first-class members of the language.
  49
  50 ;; PicoLisp is an extremely productive framework for the development
  51 ;; of interactive web-applications (on top of a database).
  52
  53 ;;; Requirements:
  54
  55 ;;; Code:
  56 (require 'ob)
  57 (require 'ob-eval)
  58 (require 'ob-comint)
  59 (require 'comint)
  60 (eval-when-compile (require 'cl))
  61
  62 (declare-function run-picolisp "ext:inferior-picolisp" (cmd))
  63
  64 ;; optionally define a file extension for this language
  65 (add-to-list 'org-babel-tangle-lang-exts '("picolisp" . "l"))
  66
  67 ;;; interferes with settings in org-babel buffer?
  68 ;; optionally declare default header arguments for this language
  69 ;; (defvar org-babel-default-header-args:picolisp
  70 ;;   '((:colnames . "no"))
  71 ;;   "Default arguments for evaluating a picolisp source block.")
  72
  73 (defvar org-babel-picolisp-eoe "org-babel-picolisp-eoe"
  74   "String to indicate that evaluation has completed.")
  75
  76 (defcustom org-babel-picolisp-cmd "pil"
  77   "Name of command used to evaluate picolisp blocks."
  78   :group 'org-babel
  79   :type 'string)
  80
  81 (defun org-babel-expand-body:picolisp (body params &optional processed-params)
  82   "Expand BODY according to PARAMS, return the expanded body."
  83   (let ((vars (mapcar #'cdr (org-babel-get-header params :var)))
  84         (result-params (cdr (assoc :result-params params)))
  85         (print-level nil) (print-length nil))
  86     (if (> (length vars) 0)
  87         (concat "(prog (let ("
  88                 (mapconcat
  89                  (lambda (var)
  90                    (format "%S '%S)"
  91                            (print (car var))
  92                            (print (cdr var))))
  93                  vars "\n      ")
  94                 " \n" body ") )")
  95       body)))
  96
  97 (defun org-babel-execute:picolisp (body params)
  98   "Execute a block of Picolisp code with org-babel.  This function is
  99  called by `org-babel-execute-src-block'"
 100   (message "executing Picolisp source code block")
 101   (let* (
 102          ;; name of the session or "none"
 103          (session-name (cdr (assoc :session params)))
 104          ;; set the session if the session variable is non-nil
 105          (session (org-babel-picolisp-initiate-session session-name))
 106          ;; either OUTPUT or VALUE which should behave as described above
 107          (result-type (cdr (assoc :result-type params)))
 108          (result-params (cdr (assoc :result-params params)))
 109          ;; expand the body with `org-babel-expand-body:picolisp'
 110          (full-body (org-babel-expand-body:picolisp body params))
 111          ;; wrap body appropriately for the type of evaluation and results
 112          (wrapped-body
 113           (cond
 114            ((or (member "code" result-params)
 115                 (member "pp" result-params))
 116             (format "(pretty (out \"/dev/null\" %s))" full-body))
 117            ((and (member "value" result-params) (not session))
 118             (format "(print (out \"/dev/null\" %s))" full-body))
 119            ((member "value" result-params)
 120             (format "(out \"/dev/null\" %s)" full-body))
 121            (t full-body))))
 122
 123     ((lambda (result)
 124        (if (or (member "verbatim" result-params)
 125                (member "scalar" result-params)
 126                (member "output" result-params)
 127                (member "code" result-params)
 128                (member "pp" result-params)
 129                (= (length result) 0))
 130            result
 131          (read result)))
 132      (if (not (string= session-name "none"))
 133          ;; session based evaluation
 134          (mapconcat ;; <- joins the list back together into a single string
 135           #'identity
 136           (butlast ;; <- remove the org-babel-picolisp-eoe line
 137            (delq nil
 138                  (mapcar
 139                   (lambda (line)
 140                     (org-babel-chomp ;; remove trailing newlines
 141                      (when (> (length line) 0) ;; remove empty lines
 142                        (cond
 143                         ;; remove leading "-> " from return values
 144                         ((and (>= (length line) 3)
 145                               (string= "-> " (substring line 0 3)))
 146                          (substring line 3))
 147                         ;; remove trailing "-> <<return-value>>" on the
 148                         ;; last line of output
 149                         ((and (member "output" result-params)
 150                               (string-match-p "->" line))
 151                          (substring line 0 (string-match "->" line)))
 152                         (t line)
 153                         )
 154                        ;; (if (and (>= (length line) 3) ;; remove leading "<- "
 155                        ;;          (string= "-> " (substring line 0 3)))
 156                        ;;     (substring line 3)
 157                        ;;   line)
 158                        )))
 159                   ;; returns a list of the output of each evaluated expression
 160                   (org-babel-comint-with-output (session org-babel-picolisp-eoe)
 161                     (insert wrapped-body) (comint-send-input)
 162                     (insert "'" org-babel-picolisp-eoe) (comint-send-input)))))
 163           "\n")
 164        ;; external evaluation
 165        (let ((script-file (org-babel-temp-file "picolisp-script-")))
 166          (with-temp-file script-file
 167            (insert (concat wrapped-body "(bye)")))
 168          (org-babel-eval
 169           (format "%s %s"
 170                   org-babel-picolisp-cmd
 171                   (org-babel-process-file-name script-file))
 172           ""))))))
 173
 174 (defun org-babel-picolisp-initiate-session (&optional session-name)
 175   "If there is not a current inferior-process-buffer in SESSION
 176 then create.  Return the initialized session."
 177   (unless (string= session-name "none")
 178     (require 'inferior-picolisp)
 179     ;; provide a reasonable default session name
 180     (let ((session (or session-name "*inferior-picolisp*")))
 181       ;; check if we already have a live session by this name
 182       (if (org-babel-comint-buffer-livep session)
 183           (get-buffer session)
 184         (save-window-excursion
 185           (run-picolisp org-babel-picolisp-cmd)
 186           (rename-buffer session-name)
 187           (current-buffer))))))
 188
 189 (provide 'ob-picolisp)
 190
 191
 192
 193 ;;; ob-picolisp.el ends here