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