gdb/ui-file.h

   1 /* UI_FILE - a generic STDIO like output stream.
   2    Copyright (C) 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
  24 struct ui_file;
  25
  26 /* Create a generic ui_file object with null methods. */
  27
  28 extern struct ui_file *ui_file_new (void);
  29
  30 /* Override methods used by specific implementations of a UI_FILE
  31    object. */
  32
  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);
  35
  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);
  40
  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);
  43
  44 typedef int (ui_file_isatty_ftype) (struct ui_file * stream);
  45 extern void set_ui_file_isatty (struct ui_file *stream, ui_file_isatty_ftype * isatty);
  46
  47 typedef void (ui_file_rewind_ftype) (struct ui_file * stream);
  48 extern void set_ui_file_rewind (struct ui_file *stream, ui_file_rewind_ftype * rewind);
  49
  50 typedef void (ui_file_put_method_ftype) (void *object, const char *buffer, long length_buffer);
  51 typedef void (ui_file_put_ftype) (struct ui_file *stream, ui_file_put_method_ftype * method, void *context);
  52 extern void set_ui_file_put (struct ui_file *stream, ui_file_put_ftype * put);
  53
  54 typedef void (ui_file_delete_ftype) (struct ui_file * stream);
  55 extern void set_ui_file_data (struct ui_file *stream, void *data, ui_file_delete_ftype * delete);
  56
  57 extern void *ui_file_data (struct ui_file *file);
  58
  59
  60 extern void gdb_flush (struct ui_file *);
  61
  62 extern void ui_file_delete (struct ui_file *stream);
  63
  64 extern void ui_file_rewind (struct ui_file *stream);
  65
  66 extern int ui_file_isatty (struct ui_file *);
  67
  68 extern void ui_file_write (struct ui_file *file, const char *buf, long length_buf);
  69
  70 /* NOTE: copies left to right */
  71 extern void ui_file_put (struct ui_file *src, ui_file_put_method_ftype *write, void *dest);
  72
  73 /* Returns a freshly allocated buffer containing the entire contents
  74    of FILE (as determined by ui_file_put()) with a NUL character
  75    appended.  LENGTH is set to the size of the buffer minus that
  76    appended NUL. */
  77 extern char *ui_file_xstrdup (struct ui_file *file, long *length);
  78
  79
  80
  81 /* Create/open a memory based file. Can be used as a scratch buffer
  82    for collecting output. */
  83 extern struct ui_file *mem_fileopen (void);
  84
  85
  86
  87 /* Open/create a an STDIO based UI_FILE using the already open FILE. */
  88 extern struct ui_file *stdio_fileopen (FILE *file);
  89
  90 /* Open NAME returning an STDIO based UI_FILE. */
  91 extern struct ui_file *gdb_fopen (char *name, char *mode);
  92
  93 #endif