Commit | Line | Data |
---|---|---|
d318976c | 1 | /* GDB CLI command scripting. |
8926118c | 2 | |
b811d2c2 | 3 | Copyright (C) 1986-2020 Free Software Foundation, Inc. |
d318976c FN |
4 | |
5 | This file is part of GDB. | |
6 | ||
7 | This program is free software; you can redistribute it and/or modify | |
8 | it under the terms of the GNU General Public License as published by | |
a9762ec7 | 9 | the Free Software Foundation; either version 3 of the License, or |
d318976c FN |
10 | (at your option) any later version. |
11 | ||
12 | This program is distributed in the hope that it will be useful, | |
13 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | GNU General Public License for more details. | |
16 | ||
17 | You should have received a copy of the GNU General Public License | |
a9762ec7 | 18 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
d318976c FN |
19 | |
20 | #include "defs.h" | |
21 | #include "value.h" | |
22 | #include "language.h" /* For value_true */ | |
23 | #include <ctype.h> | |
24 | ||
d318976c | 25 | #include "ui-out.h" |
d318976c | 26 | #include "top.h" |
40c03ae8 | 27 | #include "breakpoint.h" |
8588b356 | 28 | #include "tracepoint.h" |
d318976c FN |
29 | #include "cli/cli-cmds.h" |
30 | #include "cli/cli-decode.h" | |
31 | #include "cli/cli-script.h" | |
c6ac7fc9 | 32 | #include "cli/cli-style.h" |
d318976c | 33 | |
6dddc817 | 34 | #include "extension.h" |
b4a14fd0 | 35 | #include "interps.h" |
bb2ec1b3 | 36 | #include "compile/compile.h" |
268a13a5 | 37 | #include "gdbsupport/gdb_string_view.h" |
8588b356 SM |
38 | #include "python/python.h" |
39 | #include "guile/guile.h" | |
d57a3c85 | 40 | |
df3ee9ca PA |
41 | #include <vector> |
42 | ||
ebcd3b23 | 43 | /* Prototypes for local functions. */ |
d318976c | 44 | |
d318976c | 45 | static enum command_control_type |
60b3cef2 TT |
46 | recurse_read_control_structure |
47 | (gdb::function_view<const char * ()> read_next_line_func, | |
48 | struct command_line *current_cmd, | |
49 | gdb::function_view<void (const char *)> validator); | |
d318976c | 50 | |
7a2c85f2 TT |
51 | static void do_define_command (const char *comname, int from_tty, |
52 | const counted_command_line *commands); | |
53 | ||
a33fc9ae RK |
54 | static void do_document_command (const char *comname, int from_tty, |
55 | const counted_command_line *commands); | |
56 | ||
992a7040 | 57 | static const char *read_next_line (); |
3c1179ff | 58 | |
16026cd7 | 59 | /* Level of control structure when reading. */ |
d318976c FN |
60 | static int control_level; |
61 | ||
16026cd7 AS |
62 | /* Level of control structure when executing. */ |
63 | static int command_nest_depth = 1; | |
64 | ||
65 | /* This is to prevent certain commands being printed twice. */ | |
66 | static int suppress_next_print_command_trace = 0; | |
67 | ||
8588b356 SM |
68 | /* Command element for the 'while' command. */ |
69 | static cmd_list_element *while_cmd_element = nullptr; | |
70 | ||
71 | /* Command element for the 'if' command. */ | |
72 | static cmd_list_element *if_cmd_element = nullptr; | |
73 | ||
74 | /* Command element for the 'define' command. */ | |
75 | static cmd_list_element *define_cmd_element = nullptr; | |
76 | ||
a33fc9ae RK |
77 | /* Command element for the 'document' command. */ |
78 | static cmd_list_element *document_cmd_element = nullptr; | |
79 | ||
d318976c | 80 | /* Structure for arguments to user defined functions. */ |
df3ee9ca PA |
81 | |
82 | class user_args | |
83 | { | |
84 | public: | |
85 | /* Save the command line and store the locations of arguments passed | |
86 | to the user defined function. */ | |
87 | explicit user_args (const char *line); | |
88 | ||
89 | /* Insert the stored user defined arguments into the $arg arguments | |
90 | found in LINE. */ | |
91 | std::string insert_args (const char *line) const; | |
92 | ||
93 | private: | |
94 | /* Disable copy/assignment. (Since the elements of A point inside | |
95 | COMMAND, copying would need to reconstruct the A vector in the | |
96 | new copy.) */ | |
97 | user_args (const user_args &) =delete; | |
98 | user_args &operator= (const user_args &) =delete; | |
99 | ||
100 | /* It is necessary to store a copy of the command line to ensure | |
101 | that the arguments are not overwritten before they are used. */ | |
102 | std::string m_command_line; | |
103 | ||
104 | /* The arguments. Each element points inside M_COMMAND_LINE. */ | |
8345c4a2 | 105 | std::vector<gdb::string_view> m_args; |
df3ee9ca PA |
106 | }; |
107 | ||
108 | /* The stack of arguments passed to user defined functions. We need a | |
109 | stack because user-defined functions can call other user-defined | |
110 | functions. */ | |
111 | static std::vector<std::unique_ptr<user_args>> user_args_stack; | |
112 | ||
113 | /* An RAII-base class used to push/pop args on the user args | |
114 | stack. */ | |
115 | struct scoped_user_args_level | |
116 | { | |
117 | /* Parse the command line and push the arguments in the user args | |
118 | stack. */ | |
119 | explicit scoped_user_args_level (const char *line) | |
d318976c | 120 | { |
df3ee9ca | 121 | user_args_stack.emplace_back (new user_args (line)); |
d318976c | 122 | } |
df3ee9ca PA |
123 | |
124 | /* Pop the current user arguments from the stack. */ | |
125 | ~scoped_user_args_level () | |
126 | { | |
127 | user_args_stack.pop_back (); | |
128 | } | |
129 | }; | |
d318976c FN |
130 | |
131 | \f | |
1e9c71b8 DE |
132 | /* Return non-zero if TYPE is a multi-line command (i.e., is terminated |
133 | by "end"). */ | |
134 | ||
135 | static int | |
136 | multi_line_command_p (enum command_control_type type) | |
137 | { | |
138 | switch (type) | |
139 | { | |
140 | case if_control: | |
141 | case while_control: | |
142 | case while_stepping_control: | |
143 | case commands_control: | |
bb2ec1b3 | 144 | case compile_control: |
1e9c71b8 | 145 | case python_control: |
ed3ef339 | 146 | case guile_control: |
7a2c85f2 | 147 | case define_control: |
a33fc9ae | 148 | case document_control: |
1e9c71b8 DE |
149 | return 1; |
150 | default: | |
151 | return 0; | |
152 | } | |
153 | } | |
154 | ||
d318976c FN |
155 | /* Allocate, initialize a new command line structure for one of the |
156 | control commands (if/while). */ | |
157 | ||
158 | static struct command_line * | |
604c4576 | 159 | build_command_line (enum command_control_type type, const char *args) |
d318976c | 160 | { |
7a2c85f2 TT |
161 | if (args == NULL || *args == '\0') |
162 | { | |
163 | if (type == if_control) | |
164 | error (_("if command requires an argument.")); | |
165 | else if (type == while_control) | |
166 | error (_("while command requires an argument.")); | |
167 | else if (type == define_control) | |
168 | error (_("define command requires an argument.")); | |
a33fc9ae RK |
169 | else if (type == document_control) |
170 | error (_("document command requires an argument.")); | |
7a2c85f2 | 171 | } |
c8c12293 | 172 | gdb_assert (args != NULL); |
d318976c | 173 | |
12973681 | 174 | return new struct command_line (type, xstrdup (args)); |
d318976c FN |
175 | } |
176 | ||
177 | /* Build and return a new command structure for the control commands | |
178 | such as "if" and "while". */ | |
179 | ||
12973681 | 180 | counted_command_line |
a121b7c1 | 181 | get_command_line (enum command_control_type type, const char *arg) |
d318976c | 182 | { |
d318976c | 183 | /* Allocate and build a new command line structure. */ |
12973681 TT |
184 | counted_command_line cmd (build_command_line (type, arg), |
185 | command_lines_deleter ()); | |
d318976c FN |
186 | |
187 | /* Read in the body of this command. */ | |
60b3cef2 | 188 | if (recurse_read_control_structure (read_next_line, cmd.get (), 0) |
a7bdde9e | 189 | == invalid_control) |
d318976c | 190 | { |
40c03ae8 | 191 | warning (_("Error reading in canned sequence of commands.")); |
d318976c FN |
192 | return NULL; |
193 | } | |
194 | ||
d318976c FN |
195 | return cmd; |
196 | } | |
197 | ||
198 | /* Recursively print a command (including full control structures). */ | |
8926118c | 199 | |
d318976c FN |
200 | void |
201 | print_command_lines (struct ui_out *uiout, struct command_line *cmd, | |
202 | unsigned int depth) | |
203 | { | |
204 | struct command_line *list; | |
205 | ||
206 | list = cmd; | |
207 | while (list) | |
208 | { | |
d318976c | 209 | if (depth) |
112e8700 | 210 | uiout->spaces (2 * depth); |
d318976c FN |
211 | |
212 | /* A simple command, print it and continue. */ | |
213 | if (list->control_type == simple_control) | |
214 | { | |
112e8700 SM |
215 | uiout->field_string (NULL, list->line); |
216 | uiout->text ("\n"); | |
d318976c FN |
217 | list = list->next; |
218 | continue; | |
219 | } | |
220 | ||
221 | /* loop_continue to jump to the start of a while loop, print it | |
dda83cd7 | 222 | and continue. */ |
d318976c FN |
223 | if (list->control_type == continue_control) |
224 | { | |
112e8700 SM |
225 | uiout->field_string (NULL, "loop_continue"); |
226 | uiout->text ("\n"); | |
d318976c FN |
227 | list = list->next; |
228 | continue; | |
229 | } | |
230 | ||
ebcd3b23 MS |
231 | /* loop_break to break out of a while loop, print it and |
232 | continue. */ | |
d318976c FN |
233 | if (list->control_type == break_control) |
234 | { | |
112e8700 SM |
235 | uiout->field_string (NULL, "loop_break"); |
236 | uiout->text ("\n"); | |
d318976c FN |
237 | list = list->next; |
238 | continue; | |
239 | } | |
240 | ||
ebcd3b23 MS |
241 | /* A while command. Recursively print its subcommands and |
242 | continue. */ | |
a7bdde9e VP |
243 | if (list->control_type == while_control |
244 | || list->control_type == while_stepping_control) | |
d318976c | 245 | { |
ebcd3b23 MS |
246 | /* For while-stepping, the line includes the 'while-stepping' |
247 | token. See comment in process_next_line for explanation. | |
248 | Here, take care not print 'while-stepping' twice. */ | |
a7bdde9e | 249 | if (list->control_type == while_control) |
112e8700 | 250 | uiout->field_fmt (NULL, "while %s", list->line); |
a7bdde9e | 251 | else |
112e8700 SM |
252 | uiout->field_string (NULL, list->line); |
253 | uiout->text ("\n"); | |
12973681 | 254 | print_command_lines (uiout, list->body_list_0.get (), depth + 1); |
d318976c | 255 | if (depth) |
112e8700 SM |
256 | uiout->spaces (2 * depth); |
257 | uiout->field_string (NULL, "end"); | |
258 | uiout->text ("\n"); | |
d318976c FN |
259 | list = list->next; |
260 | continue; | |
261 | } | |
262 | ||
ebcd3b23 | 263 | /* An if command. Recursively print both arms before |
30baf67b | 264 | continuing. */ |
d318976c FN |
265 | if (list->control_type == if_control) |
266 | { | |
112e8700 SM |
267 | uiout->field_fmt (NULL, "if %s", list->line); |
268 | uiout->text ("\n"); | |
ebcd3b23 | 269 | /* The true arm. */ |
12973681 | 270 | print_command_lines (uiout, list->body_list_0.get (), depth + 1); |
d318976c FN |
271 | |
272 | /* Show the false arm if it exists. */ | |
12973681 | 273 | if (list->body_list_1 != nullptr) |
d318976c FN |
274 | { |
275 | if (depth) | |
112e8700 SM |
276 | uiout->spaces (2 * depth); |
277 | uiout->field_string (NULL, "else"); | |
278 | uiout->text ("\n"); | |
12973681 | 279 | print_command_lines (uiout, list->body_list_1.get (), depth + 1); |
d318976c FN |
280 | } |
281 | ||
d318976c | 282 | if (depth) |
112e8700 SM |
283 | uiout->spaces (2 * depth); |
284 | uiout->field_string (NULL, "end"); | |
285 | uiout->text ("\n"); | |
d318976c FN |
286 | list = list->next; |
287 | continue; | |
288 | } | |
289 | ||
ebcd3b23 MS |
290 | /* A commands command. Print the breakpoint commands and |
291 | continue. */ | |
40c03ae8 EZ |
292 | if (list->control_type == commands_control) |
293 | { | |
294 | if (*(list->line)) | |
112e8700 | 295 | uiout->field_fmt (NULL, "commands %s", list->line); |
40c03ae8 | 296 | else |
112e8700 SM |
297 | uiout->field_string (NULL, "commands"); |
298 | uiout->text ("\n"); | |
12973681 | 299 | print_command_lines (uiout, list->body_list_0.get (), depth + 1); |
40c03ae8 | 300 | if (depth) |
112e8700 SM |
301 | uiout->spaces (2 * depth); |
302 | uiout->field_string (NULL, "end"); | |
303 | uiout->text ("\n"); | |
40c03ae8 EZ |
304 | list = list->next; |
305 | continue; | |
306 | } | |
307 | ||
d57a3c85 TJB |
308 | if (list->control_type == python_control) |
309 | { | |
112e8700 SM |
310 | uiout->field_string (NULL, "python"); |
311 | uiout->text ("\n"); | |
d57a3c85 | 312 | /* Don't indent python code at all. */ |
12973681 | 313 | print_command_lines (uiout, list->body_list_0.get (), 0); |
d57a3c85 | 314 | if (depth) |
112e8700 SM |
315 | uiout->spaces (2 * depth); |
316 | uiout->field_string (NULL, "end"); | |
317 | uiout->text ("\n"); | |
d57a3c85 TJB |
318 | list = list->next; |
319 | continue; | |
320 | } | |
321 | ||
bb2ec1b3 TT |
322 | if (list->control_type == compile_control) |
323 | { | |
112e8700 SM |
324 | uiout->field_string (NULL, "compile expression"); |
325 | uiout->text ("\n"); | |
12973681 | 326 | print_command_lines (uiout, list->body_list_0.get (), 0); |
bb2ec1b3 | 327 | if (depth) |
112e8700 SM |
328 | uiout->spaces (2 * depth); |
329 | uiout->field_string (NULL, "end"); | |
330 | uiout->text ("\n"); | |
bb2ec1b3 TT |
331 | list = list->next; |
332 | continue; | |
333 | } | |
334 | ||
ed3ef339 DE |
335 | if (list->control_type == guile_control) |
336 | { | |
112e8700 SM |
337 | uiout->field_string (NULL, "guile"); |
338 | uiout->text ("\n"); | |
12973681 | 339 | print_command_lines (uiout, list->body_list_0.get (), depth + 1); |
ed3ef339 | 340 | if (depth) |
112e8700 SM |
341 | uiout->spaces (2 * depth); |
342 | uiout->field_string (NULL, "end"); | |
343 | uiout->text ("\n"); | |
ed3ef339 DE |
344 | list = list->next; |
345 | continue; | |
346 | } | |
347 | ||
ebcd3b23 | 348 | /* Ignore illegal command type and try next. */ |
d318976c FN |
349 | list = list->next; |
350 | } /* while (list) */ | |
351 | } | |
d318976c | 352 | |
5913bcb0 AC |
353 | /* Handle pre-post hooks. */ |
354 | ||
a9921622 | 355 | class scoped_restore_hook_in |
5913bcb0 | 356 | { |
a9921622 | 357 | public: |
cdb27c12 | 358 | |
a9921622 TT |
359 | scoped_restore_hook_in (struct cmd_list_element *c) |
360 | : m_cmd (c) | |
361 | { | |
362 | } | |
363 | ||
364 | ~scoped_restore_hook_in () | |
365 | { | |
366 | m_cmd->hook_in = 0; | |
367 | } | |
368 | ||
369 | scoped_restore_hook_in (const scoped_restore_hook_in &) = delete; | |
370 | scoped_restore_hook_in &operator= (const scoped_restore_hook_in &) = delete; | |
371 | ||
372 | private: | |
373 | ||
374 | struct cmd_list_element *m_cmd; | |
375 | }; | |
5913bcb0 AC |
376 | |
377 | void | |
378 | execute_cmd_pre_hook (struct cmd_list_element *c) | |
379 | { | |
380 | if ((c->hook_pre) && (!c->hook_in)) | |
381 | { | |
a9921622 | 382 | scoped_restore_hook_in restore_hook (c); |
ebcd3b23 | 383 | c->hook_in = 1; /* Prevent recursive hooking. */ |
95a6b0a1 | 384 | execute_user_command (c->hook_pre, nullptr); |
5913bcb0 AC |
385 | } |
386 | } | |
387 | ||
388 | void | |
389 | execute_cmd_post_hook (struct cmd_list_element *c) | |
390 | { | |
391 | if ((c->hook_post) && (!c->hook_in)) | |
392 | { | |
a9921622 | 393 | scoped_restore_hook_in restore_hook (c); |
ebcd3b23 | 394 | c->hook_in = 1; /* Prevent recursive hooking. */ |
95a6b0a1 | 395 | execute_user_command (c->hook_post, nullptr); |
5913bcb0 AC |
396 | } |
397 | } | |
398 | ||
56bcdbea TT |
399 | /* See cli-script.h. */ |
400 | ||
401 | void | |
402 | execute_control_commands (struct command_line *cmdlines, int from_tty) | |
403 | { | |
56bcdbea TT |
404 | scoped_restore save_async = make_scoped_restore (¤t_ui->async, 0); |
405 | scoped_restore save_nesting | |
406 | = make_scoped_restore (&command_nest_depth, command_nest_depth + 1); | |
407 | ||
408 | while (cmdlines) | |
409 | { | |
410 | enum command_control_type ret = execute_control_command (cmdlines, | |
411 | from_tty); | |
412 | if (ret != simple_control && ret != break_control) | |
413 | { | |
414 | warning (_("Error executing canned sequence of commands.")); | |
415 | break; | |
416 | } | |
417 | cmdlines = cmdlines->next; | |
418 | } | |
419 | } | |
420 | ||
421 | /* See cli-script.h. */ | |
422 | ||
423 | std::string | |
424 | execute_control_commands_to_string (struct command_line *commands, | |
425 | int from_tty) | |
426 | { | |
427 | /* GDB_STDOUT should be better already restored during these | |
428 | restoration callbacks. */ | |
429 | set_batch_flag_and_restore_page_info save_page_info; | |
430 | ||
431 | string_file str_file; | |
432 | ||
433 | { | |
434 | current_uiout->redirect (&str_file); | |
435 | ui_out_redirect_pop redirect_popper (current_uiout); | |
436 | ||
437 | scoped_restore save_stdout | |
438 | = make_scoped_restore (&gdb_stdout, &str_file); | |
439 | scoped_restore save_stderr | |
440 | = make_scoped_restore (&gdb_stderr, &str_file); | |
441 | scoped_restore save_stdlog | |
442 | = make_scoped_restore (&gdb_stdlog, &str_file); | |
443 | scoped_restore save_stdtarg | |
444 | = make_scoped_restore (&gdb_stdtarg, &str_file); | |
445 | scoped_restore save_stdtargerr | |
446 | = make_scoped_restore (&gdb_stdtargerr, &str_file); | |
447 | ||
448 | execute_control_commands (commands, from_tty); | |
449 | } | |
450 | ||
451 | return std::move (str_file.string ()); | |
452 | } | |
453 | ||
d318976c | 454 | void |
95a6b0a1 | 455 | execute_user_command (struct cmd_list_element *c, const char *args) |
d318976c | 456 | { |
12973681 | 457 | counted_command_line cmdlines_copy; |
d318976c | 458 | |
12973681 TT |
459 | /* Ensure that the user commands can't be deleted while they are |
460 | executing. */ | |
461 | cmdlines_copy = c->user_commands; | |
462 | if (cmdlines_copy == 0) | |
d318976c FN |
463 | /* Null command */ |
464 | return; | |
12973681 | 465 | struct command_line *cmdlines = cmdlines_copy.get (); |
d318976c | 466 | |
df3ee9ca | 467 | scoped_user_args_level push_user_args (args); |
5fe41fbf | 468 | |
ac991630 | 469 | if (user_args_stack.size () > max_user_call_depth) |
8a3fe4f8 | 470 | error (_("Max user call depth exceeded -- command aborted.")); |
20f01a46 | 471 | |
8f9929bb GR |
472 | /* Set the instream to nullptr, indicating execution of a |
473 | user-defined function. */ | |
474 | scoped_restore restore_instream | |
475 | = make_scoped_restore (¤t_ui->instream, nullptr); | |
476 | ||
56bcdbea | 477 | execute_control_commands (cmdlines, 0); |
d318976c FN |
478 | } |
479 | ||
ebcd3b23 MS |
480 | /* This function is called every time GDB prints a prompt. It ensures |
481 | that errors and the like do not confuse the command tracing. */ | |
16026cd7 AS |
482 | |
483 | void | |
484 | reset_command_nest_depth (void) | |
485 | { | |
486 | command_nest_depth = 1; | |
487 | ||
488 | /* Just in case. */ | |
489 | suppress_next_print_command_trace = 0; | |
490 | } | |
491 | ||
492 | /* Print the command, prefixed with '+' to represent the call depth. | |
493 | This is slightly complicated because this function may be called | |
494 | from execute_command and execute_control_command. Unfortunately | |
495 | execute_command also prints the top level control commands. | |
496 | In these cases execute_command will call execute_control_command | |
497 | via while_command or if_command. Inner levels of 'if' and 'while' | |
498 | are dealt with directly. Therefore we can use these functions | |
499 | to determine whether the command has been printed already or not. */ | |
1263a9d5 | 500 | ATTRIBUTE_PRINTF (1, 2) |
16026cd7 | 501 | void |
1263a9d5 | 502 | print_command_trace (const char *fmt, ...) |
16026cd7 AS |
503 | { |
504 | int i; | |
505 | ||
506 | if (suppress_next_print_command_trace) | |
507 | { | |
508 | suppress_next_print_command_trace = 0; | |
509 | return; | |
510 | } | |
511 | ||
512 | if (!source_verbose && !trace_commands) | |
513 | return; | |
514 | ||
515 | for (i=0; i < command_nest_depth; i++) | |
516 | printf_filtered ("+"); | |
517 | ||
1263a9d5 TT |
518 | va_list args; |
519 | ||
520 | va_start (args, fmt); | |
521 | vprintf_filtered (fmt, args); | |
522 | va_end (args); | |
523 | puts_filtered ("\n"); | |
16026cd7 AS |
524 | } |
525 | ||
3a87ae65 SM |
526 | /* Helper for execute_control_command. */ |
527 | ||
528 | static enum command_control_type | |
56bcdbea | 529 | execute_control_command_1 (struct command_line *cmd, int from_tty) |
d318976c | 530 | { |
d318976c | 531 | struct command_line *current; |
f976f6d4 AC |
532 | struct value *val; |
533 | struct value *val_mark; | |
d318976c FN |
534 | int loop; |
535 | enum command_control_type ret; | |
d318976c | 536 | |
4d2acc65 AC |
537 | /* Start by assuming failure, if a problem is detected, the code |
538 | below will simply "break" out of the switch. */ | |
539 | ret = invalid_control; | |
540 | ||
d318976c FN |
541 | switch (cmd->control_type) |
542 | { | |
543 | case simple_control: | |
b0646401 PA |
544 | { |
545 | /* A simple command, execute it and return. */ | |
01770bbd | 546 | std::string new_line = insert_user_defined_cmd_args (cmd->line); |
56bcdbea | 547 | execute_command (new_line.c_str (), from_tty); |
b0646401 PA |
548 | ret = cmd->control_type; |
549 | break; | |
550 | } | |
d318976c FN |
551 | |
552 | case continue_control: | |
16026cd7 AS |
553 | print_command_trace ("loop_continue"); |
554 | ||
555 | /* Return for "continue", and "break" so we can either | |
dda83cd7 | 556 | continue the loop at the top, or break out. */ |
16026cd7 AS |
557 | ret = cmd->control_type; |
558 | break; | |
559 | ||
d318976c | 560 | case break_control: |
16026cd7 AS |
561 | print_command_trace ("loop_break"); |
562 | ||
d318976c | 563 | /* Return for "continue", and "break" so we can either |
dda83cd7 | 564 | continue the loop at the top, or break out. */ |
d318976c FN |
565 | ret = cmd->control_type; |
566 | break; | |
567 | ||
568 | case while_control: | |
569 | { | |
1263a9d5 | 570 | print_command_trace ("while %s", cmd->line); |
16026cd7 | 571 | |
d318976c | 572 | /* Parse the loop control expression for the while statement. */ |
01770bbd | 573 | std::string new_line = insert_user_defined_cmd_args (cmd->line); |
4d01a485 | 574 | expression_up expr = parse_expression (new_line.c_str ()); |
d318976c FN |
575 | |
576 | ret = simple_control; | |
577 | loop = 1; | |
578 | ||
579 | /* Keep iterating so long as the expression is true. */ | |
580 | while (loop == 1) | |
581 | { | |
582 | int cond_result; | |
583 | ||
584 | QUIT; | |
585 | ||
586 | /* Evaluate the expression. */ | |
587 | val_mark = value_mark (); | |
4d01a485 | 588 | val = evaluate_expression (expr.get ()); |
d318976c FN |
589 | cond_result = value_true (val); |
590 | value_free_to_mark (val_mark); | |
591 | ||
592 | /* If the value is false, then break out of the loop. */ | |
593 | if (!cond_result) | |
594 | break; | |
595 | ||
596 | /* Execute the body of the while statement. */ | |
12973681 | 597 | current = cmd->body_list_0.get (); |
d318976c FN |
598 | while (current) |
599 | { | |
b51b225e TT |
600 | scoped_restore save_nesting |
601 | = make_scoped_restore (&command_nest_depth, command_nest_depth + 1); | |
56bcdbea | 602 | ret = execute_control_command_1 (current, from_tty); |
d318976c FN |
603 | |
604 | /* If we got an error, or a "break" command, then stop | |
605 | looping. */ | |
606 | if (ret == invalid_control || ret == break_control) | |
607 | { | |
608 | loop = 0; | |
609 | break; | |
610 | } | |
611 | ||
612 | /* If we got a "continue" command, then restart the loop | |
613 | at this point. */ | |
614 | if (ret == continue_control) | |
615 | break; | |
616 | ||
617 | /* Get the next statement. */ | |
618 | current = current->next; | |
619 | } | |
620 | } | |
621 | ||
622 | /* Reset RET so that we don't recurse the break all the way down. */ | |
623 | if (ret == break_control) | |
624 | ret = simple_control; | |
625 | ||
626 | break; | |
627 | } | |
628 | ||
629 | case if_control: | |
630 | { | |
1263a9d5 | 631 | print_command_trace ("if %s", cmd->line); |
16026cd7 | 632 | |
d318976c | 633 | /* Parse the conditional for the if statement. */ |
01770bbd | 634 | std::string new_line = insert_user_defined_cmd_args (cmd->line); |
4d01a485 | 635 | expression_up expr = parse_expression (new_line.c_str ()); |
d318976c FN |
636 | |
637 | current = NULL; | |
638 | ret = simple_control; | |
639 | ||
640 | /* Evaluate the conditional. */ | |
641 | val_mark = value_mark (); | |
4d01a485 | 642 | val = evaluate_expression (expr.get ()); |
d318976c | 643 | |
ebcd3b23 MS |
644 | /* Choose which arm to take commands from based on the value |
645 | of the conditional expression. */ | |
d318976c | 646 | if (value_true (val)) |
12973681 TT |
647 | current = cmd->body_list_0.get (); |
648 | else if (cmd->body_list_1 != nullptr) | |
649 | current = cmd->body_list_1.get (); | |
d318976c FN |
650 | value_free_to_mark (val_mark); |
651 | ||
652 | /* Execute commands in the given arm. */ | |
653 | while (current) | |
654 | { | |
b51b225e TT |
655 | scoped_restore save_nesting |
656 | = make_scoped_restore (&command_nest_depth, command_nest_depth + 1); | |
56bcdbea | 657 | ret = execute_control_command_1 (current, from_tty); |
d318976c FN |
658 | |
659 | /* If we got an error, get out. */ | |
660 | if (ret != simple_control) | |
661 | break; | |
662 | ||
663 | /* Get the next statement in the body. */ | |
664 | current = current->next; | |
665 | } | |
666 | ||
667 | break; | |
668 | } | |
1e9c71b8 | 669 | |
40c03ae8 EZ |
670 | case commands_control: |
671 | { | |
ebcd3b23 MS |
672 | /* Breakpoint commands list, record the commands in the |
673 | breakpoint's command list and return. */ | |
01770bbd | 674 | std::string new_line = insert_user_defined_cmd_args (cmd->line); |
b0646401 | 675 | ret = commands_from_control_command (new_line.c_str (), cmd); |
40c03ae8 EZ |
676 | break; |
677 | } | |
1e9c71b8 | 678 | |
bb2ec1b3 | 679 | case compile_control: |
5c65b58a JK |
680 | eval_compile_command (cmd, NULL, cmd->control_u.compile.scope, |
681 | cmd->control_u.compile.scope_data); | |
bb2ec1b3 TT |
682 | ret = simple_control; |
683 | break; | |
684 | ||
7a2c85f2 TT |
685 | case define_control: |
686 | print_command_trace ("define %s", cmd->line); | |
687 | do_define_command (cmd->line, 0, &cmd->body_list_0); | |
688 | ret = simple_control; | |
689 | break; | |
690 | ||
a33fc9ae RK |
691 | case document_control: |
692 | print_command_trace ("document %s", cmd->line); | |
693 | do_document_command (cmd->line, 0, &cmd->body_list_0); | |
694 | ret = simple_control; | |
695 | break; | |
696 | ||
d57a3c85 | 697 | case python_control: |
ed3ef339 | 698 | case guile_control: |
d57a3c85 | 699 | { |
6dddc817 | 700 | eval_ext_lang_from_control_command (cmd); |
d57a3c85 TJB |
701 | ret = simple_control; |
702 | break; | |
703 | } | |
d318976c FN |
704 | |
705 | default: | |
40c03ae8 | 706 | warning (_("Invalid control type in canned commands structure.")); |
4d2acc65 | 707 | break; |
d318976c FN |
708 | } |
709 | ||
d318976c FN |
710 | return ret; |
711 | } | |
712 | ||
3a87ae65 | 713 | enum command_control_type |
56bcdbea | 714 | execute_control_command (struct command_line *cmd, int from_tty) |
3a87ae65 | 715 | { |
65d1cd5f TV |
716 | if (!current_uiout->is_mi_like_p ()) |
717 | return execute_control_command_1 (cmd, from_tty); | |
718 | ||
3a87ae65 SM |
719 | /* Make sure we use the console uiout. It's possible that we are executing |
720 | breakpoint commands while running the MI interpreter. */ | |
721 | interp *console = interp_lookup (current_ui, INTERP_CONSOLE); | |
722 | scoped_restore save_uiout | |
29f94340 | 723 | = make_scoped_restore (¤t_uiout, console->interp_ui_out ()); |
3a87ae65 | 724 | |
56bcdbea | 725 | return execute_control_command_1 (cmd, from_tty); |
3a87ae65 SM |
726 | } |
727 | ||
d57a3c85 | 728 | /* Like execute_control_command, but first set |
ebcd3b23 | 729 | suppress_next_print_command_trace. */ |
d57a3c85 TJB |
730 | |
731 | enum command_control_type | |
732 | execute_control_command_untraced (struct command_line *cmd) | |
733 | { | |
734 | suppress_next_print_command_trace = 1; | |
735 | return execute_control_command (cmd); | |
736 | } | |
737 | ||
738 | ||
d318976c FN |
739 | /* "while" command support. Executes a body of statements while the |
740 | loop condition is nonzero. */ | |
741 | ||
2370e853 | 742 | static void |
0b39b52e | 743 | while_command (const char *arg, int from_tty) |
d318976c | 744 | { |
d318976c | 745 | control_level = 1; |
12973681 | 746 | counted_command_line command = get_command_line (while_control, arg); |
d318976c FN |
747 | |
748 | if (command == NULL) | |
749 | return; | |
750 | ||
b7b633e9 | 751 | scoped_restore save_async = make_scoped_restore (¤t_ui->async, 0); |
b4a14fd0 | 752 | |
93921405 | 753 | execute_control_command_untraced (command.get ()); |
d318976c FN |
754 | } |
755 | ||
756 | /* "if" command support. Execute either the true or false arm depending | |
757 | on the value of the if conditional. */ | |
758 | ||
2370e853 | 759 | static void |
0b39b52e | 760 | if_command (const char *arg, int from_tty) |
d318976c | 761 | { |
d318976c | 762 | control_level = 1; |
12973681 | 763 | counted_command_line command = get_command_line (if_control, arg); |
d318976c FN |
764 | |
765 | if (command == NULL) | |
766 | return; | |
767 | ||
b7b633e9 | 768 | scoped_restore save_async = make_scoped_restore (¤t_ui->async, 0); |
b4a14fd0 | 769 | |
93921405 | 770 | execute_control_command_untraced (command.get ()); |
d318976c FN |
771 | } |
772 | ||
df3ee9ca PA |
773 | /* Bind the incoming arguments for a user defined command to $arg0, |
774 | $arg1 ... $argN. */ | |
d318976c | 775 | |
df3ee9ca | 776 | user_args::user_args (const char *command_line) |
d318976c | 777 | { |
df3ee9ca | 778 | const char *p; |
d318976c | 779 | |
df3ee9ca PA |
780 | if (command_line == NULL) |
781 | return; | |
d318976c | 782 | |
df3ee9ca PA |
783 | m_command_line = command_line; |
784 | p = m_command_line.c_str (); | |
e28493f2 | 785 | |
d318976c FN |
786 | while (*p) |
787 | { | |
df3ee9ca | 788 | const char *start_arg; |
d318976c FN |
789 | int squote = 0; |
790 | int dquote = 0; | |
791 | int bsquote = 0; | |
792 | ||
d318976c FN |
793 | /* Strip whitespace. */ |
794 | while (*p == ' ' || *p == '\t') | |
795 | p++; | |
796 | ||
797 | /* P now points to an argument. */ | |
798 | start_arg = p; | |
d318976c FN |
799 | |
800 | /* Get to the end of this argument. */ | |
801 | while (*p) | |
802 | { | |
803 | if (((*p == ' ' || *p == '\t')) && !squote && !dquote && !bsquote) | |
804 | break; | |
805 | else | |
806 | { | |
807 | if (bsquote) | |
808 | bsquote = 0; | |
809 | else if (*p == '\\') | |
810 | bsquote = 1; | |
811 | else if (squote) | |
812 | { | |
813 | if (*p == '\'') | |
814 | squote = 0; | |
815 | } | |
816 | else if (dquote) | |
817 | { | |
818 | if (*p == '"') | |
819 | dquote = 0; | |
820 | } | |
821 | else | |
822 | { | |
823 | if (*p == '\'') | |
824 | squote = 1; | |
825 | else if (*p == '"') | |
826 | dquote = 1; | |
827 | } | |
828 | p++; | |
829 | } | |
830 | } | |
831 | ||
df3ee9ca | 832 | m_args.emplace_back (start_arg, p - start_arg); |
d318976c | 833 | } |
d318976c FN |
834 | } |
835 | ||
ebcd3b23 MS |
836 | /* Given character string P, return a point to the first argument |
837 | ($arg), or NULL if P contains no arguments. */ | |
d318976c | 838 | |
b0646401 PA |
839 | static const char * |
840 | locate_arg (const char *p) | |
d318976c FN |
841 | { |
842 | while ((p = strchr (p, '$'))) | |
843 | { | |
61012eef | 844 | if (startswith (p, "$arg") |
c03c782f | 845 | && (isdigit (p[4]) || p[4] == 'c')) |
d318976c FN |
846 | return p; |
847 | p++; | |
848 | } | |
849 | return NULL; | |
850 | } | |
851 | ||
01770bbd | 852 | /* See cli-script.h. */ |
d318976c | 853 | |
01770bbd PA |
854 | std::string |
855 | insert_user_defined_cmd_args (const char *line) | |
d318976c | 856 | { |
01770bbd | 857 | /* If we are not in a user-defined command, treat $argc, $arg0, et |
61d9b92f | 858 | cetera as normal convenience variables. */ |
df3ee9ca | 859 | if (user_args_stack.empty ()) |
b0646401 | 860 | return line; |
61d9b92f | 861 | |
df3ee9ca PA |
862 | const std::unique_ptr<user_args> &args = user_args_stack.back (); |
863 | return args->insert_args (line); | |
864 | } | |
865 | ||
866 | /* Insert the user defined arguments stored in user_args into the $arg | |
867 | arguments found in line. */ | |
868 | ||
869 | std::string | |
870 | user_args::insert_args (const char *line) const | |
871 | { | |
b0646401 PA |
872 | std::string new_line; |
873 | const char *p; | |
d318976c FN |
874 | |
875 | while ((p = locate_arg (line))) | |
876 | { | |
b0646401 | 877 | new_line.append (line, p - line); |
d318976c | 878 | |
c03c782f AS |
879 | if (p[4] == 'c') |
880 | { | |
df3ee9ca PA |
881 | new_line += std::to_string (m_args.size ()); |
882 | line = p + 5; | |
c03c782f AS |
883 | } |
884 | else | |
d318976c | 885 | { |
df3ee9ca PA |
886 | char *tmp; |
887 | unsigned long i; | |
888 | ||
889 | errno = 0; | |
890 | i = strtoul (p + 4, &tmp, 10); | |
891 | if ((i == 0 && tmp == p + 4) || errno != 0) | |
892 | line = p + 4; | |
893 | else if (i >= m_args.size ()) | |
894 | error (_("Missing argument %ld in user function."), i); | |
895 | else | |
896 | { | |
8345c4a2 | 897 | new_line.append (m_args[i].data (), m_args[i].length ()); |
df3ee9ca PA |
898 | line = tmp; |
899 | } | |
d318976c | 900 | } |
d318976c FN |
901 | } |
902 | /* Don't forget the tail. */ | |
b0646401 | 903 | new_line.append (line); |
d318976c | 904 | |
b0646401 | 905 | return new_line; |
d318976c FN |
906 | } |
907 | ||
908 | \f | |
2181a6c6 | 909 | /* Read next line from stdin. Passed to read_command_line_1 and |
3c1179ff | 910 | recurse_read_control_structure whenever we need to read commands |
2181a6c6 | 911 | from stdin. */ |
d318976c | 912 | |
992a7040 TT |
913 | static const char * |
914 | read_next_line () | |
d318976c | 915 | { |
f38d3ad1 | 916 | struct ui *ui = current_ui; |
3c1179ff | 917 | char *prompt_ptr, control_prompt[256]; |
d318976c | 918 | int i = 0; |
268a799a | 919 | int from_tty = ui->instream == ui->stdin_stream; |
d318976c FN |
920 | |
921 | if (control_level >= 254) | |
8a3fe4f8 | 922 | error (_("Control nesting too deep!")); |
d318976c FN |
923 | |
924 | /* Set a prompt based on the nesting of the control commands. */ | |
268a799a | 925 | if (from_tty |
f38d3ad1 | 926 | || (ui->instream == 0 && deprecated_readline_hook != NULL)) |
d318976c FN |
927 | { |
928 | for (i = 0; i < control_level; i++) | |
929 | control_prompt[i] = ' '; | |
930 | control_prompt[i] = '>'; | |
931 | control_prompt[i + 1] = '\0'; | |
932 | prompt_ptr = (char *) &control_prompt[0]; | |
933 | } | |
934 | else | |
935 | prompt_ptr = NULL; | |
936 | ||
89fbedf3 | 937 | return command_line_input (prompt_ptr, "commands"); |
3c1179ff VP |
938 | } |
939 | ||
604c4576 JG |
940 | /* Given an input line P, skip the command and return a pointer to the |
941 | first argument. */ | |
942 | ||
943 | static const char * | |
944 | line_first_arg (const char *p) | |
945 | { | |
946 | const char *first_arg = p + find_command_name_length (p); | |
947 | ||
f1735a53 | 948 | return skip_spaces (first_arg); |
604c4576 JG |
949 | } |
950 | ||
ebcd3b23 MS |
951 | /* Process one input line. If the command is an "end", return such an |
952 | indication to the caller. If PARSE_COMMANDS is true, strip leading | |
953 | whitespace (trailing whitespace is always stripped) in the line, | |
954 | attempt to recognize GDB control commands, and also return an | |
955 | indication if the command is an "else" or a nop. | |
956 | ||
3c1179ff VP |
957 | Otherwise, only "end" is recognized. */ |
958 | ||
959 | static enum misc_command_type | |
60b3cef2 TT |
960 | process_next_line (const char *p, struct command_line **command, |
961 | int parse_commands, | |
962 | gdb::function_view<void (const char *)> validator) | |
963 | ||
3c1179ff | 964 | { |
60b3cef2 TT |
965 | const char *p_end; |
966 | const char *p_start; | |
3c1179ff | 967 | int not_handled = 0; |
d318976c FN |
968 | |
969 | /* Not sure what to do here. */ | |
970 | if (p == NULL) | |
971 | return end_command; | |
972 | ||
311a4e6b | 973 | /* Strip trailing whitespace. */ |
50cb2941 JK |
974 | p_end = p + strlen (p); |
975 | while (p_end > p && (p_end[-1] == ' ' || p_end[-1] == '\t')) | |
976 | p_end--; | |
d318976c | 977 | |
50cb2941 | 978 | p_start = p; |
3630a92d | 979 | /* Strip leading whitespace. */ |
50cb2941 JK |
980 | while (p_start < p_end && (*p_start == ' ' || *p_start == '\t')) |
981 | p_start++; | |
d318976c | 982 | |
ebcd3b23 | 983 | /* 'end' is always recognized, regardless of parse_commands value. |
3630a92d | 984 | We also permit whitespace before end and after. */ |
61012eef | 985 | if (p_end - p_start == 3 && startswith (p_start, "end")) |
3630a92d | 986 | return end_command; |
604c4576 | 987 | |
311a4e6b | 988 | if (parse_commands) |
d318976c | 989 | { |
604c4576 JG |
990 | /* Resolve command abbreviations (e.g. 'ws' for 'while-stepping'). */ |
991 | const char *cmd_name = p; | |
992 | struct cmd_list_element *cmd | |
cf00cd6f | 993 | = lookup_cmd_1 (&cmd_name, cmdlist, NULL, NULL, 1); |
f1735a53 | 994 | cmd_name = skip_spaces (cmd_name); |
dc4bde35 | 995 | bool inline_cmd = *cmd_name != '\0'; |
604c4576 | 996 | |
ebcd3b23 | 997 | /* If commands are parsed, we skip initial spaces. Otherwise, |
3630a92d VP |
998 | which is the case for Python commands and documentation |
999 | (see the 'document' command), spaces are preserved. */ | |
50cb2941 | 1000 | p = p_start; |
3630a92d | 1001 | |
311a4e6b | 1002 | /* Blanks and comments don't really do anything, but we need to |
ebcd3b23 MS |
1003 | distinguish them from else, end and other commands which can |
1004 | be executed. */ | |
50cb2941 | 1005 | if (p_end == p || p[0] == '#') |
311a4e6b TJB |
1006 | return nop_command; |
1007 | ||
1008 | /* Is the else clause of an if control structure? */ | |
61012eef | 1009 | if (p_end - p == 4 && startswith (p, "else")) |
311a4e6b TJB |
1010 | return else_command; |
1011 | ||
ebcd3b23 MS |
1012 | /* Check for while, if, break, continue, etc and build a new |
1013 | command line structure for them. */ | |
8588b356 | 1014 | if (cmd == while_stepping_cmd_element) |
a7bdde9e VP |
1015 | { |
1016 | /* Because validate_actionline and encode_action lookup | |
1017 | command's line as command, we need the line to | |
1018 | include 'while-stepping'. | |
1019 | ||
1020 | For 'ws' alias, the command will have 'ws', not expanded | |
ebcd3b23 | 1021 | to 'while-stepping'. This is intentional -- we don't |
a7bdde9e | 1022 | really want frontend to send a command list with 'ws', |
ebcd3b23 MS |
1023 | and next break-info returning command line with |
1024 | 'while-stepping'. This should work, but might cause the | |
1025 | breakpoint to be marked as changed while it's actually | |
1026 | not. */ | |
a7bdde9e VP |
1027 | *command = build_command_line (while_stepping_control, p); |
1028 | } | |
8588b356 SM |
1029 | else if (cmd == while_cmd_element) |
1030 | *command = build_command_line (while_control, line_first_arg (p)); | |
1031 | else if (cmd == if_cmd_element) | |
1032 | *command = build_command_line (if_control, line_first_arg (p)); | |
1033 | else if (cmd == commands_cmd_element) | |
1034 | *command = build_command_line (commands_control, line_first_arg (p)); | |
1035 | else if (cmd == define_cmd_element) | |
7a2c85f2 | 1036 | *command = build_command_line (define_control, line_first_arg (p)); |
a33fc9ae RK |
1037 | else if (cmd == document_cmd_element) |
1038 | *command = build_command_line (document_control, line_first_arg (p)); | |
8588b356 | 1039 | else if (cmd == python_cmd_element && !inline_cmd) |
311a4e6b TJB |
1040 | { |
1041 | /* Note that we ignore the inline "python command" form | |
1042 | here. */ | |
1043 | *command = build_command_line (python_control, ""); | |
1044 | } | |
8588b356 | 1045 | else if (cmd == compile_cmd_element && !inline_cmd) |
bb2ec1b3 TT |
1046 | { |
1047 | /* Note that we ignore the inline "compile command" form | |
1048 | here. */ | |
1049 | *command = build_command_line (compile_control, ""); | |
1050 | (*command)->control_u.compile.scope = COMPILE_I_INVALID_SCOPE; | |
1051 | } | |
8588b356 | 1052 | else if (cmd == guile_cmd_element && !inline_cmd) |
ed3ef339 DE |
1053 | { |
1054 | /* Note that we ignore the inline "guile command" form here. */ | |
1055 | *command = build_command_line (guile_control, ""); | |
1056 | } | |
61012eef | 1057 | else if (p_end - p == 10 && startswith (p, "loop_break")) |
12973681 | 1058 | *command = new struct command_line (break_control); |
61012eef | 1059 | else if (p_end - p == 13 && startswith (p, "loop_continue")) |
12973681 | 1060 | *command = new struct command_line (continue_control); |
311a4e6b TJB |
1061 | else |
1062 | not_handled = 1; | |
d318976c | 1063 | } |
311a4e6b TJB |
1064 | |
1065 | if (!parse_commands || not_handled) | |
d318976c FN |
1066 | { |
1067 | /* A normal command. */ | |
12973681 TT |
1068 | *command = new struct command_line (simple_control, |
1069 | savestring (p, p_end - p)); | |
d318976c FN |
1070 | } |
1071 | ||
a7bdde9e VP |
1072 | if (validator) |
1073 | { | |
a70b8144 | 1074 | try |
a7bdde9e | 1075 | { |
60b3cef2 | 1076 | validator ((*command)->line); |
a7bdde9e | 1077 | } |
230d2906 | 1078 | catch (const gdb_exception &ex) |
a7bdde9e | 1079 | { |
12973681 | 1080 | free_command_lines (command); |
eedc3f4f | 1081 | throw; |
a7bdde9e VP |
1082 | } |
1083 | } | |
1084 | ||
d318976c FN |
1085 | /* Nothing special. */ |
1086 | return ok_command; | |
1087 | } | |
1088 | ||
ebcd3b23 MS |
1089 | /* Recursively read in the control structures and create a |
1090 | command_line structure from them. Use read_next_line_func to | |
1091 | obtain lines of the command. */ | |
d318976c FN |
1092 | |
1093 | static enum command_control_type | |
60b3cef2 | 1094 | recurse_read_control_structure (gdb::function_view<const char * ()> read_next_line_func, |
a7bdde9e | 1095 | struct command_line *current_cmd, |
60b3cef2 | 1096 | gdb::function_view<void (const char *)> validator) |
d318976c | 1097 | { |
d318976c FN |
1098 | enum misc_command_type val; |
1099 | enum command_control_type ret; | |
8d49165d | 1100 | struct command_line *child_tail, *next; |
12973681 | 1101 | counted_command_line *current_body = ¤t_cmd->body_list_0; |
d318976c FN |
1102 | |
1103 | child_tail = NULL; | |
d318976c FN |
1104 | |
1105 | /* Sanity checks. */ | |
1106 | if (current_cmd->control_type == simple_control) | |
8a3fe4f8 | 1107 | error (_("Recursed on a simple control type.")); |
d318976c | 1108 | |
d318976c FN |
1109 | /* Read lines from the input stream and build control structures. */ |
1110 | while (1) | |
1111 | { | |
1112 | dont_repeat (); | |
1113 | ||
1114 | next = NULL; | |
3c1179ff | 1115 | val = process_next_line (read_next_line_func (), &next, |
ed3ef339 | 1116 | current_cmd->control_type != python_control |
bb2ec1b3 TT |
1117 | && current_cmd->control_type != guile_control |
1118 | && current_cmd->control_type != compile_control, | |
60b3cef2 | 1119 | validator); |
d318976c FN |
1120 | |
1121 | /* Just skip blanks and comments. */ | |
1122 | if (val == nop_command) | |
1123 | continue; | |
1124 | ||
1125 | if (val == end_command) | |
1126 | { | |
1e9c71b8 | 1127 | if (multi_line_command_p (current_cmd->control_type)) |
d318976c | 1128 | { |
40c03ae8 | 1129 | /* Success reading an entire canned sequence of commands. */ |
d318976c FN |
1130 | ret = simple_control; |
1131 | break; | |
1132 | } | |
1133 | else | |
1134 | { | |
1135 | ret = invalid_control; | |
1136 | break; | |
1137 | } | |
1138 | } | |
1139 | ||
1140 | /* Not the end of a control structure. */ | |
1141 | if (val == else_command) | |
1142 | { | |
1143 | if (current_cmd->control_type == if_control | |
12973681 | 1144 | && current_body == ¤t_cmd->body_list_0) |
d318976c | 1145 | { |
12973681 | 1146 | current_body = ¤t_cmd->body_list_1; |
d318976c FN |
1147 | child_tail = NULL; |
1148 | continue; | |
1149 | } | |
1150 | else | |
1151 | { | |
1152 | ret = invalid_control; | |
1153 | break; | |
1154 | } | |
1155 | } | |
1156 | ||
1157 | if (child_tail) | |
1158 | { | |
1159 | child_tail->next = next; | |
1160 | } | |
1161 | else | |
12973681 | 1162 | *current_body = counted_command_line (next, command_lines_deleter ()); |
d318976c FN |
1163 | |
1164 | child_tail = next; | |
1165 | ||
1166 | /* If the latest line is another control structure, then recurse | |
dda83cd7 | 1167 | on it. */ |
1e9c71b8 | 1168 | if (multi_line_command_p (next->control_type)) |
d318976c FN |
1169 | { |
1170 | control_level++; | |
a7bdde9e | 1171 | ret = recurse_read_control_structure (read_next_line_func, next, |
60b3cef2 | 1172 | validator); |
d318976c FN |
1173 | control_level--; |
1174 | ||
1175 | if (ret != simple_control) | |
1176 | break; | |
1177 | } | |
1178 | } | |
1179 | ||
1180 | dont_repeat (); | |
1181 | ||
1182 | return ret; | |
1183 | } | |
1184 | ||
1185 | /* Read lines from the input stream and accumulate them in a chain of | |
1186 | struct command_line's, which is then returned. For input from a | |
1187 | terminal, the special command "end" is used to mark the end of the | |
311a4e6b TJB |
1188 | input, and is not included in the returned chain of commands. |
1189 | ||
1190 | If PARSE_COMMANDS is true, strip leading whitespace (trailing whitespace | |
1191 | is always stripped) in the line and attempt to recognize GDB control | |
1192 | commands. Otherwise, only "end" is recognized. */ | |
d318976c FN |
1193 | |
1194 | #define END_MESSAGE "End with a line saying just \"end\"." | |
1195 | ||
12973681 | 1196 | counted_command_line |
295dc222 | 1197 | read_command_lines (const char *prompt_arg, int from_tty, int parse_commands, |
60b3cef2 | 1198 | gdb::function_view<void (const char *)> validator) |
d318976c | 1199 | { |
268a799a | 1200 | if (from_tty && input_interactive_p (current_ui)) |
d318976c | 1201 | { |
698ba934 DJ |
1202 | if (deprecated_readline_begin_hook) |
1203 | { | |
ebcd3b23 | 1204 | /* Note - intentional to merge messages with no newline. */ |
9a2b4c1b MS |
1205 | (*deprecated_readline_begin_hook) ("%s %s\n", prompt_arg, |
1206 | END_MESSAGE); | |
698ba934 DJ |
1207 | } |
1208 | else | |
c119e040 | 1209 | printf_unfiltered ("%s\n%s\n", prompt_arg, END_MESSAGE); |
d318976c FN |
1210 | } |
1211 | ||
c41535fd EZ |
1212 | |
1213 | /* Reading commands assumes the CLI behavior, so temporarily | |
1214 | override the current interpreter with CLI. */ | |
12973681 | 1215 | counted_command_line head (nullptr, command_lines_deleter ()); |
c41535fd EZ |
1216 | if (current_interp_named_p (INTERP_CONSOLE)) |
1217 | head = read_command_lines_1 (read_next_line, parse_commands, | |
60b3cef2 | 1218 | validator); |
c41535fd EZ |
1219 | else |
1220 | { | |
be0d7abb | 1221 | scoped_restore_interp interp_restorer (INTERP_CONSOLE); |
c41535fd EZ |
1222 | |
1223 | head = read_command_lines_1 (read_next_line, parse_commands, | |
60b3cef2 | 1224 | validator); |
c41535fd | 1225 | } |
3c1179ff | 1226 | |
268a799a PA |
1227 | if (from_tty && input_interactive_p (current_ui) |
1228 | && deprecated_readline_end_hook) | |
3c1179ff VP |
1229 | { |
1230 | (*deprecated_readline_end_hook) (); | |
1231 | } | |
1232 | return (head); | |
1233 | } | |
1234 | ||
1235 | /* Act the same way as read_command_lines, except that each new line is | |
1236 | obtained using READ_NEXT_LINE_FUNC. */ | |
1237 | ||
12973681 | 1238 | counted_command_line |
60b3cef2 TT |
1239 | read_command_lines_1 (gdb::function_view<const char * ()> read_next_line_func, |
1240 | int parse_commands, | |
1241 | gdb::function_view<void (const char *)> validator) | |
3c1179ff | 1242 | { |
93921405 | 1243 | struct command_line *tail, *next; |
12973681 | 1244 | counted_command_line head (nullptr, command_lines_deleter ()); |
3c1179ff VP |
1245 | enum command_control_type ret; |
1246 | enum misc_command_type val; | |
1247 | ||
1248 | control_level = 0; | |
93921405 | 1249 | tail = NULL; |
d318976c FN |
1250 | |
1251 | while (1) | |
1252 | { | |
f429d7d0 | 1253 | dont_repeat (); |
a7bdde9e | 1254 | val = process_next_line (read_next_line_func (), &next, parse_commands, |
60b3cef2 | 1255 | validator); |
d318976c FN |
1256 | |
1257 | /* Ignore blank lines or comments. */ | |
1258 | if (val == nop_command) | |
1259 | continue; | |
1260 | ||
1261 | if (val == end_command) | |
1262 | { | |
1263 | ret = simple_control; | |
1264 | break; | |
1265 | } | |
1266 | ||
1267 | if (val != ok_command) | |
1268 | { | |
1269 | ret = invalid_control; | |
1270 | break; | |
1271 | } | |
1272 | ||
1e9c71b8 | 1273 | if (multi_line_command_p (next->control_type)) |
d318976c FN |
1274 | { |
1275 | control_level++; | |
a7bdde9e | 1276 | ret = recurse_read_control_structure (read_next_line_func, next, |
60b3cef2 | 1277 | validator); |
d318976c FN |
1278 | control_level--; |
1279 | ||
1280 | if (ret == invalid_control) | |
1281 | break; | |
1282 | } | |
1283 | ||
1284 | if (tail) | |
1285 | { | |
1286 | tail->next = next; | |
1287 | } | |
1288 | else | |
1289 | { | |
12973681 | 1290 | head = counted_command_line (next, command_lines_deleter ()); |
d318976c FN |
1291 | } |
1292 | tail = next; | |
1293 | } | |
1294 | ||
1295 | dont_repeat (); | |
1296 | ||
93921405 TT |
1297 | if (ret == invalid_control) |
1298 | return NULL; | |
d318976c | 1299 | |
3c1179ff | 1300 | return head; |
d318976c FN |
1301 | } |
1302 | ||
1303 | /* Free a chain of struct command_line's. */ | |
1304 | ||
1305 | void | |
1306 | free_command_lines (struct command_line **lptr) | |
1307 | { | |
d5b5ac79 AC |
1308 | struct command_line *l = *lptr; |
1309 | struct command_line *next; | |
d318976c FN |
1310 | |
1311 | while (l) | |
1312 | { | |
d318976c | 1313 | next = l->next; |
12973681 | 1314 | delete l; |
d318976c FN |
1315 | l = next; |
1316 | } | |
0d70f41b | 1317 | *lptr = NULL; |
d318976c | 1318 | } |
d318976c | 1319 | \f |
adb483fe DJ |
1320 | /* Validate that *COMNAME is a valid name for a command. Return the |
1321 | containing command list, in case it starts with a prefix command. | |
1322 | The prefix must already exist. *COMNAME is advanced to point after | |
1323 | any prefix, and a NUL character overwrites the space after the | |
1324 | prefix. */ | |
1325 | ||
1326 | static struct cmd_list_element ** | |
0b39b52e | 1327 | validate_comname (const char **comname) |
d318976c | 1328 | { |
adb483fe | 1329 | struct cmd_list_element **list = &cmdlist; |
0b39b52e | 1330 | const char *p, *last_word; |
d318976c | 1331 | |
adb483fe | 1332 | if (*comname == 0) |
e2e0b3e5 | 1333 | error_no_arg (_("name of command to define")); |
d318976c | 1334 | |
adb483fe DJ |
1335 | /* Find the last word of the argument. */ |
1336 | p = *comname + strlen (*comname); | |
1337 | while (p > *comname && isspace (p[-1])) | |
1338 | p--; | |
1339 | while (p > *comname && !isspace (p[-1])) | |
1340 | p--; | |
1341 | last_word = p; | |
1342 | ||
1343 | /* Find the corresponding command list. */ | |
1344 | if (last_word != *comname) | |
1345 | { | |
1346 | struct cmd_list_element *c; | |
adb483fe DJ |
1347 | |
1348 | /* Separate the prefix and the command. */ | |
0b39b52e TT |
1349 | std::string prefix (*comname, last_word - 1); |
1350 | const char *tem = prefix.c_str (); | |
adb483fe | 1351 | |
cf00cd6f | 1352 | c = lookup_cmd (&tem, cmdlist, "", NULL, 0, 1); |
adb483fe | 1353 | if (c->prefixlist == NULL) |
0b39b52e | 1354 | error (_("\"%s\" is not a prefix command."), prefix.c_str ()); |
adb483fe DJ |
1355 | |
1356 | list = c->prefixlist; | |
adb483fe DJ |
1357 | *comname = last_word; |
1358 | } | |
1359 | ||
1360 | p = *comname; | |
d318976c FN |
1361 | while (*p) |
1362 | { | |
be09caf1 | 1363 | if (!valid_cmd_char_p (*p)) |
8a3fe4f8 | 1364 | error (_("Junk in argument list: \"%s\""), p); |
d318976c FN |
1365 | p++; |
1366 | } | |
adb483fe DJ |
1367 | |
1368 | return list; | |
d318976c FN |
1369 | } |
1370 | ||
1371 | /* This is just a placeholder in the command data structures. */ | |
1372 | static void | |
898241a5 | 1373 | user_defined_command (const char *ignore, int from_tty) |
d318976c FN |
1374 | { |
1375 | } | |
1376 | ||
7a2c85f2 TT |
1377 | /* Define a user-defined command. If COMMANDS is NULL, then this is a |
1378 | top-level call and the commands will be read using | |
1379 | read_command_lines. Otherwise, it is a "define" command in an | |
1380 | existing command and the commands are provided. In the | |
1381 | non-top-level case, various prompts and warnings are disabled. */ | |
1382 | ||
2370e853 | 1383 | static void |
7a2c85f2 TT |
1384 | do_define_command (const char *comname, int from_tty, |
1385 | const counted_command_line *commands) | |
d318976c | 1386 | { |
d318976c FN |
1387 | enum cmd_hook_type |
1388 | { | |
1389 | CMD_NO_HOOK = 0, | |
1390 | CMD_PRE_HOOK, | |
1391 | CMD_POST_HOOK | |
1392 | }; | |
d36fc00b | 1393 | struct cmd_list_element *c, *newc, *hookc = 0, **list; |
0b39b52e | 1394 | const char *tem, *comfull; |
d318976c FN |
1395 | int hook_type = CMD_NO_HOOK; |
1396 | int hook_name_size = 0; | |
1397 | ||
1398 | #define HOOK_STRING "hook-" | |
1399 | #define HOOK_LEN 5 | |
1400 | #define HOOK_POST_STRING "hookpost-" | |
1401 | #define HOOK_POST_LEN 9 | |
1402 | ||
adb483fe DJ |
1403 | comfull = comname; |
1404 | list = validate_comname (&comname); | |
d318976c FN |
1405 | |
1406 | /* Look it up, and verify that we got an exact match. */ | |
0b39b52e | 1407 | tem = comname; |
cf00cd6f | 1408 | c = lookup_cmd (&tem, *list, "", NULL, -1, 1); |
5cb316ef | 1409 | if (c && strcmp (comname, c->name) != 0) |
d318976c FN |
1410 | c = 0; |
1411 | ||
7a2c85f2 | 1412 | if (c && commands == nullptr) |
d318976c | 1413 | { |
ab4e3d93 | 1414 | int q; |
cdb27c12 | 1415 | |
fe978cb0 | 1416 | if (c->theclass == class_user || c->theclass == class_alias) |
c6ac7fc9 PW |
1417 | { |
1418 | /* if C is a prefix command that was previously defined, | |
1419 | tell the user its subcommands will be kept, and ask | |
1420 | if ok to redefine the command. */ | |
1421 | if (c->prefixlist != nullptr) | |
1422 | q = (c->user_commands.get () == nullptr | |
1423 | || query (_("Keeping subcommands of prefix command \"%s\".\n" | |
1424 | "Redefine command \"%s\"? "), c->name, c->name)); | |
1425 | else | |
1426 | q = query (_("Redefine command \"%s\"? "), c->name); | |
1427 | } | |
d318976c | 1428 | else |
e2e0b3e5 | 1429 | q = query (_("Really redefine built-in command \"%s\"? "), c->name); |
ab4e3d93 | 1430 | if (!q) |
8a3fe4f8 | 1431 | error (_("Command \"%s\" not redefined."), c->name); |
d318976c FN |
1432 | } |
1433 | ||
1434 | /* If this new command is a hook, then mark the command which it | |
1435 | is hooking. Note that we allow hooking `help' commands, so that | |
1436 | we can hook the `stop' pseudo-command. */ | |
1437 | ||
1438 | if (!strncmp (comname, HOOK_STRING, HOOK_LEN)) | |
1439 | { | |
1440 | hook_type = CMD_PRE_HOOK; | |
1441 | hook_name_size = HOOK_LEN; | |
1442 | } | |
1443 | else if (!strncmp (comname, HOOK_POST_STRING, HOOK_POST_LEN)) | |
1444 | { | |
1445 | hook_type = CMD_POST_HOOK; | |
1446 | hook_name_size = HOOK_POST_LEN; | |
1447 | } | |
c6ac7fc9 | 1448 | |
d318976c FN |
1449 | if (hook_type != CMD_NO_HOOK) |
1450 | { | |
1451 | /* Look up cmd it hooks, and verify that we got an exact match. */ | |
0b39b52e | 1452 | tem = comname + hook_name_size; |
cf00cd6f | 1453 | hookc = lookup_cmd (&tem, *list, "", NULL, -1, 0); |
5cb316ef | 1454 | if (hookc && strcmp (comname + hook_name_size, hookc->name) != 0) |
d318976c | 1455 | hookc = 0; |
7a2c85f2 | 1456 | if (!hookc && commands == nullptr) |
d318976c | 1457 | { |
9a2b4c1b MS |
1458 | warning (_("Your new `%s' command does not " |
1459 | "hook any existing command."), | |
adb483fe | 1460 | comfull); |
9e2f0ad4 | 1461 | if (!query (_("Proceed? "))) |
8a3fe4f8 | 1462 | error (_("Not confirmed.")); |
d318976c FN |
1463 | } |
1464 | } | |
1465 | ||
1b36a34b | 1466 | comname = xstrdup (comname); |
d318976c | 1467 | |
7a2c85f2 TT |
1468 | counted_command_line cmds; |
1469 | if (commands == nullptr) | |
1470 | { | |
1471 | std::string prompt | |
1472 | = string_printf ("Type commands for definition of \"%s\".", comfull); | |
60b3cef2 | 1473 | cmds = read_command_lines (prompt.c_str (), from_tty, 1, 0); |
7a2c85f2 TT |
1474 | } |
1475 | else | |
1476 | cmds = *commands; | |
d318976c | 1477 | |
c6ac7fc9 PW |
1478 | { |
1479 | struct cmd_list_element **c_prefixlist | |
1480 | = c == nullptr ? nullptr : c->prefixlist; | |
1481 | const char *c_prefixname = c == nullptr ? nullptr : c->prefixname; | |
1482 | ||
1483 | newc = add_cmd (comname, class_user, user_defined_command, | |
1484 | (c != nullptr && c->theclass == class_user) | |
1485 | ? c->doc : xstrdup ("User-defined."), list); | |
1486 | newc->user_commands = std::move (cmds); | |
1487 | ||
1488 | /* If we define or re-define a command that was previously defined | |
1489 | as a prefix, keep the prefix information. */ | |
1490 | if (c_prefixlist != nullptr) | |
1491 | { | |
1492 | newc->prefixlist = c_prefixlist; | |
1493 | newc->prefixname = c_prefixname; | |
1494 | /* allow_unknown: see explanation in equivalent logic in | |
1495 | define_prefix_command (). */ | |
1496 | newc->allow_unknown = newc->user_commands.get () != nullptr; | |
1497 | } | |
1498 | } | |
d318976c FN |
1499 | |
1500 | /* If this new command is a hook, then mark both commands as being | |
1501 | tied. */ | |
1502 | if (hookc) | |
1503 | { | |
1504 | switch (hook_type) | |
dda83cd7 SM |
1505 | { |
1506 | case CMD_PRE_HOOK: | |
1507 | hookc->hook_pre = newc; /* Target gets hooked. */ | |
1508 | newc->hookee_pre = hookc; /* We are marked as hooking target cmd. */ | |
1509 | break; | |
1510 | case CMD_POST_HOOK: | |
1511 | hookc->hook_post = newc; /* Target gets hooked. */ | |
1512 | newc->hookee_post = hookc; /* We are marked as hooking | |
9a2b4c1b | 1513 | target cmd. */ |
dda83cd7 SM |
1514 | break; |
1515 | default: | |
1516 | /* Should never come here as hookc would be 0. */ | |
e2e0b3e5 | 1517 | internal_error (__FILE__, __LINE__, _("bad switch")); |
dda83cd7 | 1518 | } |
d318976c FN |
1519 | } |
1520 | } | |
1521 | ||
7a2c85f2 TT |
1522 | static void |
1523 | define_command (const char *comname, int from_tty) | |
1524 | { | |
1525 | do_define_command (comname, from_tty, nullptr); | |
1526 | } | |
1527 | ||
a33fc9ae RK |
1528 | /* Document a user-defined command. If COMMANDS is NULL, then this is a |
1529 | top-level call and the document will be read using read_command_lines. | |
1530 | Otherwise, it is a "document" command in an existing command and the | |
1531 | commands are provided. */ | |
2370e853 | 1532 | static void |
a33fc9ae RK |
1533 | do_document_command (const char *comname, int from_tty, |
1534 | const counted_command_line *commands) | |
d318976c | 1535 | { |
adb483fe | 1536 | struct cmd_list_element *c, **list; |
6f937416 | 1537 | const char *tem; |
0b39b52e | 1538 | const char *comfull; |
d318976c | 1539 | |
adb483fe DJ |
1540 | comfull = comname; |
1541 | list = validate_comname (&comname); | |
d318976c | 1542 | |
adb483fe | 1543 | tem = comname; |
cf00cd6f | 1544 | c = lookup_cmd (&tem, *list, "", NULL, 0, 1); |
d318976c | 1545 | |
fe978cb0 | 1546 | if (c->theclass != class_user) |
adb483fe | 1547 | error (_("Command \"%s\" is built-in."), comfull); |
d318976c | 1548 | |
a33fc9ae RK |
1549 | counted_command_line doclines; |
1550 | ||
1551 | if (commands == nullptr) | |
1552 | { | |
1553 | std::string prompt | |
1554 | = string_printf ("Type documentation for \"%s\".", comfull); | |
1555 | doclines = read_command_lines (prompt.c_str (), from_tty, 0, 0); | |
1556 | } | |
1557 | else | |
1558 | doclines = *commands; | |
d318976c | 1559 | |
84d53fa9 | 1560 | xfree ((char *) c->doc); |
d318976c FN |
1561 | |
1562 | { | |
d5b5ac79 AC |
1563 | struct command_line *cl1; |
1564 | int len = 0; | |
1947513d | 1565 | char *doc; |
d318976c | 1566 | |
93921405 | 1567 | for (cl1 = doclines.get (); cl1; cl1 = cl1->next) |
d318976c FN |
1568 | len += strlen (cl1->line) + 1; |
1569 | ||
1947513d TT |
1570 | doc = (char *) xmalloc (len + 1); |
1571 | *doc = 0; | |
d318976c | 1572 | |
93921405 | 1573 | for (cl1 = doclines.get (); cl1; cl1 = cl1->next) |
d318976c | 1574 | { |
1947513d | 1575 | strcat (doc, cl1->line); |
d318976c | 1576 | if (cl1->next) |
1947513d | 1577 | strcat (doc, "\n"); |
d318976c | 1578 | } |
1947513d TT |
1579 | |
1580 | c->doc = doc; | |
d318976c | 1581 | } |
d318976c | 1582 | } |
c6ac7fc9 | 1583 | |
a33fc9ae RK |
1584 | static void |
1585 | document_command (const char *comname, int from_tty) | |
1586 | { | |
1587 | do_document_command (comname, from_tty, nullptr); | |
1588 | } | |
1589 | ||
c6ac7fc9 PW |
1590 | /* Implementation of the "define-prefix" command. */ |
1591 | ||
1592 | static void | |
1593 | define_prefix_command (const char *comname, int from_tty) | |
1594 | { | |
1595 | struct cmd_list_element *c, **list; | |
1596 | const char *tem; | |
1597 | const char *comfull; | |
1598 | ||
1599 | comfull = comname; | |
1600 | list = validate_comname (&comname); | |
1601 | ||
1602 | /* Look it up, and verify that we got an exact match. */ | |
1603 | tem = comname; | |
cf00cd6f | 1604 | c = lookup_cmd (&tem, *list, "", NULL, -1, 1); |
c6ac7fc9 PW |
1605 | if (c != nullptr && strcmp (comname, c->name) != 0) |
1606 | c = nullptr; | |
1607 | ||
1608 | if (c != nullptr && c->theclass != class_user) | |
1609 | error (_("Command \"%s\" is built-in."), comfull); | |
1610 | ||
1611 | if (c != nullptr && c->prefixlist != nullptr) | |
1612 | { | |
1613 | /* c is already a user defined prefix command. */ | |
1614 | return; | |
1615 | } | |
1616 | ||
1617 | /* If the command does not exist at all, create it. */ | |
1618 | if (c == nullptr) | |
1619 | { | |
1620 | comname = xstrdup (comname); | |
1621 | c = add_cmd (comname, class_user, user_defined_command, | |
1622 | xstrdup ("User-defined."), list); | |
1623 | } | |
1624 | ||
1625 | /* Allocate the c->prefixlist, which marks the command as a prefix | |
1626 | command. */ | |
1627 | c->prefixlist = new struct cmd_list_element*; | |
1628 | *(c->prefixlist) = nullptr; | |
1629 | c->prefixname = xstrprintf ("%s ", comfull); | |
1630 | /* If the prefix command C is not a command, then it must be followed | |
1631 | by known subcommands. Otherwise, if C is also a normal command, | |
1632 | it can be followed by C args that must not cause a 'subcommand' | |
1633 | not recognised error, and thus we must allow unknown. */ | |
1634 | c->allow_unknown = c->user_commands.get () != nullptr; | |
1635 | } | |
1636 | ||
d318976c | 1637 | \f |
ebcd3b23 | 1638 | /* Used to implement source_command. */ |
d318976c FN |
1639 | |
1640 | void | |
05159abe | 1641 | script_from_file (FILE *stream, const char *file) |
d318976c | 1642 | { |
d318976c | 1643 | if (stream == NULL) |
e2e0b3e5 | 1644 | internal_error (__FILE__, __LINE__, _("called with NULL file pointer!")); |
d318976c | 1645 | |
2ec845e7 TT |
1646 | scoped_restore restore_line_number |
1647 | = make_scoped_restore (&source_line_number, 0); | |
6caa91b6 SM |
1648 | scoped_restore restore_file |
1649 | = make_scoped_restore<std::string, const std::string &> (&source_file_name, | |
1650 | file); | |
cdb27c12 | 1651 | |
2ec845e7 | 1652 | scoped_restore save_async = make_scoped_restore (¤t_ui->async, 0); |
d318976c | 1653 | |
a70b8144 | 1654 | try |
2ec845e7 TT |
1655 | { |
1656 | read_command_file (stream); | |
1657 | } | |
230d2906 | 1658 | catch (const gdb_exception_error &e) |
2ec845e7 TT |
1659 | { |
1660 | /* Re-throw the error, but with the file name information | |
1661 | prepended. */ | |
1662 | throw_error (e.error, | |
1663 | _("%s:%d: Error in sourced command file:\n%s"), | |
3d6e9d23 TT |
1664 | source_file_name.c_str (), source_line_number, |
1665 | e.what ()); | |
2ec845e7 | 1666 | } |
d318976c FN |
1667 | } |
1668 | ||
adb483fe DJ |
1669 | /* Print the definition of user command C to STREAM. Or, if C is a |
1670 | prefix command, show the definitions of all user commands under C | |
1671 | (recursively). PREFIX and NAME combined are the name of the | |
1672 | current command. */ | |
d318976c | 1673 | void |
6f937416 | 1674 | show_user_1 (struct cmd_list_element *c, const char *prefix, const char *name, |
adb483fe | 1675 | struct ui_file *stream) |
d318976c | 1676 | { |
c6ac7fc9 PW |
1677 | if (cli_user_command_p (c)) |
1678 | { | |
1679 | struct command_line *cmdlines = c->user_commands.get (); | |
1680 | ||
1681 | fprintf_filtered (stream, "User %scommand \"", | |
1682 | c->prefixlist == NULL ? "" : "prefix "); | |
1683 | fprintf_styled (stream, title_style.style (), "%s%s", | |
1684 | prefix, name); | |
1685 | fprintf_filtered (stream, "\":\n"); | |
1686 | if (cmdlines) | |
1687 | { | |
1688 | print_command_lines (current_uiout, cmdlines, 1); | |
1689 | fputs_filtered ("\n", stream); | |
1690 | } | |
1691 | } | |
d318976c | 1692 | |
adb483fe DJ |
1693 | if (c->prefixlist != NULL) |
1694 | { | |
64e61d29 | 1695 | const char *prefixname = c->prefixname; |
cdb27c12 | 1696 | |
adb483fe | 1697 | for (c = *c->prefixlist; c != NULL; c = c->next) |
fe978cb0 | 1698 | if (c->theclass == class_user || c->prefixlist != NULL) |
adb483fe | 1699 | show_user_1 (c, prefixname, c->name, gdb_stdout); |
adb483fe DJ |
1700 | } |
1701 | ||
d318976c FN |
1702 | } |
1703 | ||
6c265988 | 1704 | void _initialize_cli_script (); |
2370e853 | 1705 | void |
6c265988 | 1706 | _initialize_cli_script () |
2370e853 | 1707 | { |
c6ac7fc9 PW |
1708 | struct cmd_list_element *c; |
1709 | ||
1710 | /* "document", "define" and "define-prefix" use command_completer, | |
1711 | as this helps the user to either type the command name and/or | |
1712 | its prefixes. */ | |
a33fc9ae RK |
1713 | document_cmd_element = add_com ("document", class_support, document_command, |
1714 | _("\ | |
2370e853 TT |
1715 | Document a user-defined command.\n\ |
1716 | Give command name as argument. Give documentation on following lines.\n\ | |
1717 | End with a line of just \"end\".")); | |
a33fc9ae | 1718 | set_cmd_completer (document_cmd_element, command_completer); |
8588b356 | 1719 | define_cmd_element = add_com ("define", class_support, define_command, _("\ |
2370e853 TT |
1720 | Define a new command name. Command name is argument.\n\ |
1721 | Definition appears on following lines, one command per line.\n\ | |
1722 | End with a line of just \"end\".\n\ | |
1723 | Use the \"document\" command to give documentation for the new command.\n\ | |
87a8eca7 PW |
1724 | Commands defined in this way may accept an unlimited number of arguments\n\ |
1725 | accessed via $arg0 .. $argN. $argc tells how many arguments have\n\ | |
1726 | been passed.")); | |
c6ac7fc9 PW |
1727 | set_cmd_completer (define_cmd_element, command_completer); |
1728 | c = add_com ("define-prefix", class_support, define_prefix_command, | |
1729 | _("\ | |
1730 | Define or mark a command as a user-defined prefix command.\n\ | |
1731 | User defined prefix commands can be used as prefix commands for\n\ | |
1732 | other user defined commands.\n\ | |
1733 | If the command already exists, it is changed to a prefix command.")); | |
1734 | set_cmd_completer (c, command_completer); | |
2370e853 | 1735 | |
8588b356 | 1736 | while_cmd_element = add_com ("while", class_support, while_command, _("\ |
2370e853 TT |
1737 | Execute nested commands WHILE the conditional expression is non zero.\n\ |
1738 | The conditional expression must follow the word `while' and must in turn be\n\ | |
1739 | followed by a new line. The nested commands must be entered one per line,\n\ | |
1740 | and should be terminated by the word `end'.")); | |
1741 | ||
8588b356 | 1742 | if_cmd_element = add_com ("if", class_support, if_command, _("\ |
2370e853 TT |
1743 | Execute nested commands once IF the conditional expression is non zero.\n\ |
1744 | The conditional expression must follow the word `if' and must in turn be\n\ | |
1745 | followed by a new line. The nested commands must be entered one per line,\n\ | |
1746 | and should be terminated by the word 'else' or `end'. If an else clause\n\ | |
1747 | is used, the same rules apply to its nested commands as to the first ones.")); | |
1748 | } |