]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blobdiff - gdb/ui-file.c
Update years in copyright notice for the GDB files.
[thirdparty/binutils-gdb.git] / gdb / ui-file.c
index b9ddbb5c5a795d1672632e5cec28b5d77599d936..bb904c9ad499a869a31df61921aff029ebda373e 100644 (file)
@@ -1,7 +1,6 @@
 /* UI_FILE - a generic STDIO like output stream.
 
-   Copyright (C) 1999, 2000, 2001, 2002, 2007, 2008, 2009
-   Free Software Foundation, Inc.
+   Copyright (C) 1999-2013 Free Software Foundation, Inc.
 
    This file is part of GDB.
 
    You should have received a copy of the GNU General Public License
    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_obstack.h"
 #include "gdb_string.h"
 #include "gdb_select.h"
 
 
 static ui_file_isatty_ftype null_file_isatty;
 static ui_file_write_ftype null_file_write;
+static ui_file_write_ftype null_file_write_async_safe;
 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;
+static ui_file_fseek_ftype null_file_fseek;
 
 struct ui_file
   {
     int *magic;
     ui_file_flush_ftype *to_flush;
     ui_file_write_ftype *to_write;
+    ui_file_write_async_safe_ftype *to_write_async_safe;
     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;
+    ui_file_fseek_ftype *to_fseek;
     void *to_data;
   };
 int ui_file_magic;
@@ -55,15 +59,18 @@ 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_write_async_safe (file, null_file_write_async_safe);
   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);
+  set_ui_file_fseek (file, null_file_fseek);
   return file;
 }
 
@@ -106,8 +113,8 @@ null_file_write (struct ui_file *file,
                 long sizeof_buf)
 {
   if (file->to_fputs == null_file_fputs)
-    /* Both the write and fputs methods are null. Discard the
-       request. */
+    /* Both the write and fputs methods are null.  Discard the
+       request.  */
     return;
   else
     {
@@ -118,6 +125,7 @@ null_file_write (struct ui_file *file,
          is possible to clean up that code.  */
       int i;
       char b[2];
+
       b[1] = '\0';
       for (i = 0; i < sizeof_buf; i++)
        {
@@ -141,22 +149,38 @@ static void
 null_file_fputs (const char *buf, struct ui_file *file)
 {
   if (file->to_write == null_file_write)
-    /* Both the write and fputs methods are null. Discard the
-       request. */
+    /* Both the write and fputs methods are null.  Discard the
+       request.  */
     return;
   else
     {
-      /* The write method was implemented, use that. */
+      /* The write method was implemented, use that.  */
       file->to_write (file, buf, strlen (buf));
     }
 }
 
+static void
+null_file_write_async_safe (struct ui_file *file,
+                           const char *buf,
+                           long sizeof_buf)
+{
+  return;
+}
+
 static void
 null_file_delete (struct ui_file *file)
 {
   return;
 }
 
+static int
+null_file_fseek (struct ui_file *stream, long offset, int whence)
+{
+  errno = EBADF;
+
+  return -1;
+}
+
 void *
 ui_file_data (struct ui_file *file)
 {
@@ -200,12 +224,26 @@ ui_file_write (struct ui_file *file,
   file->to_write (file, buf, length_buf);
 }
 
+void
+ui_file_write_async_safe (struct ui_file *file,
+                         const char *buf,
+                         long length_buf)
+{
+  file->to_write_async_safe (file, buf, length_buf);
+}
+
 long
 ui_file_read (struct ui_file *file, char *buf, long length_buf)
 {
   return file->to_read (file, buf, length_buf); 
 }
 
+int
+ui_file_fseek (struct ui_file *file, long offset, int whence)
+{
+  return file->to_fseek (file, offset, whence);
+}
+
 void
 fputs_unfiltered (const char *buf, struct ui_file *file)
 {
@@ -213,58 +251,71 @@ fputs_unfiltered (const char *buf, struct ui_file *file)
 }
 
 void
-set_ui_file_flush (struct ui_file *file, ui_file_flush_ftype *flush)
+set_ui_file_flush (struct ui_file *file, ui_file_flush_ftype *flush_ptr)
 {
-  file->to_flush = flush;
+  file->to_flush = flush_ptr;
 }
 
 void
-set_ui_file_isatty (struct ui_file *file, ui_file_isatty_ftype *isatty)
+set_ui_file_isatty (struct ui_file *file, ui_file_isatty_ftype *isatty_ptr)
 {
-  file->to_isatty = isatty;
+  file->to_isatty = isatty_ptr;
 }
 
 void
-set_ui_file_rewind (struct ui_file *file, ui_file_rewind_ftype *rewind)
+set_ui_file_rewind (struct ui_file *file, ui_file_rewind_ftype *rewind_ptr)
 {
-  file->to_rewind = rewind;
+  file->to_rewind = rewind_ptr;
 }
 
 void
-set_ui_file_put (struct ui_file *file, ui_file_put_ftype *put)
+set_ui_file_put (struct ui_file *file, ui_file_put_ftype *put_ptr)
 {
-  file->to_put = put;
+  file->to_put = put_ptr;
 }
 
 void
 set_ui_file_write (struct ui_file *file,
-                   ui_file_write_ftype *write)
+                   ui_file_write_ftype *write_ptr)
+{
+  file->to_write = write_ptr;
+}
+
+void
+set_ui_file_write_async_safe (struct ui_file *file,
+                             ui_file_write_async_safe_ftype *write_async_safe_ptr)
 {
-  file->to_write = write;
+  file->to_write_async_safe = write_async_safe_ptr;
 }
 
 void
-set_ui_file_read (struct ui_file *file, ui_file_read_ftype *read)
+set_ui_file_read (struct ui_file *file, ui_file_read_ftype *read_ptr)
 {
-  file->to_read = read;
+  file->to_read = read_ptr;
 }
 
 void
-set_ui_file_fputs (struct ui_file *file, ui_file_fputs_ftype *fputs)
+set_ui_file_fputs (struct ui_file *file, ui_file_fputs_ftype *fputs_ptr)
 {
-  file->to_fputs = fputs;
+  file->to_fputs = fputs_ptr;
+}
+
+void
+set_ui_file_fseek (struct ui_file *file, ui_file_fseek_ftype *fseek_ptr)
+{
+  file->to_fseek = fseek_ptr;
 }
 
 void
 set_ui_file_data (struct ui_file *file, void *data,
-                 ui_file_delete_ftype *delete)
+                 ui_file_delete_ftype *delete_ptr)
 {
   file->to_data = data;
-  file->to_delete = delete;
+  file->to_delete = delete_ptr;
 }
 
 /* ui_file utility function for converting a ``struct ui_file'' into
-   a memory buffer''. */
+   a memory buffer */
 
 struct accumulated_ui_file
 {
@@ -276,6 +327,7 @@ static void
 do_ui_file_xstrdup (void *context, const char *buffer, long length)
 {
   struct accumulated_ui_file *acc = context;
+
   if (acc->buffer == NULL)
     acc->buffer = xmalloc (length + 1);
   else
@@ -289,6 +341,7 @@ char *
 ui_file_xstrdup (struct ui_file *file, long *length)
 {
   struct accumulated_ui_file acc;
+
   acc.buffer = NULL;
   acc.length = 0;
   ui_file_put (file, do_ui_file_xstrdup, &acc);
@@ -298,10 +351,28 @@ ui_file_xstrdup (struct ui_file *file, long *length)
     *length = acc.length;
   return acc.buffer;
 }
+
+static void
+do_ui_file_obsavestring (void *context, const char *buffer, long length)
+{
+  struct obstack *obstack = (struct obstack *) context;
+
+  obstack_grow (obstack, buffer, length);
+}
+
+char *
+ui_file_obsavestring (struct ui_file *file, struct obstack *obstack,
+                     long *length)
+{
+  ui_file_put (file, do_ui_file_obsavestring, obstack);
+  *length = obstack_object_size (obstack);
+  obstack_1grow (obstack, '\0');
+  return obstack_finish (obstack);
+}
 \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(). */
+   buffer.  The buffers accumulated contents are available via
+   ui_file_put().  */
 
 struct mem_file
   {
@@ -323,6 +394,7 @@ 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);
@@ -338,6 +410,7 @@ static void
 mem_file_delete (struct ui_file *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"));
@@ -356,6 +429,7 @@ static void
 mem_file_rewind (struct ui_file *file)
 {
   struct mem_file *stream = ui_file_data (file);
+
   if (stream->magic != &mem_file_magic)
     internal_error (__FILE__, __LINE__,
                    _("mem_file_rewind: bad magic number"));
@@ -368,6 +442,7 @@ mem_file_put (struct ui_file *file,
              void *dest)
 {
   struct mem_file *stream = ui_file_data (file);
+
   if (stream->magic != &mem_file_magic)
     internal_error (__FILE__, __LINE__,
                    _("mem_file_put: bad magic number"));
@@ -381,6 +456,7 @@ mem_file_write (struct ui_file *file,
                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"));
@@ -394,6 +470,7 @@ mem_file_write (struct ui_file *file,
   else
     {
       int new_length = stream->length_buffer + length_buffer;
+
       if (new_length >= stream->sizeof_buffer)
        {
          stream->sizeof_buffer = new_length;
@@ -405,15 +482,17 @@ mem_file_write (struct ui_file *file,
 }
 \f
 /* ``struct ui_file'' implementation that maps directly onto
-   <stdio.h>'s FILE. */
+   <stdio.h>'s FILE.  */
 
 static ui_file_write_ftype stdio_file_write;
+static ui_file_write_async_safe_ftype stdio_file_write_async_safe;
 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 struct ui_file *stdio_file_new (FILE *file, int close_p);
 static ui_file_flush_ftype stdio_file_flush;
+static ui_file_fseek_ftype stdio_file_fseek;
 
 static int stdio_file_magic;
 
@@ -421,6 +500,9 @@ struct stdio_file
   {
     int *magic;
     FILE *file;
+    /* The associated file descriptor is extracted ahead of time for
+       stdio_file_write_async_safe's benefit, in case fileno isn't async-safe.  */
+    int fd;
     int close_p;
   };
 
@@ -429,15 +511,19 @@ 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->fd = fileno (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_write_async_safe (ui_file, stdio_file_write_async_safe);
   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);
+  set_ui_file_fseek (ui_file, stdio_file_fseek);
   return ui_file;
 }
 
@@ -445,6 +531,7 @@ 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"));
@@ -459,6 +546,7 @@ static void
 stdio_file_flush (struct ui_file *file)
 {
   struct stdio_file *stdio = ui_file_data (file);
+
   if (stdio->magic != &stdio_file_magic)
     internal_error (__FILE__, __LINE__,
                    _("stdio_file_flush: bad magic number"));
@@ -469,6 +557,7 @@ static long
 stdio_file_read (struct ui_file *file, 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_read: bad magic number"));
@@ -477,52 +566,94 @@ stdio_file_read (struct ui_file *file, char *buf, long length_buf)
      the file.  Wait until at least one byte of data is available.
      Control-C can interrupt gdb_select, but not read.  */
   {
-    int fd = fileno (stdio->file);
     fd_set readfds;
     FD_ZERO (&readfds);
-    FD_SET (fd, &readfds);
-    if (gdb_select (fd + 1, &readfds, NULL, NULL, NULL) == -1)
+    FD_SET (stdio->fd, &readfds);
+    if (gdb_select (stdio->fd + 1, &readfds, NULL, NULL, NULL) == -1)
       return -1;
   }
 
-  return read (fileno (stdio->file), buf, length_buf);
+  return read (stdio->fd, buf, length_buf);
 }
 
 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"));
   /* Calling error crashes when we are called from the exception framework.  */
   if (fwrite (buf, length_buf, 1, stdio->file))
-    ;
+    {
+      /* Nothing.  */
+    }
+}
+
+static void
+stdio_file_write_async_safe (struct ui_file *file,
+                            const char *buf, long length_buf)
+{
+  struct stdio_file *stdio = ui_file_data (file);
+
+  if (stdio->magic != &stdio_file_magic)
+    {
+      /* gettext isn't necessarily async safe, so we can't use _("error message") here.
+        We could extract the correct translation ahead of time, but this is an extremely
+        rare event, and one of the other stdio_file_* routines will presumably catch
+        the problem anyway.  For now keep it simple and ignore the error here.  */
+      return;
+    }
+
+  /* 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 (stdio->fd, buf, length_buf))
+    {
+      /* Nothing.  */
+    }
 }
 
 static void
 stdio_file_fputs (const char *linebuffer, struct ui_file *file)
 {
   struct stdio_file *stdio = ui_file_data (file);
+
   if (stdio->magic != &stdio_file_magic)
     internal_error (__FILE__, __LINE__,
                    _("stdio_file_fputs: bad magic number"));
   /* Calling error crashes when we are called from the exception framework.  */
   if (fputs (linebuffer, stdio->file))
-    ;
+    {
+      /* Nothing.  */
+    }
 }
 
 static int
 stdio_file_isatty (struct ui_file *file)
 {
   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 (isatty (stdio->fd));
 }
 
-/* Like fdopen().  Create a ui_file from a previously opened FILE. */
+static int
+stdio_file_fseek (struct ui_file *file, long offset, int whence)
+{
+  struct stdio_file *stdio = ui_file_data (file);
+
+  if (stdio->magic != &stdio_file_magic)
+    internal_error (__FILE__, __LINE__,
+                   _("stdio_file_fseek: bad magic number"));
+
+  return fseek (stdio->file, offset, whence);
+}
+
+/* Like fdopen().  Create a ui_file from a previously opened FILE.  */
 
 struct ui_file *
 stdio_fileopen (FILE *file)
@@ -534,6 +665,7 @@ 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);
@@ -562,6 +694,7 @@ tee_file_new (struct ui_file *one, int close_one,
 {
   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;
@@ -579,6 +712,7 @@ 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"));
@@ -594,6 +728,7 @@ 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"));
@@ -605,6 +740,7 @@ 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"));
@@ -616,6 +752,7 @@ 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"));
@@ -627,8 +764,10 @@ 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);
+
+  return ui_file_isatty (tee->one);
 }