/* Header file for GDB command decoding library.
|
/* Header file for GDB command decoding library.
|
|
|
Copyright (c) 2000, 2003, 2007, 2008 Free Software Foundation, Inc.
|
Copyright (c) 2000, 2003, 2007, 2008 Free Software Foundation, Inc.
|
|
|
This program is free software; you can redistribute it and/or modify
|
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
|
it under the terms of the GNU General Public License as published by
|
the Free Software Foundation; either version 3 of the License, or
|
the Free Software Foundation; either version 3 of the License, or
|
(at your option) any later version.
|
(at your option) any later version.
|
|
|
This program is distributed in the hope that it will be useful,
|
This program is distributed in the hope that it will be useful,
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
GNU General Public License for more details.
|
GNU General Public License for more details.
|
|
|
You should have received a copy of the GNU General Public License
|
You should have received a copy of the GNU General Public License
|
along with this program. If not, see <http://www.gnu.org/licenses/>. */
|
along with this program. If not, see <http://www.gnu.org/licenses/>. */
|
|
|
#if !defined (CLI_DECODE_H)
|
#if !defined (CLI_DECODE_H)
|
#define CLI_DECODE_H 1
|
#define CLI_DECODE_H 1
|
|
|
#include "command.h"
|
#include "command.h"
|
|
|
struct re_pattern_buffer;
|
struct re_pattern_buffer;
|
|
|
#if 0
|
#if 0
|
/* FIXME: cagney/2002-03-17: Once cmd_type() has been removed, ``enum
|
/* FIXME: cagney/2002-03-17: Once cmd_type() has been removed, ``enum
|
cmd_types'' can be moved from "command.h" to "cli-decode.h". */
|
cmd_types'' can be moved from "command.h" to "cli-decode.h". */
|
/* Not a set/show command. Note that some commands which begin with
|
/* Not a set/show command. Note that some commands which begin with
|
"set" or "show" might be in this category, if their syntax does
|
"set" or "show" might be in this category, if their syntax does
|
not fall into one of the following categories. */
|
not fall into one of the following categories. */
|
typedef enum cmd_types
|
typedef enum cmd_types
|
{
|
{
|
not_set_cmd,
|
not_set_cmd,
|
set_cmd,
|
set_cmd,
|
show_cmd
|
show_cmd
|
}
|
}
|
cmd_types;
|
cmd_types;
|
#endif
|
#endif
|
|
|
/* This structure records one command'd definition. */
|
/* This structure records one command'd definition. */
|
|
|
|
|
/* This flag is used by the code executing commands to warn the user
|
/* This flag is used by the code executing commands to warn the user
|
the first time a deprecated command is used, see the 'flags' field in
|
the first time a deprecated command is used, see the 'flags' field in
|
the following struct.
|
the following struct.
|
*/
|
*/
|
#define CMD_DEPRECATED 0x1
|
#define CMD_DEPRECATED 0x1
|
#define DEPRECATED_WARN_USER 0x2
|
#define DEPRECATED_WARN_USER 0x2
|
#define MALLOCED_REPLACEMENT 0x4
|
#define MALLOCED_REPLACEMENT 0x4
|
|
|
struct cmd_list_element
|
struct cmd_list_element
|
{
|
{
|
/* Points to next command in this list. */
|
/* Points to next command in this list. */
|
struct cmd_list_element *next;
|
struct cmd_list_element *next;
|
|
|
/* Name of this command. */
|
/* Name of this command. */
|
char *name;
|
char *name;
|
|
|
/* Command class; class values are chosen by application program. */
|
/* Command class; class values are chosen by application program. */
|
enum command_class class;
|
enum command_class class;
|
|
|
/* Function definition of this command. NULL for command class
|
/* Function definition of this command. NULL for command class
|
names and for help topics that are not really commands. NOTE:
|
names and for help topics that are not really commands. NOTE:
|
cagney/2002-02-02: This function signature is evolving. For
|
cagney/2002-02-02: This function signature is evolving. For
|
the moment suggest sticking with either set_cmd_cfunc() or
|
the moment suggest sticking with either set_cmd_cfunc() or
|
set_cmd_sfunc(). */
|
set_cmd_sfunc(). */
|
void (*func) (struct cmd_list_element *c, char *args, int from_tty);
|
void (*func) (struct cmd_list_element *c, char *args, int from_tty);
|
/* The command's real callback. At present func() bounces through
|
/* The command's real callback. At present func() bounces through
|
to one of the below. */
|
to one of the below. */
|
union
|
union
|
{
|
{
|
/* If type is not_set_cmd, call it like this: */
|
/* If type is not_set_cmd, call it like this: */
|
cmd_cfunc_ftype *cfunc;
|
cmd_cfunc_ftype *cfunc;
|
/* If type is set_cmd or show_cmd, first set the variables,
|
/* If type is set_cmd or show_cmd, first set the variables,
|
and then call this: */
|
and then call this: */
|
cmd_sfunc_ftype *sfunc;
|
cmd_sfunc_ftype *sfunc;
|
}
|
}
|
function;
|
function;
|
|
|
/* Local state (context) for this command. This can be anything. */
|
/* Local state (context) for this command. This can be anything. */
|
void *context;
|
void *context;
|
|
|
/* Documentation of this command (or help topic).
|
/* Documentation of this command (or help topic).
|
First line is brief documentation; remaining lines form, with it,
|
First line is brief documentation; remaining lines form, with it,
|
the full documentation. First line should end with a period.
|
the full documentation. First line should end with a period.
|
Entire string should also end with a period, not a newline. */
|
Entire string should also end with a period, not a newline. */
|
char *doc;
|
char *doc;
|
|
|
/* For set/show commands. A method for printing the output to the
|
/* For set/show commands. A method for printing the output to the
|
specified stream. */
|
specified stream. */
|
show_value_ftype *show_value_func;
|
show_value_ftype *show_value_func;
|
|
|
/* flags : a bitfield
|
/* flags : a bitfield
|
|
|
bit 0: (LSB) CMD_DEPRECATED, when 1 indicated that this command
|
bit 0: (LSB) CMD_DEPRECATED, when 1 indicated that this command
|
is deprecated. It may be removed from gdb's command set in the
|
is deprecated. It may be removed from gdb's command set in the
|
future.
|
future.
|
|
|
bit 1: DEPRECATED_WARN_USER, the user needs to be warned that
|
bit 1: DEPRECATED_WARN_USER, the user needs to be warned that
|
this is a deprecated command. The user should only be warned
|
this is a deprecated command. The user should only be warned
|
the first time a command is used.
|
the first time a command is used.
|
|
|
bit 2: MALLOCED_REPLACEMENT, when functions are deprecated at
|
bit 2: MALLOCED_REPLACEMENT, when functions are deprecated at
|
compile time (this is the way it should, in general, be done)
|
compile time (this is the way it should, in general, be done)
|
the memory containing the replacement string is statically
|
the memory containing the replacement string is statically
|
allocated. In some cases it makes sense to deprecate commands
|
allocated. In some cases it makes sense to deprecate commands
|
at runtime (the testsuite is one example). In this case the
|
at runtime (the testsuite is one example). In this case the
|
memory for replacement is malloc'ed. When a command is
|
memory for replacement is malloc'ed. When a command is
|
undeprecated or re-deprecated at runtime we don't want to risk
|
undeprecated or re-deprecated at runtime we don't want to risk
|
calling free on statically allocated memory, so we check this
|
calling free on statically allocated memory, so we check this
|
flag.
|
flag.
|
*/
|
*/
|
int flags;
|
int flags;
|
|
|
/* If this command is deprecated, this is the replacement name. */
|
/* If this command is deprecated, this is the replacement name. */
|
char *replacement;
|
char *replacement;
|
|
|
/* If this command represents a show command, then this function
|
/* If this command represents a show command, then this function
|
is called before the variable's value is examined. */
|
is called before the variable's value is examined. */
|
void (*pre_show_hook) (struct cmd_list_element *c);
|
void (*pre_show_hook) (struct cmd_list_element *c);
|
|
|
/* Hook for another command to be executed before this command. */
|
/* Hook for another command to be executed before this command. */
|
struct cmd_list_element *hook_pre;
|
struct cmd_list_element *hook_pre;
|
|
|
/* Hook for another command to be executed after this command. */
|
/* Hook for another command to be executed after this command. */
|
struct cmd_list_element *hook_post;
|
struct cmd_list_element *hook_post;
|
|
|
/* Flag that specifies if this command is already running it's hook. */
|
/* Flag that specifies if this command is already running it's hook. */
|
/* Prevents the possibility of hook recursion. */
|
/* Prevents the possibility of hook recursion. */
|
int hook_in;
|
int hook_in;
|
|
|
/* Nonzero identifies a prefix command. For them, the address
|
/* Nonzero identifies a prefix command. For them, the address
|
of the variable containing the list of subcommands. */
|
of the variable containing the list of subcommands. */
|
struct cmd_list_element **prefixlist;
|
struct cmd_list_element **prefixlist;
|
|
|
/* For prefix commands only:
|
/* For prefix commands only:
|
String containing prefix commands to get here: this one
|
String containing prefix commands to get here: this one
|
plus any others needed to get to it. Should end in a space.
|
plus any others needed to get to it. Should end in a space.
|
It is used before the word "command" in describing the
|
It is used before the word "command" in describing the
|
commands reached through this prefix. */
|
commands reached through this prefix. */
|
char *prefixname;
|
char *prefixname;
|
|
|
/* For prefix commands only:
|
/* For prefix commands only:
|
nonzero means do not get an error if subcommand is not
|
nonzero means do not get an error if subcommand is not
|
recognized; call the prefix's own function in that case. */
|
recognized; call the prefix's own function in that case. */
|
char allow_unknown;
|
char allow_unknown;
|
|
|
/* Nonzero says this is an abbreviation, and should not
|
/* Nonzero says this is an abbreviation, and should not
|
be mentioned in lists of commands.
|
be mentioned in lists of commands.
|
This allows "br<tab>" to complete to "break", which it
|
This allows "br<tab>" to complete to "break", which it
|
otherwise wouldn't. */
|
otherwise wouldn't. */
|
char abbrev_flag;
|
char abbrev_flag;
|
|
|
/* Completion routine for this command. TEXT is the text beyond
|
/* Completion routine for this command. TEXT is the text beyond
|
what was matched for the command itself (leading whitespace is
|
what was matched for the command itself (leading whitespace is
|
skipped). It stops where we are supposed to stop completing
|
skipped). It stops where we are supposed to stop completing
|
(rl_point) and is '\0' terminated.
|
(rl_point) and is '\0' terminated.
|
|
|
Return value is a malloc'd vector of pointers to possible completions
|
Return value is a malloc'd vector of pointers to possible completions
|
terminated with NULL. If there are no completions, returning a pointer
|
terminated with NULL. If there are no completions, returning a pointer
|
to a NULL would work but returning NULL itself is also valid.
|
to a NULL would work but returning NULL itself is also valid.
|
WORD points in the same buffer as TEXT, and completions should be
|
WORD points in the same buffer as TEXT, and completions should be
|
returned relative to this position. For example, suppose TEXT is "foo"
|
returned relative to this position. For example, suppose TEXT is "foo"
|
and we want to complete to "foobar". If WORD is "oo", return
|
and we want to complete to "foobar". If WORD is "oo", return
|
"oobar"; if WORD is "baz/foo", return "baz/foobar". */
|
"oobar"; if WORD is "baz/foo", return "baz/foobar". */
|
char **(*completer) (char *text, char *word);
|
char **(*completer) (char *text, char *word);
|
|
|
/* Type of "set" or "show" command (or SET_NOT_SET if not "set"
|
/* Type of "set" or "show" command (or SET_NOT_SET if not "set"
|
or "show"). */
|
or "show"). */
|
cmd_types type;
|
cmd_types type;
|
|
|
/* Pointer to variable affected by "set" and "show". Doesn't matter
|
/* Pointer to variable affected by "set" and "show". Doesn't matter
|
if type is not_set. */
|
if type is not_set. */
|
void *var;
|
void *var;
|
|
|
/* What kind of variable is *VAR? */
|
/* What kind of variable is *VAR? */
|
var_types var_type;
|
var_types var_type;
|
|
|
/* Pointer to NULL terminated list of enumerated values (like argv). */
|
/* Pointer to NULL terminated list of enumerated values (like argv). */
|
const char **enums;
|
const char **enums;
|
|
|
/* Pointer to command strings of user-defined commands */
|
/* Pointer to command strings of user-defined commands */
|
struct command_line *user_commands;
|
struct command_line *user_commands;
|
|
|
/* Pointer to command that is hooked by this one, (by hook_pre)
|
/* Pointer to command that is hooked by this one, (by hook_pre)
|
so the hook can be removed when this one is deleted. */
|
so the hook can be removed when this one is deleted. */
|
struct cmd_list_element *hookee_pre;
|
struct cmd_list_element *hookee_pre;
|
|
|
/* Pointer to command that is hooked by this one, (by hook_post)
|
/* Pointer to command that is hooked by this one, (by hook_post)
|
so the hook can be removed when this one is deleted. */
|
so the hook can be removed when this one is deleted. */
|
struct cmd_list_element *hookee_post;
|
struct cmd_list_element *hookee_post;
|
|
|
/* Pointer to command that is aliased by this one, so the
|
/* Pointer to command that is aliased by this one, so the
|
aliased command can be located in case it has been hooked. */
|
aliased command can be located in case it has been hooked. */
|
struct cmd_list_element *cmd_pointer;
|
struct cmd_list_element *cmd_pointer;
|
};
|
};
|
|
|
/* API to the manipulation of command lists. */
|
/* API to the manipulation of command lists. */
|
|
|
extern struct cmd_list_element *add_cmd (char *, enum command_class,
|
extern struct cmd_list_element *add_cmd (char *, enum command_class,
|
void (*fun) (char *, int), char *,
|
void (*fun) (char *, int), char *,
|
struct cmd_list_element **);
|
struct cmd_list_element **);
|
|
|
extern struct cmd_list_element *add_alias_cmd (char *, char *,
|
extern struct cmd_list_element *add_alias_cmd (char *, char *,
|
enum command_class, int,
|
enum command_class, int,
|
struct cmd_list_element **);
|
struct cmd_list_element **);
|
|
|
extern struct cmd_list_element *add_prefix_cmd (char *, enum command_class,
|
extern struct cmd_list_element *add_prefix_cmd (char *, enum command_class,
|
void (*fun) (char *, int),
|
void (*fun) (char *, int),
|
char *,
|
char *,
|
struct cmd_list_element **,
|
struct cmd_list_element **,
|
char *, int,
|
char *, int,
|
struct cmd_list_element **);
|
struct cmd_list_element **);
|
|
|
extern struct cmd_list_element *add_abbrev_prefix_cmd (char *,
|
extern struct cmd_list_element *add_abbrev_prefix_cmd (char *,
|
enum command_class,
|
enum command_class,
|
void (*fun) (char *,
|
void (*fun) (char *,
|
int),
|
int),
|
char *,
|
char *,
|
struct cmd_list_element
|
struct cmd_list_element
|
**, char *, int,
|
**, char *, int,
|
struct cmd_list_element
|
struct cmd_list_element
|
**);
|
**);
|
|
|
/* Set the commands corresponding callback. */
|
/* Set the commands corresponding callback. */
|
|
|
extern void set_cmd_cfunc (struct cmd_list_element *cmd,
|
extern void set_cmd_cfunc (struct cmd_list_element *cmd,
|
void (*cfunc) (char *args, int from_tty));
|
void (*cfunc) (char *args, int from_tty));
|
|
|
extern void set_cmd_sfunc (struct cmd_list_element *cmd,
|
extern void set_cmd_sfunc (struct cmd_list_element *cmd,
|
void (*sfunc) (char *args, int from_tty,
|
void (*sfunc) (char *args, int from_tty,
|
struct cmd_list_element * c));
|
struct cmd_list_element * c));
|
|
|
extern void set_cmd_completer (struct cmd_list_element *cmd,
|
extern void set_cmd_completer (struct cmd_list_element *cmd,
|
char **(*completer) (char *text, char *word));
|
char **(*completer) (char *text, char *word));
|
|
|
/* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs
|
/* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs
|
around in cmd objects to test the value of the commands sfunc(). */
|
around in cmd objects to test the value of the commands sfunc(). */
|
extern int cmd_cfunc_eq (struct cmd_list_element *cmd,
|
extern int cmd_cfunc_eq (struct cmd_list_element *cmd,
|
void (*cfunc) (char *args, int from_tty));
|
void (*cfunc) (char *args, int from_tty));
|
|
|
/* Access to the command's local context. */
|
/* Access to the command's local context. */
|
extern void set_cmd_context (struct cmd_list_element *cmd, void *context);
|
extern void set_cmd_context (struct cmd_list_element *cmd, void *context);
|
extern void *get_cmd_context (struct cmd_list_element *cmd);
|
extern void *get_cmd_context (struct cmd_list_element *cmd);
|
|
|
extern struct cmd_list_element *lookup_cmd (char **,
|
extern struct cmd_list_element *lookup_cmd (char **,
|
struct cmd_list_element *, char *,
|
struct cmd_list_element *, char *,
|
int, int);
|
int, int);
|
|
|
extern struct cmd_list_element *lookup_cmd_1 (char **,
|
extern struct cmd_list_element *lookup_cmd_1 (char **,
|
struct cmd_list_element *,
|
struct cmd_list_element *,
|
struct cmd_list_element **,
|
struct cmd_list_element **,
|
int);
|
int);
|
|
|
extern struct cmd_list_element *
|
extern struct cmd_list_element *
|
deprecate_cmd (struct cmd_list_element *, char * );
|
deprecate_cmd (struct cmd_list_element *, char * );
|
|
|
extern void
|
extern void
|
deprecated_cmd_warning (char **);
|
deprecated_cmd_warning (char **);
|
|
|
extern int
|
extern int
|
lookup_cmd_composition (char *text,
|
lookup_cmd_composition (char *text,
|
struct cmd_list_element **alias,
|
struct cmd_list_element **alias,
|
struct cmd_list_element **prefix_cmd,
|
struct cmd_list_element **prefix_cmd,
|
struct cmd_list_element **cmd);
|
struct cmd_list_element **cmd);
|
|
|
extern struct cmd_list_element *add_com (char *, enum command_class,
|
extern struct cmd_list_element *add_com (char *, enum command_class,
|
void (*fun) (char *, int), char *);
|
void (*fun) (char *, int), char *);
|
|
|
extern struct cmd_list_element *add_com_alias (char *, char *,
|
extern struct cmd_list_element *add_com_alias (char *, char *,
|
enum command_class, int);
|
enum command_class, int);
|
|
|
extern struct cmd_list_element *add_info (char *, void (*fun) (char *, int),
|
extern struct cmd_list_element *add_info (char *, void (*fun) (char *, int),
|
char *);
|
char *);
|
|
|
extern struct cmd_list_element *add_info_alias (char *, char *, int);
|
extern struct cmd_list_element *add_info_alias (char *, char *, int);
|
|
|
extern char **complete_on_cmdlist (struct cmd_list_element *, char *, char *);
|
extern char **complete_on_cmdlist (struct cmd_list_element *, char *, char *);
|
|
|
extern char **complete_on_enum (const char *enumlist[], char *, char *);
|
extern char **complete_on_enum (const char *enumlist[], char *, char *);
|
|
|
extern void delete_cmd (char *, struct cmd_list_element **);
|
extern void delete_cmd (char *, struct cmd_list_element **);
|
|
|
extern void help_cmd_list (struct cmd_list_element *, enum command_class,
|
extern void help_cmd_list (struct cmd_list_element *, enum command_class,
|
char *, int, struct ui_file *);
|
char *, int, struct ui_file *);
|
|
|
/* Functions that implement commands about CLI commands. */
|
/* Functions that implement commands about CLI commands. */
|
|
|
extern void help_cmd (char *, struct ui_file *);
|
extern void help_cmd (char *, struct ui_file *);
|
|
|
extern void help_list (struct cmd_list_element *, char *,
|
extern void help_list (struct cmd_list_element *, char *,
|
enum command_class, struct ui_file *);
|
enum command_class, struct ui_file *);
|
|
|
extern void apropos_cmd (struct ui_file *, struct cmd_list_element *,
|
extern void apropos_cmd (struct ui_file *, struct cmd_list_element *,
|
struct re_pattern_buffer *, char *);
|
struct re_pattern_buffer *, char *);
|
|
|
/* Used to mark commands that don't do anything. If we just leave the
|
/* Used to mark commands that don't do anything. If we just leave the
|
function field NULL, the command is interpreted as a help topic, or
|
function field NULL, the command is interpreted as a help topic, or
|
as a class of commands. */
|
as a class of commands. */
|
|
|
extern void not_just_help_class_command (char *arg, int from_tty);
|
extern void not_just_help_class_command (char *arg, int from_tty);
|
|
|
/* Exported to cli/cli-setshow.c */
|
/* Exported to cli/cli-setshow.c */
|
|
|
extern void print_doc_line (struct ui_file *, char *);
|
extern void print_doc_line (struct ui_file *, char *);
|
|
|
|
|
#endif /* !defined (CLI_DECODE_H) */
|
#endif /* !defined (CLI_DECODE_H) */
|
|
|
