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 cairo_surface_t *
 130 display_create_surface(struct display *display,
 131                        struct wl_surface *surface,
 132                        struct rectangle *rectangle,
 133                        uint32_t flags);
 134
 135 struct wl_buffer *
 136 display_get_buffer_for_surface(struct display *display,
 137                                cairo_surface_t *surface);
 138
 139 struct wl_cursor_image *
 140 display_get_pointer_image(struct display *display, int pointer);
 141
 142 void
 143 display_defer(struct display *display, struct task *task);
 144
 145 void
 146 display_watch_fd(struct display *display,
 147                  int fd, uint32_t events, struct task *task);
 148
 149 void
 150 display_unwatch_fd(struct display *display, int fd);
 151
 152 void
 153 display_run(struct display *d);
 154
 155 void
 156 display_exit(struct display *d);
 157
 158 enum cursor_type {
 159         CURSOR_BOTTOM_LEFT,
 160         CURSOR_BOTTOM_RIGHT,
 161         CURSOR_BOTTOM,
 162         CURSOR_DRAGGING,
 163         CURSOR_LEFT_PTR,
 164         CURSOR_LEFT,
 165         CURSOR_RIGHT,
 166         CURSOR_TOP_LEFT,
 167         CURSOR_TOP_RIGHT,
 168         CURSOR_TOP,
 169         CURSOR_IBEAM,
 170         CURSOR_HAND1,
 171         CURSOR_WATCH,
 172
 173         CURSOR_BLANK
 174 };
 175
 176 typedef void (*window_key_handler_t)(struct window *window, struct input *input,
 177                                      uint32_t time, uint32_t key, uint32_t unicode,
 178                                      enum wl_keyboard_key_state state, void *data);
 179
 180 typedef void (*window_keyboard_focus_handler_t)(struct window *window,
 181                                                 struct input *device, void *data);
 182
 183 typedef void (*window_data_handler_t)(struct window *window,
 184                                       struct input *input,
 185                                       float x, float y,
 186                                       const char **types,
 187                                       void *data);
 188
 189 typedef void (*window_drop_handler_t)(struct window *window,
 190                                       struct input *input,
 191                                       int32_t x, int32_t y, void *data);
 192
 193 typedef void (*window_close_handler_t)(struct window *window, void *data);
 194 typedef void (*window_fullscreen_handler_t)(struct window *window, void *data);
 195
 196 typedef void (*window_output_handler_t)(struct window *window, struct output *output,
 197                                         int enter, void *data);
 198
 199 typedef void (*widget_resize_handler_t)(struct widget *widget,
 200                                         int32_t width, int32_t height,
 201                                         void *data);
 202 typedef void (*widget_redraw_handler_t)(struct widget *widget, void *data);
 203
 204 typedef int (*widget_enter_handler_t)(struct widget *widget,
 205                                       struct input *input,
 206                                       float x, float y, void *data);
 207 typedef void (*widget_leave_handler_t)(struct widget *widget,
 208                                        struct input *input, void *data);
 209 typedef int (*widget_motion_handler_t)(struct widget *widget,
 210                                        struct input *input, uint32_t time,
 211                                        float x, float y, void *data);
 212 typedef void (*widget_button_handler_t)(struct widget *widget,
 213                                         struct input *input, uint32_t time,
 214                                         uint32_t button,
 215                                         enum wl_pointer_button_state state,
 216                                         void *data);
 217 typedef void (*widget_axis_handler_t)(struct widget *widget,
 218                                       struct input *input, uint32_t time,
 219                                       uint32_t axis,
 220                                       wl_fixed_t value,
 221                                       void *data);
 222
 223 struct window *
 224 window_create(struct display *display);
 225 struct window *
 226 window_create_transient(struct display *display, struct window *parent,
 227                         int32_t x, int32_t y, uint32_t flags);
 228 struct window *
 229 window_create_custom(struct display *display);
 230
 231 int
 232 window_has_focus(struct window *window);
 233
 234 typedef void (*menu_func_t)(struct window *window, int index, void *data);
 235
 236 void
 237 window_show_menu(struct display *display,
 238                  struct input *input, uint32_t time, struct window *parent,
 239                  int32_t x, int32_t y,
 240                  menu_func_t func, const char **entries, int count);
 241
 242 void
 243 window_show_frame_menu(struct window *window,
 244                        struct input *input, uint32_t time);
 245
 246 int
 247 window_get_buffer_transform(struct window *window);
 248
 249 void
 250 window_set_buffer_transform(struct window *window,
 251                             enum wl_output_transform transform);
 252
 253 void
 254 window_destroy(struct window *window);
 255
 256 struct widget *
 257 window_add_widget(struct window *window, void *data);
 258
 259 typedef void (*data_func_t)(void *data, size_t len,
 260                             int32_t x, int32_t y, void *user_data);
 261
 262 struct display *
 263 window_get_display(struct window *window);
 264 void
 265 window_move(struct window *window, struct input *input, uint32_t time);
 266 void
 267 window_get_allocation(struct window *window, struct rectangle *allocation);
 268 void
 269 window_schedule_redraw(struct window *window);
 270 void
 271 window_schedule_resize(struct window *window, int width, int height);
 272
 273 void
 274 window_damage(struct window *window, int32_t x, int32_t y,
 275               int32_t width, int32_t height);
 276
 277 cairo_surface_t *
 278 window_get_surface(struct window *window);
 279
 280 struct wl_surface *
 281 window_get_wl_surface(struct window *window);
 282
 283 struct wl_shell_surface *
 284 window_get_wl_shell_surface(struct window *window);
 285
 286 enum window_buffer_type {
 287         WINDOW_BUFFER_TYPE_EGL_WINDOW,
 288         WINDOW_BUFFER_TYPE_SHM,
 289 };
 290
 291 void
 292 display_surface_damage(struct display *display, cairo_surface_t *cairo_surface,
 293                        int32_t x, int32_t y, int32_t width, int32_t height);
 294
 295 void
 296 window_set_buffer_type(struct window *window, enum window_buffer_type type);
 297
 298 int
 299 window_is_fullscreen(struct window *window);
 300
 301 void
 302 window_set_fullscreen(struct window *window, int fullscreen);
 303
 304 void
 305 window_set_fullscreen_method(struct window *window,
 306                              enum wl_shell_surface_fullscreen_method method);
 307 int
 308 window_is_maximized(struct window *window);
 309
 310 void
 311 window_set_maximized(struct window *window, int maximized);
 312
 313 void
 314 window_set_user_data(struct window *window, void *data);
 315
 316 void *
 317 window_get_user_data(struct window *window);
 318
 319 void
 320 window_set_key_handler(struct window *window,
 321                        window_key_handler_t handler);
 322
 323 void
 324 window_set_keyboard_focus_handler(struct window *window,
 325                                   window_keyboard_focus_handler_t handler);
 326
 327 void
 328 window_set_data_handler(struct window *window,
 329                         window_data_handler_t handler);
 330
 331 void
 332 window_set_drop_handler(struct window *window,
 333                         window_drop_handler_t handler);
 334
 335 void
 336 window_set_close_handler(struct window *window,
 337                          window_close_handler_t handler);
 338 void
 339 window_set_fullscreen_handler(struct window *window,
 340                               window_fullscreen_handler_t handler);
 341 void
 342 window_set_output_handler(struct window *window,
 343                           window_output_handler_t handler);
 344
 345 void
 346 window_set_title(struct window *window, const char *title);
 347
 348 const char *
 349 window_get_title(struct window *window);
 350
 351 void
 352 window_set_text_cursor_position(struct window *window, int32_t x, int32_t y);
 353
 354 int
 355 widget_set_tooltip(struct widget *parent, char *entry, float x, float y);
 356
 357 void
 358 widget_destroy_tooltip(struct widget *parent);
 359
 360 struct widget *
 361 widget_add_widget(struct widget *parent, void *data);
 362
 363 void
 364 widget_destroy(struct widget *widget);
 365 void
 366 widget_set_default_cursor(struct widget *widget, int cursor);
 367 void
 368 widget_get_allocation(struct widget *widget, struct rectangle *allocation);
 369
 370 void
 371 widget_set_allocation(struct widget *widget,
 372                       int32_t x, int32_t y, int32_t width, int32_t height);
 373 void
 374 widget_set_size(struct widget *widget, int32_t width, int32_t height);
 375 void
 376 widget_set_transparent(struct widget *widget, int transparent);
 377 void
 378 widget_schedule_resize(struct widget *widget, int32_t width, int32_t height);
 379
 380 void *
 381 widget_get_user_data(struct widget *widget);
 382
 383 void
 384 widget_set_redraw_handler(struct widget *widget,
 385                           widget_redraw_handler_t handler);
 386 void
 387 widget_set_resize_handler(struct widget *widget,
 388                           widget_resize_handler_t handler);
 389 void
 390 widget_set_enter_handler(struct widget *widget,
 391                          widget_enter_handler_t handler);
 392 void
 393 widget_set_leave_handler(struct widget *widget,
 394                          widget_leave_handler_t handler);
 395 void
 396 widget_set_motion_handler(struct widget *widget,
 397                           widget_motion_handler_t handler);
 398 void
 399 widget_set_button_handler(struct widget *widget,
 400                           widget_button_handler_t handler);
 401 void
 402 widget_set_axis_handler(struct widget *widget,
 403                         widget_axis_handler_t handler);
 404
 405 void
 406 widget_schedule_redraw(struct widget *widget);
 407
 408 struct widget *
 409 frame_create(struct window *window, void *data);
 410 void
 411 frame_set_child_size(struct widget *widget, int child_width, int child_height);
 412
 413 void
 414 input_set_pointer_image(struct input *input, int pointer);
 415
 416 void
 417 input_get_position(struct input *input, int32_t *x, int32_t *y);
 418
 419 #define MOD_SHIFT_MASK          0x01
 420 #define MOD_ALT_MASK            0x02
 421 #define MOD_CONTROL_MASK        0x04
 422
 423 uint32_t
 424 input_get_modifiers(struct input *input);
 425
 426 void
 427 input_grab(struct input *input, struct widget *widget, uint32_t button);
 428
 429 void
 430 input_ungrab(struct input *input);
 431
 432 struct widget *
 433 input_get_focus_widget(struct input *input);
 434
 435 struct display *
 436 input_get_display(struct input *input);
 437
 438 struct wl_seat *
 439 input_get_seat(struct input *input);
 440
 441 struct wl_data_device *
 442 input_get_data_device(struct input *input);
 443
 444 void
 445 input_set_selection(struct input *input,
 446                     struct wl_data_source *source, uint32_t time);
 447
 448 void
 449 input_accept(struct input *input, const char *type);
 450
 451
 452 void
 453 input_receive_drag_data(struct input *input, const char *mime_type,
 454                         data_func_t func, void *user_data);
 455
 456 int
 457 input_receive_selection_data(struct input *input, const char *mime_type,
 458                              data_func_t func, void *data);
 459 int
 460 input_receive_selection_data_to_fd(struct input *input,
 461                                    const char *mime_type, int fd);
 462
 463 void
 464 output_set_user_data(struct output *output, void *data);
 465
 466 void *
 467 output_get_user_data(struct output *output);
 468
 469 void
 470 output_set_destroy_handler(struct output *output,
 471                            display_output_handler_t handler);
 472
 473 void
 474 output_get_allocation(struct output *output, struct rectangle *allocation);
 475
 476 struct wl_output *
 477 output_get_wl_output(struct output *output);
 478
 479 enum wl_output_transform
 480 output_get_transform(struct output *output);
 481
 482 void
 483 keysym_modifiers_add(struct wl_array *modifiers_map,
 484                      const char *name);
 485
 486 xkb_mod_mask_t
 487 keysym_modifiers_get_mask(struct wl_array *modifiers_map,
 488                           const char *name);
 489
 490 #endif