6f937416b9
This is sort of a continuation of Keith's parse_exp_1 constification patch. It started out by undoing these bits: @@ -754,9 +754,12 @@ validate_actionline (char **line, struct tmp_p = p; for (loc = t->base.loc; loc; loc = loc->next) { - p = tmp_p; - exp = parse_exp_1 (&p, loc->address, + const char *q; + + q = tmp_p; + exp = parse_exp_1 (&q, loc->address, block_for_pc (loc->address), 1); + p = (char *) q; and progressively making more things const upwards, fixing fallout, rinse repeat, until GDB built again (--enable-targets=all). That ended up constifying lookup_cmd/add_cmd and (lots of) friends, and the completers. I didn't try to constify the command hooks themselves, because I know upfront there are commands that write to the command string argument, and I think I managed to stop at a nice non-hacky split point already. I think the only non-really-super-obvious changes are tracepoint.c:validate_actionline, and tracepoint.c:trace_dump_actions. The rest is just mostly about 'char *' => 'const char *', 'char **'=> 'const char **', and the occasional (e.g., deprecated_cmd_warning) case of 'char **'=> 'const char *', where/when I noticed that nothing actually cares about the pointer to pointer output. Tested on x86_64 Fedora 17, native and gdbserver. gdb/ 2013-03-13 Pedro Alves <palves@redhat.com> * ada-lang.c (struct add_partial_datum) <text, text0, word>: Make fields const. (ada_make_symbol_completion_list): Make "text0" parameter const. * ax-gdb.c (agent_eval_command_one): Make "exp" parameter const. * breakpoint.c (condition_completer): Make "text" and "word" parameters const. Adjust. (check_tracepoint_command): Adjust to validate_actionline prototype change. (catch_syscall_completer): Make "text" and "word" parameters const. * cli/cli-cmds.c (show_user): Make "comname" local const. (valid_command_p): Make "command" parameter const. (alias_command): Make "alias_prefix" and "command_prefix" locals const. * cli/cli-decode.c (add_cmd): Make "name" parameter const. (add_alias_cmd): Make "name" and "oldname" parameters const. Adjust. No longer make copy of OLDNAME. (add_prefix_cmd, add_abbrev_prefix_cmd, add_set_or_show_cmd) (add_setshow_cmd_full, add_setshow_enum_cmd) (add_setshow_auto_boolean_cmd, add_setshow_boolean_cmd) (add_setshow_filename_cmd, add_setshow_string_cmd) (add_setshow_string_noescape_cmd) (add_setshow_optional_filename_cmd, add_setshow_integer_cmd) (add_setshow_uinteger_cmd, add_setshow_zinteger_cmd) (add_setshow_zuinteger_unlimited_cmd, add_setshow_zuinteger_cmd) (delete_cmd, add_info, add_info_alias, add_com, add_com_alias): Make "name" parameter const. (help_cmd): Rename "command" parameter to "arg". New const local "command". (find_cmd): Make "command" parameter const. (lookup_cmd_1): Make "text" parameter pointer to const. Adjust to deprecated_cmd_warning prototype change. (undef_cmd_error): Make "cmdtype" parameter const. (lookup_cmd): Make "line" parameter const. (deprecated_cmd_warning): Change type of "text" parameter to pointer to const char, from pointer to pointer to char. Adjust. (lookup_cmd_composition): Make "text" parameter const. (complete_on_cmdlist, complete_on_enum): Make "text" and "word" parameters const. * cli/cli-decode.h (struct cmd_list_element) <name>: Make field const. * cli/cli-script.c (validate_comname): Make "tem" local const. (define_command): New const local "tem_c". Use it in calls to lookup_cmd. (document_command): Make "tem" and "comfull" locals const. (show_user_1): Make "prefix" and "name" parameters const. * cli-script.h (show_user_1): Make "prefix" and "name" parameters const. * command.h (add_cmd, add_alias_cmd, add_prefix_cmd) (add_abbrev_prefix_cmd, completer_ftype, lookup_cmd, lookup_cmd_1) (deprecated_cmd_warning, lookup_cmd_composition, add_com) (add_com_alias, add_info, add_info_alias, complete_on_cmdlist) (complete_on_enum, add_setshow_enum_cmd) (add_setshow_auto_boolean_cmd, add_setshow_boolean_cmd) (add_setshow_filename_cmd, add_setshow_string_cmd) (add_setshow_string_noescape_cmd) (add_setshow_optional_filename_cmd, add_setshow_integer_cmd) (add_setshow_uinteger_cmd, add_setshow_zinteger_cmd) (add_setshow_zuinteger_cmd, add_setshow_zuinteger_unlimited_cmd): Change prototypes, constifying strings. * completer.c (noop_completer, filename_completer): Make "text" and "prefix" parameters const. (location_completer, expression_completer) (complete_line_internal): Make "text" and "prefix" parameters const and adjust. (command_completer, signal_completer): Make "text" and "prefix" parameters const. * completer.h (noop_completer, filename_completer) (expression_completer, location_completer, command_completer) (signal_completer): Change prototypes. * corefile.c (complete_set_gnutarget): Make "text" and "word" parameters const. * cp-abi.c (cp_abi_completer): Likewise. * expression.h (parse_expression_for_completion): Change prototype. * f-lang.c (f_make_symbol_completion_list): Make "text" and "word" parameters const. * infcmd.c (_initialize_infcmd): Make "cmd_name" local const. * infrun.c (handle_completer): Make "text" and "word" parameters const. * interps.c (interpreter_completer): Make "text" and "word" parameters const. * language.h (struct language_defn) <la_make_symbol_completion_list>: Make "text" and "word" parameters const. * parse.c (parse_exp_1): Move const hack to parse_exp_in_context. (parse_exp_in_context): Rename to ... (parse_exp_in_context_1): ... this. (parse_exp_in_context): Reimplement, with const hack from parse_exp_1. (parse_expression_for_completion): Make "string" parameter const. * printcmd.c (decode_format): Make "string_ptr" parameter pointer to pointer to const char. Adjust. (print_command_1): Make "exp" parameter const. (output_command): Rename to ... (output_command_const): ... this. Make "exp" parameter const. (output_command): Reimplement. (x_command): Adjust. (display_command): Rename "exp" parameter to "arg". New "exp" local, const version of "arg". * python/py-auto-load.c (gdbpy_initialize_auto_load): Make "cmd_name" local const. * python/py-cmd.c (cmdpy_destroyer): Cast const away in xfree call. (cmdpy_completer): Make "text" and "word" parameters const. (gdbpy_parse_command_name): Make "prefix_text2" local const. * python/py-param.c (add_setshow_generic): Make "tmp_name" local const. * remote.c (_initialize_remote): Make "cmd_name" local const. * symtab.c (language_search_unquoted_string): Make "text" and "p" parameters const. Adjust. (completion_list_add_fields): Make "sym_text", "text" and "word" parameters const. (struct add_name_data) <sym_text, text, word>: Make fields const. (default_make_symbol_completion_list_break_on): Make "text" and "word" parameters const. Adjust locals. (default_make_symbol_completion_list) (make_symbol_completion_list, make_symbol_completion_type) (make_symbol_completion_list_fn): Make "text" and "word" parameters const. (make_file_symbol_completion_list): Make "text", "word" and "srcfile" parameters const. Adjust locals. (add_filename_to_list): Make "text" and "word" parameters const. (struct add_partial_filename_data) <text, word>: Make fields const. (make_source_files_completion_list): Make "text" and "word" parameters const. * symtab.h (default_make_symbol_completion_list_break_on) (default_make_symbol_completion_list, make_symbol_completion_list) (make_symbol_completion_type enum type_code) (make_symbol_completion_list_fn make_file_symbol_completion_list) (make_source_files_completion_list): Change prototype. * top.c (execute_command): Adjust to pass pointer to pointer to const char to lookup_cmd, and to deprecated_cmd_warning prototype change. (set_verbose): Make "cmdname" local const. * tracepoint.c (decode_agent_options): Make "exp" parameter const, and adjust. (validate_actionline): Make "line" parameter a pointer to const char, and adjust. (encode_actions_1): Make "action_exp" local const, and adjust. (encode_actions): Adjust. (replace_comma): Delete. (trace_dump_actions): Make "action_exp" and "next_comma" locals const, and adjust. Don't frob the action string while splitting it at commas. Instead, make a copy of each split substring in turn. (trace_dump_command): Adjust to validate_actionline prototype change. * tracepoint.h (decode_agent_options, decode_agent_options) (encode_actions, validate_actionline): Change prototypes. * valprint.h (output_command): Delete declaration. (output_command_const): Declare. * value.c (function_destroyer): Cast const away in xfree call.
243 lines
8.8 KiB
C
243 lines
8.8 KiB
C
/* Header file for GDB command decoding library.
|
|
|
|
Copyright (C) 2000-2013 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
|
|
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/>. */
|
|
|
|
#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;
|
|
|
|
#if 0
|
|
/* FIXME: cagney/2002-03-17: Once cmd_type() has been removed, ``enum
|
|
cmd_types'' can be moved from "command.h" to "cli-decode.h". */
|
|
/* Not a set/show command. Note that some commands which begin with
|
|
"set" or "show" might be in this category, if their syntax does
|
|
not fall into one of the following categories. */
|
|
typedef enum cmd_types
|
|
{
|
|
not_set_cmd,
|
|
set_cmd,
|
|
show_cmd
|
|
}
|
|
cmd_types;
|
|
#endif
|
|
|
|
/* 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
|
|
#define DOC_ALLOCATED 0x8
|
|
|
|
struct cmd_list_element
|
|
{
|
|
/* Points to next command in this list. */
|
|
struct cmd_list_element *next;
|
|
|
|
/* Name of this command. */
|
|
const char *name;
|
|
|
|
/* Command class; class values are chosen by application program. */
|
|
enum command_class class;
|
|
|
|
/* 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);
|
|
/* 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;
|
|
/* If type is set_cmd or show_cmd, first set the variables,
|
|
and then call this: */
|
|
cmd_sfunc_ftype *sfunc;
|
|
}
|
|
function;
|
|
|
|
/* Local state (context) for this command. This can be anything. */
|
|
void *context;
|
|
|
|
/* 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;
|
|
|
|
/* 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.
|
|
|
|
bit 3: DOC_ALLOCATED, set if the doc field should be xfree'd. */
|
|
|
|
int flags;
|
|
|
|
/* If this command is deprecated, this is the replacement name. */
|
|
char *replacement;
|
|
|
|
/* 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);
|
|
|
|
/* Hook for another command to be executed before this command. */
|
|
struct cmd_list_element *hook_pre;
|
|
|
|
/* 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;
|
|
|
|
/* 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;
|
|
|
|
/* 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;
|
|
|
|
/* 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". */
|
|
completer_ftype *completer;
|
|
|
|
/* 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 *const *enums;
|
|
|
|
/* Pointer to command strings of user-defined commands */
|
|
struct 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;
|
|
|
|
/* 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;
|
|
|
|
/* 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;
|
|
|
|
/* Start of a linked list of all aliases of this command. */
|
|
struct cmd_list_element *aliases;
|
|
|
|
/* Link pointer for aliases on an alias list. */
|
|
struct cmd_list_element *alias_chain;
|
|
};
|
|
|
|
extern void help_cmd_list (struct cmd_list_element *, enum command_class,
|
|
char *, int, struct ui_file *);
|
|
|
|
/* Functions that implement commands about CLI commands. */
|
|
|
|
extern void help_cmd (char *, struct ui_file *);
|
|
|
|
extern void apropos_cmd (struct ui_file *, struct cmd_list_element *,
|
|
struct re_pattern_buffer *, 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);
|
|
|
|
/* Exported to cli/cli-setshow.c */
|
|
|
|
extern void print_doc_line (struct ui_file *, char *);
|
|
|
|
extern const char * const auto_boolean_enums[];
|
|
|
|
#endif /* !defined (CLI_DECODE_H) */
|