org-mode/lisp/ob-awk.el

115 lines
4.0 KiB
EmacsLisp
Raw Normal View History

;;; ob-awk.el --- org-babel functions for awk evaluation
2012-01-04 10:12:43 -05:00
;; Copyright (C) 2011-2012 Free Software Foundation, Inc.
;; Author: Eric Schulte
;; Keywords: literate programming, reproducible research
;; Homepage: http://orgmode.org
;; 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:
;; Babel's awk can use special header argument:
;;
;; - :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)
replace flet/labels with org-flet/org-labels This patch ensure Org-mode will build on all supported versions of Emacs, after the renaming of the cl macros behind the cl- prefix in the recent Emacs trunk. * lisp/org-compat.el (org-flet): Compatibility function now that flet has been removed from cl-macs. (org-labels): Compatibility function now that labels has been removed from cl-macs. * lisp/ob-R.el (org-compat): Require org-compat. * lisp/ob-comint.el: Require org-compat. * lisp/ob-exp.el (org-babel-exp-do-export): Switch to compatibility function. * lisp/ob-gnuplot.el (org-babel-expand-body:gnuplot): Switch to compatibility function. * lisp/ob-lob.el (org-babel-lob-get-info): Switch to compatibility function. (org-babel-lob-execute): Switch to compatibility function. * lisp/ob-python.el (org-babel-python-evaluate-session): Switch to compatibility function. * lisp/ob-ref.el (org-babel-ref-index-list): Switch to compatibility function. * lisp/ob-sh.el (org-babel-sh-var-to-string): Switch to compatibility function. * lisp/ob-tangle.el (org-babel-load-file): Switch to compatibility function. (org-babel-tangle): Switch to compatibility function. (org-babel-spec-to-string): Switch to compatibility function. * lisp/ob.el (org-babel-view-src-block-info): Switch to compatibility function. (org-babel-execute-src-block): Switch to compatibility function. (org-babel-edit-distance): Switch to compatibility function. (org-babel-switch-to-session-with-code): Switch to compatibility function. (org-babel-sha1-hash): Switch to compatibility function. (org-babel-balanced-split): Switch to compatibility function. (org-babel-join-splits-near-ch): Switch to compatibility function. (org-babel-get-rownames): Switch to compatibility function. (org-babel-format-result): Switch to compatibility function. (org-babel-insert-result): Switch to compatibility function. (org-babel-examplize-region): Switch to compatibility function. (org-babel-merge-params): Switch to compatibility function. (org-babel-noweb-p): Switch to compatibility function. (org-babel-expand-noweb-references): Switch to compatibility function. * lisp/org-bibtex.el (org-bibtex-headline): Switch to compatibility function. (org-bibtex-fleshout): Switch to compatibility function. (org-bibtex-read): Switch to compatibility function. (org-bibtex-write): Switch to compatibility function. * lisp/org-exp-blocks.el (org-export-blocks-preprocess): Switch to compatibility function. * lisp/org-exp.el (org-export-format-source-code-or-example): Switch to compatibility function. * lisp/org-macs.el (org-called-interactively-p): Indentation fix. * lisp/org-mouse.el (org-mouse-timestamp-today): Switch to compatibility function. (org-mouse-set-priority): Switch to compatibility function. (org-mouse-popup-global-menu): Switch to compatibility function. (org-mouse-context-menu): Switch to compatibility function. * lisp/org-plot.el (org-plot/gnuplot-to-grid-data): Switch to compatibility function. (org-plot/gnuplot-script): Switch to compatibility function. * lisp/org.el (org-entry-get): Switch to compatibility function. (org-fill-paragraph): Switch to compatibility function. (org-auto-fill-function): Switch to compatibility function.
2012-07-19 00:11:36 -04:00
(require 'org-compat)
(eval-when-compile (require 'cl))
(declare-function org-babel-ref-resolve "ob-ref" (ref))
(declare-function orgtbl-to-generic "org-table" (table params))
(defvar org-babel-tangle-lang-exts)
(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 (format "$%s" (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
org-babel-result-cond - unified handling of results * lisp/ob.el (org-babel-result-cond): This function should now be used by all language backends to handle the processing of raw code block output into scalar results, table results, or ignored results depending on the value of result-params. * lisp/ob-C.el (org-babel-C-execute): Use org-babel-result-cond. * lisp/ob-R.el (org-babel-R-evaluate-external-process): Use org-babel-result-cond. (org-babel-R-evaluate-session): Use org-babel-result-cond. * lisp/ob-awk.el (org-babel-execute:awk): Use org-babel-result-cond. * lisp/ob-clojure.el (org-babel-execute:clojure): Use org-babel-result-cond. * lisp/ob-emacs-lisp.el (org-babel-execute:emacs-lisp): Use org-babel-result-cond. * lisp/ob-fortran.el (org-babel-execute:fortran): Use org-babel-result-cond. * lisp/ob-io.el (org-babel-io-evaluate): Use org-babel-result-cond. * lisp/ob-java.el (org-babel-execute:java): Use org-babel-result-cond. * lisp/ob-lisp.el (org-babel-execute:lisp): Use org-babel-result-cond. * lisp/ob-maxima.el (org-babel-execute:maxima): Use org-babel-result-cond. * lisp/ob-picolisp.el (org-babel-execute:picolisp): Use org-babel-result-cond. * lisp/ob-python.el (org-babel-python-evaluate-external-process): Use org-babel-result-cond. (org-babel-python-evaluate-session): Use org-babel-result-cond. * lisp/ob-scala.el (org-babel-scala-evaluate): Use org-babel-result-cond. * lisp/ob-sh.el (org-babel-sh-evaluate): Use org-babel-result-cond. * lisp/ob-shen.el (org-babel-execute:shen): Use org-babel-result-cond. * lisp/ob-sql.el (org-babel-execute:sql): Use org-babel-result-cond. * lisp/ob-sqlite.el (org-babel-execute:sqlite): Use org-babel-result-cond.
2012-11-18 20:02:09 -05:00
(org-babel-result-cond 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
(stdin (with-temp-buffer
(call-process-shell-command cmd stdin (current-buffer))
(buffer-string)))
(t (org-babel-eval cmd ""))))
(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."
(let ((echo-var (lambda (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 (funcall 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)
;;; ob-awk.el ends here