include/callback.h

   1 /* Remote target system call callback support.
   2    Copyright 1997 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, Boston, MA 02111-1307, USA.  */
  19
  20 #ifndef CALLBACK_H
  21 #define CALLBACK_H
  22
  23 #ifndef va_start
  24 #include <ansidecl.h>
  25 #ifdef ANSI_PROTOTYPES
  26 #include <stdarg.h>
  27 #else
  28 #include <varargs.h>
  29 #endif
  30 #endif
  31
  32 typedef struct host_callback_struct host_callback;
  33
  34 #define MAX_CALLBACK_FDS 10
  35
  36 struct host_callback_struct
  37 {
  38   int (*close) PARAMS ((host_callback *,int));
  39   int (*get_errno) PARAMS ((host_callback *));
  40   int (*isatty) PARAMS ((host_callback *, int));
  41   int (*lseek) PARAMS ((host_callback *, int, long , int));
  42   int (*open) PARAMS ((host_callback *, const char*, int mode));
  43   int (*read) PARAMS ((host_callback *,int,  char *, int));
  44   int (*read_stdin) PARAMS (( host_callback *, char *, int));
  45   int (*rename) PARAMS ((host_callback *, const char *, const char *));
  46   int (*system) PARAMS ((host_callback *, const char *));
  47   long (*time) PARAMS ((host_callback *, long *));
  48   int (*unlink) PARAMS ((host_callback *, const char *));
  49   int (*write) PARAMS ((host_callback *,int, const char *, int));
  50   int (*write_stdout) PARAMS ((host_callback *, const char *, int));
  51   void (*flush_stdout) PARAMS ((host_callback *));
  52   int (*write_stderr) PARAMS ((host_callback *, const char *, int));
  53   void (*flush_stderr) PARAMS ((host_callback *));
  54
  55   /* When present, call to the client to give it the oportunity to
  56      poll any io devices for a request to quit (indicated by a nonzero
  57      return value). */
  58   int (*poll_quit) PARAMS ((host_callback *));
  59
  60   /* Used when the target has gone away, so we can close open
  61      handles and free memory etc etc.  */
  62   int (*shutdown) PARAMS ((host_callback *));
  63   int (*init)     PARAMS ((host_callback *));
  64
  65   /* depreciated, use vprintf_filtered - Talk to the user on a console.  */
  66   void (*printf_filtered) PARAMS ((host_callback *, const char *, ...));
  67
  68   /* Talk to the user on a console.  */
  69   void (*vprintf_filtered) PARAMS ((host_callback *, const char *, va_list));
  70
  71   /* Same as vprintf_filtered but to stderr.  */
  72   void (*evprintf_filtered) PARAMS ((host_callback *, const char *, va_list));
  73
  74   /* Print an error message and "exit".
  75      In the case of gdb "exiting" means doing a longjmp back to the main
  76      command loop.  */
  77   void (*error) PARAMS ((host_callback *, const char *, ...));
  78
  79   int last_errno;               /* host format */
  80
  81   int fdmap[MAX_CALLBACK_FDS];
  82   char fdopen[MAX_CALLBACK_FDS];
  83   char alwaysopen[MAX_CALLBACK_FDS];
  84
  85   /* Marker for thse wanting to do sanity checks.
  86      This should remain the last memeber of this struct to help catch
  87      miscompilation errors. */
  88 #define HOST_CALLBACK_MAGIC 4705 /* teds constant */
  89   int magic;
  90 };
  91
  92 extern host_callback default_callback;
  93
  94 /* Mapping of host/target values.  */
  95 /* ??? For debugging purposes, one might want to add a string of the
  96    name of the symbol.  */
  97
  98 typedef struct {
  99   int host_val;
 100   int target_val;
 101 } target_defs_map;
 102
 103 extern target_defs_map errno_map[];
 104 extern target_defs_map open_map[];
 105
 106 extern int host_to_target_errno PARAMS ((int));
 107 extern int target_to_host_open PARAMS ((int));
 108
 109 /* Cover functions to the vprintf callbacks.  */
 110 extern void cb_printf PARAMS ((host_callback *, const char *, ...));
 111 extern void cb_eprintf PARAMS ((host_callback *, const char *, ...));
 112
 113 #endif