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