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     struct DisplayState *next;
 127 };
 128
 129 void register_displaystate(DisplayState *ds);
 130 DisplayState *get_displaystate(void);
 131 DisplaySurface* qemu_create_displaysurface(int width, int height, int bpp, int linesize);
 132 DisplaySurface* qemu_resize_displaysurface(DisplaySurface *surface,
 133                                            int width, int height, int bpp, int linesize);
 134 DisplaySurface* qemu_create_displaysurface_from(int width, int height, int bpp,
 135                                                 int linesize, uint8_t *data);
 136 void qemu_free_displaysurface(DisplaySurface *surface);
 137
 138 static inline int is_buffer_shared(DisplaySurface *surface)
 139 {
 140     return (!(surface->flags & QEMU_ALLOCATED_FLAG));
 141 }
 142
 143 static inline void register_displaychangelistener(DisplayState *ds, DisplayChangeListener *dcl)
 144 {
 145     dcl->next = ds->listeners;
 146     ds->listeners = dcl;
 147 }
 148
 149 static inline void dpy_update(DisplayState *s, int x, int y, int w, int h)
 150 {
 151     struct DisplayChangeListener *dcl = s->listeners;
 152     while (dcl != NULL) {
 153         dcl->dpy_update(s, x, y, w, h);
 154         dcl = dcl->next;
 155     }
 156 }
 157
 158 static inline void dpy_resize(DisplayState *s)
 159 {
 160     struct DisplayChangeListener *dcl = s->listeners;
 161     while (dcl != NULL) {
 162         dcl->dpy_resize(s);
 163         dcl = dcl->next;
 164     }
 165 }
 166
 167 static inline void dpy_setdata(DisplayState *s)
 168 {
 169     struct DisplayChangeListener *dcl = s->listeners;
 170     while (dcl != NULL) {
 171         if (dcl->dpy_setdata) dcl->dpy_setdata(s);
 172         dcl = dcl->next;
 173     }
 174 }
 175
 176 static inline void dpy_refresh(DisplayState *s)
 177 {
 178     struct DisplayChangeListener *dcl = s->listeners;
 179     while (dcl != NULL) {
 180         if (dcl->dpy_refresh) dcl->dpy_refresh(s);
 181         dcl = dcl->next;
 182     }
 183 }
 184
 185 static inline void dpy_copy(struct DisplayState *s, int src_x, int src_y,
 186                              int dst_x, int dst_y, int w, int h) {
 187     struct DisplayChangeListener *dcl = s->listeners;
 188     while (dcl != NULL) {
 189         if (dcl->dpy_copy)
 190             dcl->dpy_copy(s, src_x, src_y, dst_x, dst_y, w, h);
 191         else /* TODO */
 192             dcl->dpy_update(s, dst_x, dst_y, w, h);
 193         dcl = dcl->next;
 194     }
 195 }
 196
 197 static inline void dpy_fill(struct DisplayState *s, int x, int y,
 198                              int w, int h, uint32_t c) {
 199     struct DisplayChangeListener *dcl = s->listeners;
 200     while (dcl != NULL) {
 201         if (dcl->dpy_fill) dcl->dpy_fill(s, x, y, w, h, c);
 202         dcl = dcl->next;
 203     }
 204 }
 205
 206 static inline void dpy_cursor(struct DisplayState *s, int x, int y) {
 207     struct DisplayChangeListener *dcl = s->listeners;
 208     while (dcl != NULL) {
 209         if (dcl->dpy_text_cursor) dcl->dpy_text_cursor(s, x, y);
 210         dcl = dcl->next;
 211     }
 212 }
 213
 214 static inline int ds_get_linesize(DisplayState *ds)
 215 {
 216     return ds->surface->linesize;
 217 }
 218
 219 static inline uint8_t* ds_get_data(DisplayState *ds)
 220 {
 221     return ds->surface->data;
 222 }
 223
 224 static inline int ds_get_width(DisplayState *ds)
 225 {
 226     return ds->surface->width;
 227 }
 228
 229 static inline int ds_get_height(DisplayState *ds)
 230 {
 231     return ds->surface->height;
 232 }
 233
 234 static inline int ds_get_bits_per_pixel(DisplayState *ds)
 235 {
 236     return ds->surface->pf.bits_per_pixel;
 237 }
 238
 239 static inline int ds_get_bytes_per_pixel(DisplayState *ds)
 240 {
 241     return ds->surface->pf.bytes_per_pixel;
 242 }
 243
 244 typedef unsigned long console_ch_t;
 245 static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
 246 {
 247     cpu_to_le32wu((uint32_t *) dest, ch);
 248 }
 249
 250 typedef void (*vga_hw_update_ptr)(void *);
 251 typedef void (*vga_hw_invalidate_ptr)(void *);
 252 typedef void (*vga_hw_screen_dump_ptr)(void *, const char *);
 253 typedef void (*vga_hw_text_update_ptr)(void *, console_ch_t *);
 254
 255 DisplayState *graphic_console_init(vga_hw_update_ptr update,
 256                                    vga_hw_invalidate_ptr invalidate,
 257                                    vga_hw_screen_dump_ptr screen_dump,
 258                                    vga_hw_text_update_ptr text_update,
 259                                    void *opaque);
 260
 261 void vga_hw_update(void);
 262 void vga_hw_invalidate(void);
 263 void vga_hw_screen_dump(const char *filename);
 264 void vga_hw_text_update(console_ch_t *chardata);
 265
 266 int is_graphic_console(void);
 267 int is_fixedsize_console(void);
 268 CharDriverState *text_console_init(DisplayState *ds, const char *p);
 269 void console_select(unsigned int index);
 270 void console_color_init(DisplayState *ds);
 271 void qemu_console_resize(DisplayState *ds, int width, int height);
 272 void qemu_console_copy(DisplayState *ds, int src_x, int src_y,
 273                        int dst_x, int dst_y, int w, int h);
 274
 275 /* sdl.c */
 276 void sdl_display_init(DisplayState *ds, int full_screen, int no_frame);
 277
 278 /* cocoa.m */
 279 void cocoa_display_init(DisplayState *ds, int full_screen);
 280
 281 /* vnc.c */
 282 void vnc_display_init(DisplayState *ds);
 283 void vnc_display_close(DisplayState *ds);
 284 int vnc_display_open(DisplayState *ds, const char *display);
 285 int vnc_display_password(DisplayState *ds, const char *password);
 286 void do_info_vnc(void);
 287
 288 /* curses.c */
 289 void curses_display_init(DisplayState *ds, int full_screen);
 290
 291 /* x_keymap.c */
 292 extern uint8_t _translate_keycode(const int key);
 293
 294 /* FIXME: term_printf et al should probably go elsewhere so everything
 295    does not need to include console.h  */
 296 /* monitor.c */
 297 void monitor_init(CharDriverState *hd, int show_banner);
 298 void term_puts(const char *str);
 299 void term_vprintf(const char *fmt, va_list ap);
 300 void term_printf(const char *fmt, ...) __attribute__ ((__format__ (__printf__, 1, 2)));
 301 void term_print_filename(const char *filename);
 302 void term_flush(void);
 303 void term_print_help(void);
 304 void monitor_readline(const char *prompt, int is_password,
 305                       char *buf, int buf_size);
 306 void monitor_suspend(void);
 307 void monitor_resume(void);
 308
 309 /* readline.c */
 310 typedef void ReadLineFunc(void *opaque, const char *str);
 311
 312 extern int completion_index;
 313 void add_completion(const char *str);
 314 void readline_handle_byte(int ch);
 315 void readline_find_completion(const char *cmdline);
 316 const char *readline_get_history(unsigned int index);
 317 void readline_start(const char *prompt, int is_password,
 318                     ReadLineFunc *readline_func, void *opaque);
 319
 320 #endif