1 /* GDB CLI command scripting.
3 Copyright (C) 1986-2017 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 "cli/cli-cmds.h"
29 #include "cli/cli-decode.h"
30 #include "cli/cli-script.h"
32 #include "extension.h"
34 #include "compile/compile.h"
38 /* Prototypes for local functions. */
40 static enum command_control_type
41 recurse_read_control_structure (char * (*read_next_line_func) (void),
42 struct command_line *current_cmd,
43 void (*validator)(char *, void *),
46 static char *read_next_line (void);
48 /* Level of control structure when reading. */
49 static int control_level;
51 /* Level of control structure when executing. */
52 static int command_nest_depth = 1;
54 /* This is to prevent certain commands being printed twice. */
55 static int suppress_next_print_command_trace = 0;
57 /* A non-owning slice of a string. */
61 string_view (const char *str_, size_t len_)
62 : str (str_), len (len_)
69 /* Structure for arguments to user defined functions. */
74 /* Save the command line and store the locations of arguments passed
75 to the user defined function. */
76 explicit user_args (const char *line);
78 /* Insert the stored user defined arguments into the $arg arguments
80 std::string insert_args (const char *line) const;
83 /* Disable copy/assignment. (Since the elements of A point inside
84 COMMAND, copying would need to reconstruct the A vector in the
86 user_args (const user_args &) =delete;
87 user_args &operator= (const user_args &) =delete;
89 /* It is necessary to store a copy of the command line to ensure
90 that the arguments are not overwritten before they are used. */
91 std::string m_command_line;
93 /* The arguments. Each element points inside M_COMMAND_LINE. */
94 std::vector<string_view> m_args;
97 /* The stack of arguments passed to user defined functions. We need a
98 stack because user-defined functions can call other user-defined
100 static std::vector<std::unique_ptr<user_args>> user_args_stack;
102 /* An RAII-base class used to push/pop args on the user args
104 struct scoped_user_args_level
106 /* Parse the command line and push the arguments in the user args
108 explicit scoped_user_args_level (const char *line)
110 user_args_stack.emplace_back (new user_args (line));
113 /* Pop the current user arguments from the stack. */
114 ~scoped_user_args_level ()
116 user_args_stack.pop_back ();
121 /* Return non-zero if TYPE is a multi-line command (i.e., is terminated
125 multi_line_command_p (enum command_control_type type)
131 case while_stepping_control:
132 case commands_control:
133 case compile_control:
142 /* Allocate, initialize a new command line structure for one of the
143 control commands (if/while). */
145 static struct command_line *
146 build_command_line (enum command_control_type type, const char *args)
148 struct command_line *cmd;
150 if ((args == NULL || *args == '\0')
151 && (type == if_control || type == while_control))
152 error (_("if/while commands require arguments."));
153 gdb_assert (args != NULL);
155 cmd = XNEW (struct command_line);
157 cmd->control_type = type;
160 cmd->body_list = XCNEWVEC (struct command_line *, cmd->body_count);
161 cmd->line = xstrdup (args);
166 /* Build and return a new command structure for the control commands
167 such as "if" and "while". */
170 get_command_line (enum command_control_type type, const char *arg)
172 /* Allocate and build a new command line structure. */
173 command_line_up cmd (build_command_line (type, arg));
175 /* Read in the body of this command. */
176 if (recurse_read_control_structure (read_next_line, cmd.get (), 0, 0)
179 warning (_("Error reading in canned sequence of commands."));
186 /* Recursively print a command (including full control structures). */
189 print_command_lines (struct ui_out *uiout, struct command_line *cmd,
192 struct command_line *list;
198 uiout->spaces (2 * depth);
200 /* A simple command, print it and continue. */
201 if (list->control_type == simple_control)
203 uiout->field_string (NULL, list->line);
209 /* loop_continue to jump to the start of a while loop, print it
211 if (list->control_type == continue_control)
213 uiout->field_string (NULL, "loop_continue");
219 /* loop_break to break out of a while loop, print it and
221 if (list->control_type == break_control)
223 uiout->field_string (NULL, "loop_break");
229 /* A while command. Recursively print its subcommands and
231 if (list->control_type == while_control
232 || list->control_type == while_stepping_control)
234 /* For while-stepping, the line includes the 'while-stepping'
235 token. See comment in process_next_line for explanation.
236 Here, take care not print 'while-stepping' twice. */
237 if (list->control_type == while_control)
238 uiout->field_fmt (NULL, "while %s", list->line);
240 uiout->field_string (NULL, list->line);
242 print_command_lines (uiout, *list->body_list, depth + 1);
244 uiout->spaces (2 * depth);
245 uiout->field_string (NULL, "end");
251 /* An if command. Recursively print both arms before
253 if (list->control_type == if_control)
255 uiout->field_fmt (NULL, "if %s", list->line);
258 print_command_lines (uiout, list->body_list[0], depth + 1);
260 /* Show the false arm if it exists. */
261 if (list->body_count == 2)
264 uiout->spaces (2 * depth);
265 uiout->field_string (NULL, "else");
267 print_command_lines (uiout, list->body_list[1], depth + 1);
271 uiout->spaces (2 * depth);
272 uiout->field_string (NULL, "end");
278 /* A commands command. Print the breakpoint commands and
280 if (list->control_type == commands_control)
283 uiout->field_fmt (NULL, "commands %s", list->line);
285 uiout->field_string (NULL, "commands");
287 print_command_lines (uiout, *list->body_list, depth + 1);
289 uiout->spaces (2 * depth);
290 uiout->field_string (NULL, "end");
296 if (list->control_type == python_control)
298 uiout->field_string (NULL, "python");
300 /* Don't indent python code at all. */
301 print_command_lines (uiout, *list->body_list, 0);
303 uiout->spaces (2 * depth);
304 uiout->field_string (NULL, "end");
310 if (list->control_type == compile_control)
312 uiout->field_string (NULL, "compile expression");
314 print_command_lines (uiout, *list->body_list, 0);
316 uiout->spaces (2 * depth);
317 uiout->field_string (NULL, "end");
323 if (list->control_type == guile_control)
325 uiout->field_string (NULL, "guile");
327 print_command_lines (uiout, *list->body_list, depth + 1);
329 uiout->spaces (2 * depth);
330 uiout->field_string (NULL, "end");
336 /* Ignore illegal command type and try next. */
341 /* Handle pre-post hooks. */
343 class scoped_restore_hook_in
347 scoped_restore_hook_in (struct cmd_list_element *c)
352 ~scoped_restore_hook_in ()
357 scoped_restore_hook_in (const scoped_restore_hook_in &) = delete;
358 scoped_restore_hook_in &operator= (const scoped_restore_hook_in &) = delete;
362 struct cmd_list_element *m_cmd;
366 execute_cmd_pre_hook (struct cmd_list_element *c)
368 if ((c->hook_pre) && (!c->hook_in))
370 scoped_restore_hook_in restore_hook (c);
371 c->hook_in = 1; /* Prevent recursive hooking. */
372 execute_user_command (c->hook_pre, (char *) 0);
377 execute_cmd_post_hook (struct cmd_list_element *c)
379 if ((c->hook_post) && (!c->hook_in))
381 scoped_restore_hook_in restore_hook (c);
382 c->hook_in = 1; /* Prevent recursive hooking. */
383 execute_user_command (c->hook_post, (char *) 0);
388 execute_user_command (struct cmd_list_element *c, char *args)
390 struct ui *ui = current_ui;
391 struct command_line *cmdlines;
392 enum command_control_type ret;
393 extern unsigned int max_user_call_depth;
395 cmdlines = c->user_commands;
400 scoped_user_args_level push_user_args (args);
402 if (user_args_stack.size () > max_user_call_depth)
403 error (_("Max user call depth exceeded -- command aborted."));
405 /* Set the instream to 0, indicating execution of a
406 user-defined function. */
407 scoped_restore restore_instream
408 = make_scoped_restore (&ui->instream, nullptr);
410 scoped_restore save_async = make_scoped_restore (¤t_ui->async, 0);
412 scoped_restore save_nesting
413 = make_scoped_restore (&command_nest_depth, command_nest_depth + 1);
416 ret = execute_control_command (cmdlines);
417 if (ret != simple_control && ret != break_control)
419 warning (_("Error executing canned sequence of commands."));
422 cmdlines = cmdlines->next;
426 /* This function is called every time GDB prints a prompt. It ensures
427 that errors and the like do not confuse the command tracing. */
430 reset_command_nest_depth (void)
432 command_nest_depth = 1;
435 suppress_next_print_command_trace = 0;
438 /* Print the command, prefixed with '+' to represent the call depth.
439 This is slightly complicated because this function may be called
440 from execute_command and execute_control_command. Unfortunately
441 execute_command also prints the top level control commands.
442 In these cases execute_command will call execute_control_command
443 via while_command or if_command. Inner levels of 'if' and 'while'
444 are dealt with directly. Therefore we can use these functions
445 to determine whether the command has been printed already or not. */
447 print_command_trace (const char *cmd)
451 if (suppress_next_print_command_trace)
453 suppress_next_print_command_trace = 0;
457 if (!source_verbose && !trace_commands)
460 for (i=0; i < command_nest_depth; i++)
461 printf_filtered ("+");
463 printf_filtered ("%s\n", cmd);
466 /* Helper for execute_control_command. */
468 static enum command_control_type
469 execute_control_command_1 (struct command_line *cmd)
471 struct command_line *current;
473 struct value *val_mark;
475 enum command_control_type ret;
477 /* Start by assuming failure, if a problem is detected, the code
478 below will simply "break" out of the switch. */
479 ret = invalid_control;
481 switch (cmd->control_type)
485 /* A simple command, execute it and return. */
486 std::string new_line = insert_user_defined_cmd_args (cmd->line);
487 execute_command (&new_line[0], 0);
488 ret = cmd->control_type;
492 case continue_control:
493 print_command_trace ("loop_continue");
495 /* Return for "continue", and "break" so we can either
496 continue the loop at the top, or break out. */
497 ret = cmd->control_type;
501 print_command_trace ("loop_break");
503 /* Return for "continue", and "break" so we can either
504 continue the loop at the top, or break out. */
505 ret = cmd->control_type;
510 int len = strlen (cmd->line) + 7;
511 char *buffer = (char *) alloca (len);
513 xsnprintf (buffer, len, "while %s", cmd->line);
514 print_command_trace (buffer);
516 /* Parse the loop control expression for the while statement. */
517 std::string new_line = insert_user_defined_cmd_args (cmd->line);
518 expression_up expr = parse_expression (new_line.c_str ());
520 ret = simple_control;
523 /* Keep iterating so long as the expression is true. */
530 /* Evaluate the expression. */
531 val_mark = value_mark ();
532 val = evaluate_expression (expr.get ());
533 cond_result = value_true (val);
534 value_free_to_mark (val_mark);
536 /* If the value is false, then break out of the loop. */
540 /* Execute the body of the while statement. */
541 current = *cmd->body_list;
544 scoped_restore save_nesting
545 = make_scoped_restore (&command_nest_depth, command_nest_depth + 1);
546 ret = execute_control_command_1 (current);
548 /* If we got an error, or a "break" command, then stop
550 if (ret == invalid_control || ret == break_control)
556 /* If we got a "continue" command, then restart the loop
558 if (ret == continue_control)
561 /* Get the next statement. */
562 current = current->next;
566 /* Reset RET so that we don't recurse the break all the way down. */
567 if (ret == break_control)
568 ret = simple_control;
575 int len = strlen (cmd->line) + 4;
576 char *buffer = (char *) alloca (len);
578 xsnprintf (buffer, len, "if %s", cmd->line);
579 print_command_trace (buffer);
581 /* Parse the conditional for the if statement. */
582 std::string new_line = insert_user_defined_cmd_args (cmd->line);
583 expression_up expr = parse_expression (new_line.c_str ());
586 ret = simple_control;
588 /* Evaluate the conditional. */
589 val_mark = value_mark ();
590 val = evaluate_expression (expr.get ());
592 /* Choose which arm to take commands from based on the value
593 of the conditional expression. */
594 if (value_true (val))
595 current = *cmd->body_list;
596 else if (cmd->body_count == 2)
597 current = *(cmd->body_list + 1);
598 value_free_to_mark (val_mark);
600 /* Execute commands in the given arm. */
603 scoped_restore save_nesting
604 = make_scoped_restore (&command_nest_depth, command_nest_depth + 1);
605 ret = execute_control_command_1 (current);
607 /* If we got an error, get out. */
608 if (ret != simple_control)
611 /* Get the next statement in the body. */
612 current = current->next;
618 case commands_control:
620 /* Breakpoint commands list, record the commands in the
621 breakpoint's command list and return. */
622 std::string new_line = insert_user_defined_cmd_args (cmd->line);
623 ret = commands_from_control_command (new_line.c_str (), cmd);
627 case compile_control:
628 eval_compile_command (cmd, NULL, cmd->control_u.compile.scope,
629 cmd->control_u.compile.scope_data);
630 ret = simple_control;
636 eval_ext_lang_from_control_command (cmd);
637 ret = simple_control;
642 warning (_("Invalid control type in canned commands structure."));
649 enum command_control_type
650 execute_control_command (struct command_line *cmd)
652 /* Make sure we use the console uiout. It's possible that we are executing
653 breakpoint commands while running the MI interpreter. */
654 interp *console = interp_lookup (current_ui, INTERP_CONSOLE);
655 scoped_restore save_uiout
656 = make_scoped_restore (¤t_uiout, interp_ui_out (console));
658 return execute_control_command_1 (cmd);
661 /* Like execute_control_command, but first set
662 suppress_next_print_command_trace. */
664 enum command_control_type
665 execute_control_command_untraced (struct command_line *cmd)
667 suppress_next_print_command_trace = 1;
668 return execute_control_command (cmd);
672 /* "while" command support. Executes a body of statements while the
673 loop condition is nonzero. */
676 while_command (char *arg, int from_tty)
679 command_line_up command = get_command_line (while_control, arg);
684 scoped_restore save_async = make_scoped_restore (¤t_ui->async, 0);
686 execute_control_command_untraced (command.get ());
689 /* "if" command support. Execute either the true or false arm depending
690 on the value of the if conditional. */
693 if_command (char *arg, int from_tty)
696 command_line_up command = get_command_line (if_control, arg);
701 scoped_restore save_async = make_scoped_restore (¤t_ui->async, 0);
703 execute_control_command_untraced (command.get ());
706 /* Bind the incoming arguments for a user defined command to $arg0,
709 user_args::user_args (const char *command_line)
713 if (command_line == NULL)
716 m_command_line = command_line;
717 p = m_command_line.c_str ();
721 const char *start_arg;
726 /* Strip whitespace. */
727 while (*p == ' ' || *p == '\t')
730 /* P now points to an argument. */
733 /* Get to the end of this argument. */
736 if (((*p == ' ' || *p == '\t')) && !squote && !dquote && !bsquote)
765 m_args.emplace_back (start_arg, p - start_arg);
769 /* Given character string P, return a point to the first argument
770 ($arg), or NULL if P contains no arguments. */
773 locate_arg (const char *p)
775 while ((p = strchr (p, '$')))
777 if (startswith (p, "$arg")
778 && (isdigit (p[4]) || p[4] == 'c'))
785 /* See cli-script.h. */
788 insert_user_defined_cmd_args (const char *line)
790 /* If we are not in a user-defined command, treat $argc, $arg0, et
791 cetera as normal convenience variables. */
792 if (user_args_stack.empty ())
795 const std::unique_ptr<user_args> &args = user_args_stack.back ();
796 return args->insert_args (line);
799 /* Insert the user defined arguments stored in user_args into the $arg
800 arguments found in line. */
803 user_args::insert_args (const char *line) const
805 std::string new_line;
808 while ((p = locate_arg (line)))
810 new_line.append (line, p - line);
814 new_line += std::to_string (m_args.size ());
823 i = strtoul (p + 4, &tmp, 10);
824 if ((i == 0 && tmp == p + 4) || errno != 0)
826 else if (i >= m_args.size ())
827 error (_("Missing argument %ld in user function."), i);
830 new_line.append (m_args[i].str, m_args[i].len);
835 /* Don't forget the tail. */
836 new_line.append (line);
842 /* Expand the body_list of COMMAND so that it can hold NEW_LENGTH
843 code bodies. This is typically used when we encounter an "else"
844 clause for an "if" command. */
847 realloc_body_list (struct command_line *command, int new_length)
850 struct command_line **body_list;
852 n = command->body_count;
858 body_list = XCNEWVEC (struct command_line *, new_length);
860 memcpy (body_list, command->body_list, sizeof (struct command_line *) * n);
862 xfree (command->body_list);
863 command->body_list = body_list;
864 command->body_count = new_length;
867 /* Read next line from stdin. Passed to read_command_line_1 and
868 recurse_read_control_structure whenever we need to read commands
872 read_next_line (void)
874 struct ui *ui = current_ui;
875 char *prompt_ptr, control_prompt[256];
877 int from_tty = ui->instream == ui->stdin_stream;
879 if (control_level >= 254)
880 error (_("Control nesting too deep!"));
882 /* Set a prompt based on the nesting of the control commands. */
884 || (ui->instream == 0 && deprecated_readline_hook != NULL))
886 for (i = 0; i < control_level; i++)
887 control_prompt[i] = ' ';
888 control_prompt[i] = '>';
889 control_prompt[i + 1] = '\0';
890 prompt_ptr = (char *) &control_prompt[0];
895 return command_line_input (prompt_ptr, from_tty, "commands");
898 /* Return true if CMD's name is NAME. */
901 command_name_equals (struct cmd_list_element *cmd, const char *name)
904 && cmd != CMD_LIST_AMBIGUOUS
905 && strcmp (cmd->name, name) == 0);
908 /* Given an input line P, skip the command and return a pointer to the
912 line_first_arg (const char *p)
914 const char *first_arg = p + find_command_name_length (p);
916 return skip_spaces (first_arg);
919 /* Process one input line. If the command is an "end", return such an
920 indication to the caller. If PARSE_COMMANDS is true, strip leading
921 whitespace (trailing whitespace is always stripped) in the line,
922 attempt to recognize GDB control commands, and also return an
923 indication if the command is an "else" or a nop.
925 Otherwise, only "end" is recognized. */
927 static enum misc_command_type
928 process_next_line (char *p, struct command_line **command, int parse_commands,
929 void (*validator)(char *, void *), void *closure)
935 /* Not sure what to do here. */
939 /* Strip trailing whitespace. */
940 p_end = p + strlen (p);
941 while (p_end > p && (p_end[-1] == ' ' || p_end[-1] == '\t'))
945 /* Strip leading whitespace. */
946 while (p_start < p_end && (*p_start == ' ' || *p_start == '\t'))
949 /* 'end' is always recognized, regardless of parse_commands value.
950 We also permit whitespace before end and after. */
951 if (p_end - p_start == 3 && startswith (p_start, "end"))
956 /* Resolve command abbreviations (e.g. 'ws' for 'while-stepping'). */
957 const char *cmd_name = p;
958 struct cmd_list_element *cmd
959 = lookup_cmd_1 (&cmd_name, cmdlist, NULL, 1);
960 cmd_name = skip_spaces (cmd_name);
961 bool inline_cmd = *cmd_name != '\0';
963 /* If commands are parsed, we skip initial spaces. Otherwise,
964 which is the case for Python commands and documentation
965 (see the 'document' command), spaces are preserved. */
968 /* Blanks and comments don't really do anything, but we need to
969 distinguish them from else, end and other commands which can
971 if (p_end == p || p[0] == '#')
974 /* Is the else clause of an if control structure? */
975 if (p_end - p == 4 && startswith (p, "else"))
978 /* Check for while, if, break, continue, etc and build a new
979 command line structure for them. */
980 if (command_name_equals (cmd, "while-stepping"))
982 /* Because validate_actionline and encode_action lookup
983 command's line as command, we need the line to
984 include 'while-stepping'.
986 For 'ws' alias, the command will have 'ws', not expanded
987 to 'while-stepping'. This is intentional -- we don't
988 really want frontend to send a command list with 'ws',
989 and next break-info returning command line with
990 'while-stepping'. This should work, but might cause the
991 breakpoint to be marked as changed while it's actually
993 *command = build_command_line (while_stepping_control, p);
995 else if (command_name_equals (cmd, "while"))
997 *command = build_command_line (while_control, line_first_arg (p));
999 else if (command_name_equals (cmd, "if"))
1001 *command = build_command_line (if_control, line_first_arg (p));
1003 else if (command_name_equals (cmd, "commands"))
1005 *command = build_command_line (commands_control, line_first_arg (p));
1007 else if (command_name_equals (cmd, "python") && !inline_cmd)
1009 /* Note that we ignore the inline "python command" form
1011 *command = build_command_line (python_control, "");
1013 else if (command_name_equals (cmd, "compile") && !inline_cmd)
1015 /* Note that we ignore the inline "compile command" form
1017 *command = build_command_line (compile_control, "");
1018 (*command)->control_u.compile.scope = COMPILE_I_INVALID_SCOPE;
1020 else if (command_name_equals (cmd, "guile") && !inline_cmd)
1022 /* Note that we ignore the inline "guile command" form here. */
1023 *command = build_command_line (guile_control, "");
1025 else if (p_end - p == 10 && startswith (p, "loop_break"))
1027 *command = XNEW (struct command_line);
1028 (*command)->next = NULL;
1029 (*command)->line = NULL;
1030 (*command)->control_type = break_control;
1031 (*command)->body_count = 0;
1032 (*command)->body_list = NULL;
1034 else if (p_end - p == 13 && startswith (p, "loop_continue"))
1036 *command = XNEW (struct command_line);
1037 (*command)->next = NULL;
1038 (*command)->line = NULL;
1039 (*command)->control_type = continue_control;
1040 (*command)->body_count = 0;
1041 (*command)->body_list = NULL;
1047 if (!parse_commands || not_handled)
1049 /* A normal command. */
1050 *command = XNEW (struct command_line);
1051 (*command)->next = NULL;
1052 (*command)->line = savestring (p, p_end - p);
1053 (*command)->control_type = simple_control;
1054 (*command)->body_count = 0;
1055 (*command)->body_list = NULL;
1063 validator ((*command)->line, closure);
1065 CATCH (ex, RETURN_MASK_ALL)
1068 throw_exception (ex);
1073 /* Nothing special. */
1077 /* Recursively read in the control structures and create a
1078 command_line structure from them. Use read_next_line_func to
1079 obtain lines of the command. */
1081 static enum command_control_type
1082 recurse_read_control_structure (char * (*read_next_line_func) (void),
1083 struct command_line *current_cmd,
1084 void (*validator)(char *, void *),
1087 int current_body, i;
1088 enum misc_command_type val;
1089 enum command_control_type ret;
1090 struct command_line **body_ptr, *child_tail, *next;
1095 /* Sanity checks. */
1096 if (current_cmd->control_type == simple_control)
1097 error (_("Recursed on a simple control type."));
1099 if (current_body > current_cmd->body_count)
1100 error (_("Allocated body is smaller than this command type needs."));
1102 /* Read lines from the input stream and build control structures. */
1108 val = process_next_line (read_next_line_func (), &next,
1109 current_cmd->control_type != python_control
1110 && current_cmd->control_type != guile_control
1111 && current_cmd->control_type != compile_control,
1112 validator, closure);
1114 /* Just skip blanks and comments. */
1115 if (val == nop_command)
1118 if (val == end_command)
1120 if (multi_line_command_p (current_cmd->control_type))
1122 /* Success reading an entire canned sequence of commands. */
1123 ret = simple_control;
1128 ret = invalid_control;
1133 /* Not the end of a control structure. */
1134 if (val == else_command)
1136 if (current_cmd->control_type == if_control
1137 && current_body == 1)
1139 realloc_body_list (current_cmd, 2);
1146 ret = invalid_control;
1153 child_tail->next = next;
1157 body_ptr = current_cmd->body_list;
1158 for (i = 1; i < current_body; i++)
1167 /* If the latest line is another control structure, then recurse
1169 if (multi_line_command_p (next->control_type))
1172 ret = recurse_read_control_structure (read_next_line_func, next,
1173 validator, closure);
1176 if (ret != simple_control)
1186 /* Read lines from the input stream and accumulate them in a chain of
1187 struct command_line's, which is then returned. For input from a
1188 terminal, the special command "end" is used to mark the end of the
1189 input, and is not included in the returned chain of commands.
1191 If PARSE_COMMANDS is true, strip leading whitespace (trailing whitespace
1192 is always stripped) in the line and attempt to recognize GDB control
1193 commands. Otherwise, only "end" is recognized. */
1195 #define END_MESSAGE "End with a line saying just \"end\"."
1198 read_command_lines (char *prompt_arg, int from_tty, int parse_commands,
1199 void (*validator)(char *, void *), void *closure)
1201 if (from_tty && input_interactive_p (current_ui))
1203 if (deprecated_readline_begin_hook)
1205 /* Note - intentional to merge messages with no newline. */
1206 (*deprecated_readline_begin_hook) ("%s %s\n", prompt_arg,
1211 printf_unfiltered ("%s\n%s\n", prompt_arg, END_MESSAGE);
1212 gdb_flush (gdb_stdout);
1217 /* Reading commands assumes the CLI behavior, so temporarily
1218 override the current interpreter with CLI. */
1219 command_line_up head;
1220 if (current_interp_named_p (INTERP_CONSOLE))
1221 head = read_command_lines_1 (read_next_line, parse_commands,
1222 validator, closure);
1225 scoped_restore_interp interp_restorer (INTERP_CONSOLE);
1227 head = read_command_lines_1 (read_next_line, parse_commands,
1228 validator, closure);
1231 if (from_tty && input_interactive_p (current_ui)
1232 && deprecated_readline_end_hook)
1234 (*deprecated_readline_end_hook) ();
1239 /* Act the same way as read_command_lines, except that each new line is
1240 obtained using READ_NEXT_LINE_FUNC. */
1243 read_command_lines_1 (char * (*read_next_line_func) (void), int parse_commands,
1244 void (*validator)(char *, void *), void *closure)
1246 struct command_line *tail, *next;
1247 command_line_up head;
1248 enum command_control_type ret;
1249 enum misc_command_type val;
1257 val = process_next_line (read_next_line_func (), &next, parse_commands,
1258 validator, closure);
1260 /* Ignore blank lines or comments. */
1261 if (val == nop_command)
1264 if (val == end_command)
1266 ret = simple_control;
1270 if (val != ok_command)
1272 ret = invalid_control;
1276 if (multi_line_command_p (next->control_type))
1279 ret = recurse_read_control_structure (read_next_line_func, next,
1280 validator, closure);
1283 if (ret == invalid_control)
1300 if (ret == invalid_control)
1306 /* Free a chain of struct command_line's. */
1309 free_command_lines (struct command_line **lptr)
1311 struct command_line *l = *lptr;
1312 struct command_line *next;
1313 struct command_line **blist;
1318 if (l->body_count > 0)
1320 blist = l->body_list;
1321 for (i = 0; i < l->body_count; i++, blist++)
1322 free_command_lines (blist);
1333 copy_command_lines (struct command_line *cmds)
1335 struct command_line *result = NULL;
1339 result = XNEW (struct command_line);
1341 result->next = copy_command_lines (cmds->next).release ();
1342 result->line = xstrdup (cmds->line);
1343 result->control_type = cmds->control_type;
1344 result->body_count = cmds->body_count;
1345 if (cmds->body_count > 0)
1349 result->body_list = XNEWVEC (struct command_line *, cmds->body_count);
1351 for (i = 0; i < cmds->body_count; i++)
1352 result->body_list[i]
1353 = copy_command_lines (cmds->body_list[i]).release ();
1356 result->body_list = NULL;
1359 return command_line_up (result);
1362 /* Validate that *COMNAME is a valid name for a command. Return the
1363 containing command list, in case it starts with a prefix command.
1364 The prefix must already exist. *COMNAME is advanced to point after
1365 any prefix, and a NUL character overwrites the space after the
1368 static struct cmd_list_element **
1369 validate_comname (char **comname)
1371 struct cmd_list_element **list = &cmdlist;
1372 char *p, *last_word;
1375 error_no_arg (_("name of command to define"));
1377 /* Find the last word of the argument. */
1378 p = *comname + strlen (*comname);
1379 while (p > *comname && isspace (p[-1]))
1381 while (p > *comname && !isspace (p[-1]))
1385 /* Find the corresponding command list. */
1386 if (last_word != *comname)
1388 struct cmd_list_element *c;
1390 const char *tem = *comname;
1392 /* Separate the prefix and the command. */
1393 saved_char = last_word[-1];
1394 last_word[-1] = '\0';
1396 c = lookup_cmd (&tem, cmdlist, "", 0, 1);
1397 if (c->prefixlist == NULL)
1398 error (_("\"%s\" is not a prefix command."), *comname);
1400 list = c->prefixlist;
1401 last_word[-1] = saved_char;
1402 *comname = last_word;
1408 if (!isalnum (*p) && *p != '-' && *p != '_')
1409 error (_("Junk in argument list: \"%s\""), p);
1416 /* This is just a placeholder in the command data structures. */
1418 user_defined_command (const char *ignore, int from_tty)
1423 define_command (char *comname, int from_tty)
1425 #define MAX_TMPBUF 128
1432 struct cmd_list_element *c, *newc, *hookc = 0, **list;
1433 char *tem, *comfull;
1435 char tmpbuf[MAX_TMPBUF];
1436 int hook_type = CMD_NO_HOOK;
1437 int hook_name_size = 0;
1439 #define HOOK_STRING "hook-"
1441 #define HOOK_POST_STRING "hookpost-"
1442 #define HOOK_POST_LEN 9
1445 list = validate_comname (&comname);
1447 /* Look it up, and verify that we got an exact match. */
1449 c = lookup_cmd (&tem_c, *list, "", -1, 1);
1450 if (c && strcmp (comname, c->name) != 0)
1457 if (c->theclass == class_user || c->theclass == class_alias)
1458 q = query (_("Redefine command \"%s\"? "), c->name);
1460 q = query (_("Really redefine built-in command \"%s\"? "), c->name);
1462 error (_("Command \"%s\" not redefined."), c->name);
1465 /* If this new command is a hook, then mark the command which it
1466 is hooking. Note that we allow hooking `help' commands, so that
1467 we can hook the `stop' pseudo-command. */
1469 if (!strncmp (comname, HOOK_STRING, HOOK_LEN))
1471 hook_type = CMD_PRE_HOOK;
1472 hook_name_size = HOOK_LEN;
1474 else if (!strncmp (comname, HOOK_POST_STRING, HOOK_POST_LEN))
1476 hook_type = CMD_POST_HOOK;
1477 hook_name_size = HOOK_POST_LEN;
1480 if (hook_type != CMD_NO_HOOK)
1482 /* Look up cmd it hooks, and verify that we got an exact match. */
1483 tem_c = comname + hook_name_size;
1484 hookc = lookup_cmd (&tem_c, *list, "", -1, 0);
1485 if (hookc && strcmp (comname + hook_name_size, hookc->name) != 0)
1489 warning (_("Your new `%s' command does not "
1490 "hook any existing command."),
1492 if (!query (_("Proceed? ")))
1493 error (_("Not confirmed."));
1497 comname = xstrdup (comname);
1499 xsnprintf (tmpbuf, sizeof (tmpbuf),
1500 "Type commands for definition of \"%s\".", comfull);
1501 command_line_up cmds = read_command_lines (tmpbuf, from_tty, 1, 0, 0);
1503 if (c && c->theclass == class_user)
1504 free_command_lines (&c->user_commands);
1506 newc = add_cmd (comname, class_user, user_defined_command,
1507 (c && c->theclass == class_user)
1508 ? c->doc : xstrdup ("User-defined."), list);
1509 newc->user_commands = cmds.release ();
1511 /* If this new command is a hook, then mark both commands as being
1518 hookc->hook_pre = newc; /* Target gets hooked. */
1519 newc->hookee_pre = hookc; /* We are marked as hooking target cmd. */
1522 hookc->hook_post = newc; /* Target gets hooked. */
1523 newc->hookee_post = hookc; /* We are marked as hooking
1527 /* Should never come here as hookc would be 0. */
1528 internal_error (__FILE__, __LINE__, _("bad switch"));
1534 document_command (char *comname, int from_tty)
1536 struct cmd_list_element *c, **list;
1542 list = validate_comname (&comname);
1545 c = lookup_cmd (&tem, *list, "", 0, 1);
1547 if (c->theclass != class_user)
1548 error (_("Command \"%s\" is built-in."), comfull);
1550 xsnprintf (tmpbuf, sizeof (tmpbuf), "Type documentation for \"%s\".",
1552 command_line_up doclines = read_command_lines (tmpbuf, from_tty, 0, 0, 0);
1555 xfree ((char *) c->doc);
1558 struct command_line *cl1;
1562 for (cl1 = doclines.get (); cl1; cl1 = cl1->next)
1563 len += strlen (cl1->line) + 1;
1565 doc = (char *) xmalloc (len + 1);
1568 for (cl1 = doclines.get (); cl1; cl1 = cl1->next)
1570 strcat (doc, cl1->line);
1579 /* Used to implement source_command. */
1582 script_from_file (FILE *stream, const char *file)
1585 internal_error (__FILE__, __LINE__, _("called with NULL file pointer!"));
1587 scoped_restore restore_line_number
1588 = make_scoped_restore (&source_line_number, 0);
1589 scoped_restore resotre_file
1590 = make_scoped_restore (&source_file_name, file);
1592 scoped_restore save_async = make_scoped_restore (¤t_ui->async, 0);
1596 read_command_file (stream);
1598 CATCH (e, RETURN_MASK_ERROR)
1600 /* Re-throw the error, but with the file name information
1602 throw_error (e.error,
1603 _("%s:%d: Error in sourced command file:\n%s"),
1604 source_file_name, source_line_number, e.message);
1609 /* Print the definition of user command C to STREAM. Or, if C is a
1610 prefix command, show the definitions of all user commands under C
1611 (recursively). PREFIX and NAME combined are the name of the
1614 show_user_1 (struct cmd_list_element *c, const char *prefix, const char *name,
1615 struct ui_file *stream)
1617 struct command_line *cmdlines;
1619 if (c->prefixlist != NULL)
1621 const char *prefixname = c->prefixname;
1623 for (c = *c->prefixlist; c != NULL; c = c->next)
1624 if (c->theclass == class_user || c->prefixlist != NULL)
1625 show_user_1 (c, prefixname, c->name, gdb_stdout);
1629 cmdlines = c->user_commands;
1630 fprintf_filtered (stream, "User command \"%s%s\":\n", prefix, name);
1634 print_command_lines (current_uiout, cmdlines, 1);
1635 fputs_filtered ("\n", stream);
1639 _initialize_cli_script (void)
1641 add_com ("document", class_support, document_command, _("\
1642 Document a user-defined command.\n\
1643 Give command name as argument. Give documentation on following lines.\n\
1644 End with a line of just \"end\"."));
1645 add_com ("define", class_support, define_command, _("\
1646 Define a new command name. Command name is argument.\n\
1647 Definition appears on following lines, one command per line.\n\
1648 End with a line of just \"end\".\n\
1649 Use the \"document\" command to give documentation for the new command.\n\
1650 Commands defined in this way may have up to ten arguments."));
1652 add_com ("while", class_support, while_command, _("\
1653 Execute nested commands WHILE the conditional expression is non zero.\n\
1654 The conditional expression must follow the word `while' and must in turn be\n\
1655 followed by a new line. The nested commands must be entered one per line,\n\
1656 and should be terminated by the word `end'."));
1658 add_com ("if", class_support, if_command, _("\
1659 Execute nested commands once IF the conditional expression is non zero.\n\
1660 The conditional expression must follow the word `if' and must in turn be\n\
1661 followed by a new line. The nested commands must be entered one per line,\n\
1662 and should be terminated by the word 'else' or `end'. If an else clause\n\
1663 is used, the same rules apply to its nested commands as to the first ones."));