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
, char *args
)
148 struct command_line
*cmd
;
150 if (args
== NULL
&& (type
== if_control
|| type
== while_control
))
151 error (_("if/while commands require arguments."));
152 gdb_assert (args
!= NULL
);
154 cmd
= XNEW (struct command_line
);
156 cmd
->control_type
= type
;
159 cmd
->body_list
= XCNEWVEC (struct command_line
*, cmd
->body_count
);
160 cmd
->line
= xstrdup (args
);
165 /* Build and return a new command structure for the control commands
166 such as "if" and "while". */
168 struct command_line
*
169 get_command_line (enum command_control_type type
, char *arg
)
171 struct command_line
*cmd
;
172 struct cleanup
*old_chain
= NULL
;
174 /* Allocate and build a new command line structure. */
175 cmd
= build_command_line (type
, arg
);
177 old_chain
= make_cleanup_free_command_lines (&cmd
);
179 /* Read in the body of this command. */
180 if (recurse_read_control_structure (read_next_line
, cmd
, 0, 0)
183 warning (_("Error reading in canned sequence of commands."));
184 do_cleanups (old_chain
);
188 discard_cleanups (old_chain
);
192 /* Recursively print a command (including full control structures). */
195 print_command_lines (struct ui_out
*uiout
, struct command_line
*cmd
,
198 struct command_line
*list
;
204 uiout
->spaces (2 * depth
);
206 /* A simple command, print it and continue. */
207 if (list
->control_type
== simple_control
)
209 uiout
->field_string (NULL
, list
->line
);
215 /* loop_continue to jump to the start of a while loop, print it
217 if (list
->control_type
== continue_control
)
219 uiout
->field_string (NULL
, "loop_continue");
225 /* loop_break to break out of a while loop, print it and
227 if (list
->control_type
== break_control
)
229 uiout
->field_string (NULL
, "loop_break");
235 /* A while command. Recursively print its subcommands and
237 if (list
->control_type
== while_control
238 || list
->control_type
== while_stepping_control
)
240 /* For while-stepping, the line includes the 'while-stepping'
241 token. See comment in process_next_line for explanation.
242 Here, take care not print 'while-stepping' twice. */
243 if (list
->control_type
== while_control
)
244 uiout
->field_fmt (NULL
, "while %s", list
->line
);
246 uiout
->field_string (NULL
, list
->line
);
248 print_command_lines (uiout
, *list
->body_list
, depth
+ 1);
250 uiout
->spaces (2 * depth
);
251 uiout
->field_string (NULL
, "end");
257 /* An if command. Recursively print both arms before
259 if (list
->control_type
== if_control
)
261 uiout
->field_fmt (NULL
, "if %s", list
->line
);
264 print_command_lines (uiout
, list
->body_list
[0], depth
+ 1);
266 /* Show the false arm if it exists. */
267 if (list
->body_count
== 2)
270 uiout
->spaces (2 * depth
);
271 uiout
->field_string (NULL
, "else");
273 print_command_lines (uiout
, list
->body_list
[1], depth
+ 1);
277 uiout
->spaces (2 * depth
);
278 uiout
->field_string (NULL
, "end");
284 /* A commands command. Print the breakpoint commands and
286 if (list
->control_type
== commands_control
)
289 uiout
->field_fmt (NULL
, "commands %s", list
->line
);
291 uiout
->field_string (NULL
, "commands");
293 print_command_lines (uiout
, *list
->body_list
, depth
+ 1);
295 uiout
->spaces (2 * depth
);
296 uiout
->field_string (NULL
, "end");
302 if (list
->control_type
== python_control
)
304 uiout
->field_string (NULL
, "python");
306 /* Don't indent python code at all. */
307 print_command_lines (uiout
, *list
->body_list
, 0);
309 uiout
->spaces (2 * depth
);
310 uiout
->field_string (NULL
, "end");
316 if (list
->control_type
== compile_control
)
318 uiout
->field_string (NULL
, "compile expression");
320 print_command_lines (uiout
, *list
->body_list
, 0);
322 uiout
->spaces (2 * depth
);
323 uiout
->field_string (NULL
, "end");
329 if (list
->control_type
== guile_control
)
331 uiout
->field_string (NULL
, "guile");
333 print_command_lines (uiout
, *list
->body_list
, depth
+ 1);
335 uiout
->spaces (2 * depth
);
336 uiout
->field_string (NULL
, "end");
342 /* Ignore illegal command type and try next. */
347 /* Handle pre-post hooks. */
350 clear_hook_in_cleanup (void *data
)
352 struct cmd_list_element
*c
= (struct cmd_list_element
*) data
;
354 c
->hook_in
= 0; /* Allow hook to work again once it is complete. */
358 execute_cmd_pre_hook (struct cmd_list_element
*c
)
360 if ((c
->hook_pre
) && (!c
->hook_in
))
362 struct cleanup
*cleanups
= make_cleanup (clear_hook_in_cleanup
, c
);
363 c
->hook_in
= 1; /* Prevent recursive hooking. */
364 execute_user_command (c
->hook_pre
, (char *) 0);
365 do_cleanups (cleanups
);
370 execute_cmd_post_hook (struct cmd_list_element
*c
)
372 if ((c
->hook_post
) && (!c
->hook_in
))
374 struct cleanup
*cleanups
= make_cleanup (clear_hook_in_cleanup
, c
);
376 c
->hook_in
= 1; /* Prevent recursive hooking. */
377 execute_user_command (c
->hook_post
, (char *) 0);
378 do_cleanups (cleanups
);
382 /* Execute the command in CMD. */
384 do_restore_user_call_depth (void * call_depth
)
386 int *depth
= (int *) call_depth
;
395 execute_user_command (struct cmd_list_element
*c
, char *args
)
397 struct ui
*ui
= current_ui
;
398 struct command_line
*cmdlines
;
399 struct cleanup
*old_chain
;
400 enum command_control_type ret
;
401 static int user_call_depth
= 0;
402 extern unsigned int max_user_call_depth
;
404 cmdlines
= c
->user_commands
;
409 scoped_user_args_level
push_user_args (args
);
411 if (++user_call_depth
> max_user_call_depth
)
412 error (_("Max user call depth exceeded -- command aborted."));
414 old_chain
= make_cleanup (do_restore_user_call_depth
, &user_call_depth
);
416 /* Set the instream to 0, indicating execution of a
417 user-defined function. */
418 make_cleanup (do_restore_instream_cleanup
, ui
->instream
);
421 /* Also set the global in_user_command, so that NULL instream is
422 not confused with Insight. */
425 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
427 command_nest_depth
++;
430 ret
= execute_control_command (cmdlines
);
431 if (ret
!= simple_control
&& ret
!= break_control
)
433 warning (_("Error executing canned sequence of commands."));
436 cmdlines
= cmdlines
->next
;
438 command_nest_depth
--;
439 do_cleanups (old_chain
);
442 /* This function is called every time GDB prints a prompt. It ensures
443 that errors and the like do not confuse the command tracing. */
446 reset_command_nest_depth (void)
448 command_nest_depth
= 1;
451 suppress_next_print_command_trace
= 0;
454 /* Print the command, prefixed with '+' to represent the call depth.
455 This is slightly complicated because this function may be called
456 from execute_command and execute_control_command. Unfortunately
457 execute_command also prints the top level control commands.
458 In these cases execute_command will call execute_control_command
459 via while_command or if_command. Inner levels of 'if' and 'while'
460 are dealt with directly. Therefore we can use these functions
461 to determine whether the command has been printed already or not. */
463 print_command_trace (const char *cmd
)
467 if (suppress_next_print_command_trace
)
469 suppress_next_print_command_trace
= 0;
473 if (!source_verbose
&& !trace_commands
)
476 for (i
=0; i
< command_nest_depth
; i
++)
477 printf_filtered ("+");
479 printf_filtered ("%s\n", cmd
);
482 enum command_control_type
483 execute_control_command (struct command_line
*cmd
)
485 struct command_line
*current
;
487 struct value
*val_mark
;
489 enum command_control_type ret
;
491 /* Start by assuming failure, if a problem is detected, the code
492 below will simply "break" out of the switch. */
493 ret
= invalid_control
;
495 switch (cmd
->control_type
)
499 /* A simple command, execute it and return. */
500 std::string new_line
= insert_user_defined_cmd_args (cmd
->line
);
501 execute_command (&new_line
[0], 0);
502 ret
= cmd
->control_type
;
506 case continue_control
:
507 print_command_trace ("loop_continue");
509 /* Return for "continue", and "break" so we can either
510 continue the loop at the top, or break out. */
511 ret
= cmd
->control_type
;
515 print_command_trace ("loop_break");
517 /* Return for "continue", and "break" so we can either
518 continue the loop at the top, or break out. */
519 ret
= cmd
->control_type
;
524 int len
= strlen (cmd
->line
) + 7;
525 char *buffer
= (char *) alloca (len
);
527 xsnprintf (buffer
, len
, "while %s", cmd
->line
);
528 print_command_trace (buffer
);
530 /* Parse the loop control expression for the while statement. */
531 std::string new_line
= insert_user_defined_cmd_args (cmd
->line
);
532 expression_up expr
= parse_expression (new_line
.c_str ());
534 ret
= simple_control
;
537 /* Keep iterating so long as the expression is true. */
544 /* Evaluate the expression. */
545 val_mark
= value_mark ();
546 val
= evaluate_expression (expr
.get ());
547 cond_result
= value_true (val
);
548 value_free_to_mark (val_mark
);
550 /* If the value is false, then break out of the loop. */
554 /* Execute the body of the while statement. */
555 current
= *cmd
->body_list
;
558 command_nest_depth
++;
559 ret
= execute_control_command (current
);
560 command_nest_depth
--;
562 /* If we got an error, or a "break" command, then stop
564 if (ret
== invalid_control
|| ret
== break_control
)
570 /* If we got a "continue" command, then restart the loop
572 if (ret
== continue_control
)
575 /* Get the next statement. */
576 current
= current
->next
;
580 /* Reset RET so that we don't recurse the break all the way down. */
581 if (ret
== break_control
)
582 ret
= simple_control
;
589 int len
= strlen (cmd
->line
) + 4;
590 char *buffer
= (char *) alloca (len
);
592 xsnprintf (buffer
, len
, "if %s", cmd
->line
);
593 print_command_trace (buffer
);
595 /* Parse the conditional for the if statement. */
596 std::string new_line
= insert_user_defined_cmd_args (cmd
->line
);
597 expression_up expr
= parse_expression (new_line
.c_str ());
600 ret
= simple_control
;
602 /* Evaluate the conditional. */
603 val_mark
= value_mark ();
604 val
= evaluate_expression (expr
.get ());
606 /* Choose which arm to take commands from based on the value
607 of the conditional expression. */
608 if (value_true (val
))
609 current
= *cmd
->body_list
;
610 else if (cmd
->body_count
== 2)
611 current
= *(cmd
->body_list
+ 1);
612 value_free_to_mark (val_mark
);
614 /* Execute commands in the given arm. */
617 command_nest_depth
++;
618 ret
= execute_control_command (current
);
619 command_nest_depth
--;
621 /* If we got an error, get out. */
622 if (ret
!= simple_control
)
625 /* Get the next statement in the body. */
626 current
= current
->next
;
632 case commands_control
:
634 /* Breakpoint commands list, record the commands in the
635 breakpoint's command list and return. */
636 std::string new_line
= insert_user_defined_cmd_args (cmd
->line
);
637 ret
= commands_from_control_command (new_line
.c_str (), cmd
);
641 case compile_control
:
642 eval_compile_command (cmd
, NULL
, cmd
->control_u
.compile
.scope
,
643 cmd
->control_u
.compile
.scope_data
);
644 ret
= simple_control
;
650 eval_ext_lang_from_control_command (cmd
);
651 ret
= simple_control
;
656 warning (_("Invalid control type in canned commands structure."));
663 /* Like execute_control_command, but first set
664 suppress_next_print_command_trace. */
666 enum command_control_type
667 execute_control_command_untraced (struct command_line
*cmd
)
669 suppress_next_print_command_trace
= 1;
670 return execute_control_command (cmd
);
674 /* "while" command support. Executes a body of statements while the
675 loop condition is nonzero. */
678 while_command (char *arg
, int from_tty
)
680 struct command_line
*command
= NULL
;
683 command
= get_command_line (while_control
, arg
);
688 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
690 execute_control_command_untraced (command
);
691 free_command_lines (&command
);
694 /* "if" command support. Execute either the true or false arm depending
695 on the value of the if conditional. */
698 if_command (char *arg
, int from_tty
)
700 struct command_line
*command
= NULL
;
701 struct cleanup
*old_chain
;
704 command
= get_command_line (if_control
, arg
);
709 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
711 execute_control_command_untraced (command
);
712 free_command_lines (&command
);
715 /* Bind the incoming arguments for a user defined command to $arg0,
718 user_args::user_args (const char *command_line
)
722 if (command_line
== NULL
)
725 m_command_line
= command_line
;
726 p
= m_command_line
.c_str ();
730 const char *start_arg
;
735 /* Strip whitespace. */
736 while (*p
== ' ' || *p
== '\t')
739 /* P now points to an argument. */
742 /* Get to the end of this argument. */
745 if (((*p
== ' ' || *p
== '\t')) && !squote
&& !dquote
&& !bsquote
)
774 m_args
.emplace_back (start_arg
, p
- start_arg
);
778 /* Given character string P, return a point to the first argument
779 ($arg), or NULL if P contains no arguments. */
782 locate_arg (const char *p
)
784 while ((p
= strchr (p
, '$')))
786 if (startswith (p
, "$arg")
787 && (isdigit (p
[4]) || p
[4] == 'c'))
794 /* See cli-script.h. */
797 insert_user_defined_cmd_args (const char *line
)
799 /* If we are not in a user-defined command, treat $argc, $arg0, et
800 cetera as normal convenience variables. */
801 if (user_args_stack
.empty ())
804 const std::unique_ptr
<user_args
> &args
= user_args_stack
.back ();
805 return args
->insert_args (line
);
808 /* Insert the user defined arguments stored in user_args into the $arg
809 arguments found in line. */
812 user_args::insert_args (const char *line
) const
814 std::string new_line
;
817 while ((p
= locate_arg (line
)))
819 new_line
.append (line
, p
- line
);
823 new_line
+= std::to_string (m_args
.size ());
832 i
= strtoul (p
+ 4, &tmp
, 10);
833 if ((i
== 0 && tmp
== p
+ 4) || errno
!= 0)
835 else if (i
>= m_args
.size ())
836 error (_("Missing argument %ld in user function."), i
);
839 new_line
.append (m_args
[i
].str
, m_args
[i
].len
);
844 /* Don't forget the tail. */
845 new_line
.append (line
);
851 /* Expand the body_list of COMMAND so that it can hold NEW_LENGTH
852 code bodies. This is typically used when we encounter an "else"
853 clause for an "if" command. */
856 realloc_body_list (struct command_line
*command
, int new_length
)
859 struct command_line
**body_list
;
861 n
= command
->body_count
;
867 body_list
= XCNEWVEC (struct command_line
*, new_length
);
869 memcpy (body_list
, command
->body_list
, sizeof (struct command_line
*) * n
);
871 xfree (command
->body_list
);
872 command
->body_list
= body_list
;
873 command
->body_count
= new_length
;
876 /* Read next line from stdin. Passed to read_command_line_1 and
877 recurse_read_control_structure whenever we need to read commands
881 read_next_line (void)
883 struct ui
*ui
= current_ui
;
884 char *prompt_ptr
, control_prompt
[256];
886 int from_tty
= ui
->instream
== ui
->stdin_stream
;
888 if (control_level
>= 254)
889 error (_("Control nesting too deep!"));
891 /* Set a prompt based on the nesting of the control commands. */
893 || (ui
->instream
== 0 && deprecated_readline_hook
!= NULL
))
895 for (i
= 0; i
< control_level
; i
++)
896 control_prompt
[i
] = ' ';
897 control_prompt
[i
] = '>';
898 control_prompt
[i
+ 1] = '\0';
899 prompt_ptr
= (char *) &control_prompt
[0];
904 return command_line_input (prompt_ptr
, from_tty
, "commands");
907 /* Process one input line. If the command is an "end", return such an
908 indication to the caller. If PARSE_COMMANDS is true, strip leading
909 whitespace (trailing whitespace is always stripped) in the line,
910 attempt to recognize GDB control commands, and also return an
911 indication if the command is an "else" or a nop.
913 Otherwise, only "end" is recognized. */
915 static enum misc_command_type
916 process_next_line (char *p
, struct command_line
**command
, int parse_commands
,
917 void (*validator
)(char *, void *), void *closure
)
923 /* Not sure what to do here. */
927 /* Strip trailing whitespace. */
928 p_end
= p
+ strlen (p
);
929 while (p_end
> p
&& (p_end
[-1] == ' ' || p_end
[-1] == '\t'))
933 /* Strip leading whitespace. */
934 while (p_start
< p_end
&& (*p_start
== ' ' || *p_start
== '\t'))
937 /* 'end' is always recognized, regardless of parse_commands value.
938 We also permit whitespace before end and after. */
939 if (p_end
- p_start
== 3 && startswith (p_start
, "end"))
944 /* If commands are parsed, we skip initial spaces. Otherwise,
945 which is the case for Python commands and documentation
946 (see the 'document' command), spaces are preserved. */
949 /* Blanks and comments don't really do anything, but we need to
950 distinguish them from else, end and other commands which can
952 if (p_end
== p
|| p
[0] == '#')
955 /* Is the else clause of an if control structure? */
956 if (p_end
- p
== 4 && startswith (p
, "else"))
959 /* Check for while, if, break, continue, etc and build a new
960 command line structure for them. */
961 if ((p_end
- p
>= 14 && startswith (p
, "while-stepping"))
962 || (p_end
- p
>= 8 && startswith (p
, "stepping"))
963 || (p_end
- p
>= 2 && startswith (p
, "ws")))
965 /* Because validate_actionline and encode_action lookup
966 command's line as command, we need the line to
967 include 'while-stepping'.
969 For 'ws' alias, the command will have 'ws', not expanded
970 to 'while-stepping'. This is intentional -- we don't
971 really want frontend to send a command list with 'ws',
972 and next break-info returning command line with
973 'while-stepping'. This should work, but might cause the
974 breakpoint to be marked as changed while it's actually
976 *command
= build_command_line (while_stepping_control
, p
);
978 else if (p_end
- p
> 5 && startswith (p
, "while"))
983 while (first_arg
< p_end
&& isspace (*first_arg
))
985 *command
= build_command_line (while_control
, first_arg
);
987 else if (p_end
- p
> 2 && startswith (p
, "if"))
992 while (first_arg
< p_end
&& isspace (*first_arg
))
994 *command
= build_command_line (if_control
, first_arg
);
996 else if (p_end
- p
>= 8 && startswith (p
, "commands"))
1001 while (first_arg
< p_end
&& isspace (*first_arg
))
1003 *command
= build_command_line (commands_control
, first_arg
);
1005 else if (p_end
- p
== 6 && startswith (p
, "python"))
1007 /* Note that we ignore the inline "python command" form
1009 *command
= build_command_line (python_control
, "");
1011 else if (p_end
- p
== 6 && startswith (p
, "compile"))
1013 /* Note that we ignore the inline "compile command" form
1015 *command
= build_command_line (compile_control
, "");
1016 (*command
)->control_u
.compile
.scope
= COMPILE_I_INVALID_SCOPE
;
1019 else if (p_end
- p
== 5 && startswith (p
, "guile"))
1021 /* Note that we ignore the inline "guile command" form here. */
1022 *command
= build_command_line (guile_control
, "");
1024 else if (p_end
- p
== 10 && startswith (p
, "loop_break"))
1026 *command
= XNEW (struct command_line
);
1027 (*command
)->next
= NULL
;
1028 (*command
)->line
= NULL
;
1029 (*command
)->control_type
= break_control
;
1030 (*command
)->body_count
= 0;
1031 (*command
)->body_list
= NULL
;
1033 else if (p_end
- p
== 13 && startswith (p
, "loop_continue"))
1035 *command
= XNEW (struct command_line
);
1036 (*command
)->next
= NULL
;
1037 (*command
)->line
= NULL
;
1038 (*command
)->control_type
= continue_control
;
1039 (*command
)->body_count
= 0;
1040 (*command
)->body_list
= NULL
;
1046 if (!parse_commands
|| not_handled
)
1048 /* A normal command. */
1049 *command
= XNEW (struct command_line
);
1050 (*command
)->next
= NULL
;
1051 (*command
)->line
= savestring (p
, p_end
- p
);
1052 (*command
)->control_type
= simple_control
;
1053 (*command
)->body_count
= 0;
1054 (*command
)->body_list
= NULL
;
1062 validator ((*command
)->line
, closure
);
1064 CATCH (ex
, RETURN_MASK_ALL
)
1067 throw_exception (ex
);
1072 /* Nothing special. */
1076 /* Recursively read in the control structures and create a
1077 command_line structure from them. Use read_next_line_func to
1078 obtain lines of the command. */
1080 static enum command_control_type
1081 recurse_read_control_structure (char * (*read_next_line_func
) (void),
1082 struct command_line
*current_cmd
,
1083 void (*validator
)(char *, void *),
1086 int current_body
, i
;
1087 enum misc_command_type val
;
1088 enum command_control_type ret
;
1089 struct command_line
**body_ptr
, *child_tail
, *next
;
1094 /* Sanity checks. */
1095 if (current_cmd
->control_type
== simple_control
)
1096 error (_("Recursed on a simple control type."));
1098 if (current_body
> current_cmd
->body_count
)
1099 error (_("Allocated body is smaller than this command type needs."));
1101 /* Read lines from the input stream and build control structures. */
1107 val
= process_next_line (read_next_line_func (), &next
,
1108 current_cmd
->control_type
!= python_control
1109 && current_cmd
->control_type
!= guile_control
1110 && current_cmd
->control_type
!= compile_control
,
1111 validator
, closure
);
1113 /* Just skip blanks and comments. */
1114 if (val
== nop_command
)
1117 if (val
== end_command
)
1119 if (multi_line_command_p (current_cmd
->control_type
))
1121 /* Success reading an entire canned sequence of commands. */
1122 ret
= simple_control
;
1127 ret
= invalid_control
;
1132 /* Not the end of a control structure. */
1133 if (val
== else_command
)
1135 if (current_cmd
->control_type
== if_control
1136 && current_body
== 1)
1138 realloc_body_list (current_cmd
, 2);
1145 ret
= invalid_control
;
1152 child_tail
->next
= next
;
1156 body_ptr
= current_cmd
->body_list
;
1157 for (i
= 1; i
< current_body
; i
++)
1166 /* If the latest line is another control structure, then recurse
1168 if (multi_line_command_p (next
->control_type
))
1171 ret
= recurse_read_control_structure (read_next_line_func
, next
,
1172 validator
, closure
);
1175 if (ret
!= simple_control
)
1186 restore_interp (void *arg
)
1188 interp_set_temp (interp_name ((struct interp
*)arg
));
1191 /* Read lines from the input stream and accumulate them in a chain of
1192 struct command_line's, which is then returned. For input from a
1193 terminal, the special command "end" is used to mark the end of the
1194 input, and is not included in the returned chain of commands.
1196 If PARSE_COMMANDS is true, strip leading whitespace (trailing whitespace
1197 is always stripped) in the line and attempt to recognize GDB control
1198 commands. Otherwise, only "end" is recognized. */
1200 #define END_MESSAGE "End with a line saying just \"end\"."
1202 struct command_line
*
1203 read_command_lines (char *prompt_arg
, int from_tty
, int parse_commands
,
1204 void (*validator
)(char *, void *), void *closure
)
1206 struct command_line
*head
;
1208 if (from_tty
&& input_interactive_p (current_ui
))
1210 if (deprecated_readline_begin_hook
)
1212 /* Note - intentional to merge messages with no newline. */
1213 (*deprecated_readline_begin_hook
) ("%s %s\n", prompt_arg
,
1218 printf_unfiltered ("%s\n%s\n", prompt_arg
, END_MESSAGE
);
1219 gdb_flush (gdb_stdout
);
1224 /* Reading commands assumes the CLI behavior, so temporarily
1225 override the current interpreter with CLI. */
1226 if (current_interp_named_p (INTERP_CONSOLE
))
1227 head
= read_command_lines_1 (read_next_line
, parse_commands
,
1228 validator
, closure
);
1231 struct interp
*old_interp
= interp_set_temp (INTERP_CONSOLE
);
1232 struct cleanup
*old_chain
= make_cleanup (restore_interp
, old_interp
);
1234 head
= read_command_lines_1 (read_next_line
, parse_commands
,
1235 validator
, closure
);
1236 do_cleanups (old_chain
);
1239 if (from_tty
&& input_interactive_p (current_ui
)
1240 && deprecated_readline_end_hook
)
1242 (*deprecated_readline_end_hook
) ();
1247 /* Act the same way as read_command_lines, except that each new line is
1248 obtained using READ_NEXT_LINE_FUNC. */
1250 struct command_line
*
1251 read_command_lines_1 (char * (*read_next_line_func
) (void), int parse_commands
,
1252 void (*validator
)(char *, void *), void *closure
)
1254 struct command_line
*head
, *tail
, *next
;
1255 struct cleanup
*old_chain
= make_cleanup (null_cleanup
, NULL
);
1256 enum command_control_type ret
;
1257 enum misc_command_type val
;
1265 val
= process_next_line (read_next_line_func (), &next
, parse_commands
,
1266 validator
, closure
);
1268 /* Ignore blank lines or comments. */
1269 if (val
== nop_command
)
1272 if (val
== end_command
)
1274 ret
= simple_control
;
1278 if (val
!= ok_command
)
1280 ret
= invalid_control
;
1284 if (multi_line_command_p (next
->control_type
))
1287 ret
= recurse_read_control_structure (read_next_line_func
, next
,
1288 validator
, closure
);
1291 if (ret
== invalid_control
)
1302 make_cleanup_free_command_lines (&head
);
1309 if (ret
!= invalid_control
)
1310 discard_cleanups (old_chain
);
1312 do_cleanups (old_chain
);
1317 /* Free a chain of struct command_line's. */
1320 free_command_lines (struct command_line
**lptr
)
1322 struct command_line
*l
= *lptr
;
1323 struct command_line
*next
;
1324 struct command_line
**blist
;
1329 if (l
->body_count
> 0)
1331 blist
= l
->body_list
;
1332 for (i
= 0; i
< l
->body_count
; i
++, blist
++)
1333 free_command_lines (blist
);
1344 do_free_command_lines_cleanup (void *arg
)
1346 free_command_lines ((struct command_line
**) arg
);
1350 make_cleanup_free_command_lines (struct command_line
**arg
)
1352 return make_cleanup (do_free_command_lines_cleanup
, arg
);
1355 struct command_line
*
1356 copy_command_lines (struct command_line
*cmds
)
1358 struct command_line
*result
= NULL
;
1362 result
= XNEW (struct command_line
);
1364 result
->next
= copy_command_lines (cmds
->next
);
1365 result
->line
= xstrdup (cmds
->line
);
1366 result
->control_type
= cmds
->control_type
;
1367 result
->body_count
= cmds
->body_count
;
1368 if (cmds
->body_count
> 0)
1372 result
->body_list
= XNEWVEC (struct command_line
*, cmds
->body_count
);
1374 for (i
= 0; i
< cmds
->body_count
; i
++)
1375 result
->body_list
[i
] = copy_command_lines (cmds
->body_list
[i
]);
1378 result
->body_list
= NULL
;
1384 /* Validate that *COMNAME is a valid name for a command. Return the
1385 containing command list, in case it starts with a prefix command.
1386 The prefix must already exist. *COMNAME is advanced to point after
1387 any prefix, and a NUL character overwrites the space after the
1390 static struct cmd_list_element
**
1391 validate_comname (char **comname
)
1393 struct cmd_list_element
**list
= &cmdlist
;
1394 char *p
, *last_word
;
1397 error_no_arg (_("name of command to define"));
1399 /* Find the last word of the argument. */
1400 p
= *comname
+ strlen (*comname
);
1401 while (p
> *comname
&& isspace (p
[-1]))
1403 while (p
> *comname
&& !isspace (p
[-1]))
1407 /* Find the corresponding command list. */
1408 if (last_word
!= *comname
)
1410 struct cmd_list_element
*c
;
1412 const char *tem
= *comname
;
1414 /* Separate the prefix and the command. */
1415 saved_char
= last_word
[-1];
1416 last_word
[-1] = '\0';
1418 c
= lookup_cmd (&tem
, cmdlist
, "", 0, 1);
1419 if (c
->prefixlist
== NULL
)
1420 error (_("\"%s\" is not a prefix command."), *comname
);
1422 list
= c
->prefixlist
;
1423 last_word
[-1] = saved_char
;
1424 *comname
= last_word
;
1430 if (!isalnum (*p
) && *p
!= '-' && *p
!= '_')
1431 error (_("Junk in argument list: \"%s\""), p
);
1438 /* This is just a placeholder in the command data structures. */
1440 user_defined_command (char *ignore
, int from_tty
)
1445 define_command (char *comname
, int from_tty
)
1447 #define MAX_TMPBUF 128
1454 struct command_line
*cmds
;
1455 struct cmd_list_element
*c
, *newc
, *hookc
= 0, **list
;
1456 char *tem
, *comfull
;
1458 char tmpbuf
[MAX_TMPBUF
];
1459 int hook_type
= CMD_NO_HOOK
;
1460 int hook_name_size
= 0;
1462 #define HOOK_STRING "hook-"
1464 #define HOOK_POST_STRING "hookpost-"
1465 #define HOOK_POST_LEN 9
1468 list
= validate_comname (&comname
);
1470 /* Look it up, and verify that we got an exact match. */
1472 c
= lookup_cmd (&tem_c
, *list
, "", -1, 1);
1473 if (c
&& strcmp (comname
, c
->name
) != 0)
1480 if (c
->theclass
== class_user
|| c
->theclass
== class_alias
)
1481 q
= query (_("Redefine command \"%s\"? "), c
->name
);
1483 q
= query (_("Really redefine built-in command \"%s\"? "), c
->name
);
1485 error (_("Command \"%s\" not redefined."), c
->name
);
1488 /* If this new command is a hook, then mark the command which it
1489 is hooking. Note that we allow hooking `help' commands, so that
1490 we can hook the `stop' pseudo-command. */
1492 if (!strncmp (comname
, HOOK_STRING
, HOOK_LEN
))
1494 hook_type
= CMD_PRE_HOOK
;
1495 hook_name_size
= HOOK_LEN
;
1497 else if (!strncmp (comname
, HOOK_POST_STRING
, HOOK_POST_LEN
))
1499 hook_type
= CMD_POST_HOOK
;
1500 hook_name_size
= HOOK_POST_LEN
;
1503 if (hook_type
!= CMD_NO_HOOK
)
1505 /* Look up cmd it hooks, and verify that we got an exact match. */
1506 tem_c
= comname
+ hook_name_size
;
1507 hookc
= lookup_cmd (&tem_c
, *list
, "", -1, 0);
1508 if (hookc
&& strcmp (comname
+ hook_name_size
, hookc
->name
) != 0)
1512 warning (_("Your new `%s' command does not "
1513 "hook any existing command."),
1515 if (!query (_("Proceed? ")))
1516 error (_("Not confirmed."));
1520 comname
= xstrdup (comname
);
1522 /* If the rest of the commands will be case insensitive, this one
1523 should behave in the same manner. */
1524 for (tem
= comname
; *tem
; tem
++)
1526 *tem
= tolower (*tem
);
1528 xsnprintf (tmpbuf
, sizeof (tmpbuf
),
1529 "Type commands for definition of \"%s\".", comfull
);
1530 cmds
= read_command_lines (tmpbuf
, from_tty
, 1, 0, 0);
1532 if (c
&& c
->theclass
== class_user
)
1533 free_command_lines (&c
->user_commands
);
1535 newc
= add_cmd (comname
, class_user
, user_defined_command
,
1536 (c
&& c
->theclass
== class_user
)
1537 ? c
->doc
: xstrdup ("User-defined."), list
);
1538 newc
->user_commands
= cmds
;
1540 /* If this new command is a hook, then mark both commands as being
1547 hookc
->hook_pre
= newc
; /* Target gets hooked. */
1548 newc
->hookee_pre
= hookc
; /* We are marked as hooking target cmd. */
1551 hookc
->hook_post
= newc
; /* Target gets hooked. */
1552 newc
->hookee_post
= hookc
; /* We are marked as hooking
1556 /* Should never come here as hookc would be 0. */
1557 internal_error (__FILE__
, __LINE__
, _("bad switch"));
1563 document_command (char *comname
, int from_tty
)
1565 struct command_line
*doclines
;
1566 struct cmd_list_element
*c
, **list
;
1572 list
= validate_comname (&comname
);
1575 c
= lookup_cmd (&tem
, *list
, "", 0, 1);
1577 if (c
->theclass
!= class_user
)
1578 error (_("Command \"%s\" is built-in."), comfull
);
1580 xsnprintf (tmpbuf
, sizeof (tmpbuf
), "Type documentation for \"%s\".",
1582 doclines
= read_command_lines (tmpbuf
, from_tty
, 0, 0, 0);
1585 xfree ((char *) c
->doc
);
1588 struct command_line
*cl1
;
1592 for (cl1
= doclines
; cl1
; cl1
= cl1
->next
)
1593 len
+= strlen (cl1
->line
) + 1;
1595 doc
= (char *) xmalloc (len
+ 1);
1598 for (cl1
= doclines
; cl1
; cl1
= cl1
->next
)
1600 strcat (doc
, cl1
->line
);
1608 free_command_lines (&doclines
);
1611 struct source_cleanup_lines_args
1614 const char *old_file
;
1618 source_cleanup_lines (void *args
)
1620 struct source_cleanup_lines_args
*p
=
1621 (struct source_cleanup_lines_args
*) args
;
1623 source_line_number
= p
->old_line
;
1624 source_file_name
= p
->old_file
;
1627 /* Used to implement source_command. */
1630 script_from_file (FILE *stream
, const char *file
)
1632 struct cleanup
*old_cleanups
;
1633 struct source_cleanup_lines_args old_lines
;
1636 internal_error (__FILE__
, __LINE__
, _("called with NULL file pointer!"));
1638 old_lines
.old_line
= source_line_number
;
1639 old_lines
.old_file
= source_file_name
;
1640 old_cleanups
= make_cleanup (source_cleanup_lines
, &old_lines
);
1641 source_line_number
= 0;
1642 source_file_name
= file
;
1645 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
1649 read_command_file (stream
);
1651 CATCH (e
, RETURN_MASK_ERROR
)
1653 /* Re-throw the error, but with the file name information
1655 throw_error (e
.error
,
1656 _("%s:%d: Error in sourced command file:\n%s"),
1657 source_file_name
, source_line_number
, e
.message
);
1662 do_cleanups (old_cleanups
);
1665 /* Print the definition of user command C to STREAM. Or, if C is a
1666 prefix command, show the definitions of all user commands under C
1667 (recursively). PREFIX and NAME combined are the name of the
1670 show_user_1 (struct cmd_list_element
*c
, const char *prefix
, const char *name
,
1671 struct ui_file
*stream
)
1673 struct command_line
*cmdlines
;
1675 if (c
->prefixlist
!= NULL
)
1677 const char *prefixname
= c
->prefixname
;
1679 for (c
= *c
->prefixlist
; c
!= NULL
; c
= c
->next
)
1680 if (c
->theclass
== class_user
|| c
->prefixlist
!= NULL
)
1681 show_user_1 (c
, prefixname
, c
->name
, gdb_stdout
);
1685 cmdlines
= c
->user_commands
;
1686 fprintf_filtered (stream
, "User command \"%s%s\":\n", prefix
, name
);
1690 print_command_lines (current_uiout
, cmdlines
, 1);
1691 fputs_filtered ("\n", stream
);
1696 initialize_file_ftype _initialize_cli_script
;
1699 _initialize_cli_script (void)
1701 add_com ("document", class_support
, document_command
, _("\
1702 Document a user-defined command.\n\
1703 Give command name as argument. Give documentation on following lines.\n\
1704 End with a line of just \"end\"."));
1705 add_com ("define", class_support
, define_command
, _("\
1706 Define a new command name. Command name is argument.\n\
1707 Definition appears on following lines, one command per line.\n\
1708 End with a line of just \"end\".\n\
1709 Use the \"document\" command to give documentation for the new command.\n\
1710 Commands defined in this way may have up to ten arguments."));
1712 add_com ("while", class_support
, while_command
, _("\
1713 Execute nested commands WHILE the conditional expression is non zero.\n\
1714 The conditional expression must follow the word `while' and must in turn be\n\
1715 followed by a new line. The nested commands must be entered one per line,\n\
1716 and should be terminated by the word `end'."));
1718 add_com ("if", class_support
, if_command
, _("\
1719 Execute nested commands once IF the conditional expression is non zero.\n\
1720 The conditional expression must follow the word `if' and must in turn be\n\
1721 followed by a new line. The nested commands must be entered one per line,\n\
1722 and should be terminated by the word 'else' or `end'. If an else clause\n\
1723 is used, the same rules apply to its nested commands as to the first ones."));