1 /* UI_FILE - a generic STDIO like output stream.
2 Copyright (C) 1999, 2000, 2007, 2008, 2009 Free Software Foundation, Inc.
4 This file is part of GDB.
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 3 of the License, or
9 (at your option) any later version.
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.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
24 /* Create a generic ui_file object with null methods. */
26 extern struct ui_file
*ui_file_new (void);
28 /* Override methods used by specific implementations of a UI_FILE
31 typedef void (ui_file_flush_ftype
) (struct ui_file
* stream
);
32 extern void set_ui_file_flush (struct ui_file
*stream
, ui_file_flush_ftype
* flush
);
34 /* NOTE: Both fputs and write methods are available. Default
35 implementations that mapping one onto the other are included. */
36 typedef void (ui_file_write_ftype
) (struct ui_file
* stream
, const char *buf
, long length_buf
);
37 extern void set_ui_file_write (struct ui_file
*stream
, ui_file_write_ftype
*fputs
);
39 typedef void (ui_file_fputs_ftype
) (const char *, struct ui_file
* stream
);
40 extern void set_ui_file_fputs (struct ui_file
*stream
, ui_file_fputs_ftype
* fputs
);
42 typedef long (ui_file_read_ftype
) (struct ui_file
* stream
, char *buf
, long length_buf
);
43 extern void set_ui_file_read (struct ui_file
*stream
, ui_file_read_ftype
*fread
);
45 typedef int (ui_file_isatty_ftype
) (struct ui_file
* stream
);
46 extern void set_ui_file_isatty (struct ui_file
*stream
, ui_file_isatty_ftype
* isatty
);
48 typedef void (ui_file_rewind_ftype
) (struct ui_file
* stream
);
49 extern void set_ui_file_rewind (struct ui_file
*stream
, ui_file_rewind_ftype
* rewind
);
51 typedef void (ui_file_put_method_ftype
) (void *object
, const char *buffer
, long length_buffer
);
52 typedef void (ui_file_put_ftype
) (struct ui_file
*stream
, ui_file_put_method_ftype
* method
, void *context
);
53 extern void set_ui_file_put (struct ui_file
*stream
, ui_file_put_ftype
* put
);
55 typedef void (ui_file_delete_ftype
) (struct ui_file
* stream
);
56 extern void set_ui_file_data (struct ui_file
*stream
, void *data
, ui_file_delete_ftype
* delete);
58 extern void *ui_file_data (struct ui_file
*file
);
61 extern void gdb_flush (struct ui_file
*);
63 extern void ui_file_delete (struct ui_file
*stream
);
65 extern void ui_file_rewind (struct ui_file
*stream
);
67 extern int ui_file_isatty (struct ui_file
*);
69 extern void ui_file_write (struct ui_file
*file
, const char *buf
, long length_buf
);
71 /* NOTE: copies left to right */
72 extern void ui_file_put (struct ui_file
*src
, ui_file_put_method_ftype
*write
, void *dest
);
74 /* Returns a freshly allocated buffer containing the entire contents
75 of FILE (as determined by ui_file_put()) with a NUL character
76 appended. LENGTH is set to the size of the buffer minus that
78 extern char *ui_file_xstrdup (struct ui_file
*file
, long *length
);
82 extern long ui_file_read (struct ui_file
*file
, char *buf
, long length_buf
);
84 /* Create/open a memory based file. Can be used as a scratch buffer
85 for collecting output. */
86 extern struct ui_file
*mem_fileopen (void);
90 /* Open/create a an STDIO based UI_FILE using the already open FILE. */
91 extern struct ui_file
*stdio_fileopen (FILE *file
);
93 /* Open NAME returning an STDIO based UI_FILE. */
94 extern struct ui_file
*gdb_fopen (char *name
, char *mode
);
96 /* Create a file which writes to both ONE and TWO. CLOSE_ONE
97 and CLOSE_TWO indicate whether the original files should be
98 closed when the new file is closed. */
99 struct ui_file
*tee_file_new (struct ui_file
*one
,
This page took 0.031515 seconds and 4 git commands to generate.