/* Header file for GDB command decoding library.
- Copyright (c) 2000, 2003, 2007-2012 Free Software Foundation, Inc.
+ Copyright (C) 2000-2016 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
#if !defined (CLI_DECODE_H)
#define CLI_DECODE_H 1
+/* This file defines the private interfaces for any code implementing
+ command internals. */
+
+/* Include the public interfaces. */
#include "command.h"
struct re_pattern_buffer;
/* 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
-
struct cmd_list_element
{
/* Points to next command in this list. */
struct cmd_list_element *next;
/* 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;
+
+ /* 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:
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;
-
/* If this command is deprecated, this is the replacement name. */
- char *replacement;
+ const char *replacement;
/* If this command represents a show command, then this function
is called before the variable's value is examined. */
/* 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;
-
/* Nonzero identifies a prefix command. For them, the address
of the variable containing the list of subcommands. */
struct cmd_list_element **prefixlist;
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;
- /* 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;
-
- /* 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;
+ /* The prefix command of this command. */
+ struct cmd_list_element *prefix;
/* Completion routine for this command. TEXT is the text beyond
what was matched for the command itself (leading whitespace is
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);
+ completer_ftype *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_ftype_void *completer_handle_brkchars;
/* 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);
- /* 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 NULL terminated list of enumerated values (like
argv). */
- const char **enums;
+ const char *const *enums;
/* Pointer to command strings of user-defined commands */
struct command_line *user_commands;
/* Link pointer for aliases on an alias list. */
struct cmd_list_element *alias_chain;
- };
-
-/* Flag for an ambiguous cmd_list result. */
-#define CMD_LIST_AMBIGUOUS ((struct cmd_list_element *) -1)
-
-/* 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));
-
-/* 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);
-
-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;
+ };
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. */
-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 *);
+ struct re_pattern_buffer *, 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
/* Exported to cli/cli-setshow.c */
-extern void print_doc_line (struct ui_file *, char *);
+extern void print_doc_line (struct ui_file *, const char *);
+
+extern const char * const auto_boolean_enums[];
+
+/* Verify whether a given cmd_list_element is a user-defined command.
+ Return 1 if it is user-defined. Return 0 otherwise. */
+extern int cli_user_command_p (struct cmd_list_element *);
#endif /* !defined (CLI_DECODE_H) */
projects / deliverable / binutils-gdb.git / blobdiff