1 /* UI_FILE - a generic STDIO like output stream.
3 Copyright (C) 1999-2014 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. */
24 #include "gdb_obstack.h"
25 #include "gdb_select.h"
26 #include "filestuff.h"
28 static ui_file_isatty_ftype null_file_isatty;
29 static ui_file_write_ftype null_file_write;
30 static ui_file_write_ftype null_file_write_async_safe;
31 static ui_file_fputs_ftype null_file_fputs;
32 static ui_file_read_ftype null_file_read;
33 static ui_file_flush_ftype null_file_flush;
34 static ui_file_delete_ftype null_file_delete;
35 static ui_file_rewind_ftype null_file_rewind;
36 static ui_file_put_ftype null_file_put;
37 static ui_file_fseek_ftype null_file_fseek;
42 ui_file_flush_ftype *to_flush;
43 ui_file_write_ftype *to_write;
44 ui_file_write_async_safe_ftype *to_write_async_safe;
45 ui_file_fputs_ftype *to_fputs;
46 ui_file_read_ftype *to_read;
47 ui_file_delete_ftype *to_delete;
48 ui_file_isatty_ftype *to_isatty;
49 ui_file_rewind_ftype *to_rewind;
50 ui_file_put_ftype *to_put;
51 ui_file_fseek_ftype *to_fseek;
59 struct ui_file *file = xmalloc (sizeof (struct ui_file));
61 file->magic = &ui_file_magic;
62 set_ui_file_data (file, NULL, null_file_delete);
63 set_ui_file_flush (file, null_file_flush);
64 set_ui_file_write (file, null_file_write);
65 set_ui_file_write_async_safe (file, null_file_write_async_safe);
66 set_ui_file_fputs (file, null_file_fputs);
67 set_ui_file_read (file, null_file_read);
68 set_ui_file_isatty (file, null_file_isatty);
69 set_ui_file_rewind (file, null_file_rewind);
70 set_ui_file_put (file, null_file_put);
71 set_ui_file_fseek (file, null_file_fseek);
76 ui_file_delete (struct ui_file *file)
78 file->to_delete (file);
83 null_file_isatty (struct ui_file *file)
89 null_file_rewind (struct ui_file *file)
95 null_file_put (struct ui_file *file,
96 ui_file_put_method_ftype *write,
103 null_file_flush (struct ui_file *file)
109 null_file_write (struct ui_file *file,
113 if (file->to_fputs == null_file_fputs)
114 /* Both the write and fputs methods are null. Discard the
119 /* The fputs method isn't null, slowly pass the write request
120 onto that. FYI, this isn't as bad as it may look - the
121 current (as of 1999-11-07) printf_* function calls fputc and
122 fputc does exactly the below. By having a write function it
123 is possible to clean up that code. */
128 for (i = 0; i < sizeof_buf; i++)
131 file->to_fputs (b, file);
138 null_file_read (struct ui_file *file,
147 null_file_fputs (const char *buf, struct ui_file *file)
149 if (file->to_write == null_file_write)
150 /* Both the write and fputs methods are null. Discard the
155 /* The write method was implemented, use that. */
156 file->to_write (file, buf, strlen (buf));
161 null_file_write_async_safe (struct ui_file *file,
169 null_file_delete (struct ui_file *file)
175 null_file_fseek (struct ui_file *stream, long offset, int whence)
183 ui_file_data (struct ui_file *file)
185 if (file->magic != &ui_file_magic)
186 internal_error (__FILE__, __LINE__,
187 _("ui_file_data: bad magic number"));
188 return file->to_data;
192 gdb_flush (struct ui_file *file)
194 file->to_flush (file);
198 ui_file_isatty (struct ui_file *file)
200 return file->to_isatty (file);
204 ui_file_rewind (struct ui_file *file)
206 file->to_rewind (file);
210 ui_file_put (struct ui_file *file,
211 ui_file_put_method_ftype *write,
214 file->to_put (file, write, dest);
218 ui_file_write (struct ui_file *file,
222 file->to_write (file, buf, length_buf);
226 ui_file_write_async_safe (struct ui_file *file,
230 file->to_write_async_safe (file, buf, length_buf);
234 ui_file_read (struct ui_file *file, char *buf, long length_buf)
236 return file->to_read (file, buf, length_buf);
240 ui_file_fseek (struct ui_file *file, long offset, int whence)
242 return file->to_fseek (file, offset, whence);
246 fputs_unfiltered (const char *buf, struct ui_file *file)
248 file->to_fputs (buf, file);
252 set_ui_file_flush (struct ui_file *file, ui_file_flush_ftype *flush_ptr)
254 file->to_flush = flush_ptr;
258 set_ui_file_isatty (struct ui_file *file, ui_file_isatty_ftype *isatty_ptr)
260 file->to_isatty = isatty_ptr;
264 set_ui_file_rewind (struct ui_file *file, ui_file_rewind_ftype *rewind_ptr)
266 file->to_rewind = rewind_ptr;
270 set_ui_file_put (struct ui_file *file, ui_file_put_ftype *put_ptr)
272 file->to_put = put_ptr;
276 set_ui_file_write (struct ui_file *file,
277 ui_file_write_ftype *write_ptr)
279 file->to_write = write_ptr;
283 set_ui_file_write_async_safe (struct ui_file *file,
284 ui_file_write_async_safe_ftype *write_async_safe_ptr)
286 file->to_write_async_safe = write_async_safe_ptr;
290 set_ui_file_read (struct ui_file *file, ui_file_read_ftype *read_ptr)
292 file->to_read = read_ptr;
296 set_ui_file_fputs (struct ui_file *file, ui_file_fputs_ftype *fputs_ptr)
298 file->to_fputs = fputs_ptr;
302 set_ui_file_fseek (struct ui_file *file, ui_file_fseek_ftype *fseek_ptr)
304 file->to_fseek = fseek_ptr;
308 set_ui_file_data (struct ui_file *file, void *data,
309 ui_file_delete_ftype *delete_ptr)
311 file->to_data = data;
312 file->to_delete = delete_ptr;
315 /* ui_file utility function for converting a ``struct ui_file'' into
318 struct accumulated_ui_file
325 do_ui_file_xstrdup (void *context, const char *buffer, long length)
327 struct accumulated_ui_file *acc = context;
329 if (acc->buffer == NULL)
330 acc->buffer = xmalloc (length + 1);
332 acc->buffer = xrealloc (acc->buffer, acc->length + length + 1);
333 memcpy (acc->buffer + acc->length, buffer, length);
334 acc->length += length;
335 acc->buffer[acc->length] = '\0';
339 ui_file_xstrdup (struct ui_file *file, long *length)
341 struct accumulated_ui_file acc;
345 ui_file_put (file, do_ui_file_xstrdup, &acc);
346 if (acc.buffer == NULL)
347 acc.buffer = xstrdup ("");
349 *length = acc.length;
354 do_ui_file_obsavestring (void *context, const char *buffer, long length)
356 struct obstack *obstack = (struct obstack *) context;
358 obstack_grow (obstack, buffer, length);
362 ui_file_obsavestring (struct ui_file *file, struct obstack *obstack,
365 ui_file_put (file, do_ui_file_obsavestring, obstack);
366 *length = obstack_object_size (obstack);
367 obstack_1grow (obstack, '\0');
368 return obstack_finish (obstack);
371 /* A pure memory based ``struct ui_file'' that can be used an output
372 buffer. The buffers accumulated contents are available via
383 static ui_file_rewind_ftype mem_file_rewind;
384 static ui_file_put_ftype mem_file_put;
385 static ui_file_write_ftype mem_file_write;
386 static ui_file_delete_ftype mem_file_delete;
387 static struct ui_file *mem_file_new (void);
388 static int mem_file_magic;
390 static struct ui_file *
393 struct mem_file *stream = XNEW (struct mem_file);
394 struct ui_file *file = ui_file_new ();
396 set_ui_file_data (file, stream, mem_file_delete);
397 set_ui_file_rewind (file, mem_file_rewind);
398 set_ui_file_put (file, mem_file_put);
399 set_ui_file_write (file, mem_file_write);
400 stream->magic = &mem_file_magic;
401 stream->buffer = NULL;
402 stream->sizeof_buffer = 0;
403 stream->length_buffer = 0;
408 mem_file_delete (struct ui_file *file)
410 struct mem_file *stream = ui_file_data (file);
412 if (stream->magic != &mem_file_magic)
413 internal_error (__FILE__, __LINE__,
414 _("mem_file_delete: bad magic number"));
415 if (stream->buffer != NULL)
416 xfree (stream->buffer);
423 return mem_file_new ();
427 mem_file_rewind (struct ui_file *file)
429 struct mem_file *stream = ui_file_data (file);
431 if (stream->magic != &mem_file_magic)
432 internal_error (__FILE__, __LINE__,
433 _("mem_file_rewind: bad magic number"));
434 stream->length_buffer = 0;
438 mem_file_put (struct ui_file *file,
439 ui_file_put_method_ftype *write,
442 struct mem_file *stream = ui_file_data (file);
444 if (stream->magic != &mem_file_magic)
445 internal_error (__FILE__, __LINE__,
446 _("mem_file_put: bad magic number"));
447 if (stream->length_buffer > 0)
448 write (dest, stream->buffer, stream->length_buffer);
452 mem_file_write (struct ui_file *file,
456 struct mem_file *stream = ui_file_data (file);
458 if (stream->magic != &mem_file_magic)
459 internal_error (__FILE__, __LINE__,
460 _("mem_file_write: bad magic number"));
461 if (stream->buffer == NULL)
463 stream->length_buffer = length_buffer;
464 stream->sizeof_buffer = length_buffer;
465 stream->buffer = xmalloc (stream->sizeof_buffer);
466 memcpy (stream->buffer, buffer, length_buffer);
470 int new_length = stream->length_buffer + length_buffer;
472 if (new_length >= stream->sizeof_buffer)
474 stream->sizeof_buffer = new_length;
475 stream->buffer = xrealloc (stream->buffer, stream->sizeof_buffer);
477 memcpy (stream->buffer + stream->length_buffer, buffer, length_buffer);
478 stream->length_buffer = new_length;
482 /* ``struct ui_file'' implementation that maps directly onto
485 static ui_file_write_ftype stdio_file_write;
486 static ui_file_write_async_safe_ftype stdio_file_write_async_safe;
487 static ui_file_fputs_ftype stdio_file_fputs;
488 static ui_file_read_ftype stdio_file_read;
489 static ui_file_isatty_ftype stdio_file_isatty;
490 static ui_file_delete_ftype stdio_file_delete;
491 static struct ui_file *stdio_file_new (FILE *file, int close_p);
492 static ui_file_flush_ftype stdio_file_flush;
493 static ui_file_fseek_ftype stdio_file_fseek;
495 static int stdio_file_magic;
501 /* The associated file descriptor is extracted ahead of time for
502 stdio_file_write_async_safe's benefit, in case fileno isn't async-safe. */
507 static struct ui_file *
508 stdio_file_new (FILE *file, int close_p)
510 struct ui_file *ui_file = ui_file_new ();
511 struct stdio_file *stdio = xmalloc (sizeof (struct stdio_file));
513 stdio->magic = &stdio_file_magic;
515 stdio->fd = fileno (file);
516 stdio->close_p = close_p;
517 set_ui_file_data (ui_file, stdio, stdio_file_delete);
518 set_ui_file_flush (ui_file, stdio_file_flush);
519 set_ui_file_write (ui_file, stdio_file_write);
520 set_ui_file_write_async_safe (ui_file, stdio_file_write_async_safe);
521 set_ui_file_fputs (ui_file, stdio_file_fputs);
522 set_ui_file_read (ui_file, stdio_file_read);
523 set_ui_file_isatty (ui_file, stdio_file_isatty);
524 set_ui_file_fseek (ui_file, stdio_file_fseek);
529 stdio_file_delete (struct ui_file *file)
531 struct stdio_file *stdio = ui_file_data (file);
533 if (stdio->magic != &stdio_file_magic)
534 internal_error (__FILE__, __LINE__,
535 _("stdio_file_delete: bad magic number"));
538 fclose (stdio->file);
544 stdio_file_flush (struct ui_file *file)
546 struct stdio_file *stdio = ui_file_data (file);
548 if (stdio->magic != &stdio_file_magic)
549 internal_error (__FILE__, __LINE__,
550 _("stdio_file_flush: bad magic number"));
551 fflush (stdio->file);
555 stdio_file_read (struct ui_file *file, char *buf, long length_buf)
557 struct stdio_file *stdio = ui_file_data (file);
559 if (stdio->magic != &stdio_file_magic)
560 internal_error (__FILE__, __LINE__,
561 _("stdio_file_read: bad magic number"));
563 /* For the benefit of Windows, call gdb_select before reading from
564 the file. Wait until at least one byte of data is available.
565 Control-C can interrupt gdb_select, but not read. */
569 FD_SET (stdio->fd, &readfds);
570 if (gdb_select (stdio->fd + 1, &readfds, NULL, NULL, NULL) == -1)
574 return read (stdio->fd, buf, length_buf);
578 stdio_file_write (struct ui_file *file, const char *buf, long length_buf)
580 struct stdio_file *stdio = ui_file_data (file);
582 if (stdio->magic != &stdio_file_magic)
583 internal_error (__FILE__, __LINE__,
584 _("stdio_file_write: bad magic number"));
585 /* Calling error crashes when we are called from the exception framework. */
586 if (fwrite (buf, length_buf, 1, stdio->file))
593 stdio_file_write_async_safe (struct ui_file *file,
594 const char *buf, long length_buf)
596 struct stdio_file *stdio = ui_file_data (file);
598 if (stdio->magic != &stdio_file_magic)
600 /* gettext isn't necessarily async safe, so we can't use _("error message") here.
601 We could extract the correct translation ahead of time, but this is an extremely
602 rare event, and one of the other stdio_file_* routines will presumably catch
603 the problem anyway. For now keep it simple and ignore the error here. */
607 /* This is written the way it is to avoid a warning from gcc about not using the
608 result of write (since it can be declared with attribute warn_unused_result).
609 Alas casting to void doesn't work for this. */
610 if (write (stdio->fd, buf, length_buf))
617 stdio_file_fputs (const char *linebuffer, struct ui_file *file)
619 struct stdio_file *stdio = ui_file_data (file);
621 if (stdio->magic != &stdio_file_magic)
622 internal_error (__FILE__, __LINE__,
623 _("stdio_file_fputs: bad magic number"));
624 /* Calling error crashes when we are called from the exception framework. */
625 if (fputs (linebuffer, stdio->file))
632 stdio_file_isatty (struct ui_file *file)
634 struct stdio_file *stdio = ui_file_data (file);
636 if (stdio->magic != &stdio_file_magic)
637 internal_error (__FILE__, __LINE__,
638 _("stdio_file_isatty: bad magic number"));
639 return (isatty (stdio->fd));
643 stdio_file_fseek (struct ui_file *file, long offset, int whence)
645 struct stdio_file *stdio = ui_file_data (file);
647 if (stdio->magic != &stdio_file_magic)
648 internal_error (__FILE__, __LINE__,
649 _("stdio_file_fseek: bad magic number"));
651 return fseek (stdio->file, offset, whence);
655 /* This is the implementation of ui_file method to_write for stderr.
656 gdb_stdout is flushed before writing to gdb_stderr. */
659 stderr_file_write (struct ui_file *file, const char *buf, long length_buf)
661 gdb_flush (gdb_stdout);
662 stdio_file_write (file, buf, length_buf);
665 /* This is the implementation of ui_file method to_fputs for stderr.
666 gdb_stdout is flushed before writing to gdb_stderr. */
669 stderr_file_fputs (const char *linebuffer, struct ui_file *file)
671 gdb_flush (gdb_stdout);
672 stdio_file_fputs (linebuffer, file);
677 stderr_fileopen (void)
679 struct ui_file *ui_file = stdio_fileopen (stderr);
682 /* There is no real line-buffering on Windows, see
683 http://msdn.microsoft.com/en-us/library/86cebhfs%28v=vs.71%29.aspx
684 so the stdout is either fully-buffered or non-buffered. We can't
685 make stdout non-buffered, because of two concerns,
686 1. non-buffering hurts performance,
687 2. non-buffering may change GDB's behavior when it is interacting
688 with front-end, such as Emacs.
690 We decided to leave stdout as fully buffered, but flush it first
691 when something is written to stderr. */
693 /* Method 'to_write_async_safe' is not overwritten, because there's
694 no way to flush a stream in an async-safe manner. Fortunately,
695 it doesn't really matter, because:
696 - that method is only used for printing internal debug output
697 from signal handlers.
698 - Windows hosts don't have a concept of async-safeness. Signal
699 handlers run in a separate thread, so they can call
700 the regular non-async-safe output routines freely. */
701 set_ui_file_write (ui_file, stderr_file_write);
702 set_ui_file_fputs (ui_file, stderr_file_fputs);
708 /* Like fdopen(). Create a ui_file from a previously opened FILE. */
711 stdio_fileopen (FILE *file)
713 return stdio_file_new (file, 0);
717 gdb_fopen (const char *name, const char *mode)
719 FILE *f = gdb_fopen_cloexec (name, mode);
723 return stdio_file_new (f, 1);
726 /* ``struct ui_file'' implementation that maps onto two ui-file objects. */
728 static ui_file_write_ftype tee_file_write;
729 static ui_file_fputs_ftype tee_file_fputs;
730 static ui_file_isatty_ftype tee_file_isatty;
731 static ui_file_delete_ftype tee_file_delete;
732 static ui_file_flush_ftype tee_file_flush;
734 static int tee_file_magic;
739 struct ui_file *one, *two;
740 int close_one, close_two;
744 tee_file_new (struct ui_file *one, int close_one,
745 struct ui_file *two, int close_two)
747 struct ui_file *ui_file = ui_file_new ();
748 struct tee_file *tee = xmalloc (sizeof (struct tee_file));
750 tee->magic = &tee_file_magic;
753 tee->close_one = close_one;
754 tee->close_two = close_two;
755 set_ui_file_data (ui_file, tee, tee_file_delete);
756 set_ui_file_flush (ui_file, tee_file_flush);
757 set_ui_file_write (ui_file, tee_file_write);
758 set_ui_file_fputs (ui_file, tee_file_fputs);
759 set_ui_file_isatty (ui_file, tee_file_isatty);
764 tee_file_delete (struct ui_file *file)
766 struct tee_file *tee = ui_file_data (file);
768 if (tee->magic != &tee_file_magic)
769 internal_error (__FILE__, __LINE__,
770 _("tee_file_delete: bad magic number"));
772 ui_file_delete (tee->one);
774 ui_file_delete (tee->two);
780 tee_file_flush (struct ui_file *file)
782 struct tee_file *tee = ui_file_data (file);
784 if (tee->magic != &tee_file_magic)
785 internal_error (__FILE__, __LINE__,
786 _("tee_file_flush: bad magic number"));
787 tee->one->to_flush (tee->one);
788 tee->two->to_flush (tee->two);
792 tee_file_write (struct ui_file *file, const char *buf, long length_buf)
794 struct tee_file *tee = ui_file_data (file);
796 if (tee->magic != &tee_file_magic)
797 internal_error (__FILE__, __LINE__,
798 _("tee_file_write: bad magic number"));
799 ui_file_write (tee->one, buf, length_buf);
800 ui_file_write (tee->two, buf, length_buf);
804 tee_file_fputs (const char *linebuffer, struct ui_file *file)
806 struct tee_file *tee = ui_file_data (file);
808 if (tee->magic != &tee_file_magic)
809 internal_error (__FILE__, __LINE__,
810 _("tee_file_fputs: bad magic number"));
811 tee->one->to_fputs (linebuffer, tee->one);
812 tee->two->to_fputs (linebuffer, tee->two);
816 tee_file_isatty (struct ui_file *file)
818 struct tee_file *tee = ui_file_data (file);
820 if (tee->magic != &tee_file_magic)
821 internal_error (__FILE__, __LINE__,
822 _("tee_file_isatty: bad magic number"));
824 return ui_file_isatty (tee->one);