src/video/x11/SDL_x11clipboard.c
author Ryan C. Gordon <icculus@icculus.org>
Thu, 09 Apr 2015 22:28:37 -0400
changeset 9541 cf8fab52e33b
parent 8149 681eb46b8ac4
child 9578 e78393ffcd50
permissions -rw-r--r--
Merged Alex Szpakowski's iOS-improvement branch to default.

Fixes Bugzilla #2798.
Fixes Bugzilla #2212.
Fixes Bugzilla #2826.
Fixes Bugzilla #2661.
Fixes Bugzilla #1885.
Fixes Bugzilla #1578.
Fixes Bugzilla #2751.

(whew!)

Notable changes, from Alex's notes:

- The SDL_WINDOW_ALLOW_HIGHDPI flag is now needed (along with SDL_GL_GetDrawableSize or SDL_GetRendererOutputSize) to use Retina / high DPI resolutions, bringing SDL’s Retina-related behavior on iOS in line with Mac OS X. Window dimensions and display modes are now in the “points” (non-high DPI) coordinate system rather than pixels, whereas SDL_GL_GetDrawableSize is in pixels.

- Reworked the custom extended launch screen code:
- It now hides after the first SDL_PumpEvents call rather than SDL_CreateWindow, and it fades out in a similar manner to the system launch screen behavior.
- It now mirrors the system launch screen behavior when deciding which image to display: it falls back to using the Launch Images dictionary in Info.plist if the iOS 8+ launch screen nib isn’t available, and if the Launch Images dictionary doesn’t exist it uses the old standard launch image names.
- The extended launch screen can now be disabled via the SDL_IPHONE_LAUNCHSCREEN define in SDL_config_iphoneos.h.

- Added support for SDL_HINT_ACCELEROMETER_AS_JOYSTICK.

- Added access to a window view's renderbuffer and framebuffer to syswm.

- Added OpenGL ES debug labels for the Renderbuffer and Framebuffer Objects created with SDL_GL_CreateContext.

- Added support for sRGB OpenGL ES contexts on iOS 7+.

- Updated OpenGL ES contexts to support native-resolution rendering (when SDL_WINDOW_ALLOW_HIGHDPI is enabled) on the iPhone 6 Plus, i.e. 1080x1920 rather than 1242x2208.

- Updated SDL_GL_CreateContext, SDL_GL_SwapWindow, SDL_GL_MakeCurrent, and SDL_GL_DeleteContext to be more robust.

- Updated SDL windows to display a UIView at all times, even when an OpenGL context is not active. This allows rotation, touch events, and other windowing-related events to work properly without an active OpenGL context. It also makes it easier to use SDL_GetWindowWMInfo after creating a SDL window.

- Updated the iOS-specific Objective-C code to use cleaner and more modern language features and APIs, including ARC instead of manual reference counting.

- Updated SDL_HINT_ORIENTATIONS to allow disabling custom orientations if the hint is set with no valid orientation names.

- Fixed several rotation and orientation bugs with windows and display modes, especially in iOS 8+.

- Fixed SDL_SetWindowFullscreen failing to update the status bar visibility on iOS 7+.

- Fixed the orientation of the offset applied to the window’s view when the onscreen keyboard is shown in iOS 8+.

- Fixed SDL_IsScreenKeyboardShown (patch by Phil Hassey.)

- Fixed several major memory leaks caused by missing autorelease pool blocks in the iOS-specific Objective-C code.

- Removed several dead code paths.

- The iOS 7 SDK (Xcode 5) or newer is now required to build SDL for iOS.
slouken@4508
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@8149
     3
  Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org>
slouken@4508
     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@4508
     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@4508
    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@4508
    20
*/
icculus@8093
    21
#include "../../SDL_internal.h"
slouken@4508
    22
slouken@5481
    23
#if SDL_VIDEO_DRIVER_X11
slouken@5481
    24
slouken@4508
    25
#include <limits.h> /* For INT_MAX */
slouken@4508
    26
slouken@4508
    27
#include "SDL_events.h"
slouken@4508
    28
#include "SDL_x11video.h"
slouken@7506
    29
#include "SDL_timer.h"
slouken@4508
    30
slouken@4508
    31
slouken@4509
    32
/* If you don't support UTF-8, you might use XA_STRING here */
slouken@4516
    33
#ifdef X_HAVE_UTF8_STRING
icculus@7827
    34
#define TEXT_FORMAT X11_XInternAtom(display, "UTF8_STRING", False)
slouken@4509
    35
#else
slouken@4509
    36
#define TEXT_FORMAT XA_STRING
slouken@4509
    37
#endif
slouken@4509
    38
slouken@4508
    39
/* Get any application owned window handle for clipboard association */
slouken@4508
    40
static Window
slouken@4508
    41
GetWindow(_THIS)
slouken@4508
    42
{
slouken@4508
    43
    SDL_Window *window;
slouken@4508
    44
slouken@5246
    45
    window = _this->windows;
slouken@5246
    46
    if (window) {
slouken@5246
    47
        return ((SDL_WindowData *) window->driverdata)->xwindow;
slouken@4508
    48
    }
slouken@4508
    49
    return None;
slouken@4508
    50
}
slouken@4508
    51
slouken@4508
    52
int
slouken@4508
    53
X11_SetClipboardText(_THIS, const char *text)
slouken@4508
    54
{
slouken@4508
    55
    Display *display = ((SDL_VideoData *) _this->driverdata)->display;
slouken@4508
    56
    Atom format;
slouken@4508
    57
    Window window;
icculus@7827
    58
    Atom XA_CLIPBOARD = X11_XInternAtom(display, "CLIPBOARD", 0);
slouken@4508
    59
slouken@4508
    60
    /* Get the SDL window that will own the selection */
slouken@4508
    61
    window = GetWindow(_this);
slouken@4508
    62
    if (window == None) {
icculus@7037
    63
        return SDL_SetError("Couldn't find a window to own the selection");
slouken@4508
    64
    }
slouken@4508
    65
slouken@4509
    66
    /* Save the selection on the root window */
slouken@4509
    67
    format = TEXT_FORMAT;
icculus@7827
    68
    X11_XChangeProperty(display, DefaultRootWindow(display),
slouken@4508
    69
        XA_CUT_BUFFER0, format, 8, PropModeReplace,
slouken@4508
    70
        (const unsigned char *)text, SDL_strlen(text));
slouken@4508
    71
slouken@6420
    72
    if (XA_CLIPBOARD != None &&
icculus@7827
    73
        X11_XGetSelectionOwner(display, XA_CLIPBOARD) != window) {
icculus@7827
    74
        X11_XSetSelectionOwner(display, XA_CLIPBOARD, window, CurrentTime);
slouken@6420
    75
    }
slouken@6420
    76
icculus@7827
    77
    if (X11_XGetSelectionOwner(display, XA_PRIMARY) != window) {
icculus@7827
    78
        X11_XSetSelectionOwner(display, XA_PRIMARY, window, CurrentTime);
slouken@4508
    79
    }
slouken@4508
    80
    return 0;
slouken@4508
    81
}
slouken@4508
    82
slouken@4508
    83
char *
slouken@4508
    84
X11_GetClipboardText(_THIS)
slouken@4508
    85
{
slouken@4508
    86
    SDL_VideoData *videodata = (SDL_VideoData *) _this->driverdata;
slouken@4508
    87
    Display *display = videodata->display;
slouken@4508
    88
    Atom format;
slouken@4508
    89
    Window window;
slouken@4508
    90
    Window owner;
slouken@4508
    91
    Atom selection;
slouken@4508
    92
    Atom seln_type;
slouken@4508
    93
    int seln_format;
slouken@4508
    94
    unsigned long nbytes;
slouken@4508
    95
    unsigned long overflow;
slouken@4508
    96
    unsigned char *src;
slouken@4508
    97
    char *text;
slouken@7506
    98
    Uint32 waitStart;
slouken@7506
    99
    Uint32 waitElapsed;
icculus@7827
   100
    Atom XA_CLIPBOARD = X11_XInternAtom(display, "CLIPBOARD", 0);
slouken@6420
   101
    if (XA_CLIPBOARD == None) {
slouken@6420
   102
        SDL_SetError("Couldn't access X clipboard");
slouken@7506
   103
        return SDL_strdup("");
slouken@6420
   104
    }
slouken@4508
   105
slouken@4508
   106
    text = NULL;
slouken@4508
   107
slouken@4509
   108
    /* Get the window that holds the selection */
slouken@4508
   109
    window = GetWindow(_this);
slouken@4509
   110
    format = TEXT_FORMAT;
icculus@7827
   111
    owner = X11_XGetSelectionOwner(display, XA_CLIPBOARD);
slouken@4508
   112
    if ((owner == None) || (owner == window)) {
slouken@4508
   113
        owner = DefaultRootWindow(display);
slouken@4508
   114
        selection = XA_CUT_BUFFER0;
slouken@4508
   115
    } else {
slouken@4508
   116
        /* Request that the selection owner copy the data to our window */
slouken@4508
   117
        owner = window;
icculus@7827
   118
        selection = X11_XInternAtom(display, "SDL_SELECTION", False);
icculus@7827
   119
        X11_XConvertSelection(display, XA_CLIPBOARD, format, selection, owner,
slouken@4508
   120
            CurrentTime);
slouken@4508
   121
slouken@7506
   122
        /* When using synergy on Linux and when data has been put in the clipboard
slouken@7506
   123
           on the remote (Windows anyway) machine then selection_waiting may never
slouken@7506
   124
           be set to False. Time out after a while. */
slouken@7506
   125
        waitStart = SDL_GetTicks();
slouken@4508
   126
        videodata->selection_waiting = SDL_TRUE;
slouken@4508
   127
        while (videodata->selection_waiting) {
slouken@4508
   128
            SDL_PumpEvents();
slouken@7506
   129
            waitElapsed = SDL_GetTicks() - waitStart;
slouken@7506
   130
            /* Wait one second for a clipboard response. */
slouken@7506
   131
            if (waitElapsed > 1000) {
slouken@7506
   132
                videodata->selection_waiting = SDL_FALSE;
slouken@7506
   133
                SDL_SetError("Clipboard timeout");
slouken@7506
   134
                /* We need to set the clipboard text so that next time we won't
slouken@7506
   135
                   timeout, otherwise we will hang on every call to this function. */
slouken@7506
   136
                X11_SetClipboardText(_this, "");
slouken@7506
   137
                return SDL_strdup("");
slouken@7506
   138
            }
slouken@4508
   139
        }
slouken@4508
   140
    }
slouken@4508
   141
icculus@7827
   142
    if (X11_XGetWindowProperty(display, owner, selection, 0, INT_MAX/4, False,
slouken@4508
   143
            format, &seln_type, &seln_format, &nbytes, &overflow, &src)
slouken@4508
   144
            == Success) {
slouken@4508
   145
        if (seln_type == format) {
slouken@4508
   146
            text = (char *)SDL_malloc(nbytes+1);
slouken@4508
   147
            if (text) {
slouken@4508
   148
                SDL_memcpy(text, src, nbytes);
slouken@4508
   149
                text[nbytes] = '\0';
slouken@4508
   150
            }
slouken@4508
   151
        }
icculus@7827
   152
        X11_XFree(src);
slouken@4508
   153
    }
slouken@4508
   154
slouken@4508
   155
    if (!text) {
slouken@4508
   156
        text = SDL_strdup("");
slouken@4508
   157
    }
slouken@7191
   158
slouken@4508
   159
    return text;
slouken@4508
   160
}
slouken@4508
   161
slouken@4508
   162
SDL_bool
slouken@4508
   163
X11_HasClipboardText(_THIS)
slouken@4508
   164
{
aschiffler@6036
   165
    SDL_bool result = SDL_FALSE;
aschiffler@6036
   166
    char *text = X11_GetClipboardText(_this);
aschiffler@6036
   167
    if (text) {
slouken@7721
   168
        result = text[0] != '\0' ? SDL_TRUE : SDL_FALSE;
aschiffler@6036
   169
        SDL_free(text);
slouken@7191
   170
    }
aschiffler@6036
   171
    return result;
slouken@4508
   172
}
slouken@4508
   173
slouken@5481
   174
#endif /* SDL_VIDEO_DRIVER_X11 */
slouken@5481
   175
slouken@4508
   176
/* vi: set ts=4 sw=4 expandtab: */