/* TUI data manipulation routines.
- Copyright 1998, 1999, 2000, 2001, 2002, 2004 Free Software
- Foundation, Inc.
+ Copyright (C) 1998-2019 Free Software Foundation, Inc.
Contributed by Hewlett-Packard Company.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
+ the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA. */
+ 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
-#if defined (HAVE_NCURSES_H)
-#include <ncurses.h>
-#elif defined (HAVE_CURSES_H)
-#include <curses.h>
-#endif
+#include "tui/tui.h" /* For enum tui_win_type. */
+#include "gdb_curses.h" /* For 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 */
+/* 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 */
- void **content; /* content of window */
- int contentSize; /* Size of content (# of elements) */
- int contentInUse; /* Can it be used, or is it already used? */
- int viewportHeight; /* viewport height */
- int lastVisibleLine; /* index of last visible line */
- int isVisible; /* whether the window is visible or not */
- char* title; /* Window title to display. */
+ 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. */
};
-/* 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
+/* 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 "Line: "
-#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 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 14
-
-#define TUI_FLOAT_REGS_NAME "$FREGS"
-#define TUI_FLOAT_REGS_NAME_LOWER "$fregs"
-#define TUI_GENERAL_REGS_NAME "$GREGS"
-#define TUI_GENERAL_REGS_NAME_LOWER "$gregs"
-#define TUI_SPECIAL_REGS_NAME "$SREGS"
-#define TUI_SPECIAL_REGS_NAME_LOWER "$sregs"
-#define TUI_GENERAL_SPECIAL_REGS_NAME "$REGS"
-#define TUI_GENERAL_SPECIAL_REGS_NAME_LOWER "$regs"
+#define MAX_PID_WIDTH 19
/* Scroll direction enum. */
enum tui_scroll_direction
};
-/* General list struct. */
-struct tui_list
-{
- void **list;
- int count;
-};
-
-
-/* The kinds of layouts available */
+/* The kinds of layouts available. */
enum tui_layout_type
{
SRC_COMMAND,
UNDEFINED_LAYOUT
};
-/* Basic data types that can be displayed in the data window. */
+/* Basic data types that can be displayed in the data window. */
enum tui_data_type
{
TUI_REGISTER,
TUI_STRUCT
};
-/* Types of register displays */
-enum tui_register_display_type
+enum tui_line_or_address_kind
{
- TUI_UNDEFINED_REGS,
- TUI_GENERAL_REGS,
- TUI_SFLOAT_REGS,
- TUI_DFLOAT_REGS,
- TUI_SPECIAL_REGS,
- TUI_GENERAL_AND_SPECIAL_REGS
+ LOA_LINE,
+ LOA_ADDRESS
};
-/* Structure describing source line or line address */
-union tui_line_or_address
+/* Structure describing source line or line address. */
+struct tui_line_or_address
{
- int lineNo;
- CORE_ADDR addr;
+ enum tui_line_or_address_kind loa;
+ union
+ {
+ int line_no;
+ CORE_ADDR addr;
+ } u;
};
-/* Current Layout definition */
+/* Current Layout definition. */
struct tui_layout_def
{
- enum tui_win_type displayMode;
+ enum tui_win_type display_mode;
int split;
- enum tui_register_display_type regsDisplayType;
- enum tui_register_display_type floatRegsDisplayType;
};
-/* Elements in the Source/Disassembly Window */
+/* Elements in the Source/Disassembly Window. */
struct tui_source_element
{
char *line;
- union tui_line_or_address lineOrAddr;
- int isExecPoint;
- int hasBreak;
+ struct tui_line_or_address line_or_addr;
+ int is_exec_point;
+ int has_break;
};
-/* Elements in the data display window content */
+/* Elements in the data display window content. */
struct tui_data_element
{
const char *name;
- int itemNo; /* the register number, or data display number */
+ 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 */
+/* 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
-#define MAX_LOCATOR_ELEMENT_LEN 100
-
-/* Elements in the locator window content */
+/* Elements in the locator window content. */
struct tui_locator_element
{
- char fileName[MAX_LOCATOR_ELEMENT_LEN];
- char procName[MAX_LOCATOR_ELEMENT_LEN];
- int lineNo;
+ /* 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. */
typedef char tui_exec_info_content[TUI_EXECINFO_SIZE];
-/* An content element in a window */
+/* An content element in a window. */
union tui_which_element
{
- struct tui_source_element source; /* the source elements */
- struct tui_gen_win_info dataWindow; /* data display elements */
- struct tui_data_element data; /* elements of dataWindow */
- struct tui_command_element command; /* command elements */
- struct tui_locator_element locator; /* locator elements */
- tui_exec_info_content simpleString; /* simple char based elements */
+ 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
{
- int highlight;
- union tui_which_element whichElement;
+ union tui_which_element which_element;
};
+/* This defines information about each logical window. */
+struct tui_win_info
+{
+protected:
-/* This describes the content of the window. */
-typedef struct tui_win_element **tui_win_content;
+ 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 (enum tui_scroll_direction,
+ int num_to_scroll) = 0;
-/* This struct defines the specific information about a data display window */
-struct tui_data_info
-{
- tui_win_content dataContent; /* start of data display content */
- int dataContentCount;
- tui_win_content regsContent; /* start of regs display content */
- int regsContentCount;
- enum tui_register_display_type regsDisplayType;
- int regsColumnCount;
- int displayRegs; /* Should regs be displayed at all? */
+ /* 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;
+
+public:
+
+ virtual ~tui_win_info ();
+
+ /* 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;
+ }
+
+ /* Make this window visible or invisible. */
+ virtual void make_visible (int visible);
+
+ /* 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_gen_win_info generic; /* General window information. */
+
+ /* Can this window ever be highlighted? */
+ int can_highlight = 0;
+
+ /* Is this window highlighted? */
+ int is_highlighted = 0;
};
+/* The base class for all source-like windows, namely the source and
+ disassembly windows. */
-struct tui_source_info
+struct tui_source_window_base : public tui_win_info
{
- int hasLocator; /* Does locator belongs to this window? */
+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 (int visible) override;
+
+ /* Does the locator belong to this window? */
+ bool m_has_locator = false;
/* Execution information window. */
- struct tui_gen_win_info *executionInfo;
- int horizontalOffset; /* used for horizontal scroll */
- union tui_line_or_address startLineOrAddr;
- char* filename;
+ 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_command_info
+struct tui_source_window : public tui_source_window_base
{
- int curLine; /* The current line position */
- int curch; /* The current cursor position */
- int start_line;
+ 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. */
-/* This defines information about each logical window */
-struct tui_win_info
+struct tui_disasm_window : public tui_source_window_base
{
- struct tui_gen_win_info generic; /* general window information */
- union
+ 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;
+
+ /* 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)
+ {
+ }
+
+ DISABLE_COPY_AND_ASSIGN (tui_cmd_window);
+
+ void clear_detail () override;
+
+ void make_visible (int visible) override
+ {
+ }
+
+ int start_line = 0;
+
+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_source_info sourceInfo;
- struct tui_data_info dataDisplayInfo;
- struct tui_command_info commandInfo;
- void *opaque;
}
- detail;
- int canHighlight; /* Can this window ever be highlighted? */
- int isHighlighted; /* Is this window highlighted? */
};
-/* MACROS (prefixed with m_) */
-
-/* Testing macros */
-#define m_genWinPtrIsNull(winInfo) \
- ((winInfo) == (struct tui_gen_win_info *)NULL)
-#define m_genWinPtrNotNull(winInfo) \
- ((winInfo) != (struct tui_gen_win_info *)NULL)
-#define m_winPtrIsNull(winInfo) \
- ((winInfo) == (struct tui_win_info *)NULL)
-#define m_winPtrNotNull(winInfo) \
- ((winInfo) != (struct tui_win_info *)NULL)
-
-#define m_winIsSourceType(type) \
- (type == SRC_WIN || type == DISASSEM_WIN)
-#define m_winIsAuxillary(winType) \
- (winType > MAX_MAJOR_WINDOWS)
-#define m_hasLocator(winInfo) \
- ( ((winInfo) != (struct tui_win_info *)NULL) ? \
- (winInfo->detail.sourceInfo.hasLocator) : \
- FALSE )
-
-#define m_setWinHighlightOn(winInfo) \
- if ((winInfo) != (struct tui_win_info *)NULL) \
- (winInfo)->isHighlighted = TRUE
-#define m_setWinHighlightOff(winInfo) \
- if ((winInfo) != (struct tui_win_info *)NULL) \
- (winInfo)->isHighlighted = FALSE
-
-
-/* Global Data */
-extern struct tui_win_info *(winList[MAX_MAJOR_WINDOWS]);
-
-/* Macros */
-#define srcWin winList[SRC_WIN]
-#define disassemWin winList[DISASSEM_WIN]
-#define dataWin winList[DATA_WIN]
-#define cmdWin winList[CMD_WIN]
-
-/* Data Manipulation Functions */
+extern int tui_win_is_auxillary (enum tui_win_type win_type);
+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_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_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 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 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 char *tui_win_name (struct tui_gen_win_info *);
+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 void tui_set_gen_win_origin (struct tui_gen_win_info *, int, 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 std::vector<tui_win_info *> &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 * winInfo);
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 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 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 * winInfo);
+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 */
projects / deliverable / binutils-gdb.git / blobdiff