2 * QEMU curses/ncurses display driver
4 * Copyright (c) 2005 Andrzej Zaborowski <balrog@zabor.org>
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
25 #include "qemu/osdep.h"
28 #include <sys/ioctl.h>
36 #include "qapi/error.h"
37 #include "qemu/module.h"
38 #include "ui/console.h"
40 #include "sysemu/sysemu.h"
42 /* KEY_EVENT is defined in wincon.h and in curses.h. Avoid redefinition. */
47 #define FONT_HEIGHT 16
53 CURSES_CHAR_OR_KEYCODE,
56 static DisplayChangeListener *dcl;
57 static console_ch_t screen[160 * 100];
58 static WINDOW *screenpad = NULL;
59 static int width, height, gwidth, gheight, invalidate;
60 static int px, py, sminx, sminy, smaxx, smaxy;
62 static const char *font_charset = "CP437";
63 static cchar_t vga_to_curses[256];
65 static void curses_update(DisplayChangeListener *dcl,
66 int x, int y, int w, int h)
69 cchar_t curses_line[width];
70 wchar_t wch[CCHARW_MAX];
75 line = screen + y * width;
76 for (h += y; y < h; y ++, line += width) {
77 for (x = 0; x < width; x++) {
78 chtype ch = line[x] & 0xff;
79 chtype at = line[x] & ~0xff;
80 ret = getcchar(&vga_to_curses[ch], wch, &attrs, &colors, NULL);
81 if (ret == ERR || wch[0] == 0) {
85 setcchar(&curses_line[x], wch, at, 0, NULL);
87 mvwadd_wchnstr(screenpad, y, 0, curses_line, width);
90 pnoutrefresh(screenpad, py, px, sminy, sminx, smaxy - 1, smaxx - 1);
94 static void curses_calc_pad(void)
96 if (qemu_console_is_fixedsize(NULL)) {
110 screenpad = newpad(height, width);
113 px = (width - COLS) / 2;
118 sminx = (COLS - width) / 2;
119 smaxx = sminx + width;
122 if (height > LINES) {
123 py = (height - LINES) / 2;
128 sminy = (LINES - height) / 2;
129 smaxy = sminy + height;
133 static void curses_resize(DisplayChangeListener *dcl,
134 int width, int height)
136 if (width == gwidth && height == gheight) {
146 #if !defined(_WIN32) && defined(SIGWINCH) && defined(KEY_RESIZE)
147 static volatile sig_atomic_t got_sigwinch;
148 static void curses_winch_check(void)
151 unsigned short ws_row;
152 unsigned short ws_col;
153 unsigned short ws_xpixel; /* unused */
154 unsigned short ws_ypixel; /* unused */
160 got_sigwinch = false;
162 if (ioctl(1, TIOCGWINSZ, &ws) == -1) {
166 resize_term(ws.ws_row, ws.ws_col);
170 static void curses_winch_handler(int signum)
175 static void curses_winch_init(void)
177 struct sigaction old, winch = {
178 .sa_handler = curses_winch_handler,
180 sigaction(SIGWINCH, &winch, &old);
183 static void curses_winch_check(void) {}
184 static void curses_winch_init(void) {}
187 static void curses_cursor_position(DisplayChangeListener *dcl,
194 if (x >= 0 && y >= 0 && x < COLS && y < LINES) {
197 /* it seems that curs_set(1) must always be called before
198 * curs_set(2) for the latter to have effect */
199 if (!qemu_console_is_graphic(NULL)) {
209 /* generic keyboard conversion */
211 #include "curses_keys.h"
213 static kbd_layout_t *kbd_layout = NULL;
215 static wint_t console_getch(enum maybe_keycode *maybe_keycode)
218 switch (get_wch(&ret)) {
220 *maybe_keycode = CURSES_KEYCODE;
223 *maybe_keycode = CURSES_CHAR;
232 static int curses2foo(const int _curses2foo[], const int _curseskey2foo[],
233 int chr, enum maybe_keycode maybe_keycode)
236 if (maybe_keycode == CURSES_CHAR) {
237 if (chr < CURSES_CHARS) {
238 ret = _curses2foo[chr];
241 if (chr < CURSES_KEYS) {
242 ret = _curseskey2foo[chr];
244 if (ret == -1 && maybe_keycode == CURSES_CHAR_OR_KEYCODE &&
245 chr < CURSES_CHARS) {
246 ret = _curses2foo[chr];
252 #define curses2keycode(chr, maybe_keycode) \
253 curses2foo(_curses2keycode, _curseskey2keycode, chr, maybe_keycode)
254 #define curses2keysym(chr, maybe_keycode) \
255 curses2foo(_curses2keysym, _curseskey2keysym, chr, maybe_keycode)
256 #define curses2qemu(chr, maybe_keycode) \
257 curses2foo(_curses2qemu, _curseskey2qemu, chr, maybe_keycode)
259 static void curses_refresh(DisplayChangeListener *dcl)
261 int chr, keysym, keycode, keycode_alt;
262 enum maybe_keycode maybe_keycode;
264 curses_winch_check();
270 graphic_hw_invalidate(NULL);
274 graphic_hw_text_update(NULL, screen);
277 /* while there are any pending key strokes to process */
278 chr = console_getch(&maybe_keycode);
284 /* this shouldn't occur when we use a custom SIGWINCH handler */
285 if (maybe_keycode != CURSES_CHAR && chr == KEY_RESIZE) {
289 curses_update(dcl, 0, 0, width, height);
294 keycode = curses2keycode(chr, maybe_keycode);
299 enum maybe_keycode next_maybe_keycode;
300 int nextchr = console_getch(&next_maybe_keycode);
304 maybe_keycode = next_maybe_keycode;
306 keycode = curses2keycode(chr, maybe_keycode);
311 /* process keys reserved for qemu */
312 if (keycode >= QEMU_KEY_CONSOLE0 &&
313 keycode < QEMU_KEY_CONSOLE0 + 9) {
315 wnoutrefresh(stdscr);
316 console_select(keycode - QEMU_KEY_CONSOLE0);
326 keysym = curses2keysym(chr, maybe_keycode);
331 if (keysym >= 'A' && keysym <= 'Z')
333 keysym |= KEYSYM_CNTRL;
338 keycode = keysym2scancode(kbd_layout, keysym & KEYSYM_MASK,
343 keycode |= (keysym & ~KEYSYM_MASK) >> 16;
344 keycode |= keycode_alt;
350 if (qemu_console_is_graphic(NULL)) {
351 /* since terminals don't know about key press and release
352 * events, we need to emit both for each key received */
353 if (keycode & SHIFT) {
354 qemu_input_event_send_key_number(NULL, SHIFT_CODE, true);
355 qemu_input_event_send_key_delay(0);
357 if (keycode & CNTRL) {
358 qemu_input_event_send_key_number(NULL, CNTRL_CODE, true);
359 qemu_input_event_send_key_delay(0);
362 qemu_input_event_send_key_number(NULL, ALT_CODE, true);
363 qemu_input_event_send_key_delay(0);
365 if (keycode & ALTGR) {
366 qemu_input_event_send_key_number(NULL, GREY | ALT_CODE, true);
367 qemu_input_event_send_key_delay(0);
370 qemu_input_event_send_key_number(NULL, keycode & KEY_MASK, true);
371 qemu_input_event_send_key_delay(0);
372 qemu_input_event_send_key_number(NULL, keycode & KEY_MASK, false);
373 qemu_input_event_send_key_delay(0);
375 if (keycode & ALTGR) {
376 qemu_input_event_send_key_number(NULL, GREY | ALT_CODE, false);
377 qemu_input_event_send_key_delay(0);
380 qemu_input_event_send_key_number(NULL, ALT_CODE, false);
381 qemu_input_event_send_key_delay(0);
383 if (keycode & CNTRL) {
384 qemu_input_event_send_key_number(NULL, CNTRL_CODE, false);
385 qemu_input_event_send_key_delay(0);
387 if (keycode & SHIFT) {
388 qemu_input_event_send_key_number(NULL, SHIFT_CODE, false);
389 qemu_input_event_send_key_delay(0);
392 keysym = curses2qemu(chr, maybe_keycode);
396 kbd_put_keysym(keysym);
401 static void curses_atexit(void)
408 * - fch is the font glyph number
409 * - uch is the unicode value
410 * - wch is the wchar_t value (may not be unicode, e.g. on BSD/solaris)
411 * - mbch is the native local-dependent multibyte representation
414 /* Setup wchar glyph for one UCS-2 char */
415 static void convert_ucs(unsigned char fch, uint16_t uch, iconv_t conv)
417 char mbch[MB_LEN_MAX];
423 puch = (char *) &uch;
424 pmbch = (char *) mbch;
426 smbch = sizeof(mbch);
428 if (iconv(conv, &puch, &such, &pmbch, &smbch) == (size_t) -1) {
429 fprintf(stderr, "Could not convert 0x%04x "
430 "from UCS-2 to a multibyte character: %s\n",
431 uch, strerror(errno));
435 memset(&ps, 0, sizeof(ps));
436 if (mbrtowc(&wch[0], mbch, sizeof(mbch) - smbch, &ps) == -1) {
437 fprintf(stderr, "Could not convert 0x%04x "
438 "from a multibyte character to wchar_t: %s\n",
439 uch, strerror(errno));
444 setcchar(&vga_to_curses[fch], wch, 0, 0, NULL);
447 /* Setup wchar glyph for one font character */
448 static void convert_font(unsigned char fch, iconv_t conv)
450 char mbch[MB_LEN_MAX];
456 pfch = (char *) &fch;
457 pmbch = (char *) &mbch;
459 smbch = sizeof(mbch);
461 if (iconv(conv, &pfch, &sfch, &pmbch, &smbch) == (size_t) -1) {
462 fprintf(stderr, "Could not convert font glyph 0x%02x "
463 "from %s to a multibyte character: %s\n",
464 fch, font_charset, strerror(errno));
468 memset(&ps, 0, sizeof(ps));
469 if (mbrtowc(&wch[0], mbch, sizeof(mbch) - smbch, &ps) == -1) {
470 fprintf(stderr, "Could not convert font glyph 0x%02x "
471 "from a multibyte character to wchar_t: %s\n",
472 fch, strerror(errno));
477 setcchar(&vga_to_curses[fch], wch, 0, 0, NULL);
480 /* Convert one wchar to UCS-2 */
481 static uint16_t get_ucs(wchar_t wch, iconv_t conv)
483 char mbch[MB_LEN_MAX];
490 memset(&ps, 0, sizeof(ps));
491 ret = wcrtomb(mbch, wch, &ps);
493 fprintf(stderr, "Could not convert 0x%04lx "
494 "from wchar_t to a multibyte character: %s\n",
495 (unsigned long)wch, strerror(errno));
499 pmbch = (char *) mbch;
500 puch = (char *) &uch;
504 if (iconv(conv, &pmbch, &smbch, &puch, &such) == (size_t) -1) {
505 fprintf(stderr, "Could not convert 0x%04lx "
506 "from a multibyte character to UCS-2 : %s\n",
507 (unsigned long)wch, strerror(errno));
515 * Setup mapping for vga to curses line graphics.
517 static void font_setup(void)
519 iconv_t ucs2_to_nativecharset;
520 iconv_t nativecharset_to_ucs2;
525 * Control characters are normally non-printable, but VGA does have
526 * well-known glyphs for them.
528 static uint16_t control_characters[0x20] = {
563 ucs2_to_nativecharset = iconv_open(nl_langinfo(CODESET), "UCS-2");
564 if (ucs2_to_nativecharset == (iconv_t) -1) {
565 fprintf(stderr, "Could not convert font glyphs from UCS-2: '%s'\n",
570 nativecharset_to_ucs2 = iconv_open("UCS-2", nl_langinfo(CODESET));
571 if (nativecharset_to_ucs2 == (iconv_t) -1) {
572 iconv_close(ucs2_to_nativecharset);
573 fprintf(stderr, "Could not convert font glyphs to UCS-2: '%s'\n",
578 font_conv = iconv_open(nl_langinfo(CODESET), font_charset);
579 if (font_conv == (iconv_t) -1) {
580 iconv_close(ucs2_to_nativecharset);
581 iconv_close(nativecharset_to_ucs2);
582 fprintf(stderr, "Could not convert font glyphs from %s: '%s'\n",
583 font_charset, strerror(errno));
587 /* Control characters */
588 for (i = 0; i <= 0x1F; i++) {
589 convert_ucs(i, control_characters[i], ucs2_to_nativecharset);
592 for (i = 0x20; i <= 0xFF; i++) {
593 convert_font(i, font_conv);
597 convert_ucs(0x7F, 0x2302, ucs2_to_nativecharset);
599 if (strcmp(nl_langinfo(CODESET), "UTF-8")) {
600 /* Non-Unicode capable, use termcap equivalents for those available */
601 for (i = 0; i <= 0xFF; i++) {
602 wchar_t wch[CCHARW_MAX];
607 ret = getcchar(&vga_to_curses[i], wch, &attr, &color, NULL);
611 switch (get_ucs(wch[0], nativecharset_to_ucs2)) {
613 vga_to_curses[i] = *WACS_STERLING;
616 vga_to_curses[i] = *WACS_BOARD;
619 vga_to_curses[i] = *WACS_CKBOARD;
622 vga_to_curses[i] = *WACS_VLINE;
625 vga_to_curses[i] = *WACS_RTEE;
628 vga_to_curses[i] = *WACS_URCORNER;
631 vga_to_curses[i] = *WACS_LLCORNER;
634 vga_to_curses[i] = *WACS_BTEE;
637 vga_to_curses[i] = *WACS_TTEE;
640 vga_to_curses[i] = *WACS_LTEE;
643 vga_to_curses[i] = *WACS_HLINE;
646 vga_to_curses[i] = *WACS_PLUS;
649 vga_to_curses[i] = *WACS_LANTERN;
652 vga_to_curses[i] = *WACS_NEQUAL;
655 vga_to_curses[i] = *WACS_LRCORNER;
658 vga_to_curses[i] = *WACS_ULCORNER;
661 vga_to_curses[i] = *WACS_BLOCK;
664 vga_to_curses[i] = *WACS_PI;
667 vga_to_curses[i] = *WACS_PLMINUS;
670 vga_to_curses[i] = *WACS_GEQUAL;
673 vga_to_curses[i] = *WACS_LEQUAL;
676 vga_to_curses[i] = *WACS_DEGREE;
679 vga_to_curses[i] = *WACS_BULLET;
682 vga_to_curses[i] = *WACS_DIAMOND;
685 vga_to_curses[i] = *WACS_RARROW;
688 vga_to_curses[i] = *WACS_LARROW;
691 vga_to_curses[i] = *WACS_UARROW;
694 vga_to_curses[i] = *WACS_DARROW;
697 vga_to_curses[i] = *WACS_S1;
700 vga_to_curses[i] = *WACS_S3;
703 vga_to_curses[i] = *WACS_S7;
706 vga_to_curses[i] = *WACS_S9;
711 iconv_close(ucs2_to_nativecharset);
712 iconv_close(nativecharset_to_ucs2);
713 iconv_close(font_conv);
716 static void curses_setup(void)
718 int i, colour_default[8] = {
719 [QEMU_COLOR_BLACK] = COLOR_BLACK,
720 [QEMU_COLOR_BLUE] = COLOR_BLUE,
721 [QEMU_COLOR_GREEN] = COLOR_GREEN,
722 [QEMU_COLOR_CYAN] = COLOR_CYAN,
723 [QEMU_COLOR_RED] = COLOR_RED,
724 [QEMU_COLOR_MAGENTA] = COLOR_MAGENTA,
725 [QEMU_COLOR_YELLOW] = COLOR_YELLOW,
726 [QEMU_COLOR_WHITE] = COLOR_WHITE,
729 /* input as raw as possible, let everything be interpreted
730 * by the guest system */
731 initscr(); noecho(); intrflush(stdscr, FALSE);
732 nodelay(stdscr, TRUE); nonl(); keypad(stdscr, TRUE);
733 start_color(); raw(); scrollok(stdscr, FALSE);
736 /* Make color pair to match color format (3bits bg:3bits fg) */
737 for (i = 0; i < 64; i++) {
738 init_pair(i, colour_default[i & 7], colour_default[i >> 3]);
740 /* Set default color for more than 64 for safety. */
741 for (i = 64; i < COLOR_PAIRS; i++) {
742 init_pair(i, COLOR_WHITE, COLOR_BLACK);
748 static void curses_keyboard_setup(void)
750 #if defined(__APPLE__)
751 /* always use generic keymaps */
752 if (!keyboard_layout)
753 keyboard_layout = "en-us";
755 if(keyboard_layout) {
756 kbd_layout = init_keyboard_layout(name2keysym, keyboard_layout,
761 static const DisplayChangeListenerOps dcl_ops = {
762 .dpy_name = "curses",
763 .dpy_text_update = curses_update,
764 .dpy_text_resize = curses_resize,
765 .dpy_refresh = curses_refresh,
766 .dpy_text_cursor = curses_cursor_position,
769 static void curses_display_init(DisplayState *ds, DisplayOptions *opts)
773 fprintf(stderr, "We need a terminal output\n");
778 setlocale(LC_CTYPE, "");
779 if (opts->u.curses.charset) {
780 font_charset = opts->u.curses.charset;
783 curses_keyboard_setup();
784 atexit(curses_atexit);
788 dcl = g_new0(DisplayChangeListener, 1);
790 register_displaychangelistener(dcl);
795 static QemuDisplay qemu_display_curses = {
796 .type = DISPLAY_TYPE_CURSES,
797 .init = curses_display_init,
800 static void register_curses(void)
802 qemu_display_register(&qemu_display_curses);
805 type_init(register_curses);