#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)
+ {
+ }
+
+ /* 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 ();
+
+ /* 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 "";
+ }
+
+ /* 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;
+ }
+
+ /* 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;
};
/* 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 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
/* 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
-
-/* 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
+/* This defines information about each logical window. */
+struct tui_win_info : public tui_gen_win_info
{
- enum tui_win_type display_mode;
- int split;
-};
+protected:
-/* 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;
-};
+ explicit tui_win_info (enum tui_win_type type);
+ DISABLE_COPY_AND_ASSIGN (tui_win_info);
+ /* Scroll the contents vertically. This is only called via
+ forward_scroll and backward_scroll. */
+ virtual void do_scroll_vertical (int num_to_scroll) = 0;
-/* 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;
-};
+ /* Scroll the contents horizontally. This is only called via
+ left_scroll and right_scroll. */
+ virtual void do_scroll_horizontal (int num_to_scroll) = 0;
+ void rerender () override;
-/* Elements in the command window content. */
-struct tui_command_element
-{
- char *line;
-};
+ void make_window () override;
-#ifdef PATH_MAX
-# define MAX_LOCATOR_ELEMENT_LEN PATH_MAX
-#else
-# define MAX_LOCATOR_ELEMENT_LEN 1024
-#endif
+public:
-/* 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;
-};
+ ~tui_win_info () override
+ {
+ }
-/* 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
+ /* Compute the maximum height of this window. */
+ virtual int max_height () const;
-/* Position of breakpoint markers in the exec info string. */
-#define TUI_BP_HIT_POS 0
-#define TUI_BP_BREAK_POS 1
-#define TUI_EXEC_POS 2
-#define TUI_EXECINFO_SIZE 4
+ /* Called after the tab width has been changed. */
+ virtual void update_tab_width ()
+ {
+ }
-typedef char tui_exec_info_content[TUI_EXECINFO_SIZE];
+ /* Set whether this window is highglighted. */
+ void set_highlight (bool highlight)
+ {
+ is_highlighted = highlight;
+ }
-/* 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. */
-};
+ /* 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);
-struct tui_win_element
-{
- union tui_which_element which_element;
-};
+ /* Return true if this window can be scrolled, false otherwise. */
+ virtual bool can_scroll () const
+ {
+ return true;
+ }
-/* This struct defines the specific information about a data display
- window. */
-struct tui_data_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;
-};
+ virtual bool can_box () const
+ {
+ return true;
+ }
+ void check_and_display_highlight_if_needed ();
-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;
+ /* Window title to display. */
+ std::string title;
- /* It is the resolved form as returned by symtab_to_fullname. */
- char *fullname;
+ /* Can this window ever be highlighted? */
+ bool can_highlight = true;
- /* Architecture associated with code at this location. */
- struct gdbarch *gdbarch;
+ /* Is this window highlighted? */
+ bool is_highlighted = false;
};
+extern int tui_win_is_auxiliary (enum tui_win_type win_type);
-struct tui_command_info
-{
- int start_line;
-};
+/* Global Data. */
+extern struct tui_win_info *tui_win_list[MAX_MAJOR_WINDOWS];
-/* This defines information about each logical window. */
-struct tui_win_info
-{
-protected:
+#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])
- explicit tui_win_info (enum tui_win_type type);
- DISABLE_COPY_AND_ASSIGN (tui_win_info);
+/* An iterator that iterates over all windows. */
+class tui_window_iterator
+{
public:
- virtual ~tui_win_info ();
+ 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;
- /* Clear the pertinent detail in the window. */
- virtual void clear_detail () = 0;
+ explicit tui_window_iterator (enum tui_win_type type)
+ : m_type (type)
+ {
+ advance ();
+ }
- struct tui_gen_win_info generic; /* General window information. */
- union
+ 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;
}
- detail;
- /* Can this window ever be highlighted? */
- int can_highlight = 0;
+ bool operator!= (const self_type &other) const
+ {
+ return m_type != other.m_type;
+ }
- /* Is this window highlighted? */
- int is_highlighted = 0;
-};
+ value_type operator* () const
+ {
+ gdb_assert (m_type < MAX_MAJOR_WINDOWS);
+ return tui_win_list[m_type];
+ }
-struct tui_source_window : public tui_win_info
-{
- explicit tui_source_window (enum tui_win_type type);
- DISABLE_COPY_AND_ASSIGN (tui_source_window);
+ self_type &operator++ ()
+ {
+ ++m_type;
+ advance ();
+ return *this;
+ }
- void clear_detail () override;
-};
+private:
-struct tui_data_window : public tui_win_info
-{
- tui_data_window ();
- DISABLE_COPY_AND_ASSIGN (tui_data_window);
+ void advance ()
+ {
+ while (m_type < MAX_MAJOR_WINDOWS && tui_win_list[m_type] == nullptr)
+ ++m_type;
+ }
- void clear_detail () override;
+ int m_type;
};
-struct tui_cmd_window : public tui_win_info
+/* A range adapter for iterating over TUI windows. */
+
+struct all_tui_windows
{
- tui_cmd_window ();
- DISABLE_COPY_AND_ASSIGN (tui_cmd_window);
+ tui_window_iterator begin () const
+ {
+ return tui_window_iterator (SRC_WIN);
+ }
- void clear_detail () override;
+ tui_window_iterator end () const
+ {
+ return tui_window_iterator ();
+ }
};
-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);
-
-
-/* Global Data. */
-extern struct tui_win_info *tui_win_list[MAX_MAJOR_WINDOWS];
-
-#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 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_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 struct tui_win_info *tui_partial_win_by_name (const char *);
-extern const char *tui_win_name (const struct tui_gen_win_info *);
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 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 struct tui_locator_window *tui_locator_win_info_ptr (void);
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 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 *);
-extern void tui_add_to_source_windows (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;