]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blobdiff - gdb/cli/cli-script.h
Update copyright year range in all GDB files
[thirdparty/binutils-gdb.git] / gdb / cli / cli-script.h
index d02cb3644602ced00c408c649a3ffeb0dba364ff..518c8a80b8ae0415019e68cfc981dd7377340295 100644 (file)
@@ -1,5 +1,5 @@
 /* Header file for GDB CLI command implementation library.
-   Copyright (C) 2000-2013 Free Software Foundation, Inc.
+   Copyright (C) 2000-2018 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 CLI_SCRIPT_H 1
 
 struct ui_file;
-struct command_line;
 struct cmd_list_element;
 
+/* * Control types for commands.  */
+
+enum misc_command_type
+{
+  ok_command,
+  end_command,
+  else_command,
+  nop_command
+};
+
+enum command_control_type
+{
+  simple_control,
+  break_control,
+  continue_control,
+  while_control,
+  if_control,
+  commands_control,
+  python_control,
+  compile_control,
+  guile_control,
+  while_stepping_control,
+  invalid_control
+};
+
+/* * Structure for saved commands lines (for breakpoints, defined
+   commands, etc).  */
+
+struct command_line
+{
+  struct command_line *next;
+  char *line;
+  enum command_control_type control_type;
+  union
+    {
+      struct
+       {
+         enum compile_i_scope_types scope;
+         void *scope_data;
+       }
+      compile;
+    }
+  control_u;
+  /* * The number of elements in body_list.  */
+  int body_count;
+  /* * For composite commands, the nested lists of commands.  For
+     example, for "if" command this will contain the then branch and
+     the else branch, if that is available.  */
+  struct command_line **body_list;
+};
+
+extern void free_command_lines (struct command_line **);
+
+/* A deleter for command_line that calls free_command_lines.  */
+
+struct command_lines_deleter
+{
+  void operator() (command_line *cmd_lines) const
+  {
+    free_command_lines (&cmd_lines);
+  }
+};
+
+/* A unique pointer to a command_line.  */
+
+typedef std::unique_ptr<command_line, command_lines_deleter> command_line_up;
+
+extern command_line_up read_command_lines (char *, int, int,
+                                          void (*)(char *, void *),
+                                          void *);
+extern command_line_up read_command_lines_1 (char * (*) (void), int,
+                                            void (*)(char *, void *),
+                                            void *);
+
+
 /* Exported to cli/cli-cmds.c */
 
 extern void script_from_file (FILE *stream, const char *file);
 
-extern void show_user_1 (struct cmd_list_element *c, char *prefix,
-                        char *name, struct ui_file *stream);
+extern void show_user_1 (struct cmd_list_element *c,
+                        const char *prefix,
+                        const char *name,
+                        struct ui_file *stream);
 
 /* Exported to gdb/breakpoint.c */
 
@@ -36,20 +112,23 @@ extern enum command_control_type
 extern enum command_control_type
        execute_control_command_untraced (struct command_line *cmd);
 
-extern struct command_line *get_command_line (enum command_control_type,
-                                             char *);
+extern command_line_up get_command_line (enum command_control_type,
+                                        const char *);
 
 extern void print_command_lines (struct ui_out *,
                                 struct command_line *, unsigned int);
 
-extern struct command_line * copy_command_lines (struct command_line *cmds);
-
-extern struct cleanup *
-  make_cleanup_free_command_lines (struct command_line **arg);
+extern command_line_up copy_command_lines (struct command_line *cmds);
 
 /* Exported to gdb/infrun.c */
 
-extern void execute_user_command (struct cmd_list_element *c, char *args);
+extern void execute_user_command (struct cmd_list_element *c, const char *args);
+
+/* If we're in a user-defined command, replace any $argc/$argN
+   reference found in LINE with the arguments that were passed to the
+   command.  Otherwise, treat $argc/$argN as normal convenience
+   variables.  */
+extern std::string insert_user_defined_cmd_args (const char *line);
 
 /* Exported to top.c */