ac5b9bc4ee
X11 has a so-called primary selection, which you can use by marking text and middle-clicking elsewhere to copy the marked text.
There are 3 new API functions in `SDL_clipboard.h`, which work exactly like their clipboard equivalents.
## Test Instructions
* Run the tests (just a copy of the clipboard tests): `$ ./test/testautomation --filter Clipboard`
* Build and run this small application:
<details>
```C
#include <SDL.h>
#include <unistd.h>
#include <stdbool.h>
#include <stdio.h>
#include <stdlib.h>
#include <time.h>
void print_error(const char *where)
{
const char *errstr = SDL_GetError();
if (errstr == NULL || errstr[0] == '\0')
return;
fprintf(stderr, "SDL Error after '%s': %s\n", where, errstr);
SDL_ClearError();
}
int main()
{
char text_buf[256];
srand(time(NULL));
SDL_Init(SDL_INIT_VIDEO);
print_error("SDL_INIT()");
SDL_Window *window = SDL_CreateWindow("Primary Selection Test", SDL_WINDOWPOS_UNDEFINED,
SDL_WINDOWPOS_UNDEFINED, 400, 400, SDL_WINDOW_SHOWN);
print_error("SDL_CreateWindow()");
SDL_Renderer *renderer = SDL_CreateRenderer(window, -1, SDL_RENDERER_ACCELERATED);
print_error("SDL_CreateRenderer()");
bool quit = false;
unsigned int do_render = 0;
while (!quit) {
SDL_Event event;
while (SDL_PollEvent(&event)) {
print_error("SDL_PollEvent()");
switch (event.type) {
case SDL_QUIT: {
quit = true;
break;
} case SDL_KEYDOWN: {
switch (event.key.keysym.sym) {
case SDLK_ESCAPE:
case SDLK_q:
quit = true;
break;
case SDLK_c:
snprintf(text_buf, sizeof(text_buf), "foo%d", rand());
SDL_SetClipboardText(text_buf);
print_error("SDL_SetClipboardText()");
printf("clipboard: set_to=\"%s\"\n", text_buf);
break;
case SDLK_v: {
printf("clipboard: has=%d, ", SDL_HasClipboardText());
print_error("SDL_HasClipboardText()");
char *text = SDL_GetClipboardText();
print_error("SDL_GetClipboardText()");
printf("text=\"%s\"\n", text);
SDL_free(text);
break;
} case SDLK_d:
snprintf(text_buf, sizeof(text_buf), "bar%d", rand());
SDL_SetPrimarySelectionText(text_buf);
print_error("SDL_SetPrimarySelectionText()");
printf("primselec: set_to=\"%s\"\n", text_buf);
break;
case SDLK_f: {
printf("primselec: has=%d, ", SDL_HasPrimarySelectionText());
print_error("SDL_HasPrimarySelectionText()");
char *text = SDL_GetPrimarySelectionText();
print_error("SDL_GetPrimarySelectionText()");
printf("text=\"%s\"\n", text);
SDL_free(text);
break;
} default:
break;
}
break;
} default: {
break;
}}
}
// create less noise with WAYLAND_DEBUG=1
if (do_render == 0) {
SDL_RenderPresent(renderer);
print_error("SDL_RenderPresent()");
}
do_render += 1;
usleep(12000);
}
SDL_DestroyRenderer(renderer);
SDL_DestroyWindow(window);
SDL_Quit();
print_error("quit");
return 0;
}
```
</details>
* Use c,v,d,f to get and set the clipboard and primary selection.
* Mark text and middle-click also in other applications.
* For wayland under x:
* `$ mutter --wayland --no-x11 --nested`
* `$ XDG_SESSION_TYPE=wayland SDL_VIDEODRIVER=wayland ./<path_to_test_appl_binary>`
337 lines
11 KiB
C
337 lines
11 KiB
C
/**
|
|
* New/updated tests: aschiffler at ferzkopp dot net
|
|
*/
|
|
|
|
#include <stdio.h>
|
|
#include <string.h>
|
|
|
|
#include "SDL.h"
|
|
#include "SDL_test.h"
|
|
|
|
/* ================= Test Case Implementation ================== */
|
|
|
|
/* Test case functions */
|
|
|
|
/**
|
|
* \brief Check call to SDL_HasClipboardText
|
|
*
|
|
* \sa
|
|
* http://wiki.libsdl.org/SDL_HasClipboardText
|
|
*/
|
|
int
|
|
clipboard_testHasClipboardText(void *arg)
|
|
{
|
|
SDL_HasClipboardText();
|
|
SDLTest_AssertPass("Call to SDL_HasClipboardText succeeded");
|
|
|
|
return TEST_COMPLETED;
|
|
}
|
|
|
|
/**
|
|
* \brief Check call to SDL_HasPrimarySelectionText
|
|
*
|
|
* \sa
|
|
* http://wiki.libsdl.org/SDL_HasPrimarySelectionText
|
|
*/
|
|
int
|
|
clipboard_testHasPrimarySelectionText(void *arg)
|
|
{
|
|
SDL_HasPrimarySelectionText();
|
|
SDLTest_AssertPass("Call to SDL_HasPrimarySelectionText succeeded");
|
|
|
|
return TEST_COMPLETED;
|
|
}
|
|
|
|
/**
|
|
* \brief Check call to SDL_GetClipboardText
|
|
*
|
|
* \sa
|
|
* http://wiki.libsdl.org/SDL_GetClipboardText
|
|
*/
|
|
int
|
|
clipboard_testGetClipboardText(void *arg)
|
|
{
|
|
char *charResult;
|
|
charResult = SDL_GetClipboardText();
|
|
SDLTest_AssertPass("Call to SDL_GetClipboardText succeeded");
|
|
|
|
SDL_free(charResult);
|
|
|
|
return TEST_COMPLETED;
|
|
}
|
|
|
|
/**
|
|
* \brief Check call to SDL_GetPrimarySelectionText
|
|
*
|
|
* \sa
|
|
* http://wiki.libsdl.org/SDL_GetPrimarySelectionText
|
|
*/
|
|
int
|
|
clipboard_testGetPrimarySelectionText(void *arg)
|
|
{
|
|
char *charResult;
|
|
charResult = SDL_GetPrimarySelectionText();
|
|
SDLTest_AssertPass("Call to SDL_GetPrimarySelectionText succeeded");
|
|
|
|
SDL_free(charResult);
|
|
|
|
return TEST_COMPLETED;
|
|
}
|
|
|
|
/**
|
|
* \brief Check call to SDL_SetClipboardText
|
|
* \sa
|
|
* http://wiki.libsdl.org/SDL_SetClipboardText
|
|
*/
|
|
int
|
|
clipboard_testSetClipboardText(void *arg)
|
|
{
|
|
char *textRef = SDLTest_RandomAsciiString();
|
|
char *text = SDL_strdup(textRef);
|
|
int result;
|
|
result = SDL_SetClipboardText((const char *)text);
|
|
SDLTest_AssertPass("Call to SDL_SetClipboardText succeeded");
|
|
SDLTest_AssertCheck(
|
|
result == 0,
|
|
"Validate SDL_SetClipboardText result, expected 0, got %i",
|
|
result);
|
|
SDLTest_AssertCheck(
|
|
SDL_strcmp(textRef, text) == 0,
|
|
"Verify SDL_SetClipboardText did not modify input string, expected '%s', got '%s'",
|
|
textRef, text);
|
|
|
|
/* Cleanup */
|
|
SDL_free(textRef);
|
|
SDL_free(text);
|
|
|
|
return TEST_COMPLETED;
|
|
}
|
|
|
|
/**
|
|
* \brief Check call to SDL_SetPrimarySelectionText
|
|
* \sa
|
|
* http://wiki.libsdl.org/SDL_SetPrimarySelectionText
|
|
*/
|
|
int
|
|
clipboard_testSetPrimarySelectionText(void *arg)
|
|
{
|
|
char *textRef = SDLTest_RandomAsciiString();
|
|
char *text = SDL_strdup(textRef);
|
|
int result;
|
|
result = SDL_SetPrimarySelectionText((const char *)text);
|
|
SDLTest_AssertPass("Call to SDL_SetPrimarySelectionText succeeded");
|
|
SDLTest_AssertCheck(
|
|
result == 0,
|
|
"Validate SDL_SetPrimarySelectionText result, expected 0, got %i",
|
|
result);
|
|
SDLTest_AssertCheck(
|
|
SDL_strcmp(textRef, text) == 0,
|
|
"Verify SDL_SetPrimarySelectionText did not modify input string, expected '%s', got '%s'",
|
|
textRef, text);
|
|
|
|
/* Cleanup */
|
|
SDL_free(textRef);
|
|
SDL_free(text);
|
|
|
|
return TEST_COMPLETED;
|
|
}
|
|
|
|
/**
|
|
* \brief End-to-end test of SDL_xyzClipboardText functions
|
|
* \sa
|
|
* http://wiki.libsdl.org/SDL_HasClipboardText
|
|
* http://wiki.libsdl.org/SDL_GetClipboardText
|
|
* http://wiki.libsdl.org/SDL_SetClipboardText
|
|
*/
|
|
int
|
|
clipboard_testClipboardTextFunctions(void *arg)
|
|
{
|
|
char *textRef = SDLTest_RandomAsciiString();
|
|
char *text = SDL_strdup(textRef);
|
|
SDL_bool boolResult;
|
|
int intResult;
|
|
char *charResult;
|
|
|
|
/* Clear clipboard text state */
|
|
boolResult = SDL_HasClipboardText();
|
|
SDLTest_AssertPass("Call to SDL_HasClipboardText succeeded");
|
|
if (boolResult == SDL_TRUE) {
|
|
intResult = SDL_SetClipboardText((const char *)NULL);
|
|
SDLTest_AssertPass("Call to SDL_SetClipboardText(NULL) succeeded");
|
|
SDLTest_AssertCheck(
|
|
intResult == 0,
|
|
"Verify result from SDL_SetClipboardText(NULL), expected 0, got %i",
|
|
intResult);
|
|
charResult = SDL_GetClipboardText();
|
|
SDLTest_AssertPass("Call to SDL_GetClipboardText succeeded");
|
|
SDL_free(charResult);
|
|
boolResult = SDL_HasClipboardText();
|
|
SDLTest_AssertPass("Call to SDL_HasClipboardText succeeded");
|
|
SDLTest_AssertCheck(
|
|
boolResult == SDL_FALSE,
|
|
"Verify SDL_HasClipboardText returned SDL_FALSE, got %s",
|
|
(boolResult) ? "SDL_TRUE" : "SDL_FALSE");
|
|
}
|
|
|
|
/* Empty clipboard */
|
|
charResult = SDL_GetClipboardText();
|
|
SDLTest_AssertPass("Call to SDL_GetClipboardText succeeded");
|
|
SDLTest_AssertCheck(
|
|
charResult != NULL,
|
|
"Verify SDL_GetClipboardText did not return NULL");
|
|
SDLTest_AssertCheck(
|
|
charResult[0] == '\0',
|
|
"Verify SDL_GetClipboardText returned string with length 0, got length %i",
|
|
(int) SDL_strlen(charResult));
|
|
intResult = SDL_SetClipboardText((const char *)text);
|
|
SDLTest_AssertPass("Call to SDL_SetClipboardText succeeded");
|
|
SDLTest_AssertCheck(
|
|
intResult == 0,
|
|
"Verify result from SDL_SetClipboardText(NULL), expected 0, got %i",
|
|
intResult);
|
|
SDLTest_AssertCheck(
|
|
SDL_strcmp(textRef, text) == 0,
|
|
"Verify SDL_SetClipboardText did not modify input string, expected '%s', got '%s'",
|
|
textRef, text);
|
|
boolResult = SDL_HasClipboardText();
|
|
SDLTest_AssertPass("Call to SDL_HasClipboardText succeeded");
|
|
SDLTest_AssertCheck(
|
|
boolResult == SDL_TRUE,
|
|
"Verify SDL_HasClipboardText returned SDL_TRUE, got %s",
|
|
(boolResult) ? "SDL_TRUE" : "SDL_FALSE");
|
|
SDL_free(charResult);
|
|
charResult = SDL_GetClipboardText();
|
|
SDLTest_AssertPass("Call to SDL_GetClipboardText succeeded");
|
|
SDLTest_AssertCheck(
|
|
SDL_strcmp(textRef, charResult) == 0,
|
|
"Verify SDL_GetClipboardText returned correct string, expected '%s', got '%s'",
|
|
textRef, charResult);
|
|
|
|
/* Cleanup */
|
|
SDL_free(textRef);
|
|
SDL_free(text);
|
|
SDL_free(charResult);
|
|
|
|
return TEST_COMPLETED;
|
|
}
|
|
|
|
/**
|
|
* \brief End-to-end test of SDL_xyzPrimarySelectionText functions
|
|
* \sa
|
|
* http://wiki.libsdl.org/SDL_HasPrimarySelectionText
|
|
* http://wiki.libsdl.org/SDL_GetPrimarySelectionText
|
|
* http://wiki.libsdl.org/SDL_SetPrimarySelectionText
|
|
*/
|
|
int
|
|
clipboard_testPrimarySelectionTextFunctions(void *arg)
|
|
{
|
|
char *textRef = SDLTest_RandomAsciiString();
|
|
char *text = SDL_strdup(textRef);
|
|
SDL_bool boolResult;
|
|
int intResult;
|
|
char *charResult;
|
|
|
|
/* Clear primary selection text state */
|
|
boolResult = SDL_HasPrimarySelectionText();
|
|
SDLTest_AssertPass("Call to SDL_HasPrimarySelectionText succeeded");
|
|
if (boolResult == SDL_TRUE) {
|
|
intResult = SDL_SetPrimarySelectionText((const char *)NULL);
|
|
SDLTest_AssertPass("Call to SDL_SetPrimarySelectionText(NULL) succeeded");
|
|
SDLTest_AssertCheck(
|
|
intResult == 0,
|
|
"Verify result from SDL_SetPrimarySelectionText(NULL), expected 0, got %i",
|
|
intResult);
|
|
charResult = SDL_GetPrimarySelectionText();
|
|
SDLTest_AssertPass("Call to SDL_GetPrimarySelectionText succeeded");
|
|
SDL_free(charResult);
|
|
boolResult = SDL_HasPrimarySelectionText();
|
|
SDLTest_AssertPass("Call to SDL_HasPrimarySelectionText succeeded");
|
|
SDLTest_AssertCheck(
|
|
boolResult == SDL_FALSE,
|
|
"Verify SDL_HasPrimarySelectionText returned SDL_FALSE, got %s",
|
|
(boolResult) ? "SDL_TRUE" : "SDL_FALSE");
|
|
}
|
|
|
|
/* Empty primary selection */
|
|
charResult = SDL_GetPrimarySelectionText();
|
|
SDLTest_AssertPass("Call to SDL_GetPrimarySelectionText succeeded");
|
|
SDLTest_AssertCheck(
|
|
charResult != NULL,
|
|
"Verify SDL_GetPrimarySelectionText did not return NULL");
|
|
SDLTest_AssertCheck(
|
|
charResult[0] == '\0',
|
|
"Verify SDL_GetPrimarySelectionText returned string with length 0, got length %i",
|
|
(int) SDL_strlen(charResult));
|
|
intResult = SDL_SetPrimarySelectionText((const char *)text);
|
|
SDLTest_AssertPass("Call to SDL_SetPrimarySelectionText succeeded");
|
|
SDLTest_AssertCheck(
|
|
intResult == 0,
|
|
"Verify result from SDL_SetPrimarySelectionText(NULL), expected 0, got %i",
|
|
intResult);
|
|
SDLTest_AssertCheck(
|
|
SDL_strcmp(textRef, text) == 0,
|
|
"Verify SDL_SetPrimarySelectionText did not modify input string, expected '%s', got '%s'",
|
|
textRef, text);
|
|
boolResult = SDL_HasPrimarySelectionText();
|
|
SDLTest_AssertPass("Call to SDL_HasPrimarySelectionText succeeded");
|
|
SDLTest_AssertCheck(
|
|
boolResult == SDL_TRUE,
|
|
"Verify SDL_HasPrimarySelectionText returned SDL_TRUE, got %s",
|
|
(boolResult) ? "SDL_TRUE" : "SDL_FALSE");
|
|
SDL_free(charResult);
|
|
charResult = SDL_GetPrimarySelectionText();
|
|
SDLTest_AssertPass("Call to SDL_GetPrimarySelectionText succeeded");
|
|
SDLTest_AssertCheck(
|
|
SDL_strcmp(textRef, charResult) == 0,
|
|
"Verify SDL_GetPrimarySelectionText returned correct string, expected '%s', got '%s'",
|
|
textRef, charResult);
|
|
|
|
/* Cleanup */
|
|
SDL_free(textRef);
|
|
SDL_free(text);
|
|
SDL_free(charResult);
|
|
|
|
return TEST_COMPLETED;
|
|
}
|
|
|
|
|
|
/* ================= Test References ================== */
|
|
|
|
/* Clipboard test cases */
|
|
static const SDLTest_TestCaseReference clipboardTest1 =
|
|
{ (SDLTest_TestCaseFp)clipboard_testHasClipboardText, "clipboard_testHasClipboardText", "Check call to SDL_HasClipboardText", TEST_ENABLED };
|
|
|
|
static const SDLTest_TestCaseReference clipboardTest2 =
|
|
{ (SDLTest_TestCaseFp)clipboard_testHasPrimarySelectionText, "clipboard_testHasPrimarySelectionText", "Check call to SDL_HasPrimarySelectionText", TEST_ENABLED };
|
|
|
|
static const SDLTest_TestCaseReference clipboardTest3 =
|
|
{ (SDLTest_TestCaseFp)clipboard_testGetClipboardText, "clipboard_testGetClipboardText", "Check call to SDL_GetClipboardText", TEST_ENABLED };
|
|
|
|
static const SDLTest_TestCaseReference clipboardTest4 =
|
|
{ (SDLTest_TestCaseFp)clipboard_testGetPrimarySelectionText, "clipboard_testGetPrimarySelectionText", "Check call to SDL_GetPrimarySelectionText", TEST_ENABLED };
|
|
|
|
static const SDLTest_TestCaseReference clipboardTest5 =
|
|
{ (SDLTest_TestCaseFp)clipboard_testSetClipboardText, "clipboard_testSetClipboardText", "Check call to SDL_SetClipboardText", TEST_ENABLED };
|
|
|
|
static const SDLTest_TestCaseReference clipboardTest6 =
|
|
{ (SDLTest_TestCaseFp)clipboard_testSetPrimarySelectionText, "clipboard_testSetPrimarySelectionText", "Check call to SDL_SetPrimarySelectionText", TEST_ENABLED };
|
|
|
|
static const SDLTest_TestCaseReference clipboardTest7 =
|
|
{ (SDLTest_TestCaseFp)clipboard_testClipboardTextFunctions, "clipboard_testClipboardTextFunctions", "End-to-end test of SDL_xyzClipboardText functions", TEST_ENABLED };
|
|
|
|
static const SDLTest_TestCaseReference clipboardTest8 =
|
|
{ (SDLTest_TestCaseFp)clipboard_testPrimarySelectionTextFunctions, "clipboard_testPrimarySelectionTextFunctions", "End-to-end test of SDL_xyzPrimarySelectionText functions", TEST_ENABLED };
|
|
|
|
/* Sequence of Clipboard test cases */
|
|
static const SDLTest_TestCaseReference *clipboardTests[] = {
|
|
&clipboardTest1, &clipboardTest2, &clipboardTest3, &clipboardTest4, &clipboardTest5, &clipboardTest6, &clipboardTest7, &clipboardTest8, NULL
|
|
};
|
|
|
|
/* Clipboard test suite (global) */
|
|
SDLTest_TestSuiteReference clipboardTestSuite = {
|
|
"Clipboard",
|
|
NULL,
|
|
clipboardTests,
|
|
NULL
|
|
};
|