[BUG] org-babel-header-arg-expand is rather cavalier about "appropriate context" [9.8-pre (release_9.7.10-127-g07dd3b @ /usr/local/share/emacs/site-lisp/org/)]

[BUG] org-babel-header-arg-expand is rather cavalier about "appropriate context" [9.8-pre (release_9.7.10-127-g07dd3b @ /usr/local/share/emacs/site-lisp/org/)]

[Nick Dokos]

Remember to cover the basics, that is, what you expected to happen and
what in fact did happen.  You don't know how to make a good report?  See

     https://orgmode.org/manual/Feedback.html#Feedback

Your bug report will be posted to the Org mailing list.
------------------------------------------------------------------------
This was reported by user @Addlai on Emacs SE. See
https://emacs.stackexchange.com/questions/82276/stop-org-cycle-from-prompting-for-header-args

`org-babel-header-arg-expand' is added to the hook
`org-cycle-tab-first-hook' so when a TAB is pressed, the function is
called to check whether the context is approrpiate to call
`org-babel-enter-header-arg-w-completion'.

But the only thing it checks is whether the preceding character is a
colon and whether we are in a source block (by calling
`org-babel-where-is src-block-head'), so if one presses TAB inside a
python source block after a colon, the context is deemed "appropriate"
and you are asked for a header arg.

It should probably check that it's *on* the header line of the source
block, not just that it is *inside* the header block.

Emacs  : GNU Emacs 31.0.50 (build 1, x86_64-pc-linux-gnu, GTK+ Version 3.24.43, cairo version 1.18.0)
 of 2024-08-09
Package: Org mode version 9.8-pre (release_9.7.10-127-g07dd3b @ /usr/local/share/emacs/site-lisp/org/)

-- 
Nick

Re: [BUG] org-babel-header-arg-expand is rather cavalier about "appropriate context" [9.8-pre (release_9.7.10-127-g07dd3b @ /usr/local/share/emacs/site-lisp/org/)]

[Ihor Radchenko]

Nick Dokos <ndokos@gmail.com> writes:

> This was reported by user @Addlai on Emacs SE. See
> https://emacs.stackexchange.com/questions/82276/stop-org-cycle-from-prompting-for-header-args
>
> `org-babel-header-arg-expand' is added to the hook
> `org-cycle-tab-first-hook' so when a TAB is pressed, the function is
> called to check whether the context is approrpiate to call
> `org-babel-enter-header-arg-w-completion'.
>
> But the only thing it checks is whether the preceding character is a
> colon and whether we are in a source block (by calling
> `org-babel-where-is src-block-head'), so if one presses TAB inside a
> python source block after a colon, the context is deemed "appropriate"
> and you are asked for a header arg.

Confirmed.

> It should probably check that it's *on* the header line of the source
> block, not just that it is *inside* the header block.

Agree.
We need to compare the return value of
`org-babel-where-is-src-block-head' with point.

Would you be interested to submit a patch that fixes the issue?

-- 
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>

Re: [BUG] org-babel-header-arg-expand is rather cavalier about "appropriate context" [9.8-pre (release_9.7.10-127-g07dd3b @ /usr/local/share/emacs/site-lisp/org/)]

[Nick Dokos]

On 10/10/24 1:51 PM, Ihor Radchenko wrote:
> Nick Dokos <ndokos@gmail.com> writes:
>
>> This was reported by user @Addlai on Emacs SE. See
>> https://emacs.stackexchange.com/questions/82276/stop-org-cycle-from-prompting-for-header-args
>>
>> `org-babel-header-arg-expand' is added to the hook
>> `org-cycle-tab-first-hook' so when a TAB is pressed, the function is
>> called to check whether the context is approrpiate to call
>> `org-babel-enter-header-arg-w-completion'.
>>
>> But the only thing it checks is whether the preceding character is a
>> colon and whether we are in a source block (by calling
>> `org-babel-where-is src-block-head'), so if one presses TAB inside a
>> python source block after a colon, the context is deemed "appropriate"
>> and you are asked for a header arg.
> Confirmed.
>
>> It should probably check that it's *on* the header line of the source
>> block, not just that it is *inside* the header block.
> Agree.
> We need to compare the return value of
> `org-babel-where-is-src-block-head' with point.
>
> Would you be interested to submit a patch that fixes the issue?

Sure - it'll take me a few days, but I should be able to get one 
togother by early next week.


Thanks!

-- 

Nick


>

[PATCH] `org-babel-header-arg-expand': more stringent check for appropriate context

[Nick Dokos]

[-- Attachment #1: Type: text/plain, Size: 34 bytes --]

Patch attached.

Thanks!
-- 
Nick

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: [PATCH] `org-babel-header-arg-expand': more stringent check for appropriate context --]
[-- Type: text/x-patch, Size: 2067 bytes --]

From b7ae1e8027b7b935098bb4354a957722b55afb1d Mon Sep 17 00:00:00 2001
From: Nick Dokos <ndokos@gmail.com>
Date: Tue, 15 Oct 2024 21:28:32 -0400
Subject: [PATCH] `org-babel-header-arg-expand': more stringent check for
 appropriate context

The check for appropriate context in `org-babel-header-arg-expand' was
inadequate: a colon was deemed appropriate anywhere in the source
block, not just in the header.

* lisp/ob-core.el (org-babel-header-arg-expand): the function now uses
`org-babel-in-src-block-header-p' to check for appropriate context.
(org-babel-in-src-block-header-p): New function.

Reported-by: use @Addlai on Emacs SE.
Link: https://list.orgmode.org/orgmode/87zfnrb2nu.fsf@pierrot.dokosmarshall.org/
---
 lisp/ob-core.el | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/lisp/ob-core.el b/lisp/ob-core.el
index e6db422c9d20..60705036cc7e 100644
--- a/lisp/ob-core.el
+++ b/lisp/ob-core.el
@@ -1093,10 +1093,19 @@ completion from lists of common args and values."
       (unless (= (char-before (point)) ?\ ) (insert " "))
       (insert ":" header-arg) (when value (insert " " value)))))
 
+(defun org-babel-in-src-block-header-p ()
+  "Check whether `point' is in the header line of the source block."
+  (let ((beg (org-babel-where-is-src-block-head)))
+    (when beg
+      (let ((end (save-excursion (goto-char beg) (end-of-line) (point))))
+        (and (>= (point) beg) (<= (point) end))))))
+
 ;; Add support for completing-read insertion of header arguments after ":"
 (defun org-babel-header-arg-expand ()
-  "Call `org-babel-enter-header-arg-w-completion' in appropriate contexts."
-  (when (and (equal (char-before) ?\:) (org-babel-where-is-src-block-head))
+  "Call `org-babel-enter-header-arg-w-completion' in appropriate contexts
+(the header line of a source block)."
+  (when (and (equal (char-before) ?\:)
+             (org-babel-in-src-block-header-p))
     (org-babel-enter-header-arg-w-completion (match-string 2))))
 
 (defun org-babel-enter-header-arg-w-completion (&optional lang)
-- 
2.46.0

Re: [PATCH] `org-babel-header-arg-expand': more stringent check for appropriate context

[Ihor Radchenko]

Nick Dokos <ndokos@gmail.com> writes:

> Patch attached.

Thanks!
Applied, onto main.
Fixed.
https://git.savannah.gnu.org/cgit/emacs/org-mode.git/commit/?id=8b4b89b14b

I changed the docstring of the newly introduced function to follow the
usual Elisp conventions.

-- 
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>

Re: [PATCH] `org-babel-header-arg-expand': more stringent check for appropriate context

[Nick Dokos]

Ihor Radchenko <yantar92@posteo.net> writes:

> Nick Dokos <ndokos@gmail.com> writes:
>
>> Patch attached.
>
> Thanks!
> Applied, onto main.
> Fixed.
> https://git.savannah.gnu.org/cgit/emacs/org-mode.git/commit/?id=8b4b89b14b
>
> I changed the docstring of the newly introduced function to follow the
> usual Elisp conventions.

Noted - thanks!
-- 
Nick