From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by sourceware.org (Postfix) with ESMTPS id D07D1386EC3C for ; Fri, 28 Jan 2022 15:55:30 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org D07D1386EC3C Received: from mail-wr1-f70.google.com (mail-wr1-f70.google.com [209.85.221.70]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-262-yWg_EbiQMr69cTKYFrxwaw-1; Fri, 28 Jan 2022 10:55:29 -0500 X-MC-Unique: yWg_EbiQMr69cTKYFrxwaw-1 Received: by mail-wr1-f70.google.com with SMTP id m17-20020adfa3d1000000b001dd66c10c0cso2377995wrb.19 for ; Fri, 28 Jan 2022 07:55:28 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=fEU+X4Jw69xjUENd3PZGkCMynPCcZlLX/83tgzlKBzk=; b=0xbS+RhFA1+z+AYHcuFpKr1bM1gYjbZfj3XysBzIFlaauDxYIwbqkNBuLLfGMHw9uC tt1+rzALeQK0sqObUAxrEqC5ITsYd4q1SIOcSPcg5c3YJ8ELIfNKYaTRzw9IRwv3Kv5Y Oozj0X351DqE9YznfVdkhxfgSYs00HFrydk5L55pKyfhd464rfWMDD/CbG7x3FxiK02V zGtBNUvXxMzSf623UaFFXzgOQdbHWnrReMfgffmHcZuThhMvBt1jeevwULB7k36mGDT3 er0hDlCgtKbo3pyLjQOXMcri2S/pTWY9iDLNZX0wcT/q1WPS0/Kz6+i7++bM8P3BlsN6 cd0w== X-Gm-Message-State: AOAM533JtObBtbVuKkv5IogOVLRLKKOUswetS1qGHSbd7HclyK6xDKg4 qKcFeMTBNNAlTKMRqcbQjiU5rhkF2US5hkmxpdAFhn2tovckN1ZrBcMEFfyAgisrXak6wcUuhPf mSIfWD+b0KX5HqzlboDej0jLmRhfkGOKKOQaX+ZdeCwSbp58eOpznL//3LZV3u+xXjmje0Cx8AA == X-Received: by 2002:a5d:598c:: with SMTP id n12mr7680291wri.478.1643385327019; Fri, 28 Jan 2022 07:55:27 -0800 (PST) X-Google-Smtp-Source: ABdhPJzTPKNHXDhICUpityQwHfpVemjkWJg3FtMyNhAO3BUOwXZkBSO1IpLT6ZELxt8FyzGbFpnvXA== X-Received: by 2002:a5d:598c:: with SMTP id n12mr7680254wri.478.1643385326304; Fri, 28 Jan 2022 07:55:26 -0800 (PST) Received: from localhost (host86-140-92-93.range86-140.btcentralplus.com. [86.140.92.93]) by smtp.gmail.com with ESMTPSA id m187sm2159666wme.25.2022.01.28.07.55.25 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 28 Jan 2022 07:55:26 -0800 (PST) From: Andrew Burgess To: gdb-patches@sourceware.org Cc: Andrew Burgess Subject: [PATCH 7/7] gdb/tui: add new 'tui window width' command and 'winwidth' alias Date: Fri, 28 Jan 2022 15:55:08 +0000 Message-Id: <863bdb27ed4a48d595f5780b39a2b06e12bac0d8.1643385021.git.aburgess@redhat.com> X-Mailer: git-send-email 2.25.4 In-Reply-To: References: MIME-Version: 1.0 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: 8bit Content-Type: text/plain; charset="US-ASCII" X-Spam-Status: No, score=-11.9 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, KAM_SHORT, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H2, SPF_HELO_NONE, SPF_NONE, TXREP, T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.4 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on server2.sourceware.org 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: , X-List-Received-Date: Fri, 28 Jan 2022 15:55:33 -0000 This commit adds a new command 'tui window width', and an alias 'winwidth'. This command is equivalent to the old 'winheight' command (which was recently renamed 'tui window height'). Even though I recently moved the old tui commands under the tui namespace, and I would strongly encourage all new tui commands to be added as 'tui ....' only (users can create their own top-level aliases if they want), I'm breaking that suggestion here, and adding a 'winwidth' alias. Given that we already have 'winheight' and have done for years, it just didn't seem right to no have the matching 'winwidth'. You might notice in the test that the window resizing doesn't quite work right. I setup a horizontal layout, then grow and shrink the windows. At the end of the test the windows should be back to their original size... ... they are not. This isn't my fault, honest! GDB's window resizing is a little ... temperamental, and is prone to getting things slightly wrong during resizes, off by 1 type things. This is true for height resizing, as well as the new width resizing. I'm currently working on a patch to improve the resizing algorithm, which should improve things in this area. For now, I'm happy that the width resizing is as good as the height resizing, given the existing quirks. As for the changes in gdb itself, I've mostly just templated the existing height adjustment code so that the two functions tui_layout_split::adjust_size (tui-layout.c) and tui_set_win_height_command (tui-win.c) now have a template parameter "policy", this policy allows me to specialise the functions for either width or height adjustment. Function arguments, and locals, are renamed, replacing 'height' with 'size'. --- gdb/NEWS | 6 ++ gdb/doc/gdb.texinfo | 12 ++++ gdb/testsuite/gdb.tui/winwidth.exp | 62 +++++++++++++++++ gdb/tui/tui-layout.c | 23 +++++-- gdb/tui/tui-layout.h | 104 ++++++++++++++++++++++++++++- gdb/tui/tui-win.c | 99 +++++++++++++++++++++++++-- 6 files changed, 291 insertions(+), 15 deletions(-) create mode 100644 gdb/testsuite/gdb.tui/winwidth.exp diff --git a/gdb/NEWS b/gdb/NEWS index f97f643b6ee..1faef78056a 100644 --- a/gdb/NEWS +++ b/gdb/NEWS @@ -89,6 +89,12 @@ tui window height and 'winheight' tui commands respectively. The old names still exist as aliases to these new commands. +tui window width +winwidth + The new command 'tui window width', and the alias 'winwidth' allow + the width of a tui window to be adjusted when windows are laid out + in horizontal mode. + * Changed commands maint packet diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index df35887a304..cb5cfbaefc1 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -28975,6 +28975,18 @@ it. The @var{name} parameter can be the name of any currently visible window. The names of the currently visible windows can be discovered using @code{info win} (@pxref{info_win_command,,info win}). + +@kindex tui window width +@kindex winwidth +@item tui window width @var{name} +@var{count} +@itemx tui window width @var{name} -@var{count} +@itemx winwidth @var{name} +@var{count} +@itemx winwidth @var{name} -@var{count} +Change the width of the window @var{name} by @var{count} columns. +Positive counts increase the width, while negative counts decrease it. +The @var{name} parameter can be the name of any currently visible +window. The names of the currently visible windows can be discovered +using @code{info win} (@pxref{info_win_command,,info win}). @end table @node TUI Configuration diff --git a/gdb/testsuite/gdb.tui/winwidth.exp b/gdb/testsuite/gdb.tui/winwidth.exp new file mode 100644 index 00000000000..b0a838b578f --- /dev/null +++ b/gdb/testsuite/gdb.tui/winwidth.exp @@ -0,0 +1,62 @@ +# Copyright 2022 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 . + +# Test the "winwidth" command. + +tuiterm_env + +standard_testfile tui-layout.c + +if {[build_executable "failed to prepare" ${testfile} ${srcfile}] == -1} { + return -1 +} + +Term::clean_restart 24 80 $testfile +if {![Term::enter_tui]} { + unsupported "TUI not supported" + return +} + +Term::command "tui new-layout h { -horizontal src 1 asm 1 } 1 status 0 cmd 1" +Term::command "layout h" + +with_test_prefix "original window sizes" { + Term::check_box "source box" 0 0 40 15 + Term::check_box "asm box" 39 0 41 15 + Term::command "winwidth src +5" +} + +with_test_prefix "after src +5" { + Term::check_box "source box" 0 0 44 15 + Term::check_box "asm box" 43 0 37 15 + Term::command "winwidth asm -5" +} + +with_test_prefix "after asm -5" { + Term::check_box "source box" 0 0 48 15 + Term::check_box "asm box" 47 0 33 15 + Term::command "winwidth asm +8" +} + +with_test_prefix "after asm +8" { + Term::check_box "source box" 0 0 39 15 + Term::check_box "asm box" 38 0 42 15 + Term::command "winwidth src -2" +} + +with_test_prefix "after src -2" { + Term::check_box "source box" 0 0 36 15 + Term::check_box "asm box" 35 0 45 15 +} diff --git a/gdb/tui/tui-layout.c b/gdb/tui/tui-layout.c index 9e856ccf3fa..13e4d462426 100644 --- a/gdb/tui/tui-layout.c +++ b/gdb/tui/tui-layout.c @@ -121,6 +121,14 @@ tui_adjust_window_height (struct tui_win_info *win, int new_height) applied_layout->set_height (win->name (), new_height); } +/* See tui-layout. */ + +void +tui_adjust_window_width (struct tui_win_info *win, int new_width) +{ + applied_layout->set_width (win->name (), new_width); +} + /* Set the current layout to LAYOUT. */ static void @@ -570,8 +578,9 @@ tui_layout_split::set_weights_from_sizes () /* See tui-layout.h. */ +template tui_adjust_result -tui_layout_split::set_height (const char *name, int new_height) +tui_layout_split::set_size (const char *name, int new_size) { /* Look through the children. If one is a layout holding the named window, we're done; or if one actually is the named window, @@ -580,12 +589,12 @@ tui_layout_split::set_height (const char *name, int new_height) for (int i = 0; i < m_splits.size (); ++i) { tui_adjust_result adjusted - = m_splits[i].layout->set_height (name, new_height); + = Policy::set_size (m_splits[i].layout, name, new_size); if (adjusted == HANDLED) return HANDLED; if (adjusted == FOUND) { - if (!m_vertical) + if (!Policy::can_adjust (this)) return FOUND; found_index = i; break; @@ -594,12 +603,12 @@ tui_layout_split::set_height (const char *name, int new_height) if (found_index == -1) return NOT_FOUND; - if (m_splits[found_index].layout->height == new_height) + if (Policy::current_size (m_splits[found_index].layout) == new_size) return HANDLED; set_weights_from_sizes (); - int delta = m_splits[found_index].weight - new_height; - m_splits[found_index].weight = new_height; + int delta = m_splits[found_index].weight - new_size; + m_splits[found_index].weight = new_size; /* Distribute the "delta" over the next window; but if the next window cannot hold it all, keep going until we either find a @@ -633,7 +642,7 @@ tui_layout_split::set_height (const char *name, int new_height) if (delta != 0) { - warning (_("Invalid window height specified")); + Policy::invalid_size_warning (); /* Effectively undo any modifications made here. */ set_weights_from_sizes (); } diff --git a/gdb/tui/tui-layout.h b/gdb/tui/tui-layout.h index 8f41835b94c..f4ef0895f1f 100644 --- a/gdb/tui/tui-layout.h +++ b/gdb/tui/tui-layout.h @@ -79,6 +79,10 @@ class tui_layout_base the sizes of the other windows around it. */ virtual tui_adjust_result set_height (const char *name, int new_height) = 0; + /* Set the width of the window named NAME to NEW_WIDTH, updating + the sizes of the other windows around it. */ + virtual tui_adjust_result set_width (const char *name, int new_width) = 0; + /* Remove some windows from the layout, leaving the command window and the window being passed in here. */ virtual void remove_windows (const char *name) = 0; @@ -132,6 +136,11 @@ class tui_layout_window : public tui_layout_base return m_contents == name ? FOUND : NOT_FOUND; } + tui_adjust_result set_width (const char *name, int new_width) override + { + return m_contents == name ? FOUND : NOT_FOUND; + } + bool top_boxed_p () const override; bool bottom_boxed_p () const override; @@ -192,7 +201,15 @@ class tui_layout_split : public tui_layout_base void apply (int x, int y, int width, int height) override; - tui_adjust_result set_height (const char *name, int new_height) override; + tui_adjust_result set_height (const char *name, int new_height) override + { + return set_size (name, new_height); + } + + tui_adjust_result set_width (const char *name, int new_width) override + { + return set_size (name, new_width); + } bool top_boxed_p () const override; @@ -217,6 +234,87 @@ class tui_layout_split : public tui_layout_base private: + /* Used to implement set_height and set_width member functions. Set + either the height or width of the window named NAME to NEW_SIZE, + updating the sizes of the other windows around it as needed. The + POLICY is used to specialize this function to adjust either the height + or the width. */ + + template + tui_adjust_result set_size (const char *name, int new_size); + + /* A policy class for use with the set_size member function, use when we + want to adjust the height of a named window. */ + + struct set_height_policy + { + /* Set the height of window named NAME to NEW_HEIGHT in LAYOUT. */ + static tui_adjust_result + set_size (std::unique_ptr &layout, + const char *name, + int new_height) + { + return layout->set_height (name, new_height); + } + + /* Can we adjust the heights of windows in SPLIT? */ + static bool + can_adjust (const tui_layout_split *split) + { + return split->m_vertical; + } + + /* What is the current height of LAYOUT. */ + static int + current_size (std::unique_ptr &layout) + { + return layout->height; + } + + /* Warn about invalid height specification. */ + static void + invalid_size_warning () + { + warning (_("Invalid window height specified")); + } + }; + + /* A policy class for use with the set_size member function, use when we + want to adjust the width of a named window. */ + + struct set_width_policy + { + /* Set the width of window named NAME to NEW_HEIGHT in LAYOUT. */ + static tui_adjust_result + set_size (std::unique_ptr &layout, + const char *name, + int new_width) + { + return layout->set_width (name, new_width); + } + + /* Can we adjust the widths of windows in SPLIT? */ + static bool + can_adjust (const tui_layout_split *split) + { + return !split->m_vertical; + } + + /* What is the current width of LAYOUT. */ + static int + current_size (std::unique_ptr &layout) + { + return layout->width; + } + + /* Warn about invalid height specification. */ + static void + invalid_size_warning () + { + warning (_("Invalid window width specified")); + } + }; + /* Set the weights from the current heights (when m_vertical is true) or widths (when m_vertical is false). */ void set_weights_from_sizes (); @@ -266,6 +364,10 @@ extern void tui_apply_current_layout (); extern void tui_adjust_window_height (struct tui_win_info *win, int new_height); +/* Adjust the window width of WIN to NEW_WIDTH. */ +extern void tui_adjust_window_width (struct tui_win_info *win, + int new_width); + /* The type of a function that is used to create a TUI window. */ typedef std::function window_factory; diff --git a/gdb/tui/tui-win.c b/gdb/tui/tui-win.c index ba6aca3d078..953af640c93 100644 --- a/gdb/tui/tui-win.c +++ b/gdb/tui/tui-win.c @@ -842,10 +842,21 @@ tui_set_tab_width_command (const char *arg, int from_tty) } } +/* Helper function for the user commands to adjust a window's width or + height. The ARG string contains the command line arguments from the + user, which should give the name of a window, and how to adjust the + size. -/* Set the height of the specified window. */ + The Policy type is used to specialise this function for updating either + the width or height of the window. + + On invalid input, or if the size can't be adjusted as requested, then an + error is thrown, otherwise, the window sizes are adjusted, and the + windows redrawn. */ + +template static void -tui_set_win_height_command (const char *arg, int from_tty) +tui_set_win_size (const char *arg) { /* Make sure the curses mode is enabled. */ tui_enable (); @@ -854,7 +865,7 @@ tui_set_win_height_command (const char *arg, int from_tty) const char *buf = arg; const char *buf_ptr = buf; - int new_height; + int new_size; struct tui_win_info *win_info; buf_ptr = skip_to_space (buf_ptr); @@ -890,18 +901,82 @@ tui_set_win_height_command (const char *arg, int from_tty) if (negate) input_no *= (-1); if (fixed_size) - new_height = input_no; + new_size = input_no; else - new_height = win_info->height + input_no; + new_size = Policy::existing_window_size (win_info) + input_no; /* Now change the window's height, and adjust all other windows around it. */ - tui_adjust_window_height (win_info, new_height); + Policy::adjust_window_size (win_info, new_size); tui_update_gdb_sizes (); } else - error (_("Invalid window height specified")); + Policy::invalid_size_error (); + } +} + +/* Implement the 'tui window height' command (alias 'winheight'). */ + +static void +tui_set_win_height_command (const char *arg, int from_tty) +{ + /* Policy class for use with tui_set_win_size, this policy adjusts the + height of a window. */ + struct height_adjustment_policy + { + /* Called when the size specified is invalid. */ + static void invalid_size_error () + { + error (_("Invalid window height specified")); + } + + /* Return the existing size, height in this case, of a window WIN_INFO. */ + static int existing_window_size (struct tui_win_info *win_info) + { + return win_info->height; + } + + /* Set the size, height in this case, of WIN_INFO to NEW_SIZE. */ + static void adjust_window_size (struct tui_win_info *win_info, + int new_size) + { + tui_adjust_window_height (win_info, new_size); + } + }; + + tui_set_win_size (arg); +} + +/* Implement the 'tui window width' command (alias 'winwidth'). */ + +static void +tui_set_win_width_command (const char *arg, int from_tty) +{ + /* Policy class for use with tui_set_win_size, this policy adjusts the + width of a window. */ + struct width_adjustment_policy + { + /* Called when the size specified is invalid. */ + static void invalid_size_error () + { + error (_("Invalid window width specified")); } + + /* Return the existing size, width in this case, of a window WIN_INFO. */ + static int existing_window_size (struct tui_win_info *win_info) + { + return win_info->width; + } + + /* Set the size, width in this case, of WIN_INFO to NEW_SIZE. */ + static void adjust_window_size (struct tui_win_info *win_info, + int new_size) + { + tui_adjust_window_width (win_info, new_size); + } + }; + + tui_set_win_size (arg); } /* See tui-data.h. */ @@ -1033,6 +1108,16 @@ Use \"info win\" to see the names of the windows currently being displayed."), add_com_alias ("winheight", winheight_cmd, class_tui, 0); add_com_alias ("wh", winheight_cmd, class_tui, 0); set_cmd_completer (winheight_cmd, winheight_completer); + + cmd_list_element *winwidth_cmd + = add_cmd ("width", class_tui, tui_set_win_width_command, _("\ +Set or modify the width of a specified window.\n\ +Usage: tui window width WINDOW-NAME [+ | -] NUM-LINES\n\ +Use \"info win\" to see the names of the windows currently being displayed."), + &tui_window_cmds); + add_com_alias ("winwidth", winwidth_cmd, class_tui, 0); + set_cmd_completer (winwidth_cmd, winheight_completer); + add_info ("win", tui_all_windows_info, _("List of all displayed windows.\n\ Usage: info win")); -- 2.25.4