1 /* GDB CLI command scripting.
3 Copyright (C) 1986-2018 Free Software Foundation, Inc.
5 This file is part of GDB.
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
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
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.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #include "language.h" /* For value_true */
27 #include "breakpoint.h"
28 #include "tracepoint.h"
29 #include "cli/cli-cmds.h"
30 #include "cli/cli-decode.h"
31 #include "cli/cli-script.h"
33 #include "extension.h"
35 #include "compile/compile.h"
36 #include "common/gdb_string_view.h"
37 #include "python/python.h"
38 #include "guile/guile.h"
42 /* Prototypes for local functions. */
44 static enum command_control_type
45 recurse_read_control_structure
46 (gdb::function_view<const char * ()> read_next_line_func,
47 struct command_line *current_cmd,
48 gdb::function_view<void (const char *)> validator);
50 static void do_define_command (const char *comname, int from_tty,
51 const counted_command_line *commands);
53 static char *read_next_line (void);
55 /* Level of control structure when reading. */
56 static int control_level;
58 /* Level of control structure when executing. */
59 static int command_nest_depth = 1;
61 /* This is to prevent certain commands being printed twice. */
62 static int suppress_next_print_command_trace = 0;
64 /* Command element for the 'while' command. */
65 static cmd_list_element *while_cmd_element = nullptr;
67 /* Command element for the 'if' command. */
68 static cmd_list_element *if_cmd_element = nullptr;
70 /* Command element for the 'define' command. */
71 static cmd_list_element *define_cmd_element = nullptr;
73 /* Structure for arguments to user defined functions. */
78 /* Save the command line and store the locations of arguments passed
79 to the user defined function. */
80 explicit user_args (const char *line);
82 /* Insert the stored user defined arguments into the $arg arguments
84 std::string insert_args (const char *line) const;
87 /* Disable copy/assignment. (Since the elements of A point inside
88 COMMAND, copying would need to reconstruct the A vector in the
90 user_args (const user_args &) =delete;
91 user_args &operator= (const user_args &) =delete;
93 /* It is necessary to store a copy of the command line to ensure
94 that the arguments are not overwritten before they are used. */
95 std::string m_command_line;
97 /* The arguments. Each element points inside M_COMMAND_LINE. */
98 std::vector<gdb::string_view> m_args;
101 /* The stack of arguments passed to user defined functions. We need a
102 stack because user-defined functions can call other user-defined
104 static std::vector<std::unique_ptr<user_args>> user_args_stack;
106 /* An RAII-base class used to push/pop args on the user args
108 struct scoped_user_args_level
110 /* Parse the command line and push the arguments in the user args
112 explicit scoped_user_args_level (const char *line)
114 user_args_stack.emplace_back (new user_args (line));
117 /* Pop the current user arguments from the stack. */
118 ~scoped_user_args_level ()
120 user_args_stack.pop_back ();
125 /* Return non-zero if TYPE is a multi-line command (i.e., is terminated
129 multi_line_command_p (enum command_control_type type)
135 case while_stepping_control:
136 case commands_control:
137 case compile_control:
147 /* Allocate, initialize a new command line structure for one of the
148 control commands (if/while). */
150 static struct command_line *
151 build_command_line (enum command_control_type type, const char *args)
153 if (args == NULL || *args == '\0')
155 if (type == if_control)
156 error (_("if command requires an argument."));
157 else if (type == while_control)
158 error (_("while command requires an argument."));
159 else if (type == define_control)
160 error (_("define command requires an argument."));
162 gdb_assert (args != NULL);
164 return new struct command_line (type, xstrdup (args));
167 /* Build and return a new command structure for the control commands
168 such as "if" and "while". */
171 get_command_line (enum command_control_type type, const char *arg)
173 /* Allocate and build a new command line structure. */
174 counted_command_line cmd (build_command_line (type, arg),
175 command_lines_deleter ());
177 /* Read in the body of this command. */
178 if (recurse_read_control_structure (read_next_line, cmd.get (), 0)
181 warning (_("Error reading in canned sequence of commands."));
188 /* Recursively print a command (including full control structures). */
191 print_command_lines (struct ui_out *uiout, struct command_line *cmd,
194 struct command_line *list;
200 uiout->spaces (2 * depth);
202 /* A simple command, print it and continue. */
203 if (list->control_type == simple_control)
205 uiout->field_string (NULL, list->line);
211 /* loop_continue to jump to the start of a while loop, print it
213 if (list->control_type == continue_control)
215 uiout->field_string (NULL, "loop_continue");
221 /* loop_break to break out of a while loop, print it and
223 if (list->control_type == break_control)
225 uiout->field_string (NULL, "loop_break");
231 /* A while command. Recursively print its subcommands and
233 if (list->control_type == while_control
234 || list->control_type == while_stepping_control)
236 /* For while-stepping, the line includes the 'while-stepping'
237 token. See comment in process_next_line for explanation.
238 Here, take care not print 'while-stepping' twice. */
239 if (list->control_type == while_control)
240 uiout->field_fmt (NULL, "while %s", list->line);
242 uiout->field_string (NULL, list->line);
244 print_command_lines (uiout, list->body_list_0.get (), depth + 1);
246 uiout->spaces (2 * depth);
247 uiout->field_string (NULL, "end");
253 /* An if command. Recursively print both arms before
255 if (list->control_type == if_control)
257 uiout->field_fmt (NULL, "if %s", list->line);
260 print_command_lines (uiout, list->body_list_0.get (), depth + 1);
262 /* Show the false arm if it exists. */
263 if (list->body_list_1 != nullptr)
266 uiout->spaces (2 * depth);
267 uiout->field_string (NULL, "else");
269 print_command_lines (uiout, list->body_list_1.get (), depth + 1);
273 uiout->spaces (2 * depth);
274 uiout->field_string (NULL, "end");
280 /* A commands command. Print the breakpoint commands and
282 if (list->control_type == commands_control)
285 uiout->field_fmt (NULL, "commands %s", list->line);
287 uiout->field_string (NULL, "commands");
289 print_command_lines (uiout, list->body_list_0.get (), depth + 1);
291 uiout->spaces (2 * depth);
292 uiout->field_string (NULL, "end");
298 if (list->control_type == python_control)
300 uiout->field_string (NULL, "python");
302 /* Don't indent python code at all. */
303 print_command_lines (uiout, list->body_list_0.get (), 0);
305 uiout->spaces (2 * depth);
306 uiout->field_string (NULL, "end");
312 if (list->control_type == compile_control)
314 uiout->field_string (NULL, "compile expression");
316 print_command_lines (uiout, list->body_list_0.get (), 0);
318 uiout->spaces (2 * depth);
319 uiout->field_string (NULL, "end");
325 if (list->control_type == guile_control)
327 uiout->field_string (NULL, "guile");
329 print_command_lines (uiout, list->body_list_0.get (), depth + 1);
331 uiout->spaces (2 * depth);
332 uiout->field_string (NULL, "end");
338 /* Ignore illegal command type and try next. */
343 /* Handle pre-post hooks. */
345 class scoped_restore_hook_in
349 scoped_restore_hook_in (struct cmd_list_element *c)
354 ~scoped_restore_hook_in ()
359 scoped_restore_hook_in (const scoped_restore_hook_in &) = delete;
360 scoped_restore_hook_in &operator= (const scoped_restore_hook_in &) = delete;
364 struct cmd_list_element *m_cmd;
368 execute_cmd_pre_hook (struct cmd_list_element *c)
370 if ((c->hook_pre) && (!c->hook_in))
372 scoped_restore_hook_in restore_hook (c);
373 c->hook_in = 1; /* Prevent recursive hooking. */
374 execute_user_command (c->hook_pre, nullptr);
379 execute_cmd_post_hook (struct cmd_list_element *c)
381 if ((c->hook_post) && (!c->hook_in))
383 scoped_restore_hook_in restore_hook (c);
384 c->hook_in = 1; /* Prevent recursive hooking. */
385 execute_user_command (c->hook_post, nullptr);
389 /* See cli-script.h. */
392 execute_control_commands (struct command_line *cmdlines, int from_tty)
394 /* Set the instream to 0, indicating execution of a
395 user-defined function. */
396 scoped_restore restore_instream
397 = make_scoped_restore (¤t_ui->instream, nullptr);
398 scoped_restore save_async = make_scoped_restore (¤t_ui->async, 0);
399 scoped_restore save_nesting
400 = make_scoped_restore (&command_nest_depth, command_nest_depth + 1);
404 enum command_control_type ret = execute_control_command (cmdlines,
406 if (ret != simple_control && ret != break_control)
408 warning (_("Error executing canned sequence of commands."));
411 cmdlines = cmdlines->next;
415 /* See cli-script.h. */
418 execute_control_commands_to_string (struct command_line *commands,
421 /* GDB_STDOUT should be better already restored during these
422 restoration callbacks. */
423 set_batch_flag_and_restore_page_info save_page_info;
425 string_file str_file;
428 current_uiout->redirect (&str_file);
429 ui_out_redirect_pop redirect_popper (current_uiout);
431 scoped_restore save_stdout
432 = make_scoped_restore (&gdb_stdout, &str_file);
433 scoped_restore save_stderr
434 = make_scoped_restore (&gdb_stderr, &str_file);
435 scoped_restore save_stdlog
436 = make_scoped_restore (&gdb_stdlog, &str_file);
437 scoped_restore save_stdtarg
438 = make_scoped_restore (&gdb_stdtarg, &str_file);
439 scoped_restore save_stdtargerr
440 = make_scoped_restore (&gdb_stdtargerr, &str_file);
442 execute_control_commands (commands, from_tty);
445 return std::move (str_file.string ());
449 execute_user_command (struct cmd_list_element *c, const char *args)
451 counted_command_line cmdlines_copy;
452 extern unsigned int max_user_call_depth;
454 /* Ensure that the user commands can't be deleted while they are
456 cmdlines_copy = c->user_commands;
457 if (cmdlines_copy == 0)
460 struct command_line *cmdlines = cmdlines_copy.get ();
462 scoped_user_args_level push_user_args (args);
464 if (user_args_stack.size () > max_user_call_depth)
465 error (_("Max user call depth exceeded -- command aborted."));
467 execute_control_commands (cmdlines, 0);
470 /* This function is called every time GDB prints a prompt. It ensures
471 that errors and the like do not confuse the command tracing. */
474 reset_command_nest_depth (void)
476 command_nest_depth = 1;
479 suppress_next_print_command_trace = 0;
482 /* Print the command, prefixed with '+' to represent the call depth.
483 This is slightly complicated because this function may be called
484 from execute_command and execute_control_command. Unfortunately
485 execute_command also prints the top level control commands.
486 In these cases execute_command will call execute_control_command
487 via while_command or if_command. Inner levels of 'if' and 'while'
488 are dealt with directly. Therefore we can use these functions
489 to determine whether the command has been printed already or not. */
490 ATTRIBUTE_PRINTF (1, 2)
492 print_command_trace (const char *fmt, ...)
496 if (suppress_next_print_command_trace)
498 suppress_next_print_command_trace = 0;
502 if (!source_verbose && !trace_commands)
505 for (i=0; i < command_nest_depth; i++)
506 printf_filtered ("+");
510 va_start (args, fmt);
511 vprintf_filtered (fmt, args);
513 puts_filtered ("\n");
516 /* Helper for execute_control_command. */
518 static enum command_control_type
519 execute_control_command_1 (struct command_line *cmd, int from_tty)
521 struct command_line *current;
523 struct value *val_mark;
525 enum command_control_type ret;
527 /* Start by assuming failure, if a problem is detected, the code
528 below will simply "break" out of the switch. */
529 ret = invalid_control;
531 switch (cmd->control_type)
535 /* A simple command, execute it and return. */
536 std::string new_line = insert_user_defined_cmd_args (cmd->line);
537 execute_command (new_line.c_str (), from_tty);
538 ret = cmd->control_type;
542 case continue_control:
543 print_command_trace ("loop_continue");
545 /* Return for "continue", and "break" so we can either
546 continue the loop at the top, or break out. */
547 ret = cmd->control_type;
551 print_command_trace ("loop_break");
553 /* Return for "continue", and "break" so we can either
554 continue the loop at the top, or break out. */
555 ret = cmd->control_type;
560 print_command_trace ("while %s", cmd->line);
562 /* Parse the loop control expression for the while statement. */
563 std::string new_line = insert_user_defined_cmd_args (cmd->line);
564 expression_up expr = parse_expression (new_line.c_str ());
566 ret = simple_control;
569 /* Keep iterating so long as the expression is true. */
576 /* Evaluate the expression. */
577 val_mark = value_mark ();
578 val = evaluate_expression (expr.get ());
579 cond_result = value_true (val);
580 value_free_to_mark (val_mark);
582 /* If the value is false, then break out of the loop. */
586 /* Execute the body of the while statement. */
587 current = cmd->body_list_0.get ();
590 scoped_restore save_nesting
591 = make_scoped_restore (&command_nest_depth, command_nest_depth + 1);
592 ret = execute_control_command_1 (current, from_tty);
594 /* If we got an error, or a "break" command, then stop
596 if (ret == invalid_control || ret == break_control)
602 /* If we got a "continue" command, then restart the loop
604 if (ret == continue_control)
607 /* Get the next statement. */
608 current = current->next;
612 /* Reset RET so that we don't recurse the break all the way down. */
613 if (ret == break_control)
614 ret = simple_control;
621 print_command_trace ("if %s", cmd->line);
623 /* Parse the conditional for the if statement. */
624 std::string new_line = insert_user_defined_cmd_args (cmd->line);
625 expression_up expr = parse_expression (new_line.c_str ());
628 ret = simple_control;
630 /* Evaluate the conditional. */
631 val_mark = value_mark ();
632 val = evaluate_expression (expr.get ());
634 /* Choose which arm to take commands from based on the value
635 of the conditional expression. */
636 if (value_true (val))
637 current = cmd->body_list_0.get ();
638 else if (cmd->body_list_1 != nullptr)
639 current = cmd->body_list_1.get ();
640 value_free_to_mark (val_mark);
642 /* Execute commands in the given arm. */
645 scoped_restore save_nesting
646 = make_scoped_restore (&command_nest_depth, command_nest_depth + 1);
647 ret = execute_control_command_1 (current, from_tty);
649 /* If we got an error, get out. */
650 if (ret != simple_control)
653 /* Get the next statement in the body. */
654 current = current->next;
660 case commands_control:
662 /* Breakpoint commands list, record the commands in the
663 breakpoint's command list and return. */
664 std::string new_line = insert_user_defined_cmd_args (cmd->line);
665 ret = commands_from_control_command (new_line.c_str (), cmd);
669 case compile_control:
670 eval_compile_command (cmd, NULL, cmd->control_u.compile.scope,
671 cmd->control_u.compile.scope_data);
672 ret = simple_control;
676 print_command_trace ("define %s", cmd->line);
677 do_define_command (cmd->line, 0, &cmd->body_list_0);
678 ret = simple_control;
684 eval_ext_lang_from_control_command (cmd);
685 ret = simple_control;
690 warning (_("Invalid control type in canned commands structure."));
697 enum command_control_type
698 execute_control_command (struct command_line *cmd, int from_tty)
700 /* Make sure we use the console uiout. It's possible that we are executing
701 breakpoint commands while running the MI interpreter. */
702 interp *console = interp_lookup (current_ui, INTERP_CONSOLE);
703 scoped_restore save_uiout
704 = make_scoped_restore (¤t_uiout, console->interp_ui_out ());
706 return execute_control_command_1 (cmd, from_tty);
709 /* Like execute_control_command, but first set
710 suppress_next_print_command_trace. */
712 enum command_control_type
713 execute_control_command_untraced (struct command_line *cmd)
715 suppress_next_print_command_trace = 1;
716 return execute_control_command (cmd);
720 /* "while" command support. Executes a body of statements while the
721 loop condition is nonzero. */
724 while_command (const char *arg, int from_tty)
727 counted_command_line command = get_command_line (while_control, arg);
732 scoped_restore save_async = make_scoped_restore (¤t_ui->async, 0);
734 execute_control_command_untraced (command.get ());
737 /* "if" command support. Execute either the true or false arm depending
738 on the value of the if conditional. */
741 if_command (const char *arg, int from_tty)
744 counted_command_line command = get_command_line (if_control, arg);
749 scoped_restore save_async = make_scoped_restore (¤t_ui->async, 0);
751 execute_control_command_untraced (command.get ());
754 /* Bind the incoming arguments for a user defined command to $arg0,
757 user_args::user_args (const char *command_line)
761 if (command_line == NULL)
764 m_command_line = command_line;
765 p = m_command_line.c_str ();
769 const char *start_arg;
774 /* Strip whitespace. */
775 while (*p == ' ' || *p == '\t')
778 /* P now points to an argument. */
781 /* Get to the end of this argument. */
784 if (((*p == ' ' || *p == '\t')) && !squote && !dquote && !bsquote)
813 m_args.emplace_back (start_arg, p - start_arg);
817 /* Given character string P, return a point to the first argument
818 ($arg), or NULL if P contains no arguments. */
821 locate_arg (const char *p)
823 while ((p = strchr (p, '$')))
825 if (startswith (p, "$arg")
826 && (isdigit (p[4]) || p[4] == 'c'))
833 /* See cli-script.h. */
836 insert_user_defined_cmd_args (const char *line)
838 /* If we are not in a user-defined command, treat $argc, $arg0, et
839 cetera as normal convenience variables. */
840 if (user_args_stack.empty ())
843 const std::unique_ptr<user_args> &args = user_args_stack.back ();
844 return args->insert_args (line);
847 /* Insert the user defined arguments stored in user_args into the $arg
848 arguments found in line. */
851 user_args::insert_args (const char *line) const
853 std::string new_line;
856 while ((p = locate_arg (line)))
858 new_line.append (line, p - line);
862 new_line += std::to_string (m_args.size ());
871 i = strtoul (p + 4, &tmp, 10);
872 if ((i == 0 && tmp == p + 4) || errno != 0)
874 else if (i >= m_args.size ())
875 error (_("Missing argument %ld in user function."), i);
878 new_line.append (m_args[i].data (), m_args[i].length ());
883 /* Don't forget the tail. */
884 new_line.append (line);
890 /* Read next line from stdin. Passed to read_command_line_1 and
891 recurse_read_control_structure whenever we need to read commands
895 read_next_line (void)
897 struct ui *ui = current_ui;
898 char *prompt_ptr, control_prompt[256];
900 int from_tty = ui->instream == ui->stdin_stream;
902 if (control_level >= 254)
903 error (_("Control nesting too deep!"));
905 /* Set a prompt based on the nesting of the control commands. */
907 || (ui->instream == 0 && deprecated_readline_hook != NULL))
909 for (i = 0; i < control_level; i++)
910 control_prompt[i] = ' ';
911 control_prompt[i] = '>';
912 control_prompt[i + 1] = '\0';
913 prompt_ptr = (char *) &control_prompt[0];
918 return command_line_input (prompt_ptr, "commands");
921 /* Given an input line P, skip the command and return a pointer to the
925 line_first_arg (const char *p)
927 const char *first_arg = p + find_command_name_length (p);
929 return skip_spaces (first_arg);
932 /* Process one input line. If the command is an "end", return such an
933 indication to the caller. If PARSE_COMMANDS is true, strip leading
934 whitespace (trailing whitespace is always stripped) in the line,
935 attempt to recognize GDB control commands, and also return an
936 indication if the command is an "else" or a nop.
938 Otherwise, only "end" is recognized. */
940 static enum misc_command_type
941 process_next_line (const char *p, struct command_line **command,
943 gdb::function_view<void (const char *)> validator)
950 /* Not sure what to do here. */
954 /* Strip trailing whitespace. */
955 p_end = p + strlen (p);
956 while (p_end > p && (p_end[-1] == ' ' || p_end[-1] == '\t'))
960 /* Strip leading whitespace. */
961 while (p_start < p_end && (*p_start == ' ' || *p_start == '\t'))
964 /* 'end' is always recognized, regardless of parse_commands value.
965 We also permit whitespace before end and after. */
966 if (p_end - p_start == 3 && startswith (p_start, "end"))
971 /* Resolve command abbreviations (e.g. 'ws' for 'while-stepping'). */
972 const char *cmd_name = p;
973 struct cmd_list_element *cmd
974 = lookup_cmd_1 (&cmd_name, cmdlist, NULL, 1);
975 cmd_name = skip_spaces (cmd_name);
976 bool inline_cmd = *cmd_name != '\0';
978 /* If commands are parsed, we skip initial spaces. Otherwise,
979 which is the case for Python commands and documentation
980 (see the 'document' command), spaces are preserved. */
983 /* Blanks and comments don't really do anything, but we need to
984 distinguish them from else, end and other commands which can
986 if (p_end == p || p[0] == '#')
989 /* Is the else clause of an if control structure? */
990 if (p_end - p == 4 && startswith (p, "else"))
993 /* Check for while, if, break, continue, etc and build a new
994 command line structure for them. */
995 if (cmd == while_stepping_cmd_element)
997 /* Because validate_actionline and encode_action lookup
998 command's line as command, we need the line to
999 include 'while-stepping'.
1001 For 'ws' alias, the command will have 'ws', not expanded
1002 to 'while-stepping'. This is intentional -- we don't
1003 really want frontend to send a command list with 'ws',
1004 and next break-info returning command line with
1005 'while-stepping'. This should work, but might cause the
1006 breakpoint to be marked as changed while it's actually
1008 *command = build_command_line (while_stepping_control, p);
1010 else if (cmd == while_cmd_element)
1011 *command = build_command_line (while_control, line_first_arg (p));
1012 else if (cmd == if_cmd_element)
1013 *command = build_command_line (if_control, line_first_arg (p));
1014 else if (cmd == commands_cmd_element)
1015 *command = build_command_line (commands_control, line_first_arg (p));
1016 else if (cmd == define_cmd_element)
1017 *command = build_command_line (define_control, line_first_arg (p));
1018 else if (cmd == python_cmd_element && !inline_cmd)
1020 /* Note that we ignore the inline "python command" form
1022 *command = build_command_line (python_control, "");
1024 else if (cmd == compile_cmd_element && !inline_cmd)
1026 /* Note that we ignore the inline "compile command" form
1028 *command = build_command_line (compile_control, "");
1029 (*command)->control_u.compile.scope = COMPILE_I_INVALID_SCOPE;
1031 else if (cmd == guile_cmd_element && !inline_cmd)
1033 /* Note that we ignore the inline "guile command" form here. */
1034 *command = build_command_line (guile_control, "");
1036 else if (p_end - p == 10 && startswith (p, "loop_break"))
1037 *command = new struct command_line (break_control);
1038 else if (p_end - p == 13 && startswith (p, "loop_continue"))
1039 *command = new struct command_line (continue_control);
1044 if (!parse_commands || not_handled)
1046 /* A normal command. */
1047 *command = new struct command_line (simple_control,
1048 savestring (p, p_end - p));
1055 validator ((*command)->line);
1057 CATCH (ex, RETURN_MASK_ALL)
1059 free_command_lines (command);
1060 throw_exception (ex);
1065 /* Nothing special. */
1069 /* Recursively read in the control structures and create a
1070 command_line structure from them. Use read_next_line_func to
1071 obtain lines of the command. */
1073 static enum command_control_type
1074 recurse_read_control_structure (gdb::function_view<const char * ()> read_next_line_func,
1075 struct command_line *current_cmd,
1076 gdb::function_view<void (const char *)> validator)
1078 enum misc_command_type val;
1079 enum command_control_type ret;
1080 struct command_line **body_ptr, *child_tail, *next;
1081 counted_command_line *current_body = ¤t_cmd->body_list_0;
1085 /* Sanity checks. */
1086 if (current_cmd->control_type == simple_control)
1087 error (_("Recursed on a simple control type."));
1089 /* Read lines from the input stream and build control structures. */
1095 val = process_next_line (read_next_line_func (), &next,
1096 current_cmd->control_type != python_control
1097 && current_cmd->control_type != guile_control
1098 && current_cmd->control_type != compile_control,
1101 /* Just skip blanks and comments. */
1102 if (val == nop_command)
1105 if (val == end_command)
1107 if (multi_line_command_p (current_cmd->control_type))
1109 /* Success reading an entire canned sequence of commands. */
1110 ret = simple_control;
1115 ret = invalid_control;
1120 /* Not the end of a control structure. */
1121 if (val == else_command)
1123 if (current_cmd->control_type == if_control
1124 && current_body == ¤t_cmd->body_list_0)
1126 current_body = ¤t_cmd->body_list_1;
1132 ret = invalid_control;
1139 child_tail->next = next;
1142 *current_body = counted_command_line (next, command_lines_deleter ());
1146 /* If the latest line is another control structure, then recurse
1148 if (multi_line_command_p (next->control_type))
1151 ret = recurse_read_control_structure (read_next_line_func, next,
1155 if (ret != simple_control)
1165 /* Read lines from the input stream and accumulate them in a chain of
1166 struct command_line's, which is then returned. For input from a
1167 terminal, the special command "end" is used to mark the end of the
1168 input, and is not included in the returned chain of commands.
1170 If PARSE_COMMANDS is true, strip leading whitespace (trailing whitespace
1171 is always stripped) in the line and attempt to recognize GDB control
1172 commands. Otherwise, only "end" is recognized. */
1174 #define END_MESSAGE "End with a line saying just \"end\"."
1176 counted_command_line
1177 read_command_lines (const char *prompt_arg, int from_tty, int parse_commands,
1178 gdb::function_view<void (const char *)> validator)
1180 if (from_tty && input_interactive_p (current_ui))
1182 if (deprecated_readline_begin_hook)
1184 /* Note - intentional to merge messages with no newline. */
1185 (*deprecated_readline_begin_hook) ("%s %s\n", prompt_arg,
1190 printf_unfiltered ("%s\n%s\n", prompt_arg, END_MESSAGE);
1191 gdb_flush (gdb_stdout);
1196 /* Reading commands assumes the CLI behavior, so temporarily
1197 override the current interpreter with CLI. */
1198 counted_command_line head (nullptr, command_lines_deleter ());
1199 if (current_interp_named_p (INTERP_CONSOLE))
1200 head = read_command_lines_1 (read_next_line, parse_commands,
1204 scoped_restore_interp interp_restorer (INTERP_CONSOLE);
1206 head = read_command_lines_1 (read_next_line, parse_commands,
1210 if (from_tty && input_interactive_p (current_ui)
1211 && deprecated_readline_end_hook)
1213 (*deprecated_readline_end_hook) ();
1218 /* Act the same way as read_command_lines, except that each new line is
1219 obtained using READ_NEXT_LINE_FUNC. */
1221 counted_command_line
1222 read_command_lines_1 (gdb::function_view<const char * ()> read_next_line_func,
1224 gdb::function_view<void (const char *)> validator)
1226 struct command_line *tail, *next;
1227 counted_command_line head (nullptr, command_lines_deleter ());
1228 enum command_control_type ret;
1229 enum misc_command_type val;
1237 val = process_next_line (read_next_line_func (), &next, parse_commands,
1240 /* Ignore blank lines or comments. */
1241 if (val == nop_command)
1244 if (val == end_command)
1246 ret = simple_control;
1250 if (val != ok_command)
1252 ret = invalid_control;
1256 if (multi_line_command_p (next->control_type))
1259 ret = recurse_read_control_structure (read_next_line_func, next,
1263 if (ret == invalid_control)
1273 head = counted_command_line (next, command_lines_deleter ());
1280 if (ret == invalid_control)
1286 /* Free a chain of struct command_line's. */
1289 free_command_lines (struct command_line **lptr)
1291 struct command_line *l = *lptr;
1292 struct command_line *next;
1303 /* Validate that *COMNAME is a valid name for a command. Return the
1304 containing command list, in case it starts with a prefix command.
1305 The prefix must already exist. *COMNAME is advanced to point after
1306 any prefix, and a NUL character overwrites the space after the
1309 static struct cmd_list_element **
1310 validate_comname (const char **comname)
1312 struct cmd_list_element **list = &cmdlist;
1313 const char *p, *last_word;
1316 error_no_arg (_("name of command to define"));
1318 /* Find the last word of the argument. */
1319 p = *comname + strlen (*comname);
1320 while (p > *comname && isspace (p[-1]))
1322 while (p > *comname && !isspace (p[-1]))
1326 /* Find the corresponding command list. */
1327 if (last_word != *comname)
1329 struct cmd_list_element *c;
1331 /* Separate the prefix and the command. */
1332 std::string prefix (*comname, last_word - 1);
1333 const char *tem = prefix.c_str ();
1335 c = lookup_cmd (&tem, cmdlist, "", 0, 1);
1336 if (c->prefixlist == NULL)
1337 error (_("\"%s\" is not a prefix command."), prefix.c_str ());
1339 list = c->prefixlist;
1340 *comname = last_word;
1346 if (!isalnum (*p) && *p != '-' && *p != '_')
1347 error (_("Junk in argument list: \"%s\""), p);
1354 /* This is just a placeholder in the command data structures. */
1356 user_defined_command (const char *ignore, int from_tty)
1360 /* Define a user-defined command. If COMMANDS is NULL, then this is a
1361 top-level call and the commands will be read using
1362 read_command_lines. Otherwise, it is a "define" command in an
1363 existing command and the commands are provided. In the
1364 non-top-level case, various prompts and warnings are disabled. */
1367 do_define_command (const char *comname, int from_tty,
1368 const counted_command_line *commands)
1376 struct cmd_list_element *c, *newc, *hookc = 0, **list;
1377 const char *tem, *comfull;
1378 int hook_type = CMD_NO_HOOK;
1379 int hook_name_size = 0;
1381 #define HOOK_STRING "hook-"
1383 #define HOOK_POST_STRING "hookpost-"
1384 #define HOOK_POST_LEN 9
1387 list = validate_comname (&comname);
1389 /* Look it up, and verify that we got an exact match. */
1391 c = lookup_cmd (&tem, *list, "", -1, 1);
1392 if (c && strcmp (comname, c->name) != 0)
1395 if (c && commands == nullptr)
1399 if (c->theclass == class_user || c->theclass == class_alias)
1400 q = query (_("Redefine command \"%s\"? "), c->name);
1402 q = query (_("Really redefine built-in command \"%s\"? "), c->name);
1404 error (_("Command \"%s\" not redefined."), c->name);
1407 /* If this new command is a hook, then mark the command which it
1408 is hooking. Note that we allow hooking `help' commands, so that
1409 we can hook the `stop' pseudo-command. */
1411 if (!strncmp (comname, HOOK_STRING, HOOK_LEN))
1413 hook_type = CMD_PRE_HOOK;
1414 hook_name_size = HOOK_LEN;
1416 else if (!strncmp (comname, HOOK_POST_STRING, HOOK_POST_LEN))
1418 hook_type = CMD_POST_HOOK;
1419 hook_name_size = HOOK_POST_LEN;
1422 if (hook_type != CMD_NO_HOOK)
1424 /* Look up cmd it hooks, and verify that we got an exact match. */
1425 tem = comname + hook_name_size;
1426 hookc = lookup_cmd (&tem, *list, "", -1, 0);
1427 if (hookc && strcmp (comname + hook_name_size, hookc->name) != 0)
1429 if (!hookc && commands == nullptr)
1431 warning (_("Your new `%s' command does not "
1432 "hook any existing command."),
1434 if (!query (_("Proceed? ")))
1435 error (_("Not confirmed."));
1439 comname = xstrdup (comname);
1441 counted_command_line cmds;
1442 if (commands == nullptr)
1445 = string_printf ("Type commands for definition of \"%s\".", comfull);
1446 cmds = read_command_lines (prompt.c_str (), from_tty, 1, 0);
1451 newc = add_cmd (comname, class_user, user_defined_command,
1452 (c && c->theclass == class_user)
1453 ? c->doc : xstrdup ("User-defined."), list);
1454 newc->user_commands = std::move (cmds);
1456 /* If this new command is a hook, then mark both commands as being
1463 hookc->hook_pre = newc; /* Target gets hooked. */
1464 newc->hookee_pre = hookc; /* We are marked as hooking target cmd. */
1467 hookc->hook_post = newc; /* Target gets hooked. */
1468 newc->hookee_post = hookc; /* We are marked as hooking
1472 /* Should never come here as hookc would be 0. */
1473 internal_error (__FILE__, __LINE__, _("bad switch"));
1479 define_command (const char *comname, int from_tty)
1481 do_define_command (comname, from_tty, nullptr);
1485 document_command (const char *comname, int from_tty)
1487 struct cmd_list_element *c, **list;
1489 const char *comfull;
1492 list = validate_comname (&comname);
1495 c = lookup_cmd (&tem, *list, "", 0, 1);
1497 if (c->theclass != class_user)
1498 error (_("Command \"%s\" is built-in."), comfull);
1500 std::string prompt = string_printf ("Type documentation for \"%s\".",
1502 counted_command_line doclines = read_command_lines (prompt.c_str (),
1506 xfree ((char *) c->doc);
1509 struct command_line *cl1;
1513 for (cl1 = doclines.get (); cl1; cl1 = cl1->next)
1514 len += strlen (cl1->line) + 1;
1516 doc = (char *) xmalloc (len + 1);
1519 for (cl1 = doclines.get (); cl1; cl1 = cl1->next)
1521 strcat (doc, cl1->line);
1530 /* Used to implement source_command. */
1533 script_from_file (FILE *stream, const char *file)
1536 internal_error (__FILE__, __LINE__, _("called with NULL file pointer!"));
1538 scoped_restore restore_line_number
1539 = make_scoped_restore (&source_line_number, 0);
1540 scoped_restore resotre_file
1541 = make_scoped_restore (&source_file_name, file);
1543 scoped_restore save_async = make_scoped_restore (¤t_ui->async, 0);
1547 read_command_file (stream);
1549 CATCH (e, RETURN_MASK_ERROR)
1551 /* Re-throw the error, but with the file name information
1553 throw_error (e.error,
1554 _("%s:%d: Error in sourced command file:\n%s"),
1555 source_file_name, source_line_number, e.message);
1560 /* Print the definition of user command C to STREAM. Or, if C is a
1561 prefix command, show the definitions of all user commands under C
1562 (recursively). PREFIX and NAME combined are the name of the
1565 show_user_1 (struct cmd_list_element *c, const char *prefix, const char *name,
1566 struct ui_file *stream)
1568 struct command_line *cmdlines;
1570 if (c->prefixlist != NULL)
1572 const char *prefixname = c->prefixname;
1574 for (c = *c->prefixlist; c != NULL; c = c->next)
1575 if (c->theclass == class_user || c->prefixlist != NULL)
1576 show_user_1 (c, prefixname, c->name, gdb_stdout);
1580 cmdlines = c->user_commands.get ();
1581 fprintf_filtered (stream, "User command \"%s%s\":\n", prefix, name);
1585 print_command_lines (current_uiout, cmdlines, 1);
1586 fputs_filtered ("\n", stream);
1590 _initialize_cli_script (void)
1592 add_com ("document", class_support, document_command, _("\
1593 Document a user-defined command.\n\
1594 Give command name as argument. Give documentation on following lines.\n\
1595 End with a line of just \"end\"."));
1596 define_cmd_element = add_com ("define", class_support, define_command, _("\
1597 Define a new command name. Command name is argument.\n\
1598 Definition appears on following lines, one command per line.\n\
1599 End with a line of just \"end\".\n\
1600 Use the \"document\" command to give documentation for the new command.\n\
1601 Commands defined in this way may accept an unlimited number of arguments\n\
1602 accessed via $arg0 .. $argN. $argc tells how many arguments have\n\
1605 while_cmd_element = add_com ("while", class_support, while_command, _("\
1606 Execute nested commands WHILE the conditional expression is non zero.\n\
1607 The conditional expression must follow the word `while' and must in turn be\n\
1608 followed by a new line. The nested commands must be entered one per line,\n\
1609 and should be terminated by the word `end'."));
1611 if_cmd_element = add_com ("if", class_support, if_command, _("\
1612 Execute nested commands once IF the conditional expression is non zero.\n\
1613 The conditional expression must follow the word `if' and must in turn be\n\
1614 followed by a new line. The nested commands must be entered one per line,\n\
1615 and should be terminated by the word 'else' or `end'. If an else clause\n\
1616 is used, the same rules apply to its nested commands as to the first ones."));