1 /* Header file for GDB CLI command implementation library. 2 Copyright (C) 2000-2023 Free Software Foundation, Inc. 3 4 This program is free software; you can redistribute it and/or modify 5 it under the terms of the GNU General Public License as published by 6 the Free Software Foundation; either version 3 of the License, or 7 (at your option) any later version. 8 9 This program is distributed in the hope that it will be useful, 10 but WITHOUT ANY WARRANTY; without even the implied warranty of 11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 GNU General Public License for more details. 13 14 You should have received a copy of the GNU General Public License 15 along with this program. If not, see <http://www.gnu.org/licenses/>. */ 16 17 #ifndef CLI_CLI_SCRIPT_H 18 #define CLI_CLI_SCRIPT_H 19 20 #include "gdbsupport/function-view.h" 21 22 struct ui_file; 23 struct cmd_list_element; 24 25 /* * Control types for commands. */ 26 27 enum misc_command_type 28 { 29 ok_command, 30 end_command, 31 else_command, 32 nop_command 33 }; 34 35 enum command_control_type 36 { 37 simple_control, 38 break_control, 39 continue_control, 40 while_control, 41 if_control, 42 commands_control, 43 python_control, 44 compile_control, 45 guile_control, 46 while_stepping_control, 47 define_control, 48 document_control, 49 invalid_control 50 }; 51 52 struct command_line; 53 54 extern void free_command_lines (struct command_line **); 55 56 /* A deleter for command_line that calls free_command_lines. */ 57 58 struct command_lines_deleter 59 { 60 void operator() (command_line *cmd_lines) const 61 { 62 free_command_lines (&cmd_lines); 63 } 64 }; 65 66 /* A reference-counted struct command_line. */ 67 typedef std::shared_ptr<command_line> counted_command_line; 68 69 /* A unique_ptr specialization for command_line. */ 70 typedef std::unique_ptr<command_line, command_lines_deleter> command_line_up; 71 72 /* * Structure for saved commands lines (for breakpoints, defined 73 commands, etc). */ 74 75 struct command_line 76 { 77 explicit command_line (command_control_type type_, char *line_ = nullptr) 78 : line (line_), 79 control_type (type_) 80 { 81 memset (&control_u, 0, sizeof (control_u)); 82 } 83 84 DISABLE_COPY_AND_ASSIGN (command_line); 85 86 struct command_line *next = nullptr; 87 char *line; 88 enum command_control_type control_type; 89 union 90 { 91 struct 92 { 93 enum compile_i_scope_types scope; 94 void *scope_data; 95 } 96 compile; 97 } 98 control_u; 99 /* * For composite commands, the nested lists of commands. For 100 example, for "if" command this will contain the then branch and 101 the else branch, if that is available. */ 102 counted_command_line body_list_0; 103 counted_command_line body_list_1; 104 105 private: 106 107 friend void free_command_lines (struct command_line **); 108 109 ~command_line () 110 { 111 xfree (line); 112 } 113 }; 114 115 /* Prototype for a function to call to get one more input line. 116 117 If the function needs to return a dynamically allocated string, it can place 118 in the passed-in buffer, and return a pointer to it. Otherwise, it can 119 simply ignore it. */ 120 121 using read_next_line_ftype = gdb::function_view<const char * (std::string &)>; 122 123 extern counted_command_line read_command_lines 124 (const char *, int, int, gdb::function_view<void (const char *)>); 125 extern counted_command_line read_command_lines_1 126 (read_next_line_ftype, int, gdb::function_view<void (const char *)>); 127 128 129 /* Exported to cli/cli-cmds.c */ 130 131 extern void script_from_file (FILE *stream, const char *file); 132 133 extern void show_user_1 (struct cmd_list_element *c, 134 const char *prefix, 135 const char *name, 136 struct ui_file *stream); 137 138 /* Execute the commands in CMDLINES. */ 139 140 extern void execute_control_commands (struct command_line *cmdlines, 141 int from_tty); 142 143 /* Run execute_control_commands for COMMANDS. Capture its output into 144 the returned string, do not display it to the screen. BATCH_FLAG 145 will be temporarily set to true. */ 146 147 extern std::string execute_control_commands_to_string 148 (struct command_line *commands, int from_tty); 149 150 /* Exported to gdb/breakpoint.c */ 151 152 extern enum command_control_type 153 execute_control_command (struct command_line *cmd, 154 int from_tty = 0); 155 156 extern enum command_control_type 157 execute_control_command_untraced (struct command_line *cmd); 158 159 extern counted_command_line get_command_line (enum command_control_type, 160 const char *); 161 162 extern void print_command_lines (struct ui_out *, 163 struct command_line *, unsigned int); 164 165 /* Exported to gdb/infrun.c */ 166 167 extern void execute_user_command (struct cmd_list_element *c, const char *args); 168 169 /* If we're in a user-defined command, replace any $argc/$argN 170 reference found in LINE with the arguments that were passed to the 171 command. Otherwise, treat $argc/$argN as normal convenience 172 variables. */ 173 extern std::string insert_user_defined_cmd_args (const char *line); 174 175 /* Exported to top.c */ 176 177 extern void print_command_trace (const char *cmd, ...) 178 ATTRIBUTE_PRINTF (1, 2); 179 180 /* Exported to event-top.c */ 181 182 extern void reset_command_nest_depth (void); 183 184 #endif /* CLI_CLI_SCRIPT_H */ 185