clients/window.h

   1 /*
   2  * Copyright © 2008 Kristian Høgsberg
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and its
   5  * documentation for any purpose is hereby granted without fee, provided that
   6  * the above copyright notice appear in all copies and that both that copyright
   7  * notice and this permission notice appear in supporting documentation, and
   8  * that the name of the copyright holders not be used in advertising or
   9  * publicity pertaining to distribution of the software without specific,
  10  * written prior permission.  The copyright holders make no representations
  11  * about the suitability of this software for any purpose.  It is provided "as
  12  * is" without express or implied warranty.
  13  *
  14  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  15  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  16  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  17  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  18  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  19  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  20  * OF THIS SOFTWARE.
  21  */
  22
  23 #ifndef _WINDOW_H_
  24 #define _WINDOW_H_
  25
  26 #include <X11/extensions/XKBcommon.h>
  27 #include <glib.h>
  28 #include <wayland-client.h>
  29 #include <cairo.h>
  30
  31 struct window;
  32 struct item;
  33 struct display;
  34 struct input;
  35
  36 struct task {
  37         void (*run)(struct task *task, uint32_t events);
  38         struct wl_list link;
  39 };
  40
  41 struct rectangle {
  42         int32_t x;
  43         int32_t y;
  44         int32_t width;
  45         int32_t height;
  46 };
  47
  48 struct display *
  49 display_create(int *argc, char **argv[], const GOptionEntry *option_entries);
  50
  51 struct wl_display *
  52 display_get_display(struct display *display);
  53
  54 struct wl_compositor *
  55 display_get_compositor(struct display *display);
  56
  57 struct wl_shell *
  58 display_get_shell(struct display *display);
  59
  60 #ifdef EGL_NO_DISPLAY
  61 EGLDisplay
  62 display_get_egl_display(struct display *d);
  63
  64 EGLConfig
  65 display_get_rgb_egl_config(struct display *d);
  66
  67 EGLConfig
  68 display_get_argb_egl_config(struct display *d);
  69
  70 int
  71 display_acquire_window_surface(struct display *display,
  72                                struct window *window,
  73                                EGLContext ctx);
  74 void
  75 display_release_window_surface(struct display *display,
  76                                struct window *window);
  77
  78 #ifdef HAVE_CAIRO_EGL
  79 EGLImageKHR
  80 display_get_image_for_egl_image_surface(struct display *display,
  81                                         cairo_surface_t *surface);
  82 #endif
  83 #endif
  84
  85 #define SURFACE_OPAQUE 0x01
  86
  87 cairo_surface_t *
  88 display_create_surface(struct display *display,
  89                        struct wl_surface *surface,
  90                        struct rectangle *rectangle,
  91                        uint32_t flags);
  92
  93 struct wl_buffer *
  94 display_get_buffer_for_surface(struct display *display,
  95                                cairo_surface_t *surface);
  96
  97 cairo_surface_t *
  98 display_get_pointer_surface(struct display *display, int pointer,
  99                             int *width, int *height,
 100                             int *hotspot_x, int *hotspot_y);
 101
 102 void
 103 display_add_drag_listener(struct display *display,
 104                           const struct wl_drag_listener *drag_listener,
 105                           void *data);
 106
 107 void
 108 display_defer(struct display *display, struct task *task);
 109
 110 void
 111 display_watch_fd(struct display *display,
 112                  int fd, uint32_t events, struct task *task);
 113
 114 void
 115 display_run(struct display *d);
 116
 117 enum pointer_type {
 118         POINTER_BOTTOM_LEFT,
 119         POINTER_BOTTOM_RIGHT,
 120         POINTER_BOTTOM,
 121         POINTER_DRAGGING,
 122         POINTER_LEFT_PTR,
 123         POINTER_LEFT,
 124         POINTER_RIGHT,
 125         POINTER_TOP_LEFT,
 126         POINTER_TOP_RIGHT,
 127         POINTER_TOP,
 128         POINTER_IBEAM,
 129         POINTER_HAND1,
 130 };
 131
 132 typedef void (*window_resize_handler_t)(struct window *window,
 133                                         int32_t width, int32_t height,
 134                                         void *data);
 135 typedef void (*window_redraw_handler_t)(struct window *window, void *data);
 136
 137 typedef void (*window_key_handler_t)(struct window *window, struct input *input,
 138                                      uint32_t time, uint32_t key, uint32_t unicode,
 139                                      uint32_t state, void *data);
 140
 141 typedef void (*window_keyboard_focus_handler_t)(struct window *window,
 142                                                 struct input *device, void *data);
 143
 144 typedef void (*window_button_handler_t)(struct window *window,
 145                                         struct input *input, uint32_t time,
 146                                         int button, int state, void *data);
 147
 148 typedef int (*window_enter_handler_t)(struct window *window,
 149                                       struct input *input, uint32_t time,
 150                                       int32_t x, int32_t y, void *data);
 151 typedef void (*window_leave_handler_t)(struct window *window,
 152                                        struct input *input, uint32_t time,
 153                                        void *data);
 154
 155 typedef int (*window_motion_handler_t)(struct window *window,
 156                                        struct input *input, uint32_t time,
 157                                        int32_t x, int32_t y,
 158                                        int32_t sx, int32_t sy, void *data);
 159
 160 typedef void (*window_item_focus_handler_t)(struct window *window,
 161                                             struct item *focus, void *data);
 162
 163 struct window *
 164 window_create(struct display *display, int32_t width, int32_t height);
 165 struct window *
 166 window_create_transient(struct display *display, struct window *parent,
 167                         int32_t x, int32_t y, int32_t width, int32_t height);
 168
 169 void
 170 window_destroy(struct window *window);
 171
 172 struct item *
 173 window_add_item(struct window *window, void *data);
 174
 175 typedef void (*item_func_t)(struct item *item, void *data);
 176
 177 void
 178 window_for_each_item(struct window *window, item_func_t func, void *data);
 179
 180 struct item *
 181 window_get_focus_item(struct window *window);
 182 struct display *
 183 window_get_display(struct window *window);
 184
 185 void
 186 window_move(struct window *window, struct input *input, uint32_t time);
 187
 188 void
 189 window_draw(struct window *window);
 190
 191 void
 192 window_get_allocation(struct window *window,
 193                       struct rectangle *allocation);
 194
 195 void
 196 window_get_child_allocation(struct window *window,
 197                             struct rectangle *allocation);
 198
 199 void
 200 window_set_transparent(struct window *window, int transparent);
 201 void
 202 window_set_child_size(struct window *window, int32_t width, int32_t height);
 203 void
 204 window_schedule_redraw(struct window *window);
 205
 206 void
 207 window_damage(struct window *window, int32_t x, int32_t y,
 208               int32_t width, int32_t height);
 209
 210 cairo_surface_t *
 211 window_get_surface(struct window *window);
 212
 213 struct wl_surface *
 214 window_get_wl_surface(struct window *window);
 215
 216 void
 217 window_flush(struct window *window);
 218
 219 void
 220 window_set_surface(struct window *window, cairo_surface_t *surface);
 221
 222 void
 223 window_create_surface(struct window *window);
 224
 225 enum window_buffer_type {
 226         WINDOW_BUFFER_TYPE_EGL_WINDOW,
 227         WINDOW_BUFFER_TYPE_EGL_IMAGE,
 228         WINDOW_BUFFER_TYPE_SHM,
 229 };
 230
 231 void
 232 display_surface_damage(struct display *display, cairo_surface_t *cairo_surface,
 233                        int32_t x, int32_t y, int32_t width, int32_t height);
 234
 235 void
 236 window_set_buffer_type(struct window *window, enum window_buffer_type type);
 237
 238 void
 239 window_set_fullscreen(struct window *window, int fullscreen);
 240
 241 void
 242 window_set_custom(struct window *window);
 243
 244 void
 245 window_set_user_data(struct window *window, void *data);
 246
 247 void *
 248 window_get_user_data(struct window *window);
 249
 250 void
 251 window_set_redraw_handler(struct window *window,
 252                           window_redraw_handler_t handler);
 253
 254 void
 255 window_set_decoration(struct window *window, int decoration);
 256
 257 void
 258 window_set_resize_handler(struct window *window,
 259                           window_resize_handler_t handler);
 260
 261 void
 262 window_set_key_handler(struct window *window,
 263                        window_key_handler_t handler);
 264
 265 void
 266 window_set_button_handler(struct window *window,
 267                           window_button_handler_t handler);
 268
 269 void
 270 window_set_motion_handler(struct window *window,
 271                           window_motion_handler_t handler);
 272
 273 void
 274 window_set_enter_handler(struct window *window,
 275                          window_enter_handler_t handler);
 276 void
 277 window_set_leave_handler(struct window *window,
 278                          window_leave_handler_t handler);
 279
 280 void
 281 window_set_keyboard_focus_handler(struct window *window,
 282                                   window_keyboard_focus_handler_t handler);
 283
 284 void
 285 window_set_item_focus_handler(struct window *window,
 286                               window_item_focus_handler_t handler);
 287
 288 void
 289 window_set_title(struct window *window, const char *title);
 290
 291 const char *
 292 window_get_title(struct window *window);
 293
 294 struct wl_drag *
 295 window_create_drag(struct window *window);
 296
 297 void
 298 window_activate_drag(struct wl_drag *drag, struct window *window,
 299                      struct input *input, uint32_t time);
 300
 301 void
 302 item_get_allocation(struct item *item, struct rectangle *allocation);
 303
 304 void
 305 item_set_allocation(struct item *item,
 306                     int32_t x, int32_t y, int32_t width, int32_t height);
 307
 308 void *
 309 item_get_user_data(struct item *item);
 310
 311 void
 312 input_get_position(struct input *input, int32_t *x, int32_t *y);
 313
 314 uint32_t
 315 input_get_modifiers(struct input *input);
 316
 317 struct wl_input_device *
 318 input_get_input_device(struct input *input);
 319
 320 int
 321 input_offers_mime_type(struct input *input, const char *type);
 322 void
 323 input_receive_mime_type(struct input *input, const char *type, int fd);
 324
 325 enum {
 326         CONFIG_KEY_INTEGER,
 327         CONFIG_KEY_STRING,
 328         CONFIG_KEY_BOOL
 329 };
 330
 331 struct config_key {
 332         const char *name;
 333         int type;
 334         void *data;
 335 };
 336
 337 struct config_section {
 338         const char *name;
 339         const struct config_key *keys;
 340         int num_keys;
 341         void (*done)(void *data);
 342 };
 343
 344 int
 345 parse_config_file(const char *path,
 346                   const struct config_section *sections, int num_sections,
 347                   void *data);
 348
 349 char *
 350 config_file_path(const char *name);
 351
 352 #endif