-/* 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, 1989-1995, 1999-2000, 2002, 2004, 2007-2012 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 (COMMAND_H)
#define COMMAND_H 1
+/* 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.
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
/* Forward-declarations of the entry-points of cli/cli-decode.c. */
+/* 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 (char *, enum command_class,
void (*fun) (char *, int), char *,
struct cmd_list_element **);
extern void set_cmd_sfunc (struct cmd_list_element *cmd,
cmd_sfunc_ftype *sfunc);
-extern void set_cmd_completer (struct cmd_list_element *cmd,
- char **(*completer) (struct cmd_list_element *cmd,
- char *text, char *word));
+extern void set_cmd_completer (struct cmd_list_element *,
+ char **(*completer) (struct cmd_list_element *,
+ char *, char *));
/* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs
around in cmd objects to test the value of the commands sfunc(). */
/* 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 **,
struct cmd_list_element *, char *,
extern char **complete_on_cmdlist (struct cmd_list_element *,
char *, char *);
-extern char **complete_on_enum (const char *enumlist[],
+extern char **complete_on_enum (const char *const *enumlist,
char *, 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 *,
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). */
extern void add_setshow_enum_cmd (char *name,
enum command_class class,
- const char *enumlist[],
+ const char *const *enumlist,
const char **var,
const char *set_doc,
const char *show_doc,
extern void dont_repeat (void);
+extern struct cleanup *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
as a class of commands. */