/* Output generating routines for GDB.
- Copyright (C) 1999-2016 Free Software Foundation, Inc.
+ Copyright (C) 1999-2019 Free Software Foundation, Inc.
Contributed by Cygnus Solutions.
Written by Fernando Nasser for Cygnus.
#include <vector>
-#include "common/enum-flags.h"
+#include "gdbsupport/enum-flags.h"
class ui_out_level;
class ui_out_table;
/* flags enum */
enum ui_out_flag
- {
- ui_source_list = (1 << 0),
- };
+{
+ ui_source_list = (1 << 0),
+ fix_multi_location_breakpoint_output = (1 << 1),
+};
DEF_ENUM_FLAGS_TYPE (ui_out_flag, ui_out_flags);
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);
+/* Possible kinds of styling. */
-extern struct cleanup *make_cleanup_ui_out_tuple_begin_end (struct ui_out *uiout,
- const char *id);
+enum class ui_out_style_kind
+{
+ /* The default (plain) style. */
+ DEFAULT,
+ /* File name. */
+ FILE,
+ /* Function name. */
+ FUNCTION,
+ /* Variable name. */
+ VARIABLE,
+ /* Address. */
+ ADDRESS
+};
class ui_out
{
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_signed (const char *fldname, LONGEST value);
+ void field_fmt_signed (int width, ui_align align, const char *fldname,
+ LONGEST value);
+ /* Like field_signed, but print an unsigned value. */
+ void field_unsigned (const char *fldname, ULONGEST 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_string (const char *fldname, const char *string,
+ ui_out_style_kind style = ui_out_style_kind::DEFAULT);
+ void field_string (const char *fldname, const std::string &string);
+ void field_stream (const char *fldname, string_file &stream,
+ ui_out_style_kind style = ui_out_style_kind::DEFAULT);
void field_skip (const char *fldname);
void field_fmt (const char *fldname, const char *format, ...)
ATTRIBUTE_PRINTF (3, 4);
void flush ();
/* Redirect the output of a ui_out object temporarily. */
- int redirect (ui_file *outstream);
+ void redirect (ui_file *outstream);
ui_out_flags test_flags (ui_out_flags mask);
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 is_mi_like_p () const;
bool query_table_field (int colno, int *width, int *alignment,
const char **col_name);
+ /* Return true if this stream is prepared to handle style
+ escapes. */
+ virtual bool can_emit_style_escape () const = 0;
+
protected:
virtual void do_table_begin (int nbrofcols, int nr_rows, const char *tblid)
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_signed (int fldno, int width, ui_align align,
+ const char *fldname, LONGEST value) = 0;
+ virtual void do_field_unsigned (int fldno, int width, ui_align align,
+ const char *fldname, ULONGEST 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;
+ const char *fldname, const char *string,
+ ui_out_style_kind style) = 0;
virtual void do_field_fmt (int fldno, int width, ui_align align,
const char *fldname, 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;
+ virtual void 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 ()
+ virtual bool do_is_mi_like_p () const
{ return false; }
private:
ui_out_level *current_level () const;
};
+/* Start a new tuple or list on construction, and end it on
+ destruction. Normally this is used via the typedefs
+ ui_out_emit_tuple and ui_out_emit_list. */
+template<ui_out_type Type>
+class ui_out_emit_type
+{
+public:
+
+ ui_out_emit_type (struct ui_out *uiout, const char *id)
+ : m_uiout (uiout)
+ {
+ uiout->begin (Type, id);
+ }
+
+ ~ui_out_emit_type ()
+ {
+ m_uiout->end (Type);
+ }
+
+ DISABLE_COPY_AND_ASSIGN (ui_out_emit_type<Type>);
+
+private:
+
+ struct ui_out *m_uiout;
+};
+
+typedef ui_out_emit_type<ui_out_type_tuple> ui_out_emit_tuple;
+typedef ui_out_emit_type<ui_out_type_list> ui_out_emit_list;
+
+/* Start a new table on construction, and end the table on
+ destruction. */
+class ui_out_emit_table
+{
+public:
+
+ ui_out_emit_table (struct ui_out *uiout, int nr_cols, int nr_rows,
+ const char *tblid)
+ : m_uiout (uiout)
+ {
+ m_uiout->table_begin (nr_cols, nr_rows, tblid);
+ }
+
+ ~ui_out_emit_table ()
+ {
+ m_uiout->table_end ();
+ }
+
+ ui_out_emit_table (const ui_out_emit_table &) = delete;
+ ui_out_emit_table &operator= (const ui_out_emit_table &) = delete;
+
+private:
+
+ struct ui_out *m_uiout;
+};
+
+/* On destruction, pop the last redirection by calling the uiout's
+ redirect method with a NULL parameter. */
+class ui_out_redirect_pop
+{
+public:
+
+ ui_out_redirect_pop (ui_out *uiout)
+ : m_uiout (uiout)
+ {
+ }
+
+ ~ui_out_redirect_pop ()
+ {
+ m_uiout->redirect (NULL);
+ }
+
+ ui_out_redirect_pop (const ui_out_redirect_pop &) = delete;
+ ui_out_redirect_pop &operator= (const ui_out_redirect_pop &) = delete;
+
+private:
+ struct ui_out *m_uiout;
+};
+
#endif /* UI_OUT_H */