From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from simark.ca by simark.ca with LMTP id yD0MFmuMx19/aQAAWB0awg (envelope-from ) for ; Wed, 02 Dec 2020 07:45:31 -0500 Received: by simark.ca (Postfix, from userid 112) id 550801F0AB; Wed, 2 Dec 2020 07:45:31 -0500 (EST) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on simark.ca X-Spam-Level: X-Spam-Status: No, score=0.2 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,MAILING_LIST_MULTI,RDNS_NONE,URIBL_BLOCKED autolearn=no autolearn_force=no version=3.4.2 Received: from sourceware.org (unknown [8.43.85.97]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by simark.ca (Postfix) with ESMTPS id E883A1E58E for ; Wed, 2 Dec 2020 07:45:30 -0500 (EST) Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 12386385803B; Wed, 2 Dec 2020 12:45:30 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 12386385803B DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1606913130; bh=EHOdehgY3NYUmUoMK2W4lycUAJgaq8dqIlmTUmw6uzM=; h=Date:To:Subject:References:In-Reply-To:List-Id:List-Unsubscribe: List-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:Cc: From; b=SadmCvD88iYgwsFi38VaRbcafqZedUqmPPwpkto4ObnFIRlSS6yVgcIR3RC7Tsj31 x5L1oGkYiDV+Kkjtpf+tptjIcHHGbBPIEQt4BAXMBYXkGfMa3+fUxAqlQwV2Adwxo4 tVZmfsmz7MSXcWVAnU6bPpg5Y6jEyjfFBeDEVyV0= Received: from mail-pj1-x1033.google.com (mail-pj1-x1033.google.com [IPv6:2607:f8b0:4864:20::1033]) by sourceware.org (Postfix) with ESMTPS id B9C303857801 for ; Wed, 2 Dec 2020 12:45:26 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org B9C303857801 Received: by mail-pj1-x1033.google.com with SMTP id hk16so920883pjb.4 for ; Wed, 02 Dec 2020 04:45:26 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to; bh=EHOdehgY3NYUmUoMK2W4lycUAJgaq8dqIlmTUmw6uzM=; b=euZR1azjAnvvEtA6DIepgjyTYBbpsyfD9WBfkQ/rn2tGJ38CviCwlqli7fU6LeNS7g uo/H/p1siRQ2lwlj5oYNVrjnRUtLJOnrNB0zj0xpTARNh6RtaYKNFtcrS0/5aRDdP4dP bVuROj9Z8DfLnW4yIK0Mj54aSTqDKZYygl3br5NoADf7q8ge2Tn/oE8X0qikrdnm1czU ZrhwIK9S7FnbL23mzjU8TWwyDbJCpwQc3LeKGB5HxZDPzKnA044vHkwSZN40ykmB0clk C50NsE+ACZ+uvAgoK4/19bepDZkQk2gcjhCeBxuPRmca+IqwpfHYZC0Kvx0C1xSjYFgy Z6JQ== X-Gm-Message-State: AOAM530mC4rKKehw3CiGMjPWwkt3xY1HaICqbG2LE432NHIzH9gay3vX FSzz0EDgYNNYBen2b9ogTcP2L1PpTCw= X-Google-Smtp-Source: ABdhPJwpj4L2p+kG+YAfa+aPSJSojZKW522bJzpXyYgaQI42IVuZaFVH8CdrGDBS2oxrFxnWSMQDtg== X-Received: by 2002:a17:902:8bcb:b029:d9:d765:d7f3 with SMTP id r11-20020a1709028bcbb02900d9d765d7f3mr2529074plo.69.1606913125521; Wed, 02 Dec 2020 04:45:25 -0800 (PST) Received: from raekf.iptime.org ([122.37.26.177]) by smtp.gmail.com with ESMTPSA id l23sm2252558pgn.40.2020.12.02.04.45.24 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 02 Dec 2020 04:45:25 -0800 (PST) Date: Wed, 2 Dec 2020 21:45:22 +0900 To: gdb-patches@sourceware.org Subject: [PATCH v2] gdb: multi-line support for "document" command Message-ID: <20201202124522.tq5a7uqyqatsldrd@raekf.iptime.org> References: <20201128142453.893743-1-rae.kim@gmail.com> <6189864a-c6e8-61a5-e439-cc253b7a33eb@simark.ca> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <6189864a-c6e8-61a5-e439-cc253b7a33eb@simark.ca> X-BeenThere: gdb-patches@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , From: Rae Kim via Gdb-patches Reply-To: Rae Kim Cc: Simon Marchi Errors-To: gdb-patches-bounces@sourceware.org Sender: "Gdb-patches" "document" command executed in python, gdb.execute("document \n...\nend\n"), will wait for user input. Python extension stops working from that point. multi-line suport was introduced in commit 56bcdbea2. But "document" support seem to be implemented. gdb/ChangeLog: 2020-12-02 Rae Kim * cli/cli-script.c (do_document_command): Rename from document_command. Handle multi-line input. (multi_line_command_p): Handle document_control. (build_command_line): Likewise. (execute_control_command_1): Likewise. (process_next_line): Likewise. (document_command): Call do_document_command. * cli/cli-script.h (enum command_control_type): Add document_control. gdb/testsuite/ChangeLog: 2020-12-02 Rae Kim * gdb.base/document.exp: New test. --- gdb/cli/cli-script.c | 49 ++++++++++++++++++++++++----- gdb/cli/cli-script.h | 1 + gdb/testsuite/gdb.base/document.exp | 33 +++++++++++++++++++ 3 files changed, 76 insertions(+), 7 deletions(-) create mode 100644 gdb/testsuite/gdb.base/document.exp diff --git a/gdb/cli/cli-script.c b/gdb/cli/cli-script.c index afa44af95a..c9c4a713de 100644 --- a/gdb/cli/cli-script.c +++ b/gdb/cli/cli-script.c @@ -51,6 +51,9 @@ recurse_read_control_structure static void do_define_command (const char *comname, int from_tty, const counted_command_line *commands); +static void do_document_command (const char *comname, int from_tty, + const counted_command_line *commands); + static const char *read_next_line (); /* Level of control structure when reading. */ @@ -71,6 +74,9 @@ static cmd_list_element *if_cmd_element = nullptr; /* Command element for the 'define' command. */ static cmd_list_element *define_cmd_element = nullptr; +/* Command element for the 'document' command. */ +static cmd_list_element *document_cmd_element = nullptr; + /* Structure for arguments to user defined functions. */ class user_args @@ -139,6 +145,7 @@ multi_line_command_p (enum command_control_type type) case python_control: case guile_control: case define_control: + case document_control: return 1; default: return 0; @@ -159,6 +166,8 @@ build_command_line (enum command_control_type type, const char *args) error (_("while command requires an argument.")); else if (type == define_control) error (_("define command requires an argument.")); + else if (type == document_control) + error (_("document command requires an argument.")); } gdb_assert (args != NULL); @@ -679,6 +688,12 @@ execute_control_command_1 (struct command_line *cmd, int from_tty) ret = simple_control; break; + case document_control: + print_command_trace ("document %s", cmd->line); + do_document_command (cmd->line, 0, &cmd->body_list_0); + ret = simple_control; + break; + case python_control: case guile_control: { @@ -1019,6 +1034,8 @@ process_next_line (const char *p, struct command_line **command, *command = build_command_line (commands_control, line_first_arg (p)); else if (cmd == define_cmd_element) *command = build_command_line (define_control, line_first_arg (p)); + else if (cmd == document_cmd_element) + *command = build_command_line (document_control, line_first_arg (p)); else if (cmd == python_cmd_element && !inline_cmd) { /* Note that we ignore the inline "python command" form @@ -1508,8 +1525,13 @@ define_command (const char *comname, int from_tty) do_define_command (comname, from_tty, nullptr); } +/* Document a user-defined command. If COMMANDS is NULL, then this is a + top-level call and the document will be read using read_command_lines. + Otherwise, it is a "document" command in an existing command and the + commands are provided. */ static void -document_command (const char *comname, int from_tty) +do_document_command (const char *comname, int from_tty, + const counted_command_line *commands) { struct cmd_list_element *c, **list; const char *tem; @@ -1524,10 +1546,16 @@ document_command (const char *comname, int from_tty) if (c->theclass != class_user) error (_("Command \"%s\" is built-in."), comfull); - std::string prompt = string_printf ("Type documentation for \"%s\".", - comfull); - counted_command_line doclines = read_command_lines (prompt.c_str (), - from_tty, 0, 0); + counted_command_line doclines; + + if (commands == nullptr) + { + std::string prompt + = string_printf ("Type documentation for \"%s\".", comfull); + doclines = read_command_lines (prompt.c_str (), from_tty, 0, 0); + } + else + doclines = *commands; xfree ((char *) c->doc); @@ -1553,6 +1581,12 @@ document_command (const char *comname, int from_tty) } } +static void +document_command (const char *comname, int from_tty) +{ + do_document_command (comname, from_tty, nullptr); +} + /* Implementation of the "define-prefix" command. */ static void @@ -1676,11 +1710,12 @@ _initialize_cli_script () /* "document", "define" and "define-prefix" use command_completer, as this helps the user to either type the command name and/or its prefixes. */ - c = add_com ("document", class_support, document_command, _("\ + document_cmd_element = add_com ("document", class_support, document_command, + _("\ Document a user-defined command.\n\ Give command name as argument. Give documentation on following lines.\n\ End with a line of just \"end\".")); - set_cmd_completer (c, command_completer); + set_cmd_completer (document_cmd_element, command_completer); define_cmd_element = add_com ("define", class_support, define_command, _("\ Define a new command name. Command name is argument.\n\ Definition appears on following lines, one command per line.\n\ diff --git a/gdb/cli/cli-script.h b/gdb/cli/cli-script.h index fcae9abaa9..6ad6e61fb4 100644 --- a/gdb/cli/cli-script.h +++ b/gdb/cli/cli-script.h @@ -45,6 +45,7 @@ enum command_control_type guile_control, while_stepping_control, define_control, + document_control, invalid_control }; diff --git a/gdb/testsuite/gdb.base/document.exp b/gdb/testsuite/gdb.base/document.exp new file mode 100644 index 0000000000..6fac62d303 --- /dev/null +++ b/gdb/testsuite/gdb.base/document.exp @@ -0,0 +1,33 @@ +# Copyright 1998-2020 Free Software Foundation, Inc. + +# 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 . + +standard_testfile break.c break1.c + +if {[prepare_for_testing "failed to prepare" ${testfile} \ + [list $srcfile $srcfile2] {debug nowarnings}]} { + return -1 +} + +# test document command used within user command. +gdb_test_multiple "define do-document" "" { + -re "Type commands for definition of \"do-document\".\r\nEnd with a line saying just \"end\".\r\n>$" { + gdb_test "document do-document\nusage: do-document\nend\nend" "" "define do-document" + } +} +gdb_test_no_output "do-document" "invoke do-document" +gdb_test "help do-document" "usage: do-document" "invoke help do-document" + +gdb_exit +return 0 -- 2.28.0