org.texi: Fix typo
[org-mode.git] / lisp / ob-io.el
blobec2cd02cffc7b59c81847d312ea64a5cbe240cee
1 ;;; ob-io.el --- org-babel functions for Io evaluation
3 ;; Copyright (C) 2012-2016 Free Software Foundation, Inc.
5 ;; Author: Andrzej Lichnerowicz
6 ;; Keywords: literate programming, reproducible research
7 ;; Homepage: http://orgmode.org
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
25 ;; Currently only supports the external execution. No session support yet.
26 ;; :results output -- runs in scripting mode
27 ;; :results output repl -- runs in repl mode
29 ;;; Requirements:
30 ;; - Io language :: http://iolanguage.org/
31 ;; - Io major mode :: Can be installed from Io sources
32 ;; https://github.com/stevedekorte/io/blob/master/extras/SyntaxHighlighters/Emacs/io-mode.el
34 ;;; Code:
35 (require 'ob)
36 (eval-when-compile (require 'cl))
38 (defvar org-babel-tangle-lang-exts) ;; Autoloaded
39 (add-to-list 'org-babel-tangle-lang-exts '("io" . "io"))
40 (defvar org-babel-default-header-args:io '())
41 (defvar org-babel-io-command "io"
42 "Name of the command to use for executing Io code.")
44 (defun org-babel-execute:io (body params)
45 "Execute a block of Io code with org-babel. This function is
46 called by `org-babel-execute-src-block'"
47 (message "executing Io source code block")
48 (let* ((processed-params (org-babel-process-params params))
49 (session (org-babel-io-initiate-session (nth 0 processed-params)))
50 (vars (nth 1 processed-params))
51 (result-params (nth 2 processed-params))
52 (result-type (cdr (assoc :result-type params)))
53 (full-body (org-babel-expand-body:generic
54 body params))
55 (result (org-babel-io-evaluate
56 session full-body result-type result-params)))
58 (org-babel-reassemble-table
59 result
60 (org-babel-pick-name
61 (cdr (assoc :colname-names params)) (cdr (assoc :colnames params)))
62 (org-babel-pick-name
63 (cdr (assoc :rowname-names params)) (cdr (assoc :rownames params))))))
65 (defvar org-babel-io-wrapper-method
68 ) asString print
72 (defun org-babel-io-evaluate (session body &optional result-type result-params)
73 "Evaluate BODY in external Io process.
74 If RESULT-TYPE equals `output' then return standard output as a string.
75 If RESULT-TYPE equals `value' then return the value of the last statement
76 in BODY as elisp."
77 (when session (error "Sessions are not (yet) supported for Io"))
78 (case result-type
79 (output
80 (if (member "repl" result-params)
81 (org-babel-eval org-babel-io-command body)
82 (let ((src-file (org-babel-temp-file "io-")))
83 (progn (with-temp-file src-file (insert body))
84 (org-babel-eval
85 (concat org-babel-io-command " " src-file) "")))))
86 (value (let* ((src-file (org-babel-temp-file "io-"))
87 (wrapper (format org-babel-io-wrapper-method body)))
88 (with-temp-file src-file (insert wrapper))
89 (let ((raw (org-babel-eval
90 (concat org-babel-io-command " " src-file) "")))
91 (org-babel-result-cond result-params
92 raw
93 (org-babel-script-escape raw)))))))
96 (defun org-babel-prep-session:io (session params)
97 "Prepare SESSION according to the header arguments specified in PARAMS."
98 (error "Sessions are not (yet) supported for Io"))
100 (defun org-babel-io-initiate-session (&optional session)
101 "If there is not a current inferior-process-buffer in SESSION
102 then create. Return the initialized session. Sessions are not
103 supported in Io."
104 nil)
106 (provide 'ob-io)
110 ;;; ob-io.el ends here