ob-gnuplot.el 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
  1. ;;; ob-gnuplot.el --- Babel Functions for Gnuplot -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2009-2015 Free Software Foundation, Inc.
  3. ;; Author: Eric Schulte
  4. ;; Keywords: literate programming, reproducible research
  5. ;; Homepage: http://orgmode.org
  6. ;; This file is part of GNU Emacs.
  7. ;; GNU Emacs is free software: you can redistribute it and/or modify
  8. ;; it under the terms of the GNU General Public License as published by
  9. ;; the Free Software Foundation, either version 3 of the License, or
  10. ;; (at your option) any later version.
  11. ;; GNU Emacs is distributed in the hope that it will be useful,
  12. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. ;; GNU General Public License for more details.
  15. ;; You should have received a copy of the GNU General Public License
  16. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  17. ;;; Commentary:
  18. ;; Org-Babel support for evaluating gnuplot source code.
  19. ;;
  20. ;; This differs from most standard languages in that
  21. ;;
  22. ;; 1) we are generally only going to return results of type "file"
  23. ;;
  24. ;; 2) we are adding the "file" and "cmdline" header arguments
  25. ;;; Requirements:
  26. ;; - gnuplot :: http://www.gnuplot.info/
  27. ;;
  28. ;; - gnuplot-mode :: http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html
  29. ;;; Code:
  30. (require 'ob)
  31. (eval-when-compile (require 'cl))
  32. (declare-function org-time-string-to-time "org" (s))
  33. (declare-function org-combine-plists "org" (&rest plists))
  34. (declare-function orgtbl-to-generic "org-table" (table params))
  35. (declare-function gnuplot-mode "ext:gnuplot-mode" ())
  36. (declare-function gnuplot-send-string-to-gnuplot "ext:gnuplot-mode" (str txt))
  37. (declare-function gnuplot-send-buffer-to-gnuplot "ext:gnuplot-mode" ())
  38. (defvar org-babel-default-header-args:gnuplot
  39. '((:results . "file") (:exports . "results") (:session . nil))
  40. "Default arguments to use when evaluating a gnuplot source block.")
  41. (defvar org-babel-header-args:gnuplot
  42. '((title . :any)
  43. (lines . :any)
  44. (sets . :any)
  45. (x-labels . :any)
  46. (y-labels . :any)
  47. (timefmt . :any)
  48. (time-ind . :any)
  49. (missing . :any)
  50. (term . :any))
  51. "Gnuplot specific header args.")
  52. (defvar org-babel-gnuplot-timestamp-fmt nil) ; Dynamically scoped.
  53. (defvar *org-babel-gnuplot-missing* nil)
  54. (defcustom *org-babel-gnuplot-terms*
  55. '((eps . "postscript eps"))
  56. "List of file extensions and the associated gnuplot terminal."
  57. :group 'org-babel
  58. :type '(repeat (cons (symbol :tag "File extension")
  59. (string :tag "Gnuplot terminal"))))
  60. (defun org-babel-gnuplot-process-vars (params)
  61. "Extract variables from PARAMS and process the variables.
  62. Dumps all vectors into files and returns an association list
  63. of variable names and the related value to be used in the gnuplot
  64. code."
  65. (let ((*org-babel-gnuplot-missing* (cdr (assoc :missing params))))
  66. (mapcar
  67. (lambda (pair)
  68. (cons
  69. (car pair) ;; variable name
  70. (let* ((val (cdr pair)) ;; variable value
  71. (lp (listp val)))
  72. (if lp
  73. (org-babel-gnuplot-table-to-data
  74. (let* ((first (car val))
  75. (tablep (or (listp first) (symbolp first))))
  76. (if tablep val (mapcar 'list val)))
  77. (org-babel-temp-file "gnuplot-") params)
  78. val))))
  79. (mapcar #'cdr (org-babel-get-header params :var)))))
  80. (defun org-babel-expand-body:gnuplot (body params)
  81. "Expand BODY according to PARAMS, return the expanded body."
  82. (save-window-excursion
  83. (let* ((vars (org-babel-gnuplot-process-vars params))
  84. (out-file (cdr (assoc :file params)))
  85. (prologue (cdr (assoc :prologue params)))
  86. (epilogue (cdr (assoc :epilogue params)))
  87. (term (or (cdr (assoc :term params))
  88. (when out-file
  89. (let ((ext (file-name-extension out-file)))
  90. (or (cdr (assoc (intern (downcase ext))
  91. *org-babel-gnuplot-terms*))
  92. ext)))))
  93. (title (cdr (assoc :title params)))
  94. (lines (cdr (assoc :line params)))
  95. (sets (cdr (assoc :set params)))
  96. (x-labels (cdr (assoc :xlabels params)))
  97. (y-labels (cdr (assoc :ylabels params)))
  98. (timefmt (cdr (assoc :timefmt params)))
  99. (time-ind (or (cdr (assoc :timeind params))
  100. (when timefmt 1)))
  101. (add-to-body (lambda (text) (setq body (concat text "\n" body)))))
  102. ;; append header argument settings to body
  103. (when title (funcall add-to-body (format "set title '%s'" title)))
  104. (when lines (mapc (lambda (el) (funcall add-to-body el)) lines))
  105. (when sets
  106. (mapc (lambda (el) (funcall add-to-body (format "set %s" el))) sets))
  107. (when x-labels
  108. (funcall add-to-body
  109. (format "set xtics (%s)"
  110. (mapconcat (lambda (pair)
  111. (format "\"%s\" %d"
  112. (cdr pair) (car pair)))
  113. x-labels ", "))))
  114. (when y-labels
  115. (funcall add-to-body
  116. (format "set ytics (%s)"
  117. (mapconcat (lambda (pair)
  118. (format "\"%s\" %d"
  119. (cdr pair) (car pair)))
  120. y-labels ", "))))
  121. (when time-ind
  122. (funcall add-to-body "set xdata time")
  123. (funcall add-to-body (concat "set timefmt \""
  124. (or timefmt
  125. "%Y-%m-%d-%H:%M:%S") "\"")))
  126. (when out-file
  127. ;; set the terminal at the top of the block
  128. (funcall add-to-body (format "set output \"%s\"" out-file))
  129. ;; and close the terminal at the bottom of the block
  130. (setq body (concat body "\nset output\n")))
  131. (when term (funcall add-to-body (format "set term %s" term)))
  132. ;; insert variables into code body: this should happen last
  133. ;; placing the variables at the *top* of the code in case their
  134. ;; values are used later
  135. (funcall add-to-body
  136. (mapconcat #'identity
  137. (org-babel-variable-assignments:gnuplot params)
  138. "\n"))
  139. ;; replace any variable names preceded by '$' with the actual
  140. ;; value of the variable
  141. (mapc (lambda (pair)
  142. (setq body (replace-regexp-in-string
  143. (format "\\$%s" (car pair)) (cdr pair) body)))
  144. vars)
  145. (when prologue (funcall add-to-body prologue))
  146. (when epilogue (setq body (concat body "\n" epilogue))))
  147. body))
  148. (defun org-babel-execute:gnuplot (body params)
  149. "Execute a block of Gnuplot code.
  150. This function is called by `org-babel-execute-src-block'."
  151. (require 'gnuplot)
  152. (let ((session (cdr (assoc :session params)))
  153. (result-type (cdr (assoc :results params)))
  154. (body (org-babel-expand-body:gnuplot body params))
  155. output)
  156. (save-window-excursion
  157. ;; evaluate the code body with gnuplot
  158. (if (string= session "none")
  159. (let ((script-file (org-babel-temp-file "gnuplot-script-")))
  160. (with-temp-file script-file
  161. (insert (concat body "\n")))
  162. (message "gnuplot \"%s\"" script-file)
  163. (setq output
  164. (shell-command-to-string
  165. (format
  166. "gnuplot \"%s\""
  167. (org-babel-process-file-name
  168. script-file
  169. (if (member system-type '(cygwin windows-nt ms-dos))
  170. t nil)))))
  171. (message output))
  172. (with-temp-buffer
  173. (insert (concat body "\n"))
  174. (gnuplot-mode)
  175. (gnuplot-send-buffer-to-gnuplot)))
  176. (if (member "output" (split-string result-type))
  177. output
  178. nil)))) ;; signal that output has already been written to file
  179. (defun org-babel-prep-session:gnuplot (session params)
  180. "Prepare SESSION according to the header arguments in PARAMS."
  181. (let* ((session (org-babel-gnuplot-initiate-session session))
  182. (var-lines (org-babel-variable-assignments:gnuplot params)))
  183. (message "%S" session)
  184. (org-babel-comint-in-buffer session
  185. (dolist (var-line var-lines)
  186. (insert var-line)
  187. (comint-send-input nil t)
  188. (org-babel-comint-wait-for-output session)
  189. (sit-for .1)
  190. (goto-char (point-max))))
  191. session))
  192. (defun org-babel-load-session:gnuplot (session body params)
  193. "Load BODY into SESSION."
  194. (save-window-excursion
  195. (let ((buffer (org-babel-prep-session:gnuplot session params)))
  196. (with-current-buffer buffer
  197. (goto-char (process-mark (get-buffer-process (current-buffer))))
  198. (insert (org-babel-chomp body)))
  199. buffer)))
  200. (defun org-babel-variable-assignments:gnuplot (params)
  201. "Return list of gnuplot statements assigning the block's variables."
  202. (mapcar
  203. (lambda (pair) (format "%s = \"%s\"" (car pair) (cdr pair)))
  204. (org-babel-gnuplot-process-vars params)))
  205. (defvar gnuplot-buffer)
  206. (defun org-babel-gnuplot-initiate-session (&optional session _params)
  207. "Initiate a gnuplot session.
  208. If there is not a current inferior-process-buffer in SESSION
  209. then create one. Return the initialized session. The current
  210. `gnuplot-mode' doesn't provide support for multiple sessions."
  211. (require 'gnuplot)
  212. (unless (string= session "none")
  213. (save-window-excursion
  214. (gnuplot-send-string-to-gnuplot "" "line")
  215. gnuplot-buffer)))
  216. (defun org-babel-gnuplot-quote-timestamp-field (s)
  217. "Convert S from timestamp to Unix time and export to gnuplot."
  218. (format-time-string org-babel-gnuplot-timestamp-fmt
  219. (org-time-string-to-time s)))
  220. (defvar org-table-number-regexp)
  221. (defvar org-ts-regexp3)
  222. (defun org-babel-gnuplot-quote-tsv-field (s)
  223. "Quote S for export to gnuplot."
  224. (unless (stringp s)
  225. (setq s (format "%s" s)))
  226. (if (string-match org-table-number-regexp s) s
  227. (if (string-match org-ts-regexp3 s)
  228. (org-babel-gnuplot-quote-timestamp-field s)
  229. (if (zerop (length s))
  230. (or *org-babel-gnuplot-missing* s)
  231. (if (string-match "[ \"]" s)
  232. (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"")
  233. "\"")
  234. s)))))
  235. (defun org-babel-gnuplot-table-to-data (table data-file params)
  236. "Export TABLE to DATA-FILE in a format readable by gnuplot.
  237. Pass PARAMS through to `orgtbl-to-generic' when exporting TABLE."
  238. (with-temp-file data-file
  239. (insert (let ((org-babel-gnuplot-timestamp-fmt
  240. (or (plist-get params :timefmt) "%Y-%m-%d-%H:%M:%S")))
  241. (orgtbl-to-generic
  242. table
  243. (org-combine-plists
  244. '(:sep "\t" :fmt org-babel-gnuplot-quote-tsv-field)
  245. params)))))
  246. data-file)
  247. (provide 'ob-gnuplot)
  248. ;;; ob-gnuplot.el ends here