libchimara/input.c

   1 #include "charset.h"
   2 #include "magic.h"
   3 #include "input.h"
   4 #include "chimara-glk-private.h"
   5
   6 extern GPrivate *glk_data_key;
   7
   8 /* Forward declarations */
   9 static int finish_text_buffer_line_input(winid_t win, gboolean emit_signal);
  10 static int finish_text_grid_line_input(winid_t win, gboolean emit_signal);
  11 static void cancel_old_input_request(winid_t win);
  12
  13 /* Internal function: code common to both flavors of char event request */
  14 void
  15 request_char_event_common(winid_t win, gboolean unicode)
  16 {
  17         VALID_WINDOW(win, return);
  18         g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
  19
  20         cancel_old_input_request(win);
  21
  22         flush_window_buffer(win);
  23
  24         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
  25
  26         win->input_request_type = unicode? INPUT_REQUEST_CHARACTER_UNICODE : INPUT_REQUEST_CHARACTER;
  27         g_signal_handler_unblock( win->widget, win->char_input_keypress_handler );
  28
  29         gdk_threads_enter();
  30
  31         /* If the request is in a text buffer window, scroll to the end of the
  32          text buffer. TODO: This may scroll text off the top of the window that the
  33          user hasn't read yet. We need to implement a paging mechanism. */
  34         if(win->type == wintype_TextBuffer)
  35         {
  36                 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
  37                 GtkTextIter iter;
  38                 gtk_text_buffer_get_end_iter(buffer, &iter);
  39                 gtk_text_buffer_place_cursor(buffer, &iter);
  40                 gtk_text_view_scroll_mark_onscreen(GTK_TEXT_VIEW(win->widget), gtk_text_buffer_get_insert(buffer));
  41                 /* Why doesn't this always work?? */
  42         }
  43
  44         gtk_widget_grab_focus( GTK_WIDGET(win->widget) );
  45         gdk_threads_leave();
  46
  47         /* Emit the "waiting" signal to let listeners know we are ready for input */
  48         g_signal_emit_by_name(glk_data->self, "waiting");
  49 }
  50
  51 /**
  52  * glk_request_char_event:
  53  * @win: A window to request char events from.
  54  *
  55  * Request input of a Latin-1 character or special key. A window cannot have
  56  * requests for both character and line input at the same time. Nor can it have
  57  * requests for character input of both types (Latin-1 and Unicode). It is
  58  * illegal to call glk_request_char_event() if the window already has a pending
  59  * request for either character or line input.
  60  */
  61 void
  62 glk_request_char_event(winid_t win)
  63 {
  64         request_char_event_common(win, FALSE);
  65 }
  66
  67 /**
  68  * glk_request_char_event_uni:
  69  * @win: A window to request char events from.
  70  *
  71  * Request input of a Unicode character or special key. See
  72  * glk_request_char_event().
  73  */
  74 void
  75 glk_request_char_event_uni(winid_t win)
  76 {
  77         request_char_event_common(win, TRUE);
  78 }
  79
  80 /**
  81  * glk_cancel_char_event:
  82  * @win: A window to cancel the latest char event request on.
  83  *
  84  * This cancels a pending request for character input. (Either Latin-1 or
  85  * Unicode.) For convenience, it is legal to call glk_cancel_char_event() even
  86  * if there is no charcter input request on that window. Glk will ignore the
  87  * call in this case.
  88  */
  89 void
  90 glk_cancel_char_event(winid_t win)
  91 {
  92         VALID_WINDOW(win, return);
  93         g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
  94
  95         if(win->input_request_type == INPUT_REQUEST_CHARACTER || win->input_request_type == INPUT_REQUEST_CHARACTER_UNICODE)
  96         {
  97                 win->input_request_type = INPUT_REQUEST_NONE;
  98                 g_signal_handler_block( win->widget, win->char_input_keypress_handler );
  99         }
 100 }
 101
 102 /* Internal function: Request either latin-1 or unicode line input, in a text grid window. */
 103 static void
 104 text_grid_request_line_event_common(winid_t win, glui32 maxlen, gboolean insert, gchar *inserttext)
 105 {
 106         gdk_threads_enter();
 107
 108         GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
 109
 110     GtkTextMark *cursor = gtk_text_buffer_get_mark(buffer, "cursor_position");
 111     GtkTextIter start_iter, end_iter;
 112     gtk_text_buffer_get_iter_at_mark(buffer, &start_iter, cursor);
 113
 114     /* Determine the maximum length of the line input */
 115     gint cursorpos = gtk_text_iter_get_line_offset(&start_iter);
 116     /* Odd; the Glk spec says the maximum input length is
 117     windowwidth - 1 - cursorposition. I say no, because if cursorposition is
 118     zero, then the input should fill the whole line. FIXME??? */
 119     win->input_length = MIN(win->width - cursorpos, win->line_input_buffer_max_len);
 120     end_iter = start_iter;
 121     gtk_text_iter_set_line_offset(&end_iter, cursorpos + win->input_length);
 122
 123         /* If the buffer currently has a selection with one bound in the middle of
 124         the input field, then deselect it. Otherwise the input field gets trashed */
 125         GtkTextIter start_sel, end_sel;
 126         if( gtk_text_buffer_get_selection_bounds(buffer, &start_sel, &end_sel) )
 127         {
 128                 if( gtk_text_iter_in_range(&start_sel, &start_iter, &end_iter) )
 129                         gtk_text_buffer_place_cursor(buffer, &end_sel);
 130                 if( gtk_text_iter_in_range(&end_sel, &start_iter, &end_iter) )
 131                         gtk_text_buffer_place_cursor(buffer, &start_sel);
 132         }
 133
 134     /* Erase the text currently in the input field and replace it with a GtkEntry */
 135     gtk_text_buffer_delete(buffer, &start_iter, &end_iter);
 136     win->input_anchor = gtk_text_buffer_create_child_anchor(buffer, &start_iter);
 137     win->input_entry = gtk_entry_new();
 138         /* Set the entry's font to match that of the window */
 139     GtkRcStyle *style = gtk_widget_get_modifier_style(win->widget);     /* Don't free */
 140         gtk_widget_modify_font(win->input_entry, style->font_desc);
 141         /* Make the entry as small as possible to fit with the text */
 142         gtk_entry_set_has_frame(GTK_ENTRY(win->input_entry), FALSE);
 143         GtkBorder border = { 0, 0, 0, 0 };
 144         gtk_entry_set_inner_border(GTK_ENTRY(win->input_entry), &border);
 145     gtk_entry_set_max_length(GTK_ENTRY(win->input_entry), win->input_length);
 146     gtk_entry_set_width_chars(GTK_ENTRY(win->input_entry), win->input_length);
 147
 148     /* Insert pre-entered text if needed */
 149     if(insert)
 150         gtk_entry_set_text(GTK_ENTRY(win->input_entry), inserttext);
 151
 152     /* Set background color of entry (TODO: implement as property) */
 153     GdkColor background;
 154         gdk_color_parse("grey", &background);
 155     gtk_widget_modify_base(win->input_entry, GTK_STATE_NORMAL, &background);
 156
 157     g_signal_connect(win->input_entry, "activate", G_CALLBACK(on_input_entry_activate), win);
 158     g_signal_connect(win->input_entry, "key-press-event", G_CALLBACK(on_input_entry_key_press_event), win);
 159     win->line_input_entry_changed = g_signal_connect(win->input_entry, "changed", G_CALLBACK(on_input_entry_changed), win);
 160
 161     gtk_widget_show(win->input_entry);
 162     gtk_text_view_add_child_at_anchor(GTK_TEXT_VIEW(win->widget), win->input_entry, win->input_anchor);
 163
 164         gtk_widget_grab_focus(win->input_entry);
 165
 166         gdk_threads_leave();
 167 }
 168
 169 /* Internal function: Request either latin-1 or unicode line input, in a text buffer window. */
 170 static void
 171 text_buffer_request_line_event_common(winid_t win, glui32 maxlen, gboolean insert, gchar *inserttext)
 172 {
 173         flush_window_buffer(win);
 174
 175         gdk_threads_enter();
 176
 177         GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
 178
 179     /* Move the input_position mark to the end of the window_buffer */
 180     GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
 181     GtkTextIter end_iter;
 182     gtk_text_buffer_get_end_iter(buffer, &end_iter);
 183     gtk_text_buffer_move_mark(buffer, input_position, &end_iter);
 184
 185     /* Set the entire contents of the window_buffer as uneditable
 186      * (so input can only be entered at the end) */
 187     GtkTextIter start_iter;
 188     gtk_text_buffer_get_start_iter(buffer, &start_iter);
 189     gtk_text_buffer_remove_tag_by_name(buffer, "uneditable", &start_iter, &end_iter);
 190     gtk_text_buffer_apply_tag_by_name(buffer, "uneditable", &start_iter, &end_iter);
 191
 192     /* Insert pre-entered text if needed */
 193     if(insert) {
 194         gtk_text_buffer_insert(buffer, &end_iter, inserttext, -1);
 195                 gtk_text_buffer_get_end_iter(buffer, &end_iter); /* update after text insertion */
 196         }
 197
 198     /* Scroll to input point */
 199     gtk_text_view_scroll_mark_onscreen(GTK_TEXT_VIEW(win->widget), input_position);
 200
 201         /* Apply the correct style to the input prompt */
 202         GtkTextIter input_iter;
 203     gtk_text_buffer_get_iter_at_mark(buffer, &input_iter, input_position);
 204     gtk_text_buffer_apply_tag_by_name(buffer, "input", &input_iter, &end_iter);
 205
 206     gtk_text_view_set_editable(GTK_TEXT_VIEW(win->widget), TRUE);
 207
 208         g_signal_handler_unblock(buffer, win->insert_text_handler);
 209         gtk_widget_grab_focus(win->widget);
 210
 211         gdk_threads_leave();
 212 }
 213
 214 /**
 215  * glk_request_line_event:
 216  * @win: A text buffer or text grid window to request line input on.
 217  * @buf: A buffer of at least @maxlen bytes.
 218  * @maxlen: Length of the buffer.
 219  * @initlen: The number of characters in @buf to pre-enter.
 220  *
 221  * Requests input of a line of Latin-1 characters. A window cannot have requests
 222  * for both character and line input at the same time. Nor can it have requests
 223  * for line input of both types (Latin-1 and Unicode). It is illegal to call
 224  * glk_request_line_event() if the window already has a pending request for
 225  * either character or line input.
 226  *
 227  * The @buf argument is a pointer to space where the line input will be stored.
 228  * (This may not be %NULL.) @maxlen is the length of this space, in bytes; the
 229  * library will not accept more characters than this. If @initlen is nonzero,
 230  * then the first @initlen bytes of @buf will be entered as pre-existing input
 231  * &mdash; just as if the player had typed them himself. (The player can continue
 232  * composing after this pre-entered input, or delete it or edit as usual.)
 233  *
 234  * The contents of the buffer are undefined until the input is completed (either
 235  * by a line input event, or glk_cancel_line_event(). The library may or may not
 236  * fill in the buffer as the player composes, while the input is still pending;
 237  * it is illegal to change the contents of the buffer yourself.
 238  */
 239 void
 240 glk_request_line_event(winid_t win, char *buf, glui32 maxlen, glui32 initlen)
 241 {
 242         VALID_WINDOW(win, return);
 243         g_return_if_fail(buf);
 244         g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
 245         g_return_if_fail(initlen <= maxlen);
 246
 247         cancel_old_input_request(win);
 248
 249         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
 250
 251         /* Register the buffer */
 252         if(glk_data->register_arr)
 253         win->buffer_rock = (*glk_data->register_arr)(buf, maxlen, "&+#!Cn");
 254
 255         win->input_request_type = INPUT_REQUEST_LINE;
 256         win->line_input_buffer = buf;
 257         win->line_input_buffer_max_len = maxlen;
 258
 259         gchar *inserttext = (initlen > 0)? g_strndup(buf, initlen) : g_strdup("");
 260         switch(win->type)
 261         {
 262             case wintype_TextBuffer:
 263                 text_buffer_request_line_event_common(win, maxlen, (initlen > 0), inserttext);
 264                 break;
 265             case wintype_TextGrid:
 266                 text_grid_request_line_event_common(win, maxlen, (initlen > 0), inserttext);
 267                 break;
 268     }
 269         g_free(inserttext);
 270         g_signal_handler_unblock(win->widget, win->line_input_keypress_handler);
 271
 272         /* Emit the "waiting" signal to let listeners know we are ready for input */
 273         g_signal_emit_by_name(glk_data->self, "waiting");
 274 }
 275
 276 /**
 277  * glk_request_line_event_uni:
 278  * @win: A text buffer or text grid window to request line input on.
 279  * @buf: A buffer of at least @maxlen characters.
 280  * @maxlen: Length of the buffer.
 281  * @initlen: The number of characters in @buf to pre-enter.
 282  *
 283  * Request input of a line of Unicode characters. This works the same as
 284  * glk_request_line_event(), except the result is stored in an array of
 285  * <type>glui32</type> values instead of an array of characters, and the values
 286  * may be any valid Unicode code points.
 287  *
 288  * The result will be in Unicode Normalization Form C. This basically means that
 289  * composite characters will be single characters where possible, instead of
 290  * sequences of base and combining marks. See
 291  * <ulink url="http://www.unicode.org/reports/tr15/">Unicode Standard Annex
 292  * #15</ulink> for the details.
 293  */
 294 void
 295 glk_request_line_event_uni(winid_t win, glui32 *buf, glui32 maxlen, glui32 initlen)
 296 {
 297         VALID_WINDOW(win, return);
 298         g_return_if_fail(buf);
 299         g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
 300         g_return_if_fail(initlen <= maxlen);
 301
 302         cancel_old_input_request(win);
 303         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
 304
 305         /* Register the buffer */
 306         if(glk_data->register_arr)
 307         win->buffer_rock = (*glk_data->register_arr)(buf, maxlen, "&+#!Iu");
 308
 309         win->input_request_type = INPUT_REQUEST_LINE_UNICODE;
 310         win->line_input_buffer_unicode = buf;
 311         win->line_input_buffer_max_len = maxlen;
 312
 313         gchar *utf8;
 314         if(initlen > 0) {
 315                 utf8 = convert_ucs4_to_utf8(buf, initlen);
 316                 if(utf8 == NULL)
 317                         return;
 318         }
 319         else
 320                 utf8 = g_strdup("");
 321
 322     switch(win->type)
 323         {
 324             case wintype_TextBuffer:
 325                 text_buffer_request_line_event_common(win, maxlen, (initlen > 0), utf8);
 326                 break;
 327             case wintype_TextGrid:
 328                 text_grid_request_line_event_common(win, maxlen, (initlen > 0), utf8);
 329                 break;
 330     }
 331     g_signal_handler_unblock(win->widget, win->line_input_keypress_handler);
 332         g_free(utf8);
 333
 334         /* Emit the "waiting" signal to let listeners know we are ready for input */
 335         g_signal_emit_by_name(glk_data->self, "waiting");
 336 }
 337
 338 /**
 339  * glk_cancel_line_event:
 340  * @win: A text buffer or text grid window to cancel line input on.
 341  * @event: Will be filled in if the user had already input something.
 342  *
 343  * This cancels a pending request for line input. (Either Latin-1 or Unicode.)
 344  *
 345  * The event pointed to by the event argument will be filled in as if the
 346  * player had hit <keycap>enter</keycap>, and the input composed so far will be
 347  * stored in the buffer; see below. If you do not care about this information,
 348  * pass %NULL as the @event argument. (The buffer will still be filled.)
 349  *
 350  * For convenience, it is legal to call glk_cancel_line_event() even if there
 351  * is no line input request on that window. The event type will be set to
 352  * %evtype_None in this case.
 353  */
 354 void
 355 glk_cancel_line_event(winid_t win, event_t *event)
 356 {
 357         VALID_WINDOW(win, return);
 358         g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
 359
 360         if(event != NULL) {
 361                 event->type = evtype_None;
 362                 event->win = win;
 363                 event->val1 = 0;
 364                 event->val2 = 0;
 365         }
 366
 367         if(win->input_request_type != INPUT_REQUEST_LINE && win->input_request_type != INPUT_REQUEST_LINE_UNICODE)
 368                 return;
 369
 370         g_signal_handler_block( win->widget, win->line_input_keypress_handler );
 371
 372         int chars_written = 0;
 373
 374         gdk_threads_enter();
 375         if(win->type == wintype_TextGrid) {
 376                 chars_written = finish_text_grid_line_input(win, FALSE);
 377         } else if(win->type == wintype_TextBuffer) {
 378                 gtk_text_view_set_editable( GTK_TEXT_VIEW(win->widget), FALSE );
 379                 GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
 380                 g_signal_handler_block(window_buffer, win->insert_text_handler);
 381                 chars_written = finish_text_buffer_line_input(win, FALSE);
 382         }
 383         gdk_threads_leave();
 384
 385         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
 386         if(glk_data->unregister_arr)
 387         {
 388                 if(win->input_request_type == INPUT_REQUEST_LINE_UNICODE)
 389                         (*glk_data->unregister_arr)(win->line_input_buffer_unicode, win->line_input_buffer_max_len, "&+#!Iu", win->buffer_rock);
 390                 else
 391                 (*glk_data->unregister_arr)(win->line_input_buffer, win->line_input_buffer_max_len, "&+#!Cn", win->buffer_rock);
 392     }
 393
 394         if(event != NULL && chars_written > 0) {
 395                 event->type = evtype_LineInput;
 396                 event->val1 = chars_written;
 397         }
 398 }
 399
 400 /* Helper function: Turn off shutdown key-press-event signal handler */
 401 static gboolean
 402 turn_off_handler(GNode *node)
 403 {
 404         winid_t win = node->data;
 405         g_signal_handler_block(win->widget, win->shutdown_keypress_handler);
 406         return FALSE; /* don't stop */
 407 }
 408
 409 /* Internal function: Callback for signal key-press-event while waiting for shutdown. */
 410 gboolean
 411 on_shutdown_key_press_event(GtkWidget *widget, GdkEventKey *event, winid_t win)
 412 {
 413         ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(widget, CHIMARA_TYPE_GLK));
 414         g_assert(glk);
 415         CHIMARA_GLK_USE_PRIVATE(glk, priv);
 416
 417         /* Turn off all the signal handlers */
 418         if(priv->root_window)
 419                 g_node_traverse(priv->root_window, G_IN_ORDER, G_TRAVERSE_LEAVES, -1, (GNodeTraverseFunc)turn_off_handler, NULL);
 420
 421         /* Signal the Glk library that it can shut everything down now */
 422         g_mutex_lock(priv->shutdown_lock);
 423         g_cond_signal(priv->shutdown_key_pressed);
 424         g_mutex_unlock(priv->shutdown_lock);
 425
 426         return TRUE; /* block the event */
 427 }
 428
 429 /* Internal function: General callback for signal key-press-event on a text buffer or text grid window. Used in character input on both text buffers and grids. Blocked when not in use. */
 430 gboolean
 431 on_char_input_key_press_event(GtkWidget *widget, GdkEventKey *event, winid_t win)
 432 {
 433         glui32 keycode = keyval_to_glk_keycode(event->keyval, win->input_request_type == INPUT_REQUEST_CHARACTER_UNICODE);
 434
 435         ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(widget, CHIMARA_TYPE_GLK));
 436         g_assert(glk);
 437         event_throw(glk, evtype_CharInput, win, keycode, 0);
 438         g_signal_emit_by_name(glk, "char-input", win->rock, event->keyval);
 439
 440         /* Only one keypress will be handled */
 441         win->input_request_type = INPUT_REQUEST_NONE;
 442         g_signal_handler_block(win->widget, win->char_input_keypress_handler);
 443
 444         return TRUE;
 445 }
 446
 447 gboolean
 448 on_line_input_key_press_event(GtkWidget *widget, GdkEventKey *event, winid_t win)
 449 {
 450         switch(win->type)
 451         {
 452                 case wintype_TextBuffer:
 453
 454                         /* History up/down */
 455                         if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up
 456                                 || event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
 457                         {
 458                                 /* Prevent falling off the end of the history list */
 459                                 if( (event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
 460                                         && win->history_pos && win->history_pos->next == NULL)
 461                                         return TRUE;
 462                                 if( (event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
 463                                         && (win->history_pos == NULL || win->history_pos->prev == NULL) )
 464                                         return TRUE;
 465
 466                                 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
 467                                 GtkTextIter start, end;
 468                                 /* Erase any text that was already typed */
 469                                 GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
 470                                 gtk_text_buffer_get_iter_at_mark(buffer, &start, input_position);
 471                                 gtk_text_buffer_get_end_iter(buffer, &end);
 472
 473                                 if(win->history_pos == NULL) {
 474                                         gchar *current_input = gtk_text_buffer_get_text(buffer, &start, &end, FALSE);
 475                                         win->history = g_list_prepend(win->history, current_input);
 476                                         win->history_pos = win->history;
 477                                 }
 478
 479                                 gtk_text_buffer_delete(buffer, &start, &end);
 480
 481                                 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
 482                                 {
 483                                         if(win->history_pos)
 484                                                 win->history_pos = g_list_next(win->history_pos);
 485                                         else
 486                                                 win->history_pos = win->history;
 487                                 }
 488                                 else /* down */
 489                                         win->history_pos = g_list_previous(win->history_pos);
 490
 491                                 /* Insert the history item into the window */
 492                                 gtk_text_buffer_get_end_iter(buffer, &end);
 493
 494                                 g_signal_handler_block(buffer, win->insert_text_handler);
 495                                 gtk_text_buffer_insert_with_tags_by_name(buffer, &end, win->history_pos->data, -1, "input", NULL);
 496                                 g_signal_handler_unblock(buffer, win->insert_text_handler);
 497                                 return TRUE;
 498                         }
 499
 500                         /* Move to beginning/end of input field */
 501                         else if(event->keyval == GDK_Home) {
 502                                 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
 503                                 GtkTextIter input_iter;
 504                                 GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
 505                                 gtk_text_buffer_get_iter_at_mark(buffer, &input_iter, input_position);
 506                                 gtk_text_buffer_place_cursor(buffer, &input_iter);
 507                                 return TRUE;
 508                         }
 509                         else if(event->keyval == GDK_End) {
 510                                 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
 511                                 GtkTextIter end_iter;
 512                                 gtk_text_buffer_get_end_iter(buffer, &end_iter);
 513                                 gtk_text_buffer_place_cursor(buffer, &end_iter);
 514                                 return TRUE;
 515                         }
 516
 517                         return FALSE;
 518
 519                 /* If this is a text grid window, then redirect the key press to the line input GtkEntry */
 520                 case wintype_TextGrid:
 521                 {
 522                         if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up
 523                                 || event->keyval == GDK_Down || event->keyval == GDK_KP_Down
 524                                 || event->keyval == GDK_Left || event->keyval == GDK_KP_Left
 525                                 || event->keyval == GDK_Right || event->keyval == GDK_KP_Right
 526                                 || event->keyval == GDK_Tab || event->keyval == GDK_KP_Tab
 527                                 || event->keyval == GDK_Page_Up || event->keyval == GDK_KP_Page_Up
 528                                 || event->keyval == GDK_Page_Down || event->keyval == GDK_KP_Page_Down
 529                                 || event->keyval == GDK_Home || event->keyval == GDK_KP_Home
 530                                 || event->keyval == GDK_End || event->keyval == GDK_KP_End)
 531                                 return FALSE; /* Don't redirect these keys */
 532                         gtk_widget_grab_focus(win->input_entry);
 533                         gtk_editable_set_position(GTK_EDITABLE(win->input_entry), -1);
 534                         gboolean retval = TRUE;
 535                         g_signal_emit_by_name(win->input_entry, "key-press-event", event, &retval);
 536                         return retval; /* Block this key event if the entry handled it */
 537                 }
 538         }
 539         return FALSE;
 540 }
 541
 542 /* Internal function: finish handling a line input request, for both text grid and text buffer windows. */
 543 static int
 544 write_to_window_buffer(winid_t win, const gchar *inserted_text)
 545 {
 546         int copycount = 0;
 547
 548     /* Convert the string from UTF-8 to Latin-1 or Unicode */
 549     if(win->input_request_type == INPUT_REQUEST_LINE)
 550     {
 551         gsize bytes_written;
 552         gchar *latin1 = convert_utf8_to_latin1(inserted_text, &bytes_written);
 553
 554         if(latin1 == NULL)
 555             return 0;
 556
 557         /* Place input in the echo stream */
 558         if(win->echo_stream != NULL)
 559             glk_put_string_stream(win->echo_stream, latin1);
 560
 561         /* Copy the string (bytes_written does not include the NULL at the end) */
 562         copycount = MIN(win->line_input_buffer_max_len, bytes_written);
 563         memcpy(win->line_input_buffer, latin1, copycount);
 564         g_free(latin1);
 565     }
 566     else if(win->input_request_type == INPUT_REQUEST_LINE_UNICODE)
 567     {
 568         glong items_written;
 569         gunichar *unicode = convert_utf8_to_ucs4(inserted_text, &items_written);
 570
 571         if(unicode == NULL)
 572             return 0;
 573
 574         /* Place input in the echo stream */
 575         if(win->echo_stream != NULL)
 576             glk_put_string_stream_uni(win->echo_stream, unicode);
 577
 578         /* Copy the string (but not the NULL at the end) */
 579         copycount = MIN(win->line_input_buffer_max_len, items_written);
 580         memcpy(win->line_input_buffer_unicode, unicode, copycount * sizeof(gunichar));
 581         g_free(unicode);
 582     }
 583     else
 584         WARNING("Wrong input request type");
 585
 586     win->input_request_type = INPUT_REQUEST_NONE;
 587         return copycount;
 588 }
 589
 590 /* Internal function: Retrieves the input of a TextBuffer window and stores it in the window buffer.
 591  * Returns the number of characters written, suitable for inclusion in a line input event. */
 592 static int
 593 finish_text_buffer_line_input(winid_t win, gboolean emit_signal)
 594 {
 595         VALID_WINDOW(win, return 0);
 596         g_return_val_if_fail(win->type == wintype_TextBuffer, 0);
 597
 598         GtkTextIter start_iter, end_iter, last_character;
 599
 600         GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
 601         GtkTextMark *input_position = gtk_text_buffer_get_mark(window_buffer, "input_position");
 602         gtk_text_buffer_get_iter_at_mark(window_buffer, &start_iter, input_position);
 603         gtk_text_buffer_get_end_iter(window_buffer, &end_iter);
 604         gtk_text_buffer_get_end_iter(window_buffer, &last_character);
 605         gtk_text_iter_backward_cursor_position(&last_character);
 606
 607         gchar* last_char = gtk_text_buffer_get_text(window_buffer, &last_character, &end_iter, FALSE);
 608
 609         if( strchr(last_char, '\n') != NULL )
 610                 gtk_text_iter_backward_cursor_position(&end_iter);
 611
 612         gchar* inserted_text = gtk_text_buffer_get_text(window_buffer, &start_iter, &end_iter, FALSE);
 613
 614         int chars_written = write_to_window_buffer(win, inserted_text);
 615         if(emit_signal)
 616         {
 617                 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
 618                 g_assert(glk);
 619                 g_signal_emit_by_name(glk, "line-input", win->rock, inserted_text);
 620         }
 621
 622         /* Add the text to the window input history */
 623         if(win->history_pos != NULL)
 624         {
 625                 g_free(win->history->data);
 626                 win->history = g_list_delete_link(win->history, win->history);
 627         }
 628         if(*inserted_text != 0)
 629                 win->history = g_list_prepend(win->history, g_strdup(inserted_text));
 630
 631         win->history_pos = NULL;
 632
 633         g_free(inserted_text);
 634
 635         return chars_written;
 636 }
 637
 638 /* Internal function: Retrieves the input of a TextGrid window and stores it in the window buffer.
 639  * Returns the number of characters written, suitable for inclusion in a line input event. */
 640 static int
 641 finish_text_grid_line_input(winid_t win, gboolean emit_signal)
 642 {
 643         VALID_WINDOW(win, return 0);
 644         g_return_val_if_fail(win->type == wintype_TextGrid, 0);
 645
 646         GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
 647
 648         gchar *text = g_strdup( gtk_entry_get_text(GTK_ENTRY(win->input_entry)) );
 649         /* Move the focus back into the text view */
 650         gtk_widget_grab_focus(win->widget);
 651         /* Remove entry widget from text view */
 652         /* Should be ok even though this is the widget's own signal handler */
 653         gtk_container_remove( GTK_CONTAINER(win->widget), GTK_WIDGET(win->input_entry) );
 654         win->input_entry = NULL;
 655         /* Delete the child anchor */
 656         GtkTextIter start, end;
 657         gtk_text_buffer_get_iter_at_child_anchor(buffer, &start, win->input_anchor);
 658         end = start;
 659         gtk_text_iter_forward_char(&end); /* Point after the child anchor */
 660         gtk_text_buffer_delete(buffer, &start, &end);
 661         win->input_anchor = NULL;
 662
 663     gchar *spaces = g_strnfill(win->input_length - g_utf8_strlen(text, -1), ' ');
 664     gchar *text_to_insert = g_strconcat(text, spaces, NULL);
 665         g_free(spaces);
 666     gtk_text_buffer_insert(buffer, &start, text_to_insert, -1);
 667     g_free(text_to_insert);
 668
 669     int chars_written = write_to_window_buffer(win, text);
 670     if(emit_signal)
 671     {
 672                 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
 673                 g_assert(glk);
 674                 g_signal_emit_by_name(glk, "line-input", win->rock, text);
 675     }
 676
 677         /* Add the text to the window input history */
 678         if(win->history_pos != NULL)
 679         {
 680                 g_free(win->history->data);
 681                 win->history = g_list_delete_link(win->history, win->history);
 682         }
 683         if(*text != 0)
 684                 win->history = g_list_prepend(win->history, g_strdup(text));
 685         win->history_pos = NULL;
 686
 687         g_free(text);
 688         return chars_written;
 689 }
 690
 691 /* Internal function: Callback for signal insert-text on a text buffer window.
 692 Runs after the default handler has already inserted the text.
 693 FIXME: This function assumes that newline was the last character typed into the
 694 window. That assumption is wrong if, for example, text containing a newline was
 695 pasted into the window. */
 696 void
 697 after_window_insert_text(GtkTextBuffer *textbuffer, GtkTextIter *location, gchar *text, gint len, winid_t win)
 698 {
 699         GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
 700
 701         /* Set the history position to NULL and erase the text we were already editing */
 702         if(win->history_pos != NULL)
 703         {
 704                 g_free(win->history->data);
 705                 win->history = g_list_delete_link(win->history, win->history);
 706                 win->history_pos = NULL;
 707         }
 708         if( strchr(text, '\n') != NULL )
 709         {
 710                 /* Remove signal handlers */
 711                 g_signal_handler_block(window_buffer, win->insert_text_handler);
 712                 g_signal_handler_block(win->widget, win->line_input_keypress_handler);
 713
 714                 /* Make the window uneditable again and retrieve the text that was input */
 715         gtk_text_view_set_editable(GTK_TEXT_VIEW(win->widget), FALSE);
 716
 717         int chars_written = finish_text_buffer_line_input(win, TRUE);
 718         ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
 719                 event_throw(glk, evtype_LineInput, win, chars_written, 0);
 720         }
 721
 722         /* Apply the 'input' style to the text that was entered */
 723         GtkTextIter end_iter;
 724         gtk_text_buffer_get_end_iter(window_buffer, &end_iter);
 725         GtkTextIter input_iter;
 726         GtkTextMark *input_position = gtk_text_buffer_get_mark(window_buffer, "input_position");
 727         gtk_text_buffer_get_iter_at_mark(window_buffer, &input_iter, input_position);
 728         gtk_text_buffer_apply_tag_by_name(window_buffer, "input", &input_iter, &end_iter);
 729 }
 730
 731 /* Internal function: Callback for signal activate on the line input GtkEntry
 732 in a text grid window. */
 733 void
 734 on_input_entry_activate(GtkEntry *input_entry, winid_t win)
 735 {
 736         g_signal_handler_block(win->widget, win->line_input_keypress_handler);
 737
 738         int chars_written = finish_text_grid_line_input(win, TRUE);
 739         ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
 740         event_throw(glk, evtype_LineInput, win, chars_written, 0);
 741 }
 742
 743 /* Internal function: Callback for signal key-press-event on the line input
 744 GtkEntry in a text grid window. */
 745 gboolean
 746 on_input_entry_key_press_event(GtkEntry *input_entry, GdkEventKey *event, winid_t win)
 747 {
 748         if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up
 749                 || event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
 750         {
 751                 /* Prevent falling off the end of the history list */
 752                 if( (event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
 753                         && win->history_pos && win->history_pos->next == NULL)
 754                         return TRUE;
 755                 if( (event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
 756                         && (win->history_pos == NULL || win->history_pos->prev == NULL) )
 757                         return TRUE;
 758
 759                 if(win->history_pos == NULL)
 760                 {
 761                         const gchar *current_input = gtk_entry_get_text(input_entry);
 762                         win->history = g_list_prepend(win->history, g_strdup(current_input));
 763                         win->history_pos = win->history;
 764                 }
 765
 766                 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
 767                 {
 768                         if(win->history_pos)
 769                                 win->history_pos = g_list_next(win->history_pos);
 770                         else
 771                                 win->history_pos = win->history;
 772                 }
 773                 else /* down */
 774                         win->history_pos = g_list_previous(win->history_pos);
 775
 776                 /* Insert the history item into the window */
 777                 g_signal_handler_block(input_entry, win->line_input_entry_changed);
 778                 gtk_entry_set_text(input_entry, win->history_pos->data);
 779                 g_signal_handler_unblock(input_entry, win->line_input_entry_changed);
 780                 return TRUE;
 781         }
 782         return FALSE;
 783 }
 784
 785 void
 786 on_input_entry_changed(GtkEditable *editable, winid_t win)
 787 {
 788         /* Set the history position to NULL and erase the text we were already editing */
 789         if(win->history_pos != NULL)
 790         {
 791                 g_free(win->history->data);
 792                 win->history = g_list_delete_link(win->history, win->history);
 793                 win->history_pos = NULL;
 794         }
 795 }
 796
 797 glui32
 798 keyval_to_glk_keycode(guint keyval, gboolean unicode)
 799 {
 800         glui32 keycode;
 801         switch(keyval) {
 802                 case GDK_Up:
 803                 case GDK_KP_Up: return keycode_Up;
 804                 case GDK_Down:
 805                 case GDK_KP_Down: return keycode_Down;
 806                 case GDK_Left:
 807                 case GDK_KP_Left: return keycode_Left;
 808                 case GDK_Right:
 809                 case GDK_KP_Right: return keycode_Right;
 810                 case GDK_Linefeed:
 811                 case GDK_Return:
 812                 case GDK_KP_Enter: return keycode_Return;
 813                 case GDK_Delete:
 814                 case GDK_BackSpace:
 815                 case GDK_KP_Delete: return keycode_Delete;
 816                 case GDK_Escape: return keycode_Escape;
 817                 case GDK_Tab:
 818                 case GDK_KP_Tab: return keycode_Tab;
 819                 case GDK_Page_Up:
 820                 case GDK_KP_Page_Up: return keycode_PageUp;
 821                 case GDK_Page_Down:
 822                 case GDK_KP_Page_Down: return keycode_PageDown;
 823                 case GDK_Home:
 824                 case GDK_KP_Home: return keycode_Home;
 825                 case GDK_End:
 826                 case GDK_KP_End: return keycode_End;
 827                 case GDK_F1:
 828                 case GDK_KP_F1: return keycode_Func1;
 829                 case GDK_F2:
 830                 case GDK_KP_F2: return keycode_Func2;
 831                 case GDK_F3:
 832                 case GDK_KP_F3: return keycode_Func3;
 833                 case GDK_F4:
 834                 case GDK_KP_F4: return keycode_Func4;
 835                 case GDK_F5: return keycode_Func5;
 836                 case GDK_F6: return keycode_Func6;
 837                 case GDK_F7: return keycode_Func7;
 838                 case GDK_F8: return keycode_Func8;
 839                 case GDK_F9: return keycode_Func9;
 840                 case GDK_F10: return keycode_Func10;
 841                 case GDK_F11: return keycode_Func11;
 842                 case GDK_F12: return keycode_Func12;
 843                 default:
 844                         keycode = gdk_keyval_to_unicode(keyval);
 845                         /* If keycode is 0, then keyval was not recognized; also return
 846                         unknown if Latin-1 input was requested and the character is not in
 847                         Latin-1 */
 848                         if(keycode == 0 || (!unicode && keycode > 255))
 849                                 return keycode_Unknown;
 850                         return keycode;
 851         }
 852 }
 853
 854 void
 855 force_char_input_from_queue(winid_t win, event_t *event)
 856 {
 857         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
 858         guint keyval = GPOINTER_TO_UINT(g_async_queue_pop(glk_data->char_input_queue));
 859
 860         glk_cancel_char_event(win);
 861
 862         gdk_threads_enter();
 863         ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
 864         g_assert(glk);
 865         g_signal_emit_by_name(glk, "char-input", win->rock, keyval);
 866         gdk_threads_leave();
 867
 868         event->type = evtype_CharInput;
 869         event->win = win;
 870         event->val1 = keyval_to_glk_keycode(keyval, win->input_request_type == INPUT_REQUEST_CHARACTER_UNICODE);
 871         event->val2 = 0;
 872 }
 873
 874 void
 875 force_line_input_from_queue(winid_t win, event_t *event)
 876 {
 877         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
 878         const gchar *text = g_async_queue_pop(glk_data->line_input_queue);
 879         glui32 chars_written = 0;
 880
 881         gdk_threads_enter();
 882         if(win->type == wintype_TextBuffer)
 883         {
 884                 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
 885                 GtkTextIter start, end;
 886
 887                 /* Remove signal handlers so the line input doesn't get picked up again */
 888                 g_signal_handler_block(buffer, win->insert_text_handler);
 889                 g_signal_handler_block(win->widget, win->line_input_keypress_handler);
 890
 891                 /* Erase any text that was already typed */
 892                 GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
 893                 gtk_text_buffer_get_iter_at_mark(buffer, &start, input_position);
 894                 gtk_text_buffer_get_end_iter(buffer, &end);
 895                 gtk_text_buffer_delete(buffer, &start, &end);
 896
 897                 /* Make the window uneditable again */
 898                 gtk_text_view_set_editable(GTK_TEXT_VIEW(win->widget), FALSE);
 899
 900                 /* Insert the forced input into the window */
 901                 gtk_text_buffer_get_end_iter(buffer, &end);
 902                 gchar *text_to_insert = g_strconcat(text, "\n", NULL);
 903                 gtk_text_buffer_insert_with_tags_by_name(buffer, &end, text_to_insert, -1, "input", NULL);
 904                 chars_written = finish_text_buffer_line_input(win, TRUE);
 905         }
 906         else if(win->type == wintype_TextGrid)
 907         {
 908                 /* Remove signal handlers so the line input doesn't get picked up again */
 909                 g_signal_handler_block(win->widget, win->char_input_keypress_handler);
 910
 911                 /* Insert the forced input into the window */
 912                 gtk_entry_set_text(GTK_ENTRY(win->input_entry), text);
 913                 chars_written = finish_text_grid_line_input(win, TRUE);
 914         }
 915         gdk_threads_leave();
 916
 917         event->type = evtype_LineInput;
 918         event->win = win;
 919         event->val1 = chars_written;
 920         event->val2 = 0;
 921 }
 922
 923 /*** Internal function: cancels any pending input requests on the window and presents a warning if not INPUT_REQUEST_NONE ***/
 924 void
 925 cancel_old_input_request(winid_t win)
 926 {
 927         switch(win->input_request_type) {
 928         case INPUT_REQUEST_NONE:
 929                 break; /* All is well */
 930         case INPUT_REQUEST_CHARACTER:
 931         case INPUT_REQUEST_CHARACTER_UNICODE:
 932                 glk_cancel_char_event(win);
 933                 WARNING("Cancelling pending char event");
 934                 break;
 935         case INPUT_REQUEST_LINE:
 936         case INPUT_REQUEST_LINE_UNICODE:
 937                 glk_cancel_line_event(win, NULL);
 938                 WARNING("Cancelling pending line event");
 939                 break;
 940         default:
 941                 WARNING("Could not cancel pending input request: unknown input request");
 942         }
 943 }