bug#65007: [PATCH] Allow displaying program IO in the GDB buffer.

bug#65007: [PATCH] Allow displaying program IO in the GDB buffer.

[StrawberryTea]

* gdb-mi.el: Add new customizable variable `gdb-split-io-flag'.

This change allows the user to control whether program IO is displayed
in the GDB buffer or in a separate buffer.  The default is to display it
in the the `gdb-inferior-io' buffer.
---
 lisp/progmodes/gdb-mi.el | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

diff --git a/lisp/progmodes/gdb-mi.el b/lisp/progmodes/gdb-mi.el
index a1091de43e9..8f4f06abb9a 100644
--- a/lisp/progmodes/gdb-mi.el
+++ b/lisp/progmodes/gdb-mi.el
@@ -1098,9 +1098,10 @@ detailed description of this mode.
                      (if gdb-debuginfod-enable "on" "off"))
              'gdb-debuginfod-message)
 
-  (gdb-get-buffer-create 'gdb-inferior-io)
-  (gdb-clear-inferior-io)
-  (gdb-inferior-io--init-proc (get-process "gdb-inferior"))
+  (when gdb-split-io-flag
+    (gdb-get-buffer-create 'gdb-inferior-io)
+    (gdb-clear-inferior-io)
+    (gdb-inferior-io--init-proc (get-process "gdb-inferior")))
 
   (when (eq system-type 'windows-nt)
     ;; Don't create a separate console window for the debuggee.
@@ -1828,6 +1829,15 @@ this trigger is subscribed to `gdb-buf-publisher' and called with
   :group 'gdb
   :version "25.1")
 
+(defcustom gdb-split-io-flag t
+  "Non-nil means to split the program's I/O from the GDB buffer.
+
+If t, create the `gdb-inferior-io' buffer and redirect the
+program's I/O to it."
+  :type 'boolean
+  :group 'gdb
+  :version "30.1")
+
 (defun gdb-inferior-filter (proc string)
   (unless (string-equal string "")
     (let (buf)
-- 
2.41.0

bug#65007: [PATCH] Allow displaying program IO in the GDB buffer.

[Po Lu via Bug reports for GNU Emacs, the Swiss army knife of text editors]

StrawberryTea <look@strawberrytea.xyz> writes:

> * gdb-mi.el: Add new customizable variable `gdb-split-io-flag'.
>
> This change allows the user to control whether program IO is displayed
> in the GDB buffer or in a separate buffer.  The default is to display it
> in the the `gdb-inferior-io' buffer.
> ---
>  lisp/progmodes/gdb-mi.el | 16 +++++++++++++---
>  1 file changed, 13 insertions(+), 3 deletions(-)
>
> diff --git a/lisp/progmodes/gdb-mi.el b/lisp/progmodes/gdb-mi.el
> index a1091de43e9..8f4f06abb9a 100644
> --- a/lisp/progmodes/gdb-mi.el
> +++ b/lisp/progmodes/gdb-mi.el
> @@ -1098,9 +1098,10 @@ detailed description of this mode.
>                       (if gdb-debuginfod-enable "on" "off"))
>               'gdb-debuginfod-message)
>  
> -  (gdb-get-buffer-create 'gdb-inferior-io)
> -  (gdb-clear-inferior-io)
> -  (gdb-inferior-io--init-proc (get-process "gdb-inferior"))
> +  (when gdb-split-io-flag
> +    (gdb-get-buffer-create 'gdb-inferior-io)
> +    (gdb-clear-inferior-io)
> +    (gdb-inferior-io--init-proc (get-process "gdb-inferior")))
>  
>    (when (eq system-type 'windows-nt)
>      ;; Don't create a separate console window for the debuggee.
> @@ -1828,6 +1829,15 @@ this trigger is subscribed to `gdb-buf-publisher' and called with
>    :group 'gdb
>    :version "25.1")
>  
> +(defcustom gdb-split-io-flag t
> +  "Non-nil means to split the program's I/O from the GDB buffer.
> +
> +If t, create the `gdb-inferior-io' buffer and redirect the
> +program's I/O to it."
> +  :type 'boolean
> +  :group 'gdb
> +  :version "30.1")
> +
>  (defun gdb-inferior-filter (proc string)
>    (unless (string-equal string "")
>      (let (buf)

Please append a ChangeLog entry to your commit messages,
formatted in adherence with GNU standards.  In particular, it
should contain one entry for each function changed or variable
introduced:

Add new customizable variable `gdb-split-io-flag'.

* lisp/progmodes/gdb-mi.el (gdb-split-io-flag): Don't create IO
buffer if `gdb-split-io-flag'.
(gdb-split-io-flag): New user option.

Moreover, wouldn't `gdb-use-io-buffer' make a better name for
this option?  We don't typically name variables or user options
``flags'' in Emacs.

bug#65007: [PATCH] Allow displaying program IO in the GDB buffer.

[StrawberryTea]

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

Hi Po Lu,

I’m not sure whether I should reply or always send the edited patch in as a separate email and have been emailing several times but no longer getting responses. I made the changes you requested:


lisp/progmodes/gdb-mi.el (gdb-use-io-buffer): Don’t create IO
═════════════════════════════════════════════════════════════

buffer if `gdb-use-io-buffer’.
(gdb-use-io-buffer): New user option.
—
 lisp/progmodes/gdb-mi.el | 16 +++++++++++++—
 1 file changed, 13 insertions(+), 3 deletions(-)

diff –git a/lisp/progmodes/gdb-mi.el b/lisp/progmodes/gdb-mi.el
index a1091de43e9..00cb1013f7b 100644
— a/lisp/progmodes/gdb-mi.el
+++ b/lisp/progmodes/gdb-mi.el
@@ -1098,9 +1098,10 @@ detailed description of this mode.
                      (if gdb-debuginfod-enable “on” “off”))
              ’gdb-debuginfod-message)

• (gdb-get-buffer-create ’gdb-inferior-io)
• (gdb-clear-inferior-io)
• (gdb-inferior-io–init-proc (get-process “gdb-inferior”))
⁃ (when gdb-use-io-buffer
⁃ (gdb-get-buffer-create ’gdb-inferior-io)
⁃ (gdb-clear-inferior-io)
⁃ (gdb-inferior-io–init-proc (get-process “gdb-inferior”)))

  (when (eq system-type ’windows-nt)
    ;; Don’t create a separate console window for the debuggee.
@@ -1828,6 +1829,15 @@ this trigger is subscribed to `gdb-buf-publisher’ and called with
   :group ’gdb
   :version “25.1”)

+(defcustom gdb-use-io-buffer t
⁃ “Non-nil means to split the program’s I/O from the GDB buffer.
⁃ 
+If t, create the `gdb-inferior-io’ buffer and redirect the
+program’s I/O to it.“
⁃ :type ’boolean
⁃ :group ’gdb
⁃ :version “30.1”)
⁃ (defun gdb-inferior-filter (proc string)
    (unless (string-equal string “”)
      (let (buf)
–
2.41.0

Po Lu <luangruo@yahoo.com> writes:

> StrawberryTea <look@strawberrytea.xyz> writes:
>
>> * gdb-mi.el: Add new customizable variable `gdb-split-io-flag’.
>>
>> This change allows the user to control whether program IO is displayed
>> in the GDB buffer or in a separate buffer.  The default is to display it
>> in the the `gdb-inferior-io’ buffer.
>> —
>>  lisp/progmodes/gdb-mi.el | 16 +++++++++++++—
>>  1 file changed, 13 insertions(+), 3 deletions(-)
>>
>> diff –git a/lisp/progmodes/gdb-mi.el b/lisp/progmodes/gdb-mi.el
>> index a1091de43e9..8f4f06abb9a 100644
>> — a/lisp/progmodes/gdb-mi.el
>> +++ b/lisp/progmodes/gdb-mi.el
>> @@ -1098,9 +1098,10 @@ detailed description of this mode.
>>                       (if gdb-debuginfod-enable “on” “off”))
>>               ’gdb-debuginfod-message)
>>
>> -  (gdb-get-buffer-create ’gdb-inferior-io)
>> -  (gdb-clear-inferior-io)
>> -  (gdb-inferior-io–init-proc (get-process “gdb-inferior”))
>> +  (when gdb-split-io-flag
>> +    (gdb-get-buffer-create ’gdb-inferior-io)
>> +    (gdb-clear-inferior-io)
>> +    (gdb-inferior-io–init-proc (get-process “gdb-inferior”)))
>>
>>    (when (eq system-type ’windows-nt)
>>      ;; Don’t create a separate console window for the debuggee.
>> @@ -1828,6 +1829,15 @@ this trigger is subscribed to `gdb-buf-publisher’ and called with
>>    :group ’gdb
>>    :version “25.1”)
>>
>> +(defcustom gdb-split-io-flag t
>> +  “Non-nil means to split the program’s I/O from the GDB buffer.
>> +
>> +If t, create the `gdb-inferior-io’ buffer and redirect the
>> +program’s I/O to it.”
>> +  :type ’boolean
>> +  :group ’gdb
>> +  :version “30.1”)
>> +
>>  (defun gdb-inferior-filter (proc string)
>>    (unless (string-equal string “”)
>>      (let (buf)
>
> Please append a ChangeLog entry to your commit messages,
> formatted in adherence with GNU standards.  In particular, it
> should contain one entry for each function changed or variable
> introduced:
>
> Add new customizable variable `gdb-split-io-flag’.
>
> * lisp/progmodes/gdb-mi.el (gdb-split-io-flag): Don’t create IO
> buffer if `gdb-split-io-flag’.
> (gdb-split-io-flag): New user option.
>
> Moreover, wouldn’t `gdb-use-io-buffer’ make a better name for
> this option?  We don’t typically name variables or user options
> ``flags’’ in Emacs.

bug#65007: [PATCH] Allow displaying program IO in the GDB buffer.

[Eli Zaretskii]

> Cc: 65007@debbugs.gnu.org
> From: StrawberryTea <look@strawberrytea.xyz>
> Date: Sat, 26 Aug 2023 14:37:06 -0400
> 
> I’m not sure whether I should reply or always send the edited patch in as a separate email and have been emailing several times but no longer getting responses. I made the changes you requested:

It is best to send an updated patch, yes.  That will make the job of
installing the changes easier and less error-prone.

Don't worry about the responses, your messages are being received and
taken care of, and the changes will be installed once there are no
more review comments.

Thank you for working on this problem.

bug#65007: [PATCH] Allow displaying program IO in the GDB buffer.

[Eli Zaretskii]

Ping!  Did you have time to produce an updated patch incorporating all
the review comments?  If so, please post it.  I'd like to install this
change when it is ready.

Thanks.

> Cc: luangruo@yahoo.com, 65007@debbugs.gnu.org
> Date: Sun, 27 Aug 2023 11:01:44 +0300
> From: Eli Zaretskii <eliz@gnu.org>
> 
> > Cc: 65007@debbugs.gnu.org
> > From: StrawberryTea <look@strawberrytea.xyz>
> > Date: Sat, 26 Aug 2023 14:37:06 -0400
> > 
> > I’m not sure whether I should reply or always send the edited patch in as a separate email and have been emailing several times but no longer getting responses. I made the changes you requested:
> 
> It is best to send an updated patch, yes.  That will make the job of
> installing the changes easier and less error-prone.
> 
> Don't worry about the responses, your messages are being received and
> taken care of, and the changes will be installed once there are no
> more review comments.
> 
> Thank you for working on this problem.
> 
> 
> 
> 

bug#65007: [PATCH] Allow displaying program IO in the GDB buffer.

[StrawberryTea]

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

Eli Zaretskii <eliz@gnu.org> writes:
Yup. Here it is. By the way, is there any information on debugging or stepping through the display engine?


lisp/progmodes/gdb-mi.el (gdb-split-io-flag): Don’t create IO
═════════════════════════════════════════════════════════════

buffer if `gdb-split-io-flag’.
(gdb-split-io-flag): New user option.
—
 lisp/progmodes/gdb-mi.el | 14 +++++++++++—
 1 file changed, 11 insertions(+), 3 deletions(-)

diff –git a/lisp/progmodes/gdb-mi.el b/lisp/progmodes/gdb-mi.el
index 42c1c715c73..8ce5df6e0c7 100644
— a/lisp/progmodes/gdb-mi.el
+++ b/lisp/progmodes/gdb-mi.el
@@ -1098,9 +1098,10 @@ gdb-init-1
                      (if gdb-debuginfod-enable “on” “off”))
              ’gdb-debuginfod-message)

• (gdb-get-buffer-create ’gdb-inferior-io)
• (gdb-clear-inferior-io)
• (gdb-inferior-io–init-proc (get-process “gdb-inferior”))
⁃ (when gdb-display-io-buffer
⁃ (gdb-get-buffer-create ’gdb-inferior-io)
⁃ (gdb-clear-inferior-io)
⁃ (gdb-inferior-io–init-proc (get-process “gdb-inferior”)))

  (when (eq system-type ’windows-nt)
    ;; Don’t create a separate console window for the debuggee.
@@ -1828,6 +1829,13 @@ gdb-display-io-nopopup
   :group ’gdb
   :version “25.1”)

+(defcustom gdb-display-io-buffer t
⁃ “When non-nil, display the `gdb-inferior-io’ buffer.  Otherwise,
+send program output to the GDB buffer.“
⁃ :type ’boolean
⁃ :group ’gdb
⁃ :version “30.1”)
⁃ (defun gdb-inferior-filter (proc string)
    (unless (string-equal string “”)
      (let (buf)
– 
2.42.0

> Ping!  Did you have time to produce an updated patch incorporating all
> the review comments?  If so, please post it.  I’d like to install this
> change when it is ready.
>
> Thanks.
>
>> Cc: luangruo@yahoo.com, 65007@debbugs.gnu.org
>> Date: Sun, 27 Aug 2023 11:01:44 +0300
>> From: Eli Zaretskii <eliz@gnu.org>
>>
>> > Cc: 65007@debbugs.gnu.org
>> > From: StrawberryTea <look@strawberrytea.xyz>
>> > Date: Sat, 26 Aug 2023 14:37:06 -0400
>> >
>> > I’m not sure whether I should reply or always send the edited patch in as a separate email and have been emailing several times but no longer getting responses. I made the changes you requested:
>>
>> It is best to send an updated patch, yes.  That will make the job of
>> installing the changes easier and less error-prone.
>>
>> Don’t worry about the responses, your messages are being received and
>> taken care of, and the changes will be installed once there are no
>> more review comments.
>>
>> Thank you for working on this problem.
>>
>>
>>
>>

bug#65007: [PATCH] Allow displaying program IO in the GDB buffer.

[Eli Zaretskii]

> From: StrawberryTea <look@strawberrytea.xyz>
> Cc: luangruo@yahoo.com, 65007@debbugs.gnu.org
> Date: Sat, 16 Sep 2023 00:38:21 -0500
> 
> Yup. Here it is.

Thanks.  But did you forget to attach the patch?  I see a strangely
formatted patch, with some Unicode symbols instead of ASCII characters
I expect to see in diffs.

> By the way, is there any information on debugging or stepping through the display engine?

Yes, see etc/DEBUG, under "Debugging Emacs redisplay problems".

bug#65007: [PATCH] Allow displaying program IO in the GDB buffer.

[StrawberryTea]

Yeah, I added `org-msg' and I have been trying to figure out how to send
a patch with it. Probably I would need to put it in a source block. But
I just turned that off

* lisp/progmodes/gdb-mi.el (gdb-split-io-flag): Don't create IO
buffer if `gdb-split-io-flag'.
(gdb-split-io-flag): New user option.
---
 lisp/progmodes/gdb-mi.el | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/lisp/progmodes/gdb-mi.el b/lisp/progmodes/gdb-mi.el
index 42c1c715c73..8ce5df6e0c7 100644
--- a/lisp/progmodes/gdb-mi.el
+++ b/lisp/progmodes/gdb-mi.el
@@ -1098,9 +1098,10 @@ gdb-init-1
                      (if gdb-debuginfod-enable "on" "off"))
              'gdb-debuginfod-message)

-  (gdb-get-buffer-create 'gdb-inferior-io)
-  (gdb-clear-inferior-io)
-  (gdb-inferior-io--init-proc (get-process "gdb-inferior"))
+  (when gdb-display-io-buffer
+    (gdb-get-buffer-create 'gdb-inferior-io)
+    (gdb-clear-inferior-io)
+    (gdb-inferior-io--init-proc (get-process "gdb-inferior")))

   (when (eq system-type 'windows-nt)
     ;; Don't create a separate console window for the debuggee.
@@ -1828,6 +1829,13 @@ gdb-display-io-nopopup
   :group 'gdb
   :version "25.1")

+(defcustom gdb-display-io-buffer t
+  "When non-nil, display the `gdb-inferior-io' buffer.  Otherwise,
+send program output to the GDB buffer."
+  :type 'boolean
+  :group 'gdb
+  :version "30.1")
+
 (defun gdb-inferior-filter (proc string)
   (unless (string-equal string "")
     (let (buf)
--
2.42.0
Eli Zaretskii <eliz@gnu.org> writes:

>> From: StrawberryTea <look@strawberrytea.xyz>
>> Cc: luangruo@yahoo.com, 65007@debbugs.gnu.org
>> Date: Sat, 16 Sep 2023 00:38:21 -0500
>>
>> Yup. Here it is.
>
> Thanks.  But did you forget to attach the patch?  I see a strangely
> formatted patch, with some Unicode symbols instead of ASCII characters
> I expect to see in diffs.
>
>> By the way, is there any information on debugging or stepping through the display engine?
>
> Yes, see etc/DEBUG, under "Debugging Emacs redisplay problems".

bug#65007: [PATCH] Allow displaying program IO in the GDB buffer.

[Eli Zaretskii]

> From: StrawberryTea <look@strawberrytea.xyz>
> Cc: luangruo@yahoo.com, 65007@debbugs.gnu.org
> Date: Sat, 16 Sep 2023 01:08:44 -0500
> 
> Yeah, I added `org-msg' and I have been trying to figure out how to send
> a patch with it. Probably I would need to put it in a source block. But
> I just turned that off

Thanks, installed on the master branch (with some changes), and
closing the bug.

With this patch, you exhausted the amount of changes we can accept
from you without a copyright assignment.  Would you like to start the
legal paperwork of assigning the copyright to the FSF at this time?
If yes, I will send you the form to fill and the instructions to email
the form.

Thanks.

bug#65007: [PATCH] Allow displaying program IO in the GDB buffer.

[StrawberryTea]

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

Sure. I’ll start the paperwork.

Eli Zaretskii <eliz@gnu.org> writes:

>> From: StrawberryTea <look@strawberrytea.xyz>
>> Cc: luangruo@yahoo.com, 65007@debbugs.gnu.org
>> Date: Sat, 16 Sep 2023 01:08:44 -0500
>>
>> Yeah, I added `org-msg’ and I have been trying to figure out how to send
>> a patch with it. Probably I would need to put it in a source block. But
>> I just turned that off
>
> Thanks, installed on the master branch (with some changes), and
> closing the bug.
>
> With this patch, you exhausted the amount of changes we can accept
> from you without a copyright assignment.  Would you like to start the
> legal paperwork of assigning the copyright to the FSF at this time?
> If yes, I will send you the form to fill and the instructions to email
> the form.
>
> Thanks.

bug#65007: [PATCH] Allow displaying program IO in the GDB buffer.

[Eli Zaretskii]

> From: StrawberryTea <look@strawberrytea.xyz>
> Cc: luangruo@yahoo.com, 65007-done@debbugs.gnu.org
> Date: Sun, 17 Sep 2023 23:14:59 -0500
> 
> Sure. I’ll start the paperwork.

Thanks, form sent off-list.