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