Merge branch 'master' of orgmode.org:org-mode
[org-mode.git] / lisp / ob-picolisp.el
blobe785366c4eac93e58c1fff5e30ef45b5f13442e5
1 ;;; ob-picolisp.el --- org-babel functions for picolisp evaluation
3 ;; Copyright (C) 2010-2013 Free Software Foundation, Inc.
5 ;; Authors: Thorsten Jolitz
6 ;; Eric Schulte
7 ;; Keywords: literate programming, reproducible research
8 ;; Homepage: http://orgmode.org
10 ;; This file is part of GNU Emacs.
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.
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.
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/>.
25 ;;; Commentary:
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).
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:
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.
50 ;; PicoLisp is an extremely productive framework for the development
51 ;; of interactive web-applications (on top of a database).
53 ;;; Requirements:
55 ;;; Code:
56 (require 'ob)
57 (require 'comint)
58 (eval-when-compile (require 'cl))
60 (declare-function run-picolisp "ext:inferior-picolisp" (cmd))
61 (defvar org-babel-tangle-lang-exts) ;; Autoloaded
63 ;; optionally define a file extension for this language
64 (add-to-list 'org-babel-tangle-lang-exts '("picolisp" . "l"))
66 ;;; interferes with settings in org-babel buffer?
67 ;; optionally declare default header arguments for this language
68 ;; (defvar org-babel-default-header-args:picolisp
69 ;; '((:colnames . "no"))
70 ;; "Default arguments for evaluating a picolisp source block.")
72 (defvar org-babel-picolisp-eoe "org-babel-picolisp-eoe"
73 "String to indicate that evaluation has completed.")
75 (defcustom org-babel-picolisp-cmd "pil"
76 "Name of command used to evaluate picolisp blocks."
77 :group 'org-babel
78 :version "24.1"
79 :type 'string)
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)))
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))))
123 ((lambda (result)
124 (org-babel-result-cond result-params
125 result
126 (read result)))
127 (if (not (string= session-name "none"))
128 ;; session based evaluation
129 (mapconcat ;; <- joins the list back together into a single string
130 #'identity
131 (butlast ;; <- remove the org-babel-picolisp-eoe line
132 (delq nil
133 (mapcar
134 (lambda (line)
135 (org-babel-chomp ;; remove trailing newlines
136 (when (> (length line) 0) ;; remove empty lines
137 (cond
138 ;; remove leading "-> " from return values
139 ((and (>= (length line) 3)
140 (string= "-> " (substring line 0 3)))
141 (substring line 3))
142 ;; remove trailing "-> <<return-value>>" on the
143 ;; last line of output
144 ((and (member "output" result-params)
145 (string-match-p "->" line))
146 (substring line 0 (string-match "->" line)))
147 (t line)
149 ;; (if (and (>= (length line) 3) ;; remove leading "<- "
150 ;; (string= "-> " (substring line 0 3)))
151 ;; (substring line 3)
152 ;; line)
154 ;; returns a list of the output of each evaluated expression
155 (org-babel-comint-with-output (session org-babel-picolisp-eoe)
156 (insert wrapped-body) (comint-send-input)
157 (insert "'" org-babel-picolisp-eoe) (comint-send-input)))))
158 "\n")
159 ;; external evaluation
160 (let ((script-file (org-babel-temp-file "picolisp-script-")))
161 (with-temp-file script-file
162 (insert (concat wrapped-body "(bye)")))
163 (org-babel-eval
164 (format "%s %s"
165 org-babel-picolisp-cmd
166 (org-babel-process-file-name script-file))
167 ""))))))
169 (defun org-babel-picolisp-initiate-session (&optional session-name)
170 "If there is not a current inferior-process-buffer in SESSION
171 then create. Return the initialized session."
172 (unless (string= session-name "none")
173 (require 'inferior-picolisp)
174 ;; provide a reasonable default session name
175 (let ((session (or session-name "*inferior-picolisp*")))
176 ;; check if we already have a live session by this name
177 (if (org-babel-comint-buffer-livep session)
178 (get-buffer session)
179 (save-window-excursion
180 (run-picolisp org-babel-picolisp-cmd)
181 (rename-buffer session-name)
182 (current-buffer))))))
184 (provide 'ob-picolisp)
188 ;;; ob-picolisp.el ends here