xref: /openbmc/qemu/ui/curses.c (revision cae41fda)
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 "qemu/osdep.h"
25 #include <curses.h>
26 
27 #ifndef _WIN32
28 #include <sys/ioctl.h>
29 #include <termios.h>
30 #endif
31 
32 #include "qemu-common.h"
33 #include "ui/console.h"
34 #include "ui/input.h"
35 #include "sysemu/sysemu.h"
36 
37 #define FONT_HEIGHT 16
38 #define FONT_WIDTH 8
39 
40 static DisplayChangeListener *dcl;
41 static console_ch_t screen[160 * 100];
42 static WINDOW *screenpad = NULL;
43 static int width, height, gwidth, gheight, invalidate;
44 static int px, py, sminx, sminy, smaxx, smaxy;
45 
46 chtype vga_to_curses[256];
47 
48 static void curses_update(DisplayChangeListener *dcl,
49                           int x, int y, int w, int h)
50 {
51     chtype *line;
52 
53     line = ((chtype *) screen) + y * width;
54     for (h += y; y < h; y ++, line += width)
55         mvwaddchnstr(screenpad, y, 0, line, width);
56 
57     pnoutrefresh(screenpad, py, px, sminy, sminx, smaxy - 1, smaxx - 1);
58     refresh();
59 }
60 
61 static void curses_calc_pad(void)
62 {
63     if (qemu_console_is_fixedsize(NULL)) {
64         width = gwidth;
65         height = gheight;
66     } else {
67         width = COLS;
68         height = LINES;
69     }
70 
71     if (screenpad)
72         delwin(screenpad);
73 
74     clear();
75     refresh();
76 
77     screenpad = newpad(height, width);
78 
79     if (width > COLS) {
80         px = (width - COLS) / 2;
81         sminx = 0;
82         smaxx = COLS;
83     } else {
84         px = 0;
85         sminx = (COLS - width) / 2;
86         smaxx = sminx + width;
87     }
88 
89     if (height > LINES) {
90         py = (height - LINES) / 2;
91         sminy = 0;
92         smaxy = LINES;
93     } else {
94         py = 0;
95         sminy = (LINES - height) / 2;
96         smaxy = sminy + height;
97     }
98 }
99 
100 static void curses_resize(DisplayChangeListener *dcl,
101                           int width, int height)
102 {
103     if (width == gwidth && height == gheight) {
104         return;
105     }
106 
107     gwidth = width;
108     gheight = height;
109 
110     curses_calc_pad();
111 }
112 
113 #if !defined(_WIN32) && defined(SIGWINCH) && defined(KEY_RESIZE)
114 static volatile sig_atomic_t got_sigwinch;
115 static void curses_winch_check(void)
116 {
117     struct winsize {
118         unsigned short ws_row;
119         unsigned short ws_col;
120         unsigned short ws_xpixel;   /* unused */
121         unsigned short ws_ypixel;   /* unused */
122     } ws;
123 
124     if (!got_sigwinch) {
125         return;
126     }
127     got_sigwinch = false;
128 
129     if (ioctl(1, TIOCGWINSZ, &ws) == -1) {
130         return;
131     }
132 
133     resize_term(ws.ws_row, ws.ws_col);
134     invalidate = 1;
135 }
136 
137 static void curses_winch_handler(int signum)
138 {
139     got_sigwinch = true;
140 }
141 
142 static void curses_winch_init(void)
143 {
144     struct sigaction old, winch = {
145         .sa_handler  = curses_winch_handler,
146     };
147     sigaction(SIGWINCH, &winch, &old);
148 }
149 #else
150 static void curses_winch_check(void) {}
151 static void curses_winch_init(void) {}
152 #endif
153 
154 static void curses_cursor_position(DisplayChangeListener *dcl,
155                                    int x, int y)
156 {
157     if (x >= 0) {
158         x = sminx + x - px;
159         y = sminy + y - py;
160 
161         if (x >= 0 && y >= 0 && x < COLS && y < LINES) {
162             move(y, x);
163             curs_set(1);
164             /* it seems that curs_set(1) must always be called before
165              * curs_set(2) for the latter to have effect */
166             if (!qemu_console_is_graphic(NULL)) {
167                 curs_set(2);
168             }
169             return;
170         }
171     }
172 
173     curs_set(0);
174 }
175 
176 /* generic keyboard conversion */
177 
178 #include "curses_keys.h"
179 
180 static kbd_layout_t *kbd_layout = NULL;
181 
182 static void curses_refresh(DisplayChangeListener *dcl)
183 {
184     int chr, keysym, keycode, keycode_alt;
185 
186     curses_winch_check();
187 
188     if (invalidate) {
189         clear();
190         refresh();
191         curses_calc_pad();
192         graphic_hw_invalidate(NULL);
193         invalidate = 0;
194     }
195 
196     graphic_hw_text_update(NULL, screen);
197 
198     while (1) {
199         /* while there are any pending key strokes to process */
200         chr = getch();
201 
202         if (chr == ERR)
203             break;
204 
205 #ifdef KEY_RESIZE
206         /* this shouldn't occur when we use a custom SIGWINCH handler */
207         if (chr == KEY_RESIZE) {
208             clear();
209             refresh();
210             curses_calc_pad();
211             curses_update(dcl, 0, 0, width, height);
212             continue;
213         }
214 #endif
215 
216         keycode = curses2keycode[chr];
217         keycode_alt = 0;
218 
219         /* alt key */
220         if (keycode == 1) {
221             int nextchr = getch();
222 
223             if (nextchr != ERR) {
224                 chr = nextchr;
225                 keycode_alt = ALT;
226                 keycode = curses2keycode[chr];
227 
228                 if (keycode != -1) {
229                     keycode |= ALT;
230 
231                     /* process keys reserved for qemu */
232                     if (keycode >= QEMU_KEY_CONSOLE0 &&
233                             keycode < QEMU_KEY_CONSOLE0 + 9) {
234                         erase();
235                         wnoutrefresh(stdscr);
236                         console_select(keycode - QEMU_KEY_CONSOLE0);
237 
238                         invalidate = 1;
239                         continue;
240                     }
241                 }
242             }
243         }
244 
245         if (kbd_layout) {
246             keysym = -1;
247             if (chr < CURSES_KEYS)
248                 keysym = curses2keysym[chr];
249 
250             if (keysym == -1) {
251                 if (chr < ' ') {
252                     keysym = chr + '@';
253                     if (keysym >= 'A' && keysym <= 'Z')
254                         keysym += 'a' - 'A';
255                     keysym |= KEYSYM_CNTRL;
256                 } else
257                     keysym = chr;
258             }
259 
260             keycode = keysym2scancode(kbd_layout, keysym & KEYSYM_MASK);
261             if (keycode == 0)
262                 continue;
263 
264             keycode |= (keysym & ~KEYSYM_MASK) >> 16;
265             keycode |= keycode_alt;
266         }
267 
268         if (keycode == -1)
269             continue;
270 
271         if (qemu_console_is_graphic(NULL)) {
272             /* since terminals don't know about key press and release
273              * events, we need to emit both for each key received */
274             if (keycode & SHIFT) {
275                 qemu_input_event_send_key_number(NULL, SHIFT_CODE, true);
276                 qemu_input_event_send_key_delay(0);
277             }
278             if (keycode & CNTRL) {
279                 qemu_input_event_send_key_number(NULL, CNTRL_CODE, true);
280                 qemu_input_event_send_key_delay(0);
281             }
282             if (keycode & ALT) {
283                 qemu_input_event_send_key_number(NULL, ALT_CODE, true);
284                 qemu_input_event_send_key_delay(0);
285             }
286             if (keycode & ALTGR) {
287                 qemu_input_event_send_key_number(NULL, GREY | ALT_CODE, true);
288                 qemu_input_event_send_key_delay(0);
289             }
290 
291             qemu_input_event_send_key_number(NULL, keycode & KEY_MASK, true);
292             qemu_input_event_send_key_delay(0);
293             qemu_input_event_send_key_number(NULL, keycode & KEY_MASK, false);
294             qemu_input_event_send_key_delay(0);
295 
296             if (keycode & ALTGR) {
297                 qemu_input_event_send_key_number(NULL, GREY | ALT_CODE, false);
298                 qemu_input_event_send_key_delay(0);
299             }
300             if (keycode & ALT) {
301                 qemu_input_event_send_key_number(NULL, ALT_CODE, false);
302                 qemu_input_event_send_key_delay(0);
303             }
304             if (keycode & CNTRL) {
305                 qemu_input_event_send_key_number(NULL, CNTRL_CODE, false);
306                 qemu_input_event_send_key_delay(0);
307             }
308             if (keycode & SHIFT) {
309                 qemu_input_event_send_key_number(NULL, SHIFT_CODE, false);
310                 qemu_input_event_send_key_delay(0);
311             }
312         } else {
313             keysym = -1;
314             if (chr < CURSES_KEYS) {
315                 keysym = curses2qemu[chr];
316             }
317             if (keysym == -1)
318                 keysym = chr;
319 
320             kbd_put_keysym(keysym);
321         }
322     }
323 }
324 
325 static void curses_atexit(void)
326 {
327     endwin();
328 }
329 
330 static void curses_setup(void)
331 {
332     int i, colour_default[8] = {
333         [QEMU_COLOR_BLACK]   = COLOR_BLACK,
334         [QEMU_COLOR_BLUE]    = COLOR_BLUE,
335         [QEMU_COLOR_GREEN]   = COLOR_GREEN,
336         [QEMU_COLOR_CYAN]    = COLOR_CYAN,
337         [QEMU_COLOR_RED]     = COLOR_RED,
338         [QEMU_COLOR_MAGENTA] = COLOR_MAGENTA,
339         [QEMU_COLOR_YELLOW]  = COLOR_YELLOW,
340         [QEMU_COLOR_WHITE]   = COLOR_WHITE,
341     };
342 
343     /* input as raw as possible, let everything be interpreted
344      * by the guest system */
345     initscr(); noecho(); intrflush(stdscr, FALSE);
346     nodelay(stdscr, TRUE); nonl(); keypad(stdscr, TRUE);
347     start_color(); raw(); scrollok(stdscr, FALSE);
348 
349     /* Make color pair to match color format (3bits bg:3bits fg) */
350     for (i = 0; i < 64; i++) {
351         init_pair(i, colour_default[i & 7], colour_default[i >> 3]);
352     }
353     /* Set default color for more than 64 for safety. */
354     for (i = 64; i < COLOR_PAIRS; i++) {
355         init_pair(i, COLOR_WHITE, COLOR_BLACK);
356     }
357 
358     /*
359      * Setup mapping for vga to curses line graphics.
360      * FIXME: for better font, have to use ncursesw and setlocale()
361      */
362 #if 0
363     /* FIXME: map from where? */
364     ACS_S1;
365     ACS_S3;
366     ACS_S7;
367     ACS_S9;
368 #endif
369     /* ACS_* is not constant. So, we can't initialize statically. */
370     vga_to_curses['\0'] = ' ';
371     vga_to_curses[0x04] = ACS_DIAMOND;
372     vga_to_curses[0x18] = ACS_UARROW;
373     vga_to_curses[0x19] = ACS_DARROW;
374     vga_to_curses[0x1a] = ACS_RARROW;
375     vga_to_curses[0x1b] = ACS_LARROW;
376     vga_to_curses[0x9c] = ACS_STERLING;
377     vga_to_curses[0xb0] = ACS_BOARD;
378     vga_to_curses[0xb1] = ACS_CKBOARD;
379     vga_to_curses[0xb3] = ACS_VLINE;
380     vga_to_curses[0xb4] = ACS_RTEE;
381     vga_to_curses[0xbf] = ACS_URCORNER;
382     vga_to_curses[0xc0] = ACS_LLCORNER;
383     vga_to_curses[0xc1] = ACS_BTEE;
384     vga_to_curses[0xc2] = ACS_TTEE;
385     vga_to_curses[0xc3] = ACS_LTEE;
386     vga_to_curses[0xc4] = ACS_HLINE;
387     vga_to_curses[0xc5] = ACS_PLUS;
388     vga_to_curses[0xce] = ACS_LANTERN;
389     vga_to_curses[0xd8] = ACS_NEQUAL;
390     vga_to_curses[0xd9] = ACS_LRCORNER;
391     vga_to_curses[0xda] = ACS_ULCORNER;
392     vga_to_curses[0xdb] = ACS_BLOCK;
393     vga_to_curses[0xe3] = ACS_PI;
394     vga_to_curses[0xf1] = ACS_PLMINUS;
395     vga_to_curses[0xf2] = ACS_GEQUAL;
396     vga_to_curses[0xf3] = ACS_LEQUAL;
397     vga_to_curses[0xf8] = ACS_DEGREE;
398     vga_to_curses[0xfe] = ACS_BULLET;
399 }
400 
401 static void curses_keyboard_setup(void)
402 {
403 #if defined(__APPLE__)
404     /* always use generic keymaps */
405     if (!keyboard_layout)
406         keyboard_layout = "en-us";
407 #endif
408     if(keyboard_layout) {
409         kbd_layout = init_keyboard_layout(name2keysym, keyboard_layout);
410         if (!kbd_layout)
411             exit(1);
412     }
413 }
414 
415 static const DisplayChangeListenerOps dcl_ops = {
416     .dpy_name        = "curses",
417     .dpy_text_update = curses_update,
418     .dpy_text_resize = curses_resize,
419     .dpy_refresh     = curses_refresh,
420     .dpy_text_cursor = curses_cursor_position,
421 };
422 
423 void curses_display_init(DisplayState *ds, int full_screen)
424 {
425 #ifndef _WIN32
426     if (!isatty(1)) {
427         fprintf(stderr, "We need a terminal output\n");
428         exit(1);
429     }
430 #endif
431 
432     curses_setup();
433     curses_keyboard_setup();
434     atexit(curses_atexit);
435 
436     curses_winch_init();
437 
438     dcl = g_new0(DisplayChangeListener, 1);
439     dcl->ops = &dcl_ops;
440     register_displaychangelistener(dcl);
441 
442     invalidate = 1;
443 }
444