/* TUI data manipulation routines.
- Copyright (C) 1998-2016 Free Software Foundation, Inc.
+ Copyright (C) 1998-2019 Free Software Foundation, Inc.
Contributed by Hewlett-Packard Company.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
-#ifndef TUI_DATA_H
-#define TUI_DATA_H
+#ifndef TUI_TUI_DATA_H
+#define TUI_TUI_DATA_H
#include "tui/tui.h" /* For enum tui_win_type. */
#include "gdb_curses.h" /* For WINDOW. */
+#include "observable.h"
+
+struct tui_cmd_window;
+struct tui_source_window_base;
+struct tui_source_window;
/* This is a point definition. */
struct tui_point
int x, y;
};
-struct tui_win_element;
-
-/* This describes the content of the window. */
-typedef struct tui_win_element **tui_win_content;
-
/* Generic window information. */
struct tui_gen_win_info
{
- WINDOW *handle; /* Window handle. */
- enum tui_win_type type; /* Type of window. */
- int width; /* Window width. */
- int height; /* Window height. */
- struct tui_point origin; /* Origin of window. */
- tui_win_content content; /* Content of window. */
- int content_size; /* Size of content (# of elements). */
- int content_in_use; /* Can it be used, or is it already used? */
- int viewport_height; /* Viewport height. */
- int last_visible_line; /* Index of last visible line. */
- int is_visible; /* Whether the window is visible or not. */
- char *title; /* Window title to display. */
+protected:
+
+ explicit tui_gen_win_info (enum tui_win_type t)
+ : type (t)
+ {
+ }
+
+public:
+
+ virtual ~tui_gen_win_info ();
+
+ /* Call to refresh this window. */
+ virtual void refresh_window ();
+
+ /* Make this window visible or invisible. */
+ virtual void make_visible (bool visible);
+
+ /* Return the name of this type of window. */
+ virtual const char *name () const
+ {
+ 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);
+
+ /* Window handle. */
+ WINDOW *handle = nullptr;
+ /* Type of window. */
+ enum tui_win_type type;
+ /* 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;
+ /* Index of last visible line. */
+ int last_visible_line = 0;
+ /* Whether the window is visible or not. */
+ bool is_visible = false;
+ /* Window title to display. */
+ char *title = nullptr;
+};
+
+/* Whether or not a window should be drawn with a box. */
+enum tui_box
+{
+ DONT_BOX_WINDOW = 0,
+ BOX_WINDOW
};
/* Constant definitions. */
#define NO_DISASSEM_STRING "[ No Assembly Available ]"
#define NO_REGS_STRING "[ Register Values Unavailable ]"
#define NO_DATA_STRING "[ No Data Values Displayed ]"
-#define MAX_CONTENT_COUNT 100
#define SRC_NAME "src"
#define CMD_NAME "cmd"
#define DATA_NAME "regs"
#define DISASSEM_NAME "asm"
-#define TUI_NULL_STR ""
-#define DEFAULT_HISTORY_COUNT 25
-#define BOX_WINDOW TRUE
-#define DONT_BOX_WINDOW FALSE
#define HILITE TRUE
#define NO_HILITE FALSE
-#define WITH_LOCATOR TRUE
-#define NO_LOCATOR FALSE
-#define EMPTY_SOURCE_PROMPT TRUE
-#define NO_EMPTY_SOURCE_PROMPT FALSE
-#define UNDEFINED_ITEM -1
#define MIN_WIN_HEIGHT 3
#define MIN_CMD_WIN_HEIGHT 3
#define MAX_TARGET_WIDTH 10
#define MAX_PID_WIDTH 19
-/* Scroll direction enum. */
-enum tui_scroll_direction
-{
- FORWARD_SCROLL,
- BACKWARD_SCROLL,
- LEFT_SCROLL,
- RIGHT_SCROLL
-};
-
-
-/* General list struct. */
-struct tui_list
-{
- struct tui_win_info **list;
- int count;
-};
-
-
/* The kinds of layouts available. */
enum tui_layout_type
{
UNDEFINED_LAYOUT
};
-/* Basic data types that can be displayed in the data window. */
-enum tui_data_type
-{
- TUI_REGISTER,
- TUI_SCALAR,
- TUI_COMPLEX,
- TUI_STRUCT
-};
-
enum tui_line_or_address_kind
{
LOA_LINE,
} u;
};
-/* Current Layout definition. */
-struct tui_layout_def
+/* Flags to tell what kind of breakpoint is at current line. */
+enum tui_bp_flag
{
- enum tui_win_type display_mode;
- int split;
+ TUI_BP_ENABLED = 0x01,
+ TUI_BP_DISABLED = 0x02,
+ TUI_BP_HIT = 0x04,
+ TUI_BP_CONDITIONAL = 0x08,
+ TUI_BP_HARDWARE = 0x10
};
+DEF_ENUM_FLAGS_TYPE (enum tui_bp_flag, tui_bp_flags);
+
/* Elements in the Source/Disassembly Window. */
struct tui_source_element
{
- char *line;
- struct tui_line_or_address line_or_addr;
- int is_exec_point;
- int has_break;
-};
+ tui_source_element ()
+ {
+ line_or_addr.loa = LOA_LINE;
+ line_or_addr.u.line_no = 0;
+ }
+ ~tui_source_element ()
+ {
+ xfree (line);
+ }
-/* Elements in the data display window content. */
-struct tui_data_element
-{
- const char *name;
- int item_no; /* The register number, or data display
- number. */
- enum tui_data_type type;
- void *value;
- int highlight;
- char *content;
+ char *line = nullptr;
+ struct tui_line_or_address line_or_addr;
+ bool is_exec_point = false;
+ tui_bp_flags break_mode = 0;
};
-/* Elements in the command window content. */
-struct tui_command_element
-{
- char *line;
-};
-
#ifdef PATH_MAX
# define MAX_LOCATOR_ELEMENT_LEN PATH_MAX
#else
# define MAX_LOCATOR_ELEMENT_LEN 1024
#endif
-/* Elements in the locator window content. */
-struct tui_locator_element
-{
- /* Resolved absolute filename as returned by symtab_to_fullname. */
- char full_name[MAX_LOCATOR_ELEMENT_LEN];
- char proc_name[MAX_LOCATOR_ELEMENT_LEN];
- int line_no;
- CORE_ADDR addr;
- /* Architecture associated with code at this location. */
- struct gdbarch *gdbarch;
-};
-
-/* Flags to tell what kind of breakpoint is at current line. */
-#define TUI_BP_ENABLED 0x01
-#define TUI_BP_DISABLED 0x02
-#define TUI_BP_HIT 0x04
-#define TUI_BP_CONDITIONAL 0x08
-#define TUI_BP_HARDWARE 0x10
-
/* Position of breakpoint markers in the exec info string. */
#define TUI_BP_HIT_POS 0
#define TUI_BP_BREAK_POS 1
typedef char tui_exec_info_content[TUI_EXECINFO_SIZE];
-/* An content element in a window. */
-union tui_which_element
-{
- struct tui_source_element source; /* The source elements. */
- struct tui_gen_win_info data_window; /* Data display elements. */
- struct tui_data_element data; /* Elements of data_window. */
- struct tui_command_element command; /* Command elements. */
- struct tui_locator_element locator; /* Locator elements. */
- tui_exec_info_content simple_string; /* Simple char based elements. */
-};
+/* Locator window class. */
-struct tui_win_element
+struct tui_locator_window : public tui_gen_win_info
{
- int highlight;
- union tui_which_element which_element;
+ 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 struct defines the specific information about a data display
- window. */
-struct tui_data_info
+/* This defines information about each logical window. */
+struct tui_win_info : public tui_gen_win_info
{
- tui_win_content data_content; /* Start of data display content. */
- int data_content_count;
- tui_win_content regs_content; /* Start of regs display content. */
- int regs_content_count;
- int regs_column_count;
- int display_regs; /* Should regs be displayed at all? */
- struct reggroup *current_group;
-};
+protected:
+ explicit tui_win_info (enum tui_win_type type);
+ DISABLE_COPY_AND_ASSIGN (tui_win_info);
-struct tui_source_info
-{
- int has_locator; /* Does locator belongs to this window? */
- /* Execution information window. */
- struct tui_gen_win_info *execution_info;
- int horizontal_offset; /* Used for horizontal scroll. */
- struct tui_line_or_address start_line_or_addr;
+ /* Scroll the contents vertically. This is only called via
+ forward_scroll and backward_scroll. */
+ virtual void do_scroll_vertical (int num_to_scroll) = 0;
- /* It is the resolved form as returned by symtab_to_fullname. */
- char *fullname;
+ /* Scroll the contents horizontally. This is only called via
+ left_scroll and right_scroll. */
+ virtual void do_scroll_horizontal (int num_to_scroll) = 0;
- /* Architecture associated with code at this location. */
- struct gdbarch *gdbarch;
-};
+ /* Called after make_visible_with_new_height sets the new height.
+ Should update the window. */
+ virtual void do_make_visible_with_new_height () = 0;
+public:
-struct tui_command_info
-{
- int start_line;
+ ~tui_win_info () override
+ {
+ }
+
+ /* Called after all the TUI windows are refreshed, to let this
+ window have a chance to update itself further. */
+ virtual void refresh_all ()
+ {
+ }
+
+ /* Called after a TUI window is given a new height; this updates any
+ related auxiliary windows. */
+ virtual void set_new_height (int 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. */
+ void set_highlight (bool highlight)
+ {
+ is_highlighted = highlight;
+ }
+
+ /* Methods to scroll the contents of this window. Note that they
+ are named with "_scroll" coming at the end because the more
+ obvious "scroll_forward" is defined as a macro in term.h. */
+ void forward_scroll (int num_to_scroll);
+ void backward_scroll (int num_to_scroll);
+ void left_scroll (int num_to_scroll);
+ void right_scroll (int num_to_scroll);
+
+ /* Return true if this window can be scrolled, false otherwise. */
+ virtual bool can_scroll () const
+ {
+ return true;
+ }
+
+ /* Can this window ever be highlighted? */
+ bool can_highlight = true;
+
+ /* Is this window highlighted? */
+ bool is_highlighted = false;
};
+extern int tui_win_is_auxiliary (enum tui_win_type win_type);
-/* This defines information about each logical window. */
-struct tui_win_info
+
+/* 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_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
{
- struct tui_gen_win_info generic; /* General window information. */
- union
+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)
{
- struct tui_source_info source_info;
- struct tui_data_info data_display_info;
- struct tui_command_info command_info;
- void *opaque;
}
- detail;
- int can_highlight; /* Can this window ever be highlighted? */
- int is_highlighted; /* Is this window highlighted? */
+
+ 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;
};
-extern int tui_win_is_source_type (enum tui_win_type win_type);
-extern int tui_win_is_auxillary (enum tui_win_type win_type);
-extern int tui_win_has_locator (struct tui_win_info *win_info);
-extern void tui_set_win_highlight (struct tui_win_info *win_info,
- int highlight);
+/* A range adapter for iterating over TUI windows. */
+struct all_tui_windows
+{
+ tui_window_iterator begin () const
+ {
+ return tui_window_iterator (SRC_WIN);
+ }
-/* Global Data. */
-extern struct tui_win_info *(tui_win_list[MAX_MAJOR_WINDOWS]);
+ tui_window_iterator end () const
+ {
+ return tui_window_iterator ();
+ }
+};
-#define TUI_SRC_WIN tui_win_list[SRC_WIN]
-#define TUI_DISASM_WIN tui_win_list[DISASSEM_WIN]
-#define TUI_DATA_WIN tui_win_list[DATA_WIN]
-#define TUI_CMD_WIN tui_win_list[CMD_WIN]
/* Data Manipulation Functions. */
extern void tui_initialize_static_data (void);
-extern struct tui_gen_win_info *tui_alloc_generic_win_info (void);
-extern struct tui_win_info *tui_alloc_win_info (enum tui_win_type);
-extern void tui_init_generic_part (struct tui_gen_win_info *);
-extern void tui_init_win_info (struct tui_win_info *);
-extern tui_win_content tui_alloc_content (int, enum tui_win_type);
-extern int tui_add_content_elements (struct tui_gen_win_info *,
- int);
-extern void tui_init_content_element (struct tui_win_element *,
- enum tui_win_type);
-extern void tui_free_window (struct tui_win_info *);
-extern void tui_free_win_content (struct tui_gen_win_info *);
-extern void tui_free_data_content (tui_win_content, int);
-extern void tui_free_all_source_wins_content (void);
-extern void tui_del_window (struct tui_win_info *);
-extern void tui_del_data_windows (tui_win_content, int);
-extern struct tui_win_info *tui_partial_win_by_name (char *);
-extern const char *tui_win_name (const struct tui_gen_win_info *);
+extern struct tui_win_info *tui_partial_win_by_name (const char *);
extern enum tui_layout_type tui_current_layout (void);
extern void tui_set_current_layout_to (enum tui_layout_type);
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_gen_win_info *tui_locator_win_info_ptr (void);
-extern struct tui_gen_win_info *tui_source_exec_info_win_ptr (void);
-extern struct tui_gen_win_info *tui_disassem_exec_info_win_ptr (void);
-extern struct tui_list *tui_source_windows (void);
+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_clear_win_detail (struct tui_win_info *);
-extern void tui_add_to_source_windows (struct tui_win_info *);
-extern int tui_default_tab_len (void);
-extern void tui_set_default_tab_len (int);
+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 struct tui_layout_def *tui_layout_def (void);
extern int tui_win_resized (void);
extern void tui_set_win_resized_to (int);
extern struct tui_win_info *tui_next_win (struct tui_win_info *);
extern struct tui_win_info *tui_prev_win (struct tui_win_info *);
-extern void tui_add_to_source_windows (struct tui_win_info *);
+extern unsigned int tui_tab_width;
-#endif /* TUI_DATA_H */
+#endif /* TUI_TUI_DATA_H */