1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
/* Header file for GDB CLI command implementation library.
Copyright (C) 2000-2024 Free Software Foundation, Inc.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#ifndef CLI_CLI_SCRIPT_H
#define CLI_CLI_SCRIPT_H
#include "compile/compile.h"
#include "gdbsupport/function-view.h"
struct ui_file;
struct cmd_list_element;
/* * Control types for commands. */
enum misc_command_type
{
ok_command,
end_command,
else_command,
nop_command
};
enum command_control_type
{
simple_control,
break_control,
continue_control,
while_control,
if_control,
commands_control,
python_control,
compile_control,
guile_control,
while_stepping_control,
define_control,
document_control,
invalid_control
};
struct command_line;
extern void free_command_lines (struct command_line **);
/* A deleter for command_line that calls free_command_lines. */
struct command_lines_deleter
{
void operator() (command_line *cmd_lines) const
{
free_command_lines (&cmd_lines);
}
};
/* A reference-counted struct command_line. */
typedef std::shared_ptr<command_line> counted_command_line;
/* A unique_ptr specialization for command_line. */
typedef std::unique_ptr<command_line, command_lines_deleter> command_line_up;
/* * Structure for saved commands lines (for breakpoints, defined
commands, etc). */
struct command_line
{
explicit command_line (command_control_type type_, char *line_ = nullptr)
: line (line_),
control_type (type_)
{
memset (&control_u, 0, sizeof (control_u));
}
DISABLE_COPY_AND_ASSIGN (command_line);
struct command_line *next = nullptr;
char *line;
enum command_control_type control_type;
union
{
struct
{
enum compile_i_scope_types scope;
void *scope_data;
}
compile;
}
control_u;
/* * For composite commands, the nested lists of commands. For
example, for "if" command this will contain the then branch and
the else branch, if that is available. */
counted_command_line body_list_0;
counted_command_line body_list_1;
private:
friend void free_command_lines (struct command_line **);
~command_line ()
{
xfree (line);
}
};
/* Prototype for a function to call to get one more input line.
If the function needs to return a dynamically allocated string, it can place
in the passed-in buffer, and return a pointer to it. Otherwise, it can
simply ignore it. */
using read_next_line_ftype = gdb::function_view<const char * (std::string &)>;
extern counted_command_line read_command_lines
(const char *, int, int, gdb::function_view<void (const char *)>);
extern counted_command_line read_command_lines_1
(read_next_line_ftype, int, gdb::function_view<void (const char *)>);
/* Exported to cli/cli-cmds.c */
extern void script_from_file (FILE *stream, const char *file);
extern void show_user_1 (struct cmd_list_element *c,
const char *prefix,
const char *name,
struct ui_file *stream);
/* Execute the commands in CMDLINES. */
extern void execute_control_commands (struct command_line *cmdlines,
int from_tty);
/* Run execute_control_commands for COMMANDS. Capture its output into
the returned string, do not display it to the screen. BATCH_FLAG
will be temporarily set to true. */
extern std::string execute_control_commands_to_string
(struct command_line *commands, int from_tty);
/* Exported to gdb/breakpoint.c */
extern enum command_control_type
execute_control_command (struct command_line *cmd,
int from_tty = 0);
extern enum command_control_type
execute_control_command_untraced (struct command_line *cmd);
extern counted_command_line get_command_line (enum command_control_type,
const char *);
extern void print_command_lines (struct ui_out *,
struct command_line *, unsigned int);
/* Exported to gdb/infrun.c */
extern void execute_user_command (struct cmd_list_element *c, const char *args);
/* If we're in a user-defined command, replace any $argc/$argN
reference found in LINE with the arguments that were passed to the
command. Otherwise, treat $argc/$argN as normal convenience
variables. */
extern std::string insert_user_defined_cmd_args (const char *line);
/* Exported to top.c */
extern void print_command_trace (const char *cmd, ...)
ATTRIBUTE_PRINTF (1, 2);
/* Exported to event-top.c */
extern void reset_command_nest_depth (void);
#endif /* CLI_CLI_SCRIPT_H */
|
