lisp/ob-groovy.el

   1 ;;; ob-groovy.el --- org-babel functions for Groovy evaluation
   2
   3 ;; Copyright (C) 2013-2014 Free Software Foundation, Inc.
   4
   5 ;; Author: Miro Bezjak
   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 ;; Currently only supports the external execution.  No session support yet.
  26
  27 ;;; Requirements:
  28 ;; - Groovy language :: http://groovy.codehaus.org
  29 ;; - Groovy major mode :: Can be installed from MELPA or
  30 ;;   https://github.com/russel/Emacs-Groovy-Mode
  31
  32 ;;; Code:
  33 (require 'ob)
  34 (eval-when-compile (require 'cl))
  35
  36 (defvar org-babel-tangle-lang-exts) ;; Autoloaded
  37 (add-to-list 'org-babel-tangle-lang-exts '("groovy" . "groovy"))
  38 (defvar org-babel-default-header-args:groovy '())
  39 (defcustom org-babel-groovy-command "groovy"
  40   "Name of the command to use for executing Groovy code.
  41 May be either a command in the path, like groovy
  42 or an absolute path name, like /usr/local/bin/groovy
  43 parameters may be used, like groovy -v"
  44   :group 'org-babel
  45   :version "24.3"
  46   :type 'string)
  47
  48 (defun org-babel-execute:groovy (body params)
  49   "Execute a block of Groovy code with org-babel.  This function is
  50 called by `org-babel-execute-src-block'"
  51   (message "executing Groovy source code block")
  52   (let* ((processed-params (org-babel-process-params params))
  53          (session (org-babel-groovy-initiate-session (nth 0 processed-params)))
  54          (vars (nth 1 processed-params))
  55          (result-params (nth 2 processed-params))
  56          (result-type (cdr (assoc :result-type params)))
  57          (full-body (org-babel-expand-body:generic
  58                      body params))
  59          (result (org-babel-groovy-evaluate
  60                   session full-body result-type result-params)))
  61
  62     (org-babel-reassemble-table
  63      result
  64      (org-babel-pick-name
  65       (cdr (assoc :colname-names params)) (cdr (assoc :colnames params)))
  66      (org-babel-pick-name
  67       (cdr (assoc :rowname-names params)) (cdr (assoc :rownames params))))))
  68
  69
  70 (defun org-babel-groovy-table-or-string (results)
  71   "Convert RESULTS into an appropriate elisp value.
  72 If RESULTS look like a table, then convert them into an
  73 Emacs-lisp table, otherwise return the results as a string."
  74   (org-babel-script-escape results))
  75
  76
  77 (defvar org-babel-groovy-wrapper-method
  78
  79   "class Runner extends Script {
  80     def out = new PrintWriter(new ByteArrayOutputStream())
  81     def run() { %s }
  82 }
  83
  84 println(new Runner().run())
  85 ")
  86
  87
  88 (defun org-babel-groovy-evaluate
  89   (session body &optional result-type result-params)
  90   "Evaluate BODY in external Groovy process.
  91 If RESULT-TYPE equals 'output then return standard output as a string.
  92 If RESULT-TYPE equals 'value then return the value of the last statement
  93 in BODY as elisp."
  94   (when session (error "Sessions are not (yet) supported for Groovy"))
  95   (case result-type
  96     (output
  97      (let ((src-file (org-babel-temp-file "groovy-")))
  98        (progn (with-temp-file src-file (insert body))
  99               (org-babel-eval
 100                (concat org-babel-groovy-command " " src-file) ""))))
 101     (value
 102      (let* ((src-file (org-babel-temp-file "groovy-"))
 103             (wrapper (format org-babel-groovy-wrapper-method body)))
 104        (with-temp-file src-file (insert wrapper))
 105        (let ((raw (org-babel-eval
 106                    (concat org-babel-groovy-command " " src-file) "")))
 107          (org-babel-result-cond result-params
 108            raw
 109            (org-babel-groovy-table-or-string raw)))))))
 110
 111
 112 (defun org-babel-prep-session:groovy (session params)
 113   "Prepare SESSION according to the header arguments specified in PARAMS."
 114   (error "Sessions are not (yet) supported for Groovy"))
 115
 116 (defun org-babel-groovy-initiate-session (&optional session)
 117   "If there is not a current inferior-process-buffer in SESSION
 118 then create.  Return the initialized session.  Sessions are not
 119 supported in Groovy."
 120   nil)
 121
 122 (provide 'ob-groovy)
 123
 124
 125
 126 ;;; ob-groovy.el ends here