ob-perl.el 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119
  1. ;;; ob-perl.el --- org-babel functions for perl evaluation
  2. ;; Copyright (C) 2009-2012 Free Software Foundation, Inc.
  3. ;; Author: Dan Davison
  4. ;; Eric Schulte
  5. ;; Keywords: literate programming, reproducible research
  6. ;; Homepage: http://orgmode.org
  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 perl source code.
  20. ;;; Code:
  21. (require 'ob)
  22. (require 'ob-eval)
  23. (eval-when-compile (require 'cl))
  24. (defvar org-babel-tangle-lang-exts)
  25. (add-to-list 'org-babel-tangle-lang-exts '("perl" . "pl"))
  26. (defvar org-babel-default-header-args:perl '())
  27. (defvar org-babel-perl-command "perl"
  28. "Name of command to use for executing perl code.")
  29. (defun org-babel-execute:perl (body params)
  30. "Execute a block of Perl code with Babel.
  31. This function is called by `org-babel-execute-src-block'."
  32. (let* ((session (cdr (assoc :session params)))
  33. (result-params (cdr (assoc :result-params params)))
  34. (result-type (cdr (assoc :result-type params)))
  35. (full-body (org-babel-expand-body:generic
  36. body params (org-babel-variable-assignments:perl params)))
  37. (session (org-babel-perl-initiate-session session)))
  38. (org-babel-reassemble-table
  39. (org-babel-perl-evaluate session full-body result-type)
  40. (org-babel-pick-name
  41. (cdr (assoc :colname-names params)) (cdr (assoc :colnames params)))
  42. (org-babel-pick-name
  43. (cdr (assoc :rowname-names params)) (cdr (assoc :rownames params))))))
  44. (defun org-babel-prep-session:perl (session params)
  45. "Prepare SESSION according to the header arguments in PARAMS."
  46. (error "Sessions are not supported for Perl."))
  47. (defun org-babel-variable-assignments:perl (params)
  48. "Return list of perl statements assigning the block's variables"
  49. (mapcar
  50. (lambda (pair)
  51. (format "$%s=%s;"
  52. (car pair)
  53. (org-babel-perl-var-to-perl (cdr pair))))
  54. (mapcar #'cdr (org-babel-get-header params :var))))
  55. ;; helper functions
  56. (defun org-babel-perl-var-to-perl (var)
  57. "Convert an elisp value to a perl variable.
  58. The elisp value, VAR, is converted to a string of perl source code
  59. specifying a var of the same value."
  60. (if (listp var)
  61. (concat "[" (mapconcat #'org-babel-perl-var-to-perl var ", ") "]")
  62. (format "%S" var)))
  63. (defvar org-babel-perl-buffers '(:default . nil))
  64. (defun org-babel-perl-initiate-session (&optional session params)
  65. "Return nil because sessions are not supported by perl"
  66. nil)
  67. (defvar org-babel-perl-wrapper-method
  68. "
  69. sub main {
  70. %s
  71. }
  72. @r = main;
  73. open(o, \">%s\");
  74. print o join(\"\\n\", @r), \"\\n\"")
  75. (defvar org-babel-perl-pp-wrapper-method
  76. nil)
  77. (defun org-babel-perl-evaluate (session body &optional result-type)
  78. "Pass BODY to the Perl process in SESSION.
  79. If RESULT-TYPE equals 'output then return a list of the outputs
  80. of the statements in BODY, if RESULT-TYPE equals 'value then
  81. return the value of the last statement in BODY, as elisp."
  82. (when session (error "Sessions are not supported for Perl."))
  83. (case result-type
  84. (output (org-babel-eval org-babel-perl-command body))
  85. (value (let ((tmp-file (org-babel-temp-file "perl-")))
  86. (org-babel-eval
  87. org-babel-perl-command
  88. (format org-babel-perl-wrapper-method body
  89. (org-babel-process-file-name tmp-file 'noquote)))
  90. (org-babel-eval-read-file tmp-file)))))
  91. (provide 'ob-perl)
  92. ;;; ob-perl.el ends here