X-Git-Url: http://drtracing.org/?a=blobdiff_plain;f=gdb%2Fcommand.h;h=bdf625b5cfb2463283faea276b2eb1544d3c9057;hb=b08b78e7d4bb56f395d3212eed6184ede236c760;hp=d2f5ca501f75b8cd156b1a177da6cfb777a40673;hpb=47a80e909327f6be0451b7792162266e6695f23d;p=deliverable%2Fbinutils-gdb.git diff --git a/gdb/command.h b/gdb/command.h index d2f5ca501f..bdf625b5cf 100644 --- a/gdb/command.h +++ b/gdb/command.h @@ -1,7 +1,6 @@ -/* Header file for command-reading library command.c. +/* Header file for command creation. - Copyright (C) 1986, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1999, 2000, - 2002, 2004, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc. + Copyright (C) 1986-2015 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,11 @@ #if !defined (COMMAND_H) #define COMMAND_H 1 +#include "gdb_vecs.h" + +/* This file defines the public interface for any code wanting to + create commands. */ + /* Command classes are top-level categories into which commands are broken down for "help" purposes. @@ -34,7 +38,9 @@ enum command_class no_class = -1, class_run = 0, class_vars, class_stack, class_files, class_support, class_info, class_breakpoint, class_trace, class_alias, class_bookmark, class_obscure, class_maintenance, - class_pseudo, class_tui, class_user, class_xdb + class_pseudo, class_tui, class_user, class_xdb, + no_set_class /* Used for "show" commands that have no corresponding + "set" command. */ }; /* FIXME: cagney/2002-03-17: Once cmd_type() has been removed, ``enum @@ -70,7 +76,8 @@ typedef enum var_types /* Like var_uinteger but signed. *VAR is an int. The user can type 0 to mean "unlimited", which is stored in *VAR as - INT_MAX. */ + INT_MAX. The only remaining use of it is the Python API. + Don't use it elsewhere. */ var_integer, /* String which the user enters with escapes (e.g. the user types @@ -86,12 +93,16 @@ typedef enum var_types /* String which stores a filename. (*VAR) is a malloc'd string. */ var_filename, - /* ZeroableInteger. *VAR is an int. Like Unsigned Integer except + /* ZeroableInteger. *VAR is an int. Like var_integer except that zero really means zero. */ var_zinteger, /* ZeroableUnsignedInteger. *VAR is an unsigned int. Zero really means zero. */ var_zuinteger, + /* ZeroableUnsignedInteger with unlimited value. *VAR is an int, + but its range is [0, INT_MAX]. -1 stands for unlimited and + other negative numbers are not allowed. */ + var_zuinteger_unlimited, /* Enumerated type. Can only have one of the specified values. *VAR is a char pointer to the name of the element that we find. */ @@ -102,36 +113,41 @@ var_types; /* This structure records one command'd definition. */ struct cmd_list_element; +typedef void cmd_cfunc_ftype (char *args, int from_tty); + /* Forward-declarations of the entry-points of cli/cli-decode.c. */ -extern struct cmd_list_element *add_cmd (char *, enum command_class, - void (*fun) (char *, int), char *, +/* API to the manipulation of command lists. */ + +extern int valid_user_defined_cmd_name_p (const char *name); + +extern struct cmd_list_element *add_cmd (const char *, enum command_class, + cmd_cfunc_ftype *fun, + const char *, struct cmd_list_element **); -extern struct cmd_list_element *add_alias_cmd (char *, char *, +extern struct cmd_list_element *add_alias_cmd (const char *, const 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 *, +extern struct cmd_list_element *add_prefix_cmd (const char *, enum command_class, + cmd_cfunc_ftype *fun, + const char *, struct cmd_list_element **, - char *, int, + const char *, int, struct cmd_list_element **); -extern struct cmd_list_element *add_abbrev_prefix_cmd (char *, +extern struct cmd_list_element *add_abbrev_prefix_cmd (const char *, enum command_class, - void (*fun) (char *, - int), - char *, + cmd_cfunc_ftype *fun, + const char *, struct cmd_list_element - **, char *, int, + **, const char *, int, struct cmd_list_element **); /* Set the commands corresponding callback. */ -typedef void cmd_cfunc_ftype (char *args, int from_tty); extern void set_cmd_cfunc (struct cmd_list_element *cmd, cmd_cfunc_ftype *cfunc); @@ -140,14 +156,23 @@ typedef void cmd_sfunc_ftype (char *args, int from_tty, extern void set_cmd_sfunc (struct cmd_list_element *cmd, cmd_sfunc_ftype *sfunc); -extern void set_cmd_completer (struct cmd_list_element *, - char **(*completer) (struct cmd_list_element *, - char *, char *)); +typedef VEC (char_ptr) *completer_ftype (struct cmd_list_element *, + const char *, const char *); + +typedef void completer_ftype_void (struct cmd_list_element *, + const char *, const char *); + +extern void set_cmd_completer (struct cmd_list_element *, completer_ftype *); + +/* Set the completer_handle_brkchars callback. */ + +extern void set_cmd_completer_handle_brkchars (struct cmd_list_element *, + completer_ftype_void *); /* 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)); + cmd_cfunc_ftype *cfun); /* Each command object has a local context attached to it. */ extern void set_cmd_context (struct cmd_list_element *cmd, @@ -164,54 +189,53 @@ extern void execute_cmd_post_hook (struct cmd_list_element *cmd); /* Return the type of the command. */ extern enum cmd_types cmd_type (struct cmd_list_element *cmd); +/* Flag for an ambiguous cmd_list result. */ +#define CMD_LIST_AMBIGUOUS ((struct cmd_list_element *) -1) -extern struct cmd_list_element *lookup_cmd (char **, +extern struct cmd_list_element *lookup_cmd (const char **, struct cmd_list_element *, char *, int, int); -extern struct cmd_list_element *lookup_cmd_1 (char **, +extern struct cmd_list_element *lookup_cmd_1 (const char **, struct cmd_list_element *, struct cmd_list_element **, int); extern struct cmd_list_element *deprecate_cmd (struct cmd_list_element *, - char * ); + const char * ); -extern void deprecated_cmd_warning (char **); +extern void deprecated_cmd_warning (const char *); -extern int lookup_cmd_composition (char *text, +extern int lookup_cmd_composition (const 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 (const char *, enum command_class, + cmd_cfunc_ftype *fun, + const char *); -extern struct cmd_list_element *add_com_alias (char *, char *, +extern struct cmd_list_element *add_com_alias (const char *, const 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 (const char *, + cmd_cfunc_ftype *fun, + const char *); -extern struct cmd_list_element *add_info_alias (char *, char *, int); +extern struct cmd_list_element *add_info_alias (const char *, const char *, + int); -extern char **complete_on_cmdlist (struct cmd_list_element *, - char *, char *); +extern VEC (char_ptr) *complete_on_cmdlist (struct cmd_list_element *, + const char *, const char *, int); -extern char **complete_on_enum (const char *enumlist[], - char *, char *); +extern VEC (char_ptr) *complete_on_enum (const char *const *enumlist, + const char *, const char *); -extern void help_cmd (char *, struct ui_file *); +/* Functions that implement commands about CLI commands. */ -extern void help_list (struct cmd_list_element *, char *, +extern void help_list (struct cmd_list_element *, const char *, enum command_class, struct ui_file *); -extern void help_cmd_list (struct cmd_list_element *, - enum command_class, - char *, int, struct ui_file *); - /* Method for show a set/show variable's VALUE on FILE. If this method isn't supplied deprecated_show_value_hack() is called (which is not good). */ @@ -223,9 +247,9 @@ typedef void (show_value_ftype) (struct ui_file *file, instead print the value out directly. */ extern show_value_ftype deprecated_show_value_hack; -extern void add_setshow_enum_cmd (char *name, - enum command_class class, - const char *enumlist[], +extern void add_setshow_enum_cmd (const char *name, + enum command_class theclass, + const char *const *enumlist, const char **var, const char *set_doc, const char *show_doc, @@ -235,8 +259,8 @@ extern void add_setshow_enum_cmd (char *name, struct cmd_list_element **set_list, struct cmd_list_element **show_list); -extern void add_setshow_auto_boolean_cmd (char *name, - enum command_class class, +extern void add_setshow_auto_boolean_cmd (const char *name, + enum command_class theclass, enum auto_boolean *var, const char *set_doc, const char *show_doc, @@ -246,8 +270,8 @@ extern void add_setshow_auto_boolean_cmd (char *name, struct cmd_list_element **set_list, struct cmd_list_element **show_list); -extern void add_setshow_boolean_cmd (char *name, - enum command_class class, +extern void add_setshow_boolean_cmd (const char *name, + enum command_class theclass, int *var, const char *set_doc, const char *show_doc, const char *help_doc, @@ -256,8 +280,8 @@ extern void add_setshow_boolean_cmd (char *name, struct cmd_list_element **set_list, struct cmd_list_element **show_list); -extern void add_setshow_filename_cmd (char *name, - enum command_class class, +extern void add_setshow_filename_cmd (const char *name, + enum command_class theclass, char **var, const char *set_doc, const char *show_doc, @@ -267,8 +291,8 @@ extern void add_setshow_filename_cmd (char *name, struct cmd_list_element **set_list, struct cmd_list_element **show_list); -extern void add_setshow_string_cmd (char *name, - enum command_class class, +extern void add_setshow_string_cmd (const char *name, + enum command_class theclass, char **var, const char *set_doc, const char *show_doc, @@ -278,19 +302,20 @@ extern void add_setshow_string_cmd (char *name, struct cmd_list_element **set_list, struct cmd_list_element **show_list); -extern void add_setshow_string_noescape_cmd (char *name, - enum command_class class, - char **var, - const char *set_doc, - const char *show_doc, - const char *help_doc, - cmd_sfunc_ftype *set_func, - show_value_ftype *show_func, - struct cmd_list_element **set_list, - struct cmd_list_element **show_list); - -extern void add_setshow_optional_filename_cmd (char *name, - enum command_class class, +extern struct cmd_list_element *add_setshow_string_noescape_cmd + (const char *name, + enum command_class theclass, + char **var, + const char *set_doc, + const char *show_doc, + const char *help_doc, + cmd_sfunc_ftype *set_func, + show_value_ftype *show_func, + struct cmd_list_element **set_list, + struct cmd_list_element **show_list); + +extern void add_setshow_optional_filename_cmd (const char *name, + enum command_class theclass, char **var, const char *set_doc, const char *show_doc, @@ -300,8 +325,8 @@ extern void add_setshow_optional_filename_cmd (char *name, struct cmd_list_element **set_list, struct cmd_list_element **show_list); -extern void add_setshow_integer_cmd (char *name, - enum command_class class, +extern void add_setshow_integer_cmd (const char *name, + enum command_class theclass, int *var, const char *set_doc, const char *show_doc, @@ -311,8 +336,8 @@ extern void add_setshow_integer_cmd (char *name, struct cmd_list_element **set_list, struct cmd_list_element **show_list); -extern void add_setshow_uinteger_cmd (char *name, - enum command_class class, +extern void add_setshow_uinteger_cmd (const char *name, + enum command_class theclass, unsigned int *var, const char *set_doc, const char *show_doc, @@ -322,8 +347,8 @@ extern void add_setshow_uinteger_cmd (char *name, struct cmd_list_element **set_list, struct cmd_list_element **show_list); -extern void add_setshow_zinteger_cmd (char *name, - enum command_class class, +extern void add_setshow_zinteger_cmd (const char *name, + enum command_class theclass, int *var, const char *set_doc, const char *show_doc, @@ -333,8 +358,8 @@ extern void add_setshow_zinteger_cmd (char *name, struct cmd_list_element **set_list, struct cmd_list_element **show_list); -extern void add_setshow_zuinteger_cmd (char *name, - enum command_class class, +extern void add_setshow_zuinteger_cmd (const char *name, + enum command_class theclass, unsigned int *var, const char *set_doc, const char *show_doc, @@ -344,14 +369,26 @@ extern void add_setshow_zuinteger_cmd (char *name, struct cmd_list_element **set_list, struct cmd_list_element **show_list); +extern void + add_setshow_zuinteger_unlimited_cmd (const char *name, + enum command_class theclass, + int *var, + const char *set_doc, + const char *show_doc, + const char *help_doc, + cmd_sfunc_ftype *set_func, + show_value_ftype *show_func, + struct cmd_list_element **set_list, + struct cmd_list_element **show_list); + /* Do a "show" command for each thing on a command list. */ -extern void cmd_show_list (struct cmd_list_element *, int, char *); +extern void cmd_show_list (struct cmd_list_element *, int, const char *); /* Used everywhere whenever at least one parameter is required and none is specified. */ -extern void error_no_arg (char *) ATTRIBUTE_NORETURN; +extern void error_no_arg (const char *) ATTRIBUTE_NORETURN; extern void dont_repeat (void);