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