Commit | Line | Data |
---|---|---|
d9fcf2fb | 1 | /* UI_FILE - a generic STDIO like output stream. |
349c5d5f | 2 | |
61baf725 | 3 | Copyright (C) 1999-2017 Free Software Foundation, Inc. |
d9fcf2fb JM |
4 | |
5 | This file is part of GDB. | |
6 | ||
7 | This program is free software; you can redistribute it and/or modify | |
8 | it under the terms of the GNU General Public License as published by | |
a9762ec7 | 9 | the Free Software Foundation; either version 3 of the License, or |
d9fcf2fb JM |
10 | (at your option) any later version. |
11 | ||
12 | This program is distributed in the hope that it will be useful, | |
13 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | GNU General Public License for more details. | |
16 | ||
17 | You should have received a copy of the GNU General Public License | |
a9762ec7 | 18 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
d9fcf2fb | 19 | |
581e13c1 | 20 | /* Implement the ``struct ui_file'' object. */ |
d9fcf2fb JM |
21 | |
22 | #include "defs.h" | |
23 | #include "ui-file.h" | |
94af9270 | 24 | #include "gdb_obstack.h" |
ad960ed2 | 25 | #include "gdb_select.h" |
614c279d | 26 | #include "filestuff.h" |
d9fcf2fb | 27 | |
d7e74731 | 28 | null_file null_stream; |
d9fcf2fb | 29 | |
d7e74731 PA |
30 | ui_file::ui_file () |
31 | {} | |
d9fcf2fb | 32 | |
d7e74731 PA |
33 | ui_file::~ui_file () |
34 | {} | |
d9fcf2fb | 35 | |
d7e74731 PA |
36 | void |
37 | ui_file::printf (const char *format, ...) | |
d9fcf2fb | 38 | { |
d7e74731 | 39 | va_list args; |
d9fcf2fb | 40 | |
d7e74731 PA |
41 | va_start (args, format); |
42 | vfprintf_unfiltered (this, format, args); | |
43 | va_end (args); | |
d9fcf2fb JM |
44 | } |
45 | ||
d7e74731 PA |
46 | void |
47 | ui_file::putstr (const char *str, int quoter) | |
d9fcf2fb | 48 | { |
d7e74731 | 49 | fputstr_unfiltered (str, quoter, this); |
d9fcf2fb JM |
50 | } |
51 | ||
d7e74731 PA |
52 | void |
53 | ui_file::putstrn (const char *str, int n, int quoter) | |
d9fcf2fb | 54 | { |
d7e74731 | 55 | fputstrn_unfiltered (str, n, quoter, this); |
d9fcf2fb JM |
56 | } |
57 | ||
d7e74731 PA |
58 | int |
59 | ui_file::putc (int c) | |
449092f6 | 60 | { |
d7e74731 | 61 | return fputc_unfiltered (c, this); |
449092f6 CV |
62 | } |
63 | ||
d7e74731 PA |
64 | void |
65 | ui_file::vprintf (const char *format, va_list args) | |
d9fcf2fb | 66 | { |
d7e74731 | 67 | vfprintf_unfiltered (this, format, args); |
d9fcf2fb JM |
68 | } |
69 | ||
d7e74731 | 70 | \f |
01124a23 | 71 | |
d7e74731 PA |
72 | void |
73 | null_file::write (const char *buf, long sizeof_buf) | |
d9fcf2fb | 74 | { |
d7e74731 | 75 | /* Discard the request. */ |
d9fcf2fb JM |
76 | } |
77 | ||
d7e74731 PA |
78 | void |
79 | null_file::puts (const char *) | |
2a9d5ccf | 80 | { |
d7e74731 | 81 | /* Discard the request. */ |
2a9d5ccf HZ |
82 | } |
83 | ||
d7e74731 PA |
84 | void |
85 | null_file::write_async_safe (const char *buf, long sizeof_buf) | |
d9fcf2fb | 86 | { |
d7e74731 | 87 | /* Discard the request. */ |
d9fcf2fb JM |
88 | } |
89 | ||
d7e74731 PA |
90 | \f |
91 | ||
d9fcf2fb | 92 | void |
fba45db2 | 93 | gdb_flush (struct ui_file *file) |
d9fcf2fb | 94 | { |
d7e74731 | 95 | file->flush (); |
d9fcf2fb JM |
96 | } |
97 | ||
98 | int | |
fba45db2 | 99 | ui_file_isatty (struct ui_file *file) |
d9fcf2fb | 100 | { |
d7e74731 | 101 | return file->isatty (); |
d9fcf2fb JM |
102 | } |
103 | ||
104 | void | |
105 | ui_file_write (struct ui_file *file, | |
106 | const char *buf, | |
107 | long length_buf) | |
108 | { | |
d7e74731 | 109 | file->write (buf, length_buf); |
de571fc5 TT |
110 | } |
111 | ||
01124a23 DE |
112 | void |
113 | ui_file_write_async_safe (struct ui_file *file, | |
114 | const char *buf, | |
115 | long length_buf) | |
116 | { | |
d7e74731 | 117 | file->write_async_safe (buf, length_buf); |
01124a23 DE |
118 | } |
119 | ||
449092f6 CV |
120 | long |
121 | ui_file_read (struct ui_file *file, char *buf, long length_buf) | |
122 | { | |
d7e74731 | 123 | return file->read (buf, length_buf); |
2a9d5ccf HZ |
124 | } |
125 | ||
d9fcf2fb | 126 | void |
fba45db2 | 127 | fputs_unfiltered (const char *buf, struct ui_file *file) |
d9fcf2fb | 128 | { |
d7e74731 | 129 | file->puts (buf); |
d9fcf2fb JM |
130 | } |
131 | ||
d7e74731 | 132 | \f |
d9fcf2fb | 133 | |
d7e74731 PA |
134 | string_file::~string_file () |
135 | {} | |
d9fcf2fb JM |
136 | |
137 | void | |
d7e74731 | 138 | string_file::write (const char *buf, long length_buf) |
d9fcf2fb | 139 | { |
d7e74731 | 140 | m_string.append (buf, length_buf); |
d9fcf2fb JM |
141 | } |
142 | ||
d7e74731 | 143 | \f |
01124a23 | 144 | |
d7e74731 | 145 | stdio_file::stdio_file (FILE *file, bool close_p) |
449092f6 | 146 | { |
d7e74731 PA |
147 | set_stream (file); |
148 | m_close_p = close_p; | |
449092f6 CV |
149 | } |
150 | ||
d7e74731 PA |
151 | stdio_file::stdio_file () |
152 | : m_file (NULL), | |
153 | m_fd (-1), | |
154 | m_close_p (false) | |
155 | {} | |
d9fcf2fb | 156 | |
d7e74731 | 157 | stdio_file::~stdio_file () |
2a9d5ccf | 158 | { |
d7e74731 PA |
159 | if (m_close_p) |
160 | fclose (m_file); | |
2a9d5ccf HZ |
161 | } |
162 | ||
d9fcf2fb | 163 | void |
d7e74731 | 164 | stdio_file::set_stream (FILE *file) |
d9fcf2fb | 165 | { |
d7e74731 PA |
166 | m_file = file; |
167 | m_fd = fileno (file); | |
d9fcf2fb JM |
168 | } |
169 | ||
d7e74731 PA |
170 | bool |
171 | stdio_file::open (const char *name, const char *mode) | |
d9fcf2fb | 172 | { |
d7e74731 PA |
173 | /* Close the previous stream, if we own it. */ |
174 | if (m_close_p) | |
175 | { | |
176 | fclose (m_file); | |
177 | m_close_p = false; | |
178 | } | |
5d502164 | 179 | |
d419f42d | 180 | gdb_file_up f = gdb_fopen_cloexec (name, mode); |
d9fcf2fb | 181 | |
d7e74731 PA |
182 | if (f == NULL) |
183 | return false; | |
d9fcf2fb | 184 | |
d419f42d | 185 | set_stream (f.release ()); |
d7e74731 | 186 | m_close_p = true; |
5d502164 | 187 | |
d7e74731 | 188 | return true; |
d9fcf2fb JM |
189 | } |
190 | ||
191 | void | |
d7e74731 | 192 | stdio_file::flush () |
d9fcf2fb | 193 | { |
d7e74731 | 194 | fflush (m_file); |
d9fcf2fb JM |
195 | } |
196 | ||
d7e74731 PA |
197 | long |
198 | stdio_file::read (char *buf, long length_buf) | |
449092f6 | 199 | { |
f0881b37 PA |
200 | /* Wait until at least one byte of data is available, or we get |
201 | interrupted with Control-C. */ | |
ad960ed2 | 202 | { |
ad960ed2 | 203 | fd_set readfds; |
f0881b37 | 204 | |
ad960ed2 | 205 | FD_ZERO (&readfds); |
d7e74731 PA |
206 | FD_SET (m_fd, &readfds); |
207 | if (interruptible_select (m_fd + 1, &readfds, NULL, NULL, NULL) == -1) | |
ad960ed2 DJ |
208 | return -1; |
209 | } | |
210 | ||
d7e74731 | 211 | return ::read (m_fd, buf, length_buf); |
449092f6 CV |
212 | } |
213 | ||
d7e74731 PA |
214 | void |
215 | stdio_file::write (const char *buf, long length_buf) | |
d9fcf2fb | 216 | { |
bf1d7d9c | 217 | /* Calling error crashes when we are called from the exception framework. */ |
d7e74731 | 218 | if (fwrite (buf, length_buf, 1, m_file)) |
d4fb63e1 TT |
219 | { |
220 | /* Nothing. */ | |
221 | } | |
d9fcf2fb JM |
222 | } |
223 | ||
d7e74731 PA |
224 | void |
225 | stdio_file::write_async_safe (const char *buf, long length_buf) | |
01124a23 | 226 | { |
9f7bc587 DE |
227 | /* This is written the way it is to avoid a warning from gcc about not using the |
228 | result of write (since it can be declared with attribute warn_unused_result). | |
229 | Alas casting to void doesn't work for this. */ | |
d7e74731 | 230 | if (::write (m_fd, buf, length_buf)) |
d4fb63e1 TT |
231 | { |
232 | /* Nothing. */ | |
233 | } | |
01124a23 DE |
234 | } |
235 | ||
d7e74731 PA |
236 | void |
237 | stdio_file::puts (const char *linebuffer) | |
d9fcf2fb | 238 | { |
bf1d7d9c | 239 | /* Calling error crashes when we are called from the exception framework. */ |
d7e74731 | 240 | if (fputs (linebuffer, m_file)) |
d4fb63e1 TT |
241 | { |
242 | /* Nothing. */ | |
243 | } | |
d9fcf2fb JM |
244 | } |
245 | ||
d7e74731 PA |
246 | bool |
247 | stdio_file::isatty () | |
d9fcf2fb | 248 | { |
d7e74731 | 249 | return ::isatty (m_fd); |
d9fcf2fb JM |
250 | } |
251 | ||
d7e74731 | 252 | \f |
2a9d5ccf | 253 | |
d7e74731 | 254 | /* This is the implementation of ui_file method 'write' for stderr. |
ffa4ac95 YQ |
255 | gdb_stdout is flushed before writing to gdb_stderr. */ |
256 | ||
d7e74731 PA |
257 | void |
258 | stderr_file::write (const char *buf, long length_buf) | |
ffa4ac95 YQ |
259 | { |
260 | gdb_flush (gdb_stdout); | |
d7e74731 | 261 | stdio_file::write (buf, length_buf); |
ffa4ac95 YQ |
262 | } |
263 | ||
d7e74731 | 264 | /* This is the implementation of ui_file method 'puts' for stderr. |
ffa4ac95 YQ |
265 | gdb_stdout is flushed before writing to gdb_stderr. */ |
266 | ||
d7e74731 PA |
267 | void |
268 | stderr_file::puts (const char *linebuffer) | |
ffa4ac95 YQ |
269 | { |
270 | gdb_flush (gdb_stdout); | |
d7e74731 | 271 | stdio_file::puts (linebuffer); |
ffa4ac95 | 272 | } |
ffa4ac95 | 273 | |
d7e74731 PA |
274 | stderr_file::stderr_file (FILE *stream) |
275 | : stdio_file (stream) | |
276 | {} | |
d9fcf2fb | 277 | |
d7e74731 | 278 | \f |
e4c242d9 | 279 | |
d7e74731 PA |
280 | tee_file::tee_file (ui_file *one, bool close_one, |
281 | ui_file *two, bool close_two) | |
282 | : m_one (one), | |
283 | m_two (two), | |
284 | m_close_one (close_one), | |
285 | m_close_two (close_two) | |
286 | {} | |
e4c242d9 | 287 | |
d7e74731 | 288 | tee_file::~tee_file () |
e4c242d9 | 289 | { |
d7e74731 PA |
290 | if (m_close_one) |
291 | delete m_one; | |
292 | if (m_close_two) | |
293 | delete m_two; | |
e4c242d9 DJ |
294 | } |
295 | ||
d7e74731 PA |
296 | void |
297 | tee_file::flush () | |
e4c242d9 | 298 | { |
d7e74731 PA |
299 | m_one->flush (); |
300 | m_two->flush (); | |
e4c242d9 DJ |
301 | } |
302 | ||
d7e74731 PA |
303 | void |
304 | tee_file::write (const char *buf, long length_buf) | |
e4c242d9 | 305 | { |
d7e74731 PA |
306 | m_one->write (buf, length_buf); |
307 | m_two->write (buf, length_buf); | |
e4c242d9 DJ |
308 | } |
309 | ||
d7e74731 PA |
310 | void |
311 | tee_file::write_async_safe (const char *buf, long length_buf) | |
e4c242d9 | 312 | { |
d7e74731 PA |
313 | m_one->write_async_safe (buf, length_buf); |
314 | m_two->write_async_safe (buf, length_buf); | |
e4c242d9 DJ |
315 | } |
316 | ||
d7e74731 PA |
317 | void |
318 | tee_file::puts (const char *linebuffer) | |
e4c242d9 | 319 | { |
d7e74731 PA |
320 | m_one->puts (linebuffer); |
321 | m_two->puts (linebuffer); | |
e4c242d9 DJ |
322 | } |
323 | ||
d7e74731 PA |
324 | bool |
325 | tee_file::isatty () | |
e4c242d9 | 326 | { |
d7e74731 | 327 | return m_one->isatty (); |
e4c242d9 | 328 | } |