gdb/tui/tui-layout.h

   1 /* TUI layout window management.
   2
   3    Copyright (C) 1998-2019 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   /* Clone this object.  Ordinarily a layout is cloned before it is
  38      used, so that any necessary modifications do not affect the
  39      "skeleton" layout.  */
  40   virtual std::unique_ptr<tui_layout_base> clone () const = 0;
  41
  42   /* Change the size and location of this layout.  */
  43   virtual void apply (int x, int y, int width, int height) = 0;
  44
  45   /* Return the minimum and maximum height of this layout.  */
  46   virtual void get_sizes (int *min_height, int *max_height) = 0;
  47
  48   /* True if the topmost item in this layout is boxed.  */
  49   virtual bool top_boxed_p () const = 0;
  50
  51   /* True if the bottommost item in this layout is boxed.  */
  52   virtual bool bottom_boxed_p () const = 0;
  53
  54   /* Return the name of this layout's window, or nullptr if this
  55      layout does not represent a single window.  */
  56   virtual const char *get_name () const
  57   {
  58     return nullptr;
  59   }
  60
  61   /* Adjust the size of the window named NAME to NEW_HEIGHT, updating
  62      the sizes of the other windows around it.  */
  63   virtual bool adjust_size (const char *name, int new_height) = 0;
  64
  65   /* The most recent space allocation.  */
  66   int x = 0;
  67   int y = 0;
  68   int width = 0;
  69   int height = 0;
  70
  71 protected:
  72
  73   tui_layout_base () = default;
  74 };
  75
  76 /* A TUI layout object that displays a single window.  The window is
  77    given by name.  */
  78 class tui_layout_window : public tui_layout_base
  79 {
  80 public:
  81
  82   explicit tui_layout_window (const char *name)
  83     : m_contents (name)
  84   {
  85   }
  86
  87   DISABLE_COPY_AND_ASSIGN (tui_layout_window);
  88
  89   std::unique_ptr<tui_layout_base> clone () const override;
  90
  91   void apply (int x, int y, int width, int height) override;
  92
  93   const char *get_name () const override
  94   {
  95     return m_contents.c_str ();
  96   }
  97
  98   bool adjust_size (const char *name, int new_height) override
  99   {
 100     return false;
 101   }
 102
 103   bool top_boxed_p () const override;
 104
 105   bool bottom_boxed_p () const override;
 106
 107 protected:
 108
 109   void get_sizes (int *min_height, int *max_height) override;
 110
 111 private:
 112
 113   /* Type of content to display.  */
 114   std::string m_contents;
 115
 116   /* When a layout is applied, this is updated to point to the window
 117      object.  */
 118   tui_gen_win_info *m_window = nullptr;
 119 };
 120
 121 /* A TUI layout that holds other layouts.  */
 122 class tui_layout_split : public tui_layout_base
 123 {
 124 public:
 125
 126   tui_layout_split () = default;
 127
 128   DISABLE_COPY_AND_ASSIGN (tui_layout_split);
 129
 130   /* Add a new split layout to this layout.  WEIGHT is the desired
 131      size, which is relative to the other weights given in this
 132      layout.  */
 133   tui_layout_split *add_split (int weight);
 134
 135   /* Add a new window to this layout.  NAME is the name of the window
 136      to add.  WEIGHT is the desired size, which is relative to the
 137      other weights given in this layout.  */
 138   void add_window (const char *name, int weight);
 139
 140   std::unique_ptr<tui_layout_base> clone () const override;
 141
 142   void apply (int x, int y, int width, int height) override;
 143
 144   bool adjust_size (const char *name, int new_height) override;
 145
 146   bool top_boxed_p () const override;
 147
 148   bool bottom_boxed_p () const override;
 149
 150 protected:
 151
 152   void get_sizes (int *min_height, int *max_height) override;
 153
 154 private:
 155
 156   /* Set the weights from the current heights.  */
 157   void set_weights_from_heights ();
 158
 159   struct split
 160   {
 161     /* The requested weight.  */
 162     int weight;
 163     /* The layout.  */
 164     std::unique_ptr<tui_layout_base> layout;
 165   };
 166
 167   /* The splits.  */
 168   std::vector<split> m_splits;
 169
 170   /* True if this layout has already been applied at least once.  */
 171   bool m_applied = false;
 172 };
 173
 174 extern void tui_add_win_to_layout (enum tui_win_type);
 175 extern void tui_set_layout (enum tui_layout_type);
 176
 177 /* Apply the current layout.  */
 178 extern void tui_apply_current_layout ();
 179
 180 /* Adjust the window height of WIN to NEW_HEIGHT.  */
 181 extern void tui_adjust_window_height (struct tui_win_info *win,
 182                                       int new_height);
 183
 184 #endif /* TUI_TUI_LAYOUT_H */