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 (defvar org-babel-tangle-lang-exts) ;; Autoloaded
  64
  65 ;; optionally define a file extension for this language
  66 (add-to-list 'org-babel-tangle-lang-exts '("picolisp" . "l"))
  67
  68 ;;; interferes with settings in org-babel buffer?
  69 ;; optionally declare default header arguments for this language
  70 ;; (defvar org-babel-default-header-args:picolisp
  71 ;;   '((:colnames . "no"))
  72 ;;   "Default arguments for evaluating a picolisp source block.")
  73
  74 (defvar org-babel-picolisp-eoe "org-babel-picolisp-eoe"
  75   "String to indicate that evaluation has completed.")
  76
  77 (defcustom org-babel-picolisp-cmd "pil"
  78   "Name of command used to evaluate picolisp blocks."
  79   :group 'org-babel
  80   :version "24.1"
  81   :type 'string)
  82
  83 (defun org-babel-expand-body:picolisp (body params &optional processed-params)
  84   "Expand BODY according to PARAMS, return the expanded body."
  85   (let ((vars (mapcar #'cdr (org-babel-get-header params :var)))
  86         (result-params (cdr (assoc :result-params params)))
  87         (print-level nil) (print-length nil))
  88     (if (> (length vars) 0)
  89         (concat "(prog (let ("
  90                 (mapconcat
  91                  (lambda (var)
  92                    (format "%S '%S)"
  93                            (print (car var))
  94                            (print (cdr var))))
  95                  vars "\n      ")
  96                 " \n" body ") )")
  97       body)))
  98
  99 (defun org-babel-execute:picolisp (body params)
 100   "Execute a block of Picolisp code with org-babel.  This function is
 101  called by `org-babel-execute-src-block'"
 102   (message "executing Picolisp source code block")
 103   (let* (
 104          ;; name of the session or "none"
 105          (session-name (cdr (assoc :session params)))
 106          ;; set the session if the session variable is non-nil
 107          (session (org-babel-picolisp-initiate-session session-name))
 108          ;; either OUTPUT or VALUE which should behave as described above
 109          (result-type (cdr (assoc :result-type params)))
 110          (result-params (cdr (assoc :result-params params)))
 111          ;; expand the body with `org-babel-expand-body:picolisp'
 112          (full-body (org-babel-expand-body:picolisp body params))
 113          ;; wrap body appropriately for the type of evaluation and results
 114          (wrapped-body
 115           (cond
 116            ((or (member "code" result-params)
 117                 (member "pp" result-params))
 118             (format "(pretty (out \"/dev/null\" %s))" full-body))
 119            ((and (member "value" result-params) (not session))
 120             (format "(print (out \"/dev/null\" %s))" full-body))
 121            ((member "value" result-params)
 122             (format "(out \"/dev/null\" %s)" full-body))
 123            (t full-body))))
 124
 125     ((lambda (result)
 126        (org-babel-result-cond result-params
 127          result
 128          (read result)))
 129      (if (not (string= session-name "none"))
 130          ;; session based evaluation
 131          (mapconcat ;; <- joins the list back together into a single string
 132           #'identity
 133           (butlast ;; <- remove the org-babel-picolisp-eoe line
 134            (delq nil
 135                  (mapcar
 136                   (lambda (line)
 137                     (org-babel-chomp ;; remove trailing newlines
 138                      (when (> (length line) 0) ;; remove empty lines
 139                        (cond
 140                         ;; remove leading "-> " from return values
 141                         ((and (>= (length line) 3)
 142                               (string= "-> " (substring line 0 3)))
 143                          (substring line 3))
 144                         ;; remove trailing "-> <<return-value>>" on the
 145                         ;; last line of output
 146                         ((and (member "output" result-params)
 147                               (string-match-p "->" line))
 148                          (substring line 0 (string-match "->" line)))
 149                         (t line)
 150                         )
 151                        ;; (if (and (>= (length line) 3) ;; remove leading "<- "
 152                        ;;          (string= "-> " (substring line 0 3)))
 153                        ;;     (substring line 3)
 154                        ;;   line)
 155                        )))
 156                   ;; returns a list of the output of each evaluated expression
 157                   (org-babel-comint-with-output (session org-babel-picolisp-eoe)
 158                     (insert wrapped-body) (comint-send-input)
 159                     (insert "'" org-babel-picolisp-eoe) (comint-send-input)))))
 160           "\n")
 161        ;; external evaluation
 162        (let ((script-file (org-babel-temp-file "picolisp-script-")))
 163          (with-temp-file script-file
 164            (insert (concat wrapped-body "(bye)")))
 165          (org-babel-eval
 166           (format "%s %s"
 167                   org-babel-picolisp-cmd
 168                   (org-babel-process-file-name script-file))
 169           ""))))))
 170
 171 (defun org-babel-picolisp-initiate-session (&optional session-name)
 172   "If there is not a current inferior-process-buffer in SESSION
 173 then create.  Return the initialized session."
 174   (unless (string= session-name "none")
 175     (require 'inferior-picolisp)
 176     ;; provide a reasonable default session name
 177     (let ((session (or session-name "*inferior-picolisp*")))
 178       ;; check if we already have a live session by this name
 179       (if (org-babel-comint-buffer-livep session)
 180           (get-buffer session)
 181         (save-window-excursion
 182           (run-picolisp org-babel-picolisp-cmd)
 183           (rename-buffer session-name)
 184           (current-buffer))))))
 185
 186 (provide 'ob-picolisp)
 187
 188
 189
 190 ;;; ob-picolisp.el ends here