1 /* UI_FILE - a generic STDIO like output stream.
3 Copyright (C) 1999-2024 Free Software Foundation, Inc.
5 This file is part of GDB.
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
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
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.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 /* Implement the ``struct ui_file'' object. */
23 #include "gdbsupport/gdb_obstack.h"
24 #include "gdbsupport/gdb_select.h"
25 #include "gdbsupport/filestuff.h"
27 #include "cli/cli-style.h"
30 null_file null_stream
;
39 ui_file::printf (const char *format
, ...)
43 va_start (args
, format
);
44 vprintf (format
, args
);
49 ui_file::putstr (const char *str
, int quoter
)
52 printchar (*str
++, quoter
, false);
56 ui_file::putstrn (const char *str
, int n
, int quoter
, bool async_safe
)
58 for (int i
= 0; i
< n
; i
++)
59 printchar (str
[i
], quoter
, async_safe
);
70 ui_file::vprintf (const char *format
, va_list args
)
72 ui_out_flags flags
= disallow_ui_out_field
;
73 cli_ui_out (this, flags
).vmessage (m_applied_style
, format
, args
);
79 ui_file::emit_style_escape (const ui_file_style
&style
)
81 if (can_emit_style_escape () && style
!= m_applied_style
)
83 m_applied_style
= style
;
84 this->puts (style
.to_ansi ().c_str ());
91 ui_file::reset_style ()
93 if (can_emit_style_escape ())
95 m_applied_style
= ui_file_style ();
96 this->puts (m_applied_style
.to_ansi ().c_str ());
103 ui_file::printchar (int c
, int quoter
, bool async_safe
)
108 c
&= 0xFF; /* Avoid sign bit follies */
110 if (c
< 0x20 /* Low control chars */
111 || (c
>= 0x7F && c
< 0xA0) /* DEL, High controls */
112 || (sevenbit_strings
&& c
>= 0x80))
113 { /* high order bit set */
141 buf
[out
++] = '0' + ((c
>> 6) & 0x7);
142 buf
[out
++] = '0' + ((c
>> 3) & 0x7);
143 buf
[out
++] = '0' + ((c
>> 0) & 0x7);
150 if (quoter
!= 0 && (c
== '\\' || c
== quoter
))
156 this->write_async_safe (buf
, out
);
158 this->write (buf
, out
);
164 null_file::write (const char *buf
, long sizeof_buf
)
166 /* Discard the request. */
170 null_file::puts (const char *)
172 /* Discard the request. */
176 null_file::write_async_safe (const char *buf
, long sizeof_buf
)
178 /* Discard the request. */
183 /* true if the gdb terminal supports styling, and styling is enabled. */
191 const char *term
= getenv ("TERM");
192 /* Windows doesn't by default define $TERM, but can support styles
195 if (term
== nullptr || !strcmp (term
, "dumb"))
198 /* But if they do define $TERM, let us behave the same as on Posix
199 platforms, for the benefit of programs which invoke GDB as their
201 if (term
&& !strcmp (term
, "dumb"))
209 string_file::~string_file ()
213 string_file::write (const char *buf
, long length_buf
)
215 m_string
.append (buf
, length_buf
);
221 string_file::term_out ()
229 string_file::can_emit_style_escape ()
231 return m_term_out
&& term_cli_styling ();
236 stdio_file::stdio_file (FILE *file
, bool close_p
)
242 stdio_file::stdio_file ()
248 stdio_file::~stdio_file ()
255 stdio_file::set_stream (FILE *file
)
258 m_fd
= fileno (file
);
262 stdio_file::open (const char *name
, const char *mode
)
264 /* Close the previous stream, if we own it. */
271 gdb_file_up f
= gdb_fopen_cloexec (name
, mode
);
276 set_stream (f
.release ());
289 stdio_file::read (char *buf
, long length_buf
)
291 /* Wait until at least one byte of data is available, or we get
292 interrupted with Control-C. */
297 FD_SET (m_fd
, &readfds
);
298 if (interruptible_select (m_fd
+ 1, &readfds
, NULL
, NULL
, NULL
) == -1)
302 return ::read (m_fd
, buf
, length_buf
);
306 stdio_file::write (const char *buf
, long length_buf
)
308 /* Calling error crashes when we are called from the exception framework. */
309 if (fwrite (buf
, length_buf
, 1, m_file
))
316 stdio_file::write_async_safe (const char *buf
, long length_buf
)
318 /* This is written the way it is to avoid a warning from gcc about not using the
319 result of write (since it can be declared with attribute warn_unused_result).
320 Alas casting to void doesn't work for this. */
321 if (::write (m_fd
, buf
, length_buf
))
328 stdio_file::puts (const char *linebuffer
)
330 /* This host-dependent function (with implementations in
331 posix-hdep.c and mingw-hdep.c) is given the opportunity to
332 process the output first in host-dependent way. If it does, it
333 should return non-zero, to avoid calling fputs below. */
334 if (gdb_console_fputs (linebuffer
, m_file
))
336 /* Calling error crashes when we are called from the exception framework. */
337 if (fputs (linebuffer
, m_file
))
344 stdio_file::isatty ()
346 return ::isatty (m_fd
);
352 stdio_file::can_emit_style_escape ()
354 return (this->isatty ()
355 && term_cli_styling ());
360 /* This is the implementation of ui_file method 'write' for stderr.
361 gdb_stdout is flushed before writing to gdb_stderr. */
364 stderr_file::write (const char *buf
, long length_buf
)
366 gdb_stdout
->flush ();
367 stdio_file::write (buf
, length_buf
);
370 /* This is the implementation of ui_file method 'puts' for stderr.
371 gdb_stdout is flushed before writing to gdb_stderr. */
374 stderr_file::puts (const char *linebuffer
)
376 gdb_stdout
->flush ();
377 stdio_file::puts (linebuffer
);
380 stderr_file::stderr_file (FILE *stream
)
381 : stdio_file (stream
)
386 tee_file::tee_file (ui_file
*one
, ui_file
*two
)
391 tee_file::~tee_file ()
403 tee_file::write (const char *buf
, long length_buf
)
405 m_one
->write (buf
, length_buf
);
406 m_two
->write (buf
, length_buf
);
410 tee_file::write_async_safe (const char *buf
, long length_buf
)
412 m_one
->write_async_safe (buf
, length_buf
);
413 m_two
->write_async_safe (buf
, length_buf
);
417 tee_file::puts (const char *linebuffer
)
419 m_one
->puts (linebuffer
);
420 m_two
->puts (linebuffer
);
426 return m_one
->isatty ();
432 tee_file::term_out ()
434 return m_one
->term_out ();
440 tee_file::can_emit_style_escape ()
442 return (m_one
->term_out ()
443 && term_cli_styling ());
449 no_terminal_escape_file::write (const char *buf
, long length_buf
)
451 std::string
copy (buf
, length_buf
);
452 this->puts (copy
.c_str ());
458 no_terminal_escape_file::puts (const char *buf
)
462 const char *esc
= strchr (buf
, '\033');
467 if (!skip_ansi_escape (esc
, &n_read
))
470 this->stdio_file::write (buf
, esc
- buf
);
475 this->stdio_file::write (buf
, strlen (buf
));
479 timestamped_file::write (const char *buf
, long len
)
483 /* Print timestamp if previous print ended with a \n. */
484 if (m_needs_timestamp
)
486 using namespace std::chrono
;
488 steady_clock::time_point now
= steady_clock::now ();
489 seconds s
= duration_cast
<seconds
> (now
.time_since_epoch ());
490 microseconds us
= duration_cast
<microseconds
> (now
.time_since_epoch () - s
);
491 std::string timestamp
= string_printf ("%ld.%06ld ",
494 m_stream
->puts (timestamp
.c_str ());
497 /* Print the message. */
498 m_stream
->write (buf
, len
);
500 m_needs_timestamp
= (len
> 0 && buf
[len
- 1] == '\n');
503 m_stream
->write (buf
, len
);