gdb/tui/tui-layout.h

   1 /* TUI layout window management.
   2
   3    Copyright (C) 1998-2020 Free Software Foundation, Inc.
   4
   5    Contributed by Hewlett-Packard Company.
   6
   7    This file is part of GDB.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  21
  22 #ifndef TUI_TUI_LAYOUT_H
  23 #define TUI_TUI_LAYOUT_H
  24
  25 #include "ui-file.h"
  26
  27 #include "tui/tui.h"
  28 #include "tui/tui-data.h"
  29
  30 /* The basic object in a TUI layout.  This represents a single piece
  31    of screen real estate.  Subclasses determine the exact
  32    behavior.  */
  33 class tui_layout_base
  34 {
  35 public:
  36
  37   DISABLE_COPY_AND_ASSIGN (tui_layout_base);
  38
  39   virtual ~tui_layout_base () = default;
  40
  41   /* Clone this object.  Ordinarily a layout is cloned before it is
  42      used, so that any necessary modifications do not affect the
  43      "skeleton" layout.  */
  44   virtual std::unique_ptr<tui_layout_base> clone () const = 0;
  45
  46   /* Change the size and location of this layout.  */
  47   virtual void apply (int x, int y, int width, int height) = 0;
  48
  49   /* Return the minimum and maximum height of this layout.  */
  50   virtual void get_sizes (int *min_height, int *max_height) = 0;
  51
  52   /* True if the topmost item in this layout is boxed.  */
  53   virtual bool top_boxed_p () const = 0;
  54
  55   /* True if the bottommost item in this layout is boxed.  */
  56   virtual bool bottom_boxed_p () const = 0;
  57
  58   /* Return the name of this layout's window, or nullptr if this
  59      layout does not represent a single window.  */
  60   virtual const char *get_name () const
  61   {
  62     return nullptr;
  63   }
  64
  65   /* Adjust the size of the window named NAME to NEW_HEIGHT, updating
  66      the sizes of the other windows around it.  */
  67   virtual bool adjust_size (const char *name, int new_height) = 0;
  68
  69   /* Remove some windows from the layout, leaving the command window
  70      and the window being passed in here.  */
  71   virtual void remove_windows (const char *name) = 0;
  72
  73   /* Replace the window named NAME in the layout with the window named
  74      NEW_WINDOW.  */
  75   virtual void replace_window (const char *name, const char *new_window) = 0;
  76
  77   /* Append the specification to this window to OUTPUT.  */
  78   virtual void specification (ui_file *output) = 0;
  79
  80   /* The most recent space allocation.  */
  81   int x = 0;
  82   int y = 0;
  83   int width = 0;
  84   int height = 0;
  85
  86 protected:
  87
  88   tui_layout_base () = default;
  89 };
  90
  91 /* A TUI layout object that displays a single window.  The window is
  92    given by name.  */
  93 class tui_layout_window : public tui_layout_base
  94 {
  95 public:
  96
  97   explicit tui_layout_window (const char *name)
  98     : m_contents (name)
  99   {
 100   }
 101
 102   DISABLE_COPY_AND_ASSIGN (tui_layout_window);
 103
 104   std::unique_ptr<tui_layout_base> clone () const override;
 105
 106   void apply (int x, int y, int width, int height) override;
 107
 108   const char *get_name () const override
 109   {
 110     return m_contents.c_str ();
 111   }
 112
 113   bool adjust_size (const char *name, int new_height) override
 114   {
 115     return false;
 116   }
 117
 118   bool top_boxed_p () const override;
 119
 120   bool bottom_boxed_p () const override;
 121
 122   void remove_windows (const char *name) override
 123   {
 124   }
 125
 126   void replace_window (const char *name, const char *new_window) override;
 127
 128   void specification (ui_file *output) override;
 129
 130 protected:
 131
 132   void get_sizes (int *min_height, int *max_height) override;
 133
 134 private:
 135
 136   /* Type of content to display.  */
 137   std::string m_contents;
 138
 139   /* When a layout is applied, this is updated to point to the window
 140      object.  */
 141   tui_gen_win_info *m_window = nullptr;
 142 };
 143
 144 /* A TUI layout that holds other layouts.  */
 145 class tui_layout_split : public tui_layout_base
 146 {
 147 public:
 148
 149   tui_layout_split () = default;
 150
 151   DISABLE_COPY_AND_ASSIGN (tui_layout_split);
 152
 153   /* Add a new split layout to this layout.  WEIGHT is the desired
 154      size, which is relative to the other weights given in this
 155      layout.  */
 156   tui_layout_split *add_split (int weight);
 157
 158   /* Add a new window to this layout.  NAME is the name of the window
 159      to add.  WEIGHT is the desired size, which is relative to the
 160      other weights given in this layout.  */
 161   void add_window (const char *name, int weight);
 162
 163   std::unique_ptr<tui_layout_base> clone () const override;
 164
 165   void apply (int x, int y, int width, int height) override;
 166
 167   bool adjust_size (const char *name, int new_height) override;
 168
 169   bool top_boxed_p () const override;
 170
 171   bool bottom_boxed_p () const override;
 172
 173   void remove_windows (const char *name) override;
 174
 175   void replace_window (const char *name, const char *new_window) override;
 176
 177   void specification (ui_file *output) override;
 178
 179 protected:
 180
 181   void get_sizes (int *min_height, int *max_height) override;
 182
 183 private:
 184
 185   /* Set the weights from the current heights.  */
 186   void set_weights_from_heights ();
 187
 188   struct split
 189   {
 190     /* The requested weight.  */
 191     int weight;
 192     /* The layout.  */
 193     std::unique_ptr<tui_layout_base> layout;
 194   };
 195
 196   /* The splits.  */
 197   std::vector<split> m_splits;
 198
 199   /* True if this layout has already been applied at least once.  */
 200   bool m_applied = false;
 201 };
 202
 203 /* Add the specified window to the layout in a logical way.  This
 204    means setting up the most logical layout given the window to be
 205    added.  Only the source or disassembly window can be added this
 206    way.  */
 207 extern void tui_add_win_to_layout (enum tui_win_type);
 208
 209 /* Set the initial layout.  */
 210 extern void tui_set_initial_layout ();
 211
 212 /* Switch to the next layout.  */
 213 extern void tui_next_layout ();
 214
 215 /* Show the register window.  Like "layout regs".  */
 216 extern void tui_regs_layout ();
 217
 218 /* Remove some windows from the layout, leaving only the focused
 219    window and the command window; if no window has the focus, then
 220    some other window is chosen to remain.  */
 221 extern void tui_remove_some_windows ();
 222
 223 /* Apply the current layout.  */
 224 extern void tui_apply_current_layout ();
 225
 226 /* Adjust the window height of WIN to NEW_HEIGHT.  */
 227 extern void tui_adjust_window_height (struct tui_win_info *win,
 228                                       int new_height);
 229
 230 #endif /* TUI_TUI_LAYOUT_H */