Commit | Line | Data |
---|---|---|
d9fcf2fb | 1 | /* UI_FILE - a generic STDIO like output stream. |
349c5d5f | 2 | |
42a4f53d | 3 | Copyright (C) 1999-2019 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" |
268a13a5 | 26 | #include "gdbsupport/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 | { |
7c4e78cf | 55 | fputstrn_unfiltered (str, n, quoter, fputc_unfiltered, 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 | ||
8a522c6c PW |
104 | /* true if the gdb terminal supports styling, and styling is enabled. */ |
105 | ||
106 | static bool | |
107 | term_cli_styling () | |
108 | { | |
109 | extern int cli_styling; | |
110 | ||
111 | if (!cli_styling) | |
112 | return false; | |
113 | ||
114 | const char *term = getenv ("TERM"); | |
115 | /* Windows doesn't by default define $TERM, but can support styles | |
116 | regardless. */ | |
117 | #ifndef _WIN32 | |
118 | if (term == nullptr || !strcmp (term, "dumb")) | |
119 | return false; | |
120 | #else | |
121 | /* But if they do define $TERM, let us behave the same as on Posix | |
122 | platforms, for the benefit of programs which invoke GDB as their | |
123 | back-end. */ | |
124 | if (term && !strcmp (term, "dumb")) | |
125 | return false; | |
126 | #endif | |
127 | return true; | |
128 | } | |
129 | ||
130 | ||
d9fcf2fb JM |
131 | void |
132 | ui_file_write (struct ui_file *file, | |
133 | const char *buf, | |
134 | long length_buf) | |
135 | { | |
d7e74731 | 136 | file->write (buf, length_buf); |
de571fc5 TT |
137 | } |
138 | ||
01124a23 DE |
139 | void |
140 | ui_file_write_async_safe (struct ui_file *file, | |
141 | const char *buf, | |
142 | long length_buf) | |
143 | { | |
d7e74731 | 144 | file->write_async_safe (buf, length_buf); |
01124a23 DE |
145 | } |
146 | ||
449092f6 CV |
147 | long |
148 | ui_file_read (struct ui_file *file, char *buf, long length_buf) | |
149 | { | |
d7e74731 | 150 | return file->read (buf, length_buf); |
2a9d5ccf HZ |
151 | } |
152 | ||
d9fcf2fb | 153 | void |
fba45db2 | 154 | fputs_unfiltered (const char *buf, struct ui_file *file) |
d9fcf2fb | 155 | { |
d7e74731 | 156 | file->puts (buf); |
d9fcf2fb JM |
157 | } |
158 | ||
d7e74731 | 159 | \f |
d9fcf2fb | 160 | |
d7e74731 PA |
161 | string_file::~string_file () |
162 | {} | |
d9fcf2fb JM |
163 | |
164 | void | |
d7e74731 | 165 | string_file::write (const char *buf, long length_buf) |
d9fcf2fb | 166 | { |
d7e74731 | 167 | m_string.append (buf, length_buf); |
d9fcf2fb JM |
168 | } |
169 | ||
8a522c6c PW |
170 | /* See ui-file.h. */ |
171 | ||
172 | bool | |
173 | string_file::term_out () | |
174 | { | |
175 | return m_term_out; | |
176 | } | |
177 | ||
178 | /* See ui-file.h. */ | |
179 | ||
180 | bool | |
181 | string_file::can_emit_style_escape () | |
182 | { | |
183 | return m_term_out && term_cli_styling (); | |
184 | } | |
185 | ||
d7e74731 | 186 | \f |
01124a23 | 187 | |
d7e74731 | 188 | stdio_file::stdio_file (FILE *file, bool close_p) |
449092f6 | 189 | { |
d7e74731 PA |
190 | set_stream (file); |
191 | m_close_p = close_p; | |
449092f6 CV |
192 | } |
193 | ||
d7e74731 PA |
194 | stdio_file::stdio_file () |
195 | : m_file (NULL), | |
196 | m_fd (-1), | |
197 | m_close_p (false) | |
198 | {} | |
d9fcf2fb | 199 | |
d7e74731 | 200 | stdio_file::~stdio_file () |
2a9d5ccf | 201 | { |
d7e74731 PA |
202 | if (m_close_p) |
203 | fclose (m_file); | |
2a9d5ccf HZ |
204 | } |
205 | ||
d9fcf2fb | 206 | void |
d7e74731 | 207 | stdio_file::set_stream (FILE *file) |
d9fcf2fb | 208 | { |
d7e74731 PA |
209 | m_file = file; |
210 | m_fd = fileno (file); | |
d9fcf2fb JM |
211 | } |
212 | ||
d7e74731 PA |
213 | bool |
214 | stdio_file::open (const char *name, const char *mode) | |
d9fcf2fb | 215 | { |
d7e74731 PA |
216 | /* Close the previous stream, if we own it. */ |
217 | if (m_close_p) | |
218 | { | |
219 | fclose (m_file); | |
220 | m_close_p = false; | |
221 | } | |
5d502164 | 222 | |
d419f42d | 223 | gdb_file_up f = gdb_fopen_cloexec (name, mode); |
d9fcf2fb | 224 | |
d7e74731 PA |
225 | if (f == NULL) |
226 | return false; | |
d9fcf2fb | 227 | |
d419f42d | 228 | set_stream (f.release ()); |
d7e74731 | 229 | m_close_p = true; |
5d502164 | 230 | |
d7e74731 | 231 | return true; |
d9fcf2fb JM |
232 | } |
233 | ||
234 | void | |
d7e74731 | 235 | stdio_file::flush () |
d9fcf2fb | 236 | { |
d7e74731 | 237 | fflush (m_file); |
d9fcf2fb JM |
238 | } |
239 | ||
d7e74731 PA |
240 | long |
241 | stdio_file::read (char *buf, long length_buf) | |
449092f6 | 242 | { |
f0881b37 PA |
243 | /* Wait until at least one byte of data is available, or we get |
244 | interrupted with Control-C. */ | |
ad960ed2 | 245 | { |
ad960ed2 | 246 | fd_set readfds; |
f0881b37 | 247 | |
ad960ed2 | 248 | FD_ZERO (&readfds); |
d7e74731 PA |
249 | FD_SET (m_fd, &readfds); |
250 | if (interruptible_select (m_fd + 1, &readfds, NULL, NULL, NULL) == -1) | |
ad960ed2 DJ |
251 | return -1; |
252 | } | |
253 | ||
d7e74731 | 254 | return ::read (m_fd, buf, length_buf); |
449092f6 CV |
255 | } |
256 | ||
d7e74731 PA |
257 | void |
258 | stdio_file::write (const char *buf, long length_buf) | |
d9fcf2fb | 259 | { |
bf1d7d9c | 260 | /* Calling error crashes when we are called from the exception framework. */ |
d7e74731 | 261 | if (fwrite (buf, length_buf, 1, m_file)) |
d4fb63e1 TT |
262 | { |
263 | /* Nothing. */ | |
264 | } | |
d9fcf2fb JM |
265 | } |
266 | ||
d7e74731 PA |
267 | void |
268 | stdio_file::write_async_safe (const char *buf, long length_buf) | |
01124a23 | 269 | { |
9f7bc587 DE |
270 | /* This is written the way it is to avoid a warning from gcc about not using the |
271 | result of write (since it can be declared with attribute warn_unused_result). | |
272 | Alas casting to void doesn't work for this. */ | |
d7e74731 | 273 | if (::write (m_fd, buf, length_buf)) |
d4fb63e1 TT |
274 | { |
275 | /* Nothing. */ | |
276 | } | |
01124a23 DE |
277 | } |
278 | ||
d7e74731 PA |
279 | void |
280 | stdio_file::puts (const char *linebuffer) | |
d9fcf2fb | 281 | { |
e4adb939 EZ |
282 | /* This host-dependent function (with implementations in |
283 | posix-hdep.c and mingw-hdep.c) is given the opportunity to | |
284 | process the output first in host-dependent way. If it does, it | |
285 | should return non-zero, to avoid calling fputs below. */ | |
286 | if (gdb_console_fputs (linebuffer, m_file)) | |
287 | return; | |
bf1d7d9c | 288 | /* Calling error crashes when we are called from the exception framework. */ |
d7e74731 | 289 | if (fputs (linebuffer, m_file)) |
d4fb63e1 TT |
290 | { |
291 | /* Nothing. */ | |
292 | } | |
d9fcf2fb JM |
293 | } |
294 | ||
d7e74731 PA |
295 | bool |
296 | stdio_file::isatty () | |
d9fcf2fb | 297 | { |
d7e74731 | 298 | return ::isatty (m_fd); |
d9fcf2fb JM |
299 | } |
300 | ||
8a522c6c PW |
301 | /* See ui-file.h. */ |
302 | ||
303 | bool | |
304 | stdio_file::can_emit_style_escape () | |
305 | { | |
306 | return (this == gdb_stdout | |
307 | && this->isatty () | |
308 | && term_cli_styling ()); | |
309 | } | |
310 | ||
d7e74731 | 311 | \f |
2a9d5ccf | 312 | |
d7e74731 | 313 | /* This is the implementation of ui_file method 'write' for stderr. |
ffa4ac95 YQ |
314 | gdb_stdout is flushed before writing to gdb_stderr. */ |
315 | ||
d7e74731 PA |
316 | void |
317 | stderr_file::write (const char *buf, long length_buf) | |
ffa4ac95 YQ |
318 | { |
319 | gdb_flush (gdb_stdout); | |
d7e74731 | 320 | stdio_file::write (buf, length_buf); |
ffa4ac95 YQ |
321 | } |
322 | ||
d7e74731 | 323 | /* This is the implementation of ui_file method 'puts' for stderr. |
ffa4ac95 YQ |
324 | gdb_stdout is flushed before writing to gdb_stderr. */ |
325 | ||
d7e74731 PA |
326 | void |
327 | stderr_file::puts (const char *linebuffer) | |
ffa4ac95 YQ |
328 | { |
329 | gdb_flush (gdb_stdout); | |
d7e74731 | 330 | stdio_file::puts (linebuffer); |
ffa4ac95 | 331 | } |
ffa4ac95 | 332 | |
d7e74731 PA |
333 | stderr_file::stderr_file (FILE *stream) |
334 | : stdio_file (stream) | |
335 | {} | |
d9fcf2fb | 336 | |
d7e74731 | 337 | \f |
e4c242d9 | 338 | |
f3a09c80 | 339 | tee_file::tee_file (ui_file *one, ui_file_up &&two) |
d7e74731 | 340 | : m_one (one), |
f3a09c80 | 341 | m_two (std::move (two)) |
d7e74731 | 342 | {} |
e4c242d9 | 343 | |
d7e74731 | 344 | tee_file::~tee_file () |
e4c242d9 | 345 | { |
e4c242d9 DJ |
346 | } |
347 | ||
d7e74731 PA |
348 | void |
349 | tee_file::flush () | |
e4c242d9 | 350 | { |
d7e74731 PA |
351 | m_one->flush (); |
352 | m_two->flush (); | |
e4c242d9 DJ |
353 | } |
354 | ||
d7e74731 PA |
355 | void |
356 | tee_file::write (const char *buf, long length_buf) | |
e4c242d9 | 357 | { |
d7e74731 PA |
358 | m_one->write (buf, length_buf); |
359 | m_two->write (buf, length_buf); | |
e4c242d9 DJ |
360 | } |
361 | ||
d7e74731 PA |
362 | void |
363 | tee_file::write_async_safe (const char *buf, long length_buf) | |
e4c242d9 | 364 | { |
d7e74731 PA |
365 | m_one->write_async_safe (buf, length_buf); |
366 | m_two->write_async_safe (buf, length_buf); | |
e4c242d9 DJ |
367 | } |
368 | ||
d7e74731 PA |
369 | void |
370 | tee_file::puts (const char *linebuffer) | |
e4c242d9 | 371 | { |
d7e74731 PA |
372 | m_one->puts (linebuffer); |
373 | m_two->puts (linebuffer); | |
e4c242d9 DJ |
374 | } |
375 | ||
d7e74731 PA |
376 | bool |
377 | tee_file::isatty () | |
e4c242d9 | 378 | { |
d7e74731 | 379 | return m_one->isatty (); |
e4c242d9 | 380 | } |
8a522c6c PW |
381 | |
382 | /* See ui-file.h. */ | |
383 | ||
384 | bool | |
385 | tee_file::term_out () | |
386 | { | |
387 | return m_one->term_out (); | |
388 | } | |
389 | ||
390 | /* See ui-file.h. */ | |
391 | ||
392 | bool | |
393 | tee_file::can_emit_style_escape () | |
394 | { | |
395 | return (this == gdb_stdout | |
396 | && m_one->term_out () | |
397 | && term_cli_styling ()); | |
398 | } | |
0735b091 TT |
399 | |
400 | /* See ui-file.h. */ | |
401 | ||
402 | void | |
403 | no_terminal_escape_file::write (const char *buf, long length_buf) | |
404 | { | |
405 | std::string copy (buf, length_buf); | |
406 | this->puts (copy.c_str ()); | |
407 | } | |
408 | ||
409 | /* See ui-file.h. */ | |
410 | ||
411 | void | |
412 | no_terminal_escape_file::puts (const char *buf) | |
413 | { | |
414 | while (*buf != '\0') | |
415 | { | |
416 | const char *esc = strchr (buf, '\033'); | |
417 | if (esc == nullptr) | |
418 | break; | |
419 | ||
420 | int n_read = 0; | |
421 | if (!skip_ansi_escape (esc, &n_read)) | |
422 | ++esc; | |
423 | ||
424 | this->stdio_file::write (buf, esc - buf); | |
425 | buf = esc + n_read; | |
426 | } | |
427 | ||
428 | if (*buf != '\0') | |
429 | this->stdio_file::write (buf, strlen (buf)); | |
430 | } |