1 /* UI_FILE - a generic STDIO like output stream.
2 Copyright (C) 1999, 2000, 2007, 2008, 2009, 2010
3 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/>. */
25 /* Create a generic ui_file object with null methods. */
27 extern struct ui_file
*ui_file_new (void);
29 /* Override methods used by specific implementations of a UI_FILE
32 typedef void (ui_file_flush_ftype
) (struct ui_file
* stream
);
33 extern void set_ui_file_flush (struct ui_file
*stream
, ui_file_flush_ftype
* flush
);
35 /* NOTE: Both fputs and write methods are available. Default
36 implementations that mapping one onto the other are included. */
37 typedef void (ui_file_write_ftype
) (struct ui_file
* stream
, const char *buf
, long length_buf
);
38 extern void set_ui_file_write (struct ui_file
*stream
, ui_file_write_ftype
*fputs
);
40 typedef void (ui_file_fputs_ftype
) (const char *, struct ui_file
* stream
);
41 extern void set_ui_file_fputs (struct ui_file
*stream
, ui_file_fputs_ftype
* fputs
);
43 typedef long (ui_file_read_ftype
) (struct ui_file
* stream
, char *buf
, long length_buf
);
44 extern void set_ui_file_read (struct ui_file
*stream
, ui_file_read_ftype
*fread
);
46 typedef int (ui_file_isatty_ftype
) (struct ui_file
* stream
);
47 extern void set_ui_file_isatty (struct ui_file
*stream
, ui_file_isatty_ftype
* isatty
);
49 typedef void (ui_file_rewind_ftype
) (struct ui_file
* stream
);
50 extern void set_ui_file_rewind (struct ui_file
*stream
, ui_file_rewind_ftype
* rewind
);
52 typedef void (ui_file_put_method_ftype
) (void *object
, const char *buffer
, long length_buffer
);
53 typedef void (ui_file_put_ftype
) (struct ui_file
*stream
, ui_file_put_method_ftype
* method
, void *context
);
54 extern void set_ui_file_put (struct ui_file
*stream
, ui_file_put_ftype
* put
);
56 typedef void (ui_file_delete_ftype
) (struct ui_file
* stream
);
57 extern void set_ui_file_data (struct ui_file
*stream
, void *data
, ui_file_delete_ftype
* delete);
59 extern void *ui_file_data (struct ui_file
*file
);
62 extern void gdb_flush (struct ui_file
*);
64 extern void ui_file_delete (struct ui_file
*stream
);
66 extern void ui_file_rewind (struct ui_file
*stream
);
68 extern int ui_file_isatty (struct ui_file
*);
70 extern void ui_file_write (struct ui_file
*file
, const char *buf
, long length_buf
);
72 /* NOTE: copies left to right */
73 extern void ui_file_put (struct ui_file
*src
, ui_file_put_method_ftype
*write
, void *dest
);
75 /* Returns a freshly allocated buffer containing the entire contents
76 of FILE (as determined by ui_file_put()) with a NUL character
77 appended. LENGTH, if not NULL, is set to the size of the buffer
78 minus that appended NUL. */
79 extern char *ui_file_xstrdup (struct ui_file
*file
, long *length
);
83 extern long ui_file_read (struct ui_file
*file
, char *buf
, long length_buf
);
85 /* Create/open a memory based file. Can be used as a scratch buffer
86 for collecting output. */
87 extern struct ui_file
*mem_fileopen (void);
91 /* Open/create a an STDIO based UI_FILE using the already open FILE. */
92 extern struct ui_file
*stdio_fileopen (FILE *file
);
94 /* Open NAME returning an STDIO based UI_FILE. */
95 extern struct ui_file
*gdb_fopen (char *name
, char *mode
);
97 /* Create a file which writes to both ONE and TWO. CLOSE_ONE
98 and CLOSE_TWO indicate whether the original files should be
99 closed when the new file is closed. */
100 struct ui_file
*tee_file_new (struct ui_file
*one
,
This page took 0.032029 seconds and 4 git commands to generate.