gdb/doc: make use of group/end group in 'info pretty-printers' example
[binutils-gdb.git] / gdb / gdbcmd.h
index b21adc74e1f9e86c679f33bead5440c97256c9f4..a05c68e52c25e3682945263a8e66896b59eb198d 100644 (file)
@@ -2,12 +2,11 @@
    of the possible command languages.  If necessary, a hook (that may be
    present or not) must be used and set to the appropriate routine by any
    command language that cares about it.  If you are having to include this
-   file you are possibly doing things the old way.  This file will disapear.
+   file you are possibly doing things the old way.  This file will dissapear.
    fnasser@redhat.com    */
 
 /* Header file for GDB-specific command-line stuff.
-   Copyright (C) 1986, 1989-1994, 1998-2000, 2002, 2007-2012 Free
-   Software Foundation, Inc.
+   Copyright (C) 1986-2022 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
 
 #include "command.h"
 #include "ui-out.h"
+#include "cli/cli-script.h"
+#include "cli/cli-cmds.h"
 
-/* Chain containing all defined commands.  */
+extern void execute_command (const char *, int);
 
-extern struct cmd_list_element *cmdlist;
+/* Run FN.  Sends its output to FILE, do not display it to the screen.
+   The global BATCH_FLAG will be temporarily set to true.  */
 
-/* Chain containing all defined info subcommands.  */
+extern void execute_fn_to_ui_file (struct ui_file *file, std::function<void(void)> fn);
 
-extern struct cmd_list_element *infolist;
+/* Run FN.  Capture its output into the returned string, do not display it
+   to the screen.  The global BATCH_FLAG will temporarily be set to true.
+   When TERM_OUT is true the output is collected with terminal behaviour
+   (e.g. with styling).  When TERM_OUT is false raw output will be collected
+   (e.g. no styling).  */
 
-/* Chain containing all defined enable subcommands.  */
+extern void execute_fn_to_string (std::string &res,
+                                 std::function<void(void)> fn, bool term_out);
 
-extern struct cmd_list_element *enablelist;
+/* As execute_fn_to_ui_file, but run execute_command for P and FROM_TTY.  */
 
-/* Chain containing all defined disable subcommands.  */
+extern void execute_command_to_ui_file (struct ui_file *file,
+                                       const char *p, int from_tty);
 
-extern struct cmd_list_element *disablelist;
+/* As execute_fn_to_string, but run execute_command for P and FROM_TTY.  */
 
-/* Chain containing all defined delete subcommands.  */
+extern void execute_command_to_string (std::string &res, const char *p,
+                                      int from_tty, bool term_out);
 
-extern struct cmd_list_element *deletelist;
+/* As execute_command_to_string, but ignore resulting string.  */
 
-/* Chain containing all defined detach subcommands.  */
-
-extern struct cmd_list_element *detachlist;
-
-/* Chain containing all defined kill subcommands.  */
-
-extern struct cmd_list_element *killlist;
-
-/* Chain containing all defined toggle subcommands.  */
-
-extern struct cmd_list_element *togglelist;
-
-/* Chain containing all defined stop subcommands.  */
-
-extern struct cmd_list_element *stoplist;
-
-/* Chain containing all defined "enable breakpoint" subcommands.  */
-
-extern struct cmd_list_element *enablebreaklist;
-
-/* Chain containing all defined set subcommands.  */
-
-extern struct cmd_list_element *setlist;
-
-/* Chain containing all defined unset subcommands.  */
-
-extern struct cmd_list_element *unsetlist;
-
-/* Chain containing all defined show subcommands.  */
-
-extern struct cmd_list_element *showlist;
-
-/* Chain containing all defined \"set history\".  */
-
-extern struct cmd_list_element *sethistlist;
-
-/* Chain containing all defined \"show history\".  */
-
-extern struct cmd_list_element *showhistlist;
-
-/* Chain containing all defined \"unset history\".  */
-
-extern struct cmd_list_element *unsethistlist;
-
-/* Chain containing all defined maintenance subcommands.  */
-
-extern struct cmd_list_element *maintenancelist;
-
-/* Chain containing all defined "maintenance info" subcommands.  */
-
-extern struct cmd_list_element *maintenanceinfolist;
-
-/* Chain containing all defined "maintenance print" subcommands.  */
-
-extern struct cmd_list_element *maintenanceprintlist;
-
-/* Chain containing all defined "maintenance set" subcommands.  */
-
-extern struct cmd_list_element *maintenance_set_cmdlist;
-
-/* Chain containing all defined "maintenance show" subcommands.  */
-
-extern struct cmd_list_element *maintenance_show_cmdlist;
-
-extern struct cmd_list_element *setprintlist;
-
-extern struct cmd_list_element *showprintlist;
-
-extern struct cmd_list_element *setdebuglist;
-
-extern struct cmd_list_element *showdebuglist;
-
-extern struct cmd_list_element *setchecklist;
-
-extern struct cmd_list_element *showchecklist;
-
-extern struct cmd_list_element *skiplist;
-
-/* Chain containing all defined "save" subcommands.  */
-
-extern struct cmd_list_element *save_cmdlist;
-
-extern void execute_command (char *, int);
-extern char *execute_command_to_string (char *p, int from_tty);
-
-enum command_control_type execute_control_command (struct command_line *);
+extern void execute_command_to_string (const char *p,
+                                      int from_tty, bool term_out);
 
 extern void print_command_line (struct command_line *, unsigned int,
                                struct ui_file *);