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
186
187
188
189
190
|
/* Output generating routines for GDB.
Copyright (C) 1999-2016 Free Software Foundation, Inc.
Contributed by Cygnus Solutions.
Written by Fernando Nasser for Cygnus.
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 UI_OUT_H
#define UI_OUT_H 1
#include <vector>
#include "common/enum-flags.h"
class ui_out_level;
class ui_out_table;
struct ui_file;
/* the current ui_out */
/* FIXME: This should not be a global but something passed down from main.c
or top.c. */
extern struct ui_out **current_ui_current_uiout_ptr (void);
#define current_uiout (*current_ui_current_uiout_ptr ())
/* alignment enum */
enum ui_align
{
ui_left = -1,
ui_center,
ui_right,
ui_noalign
};
/* flags enum */
enum ui_out_flag
{
ui_source_list = (1 << 0),
};
DEF_ENUM_FLAGS_TYPE (ui_out_flag, ui_out_flags);
/* Prototypes for ui-out API. */
/* A result is a recursive data structure consisting of lists and
tuples. */
enum ui_out_type
{
ui_out_type_tuple,
ui_out_type_list
};
extern struct cleanup *make_cleanup_ui_out_table_begin_end (struct ui_out *ui_out,
int nr_cols,
int nr_rows,
const char *tblid);
/* Compatibility wrappers. */
extern struct cleanup *make_cleanup_ui_out_list_begin_end (struct ui_out *uiout,
const char *id);
extern struct cleanup *make_cleanup_ui_out_tuple_begin_end (struct ui_out *uiout,
const char *id);
class ui_out
{
public:
explicit ui_out (ui_out_flags flags = 0);
virtual ~ui_out ();
void push_level (ui_out_type type);
void pop_level (ui_out_type type);
/* A table can be considered a special tuple/list combination with the
implied structure: ``table = { hdr = { header, ... } , body = [ {
field, ... }, ... ] }''. If NR_ROWS is negative then there is at
least one row. */
void table_begin (int nr_cols, int nr_rows, const std::string &tblid);
void table_header (int width, ui_align align, const std::string &col_name,
const std::string &col_hdr);
void table_body ();
void table_end ();
void begin (ui_out_type type, const char *id);
void end (ui_out_type type);
void field_int (const char *fldname, int value);
void field_fmt_int (int width, ui_align align, const char *fldname,
int value);
void field_core_addr (const char *fldname, struct gdbarch *gdbarch,
CORE_ADDR address);
void field_string (const char *fldname, const char *string);
void field_stream (const char *fldname, ui_file *stream);
void field_skip (const char *fldname);
void field_fmt (const char *fldname, const char *format, ...)
ATTRIBUTE_PRINTF (3, 4);
void spaces (int numspaces);
void text (const char *string);
void message (const char *format, ...) ATTRIBUTE_PRINTF (2, 3);
void wrap_hint (const char *identstring);
void flush ();
/* Redirect the output of a ui_out object temporarily. */
int redirect (ui_file *outstream);
ui_out_flags test_flags (ui_out_flags mask);
/* HACK: Code in GDB is currently checking to see the type of ui_out
builder when determining which output to produce. This function is
a hack to encapsulate that test. Once GDB manages to separate the
CLI/MI from the core of GDB the problem should just go away .... */
bool is_mi_like_p ();
bool query_table_field (int colno, int *width, int *alignment,
const char **col_name);
protected:
virtual void do_table_begin (int nbrofcols, int nr_rows, const char *tblid)
= 0;
virtual void do_table_body () = 0;
virtual void do_table_end () = 0;
virtual void do_table_header (int width, ui_align align,
const std::string &col_name,
const std::string &col_hdr) = 0;
virtual void do_begin (ui_out_type type, const char *id) = 0;
virtual void do_end (ui_out_type type) = 0;
virtual void do_field_int (int fldno, int width, ui_align align,
const char *fldname, int value) = 0;
virtual void do_field_skip (int fldno, int width, ui_align align,
const char *fldname) = 0;
virtual void do_field_string (int fldno, int width, ui_align align,
const char *fldname, const char *string) = 0;
virtual void do_field_fmt (int fldno, int width, ui_align align,
const char *fldname, const char *format,
va_list args)
ATTRIBUTE_PRINTF (6,0) = 0;
virtual void do_spaces (int numspaces) = 0;
virtual void do_text (const char *string) = 0;
virtual void do_message (const char *format, va_list args)
ATTRIBUTE_PRINTF (2,0) = 0;
virtual void do_wrap_hint (const char *identstring) = 0;
virtual void do_flush () = 0;
virtual int do_redirect (struct ui_file * outstream) = 0;
/* Set as not MI-like by default. It is overridden in subclasses if
necessary. */
virtual bool do_is_mi_like_p ()
{ return false; }
private:
ui_out_flags m_flags;
/* Vector to store and track the ui-out levels. */
std::vector<std::unique_ptr<ui_out_level>> m_levels;
/* A table, if any. At present only a single table is supported. */
std::unique_ptr<ui_out_table> m_table_up;
void verify_field (int *fldno, int *width, ui_align *align);
int level () const;
ui_out_level *current_level () const;
};
#endif /* UI_OUT_H */
|
