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 <GLES2/gl2.h>
  27 #include <xkbcommon/xkbcommon.h>
  28 #include <wayland-client.h>
  29 #include <cairo.h>
  30 #include "../shared/config-parser.h"
  31
  32 struct window;
  33 struct widget;
  34 struct display;
  35 struct input;
  36 struct output;
  37
  38 struct task {
  39         void (*run)(struct task *task, uint32_t events);
  40         struct wl_list link;
  41 };
  42
  43 struct rectangle {
  44         int32_t x;
  45         int32_t y;
  46         int32_t width;
  47         int32_t height;
  48 };
  49
  50 struct display *
  51 display_create(int argc, char *argv[]);
  52
  53 void
  54 display_destroy(struct display *display);
  55
  56 void
  57 display_set_user_data(struct display *display, void *data);
  58
  59 void *
  60 display_get_user_data(struct display *display);
  61
  62 struct wl_display *
  63 display_get_display(struct display *display);
  64
  65 struct wl_compositor *
  66 display_get_compositor(struct display *display);
  67
  68 struct wl_shell *
  69 display_get_shell(struct display *display);
  70
  71 struct output *
  72 display_get_output(struct display *display);
  73
  74 uint32_t
  75 display_get_serial(struct display *display);
  76
  77 typedef void (*display_output_handler_t)(struct output *output, void *data);
  78
  79 /*
  80  * The output configure handler is called, when a new output is connected
  81  * and we know its current mode, or when the current mode changes.
  82  * Test and set the output user data in your handler to know, if the
  83  * output is new. Note: 'data' in the configure handler is the display
  84  * user data.
  85  */
  86 void
  87 display_set_output_configure_handler(struct display *display,
  88                                      display_output_handler_t handler);
  89
  90 struct wl_data_source *
  91 display_create_data_source(struct display *display);
  92
  93 #ifdef EGL_NO_DISPLAY
  94 EGLDisplay
  95 display_get_egl_display(struct display *d);
  96
  97 EGLConfig
  98 display_get_argb_egl_config(struct display *d);
  99
 100 int
 101 display_acquire_window_surface(struct display *display,
 102                                struct window *window,
 103                                EGLContext ctx);
 104 void
 105 display_release_window_surface(struct display *display,
 106                                struct window *window);
 107
 108 #ifdef HAVE_CAIRO_EGL
 109 EGLImageKHR
 110 display_get_image_for_egl_image_surface(struct display *display,
 111                                         cairo_surface_t *surface);
 112 #endif
 113 #endif
 114
 115 #define SURFACE_OPAQUE 0x01
 116
 117 cairo_surface_t *
 118 display_create_surface(struct display *display,
 119                        struct wl_surface *surface,
 120                        struct rectangle *rectangle,
 121                        uint32_t flags);
 122
 123 struct wl_buffer *
 124 display_get_buffer_for_surface(struct display *display,
 125                                cairo_surface_t *surface);
 126
 127 cairo_surface_t *
 128 display_get_pointer_surface(struct display *display, int pointer,
 129                             int *width, int *height,
 130                             int *hotspot_x, int *hotspot_y);
 131
 132 void
 133 display_defer(struct display *display, struct task *task);
 134
 135 void
 136 display_watch_fd(struct display *display,
 137                  int fd, uint32_t events, struct task *task);
 138
 139 void
 140 display_run(struct display *d);
 141
 142 void
 143 display_exit(struct display *d);
 144
 145 enum pointer_type {
 146         POINTER_BOTTOM_LEFT,
 147         POINTER_BOTTOM_RIGHT,
 148         POINTER_BOTTOM,
 149         POINTER_DRAGGING,
 150         POINTER_LEFT_PTR,
 151         POINTER_LEFT,
 152         POINTER_RIGHT,
 153         POINTER_TOP_LEFT,
 154         POINTER_TOP_RIGHT,
 155         POINTER_TOP,
 156         POINTER_IBEAM,
 157         POINTER_HAND1,
 158 };
 159
 160 typedef void (*window_key_handler_t)(struct window *window, struct input *input,
 161                                      uint32_t time, uint32_t key, uint32_t unicode,
 162                                      uint32_t state, void *data);
 163
 164 typedef void (*window_keyboard_focus_handler_t)(struct window *window,
 165                                                 struct input *device, void *data);
 166
 167 typedef void (*window_data_handler_t)(struct window *window,
 168                                       struct input *input,
 169                                       GLfloat x, GLfloat y,
 170                                       const char **types,
 171                                       void *data);
 172
 173 typedef void (*window_drop_handler_t)(struct window *window,
 174                                       struct input *input,
 175                                       int32_t x, int32_t y, void *data);
 176
 177 typedef void (*window_close_handler_t)(struct window *window, void *data);
 178
 179 typedef void (*widget_resize_handler_t)(struct widget *widget,
 180                                         int32_t width, int32_t height,
 181                                         void *data);
 182 typedef void (*widget_redraw_handler_t)(struct widget *widget, void *data);
 183
 184 typedef int (*widget_enter_handler_t)(struct widget *widget,
 185                                       struct input *input,
 186                                       GLfloat x, GLfloat y, void *data);
 187 typedef void (*widget_leave_handler_t)(struct widget *widget,
 188                                        struct input *input, void *data);
 189 typedef int (*widget_motion_handler_t)(struct widget *widget,
 190                                        struct input *input, uint32_t time,
 191                                        GLfloat x, GLfloat y, void *data);
 192 typedef void (*widget_button_handler_t)(struct widget *widget,
 193                                         struct input *input, uint32_t time,
 194                                         uint32_t button, uint32_t state,
 195                                         void *data);
 196
 197 struct window *
 198 window_create(struct display *display);
 199 struct window *
 200 window_create_transient(struct display *display, struct window *parent,
 201                         int32_t x, int32_t y);
 202
 203 typedef void (*menu_func_t)(struct window *window, int index, void *data);
 204
 205 void
 206 window_show_menu(struct display *display,
 207                  struct input *input, uint32_t time, struct window *parent,
 208                  int32_t x, int32_t y,
 209                  menu_func_t func, const char **entries, int count);
 210
 211 void
 212 window_show_frame_menu(struct window *window,
 213                        struct input *input, uint32_t time);
 214
 215 void
 216 window_destroy(struct window *window);
 217
 218 struct widget *
 219 window_add_widget(struct window *window, void *data);
 220
 221 typedef void (*data_func_t)(void *data, size_t len,
 222                             int32_t x, int32_t y, void *user_data);
 223
 224 struct display *
 225 window_get_display(struct window *window);
 226 void
 227 window_move(struct window *window, struct input *input, uint32_t time);
 228 void
 229 window_get_allocation(struct window *window, struct rectangle *allocation);
 230 void
 231 window_set_transparent(struct window *window, int transparent);
 232 void
 233 window_schedule_redraw(struct window *window);
 234 void
 235 window_schedule_resize(struct window *window, int width, int height);
 236
 237 void
 238 window_damage(struct window *window, int32_t x, int32_t y,
 239               int32_t width, int32_t height);
 240
 241 cairo_surface_t *
 242 window_get_surface(struct window *window);
 243
 244 struct wl_surface *
 245 window_get_wl_surface(struct window *window);
 246
 247 struct wl_shell_surface *
 248 window_get_wl_shell_surface(struct window *window);
 249
 250 void
 251 window_flush(struct window *window);
 252
 253 void
 254 window_set_surface(struct window *window, cairo_surface_t *surface);
 255
 256 void
 257 window_create_surface(struct window *window);
 258
 259 enum window_buffer_type {
 260         WINDOW_BUFFER_TYPE_EGL_WINDOW,
 261         WINDOW_BUFFER_TYPE_SHM,
 262 };
 263
 264 void
 265 display_surface_damage(struct display *display, cairo_surface_t *cairo_surface,
 266                        int32_t x, int32_t y, int32_t width, int32_t height);
 267
 268 void
 269 window_set_buffer_type(struct window *window, enum window_buffer_type type);
 270
 271 void
 272 window_set_fullscreen(struct window *window, int fullscreen);
 273
 274 void
 275 window_set_maximized(struct window *window, int maximized);
 276
 277 void
 278 window_set_custom(struct window *window);
 279
 280 void
 281 window_set_user_data(struct window *window, void *data);
 282
 283 void *
 284 window_get_user_data(struct window *window);
 285
 286 void
 287 window_set_key_handler(struct window *window,
 288                        window_key_handler_t handler);
 289
 290 void
 291 window_set_keyboard_focus_handler(struct window *window,
 292                                   window_keyboard_focus_handler_t handler);
 293
 294 void
 295 window_set_data_handler(struct window *window,
 296                         window_data_handler_t handler);
 297
 298 void
 299 window_set_drop_handler(struct window *window,
 300                         window_drop_handler_t handler);
 301
 302 void
 303 window_set_close_handler(struct window *window,
 304                          window_close_handler_t handler);
 305
 306 void
 307 window_set_title(struct window *window, const char *title);
 308
 309 const char *
 310 window_get_title(struct window *window);
 311
 312 struct widget *
 313 widget_add_widget(struct widget *parent, void *data);
 314 void
 315 widget_destroy(struct widget *widget);
 316 void
 317 widget_get_allocation(struct widget *widget, struct rectangle *allocation);
 318
 319 void
 320 widget_set_allocation(struct widget *widget,
 321                       int32_t x, int32_t y, int32_t width, int32_t height);
 322 void
 323 widget_set_size(struct widget *widget, int32_t width, int32_t height);
 324 void
 325 widget_set_transparent(struct widget *widget, int transparent);
 326 void
 327 widget_schedule_resize(struct widget *widget, int32_t width, int32_t height);
 328
 329 void *
 330 widget_get_user_data(struct widget *widget);
 331
 332 void
 333 widget_set_redraw_handler(struct widget *widget,
 334                           widget_redraw_handler_t handler);
 335 void
 336 widget_set_resize_handler(struct widget *widget,
 337                           widget_resize_handler_t handler);
 338 void
 339 widget_set_enter_handler(struct widget *widget,
 340                          widget_enter_handler_t handler);
 341 void
 342 widget_set_leave_handler(struct widget *widget,
 343                          widget_leave_handler_t handler);
 344 void
 345 widget_set_motion_handler(struct widget *widget,
 346                           widget_motion_handler_t handler);
 347 void
 348 widget_set_button_handler(struct widget *widget,
 349                           widget_button_handler_t handler);
 350
 351 void
 352 widget_schedule_redraw(struct widget *widget);
 353
 354 struct widget *
 355 frame_create(struct window *window, void *data);
 356
 357 void
 358 input_set_pointer_image(struct input *input, uint32_t time, int pointer);
 359
 360 void
 361 input_get_position(struct input *input, int32_t *x, int32_t *y);
 362
 363 uint32_t
 364 input_get_modifiers(struct input *input);
 365
 366 void
 367 input_grab(struct input *input, struct widget *widget, uint32_t button);
 368
 369 void
 370 input_ungrab(struct input *input);
 371
 372 struct widget *
 373 input_get_focus_widget(struct input *input);
 374
 375 struct wl_input_device *
 376 input_get_input_device(struct input *input);
 377
 378 struct wl_data_device *
 379 input_get_data_device(struct input *input);
 380
 381 void
 382 input_set_selection(struct input *input,
 383                     struct wl_data_source *source, uint32_t time);
 384
 385 void
 386 input_accept(struct input *input, const char *type);
 387
 388
 389 void
 390 input_receive_drag_data(struct input *input, const char *mime_type,
 391                         data_func_t func, void *user_data);
 392
 393 int
 394 input_receive_selection_data(struct input *input, const char *mime_type,
 395                              data_func_t func, void *data);
 396 int
 397 input_receive_selection_data_to_fd(struct input *input,
 398                                    const char *mime_type, int fd);
 399
 400 void
 401 output_set_user_data(struct output *output, void *data);
 402
 403 void *
 404 output_get_user_data(struct output *output);
 405
 406 void
 407 output_set_destroy_handler(struct output *output,
 408                            display_output_handler_t handler);
 409
 410 void
 411 output_get_allocation(struct output *output, struct rectangle *allocation);
 412
 413 struct wl_output *
 414 output_get_wl_output(struct output *output);
 415
 416 #endif