[deliverable/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
{
  explicit tui_gen_win_info (enum tui_win_type t)
    : type (t)
  {
  }

  virtual ~tui_gen_win_info ()
  {
  }

  /* Call to refresh this window.  */
  virtual void refresh_window ();

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

/* 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 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);
  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:

  ~tui_win_info () override;

  /* 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 (bool visible);

  /* 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 ()
  {
  }

  /* Called after a TUI window is given a new height; this updates any
     related auxiliary windows.  */
  virtual void set_new_height (int height)
  {
  }

  /* Compute the maximum height of this window.  */
  virtual int max_height () const;

  /* Set whether this window is highglighted.  */
  void set_highlight (bool highlight)
  {
    is_highlighted = highlight;
  }

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

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

  void refresh_window () 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 (bool visible) override
  {
  }

  int max_height () const override;

  void refresh_window () 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
  {
  }
};

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_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_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_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 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	{
ab313b35 TT	42	explicit tui_gen_win_info (enum tui_win_type t)
	43	: type (t)
	44	{
	45	}
	46
cb2ce893	47	virtual ~tui_gen_win_info ()
ab313b35 TT	48	{
	49	}
	50
5b81daba TT	51	/* Call to refresh this window. */
	52	virtual void refresh_window ();
	53
ab313b35 TT	54	/* Window handle. */
	55	WINDOW *handle = nullptr;
	56	/* Type of window. */
	57	enum tui_win_type type;
	58	/* Window width. */
	59	int width = 0;
	60	/* Window height. */
	61	int height = 0;
	62	/* Origin of window. */
	63	struct tui_point origin = {0, 0};
	64	/* Content of window. */
	65	tui_win_content content = nullptr;
	66	/* Size of content (# of elements). */
	67	int content_size = 0;
	68	/* Can it be used, or is it already used? */
	69	int content_in_use = FALSE;
	70	/* Viewport height. */
	71	int viewport_height = 0;
	72	/* Index of last visible line. */
	73	int last_visible_line = 0;
	74	/* Whether the window is visible or not. */
	75	bool is_visible = false;
	76	/* Window title to display. */
	77	char *title = nullptr;
2a8854a7	78	};
2a5127c4	79
1cc6d956	80	/* Constant definitions. */
08ef48c5 MS	81	#define DEFAULT_TAB_LEN 8
	82	#define NO_SRC_STRING "[ No Source Available ]"
	83	#define NO_DISASSEM_STRING "[ No Assembly Available ]"
	84	#define NO_REGS_STRING "[ Register Values Unavailable ]"
	85	#define NO_DATA_STRING "[ No Data Values Displayed ]"
	86	#define MAX_CONTENT_COUNT 100
6dce28e4 AB	87	#define SRC_NAME "src"
	88	#define CMD_NAME "cmd"
	89	#define DATA_NAME "regs"
	90	#define DISASSEM_NAME "asm"
08ef48c5 MS	91	#define TUI_NULL_STR ""
	92	#define DEFAULT_HISTORY_COUNT 25
	93	#define BOX_WINDOW TRUE
	94	#define DONT_BOX_WINDOW FALSE
	95	#define HILITE TRUE
	96	#define NO_HILITE FALSE
	97	#define WITH_LOCATOR TRUE
	98	#define NO_LOCATOR FALSE
	99	#define EMPTY_SOURCE_PROMPT TRUE
	100	#define NO_EMPTY_SOURCE_PROMPT FALSE
	101	#define UNDEFINED_ITEM -1
	102	#define MIN_WIN_HEIGHT 3
	103	#define MIN_CMD_WIN_HEIGHT 3
c906108c	104
50265402	105	/* Strings to display in the TUI status line. */
08ef48c5	106	#define PROC_PREFIX "In: "
9f2850ba	107	#define LINE_PREFIX "L"
08ef48c5 MS	108	#define PC_PREFIX "PC: "
08ef48c5 MS	109	#define SINGLE_KEY "(SingleKey)"
50265402	110
1cc6d956 MS	111	/* Minimum/Maximum length of some fields displayed in the TUI status
	112	line. */
	113	#define MIN_LINE_WIDTH 4 /* Use at least 4 digits for line
	114	numbers. */
50265402 SC	115	#define MIN_PROC_WIDTH 12
50265402 SC	116	#define MAX_TARGET_WIDTH 10
9f2850ba	117	#define MAX_PID_WIDTH 19
c906108c	118
2a8854a7 AC	119	/* Scroll direction enum. */
	120	enum tui_scroll_direction
	121	{
	122	FORWARD_SCROLL,
	123	BACKWARD_SCROLL,
	124	LEFT_SCROLL,
	125	RIGHT_SCROLL
	126	};
c906108c SS	127
c906108c SS	128
1cc6d956	129	/* The kinds of layouts available. */
2a8854a7 AC	130	enum tui_layout_type
	131	{
	132	SRC_COMMAND,
	133	DISASSEM_COMMAND,
	134	SRC_DISASSEM_COMMAND,
	135	SRC_DATA_COMMAND,
	136	DISASSEM_DATA_COMMAND,
	137	UNDEFINED_LAYOUT
	138	};
c906108c	139
1cc6d956	140	/* Basic data types that can be displayed in the data window. */
2a8854a7 AC	141	enum tui_data_type
	142	{
	143	TUI_REGISTER,
	144	TUI_SCALAR,
	145	TUI_COMPLEX,
	146	TUI_STRUCT
	147	};
c906108c	148
52059ffd TT	149	enum tui_line_or_address_kind
	150	{
	151	LOA_LINE,
	152	LOA_ADDRESS
	153	};
	154
1cc6d956	155	/* Structure describing source line or line address. */
362c05fe	156	struct tui_line_or_address
2a8854a7	157	{
52059ffd	158	enum tui_line_or_address_kind loa;
362c05fe AS	159	union
	160	{
	161	int line_no;
	162	CORE_ADDR addr;
	163	} u;
2a8854a7	164	};
c906108c	165
1cc6d956	166	/* Current Layout definition. */
2a8854a7 AC	167	struct tui_layout_def
2a8854a7 AC	168	{
6d012f14	169	enum tui_win_type display_mode;
2a8854a7	170	int split;
2a8854a7	171	};
c906108c	172
1cc6d956	173	/* Elements in the Source/Disassembly Window. */
2a8854a7 AC	174	struct tui_source_element
	175	{
	176	char *line;
362c05fe	177	struct tui_line_or_address line_or_addr;
6d012f14 AC	178	int is_exec_point;
6d012f14 AC	179	int has_break;
2a8854a7	180	};
c906108c SS	181
c906108c SS	182
1cc6d956	183	/* Elements in the data display window content. */
2a8854a7 AC	184	struct tui_data_element
	185	{
	186	const char *name;
08ef48c5 MS	187	int item_no; /* The register number, or data display
08ef48c5 MS	188	number. */
2a8854a7	189	enum tui_data_type type;
22940a24	190	void *value;
2a8854a7	191	int highlight;
10f59415	192	char *content;
2a8854a7	193	};
c906108c SS	194
c906108c SS	195
1cc6d956	196	/* Elements in the command window content. */
2a8854a7 AC	197	struct tui_command_element
	198	{
	199	char *line;
	200	};
c906108c	201
2d42f9a8 JB	202	#ifdef PATH_MAX
	203	# define MAX_LOCATOR_ELEMENT_LEN PATH_MAX
	204	#else
	205	# define MAX_LOCATOR_ELEMENT_LEN 1024
	206	#endif
c906108c	207
1cc6d956	208	/* Elements in the locator window content. */
2a8854a7 AC	209	struct tui_locator_element
2a8854a7 AC	210	{
56d397a3 JK	211	/* Resolved absolute filename as returned by symtab_to_fullname. */
56d397a3 JK	212	char full_name[MAX_LOCATOR_ELEMENT_LEN];
6d012f14 AC	213	char proc_name[MAX_LOCATOR_ELEMENT_LEN];
6d012f14 AC	214	int line_no;
2a8854a7	215	CORE_ADDR addr;
13274fc3 UW	216	/* Architecture associated with code at this location. */
13274fc3 UW	217	struct gdbarch *gdbarch;
2a8854a7	218	};
c906108c	219
00b2bad4 SC	220	/* Flags to tell what kind of breakpoint is at current line. */
	221	#define TUI_BP_ENABLED 0x01
	222	#define TUI_BP_DISABLED 0x02
	223	#define TUI_BP_HIT 0x04
	224	#define TUI_BP_CONDITIONAL 0x08
	225	#define TUI_BP_HARDWARE 0x10
	226
	227	/* Position of breakpoint markers in the exec info string. */
	228	#define TUI_BP_HIT_POS 0
	229	#define TUI_BP_BREAK_POS 1
	230	#define TUI_EXEC_POS 2
	231	#define TUI_EXECINFO_SIZE 4
	232
2a8854a7	233	typedef char tui_exec_info_content[TUI_EXECINFO_SIZE];
c906108c	234
1cc6d956	235	/* An content element in a window. */
2a8854a7 AC	236	union tui_which_element
2a8854a7 AC	237	{
1cc6d956	238	struct tui_source_element source; /* The source elements. */
dc2c33e4	239	struct tui_gen_win_info data_window; / Data display elements. */
1cc6d956 MS	240	struct tui_data_element data; /* Elements of data_window. */
	241	struct tui_command_element command; /* Command elements. */
	242	struct tui_locator_element locator; /* Locator elements. */
	243	tui_exec_info_content simple_string; /* Simple char based elements. */
2a8854a7 AC	244	};
	245
	246	struct tui_win_element
	247	{
6d012f14	248	union tui_which_element which_element;
2a8854a7	249	};
c906108c	250
1cc6d956	251	/* This defines information about each logical window. */
cb2ce893	252	struct tui_win_info : public tui_gen_win_info
2a8854a7	253	{
33b906ab	254	protected:
e7e11af4	255
33b906ab	256	explicit tui_win_info (enum tui_win_type type);
6792b55e TT	257	DISABLE_COPY_AND_ASSIGN (tui_win_info);
6792b55e TT	258
13446e05 TT	259	/* Scroll the contents vertically. This is only called via
	260	forward_scroll and backward_scroll. */
	261	virtual void do_scroll_vertical (enum tui_scroll_direction,
	262	int num_to_scroll) = 0;
	263
	264	/* Scroll the contents horizontally. This is only called via
	265	left_scroll and right_scroll. */
	266	virtual void do_scroll_horizontal (enum tui_scroll_direction,
	267	int num_to_scroll) = 0;
	268
33b906ab TT	269	public:
33b906ab TT	270
cb2ce893	271	~tui_win_info () override;
33b906ab	272
8761a91b TT	273	/* Clear the pertinent detail in the window. */
	274	virtual void clear_detail () = 0;
	275
44f0e208 TT	276	/* Return true if this window has the locator. */
	277	virtual bool has_locator () const
	278	{
	279	return false;
	280	}
	281
cda37efb	282	/* Make this window visible or invisible. */
56122977	283	virtual void make_visible (bool visible);
cda37efb	284
2042b506 TT	285	/* Refresh this window and any associated windows. */
	286	virtual void refresh ();
	287
1825f487 TT	288	/* Called after all the TUI windows are refreshed, to let this
	289	window have a chance to update itself further. */
	290	virtual void refresh_all ()
	291	{
	292	}
	293
3f02ce1e TT	294	/* Called after a TUI window is given a new height; this updates any
	295	related auxiliary windows. */
	296	virtual void set_new_height (int height)
	297	{
	298	}
	299
8903bd8a TT	300	/* Compute the maximum height of this window. */
	301	virtual int max_height () const;
	302
214a5cbe TT	303	/* Set whether this window is highglighted. */
	304	void set_highlight (bool highlight)
	305	{
	306	is_highlighted = highlight;
	307	}
	308
13446e05 TT	309	/* Methods to scroll the contents of this window. Note that they
	310	are named with "_scroll" coming at the end because the more
	311	obvious "scroll_forward" is defined as a macro in term.h. */
	312	void forward_scroll (int num_to_scroll);
	313	void backward_scroll (int num_to_scroll);
	314	void left_scroll (int num_to_scroll);
	315	void right_scroll (int num_to_scroll);
	316
33b906ab	317	/* Can this window ever be highlighted? */
214a5cbe	318	bool can_highlight = false;
33b906ab TT	319
33b906ab TT	320	/* Is this window highlighted? */
214a5cbe	321	bool is_highlighted = false;
33b906ab TT	322	};
33b906ab TT	323
5cf82909 TT	324	/* The base class for all source-like windows, namely the source and
	325	disassembly windows. */
	326
	327	struct tui_source_window_base : public tui_win_info
33b906ab	328	{
5cf82909 TT	329	protected:
	330	explicit tui_source_window_base (enum tui_win_type type);
	331	~tui_source_window_base () override;
	332	DISABLE_COPY_AND_ASSIGN (tui_source_window_base);
	333
13446e05 TT	334	void do_scroll_horizontal (enum tui_scroll_direction,
	335	int num_to_scroll) override;
	336
5cf82909	337	public:
8761a91b TT	338
8761a91b TT	339	void clear_detail () override;
44f0e208 TT	340
44f0e208 TT	341	/* Return true if this window has the locator. */
e6e41501 TT	342	bool has_locator () const override
	343	{
	344	return m_has_locator;
	345	}
	346
56122977	347	void make_visible (bool visible) override;
2042b506	348	void refresh () override;
1825f487	349	void refresh_all () override;
cda37efb	350
ad54d15b TT	351	/* Refill the source window's source cache and update it. If this
	352	is a disassembly window, then just update it. */
	353	void refill ();
	354
	355	/* Set the location of the execution point. */
	356	void set_is_exec_point_at (struct tui_line_or_address l);
	357
3f02ce1e TT	358	void set_new_height (int height) override;
3f02ce1e TT	359
e6e41501 TT	360	/* Does the locator belong to this window? */
	361	bool m_has_locator = false;
	362	/* Execution information window. */
	363	struct tui_gen_win_info *execution_info = nullptr;
	364	/* Used for horizontal scroll. */
	365	int horizontal_offset = 0;
	366	struct tui_line_or_address start_line_or_addr;
	367
	368	/* It is the resolved form as returned by symtab_to_fullname. */
	369	char *fullname = nullptr;
	370
	371	/* Architecture associated with code at this location. */
	372	struct gdbarch *gdbarch = nullptr;
33b906ab TT	373	};
33b906ab TT	374
5cf82909 TT	375	/* A TUI source window. */
	376
	377	struct tui_source_window : public tui_source_window_base
	378	{
	379	tui_source_window ()
	380	: tui_source_window_base (SRC_WIN)
	381	{
	382	}
	383
	384	DISABLE_COPY_AND_ASSIGN (tui_source_window);
13446e05 TT	385
	386	protected:
	387
	388	void do_scroll_vertical (enum tui_scroll_direction,
	389	int num_to_scroll) override;
5cf82909 TT	390	};
	391
	392	/* A TUI disassembly window. */
	393
	394	struct tui_disasm_window : public tui_source_window_base
	395	{
	396	tui_disasm_window ()
	397	: tui_source_window_base (DISASSEM_WIN)
	398	{
	399	}
	400
	401	DISABLE_COPY_AND_ASSIGN (tui_disasm_window);
13446e05 TT	402
	403	protected:
	404
	405	void do_scroll_vertical (enum tui_scroll_direction,
	406	int num_to_scroll) override;
5cf82909 TT	407	};
5cf82909 TT	408
33b906ab TT	409	struct tui_data_window : public tui_win_info
33b906ab TT	410	{
63901aec TT	411	tui_data_window ()
	412	: tui_win_info (DATA_WIN)
	413	{
	414	}
	415
ee1d42d6	416	~tui_data_window () override;
33b906ab	417	DISABLE_COPY_AND_ASSIGN (tui_data_window);
8761a91b TT	418
8761a91b TT	419	void clear_detail () override;
1825f487	420	void refresh_all () override;
13446e05	421
3f02ce1e TT	422	void set_new_height (int height) override;
3f02ce1e TT	423
5b81daba TT	424	void refresh_window () override;
5b81daba TT	425
63901aec TT	426	/* Start of data display content. */
	427	tui_win_content data_content = NULL;
	428	int data_content_count = 0;
	429	/* Start of regs display content. */
	430	tui_win_content regs_content = NULL;
	431	int regs_content_count = 0;
	432	int regs_column_count = 0;
	433	/* Should regs be displayed at all? */
	434	bool display_regs = false;
	435	struct reggroup *current_group = nullptr;
238eb706	436
13446e05 TT	437	protected:
	438
	439	void do_scroll_vertical (enum tui_scroll_direction,
	440	int num_to_scroll) override;
	441	void do_scroll_horizontal (enum tui_scroll_direction,
	442	int num_to_scroll) override
	443	{
	444	}
33b906ab TT	445	};
	446
	447	struct tui_cmd_window : public tui_win_info
	448	{
63901aec TT	449	tui_cmd_window ()
	450	: tui_win_info (CMD_WIN)
	451	{
	452	}
	453
33b906ab	454	DISABLE_COPY_AND_ASSIGN (tui_cmd_window);
8761a91b TT	455
8761a91b TT	456	void clear_detail () override;
13446e05	457
56122977	458	void make_visible (bool visible) override
cda37efb TT	459	{
	460	}
	461
8903bd8a TT	462	int max_height () const override;
8903bd8a TT	463
5b81daba TT	464	void refresh_window () override
	465	{
	466	}
	467
63901aec	468	int start_line = 0;
81491aa0	469
13446e05 TT	470	protected:
	471
	472	void do_scroll_vertical (enum tui_scroll_direction,
	473	int num_to_scroll) override
	474	{
	475	}
	476
	477	void do_scroll_horizontal (enum tui_scroll_direction,
	478	int num_to_scroll) override
	479	{
	480	}
2a8854a7	481	};
c906108c	482
6d012f14	483	extern int tui_win_is_auxillary (enum tui_win_type win_type);
c906108c SS	484
c906108c SS	485
1cc6d956	486	/* Global Data. */
7fa29be9	487	extern struct tui_win_info *tui_win_list[MAX_MAJOR_WINDOWS];
c906108c	488
e6e41501 TT	489	#define TUI_SRC_WIN ((tui_source_window_base *) tui_win_list[SRC_WIN])
e6e41501 TT	490	#define TUI_DISASM_WIN ((tui_source_window_base *) tui_win_list[DISASSEM_WIN])
238eb706	491	#define TUI_DATA_WIN ((tui_data_window *) tui_win_list[DATA_WIN])
81491aa0	492	#define TUI_CMD_WIN ((tui_cmd_window *) tui_win_list[CMD_WIN])
c906108c	493
1cc6d956	494	/* Data Manipulation Functions. */
dd1abb8c	495	extern void tui_initialize_static_data (void);
22940a24	496	extern struct tui_win_info *tui_alloc_win_info (enum tui_win_type);
dd1abb8c	497	extern void tui_init_generic_part (struct tui_gen_win_info *);
2a8854a7	498	extern tui_win_content tui_alloc_content (int, enum tui_win_type);
08ef48c5 MS	499	extern int tui_add_content_elements (struct tui_gen_win_info *,
08ef48c5 MS	500	int);
dd1abb8c	501	extern void tui_free_win_content (struct tui_gen_win_info *);
2a8854a7	502	extern void tui_free_data_content (tui_win_content, int);
dd1abb8c	503	extern void tui_free_all_source_wins_content (void);
a121b7c1	504	extern struct tui_win_info tui_partial_win_by_name (const char );
f41cbf58	505	extern const char tui_win_name (const struct tui_gen_win_info );
2a8854a7 AC	506	extern enum tui_layout_type tui_current_layout (void);
2a8854a7 AC	507	extern void tui_set_current_layout_to (enum tui_layout_type);
dd1abb8c AC	508	extern int tui_term_height (void);
	509	extern void tui_set_term_height_to (int);
	510	extern int tui_term_width (void);
	511	extern void tui_set_term_width_to (int);
dd1abb8c AC	512	extern struct tui_gen_win_info *tui_locator_win_info_ptr (void);
	513	extern struct tui_gen_win_info *tui_source_exec_info_win_ptr (void);
	514	extern struct tui_gen_win_info *tui_disassem_exec_info_win_ptr (void);
ad54d15b	515	extern std::vector<tui_source_window_base *> &tui_source_windows ();
dd1abb8c AC	516	extern void tui_clear_source_windows (void);
dd1abb8c AC	517	extern void tui_clear_source_windows_detail (void);
ad54d15b	518	extern void tui_add_to_source_windows (struct tui_source_window_base *);
dd1abb8c AC	519	extern struct tui_win_info *tui_win_with_focus (void);
dd1abb8c AC	520	extern void tui_set_win_with_focus (struct tui_win_info *);
5b6fe301	521	extern struct tui_layout_def *tui_layout_def (void);
dd1abb8c AC	522	extern int tui_win_resized (void);
	523	extern void tui_set_win_resized_to (int);
	524
	525	extern struct tui_win_info tui_next_win (struct tui_win_info );
	526	extern struct tui_win_info tui_prev_win (struct tui_win_info );
	527
7806cea7 TT	528	extern unsigned int tui_tab_width;
7806cea7 TT	529
1a5c2598	530	#endif /* TUI_TUI_DATA_H */