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         gdk_threads_enter();
 372         if(win->type == wintype_TextGrid) {
 373                 chars_written = finish_text_grid_line_input(win, FALSE);
 374         } else if(win->type == wintype_TextBuffer) {
 375                 gtk_text_view_set_editable( GTK_TEXT_VIEW(win->widget), FALSE );
 376                 GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
 377                 g_signal_handler_block(window_buffer, win->insert_text_handler);
 378                 chars_written = finish_text_buffer_line_input(win, FALSE);
 379         }
 380         gdk_threads_leave();
 381
 382         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
 383         if(glk_data->unregister_arr)
 384         {
 385                 if(win->input_request_type == INPUT_REQUEST_LINE_UNICODE)
 386                         (*glk_data->unregister_arr)(win->line_input_buffer_unicode, win->line_input_buffer_max_len, "&+#!Iu", win->buffer_rock);
 387                 else
 388                 (*glk_data->unregister_arr)(win->line_input_buffer, win->line_input_buffer_max_len, "&+#!Cn", win->buffer_rock);
 389     }
 390
 391         if(event != NULL && chars_written > 0) {
 392                 event->type = evtype_LineInput;
 393                 event->val1 = chars_written;
 394         }
 395 }
 396
 397 /* Helper function: Turn off shutdown key-press-event signal handler */
 398 static gboolean
 399 turn_off_handler(GNode *node)
 400 {
 401         winid_t win = node->data;
 402         g_signal_handler_block(win->widget, win->shutdown_keypress_handler);
 403         return FALSE; /* don't stop */
 404 }
 405
 406 /* Internal function: Callback for signal key-press-event while waiting for shutdown. */
 407 gboolean
 408 on_shutdown_key_press_event(GtkWidget *widget, GdkEventKey *event, winid_t win)
 409 {
 410         ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(widget, CHIMARA_TYPE_GLK));
 411         g_assert(glk);
 412         CHIMARA_GLK_USE_PRIVATE(glk, priv);
 413
 414         /* Turn off all the signal handlers */
 415         if(priv->root_window)
 416                 g_node_traverse(priv->root_window, G_IN_ORDER, G_TRAVERSE_LEAVES, -1, (GNodeTraverseFunc)turn_off_handler, NULL);
 417
 418         /* Signal the Glk library that it can shut everything down now */
 419         g_mutex_lock(priv->shutdown_lock);
 420         g_cond_signal(priv->shutdown_key_pressed);
 421         g_mutex_unlock(priv->shutdown_lock);
 422
 423         return TRUE; /* block the event */
 424 }
 425
 426 /* 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. */
 427 gboolean
 428 on_char_input_key_press_event(GtkWidget *widget, GdkEventKey *event, winid_t win)
 429 {
 430         glui32 keycode = keyval_to_glk_keycode(event->keyval, win->input_request_type == INPUT_REQUEST_CHARACTER_UNICODE);
 431
 432         ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(widget, CHIMARA_TYPE_GLK));
 433         g_assert(glk);
 434         event_throw(glk, evtype_CharInput, win, keycode, 0);
 435         g_signal_emit_by_name(glk, "char-input", win->rock, event->keyval);
 436
 437         /* Only one keypress will be handled */
 438         win->input_request_type = INPUT_REQUEST_NONE;
 439         g_signal_handler_block( win->widget, win->char_input_keypress_handler );
 440
 441         return TRUE;
 442 }
 443
 444 gboolean
 445 on_line_input_key_press_event(GtkWidget *widget, GdkEventKey *event, winid_t win)
 446 {
 447         switch(win->type)
 448         {
 449                 case wintype_TextBuffer:
 450                         if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up
 451                                 || event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
 452                         {
 453                                 /* Prevent falling off the end of the history list */
 454                                 if( (event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
 455                                         && win->history_pos && win->history_pos->next == NULL)
 456                                         return TRUE;
 457                                 if( (event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
 458                                         && (win->history_pos == NULL || win->history_pos->prev == NULL) )
 459                                         return TRUE;
 460
 461                                 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
 462                                 GtkTextIter start, end;
 463                                 /* Erase any text that was already typed */
 464                                 GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
 465                                 gtk_text_buffer_get_iter_at_mark(buffer, &start, input_position);
 466                                 gtk_text_buffer_get_end_iter(buffer, &end);
 467
 468                                 if(win->history_pos == NULL) {
 469                                         gchar *current_input = gtk_text_buffer_get_text(buffer, &start, &end, FALSE);
 470                                         win->history = g_list_prepend(win->history, current_input);
 471                                         win->history_pos = win->history;
 472                                 }
 473
 474                                 gtk_text_buffer_delete(buffer, &start, &end);
 475
 476                                 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
 477                                 {
 478                                         if(win->history_pos)
 479                                                 win->history_pos = g_list_next(win->history_pos);
 480                                         else
 481                                                 win->history_pos = win->history;
 482                                 }
 483                                 else /* down */
 484                                         win->history_pos = g_list_previous(win->history_pos);
 485
 486                                 /* Insert the history item into the window */
 487                                 gtk_text_buffer_get_end_iter(buffer, &end);
 488
 489                                 g_signal_handler_block(buffer, win->insert_text_handler);
 490                                 gtk_text_buffer_insert_with_tags_by_name(buffer, &end, win->history_pos->data, -1, "input", NULL);
 491                                 g_signal_handler_unblock(buffer, win->insert_text_handler);
 492                                 return TRUE;
 493                         }
 494                         return FALSE;
 495
 496                 /* If this is a text grid window, then redirect the key press to the line input GtkEntry */
 497                 case wintype_TextGrid:
 498                 {
 499                         if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up
 500                                 || event->keyval == GDK_Down || event->keyval == GDK_KP_Down
 501                                 || event->keyval == GDK_Left || event->keyval == GDK_KP_Left
 502                                 || event->keyval == GDK_Right || event->keyval == GDK_KP_Right
 503                                 || event->keyval == GDK_Tab || event->keyval == GDK_KP_Tab
 504                                 || event->keyval == GDK_Page_Up || event->keyval == GDK_KP_Page_Up
 505                                 || event->keyval == GDK_Page_Down || event->keyval == GDK_KP_Page_Down
 506                                 || event->keyval == GDK_Home || event->keyval == GDK_KP_Home
 507                                 || event->keyval == GDK_End || event->keyval == GDK_KP_End)
 508                                 return FALSE; /* Don't redirect these keys */
 509                         gtk_widget_grab_focus(win->input_entry);
 510                         gtk_editable_set_position(GTK_EDITABLE(win->input_entry), -1);
 511                         gboolean retval = TRUE;
 512                         g_signal_emit_by_name(win->input_entry, "key-press-event", event, &retval);
 513                         return retval; /* Block this key event if the entry handled it */
 514                 }
 515         }
 516         return FALSE;
 517 }
 518
 519 /* Internal function: finish handling a line input request, for both text grid and text buffer windows. */
 520 static int
 521 write_to_window_buffer(winid_t win, const gchar *inserted_text)
 522 {
 523         int copycount = 0;
 524
 525     /* Convert the string from UTF-8 to Latin-1 or Unicode */
 526     if(win->input_request_type == INPUT_REQUEST_LINE)
 527     {
 528         gsize bytes_written;
 529         gchar *latin1 = convert_utf8_to_latin1(inserted_text, &bytes_written);
 530
 531         if(latin1 == NULL)
 532             return 0;
 533
 534         /* Place input in the echo stream */
 535         if(win->echo_stream != NULL)
 536             glk_put_string_stream(win->echo_stream, latin1);
 537
 538         /* Copy the string (bytes_written does not include the NULL at the end) */
 539         copycount = MIN(win->line_input_buffer_max_len, bytes_written);
 540         memcpy(win->line_input_buffer, latin1, copycount);
 541         g_free(latin1);
 542     }
 543     else if(win->input_request_type == INPUT_REQUEST_LINE_UNICODE)
 544     {
 545         glong items_written;
 546         gunichar *unicode = convert_utf8_to_ucs4(inserted_text, &items_written);
 547
 548         if(unicode == NULL)
 549             return 0;
 550
 551         /* Place input in the echo stream */
 552         if(win->echo_stream != NULL)
 553             glk_put_string_stream_uni(win->echo_stream, unicode);
 554
 555         /* Copy the string (but not the NULL at the end) */
 556         copycount = MIN(win->line_input_buffer_max_len, items_written);
 557         memcpy(win->line_input_buffer_unicode, unicode, copycount * sizeof(gunichar));
 558         g_free(unicode);
 559     }
 560     else
 561         WARNING("Wrong input request type");
 562
 563     win->input_request_type = INPUT_REQUEST_NONE;
 564         return copycount;
 565 }
 566
 567 /* Internal function: Retrieves the input of a TextBuffer window and stores it in the window buffer.
 568  * Returns the number of characters written, suitable for inclusion in a line input event. */
 569 static int
 570 finish_text_buffer_line_input(winid_t win, gboolean emit_signal)
 571 {
 572         VALID_WINDOW(win, return 0);
 573         g_return_val_if_fail(win->type == wintype_TextBuffer, 0);
 574
 575         GtkTextIter start_iter, end_iter, last_character;
 576
 577         GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
 578         GtkTextMark *input_position = gtk_text_buffer_get_mark(window_buffer, "input_position");
 579         gtk_text_buffer_get_iter_at_mark(window_buffer, &start_iter, input_position);
 580         gtk_text_buffer_get_end_iter(window_buffer, &end_iter);
 581         gtk_text_buffer_get_end_iter(window_buffer, &last_character);
 582         gtk_text_iter_backward_cursor_position(&last_character);
 583
 584         gchar* last_char = gtk_text_buffer_get_text(window_buffer, &last_character, &end_iter, FALSE);
 585
 586         if( strchr(last_char, '\n') != NULL )
 587                 gtk_text_iter_backward_cursor_position(&end_iter);
 588
 589         gchar* inserted_text = gtk_text_buffer_get_text(window_buffer, &start_iter, &end_iter, FALSE);
 590
 591         int chars_written = write_to_window_buffer(win, inserted_text);
 592         if(emit_signal)
 593         {
 594                 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
 595                 g_assert(glk);
 596                 g_signal_emit_by_name(glk, "line-input", win->rock, inserted_text);
 597         }
 598
 599         /* Add the text to the window input history */
 600         if(win->history_pos != NULL)
 601         {
 602                 g_free(win->history->data);
 603                 win->history = g_list_delete_link(win->history, win->history);
 604         }
 605         if(*inserted_text != 0)
 606                 win->history = g_list_prepend(win->history, g_strdup(inserted_text));
 607
 608         win->history_pos = NULL;
 609
 610         g_free(inserted_text);
 611
 612         return chars_written;
 613 }
 614
 615 /* Internal function: Retrieves the input of a TextGrid window and stores it in the window buffer.
 616  * Returns the number of characters written, suitable for inclusion in a line input event. */
 617 static int
 618 finish_text_grid_line_input(winid_t win, gboolean emit_signal)
 619 {
 620         VALID_WINDOW(win, return 0);
 621         g_return_val_if_fail(win->type == wintype_TextGrid, 0);
 622
 623         GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
 624
 625         gchar *text = g_strdup( gtk_entry_get_text(GTK_ENTRY(win->input_entry)) );
 626         /* Move the focus back into the text view */
 627         gtk_widget_grab_focus(win->widget);
 628         /* Remove entry widget from text view */
 629         /* Should be ok even though this is the widget's own signal handler */
 630         gtk_container_remove( GTK_CONTAINER(win->widget), GTK_WIDGET(win->input_entry) );
 631         win->input_entry = NULL;
 632         /* Delete the child anchor */
 633         GtkTextIter start, end;
 634         gtk_text_buffer_get_iter_at_child_anchor(buffer, &start, win->input_anchor);
 635         end = start;
 636         gtk_text_iter_forward_char(&end); /* Point after the child anchor */
 637         gtk_text_buffer_delete(buffer, &start, &end);
 638         win->input_anchor = NULL;
 639
 640     gchar *spaces = g_strnfill(win->input_length - g_utf8_strlen(text, -1), ' ');
 641     gchar *text_to_insert = g_strconcat(text, spaces, NULL);
 642         g_free(spaces);
 643     gtk_text_buffer_insert(buffer, &start, text_to_insert, -1);
 644     g_free(text_to_insert);
 645
 646     int chars_written = write_to_window_buffer(win, text);
 647     if(emit_signal)
 648     {
 649                 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
 650                 g_assert(glk);
 651                 g_signal_emit_by_name(glk, "line-input", win->rock, text);
 652     }
 653
 654         /* Add the text to the window input history */
 655         if(win->history_pos != NULL)
 656         {
 657                 g_free(win->history->data);
 658                 win->history = g_list_delete_link(win->history, win->history);
 659         }
 660         if(*text != 0)
 661                 win->history = g_list_prepend(win->history, g_strdup(text));
 662         win->history_pos = NULL;
 663
 664         g_free(text);
 665         return chars_written;
 666 }
 667
 668 /* Internal function: Callback for signal insert-text on a text buffer window.
 669 Runs after the default handler has already inserted the text.
 670 FIXME: This function assumes that newline was the last character typed into the
 671 window. That assumption is wrong if, for example, text containing a newline was
 672 pasted into the window. */
 673 void
 674 after_window_insert_text(GtkTextBuffer *textbuffer, GtkTextIter *location, gchar *text, gint len, winid_t win)
 675 {
 676         GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
 677
 678         /* Set the history position to NULL and erase the text we were already editing */
 679         if(win->history_pos != NULL)
 680         {
 681                 g_free(win->history->data);
 682                 win->history = g_list_delete_link(win->history, win->history);
 683                 win->history_pos = NULL;
 684         }
 685         if( strchr(text, '\n') != NULL )
 686         {
 687                 /* Remove signal handlers */
 688                 g_signal_handler_block(window_buffer, win->insert_text_handler);
 689                 g_signal_handler_block(win->widget, win->line_input_keypress_handler);
 690
 691                 /* Make the window uneditable again and retrieve the text that was input */
 692         gtk_text_view_set_editable(GTK_TEXT_VIEW(win->widget), FALSE);
 693
 694         int chars_written = finish_text_buffer_line_input(win, TRUE);
 695         ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
 696                 event_throw(glk, evtype_LineInput, win, chars_written, 0);
 697         }
 698
 699         /* Apply the 'input' style to the text that was entered */
 700         GtkTextIter end_iter;
 701         gtk_text_buffer_get_end_iter(window_buffer, &end_iter);
 702         GtkTextIter input_iter;
 703         GtkTextMark *input_position = gtk_text_buffer_get_mark(window_buffer, "input_position");
 704         gtk_text_buffer_get_iter_at_mark(window_buffer, &input_iter, input_position);
 705         gtk_text_buffer_apply_tag_by_name(window_buffer, "input", &input_iter, &end_iter);
 706 }
 707
 708 /* Internal function: Callback for signal activate on the line input GtkEntry
 709 in a text grid window. */
 710 void
 711 on_input_entry_activate(GtkEntry *input_entry, winid_t win)
 712 {
 713         g_signal_handler_block(win->widget, win->line_input_keypress_handler);
 714
 715         int chars_written = finish_text_grid_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 /* Internal function: Callback for signal key-press-event on the line input
 721 GtkEntry in a text grid window. */
 722 gboolean
 723 on_input_entry_key_press_event(GtkEntry *input_entry, GdkEventKey *event, winid_t win)
 724 {
 725         if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up
 726                 || event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
 727         {
 728                 /* Prevent falling off the end of the history list */
 729                 if( (event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
 730                         && win->history_pos && win->history_pos->next == NULL)
 731                         return TRUE;
 732                 if( (event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
 733                         && (win->history_pos == NULL || win->history_pos->prev == NULL) )
 734                         return TRUE;
 735
 736                 if(win->history_pos == NULL)
 737                 {
 738                         const gchar *current_input = gtk_entry_get_text(input_entry);
 739                         win->history = g_list_prepend(win->history, g_strdup(current_input));
 740                         win->history_pos = win->history;
 741                 }
 742
 743                 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
 744                 {
 745                         if(win->history_pos)
 746                                 win->history_pos = g_list_next(win->history_pos);
 747                         else
 748                                 win->history_pos = win->history;
 749                 }
 750                 else /* down */
 751                         win->history_pos = g_list_previous(win->history_pos);
 752
 753                 /* Insert the history item into the window */
 754                 g_signal_handler_block(input_entry, win->line_input_entry_changed);
 755                 gtk_entry_set_text(input_entry, win->history_pos->data);
 756                 g_signal_handler_unblock(input_entry, win->line_input_entry_changed);
 757                 return TRUE;
 758         }
 759         return FALSE;
 760 }
 761
 762 void
 763 on_input_entry_changed(GtkEditable *editable, winid_t win)
 764 {
 765         /* Set the history position to NULL and erase the text we were already editing */
 766         if(win->history_pos != NULL)
 767         {
 768                 g_free(win->history->data);
 769                 win->history = g_list_delete_link(win->history, win->history);
 770                 win->history_pos = NULL;
 771         }
 772 }
 773
 774 glui32
 775 keyval_to_glk_keycode(guint keyval, gboolean unicode)
 776 {
 777         glui32 keycode;
 778         switch(keyval) {
 779                 case GDK_Up:
 780                 case GDK_KP_Up: return keycode_Up;
 781                 case GDK_Down:
 782                 case GDK_KP_Down: return keycode_Down;
 783                 case GDK_Left:
 784                 case GDK_KP_Left: return keycode_Left;
 785                 case GDK_Right:
 786                 case GDK_KP_Right: return keycode_Right;
 787                 case GDK_Linefeed:
 788                 case GDK_Return:
 789                 case GDK_KP_Enter: return keycode_Return;
 790                 case GDK_Delete:
 791                 case GDK_BackSpace:
 792                 case GDK_KP_Delete: return keycode_Delete;
 793                 case GDK_Escape: return keycode_Escape;
 794                 case GDK_Tab:
 795                 case GDK_KP_Tab: return keycode_Tab;
 796                 case GDK_Page_Up:
 797                 case GDK_KP_Page_Up: return keycode_PageUp;
 798                 case GDK_Page_Down:
 799                 case GDK_KP_Page_Down: return keycode_PageDown;
 800                 case GDK_Home:
 801                 case GDK_KP_Home: return keycode_Home;
 802                 case GDK_End:
 803                 case GDK_KP_End: return keycode_End;
 804                 case GDK_F1:
 805                 case GDK_KP_F1: return keycode_Func1;
 806                 case GDK_F2:
 807                 case GDK_KP_F2: return keycode_Func2;
 808                 case GDK_F3:
 809                 case GDK_KP_F3: return keycode_Func3;
 810                 case GDK_F4:
 811                 case GDK_KP_F4: return keycode_Func4;
 812                 case GDK_F5: return keycode_Func5;
 813                 case GDK_F6: return keycode_Func6;
 814                 case GDK_F7: return keycode_Func7;
 815                 case GDK_F8: return keycode_Func8;
 816                 case GDK_F9: return keycode_Func9;
 817                 case GDK_F10: return keycode_Func10;
 818                 case GDK_F11: return keycode_Func11;
 819                 case GDK_F12: return keycode_Func12;
 820                 default:
 821                         keycode = gdk_keyval_to_unicode(keyval);
 822                         /* If keycode is 0, then keyval was not recognized; also return
 823                         unknown if Latin-1 input was requested and the character is not in
 824                         Latin-1 */
 825                         if(keycode == 0 || (!unicode && keycode > 255))
 826                                 return keycode_Unknown;
 827                         return keycode;
 828         }
 829 }
 830
 831 void
 832 force_char_input_from_queue(winid_t win, event_t *event)
 833 {
 834         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
 835         guint keyval = GPOINTER_TO_UINT(g_async_queue_pop(glk_data->char_input_queue));
 836
 837         glk_cancel_char_event(win);
 838
 839         gdk_threads_enter();
 840         ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
 841         g_assert(glk);
 842         g_signal_emit_by_name(glk, "char-input", win->rock, keyval);
 843         gdk_threads_leave();
 844
 845         event->type = evtype_CharInput;
 846         event->win = win;
 847         event->val1 = keyval_to_glk_keycode(keyval, win->input_request_type == INPUT_REQUEST_CHARACTER_UNICODE);
 848         event->val2 = 0;
 849 }
 850
 851 void
 852 force_line_input_from_queue(winid_t win, event_t *event)
 853 {
 854         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
 855         const gchar *text = g_async_queue_pop(glk_data->line_input_queue);
 856         glui32 chars_written = 0;
 857
 858         gdk_threads_enter();
 859         if(win->type == wintype_TextBuffer)
 860         {
 861                 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
 862                 GtkTextIter start, end;
 863
 864                 /* Remove signal handlers so the line input doesn't get picked up again */
 865                 g_signal_handler_block(buffer, win->insert_text_handler);
 866                 g_signal_handler_block(win->widget, win->line_input_keypress_handler);
 867
 868                 /* Erase any text that was already typed */
 869                 GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
 870                 gtk_text_buffer_get_iter_at_mark(buffer, &start, input_position);
 871                 gtk_text_buffer_get_end_iter(buffer, &end);
 872                 gtk_text_buffer_delete(buffer, &start, &end);
 873
 874                 /* Make the window uneditable again */
 875                 gtk_text_view_set_editable(GTK_TEXT_VIEW(win->widget), FALSE);
 876
 877                 /* Insert the forced input into the window */
 878                 gtk_text_buffer_get_end_iter(buffer, &end);
 879                 gchar *text_to_insert = g_strconcat(text, "\n", NULL);
 880                 gtk_text_buffer_insert_with_tags_by_name(buffer, &end, text_to_insert, -1, "input", NULL);
 881                 chars_written = finish_text_buffer_line_input(win, TRUE);
 882         }
 883         else if(win->type == wintype_TextGrid)
 884         {
 885                 /* Remove signal handlers so the line input doesn't get picked up again */
 886                 g_signal_handler_block(win->widget, win->char_input_keypress_handler);
 887
 888                 /* Insert the forced input into the window */
 889                 gtk_entry_set_text(GTK_ENTRY(win->input_entry), text);
 890                 chars_written = finish_text_grid_line_input(win, TRUE);
 891         }
 892         gdk_threads_leave();
 893
 894         event->type = evtype_LineInput;
 895         event->win = win;
 896         event->val1 = chars_written;
 897         event->val2 = 0;
 898 }