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