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 "tui/tui.h"
  26 #include "tui/tui-data.h"
  27
  28 /* The basic object in a TUI layout.  This represents a single piece
  29    of screen real estate.  Subclasses determine the exact
  30    behavior.  */
  31 class tui_layout_base
  32 {
  33 public:
  34
  35   DISABLE_COPY_AND_ASSIGN (tui_layout_base);
  36
  37   virtual ~tui_layout_base () = default;
  38
  39   /* Clone this object.  Ordinarily a layout is cloned before it is
  40      used, so that any necessary modifications do not affect the
  41      "skeleton" layout.  */
  42   virtual std::unique_ptr<tui_layout_base> clone () const = 0;
  43
  44   /* Change the size and location of this layout.  */
  45   virtual void apply (int x, int y, int width, int height) = 0;
  46
  47   /* Return the minimum and maximum height of this layout.  */
  48   virtual void get_sizes (int *min_height, int *max_height) = 0;
  49
  50   /* True if the topmost item in this layout is boxed.  */
  51   virtual bool top_boxed_p () const = 0;
  52
  53   /* True if the bottommost item in this layout is boxed.  */
  54   virtual bool bottom_boxed_p () const = 0;
  55
  56   /* Return the name of this layout's window, or nullptr if this
  57      layout does not represent a single window.  */
  58   virtual const char *get_name () const
  59   {
  60     return nullptr;
  61   }
  62
  63   /* Adjust the size of the window named NAME to NEW_HEIGHT, updating
  64      the sizes of the other windows around it.  */
  65   virtual bool adjust_size (const char *name, int new_height) = 0;
  66
  67   /* Remove some windows from the layout, leaving the command window
  68      and the window being passed in here.  */
  69   virtual void remove_windows (const char *name) = 0;
  70
  71   /* The most recent space allocation.  */
  72   int x = 0;
  73   int y = 0;
  74   int width = 0;
  75   int height = 0;
  76
  77 protected:
  78
  79   tui_layout_base () = default;
  80 };
  81
  82 /* A TUI layout object that displays a single window.  The window is
  83    given by name.  */
  84 class tui_layout_window : public tui_layout_base
  85 {
  86 public:
  87
  88   explicit tui_layout_window (const char *name)
  89     : m_contents (name)
  90   {
  91   }
  92
  93   DISABLE_COPY_AND_ASSIGN (tui_layout_window);
  94
  95   std::unique_ptr<tui_layout_base> clone () const override;
  96
  97   void apply (int x, int y, int width, int height) override;
  98
  99   const char *get_name () const override
 100   {
 101     return m_contents.c_str ();
 102   }
 103
 104   bool adjust_size (const char *name, int new_height) override
 105   {
 106     return false;
 107   }
 108
 109   bool top_boxed_p () const override;
 110
 111   bool bottom_boxed_p () const override;
 112
 113   void remove_windows (const char *name) override
 114   {
 115   }
 116
 117 protected:
 118
 119   void get_sizes (int *min_height, int *max_height) override;
 120
 121 private:
 122
 123   /* Type of content to display.  */
 124   std::string m_contents;
 125
 126   /* When a layout is applied, this is updated to point to the window
 127      object.  */
 128   tui_gen_win_info *m_window = nullptr;
 129 };
 130
 131 /* A TUI layout that holds other layouts.  */
 132 class tui_layout_split : public tui_layout_base
 133 {
 134 public:
 135
 136   tui_layout_split () = default;
 137
 138   DISABLE_COPY_AND_ASSIGN (tui_layout_split);
 139
 140   /* Add a new split layout to this layout.  WEIGHT is the desired
 141      size, which is relative to the other weights given in this
 142      layout.  */
 143   tui_layout_split *add_split (int weight);
 144
 145   /* Add a new window to this layout.  NAME is the name of the window
 146      to add.  WEIGHT is the desired size, which is relative to the
 147      other weights given in this layout.  */
 148   void add_window (const char *name, int weight);
 149
 150   std::unique_ptr<tui_layout_base> clone () const override;
 151
 152   void apply (int x, int y, int width, int height) override;
 153
 154   bool adjust_size (const char *name, int new_height) override;
 155
 156   bool top_boxed_p () const override;
 157
 158   bool bottom_boxed_p () const override;
 159
 160   void remove_windows (const char *name) override;
 161
 162 protected:
 163
 164   void get_sizes (int *min_height, int *max_height) override;
 165
 166 private:
 167
 168   /* Set the weights from the current heights.  */
 169   void set_weights_from_heights ();
 170
 171   struct split
 172   {
 173     /* The requested weight.  */
 174     int weight;
 175     /* The layout.  */
 176     std::unique_ptr<tui_layout_base> layout;
 177   };
 178
 179   /* The splits.  */
 180   std::vector<split> m_splits;
 181
 182   /* True if this layout has already been applied at least once.  */
 183   bool m_applied = false;
 184 };
 185
 186 /* Add the specified window to the layout in a logical way.  This
 187    means setting up the most logical layout given the window to be
 188    added.  Only the source or disassembly window can be added this
 189    way.  */
 190 extern void tui_add_win_to_layout (enum tui_win_type);
 191
 192 extern void tui_set_layout (enum tui_layout_type);
 193
 194 /* Switch to the next layout.  */
 195 extern void tui_next_layout ();
 196
 197 /* Remove some windows from the layout, leaving only the focused
 198    window and the command window; if no window has the focus, then
 199    some other window is chosen to remain.  */
 200 extern void tui_remove_some_windows ();
 201
 202 /* Apply the current layout.  */
 203 extern void tui_apply_current_layout ();
 204
 205 /* Adjust the window height of WIN to NEW_HEIGHT.  */
 206 extern void tui_adjust_window_height (struct tui_win_info *win,
 207                                       int new_height);
 208
 209 #endif /* TUI_TUI_LAYOUT_H */