2015-10-26 00:56:00 +00:00
|
|
|
;;; ob-perl.el --- Babel Functions for Perl -*- lexical-binding: t; -*-
|
2009-11-07 03:05:58 +00:00
|
|
|
|
2016-01-09 22:12:03 +00:00
|
|
|
;; Copyright (C) 2009-2016 Free Software Foundation, Inc.
|
2009-11-07 03:05:58 +00:00
|
|
|
|
2012-04-01 22:53:28 +00:00
|
|
|
;; Authors: Dan Davison
|
|
|
|
;; Eric Schulte
|
2009-11-07 03:05:58 +00:00
|
|
|
;; Keywords: literate programming, reproducible research
|
|
|
|
;; Homepage: http://orgmode.org
|
|
|
|
|
2010-06-25 16:32:35 +00:00
|
|
|
;; This file is part of GNU Emacs.
|
2009-11-07 03:05:58 +00:00
|
|
|
|
2010-06-25 16:32:35 +00:00
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
2009-11-07 03:05:58 +00:00
|
|
|
;; it under the terms of the GNU General Public License as published by
|
2010-06-25 16:32:35 +00:00
|
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
|
|
;; (at your option) any later version.
|
|
|
|
|
|
|
|
;; GNU Emacs is distributed in the hope that it will be useful,
|
2009-11-07 03:05:58 +00:00
|
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
;; GNU General Public License for more details.
|
2010-06-25 16:32:35 +00:00
|
|
|
|
2009-11-07 03:05:58 +00:00
|
|
|
;; You should have received a copy of the GNU General Public License
|
2010-06-25 16:32:35 +00:00
|
|
|
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
|
2009-11-07 03:05:58 +00:00
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
|
|
|
;; Org-Babel support for evaluating perl source code.
|
|
|
|
|
|
|
|
;;; Code:
|
2010-06-11 23:02:42 +00:00
|
|
|
(require 'ob)
|
2009-11-07 03:05:58 +00:00
|
|
|
|
2011-06-21 22:34:41 +00:00
|
|
|
(defvar org-babel-tangle-lang-exts)
|
2010-06-17 17:21:14 +00:00
|
|
|
(add-to-list 'org-babel-tangle-lang-exts '("perl" . "pl"))
|
|
|
|
|
2010-06-25 17:12:54 +00:00
|
|
|
(defvar org-babel-default-header-args:perl '())
|
|
|
|
|
2010-07-04 20:38:24 +00:00
|
|
|
(defvar org-babel-perl-command "perl"
|
|
|
|
"Name of command to use for executing perl code.")
|
|
|
|
|
2009-11-07 03:05:58 +00:00
|
|
|
(defun org-babel-execute:perl (body params)
|
2010-07-13 23:20:08 +00:00
|
|
|
"Execute a block of Perl code with Babel.
|
|
|
|
This function is called by `org-babel-execute-src-block'."
|
2010-10-21 11:52:24 +00:00
|
|
|
(let* ((session (cdr (assoc :session params)))
|
|
|
|
(result-params (cdr (assoc :result-params params)))
|
|
|
|
(result-type (cdr (assoc :result-type params)))
|
2010-10-21 11:26:06 +00:00
|
|
|
(full-body (org-babel-expand-body:generic
|
|
|
|
body params (org-babel-variable-assignments:perl params)))
|
2012-08-11 17:10:44 +00:00
|
|
|
(session (org-babel-perl-initiate-session session)))
|
2010-04-19 01:06:34 +00:00
|
|
|
(org-babel-reassemble-table
|
2013-02-24 22:13:07 +00:00
|
|
|
(org-babel-perl-evaluate session full-body result-type result-params)
|
2010-07-04 20:38:24 +00:00
|
|
|
(org-babel-pick-name
|
2010-10-21 11:52:24 +00:00
|
|
|
(cdr (assoc :colname-names params)) (cdr (assoc :colnames params)))
|
2010-07-04 20:38:24 +00:00
|
|
|
(org-babel-pick-name
|
2010-10-21 11:52:24 +00:00
|
|
|
(cdr (assoc :rowname-names params)) (cdr (assoc :rownames params))))))
|
2009-11-07 03:05:58 +00:00
|
|
|
|
2015-10-26 00:56:00 +00:00
|
|
|
(defun org-babel-prep-session:perl (_session _params)
|
2010-07-13 23:20:08 +00:00
|
|
|
"Prepare SESSION according to the header arguments in PARAMS."
|
2012-09-28 15:47:48 +00:00
|
|
|
(error "Sessions are not supported for Perl"))
|
2009-11-07 03:05:58 +00:00
|
|
|
|
2010-10-21 11:26:06 +00:00
|
|
|
(defun org-babel-variable-assignments:perl (params)
|
2012-07-30 08:08:15 +00:00
|
|
|
"Return list of perl statements assigning the block's variables."
|
2010-10-21 11:26:06 +00:00
|
|
|
(mapcar
|
|
|
|
(lambda (pair)
|
2013-02-24 22:13:07 +00:00
|
|
|
(org-babel-perl--var-to-perl (cdr pair) (car pair)))
|
2015-10-29 19:26:11 +00:00
|
|
|
(org-babel--get-vars params)))
|
2010-10-21 11:26:06 +00:00
|
|
|
|
2009-11-07 03:05:58 +00:00
|
|
|
;; helper functions
|
|
|
|
|
2013-02-24 16:48:31 +00:00
|
|
|
(defvar org-babel-perl-var-wrap "q(%s)"
|
|
|
|
"Wrapper for variables inserted into Perl code.")
|
|
|
|
|
2013-02-24 22:13:07 +00:00
|
|
|
(defvar org-babel-perl--lvl)
|
|
|
|
(defun org-babel-perl--var-to-perl (var &optional varn)
|
2010-07-13 23:20:08 +00:00
|
|
|
"Convert an elisp value to a perl variable.
|
|
|
|
The elisp value, VAR, is converted to a string of perl source code
|
2009-11-07 03:05:58 +00:00
|
|
|
specifying a var of the same value."
|
2013-02-24 22:13:07 +00:00
|
|
|
(if varn
|
2015-10-26 00:56:00 +00:00
|
|
|
(let ((org-babel-perl--lvl 0) (lvar (listp var)))
|
2013-02-24 22:13:07 +00:00
|
|
|
(concat "my $" (symbol-name varn) "=" (when lvar "\n")
|
|
|
|
(org-babel-perl--var-to-perl var)
|
|
|
|
";\n"))
|
|
|
|
(let ((prefix (make-string (* 2 org-babel-perl--lvl) ?\ )))
|
|
|
|
(concat prefix
|
|
|
|
(if (listp var)
|
|
|
|
(let ((org-babel-perl--lvl (1+ org-babel-perl--lvl)))
|
|
|
|
(concat "[\n"
|
|
|
|
(mapconcat #'org-babel-perl--var-to-perl var "")
|
|
|
|
prefix "]"))
|
2013-03-25 00:25:42 +00:00
|
|
|
(format "q(%s)" var))
|
2013-02-24 22:13:07 +00:00
|
|
|
(unless (zerop org-babel-perl--lvl) ",\n")))))
|
2009-11-07 03:05:58 +00:00
|
|
|
|
|
|
|
(defvar org-babel-perl-buffers '(:default . nil))
|
|
|
|
|
2015-10-26 00:56:00 +00:00
|
|
|
(defun org-babel-perl-initiate-session (&optional _session _params)
|
2012-07-30 08:08:15 +00:00
|
|
|
"Return nil because sessions are not supported by perl."
|
2012-08-11 17:10:44 +00:00
|
|
|
nil)
|
2009-11-07 03:05:58 +00:00
|
|
|
|
2013-02-24 22:13:07 +00:00
|
|
|
(defvar org-babel-perl-wrapper-method "{
|
|
|
|
my $babel_sub = sub {
|
|
|
|
%s
|
|
|
|
};
|
|
|
|
open my $BOH, qq(>%s) or die qq(Perl: Could not open output file.$/);
|
|
|
|
my $rv = &$babel_sub();
|
|
|
|
my $rt = ref $rv;
|
2013-04-17 19:38:21 +00:00
|
|
|
select $BOH;
|
2013-02-24 22:13:07 +00:00
|
|
|
if (qq(ARRAY) eq $rt) {
|
|
|
|
local $\\=$/;
|
2013-04-07 09:20:42 +00:00
|
|
|
local $,=qq(\t);
|
2013-02-24 22:13:07 +00:00
|
|
|
foreach my $rv ( @$rv ) {
|
|
|
|
my $rt = ref $rv;
|
|
|
|
if (qq(ARRAY) eq $rt) {
|
2013-04-07 09:20:42 +00:00
|
|
|
print @$rv;
|
2013-02-24 22:13:07 +00:00
|
|
|
} else {
|
|
|
|
print $rv;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
print $rv;
|
|
|
|
}
|
|
|
|
}")
|
|
|
|
|
|
|
|
(defvar org-babel-perl-preface nil)
|
2009-11-07 03:05:58 +00:00
|
|
|
|
|
|
|
(defvar org-babel-perl-pp-wrapper-method
|
|
|
|
nil)
|
|
|
|
|
2013-02-24 22:13:07 +00:00
|
|
|
(defun org-babel-perl-evaluate (session ibody &optional result-type result-params)
|
2010-07-13 23:20:08 +00:00
|
|
|
"Pass BODY to the Perl process in SESSION.
|
2015-09-21 04:24:12 +00:00
|
|
|
If RESULT-TYPE equals `output' then return a list of the outputs
|
|
|
|
of the statements in BODY, if RESULT-TYPE equals `value' then
|
2010-07-13 23:20:08 +00:00
|
|
|
return the value of the last statement in BODY, as elisp."
|
2012-09-28 15:47:48 +00:00
|
|
|
(when session (error "Sessions are not supported for Perl"))
|
2013-04-17 19:38:21 +00:00
|
|
|
(let* ((body (concat org-babel-perl-preface ibody))
|
|
|
|
(tmp-file (org-babel-temp-file "perl-"))
|
|
|
|
(tmp-babel-file (org-babel-process-file-name
|
|
|
|
tmp-file 'noquote)))
|
Backport changes from Emacs revs 115081 and 115082
2013-11-12 Stefan Monnier <monnier@iro.umontreal.ca>
Address some byte-compiler warnings.
* ob-abc.el (org-babel-expand-body:abc): Use dolist.
(org-babel-execute:abc): Fix regexp quoting.
* ob-calc.el (org--var-syms): Rename from `var-syms'.
* ob-lilypond.el (ly-compile-lilyfile): Remove redundant let-binding.
* ob-table.el (sbe): Move debug declaration.
* org-clock.el (org--msg-extra): Rename from `msg-extra'.
* org.el (org-version): Avoid var name starting with _.
(org-inhibit-startup, org-called-with-limited-levels)
(org-link-search-inhibit-query, org-time-was-given)
(org-end-time-was-given, org-def, org-defdecode, org-with-time):
* org-colview.el (org-agenda-overriding-columns-format):
* org-agenda.el (org-agenda-multi, org-depend-tag-blocked)
(org-agenda-show-log-scoped):
* ob-python.el (py-which-bufname, python-shell-buffer-name):
* ob-haskell.el (org-export-copy-to-kill-ring):
* ob-exp.el (org-link-search-inhibit-query):
* ob-R.el (ess-eval-visibly-p):
* ob-core.el (org-src-window-setup): Declare before use.
(org-babel-expand-noweb-references): Remove unused `blocks-in-buffer'.
* ox-odt.el (org-odt-hfy-face-to-css):
* org-src.el (org-src-associate-babel-session, org-src-get-lang-mode):
* org-bibtex.el (org-bibtex-get, org-bibtex-ask, org-bibtex)
(org-bibtex-check):
* ob-tangle.el (org-babel-tangle, org-babel-spec-to-string)
(org-babel-tangle-single-block, org-babel-tangle-comment-links):
* ob-table.el (sbe):
* ob-sqlite.el (org-babel-sqlite-expand-vars):
* ob-sql.el (org-babel-sql-expand-vars):
* ob-shen.el (org-babel-execute:shen):
* ob-sh.el (org-babel-execute:sh, org-babel-sh-evaluate):
* ob-scala.el (org-babel-scala-evaluate):
* ob-ruby.el (org-babel-ruby-table-or-string)
(org-babel-ruby-evaluate):
* ob-python.el (org-babel-python-table-or-string)
(org-babel-python-evaluate-external-process)
(org-babel-python-evaluate-session):
* ob-picolisp.el (org-babel-execute:picolisp):
* ob-perl.el (org-babel-perl-evaluate):
* ob-maxima.el (org-babel-execute:maxima):
* ob-lisp.el (org-babel-execute:lisp):
* ob-java.el (org-babel-execute:java):
* ob-io.el (org-babel-io-evaluate):
* ob-haskell.el (org-babel-execute:haskell):
* ob-fortran.el (org-babel-execute:fortran):
* ob-exp.el (org-babel-exp-code):
* ob-emacs-lisp.el (org-babel-execute:emacs-lisp):
* ob-ditaa.el (org-babel-execute:ditaa):
* ob-core.el (org-babel-execute-src-block, org-babel-sha1-hash)
(org-babel-parse-header-arguments, org-babel-reassemble-table)
(org-babel-goto-src-block-head, org-babel-mark-block)
(org-babel-expand-noweb-references, org-babel-script-escape)
(org-babel-process-file-name):
* ob-clojure.el (org-babel-execute:clojure):
* ob-calc.el (org-babel-execute:calc):
* ob-awk.el (org-babel-execute:awk):
* ob-abc.el (org-babel-execute:abc):
* ob-R.el (org-babel-expand-body:R):
* ob-C.el (org-babel-C-execute): Avoid deprecated ((lambda) ...).
2013-11-12 Glenn Morris <rgm@gnu.org>
* ox-html.el (org-html-scripts): Add 2013 to copyright years.
(org-html-infojs-template): Copyright holder to FSF.
2013-11-12 19:57:31 +00:00
|
|
|
(let ((results
|
|
|
|
(case result-type
|
|
|
|
(output
|
|
|
|
(with-temp-file tmp-file
|
|
|
|
(insert
|
|
|
|
(org-babel-eval org-babel-perl-command body))
|
|
|
|
(buffer-string)))
|
|
|
|
(value
|
|
|
|
(org-babel-eval org-babel-perl-command
|
|
|
|
(format org-babel-perl-wrapper-method
|
|
|
|
body tmp-babel-file))))))
|
|
|
|
(when results
|
|
|
|
(org-babel-result-cond result-params
|
|
|
|
(org-babel-eval-read-file tmp-file)
|
|
|
|
(org-babel-import-elisp-from-file tmp-file '(16)))))))
|
2009-11-07 03:05:58 +00:00
|
|
|
|
2010-06-11 23:02:42 +00:00
|
|
|
(provide 'ob-perl)
|
2010-06-25 16:32:35 +00:00
|
|
|
|
2011-08-15 18:04:38 +00:00
|
|
|
|
2010-06-25 16:32:35 +00:00
|
|
|
|
2010-06-11 23:02:42 +00:00
|
|
|
;;; ob-perl.el ends here
|