diff --git a/data/keyboards/geometry/numbers-keypad.xml b/data/keyboards/geometry/numbers-keypad.xml new file mode 100644 index 00000000..4b5f11b8 --- /dev/null +++ b/data/keyboards/geometry/numbers-keypad.xml @@ -0,0 +1,105 @@ + + + +
+ + + + + + + +
+
+ + + + + + + +
+
+ + + + + + + +
+
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/data/keyboards/keyboards.xml b/data/keyboards/keyboards.xml index 87ad1843..a5536c49 100644 --- a/data/keyboards/keyboards.xml +++ b/data/keyboards/keyboards.xml @@ -88,4 +88,10 @@ + + + + diff --git a/data/keyboards/keymaps/numbers.xkb b/data/keyboards/keymaps/numbers.xkb new file mode 100644 index 00000000..c6fbdef2 --- /dev/null +++ b/data/keyboards/keymaps/numbers.xkb @@ -0,0 +1,292 @@ +xkb_keymap { + + xkb_keycodes "squeekboard" { + minimum = 8; + maximum = 255; + = 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; + = 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; + = 210; + = 211; + = 212; + = 213; + = 214; + = 215; + = 216; + = 217; + = 218; + = 219; + = 220; + = 221; + = 222; + = 223; + = 224; + = 225; + = 226; + = 227; + = 228; + = 229; + = 230; + = 231; + = 232; + = 233; + = 234; + = 235; + = 236; + = 237; + = 238; + = 239; + = 240; + = 241; + = 242; + = 243; + = 244; + = 245; + = 246; + = 247; + = 248; + = 249; + = 250; + = 251; + = 252; + = 253; + = 254; + = 255; + }; + + xkb_symbols "squeekboard" { + + name[Group1] = "Letters"; + name[Group2] = "Numbers/Symbols"; + + key { [ 1, 1 ], [ 1, 1 ] }; + key { [ 2, 2 ], [ 2, 2 ] }; + key { [ 3, 3 ], [ 3, 3 ] }; + key { [ parenleft, parenleft ], [ parenleft, parenleft ] }; + key { [ parenright, parenright ], [ parenright, parenright ] }; + key { [ 4, 4 ], [ 4, 4 ] }; + key { [ 5, 5 ], [ 5, 5 ] }; + key { [ 6, 6 ], [ 6, 6 ] }; + key { [ numbersign, numbersign ], [ numbersign, numbersign ] }; + key { [ asterisk, asterisk ], [ asterisk, asterisk ] }; + key { [ 7, 7 ], [ 7, 7 ] }; + key { [ 8, 8 ], [ 8, 8 ] }; + key { [ 9, 9 ], [ 9, 9 ] }; + key { [ plus, plus ], [ plus, plus ] }; + key { [ minus, minus ], [ minus, minus ] }; + key { [ 0, 0 ], [ 0, 0 ] }; + key { [ Return, Return ], [ Return, Return ] }; + key { [ space, space ], [ space, space ] }; + key { [ BackSpace, BackSpace ], [ BackSpace, BackSpace ] }; + }; + + xkb_types "squeekboard" { + + type "TWO_LEVEL" { + modifiers = Shift; + map[Shift] = Level2; + level_name[Level1] = "Base"; + level_name[Level2] = "Shift"; + }; + }; + + xkb_compatibility "squeekboard" { + }; +}; diff --git a/data/keyboards/symbols/special/numbers.xml b/data/keyboards/symbols/special/numbers.xml new file mode 100644 index 00000000..dc688d9f --- /dev/null +++ b/data/keyboards/symbols/special/numbers.xml @@ -0,0 +1,60 @@ + + + + 1 + + + 2 + + + 3 + + + parenleft + + + parenright + + + 4 + + + 5 + + + 6 + + + numbersign + + + asterisk + + + 7 + + + 8 + + + 9 + + + plus + + + minus + + + 0 + + + Return + + + space + + + BackSpace + + diff --git a/data/squeekboard.gresources.xml b/data/squeekboard.gresources.xml index b53dc6a1..2710633a 100644 --- a/data/squeekboard.gresources.xml +++ b/data/squeekboard.gresources.xml @@ -4,9 +4,11 @@ style.css keyboards/geometry/compact.xml keyboards/geometry/extended.xml + keyboards/geometry/numbers-keypad.xml keyboards/keyboards.xml keyboards/keymaps/nb.xkb keyboards/keymaps/us.xkb + keyboards/keymaps/numbers.xkb keyboards/symbols/ar.xml keyboards/symbols/as-inscript.xml keyboards/symbols/be.xml @@ -36,6 +38,7 @@ keyboards/symbols/ug.xml keyboards/symbols/us.xml keyboards/symbols/zh-bopomofo.xml + keyboards/symbols/special/numbers.xml icons/key-enter.svg icons/key-shift.svg icons/keyboard-mode-symbolic.svg diff --git a/eekboard/eekboard-context-service.c b/eekboard/eekboard-context-service.c index 3fda97e5..b94821ac 100644 --- a/eekboard/eekboard-context-service.c +++ b/eekboard/eekboard-context-service.c @@ -79,6 +79,8 @@ struct _EekboardContextServicePrivate { gboolean repeat_triggered; GSettings *settings; + uint32_t hint; + uint32_t purpose; }; G_DEFINE_TYPE_WITH_PRIVATE (EekboardContextService, eekboard_context_service, G_TYPE_OBJECT); @@ -353,11 +355,15 @@ settings_update_layout(EekboardContextService *context) keyboard_layout = g_strdup("undefined"); } + EekboardContextServicePrivate *priv = EEKBOARD_CONTEXT_SERVICE_GET_PRIVATE(context); + + if (priv->purpose == ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_PHONE) + keyboard_layout = g_strdup("numbers"); + // generic part follows static guint keyboard_id = 0; EekKeyboard *keyboard = g_hash_table_lookup(context->priv->keyboard_hash, GUINT_TO_POINTER(keyboard_id)); - g_debug("type=%s, layout=%s, keyboard=%p", keyboard_type, keyboard_layout, keyboard); // create a keyboard if (!keyboard) { EekboardContextServiceClass *klass = EEKBOARD_CONTEXT_SERVICE_GET_CLASS(context); @@ -641,3 +647,15 @@ void eekboard_context_service_set_keymap(EekboardContextService *context, WL_KEYBOARD_KEYMAP_FORMAT_XKB_V1, keyboard->keymap_fd, keyboard->keymap_len); } + +void eekboard_context_service_set_hint_purpose(EekboardContextService *context, + uint32_t hint, uint32_t purpose) +{ + EekboardContextServicePrivate *priv = EEKBOARD_CONTEXT_SERVICE_GET_PRIVATE(context); + + if (priv->hint != hint || priv->purpose != purpose) { + priv->hint = hint; + priv->purpose = purpose; + settings_update_layout(context); + } +} diff --git a/eekboard/eekboard-context-service.h b/eekboard/eekboard-context-service.h index c56cb4e0..b5ee738c 100644 --- a/eekboard/eekboard-context-service.h +++ b/eekboard/eekboard-context-service.h @@ -25,6 +25,7 @@ #include #include "virtual-keyboard-unstable-v1-client-protocol.h" +#include "text-input-unstable-v3-client-protocol.h" G_BEGIN_DECLS @@ -104,5 +105,9 @@ gboolean eekboard_context_service_get_fullscreen void eekboard_context_service_set_keymap(EekboardContextService *context, const EekKeyboard *keyboard); +void eekboard_context_service_set_hint_purpose(EekboardContextService *context, + uint32_t hint, + uint32_t purpose); + G_END_DECLS #endif /* EEKBOARD_CONTEXT_SERVICE_H */ diff --git a/protocols/meson.build b/protocols/meson.build index b989eb7b..db3aa70a 100644 --- a/protocols/meson.build +++ b/protocols/meson.build @@ -14,6 +14,7 @@ wl_protos = [ 'wlr-layer-shell-unstable-v1.xml', 'virtual-keyboard-unstable-v1.xml', 'input-method-unstable-v2.xml', + 'text-input-unstable-v3.xml' ] wl_proto_sources = [] foreach proto: wl_protos diff --git a/protocols/text-input-unstable-v3.xml b/protocols/text-input-unstable-v3.xml new file mode 100644 index 00000000..8b710fd6 --- /dev/null +++ b/protocols/text-input-unstable-v3.xml @@ -0,0 +1,441 @@ + + + + + Copyright © 2012, 2013 Intel Corporation + Copyright © 2015, 2016 Jan Arne Petersen + Copyright © 2017, 2018 Red Hat, Inc. + Copyright © 2018 Purism SPC + + Permission to use, copy, modify, distribute, and sell this + software and its documentation for any purpose is hereby granted + without fee, provided that the above copyright notice appear in + all copies and that both that copyright notice and this permission + notice appear in supporting documentation, and that the name of + the copyright holders not be used in advertising or publicity + pertaining to distribution of the software without specific, + written prior permission. The copyright holders make no + representations about the suitability of this software for any + purpose. It is provided "as is" without express or implied + warranty. + + THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS + SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND + FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY + SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN + AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, + ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF + THIS SOFTWARE. + + + + This protocol allows compositors to act as input methods and to send text + to applications. A text input object is used to manage state of what are + typically text entry fields in the application. + + This document adheres to the RFC 2119 when using words like "must", + "should", "may", etc. + + Warning! The protocol described in this file is experimental and + backward incompatible changes may be made. Backward compatible changes + may be added together with the corresponding interface version bump. + Backward incompatible changes are done by bumping the version number in + the protocol and interface names and resetting the interface version. + Once the protocol is to be declared stable, the 'z' prefix and the + version number in the protocol and interface names are removed and the + interface version number is reset. + + + + + The zwp_text_input_v3 interface represents text input and input methods + associated with a seat. It provides enter/leave events to follow the + text input focus for a seat. + + Requests are used to enable/disable the text-input object and set + state information like surrounding and selected text or the content type. + The information about the entered text is sent to the text-input object + via the preedit_string and commit_string events. + + Text is valid UTF-8 encoded, indices and lengths are in bytes. Indices + must not point to middle bytes inside a code point: they must either + point to the first byte of a code point or to the end of the buffer. + Lengths must be measured between two valid indices. + + Focus moving throughout surfaces will result in the emission of + zwp_text_input_v3.enter and zwp_text_input_v3.leave events. The focused + surface must commit zwp_text_input_v3.enable and + zwp_text_input_v3.disable requests as the keyboard focus moves across + editable and non-editable elements of the UI. Those two requests are not + expected to be paired with each other, the compositor must be able to + handle consecutive series of the same request. + + State is sent by the state requests (set_surrounding_text, + set_content_type and set_cursor_rectangle) and a commit request. After an + enter event or disable request all state information is invalidated and + needs to be resent by the client. + + + + + Destroy the wp_text_input object. Also disables all surfaces enabled + through this wp_text_input object. + + + + + + Requests text input on the surface previously obtained from the enter + event. + + This request must be issued every time the active text input changes + to a new one, including within the current surface. Use + zwp_text_input_v3.disable when there is no longer any input focus on + the current surface. + + This request resets all state associated with previous enable, disable, + set_surrounding_text, set_text_change_cause, set_content_type, and + set_cursor_rectangle requests, as well as the state associated with + preedit_string, commit_string, and delete_surrounding_text events. + + The set_surrounding_text, set_content_type and set_cursor_rectangle + requests must follow if the text input supports the necessary + functionality. + + State set with this request is double-buffered. It will get applied on + the next zwp_text_input_v3.commit request, and stay valid until the + next committed enable or disable request. + + The changes must be applied by the compositor after issuing a + zwp_text_input_v3.commit request. + + + + + + Explicitly disable text input on the current surface (typically when + there is no focus on any text entry inside the surface). + + State set with this request is double-buffered. It will get applied on + the next zwp_text_input_v3.commit request. + + + + + + Sets the surrounding plain text around the input, excluding the preedit + text. + + The client should notify the compositor of any changes in any of the + values carried with this request, including changes caused by handling + incoming text-input events as well as changes caused by other + mechanisms like keyboard typing. + + If the client is unaware of the text around the cursor, it should not + issue this request, to signify lack of support to the compositor. + + Text is UTF-8 encoded, and should include the cursor position, the + complete selection and additional characters before and after them. + There is a maximum length of wayland messages, so text can not be + longer than 4000 bytes. + + Cursor is the byte offset of the cursor within text buffer. + + Anchor is the byte offset of the selection anchor within text buffer. + If there is no selected text, anchor is the same as cursor. + + If any preedit text is present, it is replaced with a cursor for the + purpose of this event. + + Values set with this request are double-buffered. They will get applied + on the next zwp_text_input_v3.commit request, and stay valid until the + next committed enable or disable request. + + The initial state for affected fields is empty, meaning that the text + input does not support sending surrounding text. If the empty values + get applied, subsequent attempts to change them may have no effect. + + + + + + + + + Reason for the change of surrounding text or cursor posision. + + + + + + + + Tells the compositor why the text surrounding the cursor changed. + + Whenever the client detects an external change in text, cursor, or + anchor posision, it must issue this request to the compositor. This + request is intended to give the input method a chance to update the + preedit text in an appropriate way, e.g. by removing it when the user + starts typing with a keyboard. + + cause describes the source of the change. + + The value set with this request is double-buffered. It must be applied + and reset to initial at the next zwp_text_input_v3.commit request. + + The initial value of cause is input_method. + + + + + + + Content hint is a bitmask to allow to modify the behavior of the text + input. + + + + + + + + + + + + + + + + + The content purpose allows to specify the primary purpose of a text + input. + + This allows an input method to show special purpose input panels with + extra characters or to disallow some characters. + + + + + + + + + + + + + + + + + + + + Sets the content purpose and content hint. While the purpose is the + basic purpose of an input field, the hint flags allow to modify some of + the behavior. + + Values set with this request are double-buffered. They will get applied + on the next zwp_text_input_v3.commit request. + Subsequent attempts to update them may have no effect. The values + remain valid until the next committed enable or disable request. + + The initial value for hint is none, and the initial value for purpose + is normal. + + + + + + + + Marks an area around the cursor as a x, y, width, height rectangle in + surface local coordinates. + + Allows the compositor to put a window with word suggestions near the + cursor, without obstructing the text being input. + + If the client is unaware of the position of edited text, it should not + issue this request, to signify lack of support to the compositor. + + Values set with this request are double-buffered. They will get applied + on the next zwp_text_input_v3.commit request, and stay valid until the + next committed enable or disable request. + + The initial values describing a cursor rectangle are empty. That means + the text input does not support describing the cursor area. If the + empty values get applied, subsequent attempts to change them may have + no effect. + + + + + + + + + + Atomically applies state changes recently sent to the compositor. + + The commit request establishes and updates the state of the client, and + must be issued after any changes to apply them. + + Text input state (enabled status, content purpose, content hint, + surrounding text and change cause, cursor rectangle) is conceptually + double-buffered within the context of a text input, i.e. between a + committed enable request and the following committed enable or disable + request. + + Protocol requests modify the pending state, as opposed to the current + state in use by the input method. A commit request atomically applies + all pending state, replacing the current state. After commit, the new + pending state is as documented for each related request. + + Requests are applied in the order of arrival. + + Neither current nor pending state are modified unless noted otherwise. + + The compositor must count the number of commit requests coming from + each zwp_text_input_v3 object and use the count as the serial in done + events. + + + + + + Notification that this seat's text-input focus is on a certain surface. + + When the seat has the keyboard capability the text-input focus follows + the keyboard focus. This event sets the current surface for the + text-input object. + + + + + + + Notification that this seat's text-input focus is no longer on a + certain surface. The client should reset any preedit string previously + set. + + The leave notification clears the current surface. It is sent before + the enter notification for the new focus. + + When the seat has the keyboard capability the text-input focus follows + the keyboard focus. + + + + + + + Notify when a new composing text (pre-edit) should be set at the + current cursor position. Any previously set composing text must be + removed. Any previously existing selected text must be removed. + + The argument text contains the pre-edit string buffer. + + The parameters cursor_begin and cursor_end are counted in bytes + relative to the beginning of the submitted text buffer. Cursor should + be hidden when both are equal to -1. + + They could be represented by the client as a line if both values are + the same, or as a text highlight otherwise. + + Values set with this event are double-buffered. They must be applied + and reset to initial on the next zwp_text_input_v3.done event. + + The initial value of text is an empty string, and cursor_begin, + cursor_end and cursor_hidden are all 0. + + + + + + + + + Notify when text should be inserted into the editor widget. The text to + commit could be either just a single character after a key press or the + result of some composing (pre-edit). + + Values set with this event are double-buffered. They must be applied + and reset to initial on the next zwp_text_input_v3.done event. + + The initial value of text is an empty string. + + + + + + + Notify when the text around the current cursor position should be + deleted. + + Before_length and after_length are the number of bytes before and after + the current cursor index (excluding the selection) to delete. + + If a preedit text is present, in effect before_length is counted from + the beginning of it, and after_length from its end (see done event + sequence). + + Values set with this event are double-buffered. They must be applied + and reset to initial on the next zwp_text_input_v3.done event. + + The initial values of both before_length and after_length are 0. + + + + + + + + Instruct the application to apply changes to state requested by the + preedit_string, commit_string and delete_surrounding_text events. The + state relating to these events is double-buffered, and each one + modifies the pending state. This event replaces the current state with + the pending state. + + The application must proceed by evaluating the changes in the following + order: + + 1. Replace existing preedit string with the cursor. + 2. Delete requested surrounding text. + 3. Insert commit string with the cursor at its end. + 4. Calculate surrounding text to send. + 5. Insert new preedit text in cursor position. + 6. Place cursor inside preedit text. + + The serial number reflects the last state of the zwp_text_input_v3 + object known to the compositor. The value of the serial argument must + be equal to the number of commit requests already issued on that object. + When the client receives a done event with a serial different than the + number of past commit requests, it must proceed as normal, except it + should not change the current state of the zwp_text_input_v3 object. + + + + + + + + A factory for text-input objects. This object is a global singleton. + + + + + Destroy the wp_text_input_manager object. + + + + + + Creates a new text-input object for a given seat. + + + + + + diff --git a/src/imservice.c b/src/imservice.c index 4ee756ce..9c565040 100644 --- a/src/imservice.c +++ b/src/imservice.c @@ -6,7 +6,15 @@ void imservice_handle_text_change_cause(void *data, struct zwp_input_method_v2 *input_method, uint32_t cause) {} -void imservice_handle_content_type(void *data, struct zwp_input_method_v2 *input_method, uint32_t hint, uint32_t purpose) {} + +void imservice_handle_content_type(void *data, struct zwp_input_method_v2 *input_method, uint32_t hint, uint32_t purpose) +{ + struct imservice *ims = (struct imservice*)data; + EekboardContextService *context = EEKBOARD_CONTEXT_SERVICE(ims->ui_manager); + + eekboard_context_service_set_hint_purpose(context, hint, purpose); +} + void imservice_handle_unavailable(void *data, struct zwp_input_method_v2 *input_method) {} @@ -25,8 +33,11 @@ struct imservice* get_imservice(EekboardContextService *context, struct wl_seat *seat) { struct zwp_input_method_v2 *im = zwp_input_method_manager_v2_get_input_method(manager, seat); struct imservice *imservice = imservice_new(im, context); - zwp_input_method_v2_add_listener(im, - &input_method_listener, imservice); + + /* Add a listener, passing the imservice instance to make it available to + callbacks. */ + zwp_input_method_v2_add_listener(im, &input_method_listener, imservice); + return imservice; } diff --git a/src/imservice.h b/src/imservice.h index b728401f..271f863f 100644 --- a/src/imservice.h +++ b/src/imservice.h @@ -4,7 +4,11 @@ #include "input-method-unstable-v2-client-protocol.h" #include "eek/eek-types.h" -struct imservice; +struct imservice +{ + struct zwp_input_method_v2 *im; + EekboardContextService *ui_manager; +}; struct imservice* get_imservice(EekboardContextService *context, struct zwp_input_method_manager_v2 *manager,