From mboxrd@z Thu Jan 1 00:00:00 1970 From: stardiviner Subject: Re: [PATCH] Add support for Babel with Eshell, and some questions Date: Sun, 22 Apr 2018 10:01:11 +0800 Message-ID: <87bmecrod4.fsf@gmail.com> References: <87d0ysroer.fsf@gmail.com> Reply-To: numbchild@gmail.com Mime-Version: 1.0 Content-Type: multipart/signed; boundary="==-=-="; micalg=pgp-sha256; protocol="application/pgp-signature" Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:48864) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fA4Jj-0005rj-5t for emacs-orgmode@gnu.org; Sat, 21 Apr 2018 22:01:28 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fA4Jf-0001fW-U3 for emacs-orgmode@gnu.org; Sat, 21 Apr 2018 22:01:27 -0400 Received: from [183.249.136.165] (port=4086 helo=dark.localdomain) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fA4Jf-0001SR-0k for emacs-orgmode@gnu.org; Sat, 21 Apr 2018 22:01:23 -0400 In-reply-to: <87d0ysroer.fsf@gmail.com> List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: "Emacs-orgmode" To: org-mode --==-=-= Content-Type: multipart/mixed; boundary="=-=-=" --=-=-= Content-Type: text/plain Ahh, forgot include my patches. --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-ob-eshell.el-Add-Eshell-support-for-Babel.patch Content-Transfer-Encoding: quoted-printable From=20132c94b9b40fd9ba694fa4338f325582771c53ec Mon Sep 17 00:00:00 2001 From: stardiviner Date: Sun, 22 Apr 2018 09:37:40 +0800 Subject: [PATCH] ob-eshell.el: Add Eshell support for Babel. * lisp/ob-eshell.el (org-babel-execute:eshell): Execute Eshell code in Babe= l. (org-babel-prep-session:eshell): (ob-eshell-session-live-p): (org-babel-eshell-initiate-session): (org-babel-variable-assignments:eshell): (org-babel-load-session:eshell): * testing/test-ob-eshell.el: Write test for ob-eshell. * doc/org-manual.org (Languages): Add document for ob-eshell. =2D-- doc/org-manual.org | 1 + lisp/ob-eshell.el | 98 ++++++++++++++++++++++++++++++++++ testing/lisp/test-ob-eshell.el | 73 +++++++++++++++++++++++++ 3 files changed, 172 insertions(+) create mode 100644 lisp/ob-eshell.el create mode 100644 testing/lisp/test-ob-eshell.el diff --git a/doc/org-manual.org b/doc/org-manual.org index 0ffa73911..38a6e8fa4 100644 =2D-- a/doc/org-manual.org +++ b/doc/org-manual.org @@ -17579,6 +17579,7 @@ Code blocks in the following languages are supporte= d. | D | d | ditaa | ditaa | | Graphviz | dot | Emacs Calc | calc | | Emacs Lisp | emacs-lisp | Fortran | fortran | +| Shell | sh | Eshell | eshell | | Gnuplot | gnuplot | Haskell | haskell | | Java | java | Javascript | js | | LaTeX | latex | Ledger | ledger | diff --git a/lisp/ob-eshell.el b/lisp/ob-eshell.el new file mode 100644 index 000000000..25e52e9e8 =2D-- /dev/null +++ b/lisp/ob-eshell.el @@ -0,0 +1,98 @@ +;;; ob-eshell.el --- Babel Functions for Eshell -*- lexical-bin= ding: t; -*- + +;; Copyright (C) 2009-2018 Free Software Foundation, Inc. + +;; Author: stardiviner +;; Keywords: literate programming, reproducible research +;; Homepage: https://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 . + +;;; Commentary: + +;; Org-Babel support for evaluating Eshell source code. + +;;; Code: +(require 'ob) +(require 'eshell) + +(defvar org-babel-default-header-args:eshell '()) + +(defun org-babel-execute:eshell (body params) + "Execute a block of Eshell code. +This function is called by `org-babel-execute-src-block'." + (let* ((session (org-babel-eshell-initiate-session + (cdr (assq :session params)))) + (full-body (org-babel-expand-body:generic + body params (org-babel-variable-assignments:eshell params)))) + (if session + (progn + (with-current-buffer session + (goto-char eshell-last-output-end) + (dolist (line (split-string full-body)) + (insert line)) + (eshell-send-input) + ;; get output of last input + (goto-char eshell-last-input-end) + (buffer-substring-no-properties (point) eshell-last-output-start))) + (with-temp-buffer + (eshell-command full-body t) + (buffer-string))))) + +(defun org-babel-prep-session:eshell (session params) + "Prepare SESSION according to the header arguments specified in PARAMS." + (let* ((session (org-babel-eshell-initiate-session session)) + ;; Eshell session buffer is read from variable `eshell-buffer-name'. + (eshell-buffer-name session) + (var-lines (org-babel-variable-assignments:eshell params))) + (call-interactively 'eshell) + (dolist (var-line var-lines) + (eshell-command var-line)) + session)) + +(defun ob-eshell-session-live-p (session) + "Detect Eshell SESSION exist." + (and (get-buffer session) t)) + +(defun org-babel-eshell-initiate-session (&optional session params) + "Initiate a session named SESSION according to PARAMS." + (when (and session (not (string=3D session "none"))) + (save-window-excursion + (or (ob-eshell-session-live-p session) + (progn + (let ((eshell-buffer-name session)) + (eshell)) + (get-buffer (current-buffer))))))) + +(defun org-babel-variable-assignments:eshell (params) + "Convert ob-eshell :var specified variables into Eshell variables assign= ments." + (mapcar + (lambda (pair) + (format "(setq %s %S)" (car pair) (cdr pair))) + (org-babel--get-vars params))) + +(defun org-babel-load-session:eshell (session body params) + "Load BODY into SESSION with PARAMS." + (save-window-excursion + (let ((buffer (org-babel-prep-session:eshell session params))) + (with-current-buffer buffer + (goto-char (point-max)) + (insert (org-babel-chomp body))) + buffer))) + +(provide 'ob-eshell) + +;;; ob-eshell.el ends here diff --git a/testing/lisp/test-ob-eshell.el b/testing/lisp/test-ob-eshell.el new file mode 100644 index 000000000..77a750f0e =2D-- /dev/null +++ b/testing/lisp/test-ob-eshell.el @@ -0,0 +1,73 @@ +;;; test-ob-eshell.el + +;; Copyright (c) 2010-2014 Eric Schulte +;; Authors: stardiviner + +;; This file is not part of GNU Emacs. + +;; This program 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. + +;; This program 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 this program. If not, see . + +;;; Comment: + +;; Template test file for Org tests + +;;; Code: +(unless (featurep 'ob-eshell) + (signal 'missing-test-dependency "Support for Eshell code blocks")) + +(ert-deftest ob-eshell/execute () + "Test ob-eshell execute." + (should + (string=3D + (org-test-with-temp-text + "#+begin_src eshell +echo 2 +#+end_src" + (org-babel-execute-src-block)) + ": 2"))) + +(ert-deftest ob-eshell/variables-assignment () + "Test ob-eshell variables assignment." + (should + (string=3D + (org-test-with-temp-text + "#+begin_src eshell :var hi=3D\"hello, world\" +echo $hi +#+end_src" + (org-babel-execute-src-block)) + ": hello, world"))) + +(ert-deftest ob-eshell/session () + "Test ob-eshell session." + (should + (string=3D + (org-test-with-temp-text + "#+begin_src eshell :session +(setq hi \"hello, world\") +#+end_src + +#+begin_src eshell :session +echo $hi +#+end_src" + (org-babel-execute-src-block) + (org-babel-next-src-block) + (org-babel-execute-src-block) + (goto-char (org-babel-where-is-src-block-result)) + (forward-line) + (buffer-substring-no-properties (point) (line-end-position))) + ": hello, world"))) + +(provide 'test-ob-eshell) + +;;; test-ob-eshell.el ends here =2D-=20 2.17.0 --=-=-= Content-Type: text/plain Content-Transfer-Encoding: quoted-printable =2D-=20 [ stardiviner ] don't need to convince with trends. Blog: https://stardiviner.github.io/ IRC(freenode): stardiviner GPG: F09F650D7D674819892591401B5DF1C95AE89AC3 =20=20=20=20=20=20 --=-=-=-- --==-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQEzBAEBCAAdFiEE8J9lDX1nSBmJJZFAG13xyVromsMFAlrb7OcACgkQG13xyVro msMz0AgAw/mhvMBiIu1zi1BJ9ADFvIGKaiUpqmDSbX983QezinusjKyRFyIVuYTv 9Zguagkp7Q0A7SPlUPWJ5Iju86RpXO4vF2xfVX2zHoI37G63KXEX57j6X58bDoQn F1uNdq5BH2lX3SSSrm4gENgc+CfOtLPe3WDZlhHmsfYkah0zGBRU97lROHBDvxJ3 MeTY4KyQDeCSqQFtOZAaYOek7sOgOmUmbeudxqB+mX65JqX6Dd5DvjyDw8tOkJSo 6zcAv7gLNbRlegPgXotctI91Tv5T25Rv0aLMVgbyt6CPeZH8910VDg4dAG5AA3uA J6/4FT01/KUOCKpOHu3mzIrENQg/fg== =JV0x -----END PGP SIGNATURE----- --==-=-=--