1 ;;; ob-ocaml.el --- Babel Functions for Ocaml -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2009-2016 Free Software Foundation, Inc.
5 ;; Author: Eric Schulte
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/>.
26 ;; Org-Babel support for evaluating ocaml source code. This one will
27 ;; be sort of tricky because ocaml programs must be compiled before
28 ;; they can be run, but ocaml code can also be run through an
29 ;; interactive interpreter.
31 ;; For now lets only allow evaluation using the ocaml interpreter.
35 ;; - tuareg-mode :: http://www-rocq.inria.fr/~acohen/tuareg/
40 (eval-when-compile (require 'cl
))
42 (declare-function tuareg-run-caml
"ext:tuareg" ())
43 (declare-function tuareg-run-ocaml
"ext:tuareg" ())
44 (declare-function tuareg-interactive-send-input
"ext:tuareg" ())
45 (declare-function org-trim
"org" (s &optional keep-lead
))
47 (defvar org-babel-tangle-lang-exts
)
48 (add-to-list 'org-babel-tangle-lang-exts
'("ocaml" .
"ml"))
50 (defvar org-babel-default-header-args
:ocaml
'())
52 (defvar org-babel-ocaml-eoe-indicator
"\"org-babel-ocaml-eoe\";;")
53 (defvar org-babel-ocaml-eoe-output
"org-babel-ocaml-eoe")
55 (defcustom org-babel-ocaml-command
"ocaml"
56 "Name of the command for executing Ocaml code."
58 :package-version
'(Org .
"8.0")
62 (defun org-babel-execute:ocaml
(body params
)
63 "Execute a block of Ocaml code with Babel."
64 (let* ((full-body (org-babel-expand-body:generic
66 (org-babel-variable-assignments:ocaml params
)))
67 (session (org-babel-prep-session:ocaml
68 (cdr (assoc :session params
)) params
))
69 (raw (org-babel-comint-with-output
70 (session org-babel-ocaml-eoe-output nil full-body
)
73 (org-babel-chomp full-body
) ";;\n"
74 org-babel-ocaml-eoe-indicator
))
75 (tuareg-interactive-send-input)))
77 (car (let ((re (regexp-quote org-babel-ocaml-eoe-output
)) out
)
78 (delq nil
(mapcar (lambda (line)
80 (progn (setq out nil
) line
)
81 (when (string-match re line
)
82 (progn (setq out t
) nil
))))
83 (mapcar #'org-trim
(reverse raw
)))))))
84 (raw (org-trim clean
))
85 (result-params (cdr (assoc :result-params params
))))
87 "\\(\\(.*\n\\)*\\)[^:\n]+ : \\([^=\n]+\\) =\\(\n\\| \\)\\(.+\\)$"
89 (let ((output (match-string 1 raw
))
90 (type (match-string 3 raw
))
91 (value (match-string 5 raw
)))
92 (org-babel-reassemble-table
93 (org-babel-result-cond result-params
95 ((member "verbatim" result-params
) raw
)
96 ((member "output" result-params
) output
)
99 (org-babel-ocaml-parse-output value type
)
102 (cdr (assoc :colname-names params
)) (cdr (assoc :colnames params
)))
104 (cdr (assoc :rowname-names params
)) (cdr (assoc :rownames params
)))))))
106 (defvar tuareg-interactive-buffer-name
)
107 (defun org-babel-prep-session:ocaml
(session _params
)
108 "Prepare SESSION according to the header arguments in PARAMS."
110 (let ((tuareg-interactive-buffer-name (if (and (not (string= session
"none"))
111 (not (string= session
"default"))
114 tuareg-interactive-buffer-name
)))
115 (save-window-excursion (if (fboundp 'tuareg-run-process-if-needed
)
116 (tuareg-run-process-if-needed org-babel-ocaml-command
)
118 (get-buffer tuareg-interactive-buffer-name
)))
120 (defun org-babel-variable-assignments:ocaml
(params)
121 "Return list of ocaml statements assigning the block's variables."
123 (lambda (pair) (format "let %s = %s;;" (car pair
)
124 (org-babel-ocaml-elisp-to-ocaml (cdr pair
))))
125 (org-babel--get-vars params
)))
127 (defun org-babel-ocaml-elisp-to-ocaml (val)
128 "Return a string of ocaml code which evaluates to VAL."
130 (concat "[|" (mapconcat #'org-babel-ocaml-elisp-to-ocaml val
"; ") "|]")
133 (defun org-babel-ocaml-parse-output (value type
)
134 "Parse VALUE of type TYPE.
135 VALUE and TYPE are string output from an ocaml process."
137 ((string= "string" type
)
138 (org-babel-read value
))
139 ((or (string= "int" type
)
140 (string= "float" type
))
141 (string-to-number value
))
142 ((string-match "list" type
)
143 (org-babel-ocaml-read-list value
))
144 ((string-match "array" type
)
145 (org-babel-ocaml-read-array value
))
146 (t (message "don't recognize type %s" type
) value
)))
148 (defun org-babel-ocaml-read-list (results)
149 "Convert RESULTS into an elisp table or string.
150 If the results look like a table, then convert them into an
151 Emacs-lisp table, otherwise return the results as a string."
152 ;; XXX: This probably does not behave as expected when a semicolon
153 ;; is in a string in a list. The same comment applies to
154 ;; `org-babel-ocaml-read-array' below (with even more failure
156 (org-babel-script-escape (replace-regexp-in-string ";" "," results
)))
158 (defun org-babel-ocaml-read-array (results)
159 "Convert RESULTS into an elisp table or string.
160 If the results look like a table, then convert them into an
161 Emacs-lisp table, otherwise return the results as a string."
162 (org-babel-script-escape
163 (replace-regexp-in-string
164 "\\[|" "[" (replace-regexp-in-string
165 "|\\]" "]" (replace-regexp-in-string
166 "; " "," results
)))))
172 ;;; ob-ocaml.el ends here