/* TUI data manipulation routines.
- Copyright (C) 1998-2019 Free Software Foundation, Inc.
+ Copyright (C) 1998-2020 Free Software Foundation, Inc.
Contributed by Hewlett-Packard Company.
#ifndef TUI_TUI_DATA_H
#define TUI_TUI_DATA_H
-#include "tui/tui.h" /* For enum tui_win_type. */
+#include "tui/tui.h"
#include "gdb_curses.h" /* For WINDOW. */
#include "observable.h"
struct tui_cmd_window;
struct tui_source_window_base;
struct tui_source_window;
+struct tui_disasm_window;
-/* This is a point definition. */
-struct tui_point
+/* A deleter that calls delwin. */
+struct curses_deleter
{
- int x, y;
+ void operator() (WINDOW *win) const
+ {
+ delwin (win);
+ }
};
/* Generic window information. */
{
protected:
- explicit tui_gen_win_info (enum tui_win_type t)
- : type (t)
+ tui_gen_win_info () = default;
+
+ /* This is called after the window is resized, and should update the
+ window's contents. */
+ virtual void rerender ()
{
}
+ virtual void make_window ();
+
public:
+ tui_gen_win_info (tui_gen_win_info &&) = default;
- virtual ~tui_gen_win_info ();
+ virtual ~tui_gen_win_info ()
+ {
+ }
/* Call to refresh this window. */
virtual void refresh_window ();
return "";
}
- /* Reset this window. The parameters are used to set the window's
- size and position. */
- virtual void reset (int height, int width,
- int origin_x, int origin_y);
+ /* Compute the maximum height of this window. */
+ virtual int max_height () const = 0;
+
+ /* Compute the minimum height of this window. */
+ virtual int min_height () const = 0;
+
+ /* Compute the maximum width of this window. */
+ int max_width () const;
- /* Return true if this can be boxed. */
+ /* Compute the minimum width of this window. */
+ int min_width () const
+ {
+ return 3;
+ }
+
+ /* Return true if this window can be boxed. */
virtual bool can_box () const
{
return false;
}
+ /* Resize this window. The parameters are used to set the window's
+ size and position. */
+ virtual void resize (int height, int width,
+ int origin_x, int origin_y);
+
+ /* Return true if this window is visible. */
+ bool is_visible () const
+ {
+ return handle != nullptr;
+ }
+
+ /* Disable output until the next call to doupdate. */
+ virtual void no_refresh ()
+ {
+ if (handle != nullptr)
+ wnoutrefresh (handle.get ());
+ }
+
/* Window handle. */
- WINDOW *handle = nullptr;
- /* Type of window. */
- enum tui_win_type type;
+ std::unique_ptr<WINDOW, curses_deleter> handle;
/* Window width. */
int width = 0;
/* Window height. */
int height = 0;
/* Origin of window. */
- struct tui_point origin = {0, 0};
- /* Viewport height. */
- int viewport_height = 0;
- /* Whether the window is visible or not. */
- bool is_visible = false;
- /* Window title to display. */
- char *title = nullptr;
+ int x = 0;
+ int y = 0;
};
/* Constant definitions. */
#define DEFAULT_TAB_LEN 8
-#define NO_SRC_STRING "[ No Source Available ]"
-#define NO_DISASSEM_STRING "[ No Assembly Available ]"
-#define NO_REGS_STRING "[ Register Values Unavailable ]"
-#define NO_DATA_STRING "[ No Data Values Displayed ]"
#define SRC_NAME "src"
#define CMD_NAME "cmd"
#define DATA_NAME "regs"
#define DISASSEM_NAME "asm"
-#define HILITE TRUE
-#define NO_HILITE FALSE
#define MIN_WIN_HEIGHT 3
#define MIN_CMD_WIN_HEIGHT 3
/* Strings to display in the TUI status line. */
-#define PROC_PREFIX "In: "
-#define LINE_PREFIX "L"
-#define PC_PREFIX "PC: "
#define SINGLE_KEY "(SingleKey)"
-/* Minimum/Maximum length of some fields displayed in the TUI status
- line. */
-#define MIN_LINE_WIDTH 4 /* Use at least 4 digits for line
- numbers. */
-#define MIN_PROC_WIDTH 12
-#define MAX_TARGET_WIDTH 10
-#define MAX_PID_WIDTH 19
-
-/* The kinds of layouts available. */
-enum tui_layout_type
-{
- SRC_COMMAND,
- DISASSEM_COMMAND,
- SRC_DISASSEM_COMMAND,
- SRC_DATA_COMMAND,
- DISASSEM_DATA_COMMAND,
- UNDEFINED_LAYOUT
-};
-
enum tui_line_or_address_kind
{
LOA_LINE,
} u;
};
-#ifdef PATH_MAX
-# define MAX_LOCATOR_ELEMENT_LEN PATH_MAX
-#else
-# define MAX_LOCATOR_ELEMENT_LEN 1024
-#endif
-
-/* Locator window class. */
-
-struct tui_locator_window : public tui_gen_win_info
-{
- tui_locator_window ()
- : tui_gen_win_info (LOCATOR_WIN)
- {
- full_name[0] = 0;
- proc_name[0] = 0;
- }
-
- char full_name[MAX_LOCATOR_ELEMENT_LEN];
- char proc_name[MAX_LOCATOR_ELEMENT_LEN];
- int line_no = 0;
- CORE_ADDR addr = 0;
- /* Architecture associated with code at this location. */
- struct gdbarch *gdbarch = nullptr;
-};
-
/* This defines information about each logical window. */
struct tui_win_info : public tui_gen_win_info
{
protected:
- explicit tui_win_info (enum tui_win_type type);
+ tui_win_info () = default;
DISABLE_COPY_AND_ASSIGN (tui_win_info);
/* Scroll the contents vertically. This is only called via
left_scroll and right_scroll. */
virtual void do_scroll_horizontal (int num_to_scroll) = 0;
- /* Called after make_visible_with_new_height sets the new height.
- Should update the window. */
- virtual void do_make_visible_with_new_height () = 0;
+ void rerender () override;
+
+ void make_window () override;
public:
{
}
- /* Called after all the TUI windows are refreshed, to let this
- window have a chance to update itself further. */
- virtual void refresh_all ()
- {
- }
+ int max_height () const override;
- /* Called after a TUI window is given a new height; this updates any
- related auxiliary windows. */
- virtual void set_new_height (int height)
+ int min_height () const override
{
+ return MIN_WIN_HEIGHT;
}
- /* Compute the maximum height of this window. */
- virtual int max_height () const;
-
/* Called after the tab width has been changed. */
virtual void update_tab_width ()
{
}
- /* Function make the target window (and auxiliary windows associated
- with the target) invisible, and set the new height and
- location. */
- void make_invisible_and_set_new_height (int height);
-
- /* Make the window visible after the height has been changed. */
- void make_visible_with_new_height ();
-
- /* Set whether this window is highglighted. */
+ /* Set whether this window is highlighted. */
void set_highlight (bool highlight)
{
is_highlighted = highlight;
void check_and_display_highlight_if_needed ();
- /* Can this window ever be highlighted? */
- bool can_highlight = true;
+ /* Window title to display. */
+ std::string title;
/* Is this window highlighted? */
bool is_highlighted = false;
};
-extern int tui_win_is_auxiliary (enum tui_win_type win_type);
-
/* Global Data. */
extern struct tui_win_info *tui_win_list[MAX_MAJOR_WINDOWS];
#define TUI_SRC_WIN ((tui_source_window *) tui_win_list[SRC_WIN])
-#define TUI_DISASM_WIN ((tui_source_window_base *) tui_win_list[DISASSEM_WIN])
+#define TUI_DISASM_WIN ((tui_disasm_window *) tui_win_list[DISASSEM_WIN])
#define TUI_DATA_WIN ((tui_data_window *) tui_win_list[DATA_WIN])
#define TUI_CMD_WIN ((tui_cmd_window *) tui_win_list[CMD_WIN])
-/* An iterator that iterates over all windows. */
-
-class tui_window_iterator
-{
-public:
-
- typedef tui_window_iterator self_type;
- typedef struct tui_win_info *value_type;
- typedef struct tui_win_info *&reference;
- typedef struct tui_win_info **pointer;
- typedef std::forward_iterator_tag iterator_category;
- typedef int difference_type;
-
- explicit tui_window_iterator (enum tui_win_type type)
- : m_type (type)
- {
- advance ();
- }
-
- tui_window_iterator ()
- : m_type (MAX_MAJOR_WINDOWS)
- {
- }
-
- bool operator!= (const self_type &other) const
- {
- return m_type != other.m_type;
- }
-
- value_type operator* () const
- {
- gdb_assert (m_type < MAX_MAJOR_WINDOWS);
- return tui_win_list[m_type];
- }
-
- self_type &operator++ ()
- {
- ++m_type;
- advance ();
- return *this;
- }
-
-private:
-
- void advance ()
- {
- while (m_type < MAX_MAJOR_WINDOWS && tui_win_list[m_type] == nullptr)
- ++m_type;
- }
-
- int m_type;
-};
+/* All the windows that are currently instantiated, in layout
+ order. */
+extern std::vector<tui_win_info *> tui_windows;
-/* A range adapter for iterating over TUI windows. */
-
-struct all_tui_windows
+/* Return a range adapter for iterating over TUI windows. */
+static inline std::vector<tui_win_info *> &
+all_tui_windows ()
{
- tui_window_iterator begin () const
- {
- return tui_window_iterator (SRC_WIN);
- }
-
- tui_window_iterator end () const
- {
- return tui_window_iterator ();
- }
-};
-
+ return tui_windows;
+}
/* Data Manipulation Functions. */
-extern void tui_initialize_static_data (void);
-extern struct tui_win_info *tui_partial_win_by_name (const char *);
-extern enum tui_layout_type tui_current_layout (void);
extern int tui_term_height (void);
extern void tui_set_term_height_to (int);
extern int tui_term_width (void);
extern void tui_set_term_width_to (int);
extern struct tui_locator_window *tui_locator_win_info_ptr (void);
-extern std::vector<tui_source_window_base *> &tui_source_windows ();
-extern void tui_clear_source_windows (void);
-extern void tui_clear_source_windows_detail (void);
-extern void tui_add_to_source_windows (struct tui_source_window_base *);
extern struct tui_win_info *tui_win_with_focus (void);
-extern void tui_set_win_with_focus (struct tui_win_info *);
-extern int tui_win_resized (void);
-extern void tui_set_win_resized_to (int);
+extern bool tui_win_resized ();
+extern void tui_set_win_resized_to (bool);
extern struct tui_win_info *tui_next_win (struct tui_win_info *);
extern struct tui_win_info *tui_prev_win (struct tui_win_info *);
-/* Delete all the invisible windows. Note that it is an error to call
- this when the command window is invisible -- we don't allow the
- command window to be removed from the layout. */
-extern void tui_delete_invisible_windows ();
-
extern unsigned int tui_tab_width;
#endif /* TUI_TUI_DATA_H */