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