summaryrefslogtreecommitdiff
path: root/contrib/SDL-3.2.8/src/video/wayland/SDL_waylandkeyboard.c
blob: df1628cd5b820d3aa6bae737a71524845c43e49b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
/*
  Simple DirectMedia Layer
  Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>

  This software is provided 'as-is', without any express or implied
  warranty.  In no event will the authors be held liable for any damages
  arising from the use of this software.

  Permission is granted to anyone to use this software for any purpose,
  including commercial applications, and to alter it and redistribute it
  freely, subject to the following restrictions:

  1. The origin of this software must not be misrepresented; you must not
     claim that you wrote the original software. If you use this software
     in a product, an acknowledgment in the product documentation would be
     appreciated but is not required.
  2. Altered source versions must be plainly marked as such, and must not be
     misrepresented as being the original software.
  3. This notice may not be removed or altered from any source distribution.
*/
#include "SDL_internal.h"

#if SDL_VIDEO_DRIVER_WAYLAND

#include "../SDL_sysvideo.h"
#include "SDL_waylandvideo.h"
#include "SDL_waylandevents_c.h"
#include "../../events/SDL_keyboard_c.h"
#include "text-input-unstable-v3-client-protocol.h"

bool Wayland_InitKeyboard(SDL_VideoDevice *_this)
{
#ifdef SDL_USE_IME
    SDL_VideoData *internal = _this->internal;
    if (!internal->text_input_manager) {
        SDL_IME_Init();
    }
#endif
    SDL_SetScancodeName(SDL_SCANCODE_APPLICATION, "Menu");

    return true;
}

void Wayland_QuitKeyboard(SDL_VideoDevice *_this)
{
#ifdef SDL_USE_IME
    SDL_VideoData *internal = _this->internal;
    if (!internal->text_input_manager) {
        SDL_IME_Quit();
    }
#endif
}

bool Wayland_StartTextInput(SDL_VideoDevice *_this, SDL_Window *window, SDL_PropertiesID props)
{
    SDL_VideoData *internal = _this->internal;
    struct SDL_WaylandInput *input = internal->input;

    if (internal->text_input_manager) {
        if (input && input->text_input) {
            const SDL_Rect *rect = &input->text_input->cursor_rect;
            enum zwp_text_input_v3_content_hint hint = ZWP_TEXT_INPUT_V3_CONTENT_HINT_NONE;
            enum zwp_text_input_v3_content_purpose purpose;

            switch (SDL_GetTextInputType(props)) {
            default:
            case SDL_TEXTINPUT_TYPE_TEXT:
                purpose = ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_NORMAL;
                break;
            case SDL_TEXTINPUT_TYPE_TEXT_NAME:
                purpose = ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_NAME;
                break;
            case SDL_TEXTINPUT_TYPE_TEXT_EMAIL:
                purpose = ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_EMAIL;
                break;
            case SDL_TEXTINPUT_TYPE_TEXT_USERNAME:
                purpose = ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_NORMAL;
                hint |= ZWP_TEXT_INPUT_V3_CONTENT_HINT_SENSITIVE_DATA;
                break;
            case SDL_TEXTINPUT_TYPE_TEXT_PASSWORD_HIDDEN:
                purpose = ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_PASSWORD;
                hint |= (ZWP_TEXT_INPUT_V3_CONTENT_HINT_HIDDEN_TEXT | ZWP_TEXT_INPUT_V3_CONTENT_HINT_SENSITIVE_DATA);
                break;
            case SDL_TEXTINPUT_TYPE_TEXT_PASSWORD_VISIBLE:
                purpose = ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_PASSWORD;
                hint |= ZWP_TEXT_INPUT_V3_CONTENT_HINT_SENSITIVE_DATA;
                break;
            case SDL_TEXTINPUT_TYPE_NUMBER:
                purpose = ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_NUMBER;
                break;
            case SDL_TEXTINPUT_TYPE_NUMBER_PASSWORD_HIDDEN:
                purpose = ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_PIN;
                hint |= (ZWP_TEXT_INPUT_V3_CONTENT_HINT_HIDDEN_TEXT | ZWP_TEXT_INPUT_V3_CONTENT_HINT_SENSITIVE_DATA);
                break;
            case SDL_TEXTINPUT_TYPE_NUMBER_PASSWORD_VISIBLE:
                purpose = ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_PIN;
                hint |= ZWP_TEXT_INPUT_V3_CONTENT_HINT_SENSITIVE_DATA;
                break;
            }

            switch (SDL_GetTextInputCapitalization(props)) {
            default:
            case SDL_CAPITALIZE_NONE:
                break;
            case SDL_CAPITALIZE_LETTERS:
                hint |= ZWP_TEXT_INPUT_V3_CONTENT_HINT_UPPERCASE;
                break;
            case SDL_CAPITALIZE_WORDS:
                hint |= ZWP_TEXT_INPUT_V3_CONTENT_HINT_TITLECASE;
                break;
            case SDL_CAPITALIZE_SENTENCES:
                hint |= ZWP_TEXT_INPUT_V3_CONTENT_HINT_AUTO_CAPITALIZATION;
                break;
            }

            if (SDL_GetTextInputAutocorrect(props)) {
                hint |= (ZWP_TEXT_INPUT_V3_CONTENT_HINT_COMPLETION | ZWP_TEXT_INPUT_V3_CONTENT_HINT_SPELLCHECK);
            }
            if (SDL_GetTextInputMultiline(props)) {
                hint |= ZWP_TEXT_INPUT_V3_CONTENT_HINT_MULTILINE;
            }

            zwp_text_input_v3_enable(input->text_input->text_input);

            // Now that it's enabled, set the input properties
            zwp_text_input_v3_set_content_type(input->text_input->text_input, hint, purpose);
            if (!SDL_RectEmpty(rect)) {
                // This gets reset on enable so we have to cache it
                zwp_text_input_v3_set_cursor_rectangle(input->text_input->text_input,
                                                       rect->x,
                                                       rect->y,
                                                       rect->w,
                                                       rect->h);
            }
            zwp_text_input_v3_commit(input->text_input->text_input);
        }
    }

    if (input && input->xkb.compose_state) {
        // Reset compose state so composite and dead keys don't carry over
        WAYLAND_xkb_compose_state_reset(input->xkb.compose_state);
    }

    return Wayland_UpdateTextInputArea(_this, window);
}

bool Wayland_StopTextInput(SDL_VideoDevice *_this, SDL_Window *window)
{
    SDL_VideoData *internal = _this->internal;
    struct SDL_WaylandInput *input = internal->input;

    if (internal->text_input_manager) {
        if (input && input->text_input) {
            zwp_text_input_v3_disable(input->text_input->text_input);
            zwp_text_input_v3_commit(input->text_input->text_input);
        }
    }
#ifdef SDL_USE_IME
    else {
        SDL_IME_Reset();
    }
#endif

    if (input && input->xkb.compose_state) {
        // Reset compose state so composite and dead keys don't carry over
        WAYLAND_xkb_compose_state_reset(input->xkb.compose_state);
    }
    return true;
}

bool Wayland_UpdateTextInputArea(SDL_VideoDevice *_this, SDL_Window *window)
{
    SDL_VideoData *internal = _this->internal;
    if (internal->text_input_manager) {
        struct SDL_WaylandInput *input = internal->input;
        if (input && input->text_input) {
            if (!SDL_RectsEqual(&window->text_input_rect, &input->text_input->cursor_rect)) {
                SDL_copyp(&input->text_input->cursor_rect, &window->text_input_rect);
                zwp_text_input_v3_set_cursor_rectangle(input->text_input->text_input,
                                                       window->text_input_rect.x,
                                                       window->text_input_rect.y,
                                                       window->text_input_rect.w,
                                                       window->text_input_rect.h);
                zwp_text_input_v3_commit(input->text_input->text_input);
            }
        }
    }

#ifdef SDL_USE_IME
    else {
        SDL_IME_UpdateTextInputArea(window);
    }
#endif
    return true;
}

bool Wayland_HasScreenKeyboardSupport(SDL_VideoDevice *_this)
{
    /* In reality we just want to return true when the screen keyboard is the
     * _only_ way to get text input. So, in addition to checking for the text
     * input protocol, make sure we don't have any physical keyboards either.
     */
    SDL_VideoData *internal = _this->internal;
    bool haskeyboard = (internal->input != NULL) && (internal->input->keyboard != NULL);
    bool hastextmanager = (internal->text_input_manager != NULL);
    return !haskeyboard && hastextmanager;
}

#endif // SDL_VIDEO_DRIVER_WAYLAND