gdb/tui/tui-file.c

   1 /* UI_FILE - a generic STDIO like output stream.
   2    Copyright (C) 1999, 2000 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 2 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, write to the Free Software
  18    Foundation, Inc., 59 Temple Place - Suite 330,
  19    Boston, MA 02111-1307, USA.  */
  20
  21 #include "defs.h"
  22 #include "ui-file.h"
  23 #include "tui/tui-file.h"
  24
  25 #ifdef TUI
  26 #include "tui.h"
  27 #include "tuiData.h"
  28 #include "tuiIO.h"
  29 #include "tuiCommand.h"
  30 #endif
  31
  32 #include <string.h>
  33
  34 /* Called instead of fputs for all TUI_FILE output.  */
  35
  36 void (*fputs_unfiltered_hook) (const char *linebuffer,
  37                                struct ui_file * stream);
  38
  39 /* A ``struct ui_file'' that is compatible with all the legacy
  40    code. */
  41
  42 /* new */
  43 enum streamtype
  44 {
  45   afile,
  46   astring
  47 };
  48
  49 /* new */
  50 struct tui_stream
  51 {
  52   int *ts_magic;
  53   enum streamtype ts_streamtype;
  54   FILE *ts_filestream;
  55   char *ts_strbuf;
  56   int ts_buflen;
  57 };
  58
  59 static ui_file_flush_ftype tui_file_flush;
  60 extern ui_file_fputs_ftype tui_file_fputs;
  61 static ui_file_isatty_ftype tui_file_isatty;
  62 static ui_file_rewind_ftype tui_file_rewind;
  63 static ui_file_put_ftype tui_file_put;
  64 static ui_file_delete_ftype tui_file_delete;
  65 static struct ui_file *tui_file_new PARAMS ((void));
  66 static int tui_file_magic;
  67
  68 static struct ui_file *
  69 tui_file_new ()
  70 {
  71   struct tui_stream *tui = xmalloc (sizeof (struct tui_stream));
  72   struct ui_file *file = ui_file_new ();
  73   set_ui_file_data (file, tui, tui_file_delete);
  74   set_ui_file_flush (file, tui_file_flush);
  75   set_ui_file_fputs (file, tui_file_fputs);
  76   set_ui_file_isatty (file, tui_file_isatty);
  77   set_ui_file_rewind (file, tui_file_rewind);
  78   set_ui_file_put (file, tui_file_put);
  79   tui->ts_magic = &tui_file_magic;
  80   return file;
  81 }
  82
  83 static void
  84 tui_file_delete (file)
  85      struct ui_file *file;
  86 {
  87   struct tui_stream *tmpstream = ui_file_data (file);
  88   if (tmpstream->ts_magic != &tui_file_magic)
  89     internal_error ("tui_file_delete: bad magic number");
  90   if ((tmpstream->ts_streamtype == astring) &&
  91       (tmpstream->ts_strbuf != NULL))
  92     {
  93       free (tmpstream->ts_strbuf);
  94     }
  95   free (tmpstream);
  96 }
  97
  98 struct ui_file *
  99 tui_fileopen (stream)
 100      FILE *stream;
 101 {
 102   struct ui_file *file = tui_file_new ();
 103   struct tui_stream *tmpstream = ui_file_data (file);
 104   tmpstream->ts_streamtype = afile;
 105   tmpstream->ts_filestream = stream;
 106   tmpstream->ts_strbuf = NULL;
 107   tmpstream->ts_buflen = 0;
 108   return file;
 109 }
 110
 111 struct ui_file *
 112 tui_sfileopen (n)
 113      int n;
 114 {
 115   struct ui_file *file = tui_file_new ();
 116   struct tui_stream *tmpstream = ui_file_data (file);
 117   tmpstream->ts_streamtype = astring;
 118   tmpstream->ts_filestream = NULL;
 119   if (n > 0)
 120     {
 121       tmpstream->ts_strbuf = xmalloc ((n + 1) * sizeof (char));
 122       tmpstream->ts_strbuf[0] = '\0';
 123     }
 124   else
 125     /* Do not allocate the buffer now.  The first time something is printed
 126        one will be allocated by tui_file_adjust_strbuf()  */
 127     tmpstream->ts_strbuf = NULL;
 128   tmpstream->ts_buflen = n;
 129   return file;
 130 }
 131
 132 static int
 133 tui_file_isatty (file)
 134      struct ui_file *file;
 135 {
 136   struct tui_stream *stream = ui_file_data (file);
 137   if (stream->ts_magic != &tui_file_magic)
 138     internal_error ("tui_file_isatty: bad magic number");
 139   if (stream->ts_streamtype == afile)
 140     return (isatty (fileno (stream->ts_filestream)));
 141   else
 142     return 0;
 143 }
 144
 145 static void
 146 tui_file_rewind (file)
 147      struct ui_file *file;
 148 {
 149   struct tui_stream *stream = ui_file_data (file);
 150   if (stream->ts_magic != &tui_file_magic)
 151     internal_error ("tui_file_rewind: bad magic number");
 152   stream->ts_strbuf[0] = '\0';
 153 }
 154
 155 static void
 156 tui_file_put (struct ui_file *file,
 157               ui_file_put_method_ftype *write,
 158               void *dest)
 159 {
 160   struct tui_stream *stream = ui_file_data (file);
 161   if (stream->ts_magic != &tui_file_magic)
 162     internal_error ("tui_file_put: bad magic number");
 163   if (stream->ts_streamtype == astring)
 164     write (dest, stream->ts_strbuf, strlen (stream->ts_strbuf));
 165 }
 166
 167 /* All TUI I/O sent to the *_filtered and *_unfiltered functions
 168    eventually ends up here.  The fputs_unfiltered_hook is primarily
 169    used by GUIs to collect all output and send it to the GUI, instead
 170    of the controlling terminal.  Only output to gdb_stdout and
 171    gdb_stderr are sent to the hook.  Everything else is sent on to
 172    fputs to allow file I/O to be handled appropriately.  */
 173
 174 /* FIXME: Should be broken up and moved to a TUI specific file. */
 175
 176 void
 177 tui_file_fputs (linebuffer, file)
 178      const char *linebuffer;
 179      struct ui_file *file;
 180 {
 181   struct tui_stream *stream = ui_file_data (file);
 182 #if defined(TUI)
 183   extern int tui_owns_terminal;
 184 #endif
 185   /* NOTE: cagney/1999-10-13: The use of fputs_unfiltered_hook is
 186      seriously discouraged.  Those wanting to hook output should
 187      instead implement their own ui_file object and install that. See
 188      also tui_file_flush(). */
 189   if (fputs_unfiltered_hook
 190       && (file == gdb_stdout
 191           || file == gdb_stderr))
 192     fputs_unfiltered_hook (linebuffer, file);
 193   else
 194     {
 195 #if defined(TUI)
 196       if (tui_version && tui_owns_terminal)
 197         {
 198           /* If we get here somehow while updating the TUI (from
 199            * within a tuiDo(), then we need to temporarily
 200            * set up the terminal for GDB output. This probably just
 201            * happens on error output.
 202            */
 203
 204           if (stream->ts_streamtype == astring)
 205             {
 206               tui_file_adjust_strbuf (strlen (linebuffer), file);
 207               strcat (stream->ts_strbuf, linebuffer);
 208             }
 209           else
 210             {
 211               tuiTermUnsetup (0, (tui_version) ? cmdWin->detail.commandInfo.curch : 0);
 212               fputs (linebuffer, stream->ts_filestream);
 213               tuiTermSetup (0);
 214               if (linebuffer[strlen (linebuffer) - 1] == '\n')
 215                 tuiClearCommandCharCount ();
 216               else
 217                 tuiIncrCommandCharCountBy (strlen (linebuffer));
 218             }
 219         }
 220       else
 221         {
 222           /* The normal case - just do a fputs() */
 223           if (stream->ts_streamtype == astring)
 224             {
 225               tui_file_adjust_strbuf (strlen (linebuffer), file);
 226               strcat (stream->ts_strbuf, linebuffer);
 227             }
 228           else
 229             fputs (linebuffer, stream->ts_filestream);
 230         }
 231
 232
 233 #else
 234       if (stream->ts_streamtype == astring)
 235         {
 236           tui_file_adjust_strbuf (strlen (linebuffer), file);
 237           strcat (stream->ts_strbuf, linebuffer);
 238         }
 239       else
 240         fputs (linebuffer, stream->ts_filestream);
 241 #endif
 242     }
 243 }
 244
 245 char *
 246 tui_file_get_strbuf (struct ui_file *file)
 247 {
 248   struct tui_stream *stream = ui_file_data (file);
 249   if (stream->ts_magic != &tui_file_magic)
 250     internal_error ("tui_file_get_strbuf: bad magic number");
 251   return (stream->ts_strbuf);
 252 }
 253
 254 /* adjust the length of the buffer by the amount necessary
 255    to accomodate appending a string of length N to the buffer contents */
 256 void
 257 tui_file_adjust_strbuf (int n, struct ui_file *file)
 258 {
 259   struct tui_stream *stream = ui_file_data (file);
 260   int non_null_chars;
 261   if (stream->ts_magic != &tui_file_magic)
 262     internal_error ("tui_file_adjust_strbuf: bad magic number");
 263
 264   if (stream->ts_streamtype != astring)
 265     return;
 266
 267   if (stream->ts_strbuf)
 268     {
 269       /* There is already a buffer allocated */
 270       non_null_chars = strlen (stream->ts_strbuf);
 271
 272       if (n > (stream->ts_buflen - non_null_chars - 1))
 273         {
 274           stream->ts_buflen = n + non_null_chars + 1;
 275           stream->ts_strbuf = xrealloc (stream->ts_strbuf, stream->ts_buflen);
 276         }
 277     }
 278   else
 279     /* No buffer yet, so allocate one of the desired size */
 280     stream->ts_strbuf = xmalloc ((n + 1) * sizeof (char));
 281 }
 282
 283 static void
 284 tui_file_flush (file)
 285      struct ui_file *file;
 286 {
 287   struct tui_stream *stream = ui_file_data (file);
 288   if (stream->ts_magic != &tui_file_magic)
 289     internal_error ("tui_file_flush: bad magic number");
 290
 291   /* NOTE: cagney/1999-10-12: If we've been linked with code that uses
 292      fputs_unfiltered_hook then we assume that it doesn't need to know
 293      about flushes.  Code that does need to know about flushes can
 294      implement a proper ui_file object. */
 295   if (fputs_unfiltered_hook)
 296     return;
 297
 298   switch (stream->ts_streamtype)
 299     {
 300     case astring:
 301       break;
 302     case afile:
 303       fflush (stream->ts_filestream);
 304       break;
 305     }
 306 }