src/video/x11/SDL_x11video.c
author Sam Lantinga <slouken@libsdl.org>
Wed, 18 Jul 2012 14:48:32 -0700
changeset 6367 3c1253baeaec
parent 6331 5732e1a80bde
child 6369 a92fbd27127b
permissions -rwxr-xr-x
Fix memory leaks in X11_CreateDevice error paths

Patch contributed by Andre Heider
slouken@1950
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@6138
     3
  Copyright (C) 1997-2012 Sam Lantinga <slouken@libsdl.org>
slouken@1950
     4
slouken@5535
     5
  This software is provided 'as-is', without any express or implied
slouken@5535
     6
  warranty.  In no event will the authors be held liable for any damages
slouken@5535
     7
  arising from the use of this software.
slouken@1950
     8
slouken@5535
     9
  Permission is granted to anyone to use this software for any purpose,
slouken@5535
    10
  including commercial applications, and to alter it and redistribute it
slouken@5535
    11
  freely, subject to the following restrictions:
slouken@1950
    12
slouken@5535
    13
  1. The origin of this software must not be misrepresented; you must not
slouken@5535
    14
     claim that you wrote the original software. If you use this software
slouken@5535
    15
     in a product, an acknowledgment in the product documentation would be
slouken@5535
    16
     appreciated but is not required.
slouken@5535
    17
  2. Altered source versions must be plainly marked as such, and must not be
slouken@5535
    18
     misrepresented as being the original software.
slouken@5535
    19
  3. This notice may not be removed or altered from any source distribution.
slouken@1950
    20
*/
slouken@1950
    21
#include "SDL_config.h"
slouken@1950
    22
slouken@5481
    23
#if SDL_VIDEO_DRIVER_X11
slouken@5481
    24
slouken@4508
    25
#include <unistd.h> /* For getpid() and readlink() */
slouken@4508
    26
slouken@1950
    27
#include "SDL_video.h"
slouken@1950
    28
#include "SDL_mouse.h"
slouken@1950
    29
#include "../SDL_sysvideo.h"
slouken@1950
    30
#include "../SDL_pixels_c.h"
slouken@1950
    31
slouken@1950
    32
#include "SDL_x11video.h"
slouken@5182
    33
#include "SDL_x11framebuffer.h"
eligottlieb@4782
    34
#include "SDL_x11shape.h"
slouken@4923
    35
#include "SDL_x11touch.h" 
dimitris@6316
    36
#include "SDL_x11xinput2.h"
slouken@2710
    37
slouken@6188
    38
#if SDL_VIDEO_OPENGL_ES || SDL_VIDEO_OPENGL_ES2
slouken@3218
    39
#include "SDL_x11opengles.h"
slouken@3218
    40
#endif
slouken@1950
    41
slouken@1950
    42
/* Initialization/Query functions */
slouken@1950
    43
static int X11_VideoInit(_THIS);
slouken@1950
    44
static void X11_VideoQuit(_THIS);
slouken@1950
    45
slouken@1951
    46
/* Find out what class name we should use */
slouken@1951
    47
static char *
slouken@1951
    48
get_classname()
slouken@1951
    49
{
slouken@1951
    50
    char *spot;
slouken@1951
    51
#if defined(__LINUX__) || defined(__FREEBSD__)
slouken@1951
    52
    char procfile[1024];
slouken@1951
    53
    char linkfile[1024];
slouken@1951
    54
    int linksize;
slouken@1951
    55
#endif
slouken@1951
    56
slouken@1951
    57
    /* First allow environment variable override */
slouken@1951
    58
    spot = SDL_getenv("SDL_VIDEO_X11_WMCLASS");
slouken@1951
    59
    if (spot) {
slouken@1951
    60
        return SDL_strdup(spot);
slouken@1951
    61
    }
slouken@1951
    62
slouken@1951
    63
    /* Next look at the application's executable name */
slouken@1951
    64
#if defined(__LINUX__) || defined(__FREEBSD__)
slouken@1951
    65
#if defined(__LINUX__)
slouken@1951
    66
    SDL_snprintf(procfile, SDL_arraysize(procfile), "/proc/%d/exe", getpid());
slouken@1951
    67
#elif defined(__FREEBSD__)
slouken@1951
    68
    SDL_snprintf(procfile, SDL_arraysize(procfile), "/proc/%d/file",
slouken@1951
    69
                 getpid());
slouken@1951
    70
#else
slouken@1951
    71
#error Where can we find the executable name?
slouken@1951
    72
#endif
slouken@1951
    73
    linksize = readlink(procfile, linkfile, sizeof(linkfile) - 1);
slouken@1951
    74
    if (linksize > 0) {
slouken@1951
    75
        linkfile[linksize] = '\0';
slouken@1951
    76
        spot = SDL_strrchr(linkfile, '/');
slouken@1951
    77
        if (spot) {
slouken@1951
    78
            return SDL_strdup(spot + 1);
slouken@1951
    79
        } else {
slouken@1951
    80
            return SDL_strdup(linkfile);
slouken@1951
    81
        }
slouken@1951
    82
    }
slouken@1951
    83
#endif /* __LINUX__ || __FREEBSD__ */
slouken@1951
    84
slouken@1951
    85
    /* Finally use the default we've used forever */
slouken@1951
    86
    return SDL_strdup("SDL_App");
slouken@1951
    87
}
slouken@1951
    88
slouken@1950
    89
/* X11 driver bootstrap functions */
slouken@1950
    90
slouken@1950
    91
static int
slouken@1950
    92
X11_Available(void)
slouken@1950
    93
{
slouken@1950
    94
    Display *display = NULL;
slouken@1950
    95
    if (SDL_X11_LoadSymbols()) {
slouken@1950
    96
        display = XOpenDisplay(NULL);
slouken@1950
    97
        if (display != NULL) {
slouken@1950
    98
            XCloseDisplay(display);
slouken@1950
    99
        }
slouken@1950
   100
        SDL_X11_UnloadSymbols();
slouken@1950
   101
    }
slouken@1950
   102
    return (display != NULL);
slouken@1950
   103
}
slouken@1950
   104
slouken@1950
   105
static void
slouken@1950
   106
X11_DeleteDevice(SDL_VideoDevice * device)
slouken@1950
   107
{
slouken@1950
   108
    SDL_VideoData *data = (SDL_VideoData *) device->driverdata;
slouken@1950
   109
    if (data->display) {
slouken@1950
   110
        XCloseDisplay(data->display);
slouken@1950
   111
    }
bob@2324
   112
    SDL_free(data->windowlist);
slouken@1950
   113
    SDL_free(device->driverdata);
slouken@6188
   114
#if SDL_VIDEO_OPENGL_ES || SDL_VIDEO_OPENGL_ES2
slouken@3218
   115
    SDL_free(device->gles_data);
slouken@3218
   116
#endif
slouken@1950
   117
    SDL_free(device);
slouken@1950
   118
slouken@1950
   119
    SDL_X11_UnloadSymbols();
slouken@1950
   120
}
slouken@1950
   121
slouken@1950
   122
static SDL_VideoDevice *
slouken@1950
   123
X11_CreateDevice(int devindex)
slouken@1950
   124
{
slouken@1950
   125
    SDL_VideoDevice *device;
slouken@1950
   126
    SDL_VideoData *data;
slouken@1950
   127
    const char *display = NULL; /* Use the DISPLAY environment variable */
slouken@1950
   128
slouken@1950
   129
    if (!SDL_X11_LoadSymbols()) {
slouken@1950
   130
        return NULL;
slouken@1950
   131
    }
slouken@1950
   132
slouken@1950
   133
    /* Initialize all variables that we clean on shutdown */
slouken@1950
   134
    device = (SDL_VideoDevice *) SDL_calloc(1, sizeof(SDL_VideoDevice));
bob@2323
   135
    if (!device) {
bob@2323
   136
        SDL_OutOfMemory();
bob@2323
   137
        return NULL;
slouken@1950
   138
    }
bob@2323
   139
    data = (struct SDL_VideoData *) SDL_calloc(1, sizeof(SDL_VideoData));
bob@2323
   140
    if (!data) {
slouken@1950
   141
        SDL_OutOfMemory();
bob@2323
   142
        SDL_free(device);
slouken@1950
   143
        return NULL;
slouken@1950
   144
    }
slouken@1950
   145
    device->driverdata = data;
slouken@1950
   146
slouken@6188
   147
#if SDL_VIDEO_OPENGL_ES || SDL_VIDEO_OPENGL_ES2
slouken@3218
   148
    device->gles_data = (struct SDL_PrivateGLESData *) SDL_calloc(1, sizeof(SDL_PrivateGLESData));
slouken@3218
   149
    if (!device->gles_data) {
slouken@3218
   150
        SDL_OutOfMemory();
slouken@6367
   151
        SDL_free(device->driverdata);
slouken@6367
   152
        SDL_free(device);
slouken@3218
   153
        return NULL;
slouken@3218
   154
    }
slouken@3218
   155
#endif
slouken@3218
   156
slouken@1950
   157
    /* FIXME: Do we need this?
slouken@1950
   158
       if ( (SDL_strncmp(XDisplayName(display), ":", 1) == 0) ||
slouken@1950
   159
       (SDL_strncmp(XDisplayName(display), "unix:", 5) == 0) ) {
slouken@1950
   160
       local_X11 = 1;
slouken@1950
   161
       } else {
slouken@1950
   162
       local_X11 = 0;
slouken@1950
   163
       }
slouken@1950
   164
     */
slouken@1950
   165
    data->display = XOpenDisplay(display);
slouken@1950
   166
#if defined(__osf__) && defined(SDL_VIDEO_DRIVER_X11_DYNAMIC)
slouken@1950
   167
    /* On Tru64 if linking without -lX11, it fails and you get following message.
slouken@1950
   168
     * Xlib: connection to ":0.0" refused by server
slouken@1950
   169
     * Xlib: XDM authorization key matches an existing client!
slouken@1950
   170
     *
slouken@1950
   171
     * It succeeds if retrying 1 second later
slouken@1950
   172
     * or if running xhost +localhost on shell.
slouken@1950
   173
     */
slouken@1950
   174
    if (data->display == NULL) {
slouken@1950
   175
        SDL_Delay(1000);
slouken@1950
   176
        data->display = XOpenDisplay(display);
slouken@1950
   177
    }
slouken@1950
   178
#endif
slouken@1950
   179
    if (data->display == NULL) {
slouken@6367
   180
#if SDL_VIDEO_OPENGL_ES || SDL_VIDEO_OPENGL_ES2
slouken@6367
   181
        SDL_free(device->gles_data);
slouken@6367
   182
#endif
slouken@6367
   183
        SDL_free(device->driverdata);
slouken@1950
   184
        SDL_free(device);
slouken@1950
   185
        SDL_SetError("Couldn't open X11 display");
slouken@1950
   186
        return NULL;
slouken@1950
   187
    }
slouken@1950
   188
#ifdef X11_DEBUG
slouken@1950
   189
    XSynchronize(data->display, True);
slouken@1950
   190
#endif
slouken@1950
   191
slouken@1950
   192
    /* Set the function pointers */
slouken@1950
   193
    device->VideoInit = X11_VideoInit;
slouken@1950
   194
    device->VideoQuit = X11_VideoQuit;
slouken@1950
   195
    device->GetDisplayModes = X11_GetDisplayModes;
gabomdq@6331
   196
    device->GetDisplayBounds = X11_GetDisplayBounds;
slouken@1950
   197
    device->SetDisplayMode = X11_SetDisplayMode;
slouken@3025
   198
    device->SuspendScreenSaver = X11_SuspendScreenSaver;
slouken@1951
   199
    device->PumpEvents = X11_PumpEvents;
slouken@1950
   200
slouken@1950
   201
    device->CreateWindow = X11_CreateWindow;
slouken@1950
   202
    device->CreateWindowFrom = X11_CreateWindowFrom;
slouken@1950
   203
    device->SetWindowTitle = X11_SetWindowTitle;
slouken@2967
   204
    device->SetWindowIcon = X11_SetWindowIcon;
slouken@1950
   205
    device->SetWindowPosition = X11_SetWindowPosition;
slouken@1950
   206
    device->SetWindowSize = X11_SetWindowSize;
slouken@1950
   207
    device->ShowWindow = X11_ShowWindow;
slouken@1950
   208
    device->HideWindow = X11_HideWindow;
slouken@1950
   209
    device->RaiseWindow = X11_RaiseWindow;
slouken@1950
   210
    device->MaximizeWindow = X11_MaximizeWindow;
slouken@1950
   211
    device->MinimizeWindow = X11_MinimizeWindow;
slouken@1950
   212
    device->RestoreWindow = X11_RestoreWindow;
slouken@5302
   213
    device->SetWindowFullscreen = X11_SetWindowFullscreen;
slouken@5466
   214
    device->SetWindowGammaRamp = X11_SetWindowGammaRamp;
slouken@1950
   215
    device->SetWindowGrab = X11_SetWindowGrab;
slouken@1950
   216
    device->DestroyWindow = X11_DestroyWindow;
slouken@5182
   217
    device->CreateWindowFramebuffer = X11_CreateWindowFramebuffer;
slouken@5182
   218
    device->UpdateWindowFramebuffer = X11_UpdateWindowFramebuffer;
slouken@5182
   219
    device->DestroyWindowFramebuffer = X11_DestroyWindowFramebuffer;
slouken@1950
   220
    device->GetWindowWMInfo = X11_GetWindowWMInfo;
slouken@5182
   221
eligottlieb@4782
   222
    device->shape_driver.CreateShaper = X11_CreateShaper;
eligottlieb@4782
   223
    device->shape_driver.SetWindowShape = X11_SetWindowShape;
eligottlieb@4782
   224
    device->shape_driver.ResizeWindowShape = X11_ResizeWindowShape;
slouken@5182
   225
slouken@5088
   226
#if SDL_VIDEO_OPENGL_GLX
slouken@1950
   227
    device->GL_LoadLibrary = X11_GL_LoadLibrary;
slouken@1950
   228
    device->GL_GetProcAddress = X11_GL_GetProcAddress;
slouken@3057
   229
    device->GL_UnloadLibrary = X11_GL_UnloadLibrary;
slouken@1950
   230
    device->GL_CreateContext = X11_GL_CreateContext;
slouken@1950
   231
    device->GL_MakeCurrent = X11_GL_MakeCurrent;
slouken@1950
   232
    device->GL_SetSwapInterval = X11_GL_SetSwapInterval;
slouken@1950
   233
    device->GL_GetSwapInterval = X11_GL_GetSwapInterval;
slouken@1950
   234
    device->GL_SwapWindow = X11_GL_SwapWindow;
slouken@1950
   235
    device->GL_DeleteContext = X11_GL_DeleteContext;
slouken@1950
   236
#endif
slouken@6188
   237
#if SDL_VIDEO_OPENGL_ES || SDL_VIDEO_OPENGL_ES2
slouken@3218
   238
    device->GL_LoadLibrary = X11_GLES_LoadLibrary;
slouken@3218
   239
    device->GL_GetProcAddress = X11_GLES_GetProcAddress;
slouken@3218
   240
    device->GL_UnloadLibrary = X11_GLES_UnloadLibrary;
slouken@3218
   241
    device->GL_CreateContext = X11_GLES_CreateContext;
slouken@3218
   242
    device->GL_MakeCurrent = X11_GLES_MakeCurrent;
slouken@3218
   243
    device->GL_SetSwapInterval = X11_GLES_SetSwapInterval;
slouken@3218
   244
    device->GL_GetSwapInterval = X11_GLES_GetSwapInterval;
slouken@3218
   245
    device->GL_SwapWindow = X11_GLES_SwapWindow;
slouken@3218
   246
    device->GL_DeleteContext = X11_GLES_DeleteContext;
slouken@3218
   247
#endif
slouken@1950
   248
slouken@4508
   249
    device->SetClipboardText = X11_SetClipboardText;
slouken@4508
   250
    device->GetClipboardText = X11_GetClipboardText;
slouken@4508
   251
    device->HasClipboardText = X11_HasClipboardText;
slouken@4508
   252
slouken@1950
   253
    device->free = X11_DeleteDevice;
slouken@1950
   254
slouken@1950
   255
    return device;
slouken@1950
   256
}
slouken@1950
   257
slouken@1950
   258
VideoBootStrap X11_bootstrap = {
slouken@1950
   259
    "x11", "SDL X11 video driver",
slouken@1950
   260
    X11_Available, X11_CreateDevice
slouken@1950
   261
};
slouken@1950
   262
slouken@4559
   263
static int (*handler) (Display *, XErrorEvent *) = NULL;
slouken@4559
   264
static int
slouken@4559
   265
X11_CheckWindowManagerErrorHandler(Display * d, XErrorEvent * e)
slouken@4559
   266
{
slouken@4559
   267
    if (e->error_code == BadWindow) {
slouken@4559
   268
        return (0);
slouken@4559
   269
    } else {
slouken@4559
   270
        return (handler(d, e));
slouken@4559
   271
    }
slouken@4559
   272
}
slouken@4508
   273
slouken@4518
   274
static void
slouken@4518
   275
X11_CheckWindowManager(_THIS)
slouken@4518
   276
{
slouken@4518
   277
    SDL_VideoData *data = (SDL_VideoData *) _this->driverdata;
slouken@4518
   278
    Display *display = data->display;
slouken@4518
   279
    Atom _NET_SUPPORTING_WM_CHECK;
slouken@4518
   280
    int status, real_format;
slouken@4518
   281
    Atom real_type;
slouken@4518
   282
    unsigned long items_read, items_left;
slouken@4518
   283
    unsigned char *propdata;
slouken@4518
   284
    Window wm_window = 0;
slouken@4518
   285
#ifdef DEBUG_WINDOW_MANAGER
slouken@4518
   286
    char *wm_name;
slouken@4518
   287
#endif
slouken@4518
   288
slouken@4559
   289
    /* Set up a handler to gracefully catch errors */
slouken@4559
   290
    XSync(display, False);
slouken@4559
   291
    handler = XSetErrorHandler(X11_CheckWindowManagerErrorHandler);
slouken@4559
   292
slouken@4518
   293
    _NET_SUPPORTING_WM_CHECK = XInternAtom(display, "_NET_SUPPORTING_WM_CHECK", False);
slouken@4518
   294
    status = XGetWindowProperty(display, DefaultRootWindow(display), _NET_SUPPORTING_WM_CHECK, 0L, 1L, False, XA_WINDOW, &real_type, &real_format, &items_read, &items_left, &propdata);
slouken@4518
   295
    if (status == Success && items_read) {
slouken@4518
   296
        wm_window = ((Window*)propdata)[0];
slouken@4518
   297
    }
slouken@4559
   298
    if (propdata) {
slouken@4559
   299
        XFree(propdata);
slouken@4559
   300
    }
slouken@4559
   301
slouken@4559
   302
    if (wm_window) {
slouken@4559
   303
        status = XGetWindowProperty(display, wm_window, _NET_SUPPORTING_WM_CHECK, 0L, 1L, False, XA_WINDOW, &real_type, &real_format, &items_read, &items_left, &propdata);
slouken@4559
   304
        if (status != Success || !items_read || wm_window != ((Window*)propdata)[0]) {
slouken@4559
   305
            wm_window = None;
slouken@4559
   306
        }
slouken@4559
   307
        if (propdata) {
slouken@4559
   308
            XFree(propdata);
slouken@4559
   309
        }
slouken@4559
   310
    }
slouken@4559
   311
slouken@4559
   312
    /* Reset the error handler, we're done checking */
slouken@4559
   313
    XSync(display, False);
slouken@4559
   314
    XSetErrorHandler(handler);
slouken@4518
   315
slouken@4518
   316
    if (!wm_window) {
slouken@4518
   317
#ifdef DEBUG_WINDOW_MANAGER
slouken@4518
   318
        printf("Couldn't get _NET_SUPPORTING_WM_CHECK property\n");
slouken@4518
   319
#endif
slouken@4518
   320
        return;
slouken@4518
   321
    }
slouken@4518
   322
    data->net_wm = SDL_TRUE;
slouken@4518
   323
slouken@4518
   324
#ifdef DEBUG_WINDOW_MANAGER
slouken@4518
   325
    wm_name = X11_GetWindowTitle(_this, wm_window);
slouken@4518
   326
    printf("Window manager: %s\n", wm_name);
slouken@4518
   327
    SDL_free(wm_name);
slouken@4518
   328
#endif
slouken@4518
   329
}
slouken@1950
   330
slouken@1950
   331
int
slouken@1950
   332
X11_VideoInit(_THIS)
slouken@1950
   333
{
slouken@1951
   334
    SDL_VideoData *data = (SDL_VideoData *) _this->driverdata;
slouken@1951
   335
slouken@1951
   336
    /* Get the window class name, usually the name of the application */
slouken@1951
   337
    data->classname = get_classname();
slouken@1951
   338
mail@6167
   339
    /* Get the process PID to be associated to the window */
mail@6167
   340
    data->pid = getpid();
mail@6167
   341
slouken@1951
   342
    /* Open a connection to the X input manager */
slouken@1951
   343
#ifdef X_HAVE_UTF8_STRING
slouken@1951
   344
    if (SDL_X11_HAVE_UTF8) {
slouken@1951
   345
        data->im =
slouken@1951
   346
            XOpenIM(data->display, NULL, data->classname, data->classname);
slouken@1951
   347
    }
slouken@1951
   348
#endif
slouken@1951
   349
slouken@1951
   350
    /* Look up some useful Atoms */
slouken@4518
   351
#define GET_ATOM(X) data->X = XInternAtom(data->display, #X, False)
slouken@4518
   352
    GET_ATOM(WM_DELETE_WINDOW);
slouken@4518
   353
    GET_ATOM(_NET_WM_STATE);
slouken@4518
   354
    GET_ATOM(_NET_WM_STATE_HIDDEN);
slouken@4518
   355
    GET_ATOM(_NET_WM_STATE_MAXIMIZED_VERT);
slouken@4518
   356
    GET_ATOM(_NET_WM_STATE_MAXIMIZED_HORZ);
slouken@4518
   357
    GET_ATOM(_NET_WM_STATE_FULLSCREEN);
slouken@4518
   358
    GET_ATOM(_NET_WM_NAME);
slouken@4518
   359
    GET_ATOM(_NET_WM_ICON_NAME);
slouken@4518
   360
    GET_ATOM(_NET_WM_ICON);
slouken@4518
   361
    GET_ATOM(UTF8_STRING);
slouken@4518
   362
slouken@4518
   363
    /* Detect the window manager */
slouken@4518
   364
    X11_CheckWindowManager(_this);
slouken@1951
   365
slouken@3521
   366
    if (X11_InitModes(_this) < 0) {
slouken@3521
   367
        return -1;
slouken@3521
   368
    }
slouken@1950
   369
dimitris@6316
   370
    X11_InitXinput2(_this);
slouken@6311
   371
bob@2295
   372
    if (X11_InitKeyboard(_this) != 0) {
bob@2295
   373
        return -1;
bob@2295
   374
    }
slouken@1950
   375
    X11_InitMouse(_this);
slouken@1950
   376
jim@4645
   377
    X11_InitTouch(_this);
slouken@1950
   378
    return 0;
slouken@1950
   379
}
slouken@1950
   380
slouken@1950
   381
void
slouken@1950
   382
X11_VideoQuit(_THIS)
slouken@1950
   383
{
slouken@1951
   384
    SDL_VideoData *data = (SDL_VideoData *) _this->driverdata;
slouken@1951
   385
slouken@1951
   386
    if (data->classname) {
slouken@1951
   387
        SDL_free(data->classname);
slouken@1951
   388
    }
slouken@1951
   389
#ifdef X_HAVE_UTF8_STRING
slouken@1951
   390
    if (data->im) {
slouken@1951
   391
        XCloseIM(data->im);
slouken@1951
   392
    }
slouken@1951
   393
#endif
slouken@1951
   394
slouken@1950
   395
    X11_QuitModes(_this);
slouken@1950
   396
    X11_QuitKeyboard(_this);
slouken@1950
   397
    X11_QuitMouse(_this);
jim@4645
   398
    X11_QuitTouch(_this);
slouken@1950
   399
}
slouken@1950
   400
slouken@5466
   401
SDL_bool
slouken@5466
   402
X11_UseDirectColorVisuals(void)
slouken@5466
   403
{
slouken@5466
   404
    return SDL_getenv("SDL_VIDEO_X11_NODIRECTCOLOR") ? SDL_FALSE : SDL_TRUE;
slouken@5466
   405
}
slouken@5466
   406
slouken@5481
   407
#endif /* SDL_VIDEO_DRIVER_X11 */
slouken@5481
   408
slouken@1950
   409
/* vim: set ts=4 sw=4 expandtab: */