clients/keyboard.c

   1 /*
   2  * Copyright © 2012 Openismus GmbH
   3  * Copyright © 2012 Intel Corporation
   4  *
   5  * Permission to use, copy, modify, distribute, and sell this software and
   6  * its documentation for any purpose is hereby granted without fee, provided
   7  * that the above copyright notice appear in all copies and that both that
   8  * copyright notice and this permission notice appear in supporting
   9  * documentation, and that the name of the copyright holders not be used in
  10  * advertising or publicity pertaining to distribution of the software
  11  * without specific, written prior permission.  The copyright holders make
  12  * no representations about the suitability of this software for any
  13  * purpose.  It is provided "as is" without express or implied warranty.
  14  *
  15  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
  16  * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
  17  * FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
  18  * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
  19  * RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
  20  * CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  21  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  22  */
  23
  24 #include <stdio.h>
  25 #include <stdlib.h>
  26 #include <string.h>
  27
  28 #include <linux/input.h>
  29 #include <cairo.h>
  30
  31 #include "window.h"
  32 #include "input-method-client-protocol.h"
  33 #include "desktop-shell-client-protocol.h"
  34
  35 struct virtual_keyboard {
  36         struct input_panel *input_panel;
  37         struct input_method *input_method;
  38         struct input_method_context *context;
  39         struct display *display;
  40         char *preedit_string;
  41 };
  42
  43 enum key_type {
  44         keytype_default,
  45         keytype_backspace,
  46         keytype_enter,
  47         keytype_space,
  48         keytype_switch,
  49         keytype_symbols,
  50         keytype_tab
  51 };
  52
  53 struct key {
  54         enum key_type key_type;
  55
  56         char *label;
  57         char *alt;
  58
  59         unsigned int width;
  60 };
  61
  62 static const struct key keys[] = {
  63         { keytype_default, "q", "Q", 1},
  64         { keytype_default, "w", "W", 1},
  65         { keytype_default, "e", "E", 1},
  66         { keytype_default, "r", "R", 1},
  67         { keytype_default, "t", "T", 1},
  68         { keytype_default, "y", "Y", 1},
  69         { keytype_default, "u", "U", 1},
  70         { keytype_default, "i", "I", 1},
  71         { keytype_default, "o", "O", 1},
  72         { keytype_default, "p", "P", 1},
  73         { keytype_backspace, "<--", "<--", 2},
  74
  75         { keytype_tab, "->|", "->|", 1},
  76         { keytype_default, "a", "A", 1},
  77         { keytype_default, "s", "S", 1},
  78         { keytype_default, "d", "D", 1},
  79         { keytype_default, "f", "F", 1},
  80         { keytype_default, "g", "G", 1},
  81         { keytype_default, "h", "H", 1},
  82         { keytype_default, "j", "J", 1},
  83         { keytype_default, "k", "K", 1},
  84         { keytype_default, "l", "L", 1},
  85         { keytype_enter, "Enter", "Enter", 2},
  86
  87         { keytype_switch, "ABC", "abc", 2},
  88         { keytype_default, "z", "Z", 1},
  89         { keytype_default, "x", "X", 1},
  90         { keytype_default, "c", "C", 1},
  91         { keytype_default, "v", "V", 1},
  92         { keytype_default, "b", "B", 1},
  93         { keytype_default, "n", "N", 1},
  94         { keytype_default, "m", "M", 1},
  95         { keytype_default, ",", ",", 1},
  96         { keytype_default, ".", ".", 1},
  97         { keytype_switch, "ABC", "abc", 1},
  98
  99         { keytype_symbols, "?123", "?123", 2},
 100         { keytype_space, "", "", 8},
 101         { keytype_symbols, "?123", "?123", 2}
 102 };
 103
 104 static const unsigned int columns = 12;
 105 static const unsigned int rows = 4;
 106
 107 static const double key_width = 60;
 108 static const double key_height = 50;
 109
 110 enum keyboard_state {
 111         keyboardstate_default,
 112         keyboardstate_uppercase
 113 };
 114
 115 struct keyboard {
 116         struct virtual_keyboard *keyboard;
 117         struct window *window;
 118         struct widget *widget;
 119
 120         enum keyboard_state state;
 121 };
 122
 123 static void
 124 draw_key(const struct key *key,
 125          cairo_t *cr,
 126          enum keyboard_state state,
 127          unsigned int row,
 128          unsigned int col)
 129 {
 130         const char *label;
 131         cairo_text_extents_t extents;
 132
 133         cairo_save(cr);
 134         cairo_rectangle(cr,
 135                         col * key_width, row * key_height,
 136                         key->width * key_width, key_height);
 137         cairo_clip(cr);
 138
 139         /* Paint frame */
 140         cairo_rectangle(cr,
 141                         col * key_width, row * key_height,
 142                         key->width * key_width, key_height);
 143         cairo_set_line_width(cr, 3);
 144         cairo_stroke(cr);
 145
 146         /* Paint text */
 147         label = state == keyboardstate_default ? key->label : key->alt;
 148         cairo_text_extents(cr, label, &extents);
 149
 150         cairo_translate(cr,
 151                         col * key_width,
 152                         row * key_height);
 153         cairo_translate(cr,
 154                         (key->width * key_width - extents.width) / 2,
 155                         (key_height - extents.y_bearing) / 2);
 156         cairo_show_text(cr, label);
 157
 158         cairo_restore(cr);
 159 }
 160
 161 static void
 162 redraw_handler(struct widget *widget, void *data)
 163 {
 164         struct keyboard *keyboard = data;
 165         cairo_surface_t *surface;
 166         struct rectangle allocation;
 167         cairo_t *cr;
 168         unsigned int i;
 169         unsigned int row = 0, col = 0;
 170
 171         surface = window_get_surface(keyboard->window);
 172         widget_get_allocation(keyboard->widget, &allocation);
 173
 174         cr = cairo_create(surface);
 175         cairo_rectangle(cr, allocation.x, allocation.y, allocation.width, allocation.height);
 176         cairo_clip(cr);
 177
 178         cairo_select_font_face(cr, "sans", CAIRO_FONT_SLANT_NORMAL, CAIRO_FONT_WEIGHT_BOLD);
 179         cairo_set_font_size(cr, 16);
 180
 181         cairo_translate(cr, allocation.x, allocation.y);
 182
 183         cairo_set_operator(cr, CAIRO_OPERATOR_SOURCE);
 184         cairo_set_source_rgba(cr, 1, 1, 1, 0.75);
 185         cairo_rectangle(cr, 0, 0, columns * key_width, rows * key_height);
 186         cairo_paint(cr);
 187
 188         cairo_set_operator(cr, CAIRO_OPERATOR_OVER);
 189
 190         for (i = 0; i < sizeof(keys) / sizeof(*keys); ++i) {
 191                 cairo_set_source_rgb(cr, 0, 0, 0);
 192                 draw_key(&keys[i], cr, keyboard->state, row, col);
 193                 col += keys[i].width;
 194                 if (col >= columns) {
 195                         row += 1;
 196                         col = 0;
 197                 }
 198         }
 199
 200         cairo_destroy(cr);
 201         cairo_surface_destroy(surface);
 202 }
 203
 204 static void
 205 resize_handler(struct widget *widget,
 206                int32_t width, int32_t height, void *data)
 207 {
 208         /* struct keyboard *keyboard = data; */
 209 }
 210
 211 static void
 212 keyboard_handle_key(struct keyboard *keyboard, const struct key *key)
 213 {
 214         const char *label = keyboard->state == keyboardstate_default ? key->label : key->alt;
 215
 216         switch (key->key_type) {
 217                 case keytype_default:
 218                         keyboard->keyboard->preedit_string = strcat(keyboard->keyboard->preedit_string,
 219                                                                     label);
 220                         input_method_context_preedit_string(keyboard->keyboard->context,
 221                                                             keyboard->keyboard->preedit_string,
 222                                                             strlen(keyboard->keyboard->preedit_string));
 223                         break;
 224                 case keytype_backspace:
 225                         if (strlen(keyboard->keyboard->preedit_string) == 0) {
 226                                 input_method_context_delete_surrounding_text(keyboard->keyboard->context,
 227                                                                              -1, 1);
 228                         }
 229                         break;
 230                 case keytype_enter:
 231                         input_method_context_key(keyboard->keyboard->context,
 232                                                  XKB_KEY_KP_Enter, WL_KEYBOARD_KEY_STATE_PRESSED);
 233                         break;
 234                 case keytype_space:
 235                         keyboard->keyboard->preedit_string = strcat(keyboard->keyboard->preedit_string,
 236                                                                     " ");
 237                         input_method_context_preedit_string(keyboard->keyboard->context,
 238                                                             "",
 239                                                             0);
 240                         input_method_context_commit_string(keyboard->keyboard->context,
 241                                                            keyboard->keyboard->preedit_string,
 242                                                            strlen(keyboard->keyboard->preedit_string));
 243                         free(keyboard->keyboard->preedit_string);
 244                         keyboard->keyboard->preedit_string = strdup("");
 245                         break;
 246                 case keytype_switch:
 247                         if (keyboard->state == keyboardstate_default)
 248                                 keyboard->state = keyboardstate_uppercase;
 249                         else
 250                                 keyboard->state = keyboardstate_default;
 251                         break;
 252                 case keytype_symbols:
 253                         break;
 254                 case keytype_tab:
 255                         input_method_context_key(keyboard->keyboard->context,
 256                                                  XKB_KEY_Tab, WL_KEYBOARD_KEY_STATE_PRESSED);
 257                         break;
 258         }
 259 }
 260
 261 static void
 262 button_handler(struct widget *widget,
 263                struct input *input, uint32_t time,
 264                uint32_t button,
 265                enum wl_pointer_button_state state, void *data)
 266 {
 267         struct keyboard *keyboard = data;
 268         struct rectangle allocation;
 269         int32_t x, y;
 270         int row, col;
 271         unsigned int i;
 272
 273         if (state != WL_POINTER_BUTTON_STATE_PRESSED || button != BTN_LEFT) {
 274                 return;
 275         }
 276
 277         input_get_position(input, &x, &y);
 278
 279         widget_get_allocation(keyboard->widget, &allocation);
 280         x -= allocation.x;
 281         y -= allocation.y;
 282
 283         row = y / key_height;
 284         col = x / key_width + row * columns;
 285         for (i = 0; i < sizeof(keys) / sizeof(*keys); ++i) {
 286                 col -= keys[i].width;
 287                 if (col < 0)
 288                         break;
 289         }
 290
 291         keyboard_handle_key(keyboard, &keys[i]);
 292
 293         widget_schedule_redraw(widget);
 294 }
 295
 296 static void
 297 input_method_context_surrounding_text(void *data,
 298                                       struct input_method_context *context,
 299                                       const char *text,
 300                                       uint32_t cursor,
 301                                       uint32_t anchor)
 302 {
 303         fprintf(stderr, "Surrounding text updated: %s\n", text);
 304 }
 305
 306 static const struct input_method_context_listener input_method_context_listener = {
 307         input_method_context_surrounding_text,
 308 };
 309
 310 static void
 311 input_method_activate(void *data,
 312                       struct input_method *input_method,
 313                       struct input_method_context *context)
 314 {
 315         struct virtual_keyboard *keyboard = data;
 316
 317         if (keyboard->context)
 318                 input_method_context_destroy(keyboard->context);
 319
 320         if (keyboard->preedit_string)
 321                 free(keyboard->preedit_string);
 322
 323         keyboard->preedit_string = strdup("");
 324
 325         keyboard->context = context;
 326         input_method_context_add_listener(context,
 327                                           &input_method_context_listener,
 328                                           keyboard);
 329 }
 330
 331 static void
 332 input_method_deactivate(void *data,
 333                         struct input_method *input_method,
 334                         struct input_method_context *context)
 335 {
 336         struct virtual_keyboard *keyboard = data;
 337
 338         if (!keyboard->context)
 339                 return;
 340
 341         input_method_context_destroy(keyboard->context);
 342         keyboard->context = NULL;
 343 }
 344
 345 static const struct input_method_listener input_method_listener = {
 346         input_method_activate,
 347         input_method_deactivate
 348 };
 349
 350 static void
 351 global_handler(struct wl_display *display, uint32_t id,
 352                const char *interface, uint32_t version, void *data)
 353 {
 354         struct virtual_keyboard *keyboard = data;
 355
 356         if (!strcmp(interface, "input_panel")) {
 357                 keyboard->input_panel = wl_display_bind(display, id, &input_panel_interface);
 358         } else if (!strcmp(interface, "input_method")) {
 359                 keyboard->input_method = wl_display_bind(display, id, &input_method_interface);
 360                 input_method_add_listener(keyboard->input_method, &input_method_listener, keyboard);
 361         }
 362 }
 363
 364 static void
 365 keyboard_create(struct output *output, struct virtual_keyboard *virtual_keyboard)
 366 {
 367         struct keyboard *keyboard;
 368
 369         keyboard = malloc(sizeof *keyboard);
 370         memset(keyboard, 0, sizeof *keyboard);
 371
 372         keyboard->keyboard = virtual_keyboard;
 373         keyboard->window = window_create_custom(virtual_keyboard->display);
 374         keyboard->widget = window_add_widget(keyboard->window, keyboard);
 375
 376         window_set_title(keyboard->window, "Virtual keyboard");
 377         window_set_user_data(keyboard->window, keyboard);
 378
 379         widget_set_redraw_handler(keyboard->widget, redraw_handler);
 380         widget_set_resize_handler(keyboard->widget, resize_handler);
 381         widget_set_button_handler(keyboard->widget, button_handler);
 382
 383         window_schedule_resize(keyboard->window,
 384                                columns * key_width,
 385                                rows * key_height);
 386
 387         input_panel_set_surface(virtual_keyboard->input_panel,
 388                                 window_get_wl_surface(keyboard->window),
 389                                 output_get_wl_output(output));
 390 }
 391
 392 static void
 393 handle_output_configure(struct output *output, void *data)
 394 {
 395         struct virtual_keyboard *virtual_keyboard = data;
 396
 397         /* skip existing outputs */
 398         if (output_get_user_data(output))
 399                 return;
 400
 401         output_set_user_data(output, virtual_keyboard);
 402
 403         keyboard_create(output, virtual_keyboard);
 404 }
 405
 406 int
 407 main(int argc, char *argv[])
 408 {
 409         struct virtual_keyboard virtual_keyboard;
 410
 411         virtual_keyboard.display = display_create(argc, argv);
 412         if (virtual_keyboard.display == NULL) {
 413                 fprintf(stderr, "failed to create display: %m\n");
 414                 return -1;
 415         }
 416
 417         virtual_keyboard.context = NULL;
 418         virtual_keyboard.preedit_string = NULL;
 419
 420         wl_display_add_global_listener(display_get_display(virtual_keyboard.display),
 421                                        global_handler, &virtual_keyboard);
 422
 423         display_set_user_data(virtual_keyboard.display, &virtual_keyboard);
 424         display_set_output_configure_handler(virtual_keyboard.display, handle_output_configure);
 425
 426         display_run(virtual_keyboard.display);
 427
 428         return 0;
 429 }