Commit | Line | Data |
---|---|---|
86fbb8ca CD |
1 | ;;; ob-haskell.el --- org-babel functions for haskell evaluation |
2 | ||
ba318903 | 3 | ;; Copyright (C) 2009-2014 Free Software Foundation, Inc. |
86fbb8ca CD |
4 | |
5 | ;; Author: Eric Schulte | |
6 | ;; Keywords: literate programming, reproducible research | |
7 | ;; Homepage: http://orgmode.org | |
86fbb8ca CD |
8 | |
9 | ;; This file is part of GNU Emacs. | |
10 | ||
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. | |
15 | ||
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. | |
20 | ||
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/>. | |
23 | ||
24 | ;;; Commentary: | |
25 | ||
26 | ;; Org-Babel support for evaluating haskell source code. This one will | |
27 | ;; be sort of tricky because haskell programs must be compiled before | |
28 | ;; they can be run, but haskell code can also be run through an | |
29 | ;; interactive interpreter. | |
30 | ;; | |
e66ba1df | 31 | ;; For now lets only allow evaluation using the haskell interpreter. |
86fbb8ca CD |
32 | |
33 | ;;; Requirements: | |
34 | ||
35 | ;; - haskell-mode :: http://www.iro.umontreal.ca/~monnier/elisp/#haskell-mode | |
36 | ;; | |
37 | ;; - inf-haskell :: http://www.iro.umontreal.ca/~monnier/elisp/#haskell-mode | |
38 | ;; | |
39 | ;; - (optionally) lhs2tex :: http://people.cs.uu.nl/andres/lhs2tex/ | |
40 | ||
41 | ;;; Code: | |
42 | (require 'ob) | |
86fbb8ca CD |
43 | (require 'comint) |
44 | (eval-when-compile (require 'cl)) | |
45 | ||
46 | (declare-function org-remove-indentation "org" (code &optional n)) | |
47 | (declare-function haskell-mode "ext:haskell-mode" ()) | |
48 | (declare-function run-haskell "ext:inf-haskell" (&optional arg)) | |
49 | (declare-function inferior-haskell-load-file | |
50 | "ext:inf-haskell" (&optional reload)) | |
51 | ||
3ab2c837 | 52 | (defvar org-babel-tangle-lang-exts) |
86fbb8ca CD |
53 | (add-to-list 'org-babel-tangle-lang-exts '("haskell" . "hs")) |
54 | ||
271672fa BG |
55 | (defvar org-babel-default-header-args:haskell |
56 | '((:padlines . "no"))) | |
86fbb8ca CD |
57 | |
58 | (defvar org-babel-haskell-lhs2tex-command "lhs2tex") | |
59 | ||
60 | (defvar org-babel-haskell-eoe "\"org-babel-haskell-eoe\"") | |
61 | ||
86fbb8ca CD |
62 | (defun org-babel-execute:haskell (body params) |
63 | "Execute a block of Haskell code." | |
afe98dfa CD |
64 | (let* ((session (cdr (assoc :session params))) |
65 | (vars (mapcar #'cdr (org-babel-get-header params :var))) | |
66 | (result-type (cdr (assoc :result-type params))) | |
67 | (full-body (org-babel-expand-body:generic | |
68 | body params | |
69 | (org-babel-variable-assignments:haskell params))) | |
86fbb8ca CD |
70 | (session (org-babel-haskell-initiate-session session params)) |
71 | (raw (org-babel-comint-with-output | |
72 | (session org-babel-haskell-eoe t full-body) | |
73 | (insert (org-babel-trim full-body)) | |
74 | (comint-send-input nil t) | |
75 | (insert org-babel-haskell-eoe) | |
76 | (comint-send-input nil t))) | |
77 | (results (mapcar | |
78 | #'org-babel-haskell-read-string | |
79 | (cdr (member org-babel-haskell-eoe | |
80 | (reverse (mapcar #'org-babel-trim raw))))))) | |
81 | (org-babel-reassemble-table | |
666ffc7e SM |
82 | (let ((result |
83 | (case result-type | |
84 | (output (mapconcat #'identity (reverse (cdr results)) "\n")) | |
85 | (value (car results))))) | |
86 | (org-babel-result-cond (cdr (assoc :result-params params)) | |
87 | result (org-babel-haskell-table-or-string result))) | |
afe98dfa CD |
88 | (org-babel-pick-name (cdr (assoc :colname-names params)) |
89 | (cdr (assoc :colname-names params))) | |
90 | (org-babel-pick-name (cdr (assoc :rowname-names params)) | |
91 | (cdr (assoc :rowname-names params)))))) | |
86fbb8ca CD |
92 | |
93 | (defun org-babel-haskell-read-string (string) | |
94 | "Strip \\\"s from around a haskell string." | |
95 | (if (string-match "^\"\\([^\000]+\\)\"$" string) | |
96 | (match-string 1 string) | |
97 | string)) | |
98 | ||
99 | (defun org-babel-haskell-initiate-session (&optional session params) | |
100 | "Initiate a haskell session. | |
101 | If there is not a current inferior-process-buffer in SESSION | |
102 | then create one. Return the initialized session." | |
103 | (require 'inf-haskell) | |
104 | (or (get-buffer "*haskell*") | |
105 | (save-window-excursion (run-haskell) (sleep-for 0.25) (current-buffer)))) | |
106 | ||
afe98dfa | 107 | (defun org-babel-load-session:haskell (session body params) |
86fbb8ca CD |
108 | "Load BODY into SESSION." |
109 | (save-window-excursion | |
afe98dfa CD |
110 | (let* ((buffer (org-babel-prep-session:haskell session params)) |
111 | (load-file (concat (org-babel-temp-file "haskell-load-") ".hs"))) | |
86fbb8ca CD |
112 | (with-temp-buffer |
113 | (insert body) (write-file load-file) | |
114 | (haskell-mode) (inferior-haskell-load-file)) | |
115 | buffer))) | |
116 | ||
afe98dfa | 117 | (defun org-babel-prep-session:haskell (session params) |
86fbb8ca CD |
118 | "Prepare SESSION according to the header arguments in PARAMS." |
119 | (save-window-excursion | |
afe98dfa | 120 | (let ((buffer (org-babel-haskell-initiate-session session))) |
86fbb8ca | 121 | (org-babel-comint-in-buffer buffer |
afe98dfa CD |
122 | (mapc (lambda (line) |
123 | (insert line) | |
124 | (comint-send-input nil t)) | |
125 | (org-babel-variable-assignments:haskell params))) | |
86fbb8ca CD |
126 | (current-buffer)))) |
127 | ||
afe98dfa | 128 | (defun org-babel-variable-assignments:haskell (params) |
8223b1d2 | 129 | "Return list of haskell statements assigning the block's variables." |
afe98dfa CD |
130 | (mapcar (lambda (pair) |
131 | (format "let %s = %s" | |
132 | (car pair) | |
133 | (org-babel-haskell-var-to-haskell (cdr pair)))) | |
8223b1d2 | 134 | (mapcar #'cdr (org-babel-get-header params :var)))) |
afe98dfa | 135 | |
86fbb8ca CD |
136 | (defun org-babel-haskell-table-or-string (results) |
137 | "Convert RESULTS to an Emacs-lisp table or string. | |
138 | If RESULTS look like a table, then convert them into an | |
139 | Emacs-lisp table, otherwise return the results as a string." | |
acedf35c | 140 | (org-babel-script-escape results)) |
86fbb8ca CD |
141 | |
142 | (defun org-babel-haskell-var-to-haskell (var) | |
143 | "Convert an elisp value VAR into a haskell variable. | |
144 | The elisp VAR is converted to a string of haskell source code | |
145 | specifying a variable of the same value." | |
146 | (if (listp var) | |
147 | (concat "[" (mapconcat #'org-babel-haskell-var-to-haskell var ", ") "]") | |
148 | (format "%S" var))) | |
149 | ||
150 | (defvar org-src-preserve-indentation) | |
666ffc7e | 151 | (defvar org-export-copy-to-kill-ring) |
271672fa BG |
152 | (declare-function org-export-to-file "ox" |
153 | (backend file | |
154 | &optional async subtreep visible-only body-only ext-plist)) | |
86fbb8ca CD |
155 | (defun org-babel-haskell-export-to-lhs (&optional arg) |
156 | "Export to a .lhs file with all haskell code blocks escaped. | |
157 | When called with a prefix argument the resulting | |
158 | .lhs file will be exported to a .tex file. This function will | |
159 | create two new files, base-name.lhs and base-name.tex where | |
160 | base-name is the name of the current org-mode file. | |
161 | ||
162 | Note that all standard Babel literate programming | |
163 | constructs (header arguments, no-web syntax etc...) are ignored." | |
164 | (interactive "P") | |
165 | (let* ((contents (buffer-string)) | |
166 | (haskell-regexp | |
167 | (concat "^\\([ \t]*\\)#\\+begin_src[ \t]haskell*\\(.*\\)?[\r\n]" | |
168 | "\\([^\000]*?\\)[\r\n][ \t]*#\\+end_src.*")) | |
169 | (base-name (file-name-sans-extension (buffer-file-name))) | |
afe98dfa | 170 | (tmp-file (org-babel-temp-file "haskell-")) |
86fbb8ca CD |
171 | (tmp-org-file (concat tmp-file ".org")) |
172 | (tmp-tex-file (concat tmp-file ".tex")) | |
173 | (lhs-file (concat base-name ".lhs")) | |
174 | (tex-file (concat base-name ".tex")) | |
afe98dfa CD |
175 | (command (concat org-babel-haskell-lhs2tex-command |
176 | " " (org-babel-process-file-name lhs-file) | |
177 | " > " (org-babel-process-file-name tex-file))) | |
86fbb8ca CD |
178 | (preserve-indentp org-src-preserve-indentation) |
179 | indentation) | |
180 | ;; escape haskell source-code blocks | |
181 | (with-temp-file tmp-org-file | |
182 | (insert contents) | |
183 | (goto-char (point-min)) | |
184 | (while (re-search-forward haskell-regexp nil t) | |
185 | (save-match-data (setq indentation (length (match-string 1)))) | |
186 | (replace-match (save-match-data | |
187 | (concat | |
188 | "#+begin_latex\n\\begin{code}\n" | |
189 | (if (or preserve-indentp | |
190 | (string-match "-i" (match-string 2))) | |
191 | (match-string 3) | |
192 | (org-remove-indentation (match-string 3))) | |
193 | "\n\\end{code}\n#+end_latex\n")) | |
194 | t t) | |
195 | (indent-code-rigidly (match-beginning 0) (match-end 0) indentation))) | |
196 | (save-excursion | |
197 | ;; export to latex w/org and save as .lhs | |
271672fa BG |
198 | (require 'ox-latex) |
199 | (find-file tmp-org-file) | |
200 | ;; Ensure we do not clutter kill ring with incomplete results. | |
201 | (let (org-export-copy-to-kill-ring) | |
202 | (org-export-to-file 'latex tmp-tex-file)) | |
3ab2c837 | 203 | (kill-buffer nil) |
86fbb8ca CD |
204 | (delete-file tmp-org-file) |
205 | (find-file tmp-tex-file) | |
206 | (goto-char (point-min)) (forward-line 2) | |
207 | (insert "%include polycode.fmt\n") | |
208 | ;; ensure all \begin/end{code} statements start at the first column | |
209 | (while (re-search-forward "^[ \t]+\\\\begin{code}[^\000]+\\\\end{code}" nil t) | |
210 | (replace-match (save-match-data (org-remove-indentation (match-string 0))) | |
211 | t t)) | |
212 | (setq contents (buffer-string)) | |
3ab2c837 | 213 | (save-buffer) (kill-buffer nil)) |
86fbb8ca CD |
214 | (delete-file tmp-tex-file) |
215 | ;; save org exported latex to a .lhs file | |
216 | (with-temp-file lhs-file (insert contents)) | |
217 | (if (not arg) | |
218 | (find-file lhs-file) | |
219 | ;; process .lhs file with lhs2tex | |
220 | (message "running %s" command) (shell-command command) (find-file tex-file)))) | |
221 | ||
222 | (provide 'ob-haskell) | |
223 | ||
5b409b39 | 224 | |
86fbb8ca CD |
225 | |
226 | ;;; ob-haskell.el ends here |