/* 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"
-/* This is a point definition. */
-struct tui_point
+struct tui_cmd_window;
+struct tui_source_window_base;
+struct tui_source_window;
+struct tui_disasm_window;
+
+/* A deleter that calls delwin. */
+struct curses_deleter
{
- int x, y;
+ void operator() (WINDOW *win) const
+ {
+ delwin (win);
+ }
};
-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
{
- explicit tui_gen_win_info (enum tui_win_type t)
- : type (t)
+protected:
+
+ 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 ()
{
}
+ /* 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 "";
+ }
+
+ /* 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;
+
+ /* 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};
- /* Content of window. */
- tui_win_content content = nullptr;
- /* Size of content (# of elements). */
- int content_size = 0;
- /* Can it be used, or is it already used? */
- int content_in_use = FALSE;
- /* 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;
+ 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 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
-};
-
-
-/* The kinds of layouts available. */
-enum tui_layout_type
-{
- SRC_COMMAND,
- DISASSEM_COMMAND,
- SRC_DISASSEM_COMMAND,
- SRC_DATA_COMMAND,
- DISASSEM_DATA_COMMAND,
- 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
-{
- enum tui_win_type display_mode;
- int split;
-};
-
-/* 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;
-};
-
-
-/* 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;
-};
-
-
-/* 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
-#define TUI_EXEC_POS 2
-#define TUI_EXECINFO_SIZE 4
-
-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. */
-};
-
-struct tui_win_element
-{
- union tui_which_element which_element;
-};
-
/* 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
forward_scroll and backward_scroll. */
- virtual void do_scroll_vertical (enum tui_scroll_direction,
- int num_to_scroll) = 0;
+ virtual void do_scroll_vertical (int num_to_scroll) = 0;
/* Scroll the contents horizontally. This is only called via
left_scroll and right_scroll. */
- virtual void do_scroll_horizontal (enum tui_scroll_direction,
- int num_to_scroll) = 0;
+ virtual void do_scroll_horizontal (int num_to_scroll) = 0;
-public:
+ void rerender () override;
- ~tui_win_info () override;
+ void make_window () override;
- /* Clear the pertinent detail in the window. */
- virtual void clear_detail () = 0;
+public:
- /* Return true if this window has the locator. */
- virtual bool has_locator () const
+ ~tui_win_info () override
{
- return false;
}
- /* Make this window visible or invisible. */
- virtual void make_visible (bool visible);
-
- /* Refresh this window and any associated windows. */
- virtual void refresh ();
+ int max_height () const override;
- /* Called after all the TUI windows are refreshed, to let this
- window have a chance to update itself further. */
- virtual void refresh_all ()
+ int min_height () const override
{
+ return MIN_WIN_HEIGHT;
}
- /* Called after a TUI window is given a new height; this updates any
- related auxiliary windows. */
- virtual void set_new_height (int height)
+ /* Called after the tab width has been changed. */
+ virtual void update_tab_width ()
{
}
- /* Compute the maximum height of this window. */
- virtual int max_height () const;
-
- /* Set whether this window is highglighted. */
+ /* Set whether this window is highlighted. */
void set_highlight (bool highlight)
{
is_highlighted = highlight;
void left_scroll (int num_to_scroll);
void right_scroll (int num_to_scroll);
- /* Can this window ever be highlighted? */
- bool can_highlight = false;
-
- /* Is this window highlighted? */
- bool is_highlighted = false;
-};
-
-/* The base class for all source-like windows, namely the source and
- disassembly windows. */
-
-struct tui_source_window_base : public tui_win_info
-{
-protected:
- explicit tui_source_window_base (enum tui_win_type type);
- ~tui_source_window_base () override;
- DISABLE_COPY_AND_ASSIGN (tui_source_window_base);
-
- void do_scroll_horizontal (enum tui_scroll_direction,
- int num_to_scroll) override;
-
-public:
-
- void clear_detail () override;
-
- /* Return true if this window has the locator. */
- bool has_locator () const override
- {
- return m_has_locator;
- }
-
- void make_visible (bool visible) override;
- void refresh () override;
- void refresh_all () override;
-
- /* Refill the source window's source cache and update it. If this
- is a disassembly window, then just update it. */
- void refill ();
-
- /* Set the location of the execution point. */
- void set_is_exec_point_at (struct tui_line_or_address l);
-
- void set_new_height (int height) override;
-
- /* Does the locator belong to this window? */
- bool m_has_locator = false;
- /* Execution information window. */
- struct tui_gen_win_info *execution_info = nullptr;
- /* Used for horizontal scroll. */
- int horizontal_offset = 0;
- struct tui_line_or_address start_line_or_addr;
-
- /* It is the resolved form as returned by symtab_to_fullname. */
- char *fullname = nullptr;
-
- /* Architecture associated with code at this location. */
- struct gdbarch *gdbarch = nullptr;
-};
-
-/* A TUI source window. */
-
-struct tui_source_window : public tui_source_window_base
-{
- tui_source_window ()
- : tui_source_window_base (SRC_WIN)
- {
- }
-
- DISABLE_COPY_AND_ASSIGN (tui_source_window);
-
-protected:
-
- void do_scroll_vertical (enum tui_scroll_direction,
- int num_to_scroll) override;
-};
-
-/* A TUI disassembly window. */
-
-struct tui_disasm_window : public tui_source_window_base
-{
- tui_disasm_window ()
- : tui_source_window_base (DISASSEM_WIN)
- {
- }
-
- DISABLE_COPY_AND_ASSIGN (tui_disasm_window);
-
-protected:
-
- void do_scroll_vertical (enum tui_scroll_direction,
- int num_to_scroll) override;
-};
-
-struct tui_data_window : public tui_win_info
-{
- tui_data_window ()
- : tui_win_info (DATA_WIN)
- {
- }
-
- ~tui_data_window () override;
- DISABLE_COPY_AND_ASSIGN (tui_data_window);
-
- void clear_detail () override;
- void refresh_all () override;
-
- void set_new_height (int height) override;
-
- /* Start of data display content. */
- tui_win_content data_content = NULL;
- int data_content_count = 0;
- /* Start of regs display content. */
- tui_win_content regs_content = NULL;
- int regs_content_count = 0;
- int regs_column_count = 0;
- /* Should regs be displayed at all? */
- bool display_regs = false;
- struct reggroup *current_group = nullptr;
-
-protected:
-
- void do_scroll_vertical (enum tui_scroll_direction,
- int num_to_scroll) override;
- void do_scroll_horizontal (enum tui_scroll_direction,
- int num_to_scroll) override
- {
- }
-};
-
-struct tui_cmd_window : public tui_win_info
-{
- tui_cmd_window ()
- : tui_win_info (CMD_WIN)
+ /* Return true if this window can be scrolled, false otherwise. */
+ virtual bool can_scroll () const
{
+ return true;
}
- DISABLE_COPY_AND_ASSIGN (tui_cmd_window);
-
- void clear_detail () override;
-
- void make_visible (bool visible) override
+ bool can_box () const override
{
+ return true;
}
- int max_height () const override;
-
- int start_line = 0;
+ void check_and_display_highlight_if_needed ();
-protected:
-
- void do_scroll_vertical (enum tui_scroll_direction,
- int num_to_scroll) override
- {
- }
+ /* Window title to display. */
+ std::string title;
- void do_scroll_horizontal (enum tui_scroll_direction,
- int num_to_scroll) override
- {
- }
+ /* Is this window highlighted? */
+ bool is_highlighted = false;
};
-extern int tui_win_is_auxillary (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_base *) tui_win_list[SRC_WIN])
-#define TUI_DISASM_WIN ((tui_source_window_base *) tui_win_list[DISASSEM_WIN])
+#define TUI_SRC_WIN ((tui_source_window *) tui_win_list[SRC_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])
+/* All the windows that are currently instantiated, in layout
+ order. */
+extern std::vector<tui_win_info *> tui_windows;
+
+/* Return a range adapter for iterating over TUI windows. */
+static inline std::vector<tui_win_info *> &
+all_tui_windows ()
+{
+ return tui_windows;
+}
+
/* Data Manipulation Functions. */
-extern void tui_initialize_static_data (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 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_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 *);
projects / deliverable / binutils-gdb.git / blobdiff