/* Output generating routines for GDB.
- Copyright 1999, 2000 Free Software Foundation, Inc.
+ Copyright 1999, 2000, 2001 Free Software Foundation, Inc.
Contributed by Cygnus Solutions.
Written by Fernando Nasser for Cygnus.
#include "expression.h" /* For language.h */
#include "language.h"
#include "ui-out.h"
+#include "gdb_assert.h"
/* Convenience macro for allocting typesafe memory. */
int colno;
int width;
int alignment;
+ char *col_name;
char *colhdr;
struct ui_out_hdr *next;
};
+/* Maintain a stack so that the info applicable to the inner most list
+ is always available. Stack/nested level 0 is reserved for the
+ top-level result. */
+
+enum { MAX_UI_OUT_LEVELS = 5 };
+
+struct ui_out_level
+ {
+ /* Count each field; the first element is for non-list fields */
+ int field_count;
+ /* The type of this level. */
+ enum ui_out_type type;
+ };
+
/* The ui_out structure */
/* Any change here requires a corresponding one in the initialization
of the default uiout, which is statically initialized */
/* strinf identifying the table (as specified in the table_begin call) */
char *table_id;
- /* if on, a list is being generated. The value is the level of nesting */
- int list_flag;
-
- /* we count each field; the first element is for non-list fields */
- int field_count[5];
+ /* Sub structure tracking the table depth. */
+ int level;
+ struct ui_out_level levels[MAX_UI_OUT_LEVELS];
/* points to the first header (if any) */
struct ui_out_hdr *headerfirst;
};
+/* The current (inner most) level. */
+static struct ui_out_level *
+current_level (struct ui_out *uiout)
+{
+ return &uiout->levels[uiout->level];
+}
+
+/* Create a new level, of TYPE. Return the new level's index. */
+static int
+push_level (struct ui_out *uiout,
+ enum ui_out_type type,
+ const char *id)
+{
+ struct ui_out_level *current;
+ /* We had better not overflow the buffer. */
+ uiout->level++;
+ gdb_assert (uiout->level >= 0 && uiout->level < MAX_UI_OUT_LEVELS);
+ current = current_level (uiout);
+ current->field_count = 0;
+ current->type = type;
+ return uiout->level;
+}
+
+/* Discard the current level, return the discarded level's index.
+ TYPE is the type of the level being discarded. */
+static int
+pop_level (struct ui_out *uiout,
+ enum ui_out_type type)
+{
+ /* We had better not underflow the buffer. */
+ gdb_assert (uiout->level > 0 && uiout->level < MAX_UI_OUT_LEVELS);
+ gdb_assert (current_level (uiout)->type == type);
+ uiout->level--;
+ return uiout->level + 1;
+}
+
+
/* These are the default implementation functions */
static void default_table_begin (struct ui_out *uiout, int nbrofcols,
- char *tblid);
+ int nr_rows, const char *tblid);
static void default_table_body (struct ui_out *uiout);
static void default_table_end (struct ui_out *uiout);
static void default_table_header (struct ui_out *uiout, int width,
- enum ui_align alig, char *colhdr);
-static void default_list_begin (struct ui_out *uiout, int list_flag,
- char *lstid);
-static void default_list_end (struct ui_out *uiout, int list_flag);
+ enum ui_align alig, const char *col_name,
+ const char *colhdr);
+static void default_begin (struct ui_out *uiout,
+ enum ui_out_type type,
+ int level, const char *id);
+static void default_end (struct ui_out *uiout,
+ enum ui_out_type type,
+ int level);
static void default_field_int (struct ui_out *uiout, int fldno, int width,
- enum ui_align alig, char *fldname, int value);
+ enum ui_align alig,
+ const char *fldname,
+ int value);
static void default_field_skip (struct ui_out *uiout, int fldno, int width,
- enum ui_align alig, char *fldname);
+ enum ui_align alig,
+ const char *fldname);
static void default_field_string (struct ui_out *uiout, int fldno, int width,
- enum ui_align align, char *fldname,
+ enum ui_align align,
+ const char *fldname,
const char *string);
static void default_field_fmt (struct ui_out *uiout, int fldno,
int width, enum ui_align align,
- char *fldname, char *format, va_list args);
+ const char *fldname,
+ const char *format,
+ va_list args);
static void default_spaces (struct ui_out *uiout, int numspaces);
-static void default_text (struct ui_out *uiout, char *string);
-static void default_message (struct ui_out *uiout, int verbosity, char *format,
+static void default_text (struct ui_out *uiout, const char *string);
+static void default_message (struct ui_out *uiout, int verbosity,
+ const char *format,
va_list args);
static void default_wrap_hint (struct ui_out *uiout, char *identstring);
static void default_flush (struct ui_out *uiout);
default_table_body,
default_table_end,
default_table_header,
- default_list_begin,
- default_list_end,
+ default_begin,
+ default_end,
default_field_int,
default_field_skip,
default_field_string,
/* These are the interfaces to implementation functions */
-static void uo_table_begin (struct ui_out *uiout, int nbrofcols, char *tblid);
+static void uo_table_begin (struct ui_out *uiout, int nbrofcols,
+ int nr_rows, const char *tblid);
static void uo_table_body (struct ui_out *uiout);
static void uo_table_end (struct ui_out *uiout);
static void uo_table_header (struct ui_out *uiout, int width,
- enum ui_align align, char *colhdr);
-static void uo_list_begin (struct ui_out *uiout, int list_flag, char *lstid);
-static void uo_list_end (struct ui_out *uiout, int list_flag);
+ enum ui_align align, const char *col_name,
+ const char *colhdr);
+static void uo_begin (struct ui_out *uiout,
+ enum ui_out_type type,
+ int level, const char *id);
+static void uo_end (struct ui_out *uiout,
+ enum ui_out_type type,
+ int level);
static void uo_field_int (struct ui_out *uiout, int fldno, int width,
- enum ui_align align, char *fldname, int value);
+ enum ui_align align, const char *fldname, int value);
static void uo_field_skip (struct ui_out *uiout, int fldno, int width,
- enum ui_align align, char *fldname);
+ enum ui_align align, const char *fldname);
static void uo_field_string (struct ui_out *uiout, int fldno, int width,
- enum ui_align align, char *fldname, const char *string);
+ enum ui_align align, const char *fldname,
+ const char *string);
static void uo_field_fmt (struct ui_out *uiout, int fldno, int width,
- enum ui_align align, char *fldname,
- char *format, va_list args);
+ enum ui_align align, const char *fldname,
+ const char *format, va_list args);
static void uo_spaces (struct ui_out *uiout, int numspaces);
-static void uo_text (struct ui_out *uiout, char *string);
+static void uo_text (struct ui_out *uiout, const char *string);
static void uo_message (struct ui_out *uiout, int verbosity,
- char *format, va_list args);
+ const char *format, va_list args);
static void uo_wrap_hint (struct ui_out *uiout, char *identstring);
static void uo_flush (struct ui_out *uiout);
/* Prototypes for local functions */
extern void _initialize_ui_out (void);
-static void append_header_to_list (struct ui_out *uiout, int width, int alignment, char *colhdr);
+static void append_header_to_list (struct ui_out *uiout, int width,
+ int alignment, const char *col_name,
+ const char *colhdr);
static int get_curr_header (struct ui_out *uiout, int *colno, int *width,
int *alignment, char **colhdr);
static void clear_header_list (struct ui_out *uiout);
/* Mark beginning of a table */
void
-ui_out_table_begin (struct ui_out *uiout, int nbrofcols, char *tblid)
+ui_out_table_begin (struct ui_out *uiout, int nbrofcols,
+ int nr_rows,
+ const char *tblid)
{
if (uiout->table_flag)
- internal_error ("gdb/ui_out.c: tables cannot be nested; table_begin found before \
+ internal_error (__FILE__, __LINE__,
+ "tables cannot be nested; table_begin found before \
previous table_end.");
uiout->table_flag = 1;
uiout->table_id = NULL;
clear_header_list (uiout);
- uo_table_begin (uiout, nbrofcols, uiout->table_id);
+ uo_table_begin (uiout, nbrofcols, nr_rows, uiout->table_id);
}
void
ui_out_table_body (struct ui_out *uiout)
{
if (!uiout->table_flag)
- internal_error ("gdb/ui_out.c: table_body outside a table is not valid; it must be \
+ internal_error (__FILE__, __LINE__,
+ "table_body outside a table is not valid; it must be \
after a table_begin and before a table_end.");
if (uiout->body_flag)
- internal_error ("gdb/ui_out.c: extra table_body call not allowed; there must be \
+ internal_error (__FILE__, __LINE__,
+ "extra table_body call not allowed; there must be \
only one table_body after a table_begin and before a table_end.");
if (uiout->headercurr->colno != uiout->table_columns)
- internal_error ("gdb/ui_out.c: number of headers differ from number of table \
+ internal_error (__FILE__, __LINE__,
+ "number of headers differ from number of table \
columns.");
uiout->body_flag = 1;
ui_out_table_end (struct ui_out *uiout)
{
if (!uiout->table_flag)
- internal_error ("gdb/ui_out.c: misplaced table_end or missing table_begin.");
+ internal_error (__FILE__, __LINE__,
+ "misplaced table_end or missing table_begin.");
uiout->body_flag = 0;
uiout->table_flag = 0;
uo_table_end (uiout);
if (uiout->table_id)
- free (uiout->table_id);
+ xfree (uiout->table_id);
clear_header_list (uiout);
}
void
ui_out_table_header (struct ui_out *uiout, int width, enum ui_align alignment,
- char *colhdr)
+ const char *col_name,
+ const char *colhdr)
{
if (!uiout->table_flag || uiout->body_flag)
- internal_error ("ui_out: table header must be specified after table_begin \
+ internal_error (__FILE__, __LINE__,
+ "table header must be specified after table_begin \
and before table_body.");
- append_header_to_list (uiout, width, alignment, colhdr);
+ append_header_to_list (uiout, width, alignment, col_name, colhdr);
- uo_table_header (uiout, width, alignment, colhdr);
+ uo_table_header (uiout, width, alignment, col_name, colhdr);
}
void
-ui_out_list_begin (struct ui_out *uiout, char *lstid)
+ui_out_begin (struct ui_out *uiout,
+ enum ui_out_type type,
+ const char *id)
{
+ int new_level;
if (uiout->table_flag && !uiout->body_flag)
- internal_error ("ui_out: table header or table_body expected; lists must be \
+ internal_error (__FILE__, __LINE__,
+ "table header or table_body expected; lists must be \
specified after table_body.");
- if (uiout->list_flag >= 4)
- internal_error ("ui_out: list depth exceeded; only 4 levels of lists can be \
-nested.");
-
- uiout->list_flag++;
- uiout->field_count[uiout->list_flag] = 0;
- if (uiout->table_flag && (uiout->list_flag == 1))
+ new_level = push_level (uiout, type, id);
+ if (uiout->table_flag && (new_level == 1))
uiout->headercurr = uiout->headerfirst;
+ uo_begin (uiout, type, new_level, id);
+}
+
+void
+ui_out_list_begin (struct ui_out *uiout,
+ const char *id)
+{
+ ui_out_begin (uiout, ui_out_type_list, id);
+}
- uo_list_begin (uiout, uiout->list_flag, lstid);
+void
+ui_out_tuple_begin (struct ui_out *uiout, const char *id)
+{
+ ui_out_begin (uiout, ui_out_type_tuple, id);
+}
+
+void
+ui_out_end (struct ui_out *uiout,
+ enum ui_out_type type)
+{
+ int old_level = pop_level (uiout, type);
+ uo_end (uiout, type, old_level);
}
void
ui_out_list_end (struct ui_out *uiout)
{
- if (!uiout->list_flag)
- internal_error ("ui_out: misplaced list_end; there is no list to be closed.");
+ ui_out_end (uiout, ui_out_type_list);
+}
- uo_list_end (uiout, uiout->list_flag);
+void
+ui_out_tuple_end (struct ui_out *uiout)
+{
+ ui_out_end (uiout, ui_out_type_tuple);
+}
+
+struct ui_out_end_cleanup_data
+{
+ struct ui_out *uiout;
+ enum ui_out_type type;
+};
+
+static void
+do_cleanup_end (void *data)
+{
+ struct ui_out_end_cleanup_data *end_cleanup_data = data;
+ ui_out_end (end_cleanup_data->uiout, end_cleanup_data->type);
+ xfree (end_cleanup_data);
+}
- uiout->list_flag--;
+static struct cleanup *
+make_cleanup_ui_out_end (struct ui_out *uiout,
+ enum ui_out_type type)
+{
+ struct ui_out_end_cleanup_data *end_cleanup_data;
+ end_cleanup_data = XMALLOC (struct ui_out_end_cleanup_data);
+ end_cleanup_data->uiout = uiout;
+ end_cleanup_data->type = type;
+ return make_cleanup (do_cleanup_end, end_cleanup_data);
+}
+
+struct cleanup *
+make_cleanup_ui_out_begin_end (struct ui_out *uiout,
+ enum ui_out_type type,
+ const char *id)
+{
+ ui_out_begin (uiout, type, id);
+ return make_cleanup_ui_out_end (uiout, type);
+}
+
+struct cleanup *
+make_cleanup_ui_out_tuple_begin_end (struct ui_out *uiout,
+ const char *id)
+{
+ ui_out_tuple_begin (uiout, id);
+ return make_cleanup_ui_out_end (uiout, ui_out_type_tuple);
+}
+
+struct cleanup *
+make_cleanup_ui_out_list_begin_end (struct ui_out *uiout,
+ const char *id)
+{
+ ui_out_list_begin (uiout, id);
+ return make_cleanup_ui_out_end (uiout, ui_out_type_list);
}
void
-ui_out_field_int (struct ui_out *uiout, char *fldname, int value)
+ui_out_field_int (struct ui_out *uiout,
+ const char *fldname,
+ int value)
{
int fldno;
int width;
int align;
+ struct ui_out_level *current = current_level (uiout);
verify_field_proper_position (uiout);
- uiout->field_count[uiout->list_flag] += 1;
- fldno = uiout->field_count[uiout->list_flag];
+ current->field_count += 1;
+ fldno = current->field_count;
verify_field_alignment (uiout, fldno, &width, &align);
}
void
-ui_out_field_core_addr (struct ui_out *uiout, char *fldname, CORE_ADDR address)
+ui_out_field_core_addr (struct ui_out *uiout,
+ const char *fldname,
+ CORE_ADDR address)
{
char addstr[20];
}
void
-ui_out_field_stream (struct ui_out *uiout, char *fldname, struct ui_stream *buf)
+ui_out_field_stream (struct ui_out *uiout,
+ const char *fldname,
+ struct ui_stream *buf)
{
long length;
char *buffer = ui_file_xstrdup (buf->stream, &length);
- struct cleanup *old_cleanup = make_cleanup (free, buffer);
+ struct cleanup *old_cleanup = make_cleanup (xfree, buffer);
if (length > 0)
ui_out_field_string (uiout, fldname, buffer);
else
/* used to ommit a field */
void
-ui_out_field_skip (struct ui_out *uiout, char *fldname)
+ui_out_field_skip (struct ui_out *uiout,
+ const char *fldname)
{
int fldno;
int width;
int align;
+ struct ui_out_level *current = current_level (uiout);
verify_field_proper_position (uiout);
- uiout->field_count[uiout->list_flag] += 1;
- fldno = uiout->field_count[uiout->list_flag];
+ current->field_count += 1;
+ fldno = current->field_count;
verify_field_alignment (uiout, fldno, &width, &align);
void
ui_out_field_string (struct ui_out *uiout,
- char *fldname,
+ const char *fldname,
const char *string)
{
int fldno;
int width;
int align;
+ struct ui_out_level *current = current_level (uiout);
verify_field_proper_position (uiout);
- uiout->field_count[uiout->list_flag] += 1;
- fldno = uiout->field_count[uiout->list_flag];
+ current->field_count += 1;
+ fldno = current->field_count;
verify_field_alignment (uiout, fldno, &width, &align);
/* VARARGS */
void
-ui_out_field_fmt (struct ui_out *uiout, char *fldname, char *format,...)
+ui_out_field_fmt (struct ui_out *uiout,
+ const char *fldname,
+ const char *format, ...)
{
va_list args;
int fldno;
int width;
int align;
+ struct ui_out_level *current = current_level (uiout);
verify_field_proper_position (uiout);
- uiout->field_count[uiout->list_flag] += 1;
- fldno = uiout->field_count[uiout->list_flag];
+ current->field_count += 1;
+ fldno = current->field_count;
/* will not align, but has to call anyway */
verify_field_alignment (uiout, fldno, &width, &align);
}
void
-ui_out_text (struct ui_out *uiout, char *string)
+ui_out_text (struct ui_out *uiout,
+ const char *string)
{
uo_text (uiout, string);
}
void
-ui_out_message (struct ui_out *uiout, int verbosity, char *format,...)
+ui_out_message (struct ui_out *uiout, int verbosity,
+ const char *format,...)
{
va_list args;
ui_out_stream_delete (struct ui_stream *buf)
{
ui_file_delete (buf->stream);
- free (buf);
+ xfree (buf);
}
static void
}
void
-gdb_query (uiout, qflags, qprompt)
- struct ui_out *uiout;
- int flags;
- char *qprompt;
+gdb_query (struct ui_out *uiout, int qflags, char *qprompt)
{
}
#endif
/* default gdb-out hook functions */
static void
-default_table_begin (struct ui_out *uiout, int nbrofcols, char *tblid)
+default_table_begin (struct ui_out *uiout, int nbrofcols,
+ int nr_rows,
+ const char *tblid)
{
}
static void
default_table_header (struct ui_out *uiout, int width, enum ui_align alignment,
- char *colhdr)
+ const char *col_name,
+ const char *colhdr)
{
}
static void
-default_list_begin (struct ui_out *uiout, int list_flag, char *lstid)
+default_begin (struct ui_out *uiout,
+ enum ui_out_type type,
+ int level,
+ const char *id)
{
}
static void
-default_list_end (struct ui_out *uiout, int list_flag)
+default_end (struct ui_out *uiout,
+ enum ui_out_type type,
+ int level)
{
}
static void
default_field_int (struct ui_out *uiout, int fldno, int width,
- enum ui_align align, char *fldname, int value)
+ enum ui_align align,
+ const char *fldname, int value)
{
}
static void
default_field_skip (struct ui_out *uiout, int fldno, int width,
- enum ui_align align, char *fldname)
+ enum ui_align align, const char *fldname)
{
}
int fldno,
int width,
enum ui_align align,
- char *fldname,
+ const char *fldname,
const char *string)
{
}
static void
default_field_fmt (struct ui_out *uiout, int fldno, int width,
- enum ui_align align, char *fldname, char *format,
+ enum ui_align align,
+ const char *fldname,
+ const char *format,
va_list args)
{
}
}
static void
-default_text (struct ui_out *uiout, char *string)
+default_text (struct ui_out *uiout, const char *string)
{
}
static void
-default_message (struct ui_out *uiout, int verbosity, char *format,
+default_message (struct ui_out *uiout, int verbosity,
+ const char *format,
va_list args)
{
}
/* Interface to the implementation functions */
void
-uo_table_begin (struct ui_out *uiout, int nbrofcols, char *tblid)
+uo_table_begin (struct ui_out *uiout, int nbrofcols,
+ int nr_rows,
+ const char *tblid)
{
if (!uiout->impl->table_begin)
return;
- uiout->impl->table_begin (uiout, nbrofcols, tblid);
+ uiout->impl->table_begin (uiout, nbrofcols, nr_rows, tblid);
}
void
}
void
-uo_table_header (struct ui_out *uiout, int width, enum ui_align align, char *colhdr)
+uo_table_header (struct ui_out *uiout, int width, enum ui_align align,
+ const char *col_name,
+ const char *colhdr)
{
if (!uiout->impl->table_header)
return;
- uiout->impl->table_header (uiout, width, align, colhdr);
+ uiout->impl->table_header (uiout, width, align, col_name, colhdr);
}
void
-uo_list_begin (struct ui_out *uiout, int list_flag, char *lstid)
+uo_begin (struct ui_out *uiout,
+ enum ui_out_type type,
+ int level,
+ const char *id)
{
- if (!uiout->impl->list_begin)
+ if (uiout->impl->begin == NULL)
return;
- uiout->impl->list_begin (uiout, list_flag, lstid);
+ uiout->impl->begin (uiout, type, level, id);
}
void
-uo_list_end (struct ui_out *uiout, int list_flag)
+uo_end (struct ui_out *uiout,
+ enum ui_out_type type,
+ int level)
{
- if (!uiout->impl->list_end)
+ if (uiout->impl->end == NULL)
return;
- uiout->impl->list_end (uiout, list_flag);
+ uiout->impl->end (uiout, type, level);
}
void
-uo_field_int (struct ui_out *uiout, int fldno, int width, enum ui_align align, char *fldname, int value)
+uo_field_int (struct ui_out *uiout, int fldno, int width, enum ui_align align,
+ const char *fldname,
+ int value)
{
if (!uiout->impl->field_int)
return;
}
void
-uo_field_skip (struct ui_out *uiout, int fldno, int width, enum ui_align align, char *fldname)
+uo_field_skip (struct ui_out *uiout, int fldno, int width, enum ui_align align,
+ const char *fldname)
{
if (!uiout->impl->field_skip)
return;
void
uo_field_string (struct ui_out *uiout, int fldno, int width,
- enum ui_align align, char *fldname, const char *string)
+ enum ui_align align,
+ const char *fldname,
+ const char *string)
{
if (!uiout->impl->field_string)
return;
}
void
-uo_field_fmt (struct ui_out *uiout, int fldno, int width, enum ui_align align, char *fldname, char *format, va_list args)
+uo_field_fmt (struct ui_out *uiout, int fldno, int width, enum ui_align align,
+ const char *fldname,
+ const char *format,
+ va_list args)
{
if (!uiout->impl->field_fmt)
return;
}
void
-uo_text (struct ui_out *uiout, char *string)
+uo_text (struct ui_out *uiout,
+ const char *string)
{
if (!uiout->impl->text)
return;
}
void
-uo_message (struct ui_out *uiout, int verbosity, char *format, va_list args)
+uo_message (struct ui_out *uiout, int verbosity,
+ const char *format,
+ va_list args)
{
if (!uiout->impl->message)
return;
uiout->headercurr = uiout->headerfirst;
uiout->headerfirst = uiout->headerfirst->next;
if (uiout->headercurr->colhdr != NULL)
- free (uiout->headercurr->colhdr);
- free (uiout->headercurr);
+ xfree (uiout->headercurr->colhdr);
+ xfree (uiout->headercurr);
}
uiout->headerlast = NULL;
uiout->headercurr = NULL;
append_header_to_list (struct ui_out *uiout,
int width,
int alignment,
- char *colhdr)
+ const char *col_name,
+ const char *colhdr)
{
struct ui_out_hdr *temphdr;
temphdr->alignment = alignment;
/* we have to copy the column title as the original may be an automatic */
if (colhdr != NULL)
- {
- temphdr->colhdr = xmalloc (strlen (colhdr) + 1);
- strcpy (temphdr->colhdr, colhdr);
- }
+ temphdr->colhdr = xstrdup (colhdr);
+ else
+ temphdr->colhdr = NULL;
+ if (col_name != NULL)
+ temphdr->col_name = xstrdup (colhdr);
+ else
+ temphdr->col_name = xstrdup (colhdr);
temphdr->next = NULL;
if (uiout->headerfirst == NULL)
{
if (uiout->table_flag)
{
if (!uiout->body_flag)
- internal_error ("ui_out: table_body missing; table fields must be \
+ internal_error (__FILE__, __LINE__,
+ "table_body missing; table fields must be \
specified after table_body and inside a list.");
- if (!uiout->list_flag)
- internal_error ("ui_out: list_begin missing; table fields must be \
+ if (uiout->level == 0)
+ internal_error (__FILE__, __LINE__,
+ "list_begin missing; table fields must be \
specified after table_body and inside a list.");
}
}
&& get_curr_header (uiout, &colno, width, align, &text))
{
if (fldno != colno)
- internal_error ("gdb/ui-out.c: ui-out internal error in handling headers.");
+ internal_error (__FILE__, __LINE__,
+ "ui-out internal error in handling headers.");
}
else
{
uiout->flags = flags;
uiout->table_flag = 0;
uiout->body_flag = 0;
- uiout->list_flag = 0;
- uiout->field_count[0] = 0;
+ uiout->level = 0;
+ memset (uiout->levels, 0, sizeof (uiout->levels));
uiout->headerfirst = NULL;
uiout->headerlast = NULL;
uiout->headercurr = NULL;