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/>. */
26 /* Create a generic ui_file object with null methods. */
28 extern struct ui_file
*ui_file_new (void);
30 /* Override methods used by specific implementations of a UI_FILE
33 typedef void (ui_file_flush_ftype
) (struct ui_file
* stream
);
34 extern void set_ui_file_flush (struct ui_file
*stream
, ui_file_flush_ftype
* flush
);
36 /* NOTE: Both fputs and write methods are available. Default
37 implementations that mapping one onto the other are included. */
38 typedef void (ui_file_write_ftype
) (struct ui_file
* stream
, const char *buf
, long length_buf
);
39 extern void set_ui_file_write (struct ui_file
*stream
, ui_file_write_ftype
*fputs
);
41 typedef void (ui_file_fputs_ftype
) (const char *, struct ui_file
* stream
);
42 extern void set_ui_file_fputs (struct ui_file
*stream
, ui_file_fputs_ftype
* fputs
);
44 typedef long (ui_file_read_ftype
) (struct ui_file
* stream
, char *buf
, long length_buf
);
45 extern void set_ui_file_read (struct ui_file
*stream
, ui_file_read_ftype
*fread
);
47 typedef int (ui_file_isatty_ftype
) (struct ui_file
* stream
);
48 extern void set_ui_file_isatty (struct ui_file
*stream
, ui_file_isatty_ftype
* isatty
);
50 typedef void (ui_file_rewind_ftype
) (struct ui_file
* stream
);
51 extern void set_ui_file_rewind (struct ui_file
*stream
, ui_file_rewind_ftype
* rewind
);
53 typedef void (ui_file_put_method_ftype
) (void *object
, const char *buffer
, long length_buffer
);
54 typedef void (ui_file_put_ftype
) (struct ui_file
*stream
, ui_file_put_method_ftype
* method
, void *context
);
55 extern void set_ui_file_put (struct ui_file
*stream
, ui_file_put_ftype
* put
);
57 typedef void (ui_file_delete_ftype
) (struct ui_file
* stream
);
58 extern void set_ui_file_data (struct ui_file
*stream
, void *data
, ui_file_delete_ftype
* delete);
60 extern void *ui_file_data (struct ui_file
*file
);
63 extern void gdb_flush (struct ui_file
*);
65 extern void ui_file_delete (struct ui_file
*stream
);
67 extern void ui_file_rewind (struct ui_file
*stream
);
69 extern int ui_file_isatty (struct ui_file
*);
71 extern void ui_file_write (struct ui_file
*file
, const char *buf
, long length_buf
);
73 /* NOTE: copies left to right */
74 extern void ui_file_put (struct ui_file
*src
, ui_file_put_method_ftype
*write
, void *dest
);
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, if not NULL, is set to the size of the buffer
79 minus that appended NUL. */
80 extern char *ui_file_xstrdup (struct ui_file
*file
, long *length
);
82 /* Similar to ui_file_xstrdup, but return a new string allocated on
84 extern char *ui_file_obsavestring (struct ui_file
*file
,
85 struct obstack
*obstack
, long *length
);
87 extern long ui_file_read (struct ui_file
*file
, char *buf
, long length_buf
);
89 /* Create/open a memory based file. Can be used as a scratch buffer
90 for collecting output. */
91 extern struct ui_file
*mem_fileopen (void);
95 /* Open/create a an STDIO based UI_FILE using the already open FILE. */
96 extern struct ui_file
*stdio_fileopen (FILE *file
);
98 /* Open NAME returning an STDIO based UI_FILE. */
99 extern struct ui_file
*gdb_fopen (char *name
, char *mode
);
101 /* Create a file which writes to both ONE and TWO. CLOSE_ONE
102 and CLOSE_TWO indicate whether the original files should be
103 closed when the new file is closed. */
104 struct ui_file
*tee_file_new (struct ui_file
*one
,
This page took 0.032361 seconds and 4 git commands to generate.