]> Git Repo - qemu.git/blame - include/ui/console.h
Merge remote-tracking branch 'remotes/stefanha/tags/block-pull-request' into staging
[qemu.git] / include / ui / console.h
CommitLineData
87ecb68b
PB
1#ifndef CONSOLE_H
2#define CONSOLE_H
3
28ecbaee 4#include "ui/qemu-pixman.h"
95be0669 5#include "qom/object.h"
7b1b5d19 6#include "qapi/qmp/qdict.h"
1de7afc9 7#include "qemu/notify.h"
83c9089e 8#include "monitor/monitor.h"
1048c88f 9#include "qapi-types.h"
7b1b5d19 10#include "qapi/error.h"
87ecb68b
PB
11
12/* keyboard/mouse support */
13
14#define MOUSE_EVENT_LBUTTON 0x01
15#define MOUSE_EVENT_RBUTTON 0x02
16#define MOUSE_EVENT_MBUTTON 0x04
21bae11a
GH
17#define MOUSE_EVENT_WHEELUP 0x08
18#define MOUSE_EVENT_WHEELDN 0x10
87ecb68b 19
03a23a85
GH
20/* identical to the ps/2 keyboard bits */
21#define QEMU_SCROLL_LOCK_LED (1 << 0)
22#define QEMU_NUM_LOCK_LED (1 << 1)
23#define QEMU_CAPS_LOCK_LED (1 << 2)
24
7ed9eba3 25/* in ms */
0f7b2864
GH
26#define GUI_REFRESH_INTERVAL_DEFAULT 30
27#define GUI_REFRESH_INTERVAL_IDLE 3000
7ed9eba3 28
87ecb68b 29typedef void QEMUPutKBDEvent(void *opaque, int keycode);
03a23a85 30typedef void QEMUPutLEDEvent(void *opaque, int ledstate);
87ecb68b
PB
31typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);
32
72711efb 33typedef struct QEMUPutMouseEntry QEMUPutMouseEntry;
5a37532d 34typedef struct QEMUPutKbdEntry QEMUPutKbdEntry;
72711efb 35typedef struct QEMUPutLEDEntry QEMUPutLEDEntry;
03a23a85 36
5a37532d
GH
37QEMUPutKbdEntry *qemu_add_kbd_event_handler(QEMUPutKBDEvent *func,
38 void *opaque);
39void qemu_remove_kbd_event_handler(QEMUPutKbdEntry *entry);
87ecb68b
PB
40QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func,
41 void *opaque, int absolute,
42 const char *name);
43void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry);
6fef28ee
AL
44void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry);
45
03a23a85
GH
46QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque);
47void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry);
87ecb68b 48
03a23a85 49void kbd_put_ledstate(int ledstate);
eb2e259d 50
bc24a225 51struct MouseTransformInfo {
a5d7eb65
AZ
52 /* Touchscreen resolution */
53 int x;
54 int y;
55 /* Calibration values as used/generated by tslib */
56 int a[7];
57};
58
d54908a5 59void do_mouse_set(Monitor *mon, const QDict *qdict);
87ecb68b
PB
60
61/* keysym is a unicode code except for special keys (see QEMU_KEY_xxx
62 constants) */
63#define QEMU_KEY_ESC1(c) ((c) | 0xe100)
64#define QEMU_KEY_BACKSPACE 0x007f
65#define QEMU_KEY_UP QEMU_KEY_ESC1('A')
66#define QEMU_KEY_DOWN QEMU_KEY_ESC1('B')
67#define QEMU_KEY_RIGHT QEMU_KEY_ESC1('C')
68#define QEMU_KEY_LEFT QEMU_KEY_ESC1('D')
69#define QEMU_KEY_HOME QEMU_KEY_ESC1(1)
70#define QEMU_KEY_END QEMU_KEY_ESC1(4)
71#define QEMU_KEY_PAGEUP QEMU_KEY_ESC1(5)
72#define QEMU_KEY_PAGEDOWN QEMU_KEY_ESC1(6)
73#define QEMU_KEY_DELETE QEMU_KEY_ESC1(3)
74
75#define QEMU_KEY_CTRL_UP 0xe400
76#define QEMU_KEY_CTRL_DOWN 0xe401
77#define QEMU_KEY_CTRL_LEFT 0xe402
78#define QEMU_KEY_CTRL_RIGHT 0xe403
79#define QEMU_KEY_CTRL_HOME 0xe404
80#define QEMU_KEY_CTRL_END 0xe405
81#define QEMU_KEY_CTRL_PAGEUP 0xe406
82#define QEMU_KEY_CTRL_PAGEDOWN 0xe407
83
3f9a6e85 84void kbd_put_keysym_console(QemuConsole *s, int keysym);
50ef4679 85bool kbd_put_qcode_console(QemuConsole *s, int qcode);
bdef9724 86void kbd_put_string_console(QemuConsole *s, const char *str, int len);
87ecb68b
PB
87void kbd_put_keysym(int keysym);
88
89/* consoles */
90
95be0669
GH
91#define TYPE_QEMU_CONSOLE "qemu-console"
92#define QEMU_CONSOLE(obj) \
93 OBJECT_CHECK(QemuConsole, (obj), TYPE_QEMU_CONSOLE)
94#define QEMU_CONSOLE_GET_CLASS(obj) \
95 OBJECT_GET_CLASS(QemuConsoleClass, (obj), TYPE_QEMU_CONSOLE)
96#define QEMU_CONSOLE_CLASS(klass) \
97 OBJECT_CLASS_CHECK(QemuConsoleClass, (klass), TYPE_QEMU_CONSOLE)
98
99typedef struct QemuConsoleClass QemuConsoleClass;
100
101struct QemuConsoleClass {
102 ObjectClass parent_class;
103};
104
7d957bd8
AL
105#define QEMU_BIG_ENDIAN_FLAG 0x01
106#define QEMU_ALLOCATED_FLAG 0x02
107
108struct PixelFormat {
109 uint8_t bits_per_pixel;
110 uint8_t bytes_per_pixel;
111 uint8_t depth; /* color depth in bits */
112 uint32_t rmask, gmask, bmask, amask;
113 uint8_t rshift, gshift, bshift, ashift;
114 uint8_t rmax, gmax, bmax, amax;
90a1e3c0 115 uint8_t rbits, gbits, bbits, abits;
7d957bd8
AL
116};
117
118struct DisplaySurface {
69c77777
GH
119 pixman_format_code_t format;
120 pixman_image_t *image;
7d957bd8 121 uint8_t flags;
7d957bd8
AL
122
123 struct PixelFormat pf;
124};
125
6f90f3d7
GH
126typedef struct QemuUIInfo {
127 /* geometry */
128 int xoff;
129 int yoff;
130 uint32_t width;
131 uint32_t height;
132} QemuUIInfo;
133
254e5950
GH
134/* cursor data format is 32bit RGBA */
135typedef struct QEMUCursor {
136 int width, height;
137 int hot_x, hot_y;
138 int refcount;
139 uint32_t data[];
140} QEMUCursor;
141
142QEMUCursor *cursor_alloc(int width, int height);
143void cursor_get(QEMUCursor *c);
144void cursor_put(QEMUCursor *c);
145QEMUCursor *cursor_builtin_hidden(void);
146QEMUCursor *cursor_builtin_left_ptr(void);
147void cursor_print_ascii_art(QEMUCursor *c, const char *prefix);
148int cursor_get_mono_bpl(QEMUCursor *c);
149void cursor_set_mono(QEMUCursor *c,
150 uint32_t foreground, uint32_t background, uint8_t *image,
151 int transparent, uint8_t *mask);
152void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask);
153void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask);
154
7c20b4a3
GH
155typedef struct DisplayChangeListenerOps {
156 const char *dpy_name;
157
bc2ed970 158 void (*dpy_refresh)(DisplayChangeListener *dcl);
7c20b4a3
GH
159
160 void (*dpy_gfx_update)(DisplayChangeListener *dcl,
7c20b4a3 161 int x, int y, int w, int h);
c12aeb86 162 void (*dpy_gfx_switch)(DisplayChangeListener *dcl,
c12aeb86 163 struct DisplaySurface *new_surface);
7c20b4a3 164 void (*dpy_gfx_copy)(DisplayChangeListener *dcl,
bc2ed970 165 int src_x, int src_y,
a93a4a22 166 int dst_x, int dst_y, int w, int h);
a93a4a22 167
7c20b4a3 168 void (*dpy_text_cursor)(DisplayChangeListener *dcl,
7c20b4a3
GH
169 int x, int y);
170 void (*dpy_text_resize)(DisplayChangeListener *dcl,
7c20b4a3
GH
171 int w, int h);
172 void (*dpy_text_update)(DisplayChangeListener *dcl,
7c20b4a3
GH
173 int x, int y, int w, int h);
174
175 void (*dpy_mouse_set)(DisplayChangeListener *dcl,
7c20b4a3
GH
176 int x, int y, int on);
177 void (*dpy_cursor_define)(DisplayChangeListener *dcl,
7c20b4a3
GH
178 QEMUCursor *cursor);
179} DisplayChangeListenerOps;
7d957bd8 180
7c20b4a3 181struct DisplayChangeListener {
0f7b2864 182 uint64_t update_interval;
7c20b4a3
GH
183 const DisplayChangeListenerOps *ops;
184 DisplayState *ds;
284d1c6b 185 QemuConsole *con;
bf2fde70 186
87e487a1 187 QLIST_ENTRY(DisplayChangeListener) next;
7d957bd8
AL
188};
189
64840c66 190DisplayState *init_displaystate(void);
7d957bd8 191DisplaySurface* qemu_create_displaysurface_from(int width, int height, int bpp,
b1424e03
GH
192 int linesize, uint8_t *data,
193 bool byteswap);
0da2ea1b 194PixelFormat qemu_different_endianness_pixelformat(int bpp);
195PixelFormat qemu_default_pixelformat(int bpp);
7d957bd8 196
da229ef3
GH
197DisplaySurface *qemu_create_displaysurface(int width, int height);
198void qemu_free_displaysurface(DisplaySurface *surface);
7b5d76da
AL
199
200static inline int is_surface_bgr(DisplaySurface *surface)
201{
202 if (surface->pf.bits_per_pixel == 32 && surface->pf.rshift == 0)
203 return 1;
204 else
205 return 0;
206}
207
7d957bd8
AL
208static inline int is_buffer_shared(DisplaySurface *surface)
209{
187cd1d9 210 return !(surface->flags & QEMU_ALLOCATED_FLAG);
7d957bd8
AL
211}
212
5209089f 213void register_displaychangelistener(DisplayChangeListener *dcl);
0f7b2864
GH
214void update_displaychangelistener(DisplayChangeListener *dcl,
215 uint64_t interval);
7c20b4a3
GH
216void unregister_displaychangelistener(DisplayChangeListener *dcl);
217
6f90f3d7
GH
218int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info);
219
c78f7137
GH
220void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
221void dpy_gfx_replace_surface(QemuConsole *con,
da229ef3 222 DisplaySurface *surface);
c78f7137 223void dpy_gfx_copy(QemuConsole *con, int src_x, int src_y,
7c20b4a3 224 int dst_x, int dst_y, int w, int h);
c78f7137
GH
225void dpy_text_cursor(QemuConsole *con, int x, int y);
226void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
227void dpy_text_resize(QemuConsole *con, int w, int h);
228void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
229void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor);
230bool dpy_cursor_define_supported(QemuConsole *con);
bf2fde70 231
626e3b34
GH
232static inline int surface_stride(DisplaySurface *s)
233{
234 return pixman_image_get_stride(s->image);
235}
236
237static inline void *surface_data(DisplaySurface *s)
238{
239 return pixman_image_get_data(s->image);
240}
241
242static inline int surface_width(DisplaySurface *s)
243{
244 return pixman_image_get_width(s->image);
245}
246
247static inline int surface_height(DisplaySurface *s)
248{
249 return pixman_image_get_height(s->image);
250}
251
252static inline int surface_bits_per_pixel(DisplaySurface *s)
253{
254 int bits = PIXMAN_FORMAT_BPP(s->format);
255 return bits;
256}
257
258static inline int surface_bytes_per_pixel(DisplaySurface *s)
259{
260 int bits = PIXMAN_FORMAT_BPP(s->format);
261 return (bits + 7) / 8;
262}
263
df00bed0
DP
264#ifdef CONFIG_CURSES
265#include <curses.h>
266typedef chtype console_ch_t;
267#else
c227f099 268typedef unsigned long console_ch_t;
df00bed0 269#endif
c227f099 270static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
4d3b6f6e 271{
f6d20d0f
BK
272 if (!(ch & 0xff))
273 ch |= ' ';
9ae19b65 274 *dest = ch;
4d3b6f6e
AZ
275}
276
380cd056
GH
277typedef struct GraphicHwOps {
278 void (*invalidate)(void *opaque);
279 void (*gfx_update)(void *opaque);
280 void (*text_update)(void *opaque, console_ch_t *text);
dea1b0bd 281 void (*update_interval)(void *opaque, uint64_t interval);
6f90f3d7 282 int (*ui_info)(void *opaque, uint32_t head, QemuUIInfo *info);
380cd056 283} GraphicHwOps;
87ecb68b 284
5643706a 285QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head,
aa2beaa1 286 const GraphicHwOps *ops,
c78f7137 287 void *opaque);
3023f332 288
1dbfa005
GH
289void graphic_hw_update(QemuConsole *con);
290void graphic_hw_invalidate(QemuConsole *con);
291void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata);
87ecb68b 292
284d1c6b 293QemuConsole *qemu_console_lookup_by_index(unsigned int index);
5643706a 294QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head);
81c0d5a6
GH
295bool qemu_console_is_visible(QemuConsole *con);
296bool qemu_console_is_graphic(QemuConsole *con);
297bool qemu_console_is_fixedsize(QemuConsole *con);
d4c85337 298int qemu_console_get_index(QemuConsole *con);
5643706a 299uint32_t qemu_console_get_head(QemuConsole *con);
6f90f3d7 300QemuUIInfo *qemu_console_get_ui_info(QemuConsole *con);
d4c85337
GH
301int qemu_console_get_width(QemuConsole *con, int fallback);
302int qemu_console_get_height(QemuConsole *con, int fallback);
81c0d5a6 303
2796dae0 304void text_consoles_set_display(DisplayState *ds);
87ecb68b
PB
305void console_select(unsigned int index);
306void console_color_init(DisplayState *ds);
c78f7137
GH
307void qemu_console_resize(QemuConsole *con, int width, int height);
308void qemu_console_copy(QemuConsole *con, int src_x, int src_y,
3023f332 309 int dst_x, int dst_y, int w, int h);
c78f7137
GH
310DisplaySurface *qemu_console_surface(QemuConsole *con);
311DisplayState *qemu_console_displaystate(QemuConsole *console);
87ecb68b
PB
312
313/* sdl.c */
314void sdl_display_init(DisplayState *ds, int full_screen, int no_frame);
315
316/* cocoa.m */
317void cocoa_display_init(DisplayState *ds, int full_screen);
318
319/* vnc.c */
320void vnc_display_init(DisplayState *ds);
007fcd3e 321void vnc_display_open(DisplayState *ds, const char *display, Error **errp);
2c8cf549 322void vnc_display_add_client(DisplayState *ds, int csock, bool skipauth);
821601ea
JS
323char *vnc_display_local_addr(DisplayState *ds);
324#ifdef CONFIG_VNC
325int vnc_display_password(DisplayState *ds, const char *password);
3c9405a0 326int vnc_display_pw_expire(DisplayState *ds, time_t expires);
821601ea
JS
327#else
328static inline int vnc_display_password(DisplayState *ds, const char *password)
329{
821601ea
JS
330 return -ENODEV;
331}
332static inline int vnc_display_pw_expire(DisplayState *ds, time_t expires)
333{
821601ea
JS
334 return -ENODEV;
335};
821601ea 336#endif
87ecb68b 337
4d3b6f6e
AZ
338/* curses.c */
339void curses_display_init(DisplayState *ds, int full_screen);
340
1048c88f 341/* input.c */
1048c88f 342int index_from_key(const char *key);
1048c88f 343
a4ccabcf
AL
344/* gtk.c */
345void early_gtk_display_init(void);
881249c7 346void gtk_display_init(DisplayState *ds, bool full_screen, bool grab_on_hover);
a4ccabcf 347
87ecb68b 348#endif
This page took 0.524185 seconds and 4 git commands to generate.