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 #define QEMU_BIG_ENDIAN_FLAG    0x01
  77 #define QEMU_ALLOCATED_FLAG     0x02
  78
  79 struct PixelFormat {
  80     uint8_t bits_per_pixel;
  81     uint8_t bytes_per_pixel;
  82     uint8_t depth; /* color depth in bits */
  83     uint32_t rmask, gmask, bmask, amask;
  84     uint8_t rshift, gshift, bshift, ashift;
  85     uint8_t rmax, gmax, bmax, amax;
  86 };
  87
  88 struct DisplaySurface {
  89     uint8_t flags;
  90     int width;
  91     int height;
  92     int linesize;        /* bytes per line */
  93     uint8_t *data;
  94
  95     struct PixelFormat pf;
  96 };
  97
  98 struct DisplayChangeListener {
  99     int idle;
 100     uint64_t gui_timer_interval;
 101
 102     void (*dpy_update)(struct DisplayState *s, int x, int y, int w, int h);
 103     void (*dpy_resize)(struct DisplayState *s);
 104     void (*dpy_setdata)(struct DisplayState *s);
 105     void (*dpy_refresh)(struct DisplayState *s);
 106     void (*dpy_copy)(struct DisplayState *s, int src_x, int src_y,
 107                      int dst_x, int dst_y, int w, int h);
 108     void (*dpy_fill)(struct DisplayState *s, int x, int y,
 109                      int w, int h, uint32_t c);
 110     void (*dpy_text_cursor)(struct DisplayState *s, int x, int y);
 111
 112     struct DisplayChangeListener *next;
 113 };
 114
 115 struct DisplayState {
 116     struct DisplaySurface *surface;
 117     void *opaque;
 118     struct QEMUTimer *gui_timer;
 119
 120     struct DisplayChangeListener* listeners;
 121
 122     void (*mouse_set)(int x, int y, int on);
 123     void (*cursor_define)(int width, int height, int bpp, int hot_x, int hot_y,
 124                           uint8_t *image, uint8_t *mask);
 125 };
 126
 127 DisplaySurface* qemu_create_displaysurface(int width, int height, int bpp, int linesize);
 128 DisplaySurface* qemu_resize_displaysurface(DisplaySurface *surface,
 129                                            int width, int height, int bpp, int linesize);
 130 DisplaySurface* qemu_create_displaysurface_from(int width, int height, int bpp,
 131                                                 int linesize, uint8_t *data);
 132 void qemu_free_displaysurface(DisplaySurface *surface);
 133
 134 static inline int is_buffer_shared(DisplaySurface *surface)
 135 {
 136     return (!(surface->flags & QEMU_ALLOCATED_FLAG));
 137 }
 138
 139 static inline void register_displaychangelistener(DisplayState *ds, DisplayChangeListener *dcl)
 140 {
 141     dcl->next = ds->listeners;
 142     ds->listeners = dcl;
 143 }
 144
 145 static inline void dpy_update(DisplayState *s, int x, int y, int w, int h)
 146 {
 147     struct DisplayChangeListener *dcl = s->listeners;
 148     while (dcl != NULL) {
 149         dcl->dpy_update(s, x, y, w, h);
 150         dcl = dcl->next;
 151     }
 152 }
 153
 154 static inline void dpy_resize(DisplayState *s)
 155 {
 156     struct DisplayChangeListener *dcl = s->listeners;
 157     while (dcl != NULL) {
 158         dcl->dpy_resize(s);
 159         dcl = dcl->next;
 160     }
 161 }
 162
 163 static inline void dpy_setdata(DisplayState *s)
 164 {
 165     struct DisplayChangeListener *dcl = s->listeners;
 166     while (dcl != NULL) {
 167         if (dcl->dpy_setdata) dcl->dpy_setdata(s);
 168         dcl = dcl->next;
 169     }
 170 }
 171
 172 static inline void dpy_refresh(DisplayState *s)
 173 {
 174     struct DisplayChangeListener *dcl = s->listeners;
 175     while (dcl != NULL) {
 176         if (dcl->dpy_refresh) dcl->dpy_refresh(s);
 177         dcl = dcl->next;
 178     }
 179 }
 180
 181 static inline void dpy_copy(struct DisplayState *s, int src_x, int src_y,
 182                              int dst_x, int dst_y, int w, int h) {
 183     struct DisplayChangeListener *dcl = s->listeners;
 184     while (dcl != NULL) {
 185         if (dcl->dpy_copy)
 186             dcl->dpy_copy(s, src_x, src_y, dst_x, dst_y, w, h);
 187         else /* TODO */
 188             dcl->dpy_update(s, dst_x, dst_y, w, h);
 189         dcl = dcl->next;
 190     }
 191 }
 192
 193 static inline void dpy_fill(struct DisplayState *s, int x, int y,
 194                              int w, int h, uint32_t c) {
 195     struct DisplayChangeListener *dcl = s->listeners;
 196     while (dcl != NULL) {
 197         if (dcl->dpy_fill) dcl->dpy_fill(s, x, y, w, h, c);
 198         dcl = dcl->next;
 199     }
 200 }
 201
 202 static inline void dpy_cursor(struct DisplayState *s, int x, int y) {
 203     struct DisplayChangeListener *dcl = s->listeners;
 204     while (dcl != NULL) {
 205         if (dcl->dpy_text_cursor) dcl->dpy_text_cursor(s, x, y);
 206         dcl = dcl->next;
 207     }
 208 }
 209
 210 static inline int ds_get_linesize(DisplayState *ds)
 211 {
 212     return ds->surface->linesize;
 213 }
 214
 215 static inline uint8_t* ds_get_data(DisplayState *ds)
 216 {
 217     return ds->surface->data;
 218 }
 219
 220 static inline int ds_get_width(DisplayState *ds)
 221 {
 222     return ds->surface->width;
 223 }
 224
 225 static inline int ds_get_height(DisplayState *ds)
 226 {
 227     return ds->surface->height;
 228 }
 229
 230 static inline int ds_get_bits_per_pixel(DisplayState *ds)
 231 {
 232     return ds->surface->pf.bits_per_pixel;
 233 }
 234
 235 static inline int ds_get_bytes_per_pixel(DisplayState *ds)
 236 {
 237     return ds->surface->pf.bytes_per_pixel;
 238 }
 239
 240 typedef unsigned long console_ch_t;
 241 static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
 242 {
 243     cpu_to_le32wu((uint32_t *) dest, ch);
 244 }
 245
 246 typedef void (*vga_hw_update_ptr)(void *);
 247 typedef void (*vga_hw_invalidate_ptr)(void *);
 248 typedef void (*vga_hw_screen_dump_ptr)(void *, const char *);
 249 typedef void (*vga_hw_text_update_ptr)(void *, console_ch_t *);
 250
 251 TextConsole *graphic_console_init(DisplayState *ds, vga_hw_update_ptr update,
 252                                   vga_hw_invalidate_ptr invalidate,
 253                                   vga_hw_screen_dump_ptr screen_dump,
 254                                   vga_hw_text_update_ptr text_update,
 255                                   void *opaque);
 256 void vga_hw_update(void);
 257 void vga_hw_invalidate(void);
 258 void vga_hw_screen_dump(const char *filename);
 259 void vga_hw_text_update(console_ch_t *chardata);
 260
 261 int is_graphic_console(void);
 262 int is_fixedsize_console(void);
 263 CharDriverState *text_console_init(DisplayState *ds, const char *p);
 264 void console_select(unsigned int index);
 265 void console_color_init(DisplayState *ds);
 266 void qemu_console_resize(QEMUConsole *console, int width, int height);
 267 void qemu_console_copy(QEMUConsole *console, int src_x, int src_y,
 268                 int dst_x, int dst_y, int w, int h);
 269
 270 /* sdl.c */
 271 void sdl_display_init(DisplayState *ds, int full_screen, int no_frame);
 272
 273 /* cocoa.m */
 274 void cocoa_display_init(DisplayState *ds, int full_screen);
 275
 276 /* vnc.c */
 277 void vnc_display_init(DisplayState *ds);
 278 void vnc_display_close(DisplayState *ds);
 279 int vnc_display_open(DisplayState *ds, const char *display);
 280 int vnc_display_password(DisplayState *ds, const char *password);
 281 void do_info_vnc(void);
 282
 283 /* curses.c */
 284 void curses_display_init(DisplayState *ds, int full_screen);
 285
 286 /* x_keymap.c */
 287 extern uint8_t _translate_keycode(const int key);
 288
 289 /* FIXME: term_printf et al should probably go elsewhere so everything
 290    does not need to include console.h  */
 291 /* monitor.c */
 292 void monitor_init(CharDriverState *hd, int show_banner);
 293 void term_puts(const char *str);
 294 void term_vprintf(const char *fmt, va_list ap);
 295 void term_printf(const char *fmt, ...) __attribute__ ((__format__ (__printf__, 1, 2)));
 296 void term_print_filename(const char *filename);
 297 void term_flush(void);
 298 void term_print_help(void);
 299 void monitor_readline(const char *prompt, int is_password,
 300                       char *buf, int buf_size);
 301 void monitor_suspend(void);
 302 void monitor_resume(void);
 303
 304 /* readline.c */
 305 typedef void ReadLineFunc(void *opaque, const char *str);
 306
 307 extern int completion_index;
 308 void add_completion(const char *str);
 309 void readline_handle_byte(int ch);
 310 void readline_find_completion(const char *cmdline);
 311 const char *readline_get_history(unsigned int index);
 312 void readline_start(const char *prompt, int is_password,
 313                     ReadLineFunc *readline_func, void *opaque);
 314
 315 #endif