1*b725ae77Skettenis /* UI_FILE - a generic STDIO like output stream. 2*b725ae77Skettenis Copyright 1999, 2000 Free Software Foundation, Inc. 3*b725ae77Skettenis 4*b725ae77Skettenis This file is part of GDB. 5*b725ae77Skettenis 6*b725ae77Skettenis This program is free software; you can redistribute it and/or modify 7*b725ae77Skettenis it under the terms of the GNU General Public License as published by 8*b725ae77Skettenis the Free Software Foundation; either version 2 of the License, or 9*b725ae77Skettenis (at your option) any later version. 10*b725ae77Skettenis 11*b725ae77Skettenis This program is distributed in the hope that it will be useful, 12*b725ae77Skettenis but WITHOUT ANY WARRANTY; without even the implied warranty of 13*b725ae77Skettenis MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14*b725ae77Skettenis GNU General Public License for more details. 15*b725ae77Skettenis 16*b725ae77Skettenis You should have received a copy of the GNU General Public License 17*b725ae77Skettenis along with this program; if not, write to the Free Software 18*b725ae77Skettenis Foundation, Inc., 59 Temple Place - Suite 330, 19*b725ae77Skettenis Boston, MA 02111-1307, USA. */ 20*b725ae77Skettenis 21*b725ae77Skettenis #ifndef UI_FILE_H 22*b725ae77Skettenis #define UI_FILE_H 23*b725ae77Skettenis 24*b725ae77Skettenis struct ui_file; 25*b725ae77Skettenis 26*b725ae77Skettenis /* Create a generic ui_file object with null methods. */ 27*b725ae77Skettenis 28*b725ae77Skettenis extern struct ui_file *ui_file_new (void); 29*b725ae77Skettenis 30*b725ae77Skettenis /* Override methods used by specific implementations of a UI_FILE 31*b725ae77Skettenis object. */ 32*b725ae77Skettenis 33*b725ae77Skettenis typedef void (ui_file_flush_ftype) (struct ui_file * stream); 34*b725ae77Skettenis extern void set_ui_file_flush (struct ui_file *stream, ui_file_flush_ftype * flush); 35*b725ae77Skettenis 36*b725ae77Skettenis /* NOTE: Both fputs and write methods are available. Default 37*b725ae77Skettenis implementations that mapping one onto the other are included. */ 38*b725ae77Skettenis typedef void (ui_file_write_ftype) (struct ui_file * stream, const char *buf, long length_buf); 39*b725ae77Skettenis extern void set_ui_file_write (struct ui_file *stream, ui_file_write_ftype *fputs); 40*b725ae77Skettenis 41*b725ae77Skettenis typedef void (ui_file_fputs_ftype) (const char *, struct ui_file * stream); 42*b725ae77Skettenis extern void set_ui_file_fputs (struct ui_file *stream, ui_file_fputs_ftype * fputs); 43*b725ae77Skettenis 44*b725ae77Skettenis typedef long (ui_file_read_ftype) (struct ui_file * stream, char *buf, long length_buf); 45*b725ae77Skettenis extern void set_ui_file_read (struct ui_file *stream, ui_file_read_ftype *fread); 46*b725ae77Skettenis 47*b725ae77Skettenis typedef int (ui_file_isatty_ftype) (struct ui_file * stream); 48*b725ae77Skettenis extern void set_ui_file_isatty (struct ui_file *stream, ui_file_isatty_ftype * isatty); 49*b725ae77Skettenis 50*b725ae77Skettenis typedef void (ui_file_rewind_ftype) (struct ui_file * stream); 51*b725ae77Skettenis extern void set_ui_file_rewind (struct ui_file *stream, ui_file_rewind_ftype * rewind); 52*b725ae77Skettenis 53*b725ae77Skettenis typedef void (ui_file_put_method_ftype) (void *object, const char *buffer, long length_buffer); 54*b725ae77Skettenis typedef void (ui_file_put_ftype) (struct ui_file *stream, ui_file_put_method_ftype * method, void *context); 55*b725ae77Skettenis extern void set_ui_file_put (struct ui_file *stream, ui_file_put_ftype * put); 56*b725ae77Skettenis 57*b725ae77Skettenis typedef void (ui_file_delete_ftype) (struct ui_file * stream); 58*b725ae77Skettenis extern void set_ui_file_data (struct ui_file *stream, void *data, ui_file_delete_ftype * delete); 59*b725ae77Skettenis 60*b725ae77Skettenis extern void *ui_file_data (struct ui_file *file); 61*b725ae77Skettenis 62*b725ae77Skettenis 63*b725ae77Skettenis extern void gdb_flush (struct ui_file *); 64*b725ae77Skettenis 65*b725ae77Skettenis extern void ui_file_delete (struct ui_file *stream); 66*b725ae77Skettenis 67*b725ae77Skettenis extern void ui_file_rewind (struct ui_file *stream); 68*b725ae77Skettenis 69*b725ae77Skettenis extern int ui_file_isatty (struct ui_file *); 70*b725ae77Skettenis 71*b725ae77Skettenis extern void ui_file_write (struct ui_file *file, const char *buf, long length_buf); 72*b725ae77Skettenis 73*b725ae77Skettenis /* NOTE: copies left to right */ 74*b725ae77Skettenis extern void ui_file_put (struct ui_file *src, ui_file_put_method_ftype *write, void *dest); 75*b725ae77Skettenis 76*b725ae77Skettenis /* Returns a freshly allocated buffer containing the entire contents 77*b725ae77Skettenis of FILE (as determined by ui_file_put()) with a NUL character 78*b725ae77Skettenis appended. LENGTH is set to the size of the buffer minus that 79*b725ae77Skettenis appended NUL. */ 80*b725ae77Skettenis extern char *ui_file_xstrdup (struct ui_file *file, long *length); 81*b725ae77Skettenis 82*b725ae77Skettenis 83*b725ae77Skettenis 84*b725ae77Skettenis extern long ui_file_read (struct ui_file *file, char *buf, long length_buf); 85*b725ae77Skettenis 86*b725ae77Skettenis /* Create/open a memory based file. Can be used as a scratch buffer 87*b725ae77Skettenis for collecting output. */ 88*b725ae77Skettenis extern struct ui_file *mem_fileopen (void); 89*b725ae77Skettenis 90*b725ae77Skettenis 91*b725ae77Skettenis 92*b725ae77Skettenis /* Open/create a an STDIO based UI_FILE using the already open FILE. */ 93*b725ae77Skettenis extern struct ui_file *stdio_fileopen (FILE *file); 94*b725ae77Skettenis 95*b725ae77Skettenis /* Open NAME returning an STDIO based UI_FILE. */ 96*b725ae77Skettenis extern struct ui_file *gdb_fopen (char *name, char *mode); 97*b725ae77Skettenis 98*b725ae77Skettenis /* Create a file which writes to both ONE and TWO. CLOSE_ONE 99*b725ae77Skettenis and CLOSE_TWO indicate whether the original files should be 100*b725ae77Skettenis closed when the new file is closed. */ 101*b725ae77Skettenis struct ui_file *tee_file_new (struct ui_file *one, 102*b725ae77Skettenis int close_one, 103*b725ae77Skettenis struct ui_file *two, 104*b725ae77Skettenis int close_two); 105*b725ae77Skettenis #endif 106