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