1 ;;; ob-haskell.el --- Babel Functions for Haskell -*- 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 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.
31 ;; For now lets only allow evaluation using the haskell interpreter.
35 ;; - haskell-mode :: http://www.iro.umontreal.ca/~monnier/elisp/#haskell-mode
37 ;; - inf-haskell :: http://www.iro.umontreal.ca/~monnier/elisp/#haskell-mode
39 ;; - (optionally) lhs2tex :: http://people.cs.uu.nl/andres/lhs2tex/
45 (declare-function org-remove-indentation
"org" (code &optional n
))
46 (declare-function org-trim
"org" (s &optional keep-lead
))
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
))
52 (defvar org-babel-tangle-lang-exts
)
53 (add-to-list 'org-babel-tangle-lang-exts
'("haskell" .
"hs"))
55 (defvar org-babel-default-header-args
:haskell
56 '((:padlines .
"no")))
58 (defvar org-babel-haskell-lhs2tex-command
"lhs2tex")
60 (defvar org-babel-haskell-eoe
"\"org-babel-haskell-eoe\"")
62 (defun org-babel-execute:haskell
(body params
)
63 "Execute a block of Haskell code."
64 (let* ((session (cdr (assoc :session params
)))
65 (result-type (cdr (assoc :result-type params
)))
66 (full-body (org-babel-expand-body:generic
68 (org-babel-variable-assignments:haskell params
)))
69 (session (org-babel-haskell-initiate-session session params
))
70 (raw (org-babel-comint-with-output
71 (session org-babel-haskell-eoe t full-body
)
72 (insert (org-trim full-body
))
73 (comint-send-input nil t
)
74 (insert org-babel-haskell-eoe
)
75 (comint-send-input nil t
)))
77 #'org-babel-haskell-read-string
78 (cdr (member org-babel-haskell-eoe
79 (reverse (mapcar #'org-trim raw
)))))))
80 (org-babel-reassemble-table
83 (`output
(mapconcat #'identity
(reverse (cdr results
)) "\n"))
84 (`value
(car results
)))))
85 (org-babel-result-cond (cdr (assoc :result-params params
))
86 result
(org-babel-script-escape result
)))
87 (org-babel-pick-name (cdr (assoc :colname-names params
))
88 (cdr (assoc :colname-names params
)))
89 (org-babel-pick-name (cdr (assoc :rowname-names params
))
90 (cdr (assoc :rowname-names params
))))))
92 (defun org-babel-haskell-read-string (string)
93 "Strip \\\"s from around a haskell string."
94 (if (string-match "^\"\\([^\000]+\\)\"$" string
)
95 (match-string 1 string
)
98 (defun org-babel-haskell-initiate-session (&optional _session _params
)
99 "Initiate a haskell session.
100 If there is not a current inferior-process-buffer in SESSION
101 then create one. Return the initialized session."
102 (require 'inf-haskell
)
103 (or (get-buffer "*haskell*")
104 (save-window-excursion (run-haskell) (sleep-for 0.25) (current-buffer))))
106 (defun org-babel-load-session:haskell
(session body params
)
107 "Load BODY into SESSION."
108 (save-window-excursion
109 (let* ((buffer (org-babel-prep-session:haskell session params
))
110 (load-file (concat (org-babel-temp-file "haskell-load-") ".hs")))
112 (insert body
) (write-file load-file
)
113 (haskell-mode) (inferior-haskell-load-file))
116 (defun org-babel-prep-session:haskell
(session params
)
117 "Prepare SESSION according to the header arguments in PARAMS."
118 (save-window-excursion
119 (let ((buffer (org-babel-haskell-initiate-session session
)))
120 (org-babel-comint-in-buffer buffer
123 (comint-send-input nil t
))
124 (org-babel-variable-assignments:haskell params
)))
127 (defun org-babel-variable-assignments:haskell
(params)
128 "Return list of haskell statements assigning the block's variables."
129 (mapcar (lambda (pair)
130 (format "let %s = %s"
132 (org-babel-haskell-var-to-haskell (cdr pair
))))
133 (org-babel--get-vars params
)))
135 (defun org-babel-haskell-var-to-haskell (var)
136 "Convert an elisp value VAR into a haskell variable.
137 The elisp VAR is converted to a string of haskell source code
138 specifying a variable of the same value."
140 (concat "[" (mapconcat #'org-babel-haskell-var-to-haskell var
", ") "]")
143 (defvar org-export-copy-to-kill-ring
)
144 (declare-function org-export-to-file
"ox"
146 &optional async subtreep visible-only body-only
147 ext-plist post-process
))
148 (defun org-babel-haskell-export-to-lhs (&optional arg
)
149 "Export to a .lhs file with all haskell code blocks escaped.
150 When called with a prefix argument the resulting
151 .lhs file will be exported to a .tex file. This function will
152 create two new files, base-name.lhs and base-name.tex where
153 base-name is the name of the current Org file.
155 Note that all standard Babel literate programming
156 constructs (header arguments, no-web syntax etc...) are ignored."
158 (let* ((contents (buffer-string))
160 (concat "^\\([ \t]*\\)#\\+begin_src[ \t]haskell*\\(.*\\)?[\r\n]"
161 "\\([^\000]*?\\)[\r\n][ \t]*#\\+end_src.*"))
162 (base-name (file-name-sans-extension (buffer-file-name)))
163 (tmp-file (org-babel-temp-file "haskell-"))
164 (tmp-org-file (concat tmp-file
".org"))
165 (tmp-tex-file (concat tmp-file
".tex"))
166 (lhs-file (concat base-name
".lhs"))
167 (tex-file (concat base-name
".tex"))
168 (command (concat org-babel-haskell-lhs2tex-command
169 " " (org-babel-process-file-name lhs-file
)
170 " > " (org-babel-process-file-name tex-file
)))
171 (preserve-indentp org-src-preserve-indentation
)
173 ;; escape haskell source-code blocks
174 (with-temp-file tmp-org-file
176 (goto-char (point-min))
177 (while (re-search-forward haskell-regexp nil t
)
178 (save-match-data (setq indentation
(length (match-string 1))))
179 (replace-match (save-match-data
181 "#+begin_export latex\n\\begin{code}\n"
182 (if (or preserve-indentp
183 (string-match "-i" (match-string 2)))
185 (org-remove-indentation (match-string 3)))
186 "\n\\end{code}\n#+end_export\n"))
188 (indent-code-rigidly (match-beginning 0) (match-end 0) indentation
)))
190 ;; export to latex w/org and save as .lhs
192 (find-file tmp-org-file
)
193 ;; Ensure we do not clutter kill ring with incomplete results.
194 (let (org-export-copy-to-kill-ring)
195 (org-export-to-file 'latex tmp-tex-file
))
197 (delete-file tmp-org-file
)
198 (find-file tmp-tex-file
)
199 (goto-char (point-min)) (forward-line 2)
200 (insert "%include polycode.fmt\n")
201 ;; ensure all \begin/end{code} statements start at the first column
202 (while (re-search-forward "^[ \t]+\\\\begin{code}[^\000]+\\\\end{code}" nil t
)
203 (replace-match (save-match-data (org-remove-indentation (match-string 0)))
205 (setq contents
(buffer-string))
206 (save-buffer) (kill-buffer nil
))
207 (delete-file tmp-tex-file
)
208 ;; save org exported latex to a .lhs file
209 (with-temp-file lhs-file
(insert contents
))
212 ;; process .lhs file with lhs2tex
213 (message "running %s" command
) (shell-command command
) (find-file tex-file
))))
215 (provide 'ob-haskell
)
219 ;;; ob-haskell.el ends here