ui/curses.c

   1 /*
   2  * QEMU curses/ncurses display driver
   3  *
   4  * Copyright (c) 2005 Andrzej Zaborowski  <balrog@zabor.org>
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24 #include <curses.h>
  25
  26 #ifndef _WIN32
  27 #include <sys/ioctl.h>
  28 #include <termios.h>
  29 #endif
  30
  31 #include "qemu-common.h"
  32 #include "ui/console.h"
  33 #include "sysemu/sysemu.h"
  34
  35 #define FONT_HEIGHT 16
  36 #define FONT_WIDTH 8
  37
  38 static DisplayChangeListener *dcl;
  39 static console_ch_t screen[160 * 100];
  40 static WINDOW *screenpad = NULL;
  41 static int width, height, gwidth, gheight, invalidate;
  42 static int px, py, sminx, sminy, smaxx, smaxy;
  43
  44 static void curses_update(DisplayChangeListener *dcl,
  45                           int x, int y, int w, int h)
  46 {
  47     chtype *line;
  48
  49     line = ((chtype *) screen) + y * width;
  50     for (h += y; y < h; y ++, line += width)
  51         mvwaddchnstr(screenpad, y, 0, line, width);
  52
  53     pnoutrefresh(screenpad, py, px, sminy, sminx, smaxy - 1, smaxx - 1);
  54     refresh();
  55 }
  56
  57 static void curses_calc_pad(void)
  58 {
  59     if (is_fixedsize_console()) {
  60         width = gwidth;
  61         height = gheight;
  62     } else {
  63         width = COLS;
  64         height = LINES;
  65     }
  66
  67     if (screenpad)
  68         delwin(screenpad);
  69
  70     clear();
  71     refresh();
  72
  73     screenpad = newpad(height, width);
  74
  75     if (width > COLS) {
  76         px = (width - COLS) / 2;
  77         sminx = 0;
  78         smaxx = COLS;
  79     } else {
  80         px = 0;
  81         sminx = (COLS - width) / 2;
  82         smaxx = sminx + width;
  83     }
  84
  85     if (height > LINES) {
  86         py = (height - LINES) / 2;
  87         sminy = 0;
  88         smaxy = LINES;
  89     } else {
  90         py = 0;
  91         sminy = (LINES - height) / 2;
  92         smaxy = sminy + height;
  93     }
  94 }
  95
  96 static void curses_resize(DisplayChangeListener *dcl,
  97                           int width, int height)
  98 {
  99     if (width == gwidth && height == gheight) {
 100         return;
 101     }
 102
 103     gwidth = width;
 104     gheight = height;
 105
 106     curses_calc_pad();
 107 }
 108
 109 #ifndef _WIN32
 110 #if defined(SIGWINCH) && defined(KEY_RESIZE)
 111 static void curses_winch_handler(int signum)
 112 {
 113     struct winsize {
 114         unsigned short ws_row;
 115         unsigned short ws_col;
 116         unsigned short ws_xpixel;   /* unused */
 117         unsigned short ws_ypixel;   /* unused */
 118     } ws;
 119
 120     /* terminal size changed */
 121     if (ioctl(1, TIOCGWINSZ, &ws) == -1)
 122         return;
 123
 124     resize_term(ws.ws_row, ws.ws_col);
 125     curses_calc_pad();
 126     invalidate = 1;
 127
 128     /* some systems require this */
 129     signal(SIGWINCH, curses_winch_handler);
 130 }
 131 #endif
 132 #endif
 133
 134 static void curses_cursor_position(DisplayChangeListener *dcl,
 135                                    int x, int y)
 136 {
 137     if (x >= 0) {
 138         x = sminx + x - px;
 139         y = sminy + y - py;
 140
 141         if (x >= 0 && y >= 0 && x < COLS && y < LINES) {
 142             move(y, x);
 143             curs_set(1);
 144             /* it seems that curs_set(1) must always be called before
 145              * curs_set(2) for the latter to have effect */
 146             if (!is_graphic_console())
 147                 curs_set(2);
 148             return;
 149         }
 150     }
 151
 152     curs_set(0);
 153 }
 154
 155 /* generic keyboard conversion */
 156
 157 #include "curses_keys.h"
 158
 159 static kbd_layout_t *kbd_layout = NULL;
 160
 161 static void curses_refresh(DisplayChangeListener *dcl)
 162 {
 163     int chr, nextchr, keysym, keycode, keycode_alt;
 164
 165     if (invalidate) {
 166         clear();
 167         refresh();
 168         curses_calc_pad();
 169         vga_hw_invalidate();
 170         invalidate = 0;
 171     }
 172
 173     vga_hw_text_update(screen);
 174
 175     nextchr = ERR;
 176     while (1) {
 177         /* while there are any pending key strokes to process */
 178         if (nextchr == ERR)
 179             chr = getch();
 180         else {
 181             chr = nextchr;
 182             nextchr = ERR;
 183         }
 184
 185         if (chr == ERR)
 186             break;
 187
 188 #ifdef KEY_RESIZE
 189         /* this shouldn't occur when we use a custom SIGWINCH handler */
 190         if (chr == KEY_RESIZE) {
 191             clear();
 192             refresh();
 193             curses_calc_pad();
 194             curses_update(dcl, 0, 0, width, height);
 195             continue;
 196         }
 197 #endif
 198
 199         keycode = curses2keycode[chr];
 200         keycode_alt = 0;
 201
 202         /* alt key */
 203         if (keycode == 1) {
 204             nextchr = getch();
 205
 206             if (nextchr != ERR) {
 207                 chr = nextchr;
 208                 keycode_alt = ALT;
 209                 keycode = curses2keycode[nextchr];
 210                 nextchr = ERR;
 211
 212                 if (keycode != -1) {
 213                     keycode |= ALT;
 214
 215                     /* process keys reserved for qemu */
 216                     if (keycode >= QEMU_KEY_CONSOLE0 &&
 217                             keycode < QEMU_KEY_CONSOLE0 + 9) {
 218                         erase();
 219                         wnoutrefresh(stdscr);
 220                         console_select(keycode - QEMU_KEY_CONSOLE0);
 221
 222                         invalidate = 1;
 223                         continue;
 224                     }
 225                 }
 226             }
 227         }
 228
 229         if (kbd_layout) {
 230             keysym = -1;
 231             if (chr < CURSES_KEYS)
 232                 keysym = curses2keysym[chr];
 233
 234             if (keysym == -1) {
 235                 if (chr < ' ') {
 236                     keysym = chr + '@';
 237                     if (keysym >= 'A' && keysym <= 'Z')
 238                         keysym += 'a' - 'A';
 239                     keysym |= KEYSYM_CNTRL;
 240                 } else
 241                     keysym = chr;
 242             }
 243
 244             keycode = keysym2scancode(kbd_layout, keysym & KEYSYM_MASK);
 245             if (keycode == 0)
 246                 continue;
 247
 248             keycode |= (keysym & ~KEYSYM_MASK) >> 16;
 249             keycode |= keycode_alt;
 250         }
 251
 252         if (keycode == -1)
 253             continue;
 254
 255         if (is_graphic_console()) {
 256             /* since terminals don't know about key press and release
 257              * events, we need to emit both for each key received */
 258             if (keycode & SHIFT)
 259                 kbd_put_keycode(SHIFT_CODE);
 260             if (keycode & CNTRL)
 261                 kbd_put_keycode(CNTRL_CODE);
 262             if (keycode & ALT)
 263                 kbd_put_keycode(ALT_CODE);
 264             if (keycode & ALTGR) {
 265                 kbd_put_keycode(SCANCODE_EMUL0);
 266                 kbd_put_keycode(ALT_CODE);
 267             }
 268             if (keycode & GREY)
 269                 kbd_put_keycode(GREY_CODE);
 270             kbd_put_keycode(keycode & KEY_MASK);
 271             if (keycode & GREY)
 272                 kbd_put_keycode(GREY_CODE);
 273             kbd_put_keycode((keycode & KEY_MASK) | KEY_RELEASE);
 274             if (keycode & ALTGR) {
 275                 kbd_put_keycode(SCANCODE_EMUL0);
 276                 kbd_put_keycode(ALT_CODE | KEY_RELEASE);
 277             }
 278             if (keycode & ALT)
 279                 kbd_put_keycode(ALT_CODE | KEY_RELEASE);
 280             if (keycode & CNTRL)
 281                 kbd_put_keycode(CNTRL_CODE | KEY_RELEASE);
 282             if (keycode & SHIFT)
 283                 kbd_put_keycode(SHIFT_CODE | KEY_RELEASE);
 284         } else {
 285             keysym = curses2qemu[chr];
 286             if (keysym == -1)
 287                 keysym = chr;
 288
 289             kbd_put_keysym(keysym);
 290         }
 291     }
 292 }
 293
 294 static void curses_atexit(void)
 295 {
 296     endwin();
 297 }
 298
 299 static void curses_setup(void)
 300 {
 301     int i, colour_default[8] = {
 302         COLOR_BLACK, COLOR_BLUE, COLOR_GREEN, COLOR_CYAN,
 303         COLOR_RED, COLOR_MAGENTA, COLOR_YELLOW, COLOR_WHITE,
 304     };
 305
 306     /* input as raw as possible, let everything be interpreted
 307      * by the guest system */
 308     initscr(); noecho(); intrflush(stdscr, FALSE);
 309     nodelay(stdscr, TRUE); nonl(); keypad(stdscr, TRUE);
 310     start_color(); raw(); scrollok(stdscr, FALSE);
 311
 312     for (i = 0; i < 64; i ++)
 313         init_pair(i, colour_default[i & 7], colour_default[i >> 3]);
 314 }
 315
 316 static void curses_keyboard_setup(void)
 317 {
 318 #if defined(__APPLE__)
 319     /* always use generic keymaps */
 320     if (!keyboard_layout)
 321         keyboard_layout = "en-us";
 322 #endif
 323     if(keyboard_layout) {
 324         kbd_layout = init_keyboard_layout(name2keysym, keyboard_layout);
 325         if (!kbd_layout)
 326             exit(1);
 327     }
 328 }
 329
 330 static const DisplayChangeListenerOps dcl_ops = {
 331     .dpy_name        = "curses",
 332     .dpy_text_update = curses_update,
 333     .dpy_text_resize = curses_resize,
 334     .dpy_refresh     = curses_refresh,
 335     .dpy_text_cursor = curses_cursor_position,
 336 };
 337
 338 void curses_display_init(DisplayState *ds, int full_screen)
 339 {
 340 #ifndef _WIN32
 341     if (!isatty(1)) {
 342         fprintf(stderr, "We need a terminal output\n");
 343         exit(1);
 344     }
 345 #endif
 346
 347     curses_setup();
 348     curses_keyboard_setup();
 349     atexit(curses_atexit);
 350
 351 #ifndef _WIN32
 352 #if defined(SIGWINCH) && defined(KEY_RESIZE)
 353     /* some curses implementations provide a handler, but we
 354      * want to be sure this is handled regardless of the library */
 355     signal(SIGWINCH, curses_winch_handler);
 356 #endif
 357 #endif
 358
 359     dcl = (DisplayChangeListener *) g_malloc0(sizeof(DisplayChangeListener));
 360     dcl->ops = &dcl_ops;
 361     register_displaychangelistener(ds, dcl);
 362
 363     invalidate = 1;
 364 }