[deliverable/binutils-gdb.git] / gdb / mi / mi-cmds.h

/* MI Command Set for GDB, the GNU debugger.

   Copyright (C) 2000, 2003, 2004, 2005, 2007, 2008
   Free Software Foundation, Inc.

   Contributed by Cygnus Solutions (a Red Hat 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 MI_CMDS_H
#define MI_CMDS_H

/* An MI command can return any of the following. */

enum mi_cmd_result
  {
    /* Report the command as ``done''.  Display both the ``NNN^done''
       message and the completion prompt.  */
    MI_CMD_DONE = 0,
    /* The command is still running in the forground.  Main loop should
       display the completion prompt. */
    MI_CMD_FORGROUND,
    /* An error condition was detected and an error message was
       asprintf'd into the mi_error_message buffer.  The main loop will
       display the error message and the completion prompt. */
    MI_CMD_ERROR,
    /* The MI command has already displayed its completion message.
       Main loop will not display a completion message but will display
       the completion prompt. */
    MI_CMD_QUIET
  };

enum print_values {
   PRINT_NO_VALUES,
   PRINT_ALL_VALUES,
   PRINT_SIMPLE_VALUES
};

extern const char mi_no_values[];
extern const char mi_simple_values[];
extern const char mi_all_values[];

typedef enum mi_cmd_result (mi_cmd_argv_ftype) (char *command, char **argv, int argc);

/* Older MI commands have this interface. Retained until all old
   commands are flushed. */

typedef enum mi_cmd_result (mi_cmd_args_ftype) ( /*ui */ char *args, int from_tty);

/* Function implementing each command */
extern mi_cmd_argv_ftype mi_cmd_break_insert;
extern mi_cmd_argv_ftype mi_cmd_break_watch;
extern mi_cmd_argv_ftype mi_cmd_disassemble;
extern mi_cmd_argv_ftype mi_cmd_data_evaluate_expression;
extern mi_cmd_argv_ftype mi_cmd_data_list_register_names;
extern mi_cmd_argv_ftype mi_cmd_data_list_register_values;
extern mi_cmd_argv_ftype mi_cmd_data_list_changed_registers;
extern mi_cmd_argv_ftype mi_cmd_data_read_memory;
extern mi_cmd_argv_ftype mi_cmd_data_write_memory;
extern mi_cmd_argv_ftype mi_cmd_data_write_register_values;
extern mi_cmd_argv_ftype mi_cmd_enable_timings;
extern mi_cmd_argv_ftype mi_cmd_env_cd;
extern mi_cmd_argv_ftype mi_cmd_env_dir;
extern mi_cmd_argv_ftype mi_cmd_env_path;
extern mi_cmd_argv_ftype mi_cmd_env_pwd;
extern mi_cmd_args_ftype mi_cmd_exec_continue;
extern mi_cmd_args_ftype mi_cmd_exec_finish;
extern mi_cmd_args_ftype mi_cmd_exec_next;
extern mi_cmd_args_ftype mi_cmd_exec_next_instruction;
extern mi_cmd_args_ftype mi_cmd_exec_return;
extern mi_cmd_args_ftype mi_cmd_exec_run;
extern mi_cmd_args_ftype mi_cmd_exec_step;
extern mi_cmd_args_ftype mi_cmd_exec_step_instruction;
extern mi_cmd_args_ftype mi_cmd_exec_until;
extern mi_cmd_args_ftype mi_cmd_exec_interrupt;
extern mi_cmd_argv_ftype mi_cmd_file_list_exec_source_file;
extern mi_cmd_argv_ftype mi_cmd_file_list_exec_source_files;
extern mi_cmd_argv_ftype mi_cmd_gdb_exit;
extern mi_cmd_argv_ftype mi_cmd_inferior_tty_set;
extern mi_cmd_argv_ftype mi_cmd_inferior_tty_show;
extern mi_cmd_argv_ftype mi_cmd_interpreter_exec;
extern mi_cmd_argv_ftype mi_cmd_list_features;
extern mi_cmd_argv_ftype mi_cmd_stack_info_depth;
extern mi_cmd_argv_ftype mi_cmd_stack_info_frame;
extern mi_cmd_argv_ftype mi_cmd_stack_list_args;
extern mi_cmd_argv_ftype mi_cmd_stack_list_frames;
extern mi_cmd_argv_ftype mi_cmd_stack_list_locals;
extern mi_cmd_argv_ftype mi_cmd_stack_select_frame;
extern mi_cmd_argv_ftype mi_cmd_symbol_list_lines;
extern mi_cmd_args_ftype mi_cmd_target_download;
extern mi_cmd_argv_ftype mi_cmd_target_file_get;
extern mi_cmd_argv_ftype mi_cmd_target_file_put;
extern mi_cmd_argv_ftype mi_cmd_target_file_delete;
extern mi_cmd_args_ftype mi_cmd_target_select;
extern mi_cmd_argv_ftype mi_cmd_thread_list_ids;
extern mi_cmd_argv_ftype mi_cmd_thread_select;
extern mi_cmd_argv_ftype mi_cmd_var_assign;
extern mi_cmd_argv_ftype mi_cmd_var_create;
extern mi_cmd_argv_ftype mi_cmd_var_delete;
extern mi_cmd_argv_ftype mi_cmd_var_evaluate_expression;
extern mi_cmd_argv_ftype mi_cmd_var_info_expression;
extern mi_cmd_argv_ftype mi_cmd_var_info_path_expression;
extern mi_cmd_argv_ftype mi_cmd_var_info_num_children;
extern mi_cmd_argv_ftype mi_cmd_var_info_type;
extern mi_cmd_argv_ftype mi_cmd_var_list_children;
extern mi_cmd_argv_ftype mi_cmd_var_set_format;
extern mi_cmd_argv_ftype mi_cmd_var_set_frozen;
extern mi_cmd_argv_ftype mi_cmd_var_show_attributes;
extern mi_cmd_argv_ftype mi_cmd_var_show_format;
extern mi_cmd_argv_ftype mi_cmd_var_update;

/* Description of a single command. */

struct mi_cli
{
  /* Corresponding CLI command.  If ARGS_P is non-zero, the MI
     command's argument list is appended to the CLI command.  */
  const char *cmd;
  int args_p;
};

struct mi_cmd
{
  /* official name of the command.  */
  const char *name;
  /* The corresponding CLI command that can be used to implement this
     MI command (if cli.lhs is non NULL).  */
  struct mi_cli cli;
  /* If non-null, the function implementing the MI command.  */
  mi_cmd_args_ftype *args_func;
  /* If non-null, the function implementing the MI command.  */
  mi_cmd_argv_ftype *argv_func;
};

/* Lookup a command in the mi comand table */

extern struct mi_cmd *mi_lookup (const char *command);

/* Debug flag */
extern int mi_debug_p;

/* Raw console output - FIXME: should this be a parameter? */
extern struct ui_file *raw_stdout;

extern char *mi_error_message;
extern void mi_execute_command (char *cmd, int from_tty);

#endif
Commit	Line	Data
4389a95a AC	1	/* MI Command Set for GDB, the GNU debugger.
4389a95a AC	2
9b254dd1 DJ	3	Copyright (C) 2000, 2003, 2004, 2005, 2007, 2008
9b254dd1 DJ	4	Free Software Foundation, Inc.
4389a95a	5
ab91fdd5	6	Contributed by Cygnus Solutions (a Red Hat company).
fb40c209 AC	7
	8	This file is part of GDB.
	9
	10	This program is free software; you can redistribute it and/or modify
	11	it under the terms of the GNU General Public License as published by
a9762ec7	12	the Free Software Foundation; either version 3 of the License, or
fb40c209 AC	13	(at your option) any later version.
	14
	15	This program is distributed in the hope that it will be useful,
	16	but WITHOUT ANY WARRANTY; without even the implied warranty of
	17	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	18	GNU General Public License for more details.
	19
	20	You should have received a copy of the GNU General Public License
a9762ec7	21	along with this program. If not, see <http://www.gnu.org/licenses/>. */
fb40c209 AC	22
	23	#ifndef MI_CMDS_H
	24	#define MI_CMDS_H
	25
	26	/* An MI command can return any of the following. */
	27
	28	enum mi_cmd_result
	29	{
	30	/* Report the command as ``done''. Display both the ``NNN^done''
	31	message and the completion prompt. */
	32	MI_CMD_DONE = 0,
	33	/* The command is still running in the forground. Main loop should
	34	display the completion prompt. */
	35	MI_CMD_FORGROUND,
	36	/* An error condition was detected and an error message was
	37	asprintf'd into the mi_error_message buffer. The main loop will
	38	display the error message and the completion prompt. */
	39	MI_CMD_ERROR,
fb40c209 AC	40	/* The MI command has already displayed its completion message.
	41	Main loop will not display a completion message but will display
	42	the completion prompt. */
	43	MI_CMD_QUIET
	44	};
	45
90e645cd NR	46	enum print_values {
	47	PRINT_NO_VALUES,
	48	PRINT_ALL_VALUES,
	49	PRINT_SIMPLE_VALUES
	50	};
	51
1ecb4ee0 DJ	52	extern const char mi_no_values[];
	53	extern const char mi_simple_values[];
	54	extern const char mi_all_values[];
	55
fb40c209 AC	56	typedef enum mi_cmd_result (mi_cmd_argv_ftype) (char command, char *argv, int argc);
	57
	58	/* Older MI commands have this interface. Retained until all old
	59	commands are flushed. */
	60
	61	typedef enum mi_cmd_result (mi_cmd_args_ftype) ( /ui / char *args, int from_tty);
	62
	63	/* Function implementing each command */
	64	extern mi_cmd_argv_ftype mi_cmd_break_insert;
	65	extern mi_cmd_argv_ftype mi_cmd_break_watch;
	66	extern mi_cmd_argv_ftype mi_cmd_disassemble;
	67	extern mi_cmd_argv_ftype mi_cmd_data_evaluate_expression;
	68	extern mi_cmd_argv_ftype mi_cmd_data_list_register_names;
	69	extern mi_cmd_argv_ftype mi_cmd_data_list_register_values;
	70	extern mi_cmd_argv_ftype mi_cmd_data_list_changed_registers;
	71	extern mi_cmd_argv_ftype mi_cmd_data_read_memory;
	72	extern mi_cmd_argv_ftype mi_cmd_data_write_memory;
24e8cecf	73	extern mi_cmd_argv_ftype mi_cmd_data_write_register_values;
d8c83789	74	extern mi_cmd_argv_ftype mi_cmd_enable_timings;
068890be JJ	75	extern mi_cmd_argv_ftype mi_cmd_env_cd;
	76	extern mi_cmd_argv_ftype mi_cmd_env_dir;
	77	extern mi_cmd_argv_ftype mi_cmd_env_path;
	78	extern mi_cmd_argv_ftype mi_cmd_env_pwd;
fb40c209 AC	79	extern mi_cmd_args_ftype mi_cmd_exec_continue;
	80	extern mi_cmd_args_ftype mi_cmd_exec_finish;
	81	extern mi_cmd_args_ftype mi_cmd_exec_next;
	82	extern mi_cmd_args_ftype mi_cmd_exec_next_instruction;
	83	extern mi_cmd_args_ftype mi_cmd_exec_return;
	84	extern mi_cmd_args_ftype mi_cmd_exec_run;
	85	extern mi_cmd_args_ftype mi_cmd_exec_step;
	86	extern mi_cmd_args_ftype mi_cmd_exec_step_instruction;
	87	extern mi_cmd_args_ftype mi_cmd_exec_until;
	88	extern mi_cmd_args_ftype mi_cmd_exec_interrupt;
1abaf70c	89	extern mi_cmd_argv_ftype mi_cmd_file_list_exec_source_file;
57c22c6c	90	extern mi_cmd_argv_ftype mi_cmd_file_list_exec_source_files;
fb40c209	91	extern mi_cmd_argv_ftype mi_cmd_gdb_exit;
3cb3b8df BR	92	extern mi_cmd_argv_ftype mi_cmd_inferior_tty_set;
3cb3b8df BR	93	extern mi_cmd_argv_ftype mi_cmd_inferior_tty_show;
4389a95a	94	extern mi_cmd_argv_ftype mi_cmd_interpreter_exec;
084344da	95	extern mi_cmd_argv_ftype mi_cmd_list_features;
fb40c209	96	extern mi_cmd_argv_ftype mi_cmd_stack_info_depth;
3ba51a77	97	extern mi_cmd_argv_ftype mi_cmd_stack_info_frame;
fb40c209 AC	98	extern mi_cmd_argv_ftype mi_cmd_stack_list_args;
	99	extern mi_cmd_argv_ftype mi_cmd_stack_list_frames;
	100	extern mi_cmd_argv_ftype mi_cmd_stack_list_locals;
	101	extern mi_cmd_argv_ftype mi_cmd_stack_select_frame;
0d18235f	102	extern mi_cmd_argv_ftype mi_cmd_symbol_list_lines;
fb40c209	103	extern mi_cmd_args_ftype mi_cmd_target_download;
a6b151f1 DJ	104	extern mi_cmd_argv_ftype mi_cmd_target_file_get;
	105	extern mi_cmd_argv_ftype mi_cmd_target_file_put;
	106	extern mi_cmd_argv_ftype mi_cmd_target_file_delete;
fb40c209 AC	107	extern mi_cmd_args_ftype mi_cmd_target_select;
	108	extern mi_cmd_argv_ftype mi_cmd_thread_list_ids;
	109	extern mi_cmd_argv_ftype mi_cmd_thread_select;
	110	extern mi_cmd_argv_ftype mi_cmd_var_assign;
	111	extern mi_cmd_argv_ftype mi_cmd_var_create;
	112	extern mi_cmd_argv_ftype mi_cmd_var_delete;
	113	extern mi_cmd_argv_ftype mi_cmd_var_evaluate_expression;
	114	extern mi_cmd_argv_ftype mi_cmd_var_info_expression;
02142340	115	extern mi_cmd_argv_ftype mi_cmd_var_info_path_expression;
fb40c209 AC	116	extern mi_cmd_argv_ftype mi_cmd_var_info_num_children;
	117	extern mi_cmd_argv_ftype mi_cmd_var_info_type;
	118	extern mi_cmd_argv_ftype mi_cmd_var_list_children;
	119	extern mi_cmd_argv_ftype mi_cmd_var_set_format;
25d5ea92	120	extern mi_cmd_argv_ftype mi_cmd_var_set_frozen;
fb40c209 AC	121	extern mi_cmd_argv_ftype mi_cmd_var_show_attributes;
	122	extern mi_cmd_argv_ftype mi_cmd_var_show_format;
	123	extern mi_cmd_argv_ftype mi_cmd_var_update;
	124
	125	/* Description of a single command. */
	126
b2af646b AC	127	struct mi_cli
	128	{
	129	/* Corresponding CLI command. If ARGS_P is non-zero, the MI
	130	command's argument list is appended to the CLI command. */
	131	const char *cmd;
	132	int args_p;
	133	};
	134
fb40c209	135	struct mi_cmd
b2af646b AC	136	{
	137	/* official name of the command. */
	138	const char *name;
	139	/* The corresponding CLI command that can be used to implement this
	140	MI command (if cli.lhs is non NULL). */
	141	struct mi_cli cli;
	142	/* If non-null, the function implementing the MI command. */
	143	mi_cmd_args_ftype *args_func;
	144	/* If non-null, the function implementing the MI command. */
	145	mi_cmd_argv_ftype *argv_func;
	146	};
fb40c209 AC	147
	148	/* Lookup a command in the mi comand table */
	149
	150	extern struct mi_cmd mi_lookup (const char command);
	151
	152	/* Debug flag */
	153	extern int mi_debug_p;
	154
	155	/* Raw console output - FIXME: should this be a parameter? */
	156	extern struct ui_file *raw_stdout;
	157
4389a95a	158	extern char *mi_error_message;
4389a95a AC	159	extern void mi_execute_command (char *cmd, int from_tty);
4389a95a AC	160
fb40c209	161	#endif