xref: /openbmc/qemu/ui/curses.c (revision d03703c81a202cea156811e5dbc8e88627c19986)
13e230dd2SCorentin Chary /*
23e230dd2SCorentin Chary  * QEMU curses/ncurses display driver
33e230dd2SCorentin Chary  *
43e230dd2SCorentin Chary  * Copyright (c) 2005 Andrzej Zaborowski  <balrog@zabor.org>
53e230dd2SCorentin Chary  *
63e230dd2SCorentin Chary  * Permission is hereby granted, free of charge, to any person obtaining a copy
73e230dd2SCorentin Chary  * of this software and associated documentation files (the "Software"), to deal
83e230dd2SCorentin Chary  * in the Software without restriction, including without limitation the rights
93e230dd2SCorentin Chary  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
103e230dd2SCorentin Chary  * copies of the Software, and to permit persons to whom the Software is
113e230dd2SCorentin Chary  * furnished to do so, subject to the following conditions:
123e230dd2SCorentin Chary  *
133e230dd2SCorentin Chary  * The above copyright notice and this permission notice shall be included in
143e230dd2SCorentin Chary  * all copies or substantial portions of the Software.
153e230dd2SCorentin Chary  *
163e230dd2SCorentin Chary  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
173e230dd2SCorentin Chary  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
183e230dd2SCorentin Chary  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
193e230dd2SCorentin Chary  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
203e230dd2SCorentin Chary  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
213e230dd2SCorentin Chary  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
223e230dd2SCorentin Chary  * THE SOFTWARE.
233e230dd2SCorentin Chary  */
243e230dd2SCorentin Chary #include <curses.h>
253e230dd2SCorentin Chary 
263e230dd2SCorentin Chary #ifndef _WIN32
273e230dd2SCorentin Chary #include <signal.h>
283e230dd2SCorentin Chary #include <sys/ioctl.h>
293e230dd2SCorentin Chary #include <termios.h>
303e230dd2SCorentin Chary #endif
313e230dd2SCorentin Chary 
323e230dd2SCorentin Chary #ifdef __OpenBSD__
333e230dd2SCorentin Chary #define resize_term resizeterm
343e230dd2SCorentin Chary #endif
353e230dd2SCorentin Chary 
363e230dd2SCorentin Chary #include "qemu-common.h"
373e230dd2SCorentin Chary #include "console.h"
383e230dd2SCorentin Chary #include "sysemu.h"
393e230dd2SCorentin Chary 
403e230dd2SCorentin Chary #define FONT_HEIGHT 16
413e230dd2SCorentin Chary #define FONT_WIDTH 8
423e230dd2SCorentin Chary 
433e230dd2SCorentin Chary static console_ch_t screen[160 * 100];
443e230dd2SCorentin Chary static WINDOW *screenpad = NULL;
453e230dd2SCorentin Chary static int width, height, gwidth, gheight, invalidate;
463e230dd2SCorentin Chary static int px, py, sminx, sminy, smaxx, smaxy;
473e230dd2SCorentin Chary 
483e230dd2SCorentin Chary static void curses_update(DisplayState *ds, int x, int y, int w, int h)
493e230dd2SCorentin Chary {
503e230dd2SCorentin Chary     chtype *line;
513e230dd2SCorentin Chary 
523e230dd2SCorentin Chary     line = ((chtype *) screen) + y * width;
533e230dd2SCorentin Chary     for (h += y; y < h; y ++, line += width)
543e230dd2SCorentin Chary         mvwaddchnstr(screenpad, y, 0, line, width);
553e230dd2SCorentin Chary 
563e230dd2SCorentin Chary     pnoutrefresh(screenpad, py, px, sminy, sminx, smaxy - 1, smaxx - 1);
573e230dd2SCorentin Chary     refresh();
583e230dd2SCorentin Chary }
593e230dd2SCorentin Chary 
603e230dd2SCorentin Chary static void curses_calc_pad(void)
613e230dd2SCorentin Chary {
623e230dd2SCorentin Chary     if (is_fixedsize_console()) {
633e230dd2SCorentin Chary         width = gwidth;
643e230dd2SCorentin Chary         height = gheight;
653e230dd2SCorentin Chary     } else {
663e230dd2SCorentin Chary         width = COLS;
673e230dd2SCorentin Chary         height = LINES;
683e230dd2SCorentin Chary     }
693e230dd2SCorentin Chary 
703e230dd2SCorentin Chary     if (screenpad)
713e230dd2SCorentin Chary         delwin(screenpad);
723e230dd2SCorentin Chary 
733e230dd2SCorentin Chary     clear();
743e230dd2SCorentin Chary     refresh();
753e230dd2SCorentin Chary 
763e230dd2SCorentin Chary     screenpad = newpad(height, width);
773e230dd2SCorentin Chary 
783e230dd2SCorentin Chary     if (width > COLS) {
793e230dd2SCorentin Chary         px = (width - COLS) / 2;
803e230dd2SCorentin Chary         sminx = 0;
813e230dd2SCorentin Chary         smaxx = COLS;
823e230dd2SCorentin Chary     } else {
833e230dd2SCorentin Chary         px = 0;
843e230dd2SCorentin Chary         sminx = (COLS - width) / 2;
853e230dd2SCorentin Chary         smaxx = sminx + width;
863e230dd2SCorentin Chary     }
873e230dd2SCorentin Chary 
883e230dd2SCorentin Chary     if (height > LINES) {
893e230dd2SCorentin Chary         py = (height - LINES) / 2;
903e230dd2SCorentin Chary         sminy = 0;
913e230dd2SCorentin Chary         smaxy = LINES;
923e230dd2SCorentin Chary     } else {
933e230dd2SCorentin Chary         py = 0;
943e230dd2SCorentin Chary         sminy = (LINES - height) / 2;
953e230dd2SCorentin Chary         smaxy = sminy + height;
963e230dd2SCorentin Chary     }
973e230dd2SCorentin Chary }
983e230dd2SCorentin Chary 
993e230dd2SCorentin Chary static void curses_resize(DisplayState *ds)
1003e230dd2SCorentin Chary {
1013e230dd2SCorentin Chary     if (ds_get_width(ds) == gwidth && ds_get_height(ds) == gheight)
1023e230dd2SCorentin Chary         return;
1033e230dd2SCorentin Chary 
1043e230dd2SCorentin Chary     gwidth = ds_get_width(ds);
1053e230dd2SCorentin Chary     gheight = ds_get_height(ds);
1063e230dd2SCorentin Chary 
1073e230dd2SCorentin Chary     curses_calc_pad();
1083e230dd2SCorentin Chary     ds->surface->width = width * FONT_WIDTH;
1093e230dd2SCorentin Chary     ds->surface->height = height * FONT_HEIGHT;
1103e230dd2SCorentin Chary }
1113e230dd2SCorentin Chary 
1123e230dd2SCorentin Chary #ifndef _WIN32
1133e230dd2SCorentin Chary #if defined(SIGWINCH) && defined(KEY_RESIZE)
1143e230dd2SCorentin Chary static void curses_winch_handler(int signum)
1153e230dd2SCorentin Chary {
1163e230dd2SCorentin Chary     struct winsize {
1173e230dd2SCorentin Chary         unsigned short ws_row;
1183e230dd2SCorentin Chary         unsigned short ws_col;
1193e230dd2SCorentin Chary         unsigned short ws_xpixel;   /* unused */
1203e230dd2SCorentin Chary         unsigned short ws_ypixel;   /* unused */
1213e230dd2SCorentin Chary     } ws;
1223e230dd2SCorentin Chary 
1233e230dd2SCorentin Chary     /* terminal size changed */
1243e230dd2SCorentin Chary     if (ioctl(1, TIOCGWINSZ, &ws) == -1)
1253e230dd2SCorentin Chary         return;
1263e230dd2SCorentin Chary 
1273e230dd2SCorentin Chary     resize_term(ws.ws_row, ws.ws_col);
1283e230dd2SCorentin Chary     curses_calc_pad();
1293e230dd2SCorentin Chary     invalidate = 1;
1303e230dd2SCorentin Chary 
1313e230dd2SCorentin Chary     /* some systems require this */
1323e230dd2SCorentin Chary     signal(SIGWINCH, curses_winch_handler);
1333e230dd2SCorentin Chary }
1343e230dd2SCorentin Chary #endif
1353e230dd2SCorentin Chary #endif
1363e230dd2SCorentin Chary 
1373e230dd2SCorentin Chary static void curses_cursor_position(DisplayState *ds, int x, int y)
1383e230dd2SCorentin Chary {
1393e230dd2SCorentin Chary     if (x >= 0) {
1403e230dd2SCorentin Chary         x = sminx + x - px;
1413e230dd2SCorentin Chary         y = sminy + y - py;
1423e230dd2SCorentin Chary 
1433e230dd2SCorentin Chary         if (x >= 0 && y >= 0 && x < COLS && y < LINES) {
1443e230dd2SCorentin Chary             move(y, x);
1453e230dd2SCorentin Chary             curs_set(1);
1463e230dd2SCorentin Chary             /* it seems that curs_set(1) must always be called before
1473e230dd2SCorentin Chary              * curs_set(2) for the latter to have effect */
1483e230dd2SCorentin Chary             if (!is_graphic_console())
1493e230dd2SCorentin Chary                 curs_set(2);
1503e230dd2SCorentin Chary             return;
1513e230dd2SCorentin Chary         }
1523e230dd2SCorentin Chary     }
1533e230dd2SCorentin Chary 
1543e230dd2SCorentin Chary     curs_set(0);
1553e230dd2SCorentin Chary }
1563e230dd2SCorentin Chary 
1573e230dd2SCorentin Chary /* generic keyboard conversion */
1583e230dd2SCorentin Chary 
1593e230dd2SCorentin Chary #include "curses_keys.h"
1603e230dd2SCorentin Chary 
1613e230dd2SCorentin Chary static kbd_layout_t *kbd_layout = NULL;
1623e230dd2SCorentin Chary 
1633e230dd2SCorentin Chary static void curses_refresh(DisplayState *ds)
1643e230dd2SCorentin Chary {
1653e230dd2SCorentin Chary     int chr, nextchr, keysym, keycode, keycode_alt;
1663e230dd2SCorentin Chary 
1673e230dd2SCorentin Chary     if (invalidate) {
1683e230dd2SCorentin Chary         clear();
1693e230dd2SCorentin Chary         refresh();
1703e230dd2SCorentin Chary         curses_calc_pad();
1713e230dd2SCorentin Chary         ds->surface->width = FONT_WIDTH * width;
1723e230dd2SCorentin Chary         ds->surface->height = FONT_HEIGHT * height;
1733e230dd2SCorentin Chary         vga_hw_invalidate();
1743e230dd2SCorentin Chary         invalidate = 0;
1753e230dd2SCorentin Chary     }
1763e230dd2SCorentin Chary 
1773e230dd2SCorentin Chary     vga_hw_text_update(screen);
1783e230dd2SCorentin Chary 
1793e230dd2SCorentin Chary     nextchr = ERR;
1803e230dd2SCorentin Chary     while (1) {
1813e230dd2SCorentin Chary         /* while there are any pending key strokes to process */
1823e230dd2SCorentin Chary         if (nextchr == ERR)
1833e230dd2SCorentin Chary             chr = getch();
1843e230dd2SCorentin Chary         else {
1853e230dd2SCorentin Chary             chr = nextchr;
1863e230dd2SCorentin Chary             nextchr = ERR;
1873e230dd2SCorentin Chary         }
1883e230dd2SCorentin Chary 
1893e230dd2SCorentin Chary         if (chr == ERR)
1903e230dd2SCorentin Chary             break;
1913e230dd2SCorentin Chary 
1923e230dd2SCorentin Chary #ifdef KEY_RESIZE
1933e230dd2SCorentin Chary         /* this shouldn't occur when we use a custom SIGWINCH handler */
1943e230dd2SCorentin Chary         if (chr == KEY_RESIZE) {
1953e230dd2SCorentin Chary             clear();
1963e230dd2SCorentin Chary             refresh();
1973e230dd2SCorentin Chary             curses_calc_pad();
1983e230dd2SCorentin Chary             curses_update(ds, 0, 0, width, height);
1993e230dd2SCorentin Chary             ds->surface->width = FONT_WIDTH * width;
2003e230dd2SCorentin Chary             ds->surface->height = FONT_HEIGHT * height;
2013e230dd2SCorentin Chary             continue;
2023e230dd2SCorentin Chary         }
2033e230dd2SCorentin Chary #endif
2043e230dd2SCorentin Chary 
2053e230dd2SCorentin Chary         keycode = curses2keycode[chr];
2063e230dd2SCorentin Chary         keycode_alt = 0;
2073e230dd2SCorentin Chary 
2083e230dd2SCorentin Chary         /* alt key */
2093e230dd2SCorentin Chary         if (keycode == 1) {
2103e230dd2SCorentin Chary             nextchr = getch();
2113e230dd2SCorentin Chary 
2123e230dd2SCorentin Chary             if (nextchr != ERR) {
2133e230dd2SCorentin Chary                 chr = nextchr;
2143e230dd2SCorentin Chary                 keycode_alt = ALT;
2153e230dd2SCorentin Chary                 keycode = curses2keycode[nextchr];
2163e230dd2SCorentin Chary                 nextchr = ERR;
2173e230dd2SCorentin Chary 
2183e230dd2SCorentin Chary                 if (keycode != -1) {
2193e230dd2SCorentin Chary                     keycode |= ALT;
2203e230dd2SCorentin Chary 
2213e230dd2SCorentin Chary                     /* process keys reserved for qemu */
2223e230dd2SCorentin Chary                     if (keycode >= QEMU_KEY_CONSOLE0 &&
2233e230dd2SCorentin Chary                             keycode < QEMU_KEY_CONSOLE0 + 9) {
2243e230dd2SCorentin Chary                         erase();
2253e230dd2SCorentin Chary                         wnoutrefresh(stdscr);
2263e230dd2SCorentin Chary                         console_select(keycode - QEMU_KEY_CONSOLE0);
2273e230dd2SCorentin Chary 
2283e230dd2SCorentin Chary                         invalidate = 1;
2293e230dd2SCorentin Chary                         continue;
2303e230dd2SCorentin Chary                     }
2313e230dd2SCorentin Chary                 }
2323e230dd2SCorentin Chary             }
2333e230dd2SCorentin Chary         }
2343e230dd2SCorentin Chary 
2353e230dd2SCorentin Chary         if (kbd_layout) {
2363e230dd2SCorentin Chary             keysym = -1;
2373e230dd2SCorentin Chary             if (chr < CURSES_KEYS)
2383e230dd2SCorentin Chary                 keysym = curses2keysym[chr];
2393e230dd2SCorentin Chary 
2403e230dd2SCorentin Chary             if (keysym == -1) {
241*d03703c8SSamuel Thibault                 if (chr < ' ') {
242*d03703c8SSamuel Thibault                     keysym = chr + '@';
243*d03703c8SSamuel Thibault                     if (keysym >= 'A' && keysym <= 'Z')
244*d03703c8SSamuel Thibault                         keysym += 'a' - 'A';
245*d03703c8SSamuel Thibault                     keysym |= KEYSYM_CNTRL;
246*d03703c8SSamuel Thibault                 } else
2473e230dd2SCorentin Chary                     keysym = chr;
2483e230dd2SCorentin Chary             }
2493e230dd2SCorentin Chary 
2503e230dd2SCorentin Chary             keycode = keysym2scancode(kbd_layout, keysym & KEYSYM_MASK);
2513e230dd2SCorentin Chary             if (keycode == 0)
2523e230dd2SCorentin Chary                 continue;
2533e230dd2SCorentin Chary 
2543e230dd2SCorentin Chary             keycode |= (keysym & ~KEYSYM_MASK) >> 16;
2553e230dd2SCorentin Chary             keycode |= keycode_alt;
2563e230dd2SCorentin Chary         }
2573e230dd2SCorentin Chary 
2583e230dd2SCorentin Chary         if (keycode == -1)
2593e230dd2SCorentin Chary             continue;
2603e230dd2SCorentin Chary 
2613e230dd2SCorentin Chary         if (is_graphic_console()) {
2623e230dd2SCorentin Chary             /* since terminals don't know about key press and release
2633e230dd2SCorentin Chary              * events, we need to emit both for each key received */
2643e230dd2SCorentin Chary             if (keycode & SHIFT)
2653e230dd2SCorentin Chary                 kbd_put_keycode(SHIFT_CODE);
2663e230dd2SCorentin Chary             if (keycode & CNTRL)
2673e230dd2SCorentin Chary                 kbd_put_keycode(CNTRL_CODE);
2683e230dd2SCorentin Chary             if (keycode & ALT)
2693e230dd2SCorentin Chary                 kbd_put_keycode(ALT_CODE);
2703e230dd2SCorentin Chary             if (keycode & ALTGR) {
2713e230dd2SCorentin Chary                 kbd_put_keycode(SCANCODE_EMUL0);
2723e230dd2SCorentin Chary                 kbd_put_keycode(ALT_CODE);
2733e230dd2SCorentin Chary             }
2743e230dd2SCorentin Chary             if (keycode & GREY)
2753e230dd2SCorentin Chary                 kbd_put_keycode(GREY_CODE);
2763e230dd2SCorentin Chary             kbd_put_keycode(keycode & KEY_MASK);
2773e230dd2SCorentin Chary             if (keycode & GREY)
2783e230dd2SCorentin Chary                 kbd_put_keycode(GREY_CODE);
2793e230dd2SCorentin Chary             kbd_put_keycode((keycode & KEY_MASK) | KEY_RELEASE);
2803e230dd2SCorentin Chary             if (keycode & ALTGR) {
2813e230dd2SCorentin Chary                 kbd_put_keycode(SCANCODE_EMUL0);
2823e230dd2SCorentin Chary                 kbd_put_keycode(ALT_CODE | KEY_RELEASE);
2833e230dd2SCorentin Chary             }
2843e230dd2SCorentin Chary             if (keycode & ALT)
2853e230dd2SCorentin Chary                 kbd_put_keycode(ALT_CODE | KEY_RELEASE);
2863e230dd2SCorentin Chary             if (keycode & CNTRL)
2873e230dd2SCorentin Chary                 kbd_put_keycode(CNTRL_CODE | KEY_RELEASE);
2883e230dd2SCorentin Chary             if (keycode & SHIFT)
2893e230dd2SCorentin Chary                 kbd_put_keycode(SHIFT_CODE | KEY_RELEASE);
2903e230dd2SCorentin Chary         } else {
2913e230dd2SCorentin Chary             keysym = curses2qemu[chr];
2923e230dd2SCorentin Chary             if (keysym == -1)
2933e230dd2SCorentin Chary                 keysym = chr;
2943e230dd2SCorentin Chary 
2953e230dd2SCorentin Chary             kbd_put_keysym(keysym);
2963e230dd2SCorentin Chary         }
2973e230dd2SCorentin Chary     }
2983e230dd2SCorentin Chary }
2993e230dd2SCorentin Chary 
3003e230dd2SCorentin Chary static void curses_atexit(void)
3013e230dd2SCorentin Chary {
3023e230dd2SCorentin Chary     endwin();
3033e230dd2SCorentin Chary }
3043e230dd2SCorentin Chary 
3053e230dd2SCorentin Chary static void curses_setup(void)
3063e230dd2SCorentin Chary {
3073e230dd2SCorentin Chary     int i, colour_default[8] = {
3083e230dd2SCorentin Chary         COLOR_BLACK, COLOR_BLUE, COLOR_GREEN, COLOR_CYAN,
3093e230dd2SCorentin Chary         COLOR_RED, COLOR_MAGENTA, COLOR_YELLOW, COLOR_WHITE,
3103e230dd2SCorentin Chary     };
3113e230dd2SCorentin Chary 
3123e230dd2SCorentin Chary     /* input as raw as possible, let everything be interpreted
3133e230dd2SCorentin Chary      * by the guest system */
3143e230dd2SCorentin Chary     initscr(); noecho(); intrflush(stdscr, FALSE);
3153e230dd2SCorentin Chary     nodelay(stdscr, TRUE); nonl(); keypad(stdscr, TRUE);
3163e230dd2SCorentin Chary     start_color(); raw(); scrollok(stdscr, FALSE);
3173e230dd2SCorentin Chary 
3183e230dd2SCorentin Chary     for (i = 0; i < 64; i ++)
3193e230dd2SCorentin Chary         init_pair(i, colour_default[i & 7], colour_default[i >> 3]);
3203e230dd2SCorentin Chary }
3213e230dd2SCorentin Chary 
3223e230dd2SCorentin Chary static void curses_keyboard_setup(void)
3233e230dd2SCorentin Chary {
3243e230dd2SCorentin Chary #if defined(__APPLE__)
3253e230dd2SCorentin Chary     /* always use generic keymaps */
3263e230dd2SCorentin Chary     if (!keyboard_layout)
3273e230dd2SCorentin Chary         keyboard_layout = "en-us";
3283e230dd2SCorentin Chary #endif
3293e230dd2SCorentin Chary     if(keyboard_layout) {
3303e230dd2SCorentin Chary         kbd_layout = init_keyboard_layout(name2keysym, keyboard_layout);
3313e230dd2SCorentin Chary         if (!kbd_layout)
3323e230dd2SCorentin Chary             exit(1);
3333e230dd2SCorentin Chary     }
3343e230dd2SCorentin Chary }
3353e230dd2SCorentin Chary 
3363e230dd2SCorentin Chary void curses_display_init(DisplayState *ds, int full_screen)
3373e230dd2SCorentin Chary {
3383e230dd2SCorentin Chary     DisplayChangeListener *dcl;
3393e230dd2SCorentin Chary #ifndef _WIN32
3403e230dd2SCorentin Chary     if (!isatty(1)) {
3413e230dd2SCorentin Chary         fprintf(stderr, "We need a terminal output\n");
3423e230dd2SCorentin Chary         exit(1);
3433e230dd2SCorentin Chary     }
3443e230dd2SCorentin Chary #endif
3453e230dd2SCorentin Chary 
3463e230dd2SCorentin Chary     curses_setup();
3473e230dd2SCorentin Chary     curses_keyboard_setup();
3483e230dd2SCorentin Chary     atexit(curses_atexit);
3493e230dd2SCorentin Chary 
3503e230dd2SCorentin Chary #ifndef _WIN32
3513e230dd2SCorentin Chary #if defined(SIGWINCH) && defined(KEY_RESIZE)
3523e230dd2SCorentin Chary     /* some curses implementations provide a handler, but we
3533e230dd2SCorentin Chary      * want to be sure this is handled regardless of the library */
3543e230dd2SCorentin Chary     signal(SIGWINCH, curses_winch_handler);
3553e230dd2SCorentin Chary #endif
3563e230dd2SCorentin Chary #endif
3573e230dd2SCorentin Chary 
3583e230dd2SCorentin Chary     dcl = (DisplayChangeListener *) qemu_mallocz(sizeof(DisplayChangeListener));
3593e230dd2SCorentin Chary     dcl->dpy_update = curses_update;
3603e230dd2SCorentin Chary     dcl->dpy_resize = curses_resize;
3613e230dd2SCorentin Chary     dcl->dpy_refresh = curses_refresh;
3623e230dd2SCorentin Chary     dcl->dpy_text_cursor = curses_cursor_position;
3633e230dd2SCorentin Chary     register_displaychangelistener(ds, dcl);
3643e230dd2SCorentin Chary     qemu_free_displaysurface(ds);
3653e230dd2SCorentin Chary     ds->surface = qemu_create_displaysurface_from(640, 400, 0, 0, (uint8_t*) screen);
3663e230dd2SCorentin Chary 
3673e230dd2SCorentin Chary     invalidate = 1;
3683e230dd2SCorentin Chary }
369