1/* UI_FILE - a generic STDIO like output stream. 2 Copyright 1999, 2000 Free Software Foundation, Inc. 3 4 This file is part of GDB. 5 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. 10 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. 15 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. */ 20 21#ifndef UI_FILE_H 22#define UI_FILE_H 23 24struct ui_file; 25 26/* Create a generic ui_file object with null methods. */ 27 28extern struct ui_file *ui_file_new (void); 29 30/* Override methods used by specific implementations of a UI_FILE 31 object. */ 32 33typedef void (ui_file_flush_ftype) (struct ui_file * stream); 34extern void set_ui_file_flush (struct ui_file *stream, ui_file_flush_ftype * flush); 35 36/* NOTE: Both fputs and write methods are available. Default 37 implementations that mapping one onto the other are included. */ 38typedef void (ui_file_write_ftype) (struct ui_file * stream, const char *buf, long length_buf); 39extern void set_ui_file_write (struct ui_file *stream, ui_file_write_ftype *fputs); 40 41typedef void (ui_file_fputs_ftype) (const char *, struct ui_file * stream); 42extern void set_ui_file_fputs (struct ui_file *stream, ui_file_fputs_ftype * fputs); 43 44typedef long (ui_file_read_ftype) (struct ui_file * stream, char *buf, long length_buf); 45extern void set_ui_file_read (struct ui_file *stream, ui_file_read_ftype *fread); 46 47typedef int (ui_file_isatty_ftype) (struct ui_file * stream); 48extern void set_ui_file_isatty (struct ui_file *stream, ui_file_isatty_ftype * isatty); 49 50typedef void (ui_file_rewind_ftype) (struct ui_file * stream); 51extern void set_ui_file_rewind (struct ui_file *stream, ui_file_rewind_ftype * rewind); 52 53typedef void (ui_file_put_method_ftype) (void *object, const char *buffer, long length_buffer); 54typedef void (ui_file_put_ftype) (struct ui_file *stream, ui_file_put_method_ftype * method, void *context); 55extern void set_ui_file_put (struct ui_file *stream, ui_file_put_ftype * put); 56 57typedef void (ui_file_delete_ftype) (struct ui_file * stream); 58extern void set_ui_file_data (struct ui_file *stream, void *data, ui_file_delete_ftype * delete); 59 60extern void *ui_file_data (struct ui_file *file); 61 62 63extern void gdb_flush (struct ui_file *); 64 65extern void ui_file_delete (struct ui_file *stream); 66 67extern void ui_file_rewind (struct ui_file *stream); 68 69extern int ui_file_isatty (struct ui_file *); 70 71extern void ui_file_write (struct ui_file *file, const char *buf, long length_buf); 72 73/* NOTE: copies left to right */ 74extern void ui_file_put (struct ui_file *src, ui_file_put_method_ftype *write, void *dest); 75 76/* Returns a freshly allocated buffer containing the entire contents 77 of FILE (as determined by ui_file_put()) with a NUL character 78 appended. LENGTH is set to the size of the buffer minus that 79 appended NUL. */ 80extern char *ui_file_xstrdup (struct ui_file *file, long *length); 81 82 83 84extern long ui_file_read (struct ui_file *file, char *buf, long length_buf); 85 86/* Create/open a memory based file. Can be used as a scratch buffer 87 for collecting output. */ 88extern struct ui_file *mem_fileopen (void); 89 90 91 92/* Open/create a an STDIO based UI_FILE using the already open FILE. */ 93extern struct ui_file *stdio_fileopen (FILE *file); 94 95/* Open NAME returning an STDIO based UI_FILE. */ 96extern struct ui_file *gdb_fopen (char *name, char *mode); 97 98/* Create a file which writes to both ONE and TWO. CLOSE_ONE 99 and CLOSE_TWO indicate whether the original files should be 100 closed when the new file is closed. */ 101struct ui_file *tee_file_new (struct ui_file *one, 102 int close_one, 103 struct ui_file *two, 104 int close_two); 105#endif 106