1 ;;; ob-perl.el --- org-babel functions for perl evaluation
3 ;; Copyright (C) 2009-2013 Free Software Foundation, Inc.
5 ;; Authors: Dan Davison
7 ;; Keywords: literate programming, reproducible research
8 ;; Homepage: http://orgmode.org
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;; Org-Babel support for evaluating perl source code.
31 (eval-when-compile (require 'cl
))
33 (defvar org-babel-tangle-lang-exts
)
34 (add-to-list 'org-babel-tangle-lang-exts
'("perl" .
"pl"))
36 (defvar org-babel-default-header-args
:perl
'())
38 (defvar org-babel-perl-command
"perl"
39 "Name of command to use for executing perl code.")
41 (defun org-babel-execute:perl
(body params
)
42 "Execute a block of Perl code with Babel.
43 This function is called by `org-babel-execute-src-block'."
44 (let* ((session (cdr (assoc :session params
)))
45 (result-params (cdr (assoc :result-params params
)))
46 (result-type (cdr (assoc :result-type params
)))
47 (full-body (org-babel-expand-body:generic
48 body params
(org-babel-variable-assignments:perl params
)))
49 (session (org-babel-perl-initiate-session session
)))
50 (org-babel-reassemble-table
51 (org-babel-perl-evaluate session full-body result-type result-params
)
53 (cdr (assoc :colname-names params
)) (cdr (assoc :colnames params
)))
55 (cdr (assoc :rowname-names params
)) (cdr (assoc :rownames params
))))))
57 (defun org-babel-prep-session:perl
(session params
)
58 "Prepare SESSION according to the header arguments in PARAMS."
59 (error "Sessions are not supported for Perl"))
61 (defun org-babel-variable-assignments:perl
(params)
62 "Return list of perl statements assigning the block's variables."
65 (org-babel-perl--var-to-perl (cdr pair
) (car pair
)))
66 (mapcar #'cdr
(org-babel-get-header params
:var
))))
70 (defvar org-babel-perl-var-wrap
"q(%s)"
71 "Wrapper for variables inserted into Perl code.")
73 (defvar org-babel-perl--lvl
)
74 (defun org-babel-perl--var-to-perl (var &optional varn
)
75 "Convert an elisp value to a perl variable.
76 The elisp value, VAR, is converted to a string of perl source code
77 specifying a var of the same value."
79 (let ((org-babel-perl--lvl 0) (lvar (listp var
)) prefix
)
80 (concat "my $" (symbol-name varn
) "=" (when lvar
"\n")
81 (org-babel-perl--var-to-perl var
)
83 (let ((prefix (make-string (* 2 org-babel-perl--lvl
) ?\
)))
86 (let ((org-babel-perl--lvl (1+ org-babel-perl--lvl
)))
88 (mapconcat #'org-babel-perl--var-to-perl var
"")
90 (concat "q(" (princ var
) ")"))
91 (unless (zerop org-babel-perl--lvl
) ",\n")))))
93 (defvar org-babel-perl-buffers
'(:default . nil
))
95 (defun org-babel-perl-initiate-session (&optional session params
)
96 "Return nil because sessions are not supported by perl."
99 (defvar org-babel-perl-wrapper-method
"{
100 my $babel_sub = sub {
103 open my $BOH, qq(>%s) or die qq(Perl: Could not open output file.$/);
105 my $rv = &$babel_sub();
107 if (qq(ARRAY) eq $rt) {
109 foreach my $rv ( @$rv ) {
111 if (qq(ARRAY) eq $rt) {
112 print join q(|), @$rv;
122 (defvar org-babel-perl-preface nil
)
124 (defvar org-babel-perl-pp-wrapper-method
127 (defun org-babel-perl-evaluate (session ibody
&optional result-type result-params
)
128 "Pass BODY to the Perl process in SESSION.
129 If RESULT-TYPE equals 'output then return a list of the outputs
130 of the statements in BODY, if RESULT-TYPE equals 'value then
131 return the value of the last statement in BODY, as elisp."
132 (when session
(error "Sessions are not supported for Perl"))
133 (let ((body (concat org-babel-perl-preface ibody
)))
135 (output (org-babel-eval org-babel-perl-command body
))
136 (value (let ((tmp-file (org-babel-temp-file "perl-")))
138 org-babel-perl-command
139 (format org-babel-perl-wrapper-method body
140 (org-babel-process-file-name tmp-file
'noquote
)))
141 (org-babel-result-cond result-params
143 (insert-file-contents tmp-file
)
145 (org-babel-import-elisp-from-file tmp-file
'(16))))))))
151 ;;; ob-perl.el ends here