Introduce accessors for DisplayState (Stefano Stabellini)
[qemu] / console.h
1 #ifndef CONSOLE_H
2 #define CONSOLE_H
3
4 #include "qemu-char.h"
5
6 /* keyboard/mouse support */
7
8 #define MOUSE_EVENT_LBUTTON 0x01
9 #define MOUSE_EVENT_RBUTTON 0x02
10 #define MOUSE_EVENT_MBUTTON 0x04
11
12 /* in ms */
13 #define GUI_REFRESH_INTERVAL 30
14
15 typedef void QEMUPutKBDEvent(void *opaque, int keycode);
16 typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);
17
18 typedef struct QEMUPutMouseEntry {
19     QEMUPutMouseEvent *qemu_put_mouse_event;
20     void *qemu_put_mouse_event_opaque;
21     int qemu_put_mouse_event_absolute;
22     char *qemu_put_mouse_event_name;
23
24     /* used internally by qemu for handling mice */
25     struct QEMUPutMouseEntry *next;
26 } QEMUPutMouseEntry;
27
28 void qemu_add_kbd_event_handler(QEMUPutKBDEvent *func, void *opaque);
29 QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func,
30                                                 void *opaque, int absolute,
31                                                 const char *name);
32 void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry);
33
34 void kbd_put_keycode(int keycode);
35 void kbd_mouse_event(int dx, int dy, int dz, int buttons_state);
36 int kbd_mouse_is_absolute(void);
37
38 struct mouse_transform_info_s {
39     /* Touchscreen resolution */
40     int x;
41     int y;
42     /* Calibration values as used/generated by tslib */
43     int a[7];
44 };
45
46 void do_info_mice(void);
47 void do_mouse_set(int index);
48
49 /* keysym is a unicode code except for special keys (see QEMU_KEY_xxx
50    constants) */
51 #define QEMU_KEY_ESC1(c) ((c) | 0xe100)
52 #define QEMU_KEY_BACKSPACE  0x007f
53 #define QEMU_KEY_UP         QEMU_KEY_ESC1('A')
54 #define QEMU_KEY_DOWN       QEMU_KEY_ESC1('B')
55 #define QEMU_KEY_RIGHT      QEMU_KEY_ESC1('C')
56 #define QEMU_KEY_LEFT       QEMU_KEY_ESC1('D')
57 #define QEMU_KEY_HOME       QEMU_KEY_ESC1(1)
58 #define QEMU_KEY_END        QEMU_KEY_ESC1(4)
59 #define QEMU_KEY_PAGEUP     QEMU_KEY_ESC1(5)
60 #define QEMU_KEY_PAGEDOWN   QEMU_KEY_ESC1(6)
61 #define QEMU_KEY_DELETE     QEMU_KEY_ESC1(3)
62
63 #define QEMU_KEY_CTRL_UP         0xe400
64 #define QEMU_KEY_CTRL_DOWN       0xe401
65 #define QEMU_KEY_CTRL_LEFT       0xe402
66 #define QEMU_KEY_CTRL_RIGHT      0xe403
67 #define QEMU_KEY_CTRL_HOME       0xe404
68 #define QEMU_KEY_CTRL_END        0xe405
69 #define QEMU_KEY_CTRL_PAGEUP     0xe406
70 #define QEMU_KEY_CTRL_PAGEDOWN   0xe407
71
72 void kbd_put_keysym(int keysym);
73
74 /* consoles */
75
76 struct DisplayState {
77     uint8_t *data;
78     int linesize;
79     int depth;
80     int bgr; /* BGR color order instead of RGB. Only valid for depth == 32 */
81     int width;
82     int height;
83     void *opaque;
84     struct QEMUTimer *gui_timer;
85     uint64_t gui_timer_interval;
86     int idle; /* there is nothing to update (window invisible), set by vnc/sdl */
87
88     void (*dpy_update)(struct DisplayState *s, int x, int y, int w, int h);
89     void (*dpy_resize)(struct DisplayState *s, int w, int h);
90     void (*dpy_refresh)(struct DisplayState *s);
91     void (*dpy_copy)(struct DisplayState *s, int src_x, int src_y,
92                      int dst_x, int dst_y, int w, int h);
93     void (*dpy_fill)(struct DisplayState *s, int x, int y,
94                      int w, int h, uint32_t c);
95     void (*dpy_text_cursor)(struct DisplayState *s, int x, int y);
96     void (*mouse_set)(int x, int y, int on);
97     void (*cursor_define)(int width, int height, int bpp, int hot_x, int hot_y,
98                           uint8_t *image, uint8_t *mask);
99 };
100
101 static inline void dpy_update(DisplayState *s, int x, int y, int w, int h)
102 {
103     s->dpy_update(s, x, y, w, h);
104 }
105
106 static inline void dpy_resize(DisplayState *s, int w, int h)
107 {
108     s->dpy_resize(s, w, h);
109 }
110
111 static inline void dpy_cursor(DisplayState *s, int x, int y)
112 {
113     if (s->dpy_text_cursor)
114         s->dpy_text_cursor(s, x, y);
115 }
116
117 static inline int ds_get_linesize(DisplayState *ds)
118 {
119     return ds->linesize;
120 }
121
122 static inline uint8_t* ds_get_data(DisplayState *ds)
123 {
124     return ds->data;
125 }
126
127 static inline int ds_get_width(DisplayState *ds)
128 {
129     return ds->width;
130 }
131
132 static inline int ds_get_height(DisplayState *ds)
133 {
134     return ds->height;
135 }
136
137 static inline int ds_get_bits_per_pixel(DisplayState *ds)
138 {
139     return ds->depth;
140 }
141
142 typedef unsigned long console_ch_t;
143 static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
144 {
145     cpu_to_le32wu((uint32_t *) dest, ch);
146 }
147
148 typedef void (*vga_hw_update_ptr)(void *);
149 typedef void (*vga_hw_invalidate_ptr)(void *);
150 typedef void (*vga_hw_screen_dump_ptr)(void *, const char *);
151 typedef void (*vga_hw_text_update_ptr)(void *, console_ch_t *);
152
153 TextConsole *graphic_console_init(DisplayState *ds, vga_hw_update_ptr update,
154                                   vga_hw_invalidate_ptr invalidate,
155                                   vga_hw_screen_dump_ptr screen_dump,
156                                   vga_hw_text_update_ptr text_update,
157                                   void *opaque);
158 void vga_hw_update(void);
159 void vga_hw_invalidate(void);
160 void vga_hw_screen_dump(const char *filename);
161 void vga_hw_text_update(console_ch_t *chardata);
162
163 int is_graphic_console(void);
164 int is_fixedsize_console(void);
165 CharDriverState *text_console_init(DisplayState *ds, const char *p);
166 void console_select(unsigned int index);
167 void console_color_init(DisplayState *ds);
168 void qemu_console_resize(QEMUConsole *console, int width, int height);
169 void qemu_console_copy(QEMUConsole *console, int src_x, int src_y,
170                 int dst_x, int dst_y, int w, int h);
171
172 /* sdl.c */
173 void sdl_display_init(DisplayState *ds, int full_screen, int no_frame);
174
175 /* cocoa.m */
176 void cocoa_display_init(DisplayState *ds, int full_screen);
177
178 /* vnc.c */
179 void vnc_display_init(DisplayState *ds);
180 void vnc_display_close(DisplayState *ds);
181 int vnc_display_open(DisplayState *ds, const char *display);
182 int vnc_display_password(DisplayState *ds, const char *password);
183 void do_info_vnc(void);
184
185 /* curses.c */
186 void curses_display_init(DisplayState *ds, int full_screen);
187
188 /* x_keymap.c */
189 extern uint8_t _translate_keycode(const int key);
190
191 /* FIXME: term_printf et al should probably go elsewhere so everything
192    does not need to include console.h  */
193 /* monitor.c */
194 void monitor_init(CharDriverState *hd, int show_banner);
195 void term_puts(const char *str);
196 void term_vprintf(const char *fmt, va_list ap);
197 void term_printf(const char *fmt, ...) __attribute__ ((__format__ (__printf__, 1, 2)));
198 void term_print_filename(const char *filename);
199 void term_flush(void);
200 void term_print_help(void);
201 void monitor_readline(const char *prompt, int is_password,
202                       char *buf, int buf_size);
203 void monitor_suspend(void);
204 void monitor_resume(void);
205
206 /* readline.c */
207 typedef void ReadLineFunc(void *opaque, const char *str);
208
209 extern int completion_index;
210 void add_completion(const char *str);
211 void readline_handle_byte(int ch);
212 void readline_find_completion(const char *cmdline);
213 const char *readline_get_history(unsigned int index);
214 void readline_start(const char *prompt, int is_password,
215                     ReadLineFunc *readline_func, void *opaque);
216
217 #endif