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 <X11/extensions/XKBcommon.h>
  27 #include <glib.h>
  28 #include <wayland-client.h>
  29 #include <cairo.h>
  30
  31 struct window;
  32 struct item;
  33 struct display;
  34 struct input;
  35
  36 struct task {
  37         void (*run)(struct task *task, uint32_t events);
  38         struct wl_list link;
  39 };
  40
  41 struct rectangle {
  42         int32_t x;
  43         int32_t y;
  44         int32_t width;
  45         int32_t height;
  46 };
  47
  48 struct display *
  49 display_create(int *argc, char **argv[], const GOptionEntry *option_entries);
  50
  51 struct wl_display *
  52 display_get_display(struct display *display);
  53
  54 struct wl_compositor *
  55 display_get_compositor(struct display *display);
  56
  57 struct wl_shell *
  58 display_get_shell(struct display *display);
  59
  60 struct wl_data_source *
  61 display_create_data_source(struct display *display);
  62
  63 #ifdef EGL_NO_DISPLAY
  64 EGLDisplay
  65 display_get_egl_display(struct display *d);
  66
  67 EGLConfig
  68 display_get_rgb_egl_config(struct display *d);
  69
  70 EGLConfig
  71 display_get_argb_egl_config(struct display *d);
  72
  73 int
  74 display_acquire_window_surface(struct display *display,
  75                                struct window *window,
  76                                EGLContext ctx);
  77 void
  78 display_release_window_surface(struct display *display,
  79                                struct window *window);
  80
  81 #ifdef HAVE_CAIRO_EGL
  82 EGLImageKHR
  83 display_get_image_for_egl_image_surface(struct display *display,
  84                                         cairo_surface_t *surface);
  85 #endif
  86 #endif
  87
  88 #define SURFACE_OPAQUE 0x01
  89
  90 cairo_surface_t *
  91 display_create_surface(struct display *display,
  92                        struct wl_surface *surface,
  93                        struct rectangle *rectangle,
  94                        uint32_t flags);
  95
  96 struct wl_buffer *
  97 display_get_buffer_for_surface(struct display *display,
  98                                cairo_surface_t *surface);
  99
 100 cairo_surface_t *
 101 display_get_pointer_surface(struct display *display, int pointer,
 102                             int *width, int *height,
 103                             int *hotspot_x, int *hotspot_y);
 104
 105 void
 106 display_defer(struct display *display, struct task *task);
 107
 108 void
 109 display_watch_fd(struct display *display,
 110                  int fd, uint32_t events, struct task *task);
 111
 112 void
 113 display_run(struct display *d);
 114
 115 enum pointer_type {
 116         POINTER_BOTTOM_LEFT,
 117         POINTER_BOTTOM_RIGHT,
 118         POINTER_BOTTOM,
 119         POINTER_DRAGGING,
 120         POINTER_LEFT_PTR,
 121         POINTER_LEFT,
 122         POINTER_RIGHT,
 123         POINTER_TOP_LEFT,
 124         POINTER_TOP_RIGHT,
 125         POINTER_TOP,
 126         POINTER_IBEAM,
 127         POINTER_HAND1,
 128 };
 129
 130 typedef void (*window_resize_handler_t)(struct window *window,
 131                                         int32_t width, int32_t height,
 132                                         void *data);
 133 typedef void (*window_redraw_handler_t)(struct window *window, void *data);
 134
 135 typedef void (*window_key_handler_t)(struct window *window, struct input *input,
 136                                      uint32_t time, uint32_t key, uint32_t unicode,
 137                                      uint32_t state, void *data);
 138
 139 typedef void (*window_keyboard_focus_handler_t)(struct window *window,
 140                                                 struct input *device, void *data);
 141
 142 typedef void (*window_button_handler_t)(struct window *window,
 143                                         struct input *input, uint32_t time,
 144                                         int button, int state, void *data);
 145
 146 typedef int (*window_enter_handler_t)(struct window *window,
 147                                       struct input *input, uint32_t time,
 148                                       int32_t x, int32_t y, void *data);
 149 typedef void (*window_leave_handler_t)(struct window *window,
 150                                        struct input *input, uint32_t time,
 151                                        void *data);
 152
 153 typedef int (*window_motion_handler_t)(struct window *window,
 154                                        struct input *input, uint32_t time,
 155                                        int32_t x, int32_t y,
 156                                        int32_t sx, int32_t sy, void *data);
 157
 158 typedef void (*window_data_handler_t)(struct window *window,
 159                                       struct input *input, uint32_t time,
 160                                       int32_t x, int32_t y,
 161                                       const char **types,
 162                                       void *data);
 163
 164 typedef void (*window_drop_handler_t)(struct window *window,
 165                                       struct input *input,
 166                                       int32_t x, int32_t y, void *data);
 167
 168 typedef void (*window_item_focus_handler_t)(struct window *window,
 169                                             struct item *focus, void *data);
 170
 171 struct window *
 172 window_create(struct display *display, int32_t width, int32_t height);
 173 struct window *
 174 window_create_transient(struct display *display, struct window *parent,
 175                         int32_t x, int32_t y, int32_t width, int32_t height);
 176
 177 void
 178 window_destroy(struct window *window);
 179
 180 struct item *
 181 window_add_item(struct window *window, void *data);
 182
 183 typedef void (*item_func_t)(struct item *item, void *data);
 184
 185 typedef void (*data_func_t)(void *data, size_t len,
 186                             int32_t x, int32_t y, void *user_data);
 187
 188 void
 189 window_for_each_item(struct window *window, item_func_t func, void *data);
 190
 191 struct item *
 192 window_get_focus_item(struct window *window);
 193 struct display *
 194 window_get_display(struct window *window);
 195
 196 void
 197 window_move(struct window *window, struct input *input, uint32_t time);
 198
 199 void
 200 window_draw(struct window *window);
 201
 202 void
 203 window_get_allocation(struct window *window,
 204                       struct rectangle *allocation);
 205
 206 void
 207 window_get_child_allocation(struct window *window,
 208                             struct rectangle *allocation);
 209
 210 void
 211 window_set_transparent(struct window *window, int transparent);
 212 void
 213 window_set_child_size(struct window *window, int32_t width, int32_t height);
 214 void
 215 window_schedule_redraw(struct window *window);
 216
 217 void
 218 window_damage(struct window *window, int32_t x, int32_t y,
 219               int32_t width, int32_t height);
 220
 221 cairo_surface_t *
 222 window_get_surface(struct window *window);
 223
 224 struct wl_surface *
 225 window_get_wl_surface(struct window *window);
 226
 227 void
 228 window_flush(struct window *window);
 229
 230 void
 231 window_set_surface(struct window *window, cairo_surface_t *surface);
 232
 233 void
 234 window_create_surface(struct window *window);
 235
 236 enum window_buffer_type {
 237         WINDOW_BUFFER_TYPE_EGL_WINDOW,
 238         WINDOW_BUFFER_TYPE_EGL_IMAGE,
 239         WINDOW_BUFFER_TYPE_SHM,
 240 };
 241
 242 void
 243 display_surface_damage(struct display *display, cairo_surface_t *cairo_surface,
 244                        int32_t x, int32_t y, int32_t width, int32_t height);
 245
 246 void
 247 window_set_buffer_type(struct window *window, enum window_buffer_type type);
 248
 249 void
 250 window_set_fullscreen(struct window *window, int fullscreen);
 251
 252 void
 253 window_set_custom(struct window *window);
 254
 255 void
 256 window_set_user_data(struct window *window, void *data);
 257
 258 void *
 259 window_get_user_data(struct window *window);
 260
 261 void
 262 window_set_redraw_handler(struct window *window,
 263                           window_redraw_handler_t handler);
 264
 265 void
 266 window_set_decoration(struct window *window, int decoration);
 267
 268 void
 269 window_set_resize_handler(struct window *window,
 270                           window_resize_handler_t handler);
 271
 272 void
 273 window_set_key_handler(struct window *window,
 274                        window_key_handler_t handler);
 275
 276 void
 277 window_set_button_handler(struct window *window,
 278                           window_button_handler_t handler);
 279
 280 void
 281 window_set_motion_handler(struct window *window,
 282                           window_motion_handler_t handler);
 283
 284 void
 285 window_set_enter_handler(struct window *window,
 286                          window_enter_handler_t handler);
 287 void
 288 window_set_leave_handler(struct window *window,
 289                          window_leave_handler_t handler);
 290
 291 void
 292 window_set_keyboard_focus_handler(struct window *window,
 293                                   window_keyboard_focus_handler_t handler);
 294
 295 void
 296 window_set_item_focus_handler(struct window *window,
 297                               window_item_focus_handler_t handler);
 298
 299 void
 300 window_set_data_handler(struct window *window,
 301                         window_data_handler_t handler);
 302
 303 void
 304 window_set_drop_handler(struct window *window,
 305                         window_drop_handler_t handler);
 306
 307 void
 308 window_set_title(struct window *window, const char *title);
 309
 310 const char *
 311 window_get_title(struct window *window);
 312
 313 void
 314 item_get_allocation(struct item *item, struct rectangle *allocation);
 315
 316 void
 317 item_set_allocation(struct item *item,
 318                     int32_t x, int32_t y, int32_t width, int32_t height);
 319
 320 void *
 321 item_get_user_data(struct item *item);
 322
 323 void
 324 input_set_pointer_image(struct input *input, uint32_t time, int pointer);
 325
 326 void
 327 input_get_position(struct input *input, int32_t *x, int32_t *y);
 328
 329 uint32_t
 330 input_get_modifiers(struct input *input);
 331
 332 struct wl_input_device *
 333 input_get_input_device(struct input *input);
 334
 335 struct wl_data_device *
 336 input_get_data_device(struct input *input);
 337
 338 void
 339 input_set_selection(struct input *input,
 340                     struct wl_data_source *source, uint32_t time);
 341
 342 void
 343 input_accept(struct input *input, uint32_t time, const char *type);
 344
 345
 346 void
 347 input_receive_drag_data(struct input *input, const char *mime_type,
 348                         data_func_t func, void *user_data);
 349
 350 int
 351 input_receive_selection_data(struct input *input, const char *mime_type,
 352                              data_func_t func, void *data);
 353
 354 enum {
 355         CONFIG_KEY_INTEGER,
 356         CONFIG_KEY_STRING,
 357         CONFIG_KEY_BOOL
 358 };
 359
 360 struct config_key {
 361         const char *name;
 362         int type;
 363         void *data;
 364 };
 365
 366 struct config_section {
 367         const char *name;
 368         const struct config_key *keys;
 369         int num_keys;
 370         void (*done)(void *data);
 371 };
 372
 373 int
 374 parse_config_file(const char *path,
 375                   const struct config_section *sections, int num_sections,
 376                   void *data);
 377
 378 char *
 379 config_file_path(const char *name);
 380
 381 #endif