Subversion Repositories or1k

/* External/Public TUI Header File.

   Copyright 1998, 1999, 2000, 2001 Free Software Foundation, Inc.

   Contributed by Hewlett-Packard Company.

   This file is part of GDB.

   This program is free software; you can redistribute it and/or modify

   it under the terms of the GNU General Public License as published by

   the Free Software Foundation; either version 2 of the License, or

   (at your option) any later version.

   This program is distributed in the hope that it will be useful,

   but WITHOUT ANY WARRANTY; without even the implied warranty of

   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License

   along with this program; if not, write to the Free Software

   Foundation, Inc., 59 Temple Place - Suite 330,

   Boston, MA 02111-1307, USA.  */

#ifndef TUI_H

#define TUI_H

#include <stdarg.h>

#include <string.h>

#include "ansidecl.h"

#if defined(reg)

#undef reg

#endif

#if defined(chtype)

#undef chtype

#endif

/* Opaque data type */

typedef char *Opaque;

typedef

Opaque (*OpaqueFuncPtr) (va_list);

     typedef char **OpaqueList;

     typedef OpaqueList OpaquePtr;

/* Generic function pointer */

     typedef void (*TuiVoidFuncPtr) (va_list);

     typedef int (*TuiIntFuncPtr) (va_list);

/*

   typedef Opaque (*TuiOpaqueFuncPtr) (va_list);

 */

     typedef OpaqueFuncPtr TuiOpaqueFuncPtr;

extern void strcat_to_buf (char *, int, const char *);

/* Types of error returns */

     typedef enum

       {

         TUI_SUCCESS,

         TUI_FAILURE

       }

TuiStatus, *TuiStatusPtr;

/* Types of windows */

     typedef enum

       {

         SRC_WIN = 0,

         DISASSEM_WIN,

         DATA_WIN,

         CMD_WIN,

         /* This must ALWAYS be AFTER the major windows last */

         MAX_MAJOR_WINDOWS,

         /* auxillary windows */

         LOCATOR_WIN,

         EXEC_INFO_WIN,

         DATA_ITEM_WIN,

         /* This must ALWAYS be next to last */

         MAX_WINDOWS,

         UNDEFINED_WIN          /* LAST */

       }

TuiWinType, *TuiWinTypePtr;

/* This is a point definition */

     typedef struct _TuiPoint

       {

         int x, y;

       }

TuiPoint, *TuiPointPtr;

/* GENERAL TUI FUNCTIONS */

/* tui.c */

extern void tuiFree (char *);

extern CORE_ADDR tuiGetLowDisassemblyAddress (CORE_ADDR, CORE_ADDR);

extern void tui_show_assembly (CORE_ADDR addr);

extern int tui_is_window_visible (TuiWinType type);

extern int tui_get_command_dimension (int *width, int *height);

/* Initialize readline and configure the keymap for the switching

   key shortcut.  */

extern void tui_initialize_readline (void);

/* Enter in the tui mode (curses).  */

extern void tui_enable (void);

/* Leave the tui mode.  */

extern void tui_disable (void);

enum tui_key_mode

{

  /* Plain command mode to enter gdb commands.  */

  tui_command_mode,

  /* SingleKey mode with some keys bound to gdb commands.  */

  tui_single_key_mode,

  /* Read/edit one command and return to SingleKey after it's processed.  */

  tui_one_command_mode

};

extern enum tui_key_mode tui_current_key_mode;

/* Change the TUI key mode by installing the appropriate readline keymap.  */

extern void tui_set_key_mode (enum tui_key_mode mode);

extern void tui_initialize_io (void);

extern void tui_initialize_readline (void);

extern int tui_active;

extern void tui_install_hooks (void);

extern void tui_remove_hooks (void);

extern void tui_show_source (const char *file, int line);

extern struct ui_out *tui_out_new (struct ui_file *stream);

/* tuiLayout.c */

extern TuiStatus tui_set_layout (const char *);

/* tuiSourceWin.c */

extern void tuiUpdateAllExecInfos (void);

#endif /* TUI_H */