1 /* UI_FILE - a generic STDIO like output stream.
2 Copyright 1999, 2000, 2001 Free Software Foundation, Inc.
4 This file is part of GDB.
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.
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.
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. */
23 #include "tui/tui-file.h"
29 #include "tuiCommand.h"
34 /* Called instead of fputs for all TUI_FILE output. */
36 void (*fputs_unfiltered_hook
) (const char *linebuffer
,
37 struct ui_file
* stream
);
39 /* A ``struct ui_file'' that is compatible with all the legacy
53 enum streamtype ts_streamtype
;
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 (void);
66 static int tui_file_magic
;
68 static struct ui_file
*
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
;
84 tui_file_delete (struct ui_file
*file
)
86 struct tui_stream
*tmpstream
= ui_file_data (file
);
87 if (tmpstream
->ts_magic
!= &tui_file_magic
)
88 internal_error (__FILE__
, __LINE__
,
89 "tui_file_delete: bad magic number");
90 if ((tmpstream
->ts_streamtype
== astring
) &&
91 (tmpstream
->ts_strbuf
!= NULL
))
93 xfree (tmpstream
->ts_strbuf
);
99 tui_fileopen (FILE *stream
)
101 struct ui_file
*file
= tui_file_new ();
102 struct tui_stream
*tmpstream
= ui_file_data (file
);
103 tmpstream
->ts_streamtype
= afile
;
104 tmpstream
->ts_filestream
= stream
;
105 tmpstream
->ts_strbuf
= NULL
;
106 tmpstream
->ts_buflen
= 0;
111 tui_sfileopen (int n
)
113 struct ui_file
*file
= tui_file_new ();
114 struct tui_stream
*tmpstream
= ui_file_data (file
);
115 tmpstream
->ts_streamtype
= astring
;
116 tmpstream
->ts_filestream
= NULL
;
119 tmpstream
->ts_strbuf
= xmalloc ((n
+ 1) * sizeof (char));
120 tmpstream
->ts_strbuf
[0] = '\0';
123 /* Do not allocate the buffer now. The first time something is printed
124 one will be allocated by tui_file_adjust_strbuf() */
125 tmpstream
->ts_strbuf
= NULL
;
126 tmpstream
->ts_buflen
= n
;
131 tui_file_isatty (struct ui_file
*file
)
133 struct tui_stream
*stream
= ui_file_data (file
);
134 if (stream
->ts_magic
!= &tui_file_magic
)
135 internal_error (__FILE__
, __LINE__
,
136 "tui_file_isatty: bad magic number");
137 if (stream
->ts_streamtype
== afile
)
138 return (isatty (fileno (stream
->ts_filestream
)));
144 tui_file_rewind (struct ui_file
*file
)
146 struct tui_stream
*stream
= ui_file_data (file
);
147 if (stream
->ts_magic
!= &tui_file_magic
)
148 internal_error (__FILE__
, __LINE__
,
149 "tui_file_rewind: bad magic number");
150 stream
->ts_strbuf
[0] = '\0';
154 tui_file_put (struct ui_file
*file
,
155 ui_file_put_method_ftype
*write
,
158 struct tui_stream
*stream
= ui_file_data (file
);
159 if (stream
->ts_magic
!= &tui_file_magic
)
160 internal_error (__FILE__
, __LINE__
,
161 "tui_file_put: bad magic number");
162 if (stream
->ts_streamtype
== astring
)
163 write (dest
, stream
->ts_strbuf
, strlen (stream
->ts_strbuf
));
166 /* All TUI I/O sent to the *_filtered and *_unfiltered functions
167 eventually ends up here. The fputs_unfiltered_hook is primarily
168 used by GUIs to collect all output and send it to the GUI, instead
169 of the controlling terminal. Only output to gdb_stdout and
170 gdb_stderr are sent to the hook. Everything else is sent on to
171 fputs to allow file I/O to be handled appropriately. */
173 /* FIXME: Should be broken up and moved to a TUI specific file. */
176 tui_file_fputs (const char *linebuffer
, struct ui_file
*file
)
178 struct tui_stream
*stream
= ui_file_data (file
);
180 extern int tui_owns_terminal
;
182 /* NOTE: cagney/1999-10-13: The use of fputs_unfiltered_hook is
183 seriously discouraged. Those wanting to hook output should
184 instead implement their own ui_file object and install that. See
185 also tui_file_flush(). */
186 if (fputs_unfiltered_hook
187 && (file
== gdb_stdout
188 || file
== gdb_stderr
))
189 fputs_unfiltered_hook (linebuffer
, file
);
193 if (tui_version
&& tui_owns_terminal
)
195 /* If we get here somehow while updating the TUI (from
196 * within a tuiDo(), then we need to temporarily
197 * set up the terminal for GDB output. This probably just
198 * happens on error output.
201 if (stream
->ts_streamtype
== astring
)
203 tui_file_adjust_strbuf (strlen (linebuffer
), file
);
204 strcat (stream
->ts_strbuf
, linebuffer
);
208 tuiTermUnsetup (0, (tui_version
) ? cmdWin
->detail
.commandInfo
.curch
: 0);
209 fputs (linebuffer
, stream
->ts_filestream
);
211 if (linebuffer
[strlen (linebuffer
) - 1] == '\n')
212 tuiClearCommandCharCount ();
214 tuiIncrCommandCharCountBy (strlen (linebuffer
));
219 /* The normal case - just do a fputs() */
220 if (stream
->ts_streamtype
== astring
)
222 tui_file_adjust_strbuf (strlen (linebuffer
), file
);
223 strcat (stream
->ts_strbuf
, linebuffer
);
226 fputs (linebuffer
, stream
->ts_filestream
);
231 if (stream
->ts_streamtype
== astring
)
233 tui_file_adjust_strbuf (strlen (linebuffer
), file
);
234 strcat (stream
->ts_strbuf
, linebuffer
);
237 fputs (linebuffer
, stream
->ts_filestream
);
243 tui_file_get_strbuf (struct ui_file
*file
)
245 struct tui_stream
*stream
= ui_file_data (file
);
246 if (stream
->ts_magic
!= &tui_file_magic
)
247 internal_error (__FILE__
, __LINE__
,
248 "tui_file_get_strbuf: bad magic number");
249 return (stream
->ts_strbuf
);
252 /* adjust the length of the buffer by the amount necessary
253 to accomodate appending a string of length N to the buffer contents */
255 tui_file_adjust_strbuf (int n
, struct ui_file
*file
)
257 struct tui_stream
*stream
= ui_file_data (file
);
259 if (stream
->ts_magic
!= &tui_file_magic
)
260 internal_error (__FILE__
, __LINE__
,
261 "tui_file_adjust_strbuf: bad magic number");
263 if (stream
->ts_streamtype
!= astring
)
266 if (stream
->ts_strbuf
)
268 /* There is already a buffer allocated */
269 non_null_chars
= strlen (stream
->ts_strbuf
);
271 if (n
> (stream
->ts_buflen
- non_null_chars
- 1))
273 stream
->ts_buflen
= n
+ non_null_chars
+ 1;
274 stream
->ts_strbuf
= xrealloc (stream
->ts_strbuf
, stream
->ts_buflen
);
278 /* No buffer yet, so allocate one of the desired size */
279 stream
->ts_strbuf
= xmalloc ((n
+ 1) * sizeof (char));
283 tui_file_flush (struct ui_file
*file
)
285 struct tui_stream
*stream
= ui_file_data (file
);
286 if (stream
->ts_magic
!= &tui_file_magic
)
287 internal_error (__FILE__
, __LINE__
,
288 "tui_file_flush: bad magic number");
290 /* NOTE: cagney/1999-10-12: If we've been linked with code that uses
291 fputs_unfiltered_hook then we assume that it doesn't need to know
292 about flushes. Code that does need to know about flushes can
293 implement a proper ui_file object. */
294 if (fputs_unfiltered_hook
)
297 switch (stream
->ts_streamtype
)
302 fflush (stream
->ts_filestream
);