/* 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.
#include "tui/tui.h" /* For enum tui_win_type. */
#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;
+
+/* A deleter that calls delwin. */
+struct curses_deleter
{
- int x, y;
+ void operator() (WINDOW *win) const
+ {
+ delwin (win);
+ }
};
/* Generic window information. */
{
}
+ /* 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. WIN_TYPE must match the existing type of this
- window (it is only passed for self-test purposes). The other
- parameters are used to set the window's size and position. */
- void reset (enum tui_win_type win_type,
- 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;
+
+ /* 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;
+ }
/* Window handle. */
- WINDOW *handle = nullptr;
+ std::unique_ptr<WINDOW, curses_deleter> handle;
/* Type of window. */
enum tui_win_type type;
/* Window width. */
/* Window height. */
int height = 0;
/* Origin of window. */
- struct tui_point origin = {0, 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;
-};
-
-/* Whether or not a window should be drawn with a box. */
-enum tui_box
-{
- DONT_BOX_WINDOW = 0,
- BOX_WINDOW
+ 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 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
-
/* The kinds of layouts available. */
enum tui_layout_type
{
} u;
};
-/* Current Layout definition. */
-struct tui_layout_def
-{
- enum tui_win_type display_mode;
-};
-
-/* Flags to tell what kind of breakpoint is at current line. */
-enum tui_bp_flag
-{
- 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
-{
- tui_source_element ()
- {
- line_or_addr.loa = LOA_LINE;
- line_or_addr.u.line_no = 0;
- }
-
- ~tui_source_element ()
- {
- xfree (line);
- }
-
- char *line = nullptr;
- struct tui_line_or_address line_or_addr;
- bool is_exec_point = false;
- tui_bp_flags break_mode = 0;
-};
-
-
-#ifdef PATH_MAX
-# define MAX_LOCATOR_ELEMENT_LEN PATH_MAX
-#else
-# define MAX_LOCATOR_ELEMENT_LEN 1024
-#endif
-
-/* 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];
-
-/* Execution info window class. */
-
-struct tui_exec_info_window : public tui_gen_win_info
-{
- tui_exec_info_window ()
- : tui_gen_win_info (EXEC_INFO_WIN)
- {
- }
-
- ~tui_exec_info_window () override
- {
- xfree (m_content);
- }
-
- /* Get or allocate contents. */
- tui_exec_info_content *maybe_allocate_content (int n_elements);
-
- /* Return the contents. */
- const tui_exec_info_content *get_content () const
- {
- return m_content;
- }
-
-private:
-
- tui_exec_info_content *m_content = nullptr;
-};
-
-/* 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;
-};
-
-/* A data item window. */
-
-struct tui_data_item_window : public tui_gen_win_info
-{
- tui_data_item_window ()
- : tui_gen_win_info (DATA_ITEM_WIN)
- {
- }
-
- ~tui_data_item_window () override;
-
- const char *name = nullptr;
- /* The register number, or data display number. */
- int item_no = UNDEFINED_ITEM;
- void *value = nullptr;
- bool highlight = false;
- char *content = nullptr;
-};
-
/* This defines information about each logical window. */
struct tui_win_info : public tui_gen_win_info
{
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:
{
}
- /* Clear the pertinent detail in the window. */
- virtual void clear_detail () = 0;
-
- /* Return true if this window has the locator. */
- virtual bool has_locator () const
- {
- return false;
- }
-
- /* Refresh this window and any associated windows. */
- virtual void refresh ();
-
- /* 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 ()
{
}
- /* 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;
return true;
}
- /* Can this window ever be highlighted? */
- bool can_highlight = true;
-
- /* 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 (int num_to_scroll) override;
- void do_make_visible_with_new_height () 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;
-
- void update_tab_width () override;
-
- /* Does the locator belong to this window? */
- bool m_has_locator = false;
- /* Execution information window. */
- struct tui_exec_info_window *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;
-
- std::vector<tui_source_element> content;
-};
-
-/* A TUI source window. */
-
-struct tui_source_window : public tui_source_window_base
-{
- tui_source_window ()
- : tui_source_window_base (SRC_WIN)
+ bool can_box () const override
{
+ return true;
}
- DISABLE_COPY_AND_ASSIGN (tui_source_window);
+ void check_and_display_highlight_if_needed ();
- const char *name () const override
- {
- return SRC_NAME;
- }
-
-protected:
+ /* Window title to display. */
+ std::string title;
- void do_scroll_vertical (int num_to_scroll) override;
+ /* Is this window highlighted? */
+ bool is_highlighted = false;
};
-/* 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);
-
- const char *name () const override
- {
- return DISASSEM_NAME;
- }
+/* Global Data. */
+extern struct tui_win_info *tui_win_list[MAX_MAJOR_WINDOWS];
-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])
- void do_scroll_vertical (int num_to_scroll) override;
-};
+/* An iterator that iterates over all windows. */
-struct tui_data_window : public tui_win_info
+class tui_window_iterator
{
- tui_data_window ()
- : tui_win_info (DATA_WIN)
- {
- }
-
- DISABLE_COPY_AND_ASSIGN (tui_data_window);
-
- void clear_detail () override;
- void refresh_all () override;
-
- void set_new_height (int height) override;
+public:
- void refresh_window () override;
+ 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;
- const char *name () const override
+ explicit tui_window_iterator (enum tui_win_type type)
+ : m_type (type)
{
- return DATA_NAME;
+ advance ();
}
- /* Windows that are used to display registers. */
- std::vector<std::unique_ptr<tui_data_item_window>> regs_content;
- int regs_column_count = 0;
- /* Should regs be displayed at all? */
- bool display_regs = false;
- struct reggroup *current_group = nullptr;
-
- /* Answer the number of the last line in the regs display. If there
- are no registers (-1) is returned. */
- int last_regs_line_no () const;
-
- /* Answer the line number that the register element at element_no is
- on. If element_no is greater than the number of register
- elements there are, -1 is returned. */
- int line_from_reg_element_no (int element_no) const;
-
- /* Answer the index of the first element in line_no. If line_no is
- past the register area (-1) is returned. */
- int first_reg_element_no_inline (int line_no) const;
-
- /* Displays the data that is in the data window's content. It does
- not set the content. */
- void display_all_data ();
-
- /* Delete all the item windows in the data window. This is usually
- done when the data window is scrolled. */
- void delete_data_content_windows ();
-
- void erase_data_content (const char *prompt);
-
- /* Display the registers in the content from 'start_element_no'
- until the end of the register content or the end of the display
- height. No checking for displaying past the end of the registers
- is done here. */
- void display_registers_from (int start_element_no);
-
- /* Display the registers starting at line line_no in the data
- window. Answers the line number that the display actually
- started from. If nothing is displayed (-1) is returned. */
- int display_registers_from_line (int line_no);
-
-protected:
-
- void do_scroll_vertical (int num_to_scroll) override;
- void do_scroll_horizontal (int num_to_scroll) override
+ tui_window_iterator ()
+ : m_type (MAX_MAJOR_WINDOWS)
{
}
- void do_make_visible_with_new_height () override;
-
- /* Return the index of the first element displayed. If none are
- displayed, then return -1. */
- int first_data_item_displayed ();
-
- /* Display the registers in the content from 'start_element_no' on
- 'start_line_no' until the end of the register content or the end
- of the display height. This function checks that we won't
- display off the end of the register display. */
- void display_reg_element_at_line (int start_element_no, int start_line_no);
-};
-struct tui_cmd_window : public tui_win_info
-{
- tui_cmd_window ()
- : tui_win_info (CMD_WIN)
+ bool operator!= (const self_type &other) const
{
- can_highlight = false;
+ return m_type != other.m_type;
}
- DISABLE_COPY_AND_ASSIGN (tui_cmd_window);
-
- void clear_detail () override;
-
- void make_visible (bool visible) override
+ value_type operator* () const
{
+ gdb_assert (m_type < MAX_MAJOR_WINDOWS);
+ return tui_win_list[m_type];
}
- int max_height () const override;
-
- void refresh_window () override
+ self_type &operator++ ()
{
+ ++m_type;
+ advance ();
+ return *this;
}
- const char *name () const override
- {
- return CMD_NAME;
- }
+private:
- bool can_scroll () const override
+ void advance ()
{
- return false;
+ while (m_type < MAX_MAJOR_WINDOWS && tui_win_list[m_type] == nullptr)
+ ++m_type;
}
- int start_line = 0;
+ int m_type;
+};
-protected:
+/* A range adapter for iterating over TUI windows. */
- void do_scroll_vertical (int num_to_scroll) override
+struct all_tui_windows
+{
+ tui_window_iterator begin () const
{
+ return tui_window_iterator (SRC_WIN);
}
- void do_scroll_horizontal (int num_to_scroll) override
+ tui_window_iterator end () const
{
+ return tui_window_iterator ();
}
-
- void do_make_visible_with_new_height () override;
};
-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_base *) 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])
/* 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 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_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 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 *);
+/* 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 */
projects / deliverable / binutils-gdb.git / blobdiff