Commit | Line | Data |
---|---|---|
d318976c | 1 | /* Header file for GDB CLI command implementation library. |
e2882c85 | 2 | Copyright (C) 2000-2018 Free Software Foundation, Inc. |
d318976c FN |
3 | |
4 | This program is free software; you can redistribute it and/or modify | |
5 | it under the terms of the GNU General Public License as published by | |
a9762ec7 | 6 | the Free Software Foundation; either version 3 of the License, or |
d318976c FN |
7 | (at your option) any later version. |
8 | ||
9 | This program is distributed in the hope that it will be useful, | |
10 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
12 | GNU General Public License for more details. | |
13 | ||
14 | You should have received a copy of the GNU General Public License | |
a9762ec7 | 15 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
d318976c FN |
16 | |
17 | #if !defined (CLI_SCRIPT_H) | |
18 | #define CLI_SCRIPT_H 1 | |
19 | ||
da3331ec | 20 | struct ui_file; |
da3331ec AC |
21 | struct cmd_list_element; |
22 | ||
6b66338c SM |
23 | /* * Control types for commands. */ |
24 | ||
25 | enum misc_command_type | |
26 | { | |
27 | ok_command, | |
28 | end_command, | |
29 | else_command, | |
30 | nop_command | |
31 | }; | |
32 | ||
33 | enum command_control_type | |
34 | { | |
35 | simple_control, | |
36 | break_control, | |
37 | continue_control, | |
38 | while_control, | |
39 | if_control, | |
40 | commands_control, | |
41 | python_control, | |
42 | compile_control, | |
43 | guile_control, | |
44 | while_stepping_control, | |
45 | invalid_control | |
46 | }; | |
47 | ||
48 | /* * Structure for saved commands lines (for breakpoints, defined | |
49 | commands, etc). */ | |
50 | ||
51 | struct command_line | |
52 | { | |
53 | struct command_line *next; | |
54 | char *line; | |
55 | enum command_control_type control_type; | |
56 | union | |
57 | { | |
58 | struct | |
59 | { | |
60 | enum compile_i_scope_types scope; | |
61 | void *scope_data; | |
62 | } | |
63 | compile; | |
64 | } | |
65 | control_u; | |
66 | /* * The number of elements in body_list. */ | |
67 | int body_count; | |
68 | /* * For composite commands, the nested lists of commands. For | |
69 | example, for "if" command this will contain the then branch and | |
70 | the else branch, if that is available. */ | |
71 | struct command_line **body_list; | |
72 | }; | |
73 | ||
74 | extern void free_command_lines (struct command_line **); | |
75 | ||
76 | /* A deleter for command_line that calls free_command_lines. */ | |
77 | ||
78 | struct command_lines_deleter | |
79 | { | |
80 | void operator() (command_line *cmd_lines) const | |
81 | { | |
82 | free_command_lines (&cmd_lines); | |
83 | } | |
84 | }; | |
85 | ||
86 | /* A unique pointer to a command_line. */ | |
87 | ||
88 | typedef std::unique_ptr<command_line, command_lines_deleter> command_line_up; | |
89 | ||
90 | extern command_line_up read_command_lines (char *, int, int, | |
91 | void (*)(char *, void *), | |
92 | void *); | |
93 | extern command_line_up read_command_lines_1 (char * (*) (void), int, | |
94 | void (*)(char *, void *), | |
95 | void *); | |
96 | ||
97 | ||
d318976c FN |
98 | /* Exported to cli/cli-cmds.c */ |
99 | ||
05159abe | 100 | extern void script_from_file (FILE *stream, const char *file); |
d318976c | 101 | |
6f937416 PA |
102 | extern void show_user_1 (struct cmd_list_element *c, |
103 | const char *prefix, | |
104 | const char *name, | |
105 | struct ui_file *stream); | |
d318976c FN |
106 | |
107 | /* Exported to gdb/breakpoint.c */ | |
108 | ||
109 | extern enum command_control_type | |
110 | execute_control_command (struct command_line *cmd); | |
111 | ||
d57a3c85 TJB |
112 | extern enum command_control_type |
113 | execute_control_command_untraced (struct command_line *cmd); | |
114 | ||
93921405 TT |
115 | extern command_line_up get_command_line (enum command_control_type, |
116 | const char *); | |
d57a3c85 | 117 | |
d318976c FN |
118 | extern void print_command_lines (struct ui_out *, |
119 | struct command_line *, unsigned int); | |
d318976c | 120 | |
93921405 | 121 | extern command_line_up copy_command_lines (struct command_line *cmds); |
6c50ab1c | 122 | |
d318976c FN |
123 | /* Exported to gdb/infrun.c */ |
124 | ||
95a6b0a1 | 125 | extern void execute_user_command (struct cmd_list_element *c, const char *args); |
d318976c | 126 | |
01770bbd PA |
127 | /* If we're in a user-defined command, replace any $argc/$argN |
128 | reference found in LINE with the arguments that were passed to the | |
129 | command. Otherwise, treat $argc/$argN as normal convenience | |
130 | variables. */ | |
131 | extern std::string insert_user_defined_cmd_args (const char *line); | |
132 | ||
16026cd7 AS |
133 | /* Exported to top.c */ |
134 | ||
135 | extern void print_command_trace (const char *cmd); | |
136 | ||
137 | /* Exported to event-top.c */ | |
138 | ||
139 | extern void reset_command_nest_depth (void); | |
140 | ||
d318976c | 141 | #endif /* !defined (CLI_SCRIPT_H) */ |