GDB (xrefs)
Loading...
Searching...
No Matches
mi-console.c
Go to the documentation of this file.
1/* MI Console code.
2
3 Copyright (C) 2000-2023 Free Software Foundation, Inc.
4
5 Contributed by Cygnus Solutions (a Red Hat company).
6
7 This file is part of GDB.
8
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
13
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21
22/* An MI console is a kind of ui_file stream that sends output to
23 stdout, but encapsulated and prefixed with a distinctive string;
24 for instance, error output is normally identified by a leading
25 "&". */
26
27#include "defs.h"
28#include "mi-console.h"
29
30/* Create a console that wraps the given output stream RAW with the
31 string PREFIX and quoting it with QUOTE. */
32
33mi_console_file::mi_console_file (ui_file *raw, const char *prefix, char quote)
34 : m_raw (raw),
35 m_prefix (prefix),
36 m_quote (quote)
37{}
38
39void
40mi_console_file::write (const char *buf, long length_buf)
41{
42 size_t prev_size = m_buffer.size ();
43 /* Append the text to our internal buffer. */
44 m_buffer.write (buf, length_buf);
45 /* Flush when an embedded newline is present anywhere in the
46 buffer. */
47 if (strchr (m_buffer.c_str () + prev_size, '\n') != NULL)
48 this->flush ();
49}
50
51void
52mi_console_file::write_async_safe (const char *buf, long length_buf)
53{
55 if (m_quote)
56 {
58 m_raw->putstrn (buf, length_buf, m_quote, true);
60 }
61 else
62 m_raw->putstrn (buf, length_buf, 0, true);
63
64 char nl = '\n';
65 m_raw->write_async_safe (&nl, 1);
66}
67
68void
70{
71 const std::string &str = m_buffer.string ();
72
73 /* Transform a byte sequence into a console output packet. */
74 if (!str.empty ())
75 {
76 size_t length_buf = str.size ();
77 const char *buf = str.data ();
78
80 if (m_quote)
81 {
83 m_raw->putstrn (buf, length_buf, m_quote);
85 gdb_putc ('\n', m_raw);
86 }
87 else
88 {
89 m_raw->putstrn (buf, length_buf, 0);
90 gdb_putc ('\n', m_raw);
91 }
93 }
94
95 m_buffer.clear ();
96}
97
98/* Change the underlying stream of the console directly; this is
99 useful as a minimum-impact way to reflect external changes like
100 logging enable/disable. */
101
102void
104{
105 m_raw = raw;
106}
string_file m_buffer
Definition mi-console.h:49
void write_async_safe(const char *buf, long length_buf) override
Definition mi-console.c:52
ui_file * m_raw
Definition mi-console.h:46
mi_console_file(ui_file *raw, const char *prefix, char quote)
Definition mi-console.c:33
void set_raw(ui_file *raw)
Definition mi-console.c:103
const char * m_prefix
Definition mi-console.h:52
void write(const char *buf, long length_buf) override
Definition mi-console.c:40
void flush() override
Definition mi-console.c:69
size_t size() const
Definition ui-file.h:223
void write(const char *buf, long length_buf) override
Definition ui-file.c:214
const char * c_str() const
Definition ui-file.h:222
const std::string & string()
Definition ui-file.h:198
void clear()
Definition ui-file.h:225
virtual void write_async_safe(const char *buf, long length_buf)
Definition ui-file.h:71
void putstrn(const char *str, int n, int quoter, bool async_safe=false)
Definition ui-file.c:57
#define prefix(a, b, R, do)
Definition ppc64-tdep.c:52
void gdb_putc(int c)
Definition utils.c:1862
void gdb_flush(struct ui_file *stream)
Definition utils.c:1498
void gdb_puts(const char *linebuffer, struct ui_file *stream)
Definition utils.c:1809