libchimara/input.c

   1 #include "charset.h"
   2 #include "magic.h"
   3 #include "input.h"
   4 #include "chimara-glk-private.h"
   5
   6 extern GPrivate *glk_data_key;
   7
   8 /* Forward declarations */
   9 static int finish_text_buffer_line_input(winid_t win, gboolean emit_signal);
  10 static int finish_text_grid_line_input(winid_t win, gboolean emit_signal);
  11 static void cancel_old_input_request(winid_t win);
  12
  13 /* Internal function: code common to both flavors of char event request */
  14 void
  15 request_char_event_common(winid_t win, gboolean unicode)
  16 {
  17         VALID_WINDOW(win, return);
  18         g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
  19
  20         cancel_old_input_request(win);
  21
  22         flush_window_buffer(win);
  23
  24         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
  25
  26         win->input_request_type = unicode? INPUT_REQUEST_CHARACTER_UNICODE : INPUT_REQUEST_CHARACTER;
  27         g_signal_handler_unblock( win->widget, win->char_input_keypress_handler );
  28
  29         gdk_threads_enter();
  30
  31         /*
  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->type != wintype_TextBuffer || win->type != wintype_TextGrid);
 243         g_return_if_fail(initlen <= maxlen);
 244
 245         cancel_old_input_request(win);
 246
 247         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
 248
 249         /* Register the buffer */
 250         if(glk_data->register_arr)
 251         win->buffer_rock = (*glk_data->register_arr)(buf, maxlen, "&+#!Cn");
 252
 253         win->input_request_type = INPUT_REQUEST_LINE;
 254         win->line_input_buffer = buf;
 255         win->line_input_buffer_max_len = maxlen;
 256
 257         gchar *inserttext = (initlen > 0)? g_strndup(buf, initlen) : g_strdup("");
 258         switch(win->type)
 259         {
 260             case wintype_TextBuffer:
 261                 text_buffer_request_line_event_common(win, maxlen, (initlen > 0), inserttext);
 262                 break;
 263             case wintype_TextGrid:
 264                 text_grid_request_line_event_common(win, maxlen, (initlen > 0), inserttext);
 265                 break;
 266     }
 267         g_free(inserttext);
 268         g_signal_handler_unblock(win->widget, win->line_input_keypress_handler);
 269
 270         /* Emit the "waiting" signal to let listeners know we are ready for input */
 271         g_signal_emit_by_name(glk_data->self, "waiting");
 272 }
 273
 274 /**
 275  * glk_request_line_event_uni:
 276  * @win: A text buffer or text grid window to request line input on.
 277  * @buf: A buffer of at least @maxlen characters.
 278  * @maxlen: Length of the buffer.
 279  * @initlen: The number of characters in @buf to pre-enter.
 280  *
 281  * Request input of a line of Unicode characters. This works the same as
 282  * glk_request_line_event(), except the result is stored in an array of
 283  * <type>glui32</type> values instead of an array of characters, and the values
 284  * may be any valid Unicode code points.
 285  *
 286  * The result will be in Unicode Normalization Form C. This basically means that
 287  * composite characters will be single characters where possible, instead of
 288  * sequences of base and combining marks. See
 289  * <ulink url="http://www.unicode.org/reports/tr15/">Unicode Standard Annex
 290  * #15</ulink> for the details.
 291  */
 292 void
 293 glk_request_line_event_uni(winid_t win, glui32 *buf, glui32 maxlen, glui32 initlen)
 294 {
 295         VALID_WINDOW(win, return);
 296         g_return_if_fail(buf);
 297         g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
 298         g_return_if_fail(initlen <= maxlen);
 299
 300         cancel_old_input_request(win);
 301         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
 302
 303         /* Register the buffer */
 304         if(glk_data->register_arr)
 305         win->buffer_rock = (*glk_data->register_arr)(buf, maxlen, "&+#!Iu");
 306
 307         win->input_request_type = INPUT_REQUEST_LINE_UNICODE;
 308         win->line_input_buffer_unicode = buf;
 309         win->line_input_buffer_max_len = maxlen;
 310
 311         gchar *utf8;
 312         if(initlen > 0) {
 313                 utf8 = convert_ucs4_to_utf8(buf, initlen);
 314                 if(utf8 == NULL)
 315                         return;
 316         }
 317         else
 318                 utf8 = g_strdup("");
 319
 320     switch(win->type)
 321         {
 322             case wintype_TextBuffer:
 323                 text_buffer_request_line_event_common(win, maxlen, (initlen > 0), utf8);
 324                 break;
 325             case wintype_TextGrid:
 326                 text_grid_request_line_event_common(win, maxlen, (initlen > 0), utf8);
 327                 break;
 328     }
 329     g_signal_handler_unblock(win->widget, win->line_input_keypress_handler);
 330         g_free(utf8);
 331
 332         /* Emit the "waiting" signal to let listeners know we are ready for input */
 333         g_signal_emit_by_name(glk_data->self, "waiting");
 334 }
 335
 336 /**
 337  * glk_cancel_line_event:
 338  * @win: A text buffer or text grid window to cancel line input on.
 339  * @event: Will be filled in if the user had already input something.
 340  *
 341  * This cancels a pending request for line input. (Either Latin-1 or Unicode.)
 342  *
 343  * The event pointed to by the event argument will be filled in as if the
 344  * player had hit <keycap>enter</keycap>, and the input composed so far will be
 345  * stored in the buffer; see below. If you do not care about this information,
 346  * pass %NULL as the @event argument. (The buffer will still be filled.)
 347  *
 348  * For convenience, it is legal to call glk_cancel_line_event() even if there
 349  * is no line input request on that window. The event type will be set to
 350  * %evtype_None in this case.
 351  */
 352 void
 353 glk_cancel_line_event(winid_t win, event_t *event)
 354 {
 355         VALID_WINDOW(win, return);
 356         g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
 357
 358         if(event != NULL) {
 359                 event->type = evtype_None;
 360                 event->win = win;
 361                 event->val1 = 0;
 362                 event->val2 = 0;
 363         }
 364
 365         if(win->input_request_type != INPUT_REQUEST_LINE && win->input_request_type != INPUT_REQUEST_LINE_UNICODE)
 366                 return;
 367
 368         g_signal_handler_block( win->widget, win->line_input_keypress_handler );
 369
 370         int chars_written = 0;
 371
 372         gdk_threads_enter();
 373         if(win->type == wintype_TextGrid) {
 374                 chars_written = finish_text_grid_line_input(win, FALSE);
 375         } else if(win->type == wintype_TextBuffer) {
 376                 gtk_text_view_set_editable( GTK_TEXT_VIEW(win->widget), FALSE );
 377                 GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
 378                 g_signal_handler_block(window_buffer, win->insert_text_handler);
 379                 chars_written = finish_text_buffer_line_input(win, FALSE);
 380         }
 381         gdk_threads_leave();
 382
 383         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
 384         if(glk_data->unregister_arr)
 385         {
 386                 if(win->input_request_type == INPUT_REQUEST_LINE_UNICODE)
 387                         (*glk_data->unregister_arr)(win->line_input_buffer_unicode, win->line_input_buffer_max_len, "&+#!Iu", win->buffer_rock);
 388                 else
 389                 (*glk_data->unregister_arr)(win->line_input_buffer, win->line_input_buffer_max_len, "&+#!Cn", win->buffer_rock);
 390     }
 391
 392         if(event != NULL && chars_written > 0) {
 393                 event->type = evtype_LineInput;
 394                 event->val1 = chars_written;
 395         }
 396 }
 397
 398 /* Helper function: Turn off shutdown key-press-event signal handler */
 399 static gboolean
 400 turn_off_handler(GNode *node)
 401 {
 402         winid_t win = node->data;
 403         g_signal_handler_block(win->widget, win->shutdown_keypress_handler);
 404         return FALSE; /* don't stop */
 405 }
 406
 407 /* Internal function: Callback for signal key-press-event while waiting for shutdown. */
 408 gboolean
 409 on_shutdown_key_press_event(GtkWidget *widget, GdkEventKey *event, winid_t win)
 410 {
 411         ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(widget, CHIMARA_TYPE_GLK));
 412         g_assert(glk);
 413         CHIMARA_GLK_USE_PRIVATE(glk, priv);
 414
 415         /* Turn off all the signal handlers */
 416         if(priv->root_window)
 417                 g_node_traverse(priv->root_window, G_IN_ORDER, G_TRAVERSE_LEAVES, -1, (GNodeTraverseFunc)turn_off_handler, NULL);
 418
 419         /* Signal the Glk library that it can shut everything down now */
 420         g_mutex_lock(priv->shutdown_lock);
 421         g_cond_signal(priv->shutdown_key_pressed);
 422         g_mutex_unlock(priv->shutdown_lock);
 423
 424         return TRUE; /* block the event */
 425 }
 426
 427 /* 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. */
 428 gboolean
 429 on_char_input_key_press_event(GtkWidget *widget, GdkEventKey *event, winid_t win)
 430 {
 431         glui32 keycode = keyval_to_glk_keycode(event->keyval, win->input_request_type == INPUT_REQUEST_CHARACTER_UNICODE);
 432
 433         ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(widget, CHIMARA_TYPE_GLK));
 434         g_assert(glk);
 435         event_throw(glk, evtype_CharInput, win, keycode, 0);
 436         g_signal_emit_by_name(glk, "char-input", win->rock, event->keyval);
 437
 438         /* Only one keypress will be handled */
 439         win->input_request_type = INPUT_REQUEST_NONE;
 440         g_signal_handler_block(win->widget, win->char_input_keypress_handler);
 441
 442         return TRUE;
 443 }
 444
 445 gboolean
 446 on_line_input_key_press_event(GtkWidget *widget, GdkEventKey *event, winid_t win)
 447 {
 448         switch(win->type)
 449         {
 450                 case wintype_TextBuffer:
 451
 452                         /* History up/down */
 453                         if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up
 454                                 || event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
 455                         {
 456                                 /* Prevent falling off the end of the history list */
 457                                 if(win->history == NULL)
 458                                         return TRUE;
 459                                 if( (event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
 460                                         && win->history_pos && win->history_pos->next == NULL)
 461                                         return TRUE;
 462                                 if( (event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
 463                                         && (win->history_pos == NULL || win->history_pos->prev == NULL) )
 464                                         return TRUE;
 465
 466                                 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
 467                                 GtkTextIter start, end;
 468                                 /* Erase any text that was already typed */
 469                                 GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
 470                                 gtk_text_buffer_get_iter_at_mark(buffer, &start, input_position);
 471                                 gtk_text_buffer_get_end_iter(buffer, &end);
 472
 473                                 if(win->history_pos == NULL) {
 474                                         gchar *current_input = gtk_text_buffer_get_text(buffer, &start, &end, FALSE);
 475                                         win->history = g_list_prepend(win->history, current_input);
 476                                         win->history_pos = win->history;
 477                                 }
 478
 479                                 gtk_text_buffer_delete(buffer, &start, &end);
 480
 481                                 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
 482                                 {
 483                                         if(win->history_pos)
 484                                                 win->history_pos = g_list_next(win->history_pos);
 485                                         else
 486                                                 win->history_pos = win->history;
 487                                 }
 488                                 else /* down */
 489                                         win->history_pos = g_list_previous(win->history_pos);
 490
 491                                 /* Insert the history item into the window */
 492                                 gtk_text_buffer_get_end_iter(buffer, &end);
 493
 494                                 g_signal_handler_block(buffer, win->insert_text_handler);
 495                                 gtk_text_buffer_insert_with_tags_by_name(buffer, &end, win->history_pos->data, -1, "input", NULL);
 496                                 g_signal_handler_unblock(buffer, win->insert_text_handler);
 497                                 return TRUE;
 498                         }
 499
 500                         /* Move to beginning/end of input field */
 501                         else if(event->keyval == GDK_Home) {
 502                                 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
 503                                 GtkTextIter input_iter;
 504                                 GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
 505                                 gtk_text_buffer_get_iter_at_mark(buffer, &input_iter, input_position);
 506                                 gtk_text_buffer_place_cursor(buffer, &input_iter);
 507                                 return TRUE;
 508                         }
 509                         else if(event->keyval == GDK_End) {
 510                                 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
 511                                 GtkTextIter end_iter;
 512                                 gtk_text_buffer_get_end_iter(buffer, &end_iter);
 513                                 gtk_text_buffer_place_cursor(buffer, &end_iter);
 514                                 return TRUE;
 515                         }
 516
 517                         /* Handle the enter key, which could occur in the middle of the sentence. */
 518                         else if(event->keyval == GDK_Return || event->keyval == GDK_KP_Enter) {
 519                                 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
 520                                 GtkTextIter end_iter;
 521                                 gtk_text_buffer_get_end_iter(buffer, &end_iter);
 522                                 gtk_text_buffer_place_cursor(buffer, &end_iter);
 523                                 return FALSE;
 524                         }
 525
 526                         return FALSE;
 527
 528                 /* If this is a text grid window, then redirect the key press to the line input GtkEntry */
 529                 case wintype_TextGrid:
 530                 {
 531                         if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up
 532                                 || event->keyval == GDK_Down || event->keyval == GDK_KP_Down
 533                                 || event->keyval == GDK_Left || event->keyval == GDK_KP_Left
 534                                 || event->keyval == GDK_Right || event->keyval == GDK_KP_Right
 535                                 || event->keyval == GDK_Tab || event->keyval == GDK_KP_Tab
 536                                 || event->keyval == GDK_Page_Up || event->keyval == GDK_KP_Page_Up
 537                                 || event->keyval == GDK_Page_Down || event->keyval == GDK_KP_Page_Down
 538                                 || event->keyval == GDK_Home || event->keyval == GDK_KP_Home
 539                                 || event->keyval == GDK_End || event->keyval == GDK_KP_End)
 540                                 return FALSE; /* Don't redirect these keys */
 541                         gtk_widget_grab_focus(win->input_entry);
 542                         gtk_editable_set_position(GTK_EDITABLE(win->input_entry), -1);
 543                         gboolean retval = TRUE;
 544                         g_signal_emit_by_name(win->input_entry, "key-press-event", event, &retval);
 545                         return retval; /* Block this key event if the entry handled it */
 546                 }
 547         }
 548         return FALSE;
 549 }
 550
 551 /* Internal function: finish handling a line input request, for both text grid and text buffer windows. */
 552 static int
 553 write_to_window_buffer(winid_t win, const gchar *inserted_text)
 554 {
 555         int copycount = 0;
 556
 557     /* Convert the string from UTF-8 to Latin-1 or Unicode */
 558     if(win->input_request_type == INPUT_REQUEST_LINE)
 559     {
 560         gsize bytes_written;
 561         gchar *latin1 = convert_utf8_to_latin1(inserted_text, &bytes_written);
 562
 563         if(latin1 == NULL)
 564             return 0;
 565
 566         /* Place input in the echo stream */
 567         if(win->echo_stream != NULL)
 568             glk_put_string_stream(win->echo_stream, latin1);
 569
 570         /* Copy the string (bytes_written does not include the NULL at the end) */
 571         copycount = MIN(win->line_input_buffer_max_len, bytes_written);
 572         memcpy(win->line_input_buffer, latin1, copycount);
 573         g_free(latin1);
 574     }
 575     else if(win->input_request_type == INPUT_REQUEST_LINE_UNICODE)
 576     {
 577         glong items_written;
 578         gunichar *unicode = convert_utf8_to_ucs4(inserted_text, &items_written);
 579
 580         if(unicode == NULL)
 581             return 0;
 582
 583         /* Place input in the echo stream */
 584         if(win->echo_stream != NULL)
 585             glk_put_string_stream_uni(win->echo_stream, unicode);
 586
 587         /* Copy the string (but not the NULL at the end) */
 588         copycount = MIN(win->line_input_buffer_max_len, items_written);
 589         memcpy(win->line_input_buffer_unicode, unicode, copycount * sizeof(gunichar));
 590         g_free(unicode);
 591     }
 592     else
 593         WARNING("Wrong input request type");
 594
 595     win->input_request_type = INPUT_REQUEST_NONE;
 596         return copycount;
 597 }
 598
 599 /* Internal function: Retrieves the input of a TextBuffer window and stores it in the window buffer.
 600  * Returns the number of characters written, suitable for inclusion in a line input event. */
 601 static int
 602 finish_text_buffer_line_input(winid_t win, gboolean emit_signal)
 603 {
 604         VALID_WINDOW(win, return 0);
 605         g_return_val_if_fail(win->type == wintype_TextBuffer, 0);
 606
 607         GtkTextIter start_iter, end_iter, last_character;
 608
 609         GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
 610         GtkTextMark *input_position = gtk_text_buffer_get_mark(window_buffer, "input_position");
 611         gtk_text_buffer_get_iter_at_mark(window_buffer, &start_iter, input_position);
 612         gtk_text_buffer_get_end_iter(window_buffer, &end_iter);
 613         gtk_text_buffer_get_end_iter(window_buffer, &last_character);
 614         gtk_text_iter_backward_cursor_position(&last_character);
 615
 616         gchar* last_char = gtk_text_buffer_get_text(window_buffer, &last_character, &end_iter, FALSE);
 617
 618         if( strchr(last_char, '\n') != NULL )
 619                 gtk_text_iter_backward_cursor_position(&end_iter);
 620
 621         gchar* inserted_text = gtk_text_buffer_get_text(window_buffer, &start_iter, &end_iter, FALSE);
 622
 623         int chars_written = write_to_window_buffer(win, inserted_text);
 624         if(emit_signal)
 625         {
 626                 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
 627                 g_assert(glk);
 628                 g_signal_emit_by_name(glk, "line-input", win->rock, inserted_text);
 629         }
 630
 631         /* Add the text to the window input history */
 632         if(win->history_pos != NULL)
 633         {
 634                 g_free(win->history->data);
 635                 win->history = g_list_delete_link(win->history, win->history);
 636         }
 637         if(*inserted_text != 0)
 638                 win->history = g_list_prepend(win->history, g_strdup(inserted_text));
 639
 640         win->history_pos = NULL;
 641
 642         g_free(inserted_text);
 643
 644         return chars_written;
 645 }
 646
 647 /* Internal function: Retrieves the input of a TextGrid window and stores it in the window buffer.
 648  * Returns the number of characters written, suitable for inclusion in a line input event. */
 649 static int
 650 finish_text_grid_line_input(winid_t win, gboolean emit_signal)
 651 {
 652         VALID_WINDOW(win, return 0);
 653         g_return_val_if_fail(win->type == wintype_TextGrid, 0);
 654
 655         GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
 656
 657         gchar *text = g_strdup( gtk_entry_get_text(GTK_ENTRY(win->input_entry)) );
 658         /* Move the focus back into the text view */
 659         gtk_widget_grab_focus(win->widget);
 660         /* Remove entry widget from text view */
 661         /* Should be ok even though this is the widget's own signal handler */
 662         gtk_container_remove( GTK_CONTAINER(win->widget), GTK_WIDGET(win->input_entry) );
 663         win->input_entry = NULL;
 664         /* Delete the child anchor */
 665         GtkTextIter start, end;
 666         gtk_text_buffer_get_iter_at_child_anchor(buffer, &start, win->input_anchor);
 667         end = start;
 668         gtk_text_iter_forward_char(&end); /* Point after the child anchor */
 669         gtk_text_buffer_delete(buffer, &start, &end);
 670         win->input_anchor = NULL;
 671
 672     gchar *spaces = g_strnfill(win->input_length - g_utf8_strlen(text, -1), ' ');
 673     gchar *text_to_insert = g_strconcat(text, spaces, NULL);
 674         g_free(spaces);
 675     gtk_text_buffer_insert(buffer, &start, text_to_insert, -1);
 676     g_free(text_to_insert);
 677
 678     int chars_written = write_to_window_buffer(win, text);
 679     if(emit_signal)
 680     {
 681                 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
 682                 g_assert(glk);
 683                 g_signal_emit_by_name(glk, "line-input", win->rock, text);
 684     }
 685
 686         /* Add the text to the window input history */
 687         if(win->history_pos != NULL)
 688         {
 689                 g_free(win->history->data);
 690                 win->history = g_list_delete_link(win->history, win->history);
 691         }
 692         if(*text != 0)
 693                 win->history = g_list_prepend(win->history, g_strdup(text));
 694         win->history_pos = NULL;
 695
 696         g_free(text);
 697         return chars_written;
 698 }
 699
 700 /* Internal function: Callback for signal insert-text on a text buffer window.
 701 Runs after the default handler has already inserted the text.
 702 FIXME: This function assumes that newline was the last character typed into the
 703 window. That assumption is wrong if, for example, text containing a newline was
 704 pasted into the window. */
 705 void
 706 after_window_insert_text(GtkTextBuffer *textbuffer, GtkTextIter *location, gchar *text, gint len, winid_t win)
 707 {
 708         GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
 709
 710         /* Set the history position to NULL and erase the text we were already editing */
 711         if(win->history_pos != NULL)
 712         {
 713                 g_free(win->history->data);
 714                 win->history = g_list_delete_link(win->history, win->history);
 715                 win->history_pos = NULL;
 716         }
 717         if( strchr(text, '\n') != NULL )
 718         {
 719                 /* Remove signal handlers */
 720                 g_signal_handler_block(window_buffer, win->insert_text_handler);
 721                 g_signal_handler_block(win->widget, win->line_input_keypress_handler);
 722
 723                 /* Make the window uneditable again and retrieve the text that was input */
 724         gtk_text_view_set_editable(GTK_TEXT_VIEW(win->widget), FALSE);
 725
 726         int chars_written = finish_text_buffer_line_input(win, TRUE);
 727         ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
 728                 event_throw(glk, evtype_LineInput, win, chars_written, 0);
 729         }
 730
 731         /* Apply the 'input' style to the text that was entered */
 732         GtkTextIter end_iter;
 733         gtk_text_buffer_get_end_iter(window_buffer, &end_iter);
 734         GtkTextIter input_iter;
 735         GtkTextMark *input_position = gtk_text_buffer_get_mark(window_buffer, "input_position");
 736         gtk_text_buffer_get_iter_at_mark(window_buffer, &input_iter, input_position);
 737         gtk_text_buffer_apply_tag_by_name(window_buffer, "input", &input_iter, &end_iter);
 738 }
 739
 740 /* Internal function: Callback for signal activate on the line input GtkEntry
 741 in a text grid window. */
 742 void
 743 on_input_entry_activate(GtkEntry *input_entry, winid_t win)
 744 {
 745         g_signal_handler_block(win->widget, win->line_input_keypress_handler);
 746
 747         int chars_written = finish_text_grid_line_input(win, TRUE);
 748         ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
 749         event_throw(glk, evtype_LineInput, win, chars_written, 0);
 750 }
 751
 752 /* Internal function: Callback for signal key-press-event on the line input
 753 GtkEntry in a text grid window. */
 754 gboolean
 755 on_input_entry_key_press_event(GtkEntry *input_entry, GdkEventKey *event, winid_t win)
 756 {
 757         if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up
 758                 || event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
 759         {
 760                 /* Prevent falling off the end of the history list */
 761                 if( (event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
 762                         && win->history_pos && win->history_pos->next == NULL)
 763                         return TRUE;
 764                 if( (event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
 765                         && (win->history_pos == NULL || win->history_pos->prev == NULL) )
 766                         return TRUE;
 767
 768                 if(win->history_pos == NULL)
 769                 {
 770                         const gchar *current_input = gtk_entry_get_text(input_entry);
 771                         win->history = g_list_prepend(win->history, g_strdup(current_input));
 772                         win->history_pos = win->history;
 773                 }
 774
 775                 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
 776                 {
 777                         if(win->history_pos)
 778                                 win->history_pos = g_list_next(win->history_pos);
 779                         else
 780                                 win->history_pos = win->history;
 781                 }
 782                 else /* down */
 783                         win->history_pos = g_list_previous(win->history_pos);
 784
 785                 /* Insert the history item into the window */
 786                 g_signal_handler_block(input_entry, win->line_input_entry_changed);
 787                 gtk_entry_set_text(input_entry, win->history_pos->data);
 788                 g_signal_handler_unblock(input_entry, win->line_input_entry_changed);
 789                 return TRUE;
 790         }
 791         return FALSE;
 792 }
 793
 794 void
 795 on_input_entry_changed(GtkEditable *editable, winid_t win)
 796 {
 797         /* Set the history position to NULL and erase the text we were already editing */
 798         if(win->history_pos != NULL)
 799         {
 800                 g_free(win->history->data);
 801                 win->history = g_list_delete_link(win->history, win->history);
 802                 win->history_pos = NULL;
 803         }
 804 }
 805
 806 glui32
 807 keyval_to_glk_keycode(guint keyval, gboolean unicode)
 808 {
 809         glui32 keycode;
 810         switch(keyval) {
 811                 case GDK_Up:
 812                 case GDK_KP_Up: return keycode_Up;
 813                 case GDK_Down:
 814                 case GDK_KP_Down: return keycode_Down;
 815                 case GDK_Left:
 816                 case GDK_KP_Left: return keycode_Left;
 817                 case GDK_Right:
 818                 case GDK_KP_Right: return keycode_Right;
 819                 case GDK_Linefeed:
 820                 case GDK_Return:
 821                 case GDK_KP_Enter: return keycode_Return;
 822                 case GDK_Delete:
 823                 case GDK_BackSpace:
 824                 case GDK_KP_Delete: return keycode_Delete;
 825                 case GDK_Escape: return keycode_Escape;
 826                 case GDK_Tab:
 827                 case GDK_KP_Tab: return keycode_Tab;
 828                 case GDK_Page_Up:
 829                 case GDK_KP_Page_Up: return keycode_PageUp;
 830                 case GDK_Page_Down:
 831                 case GDK_KP_Page_Down: return keycode_PageDown;
 832                 case GDK_Home:
 833                 case GDK_KP_Home: return keycode_Home;
 834                 case GDK_End:
 835                 case GDK_KP_End: return keycode_End;
 836                 case GDK_F1:
 837                 case GDK_KP_F1: return keycode_Func1;
 838                 case GDK_F2:
 839                 case GDK_KP_F2: return keycode_Func2;
 840                 case GDK_F3:
 841                 case GDK_KP_F3: return keycode_Func3;
 842                 case GDK_F4:
 843                 case GDK_KP_F4: return keycode_Func4;
 844                 case GDK_F5: return keycode_Func5;
 845                 case GDK_F6: return keycode_Func6;
 846                 case GDK_F7: return keycode_Func7;
 847                 case GDK_F8: return keycode_Func8;
 848                 case GDK_F9: return keycode_Func9;
 849                 case GDK_F10: return keycode_Func10;
 850                 case GDK_F11: return keycode_Func11;
 851                 case GDK_F12: return keycode_Func12;
 852                 default:
 853                         keycode = gdk_keyval_to_unicode(keyval);
 854                         /* If keycode is 0, then keyval was not recognized; also return
 855                         unknown if Latin-1 input was requested and the character is not in
 856                         Latin-1 */
 857                         if(keycode == 0 || (!unicode && keycode > 255))
 858                                 return keycode_Unknown;
 859                         return keycode;
 860         }
 861 }
 862
 863 void
 864 force_char_input_from_queue(winid_t win, event_t *event)
 865 {
 866         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
 867         guint keyval = GPOINTER_TO_UINT(g_async_queue_pop(glk_data->char_input_queue));
 868
 869         glk_cancel_char_event(win);
 870
 871         gdk_threads_enter();
 872         ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
 873         g_assert(glk);
 874         g_signal_emit_by_name(glk, "char-input", win->rock, keyval);
 875         gdk_threads_leave();
 876
 877         event->type = evtype_CharInput;
 878         event->win = win;
 879         event->val1 = keyval_to_glk_keycode(keyval, win->input_request_type == INPUT_REQUEST_CHARACTER_UNICODE);
 880         event->val2 = 0;
 881 }
 882
 883 void
 884 force_line_input_from_queue(winid_t win, event_t *event)
 885 {
 886         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
 887         const gchar *text = g_async_queue_pop(glk_data->line_input_queue);
 888         glui32 chars_written = 0;
 889
 890         gdk_threads_enter();
 891         if(win->type == wintype_TextBuffer)
 892         {
 893                 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
 894                 GtkTextIter start, end;
 895
 896                 /* Remove signal handlers so the line input doesn't get picked up again */
 897                 g_signal_handler_block(buffer, win->insert_text_handler);
 898                 g_signal_handler_block(win->widget, win->line_input_keypress_handler);
 899
 900                 /* Erase any text that was already typed */
 901                 GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
 902                 gtk_text_buffer_get_iter_at_mark(buffer, &start, input_position);
 903                 gtk_text_buffer_get_end_iter(buffer, &end);
 904                 gtk_text_buffer_delete(buffer, &start, &end);
 905
 906                 /* Make the window uneditable again */
 907                 gtk_text_view_set_editable(GTK_TEXT_VIEW(win->widget), FALSE);
 908
 909                 /* Insert the forced input into the window */
 910                 gtk_text_buffer_get_end_iter(buffer, &end);
 911                 gchar *text_to_insert = g_strconcat(text, "\n", NULL);
 912                 gtk_text_buffer_insert_with_tags_by_name(buffer, &end, text_to_insert, -1, "input", NULL);
 913                 chars_written = finish_text_buffer_line_input(win, TRUE);
 914         }
 915         else if(win->type == wintype_TextGrid)
 916         {
 917                 /* Remove signal handlers so the line input doesn't get picked up again */
 918                 g_signal_handler_block(win->widget, win->char_input_keypress_handler);
 919
 920                 /* Insert the forced input into the window */
 921                 gtk_entry_set_text(GTK_ENTRY(win->input_entry), text);
 922                 chars_written = finish_text_grid_line_input(win, TRUE);
 923         }
 924         gdk_threads_leave();
 925
 926         event->type = evtype_LineInput;
 927         event->win = win;
 928         event->val1 = chars_written;
 929         event->val2 = 0;
 930 }
 931
 932 /*** Internal function: cancels any pending input requests on the window and presents a warning if not INPUT_REQUEST_NONE ***/
 933 void
 934 cancel_old_input_request(winid_t win)
 935 {
 936         switch(win->input_request_type) {
 937         case INPUT_REQUEST_NONE:
 938                 break; /* All is well */
 939         case INPUT_REQUEST_CHARACTER:
 940         case INPUT_REQUEST_CHARACTER_UNICODE:
 941                 glk_cancel_char_event(win);
 942                 WARNING("Cancelling pending char event");
 943                 break;
 944         case INPUT_REQUEST_LINE:
 945         case INPUT_REQUEST_LINE_UNICODE:
 946                 glk_cancel_line_event(win, NULL);
 947                 WARNING("Cancelling pending line event");
 948                 break;
 949         default:
 950                 WARNING("Could not cancel pending input request: unknown input request");
 951         }
 952 }