src/video/wayland/SDL_waylandmouse.c
author Gabriel Jacobo <gabomdq@gmail.com>
Sat, 14 Dec 2013 20:18:43 -0300
changeset 8062 4fc5f66d63cc
child 8104 2e4f1bd21196
permissions -rw-r--r--
Wayland support

Based on the original port to Wayland by: Joel Teichroeb, Benjamin Franzke, Scott Moreau, et al.

Additional changes in this commit, done by me:

* Wayland uses the common EGL framework
* EGL can now create a desktop OpenGL context
* testgl2 loads GL functions dynamically, no need to link to libGL anymore
* Assorted fixes to the Wayland backend

Tested on the Weston Compositor (v1.0.5) that ships with Ubuntu 13.10,
running Weston under X. Tests ran: testrendercopyex (all backends), testgl2, testgles2,testintersections
gabomdq@8062
     1
/*
gabomdq@8062
     2
  Simple DirectMedia Layer
gabomdq@8062
     3
  Copyright (C) 1997-2013 Sam Lantinga <slouken@libsdl.org>
gabomdq@8062
     4
gabomdq@8062
     5
  This software is provided 'as-is', without any express or implied
gabomdq@8062
     6
  warranty.  In no event will the authors be held liable for any damages
gabomdq@8062
     7
  arising from the use of this software.
gabomdq@8062
     8
gabomdq@8062
     9
  Permission is granted to anyone to use this software for any purpose,
gabomdq@8062
    10
  including commercial applications, and to alter it and redistribute it
gabomdq@8062
    11
  freely, subject to the following restrictions:
gabomdq@8062
    12
gabomdq@8062
    13
  1. The origin of this software must not be misrepresented; you must not
gabomdq@8062
    14
     claim that you wrote the original software. If you use this software
gabomdq@8062
    15
     in a product, an acknowledgment in the product documentation would be
gabomdq@8062
    16
     appreciated but is not required.
gabomdq@8062
    17
  2. Altered source versions must be plainly marked as such, and must not be
gabomdq@8062
    18
     misrepresented as being the original software.
gabomdq@8062
    19
  3. This notice may not be removed or altered from any source distribution.
gabomdq@8062
    20
*/
gabomdq@8062
    21
gabomdq@8062
    22
#ifndef _GNU_SOURCE
gabomdq@8062
    23
#define _GNU_SOURCE
gabomdq@8062
    24
#endif
gabomdq@8062
    25
gabomdq@8062
    26
#include <errno.h>
gabomdq@8062
    27
#include <sys/types.h>
gabomdq@8062
    28
#include <sys/mman.h>
gabomdq@8062
    29
#include <fcntl.h>
gabomdq@8062
    30
#include <unistd.h>
gabomdq@8062
    31
#include <stdlib.h>
gabomdq@8062
    32
#include <limits.h>
gabomdq@8062
    33
gabomdq@8062
    34
#include "../SDL_sysvideo.h"
gabomdq@8062
    35
gabomdq@8062
    36
#include "SDL_config.h"
gabomdq@8062
    37
#include "SDL_mouse.h"
gabomdq@8062
    38
#include "../../events/SDL_mouse_c.h"
gabomdq@8062
    39
#include "SDL_waylandvideo.h"
gabomdq@8062
    40
#include "SDL_waylandevents_c.h"
gabomdq@8062
    41
gabomdq@8062
    42
#include "SDL_assert.h"
gabomdq@8062
    43
gabomdq@8062
    44
#if SDL_VIDEO_DRIVER_WAYLAND
gabomdq@8062
    45
gabomdq@8062
    46
typedef struct {
gabomdq@8062
    47
    struct wl_buffer   *buffer;
gabomdq@8062
    48
    struct wl_surface  *surface;
gabomdq@8062
    49
gabomdq@8062
    50
    int                hot_x, hot_y;
gabomdq@8062
    51
gabomdq@8062
    52
    /* Either a preloaded cursor, or one we created ourselves */
gabomdq@8062
    53
    struct wl_cursor   *cursor;
gabomdq@8062
    54
    void               *shm_data;
gabomdq@8062
    55
} Wayland_CursorData;
gabomdq@8062
    56
gabomdq@8062
    57
static int
gabomdq@8062
    58
wayland_create_tmp_file(off_t size)
gabomdq@8062
    59
{
gabomdq@8062
    60
    static const char template[] = "/sdl-shared-XXXXXX";
gabomdq@8062
    61
    char *xdg_path;
gabomdq@8062
    62
    char tmp_path[PATH_MAX];
gabomdq@8062
    63
    int fd;
gabomdq@8062
    64
gabomdq@8062
    65
    xdg_path = SDL_getenv("XDG_RUNTIME_DIR");
gabomdq@8062
    66
    if (!xdg_path) {
gabomdq@8062
    67
        errno = ENOENT;
gabomdq@8062
    68
        return -1;
gabomdq@8062
    69
    }
gabomdq@8062
    70
gabomdq@8062
    71
    SDL_strlcpy(tmp_path, xdg_path, PATH_MAX);
gabomdq@8062
    72
    SDL_strlcat(tmp_path, template, PATH_MAX);
gabomdq@8062
    73
gabomdq@8062
    74
    fd = mkostemp(tmp_path, O_CLOEXEC);
gabomdq@8062
    75
    if (fd < 0)
gabomdq@8062
    76
        return -1;
gabomdq@8062
    77
gabomdq@8062
    78
    if (ftruncate(fd, size) < 0) {
gabomdq@8062
    79
        close(fd);
gabomdq@8062
    80
        return -1;
gabomdq@8062
    81
    }
gabomdq@8062
    82
gabomdq@8062
    83
    return fd;
gabomdq@8062
    84
}
gabomdq@8062
    85
gabomdq@8062
    86
static void
gabomdq@8062
    87
mouse_buffer_release(void *data, struct wl_buffer *buffer)
gabomdq@8062
    88
{
gabomdq@8062
    89
}
gabomdq@8062
    90
gabomdq@8062
    91
static const struct wl_buffer_listener mouse_buffer_listener = {
gabomdq@8062
    92
    mouse_buffer_release
gabomdq@8062
    93
};
gabomdq@8062
    94
gabomdq@8062
    95
static int
gabomdq@8062
    96
create_buffer_from_shm(Wayland_CursorData *d,
gabomdq@8062
    97
                       int width,
gabomdq@8062
    98
                       int height,
gabomdq@8062
    99
                       uint32_t format)
gabomdq@8062
   100
{
gabomdq@8062
   101
    SDL_VideoDevice *vd = SDL_GetVideoDevice();
gabomdq@8062
   102
    SDL_VideoData *data = (SDL_VideoData *) vd->driverdata;
gabomdq@8062
   103
gabomdq@8062
   104
    int stride = width * 4;
gabomdq@8062
   105
    int size = stride * height;
gabomdq@8062
   106
gabomdq@8062
   107
    int shm_fd;
gabomdq@8062
   108
gabomdq@8062
   109
    shm_fd = wayland_create_tmp_file(size);
gabomdq@8062
   110
    if (shm_fd < 0)
gabomdq@8062
   111
    {
gabomdq@8062
   112
        fprintf(stderr, "creating mouse cursor buffer failed!\n");
gabomdq@8062
   113
        return -1;
gabomdq@8062
   114
    }
gabomdq@8062
   115
gabomdq@8062
   116
    d->shm_data = mmap(NULL,
gabomdq@8062
   117
                       size,
gabomdq@8062
   118
                       PROT_READ | PROT_WRITE,
gabomdq@8062
   119
                       MAP_SHARED,
gabomdq@8062
   120
                       shm_fd,
gabomdq@8062
   121
                       0);
gabomdq@8062
   122
    if (data == MAP_FAILED) {
gabomdq@8062
   123
        d->shm_data = NULL;
gabomdq@8062
   124
        fprintf (stderr, "mmap () failed\n");
gabomdq@8062
   125
        close (shm_fd);
gabomdq@8062
   126
    }
gabomdq@8062
   127
gabomdq@8062
   128
    struct wl_shm_pool *shm_pool = wl_shm_create_pool(data->shm,
gabomdq@8062
   129
                                                      shm_fd,
gabomdq@8062
   130
                                                      size);
gabomdq@8062
   131
    d->buffer = wl_shm_pool_create_buffer(shm_pool,
gabomdq@8062
   132
                                          0,
gabomdq@8062
   133
                                          width,
gabomdq@8062
   134
                                          height,
gabomdq@8062
   135
                                          stride,
gabomdq@8062
   136
                                          format);
gabomdq@8062
   137
    wl_buffer_add_listener(d->buffer,
gabomdq@8062
   138
                           &mouse_buffer_listener,
gabomdq@8062
   139
                           d);
gabomdq@8062
   140
gabomdq@8062
   141
    wl_shm_pool_destroy (shm_pool);
gabomdq@8062
   142
    close (shm_fd);
gabomdq@8062
   143
gabomdq@8062
   144
    return 0;
gabomdq@8062
   145
}
gabomdq@8062
   146
gabomdq@8062
   147
static SDL_Cursor *
gabomdq@8062
   148
Wayland_CreateCursor(SDL_Surface *surface, int hot_x, int hot_y)
gabomdq@8062
   149
{
gabomdq@8062
   150
    SDL_Cursor *cursor;
gabomdq@8062
   151
gabomdq@8062
   152
    cursor = calloc(1, sizeof (*cursor));
gabomdq@8062
   153
    if (cursor) {
gabomdq@8062
   154
        SDL_VideoDevice *vd = SDL_GetVideoDevice ();
gabomdq@8062
   155
        SDL_VideoData *wd = (SDL_VideoData *) vd->driverdata;
gabomdq@8062
   156
        Wayland_CursorData *data = calloc (1, sizeof (Wayland_CursorData));
gabomdq@8062
   157
        cursor->driverdata = (void *) data;
gabomdq@8062
   158
gabomdq@8062
   159
        /* Assume ARGB8888 */
gabomdq@8062
   160
        SDL_assert(surface->format->format == SDL_PIXELFORMAT_ARGB8888);
gabomdq@8062
   161
        SDL_assert(surface->pitch == surface->w * 4);
gabomdq@8062
   162
gabomdq@8062
   163
        /* Allocate shared memory buffer for this cursor */
gabomdq@8062
   164
        if (create_buffer_from_shm (data,
gabomdq@8062
   165
                                    surface->w,
gabomdq@8062
   166
                                    surface->h,
gabomdq@8062
   167
                                    WL_SHM_FORMAT_XRGB8888) < 0)
gabomdq@8062
   168
        {
gabomdq@8062
   169
            free (cursor->driverdata);
gabomdq@8062
   170
            free (cursor);
gabomdq@8062
   171
            return NULL;
gabomdq@8062
   172
        }
gabomdq@8062
   173
gabomdq@8062
   174
        SDL_memcpy(data->shm_data,
gabomdq@8062
   175
                   surface->pixels,
gabomdq@8062
   176
                   surface->h * surface->pitch);
gabomdq@8062
   177
gabomdq@8062
   178
        data->surface = wl_compositor_create_surface(wd->compositor);
gabomdq@8062
   179
        wl_surface_attach(data->surface,
gabomdq@8062
   180
                          data->buffer,
gabomdq@8062
   181
                          0,
gabomdq@8062
   182
                          0);
gabomdq@8062
   183
        wl_surface_damage(data->surface,
gabomdq@8062
   184
                          0,
gabomdq@8062
   185
                          0,
gabomdq@8062
   186
                          surface->w,
gabomdq@8062
   187
                          surface->h);
gabomdq@8062
   188
        wl_surface_commit(data->surface);
gabomdq@8062
   189
gabomdq@8062
   190
        data->hot_x = hot_x;
gabomdq@8062
   191
        data->hot_y = hot_y;
gabomdq@8062
   192
    }
gabomdq@8062
   193
gabomdq@8062
   194
    return cursor;
gabomdq@8062
   195
}
gabomdq@8062
   196
gabomdq@8062
   197
static SDL_Cursor *
gabomdq@8062
   198
CreateCursorFromWlCursor(SDL_VideoData *d, struct wl_cursor *wlcursor)
gabomdq@8062
   199
{
gabomdq@8062
   200
    SDL_Cursor *cursor;
gabomdq@8062
   201
gabomdq@8062
   202
    cursor = calloc(1, sizeof (*cursor));
gabomdq@8062
   203
    if (cursor) {
gabomdq@8062
   204
        Wayland_CursorData *data = calloc (1, sizeof (Wayland_CursorData));
gabomdq@8062
   205
        cursor->driverdata = (void *) data;
gabomdq@8062
   206
gabomdq@8062
   207
        /* The wl_buffer here will be destroyed from wl_cursor_theme_destroy
gabomdq@8062
   208
         * if we are fetching this from a wl_cursor_theme, so don't store a
gabomdq@8062
   209
         * reference to it here */
gabomdq@8062
   210
        data->buffer = NULL;
gabomdq@8062
   211
        data->surface = wl_compositor_create_surface(d->compositor);
gabomdq@8062
   212
        wl_surface_attach(data->surface,
gabomdq@8062
   213
                          wl_cursor_image_get_buffer(wlcursor->images[0]),
gabomdq@8062
   214
                          0,
gabomdq@8062
   215
                          0);
gabomdq@8062
   216
        wl_surface_damage(data->surface,
gabomdq@8062
   217
                          0,
gabomdq@8062
   218
                          0,
gabomdq@8062
   219
                          wlcursor->images[0]->width,
gabomdq@8062
   220
                          wlcursor->images[0]->height);
gabomdq@8062
   221
        wl_surface_commit(data->surface);
gabomdq@8062
   222
        data->hot_x = wlcursor->images[0]->hotspot_x;
gabomdq@8062
   223
        data->hot_y = wlcursor->images[0]->hotspot_y;
gabomdq@8062
   224
        data->cursor= wlcursor;
gabomdq@8062
   225
    } else {
gabomdq@8062
   226
        SDL_OutOfMemory ();
gabomdq@8062
   227
    }
gabomdq@8062
   228
gabomdq@8062
   229
    return cursor;
gabomdq@8062
   230
}
gabomdq@8062
   231
gabomdq@8062
   232
static SDL_Cursor *
gabomdq@8062
   233
Wayland_CreateDefaultCursor()
gabomdq@8062
   234
{
gabomdq@8062
   235
    SDL_VideoDevice *device = SDL_GetVideoDevice();
gabomdq@8062
   236
    SDL_VideoData *data = device->driverdata;
gabomdq@8062
   237
gabomdq@8062
   238
    return CreateCursorFromWlCursor (data,
gabomdq@8062
   239
                                     wl_cursor_theme_get_cursor(data->cursor_theme,
gabomdq@8062
   240
                                                                "left_ptr"));
gabomdq@8062
   241
}
gabomdq@8062
   242
gabomdq@8062
   243
static SDL_Cursor *
gabomdq@8062
   244
Wayland_CreateSystemCursor(SDL_SystemCursor id)
gabomdq@8062
   245
{
gabomdq@8062
   246
    SDL_VideoDevice *vd = SDL_GetVideoDevice();
gabomdq@8062
   247
    SDL_VideoData *d = vd->driverdata;
gabomdq@8062
   248
gabomdq@8062
   249
    struct wl_cursor *cursor = NULL;
gabomdq@8062
   250
gabomdq@8062
   251
    switch(id)
gabomdq@8062
   252
    {
gabomdq@8062
   253
    default:
gabomdq@8062
   254
        SDL_assert(0);
gabomdq@8062
   255
        return NULL;
gabomdq@8062
   256
    case SDL_SYSTEM_CURSOR_ARROW:
gabomdq@8062
   257
        cursor = wl_cursor_theme_get_cursor(d->cursor_theme, "left_ptr");
gabomdq@8062
   258
        break;
gabomdq@8062
   259
    case SDL_SYSTEM_CURSOR_IBEAM:
gabomdq@8062
   260
        cursor = wl_cursor_theme_get_cursor(d->cursor_theme, "xterm");
gabomdq@8062
   261
        break;
gabomdq@8062
   262
    case SDL_SYSTEM_CURSOR_WAIT:
gabomdq@8062
   263
        cursor = wl_cursor_theme_get_cursor(d->cursor_theme, "wait");
gabomdq@8062
   264
        break;
gabomdq@8062
   265
    case SDL_SYSTEM_CURSOR_CROSSHAIR:
gabomdq@8062
   266
        cursor = wl_cursor_theme_get_cursor(d->cursor_theme, "hand1");
gabomdq@8062
   267
        break;
gabomdq@8062
   268
    case SDL_SYSTEM_CURSOR_WAITARROW:
gabomdq@8062
   269
        cursor = wl_cursor_theme_get_cursor(d->cursor_theme, "wait");
gabomdq@8062
   270
        break;
gabomdq@8062
   271
    case SDL_SYSTEM_CURSOR_SIZENWSE:
gabomdq@8062
   272
        cursor = wl_cursor_theme_get_cursor(d->cursor_theme, "hand1");
gabomdq@8062
   273
        break;
gabomdq@8062
   274
    case SDL_SYSTEM_CURSOR_SIZENESW:
gabomdq@8062
   275
        cursor = wl_cursor_theme_get_cursor(d->cursor_theme, "hand1");
gabomdq@8062
   276
        break;
gabomdq@8062
   277
    case SDL_SYSTEM_CURSOR_SIZEWE:
gabomdq@8062
   278
        cursor = wl_cursor_theme_get_cursor(d->cursor_theme, "hand1");
gabomdq@8062
   279
        break;
gabomdq@8062
   280
    case SDL_SYSTEM_CURSOR_SIZENS:
gabomdq@8062
   281
        cursor = wl_cursor_theme_get_cursor(d->cursor_theme, "hand1");
gabomdq@8062
   282
        break;
gabomdq@8062
   283
    case SDL_SYSTEM_CURSOR_SIZEALL:
gabomdq@8062
   284
        cursor = wl_cursor_theme_get_cursor(d->cursor_theme, "hand1");
gabomdq@8062
   285
        break;
gabomdq@8062
   286
    case SDL_SYSTEM_CURSOR_NO:
gabomdq@8062
   287
        cursor = wl_cursor_theme_get_cursor(d->cursor_theme, "xterm");
gabomdq@8062
   288
        break;
gabomdq@8062
   289
    case SDL_SYSTEM_CURSOR_HAND:
gabomdq@8062
   290
        cursor = wl_cursor_theme_get_cursor(d->cursor_theme, "hand1");
gabomdq@8062
   291
        break;
gabomdq@8062
   292
    }
gabomdq@8062
   293
gabomdq@8062
   294
    SDL_Cursor *sdl_cursor = CreateCursorFromWlCursor (d, cursor);
gabomdq@8062
   295
gabomdq@8062
   296
    return sdl_cursor;
gabomdq@8062
   297
}
gabomdq@8062
   298
gabomdq@8062
   299
static void
gabomdq@8062
   300
Wayland_FreeCursor(SDL_Cursor *cursor)
gabomdq@8062
   301
{
gabomdq@8062
   302
    if (!cursor)
gabomdq@8062
   303
        return;
gabomdq@8062
   304
gabomdq@8062
   305
    Wayland_CursorData *d = cursor->driverdata;
gabomdq@8062
   306
gabomdq@8062
   307
    /* Probably not a cursor we own */
gabomdq@8062
   308
    if (!d)
gabomdq@8062
   309
        return;
gabomdq@8062
   310
gabomdq@8062
   311
    if (d->buffer)
gabomdq@8062
   312
        wl_buffer_destroy(d->buffer);
gabomdq@8062
   313
gabomdq@8062
   314
    if (d->surface)
gabomdq@8062
   315
        wl_surface_destroy(d->surface);
gabomdq@8062
   316
gabomdq@8062
   317
    /* Not sure what's meant to happen to shm_data */
gabomdq@8062
   318
    free (cursor->driverdata);
gabomdq@8062
   319
    SDL_free(cursor);
gabomdq@8062
   320
}
gabomdq@8062
   321
gabomdq@8062
   322
static int
gabomdq@8062
   323
Wayland_ShowCursor(SDL_Cursor *cursor)
gabomdq@8062
   324
{
gabomdq@8062
   325
    SDL_VideoDevice *vd = SDL_GetVideoDevice();
gabomdq@8062
   326
    SDL_VideoData *d = vd->driverdata;
gabomdq@8062
   327
gabomdq@8062
   328
    struct wl_pointer *pointer = d->pointer;
gabomdq@8062
   329
gabomdq@8062
   330
    if (!pointer)
gabomdq@8062
   331
        return -1;
gabomdq@8062
   332
gabomdq@8062
   333
    if (cursor)
gabomdq@8062
   334
    {
gabomdq@8062
   335
        Wayland_CursorData *data = cursor->driverdata;
gabomdq@8062
   336
gabomdq@8062
   337
        wl_pointer_set_cursor (pointer, 0,
gabomdq@8062
   338
                               data->surface,
gabomdq@8062
   339
                               data->hot_x,
gabomdq@8062
   340
                               data->hot_y);
gabomdq@8062
   341
    }
gabomdq@8062
   342
    else
gabomdq@8062
   343
    {
gabomdq@8062
   344
        wl_pointer_set_cursor (pointer, 0,
gabomdq@8062
   345
                               NULL,
gabomdq@8062
   346
                               0,
gabomdq@8062
   347
                               0);
gabomdq@8062
   348
    }
gabomdq@8062
   349
    
gabomdq@8062
   350
    return 0;
gabomdq@8062
   351
}
gabomdq@8062
   352
gabomdq@8062
   353
static void
gabomdq@8062
   354
Wayland_WarpMouse(SDL_Window *window, int x, int y)
gabomdq@8062
   355
{
gabomdq@8062
   356
    SDL_Unsupported();
gabomdq@8062
   357
    return;
gabomdq@8062
   358
}
gabomdq@8062
   359
gabomdq@8062
   360
static int
gabomdq@8062
   361
Wayland_SetRelativeMouseMode(SDL_bool enabled)
gabomdq@8062
   362
{
gabomdq@8062
   363
    SDL_Unsupported();
gabomdq@8062
   364
    return -1;
gabomdq@8062
   365
}
gabomdq@8062
   366
gabomdq@8062
   367
void
gabomdq@8062
   368
Wayland_InitMouse(void)
gabomdq@8062
   369
{
gabomdq@8062
   370
    SDL_Mouse *mouse = SDL_GetMouse();
gabomdq@8062
   371
gabomdq@8062
   372
    mouse->CreateCursor = Wayland_CreateCursor;
gabomdq@8062
   373
    mouse->CreateSystemCursor = Wayland_CreateSystemCursor;
gabomdq@8062
   374
    mouse->ShowCursor = Wayland_ShowCursor;
gabomdq@8062
   375
    mouse->FreeCursor = Wayland_FreeCursor;
gabomdq@8062
   376
    mouse->WarpMouse = Wayland_WarpMouse;
gabomdq@8062
   377
    mouse->SetRelativeMouseMode = Wayland_SetRelativeMouseMode;
gabomdq@8062
   378
gabomdq@8062
   379
    SDL_SetDefaultCursor(Wayland_CreateDefaultCursor());
gabomdq@8062
   380
}
gabomdq@8062
   381
gabomdq@8062
   382
void
gabomdq@8062
   383
Wayland_FiniMouse(void)
gabomdq@8062
   384
{
gabomdq@8062
   385
    /* This effectively assumes that nobody else
gabomdq@8062
   386
     * touches SDL_Mouse which is effectively
gabomdq@8062
   387
     * a singleton */
gabomdq@8062
   388
gabomdq@8062
   389
    SDL_Mouse *mouse = SDL_GetMouse();
gabomdq@8062
   390
gabomdq@8062
   391
    /* Free the current cursor if not the same pointer as
gabomdq@8062
   392
     * the default cursor */
gabomdq@8062
   393
    if (mouse->def_cursor != mouse->cur_cursor)
gabomdq@8062
   394
        Wayland_FreeCursor (mouse->cur_cursor);
gabomdq@8062
   395
gabomdq@8062
   396
    Wayland_FreeCursor (mouse->def_cursor);
gabomdq@8062
   397
    mouse->def_cursor = NULL;
gabomdq@8062
   398
    mouse->cur_cursor = NULL;
gabomdq@8062
   399
gabomdq@8062
   400
    mouse->CreateCursor =  NULL;
gabomdq@8062
   401
    mouse->CreateSystemCursor = NULL;
gabomdq@8062
   402
    mouse->ShowCursor = NULL;
gabomdq@8062
   403
    mouse->FreeCursor = NULL;
gabomdq@8062
   404
    mouse->WarpMouse = NULL;
gabomdq@8062
   405
    mouse->SetRelativeMouseMode = NULL;
gabomdq@8062
   406
}
gabomdq@8062
   407
#endif