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
|
/* Python implementation of ui_out
Copyright (C) 2023-2024 Free Software Foundation, Inc.
This file is part of GDB.
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 GDB_PYTHON_PY_UIOUT_H
#define GDB_PYTHON_PY_UIOUT_H
#include "python-internal.h"
#include "ui-out.h"
/* A ui_out subclass that creates a Python object based on the data
that is passed in. */
class py_ui_out : public ui_out
{
public:
py_ui_out ()
: ui_out (fix_multi_location_breakpoint_output
| fix_breakpoint_script_output)
{
do_begin (ui_out_type_tuple, nullptr);
}
bool can_emit_style_escape () const override
{ return false; }
bool do_is_mi_like_p () const override
{ return true; }
/* Return the Python object that was created. If a Python error
occurred during the processing, set the Python error and return
nullptr. */
gdbpy_ref<> result ()
{
if (m_error.has_value ())
{
m_error->restore ();
return nullptr;
}
return std::move (current ().obj);
}
ui_file *current_stream () const override
{ return nullptr; }
protected:
void do_progress_end () override { }
void do_progress_start () override { }
void do_progress_notify (const std::string &, const char *, double, double)
override
{ }
void do_table_begin (int nbrofcols, int nr_rows, const char *tblid) override
{
do_begin (ui_out_type_list, tblid);
}
void do_table_body () override
{ }
void do_table_end () override
{
do_end (ui_out_type_list);
}
void do_table_header (int width, ui_align align,
const std::string &col_name,
const std::string &col_hdr) override
{ }
void do_begin (ui_out_type type, const char *id) override;
void do_end (ui_out_type type) override;
void do_field_signed (int fldno, int width, ui_align align,
const char *fldname, LONGEST value,
const ui_file_style &style) override;
void do_field_unsigned (int fldno, int width, ui_align align,
const char *fldname, ULONGEST value) override;
void do_field_skip (int fldno, int width, ui_align align,
const char *fldname) override
{ }
void do_field_string (int fldno, int width, ui_align align,
const char *fldname, const char *string,
const ui_file_style &style) override;
void do_field_fmt (int fldno, int width, ui_align align,
const char *fldname, const ui_file_style &style,
const char *format, va_list args) override
ATTRIBUTE_PRINTF (7, 0);
void do_spaces (int numspaces) override
{ }
void do_text (const char *string) override
{ }
void do_message (const ui_file_style &style,
const char *format, va_list args)
override ATTRIBUTE_PRINTF (3,0)
{ }
void do_wrap_hint (int indent) override
{ }
void do_flush () override
{ }
void do_redirect (struct ui_file *outstream) override
{ }
private:
/* When constructing Python objects, this class keeps a stack of
objects being constructed. Each such object has this type. */
struct object_desc
{
/* Name of the field (or empty for lists) that this object will
eventually become. */
std::string field_name;
/* The object under construction. */
gdbpy_ref<> obj;
/* The type of structure being created. Note that tables are
treated as lists here. */
ui_out_type type;
};
/* The stack of objects being created. */
std::vector<object_desc> m_objects;
/* If an error occurred, this holds the exception information for
use by the 'release' method. */
std::optional<gdbpy_err_fetch> m_error;
/* Return a reference to the object under construction. */
object_desc ¤t ()
{ return m_objects.back (); }
/* Add a new field to the current object under construction. */
void add_field (const char *name, const gdbpy_ref<> &obj);
};
#endif /* GDB_PYTHON_PY_UIOUT_H */
|
