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