/* Header file for command creation.
- Copyright (C) 1986-2014 Free Software Foundation, Inc.
+ Copyright (C) 1986-2017 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
#define COMMAND_H 1
#include "gdb_vecs.h"
+#include "common/scoped_restore.h"
+
+struct completion_tracker;
/* This file defines the public interface for any code wanting to
create commands. */
typedef void cmd_cfunc_ftype (char *args, int from_tty);
+/* This structure specifies notifications to be suppressed by a cli
+ command interpreter. */
+
+struct cli_suppress_notification
+{
+ /* Inferior, thread, frame selected notification suppressed? */
+ int user_selected_context;
+};
+
+extern struct cli_suppress_notification cli_suppress_notification;
+
/* Forward-declarations of the entry-points of cli/cli-decode.c. */
/* API to the manipulation of command lists. */
extern struct cmd_list_element *add_cmd (const char *, enum command_class,
cmd_cfunc_ftype *fun,
- char *,
+ const char *,
struct cmd_list_element **);
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_alias_cmd (const char *,
+ cmd_list_element *,
+ enum command_class, int,
+ struct cmd_list_element **);
+
+
extern struct cmd_list_element *add_prefix_cmd (const char *, enum command_class,
cmd_cfunc_ftype *fun,
- char *,
+ const char *,
struct cmd_list_element **,
- char *, int,
+ const char *, int,
struct cmd_list_element **);
extern struct cmd_list_element *add_abbrev_prefix_cmd (const char *,
enum command_class,
cmd_cfunc_ftype *fun,
- char *,
+ const char *,
struct cmd_list_element
- **, char *, int,
+ **, const char *, int,
struct cmd_list_element
**);
extern void set_cmd_sfunc (struct cmd_list_element *cmd,
cmd_sfunc_ftype *sfunc);
-typedef VEC (char_ptr) *completer_ftype (struct cmd_list_element *,
- const char *, const char *);
+/* A completion routine. Add possible completions to tracker.
+
+ 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. 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". */
+typedef void completer_ftype (struct cmd_list_element *,
+ completion_tracker &tracker,
+ const char *text, const char *word);
+
+/* Same, but for set_cmd_completer_handle_brkchars. */
+typedef void completer_handle_brkchars_ftype (struct cmd_list_element *,
+ completion_tracker &tracker,
+ const char *text, const char *word);
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_handle_brkchars_ftype *);
+
/* 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,
#define CMD_LIST_AMBIGUOUS ((struct cmd_list_element *) -1)
extern struct cmd_list_element *lookup_cmd (const char **,
- struct cmd_list_element *, char *,
+ struct cmd_list_element *,
+ const char *,
int, int);
extern struct cmd_list_element *lookup_cmd_1 (const char **,
extern struct cmd_list_element *add_com (const char *, enum command_class,
cmd_cfunc_ftype *fun,
- char *);
+ const char *);
extern struct cmd_list_element *add_com_alias (const char *, const char *,
enum command_class, int);
+extern struct cmd_list_element *add_com_suppress_notification
+ (const char *name, enum command_class theclass,
+ cmd_cfunc_ftype *fun, const char *doc,
+ int *supress_notification);
+
extern struct cmd_list_element *add_info (const char *,
cmd_cfunc_ftype *fun,
- char *);
+ const char *);
-extern struct cmd_list_element *add_info_alias (const char *, char *, int);
+extern struct cmd_list_element *add_info_alias (const char *, const char *,
+ int);
-extern VEC (char_ptr) *complete_on_cmdlist (struct cmd_list_element *,
- const char *, const char *, int);
+extern void complete_on_cmdlist (struct cmd_list_element *,
+ completion_tracker &tracker,
+ const char *, const char *, int);
-extern VEC (char_ptr) *complete_on_enum (const char *const *enumlist,
- const char *, const char *);
+extern void complete_on_enum (completion_tracker &tracker,
+ const char *const *enumlist,
+ const char *, const char *);
/* 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 *);
/* Method for show a set/show variable's VALUE on FILE. If this
extern show_value_ftype deprecated_show_value_hack;
extern void add_setshow_enum_cmd (const char *name,
- enum command_class class,
+ enum command_class theclass,
const char *const *enumlist,
const char **var,
const char *set_doc,
struct cmd_list_element **show_list);
extern void add_setshow_auto_boolean_cmd (const char *name,
- enum command_class class,
+ enum command_class theclass,
enum auto_boolean *var,
const char *set_doc,
const char *show_doc,
struct cmd_list_element **show_list);
extern void add_setshow_boolean_cmd (const char *name,
- enum command_class class,
+ enum command_class theclass,
int *var,
const char *set_doc, const char *show_doc,
const char *help_doc,
struct cmd_list_element **show_list);
extern void add_setshow_filename_cmd (const char *name,
- enum command_class class,
+ enum command_class theclass,
char **var,
const char *set_doc,
const char *show_doc,
struct cmd_list_element **show_list);
extern void add_setshow_string_cmd (const char *name,
- enum command_class class,
+ enum command_class theclass,
char **var,
const char *set_doc,
const char *show_doc,
extern struct cmd_list_element *add_setshow_string_noescape_cmd
(const char *name,
- enum command_class class,
+ enum command_class theclass,
char **var,
const char *set_doc,
const char *show_doc,
struct cmd_list_element **show_list);
extern void add_setshow_optional_filename_cmd (const char *name,
- enum command_class class,
+ enum command_class theclass,
char **var,
const char *set_doc,
const char *show_doc,
struct cmd_list_element **show_list);
extern void add_setshow_integer_cmd (const char *name,
- enum command_class class,
+ enum command_class theclass,
int *var,
const char *set_doc,
const char *show_doc,
struct cmd_list_element **show_list);
extern void add_setshow_uinteger_cmd (const char *name,
- enum command_class class,
+ enum command_class theclass,
unsigned int *var,
const char *set_doc,
const char *show_doc,
struct cmd_list_element **show_list);
extern void add_setshow_zinteger_cmd (const char *name,
- enum command_class class,
+ enum command_class theclass,
int *var,
const char *set_doc,
const char *show_doc,
struct cmd_list_element **show_list);
extern void add_setshow_zuinteger_cmd (const char *name,
- enum command_class class,
+ enum command_class theclass,
unsigned int *var,
const char *set_doc,
const char *show_doc,
extern void
add_setshow_zuinteger_unlimited_cmd (const char *name,
- enum command_class class,
+ enum command_class theclass,
int *var,
const char *set_doc,
const char *show_doc,
/* 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 dont_repeat (void);
-extern struct cleanup *prevent_dont_repeat (void);
+extern scoped_restore_tmpl<int> prevent_dont_repeat (void);
/* 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
projects / deliverable / binutils-gdb.git / blobdiff