lisp/ob-gnuplot.el

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