[deliverable/binutils-gdb.git] / gdb / tui / tui.h

/* External/Public TUI Header File.

   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_H
#define TUI_TUI_H

struct ui_file;

extern void strcat_to_buf (char *, int, const char *);

/* Types of error returns.  */
enum tui_status
{
  TUI_SUCCESS,
  TUI_FAILURE
};

/* Types of windows.  */
enum tui_win_type
{
  SRC_WIN = 0,
  DISASSEM_WIN,
  DATA_WIN,
  CMD_WIN,
  /* This must ALWAYS be AFTER the major windows last.  */
  MAX_MAJOR_WINDOWS,
  /* Auxiliary windows.  */
  LOCATOR_WIN,
  DATA_ITEM_WIN
};

/* GENERAL TUI FUNCTIONS */
/* tui.c */
extern CORE_ADDR tui_get_low_disassembly_address (struct gdbarch *,
						  CORE_ADDR, CORE_ADDR);
extern void tui_show_assembly (struct gdbarch *gdbarch, CORE_ADDR addr);
extern bool tui_is_window_visible (enum tui_win_type type);
extern int tui_get_command_dimension (unsigned int *width,
				      unsigned int *height);

/* Initialize readline and configure the keymap for the switching
   key shortcut.  */
extern void tui_initialize_readline (void);

/* Enter in the tui mode (curses).  */
extern void tui_enable (void);

/* Leave the tui mode.  */
extern void tui_disable (void);

enum tui_key_mode
{
  /* Plain command mode to enter gdb commands.  */
  TUI_COMMAND_MODE,

  /* SingleKey mode with some keys bound to gdb commands.  */
  TUI_SINGLE_KEY_MODE,

  /* Read/edit one command and return to SingleKey after it's
     processed.  */
  TUI_ONE_COMMAND_MODE
};

extern enum tui_key_mode tui_current_key_mode;

/* Change the TUI key mode by installing the appropriate readline
   keymap.  */
extern void tui_set_key_mode (enum tui_key_mode mode);

extern int tui_active;

extern void tui_show_source (const char *fullname, int line);

#endif /* TUI_TUI_H */
Commit	Line	Data
	1	/* External/Public TUI Header File.
	2
	3	Copyright (C) 1998-2019 Free Software Foundation, Inc.
	4
	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
	11	the Free Software Foundation; either version 3 of the License, or
	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
	20	along with this program. If not, see <http://www.gnu.org/licenses/>. */
	21
	22	#ifndef TUI_TUI_H
	23	#define TUI_TUI_H
	24
	25	struct ui_file;
	26
	27	extern void strcat_to_buf (char , int, const char );
	28
	29	/* Types of error returns. */
	30	enum tui_status
	31	{
	32	TUI_SUCCESS,
	33	TUI_FAILURE
	34	};
	35
	36	/* Types of windows. */
	37	enum tui_win_type
	38	{
	39	SRC_WIN = 0,
	40	DISASSEM_WIN,
	41	DATA_WIN,
	42	CMD_WIN,
	43	/* This must ALWAYS be AFTER the major windows last. */
	44	MAX_MAJOR_WINDOWS,
	45	/* Auxiliary windows. */
	46	LOCATOR_WIN,
	47	DATA_ITEM_WIN
	48	};
	49
	50	/* GENERAL TUI FUNCTIONS */
	51	/* tui.c */
	52	extern CORE_ADDR tui_get_low_disassembly_address (struct gdbarch *,
	53	CORE_ADDR, CORE_ADDR);
	54	extern void tui_show_assembly (struct gdbarch *gdbarch, CORE_ADDR addr);
	55	extern bool tui_is_window_visible (enum tui_win_type type);
	56	extern int tui_get_command_dimension (unsigned int *width,
	57	unsigned int *height);
	58
	59	/* Initialize readline and configure the keymap for the switching
	60	key shortcut. */
	61	extern void tui_initialize_readline (void);
	62
	63	/* Enter in the tui mode (curses). */
	64	extern void tui_enable (void);
	65
	66	/* Leave the tui mode. */
	67	extern void tui_disable (void);
	68
	69	enum tui_key_mode
	70	{
	71	/* Plain command mode to enter gdb commands. */
	72	TUI_COMMAND_MODE,
	73
	74	/* SingleKey mode with some keys bound to gdb commands. */
	75	TUI_SINGLE_KEY_MODE,
	76
	77	/* Read/edit one command and return to SingleKey after it's
	78	processed. */
	79	TUI_ONE_COMMAND_MODE
	80	};
	81
	82	extern enum tui_key_mode tui_current_key_mode;
	83
	84	/* Change the TUI key mode by installing the appropriate readline
	85	keymap. */
	86	extern void tui_set_key_mode (enum tui_key_mode mode);
	87
	88	extern int tui_active;
	89
	90	extern void tui_show_source (const char *fullname, int line);
	91
	92	#endif /* TUI_TUI_H */