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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
|
/* Output generating routines for GDB.
Copyright (C) 1999-2024 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/>. */
#include "defs.h"
#include "expression.h"
#include "language.h"
#include "ui-out.h"
#include "gdbsupport/format.h"
#include "cli/cli-style.h"
#include "diagnostics.h"
#include <vector>
#include <memory>
#include <string>
namespace {
/* A header of a ui_out_table. */
class ui_out_hdr
{
public:
explicit ui_out_hdr (int number, int min_width, ui_align alignment,
const std::string &name, const std::string &header)
: m_number (number),
m_min_width (min_width),
m_alignment (alignment),
m_name (name),
m_header (header)
{
}
int number () const
{
return m_number;
}
int min_width () const
{
return m_min_width;
}
ui_align alignment () const
{
return m_alignment;
}
const std::string &header () const
{
return m_header;
}
const std::string &name () const
{
return m_name;
}
private:
/* The number of the table column this header represents, 1-based. */
int m_number;
/* Minimal column width in characters. May or may not be applicable,
depending on the actual implementation of ui_out. */
int m_min_width;
/* Alignment of the content in the column. May or may not be applicable,
depending on the actual implementation of ui_out. */
ui_align m_alignment;
/* Internal column name, used to internally refer to the column. */
std::string m_name;
/* Printed header text of the column. */
std::string m_header;
};
} // namespace
/* A level of nesting (either a list or a tuple) in a ui_out output. */
class ui_out_level
{
public:
explicit ui_out_level (ui_out_type type)
: m_type (type),
m_field_count (0)
{
}
ui_out_type type () const
{
return m_type;
}
int field_count () const
{
return m_field_count;
}
void inc_field_count ()
{
m_field_count++;
}
private:
/* The type of this level. */
ui_out_type m_type;
/* Count each field; the first element is for non-list fields. */
int m_field_count;
};
/* Tables are special. Maintain a separate structure that tracks
their state. At present an output can only contain a single table
but that restriction might eventually be lifted. */
class ui_out_table
{
public:
/* States (steps) of a table generation. */
enum class state
{
/* We are generating the table headers. */
HEADERS,
/* We are generating the table body. */
BODY,
};
explicit ui_out_table (int entry_level, int nr_cols, const std::string &id)
: m_state (state::HEADERS),
m_entry_level (entry_level),
m_nr_cols (nr_cols),
m_id (id)
{
}
/* Start building the body of the table. */
void start_body ();
/* Add a new header to the table. */
void append_header (int width, ui_align alignment,
const std::string &col_name, const std::string &col_hdr);
void start_row ();
/* Extract the format information for the next header and advance
the header iterator. Return false if there was no next header. */
bool get_next_header (int *colno, int *width, ui_align *alignment,
const char **col_hdr);
bool query_field (int colno, int *width, int *alignment,
const char **col_name) const;
state current_state () const;
int entry_level () const;
private:
state m_state;
/* The level at which each entry of the table is to be found. A row
(a tuple) is made up of entries. Consequently ENTRY_LEVEL is one
above that of the table. */
int m_entry_level;
/* Number of table columns (as specified in the table_begin call). */
int m_nr_cols;
/* String identifying the table (as specified in the table_begin
call). */
std::string m_id;
/* Pointers to the column headers. */
std::vector<std::unique_ptr<ui_out_hdr>> m_headers;
/* Iterator over the headers vector, used when printing successive fields. */
std::vector<std::unique_ptr<ui_out_hdr>>::const_iterator m_headers_iterator;
};
/* See ui-out.h. */
void ui_out_table::start_body ()
{
if (m_state != state::HEADERS)
internal_error (_("extra table_body call not allowed; there must be only "
"one table_body after a table_begin and before a "
"table_end."));
/* Check if the number of defined headers matches the number of expected
columns. */
if (m_headers.size () != m_nr_cols)
internal_error (_("number of headers differ from number of table "
"columns."));
m_state = state::BODY;
m_headers_iterator = m_headers.begin ();
}
/* See ui-out.h. */
void ui_out_table::append_header (int width, ui_align alignment,
const std::string &col_name,
const std::string &col_hdr)
{
if (m_state != state::HEADERS)
internal_error (_("table header must be specified after table_begin and "
"before table_body."));
auto header = std::make_unique<ui_out_hdr> (m_headers.size () + 1,
width, alignment,
col_name, col_hdr);
m_headers.push_back (std::move (header));
}
/* See ui-out.h. */
void ui_out_table::start_row ()
{
m_headers_iterator = m_headers.begin ();
}
/* See ui-out.h. */
bool ui_out_table::get_next_header (int *colno, int *width, ui_align *alignment,
const char **col_hdr)
{
/* There may be no headers at all or we may have used all columns. */
if (m_headers_iterator == m_headers.end ())
return false;
ui_out_hdr *hdr = m_headers_iterator->get ();
*colno = hdr->number ();
*width = hdr->min_width ();
*alignment = hdr->alignment ();
*col_hdr = hdr->header ().c_str ();
/* Advance the header pointer to the next entry. */
m_headers_iterator++;
return true;
}
/* See ui-out.h. */
bool ui_out_table::query_field (int colno, int *width, int *alignment,
const char **col_name) const
{
/* Column numbers are 1-based, so convert to 0-based index. */
int index = colno - 1;
if (index >= 0 && index < m_headers.size ())
{
ui_out_hdr *hdr = m_headers[index].get ();
gdb_assert (colno == hdr->number ());
*width = hdr->min_width ();
*alignment = hdr->alignment ();
*col_name = hdr->name ().c_str ();
return true;
}
else
return false;
}
/* See ui-out.h. */
ui_out_table::state ui_out_table::current_state () const
{
return m_state;
}
/* See ui-out.h. */
int ui_out_table::entry_level () const
{
return m_entry_level;
}
int
ui_out::level () const
{
return m_levels.size ();
}
/* The current (inner most) level. */
ui_out_level *
ui_out::current_level () const
{
return m_levels.back ().get ();
}
/* Create a new level, of TYPE. */
void
ui_out::push_level (ui_out_type type)
{
auto level = std::make_unique<ui_out_level> (type);
m_levels.push_back (std::move (level));
}
/* Discard the current level. TYPE is the type of the level being
discarded. */
void
ui_out::pop_level (ui_out_type type)
{
/* We had better not underflow the buffer. */
gdb_assert (m_levels.size () > 0);
gdb_assert (current_level ()->type () == type);
m_levels.pop_back ();
}
/* Mark beginning of a table. */
void
ui_out::table_begin (int nr_cols, int nr_rows, const std::string &tblid)
{
if (m_table_up != nullptr)
internal_error (_("tables cannot be nested; table_begin found before \
previous table_end."));
m_table_up.reset (new ui_out_table (level () + 1, nr_cols, tblid));
do_table_begin (nr_cols, nr_rows, tblid.c_str ());
}
void
ui_out::table_header (int width, ui_align alignment,
const std::string &col_name, const std::string &col_hdr)
{
if (m_table_up == nullptr)
internal_error (_("table_header outside a table is not valid; it must be \
after a table_begin and before a table_body."));
m_table_up->append_header (width, alignment, col_name, col_hdr);
do_table_header (width, alignment, col_name, col_hdr);
}
void
ui_out::table_body ()
{
if (m_table_up == nullptr)
internal_error (_("table_body outside a table is not valid; it must be "
"after a table_begin and before a table_end."));
m_table_up->start_body ();
do_table_body ();
}
void
ui_out::table_end ()
{
if (m_table_up == nullptr)
internal_error (_("misplaced table_end or missing table_begin."));
do_table_end ();
m_table_up = nullptr;
}
void
ui_out::begin (ui_out_type type, const char *id)
{
/* Be careful to verify the ``field'' before the new tuple/list is
pushed onto the stack. That way the containing list/table/row is
verified and not the newly created tuple/list. This verification
is needed (at least) for the case where a table row entry
contains either a tuple/list. For that case bookkeeping such as
updating the column count or advancing to the next heading still
needs to be performed. */
{
int fldno;
int width;
ui_align align;
verify_field (&fldno, &width, &align);
}
push_level (type);
/* If the push puts us at the same level as a table row entry, we've
got a new table row. Put the header pointer back to the start. */
if (m_table_up != nullptr
&& m_table_up->current_state () == ui_out_table::state::BODY
&& m_table_up->entry_level () == level ())
m_table_up->start_row ();
do_begin (type, id);
}
void
ui_out::end (ui_out_type type)
{
pop_level (type);
do_end (type);
}
void
ui_out::field_signed (const char *fldname, LONGEST value)
{
int fldno;
int width;
ui_align align;
verify_field (&fldno, &width, &align);
do_field_signed (fldno, width, align, fldname, value);
}
void
ui_out::field_fmt_signed (int input_width, ui_align input_align,
const char *fldname, LONGEST value)
{
int fldno;
int width;
ui_align align;
verify_field (&fldno, &width, &align);
do_field_signed (fldno, input_width, input_align, fldname, value);
}
/* See ui-out.h. */
void
ui_out::field_unsigned (const char *fldname, ULONGEST value)
{
int fldno;
int width;
ui_align align;
verify_field (&fldno, &width, &align);
do_field_unsigned (fldno, width, align, fldname, value);
}
/* Documented in ui-out.h. */
void
ui_out::field_core_addr (const char *fldname, struct gdbarch *gdbarch,
CORE_ADDR address)
{
field_string (fldname, print_core_address (gdbarch, address),
address_style.style ());
}
void
ui_out::field_stream (const char *fldname, string_file &stream,
const ui_file_style &style)
{
if (!stream.empty ())
field_string (fldname, stream.c_str (), style);
else
field_skip (fldname);
stream.clear ();
}
/* Used to omit a field. */
void
ui_out::field_skip (const char *fldname)
{
int fldno;
int width;
ui_align align;
verify_field (&fldno, &width, &align);
do_field_skip (fldno, width, align, fldname);
}
void
ui_out::field_string (const char *fldname, const char *string,
const ui_file_style &style)
{
int fldno;
int width;
ui_align align;
verify_field (&fldno, &width, &align);
do_field_string (fldno, width, align, fldname, string, style);
}
/* VARARGS */
void
ui_out::field_fmt (const char *fldname, const char *format, ...)
{
va_list args;
int fldno;
int width;
ui_align align;
verify_field (&fldno, &width, &align);
va_start (args, format);
do_field_fmt (fldno, width, align, fldname, ui_file_style (), format, args);
va_end (args);
}
void
ui_out::field_fmt (const char *fldname, const ui_file_style &style,
const char *format, ...)
{
va_list args;
int fldno;
int width;
ui_align align;
verify_field (&fldno, &width, &align);
va_start (args, format);
do_field_fmt (fldno, width, align, fldname, style, format, args);
va_end (args);
}
void
ui_out::spaces (int numspaces)
{
do_spaces (numspaces);
}
void
ui_out::text (const char *string)
{
do_text (string);
}
void
ui_out::call_do_message (const ui_file_style &style, const char *format,
...)
{
va_list args;
va_start (args, format);
/* Since call_do_message is only used as a helper of vmessage, silence the
warning here once instead of at all call sites in vmessage, if we were
to put a "format" attribute on call_do_message. */
DIAGNOSTIC_PUSH
DIAGNOSTIC_IGNORE_FORMAT_NONLITERAL
do_message (style, format, args);
DIAGNOSTIC_POP
va_end (args);
}
void
ui_out::vmessage (const ui_file_style &in_style, const char *format,
va_list args)
{
format_pieces fpieces (&format, true);
ui_file_style style = in_style;
for (auto &&piece : fpieces)
{
const char *current_substring = piece.string;
gdb_assert (piece.n_int_args >= 0 && piece.n_int_args <= 2);
int intvals[2] = { 0, 0 };
for (int i = 0; i < piece.n_int_args; ++i)
intvals[i] = va_arg (args, int);
/* The only ones we support for now. */
gdb_assert (piece.n_int_args == 0
|| piece.argclass == string_arg
|| piece.argclass == int_arg
|| piece.argclass == long_arg);
switch (piece.argclass)
{
case string_arg:
{
const char *str = va_arg (args, const char *);
switch (piece.n_int_args)
{
case 0:
call_do_message (style, current_substring, str);
break;
case 1:
call_do_message (style, current_substring, intvals[0], str);
break;
case 2:
call_do_message (style, current_substring,
intvals[0], intvals[1], str);
break;
}
}
break;
case wide_string_arg:
gdb_assert_not_reached ("wide_string_arg not supported in vmessage");
break;
case wide_char_arg:
gdb_assert_not_reached ("wide_char_arg not supported in vmessage");
break;
case long_long_arg:
call_do_message (style, current_substring, va_arg (args, long long));
break;
case int_arg:
{
int val = va_arg (args, int);
switch (piece.n_int_args)
{
case 0:
call_do_message (style, current_substring, val);
break;
case 1:
call_do_message (style, current_substring, intvals[0], val);
break;
case 2:
call_do_message (style, current_substring,
intvals[0], intvals[1], val);
break;
}
}
break;
case long_arg:
{
long val = va_arg (args, long);
switch (piece.n_int_args)
{
case 0:
call_do_message (style, current_substring, val);
break;
case 1:
call_do_message (style, current_substring, intvals[0], val);
break;
case 2:
call_do_message (style, current_substring,
intvals[0], intvals[1], val);
break;
}
}
break;
case size_t_arg:
{
size_t val = va_arg (args, size_t);
switch (piece.n_int_args)
{
case 0:
call_do_message (style, current_substring, val);
break;
case 1:
call_do_message (style, current_substring, intvals[0], val);
break;
case 2:
call_do_message (style, current_substring,
intvals[0], intvals[1], val);
break;
}
}
break;
case double_arg:
call_do_message (style, current_substring, va_arg (args, double));
break;
case long_double_arg:
gdb_assert_not_reached ("long_double_arg not supported in vmessage");
break;
case dec32float_arg:
gdb_assert_not_reached ("dec32float_arg not supported in vmessage");
break;
case dec64float_arg:
gdb_assert_not_reached ("dec64float_arg not supported in vmessage");
break;
case dec128float_arg:
gdb_assert_not_reached ("dec128float_arg not supported in vmessage");
break;
case ptr_arg:
switch (current_substring[2])
{
case 'F':
{
gdb_assert (!test_flags (disallow_ui_out_field));
base_field_s *bf = va_arg (args, base_field_s *);
switch (bf->kind)
{
case field_kind::FIELD_SIGNED:
{
auto *f = (signed_field_s *) bf;
field_signed (f->name, f->val);
}
break;
case field_kind::FIELD_STRING:
{
auto *f = (string_field_s *) bf;
field_string (f->name, f->str);
}
break;
}
}
break;
case 's':
{
styled_string_s *ss = va_arg (args, styled_string_s *);
call_do_message (ss->style, "%s", ss->str);
}
break;
case '[':
style = *va_arg (args, const ui_file_style *);
break;
case ']':
{
void *arg = va_arg (args, void *);
gdb_assert (arg == nullptr);
style = {};
}
break;
default:
call_do_message (style, current_substring, va_arg (args, void *));
break;
}
break;
case literal_piece:
/* Print a portion of the format string that has no
directives. Note that this will not include any ordinary
%-specs, but it might include "%%". That is why we use
call_do_message here. Also, we pass a dummy argument
because some platforms have modified GCC to include
-Wformat-security by default, which will warn here if
there is no argument. */
call_do_message (style, current_substring, 0);
break;
default:
internal_error (_("failed internal consistency check"));
}
}
}
void
ui_out::message (const char *format, ...)
{
va_list args;
va_start (args, format);
vmessage (ui_file_style (), format, args);
va_end (args);
}
void
ui_out::wrap_hint (int indent)
{
do_wrap_hint (indent);
}
void
ui_out::flush ()
{
do_flush ();
}
void
ui_out::redirect (ui_file *outstream)
{
do_redirect (outstream);
}
/* Test the flags against the mask given. */
ui_out_flags
ui_out::test_flags (ui_out_flags mask)
{
return m_flags & mask;
}
bool
ui_out::is_mi_like_p () const
{
return do_is_mi_like_p ();
}
/* Verify that the field/tuple/list is correctly positioned. Return
the field number and corresponding alignment (if
available/applicable). */
void
ui_out::verify_field (int *fldno, int *width, ui_align *align)
{
ui_out_level *current = current_level ();
const char *text;
if (m_table_up != nullptr
&& m_table_up->current_state () != ui_out_table::state::BODY)
{
internal_error (_("table_body missing; table fields must be \
specified after table_body and inside a list."));
}
current->inc_field_count ();
if (m_table_up != nullptr
&& m_table_up->current_state () == ui_out_table::state::BODY
&& m_table_up->entry_level () == level ()
&& m_table_up->get_next_header (fldno, width, align, &text))
{
if (*fldno != current->field_count ())
internal_error (_("ui-out internal error in handling headers."));
}
else
{
*width = 0;
*align = ui_noalign;
*fldno = current->field_count ();
}
}
/* Access table field parameters. */
bool
ui_out::query_table_field (int colno, int *width, int *alignment,
const char **col_name)
{
if (m_table_up == nullptr)
return false;
return m_table_up->query_field (colno, width, alignment, col_name);
}
/* The constructor. */
ui_out::ui_out (ui_out_flags flags)
: m_flags (flags)
{
/* Create the ui-out level #1, the default level. */
push_level (ui_out_type_tuple);
}
ui_out::~ui_out ()
{
}
|