/* MI Console code.
- Copyright (C) 2000, 2001, 2002, 2007, 2008, 2009, 2010, 2011
- Free Software Foundation, Inc.
+ Copyright (C) 2000-2020 Free Software Foundation, Inc.
Contributed by Cygnus Solutions (a Red Hat company).
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
+/* An MI console is a kind of ui_file stream that sends output to
+ stdout, but encapsulated and prefixed with a distinctive string;
+ for instance, error output is normally identified by a leading
+ "&". */
+
#include "defs.h"
#include "mi-console.h"
-#include "gdb_string.h"
-
-/* MI-console: send output to std-out but correcty encapsulated */
-static ui_file_fputs_ftype mi_console_file_fputs;
-static ui_file_flush_ftype mi_console_file_flush;
-static ui_file_delete_ftype mi_console_file_delete;
+/* Create a console that wraps the given output stream RAW with the
+ string PREFIX and quoting it with QUOTE. */
-struct mi_console_file
- {
- int *magic;
- struct ui_file *raw;
- struct ui_file *buffer;
- const char *prefix;
- char quote;
- };
+mi_console_file::mi_console_file (ui_file *raw, const char *prefix, char quote)
+ : m_raw (raw),
+ m_prefix (prefix),
+ m_quote (quote)
+{}
-int mi_console_file_magic;
-
-struct ui_file *
-mi_console_file_new (struct ui_file *raw,
- const char *prefix, char quote)
+void
+mi_console_file::write (const char *buf, long length_buf)
{
- struct ui_file *ui_file = ui_file_new ();
- struct mi_console_file *mi_console = XMALLOC (struct mi_console_file);
-
- mi_console->magic = &mi_console_file_magic;
- mi_console->raw = raw;
- mi_console->buffer = mem_fileopen ();
- mi_console->prefix = prefix;
- mi_console->quote = quote;
- set_ui_file_fputs (ui_file, mi_console_file_fputs);
- set_ui_file_flush (ui_file, mi_console_file_flush);
- set_ui_file_data (ui_file, mi_console, mi_console_file_delete);
- return ui_file;
+ size_t prev_size = m_buffer.size ();
+ /* Append the text to our internal buffer. */
+ m_buffer.write (buf, length_buf);
+ /* Flush when an embedded newline is present anywhere in the
+ buffer. */
+ if (strchr (m_buffer.c_str () + prev_size, '\n') != NULL)
+ this->flush ();
}
-static void
-mi_console_file_delete (struct ui_file *file)
-{
- struct mi_console_file *mi_console = ui_file_data (file);
+/* Write C to STREAM's in an async-safe way. */
- if (mi_console->magic != &mi_console_file_magic)
- internal_error (__FILE__, __LINE__,
- _("mi_console_file_delete: bad magic number"));
- xfree (mi_console);
+static int
+do_fputc_async_safe (int c, ui_file *stream)
+{
+ char ch = c;
+ stream->write_async_safe (&ch, 1);
+ return c;
}
-static void
-mi_console_file_fputs (const char *buf,
- struct ui_file *file)
+void
+mi_console_file::write_async_safe (const char *buf, long length_buf)
{
- struct mi_console_file *mi_console = ui_file_data (file);
-
- if (mi_console->magic != &mi_console_file_magic)
- internal_error (__FILE__, __LINE__,
- "mi_console_file_fputs: bad magic number");
- /* Append the text to our internal buffer */
- fputs_unfiltered (buf, mi_console->buffer);
- /* Flush when an embedded \n */
- if (strchr (buf, '\n') != NULL)
- gdb_flush (file);
+ m_raw->write_async_safe (m_prefix, strlen (m_prefix));
+ if (m_quote)
+ {
+ m_raw->write_async_safe (&m_quote, 1);
+ fputstrn_unfiltered (buf, length_buf, m_quote, do_fputc_async_safe,
+ m_raw);
+ m_raw->write_async_safe (&m_quote, 1);
+ }
+ else
+ fputstrn_unfiltered (buf, length_buf, 0, do_fputc_async_safe, m_raw);
+
+ char nl = '\n';
+ m_raw->write_async_safe (&nl, 1);
}
-/* Transform a byte sequence into a console output packet. */
-static void
-mi_console_raw_packet (void *data,
- const char *buf,
- long length_buf)
+void
+mi_console_file::flush ()
{
- struct mi_console_file *mi_console = data;
-
- if (mi_console->magic != &mi_console_file_magic)
- internal_error (__FILE__, __LINE__,
- _("mi_console_file_transform: bad magic number"));
+ const std::string &str = m_buffer.string ();
- if (length_buf > 0)
+ /* Transform a byte sequence into a console output packet. */
+ if (!str.empty ())
{
- fputs_unfiltered (mi_console->prefix, mi_console->raw);
- if (mi_console->quote)
+ size_t length_buf = str.size ();
+ const char *buf = str.data ();
+
+ fputs_unfiltered (m_prefix, m_raw);
+ if (m_quote)
{
- fputs_unfiltered ("\"", mi_console->raw);
- fputstrn_unfiltered (buf, length_buf,
- mi_console->quote, mi_console->raw);
- fputs_unfiltered ("\"\n", mi_console->raw);
+ fputc_unfiltered (m_quote, m_raw);
+ fputstrn_unfiltered (buf, length_buf, m_quote, fputc_unfiltered,
+ m_raw);
+ fputc_unfiltered (m_quote, m_raw);
+ fputc_unfiltered ('\n', m_raw);
}
else
{
- fputstrn_unfiltered (buf, length_buf, 0, mi_console->raw);
- fputs_unfiltered ("\n", mi_console->raw);
+ fputstrn_unfiltered (buf, length_buf, 0, fputc_unfiltered, m_raw);
+ fputc_unfiltered ('\n', m_raw);
}
- gdb_flush (mi_console->raw);
+ gdb_flush (m_raw);
}
+
+ m_buffer.clear ();
}
-static void
-mi_console_file_flush (struct ui_file *file)
-{
- struct mi_console_file *mi_console = ui_file_data (file);
+/* Change the underlying stream of the console directly; this is
+ useful as a minimum-impact way to reflect external changes like
+ logging enable/disable. */
- if (mi_console->magic != &mi_console_file_magic)
- internal_error (__FILE__, __LINE__,
- _("mi_console_file_flush: bad magic number"));
- ui_file_put (mi_console->buffer, mi_console_raw_packet, mi_console);
- ui_file_rewind (mi_console->buffer);
+void
+mi_console_file::set_raw (ui_file *raw)
+{
+ m_raw = raw;
}