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 struct output;
  36
  37 struct task {
  38         void (*run)(struct task *task, uint32_t events);
  39         struct wl_list link;
  40 };
  41
  42 struct rectangle {
  43         int32_t x;
  44         int32_t y;
  45         int32_t width;
  46         int32_t height;
  47 };
  48
  49 struct display *
  50 display_create(int *argc, char **argv[], const GOptionEntry *option_entries);
  51
  52 struct wl_display *
  53 display_get_display(struct display *display);
  54
  55 struct wl_compositor *
  56 display_get_compositor(struct display *display);
  57
  58 struct wl_shell *
  59 display_get_shell(struct display *display);
  60
  61 struct output *
  62 display_get_output(struct display *display);
  63
  64 struct wl_data_source *
  65 display_create_data_source(struct display *display);
  66
  67 #ifdef EGL_NO_DISPLAY
  68 EGLDisplay
  69 display_get_egl_display(struct display *d);
  70
  71 EGLConfig
  72 display_get_rgb_egl_config(struct display *d);
  73
  74 EGLConfig
  75 display_get_argb_egl_config(struct display *d);
  76
  77 int
  78 display_acquire_window_surface(struct display *display,
  79                                struct window *window,
  80                                EGLContext ctx);
  81 void
  82 display_release_window_surface(struct display *display,
  83                                struct window *window);
  84
  85 #ifdef HAVE_CAIRO_EGL
  86 EGLImageKHR
  87 display_get_image_for_egl_image_surface(struct display *display,
  88                                         cairo_surface_t *surface);
  89 #endif
  90 #endif
  91
  92 #define SURFACE_OPAQUE 0x01
  93
  94 cairo_surface_t *
  95 display_create_surface(struct display *display,
  96                        struct wl_surface *surface,
  97                        struct rectangle *rectangle,
  98                        uint32_t flags);
  99
 100 struct wl_buffer *
 101 display_get_buffer_for_surface(struct display *display,
 102                                cairo_surface_t *surface);
 103
 104 cairo_surface_t *
 105 display_get_pointer_surface(struct display *display, int pointer,
 106                             int *width, int *height,
 107                             int *hotspot_x, int *hotspot_y);
 108
 109 void
 110 display_defer(struct display *display, struct task *task);
 111
 112 void
 113 display_watch_fd(struct display *display,
 114                  int fd, uint32_t events, struct task *task);
 115
 116 void
 117 display_run(struct display *d);
 118
 119 enum pointer_type {
 120         POINTER_BOTTOM_LEFT,
 121         POINTER_BOTTOM_RIGHT,
 122         POINTER_BOTTOM,
 123         POINTER_DRAGGING,
 124         POINTER_LEFT_PTR,
 125         POINTER_LEFT,
 126         POINTER_RIGHT,
 127         POINTER_TOP_LEFT,
 128         POINTER_TOP_RIGHT,
 129         POINTER_TOP,
 130         POINTER_IBEAM,
 131         POINTER_HAND1,
 132 };
 133
 134 typedef void (*window_resize_handler_t)(struct window *window,
 135                                         int32_t width, int32_t height,
 136                                         void *data);
 137 typedef void (*window_redraw_handler_t)(struct window *window, void *data);
 138
 139 typedef void (*window_key_handler_t)(struct window *window, struct input *input,
 140                                      uint32_t time, uint32_t key, uint32_t unicode,
 141                                      uint32_t state, void *data);
 142
 143 typedef void (*window_keyboard_focus_handler_t)(struct window *window,
 144                                                 struct input *device, void *data);
 145
 146 typedef void (*window_button_handler_t)(struct window *window,
 147                                         struct input *input, uint32_t time,
 148                                         int button, int state, void *data);
 149
 150 typedef int (*window_enter_handler_t)(struct window *window,
 151                                       struct input *input, uint32_t time,
 152                                       int32_t x, int32_t y, void *data);
 153 typedef void (*window_leave_handler_t)(struct window *window,
 154                                        struct input *input, uint32_t time,
 155                                        void *data);
 156
 157 typedef int (*window_motion_handler_t)(struct window *window,
 158                                        struct input *input, uint32_t time,
 159                                        int32_t x, int32_t y,
 160                                        int32_t sx, int32_t sy, void *data);
 161
 162 typedef void (*window_data_handler_t)(struct window *window,
 163                                       struct input *input, uint32_t time,
 164                                       int32_t x, int32_t y,
 165                                       const char **types,
 166                                       void *data);
 167
 168 typedef void (*window_drop_handler_t)(struct window *window,
 169                                       struct input *input,
 170                                       int32_t x, int32_t y, void *data);
 171
 172 typedef void (*window_item_focus_handler_t)(struct window *window,
 173                                             struct item *focus, void *data);
 174
 175 struct window *
 176 window_create(struct display *display, int32_t width, int32_t height);
 177 struct window *
 178 window_create_transient(struct display *display, struct window *parent,
 179                         int32_t x, int32_t y, int32_t width, int32_t height);
 180
 181 void
 182 window_destroy(struct window *window);
 183
 184 struct item *
 185 window_add_item(struct window *window, void *data);
 186
 187 typedef void (*item_func_t)(struct item *item, void *data);
 188
 189 typedef void (*data_func_t)(void *data, size_t len,
 190                             int32_t x, int32_t y, void *user_data);
 191
 192 void
 193 window_for_each_item(struct window *window, item_func_t func, void *data);
 194
 195 struct item *
 196 window_get_focus_item(struct window *window);
 197 struct display *
 198 window_get_display(struct window *window);
 199
 200 void
 201 window_move(struct window *window, struct input *input, uint32_t time);
 202
 203 void
 204 window_draw(struct window *window);
 205
 206 void
 207 window_get_allocation(struct window *window,
 208                       struct rectangle *allocation);
 209
 210 void
 211 window_get_child_allocation(struct window *window,
 212                             struct rectangle *allocation);
 213
 214 void
 215 window_set_transparent(struct window *window, int transparent);
 216 void
 217 window_set_child_size(struct window *window, int32_t width, int32_t height);
 218 void
 219 window_schedule_redraw(struct window *window);
 220
 221 void
 222 window_damage(struct window *window, int32_t x, int32_t y,
 223               int32_t width, int32_t height);
 224
 225 cairo_surface_t *
 226 window_get_surface(struct window *window);
 227
 228 struct wl_surface *
 229 window_get_wl_surface(struct window *window);
 230
 231 void
 232 window_flush(struct window *window);
 233
 234 void
 235 window_set_surface(struct window *window, cairo_surface_t *surface);
 236
 237 void
 238 window_create_surface(struct window *window);
 239
 240 enum window_buffer_type {
 241         WINDOW_BUFFER_TYPE_EGL_WINDOW,
 242         WINDOW_BUFFER_TYPE_EGL_IMAGE,
 243         WINDOW_BUFFER_TYPE_SHM,
 244 };
 245
 246 void
 247 display_surface_damage(struct display *display, cairo_surface_t *cairo_surface,
 248                        int32_t x, int32_t y, int32_t width, int32_t height);
 249
 250 void
 251 window_set_buffer_type(struct window *window, enum window_buffer_type type);
 252
 253 void
 254 window_set_fullscreen(struct window *window, int fullscreen);
 255
 256 void
 257 window_set_custom(struct window *window);
 258
 259 void
 260 window_set_user_data(struct window *window, void *data);
 261
 262 void *
 263 window_get_user_data(struct window *window);
 264
 265 void
 266 window_set_redraw_handler(struct window *window,
 267                           window_redraw_handler_t handler);
 268
 269 void
 270 window_set_decoration(struct window *window, int decoration);
 271
 272 void
 273 window_set_resize_handler(struct window *window,
 274                           window_resize_handler_t handler);
 275
 276 void
 277 window_set_key_handler(struct window *window,
 278                        window_key_handler_t handler);
 279
 280 void
 281 window_set_button_handler(struct window *window,
 282                           window_button_handler_t handler);
 283
 284 void
 285 window_set_motion_handler(struct window *window,
 286                           window_motion_handler_t handler);
 287
 288 void
 289 window_set_enter_handler(struct window *window,
 290                          window_enter_handler_t handler);
 291 void
 292 window_set_leave_handler(struct window *window,
 293                          window_leave_handler_t handler);
 294
 295 void
 296 window_set_keyboard_focus_handler(struct window *window,
 297                                   window_keyboard_focus_handler_t handler);
 298
 299 void
 300 window_set_item_focus_handler(struct window *window,
 301                               window_item_focus_handler_t handler);
 302
 303 void
 304 window_set_data_handler(struct window *window,
 305                         window_data_handler_t handler);
 306
 307 void
 308 window_set_drop_handler(struct window *window,
 309                         window_drop_handler_t handler);
 310
 311 void
 312 window_set_title(struct window *window, const char *title);
 313
 314 const char *
 315 window_get_title(struct window *window);
 316
 317 void
 318 item_get_allocation(struct item *item, struct rectangle *allocation);
 319
 320 void
 321 item_set_allocation(struct item *item,
 322                     int32_t x, int32_t y, int32_t width, int32_t height);
 323
 324 void *
 325 item_get_user_data(struct item *item);
 326
 327 void
 328 input_set_pointer_image(struct input *input, uint32_t time, int pointer);
 329
 330 void
 331 input_get_position(struct input *input, int32_t *x, int32_t *y);
 332
 333 uint32_t
 334 input_get_modifiers(struct input *input);
 335
 336 struct wl_input_device *
 337 input_get_input_device(struct input *input);
 338
 339 struct wl_data_device *
 340 input_get_data_device(struct input *input);
 341
 342 void
 343 input_set_selection(struct input *input,
 344                     struct wl_data_source *source, uint32_t time);
 345
 346 void
 347 input_accept(struct input *input, uint32_t time, const char *type);
 348
 349
 350 void
 351 input_receive_drag_data(struct input *input, const char *mime_type,
 352                         data_func_t func, void *user_data);
 353
 354 int
 355 input_receive_selection_data(struct input *input, const char *mime_type,
 356                              data_func_t func, void *data);
 357
 358 void
 359 output_get_allocation(struct output *output, struct rectangle *allocation);
 360
 361
 362 enum {
 363         CONFIG_KEY_INTEGER,
 364         CONFIG_KEY_STRING,
 365         CONFIG_KEY_BOOL
 366 };
 367
 368 struct config_key {
 369         const char *name;
 370         int type;
 371         void *data;
 372 };
 373
 374 struct config_section {
 375         const char *name;
 376         const struct config_key *keys;
 377         int num_keys;
 378         void (*done)(void *data);
 379 };
 380
 381 int
 382 parse_config_file(const char *path,
 383                   const struct config_section *sections, int num_sections,
 384                   void *data);
 385
 386 char *
 387 config_file_path(const char *name);
 388
 389 #endif