X-Git-Url: http://drtracing.org/?a=blobdiff_plain;f=gdb%2Fcli%2Fcli-decode.h;h=10ff36d83d878242901a882f077eea39d2d6d145;hb=1f2bdf09c6ace2eefc3dd4dfc7366dea9ff5b30e;hp=d63570cc9c46b132b412079e2dc08782cd6cf71b;hpb=ebcd3b23ee08bb41a5492dce554c810eb59f895d;p=deliverable%2Fbinutils-gdb.git diff --git a/gdb/cli/cli-decode.h b/gdb/cli/cli-decode.h index d63570cc9c..10ff36d83d 100644 --- a/gdb/cli/cli-decode.h +++ b/gdb/cli/cli-decode.h @@ -1,7 +1,6 @@ /* Header file for GDB command decoding library. - Copyright (c) 2000, 2003, 2007, 2008, 2009, 2010 - Free Software Foundation, Inc. + Copyright (C) 2000-2014 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 @@ -19,6 +18,10 @@ #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; @@ -41,21 +44,13 @@ cmd_types; /* 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; @@ -91,27 +86,31 @@ struct cmd_list_element 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. + /* 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; - 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. + /* 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; + 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; /* If this command is deprecated, this is the replacement name. */ char *replacement; @@ -123,12 +122,12 @@ struct cmd_list_element /* 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; + unsigned int hook_in : 1; + + /* Hook for another command to be executed after this command. */ + struct cmd_list_element *hook_post; /* Nonzero identifies a prefix command. For them, the address of the variable containing the list of subcommands. */ @@ -144,13 +143,16 @@ struct cmd_list_element /* 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; + unsigned int allow_unknown : 1; + + /* 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" to complete to "break", which it otherwise wouldn't. */ - char abbrev_flag; + unsigned int abbrev_flag : 1; /* Completion routine for this command. TEXT is the text beyond what was matched for the command itself (leading whitespace is @@ -165,8 +167,7 @@ struct cmd_list_element 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; /* Destruction routine for this command. If non-NULL, this is called when this command instance is destroyed. This may be @@ -175,18 +176,18 @@ struct cmd_list_element /* Type of "set" or "show" command (or SET_NOT_SET if not "set" or "show"). */ - cmd_types type; + ENUM_BITFIELD (cmd_types) type : 2; /* 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; + ENUM_BITFIELD (var_types) var_type : 4; /* 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; @@ -210,91 +211,6 @@ struct cmd_list_element 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)); - -/* 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 *); - extern void help_cmd_list (struct cmd_list_element *, enum command_class, char *, int, struct ui_file *); @@ -302,9 +218,6 @@ extern void help_cmd_list (struct cmd_list_element *, enum command_class, 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 apropos_cmd (struct ui_file *, struct cmd_list_element *, struct re_pattern_buffer *, char *); @@ -318,5 +231,6 @@ extern void not_just_help_class_command (char *arg, int from_tty); extern void print_doc_line (struct ui_file *, char *); +extern const char * const auto_boolean_enums[]; #endif /* !defined (CLI_DECODE_H) */