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 "config.h"
  27
  28 #include <xkbcommon/xkbcommon.h>
  29 #include <wayland-client.h>
  30 #include <cairo.h>
  31 #include "../shared/config-parser.h"
  32 #include "../shared/zalloc.h"
  33
  34 #define ARRAY_LENGTH(a) (sizeof (a) / sizeof (a)[0])
  35
  36 #define container_of(ptr, type, member) ({                              \
  37         const __typeof__( ((type *)0)->member ) *__mptr = (ptr);        \
  38         (type *)( (char *)__mptr - offsetof(type,member) );})
  39
  40 struct window;
  41 struct widget;
  42 struct display;
  43 struct input;
  44 struct output;
  45
  46 struct task {
  47         void (*run)(struct task *task, uint32_t events);
  48         struct wl_list link;
  49 };
  50
  51 struct rectangle {
  52         int32_t x;
  53         int32_t y;
  54         int32_t width;
  55         int32_t height;
  56 };
  57
  58 void *
  59 fail_on_null(void *p);
  60 void *
  61 xmalloc(size_t s);
  62 void *
  63 xzalloc(size_t s);
  64 char *
  65 xstrdup(const char *s);
  66 void *
  67 xrealloc(char *p, size_t s);
  68
  69 struct display *
  70 display_create(int *argc, char *argv[]);
  71
  72 void
  73 display_destroy(struct display *display);
  74
  75 void
  76 display_set_user_data(struct display *display, void *data);
  77
  78 void *
  79 display_get_user_data(struct display *display);
  80
  81 struct wl_display *
  82 display_get_display(struct display *display);
  83
  84 int
  85 display_has_subcompositor(struct display *display);
  86
  87 cairo_device_t *
  88 display_get_cairo_device(struct display *display);
  89
  90 struct wl_compositor *
  91 display_get_compositor(struct display *display);
  92
  93 struct output *
  94 display_get_output(struct display *display);
  95
  96 uint32_t
  97 display_get_serial(struct display *display);
  98
  99 typedef void (*display_global_handler_t)(struct display *display,
 100                                          uint32_t name,
 101                                          const char *interface,
 102                                          uint32_t version, void *data);
 103
 104 void
 105 display_set_global_handler(struct display *display,
 106                            display_global_handler_t handler);
 107 void
 108 display_set_global_handler_remove(struct display *display,
 109                            display_global_handler_t remove_handler);
 110 void *
 111 display_bind(struct display *display, uint32_t name,
 112              const struct wl_interface *interface, uint32_t version);
 113
 114 typedef void (*display_output_handler_t)(struct output *output, void *data);
 115
 116 /*
 117  * The output configure handler is called, when a new output is connected
 118  * and we know its current mode, or when the current mode changes.
 119  * Test and set the output user data in your handler to know, if the
 120  * output is new. Note: 'data' in the configure handler is the display
 121  * user data.
 122  */
 123 void
 124 display_set_output_configure_handler(struct display *display,
 125                                      display_output_handler_t handler);
 126
 127 struct wl_data_source *
 128 display_create_data_source(struct display *display);
 129
 130 #ifdef EGL_NO_DISPLAY
 131 EGLDisplay
 132 display_get_egl_display(struct display *d);
 133
 134 EGLConfig
 135 display_get_argb_egl_config(struct display *d);
 136
 137 int
 138 display_acquire_window_surface(struct display *display,
 139                                struct window *window,
 140                                EGLContext ctx);
 141 void
 142 display_release_window_surface(struct display *display,
 143                                struct window *window);
 144 #endif
 145
 146 #define SURFACE_OPAQUE 0x01
 147 #define SURFACE_SHM    0x02
 148
 149 #define SURFACE_HINT_RESIZE 0x10
 150
 151 #define SURFACE_HINT_RGB565 0x100
 152
 153 cairo_surface_t *
 154 display_create_surface(struct display *display,
 155                        struct wl_surface *surface,
 156                        struct rectangle *rectangle,
 157                        uint32_t flags);
 158
 159 struct wl_buffer *
 160 display_get_buffer_for_surface(struct display *display,
 161                                cairo_surface_t *surface);
 162
 163 struct wl_cursor_image *
 164 display_get_pointer_image(struct display *display, int pointer);
 165
 166 void
 167 display_defer(struct display *display, struct task *task);
 168
 169 void
 170 display_watch_fd(struct display *display,
 171                  int fd, uint32_t events, struct task *task);
 172
 173 void
 174 display_unwatch_fd(struct display *display, int fd);
 175
 176 void
 177 display_run(struct display *d);
 178
 179 void
 180 display_exit(struct display *d);
 181
 182 enum cursor_type {
 183         CURSOR_BOTTOM_LEFT,
 184         CURSOR_BOTTOM_RIGHT,
 185         CURSOR_BOTTOM,
 186         CURSOR_DRAGGING,
 187         CURSOR_LEFT_PTR,
 188         CURSOR_LEFT,
 189         CURSOR_RIGHT,
 190         CURSOR_TOP_LEFT,
 191         CURSOR_TOP_RIGHT,
 192         CURSOR_TOP,
 193         CURSOR_IBEAM,
 194         CURSOR_HAND1,
 195         CURSOR_WATCH,
 196
 197         CURSOR_BLANK
 198 };
 199
 200 typedef void (*window_key_handler_t)(struct window *window, struct input *input,
 201                                      uint32_t time, uint32_t key, uint32_t unicode,
 202                                      enum wl_keyboard_key_state state, void *data);
 203
 204 typedef void (*window_keyboard_focus_handler_t)(struct window *window,
 205                                                 struct input *device, void *data);
 206
 207 typedef void (*window_data_handler_t)(struct window *window,
 208                                       struct input *input,
 209                                       float x, float y,
 210                                       const char **types,
 211                                       void *data);
 212
 213 typedef void (*window_drop_handler_t)(struct window *window,
 214                                       struct input *input,
 215                                       int32_t x, int32_t y, void *data);
 216
 217 typedef void (*window_close_handler_t)(void *data);
 218 typedef void (*window_fullscreen_handler_t)(struct window *window, void *data);
 219
 220 typedef void (*window_output_handler_t)(struct window *window, struct output *output,
 221                                         int enter, void *data);
 222 typedef void (*window_state_changed_handler_t)(struct window *window,
 223                                                void *data);
 224
 225 typedef void (*widget_resize_handler_t)(struct widget *widget,
 226                                         int32_t width, int32_t height,
 227                                         void *data);
 228 typedef void (*widget_redraw_handler_t)(struct widget *widget, void *data);
 229
 230 typedef int (*widget_enter_handler_t)(struct widget *widget,
 231                                       struct input *input,
 232                                       float x, float y, void *data);
 233 typedef void (*widget_leave_handler_t)(struct widget *widget,
 234                                        struct input *input, void *data);
 235 typedef int (*widget_motion_handler_t)(struct widget *widget,
 236                                        struct input *input, uint32_t time,
 237                                        float x, float y, void *data);
 238 typedef void (*widget_button_handler_t)(struct widget *widget,
 239                                         struct input *input, uint32_t time,
 240                                         uint32_t button,
 241                                         enum wl_pointer_button_state state,
 242                                         void *data);
 243 typedef void (*widget_touch_down_handler_t)(struct widget *widget,
 244                                             struct input *input,
 245                                             uint32_t serial,
 246                                             uint32_t time,
 247                                             int32_t id,
 248                                             float x,
 249                                             float y,
 250                                             void *data);
 251 typedef void (*widget_touch_up_handler_t)(struct widget *widget,
 252                                           struct input *input,
 253                                           uint32_t serial,
 254                                           uint32_t time,
 255                                           int32_t id,
 256                                           void *data);
 257 typedef void (*widget_touch_motion_handler_t)(struct widget *widget,
 258                                               struct input *input,
 259                                               uint32_t time,
 260                                               int32_t id,
 261                                               float x,
 262                                               float y,
 263                                               void *data);
 264 typedef void (*widget_touch_frame_handler_t)(struct widget *widget,
 265                                              struct input *input, void *data);
 266 typedef void (*widget_touch_cancel_handler_t)(struct widget *widget,
 267                                               struct input *input, void *data);
 268 typedef void (*widget_axis_handler_t)(struct widget *widget,
 269                                       struct input *input, uint32_t time,
 270                                       uint32_t axis,
 271                                       wl_fixed_t value,
 272                                       void *data);
 273
 274 struct window *
 275 window_create(struct display *display);
 276 struct window *
 277 window_create_custom(struct display *display);
 278
 279 void
 280 window_set_parent(struct window *window, struct window *parent_window);
 281 struct window *
 282 window_get_parent(struct window *window);
 283
 284 int
 285 window_has_focus(struct window *window);
 286
 287 typedef void (*menu_func_t)(struct window *window,
 288                             struct input *input, int index, void *data);
 289
 290 void
 291 window_show_menu(struct display *display,
 292                  struct input *input, uint32_t time, struct window *parent,
 293                  int32_t x, int32_t y,
 294                  menu_func_t func, const char **entries, int count);
 295
 296 void
 297 window_show_frame_menu(struct window *window,
 298                        struct input *input, uint32_t time);
 299
 300 int
 301 window_get_buffer_transform(struct window *window);
 302
 303 void
 304 window_set_buffer_transform(struct window *window,
 305                             enum wl_output_transform transform);
 306
 307 uint32_t
 308 window_get_buffer_scale(struct window *window);
 309
 310 void
 311 window_set_buffer_scale(struct window *window,
 312                         int32_t scale);
 313
 314 uint32_t
 315 window_get_output_scale(struct window *window);
 316
 317 void
 318 window_destroy(struct window *window);
 319
 320 struct widget *
 321 window_add_widget(struct window *window, void *data);
 322
 323 enum subsurface_mode {
 324         SUBSURFACE_SYNCHRONIZED,
 325         SUBSURFACE_DESYNCHRONIZED
 326 };
 327
 328 struct widget *
 329 window_add_subsurface(struct window *window, void *data,
 330                       enum subsurface_mode default_mode);
 331
 332 typedef void (*data_func_t)(void *data, size_t len,
 333                             int32_t x, int32_t y, void *user_data);
 334
 335 struct display *
 336 window_get_display(struct window *window);
 337 void
 338 window_move(struct window *window, struct input *input, uint32_t time);
 339 void
 340 window_get_allocation(struct window *window, struct rectangle *allocation);
 341 void
 342 window_schedule_redraw(struct window *window);
 343 void
 344 window_schedule_resize(struct window *window, int width, int height);
 345
 346 void
 347 window_damage(struct window *window, int32_t x, int32_t y,
 348               int32_t width, int32_t height);
 349
 350 cairo_surface_t *
 351 window_get_surface(struct window *window);
 352
 353 struct wl_surface *
 354 window_get_wl_surface(struct window *window);
 355
 356 struct wl_subsurface *
 357 widget_get_wl_subsurface(struct widget *widget);
 358
 359 enum window_buffer_type {
 360         WINDOW_BUFFER_TYPE_EGL_WINDOW,
 361         WINDOW_BUFFER_TYPE_SHM,
 362 };
 363
 364 void
 365 display_surface_damage(struct display *display, cairo_surface_t *cairo_surface,
 366                        int32_t x, int32_t y, int32_t width, int32_t height);
 367
 368 void
 369 window_set_buffer_type(struct window *window, enum window_buffer_type type);
 370
 371 enum window_buffer_type
 372 window_get_buffer_type(struct window *window);
 373
 374 int
 375 window_is_fullscreen(struct window *window);
 376
 377 void
 378 window_set_fullscreen(struct window *window, int fullscreen);
 379
 380 int
 381 window_is_maximized(struct window *window);
 382
 383 void
 384 window_set_maximized(struct window *window, int maximized);
 385
 386 int
 387 window_is_resizing(struct window *window);
 388
 389 void
 390 window_set_minimized(struct window *window);
 391
 392 void
 393 window_set_user_data(struct window *window, void *data);
 394
 395 void *
 396 window_get_user_data(struct window *window);
 397
 398 void
 399 window_set_key_handler(struct window *window,
 400                        window_key_handler_t handler);
 401
 402 void
 403 window_set_keyboard_focus_handler(struct window *window,
 404                                   window_keyboard_focus_handler_t handler);
 405
 406 void
 407 window_set_data_handler(struct window *window,
 408                         window_data_handler_t handler);
 409
 410 void
 411 window_set_drop_handler(struct window *window,
 412                         window_drop_handler_t handler);
 413
 414 void
 415 window_set_close_handler(struct window *window,
 416                          window_close_handler_t handler);
 417 void
 418 window_set_fullscreen_handler(struct window *window,
 419                               window_fullscreen_handler_t handler);
 420 void
 421 window_set_output_handler(struct window *window,
 422                           window_output_handler_t handler);
 423 void
 424 window_set_state_changed_handler(struct window *window,
 425                                  window_state_changed_handler_t handler);
 426
 427 void
 428 window_set_title(struct window *window, const char *title);
 429
 430 const char *
 431 window_get_title(struct window *window);
 432
 433 void
 434 window_set_text_cursor_position(struct window *window, int32_t x, int32_t y);
 435
 436 enum preferred_format {
 437         WINDOW_PREFERRED_FORMAT_NONE,
 438         WINDOW_PREFERRED_FORMAT_RGB565
 439 };
 440
 441 void
 442 window_set_preferred_format(struct window *window,
 443                             enum preferred_format format);
 444
 445 int
 446 widget_set_tooltip(struct widget *parent, char *entry, float x, float y);
 447
 448 void
 449 widget_destroy_tooltip(struct widget *parent);
 450
 451 struct widget *
 452 widget_add_widget(struct widget *parent, void *data);
 453
 454 void
 455 widget_destroy(struct widget *widget);
 456 void
 457 widget_set_default_cursor(struct widget *widget, int cursor);
 458 void
 459 widget_get_allocation(struct widget *widget, struct rectangle *allocation);
 460
 461 void
 462 widget_set_allocation(struct widget *widget,
 463                       int32_t x, int32_t y, int32_t width, int32_t height);
 464 void
 465 widget_set_size(struct widget *widget, int32_t width, int32_t height);
 466 void
 467 widget_set_transparent(struct widget *widget, int transparent);
 468 void
 469 widget_schedule_resize(struct widget *widget, int32_t width, int32_t height);
 470
 471 void *
 472 widget_get_user_data(struct widget *widget);
 473
 474 cairo_t *
 475 widget_cairo_create(struct widget *widget);
 476
 477 struct wl_surface *
 478 widget_get_wl_surface(struct widget *widget);
 479
 480 uint32_t
 481 widget_get_last_time(struct widget *widget);
 482
 483 void
 484 widget_input_region_add(struct widget *widget, const struct rectangle *rect);
 485
 486 void
 487 widget_set_redraw_handler(struct widget *widget,
 488                           widget_redraw_handler_t handler);
 489 void
 490 widget_set_resize_handler(struct widget *widget,
 491                           widget_resize_handler_t handler);
 492 void
 493 widget_set_enter_handler(struct widget *widget,
 494                          widget_enter_handler_t handler);
 495 void
 496 widget_set_leave_handler(struct widget *widget,
 497                          widget_leave_handler_t handler);
 498 void
 499 widget_set_motion_handler(struct widget *widget,
 500                           widget_motion_handler_t handler);
 501 void
 502 widget_set_button_handler(struct widget *widget,
 503                           widget_button_handler_t handler);
 504 void
 505 widget_set_touch_down_handler(struct widget *widget,
 506                               widget_touch_down_handler_t handler);
 507 void
 508 widget_set_touch_up_handler(struct widget *widget,
 509                             widget_touch_up_handler_t handler);
 510 void
 511 widget_set_touch_motion_handler(struct widget *widget,
 512                                 widget_touch_motion_handler_t handler);
 513 void
 514 widget_set_touch_frame_handler(struct widget *widget,
 515                                widget_touch_frame_handler_t handler);
 516 void
 517 widget_set_touch_cancel_handler(struct widget *widget,
 518                                 widget_touch_cancel_handler_t handler);
 519 void
 520 widget_set_axis_handler(struct widget *widget,
 521                         widget_axis_handler_t handler);
 522 void
 523 widget_schedule_redraw(struct widget *widget);
 524 void
 525 widget_set_use_cairo(struct widget *widget, int use_cairo);
 526
 527 struct widget *
 528 window_frame_create(struct window *window, void *data);
 529
 530 void
 531 window_frame_set_child_size(struct widget *widget, int child_width,
 532                             int child_height);
 533
 534 void
 535 input_set_pointer_image(struct input *input, int pointer);
 536
 537 void
 538 input_get_position(struct input *input, int32_t *x, int32_t *y);
 539
 540 int
 541 input_get_touch(struct input *input, int32_t id, float *x, float *y);
 542
 543 #define MOD_SHIFT_MASK          0x01
 544 #define MOD_ALT_MASK            0x02
 545 #define MOD_CONTROL_MASK        0x04
 546
 547 uint32_t
 548 input_get_modifiers(struct input *input);
 549
 550 void
 551 touch_grab(struct input *input, int32_t touch_id);
 552
 553 void
 554 touch_ungrab(struct input *input);
 555
 556 void
 557 input_grab(struct input *input, struct widget *widget, uint32_t button);
 558
 559 void
 560 input_ungrab(struct input *input);
 561
 562 struct widget *
 563 input_get_focus_widget(struct input *input);
 564
 565 struct display *
 566 input_get_display(struct input *input);
 567
 568 struct wl_seat *
 569 input_get_seat(struct input *input);
 570
 571 struct wl_data_device *
 572 input_get_data_device(struct input *input);
 573
 574 void
 575 input_set_selection(struct input *input,
 576                     struct wl_data_source *source, uint32_t time);
 577
 578 void
 579 input_accept(struct input *input, const char *type);
 580
 581
 582 void
 583 input_receive_drag_data(struct input *input, const char *mime_type,
 584                         data_func_t func, void *user_data);
 585 int
 586 input_receive_drag_data_to_fd(struct input *input,
 587                               const char *mime_type, int fd);
 588
 589 int
 590 input_receive_selection_data(struct input *input, const char *mime_type,
 591                              data_func_t func, void *data);
 592 int
 593 input_receive_selection_data_to_fd(struct input *input,
 594                                    const char *mime_type, int fd);
 595
 596 void
 597 output_set_user_data(struct output *output, void *data);
 598
 599 void *
 600 output_get_user_data(struct output *output);
 601
 602 void
 603 output_set_destroy_handler(struct output *output,
 604                            display_output_handler_t handler);
 605
 606 void
 607 output_get_allocation(struct output *output, struct rectangle *allocation);
 608
 609 struct wl_output *
 610 output_get_wl_output(struct output *output);
 611
 612 enum wl_output_transform
 613 output_get_transform(struct output *output);
 614
 615 uint32_t
 616 output_get_scale(struct output *output);
 617
 618 const char *
 619 output_get_make(struct output *output);
 620
 621 const char *
 622 output_get_model(struct output *output);
 623
 624 void
 625 keysym_modifiers_add(struct wl_array *modifiers_map,
 626                      const char *name);
 627
 628 xkb_mod_mask_t
 629 keysym_modifiers_get_mask(struct wl_array *modifiers_map,
 630                           const char *name);
 631
 632 #endif