2007-07-03 Paul Gilliam <pgilliam@us.ibm.com>
[deliverable/binutils-gdb.git] / gdb / ui-out.c
1 /* Output generating routines for GDB.
2
3 Copyright (C) 1999, 2000, 2001, 2002, 2004, 2005, 2007
4 Free Software Foundation, Inc.
5
6 Contributed by Cygnus Solutions.
7 Written by Fernando Nasser for Cygnus.
8
9 This file is part of GDB.
10
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 2 of the License, or
14 (at your option) any later version.
15
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
20
21 You should have received a copy of the GNU General Public License
22 along with this program; if not, write to the Free Software
23 Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 Boston, MA 02110-1301, USA. */
25
26 #include "defs.h"
27 #include "gdb_string.h"
28 #include "expression.h" /* For language.h */
29 #include "language.h"
30 #include "ui-out.h"
31 #include "gdb_assert.h"
32
33 /* table header structures */
34
35 struct ui_out_hdr
36 {
37 int colno;
38 int width;
39 int alignment;
40 char *col_name;
41 char *colhdr;
42 struct ui_out_hdr *next;
43 };
44
45 /* Maintain a stack so that the info applicable to the inner most list
46 is always available. Stack/nested level 0 is reserved for the
47 top-level result. */
48
49 enum { MAX_UI_OUT_LEVELS = 6 };
50
51 struct ui_out_level
52 {
53 /* Count each field; the first element is for non-list fields */
54 int field_count;
55 /* The type of this level. */
56 enum ui_out_type type;
57 };
58
59 /* Tables are special. Maintain a separate structure that tracks
60 their state. At present an output can only contain a single table
61 but that restriction might eventually be lifted. */
62
63 struct ui_out_table
64 {
65 /* If on, a table is being generated. */
66 int flag;
67
68 /* If on, the body of a table is being generated. If off, the table
69 header is being generated. */
70 int body_flag;
71
72 /* The level at which each entry of the table is to be found. A row
73 (a tuple) is made up of entries. Consequently ENTRY_LEVEL is one
74 above that of the table. */
75 int entry_level;
76
77 /* Number of table columns (as specified in the table_begin call). */
78 int columns;
79
80 /* String identifying the table (as specified in the table_begin
81 call). */
82 char *id;
83
84 /* Points to the first table header (if any). */
85 struct ui_out_hdr *header_first;
86
87 /* Points to the last table header (if any). */
88 struct ui_out_hdr *header_last;
89
90 /* Points to header of NEXT column to format. */
91 struct ui_out_hdr *header_next;
92
93 };
94
95
96 /* The ui_out structure */
97 /* Any change here requires a corresponding one in the initialization
98 of the default uiout, which is statically initialized */
99
100 struct ui_out
101 {
102 int flags;
103 /* specific implementation of ui-out */
104 struct ui_out_impl *impl;
105 struct ui_out_data *data;
106
107 /* Sub structure tracking the ui-out depth. */
108 int level;
109 struct ui_out_level levels[MAX_UI_OUT_LEVELS];
110
111 /* A table, if any. At present only a single table is supported. */
112 struct ui_out_table table;
113 };
114
115 /* The current (inner most) level. */
116 static struct ui_out_level *
117 current_level (struct ui_out *uiout)
118 {
119 return &uiout->levels[uiout->level];
120 }
121
122 /* Create a new level, of TYPE. Return the new level's index. */
123 static int
124 push_level (struct ui_out *uiout,
125 enum ui_out_type type,
126 const char *id)
127 {
128 struct ui_out_level *current;
129 /* We had better not overflow the buffer. */
130 uiout->level++;
131 gdb_assert (uiout->level >= 0 && uiout->level < MAX_UI_OUT_LEVELS);
132 current = current_level (uiout);
133 current->field_count = 0;
134 current->type = type;
135 return uiout->level;
136 }
137
138 /* Discard the current level, return the discarded level's index.
139 TYPE is the type of the level being discarded. */
140 static int
141 pop_level (struct ui_out *uiout,
142 enum ui_out_type type)
143 {
144 /* We had better not underflow the buffer. */
145 gdb_assert (uiout->level > 0 && uiout->level < MAX_UI_OUT_LEVELS);
146 gdb_assert (current_level (uiout)->type == type);
147 uiout->level--;
148 return uiout->level + 1;
149 }
150
151
152 /* These are the default implementation functions */
153
154 static void default_table_begin (struct ui_out *uiout, int nbrofcols,
155 int nr_rows, const char *tblid);
156 static void default_table_body (struct ui_out *uiout);
157 static void default_table_end (struct ui_out *uiout);
158 static void default_table_header (struct ui_out *uiout, int width,
159 enum ui_align alig, const char *col_name,
160 const char *colhdr);
161 static void default_begin (struct ui_out *uiout,
162 enum ui_out_type type,
163 int level, const char *id);
164 static void default_end (struct ui_out *uiout,
165 enum ui_out_type type,
166 int level);
167 static void default_field_int (struct ui_out *uiout, int fldno, int width,
168 enum ui_align alig,
169 const char *fldname,
170 int value);
171 static void default_field_skip (struct ui_out *uiout, int fldno, int width,
172 enum ui_align alig,
173 const char *fldname);
174 static void default_field_string (struct ui_out *uiout, int fldno, int width,
175 enum ui_align align,
176 const char *fldname,
177 const char *string);
178 static void default_field_fmt (struct ui_out *uiout, int fldno,
179 int width, enum ui_align align,
180 const char *fldname,
181 const char *format,
182 va_list args) ATTR_FORMAT (printf, 6, 0);
183 static void default_spaces (struct ui_out *uiout, int numspaces);
184 static void default_text (struct ui_out *uiout, const char *string);
185 static void default_message (struct ui_out *uiout, int verbosity,
186 const char *format,
187 va_list args) ATTR_FORMAT (printf, 3, 0);
188 static void default_wrap_hint (struct ui_out *uiout, char *identstring);
189 static void default_flush (struct ui_out *uiout);
190
191 /* This is the default ui-out implementation functions vector */
192
193 struct ui_out_impl default_ui_out_impl =
194 {
195 default_table_begin,
196 default_table_body,
197 default_table_end,
198 default_table_header,
199 default_begin,
200 default_end,
201 default_field_int,
202 default_field_skip,
203 default_field_string,
204 default_field_fmt,
205 default_spaces,
206 default_text,
207 default_message,
208 default_wrap_hint,
209 default_flush,
210 NULL,
211 0, /* Does not need MI hacks. */
212 };
213
214 /* The default ui_out */
215
216 struct ui_out def_uiout =
217 {
218 0, /* flags */
219 &default_ui_out_impl, /* impl */
220 };
221
222 /* Pointer to current ui_out */
223 /* FIXME: This should not be a global, but something passed down from main.c
224 or top.c */
225
226 struct ui_out *uiout = &def_uiout;
227
228 /* These are the interfaces to implementation functions */
229
230 static void uo_table_begin (struct ui_out *uiout, int nbrofcols,
231 int nr_rows, const char *tblid);
232 static void uo_table_body (struct ui_out *uiout);
233 static void uo_table_end (struct ui_out *uiout);
234 static void uo_table_header (struct ui_out *uiout, int width,
235 enum ui_align align, const char *col_name,
236 const char *colhdr);
237 static void uo_begin (struct ui_out *uiout,
238 enum ui_out_type type,
239 int level, const char *id);
240 static void uo_end (struct ui_out *uiout,
241 enum ui_out_type type,
242 int level);
243 static void uo_field_int (struct ui_out *uiout, int fldno, int width,
244 enum ui_align align, const char *fldname, int value);
245 static void uo_field_skip (struct ui_out *uiout, int fldno, int width,
246 enum ui_align align, const char *fldname);
247 static void uo_field_string (struct ui_out *uiout, int fldno, int width,
248 enum ui_align align, const char *fldname,
249 const char *string);
250 static void uo_field_fmt (struct ui_out *uiout, int fldno, int width,
251 enum ui_align align, const char *fldname,
252 const char *format, va_list args)
253 ATTR_FORMAT (printf, 6, 0);
254 static void uo_spaces (struct ui_out *uiout, int numspaces);
255 static void uo_text (struct ui_out *uiout, const char *string);
256 static void uo_message (struct ui_out *uiout, int verbosity,
257 const char *format, va_list args)
258 ATTR_FORMAT (printf, 3, 0);
259 static void uo_wrap_hint (struct ui_out *uiout, char *identstring);
260 static void uo_flush (struct ui_out *uiout);
261 static int uo_redirect (struct ui_out *uiout, struct ui_file *outstream);
262
263 /* Prototypes for local functions */
264
265 extern void _initialize_ui_out (void);
266 static void append_header_to_list (struct ui_out *uiout, int width,
267 int alignment, const char *col_name,
268 const char *colhdr);
269 static int get_next_header (struct ui_out *uiout, int *colno, int *width,
270 int *alignment, char **colhdr);
271 static void clear_header_list (struct ui_out *uiout);
272 static void verify_field (struct ui_out *uiout, int *fldno, int *width,
273 int *align);
274
275 /* exported functions (ui_out API) */
276
277 /* Mark beginning of a table */
278
279 static void
280 ui_out_table_begin (struct ui_out *uiout, int nbrofcols,
281 int nr_rows,
282 const char *tblid)
283 {
284 if (uiout->table.flag)
285 internal_error (__FILE__, __LINE__,
286 _("tables cannot be nested; table_begin found before \
287 previous table_end."));
288
289 uiout->table.flag = 1;
290 uiout->table.body_flag = 0;
291 uiout->table.entry_level = uiout->level + 1;
292 uiout->table.columns = nbrofcols;
293 if (tblid != NULL)
294 uiout->table.id = xstrdup (tblid);
295 else
296 uiout->table.id = NULL;
297 clear_header_list (uiout);
298
299 uo_table_begin (uiout, nbrofcols, nr_rows, uiout->table.id);
300 }
301
302 void
303 ui_out_table_body (struct ui_out *uiout)
304 {
305 if (!uiout->table.flag)
306 internal_error (__FILE__, __LINE__,
307 _("table_body outside a table is not valid; it must be \
308 after a table_begin and before a table_end."));
309 if (uiout->table.body_flag)
310 internal_error (__FILE__, __LINE__,
311 _("extra table_body call not allowed; there must be \
312 only one table_body after a table_begin and before a table_end."));
313 if (uiout->table.header_next->colno != uiout->table.columns)
314 internal_error (__FILE__, __LINE__,
315 _("number of headers differ from number of table \
316 columns."));
317
318 uiout->table.body_flag = 1;
319 uiout->table.header_next = uiout->table.header_first;
320
321 uo_table_body (uiout);
322 }
323
324 static void
325 ui_out_table_end (struct ui_out *uiout)
326 {
327 if (!uiout->table.flag)
328 internal_error (__FILE__, __LINE__,
329 _("misplaced table_end or missing table_begin."));
330
331 uiout->table.entry_level = 0;
332 uiout->table.body_flag = 0;
333 uiout->table.flag = 0;
334
335 uo_table_end (uiout);
336
337 if (uiout->table.id)
338 xfree (uiout->table.id);
339 clear_header_list (uiout);
340 }
341
342 void
343 ui_out_table_header (struct ui_out *uiout, int width, enum ui_align alignment,
344 const char *col_name,
345 const char *colhdr)
346 {
347 if (!uiout->table.flag || uiout->table.body_flag)
348 internal_error (__FILE__, __LINE__,
349 _("table header must be specified after table_begin \
350 and before table_body."));
351
352 append_header_to_list (uiout, width, alignment, col_name, colhdr);
353
354 uo_table_header (uiout, width, alignment, col_name, colhdr);
355 }
356
357 static void
358 do_cleanup_table_end (void *data)
359 {
360 struct ui_out *ui_out = data;
361
362 ui_out_table_end (ui_out);
363 }
364
365 struct cleanup *
366 make_cleanup_ui_out_table_begin_end (struct ui_out *ui_out, int nr_cols,
367 int nr_rows, const char *tblid)
368 {
369 ui_out_table_begin (ui_out, nr_cols, nr_rows, tblid);
370 return make_cleanup (do_cleanup_table_end, ui_out);
371 }
372
373 void
374 ui_out_begin (struct ui_out *uiout,
375 enum ui_out_type type,
376 const char *id)
377 {
378 int new_level;
379 if (uiout->table.flag && !uiout->table.body_flag)
380 internal_error (__FILE__, __LINE__,
381 _("table header or table_body expected; lists must be \
382 specified after table_body."));
383
384 /* Be careful to verify the ``field'' before the new tuple/list is
385 pushed onto the stack. That way the containing list/table/row is
386 verified and not the newly created tuple/list. This verification
387 is needed (at least) for the case where a table row entry
388 contains either a tuple/list. For that case bookkeeping such as
389 updating the column count or advancing to the next heading still
390 needs to be performed. */
391 {
392 int fldno;
393 int width;
394 int align;
395 verify_field (uiout, &fldno, &width, &align);
396 }
397
398 new_level = push_level (uiout, type, id);
399
400 /* If the push puts us at the same level as a table row entry, we've
401 got a new table row. Put the header pointer back to the start. */
402 if (uiout->table.body_flag
403 && uiout->table.entry_level == new_level)
404 uiout->table.header_next = uiout->table.header_first;
405
406 uo_begin (uiout, type, new_level, id);
407 }
408
409 void
410 ui_out_end (struct ui_out *uiout,
411 enum ui_out_type type)
412 {
413 int old_level = pop_level (uiout, type);
414 uo_end (uiout, type, old_level);
415 }
416
417 struct ui_out_end_cleanup_data
418 {
419 struct ui_out *uiout;
420 enum ui_out_type type;
421 };
422
423 static void
424 do_cleanup_end (void *data)
425 {
426 struct ui_out_end_cleanup_data *end_cleanup_data = data;
427 ui_out_end (end_cleanup_data->uiout, end_cleanup_data->type);
428 xfree (end_cleanup_data);
429 }
430
431 static struct cleanup *
432 make_cleanup_ui_out_end (struct ui_out *uiout,
433 enum ui_out_type type)
434 {
435 struct ui_out_end_cleanup_data *end_cleanup_data;
436 end_cleanup_data = XMALLOC (struct ui_out_end_cleanup_data);
437 end_cleanup_data->uiout = uiout;
438 end_cleanup_data->type = type;
439 return make_cleanup (do_cleanup_end, end_cleanup_data);
440 }
441
442 struct cleanup *
443 make_cleanup_ui_out_tuple_begin_end (struct ui_out *uiout,
444 const char *id)
445 {
446 ui_out_begin (uiout, ui_out_type_tuple, id);
447 return make_cleanup_ui_out_end (uiout, ui_out_type_tuple);
448 }
449
450 struct cleanup *
451 make_cleanup_ui_out_list_begin_end (struct ui_out *uiout,
452 const char *id)
453 {
454 ui_out_begin (uiout, ui_out_type_list, id);
455 return make_cleanup_ui_out_end (uiout, ui_out_type_list);
456 }
457
458 void
459 ui_out_field_int (struct ui_out *uiout,
460 const char *fldname,
461 int value)
462 {
463 int fldno;
464 int width;
465 int align;
466 struct ui_out_level *current = current_level (uiout);
467
468 verify_field (uiout, &fldno, &width, &align);
469
470 uo_field_int (uiout, fldno, width, align, fldname, value);
471 }
472
473 void
474 ui_out_field_fmt_int (struct ui_out *uiout,
475 int input_width,
476 enum ui_align input_align,
477 const char *fldname,
478 int value)
479 {
480 int fldno;
481 int width;
482 int align;
483 struct ui_out_level *current = current_level (uiout);
484
485 verify_field (uiout, &fldno, &width, &align);
486
487 uo_field_int (uiout, fldno, input_width, input_align, fldname, value);
488 }
489
490 void
491 ui_out_field_core_addr (struct ui_out *uiout,
492 const char *fldname,
493 CORE_ADDR address)
494 {
495 char addstr[20];
496 int addr_bit = gdbarch_addr_bit (current_gdbarch);
497
498 /* Truncate address to match deprecated_print_address_numeric(). */
499 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
500 address &= ((CORE_ADDR) 1 << addr_bit) - 1;
501
502 /* FIXME: cagney/2002-05-03: Need local_address_string() function
503 that returns the language localized string formatted to a width
504 based on gdbarch_addr_bit. */
505 /* deprecated_print_address_numeric (address, 1, local_stream); */
506 if (addr_bit <= 32)
507 strcpy (addstr, hex_string_custom (address, 8));
508 else
509 strcpy (addstr, hex_string_custom (address, 16));
510
511 ui_out_field_string (uiout, fldname, addstr);
512 }
513
514 void
515 ui_out_field_stream (struct ui_out *uiout,
516 const char *fldname,
517 struct ui_stream *buf)
518 {
519 long length;
520 char *buffer = ui_file_xstrdup (buf->stream, &length);
521 struct cleanup *old_cleanup = make_cleanup (xfree, buffer);
522 if (length > 0)
523 ui_out_field_string (uiout, fldname, buffer);
524 else
525 ui_out_field_skip (uiout, fldname);
526 ui_file_rewind (buf->stream);
527 do_cleanups (old_cleanup);
528 }
529
530 /* used to ommit a field */
531
532 void
533 ui_out_field_skip (struct ui_out *uiout,
534 const char *fldname)
535 {
536 int fldno;
537 int width;
538 int align;
539
540 verify_field (uiout, &fldno, &width, &align);
541
542 uo_field_skip (uiout, fldno, width, align, fldname);
543 }
544
545 void
546 ui_out_field_string (struct ui_out *uiout,
547 const char *fldname,
548 const char *string)
549 {
550 int fldno;
551 int width;
552 int align;
553
554 verify_field (uiout, &fldno, &width, &align);
555
556 uo_field_string (uiout, fldno, width, align, fldname, string);
557 }
558
559 /* VARARGS */
560 void
561 ui_out_field_fmt (struct ui_out *uiout,
562 const char *fldname,
563 const char *format, ...)
564 {
565 va_list args;
566 int fldno;
567 int width;
568 int align;
569
570 /* will not align, but has to call anyway */
571 verify_field (uiout, &fldno, &width, &align);
572
573 va_start (args, format);
574
575 uo_field_fmt (uiout, fldno, width, align, fldname, format, args);
576
577 va_end (args);
578 }
579
580 void
581 ui_out_spaces (struct ui_out *uiout, int numspaces)
582 {
583 uo_spaces (uiout, numspaces);
584 }
585
586 void
587 ui_out_text (struct ui_out *uiout,
588 const char *string)
589 {
590 uo_text (uiout, string);
591 }
592
593 void
594 ui_out_message (struct ui_out *uiout, int verbosity,
595 const char *format,...)
596 {
597 va_list args;
598
599 va_start (args, format);
600
601 uo_message (uiout, verbosity, format, args);
602
603 va_end (args);
604 }
605
606 struct ui_stream *
607 ui_out_stream_new (struct ui_out *uiout)
608 {
609 struct ui_stream *tempbuf;
610
611 tempbuf = XMALLOC (struct ui_stream);
612 tempbuf->uiout = uiout;
613 tempbuf->stream = mem_fileopen ();
614 return tempbuf;
615 }
616
617 void
618 ui_out_stream_delete (struct ui_stream *buf)
619 {
620 ui_file_delete (buf->stream);
621 xfree (buf);
622 }
623
624 static void
625 do_stream_delete (void *buf)
626 {
627 ui_out_stream_delete (buf);
628 }
629
630 struct cleanup *
631 make_cleanup_ui_out_stream_delete (struct ui_stream *buf)
632 {
633 return make_cleanup (do_stream_delete, buf);
634 }
635
636
637 void
638 ui_out_wrap_hint (struct ui_out *uiout, char *identstring)
639 {
640 uo_wrap_hint (uiout, identstring);
641 }
642
643 void
644 ui_out_flush (struct ui_out *uiout)
645 {
646 uo_flush (uiout);
647 }
648
649 int
650 ui_out_redirect (struct ui_out *uiout, struct ui_file *outstream)
651 {
652 return uo_redirect (uiout, outstream);
653 }
654
655 /* set the flags specified by the mask given */
656 int
657 ui_out_set_flags (struct ui_out *uiout, int mask)
658 {
659 int oldflags = uiout->flags;
660
661 uiout->flags |= mask;
662
663 return oldflags;
664 }
665
666 /* clear the flags specified by the mask given */
667 int
668 ui_out_clear_flags (struct ui_out *uiout, int mask)
669 {
670 int oldflags = uiout->flags;
671
672 uiout->flags &= ~mask;
673
674 return oldflags;
675 }
676
677 /* test the flags against the mask given */
678 int
679 ui_out_test_flags (struct ui_out *uiout, int mask)
680 {
681 return (uiout->flags & mask);
682 }
683
684 /* obtain the current verbosity level (as stablished by the
685 'set verbositylevel' command */
686
687 int
688 ui_out_get_verblvl (struct ui_out *uiout)
689 {
690 /* FIXME: not implemented yet */
691 return 0;
692 }
693
694 #if 0
695 void
696 ui_out_result_begin (struct ui_out *uiout, char *class)
697 {
698 }
699
700 void
701 ui_out_result_end (struct ui_out *uiout)
702 {
703 }
704
705 void
706 ui_out_info_begin (struct ui_out *uiout, char *class)
707 {
708 }
709
710 void
711 ui_out_info_end (struct ui_out *uiout)
712 {
713 }
714
715 void
716 ui_out_notify_begin (struct ui_out *uiout, char *class)
717 {
718 }
719
720 void
721 ui_out_notify_end (struct ui_out *uiout)
722 {
723 }
724
725 void
726 ui_out_error_begin (struct ui_out *uiout, char *class)
727 {
728 }
729
730 void
731 ui_out_error_end (struct ui_out *uiout)
732 {
733 }
734 #endif
735
736 #if 0
737 void
738 gdb_error (ui_out * uiout, int severity, char *format,...)
739 {
740 va_list args;
741 }
742
743 void
744 gdb_query (struct ui_out *uiout, int qflags, char *qprompt)
745 {
746 }
747 #endif
748
749 int
750 ui_out_is_mi_like_p (struct ui_out *uiout)
751 {
752 return uiout->impl->is_mi_like_p;
753 }
754
755 /* default gdb-out hook functions */
756
757 static void
758 default_table_begin (struct ui_out *uiout, int nbrofcols,
759 int nr_rows,
760 const char *tblid)
761 {
762 }
763
764 static void
765 default_table_body (struct ui_out *uiout)
766 {
767 }
768
769 static void
770 default_table_end (struct ui_out *uiout)
771 {
772 }
773
774 static void
775 default_table_header (struct ui_out *uiout, int width, enum ui_align alignment,
776 const char *col_name,
777 const char *colhdr)
778 {
779 }
780
781 static void
782 default_begin (struct ui_out *uiout,
783 enum ui_out_type type,
784 int level,
785 const char *id)
786 {
787 }
788
789 static void
790 default_end (struct ui_out *uiout,
791 enum ui_out_type type,
792 int level)
793 {
794 }
795
796 static void
797 default_field_int (struct ui_out *uiout, int fldno, int width,
798 enum ui_align align,
799 const char *fldname, int value)
800 {
801 }
802
803 static void
804 default_field_skip (struct ui_out *uiout, int fldno, int width,
805 enum ui_align align, const char *fldname)
806 {
807 }
808
809 static void
810 default_field_string (struct ui_out *uiout,
811 int fldno,
812 int width,
813 enum ui_align align,
814 const char *fldname,
815 const char *string)
816 {
817 }
818
819 static void
820 default_field_fmt (struct ui_out *uiout, int fldno, int width,
821 enum ui_align align,
822 const char *fldname,
823 const char *format,
824 va_list args)
825 {
826 }
827
828 static void
829 default_spaces (struct ui_out *uiout, int numspaces)
830 {
831 }
832
833 static void
834 default_text (struct ui_out *uiout, const char *string)
835 {
836 }
837
838 static void
839 default_message (struct ui_out *uiout, int verbosity,
840 const char *format,
841 va_list args)
842 {
843 }
844
845 static void
846 default_wrap_hint (struct ui_out *uiout, char *identstring)
847 {
848 }
849
850 static void
851 default_flush (struct ui_out *uiout)
852 {
853 }
854
855 /* Interface to the implementation functions */
856
857 void
858 uo_table_begin (struct ui_out *uiout, int nbrofcols,
859 int nr_rows,
860 const char *tblid)
861 {
862 if (!uiout->impl->table_begin)
863 return;
864 uiout->impl->table_begin (uiout, nbrofcols, nr_rows, tblid);
865 }
866
867 void
868 uo_table_body (struct ui_out *uiout)
869 {
870 if (!uiout->impl->table_body)
871 return;
872 uiout->impl->table_body (uiout);
873 }
874
875 void
876 uo_table_end (struct ui_out *uiout)
877 {
878 if (!uiout->impl->table_end)
879 return;
880 uiout->impl->table_end (uiout);
881 }
882
883 void
884 uo_table_header (struct ui_out *uiout, int width, enum ui_align align,
885 const char *col_name,
886 const char *colhdr)
887 {
888 if (!uiout->impl->table_header)
889 return;
890 uiout->impl->table_header (uiout, width, align, col_name, colhdr);
891 }
892
893 void
894 uo_begin (struct ui_out *uiout,
895 enum ui_out_type type,
896 int level,
897 const char *id)
898 {
899 if (uiout->impl->begin == NULL)
900 return;
901 uiout->impl->begin (uiout, type, level, id);
902 }
903
904 void
905 uo_end (struct ui_out *uiout,
906 enum ui_out_type type,
907 int level)
908 {
909 if (uiout->impl->end == NULL)
910 return;
911 uiout->impl->end (uiout, type, level);
912 }
913
914 void
915 uo_field_int (struct ui_out *uiout, int fldno, int width, enum ui_align align,
916 const char *fldname,
917 int value)
918 {
919 if (!uiout->impl->field_int)
920 return;
921 uiout->impl->field_int (uiout, fldno, width, align, fldname, value);
922 }
923
924 void
925 uo_field_skip (struct ui_out *uiout, int fldno, int width, enum ui_align align,
926 const char *fldname)
927 {
928 if (!uiout->impl->field_skip)
929 return;
930 uiout->impl->field_skip (uiout, fldno, width, align, fldname);
931 }
932
933 void
934 uo_field_string (struct ui_out *uiout, int fldno, int width,
935 enum ui_align align,
936 const char *fldname,
937 const char *string)
938 {
939 if (!uiout->impl->field_string)
940 return;
941 uiout->impl->field_string (uiout, fldno, width, align, fldname, string);
942 }
943
944 void
945 uo_field_fmt (struct ui_out *uiout, int fldno, int width, enum ui_align align,
946 const char *fldname,
947 const char *format,
948 va_list args)
949 {
950 if (!uiout->impl->field_fmt)
951 return;
952 uiout->impl->field_fmt (uiout, fldno, width, align, fldname, format, args);
953 }
954
955 void
956 uo_spaces (struct ui_out *uiout, int numspaces)
957 {
958 if (!uiout->impl->spaces)
959 return;
960 uiout->impl->spaces (uiout, numspaces);
961 }
962
963 void
964 uo_text (struct ui_out *uiout,
965 const char *string)
966 {
967 if (!uiout->impl->text)
968 return;
969 uiout->impl->text (uiout, string);
970 }
971
972 void
973 uo_message (struct ui_out *uiout, int verbosity,
974 const char *format,
975 va_list args)
976 {
977 if (!uiout->impl->message)
978 return;
979 uiout->impl->message (uiout, verbosity, format, args);
980 }
981
982 void
983 uo_wrap_hint (struct ui_out *uiout, char *identstring)
984 {
985 if (!uiout->impl->wrap_hint)
986 return;
987 uiout->impl->wrap_hint (uiout, identstring);
988 }
989
990 void
991 uo_flush (struct ui_out *uiout)
992 {
993 if (!uiout->impl->flush)
994 return;
995 uiout->impl->flush (uiout);
996 }
997
998 int
999 uo_redirect (struct ui_out *uiout, struct ui_file *outstream)
1000 {
1001 if (!uiout->impl->redirect)
1002 return -1;
1003 uiout->impl->redirect (uiout, outstream);
1004 return 0;
1005 }
1006
1007 /* local functions */
1008
1009 /* list of column headers manipulation routines */
1010
1011 static void
1012 clear_header_list (struct ui_out *uiout)
1013 {
1014 while (uiout->table.header_first != NULL)
1015 {
1016 uiout->table.header_next = uiout->table.header_first;
1017 uiout->table.header_first = uiout->table.header_first->next;
1018 if (uiout->table.header_next->colhdr != NULL)
1019 xfree (uiout->table.header_next->colhdr);
1020 xfree (uiout->table.header_next);
1021 }
1022 gdb_assert (uiout->table.header_first == NULL);
1023 uiout->table.header_last = NULL;
1024 uiout->table.header_next = NULL;
1025 }
1026
1027 static void
1028 append_header_to_list (struct ui_out *uiout,
1029 int width,
1030 int alignment,
1031 const char *col_name,
1032 const char *colhdr)
1033 {
1034 struct ui_out_hdr *temphdr;
1035
1036 temphdr = XMALLOC (struct ui_out_hdr);
1037 temphdr->width = width;
1038 temphdr->alignment = alignment;
1039 /* we have to copy the column title as the original may be an automatic */
1040 if (colhdr != NULL)
1041 temphdr->colhdr = xstrdup (colhdr);
1042 else
1043 temphdr->colhdr = NULL;
1044 if (col_name != NULL)
1045 temphdr->col_name = xstrdup (colhdr);
1046 else
1047 temphdr->col_name = xstrdup (colhdr);
1048 temphdr->next = NULL;
1049 if (uiout->table.header_first == NULL)
1050 {
1051 temphdr->colno = 1;
1052 uiout->table.header_first = temphdr;
1053 uiout->table.header_last = temphdr;
1054 }
1055 else
1056 {
1057 temphdr->colno = uiout->table.header_last->colno + 1;
1058 uiout->table.header_last->next = temphdr;
1059 uiout->table.header_last = temphdr;
1060 }
1061 uiout->table.header_next = uiout->table.header_last;
1062 }
1063
1064 /* Extract the format information for the NEXT header and and advance
1065 the header pointer. Return 0 if there was no next header. */
1066
1067 static int
1068 get_next_header (struct ui_out *uiout,
1069 int *colno,
1070 int *width,
1071 int *alignment,
1072 char **colhdr)
1073 {
1074 /* There may be no headers at all or we may have used all columns. */
1075 if (uiout->table.header_next == NULL)
1076 return 0;
1077 *colno = uiout->table.header_next->colno;
1078 *width = uiout->table.header_next->width;
1079 *alignment = uiout->table.header_next->alignment;
1080 *colhdr = uiout->table.header_next->colhdr;
1081 /* Advance the header pointer to the next entry. */
1082 uiout->table.header_next = uiout->table.header_next->next;
1083 return 1;
1084 }
1085
1086
1087 /* Verify that the field/tuple/list is correctly positioned. Return
1088 the field number and corresponding alignment (if
1089 available/applicable). */
1090
1091 static void
1092 verify_field (struct ui_out *uiout, int *fldno, int *width, int *align)
1093 {
1094 struct ui_out_level *current = current_level (uiout);
1095 char *text;
1096
1097 if (uiout->table.flag)
1098 {
1099 if (!uiout->table.body_flag)
1100 internal_error (__FILE__, __LINE__,
1101 _("table_body missing; table fields must be \
1102 specified after table_body and inside a list."));
1103 /* NOTE: cagney/2001-12-08: There was a check here to ensure
1104 that this code was only executed when uiout->level was
1105 greater than zero. That no longer applies - this code is run
1106 before each table row tuple is started and at that point the
1107 level is zero. */
1108 }
1109
1110 current->field_count += 1;
1111
1112 if (uiout->table.body_flag
1113 && uiout->table.entry_level == uiout->level
1114 && get_next_header (uiout, fldno, width, align, &text))
1115 {
1116 if (*fldno != current->field_count)
1117 internal_error (__FILE__, __LINE__,
1118 _("ui-out internal error in handling headers."));
1119 }
1120 else
1121 {
1122 *width = 0;
1123 *align = ui_noalign;
1124 *fldno = current->field_count;
1125 }
1126 }
1127
1128
1129 /* access to ui_out format private members */
1130
1131 void
1132 ui_out_get_field_separator (struct ui_out *uiout)
1133 {
1134 }
1135
1136 /* Access to ui-out members data */
1137
1138 struct ui_out_data *
1139 ui_out_data (struct ui_out *uiout)
1140 {
1141 return uiout->data;
1142 }
1143
1144 /* initalize private members at startup */
1145
1146 struct ui_out *
1147 ui_out_new (struct ui_out_impl *impl,
1148 struct ui_out_data *data,
1149 int flags)
1150 {
1151 struct ui_out *uiout = XMALLOC (struct ui_out);
1152 uiout->data = data;
1153 uiout->impl = impl;
1154 uiout->flags = flags;
1155 uiout->table.flag = 0;
1156 uiout->table.body_flag = 0;
1157 uiout->level = 0;
1158 memset (uiout->levels, 0, sizeof (uiout->levels));
1159 uiout->table.header_first = NULL;
1160 uiout->table.header_last = NULL;
1161 uiout->table.header_next = NULL;
1162 return uiout;
1163 }
1164
1165 /* standard gdb initialization hook */
1166
1167 void
1168 _initialize_ui_out (void)
1169 {
1170 /* nothing needs to be done */
1171 }
This page took 0.053771 seconds and 4 git commands to generate.