Prevent duplicating calls to `org-link-search'
[org-mode.git] / lisp / ob-haskell.el
blob2e1d390f92b0e71462674ea2f340b64d4fde9d51
1 ;;; ob-haskell.el --- org-babel functions for haskell evaluation
3 ;; Copyright (C) 2009-2014 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/>.
24 ;;; Commentary:
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.
33 ;;; Requirements:
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/
41 ;;; Code:
42 (require 'ob)
43 (require 'comint)
44 (eval-when-compile (require 'cl))
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))
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 (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)))
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
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-script-escape result)))
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))))))
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))
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))))
107 (defun org-babel-load-session:haskell (session body params)
108 "Load BODY into SESSION."
109 (save-window-excursion
110 (let* ((buffer (org-babel-prep-session:haskell session params))
111 (load-file (concat (org-babel-temp-file "haskell-load-") ".hs")))
112 (with-temp-buffer
113 (insert body) (write-file load-file)
114 (haskell-mode) (inferior-haskell-load-file))
115 buffer)))
117 (defun org-babel-prep-session:haskell (session params)
118 "Prepare SESSION according to the header arguments in PARAMS."
119 (save-window-excursion
120 (let ((buffer (org-babel-haskell-initiate-session session)))
121 (org-babel-comint-in-buffer buffer
122 (mapc (lambda (line)
123 (insert line)
124 (comint-send-input nil t))
125 (org-babel-variable-assignments:haskell params)))
126 (current-buffer))))
128 (defun org-babel-variable-assignments:haskell (params)
129 "Return list of haskell statements assigning the block's variables."
130 (mapcar (lambda (pair)
131 (format "let %s = %s"
132 (car pair)
133 (org-babel-haskell-var-to-haskell (cdr pair))))
134 (mapcar #'cdr (org-babel-get-header params :var))))
136 (defun org-babel-haskell-var-to-haskell (var)
137 "Convert an elisp value VAR into a haskell variable.
138 The elisp VAR is converted to a string of haskell source code
139 specifying a variable of the same value."
140 (if (listp var)
141 (concat "[" (mapconcat #'org-babel-haskell-var-to-haskell var ", ") "]")
142 (format "%S" var)))
144 (defvar org-export-copy-to-kill-ring)
145 (declare-function org-export-to-file "ox"
146 (backend file
147 &optional async subtreep visible-only body-only ext-plist))
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-mode file.
155 Note that all standard Babel literate programming
156 constructs (header arguments, no-web syntax etc...) are ignored."
157 (interactive "P")
158 (let* ((contents (buffer-string))
159 (haskell-regexp
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)
172 indentation)
173 ;; escape haskell source-code blocks
174 (with-temp-file tmp-org-file
175 (insert contents)
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
180 (concat
181 "#+begin_latex\n\\begin{code}\n"
182 (if (or preserve-indentp
183 (string-match "-i" (match-string 2)))
184 (match-string 3)
185 (org-remove-indentation (match-string 3)))
186 "\n\\end{code}\n#+end_latex\n"))
187 t t)
188 (indent-code-rigidly (match-beginning 0) (match-end 0) indentation)))
189 (save-excursion
190 ;; export to latex w/org and save as .lhs
191 (require 'ox-latex)
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))
196 (kill-buffer nil)
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)))
204 t t))
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))
210 (if (not arg)
211 (find-file lhs-file)
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