From patchwork Fri May 6 12:35:00 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Pedro Alves X-Patchwork-Id: 12093 Received: (qmail 126648 invoked by alias); 6 May 2016 12:42:54 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Unsubscribe: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Delivered-To: mailing list gdb-patches@sourceware.org Received: (qmail 126623 invoked by uid 89); 6 May 2016 12:42:52 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-4.0 required=5.0 tests=BAYES_00, RP_MATCHES_RCVD, SPF_HELO_PASS autolearn=ham version=3.3.2 spammy=enters, sc, 2718, 5210 X-HELO: mx1.redhat.com Received: from mx1.redhat.com (HELO mx1.redhat.com) (209.132.183.28) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with (AES256-GCM-SHA384 encrypted) ESMTPS; Fri, 06 May 2016 12:42:51 +0000 Received: from int-mx14.intmail.prod.int.phx2.redhat.com (int-mx14.intmail.prod.int.phx2.redhat.com [10.5.11.27]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 39BE581137 for ; Fri, 6 May 2016 12:35:33 +0000 (UTC) Received: from cascais.lan (ovpn01.gateway.prod.ext.phx2.redhat.com [10.5.9.1]) by int-mx14.intmail.prod.int.phx2.redhat.com (8.14.4/8.14.4) with ESMTP id u46CZ5IR017259 for ; Fri, 6 May 2016 08:35:32 -0400 From: Pedro Alves To: gdb-patches@sourceware.org Subject: [PATCH v3 30/34] [DOC] Document support for running interpreters on separate UI channels Date: Fri, 6 May 2016 13:35:00 +0100 Message-Id: <1462538104-19109-31-git-send-email-palves@redhat.com> In-Reply-To: <1462538104-19109-1-git-send-email-palves@redhat.com> References: <1462538104-19109-1-git-send-email-palves@redhat.com> gdb/ChangeLog: yyyy-mm-dd Pedro Alves * NEWS: Mention support for running interpreters on separate channels and the new new-ui command. gdb/doc/ChangeLog: yyyy-mm-dd Pedro Alves * gdb.texinfo (Interpreters): Update intepreter-exec section, document new-ui and explain use case. --- gdb/doc/gdb.texinfo | 55 +++++++++++++++++++++++++++++++++++++++++++---------- gdb/NEWS | 16 ++++++++++++++++ 2 files changed, 61 insertions(+), 10 deletions(-) diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index f74c41c..c89486d 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -24805,18 +24805,11 @@ The @sc{gdb/mi} interface included in @value{GDBN} 5.1, 5.2, and 5.3. @end table @cindex invoke another interpreter -The interpreter being used by @value{GDBN} may not be dynamically -switched at runtime. Although possible, this could lead to a very -precarious situation. Consider an IDE using @sc{gdb/mi}. If a user -enters the command "interpreter-set console" in a console view, -@value{GDBN} would switch to using the console interpreter, rendering -the IDE inoperable! @kindex interpreter-exec -Although you may only choose a single interpreter at startup, you may execute -commands in any interpreter from the current interpreter using the appropriate -command. If you are running the console interpreter, simply use the -@code{interpreter-exec} command: +You may execute commands in any interpreter from the current +interpreter using the appropriate command. If you are running the +console interpreter, simply use the @code{interpreter-exec} command: @smallexample interpreter-exec mi "-data-list-register-names" @@ -24825,6 +24818,48 @@ interpreter-exec mi "-data-list-register-names" @sc{gdb/mi} has a similar command, although it is only available in versions of @value{GDBN} which support @sc{gdb/mi} version 2 (or greater). +Note that @code{interpreter-exec} only changes the interpreter for the +duration of the specified command. It does change the interpreter +permanently. + +@cindex start a new independent interpreter + +Although you may only choose a single interpreter at startup, it is +possible to run an independent interpreter on a separate channel. + +For example, consider a debugger GUI or IDE that wants to provide a +@value{GDBN} console view. It may do so by embedding a terminal +window widget in its GUI, starting @value{GDBN} with the default +console interpreter running on that terminal, and then opening a +secondary communication channel running the MI interpreter. The +console interpreter created by @value{GDBN} at startup handles +commands the user types in the terminal widget, while the GUI controls +and synchronizes state with @value{GDBN} using the separate MI +channel. + +To start a new secondary @dfn{user interface} channel running MI, use +the @code{new-ui} command: + +@kindex new-ui +@cindex new user interface +@smallexample +new-ui @var{interpreter} @var{tty} +@end smallexample + +The @var{interpreter} parameter specifies the interpreter to run. +This accepts the same values as the @code{interpreter-exec} command. +For example, @samp{console}, @samp{mi}, @samp{mi2}, etc. The +@var{tty} parameter specifies the name of the bidirectional file the +interpreter uses for input/output, usually the name of a +pseudoterminal slave on Unix systems. For example: + +@smallexample +(@value{GDBP}) new-ui mi /dev/pts/9 +@end smallexample + +@noindent +runs an MI interpreter on @file{/dev/pts/9}. + @node TUI @chapter @value{GDBN} Text User Interface @cindex TUI diff --git a/gdb/NEWS b/gdb/NEWS index 7bf1e1a..c280300 100644 --- a/gdb/NEWS +++ b/gdb/NEWS @@ -27,6 +27,18 @@ Bounds: [lower = 0x7fffffffc390, upper = 0x7fffffffc3a3] 0x0000000000400d7c in upper () at i386-mpx-sigsegv.c:68 +* Support for running interpreters on separate channels + + GDB now supports a new mechanism that allows frontends to provide + fully featured GDB console views, as a better alternative to + building such views on top of the "-interpreter-exec console" + command. See the new "new-ui" command below. With that command, + frontends can now start GDB in console mode running on an embedded + terminal widget, and open a separate MI channel for the usual MI + control and synchronization invisible to the user. In this way, GDB + handles line editing, history, tab completion, etc. in the console + all by itself. + * New commands skip -file file @@ -40,6 +52,10 @@ skip -rfunction regular-expression maint info line-table REGEXP Display the contents of GDB's internal line table data struture. +new-ui INTERP TTY + Start a new user interface instance running INTERP as interpreter, + using the TTY file for input/output. + * Support for tracepoints and fast tracepoints on s390-linux and s390x-linux was added in GDBserver, including JIT compiling fast tracepoint's conditional expression bytecode into native code.