[thirdparty/binutils-gdb.git] / gdb / tui / tui-data.h

/* TUI data manipulation routines.

   Copyright (C) 1998-2019 Free Software Foundation, Inc.

   Contributed by Hewlett-Packard Company.

   This file is part of GDB.

   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 3 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   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, see <http://www.gnu.org/licenses/>.  */

#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.  */

/* 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.  */
};

/* 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,
  LOA_ADDRESS
};

/* Structure describing source line or line address.  */
struct tui_line_or_address
{
  enum tui_line_or_address_kind loa;
  union
    {
      int line_no;
      CORE_ADDR addr;
    } 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 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;
};


struct tui_command_info
{
  int start_line;
};


/* This defines information about each logical window.  */
struct tui_win_info
{
protected:

  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;

  /* 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;
  }

  /* 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.  */
  union
  {
    struct tui_data_info data_display_info;
    struct tui_command_info command_info;
  }
  detail;

  /* 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_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;
  }

  /* 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_data_window () override;
  DISABLE_COPY_AND_ASSIGN (tui_data_window);

  void clear_detail () override;

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 ();
  DISABLE_COPY_AND_ASSIGN (tui_cmd_window);

  void clear_detail () override;

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
  {
  }
};

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 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_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 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_add_to_source_windows (struct tui_win_info *);
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_TUI_DATA_H */
Commit	Line	Data
f377b406	1	/* TUI data manipulation routines.
55fb0713	2
42a4f53d	3	Copyright (C) 1998-2019 Free Software Foundation, Inc.
55fb0713	4
f377b406 SC	5	Contributed by Hewlett-Packard Company.
	6
	7	This file is part of GDB.
	8
	9	This program is free software; you can redistribute it and/or modify
	10	it under the terms of the GNU General Public License as published by
a9762ec7	11	the Free Software Foundation; either version 3 of the License, or
f377b406 SC	12	(at your option) any later version.
	13
	14	This program is distributed in the hope that it will be useful,
	15	but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	GNU General Public License for more details.
	18
	19	You should have received a copy of the GNU General Public License
a9762ec7	20	along with this program. If not, see <http://www.gnu.org/licenses/>. */
f377b406	21
1a5c2598 TT	22	#ifndef TUI_TUI_DATA_H
1a5c2598 TT	23	#define TUI_TUI_DATA_H
c906108c	24
6a83354a AC	25	#include "tui/tui.h" /* For enum tui_win_type. */
	26	#include "gdb_curses.h" /* For WINDOW. */
	27
	28	/* This is a point definition. */
	29	struct tui_point
	30	{
	31	int x, y;
	32	};
2a5127c4	33
63ed8182 PP	34	struct tui_win_element;
	35
	36	/* This describes the content of the window. */
	37	typedef struct tui_win_element **tui_win_content;
	38
1cc6d956	39	/* Generic window information. */
2a8854a7 AC	40	struct tui_gen_win_info
2a8854a7 AC	41	{
08ef48c5 MS	42	WINDOW handle; / Window handle. */
	43	enum tui_win_type type; /* Type of window. */
	44	int width; /* Window width. */
	45	int height; /* Window height. */
	46	struct tui_point origin; /* Origin of window. */
63ed8182	47	tui_win_content content; /* Content of window. */
08ef48c5 MS	48	int content_size; /* Size of content (# of elements). */
	49	int content_in_use; /* Can it be used, or is it already used? */
	50	int viewport_height; /* Viewport height. */
	51	int last_visible_line; /* Index of last visible line. */
	52	int is_visible; /* Whether the window is visible or not. */
	53	char title; / Window title to display. */
2a8854a7	54	};
2a5127c4	55
1cc6d956	56	/* Constant definitions. */
08ef48c5 MS	57	#define DEFAULT_TAB_LEN 8
	58	#define NO_SRC_STRING "[ No Source Available ]"
	59	#define NO_DISASSEM_STRING "[ No Assembly Available ]"
	60	#define NO_REGS_STRING "[ Register Values Unavailable ]"
	61	#define NO_DATA_STRING "[ No Data Values Displayed ]"
	62	#define MAX_CONTENT_COUNT 100
6dce28e4 AB	63	#define SRC_NAME "src"
	64	#define CMD_NAME "cmd"
	65	#define DATA_NAME "regs"
	66	#define DISASSEM_NAME "asm"
08ef48c5 MS	67	#define TUI_NULL_STR ""
	68	#define DEFAULT_HISTORY_COUNT 25
	69	#define BOX_WINDOW TRUE
	70	#define DONT_BOX_WINDOW FALSE
	71	#define HILITE TRUE
	72	#define NO_HILITE FALSE
	73	#define WITH_LOCATOR TRUE
	74	#define NO_LOCATOR FALSE
	75	#define EMPTY_SOURCE_PROMPT TRUE
	76	#define NO_EMPTY_SOURCE_PROMPT FALSE
	77	#define UNDEFINED_ITEM -1
	78	#define MIN_WIN_HEIGHT 3
	79	#define MIN_CMD_WIN_HEIGHT 3
c906108c	80
50265402	81	/* Strings to display in the TUI status line. */
08ef48c5	82	#define PROC_PREFIX "In: "
9f2850ba	83	#define LINE_PREFIX "L"
08ef48c5 MS	84	#define PC_PREFIX "PC: "
08ef48c5 MS	85	#define SINGLE_KEY "(SingleKey)"
50265402	86
1cc6d956 MS	87	/* Minimum/Maximum length of some fields displayed in the TUI status
	88	line. */
	89	#define MIN_LINE_WIDTH 4 /* Use at least 4 digits for line
	90	numbers. */
50265402 SC	91	#define MIN_PROC_WIDTH 12
50265402 SC	92	#define MAX_TARGET_WIDTH 10
9f2850ba	93	#define MAX_PID_WIDTH 19
c906108c	94
2a8854a7 AC	95	/* Scroll direction enum. */
	96	enum tui_scroll_direction
	97	{
	98	FORWARD_SCROLL,
	99	BACKWARD_SCROLL,
	100	LEFT_SCROLL,
	101	RIGHT_SCROLL
	102	};
c906108c SS	103
c906108c SS	104
1cc6d956	105	/* The kinds of layouts available. */
2a8854a7 AC	106	enum tui_layout_type
	107	{
	108	SRC_COMMAND,
	109	DISASSEM_COMMAND,
	110	SRC_DISASSEM_COMMAND,
	111	SRC_DATA_COMMAND,
	112	DISASSEM_DATA_COMMAND,
	113	UNDEFINED_LAYOUT
	114	};
c906108c	115
1cc6d956	116	/* Basic data types that can be displayed in the data window. */
2a8854a7 AC	117	enum tui_data_type
	118	{
	119	TUI_REGISTER,
	120	TUI_SCALAR,
	121	TUI_COMPLEX,
	122	TUI_STRUCT
	123	};
c906108c	124
52059ffd TT	125	enum tui_line_or_address_kind
	126	{
	127	LOA_LINE,
	128	LOA_ADDRESS
	129	};
	130
1cc6d956	131	/* Structure describing source line or line address. */
362c05fe	132	struct tui_line_or_address
2a8854a7	133	{
52059ffd	134	enum tui_line_or_address_kind loa;
362c05fe AS	135	union
	136	{
	137	int line_no;
	138	CORE_ADDR addr;
	139	} u;
2a8854a7	140	};
c906108c	141
1cc6d956	142	/* Current Layout definition. */
2a8854a7 AC	143	struct tui_layout_def
2a8854a7 AC	144	{
6d012f14	145	enum tui_win_type display_mode;
2a8854a7	146	int split;
2a8854a7	147	};
c906108c	148
1cc6d956	149	/* Elements in the Source/Disassembly Window. */
2a8854a7 AC	150	struct tui_source_element
	151	{
	152	char *line;
362c05fe	153	struct tui_line_or_address line_or_addr;
6d012f14 AC	154	int is_exec_point;
6d012f14 AC	155	int has_break;
2a8854a7	156	};
c906108c SS	157
c906108c SS	158
1cc6d956	159	/* Elements in the data display window content. */
2a8854a7 AC	160	struct tui_data_element
	161	{
	162	const char *name;
08ef48c5 MS	163	int item_no; /* The register number, or data display
08ef48c5 MS	164	number. */
2a8854a7	165	enum tui_data_type type;
22940a24	166	void *value;
2a8854a7	167	int highlight;
10f59415	168	char *content;
2a8854a7	169	};
c906108c SS	170
c906108c SS	171
1cc6d956	172	/* Elements in the command window content. */
2a8854a7 AC	173	struct tui_command_element
	174	{
	175	char *line;
	176	};
c906108c	177
2d42f9a8 JB	178	#ifdef PATH_MAX
	179	# define MAX_LOCATOR_ELEMENT_LEN PATH_MAX
	180	#else
	181	# define MAX_LOCATOR_ELEMENT_LEN 1024
	182	#endif
c906108c	183
1cc6d956	184	/* Elements in the locator window content. */
2a8854a7 AC	185	struct tui_locator_element
2a8854a7 AC	186	{
56d397a3 JK	187	/* Resolved absolute filename as returned by symtab_to_fullname. */
56d397a3 JK	188	char full_name[MAX_LOCATOR_ELEMENT_LEN];
6d012f14 AC	189	char proc_name[MAX_LOCATOR_ELEMENT_LEN];
6d012f14 AC	190	int line_no;
2a8854a7	191	CORE_ADDR addr;
13274fc3 UW	192	/* Architecture associated with code at this location. */
13274fc3 UW	193	struct gdbarch *gdbarch;
2a8854a7	194	};
c906108c	195
00b2bad4 SC	196	/* Flags to tell what kind of breakpoint is at current line. */
	197	#define TUI_BP_ENABLED 0x01
	198	#define TUI_BP_DISABLED 0x02
	199	#define TUI_BP_HIT 0x04
	200	#define TUI_BP_CONDITIONAL 0x08
	201	#define TUI_BP_HARDWARE 0x10
	202
	203	/* Position of breakpoint markers in the exec info string. */
	204	#define TUI_BP_HIT_POS 0
	205	#define TUI_BP_BREAK_POS 1
	206	#define TUI_EXEC_POS 2
	207	#define TUI_EXECINFO_SIZE 4
	208
2a8854a7	209	typedef char tui_exec_info_content[TUI_EXECINFO_SIZE];
c906108c	210
1cc6d956	211	/* An content element in a window. */
2a8854a7 AC	212	union tui_which_element
2a8854a7 AC	213	{
1cc6d956 MS	214	struct tui_source_element source; /* The source elements. */
	215	struct tui_gen_win_info data_window; /* Data display elements. */
	216	struct tui_data_element data; /* Elements of data_window. */
	217	struct tui_command_element command; /* Command elements. */
	218	struct tui_locator_element locator; /* Locator elements. */
	219	tui_exec_info_content simple_string; /* Simple char based elements. */
2a8854a7 AC	220	};
	221
	222	struct tui_win_element
	223	{
6d012f14	224	union tui_which_element which_element;
2a8854a7	225	};
c906108c	226
1cc6d956 MS	227	/* This struct defines the specific information about a data display
1cc6d956 MS	228	window. */
2a8854a7 AC	229	struct tui_data_info
2a8854a7 AC	230	{
1cc6d956	231	tui_win_content data_content; /* Start of data display content. */
6d012f14	232	int data_content_count;
1cc6d956	233	tui_win_content regs_content; /* Start of regs display content. */
6d012f14	234	int regs_content_count;
6d012f14	235	int regs_column_count;
1cc6d956	236	int display_regs; /* Should regs be displayed at all? */
10f59415	237	struct reggroup *current_group;
2a8854a7 AC	238	};
	239
	240
2a8854a7 AC	241	struct tui_command_info
2a8854a7 AC	242	{
2a8854a7 AC	243	int start_line;
2a8854a7 AC	244	};
c906108c SS	245
c906108c SS	246
1cc6d956	247	/* This defines information about each logical window. */
2a8854a7 AC	248	struct tui_win_info
2a8854a7 AC	249	{
33b906ab	250	protected:
e7e11af4	251
33b906ab	252	explicit tui_win_info (enum tui_win_type type);
6792b55e TT	253	DISABLE_COPY_AND_ASSIGN (tui_win_info);
6792b55e TT	254
13446e05 TT	255	/* Scroll the contents vertically. This is only called via
	256	forward_scroll and backward_scroll. */
	257	virtual void do_scroll_vertical (enum tui_scroll_direction,
	258	int num_to_scroll) = 0;
	259
	260	/* Scroll the contents horizontally. This is only called via
	261	left_scroll and right_scroll. */
	262	virtual void do_scroll_horizontal (enum tui_scroll_direction,
	263	int num_to_scroll) = 0;
	264
33b906ab TT	265	public:
	266
	267	virtual ~tui_win_info ();
	268
8761a91b TT	269	/* Clear the pertinent detail in the window. */
	270	virtual void clear_detail () = 0;
	271
44f0e208 TT	272	/* Return true if this window has the locator. */
	273	virtual bool has_locator () const
	274	{
	275	return false;
	276	}
	277
13446e05 TT	278	/* Methods to scroll the contents of this window. Note that they
	279	are named with "_scroll" coming at the end because the more
	280	obvious "scroll_forward" is defined as a macro in term.h. */
	281	void forward_scroll (int num_to_scroll);
	282	void backward_scroll (int num_to_scroll);
	283	void left_scroll (int num_to_scroll);
	284	void right_scroll (int num_to_scroll);
	285
1cc6d956	286	struct tui_gen_win_info generic; /* General window information. */
2a8854a7	287	union
c5aa993b	288	{
6d012f14 AC	289	struct tui_data_info data_display_info;
6d012f14 AC	290	struct tui_command_info command_info;
c5aa993b	291	}
2a8854a7	292	detail;
33b906ab TT	293
	294	/* Can this window ever be highlighted? */
	295	int can_highlight = 0;
	296
	297	/* Is this window highlighted? */
	298	int is_highlighted = 0;
	299	};
	300
5cf82909 TT	301	/* The base class for all source-like windows, namely the source and
	302	disassembly windows. */
	303
	304	struct tui_source_window_base : public tui_win_info
33b906ab	305	{
5cf82909 TT	306	protected:
	307	explicit tui_source_window_base (enum tui_win_type type);
	308	~tui_source_window_base () override;
	309	DISABLE_COPY_AND_ASSIGN (tui_source_window_base);
	310
13446e05 TT	311	void do_scroll_horizontal (enum tui_scroll_direction,
	312	int num_to_scroll) override;
	313
5cf82909	314	public:
8761a91b TT	315
8761a91b TT	316	void clear_detail () override;
44f0e208 TT	317
44f0e208 TT	318	/* Return true if this window has the locator. */
e6e41501 TT	319	bool has_locator () const override
	320	{
	321	return m_has_locator;
	322	}
	323
	324	/* Does the locator belong to this window? */
	325	bool m_has_locator = false;
	326	/* Execution information window. */
	327	struct tui_gen_win_info *execution_info = nullptr;
	328	/* Used for horizontal scroll. */
	329	int horizontal_offset = 0;
	330	struct tui_line_or_address start_line_or_addr;
	331
	332	/* It is the resolved form as returned by symtab_to_fullname. */
	333	char *fullname = nullptr;
	334
	335	/* Architecture associated with code at this location. */
	336	struct gdbarch *gdbarch = nullptr;
33b906ab TT	337	};
33b906ab TT	338
5cf82909 TT	339	/* A TUI source window. */
	340
	341	struct tui_source_window : public tui_source_window_base
	342	{
	343	tui_source_window ()
	344	: tui_source_window_base (SRC_WIN)
	345	{
	346	}
	347
	348	DISABLE_COPY_AND_ASSIGN (tui_source_window);
13446e05 TT	349
	350	protected:
	351
	352	void do_scroll_vertical (enum tui_scroll_direction,
	353	int num_to_scroll) override;
5cf82909 TT	354	};
	355
	356	/* A TUI disassembly window. */
	357
	358	struct tui_disasm_window : public tui_source_window_base
	359	{
	360	tui_disasm_window ()
	361	: tui_source_window_base (DISASSEM_WIN)
	362	{
	363	}
	364
	365	DISABLE_COPY_AND_ASSIGN (tui_disasm_window);
13446e05 TT	366
	367	protected:
	368
	369	void do_scroll_vertical (enum tui_scroll_direction,
	370	int num_to_scroll) override;
5cf82909 TT	371	};
5cf82909 TT	372
33b906ab TT	373	struct tui_data_window : public tui_win_info
	374	{
	375	tui_data_window ();
ee1d42d6	376	~tui_data_window () override;
33b906ab	377	DISABLE_COPY_AND_ASSIGN (tui_data_window);
8761a91b TT	378
8761a91b TT	379	void clear_detail () override;
13446e05 TT	380
	381	protected:
	382
	383	void do_scroll_vertical (enum tui_scroll_direction,
	384	int num_to_scroll) override;
	385	void do_scroll_horizontal (enum tui_scroll_direction,
	386	int num_to_scroll) override
	387	{
	388	}
33b906ab TT	389	};
	390
	391	struct tui_cmd_window : public tui_win_info
	392	{
	393	tui_cmd_window ();
	394	DISABLE_COPY_AND_ASSIGN (tui_cmd_window);
8761a91b TT	395
8761a91b TT	396	void clear_detail () override;
13446e05 TT	397
	398	protected:
	399
	400	void do_scroll_vertical (enum tui_scroll_direction,
	401	int num_to_scroll) override
	402	{
	403	}
	404
	405	void do_scroll_horizontal (enum tui_scroll_direction,
	406	int num_to_scroll) override
	407	{
	408	}
2a8854a7	409	};
c906108c	410
6d012f14 AC	411	extern int tui_win_is_source_type (enum tui_win_type win_type);
6d012f14 AC	412	extern int tui_win_is_auxillary (enum tui_win_type win_type);
6d012f14 AC	413	extern void tui_set_win_highlight (struct tui_win_info *win_info,
6d012f14 AC	414	int highlight);
c906108c SS	415
c906108c SS	416
1cc6d956	417	/* Global Data. */
7fa29be9	418	extern struct tui_win_info *tui_win_list[MAX_MAJOR_WINDOWS];
c906108c	419
e6e41501 TT	420	#define TUI_SRC_WIN ((tui_source_window_base *) tui_win_list[SRC_WIN])
e6e41501 TT	421	#define TUI_DISASM_WIN ((tui_source_window_base *) tui_win_list[DISASSEM_WIN])
1cc6d956 MS	422	#define TUI_DATA_WIN tui_win_list[DATA_WIN]
1cc6d956 MS	423	#define TUI_CMD_WIN tui_win_list[CMD_WIN]
c906108c	424
1cc6d956	425	/* Data Manipulation Functions. */
dd1abb8c AC	426	extern void tui_initialize_static_data (void);
dd1abb8c AC	427	extern struct tui_gen_win_info *tui_alloc_generic_win_info (void);
22940a24	428	extern struct tui_win_info *tui_alloc_win_info (enum tui_win_type);
dd1abb8c	429	extern void tui_init_generic_part (struct tui_gen_win_info *);
2a8854a7	430	extern tui_win_content tui_alloc_content (int, enum tui_win_type);
08ef48c5 MS	431	extern int tui_add_content_elements (struct tui_gen_win_info *,
08ef48c5 MS	432	int);
dd1abb8c	433	extern void tui_free_win_content (struct tui_gen_win_info *);
2a8854a7	434	extern void tui_free_data_content (tui_win_content, int);
dd1abb8c	435	extern void tui_free_all_source_wins_content (void);
a121b7c1	436	extern struct tui_win_info tui_partial_win_by_name (const char );
f41cbf58	437	extern const char tui_win_name (const struct tui_gen_win_info );
2a8854a7 AC	438	extern enum tui_layout_type tui_current_layout (void);
2a8854a7 AC	439	extern void tui_set_current_layout_to (enum tui_layout_type);
dd1abb8c AC	440	extern int tui_term_height (void);
	441	extern void tui_set_term_height_to (int);
	442	extern int tui_term_width (void);
	443	extern void tui_set_term_width_to (int);
dd1abb8c AC	444	extern struct tui_gen_win_info *tui_locator_win_info_ptr (void);
	445	extern struct tui_gen_win_info *tui_source_exec_info_win_ptr (void);
	446	extern struct tui_gen_win_info *tui_disassem_exec_info_win_ptr (void);
b4eb2452	447	extern std::vector<tui_win_info *> &tui_source_windows ();
dd1abb8c AC	448	extern void tui_clear_source_windows (void);
dd1abb8c AC	449	extern void tui_clear_source_windows_detail (void);
dd1abb8c	450	extern void tui_add_to_source_windows (struct tui_win_info *);
dd1abb8c AC	451	extern struct tui_win_info *tui_win_with_focus (void);
dd1abb8c AC	452	extern void tui_set_win_with_focus (struct tui_win_info *);
5b6fe301	453	extern struct tui_layout_def *tui_layout_def (void);
dd1abb8c AC	454	extern int tui_win_resized (void);
	455	extern void tui_set_win_resized_to (int);
	456
	457	extern struct tui_win_info tui_next_win (struct tui_win_info );
	458	extern struct tui_win_info tui_prev_win (struct tui_win_info );
	459
08ef48c5	460	extern void tui_add_to_source_windows (struct tui_win_info *);
c7c228ed	461
7806cea7 TT	462	extern unsigned int tui_tab_width;
7806cea7 TT	463
1a5c2598	464	#endif /* TUI_TUI_DATA_H */