/* Header file for GDB command decoding library.
- Copyright (c) 2000, 2003, 2007, 2008, 2009 Free Software Foundation, Inc.
+ Copyright (C) 2000-2020 Free Software Foundation, Inc.
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
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
-#if !defined (CLI_DECODE_H)
-#define CLI_DECODE_H 1
+#ifndef CLI_CLI_DECODE_H
+#define CLI_CLI_DECODE_H
-#include "command.h"
+/* This file defines the private interfaces for any code implementing
+ command internals. */
-struct re_pattern_buffer;
+/* Include the public interfaces. */
+#include "command.h"
+#include "gdb_regex.h"
+#include "cli-script.h"
+#include "completer.h"
#if 0
/* FIXME: cagney/2002-03-17: Once cmd_type() has been removed, ``enum
/* This structure records one command'd definition. */
-/* 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 following struct.
-*/
-#define CMD_DEPRECATED 0x1
-#define DEPRECATED_WARN_USER 0x2
-#define MALLOCED_REPLACEMENT 0x4
-
-/* This flag is set if the command is allowed to run when the target
- has execution, but there's no selected thread. */
-#define CMD_NO_SELECTED_THREAD_OK 0x10
-
struct cmd_list_element
{
+ cmd_list_element (const char *name_, enum command_class theclass_,
+ const char *doc_)
+ : name (name_),
+ theclass (theclass_),
+ cmd_deprecated (0),
+ deprecated_warn_user (0),
+ malloced_replacement (0),
+ doc_allocated (0),
+ name_allocated (0),
+ hook_in (0),
+ allow_unknown (0),
+ abbrev_flag (0),
+ type (not_set_cmd),
+ var_type (var_boolean),
+ doc (doc_)
+ {
+ memset (&function, 0, sizeof (function));
+ }
+
+ ~cmd_list_element ()
+ {
+ if (doc && doc_allocated)
+ xfree ((char *) doc);
+ if (name_allocated)
+ xfree ((char *) name);
+ }
+
+ DISABLE_COPY_AND_ASSIGN (cmd_list_element);
+
+
/* Points to next command in this list. */
- struct cmd_list_element *next;
+ struct cmd_list_element *next = nullptr;
/* Name of this command. */
- char *name;
+ const char *name;
/* Command class; class values are chosen by application program. */
- enum command_class class;
+ enum command_class theclass;
+
+ /* When 1 indicated that this command is deprecated. It may be
+ removed from gdb's command set in the future. */
+
+ unsigned int cmd_deprecated : 1;
+
+ /* The user needs to be warned that this is a deprecated command.
+ The user should only be warned the first time a command is
+ used. */
+
+ unsigned int deprecated_warn_user : 1;
+
+ /* When functions are deprecated at compile time (this is the way
+ it should, in general, be done) the memory containing the
+ replacement string is statically allocated. In some cases it
+ makes sense to deprecate commands at runtime (the testsuite is
+ one example). In this case the memory for replacement is
+ malloc'ed. When a command is undeprecated or re-deprecated at
+ runtime we don't want to risk calling free on statically
+ allocated memory, so we check this flag. */
+
+ unsigned int malloced_replacement : 1;
+
+ /* Set if the doc field should be xfree'd. */
+
+ unsigned int doc_allocated : 1;
+
+ /* Set if the name field should be xfree'd. */
+
+ unsigned int name_allocated : 1;
+
+ /* Flag that specifies if this command is already running its hook. */
+ /* Prevents the possibility of hook recursion. */
+ unsigned int hook_in : 1;
+
+ /* For prefix commands only:
+ nonzero means do not get an error if subcommand is not
+ recognized; call the prefix's own function in that case. */
+ unsigned int allow_unknown : 1;
+
+ /* Nonzero says this is an abbreviation, and should not
+ be mentioned in lists of commands.
+ This allows "br<tab>" to complete to "break", which it
+ otherwise wouldn't. */
+ unsigned int abbrev_flag : 1;
+
+ /* Type of "set" or "show" command (or SET_NOT_SET if not "set"
+ or "show"). */
+ ENUM_BITFIELD (cmd_types) type : 2;
+
+ /* What kind of variable is *VAR? */
+ ENUM_BITFIELD (var_types) var_type : 4;
/* Function definition of this command. NULL for command class
names and for help topics that are not really commands. NOTE:
cagney/2002-02-02: This function signature is evolving. For
the moment suggest sticking with either set_cmd_cfunc() or
set_cmd_sfunc(). */
- void (*func) (struct cmd_list_element *c, char *args, int from_tty);
+ void (*func) (struct cmd_list_element *c, const char *args, int from_tty)
+ = nullptr;
/* The command's real callback. At present func() bounces through
to one of the below. */
union
{
/* If type is not_set_cmd, call it like this: */
- cmd_cfunc_ftype *cfunc;
+ cmd_const_cfunc_ftype *const_cfunc;
/* If type is set_cmd or show_cmd, first set the variables,
and then call this: */
- cmd_sfunc_ftype *sfunc;
+ cmd_const_sfunc_ftype *sfunc;
}
function;
/* Local state (context) for this command. This can be anything. */
- void *context;
+ void *context = nullptr;
/* Documentation of this command (or help topic).
First line is brief documentation; remaining lines form, with it,
the full documentation. First line should end with a period.
Entire string should also end with a period, not a newline. */
- char *doc;
+ const char *doc;
/* For set/show commands. A method for printing the output to the
specified stream. */
- show_value_ftype *show_value_func;
-
- /* flags : a bitfield
-
- bit 0: (LSB) CMD_DEPRECATED, when 1 indicated that this command
- is deprecated. It may be removed from gdb's command set in the
- future.
-
- bit 1: DEPRECATED_WARN_USER, the user needs to be warned that
- this is a deprecated command. The user should only be warned
- the first time a command is used.
-
- bit 2: MALLOCED_REPLACEMENT, when functions are deprecated at
- compile time (this is the way it should, in general, be done)
- the memory containing the replacement string is statically
- allocated. In some cases it makes sense to deprecate commands
- at runtime (the testsuite is one example). In this case the
- memory for replacement is malloc'ed. When a command is
- undeprecated or re-deprecated at runtime we don't want to risk
- calling free on statically allocated memory, so we check this
- flag.
- */
- int flags;
+ show_value_ftype *show_value_func = nullptr;
/* If this command is deprecated, this is the replacement name. */
- char *replacement;
+ const char *replacement = nullptr;
/* If this command represents a show command, then this function
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) = nullptr;
/* Hook for another command to be executed before this command. */
- struct cmd_list_element *hook_pre;
+ struct cmd_list_element *hook_pre = nullptr;
/* Hook for another command to be executed after this command. */
- struct cmd_list_element *hook_post;
-
- /* Flag that specifies if this command is already running its hook. */
- /* Prevents the possibility of hook recursion. */
- int hook_in;
+ struct cmd_list_element *hook_post = nullptr;
/* Nonzero identifies a prefix command. For them, the address
of the variable containing the list of subcommands. */
- struct cmd_list_element **prefixlist;
+ struct cmd_list_element **prefixlist = nullptr;
/* For prefix commands only:
String containing prefix commands to get here: this one
plus any others needed to get to it. Should end in a space.
It is used before the word "command" in describing the
commands reached through this prefix. */
- char *prefixname;
+ const char *prefixname = nullptr;
- /* For prefix commands only:
- nonzero means do not get an error if subcommand is not
- recognized; call the prefix's own function in that case. */
- char allow_unknown;
+ /* The prefix command of this command. */
+ struct cmd_list_element *prefix = nullptr;
- /* Nonzero says this is an abbreviation, and should not
- be mentioned in lists of commands.
- This allows "br<tab>" to complete to "break", which it
- otherwise wouldn't. */
- char abbrev_flag;
-
- /* Completion routine for this command. TEXT is the text beyond
- what was matched for the command itself (leading whitespace is
- skipped). It stops where we are supposed to stop completing
- (rl_point) and is '\0' terminated.
-
- Return value is a malloc'd vector of pointers to possible completions
- terminated with NULL. If there are no completions, returning a pointer
- to a NULL would work but returning NULL itself is also valid.
- WORD points in the same buffer as TEXT, and completions should be
- returned relative to this position. For example, suppose TEXT is "foo"
- and we want to complete to "foobar". If WORD is "oo", return
- "oobar"; if WORD is "baz/foo", return "baz/foobar". */
- char **(*completer) (struct cmd_list_element *cmd, char *text, char *word);
+ /* Completion routine for this command. */
+ completer_ftype *completer = symbol_completer;
+
+ /* Handle the word break characters for this completer. Usually
+ this function need not be defined, but for some types of
+ completers (e.g., Python completers declared as methods inside
+ a class) the word break chars may need to be redefined
+ depending on the completer type (e.g., for filename
+ completers). */
+ completer_handle_brkchars_ftype *completer_handle_brkchars = nullptr;
/* Destruction routine for this command. If non-NULL, this is
called when this command instance is destroyed. This may be
used to finalize the CONTEXT field, if needed. */
- void (*destroyer) (struct cmd_list_element *self, void *context);
+ void (*destroyer) (struct cmd_list_element *self, void *context) = nullptr;
- /* Type of "set" or "show" command (or SET_NOT_SET if not "set"
- or "show"). */
- cmd_types type;
-
- /* Pointer to variable affected by "set" and "show". Doesn't matter
- if type is not_set. */
- void *var;
-
- /* What kind of variable is *VAR? */
- var_types var_type;
+ /* Pointer to variable affected by "set" and "show". Doesn't
+ matter if type is not_set. */
+ void *var = nullptr;
- /* Pointer to NULL terminated list of enumerated values (like argv). */
- const char **enums;
+ /* Pointer to NULL terminated list of enumerated values (like
+ argv). */
+ const char *const *enums = nullptr;
/* Pointer to command strings of user-defined commands */
- struct command_line *user_commands;
+ counted_command_line user_commands;
/* Pointer to command that is hooked by this one, (by hook_pre)
so the hook can be removed when this one is deleted. */
- struct cmd_list_element *hookee_pre;
+ struct cmd_list_element *hookee_pre = nullptr;
/* Pointer to command that is hooked by this one, (by hook_post)
so the hook can be removed when this one is deleted. */
- struct cmd_list_element *hookee_post;
+ struct cmd_list_element *hookee_post = nullptr;
/* Pointer to command that is aliased by this one, so the
aliased command can be located in case it has been hooked. */
- struct cmd_list_element *cmd_pointer;
+ struct cmd_list_element *cmd_pointer = nullptr;
/* Start of a linked list of all aliases of this command. */
- struct cmd_list_element *aliases;
+ struct cmd_list_element *aliases = nullptr;
/* Link pointer for aliases on an alias list. */
- struct cmd_list_element *alias_chain;
- };
-
-/* API to the manipulation of command lists. */
-
-extern struct cmd_list_element *add_cmd (char *, enum command_class,
- void (*fun) (char *, int), char *,
- struct cmd_list_element **);
-
-extern struct cmd_list_element *add_alias_cmd (char *, char *,
- enum command_class, int,
- struct cmd_list_element **);
-
-extern struct cmd_list_element *add_prefix_cmd (char *, enum command_class,
- void (*fun) (char *, int),
- char *,
- struct cmd_list_element **,
- char *, int,
- struct cmd_list_element **);
-
-extern struct cmd_list_element *add_abbrev_prefix_cmd (char *,
- enum command_class,
- void (*fun) (char *,
- int),
- char *,
- struct cmd_list_element
- **, char *, int,
- struct cmd_list_element
- **);
-
-/* Set the commands corresponding callback. */
-
-extern void set_cmd_cfunc (struct cmd_list_element *cmd,
- void (*cfunc) (char *args, int from_tty));
-
-extern void set_cmd_sfunc (struct cmd_list_element *cmd,
- void (*sfunc) (char *args, int from_tty,
- struct cmd_list_element * c));
-
-extern void set_cmd_completer (struct cmd_list_element *cmd,
- char **(*completer) (struct cmd_list_element *self,
- char *text, char *word));
+ struct cmd_list_element *alias_chain = nullptr;
-/* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs
- around in cmd objects to test the value of the commands sfunc(). */
-extern int cmd_cfunc_eq (struct cmd_list_element *cmd,
- void (*cfunc) (char *args, int from_tty));
-
-/* Access to the command's local context. */
-extern void set_cmd_context (struct cmd_list_element *cmd, void *context);
-extern void *get_cmd_context (struct cmd_list_element *cmd);
-
-/* Mark command as ok to call when there is no selected thread. There
- is no way to disable this once set. */
-extern void set_cmd_no_selected_thread_ok (struct cmd_list_element *);
-
-/* Return true if command is no-selected-thread-ok. */
-extern int get_cmd_no_selected_thread_ok (struct cmd_list_element *);
-
-extern struct cmd_list_element *lookup_cmd (char **,
- struct cmd_list_element *, char *,
- int, int);
-
-extern struct cmd_list_element *lookup_cmd_1 (char **,
- struct cmd_list_element *,
- struct cmd_list_element **,
- int);
-
-extern struct cmd_list_element *
- deprecate_cmd (struct cmd_list_element *, char * );
-
-extern void
- deprecated_cmd_warning (char **);
-
-extern int
- lookup_cmd_composition (char *text,
- struct cmd_list_element **alias,
- struct cmd_list_element **prefix_cmd,
- struct cmd_list_element **cmd);
-
-extern struct cmd_list_element *add_com (char *, enum command_class,
- void (*fun) (char *, int), char *);
-
-extern struct cmd_list_element *add_com_alias (char *, char *,
- enum command_class, int);
-
-extern struct cmd_list_element *add_info (char *, void (*fun) (char *, int),
- char *);
-
-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_enum (const char *enumlist[], char *, char *);
+ /* If non-null, the pointer to a field in 'struct
+ cli_suppress_notification', which will be set to true in cmd_func
+ when this command is being executed. It will be set back to false
+ when the command has been executed. */
+ int *suppress_notification = nullptr;
+ };
extern void help_cmd_list (struct cmd_list_element *, enum command_class,
- char *, int, struct ui_file *);
+ const 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_list (struct cmd_list_element *, char *,
- enum command_class, struct ui_file *);
+extern void help_cmd (const char *, struct ui_file *);
extern void apropos_cmd (struct ui_file *, struct cmd_list_element *,
- struct re_pattern_buffer *, char *);
+ bool verbose, compiled_regex &, const char *);
/* 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
as a class of commands. */
-extern void not_just_help_class_command (char *arg, int from_tty);
+extern void not_just_help_class_command (const char *arg, int from_tty);
+
+/* Print only the first line of STR on STREAM.
+ FOR_VALUE_PREFIX true indicates that the first line is output
+ to be a prefix to show a value (see deprecated_show_value_hack):
+ the first character is printed in uppercase, and the trailing
+ dot character is not printed. */
+
+extern void print_doc_line (struct ui_file *stream, const char *str,
+ bool for_value_prefix);
+
+/* The enums of boolean commands. */
+extern const char * const boolean_enums[];
+
+/* The enums of auto-boolean commands. */
+extern const char * const auto_boolean_enums[];
-/* Exported to cli/cli-setshow.c */
+/* Verify whether a given cmd_list_element is a user-defined command.
+ Return 1 if it is user-defined. Return 0 otherwise. */
-extern void print_doc_line (struct ui_file *, char *);
+extern int cli_user_command_p (struct cmd_list_element *);
+extern int find_command_name_length (const char *);
-#endif /* !defined (CLI_DECODE_H) */
+#endif /* CLI_CLI_DECODE_H */
projects / deliverable / binutils-gdb.git / blobdiff