-extern void ui_out_begin (struct ui_out *uiout,
- enum ui_out_type level_type,
- const char *id);
-
-extern void ui_out_end (struct ui_out *uiout, enum ui_out_type type);
-
-extern struct cleanup *ui_out_begin_cleanup_end (struct ui_out *uiout,
- enum ui_out_type level_type,
- const char *id);
-
-/* 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. */
-extern void ui_out_table_header (struct ui_out *uiout, int width,
- enum ui_align align, const char *col_name,
- const char *colhdr);
-
-extern void ui_out_table_body (struct ui_out *uiout);
-
-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);
-
-extern void ui_out_field_int (struct ui_out *uiout, const char *fldname,
- int value);
-
-extern void ui_out_field_fmt_int (struct ui_out *uiout, int width,
- enum ui_align align, const char *fldname,
- int value);
-
-/* Output a field containing an address. */
-
-extern void ui_out_field_core_addr (struct ui_out *uiout, const char *fldname,
- struct gdbarch *gdbarch, CORE_ADDR address);
-
-extern void ui_out_field_string (struct ui_out * uiout, const char *fldname,
- const char *string);
-
-extern void ui_out_field_stream (struct ui_out *uiout, const char *fldname,
- struct ui_file *stream);
-
-extern void ui_out_field_fmt (struct ui_out *uiout, const char *fldname,
- const char *format, ...)
- ATTRIBUTE_PRINTF (3, 4);
-
-extern void ui_out_field_skip (struct ui_out *uiout, const char *fldname);
-
-extern void ui_out_spaces (struct ui_out *uiout, int numspaces);
-
-extern void ui_out_text (struct ui_out *uiout, const char *string);
-
-extern void ui_out_message (struct ui_out *uiout, int verbosity,
- const char *format, ...)
- ATTRIBUTE_PRINTF (3, 4);
-
-extern void ui_out_wrap_hint (struct ui_out *uiout, char *identstring);
-
-extern void ui_out_flush (struct ui_out *uiout);
-
-extern int ui_out_set_flags (struct ui_out *uiout, int mask);
-
-extern int ui_out_clear_flags (struct ui_out *uiout, int mask);
-
-extern int ui_out_get_verblvl (struct ui_out *uiout);
-
-extern int ui_out_test_flags (struct ui_out *uiout, int mask);
-
-extern int ui_out_query_field (struct ui_out *uiout, int colno,
- int *width, int *alignment, char **col_name);
-
-#if 0
-extern void ui_out_result_begin (struct ui_out *uiout, char *class);
-
-extern void ui_out_result_end (struct ui_out *uiout);
-
-extern void ui_out_info_begin (struct ui_out *uiout, char *class);
-
-extern void ui_out_info_end (struct ui_out *uiout);
-
-extern void ui_out_notify_begin (struct ui_out *uiout, char *class);
-
-extern void ui_out_notify_end (struct ui_out *uiout);
+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_string (const char *fldname, const std::string &string);
+ void field_stream (const char *fldname, string_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. */
+ void 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 () const;
+
+ 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 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 () const
+ { 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;
+};
+
+/* This is similar to make_cleanup_ui_out_tuple_begin_end and
+ make_cleanup_ui_out_list_begin_end, but written as an RAII template
+ class. It takes the ui_out_type as a template parameter. 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);
+ }