include/wincurs.h

   1 /* NetHack 3.6 wincurs.h */
   2 /* Copyright (c) Karl Garrison, 2010. */
   3 /* NetHack may be freely redistributed.  See license for details. */
   4
   5 #ifndef WINCURS_H
   6 #define WINCURS_H
   7
   8 /* Global declarations for curses interface */
   9
  10 extern int term_rows, term_cols;   /* size of underlying terminal   */
  11 extern int orig_cursor;            /* Preserve initial cursor state */
  12 extern WINDOW *base_term;          /* underlying terminal window    */
  13 extern boolean counting;           /* Count window is active        */
  14 extern WINDOW *mapwin, *statuswin, *messagewin;    /* Main windows  */
  15
  16 #define TEXTCOLOR   /* Allow color */
  17 #define NHW_END 19
  18 #define OFF 0
  19 #define ON 1
  20 #define NONE -1
  21 #define KEY_ESC 0x1b
  22 #define DIALOG_BORDER_COLOR CLR_MAGENTA
  23 #define ALERT_BORDER_COLOR CLR_RED
  24 #define SCROLLBAR_COLOR CLR_MAGENTA
  25 #define SCROLLBAR_BACK_COLOR CLR_BLACK
  26 #define HIGHLIGHT_COLOR CLR_WHITE
  27 #define MORECOLOR CLR_ORANGE
  28 #define STAT_UP_COLOR CLR_GREEN
  29 #define STAT_DOWN_COLOR CLR_RED
  30 #define MESSAGE_WIN 1
  31 #define STATUS_WIN  2
  32 #define MAP_WIN     3
  33 #define INV_WIN     4
  34 #define NHWIN_MAX   5
  35 #define MESG_HISTORY_MAX   200
  36 #if !defined(__APPLE__) || !defined(NCURSES_VERSION)
  37 # define USE_DARKGRAY /* Allow "bright" black; delete if not visible */
  38 #endif  /* !__APPLE__ && !PDCURSES */
  39 #define CURSES_DARK_GRAY    17
  40 #define MAP_SCROLLBARS
  41 #ifdef PDCURSES
  42 # define getmouse nc_getmouse
  43 # ifndef NCURSES_MOUSE_VERSION
  44 #  define NCURSES_MOUSE_VERSION
  45 # endif
  46 #endif
  47
  48 #if !defined(A_LEFTLINE) && defined(A_LEFT)
  49 #define A_LEFTLINE A_LEFT
  50 #endif
  51 #if !defined(A_RIGHTLINE) && defined(A_RIGHT)
  52 #define A_RIGHTLINE A_RIGHT
  53 #endif
  54
  55 typedef enum orient_type
  56 {
  57     CENTER,
  58     UP,
  59     DOWN,
  60     RIGHT,
  61     LEFT,
  62     UNDEFINED
  63 } orient;
  64
  65 #ifdef GCC_WARN
  66 int wprintw(WINDOW *, const char *, ...) PRINTF_F(2, 3);
  67 int mvwprintw(WINDOW *, int, int, const char *, ...) PRINTF_F(4, 5);
  68 #endif
  69
  70 /* cursmain.c */
  71
  72 extern struct window_procs curses_procs;
  73
  74 extern void curses_init_nhwindows(int* argcp, char** argv);
  75 extern void curses_player_selection(void);
  76 extern void curses_askname(void);
  77 extern void curses_get_nh_event(void);
  78 extern void curses_exit_nhwindows(const char *str);
  79 extern void curses_suspend_nhwindows(const char *str);
  80 extern void curses_resume_nhwindows(void);
  81 extern winid curses_create_nhwindow(int type);
  82 extern void curses_clear_nhwindow(winid wid);
  83 extern void curses_display_nhwindow(winid wid, BOOLEAN_P block);
  84 extern void curses_destroy_nhwindow(winid wid);
  85 extern void curses_curs(winid wid, int x, int y);
  86 extern void curses_putstr(winid wid, int attr, const char *text);
  87 extern void curses_display_file(const char *filename, BOOLEAN_P must_exist);
  88 extern void curses_start_menu(winid wid);
  89 extern void curses_add_menu(winid wid, int glyph, const ANY_P * identifier,
  90                             CHAR_P accelerator, CHAR_P group_accel, int attr,
  91                             const char *str, BOOLEAN_P presel);
  92 extern void curses_end_menu(winid wid, const char *prompt);
  93 extern int curses_select_menu(winid wid, int how, MENU_ITEM_P **selected);
  94 extern void curses_update_inventory(void);
  95 extern void curses_mark_synch(void);
  96 extern void curses_wait_synch(void);
  97 extern void curses_cliparound(int x, int y);
  98 extern void curses_print_glyph(winid wid, XCHAR_P x, XCHAR_P y,
  99                                int glyph, int bkglyph);
 100 extern void curses_raw_print(const char *str);
 101 extern void curses_raw_print_bold(const char *str);
 102 extern int curses_nhgetch(void);
 103 extern int curses_nh_poskey(int *x, int *y, int *mod);
 104 extern void curses_nhbell(void);
 105 extern int curses_doprev_message(void);
 106 extern char curses_yn_function(const char *question, const char *choices,
 107                                CHAR_P def);
 108 extern void curses_getlin(const char *question, char *input);
 109 extern int curses_get_ext_cmd(void);
 110 extern void curses_number_pad(int state);
 111 extern void curses_delay_output(void);
 112 extern void curses_start_screen(void);
 113 extern void curses_end_screen(void);
 114 extern void curses_outrip(winid wid, int how);
 115 extern void genl_outrip(winid tmpwin, int how, time_t when);
 116 extern void curses_preference_update(const char *pref);
 117 extern void curs_reset_windows(boolean, boolean);
 118
 119 /* curswins.c */
 120
 121 extern WINDOW *curses_create_window(int width, int height, orient orientation);
 122 extern void curses_destroy_win(WINDOW *win);
 123 extern WINDOW *curses_get_nhwin(winid wid);
 124 extern void curses_add_nhwin(winid wid, int height, int width, int y,
 125                              int x, orient orientation, boolean border);
 126 extern void curses_add_wid(winid wid);
 127 extern void curses_refresh_nhwin(winid wid);
 128 extern void curses_refresh_nethack_windows(void);
 129 extern void curses_del_nhwin(winid wid);
 130 extern void curses_del_wid(winid wid);
 131 extern void curs_destroy_all_wins(void);
 132 extern void curses_putch(winid wid, int x, int y, int ch,
 133                          int color, int attrs);
 134 extern void curses_get_window_size(winid wid, int *height, int *width);
 135 extern boolean curses_window_has_border(winid wid);
 136 extern boolean curses_window_exists(winid wid);
 137 extern int curses_get_window_orientation(winid wid);
 138 extern void curses_get_window_xy(winid wid, int *x, int *y);
 139 extern void curses_puts(winid wid, int attr, const char *text);
 140 extern void curses_clear_nhwin(winid wid);
 141 extern void curses_alert_win_border(winid wid, boolean onoff);
 142 extern void curses_alert_main_borders(boolean onoff);
 143 extern void curses_draw_map(int sx, int sy, int ex, int ey);
 144 extern boolean curses_map_borders(int *sx, int *sy, int *ex, int *ey,
 145                                   int ux, int uy);
 146
 147 /* cursmisc.c */
 148
 149 extern int curses_read_char(void);
 150 extern void curses_toggle_color_attr(WINDOW *win, int color, int attr,
 151                                      int onoff);
 152 extern void curses_bail(const char *mesg);
 153 extern winid curses_get_wid(int type);
 154 extern char *curses_copy_of(const char *s);
 155 extern int curses_num_lines(const char *str, int width);
 156 extern char *curses_break_str(const char *str, int width, int line_num);
 157 extern char *curses_str_remainder(const char *str, int width, int line_num);
 158 extern boolean curses_is_menu(winid wid);
 159 extern boolean curses_is_text(winid wid);
 160 extern int curses_convert_glyph(int ch, int glyph);
 161 extern void curses_move_cursor(winid wid, int x, int y);
 162 extern void curses_prehousekeeping(void);
 163 extern void curses_posthousekeeping(void);
 164 extern void curses_view_file(const char *filename, boolean must_exist);
 165 extern void curses_rtrim(char *str);
 166 extern int curses_get_count(int first_digit);
 167 extern int curses_convert_attr(int attr);
 168 extern int curses_read_attrs(const char *attrs);
 169 extern char *curses_fmt_attrs(char *);
 170 extern int curses_convert_keys(int key);
 171 extern int curses_get_mouse(int *mousex, int *mousey, int *mod);
 172
 173 /* cursdial.c */
 174
 175 extern void curses_line_input_dialog(const char *prompt,
 176                                      char *answer, int buffer);
 177 extern int curses_character_input_dialog(const char *prompt,
 178                                          const char *choices, CHAR_P def);
 179 extern int curses_ext_cmd(void);
 180 extern void curses_create_nhmenu(winid wid);
 181 extern void curses_add_nhmenu_item(winid wid, int glyph,
 182                                    const ANY_P *identifier, CHAR_P accelerator,
 183                                    CHAR_P group_accel, int attr,
 184                                    const char *str, BOOLEAN_P presel);
 185 extern void curs_menu_set_bottom_heavy(winid);
 186 extern void curses_finalize_nhmenu(winid wid, const char *prompt);
 187 extern int curses_display_nhmenu(winid wid, int how, MENU_ITEM_P **_selected);
 188 extern boolean curses_menu_exists(winid wid);
 189 extern void curses_del_menu(winid, boolean);
 190
 191 /* cursstat.c */
 192
 193 extern void curses_status_init(void);
 194 extern void curses_status_finish(void);
 195 extern void curses_status_update(int, genericptr_t, int, int, int,
 196                                  unsigned long *);
 197
 198 /* cursinvt.c */
 199
 200 extern void curses_update_inv(void);
 201 extern void curses_add_inv(int, int, CHAR_P, attr_t, const char *);
 202
 203 /* cursinit.c */
 204
 205 extern void curses_create_main_windows(void);
 206 extern void curses_init_nhcolors(void);
 207 extern void curses_choose_character(void);
 208 extern int curses_character_dialog(const char **choices, const char *prompt);
 209 extern void curses_init_options(void);
 210 extern void curses_display_splash_window(void);
 211 extern void curses_cleanup(void);
 212
 213 /* cursmesg.c */
 214
 215 extern void curses_message_win_puts(const char *message, boolean recursed);
 216 extern void curses_got_input(void);
 217 extern int curses_block(boolean require_tab); /* for MSGTYPE=STOP */
 218 extern int curses_more(void);
 219 extern void curses_clear_unhighlight_message_window(void);
 220 extern void curses_message_win_getline(const char *prompt,
 221                                        char *answer, int buffer);
 222 extern void curses_last_messages(void);
 223 extern void curses_init_mesg_history(void);
 224 extern void curses_teardown_messages(void);
 225 extern void curses_prev_mesg(void);
 226 extern void curses_count_window(const char *count_text);
 227 char *curses_getmsghistory(BOOLEAN_P);
 228 void curses_putmsghistory(const char *, BOOLEAN_P);
 229
 230 #endif  /* WINCURS_H */
 231