summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBastien Guerry <bzg@altern.org>2011-10-26 23:04:19 +0200
committerBastien Guerry <bzg@altern.org>2011-10-26 23:04:19 +0200
commit44435f3ee3eca7fb91505442ae6ea6a9ffe4725f (patch)
treeefc3b3e4233b2c02723405a75981658950cfb440
parent2d296c12eae655c87fe9f5056c042ff3c532e0aa (diff)
parent71f1c1bed434f42f6890cc27f4ecc69ad732adf7 (diff)
downloadorg-mode-44435f3ee3eca7fb91505442ae6ea6a9ffe4725f.tar.gz
Merge branch 'master' of orgmode.org:org-mode
-rw-r--r--contrib/babel/langs/ob-picolisp.el196
1 files changed, 196 insertions, 0 deletions
diff --git a/contrib/babel/langs/ob-picolisp.el b/contrib/babel/langs/ob-picolisp.el
new file mode 100644
index 0000000..b4d6123
--- /dev/null
+++ b/contrib/babel/langs/ob-picolisp.el
@@ -0,0 +1,196 @@
+;;; ob-picolisp.el --- org-babel functions for picolisp evaluation
+
+;; Copyright (C) 2011 Thorsten Jolitz
+
+;; Authors: Thorsten Jolitz and Eric Schulte
+;; Keywords: literate programming, reproducible research,
+;; Homepage: http://orgmode.org
+;; Version: 1.0
+
+;;;; Contact:
+
+;; For comments, bug reports, questions, etc, you can contact the
+;; first author via email to
+;; (concat "t" "jolitz") at gmail dot com
+;; or post a question in the org-newsgroup (see homepage) with prefix
+;; [babel] in the header.
+
+;; This file is NOT (yet) part of GNU Emacs
+
+;;; License:
+
+;; This program 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, or (at your option)
+;; any later version.
+;;
+;; This program 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; see the file COPYING. If not, write to the
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
+
+;;; Commentary:
+
+;; This library enables the use of PicoLisp in the multi-language
+;; programming framework Org-Babel. PicoLisp is a minimal yet
+;; fascinating lisp dialect and a highly productive application
+;; framework for web-based client-server applications on top of
+;; object-oriented databases. A good way to learn PicoLisp is to first
+;; read Paul Grahams essay "The hundred year language"
+;; (http://www.paulgraham.com/hundred.html) and then study the various
+;; documents and essays published in the PicoLisp wiki
+;; (http://picolisp.com/5000/-2.html). PicoLisp is included in some
+;; GNU/Linux Distributions, and can be downloaded here:
+;; http://software-lab.de/down.html. It ships with a picolisp-mode and
+;; a inferior-picolisp-mode for Emacs (to be found in the /lib/el/
+;; directory).
+
+;; Although it might seem more natural to use Emacs Lisp for most
+;; Lisp-based programming tasks inside Org-Mode, an Emacs library
+;; written in Emacs Lisp, PicoLisp has at least two outstanding
+;; features that make it a valuable addition to Org-Babel:
+
+;; PicoLisp _is_ an object-oriented database with a Prolog-based query
+;; language implemented in PicoLisp (Pilog). Database objects are
+;; first-class members of the language.
+
+;; PicoLisp is an extremely productive framework for the development
+;; of interactive web-applications (on top of a database).
+
+;;; Requirements:
+
+;;; Code:
+(require 'ob)
+(require 'ob-eval)
+
+;; optionally define a file extension for this language
+(add-to-list 'org-babel-tangle-lang-exts '("picolisp" . "l"))
+
+;;; interferes with settings in org-babel buffer?
+;; optionally declare default header arguments for this language
+;; (defvar org-babel-default-header-args:picolisp
+;; '((:colnames . "no"))
+;; "Default arguments for evaluating a picolisp source block.")
+
+(defvar org-babel-picolisp-eoe "org-babel-picolisp-eoe"
+ "String to indicate that evaluation has completed.")
+
+(defcustom org-babel-picolisp-cmd "pil"
+ "Name of command used to evaluate picolisp blocks."
+ :group 'org-babel
+ :type 'string)
+
+(defun org-babel-expand-body:picolisp (body params &optional processed-params)
+ "Expand BODY according to PARAMS, return the expanded body."
+ (let ((vars (mapcar #'cdr (org-babel-get-header params :var)))
+ (result-params (cdr (assoc :result-params params)))
+ (print-level nil) (print-length nil))
+ (if (> (length vars) 0)
+ (concat "(prog (let ("
+ (mapconcat
+ (lambda (var)
+ (format "%S '%S)"
+ (print (car var))
+ (print (cdr var))))
+ vars "\n ")
+ " \n" body ") )")
+ body)))
+
+(defun org-babel-execute:picolisp (body params)
+ "Execute a block of Picolisp code with org-babel. This function is
+ called by `org-babel-execute-src-block'"
+ (message "executing Picolisp source code block")
+ (let* (
+ ;; name of the session or "none"
+ (session-name (cdr (assoc :session params)))
+ ;; set the session if the session variable is non-nil
+ (session (org-babel-picolisp-initiate-session session-name))
+ ;; either OUTPUT or VALUE which should behave as described above
+ (result-type (cdr (assoc :result-type params)))
+ ;; expand the body with `org-babel-expand-body:picolisp'
+ (full-body (org-babel-expand-body:picolisp body params))
+ ;; wrap body appropriately for the type of evaluation and results
+ (wrapped-body
+ (cond
+ ((or (member "code" result-params)
+ (member "pp" result-params))
+ (format "(pretty (out \"/dev/null\" %s))" full-body))
+ ((and (member "value" result-params) (not session))
+ (format "(print (out \"/dev/null\" %s))" full-body))
+ ((member "value" result-params)
+ (format "(out \"/dev/null\" %s)" full-body))
+ (t full-body))))
+
+ ((lambda (result)
+ (if (or (member "verbatim" result-params)
+ (member "scalar" result-params)
+ (member "output" result-params)
+ (member "code" result-params)
+ (member "pp" result-params)
+ (= (length result) 0))
+ result
+ (read result)))
+ (if (not (string= session-name "none"))
+ ;; session based evaluation
+ (mapconcat ;; <- joins the list back together into a single string
+ #'identity
+ (butlast ;; <- remove the org-babel-picolisp-eoe line
+ (delq nil
+ (mapcar
+ (lambda (line)
+ (org-babel-chomp ;; remove trailing newlines
+ (when (> (length line) 0) ;; remove empty lines
+ (cond
+ ;; remove leading "-> " from return values
+ ((and (>= (length line) 3)
+ (string= "-> " (subseq line 0 3)))
+ (subseq line 3))
+ ;; remove trailing "-> <<return-value>>" on the
+ ;; last line of output
+ ((and (member "output" result-params)
+ (string-match-p "->" line))
+ (subseq line 0 (string-match "->" line)))
+ (t line)
+ )
+ ;; (if (and (>= (length line) 3) ;; remove leading "<- "
+ ;; (string= "-> " (subseq line 0 3)))
+ ;; (subseq line 3)
+ ;; line)
+ )))
+ ;; returns a list of the output of each evaluated expression
+ (org-babel-comint-with-output (session org-babel-picolisp-eoe)
+ (insert wrapped-body) (comint-send-input)
+ (insert "'" org-babel-picolisp-eoe) (comint-send-input)))))
+ "\n")
+ ;; external evaluation
+ (let ((script-file (org-babel-temp-file "picolisp-script-")))
+ (with-temp-file script-file
+ (insert (concat wrapped-body "(bye)")))
+ (org-babel-eval
+ (format "%s %s"
+ org-babel-picolisp-cmd
+ (org-babel-process-file-name script-file))
+ ""))))))
+
+(defun org-babel-picolisp-initiate-session (&optional session-name)
+ "If there is not a current inferior-process-buffer in SESSION
+then create. Return the initialized session."
+ (unless (string= session-name "none")
+ (require 'inferior-picolisp)
+ ;; provide a reasonable default session name
+ (let ((session (or session-name "*inferior-picolisp*")))
+ ;; check if we already have a live session by this name
+ (if (org-babel-comint-buffer-livep session)
+ (get-buffer session)
+ (save-window-excursion
+ (run-picolisp org-babel-picolisp-cmd)
+ (rename-buffer session-name)
+ (current-buffer))))))
+
+(provide 'ob-picolisp)
+;;; ob-picolisp.el ends here