include/wintty.h

   1 /* NetHack 3.6  wintty.h        $NHDT-Date: 1558330405 2019/05/20 05:33:25 $  $NHDT-Branch: NetHack-3.6 $:$NHDT-Revision: 1.34 $ */
   2 /* Copyright (c) David Cohrs, 1991,1992                           */
   3 /* NetHack may be freely redistributed.  See license for details. */
   4
   5 #ifndef WINTTY_H
   6 #define WINTTY_H
   7
   8 #define E extern
   9
  10 #ifndef WINDOW_STRUCTS
  11 #define WINDOW_STRUCTS
  12
  13 /* menu structure */
  14 typedef struct tty_mi {
  15     struct tty_mi *next;
  16     anything identifier; /* user identifier */
  17     long count;          /* user count */
  18     char *str;           /* description string (including accelerator) */
  19     int attr;            /* string attribute */
  20     boolean selected;    /* TRUE if selected by user */
  21     char selector;       /* keyboard accelerator */
  22     char gselector;      /* group accelerator */
  23 } tty_menu_item;
  24
  25 /* descriptor for tty-based windows */
  26 struct WinDesc {
  27     int flags;           /* window flags */
  28     xchar type;          /* type of window */
  29     boolean active;      /* true if window is active */
  30     short offx, offy;    /* offset from topleft of display */
  31     long rows, cols;     /* dimensions */
  32     long curx, cury;     /* current cursor position */
  33     long maxrow, maxcol; /* the maximum size used -- for MENU wins */
  34     /* maxcol is also used by WIN_MESSAGE for */
  35     /* tracking the ^P command */
  36     short *datlen;         /* allocation size for *data */
  37     char **data;           /* window data [row][column] */
  38     char *morestr;         /* string to display instead of default */
  39     tty_menu_item *mlist;  /* menu information (MENU) */
  40     tty_menu_item **plist; /* menu page pointers (MENU) */
  41     long plist_size;       /* size of allocated plist (MENU) */
  42     long npages;           /* number of pages in menu (MENU) */
  43     long nitems;           /* total number of items (MENU) */
  44     short how;             /* menu mode - pick 1 or N (MENU) */
  45     char menu_ch;          /* menu char (MENU) */
  46 };
  47
  48 /* window flags */
  49 #define WIN_CANCELLED 1
  50 #define WIN_STOP 1        /* for NHW_MESSAGE; stops output */
  51 #define WIN_LOCKHISTORY 2 /* for NHW_MESSAGE; suppress history updates */
  52
  53 /* descriptor for tty-based displays -- all the per-display data */
  54 struct DisplayDesc {
  55     short rows, cols; /* width and height of tty display */
  56     short curx, cury; /* current cursor position on the screen */
  57 #ifdef TEXTCOLOR
  58     int color; /* current color */
  59 #endif
  60     int attrs;         /* attributes in effect */
  61     int toplin;        /* flag for topl stuff */
  62     int rawprint;      /* number of raw_printed lines since synch */
  63     int inmore;        /* non-zero if more() is active */
  64     int inread;        /* non-zero if reading a character */
  65     int intr;          /* non-zero if inread was interrupted */
  66     winid lastwin;     /* last window used for I/O */
  67     char dismiss_more; /* extra character accepted at --More-- */
  68 };
  69
  70 #endif /* WINDOW_STRUCTS */
  71
  72 #ifdef STATUS_HILITES
  73 struct tty_status_fields {
  74     int idx;
  75     int color;
  76     int attr;
  77     int x, y;
  78     size_t lth;
  79     boolean valid;
  80     boolean dirty;
  81     boolean redraw;
  82     boolean sanitycheck; /* was 'last_in_row' */
  83 };
  84 #endif
  85
  86 #define MAXWIN 20 /* maximum number of windows, cop-out */
  87
  88 /* tty dependent window types */
  89 #ifdef NHW_BASE
  90 #undef NHW_BASE
  91 #endif
  92 #define NHW_BASE 6
  93
  94 extern struct window_procs tty_procs;
  95
  96 /* port specific variable declarations */
  97 extern winid BASE_WINDOW;
  98
  99 extern struct WinDesc *wins[MAXWIN];
 100
 101 extern struct DisplayDesc *ttyDisplay; /* the tty display descriptor */
 102
 103 extern char morc;         /* last character typed to xwaitforspace */
 104 extern char defmorestr[]; /* default --more-- prompt */
 105
 106 /* port specific external function references */
 107
 108 /* ### getline.c ### */
 109 E void FDECL(xwaitforspace, (const char *));
 110
 111 /* ### termcap.c, video.c ### */
 112
 113 E void FDECL(tty_startup, (int *, int *));
 114 #ifndef NO_TERMS
 115 E void NDECL(tty_shutdown);
 116 #endif
 117 E int FDECL(xputc, (int));
 118 # if 1 /*JP*/
 119 E void FDECL(xputc2, (int, int));
 120 # endif
 121 E void FDECL(xputs, (const char *));
 122 #if defined(SCREEN_VGA) || defined(SCREEN_8514)
 123 E void FDECL(xputg, (int, int, unsigned));
 124 #endif
 125 E void NDECL(cl_end);
 126 E void NDECL(clear_screen);
 127 E void NDECL(home);
 128 E void NDECL(standoutbeg);
 129 E void NDECL(standoutend);
 130 #if 0
 131 E void NDECL(revbeg);
 132 E void NDECL(boldbeg);
 133 E void NDECL(blinkbeg);
 134 E void NDECL(dimbeg);
 135 E void NDECL(m_end);
 136 #endif
 137 E void NDECL(backsp);
 138 E void NDECL(graph_on);
 139 E void NDECL(graph_off);
 140 E void NDECL(cl_eos);
 141
 142 /*
 143  * termcap.c (or facsimiles in other ports) is the right place for doing
 144  * strange and arcane things such as outputting escape sequences to select
 145  * a color or whatever.  wintty.c should concern itself with WHERE to put
 146  * stuff in a window.
 147  */
 148 E int FDECL(term_attr_fixup, (int));
 149 E void FDECL(term_start_attr, (int attr));
 150 E void FDECL(term_end_attr, (int attr));
 151 E void NDECL(term_start_raw_bold);
 152 E void NDECL(term_end_raw_bold);
 153
 154 #ifdef TEXTCOLOR
 155 E void NDECL(term_end_color);
 156 E void FDECL(term_start_color, (int color));
 157 E int FDECL(has_color, (int color));
 158 #endif /* TEXTCOLOR */
 159
 160 /* ### topl.c ### */
 161
 162 E void FDECL(show_topl, (const char *));
 163 E void NDECL(remember_topl);
 164 E void FDECL(addtopl, (const char *));
 165 E void NDECL(more);
 166 E void FDECL(update_topl, (const char *));
 167 E void FDECL(putsyms, (const char *));
 168 #if 1 /*JP*/
 169 E void FDECL(raw_putsyms, (const char*));
 170 #endif
 171
 172 /* ### wintty.c ### */
 173 #ifdef CLIPPING
 174 E void NDECL(setclipped);
 175 #endif
 176 E void FDECL(docorner, (int, int));
 177 E void NDECL(end_glyphout);
 178 E void FDECL(g_putch, (int));
 179 E void FDECL(win_tty_init, (int));
 180
 181 /* external declarations */
 182 E void FDECL(tty_init_nhwindows, (int *, char **));
 183 E void FDECL(tty_preference_update, (const char *));
 184 E void NDECL(tty_player_selection);
 185 E void NDECL(tty_askname);
 186 E void NDECL(tty_get_nh_event);
 187 E void FDECL(tty_exit_nhwindows, (const char *));
 188 E void FDECL(tty_suspend_nhwindows, (const char *));
 189 E void NDECL(tty_resume_nhwindows);
 190 E winid FDECL(tty_create_nhwindow, (int));
 191 E void FDECL(tty_clear_nhwindow, (winid));
 192 E void FDECL(tty_display_nhwindow, (winid, BOOLEAN_P));
 193 E void FDECL(tty_dismiss_nhwindow, (winid));
 194 E void FDECL(tty_destroy_nhwindow, (winid));
 195 E void FDECL(tty_curs, (winid, int, int));
 196 E void FDECL(tty_putstr, (winid, int, const char *));
 197 E void FDECL(tty_display_file, (const char *, BOOLEAN_P));
 198 E void FDECL(tty_start_menu, (winid));
 199 E void FDECL(tty_add_menu, (winid, int, const ANY_P *, CHAR_P, CHAR_P, int,
 200                             const char *, BOOLEAN_P));
 201 E void FDECL(tty_end_menu, (winid, const char *));
 202 E int FDECL(tty_select_menu, (winid, int, MENU_ITEM_P **));
 203 E char FDECL(tty_message_menu, (CHAR_P, int, const char *));
 204 E void NDECL(tty_update_inventory);
 205 E void NDECL(tty_mark_synch);
 206 E void NDECL(tty_wait_synch);
 207 #ifdef CLIPPING
 208 E void FDECL(tty_cliparound, (int, int));
 209 #endif
 210 #ifdef POSITIONBAR
 211 E void FDECL(tty_update_positionbar, (char *));
 212 #endif
 213 E void FDECL(tty_print_glyph, (winid, XCHAR_P, XCHAR_P, int, int));
 214 E void FDECL(tty_raw_print, (const char *));
 215 E void FDECL(tty_raw_print_bold, (const char *));
 216 E int NDECL(tty_nhgetch);
 217 E int FDECL(tty_nh_poskey, (int *, int *, int *));
 218 E void NDECL(tty_nhbell);
 219 E int NDECL(tty_doprev_message);
 220 E char FDECL(tty_yn_function, (const char *, const char *, CHAR_P));
 221 E void FDECL(tty_getlin, (const char *, char *));
 222 E int NDECL(tty_get_ext_cmd);
 223 E void FDECL(tty_number_pad, (int));
 224 E void NDECL(tty_delay_output);
 225 #ifdef CHANGE_COLOR
 226 E void FDECL(tty_change_color, (int color, long rgb, int reverse));
 227 #ifdef MAC
 228 E void FDECL(tty_change_background, (int white_or_black));
 229 E short FDECL(set_tty_font_name, (winid, char *));
 230 #endif
 231 E char *NDECL(tty_get_color_string);
 232 #endif
 233 E void FDECL(tty_status_enablefield,
 234              (int, const char *, const char *, BOOLEAN_P));
 235 E void NDECL(tty_status_init);
 236 E void FDECL(tty_status_update, (int, genericptr_t, int, int, int, unsigned long *));
 237
 238 /* other defs that really should go away (they're tty specific) */
 239 E void NDECL(tty_start_screen);
 240 E void NDECL(tty_end_screen);
 241
 242 E void FDECL(genl_outrip, (winid, int, time_t));
 243
 244 E char *FDECL(tty_getmsghistory, (BOOLEAN_P));
 245 E void FDECL(tty_putmsghistory, (const char *, BOOLEAN_P));
 246
 247 #ifdef NO_TERMS
 248 #ifdef MAC
 249 #ifdef putchar
 250 #undef putchar
 251 #undef putc
 252 #endif
 253 #define putchar term_putc
 254 #define fflush term_flush
 255 #define puts term_puts
 256 E int FDECL(term_putc, (int c));
 257 E int FDECL(term_flush, (void *desc));
 258 E int FDECL(term_puts, (const char *str));
 259 #endif /* MAC */
 260 #if defined(MSDOS) || defined(WIN32)
 261 #if defined(SCREEN_BIOS) || defined(SCREEN_DJGPPFAST) || defined(WIN32)
 262 #undef putchar
 263 #undef putc
 264 #undef puts
 265 #define putchar(x) xputc(x) /* these are in video.c, nttty.c */
 266 #define putc(x) xputc(x)
 267 #define puts(x) xputs(x)
 268 #endif /*SCREEN_BIOS || SCREEN_DJGPPFAST || WIN32 */
 269 #ifdef POSITIONBAR
 270 E void FDECL(video_update_positionbar, (char *));
 271 #endif
 272 #endif /*MSDOS*/
 273 #endif /*NO_TERMS*/
 274
 275 #undef E
 276
 277 #endif /* WINTTY_H */