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 <signal.h>
28#include <sys/ioctl.h>
29#include <termios.h>
30#endif
31
32#ifdef __OpenBSD__
33#define resize_term resizeterm
34#endif
35
36#include "qemu-common.h"
37#include "ui/console.h"
38#include "sysemu/sysemu.h"
39
40#define FONT_HEIGHT 16
41#define FONT_WIDTH 8
42
43static console_ch_t screen[160 * 100];
44static WINDOW *screenpad = NULL;
45static int width, height, gwidth, gheight, invalidate;
46static int px, py, sminx, sminy, smaxx, smaxy;
47
48static void curses_update(DisplayState *ds, 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
60static void curses_calc_pad(void)
61{
62    if (is_fixedsize_console()) {
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
99static void curses_resize(DisplayState *ds)
100{
101    if (ds_get_width(ds) == gwidth && ds_get_height(ds) == gheight)
102        return;
103
104    gwidth = ds_get_width(ds);
105    gheight = ds_get_height(ds);
106
107    curses_calc_pad();
108    ds->surface->width = width * FONT_WIDTH;
109    ds->surface->height = height * FONT_HEIGHT;
110}
111
112#ifndef _WIN32
113#if defined(SIGWINCH) && defined(KEY_RESIZE)
114static void curses_winch_handler(int signum)
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    /* terminal size changed */
124    if (ioctl(1, TIOCGWINSZ, &ws) == -1)
125        return;
126
127    resize_term(ws.ws_row, ws.ws_col);
128    curses_calc_pad();
129    invalidate = 1;
130
131    /* some systems require this */
132    signal(SIGWINCH, curses_winch_handler);
133}
134#endif
135#endif
136
137static void curses_cursor_position(DisplayState *ds, int x, int y)
138{
139    if (x >= 0) {
140        x = sminx + x - px;
141        y = sminy + y - py;
142
143        if (x >= 0 && y >= 0 && x < COLS && y < LINES) {
144            move(y, x);
145            curs_set(1);
146            /* it seems that curs_set(1) must always be called before
147             * curs_set(2) for the latter to have effect */
148            if (!is_graphic_console())
149                curs_set(2);
150            return;
151        }
152    }
153
154    curs_set(0);
155}
156
157/* generic keyboard conversion */
158
159#include "curses_keys.h"
160
161static kbd_layout_t *kbd_layout = NULL;
162static int keycode2keysym[CURSES_KEYS];
163
164static void curses_refresh(DisplayState *ds)
165{
166    int chr, nextchr, keysym, keycode;
167
168    if (invalidate) {
169        clear();
170        refresh();
171        curses_calc_pad();
172        ds->surface->width = FONT_WIDTH * width;
173        ds->surface->height = FONT_HEIGHT * height;
174        vga_hw_invalidate();
175        invalidate = 0;
176    }
177
178    vga_hw_text_update(screen);
179
180    nextchr = ERR;
181    while (1) {
182        /* while there are any pending key strokes to process */
183        if (nextchr == ERR)
184            chr = getch();
185        else {
186            chr = nextchr;
187            nextchr = ERR;
188        }
189
190        if (chr == ERR)
191            break;
192
193#ifdef KEY_RESIZE
194        /* this shouldn't occur when we use a custom SIGWINCH handler */
195        if (chr == KEY_RESIZE) {
196            clear();
197            refresh();
198            curses_calc_pad();
199            curses_update(ds, 0, 0, width, height);
200            ds->surface->width = FONT_WIDTH * width;
201            ds->surface->height = FONT_HEIGHT * height;
202            continue;
203        }
204#endif
205
206        keycode = curses2keycode[chr];
207        if (keycode == -1)
208            continue;
209
210        /* alt key */
211        if (keycode == 1) {
212            nextchr = getch();
213
214            if (nextchr != ERR) {
215                keycode = curses2keycode[nextchr];
216                nextchr = ERR;
217                if (keycode == -1)
218                    continue;
219
220                keycode |= ALT;
221
222                /* process keys reserved for qemu */
223                if (keycode >= QEMU_KEY_CONSOLE0 &&
224                        keycode < QEMU_KEY_CONSOLE0 + 9) {
225                    erase();
226                    wnoutrefresh(stdscr);
227                    console_select(keycode - QEMU_KEY_CONSOLE0);
228
229                    invalidate = 1;
230                    continue;
231                }
232            }
233        }
234
235        if (kbd_layout && !(keycode & GREY)) {
236            keysym = keycode2keysym[keycode & KEY_MASK];
237            if (keysym == -1)
238                keysym = chr;
239
240            keycode &= ~KEY_MASK;
241            keycode |= keysym2scancode(kbd_layout, keysym);
242        }
243
244        if (is_graphic_console()) {
245            /* since terminals don't know about key press and release
246             * events, we need to emit both for each key received */
247            if (keycode & SHIFT)
248                kbd_put_keycode(SHIFT_CODE);
249            if (keycode & CNTRL)
250                kbd_put_keycode(CNTRL_CODE);
251            if (keycode & ALT)
252                kbd_put_keycode(ALT_CODE);
253            if (keycode & GREY)
254                kbd_put_keycode(GREY_CODE);
255            kbd_put_keycode(keycode & KEY_MASK);
256            if (keycode & GREY)
257                kbd_put_keycode(GREY_CODE);
258            kbd_put_keycode((keycode & KEY_MASK) | KEY_RELEASE);
259            if (keycode & ALT)
260                kbd_put_keycode(ALT_CODE | KEY_RELEASE);
261            if (keycode & CNTRL)
262                kbd_put_keycode(CNTRL_CODE | KEY_RELEASE);
263            if (keycode & SHIFT)
264                kbd_put_keycode(SHIFT_CODE | KEY_RELEASE);
265        } else {
266            keysym = curses2keysym[chr];
267            if (keysym == -1)
268                keysym = chr;
269
270            kbd_put_keysym(keysym);
271        }
272    }
273}
274
275static void curses_cleanup(void *opaque)
276{
277    endwin();
278}
279
280static void curses_atexit(void)
281{
282    curses_cleanup(NULL);
283}
284
285static void curses_setup(void)
286{
287    int i, colour_default[8] = {
288        COLOR_BLACK, COLOR_BLUE, COLOR_GREEN, COLOR_CYAN,
289        COLOR_RED, COLOR_MAGENTA, COLOR_YELLOW, COLOR_WHITE,
290    };
291
292    /* input as raw as possible, let everything be interpreted
293     * by the guest system */
294    initscr(); noecho(); intrflush(stdscr, FALSE);
295    nodelay(stdscr, TRUE); nonl(); keypad(stdscr, TRUE);
296    start_color(); raw(); scrollok(stdscr, FALSE);
297
298    for (i = 0; i < 64; i ++)
299        init_pair(i, colour_default[i & 7], colour_default[i >> 3]);
300}
301
302static void curses_keyboard_setup(void)
303{
304    int i, keycode, keysym;
305
306#if defined(__APPLE__)
307    /* always use generic keymaps */
308    if (!keyboard_layout)
309        keyboard_layout = "en-us";
310#endif
311    if(keyboard_layout) {
312        kbd_layout = init_keyboard_layout(name2keysym, keyboard_layout);
313        if (!kbd_layout)
314            exit(1);
315    }
316
317    for (i = 0; i < CURSES_KEYS; i ++)
318        keycode2keysym[i] = -1;
319
320    for (i = 0; i < CURSES_KEYS; i ++) {
321        if (curses2keycode[i] == -1)
322            continue;
323
324        keycode = curses2keycode[i] & KEY_MASK;
325        if (keycode2keysym[keycode] >= 0)
326            continue;
327
328        for (keysym = 0; keysym < CURSES_KEYS; keysym ++)
329            if (curses2keycode[keysym] == keycode) {
330                keycode2keysym[keycode] = keysym;
331                break;
332            }
333
334        if (keysym >= CURSES_KEYS)
335            keycode2keysym[keycode] = i;
336    }
337}
338
339void curses_display_init(DisplayState *ds, int full_screen)
340{
341    DisplayChangeListener *dcl;
342#ifndef _WIN32
343    if (!isatty(1)) {
344        fprintf(stderr, "We need a terminal output\n");
345        exit(1);
346    }
347#endif
348
349    curses_setup();
350    curses_keyboard_setup();
351    atexit(curses_atexit);
352
353#ifndef _WIN32
354#if defined(SIGWINCH) && defined(KEY_RESIZE)
355    /* some curses implementations provide a handler, but we
356     * want to be sure this is handled regardless of the library */
357    signal(SIGWINCH, curses_winch_handler);
358#endif
359#endif
360
361    dcl = (DisplayChangeListener *) g_malloc0(sizeof(DisplayChangeListener));
362    dcl->dpy_update = curses_update;
363    dcl->dpy_resize = curses_resize;
364    dcl->dpy_refresh = curses_refresh;
365    dcl->dpy_text_cursor = curses_cursor_position;
366    register_displaychangelistener(ds, dcl);
367    qemu_free_displaysurface(ds);
368    ds->surface = qemu_create_displaysurface_from(640, 400, 0, 0, (uint8_t*) screen);
369
370    invalidate = 1;
371}
372