/* UI_FILE - a generic STDIO like output stream.
- Copyright (C) 1999, 2000, 2001, 2002, 2007 Free Software Foundation, Inc.
+ Copyright (C) 1999-2020 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
+ the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 51 Franklin Street, Fifth Floor,
- Boston, MA 02110-1301, USA. */
+ along with this program. If not, see <http://www.gnu.org/licenses/>. */
-/* Implement the ``struct ui_file'' object. */
+/* Implement the ``struct ui_file'' object. */
#include "defs.h"
#include "ui-file.h"
-#include "gdb_string.h"
+#include "gdb_obstack.h"
+#include "gdbsupport/gdb_select.h"
+#include "gdbsupport/filestuff.h"
+#include "cli/cli-style.h"
-#include <errno.h>
+null_file null_stream;
-static ui_file_isatty_ftype null_file_isatty;
-static ui_file_write_ftype null_file_write;
-static ui_file_fputs_ftype null_file_fputs;
-static ui_file_read_ftype null_file_read;
-static ui_file_flush_ftype null_file_flush;
-static ui_file_delete_ftype null_file_delete;
-static ui_file_rewind_ftype null_file_rewind;
-static ui_file_put_ftype null_file_put;
+ui_file::ui_file ()
+{}
-struct ui_file
- {
- int *magic;
- ui_file_flush_ftype *to_flush;
- ui_file_write_ftype *to_write;
- ui_file_fputs_ftype *to_fputs;
- ui_file_read_ftype *to_read;
- ui_file_delete_ftype *to_delete;
- ui_file_isatty_ftype *to_isatty;
- ui_file_rewind_ftype *to_rewind;
- ui_file_put_ftype *to_put;
- void *to_data;
- };
-int ui_file_magic;
-
-struct ui_file *
-ui_file_new (void)
-{
- struct ui_file *file = xmalloc (sizeof (struct ui_file));
- file->magic = &ui_file_magic;
- set_ui_file_data (file, NULL, null_file_delete);
- set_ui_file_flush (file, null_file_flush);
- set_ui_file_write (file, null_file_write);
- set_ui_file_fputs (file, null_file_fputs);
- set_ui_file_read (file, null_file_read);
- set_ui_file_isatty (file, null_file_isatty);
- set_ui_file_rewind (file, null_file_rewind);
- set_ui_file_put (file, null_file_put);
- return file;
-}
+ui_file::~ui_file ()
+{}
void
-ui_file_delete (struct ui_file *file)
+ui_file::printf (const char *format, ...)
{
- file->to_delete (file);
- xfree (file);
-}
+ va_list args;
-static int
-null_file_isatty (struct ui_file *file)
-{
- return 0;
+ va_start (args, format);
+ vfprintf_unfiltered (this, format, args);
+ va_end (args);
}
-static void
-null_file_rewind (struct ui_file *file)
+void
+ui_file::putstr (const char *str, int quoter)
{
- return;
+ fputstr_unfiltered (str, quoter, this);
}
-static void
-null_file_put (struct ui_file *file,
- ui_file_put_method_ftype *write,
- void *dest)
+void
+ui_file::putstrn (const char *str, int n, int quoter)
{
- return;
+ fputstrn_unfiltered (str, n, quoter, fputc_unfiltered, this);
}
-static void
-null_file_flush (struct ui_file *file)
+int
+ui_file::putc (int c)
{
- return;
+ return fputc_unfiltered (c, this);
}
-static void
-null_file_write (struct ui_file *file,
- const char *buf,
- long sizeof_buf)
+void
+ui_file::vprintf (const char *format, va_list args)
{
- if (file->to_fputs == null_file_fputs)
- /* Both the write and fputs methods are null. Discard the
- request. */
- return;
- else
- {
- /* The fputs method isn't null, slowly pass the write request
- onto that. FYI, this isn't as bad as it may look - the
- current (as of 1999-11-07) printf_* function calls fputc and
- fputc does exactly the below. By having a write function it
- is possible to clean up that code. */
- int i;
- char b[2];
- b[1] = '\0';
- for (i = 0; i < sizeof_buf; i++)
- {
- b[0] = buf[i];
- file->to_fputs (b, file);
- }
- return;
- }
+ vfprintf_unfiltered (this, format, args);
}
-static long
-null_file_read (struct ui_file *file,
- char *buf,
- long sizeof_buf)
+\f
+
+void
+null_file::write (const char *buf, long sizeof_buf)
{
- errno = EBADF;
- return 0;
+ /* Discard the request. */
}
-static void
-null_file_fputs (const char *buf, struct ui_file *file)
+void
+null_file::puts (const char *)
{
- if (file->to_write == null_file_write)
- /* Both the write and fputs methods are null. Discard the
- request. */
- return;
- else
- {
- /* The write method was implemented, use that. */
- file->to_write (file, buf, strlen (buf));
- }
+ /* Discard the request. */
}
-static void
-null_file_delete (struct ui_file *file)
+void
+null_file::write_async_safe (const char *buf, long sizeof_buf)
{
- return;
+ /* Discard the request. */
}
-void *
-ui_file_data (struct ui_file *file)
+\f
+
+/* true if the gdb terminal supports styling, and styling is enabled. */
+
+static bool
+term_cli_styling ()
{
- if (file->magic != &ui_file_magic)
- internal_error (__FILE__, __LINE__,
- _("ui_file_data: bad magic number"));
- return file->to_data;
+ if (!cli_styling)
+ return false;
+
+ const char *term = getenv ("TERM");
+ /* Windows doesn't by default define $TERM, but can support styles
+ regardless. */
+#ifndef _WIN32
+ if (term == nullptr || !strcmp (term, "dumb"))
+ return false;
+#else
+ /* But if they do define $TERM, let us behave the same as on Posix
+ platforms, for the benefit of programs which invoke GDB as their
+ back-end. */
+ if (term && !strcmp (term, "dumb"))
+ return false;
+#endif
+ return true;
}
+\f
+
+string_file::~string_file ()
+{}
+
void
-gdb_flush (struct ui_file *file)
+string_file::write (const char *buf, long length_buf)
{
- file->to_flush (file);
+ m_string.append (buf, length_buf);
}
-int
-ui_file_isatty (struct ui_file *file)
-{
- return file->to_isatty (file);
-}
+/* See ui-file.h. */
-void
-ui_file_rewind (struct ui_file *file)
+bool
+string_file::term_out ()
{
- file->to_rewind (file);
+ return m_term_out;
}
-void
-ui_file_put (struct ui_file *file,
- ui_file_put_method_ftype *write,
- void *dest)
+/* See ui-file.h. */
+
+bool
+string_file::can_emit_style_escape ()
{
- file->to_put (file, write, dest);
+ return m_term_out && term_cli_styling ();
}
-void
-ui_file_write (struct ui_file *file,
- const char *buf,
- long length_buf)
+\f
+
+stdio_file::stdio_file (FILE *file, bool close_p)
{
- file->to_write (file, buf, length_buf);
+ set_stream (file);
+ m_close_p = close_p;
}
-long
-ui_file_read (struct ui_file *file, char *buf, long length_buf)
+stdio_file::stdio_file ()
+ : m_file (NULL),
+ m_fd (-1),
+ m_close_p (false)
+{}
+
+stdio_file::~stdio_file ()
{
- return file->to_read (file, buf, length_buf);
+ if (m_close_p)
+ fclose (m_file);
}
void
-fputs_unfiltered (const char *buf, struct ui_file *file)
+stdio_file::set_stream (FILE *file)
{
- file->to_fputs (buf, file);
+ m_file = file;
+ m_fd = fileno (file);
}
-void
-set_ui_file_flush (struct ui_file *file, ui_file_flush_ftype *flush)
+bool
+stdio_file::open (const char *name, const char *mode)
{
- file->to_flush = flush;
+ /* Close the previous stream, if we own it. */
+ if (m_close_p)
+ {
+ fclose (m_file);
+ m_close_p = false;
+ }
+
+ gdb_file_up f = gdb_fopen_cloexec (name, mode);
+
+ if (f == NULL)
+ return false;
+
+ set_stream (f.release ());
+ m_close_p = true;
+
+ return true;
}
void
-set_ui_file_isatty (struct ui_file *file, ui_file_isatty_ftype *isatty)
+stdio_file::flush ()
{
- file->to_isatty = isatty;
+ fflush (m_file);
}
-void
-set_ui_file_rewind (struct ui_file *file, ui_file_rewind_ftype *rewind)
+long
+stdio_file::read (char *buf, long length_buf)
{
- file->to_rewind = rewind;
+ /* Wait until at least one byte of data is available, or we get
+ interrupted with Control-C. */
+ {
+ fd_set readfds;
+
+ FD_ZERO (&readfds);
+ FD_SET (m_fd, &readfds);
+ if (interruptible_select (m_fd + 1, &readfds, NULL, NULL, NULL) == -1)
+ return -1;
+ }
+
+ return ::read (m_fd, buf, length_buf);
}
void
-set_ui_file_put (struct ui_file *file, ui_file_put_ftype *put)
+stdio_file::write (const char *buf, long length_buf)
{
- file->to_put = put;
+ /* Calling error crashes when we are called from the exception framework. */
+ if (fwrite (buf, length_buf, 1, m_file))
+ {
+ /* Nothing. */
+ }
}
void
-set_ui_file_write (struct ui_file *file,
- ui_file_write_ftype *write)
+stdio_file::write_async_safe (const char *buf, long length_buf)
{
- file->to_write = write;
+ /* This is written the way it is to avoid a warning from gcc about not using the
+ result of write (since it can be declared with attribute warn_unused_result).
+ Alas casting to void doesn't work for this. */
+ if (::write (m_fd, buf, length_buf))
+ {
+ /* Nothing. */
+ }
}
void
-set_ui_file_read (struct ui_file *file, ui_file_read_ftype *read)
+stdio_file::puts (const char *linebuffer)
{
- file->to_read = read;
+ /* This host-dependent function (with implementations in
+ posix-hdep.c and mingw-hdep.c) is given the opportunity to
+ process the output first in host-dependent way. If it does, it
+ should return non-zero, to avoid calling fputs below. */
+ if (gdb_console_fputs (linebuffer, m_file))
+ return;
+ /* Calling error crashes when we are called from the exception framework. */
+ if (fputs (linebuffer, m_file))
+ {
+ /* Nothing. */
+ }
}
-void
-set_ui_file_fputs (struct ui_file *file, ui_file_fputs_ftype *fputs)
+bool
+stdio_file::isatty ()
{
- file->to_fputs = fputs;
+ return ::isatty (m_fd);
}
-void
-set_ui_file_data (struct ui_file *file, void *data,
- ui_file_delete_ftype *delete)
+/* See ui-file.h. */
+
+bool
+stdio_file::can_emit_style_escape ()
{
- file->to_data = data;
- file->to_delete = delete;
+ return ((this == gdb_stdout || this == gdb_stderr)
+ && this->isatty ()
+ && term_cli_styling ());
}
-/* ui_file utility function for converting a ``struct ui_file'' into
- a memory buffer''. */
+\f
-struct accumulated_ui_file
-{
- char *buffer;
- long length;
-};
+/* This is the implementation of ui_file method 'write' for stderr.
+ gdb_stdout is flushed before writing to gdb_stderr. */
-static void
-do_ui_file_xstrdup (void *context, const char *buffer, long length)
+void
+stderr_file::write (const char *buf, long length_buf)
{
- struct accumulated_ui_file *acc = context;
- if (acc->buffer == NULL)
- acc->buffer = xmalloc (length + 1);
- else
- acc->buffer = xrealloc (acc->buffer, acc->length + length + 1);
- memcpy (acc->buffer + acc->length, buffer, length);
- acc->length += length;
- acc->buffer[acc->length] = '\0';
+ gdb_stdout->flush ();
+ stdio_file::write (buf, length_buf);
}
-char *
-ui_file_xstrdup (struct ui_file *file,
- long *length)
+/* This is the implementation of ui_file method 'puts' for stderr.
+ gdb_stdout is flushed before writing to gdb_stderr. */
+
+void
+stderr_file::puts (const char *linebuffer)
{
- struct accumulated_ui_file acc;
- acc.buffer = NULL;
- acc.length = 0;
- ui_file_put (file, do_ui_file_xstrdup, &acc);
- if (acc.buffer == NULL)
- acc.buffer = xstrdup ("");
- *length = acc.length;
- return acc.buffer;
+ gdb_stdout->flush ();
+ stdio_file::puts (linebuffer);
}
-\f
-/* A pure memory based ``struct ui_file'' that can be used an output
- buffer. The buffers accumulated contents are available via
- ui_file_put(). */
-struct mem_file
- {
- int *magic;
- char *buffer;
- int sizeof_buffer;
- int length_buffer;
- };
+stderr_file::stderr_file (FILE *stream)
+ : stdio_file (stream)
+{}
-static ui_file_rewind_ftype mem_file_rewind;
-static ui_file_put_ftype mem_file_put;
-static ui_file_write_ftype mem_file_write;
-static ui_file_delete_ftype mem_file_delete;
-static struct ui_file *mem_file_new (void);
-static int mem_file_magic;
+\f
-static struct ui_file *
-mem_file_new (void)
-{
- struct mem_file *stream = XMALLOC (struct mem_file);
- struct ui_file *file = ui_file_new ();
- set_ui_file_data (file, stream, mem_file_delete);
- set_ui_file_rewind (file, mem_file_rewind);
- set_ui_file_put (file, mem_file_put);
- set_ui_file_write (file, mem_file_write);
- stream->magic = &mem_file_magic;
- stream->buffer = NULL;
- stream->sizeof_buffer = 0;
- stream->length_buffer = 0;
- return file;
-}
+tee_file::tee_file (ui_file *one, ui_file_up &&two)
+ : m_one (one),
+ m_two (std::move (two))
+{}
-static void
-mem_file_delete (struct ui_file *file)
+tee_file::~tee_file ()
{
- struct mem_file *stream = ui_file_data (file);
- if (stream->magic != &mem_file_magic)
- internal_error (__FILE__, __LINE__,
- _("mem_file_delete: bad magic number"));
- if (stream->buffer != NULL)
- xfree (stream->buffer);
- xfree (stream);
}
-struct ui_file *
-mem_fileopen (void)
+void
+tee_file::flush ()
{
- return mem_file_new ();
+ m_one->flush ();
+ m_two->flush ();
}
-static void
-mem_file_rewind (struct ui_file *file)
+void
+tee_file::write (const char *buf, long length_buf)
{
- struct mem_file *stream = ui_file_data (file);
- if (stream->magic != &mem_file_magic)
- internal_error (__FILE__, __LINE__,
- _("mem_file_rewind: bad magic number"));
- stream->length_buffer = 0;
+ m_one->write (buf, length_buf);
+ m_two->write (buf, length_buf);
}
-static void
-mem_file_put (struct ui_file *file,
- ui_file_put_method_ftype *write,
- void *dest)
+void
+tee_file::write_async_safe (const char *buf, long length_buf)
{
- struct mem_file *stream = ui_file_data (file);
- if (stream->magic != &mem_file_magic)
- internal_error (__FILE__, __LINE__,
- _("mem_file_put: bad magic number"));
- if (stream->length_buffer > 0)
- write (dest, stream->buffer, stream->length_buffer);
+ m_one->write_async_safe (buf, length_buf);
+ m_two->write_async_safe (buf, length_buf);
}
void
-mem_file_write (struct ui_file *file,
- const char *buffer,
- long length_buffer)
-{
- struct mem_file *stream = ui_file_data (file);
- if (stream->magic != &mem_file_magic)
- internal_error (__FILE__, __LINE__,
- _("mem_file_write: bad magic number"));
- if (stream->buffer == NULL)
- {
- stream->length_buffer = length_buffer;
- stream->sizeof_buffer = length_buffer;
- stream->buffer = xmalloc (stream->sizeof_buffer);
- memcpy (stream->buffer, buffer, length_buffer);
- }
- else
- {
- int new_length = stream->length_buffer + length_buffer;
- if (new_length >= stream->sizeof_buffer)
- {
- stream->sizeof_buffer = new_length;
- stream->buffer = xrealloc (stream->buffer, stream->sizeof_buffer);
- }
- memcpy (stream->buffer + stream->length_buffer, buffer, length_buffer);
- stream->length_buffer = new_length;
- }
-}
-\f
-/* ``struct ui_file'' implementation that maps directly onto
- <stdio.h>'s FILE. */
-
-static ui_file_write_ftype stdio_file_write;
-static ui_file_fputs_ftype stdio_file_fputs;
-static ui_file_read_ftype stdio_file_read;
-static ui_file_isatty_ftype stdio_file_isatty;
-static ui_file_delete_ftype stdio_file_delete;
-static struct ui_file *stdio_file_new (FILE * file, int close_p);
-static ui_file_flush_ftype stdio_file_flush;
-
-static int stdio_file_magic;
-
-struct stdio_file
- {
- int *magic;
- FILE *file;
- int close_p;
- };
-
-static struct ui_file *
-stdio_file_new (FILE *file, int close_p)
-{
- struct ui_file *ui_file = ui_file_new ();
- struct stdio_file *stdio = xmalloc (sizeof (struct stdio_file));
- stdio->magic = &stdio_file_magic;
- stdio->file = file;
- stdio->close_p = close_p;
- set_ui_file_data (ui_file, stdio, stdio_file_delete);
- set_ui_file_flush (ui_file, stdio_file_flush);
- set_ui_file_write (ui_file, stdio_file_write);
- set_ui_file_fputs (ui_file, stdio_file_fputs);
- set_ui_file_read (ui_file, stdio_file_read);
- set_ui_file_isatty (ui_file, stdio_file_isatty);
- return ui_file;
-}
-
-static void
-stdio_file_delete (struct ui_file *file)
-{
- struct stdio_file *stdio = ui_file_data (file);
- if (stdio->magic != &stdio_file_magic)
- internal_error (__FILE__, __LINE__,
- _("stdio_file_delete: bad magic number"));
- if (stdio->close_p)
- {
- fclose (stdio->file);
- }
- xfree (stdio);
-}
-
-static void
-stdio_file_flush (struct ui_file *file)
+tee_file::puts (const char *linebuffer)
{
- struct stdio_file *stdio = ui_file_data (file);
- if (stdio->magic != &stdio_file_magic)
- internal_error (__FILE__, __LINE__,
- _("stdio_file_flush: bad magic number"));
- fflush (stdio->file);
+ m_one->puts (linebuffer);
+ m_two->puts (linebuffer);
}
-static long
-stdio_file_read (struct ui_file *file, char *buf, long length_buf)
+bool
+tee_file::isatty ()
{
- struct stdio_file *stdio = ui_file_data (file);
- if (stdio->magic != &stdio_file_magic)
- internal_error (__FILE__, __LINE__,
- _("stdio_file_read: bad magic number"));
- return read (fileno (stdio->file), buf, length_buf);
+ return m_one->isatty ();
}
-static void
-stdio_file_write (struct ui_file *file, const char *buf, long length_buf)
-{
- struct stdio_file *stdio = ui_file_data (file);
- if (stdio->magic != &stdio_file_magic)
- internal_error (__FILE__, __LINE__,
- _("stdio_file_write: bad magic number"));
- fwrite (buf, length_buf, 1, stdio->file);
-}
+/* See ui-file.h. */
-static void
-stdio_file_fputs (const char *linebuffer, struct ui_file *file)
+bool
+tee_file::term_out ()
{
- struct stdio_file *stdio = ui_file_data (file);
- if (stdio->magic != &stdio_file_magic)
- internal_error (__FILE__, __LINE__,
- _("stdio_file_fputs: bad magic number"));
- fputs (linebuffer, stdio->file);
+ return m_one->term_out ();
}
-static int
-stdio_file_isatty (struct ui_file *file)
+/* See ui-file.h. */
+
+bool
+tee_file::can_emit_style_escape ()
{
- struct stdio_file *stdio = ui_file_data (file);
- if (stdio->magic != &stdio_file_magic)
- internal_error (__FILE__, __LINE__,
- _("stdio_file_isatty: bad magic number"));
- return (isatty (fileno (stdio->file)));
+ return ((this == gdb_stdout || this == gdb_stderr)
+ && m_one->term_out ()
+ && term_cli_styling ());
}
-/* Like fdopen(). Create a ui_file from a previously opened FILE. */
+/* See ui-file.h. */
-struct ui_file *
-stdio_fileopen (FILE *file)
+void
+no_terminal_escape_file::write (const char *buf, long length_buf)
{
- return stdio_file_new (file, 0);
+ std::string copy (buf, length_buf);
+ this->puts (copy.c_str ());
}
-struct ui_file *
-gdb_fopen (char *name, char *mode)
-{
- FILE *f = fopen (name, mode);
- if (f == NULL)
- return NULL;
- return stdio_file_new (f, 1);
-}
+/* See ui-file.h. */
-/* ``struct ui_file'' implementation that maps onto two ui-file objects. */
+void
+no_terminal_escape_file::puts (const char *buf)
+{
+ while (*buf != '\0')
+ {
+ const char *esc = strchr (buf, '\033');
+ if (esc == nullptr)
+ break;
-static ui_file_write_ftype tee_file_write;
-static ui_file_fputs_ftype tee_file_fputs;
-static ui_file_isatty_ftype tee_file_isatty;
-static ui_file_delete_ftype tee_file_delete;
-static ui_file_flush_ftype tee_file_flush;
+ int n_read = 0;
+ if (!skip_ansi_escape (esc, &n_read))
+ ++esc;
-static int tee_file_magic;
+ this->stdio_file::write (buf, esc - buf);
+ buf = esc + n_read;
+ }
-struct tee_file
- {
- int *magic;
- struct ui_file *one, *two;
- int close_one, close_two;
- };
-
-struct ui_file *
-tee_file_new (struct ui_file *one, int close_one,
- struct ui_file *two, int close_two)
-{
- struct ui_file *ui_file = ui_file_new ();
- struct tee_file *tee = xmalloc (sizeof (struct tee_file));
- tee->magic = &tee_file_magic;
- tee->one = one;
- tee->two = two;
- tee->close_one = close_one;
- tee->close_two = close_two;
- set_ui_file_data (ui_file, tee, tee_file_delete);
- set_ui_file_flush (ui_file, tee_file_flush);
- set_ui_file_write (ui_file, tee_file_write);
- set_ui_file_fputs (ui_file, tee_file_fputs);
- set_ui_file_isatty (ui_file, tee_file_isatty);
- return ui_file;
-}
-
-static void
-tee_file_delete (struct ui_file *file)
-{
- struct tee_file *tee = ui_file_data (file);
- if (tee->magic != &tee_file_magic)
- internal_error (__FILE__, __LINE__,
- _("tee_file_delete: bad magic number"));
- if (tee->close_one)
- ui_file_delete (tee->one);
- if (tee->close_two)
- ui_file_delete (tee->two);
-
- xfree (tee);
-}
-
-static void
-tee_file_flush (struct ui_file *file)
-{
- struct tee_file *tee = ui_file_data (file);
- if (tee->magic != &tee_file_magic)
- internal_error (__FILE__, __LINE__,
- _("tee_file_flush: bad magic number"));
- tee->one->to_flush (tee->one);
- tee->two->to_flush (tee->two);
-}
-
-static void
-tee_file_write (struct ui_file *file, const char *buf, long length_buf)
-{
- struct tee_file *tee = ui_file_data (file);
- if (tee->magic != &tee_file_magic)
- internal_error (__FILE__, __LINE__,
- _("tee_file_write: bad magic number"));
- ui_file_write (tee->one, buf, length_buf);
- ui_file_write (tee->two, buf, length_buf);
-}
-
-static void
-tee_file_fputs (const char *linebuffer, struct ui_file *file)
-{
- struct tee_file *tee = ui_file_data (file);
- if (tee->magic != &tee_file_magic)
- internal_error (__FILE__, __LINE__,
- _("tee_file_fputs: bad magic number"));
- tee->one->to_fputs (linebuffer, tee->one);
- tee->two->to_fputs (linebuffer, tee->two);
-}
-
-static int
-tee_file_isatty (struct ui_file *file)
-{
- struct tee_file *tee = ui_file_data (file);
- if (tee->magic != &tee_file_magic)
- internal_error (__FILE__, __LINE__,
- _("tee_file_isatty: bad magic number"));
- return (0);
+ if (*buf != '\0')
+ this->stdio_file::write (buf, strlen (buf));
}
projects / deliverable / binutils-gdb.git / blobdiff