ob-ocaml.el 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158
  1. ;;; ob-ocaml.el --- org-babel functions for ocaml evaluation
  2. ;; Copyright (C) 2009, 2010 Free Software Foundation, Inc.
  3. ;; Author: Eric Schulte
  4. ;; Keywords: literate programming, reproducible research
  5. ;; Homepage: http://orgmode.org
  6. ;; Version: 7.5
  7. ;; This file is part of GNU Emacs.
  8. ;; GNU Emacs is free software: you can redistribute it and/or modify
  9. ;; it under the terms of the GNU General Public License as published by
  10. ;; the Free Software Foundation, either version 3 of the License, or
  11. ;; (at your option) any later version.
  12. ;; GNU Emacs is distributed in the hope that it will be useful,
  13. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15. ;; GNU General Public License for more details.
  16. ;; You should have received a copy of the GNU General Public License
  17. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  18. ;;; Commentary:
  19. ;; Org-Babel support for evaluating ocaml source code. This one will
  20. ;; be sort of tricky because ocaml programs must be compiled before
  21. ;; they can be run, but ocaml code can also be run through an
  22. ;; interactive interpreter.
  23. ;;
  24. ;; For now lets only allow evaluation using the ocaml interpreter.
  25. ;;; Requirements:
  26. ;; - tuareg-mode :: http://www-rocq.inria.fr/~acohen/tuareg/
  27. ;;; Code:
  28. (require 'ob)
  29. (require 'ob-comint)
  30. (require 'comint)
  31. (eval-when-compile (require 'cl))
  32. (declare-function tuareg-run-caml "ext:tuareg" ())
  33. (declare-function tuareg-interactive-send-input "ext:tuareg" ())
  34. (add-to-list 'org-babel-tangle-lang-exts '("ocaml" . "ml"))
  35. (defvar org-babel-default-header-args:ocaml '())
  36. (defvar org-babel-ocaml-eoe-indicator "\"org-babel-ocaml-eoe\";;")
  37. (defvar org-babel-ocaml-eoe-output "org-babel-ocaml-eoe")
  38. (defun org-babel-execute:ocaml (body params)
  39. "Execute a block of Ocaml code with Babel."
  40. (let* ((vars (mapcar #'cdr (org-babel-get-header params :var)))
  41. (full-body (org-babel-expand-body:generic
  42. body params
  43. (org-babel-variable-assignments:ocaml params)))
  44. (session (org-babel-prep-session:ocaml
  45. (cdr (assoc :session params)) params))
  46. (raw (org-babel-comint-with-output
  47. (session org-babel-ocaml-eoe-output t full-body)
  48. (insert
  49. (concat
  50. (org-babel-chomp full-body)"\n"org-babel-ocaml-eoe-indicator))
  51. (tuareg-interactive-send-input)))
  52. (clean
  53. (car (let ((re (regexp-quote org-babel-ocaml-eoe-output)) out)
  54. (delq nil (mapcar (lambda (line)
  55. (if out
  56. (progn (setq out nil) line)
  57. (when (string-match re line)
  58. (progn (setq out t) nil))))
  59. (mapcar #'org-babel-trim (reverse raw))))))))
  60. (org-babel-reassemble-table
  61. (org-babel-ocaml-parse-output (org-babel-trim clean))
  62. (org-babel-pick-name
  63. (cdr (assoc :colname-names params)) (cdr (assoc :colnames params)))
  64. (org-babel-pick-name
  65. (cdr (assoc :rowname-names params)) (cdr (assoc :rownames params))))))
  66. (defvar tuareg-interactive-buffer-name)
  67. (defun org-babel-prep-session:ocaml (session params)
  68. "Prepare SESSION according to the header arguments in PARAMS."
  69. (require 'tuareg)
  70. (let ((tuareg-interactive-buffer-name (if (and (not (string= session "none"))
  71. (not (string= session "default"))
  72. (stringp session))
  73. session
  74. tuareg-interactive-buffer-name)))
  75. (save-window-excursion (tuareg-run-caml)
  76. (get-buffer tuareg-interactive-buffer-name))))
  77. (defun org-babel-variable-assignments:ocaml (params)
  78. "Return list of ocaml statements assigning the block's variables"
  79. (mapcar
  80. (lambda (pair) (format "let %s = %s;;" (car pair)
  81. (org-babel-ocaml-elisp-to-ocaml (cdr pair))))
  82. (mapcar #'cdr (org-babel-get-header params :var))))
  83. (defun org-babel-ocaml-elisp-to-ocaml (val)
  84. "Return a string of ocaml code which evaluates to VAL."
  85. (if (listp val)
  86. (concat "[|" (mapconcat #'org-babel-ocaml-elisp-to-ocaml val "; ") "|]")
  87. (format "%S" val)))
  88. (defun org-babel-ocaml-parse-output (output)
  89. "Parse OUTPUT.
  90. OUTPUT is string output from an ocaml process."
  91. (let ((regexp "%s = \\(.+\\)$"))
  92. (cond
  93. ((string-match (format regexp "string") output)
  94. (org-babel-read (match-string 1 output)))
  95. ((or (string-match (format regexp "int") output)
  96. (string-match (format regexp "float") output))
  97. (string-to-number (match-string 1 output)))
  98. ((string-match (format regexp "list") output)
  99. (org-babel-ocaml-read-list (match-string 1 output)))
  100. ((string-match (format regexp "array") output)
  101. (org-babel-ocaml-read-array (match-string 1 output)))
  102. (t (message "don't recognize type of %s" output) output))))
  103. (defun org-babel-ocaml-read-list (results)
  104. "Convert RESULTS into an elisp table or string.
  105. If the results look like a table, then convert them into an
  106. Emacs-lisp table, otherwise return the results as a string."
  107. (org-babel-read
  108. (if (and (stringp results) (string-match "^\\[.+\\]$" results))
  109. (org-babel-read
  110. (replace-regexp-in-string
  111. "\\[" "(" (replace-regexp-in-string
  112. "\\]" ")" (replace-regexp-in-string
  113. "; " " " (replace-regexp-in-string
  114. "'" "\"" results)))))
  115. results)))
  116. (defun org-babel-ocaml-read-array (results)
  117. "Convert RESULTS into an elisp table or string.
  118. If the results look like a table, then convert them into an
  119. Emacs-lisp table, otherwise return the results as a string."
  120. (org-babel-read
  121. (if (and (stringp results) (string-match "^\\[.+\\]$" results))
  122. (org-babel-read
  123. (concat
  124. "'" (replace-regexp-in-string
  125. "\\[|" "(" (replace-regexp-in-string
  126. "|\\]" ")" (replace-regexp-in-string
  127. "; " " " (replace-regexp-in-string
  128. "'" "\"" results))))))
  129. results)))
  130. (provide 'ob-ocaml)
  131. ;; arch-tag: 2e815f4d-365e-4d69-b1df-dd17fdd7b7b7
  132. ;;; ob-ocaml.el ends here