emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Chris Clark <cfclrk@gmail.com>
To: Ihor Radchenko <yantar92@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: Add 'backend' header arg to clojure code blocks
Date: Sun, 9 Oct 2022 11:34:11 -0400	[thread overview]
Message-ID: <CAL2EVtcXbU9EebzC16M7XzE-tmu6S7s1BGqfCiYLtx4L3fJtgQ@mail.gmail.com> (raw)
In-Reply-To: <875ygtqw77.fsf@localhost>


[-- Attachment #1.1: Type: text/plain, Size: 2043 bytes --]

Thank you for the great feedback! Here are some updated patches.

Attached are two patches: one for org mode, and a corresponding one for
worg.

On Sun, Oct 9, 2022 at 3:42 AM Ihor Radchenko <yantar92@gmail.com> wrote:

> Chris Clark <cfclrk@gmail.com> writes:
>
> > This is my first attempt to contribute to org-mode; please let me know if
> > I'm doing something wrong.
>
> Thanks a lot! Contributions are always welcome.
>
> Please also add a mention and/or example to the ob-clojure documentation
> https://orgmode.org/worg/org-contrib/babel/languages/ob-doc-clojure.html
> (The source repository is https://git.sr.ht/~bzg/worg )
>
> Also, you need to add an etc/ORG-NEWS entry about the new header
> argument.
>
> And I have few minor comments on the patch itself.
>
> > From cc72dcac3075be76e3edcfee75c887272e48698c Mon Sep 17 00:00:00 2001
> > From: Chris Clark <cfclrk@gmail.com>
> > Date: Sat, 8 Oct 2022 05:41:20 -0400
> > Subject: [PATCH] ob-clojure.el: Add a 'backend' header arg to clojure
> code blocks
>                                        ^:backend
> > * ob-clojure.el (org-babel-header-args:clojure,
> > org-babel-execute:clojure): Add a 'backend' header arg that can
>                                    ^:backend
> > override the configured `org-babel-clojure-backend`.
>                                                    ^'
> (by convention, we quote like `symbol' using `' pair).
>
>
> Also, unless you have FSF copyright assignment, we need you to add
> TINYCHANGE at the end of the commit message. See
> https://orgmode.org/worg/org-contribute.html#first-patch
>
> > +           (t (user-error "You need to customize
> org-babel-clojure-backend")))))
>
> While we are here, can as well quote `org-babel-clojure-backend'.
>
> Or may even add "or set `:backend' header argument".
>
> --
> Ihor Radchenko // yantar92,
> Org mode contributor,
> Learn more about Org mode at <https://orgmode.org/>.
> Support Org development at <https://liberapay.com/org-mode>,
> or support my work at <https://liberapay.com/yantar92>
>

[-- Attachment #1.2: Type: text/html, Size: 3414 bytes --]

[-- Attachment #2: 0001-ob-clojure.el-Add-a-backend-header-arg-to-clojure-co.patch --]
[-- Type: application/octet-stream, Size: 4395 bytes --]

From 669dc16a851fdab017e162c74c1cbf050ef429f4 Mon Sep 17 00:00:00 2001
From: Chris Clark <cfclrk@gmail.com>
Date: Sat, 8 Oct 2022 05:41:20 -0400
Subject: [PATCH] ob-clojure.el: Add a :backend header arg to clojure code
 blocks

* ob-clojure.el (org-babel-header-args:clojure,
org-babel-execute:clojure): Add a :backend header arg that can
override the configured `org-babel-clojure-backend'.

TINYCHANGE
---
 etc/ORG-NEWS       |  9 ++++++++
 lisp/ob-clojure.el | 54 ++++++++++++++++++++++++++--------------------
 2 files changed, 40 insertions(+), 23 deletions(-)

diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS
index 34ec09927..c18c03725 100644
--- a/etc/ORG-NEWS
+++ b/etc/ORG-NEWS
@@ -314,6 +314,15 @@ This provides a proper counterpart to ~org-babel-pre-tangle-hook~, as
 per-tangle-destination. ~org-babel-tangle-finished-hook~ is just run
 once after the post tangle hooks.
 
+*** New =:backend= header argument for clojure code blocks
+
+The =:backend= header argument on clojure code blocks can override the
+value of ~org-babel-clojure-backend~. For example:
+
+#+begin_src clojure :backend babashka
+(range 2)
+#+end_src
+
 ** New options
 *** New custom settings =org-icalendar-scheduled-summary-prefix= and =org-icalendar-deadline-summary-prefix=
 
diff --git a/lisp/ob-clojure.el b/lisp/ob-clojure.el
index dc72eb049..d6f860e98 100644
--- a/lisp/ob-clojure.el
+++ b/lisp/ob-clojure.el
@@ -68,7 +68,10 @@
 (add-to-list 'org-babel-tangle-lang-exts '("clojurescript" . "cljs"))
 
 (defvar org-babel-default-header-args:clojure '())
-(defvar org-babel-header-args:clojure '((ns . :any) (package . :any)))
+(defvar org-babel-header-args:clojure
+  '((ns . :any)
+    (package . :any)
+    (backend . ((inf-clojure cider slime babashka nbb)))))
 (defvar org-babel-default-header-args:clojurescript '())
 (defvar org-babel-header-args:clojurescript '((package . :any)))
 
@@ -253,28 +256,33 @@
      "")))
 
 (defun org-babel-execute:clojure (body params)
-  "Execute a block of Clojure code with Babel."
-  (unless org-babel-clojure-backend
-    (user-error "You need to customize org-babel-clojure-backend"))
-  (let* ((expanded (org-babel-expand-body:clojure body params))
-	 (result-params (cdr (assq :result-params params)))
-	 result)
-    (setq result
-	  (cond
-	   ((eq org-babel-clojure-backend 'inf-clojure)
-	    (ob-clojure-eval-with-inf-clojure expanded params))
-           ((eq org-babel-clojure-backend 'babashka)
-	    (ob-clojure-eval-with-babashka ob-clojure-babashka-command expanded))
-           ((eq org-babel-clojure-backend 'nbb)
-	    (ob-clojure-eval-with-babashka ob-clojure-nbb-command expanded))
-	   ((eq org-babel-clojure-backend 'cider)
-	    (ob-clojure-eval-with-cider expanded params))
-	   ((eq org-babel-clojure-backend 'slime)
-	    (ob-clojure-eval-with-slime expanded params))))
-    (org-babel-result-cond result-params
-      result
-      (condition-case nil (org-babel-script-escape result)
-	(error result)))))
+  "Execute the BODY block of Clojure code with PARAMS using Babel."
+  (let* ((backend-override (cdr (assq :backend params)))
+         (org-babel-clojure-backend
+          (cond
+           (backend-override (intern backend-override))
+           (org-babel-clojure-backend org-babel-clojure-backend)
+           (t (user-error "You need to customize `org-babel-clojure-backend'
+or set the `:backend' header argument")))))
+    (let* ((expanded (org-babel-expand-body:clojure body params))
+	   (result-params (cdr (assq :result-params params)))
+	   result)
+      (setq result
+	    (cond
+	     ((eq org-babel-clojure-backend 'inf-clojure)
+	      (ob-clojure-eval-with-inf-clojure expanded params))
+             ((eq org-babel-clojure-backend 'babashka)
+	      (ob-clojure-eval-with-babashka ob-clojure-babashka-command expanded))
+             ((eq org-babel-clojure-backend 'nbb)
+	      (ob-clojure-eval-with-babashka ob-clojure-nbb-command expanded))
+	     ((eq org-babel-clojure-backend 'cider)
+	      (ob-clojure-eval-with-cider expanded params))
+	     ((eq org-babel-clojure-backend 'slime)
+	      (ob-clojure-eval-with-slime expanded params))))
+      (org-babel-result-cond result-params
+        result
+        (condition-case nil (org-babel-script-escape result)
+	  (error result))))))
 
 (defun org-babel-execute:clojurescript (body params)
   "Evaluate BODY with PARAMS as ClojureScript code."
-- 
2.38.0


[-- Attachment #3: 0001-ob-doc-clojure.org-Add-example-of-backend-header-arg.patch --]
[-- Type: application/octet-stream, Size: 1116 bytes --]

From 439a0567e6a195f8a492b9bd1128bdf2fac96f31 Mon Sep 17 00:00:00 2001
From: Chris Clark <cfclrk@gmail.com>
Date: Sun, 9 Oct 2022 10:49:07 -0400
Subject: [PATCH] ob-doc-clojure.org: Add example of :backend header arg

---
 org-contrib/babel/languages/ob-doc-clojure.org | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/org-contrib/babel/languages/ob-doc-clojure.org b/org-contrib/babel/languages/ob-doc-clojure.org
index a577d9b2..818cfef7 100644
--- a/org-contrib/babel/languages/ob-doc-clojure.org
+++ b/org-contrib/babel/languages/ob-doc-clojure.org
@@ -305,6 +305,21 @@ this dir variable in Clojure to construct a correct path.
 ,#+end_src
 #+end_src
 
+* Evaluating with babashka
+
+You can also evaluate a Clojure code block using [[https://github.com/babashka/babashka][babashka]] (assuming
+you have it installed). To do so, either customize
+~org-babel-clojure-backend~ or use the ~:backend~ header argument. For
+example:
+
+#+begin_example
+,#+begin_src clojure :backend babashka
+  (range 3)
+,#+end_src
+
+,#+RESULTS:
+: (0 1 2)
+#+end_example
 
 * Additional Examples
 
-- 
2.38.0


  reply	other threads:[~2022-10-09 15:35 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-10-08 10:24 Add 'backend' header arg to clojure code blocks Chris Clark
2022-10-08 12:43 ` Christopher M. Miles
2022-10-09  7:42 ` Ihor Radchenko
2022-10-09 15:34   ` Chris Clark [this message]
2022-10-11  2:55     ` Ihor Radchenko
2022-10-12  0:40       ` [PATCH] Fix void variable error `cider-buffer-ns` when specifying :backend header argument Christopher M. Miles
     [not found]       ` <63460e17.050a0220.1ff7f.4bdeSMTPIN_ADDED_BROKEN@mx.google.com>
2022-10-12  6:04         ` Ihor Radchenko
2022-10-12  9:29           ` [PATCH] (v2) " Christopher M. Miles
     [not found]           ` <6346892e.050a0220.a2480.498fSMTPIN_ADDED_BROKEN@mx.google.com>
2022-10-13  2:56             ` Ihor Radchenko

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CAL2EVtcXbU9EebzC16M7XzE-tmu6S7s1BGqfCiYLtx4L3fJtgQ@mail.gmail.com \
    --to=cfclrk@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=yantar92@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).