gdb/tui/tui-file.c

   1 /* UI_FILE - a generic STDIO like output stream.
   2    Copyright (C) 1999-2014 Free Software Foundation, Inc.
   3
   4    This file is part of GDB.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #include "defs.h"
  20 #include "ui-file.h"
  21 #include "tui/tui-file.h"
  22 #include "tui/tui-io.h"
  23
  24 #include "tui.h"
  25
  26 #include <string.h>
  27
  28 /* A ``struct ui_file'' that is compatible with all the legacy
  29    code.  */
  30
  31 /* new */
  32 enum streamtype
  33 {
  34   afile,
  35   astring
  36 };
  37
  38 /* new */
  39 struct tui_stream
  40 {
  41   int *ts_magic;
  42   enum streamtype ts_streamtype;
  43   FILE *ts_filestream;
  44   char *ts_strbuf;
  45   int ts_buflen;
  46 };
  47
  48 static ui_file_flush_ftype tui_file_flush;
  49 extern ui_file_fputs_ftype tui_file_fputs;
  50 static ui_file_isatty_ftype tui_file_isatty;
  51 static ui_file_rewind_ftype tui_file_rewind;
  52 static ui_file_put_ftype tui_file_put;
  53 static ui_file_delete_ftype tui_file_delete;
  54 static struct ui_file *tui_file_new (void);
  55 static int tui_file_magic;
  56
  57 static struct ui_file *
  58 tui_file_new (void)
  59 {
  60   struct tui_stream *tui = XMALLOC (struct tui_stream);
  61   struct ui_file *file = ui_file_new ();
  62
  63   set_ui_file_data (file, tui, tui_file_delete);
  64   set_ui_file_flush (file, tui_file_flush);
  65   set_ui_file_fputs (file, tui_file_fputs);
  66   set_ui_file_isatty (file, tui_file_isatty);
  67   set_ui_file_rewind (file, tui_file_rewind);
  68   set_ui_file_put (file, tui_file_put);
  69   tui->ts_magic = &tui_file_magic;
  70   return file;
  71 }
  72
  73 static void
  74 tui_file_delete (struct ui_file *file)
  75 {
  76   struct tui_stream *tmpstream = ui_file_data (file);
  77
  78   if (tmpstream->ts_magic != &tui_file_magic)
  79     internal_error (__FILE__, __LINE__,
  80                     _("tui_file_delete: bad magic number"));
  81   if ((tmpstream->ts_streamtype == astring)
  82       && (tmpstream->ts_strbuf != NULL))
  83     {
  84       xfree (tmpstream->ts_strbuf);
  85     }
  86   xfree (tmpstream);
  87 }
  88
  89 struct ui_file *
  90 tui_fileopen (FILE *stream)
  91 {
  92   struct ui_file *file = tui_file_new ();
  93   struct tui_stream *tmpstream = ui_file_data (file);
  94
  95   tmpstream->ts_streamtype = afile;
  96   tmpstream->ts_filestream = stream;
  97   tmpstream->ts_strbuf = NULL;
  98   tmpstream->ts_buflen = 0;
  99   return file;
 100 }
 101
 102 struct ui_file *
 103 tui_sfileopen (int n)
 104 {
 105   struct ui_file *file = tui_file_new ();
 106   struct tui_stream *tmpstream = ui_file_data (file);
 107
 108   tmpstream->ts_streamtype = astring;
 109   tmpstream->ts_filestream = NULL;
 110   if (n > 0)
 111     {
 112       tmpstream->ts_strbuf = xmalloc ((n + 1) * sizeof (char));
 113       tmpstream->ts_strbuf[0] = '\0';
 114     }
 115   else
 116     /* Do not allocate the buffer now.  The first time something is
 117        printed one will be allocated by tui_file_adjust_strbuf().  */
 118     tmpstream->ts_strbuf = NULL;
 119   tmpstream->ts_buflen = n;
 120   return file;
 121 }
 122
 123 static int
 124 tui_file_isatty (struct ui_file *file)
 125 {
 126   struct tui_stream *stream = ui_file_data (file);
 127
 128   if (stream->ts_magic != &tui_file_magic)
 129     internal_error (__FILE__, __LINE__,
 130                     _("tui_file_isatty: bad magic number"));
 131   if (stream->ts_streamtype == afile)
 132     return (isatty (fileno (stream->ts_filestream)));
 133   else
 134     return 0;
 135 }
 136
 137 static void
 138 tui_file_rewind (struct ui_file *file)
 139 {
 140   struct tui_stream *stream = ui_file_data (file);
 141
 142   if (stream->ts_magic != &tui_file_magic)
 143     internal_error (__FILE__, __LINE__,
 144                     _("tui_file_rewind: bad magic number"));
 145   stream->ts_strbuf[0] = '\0';
 146 }
 147
 148 static void
 149 tui_file_put (struct ui_file *file,
 150               ui_file_put_method_ftype *write,
 151               void *dest)
 152 {
 153   struct tui_stream *stream = ui_file_data (file);
 154
 155   if (stream->ts_magic != &tui_file_magic)
 156     internal_error (__FILE__, __LINE__,
 157                     _("tui_file_put: bad magic number"));
 158   if (stream->ts_streamtype == astring)
 159     write (dest, stream->ts_strbuf, strlen (stream->ts_strbuf));
 160 }
 161
 162 /* All TUI I/O sent to the *_filtered and *_unfiltered functions
 163    eventually ends up here.  The fputs_unfiltered_hook is primarily
 164    used by GUIs to collect all output and send it to the GUI, instead
 165    of the controlling terminal.  Only output to gdb_stdout and
 166    gdb_stderr are sent to the hook.  Everything else is sent on to
 167    fputs to allow file I/O to be handled appropriately.  */
 168
 169 /* FIXME: Should be broken up and moved to a TUI specific file.  */
 170
 171 void
 172 tui_file_fputs (const char *linebuffer, struct ui_file *file)
 173 {
 174   struct tui_stream *stream = ui_file_data (file);
 175
 176   if (stream->ts_streamtype == astring)
 177     {
 178       tui_file_adjust_strbuf (strlen (linebuffer), file);
 179       strcat (stream->ts_strbuf, linebuffer);
 180     }
 181   else
 182     {
 183       tui_puts (linebuffer);
 184     }
 185 }
 186
 187 char *
 188 tui_file_get_strbuf (struct ui_file *file)
 189 {
 190   struct tui_stream *stream = ui_file_data (file);
 191
 192   if (stream->ts_magic != &tui_file_magic)
 193     internal_error (__FILE__, __LINE__,
 194                     _("tui_file_get_strbuf: bad magic number"));
 195   return (stream->ts_strbuf);
 196 }
 197
 198 /* Adjust the length of the buffer by the amount necessary to
 199    accomodate appending a string of length N to the buffer
 200    contents.  */
 201 void
 202 tui_file_adjust_strbuf (int n, struct ui_file *file)
 203 {
 204   struct tui_stream *stream = ui_file_data (file);
 205   int non_null_chars;
 206
 207   if (stream->ts_magic != &tui_file_magic)
 208     internal_error (__FILE__, __LINE__,
 209                     _("tui_file_adjust_strbuf: bad magic number"));
 210
 211   if (stream->ts_streamtype != astring)
 212     return;
 213
 214   if (stream->ts_strbuf)
 215     {
 216       /* There is already a buffer allocated.  */
 217       non_null_chars = strlen (stream->ts_strbuf);
 218
 219       if (n > (stream->ts_buflen - non_null_chars - 1))
 220         {
 221           stream->ts_buflen = n + non_null_chars + 1;
 222           stream->ts_strbuf = xrealloc (stream->ts_strbuf, stream->ts_buflen);
 223         }
 224     }
 225   else
 226     /* No buffer yet, so allocate one of the desired size.  */
 227     stream->ts_strbuf = xmalloc ((n + 1) * sizeof (char));
 228 }
 229
 230 static void
 231 tui_file_flush (struct ui_file *file)
 232 {
 233   struct tui_stream *stream = ui_file_data (file);
 234
 235   if (stream->ts_magic != &tui_file_magic)
 236     internal_error (__FILE__, __LINE__,
 237                     _("tui_file_flush: bad magic number"));
 238
 239   switch (stream->ts_streamtype)
 240     {
 241     case astring:
 242       break;
 243     case afile:
 244       fflush (stream->ts_filestream);
 245       break;
 246     }
 247 }