gdb/tui/tui.h

   1 /* External/Public TUI Header File.
   2    Copyright 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
   3    Contributed by Hewlett-Packard Company.
   4
   5    This file is part of GDB.
   6
   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 2 of the License, or
  10    (at your option) any later version.
  11
  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.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 59 Temple Place - Suite 330,
  20    Boston, MA 02111-1307, USA.  */
  21
  22 #ifndef TUI_H
  23 #define TUI_H
  24
  25 #include <stdarg.h>
  26 #include <string.h>
  27 #include "ansidecl.h"
  28
  29 #if defined(reg)
  30 #undef reg
  31 #endif
  32 #if defined(chtype)
  33 #undef chtype
  34 #endif
  35
  36 /* Opaque data type */
  37 typedef char *Opaque;
  38 typedef
  39 Opaque (*OpaqueFuncPtr) (va_list);
  40      typedef char **OpaqueList;
  41      typedef OpaqueList OpaquePtr;
  42
  43 /* Generic function pointer */
  44      typedef void (*TuiVoidFuncPtr) (va_list);
  45      typedef int (*TuiIntFuncPtr) (va_list);
  46 /*
  47    typedef Opaque (*TuiOpaqueFuncPtr) (va_list);
  48  */
  49      typedef OpaqueFuncPtr TuiOpaqueFuncPtr;
  50
  51 extern Opaque vcatch_errors (OpaqueFuncPtr, ...);
  52 extern Opaque va_catch_errors (OpaqueFuncPtr, va_list);
  53
  54 extern void strcat_to_buf (char *, int, char *);
  55 extern void strcat_to_buf_with_fmt (char *, int, char *, ...);
  56
  57 /* Types of error returns */
  58      typedef enum
  59        {
  60          TUI_SUCCESS,
  61          TUI_FAILURE
  62        }
  63 TuiStatus, *TuiStatusPtr;
  64
  65 /* Types of windows */
  66      typedef enum
  67        {
  68          SRC_WIN = 0,
  69          DISASSEM_WIN,
  70          DATA_WIN,
  71          CMD_WIN,
  72          /* This must ALWAYS be AFTER the major windows last */
  73          MAX_MAJOR_WINDOWS,
  74          /* auxillary windows */
  75          LOCATOR_WIN,
  76          EXEC_INFO_WIN,
  77          DATA_ITEM_WIN,
  78          /* This must ALWAYS be next to last */
  79          MAX_WINDOWS,
  80          UNDEFINED_WIN          /* LAST */
  81        }
  82 TuiWinType, *TuiWinTypePtr;
  83
  84 /* This is a point definition */
  85      typedef struct _TuiPoint
  86        {
  87          int x, y;
  88        }
  89 TuiPoint, *TuiPointPtr;
  90
  91 /* GENERAL TUI FUNCTIONS */
  92 /* tui.c */
  93 extern void tuiFree (char *);
  94 extern CORE_ADDR tuiGetLowDisassemblyAddress (CORE_ADDR, CORE_ADDR);
  95 extern void tui_show_assembly (CORE_ADDR addr);
  96 extern int tui_is_window_visible (TuiWinType type);
  97 extern int tui_get_command_dimension (int *width, int *height);
  98
  99 /* Initialize readline and configure the keymap for the switching
 100    key shortcut.  */
 101 extern void tui_initialize_readline (void);
 102
 103 /* Enter in the tui mode (curses).  */
 104 extern void tui_enable (void);
 105
 106 /* Leave the tui mode.  */
 107 extern void tui_disable (void);
 108
 109 extern void tui_initialize_io (void);
 110
 111 extern void tui_initialize_readline (void);
 112
 113 extern int tui_active;
 114
 115 extern void tui_install_hooks (void);
 116 extern void tui_remove_hooks (void);
 117
 118 extern void tui_show_source (const char *file, int line);
 119
 120 extern struct ui_out *tui_out_new (struct ui_file *stream);
 121
 122 /* tuiDataWin.c */
 123 extern void tui_vCheckDataValues (va_list);
 124
 125 /* tuiIO.c */
 126 extern void tui_vStartNewLines (va_list);
 127
 128 /* tuiLayout.c */
 129 extern TuiStatus tui_set_layout (const char *);
 130
 131 /* tuiSourceWin.c */
 132 extern void tuiDisplayMainFunction (void);
 133 extern void tuiUpdateAllExecInfos (void);
 134 extern void tuiUpdateOnEnd (void);
 135 extern void tui_vAllSetHasBreakAt (va_list);
 136 extern void tui_vUpdateSourceWindowsWithAddr (va_list);
 137
 138 /* tuiStack.c */
 139 extern void tui_vShowFrameInfo (va_list);
 140 extern void tui_vUpdateLocatorFilename (va_list);
 141 #endif /* TUI_H */