GDB (xrefs)
Loading...
Searching...
No Matches
cli-out.h
Go to the documentation of this file.
1/* Output generating routines for GDB CLI.
2 Copyright (C) 1999-2023 Free Software Foundation, Inc.
3 Contributed by Cygnus Solutions.
4
5 This file is part of GDB.
6
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
11
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
19
20#ifndef CLI_OUT_H
21#define CLI_OUT_H
22
23#include "ui-out.h"
24#include <chrono>
25#include <vector>
26
27class cli_ui_out : public ui_out
28{
29public:
30
31 explicit cli_ui_out (ui_file *stream, ui_out_flags flags = ui_source_list);
32 virtual ~cli_ui_out ();
33
34 ui_file *set_stream (ui_file *stream);
35
36 bool can_emit_style_escape () const override;
37
38protected:
39
40 virtual void do_table_begin (int nbrofcols, int nr_rows,
41 const char *tblid) override;
42 virtual void do_table_body () override;
43 virtual void do_table_end () override;
44 virtual void do_table_header (int width, ui_align align,
45 const std::string &col_name,
46 const std::string &col_hdr) override;
47 /* Note: level 0 is the top-level so LEVEL is always greater than
48 zero. */
49 virtual void do_begin (ui_out_type type, const char *id) override;
50 virtual void do_end (ui_out_type type) override;
51 virtual void do_field_signed (int fldno, int width, ui_align align,
52 const char *fldname, LONGEST value) override;
53 virtual void do_field_unsigned (int fldno, int width, ui_align align,
54 const char *fldname, ULONGEST value)
55 override;
56 virtual void do_field_skip (int fldno, int width, ui_align align,
57 const char *fldname) override;
58 virtual void do_field_string (int fldno, int width, ui_align align,
59 const char *fldname,
60 const char *string,
61 const ui_file_style &style) override;
62 virtual void do_field_fmt (int fldno, int width, ui_align align,
63 const char *fldname, const ui_file_style &style,
64 const char *format, va_list args)
65 override ATTRIBUTE_PRINTF (7, 0);
66 virtual void do_spaces (int numspaces) override;
67 virtual void do_text (const char *string) override;
68 virtual void do_message (const ui_file_style &style,
69 const char *format, va_list args) override
70 ATTRIBUTE_PRINTF (3,0);
71 virtual void do_wrap_hint (int indent) override;
72 virtual void do_flush () override;
73 virtual void do_redirect (struct ui_file *outstream) override;
74
75 virtual void do_progress_start () override;
76 virtual void do_progress_notify (const std::string &, const char *,
77 double, double) override;
78 virtual void do_progress_end () override;
79
81 { return m_suppress_output; }
82
83private:
84
85 void field_separator ();
86
87 std::vector<ui_file *> m_streams;
89
90 /* The state of a recent progress update. */
92 {
93 /* Position of the progress indicator. */
94 int pos;
95 /* The current state. */
96 progress_update::state state;
97 /* Progress indicator's time of last update. */
98 std::chrono::steady_clock::time_point last_update;
99
101 : pos (0), state (progress_update::START)
102 {}
103 };
104
105 /* Stack of progress info. */
106 std::vector<cli_progress_info> m_progress_info;
107 void clear_progress_notify ();
108};
109
110extern void cli_display_match_list (char **matches, int len, int max);
111
112#endif
void field_separator()
Definition cli-out.c:425
virtual void do_flush() override
Definition cli-out.c:248
bool can_emit_style_escape() const override
Definition cli-out.c:457
virtual void do_table_body() override
Definition cli-out.c:49
std::vector< cli_progress_info > m_progress_info
Definition cli-out.h:106
cli_ui_out(ui_file *stream, ui_out_flags flags=ui_source_list)
Definition cli-out.c:432
virtual void do_begin(ui_out_type type, const char *id) override
Definition cli-out.c:83
virtual void do_table_end() override
Definition cli-out.c:61
virtual void do_table_header(int width, ui_align align, const std::string &col_name, const std::string &col_hdr) override
Definition cli-out.c:69
void clear_progress_notify()
Definition cli-out.c:385
virtual void do_progress_start() override
Definition cli-out.c:270
virtual void virtual void do_spaces(int numspaces) override
Definition cli-out.c:204
virtual void do_field_string(int fldno, int width, ui_align align, const char *fldname, const char *string, const ui_file_style &style) override
Definition cli-out.c:137
virtual void do_field_signed(int fldno, int width, ui_align align, const char *fldname, LONGEST value) override
Definition cli-out.c:97
virtual void do_message(const ui_file_style &style, const char *format, va_list args) override ATTRIBUTE_PRINTF(3
Definition cli-out.c:222
virtual void do_progress_end() override
Definition cli-out.c:413
bool suppress_output()
Definition cli-out.h:80
virtual void do_field_fmt(int fldno, int width, ui_align align, const char *fldname, const ui_file_style &style, const char *format, va_list args) override ATTRIBUTE_PRINTF(7
Definition cli-out.c:191
bool m_suppress_output
Definition cli-out.h:88
virtual void virtual void do_wrap_hint(int indent) override
Definition cli-out.c:239
std::vector< ui_file * > m_streams
Definition cli-out.h:87
virtual void do_text(const char *string) override
Definition cli-out.c:213
virtual ~cli_ui_out()
Definition cli-out.c:441
virtual void do_table_begin(int nbrofcols, int nr_rows, const char *tblid) override
Definition cli-out.c:36
ui_file * set_stream(ui_file *stream)
Definition cli-out.c:446
virtual void do_field_unsigned(int fldno, int width, ui_align align, const char *fldname, ULONGEST value) override
Definition cli-out.c:110
virtual void do_end(ui_out_type type) override
Definition cli-out.c:90
virtual void do_field_skip(int fldno, int width, ui_align align, const char *fldname) override
Definition cli-out.c:123
virtual void do_redirect(struct ui_file *outstream) override
Definition cli-out.c:258
virtual void do_progress_notify(const std::string &, const char *, double, double) override
Definition cli-out.c:297
void cli_display_match_list(char **matches, int len, int max)
Definition cli-out.c:526
static void ATTRIBUTE_PRINTF(1, 0)
Definition gdb_bfd.c:1154
mach_port_t kern_return_t mach_port_t mach_msg_type_name_t msgportsPoly mach_port_t kern_return_t pid_t pid mach_port_t kern_return_t mach_port_t task mach_port_t kern_return_t int flags
Definition gnu-nat.c:1861
progress_update::state state
Definition cli-out.h:96
std::chrono::steady_clock::time_point last_update
Definition cli-out.h:98
Definition value.h:130
ui_out_type
Definition ui-out.h:70
ui_align
Definition ui-out.h:44
@ ui_source_list
Definition ui-out.h:54