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