2011-05-26 13:28:30 +00:00
|
|
|
;;; ob-awk.el --- org-babel functions for awk evaluation
|
|
|
|
|
2014-01-05 05:28:07 +00:00
|
|
|
;; Copyright (C) 2011-2013 Free Software Foundation, Inc.
|
2011-05-26 13:28:30 +00:00
|
|
|
|
|
|
|
;; 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:
|
|
|
|
|
2011-07-24 10:28:35 +00:00
|
|
|
;; Babel's awk can use special header argument:
|
2012-03-19 20:38:12 +00:00
|
|
|
;;
|
2011-05-26 13:28:30 +00:00
|
|
|
;; - :in-file takes a path to a file of data to be processed by awk
|
2012-03-19 20:38:12 +00:00
|
|
|
;;
|
2011-05-26 13:28:30 +00:00
|
|
|
;; - :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)
|
2012-07-19 04:11:36 +00:00
|
|
|
(require 'org-compat)
|
2011-05-26 13:28:30 +00:00
|
|
|
(eval-when-compile (require 'cl))
|
|
|
|
|
|
|
|
(declare-function org-babel-ref-resolve "ob-ref" (ref))
|
|
|
|
(declare-function orgtbl-to-generic "org-table" (table params))
|
|
|
|
|
2011-06-21 22:34:41 +00:00
|
|
|
(defvar org-babel-tangle-lang-exts)
|
2011-05-26 13:28:30 +00:00
|
|
|
(add-to-list 'org-babel-tangle-lang-exts '("awk" . "awk"))
|
|
|
|
|
|
|
|
(defvar org-babel-awk-command "awk"
|
|
|
|
"Name of the awk executable command.")
|
|
|
|
|
2013-04-01 05:42:16 +00:00
|
|
|
(defun org-babel-expand-body:awk (body params)
|
2011-05-26 13:28:30 +00:00
|
|
|
"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
|
2011-08-28 15:03:07 +00:00
|
|
|
(regexp-quote (format "$%s" (car pair))) (cdr pair) body)))
|
2011-05-26 13:28:30 +00:00
|
|
|
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))
|
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
|
|
|
(code-file (let ((file (org-babel-temp-file "awk-")))
|
|
|
|
(with-temp-file file (insert full-body)) file))
|
|
|
|
(stdin (let ((stdin (cdr (assoc :stdin params))))
|
2011-05-26 13:28:30 +00:00
|
|
|
(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)))
|
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
|
|
|
tmp))))
|
2011-05-26 13:28:30 +00:00
|
|
|
(cmd (mapconcat #'identity (remove nil (list org-babel-awk-command
|
|
|
|
"-f" code-file
|
|
|
|
cmd-line
|
|
|
|
in-file))
|
|
|
|
" ")))
|
|
|
|
(org-babel-reassemble-table
|
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
|
|
|
|
(cond
|
|
|
|
(stdin (with-temp-buffer
|
|
|
|
(call-process-shell-command cmd stdin (current-buffer))
|
|
|
|
(buffer-string)))
|
|
|
|
(t (org-babel-eval cmd "")))))
|
|
|
|
(when results
|
|
|
|
(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)))))
|
2011-05-26 13:28:30 +00:00
|
|
|
(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."
|
2012-08-10 14:05:26 +00:00
|
|
|
(let ((echo-var (lambda (v) (if (stringp v) v (format "%S" v)))))
|
2011-05-26 13:28:30 +00:00
|
|
|
(cond
|
|
|
|
((and (listp var) (listp (car var)))
|
2012-08-10 14:05:26 +00:00
|
|
|
(orgtbl-to-generic var (list :sep (or sep "\t") :fmt echo-var)))
|
2011-05-26 13:28:30 +00:00
|
|
|
((listp var)
|
2012-08-10 14:05:26 +00:00
|
|
|
(mapconcat echo-var var "\n"))
|
|
|
|
(t (funcall echo-var var)))))
|
2011-05-26 13:28:30 +00:00
|
|
|
|
|
|
|
(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)
|
|
|
|
|
2011-08-15 18:04:38 +00:00
|
|
|
|
2011-05-26 13:28:30 +00:00
|
|
|
|
|
|
|
;;; ob-awk.el ends here
|