summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEric Schulte <schulte.eric@gmail.com>2011-05-26 07:28:30 -0600
committerEric Schulte <schulte.eric@gmail.com>2011-05-26 07:34:58 -0600
commit5c1cc3fb4b199a5757e63e73646d97b9c71a64f0 (patch)
tree87a8a746926b9befbbcea1bd1cbd36ad4becb088
parent75eeae086e6e992b850d7252a6a6af413f363574 (diff)
downloadorg-mode-5c1cc3fb4b199a5757e63e73646d97b9c71a64f0.tar.gz
adding support for evaluation of awk code blocks
* Makefile (LISPF): Adding ob-awk to the makefile * lisp/org.el (org-babel-load-languages): Adding ob-awk to the list of executable languages.
-rw-r--r--Makefile1
-rw-r--r--lisp/ob-awk.el119
-rw-r--r--lisp/org.el1
3 files changed, 121 insertions, 0 deletions
diff --git a/Makefile b/Makefile
index b3fa19f..9693fd3 100644
--- a/Makefile
+++ b/Makefile
@@ -126,6 +126,7 @@ LISPF = org.el \
ob-comint.el \
ob-eval.el \
ob-keys.el \
+ ob-awk.el \
ob-C.el \
ob-calc.el \
ob-ditaa.el \
diff --git a/lisp/ob-awk.el b/lisp/ob-awk.el
new file mode 100644
index 0000000..b69e800
--- /dev/null
+++ b/lisp/ob-awk.el
@@ -0,0 +1,119 @@
+;;; ob-awk.el --- org-babel functions for awk evaluation
+
+;; Copyright (C) 2011 Free Software Foundation, Inc.
+
+;; Author: Eric Schulte
+;; Keywords: literate programming, reproducible research
+;; Homepage: http://orgmode.org
+;; Version: 7.5
+
+;; This file is part of GNU Emacs.
+
+;; GNU Emacs is free software: you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; 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,
+;; 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.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;;; Commentary:
+
+;; Babel's awk support relies on two special header argument one of
+;; which is required to pass data to the awk process.
+;;
+;; - :in-file takes a path to a file of data to be processed by awk
+;;
+;; - :stdin takes an Org-mode data or code block reference, the value
+;; of which will be passed to the awk process through STDIN
+
+;;; Code:
+(require 'ob)
+(require 'ob-eval)
+(eval-when-compile (require 'cl))
+
+(declare-function org-babel-ref-resolve "ob-ref" (ref))
+(declare-function orgtbl-to-generic "org-table" (table params))
+
+(add-to-list 'org-babel-tangle-lang-exts '("awk" . "awk"))
+
+(defvar org-babel-awk-command "awk"
+ "Name of the awk executable command.")
+
+(defun org-babel-expand-body:awk (body params &optional processed-params)
+ "Expand BODY according to PARAMS, return the expanded body."
+ (dolist (pair (mapcar #'cdr (org-babel-get-header params :var)))
+ (setf body (replace-regexp-in-string
+ (regexp-quote (concat "$" (car pair))) (cdr pair) body)))
+ body)
+
+(defun org-babel-execute:awk (body params)
+ "Execute a block of Awk code with org-babel. This function is
+called by `org-babel-execute-src-block'"
+ (message "executing Awk source code block")
+ (let* ((result-params (cdr (assoc :result-params params)))
+ (cmd-line (cdr (assoc :cmd-line params)))
+ (in-file (cdr (assoc :in-file params)))
+ (full-body (org-babel-expand-body:awk body params))
+ (code-file ((lambda (file) (with-temp-file file (insert full-body)) file)
+ (org-babel-temp-file "awk-")))
+ (stdin ((lambda (stdin)
+ (when stdin
+ (let ((tmp (org-babel-temp-file "awk-stdin-"))
+ (res (org-babel-ref-resolve stdin)))
+ (with-temp-file tmp
+ (insert (org-babel-awk-var-to-awk res)))
+ tmp)))
+ (cdr (assoc :stdin params))))
+ (cmd (mapconcat #'identity (remove nil (list org-babel-awk-command
+ "-f" code-file
+ cmd-line
+ in-file))
+ " ")))
+ (org-babel-reassemble-table
+ ((lambda (results)
+ (when results
+ (if (or (member "scalar" result-params)
+ (member "output" result-params))
+ results
+ (let ((tmp (org-babel-temp-file "awk-results-")))
+ (with-temp-file tmp (insert results))
+ (org-babel-import-elisp-from-file tmp)))))
+ (cond
+ (in-file (org-babel-eval cmd ""))
+ (stdin (with-temp-buffer
+ (call-process-shell-command cmd stdin (current-buffer))
+ (buffer-string)))
+ (t (error "ob-awk: must specify either :in-file or :stdin"))))
+ (org-babel-pick-name
+ (cdr (assoc :colname-names params)) (cdr (assoc :colnames params)))
+ (org-babel-pick-name
+ (cdr (assoc :rowname-names params)) (cdr (assoc :rownames params))))))
+
+(defun org-babel-awk-var-to-awk (var &optional sep)
+ "Return a printed value of VAR suitable for parsing with awk."
+ (flet ((echo-var (v) (if (stringp v) v (format "%S" v))))
+ (cond
+ ((and (listp var) (listp (car var)))
+ (orgtbl-to-generic var (list :sep (or sep "\t") :fmt #'echo-var)))
+ ((listp var)
+ (mapconcat #'echo-var var "\n"))
+ (t (echo-var var)))))
+
+(defun org-babel-awk-table-or-string (results)
+ "If the results look like a table, then convert them into an
+Emacs-lisp table, otherwise return the results as a string."
+ (org-babel-script-escape results))
+
+(provide 'ob-awk)
+
+;; arch-tag: 844e2c88-6aad-4018-868d-a2df6bcdf68f
+
+;;; ob-awk.el ends here
diff --git a/lisp/org.el b/lisp/org.el
index cdf48c1..a0968b6 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -150,6 +150,7 @@ requirements) is loaded."
:type '(alist :tag "Babel Languages"
:key-type
(choice
+ (const :tag "Awk" awk)
(const :tag "C" C)
(const :tag "R" R)
(const :tag "Asymptote" asymptote)