console/ncurses.c

   1 /* ncurses.c */
   2 /* Copyright 1999 - Joseph Pranevich */
   3
   4 #include <stdio.h>
   5 #include "config.h"
   6 #include "console.h"    /* Must define WINE_NCURSES */
   7
   8 #ifdef WINE_NCURSES
   9
  10 /* This is the console driver for systems that support the ncurses
  11    interface.
  12 */
  13
  14 /* Actually, this should work for curses, as well. But there may be
  15    individual functions that are unsupported in plain curses or other
  16    variants. Those should be detected and special-cased by autoconf.
  17 */
  18
  19 /* When creating new drivers, you need to assign all the functions that
  20    that driver supports into the driver struct. If it is a supplementary
  21    driver, it should make sure to perserve the old values.
  22 */
  23
  24 #include "debug.h"
  25 #include "options.h"
  26
  27 #undef ERR /* Use ncurses's err() */
  28 #ifdef HAVE_NCURSES_H
  29 # include <ncurses.h>
  30 #else
  31 # ifdef HAVE_CURSES_H
  32 #  include <curses.h>
  33 # endif
  34 #endif
  35
  36 SCREEN *ncurses_screen;
  37
  38 static int get_color_pair(int fg_color, int bg_color);
  39
  40 const char *color_names[] = {"null", "black", "blue", "green",
  41    "cyan", "magenta", "brown", "red", "light gray", "dark gray",
  42    "light blue", "light green", "light red", "light magenta",
  43    "light cyan", "yellow", "white"};
  44
  45 void NCURSES_Start()
  46 {
  47    /* This should be the root driver so we can ignore anything
  48       already in the struct. */
  49
  50    driver.norefresh = FALSE;
  51
  52    driver.init = NCURSES_Init;
  53    driver.write = NCURSES_Write;
  54    driver.close = NCURSES_Close;
  55    driver.moveCursor = NCURSES_MoveCursor;
  56    driver.getCursorPosition = NCURSES_GetCursorPosition;
  57    driver.getCharacterAtCursor = NCURSES_GetCharacterAtCursor;
  58    driver.clearScreen = NCURSES_ClearScreen;
  59    driver.allocColor = NCURSES_AllocColor;
  60 #ifdef HAVE_GETBKGD
  61    driver.setBackgroundColor = NCURSES_SetBackgroundColor;
  62 #endif
  63 #ifdef HAVE_RESIZETERM
  64    driver.notifyResizeScreen = NCURSES_NotifyResizeScreen;
  65 #endif /* HAVE_RESIZETERM */
  66
  67    driver.checkForKeystroke = NCURSES_CheckForKeystroke;
  68    driver.getKeystroke = NCURSES_GetKeystroke;
  69
  70    driver.refresh = NCURSES_Refresh;
  71 }
  72
  73 void NCURSES_Init()
  74 {
  75    char terminal_type[80];
  76
  77    PROFILE_GetWineIniString("console", "TerminalType",
  78       "xterm", terminal_type, 79);
  79
  80    ncurses_screen = newterm(terminal_type, driver.console_out,
  81       driver.console_in);
  82    set_term(ncurses_screen);
  83    start_color();
  84    raw();
  85    noecho();
  86    nonl();
  87    intrflush(stdscr, FALSE);
  88    keypad(stdscr, TRUE);
  89    nodelay(stdscr, TRUE);
  90 }
  91
  92 void NCURSES_Write(char output, int fg, int bg, int attribute)
  93 {
  94    char row, col;
  95    int pair;
  96
  97    if (!fg)
  98       fg = COLOR_WHITE; /* Default */
  99
 100    if (!bg)
 101       bg = COLOR_BLACK; /* Default */
 102
 103    pair = get_color_pair(fg, bg);
 104
 105    if (waddch(stdscr, output | COLOR_PAIR(pair)) == ERR)
 106    {
 107       NCURSES_GetCursorPosition(&row, &col);
 108       FIXME(console, "NCURSES: waddch() failed at %d, %d.\n", row, col);
 109    }
 110 }
 111
 112 void NCURSES_Close()
 113 {
 114    endwin();
 115 }
 116
 117 void NCURSES_GetKeystroke(char *scan, char *ascii)
 118 {
 119    while (!NCURSES_CheckForKeystroke(scan, ascii))
 120    {} /* Wait until keystroke is detected */
 121
 122    /* When it is detected, we will already have the right value
 123       in scan and ascii, but we need to take this keystroke
 124       out of the buffer. */
 125    wgetch(stdscr);
 126 }
 127
 128 int NCURSES_CheckForKeystroke(char *scan, char *ascii)
 129 {
 130    /* We don't currently support scan codes here */
 131    /* FIXME */
 132    int temp;
 133    temp = wgetch(stdscr);
 134    if (temp == ERR)
 135    {
 136       return FALSE;
 137    }
 138    else
 139    {
 140       ungetch(temp);  /* Keystroke not removed from buffer */
 141       *ascii = (char) temp;
 142       return TRUE;
 143    }
 144 }
 145
 146 void NCURSES_MoveCursor(char row, char col)
 147 {
 148    if (wmove(stdscr, row, col) == ERR)
 149       FIXME(console, "NCURSES: wmove() failed to %d, %d.\n", row, col);
 150 }
 151
 152 void NCURSES_GetCursorPosition(char *row, char *col)
 153 {
 154    int trow, tcol;
 155
 156    getyx(stdscr, trow, tcol); /* MACRO, no need to pass pointer */
 157
 158    *row = (char) trow;
 159    *col = (char) tcol;
 160 }
 161
 162 void NCURSES_GetCharacterAtCursor(char *ch, int *fg_color, int
 163    *bg_color, int *attribute)
 164 {
 165    /* If any of the pointers are NULL, ignore them */
 166    /* We will eventually have to convert the color data */
 167    if (ch)
 168       *ch = (char) winch(stdscr);
 169    if (fg_color)
 170       *fg_color = WINE_WHITE;
 171    if (bg_color)
 172       *bg_color = WINE_BLACK;
 173    if (attribute)
 174       *attribute = 0;
 175 };
 176
 177 void NCURSES_Refresh()
 178 {
 179    wrefresh(stdscr);
 180 }
 181
 182 void NCURSES_ClearScreen()
 183 {
 184    werase(stdscr);
 185 }
 186
 187 int NCURSES_AllocColor(int color)
 188 {
 189    /* Currently support only internal colors */
 190    switch (color)
 191    {
 192       case WINE_BLACK:          return COLOR_BLACK;
 193       case WINE_WHITE:          return COLOR_WHITE;
 194       case WINE_RED:            return COLOR_RED;
 195       case WINE_GREEN:          return COLOR_GREEN;
 196       case WINE_YELLOW:         return COLOR_YELLOW;
 197       case WINE_BLUE:           return COLOR_BLUE;
 198       case WINE_MAGENTA:        return COLOR_MAGENTA;
 199       case WINE_CYAN:           return COLOR_CYAN;
 200    }
 201
 202    FIXME(console, "Unable to allocate color %d (%s)\n", color,
 203       color_names[color]);
 204
 205    /* Don't allocate a color... yet */
 206    return 0;
 207 }
 208
 209 void NCURSES_SetBackgroundColor(int fg, int bg)
 210 {
 211    int pair;
 212
 213    pair = get_color_pair(fg, bg);
 214
 215    wbkgd(stdscr, COLOR_PAIR(pair));
 216 }
 217
 218 #ifdef HAVE_GETBKGD
 219 void NCURSES_GetBackgroundColor(int *fg, int *bg)
 220 {
 221    chtype background;
 222    short pair, sfg, sbg;
 223
 224    background = getbkgd(stdscr);
 225
 226    pair = (!A_CHARTEXT & background);
 227
 228    pair_content(pair, &sfg, &sbg);
 229
 230    *fg = sfg;
 231    *bg = sbg;
 232 }
 233 #endif /* HAVE_GETBKGD */
 234
 235 #ifdef HAVE_RESIZETERM
 236
 237 void NCURSES_NotifyResizeScreen(int x, int y)
 238 {
 239    /* Note: This function gets called *after* another driver in the chain
 240       calls ResizeScreen(). It is meant to resize the ncurses internal
 241       data structures to know about the new window dimensions. */
 242
 243    TRACE(console, "Terminal resized to y: %d, x: %d\n", y, x);
 244
 245    resizeterm(y, x);
 246 }
 247
 248 #endif /* HAVE_RESIZETERM */
 249
 250 static int get_color_pair(int fg_color, int bg_color)
 251 {
 252    /* ncurses internally uses "color pairs" in addition to the "pallet" */
 253    /* This isn't the best way to do this. Or even close */
 254
 255    static int current = 0;
 256    static int fg[255];     /* 16 x 16 is enough */
 257    static int bg[255];
 258    int x;
 259
 260    /* The first pair is hardwired into ncurses */
 261    fg[0] = COLOR_WHITE;
 262    bg[0] = COLOR_BLACK;
 263
 264    for (x = 0; x <= current; x++)
 265    {
 266       if ((fg_color == fg[x]) && (bg_color == bg[x]))
 267       {
 268          TRACE(console, "Color pair: already allocated\n");
 269          return x;
 270       }
 271    }
 272
 273    /* Need to allocate new color */
 274    current++;
 275    fg[current] = fg_color;
 276    bg[current] = bg_color;
 277    TRACE(console, "Color pair: allocated.\n");
 278    return init_pair(current, fg_color, bg_color);
 279 }
 280
 281 #endif /* WINE_NCURSES */