4 #include "chimara-glk-private.h"
6 extern GPrivate *glk_data_key;
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);
13 /* Internal function: code common to both flavors of char event request */
15 request_char_event_common(winid_t win, gboolean unicode)
17 VALID_WINDOW(win, return);
18 g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
20 cancel_old_input_request(win);
22 flush_window_buffer(win);
24 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
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 );
30 gtk_widget_grab_focus( GTK_WIDGET(win->widget) );
33 /* Emit the "waiting" signal to let listeners know we are ready for input */
34 g_signal_emit_by_name(glk_data->self, "waiting");
38 * glk_request_char_event:
39 * @win: A window to request char events from.
41 * Request input of a Latin-1 character or special key. A window cannot have
42 * requests for both character and line input at the same time. Nor can it have
43 * requests for character input of both types (Latin-1 and Unicode). It is
44 * illegal to call glk_request_char_event() if the window already has a pending
45 * request for either character or line input.
48 glk_request_char_event(winid_t win)
50 request_char_event_common(win, FALSE);
54 * glk_request_char_event_uni:
55 * @win: A window to request char events from.
57 * Request input of a Unicode character or special key. See
58 * glk_request_char_event().
61 glk_request_char_event_uni(winid_t win)
63 request_char_event_common(win, TRUE);
67 * glk_cancel_char_event:
68 * @win: A window to cancel the latest char event request on.
70 * This cancels a pending request for character input. (Either Latin-1 or
71 * Unicode.) For convenience, it is legal to call glk_cancel_char_event() even
72 * if there is no charcter input request on that window. Glk will ignore the
76 glk_cancel_char_event(winid_t win)
78 VALID_WINDOW(win, return);
79 g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
81 if(win->input_request_type == INPUT_REQUEST_CHARACTER || win->input_request_type == INPUT_REQUEST_CHARACTER_UNICODE)
83 win->input_request_type = INPUT_REQUEST_NONE;
84 g_signal_handler_block( win->widget, win->char_input_keypress_handler );
88 /* Internal function: Request either latin-1 or unicode line input, in a text grid window. */
90 text_grid_request_line_event_common(winid_t win, glui32 maxlen, gboolean insert, gchar *inserttext)
94 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
96 GtkTextMark *cursor = gtk_text_buffer_get_mark(buffer, "cursor_position");
97 GtkTextIter start_iter, end_iter;
98 gtk_text_buffer_get_iter_at_mark(buffer, &start_iter, cursor);
100 /* Determine the maximum length of the line input */
101 gint cursorpos = gtk_text_iter_get_line_offset(&start_iter);
102 /* Odd; the Glk spec says the maximum input length is
103 windowwidth - 1 - cursorposition. I say no, because if cursorposition is
104 zero, then the input should fill the whole line. FIXME??? */
105 win->input_length = MIN(win->width - cursorpos, win->line_input_buffer_max_len);
106 end_iter = start_iter;
107 gtk_text_iter_set_line_offset(&end_iter, cursorpos + win->input_length);
109 /* If the buffer currently has a selection with one bound in the middle of
110 the input field, then deselect it. Otherwise the input field gets trashed */
111 GtkTextIter start_sel, end_sel;
112 if( gtk_text_buffer_get_selection_bounds(buffer, &start_sel, &end_sel) )
114 if( gtk_text_iter_in_range(&start_sel, &start_iter, &end_iter) )
115 gtk_text_buffer_place_cursor(buffer, &end_sel);
116 if( gtk_text_iter_in_range(&end_sel, &start_iter, &end_iter) )
117 gtk_text_buffer_place_cursor(buffer, &start_sel);
120 /* Erase the text currently in the input field and replace it with a GtkEntry */
121 gtk_text_buffer_delete(buffer, &start_iter, &end_iter);
122 win->input_anchor = gtk_text_buffer_create_child_anchor(buffer, &start_iter);
123 win->input_entry = gtk_entry_new();
124 /* Set the entry's font to match that of the window */
125 GtkRcStyle *style = gtk_widget_get_modifier_style(win->widget); /* Don't free */
126 gtk_widget_modify_font(win->input_entry, style->font_desc);
127 /* Make the entry as small as possible to fit with the text */
128 gtk_entry_set_has_frame(GTK_ENTRY(win->input_entry), FALSE);
129 GtkBorder border = { 0, 0, 0, 0 };
132 #if GTK_CHECK_VERSION(2,10,0)
133 gtk_entry_set_inner_border(GTK_ENTRY(win->input_entry), &border);
135 gtk_entry_set_max_length(GTK_ENTRY(win->input_entry), win->input_length);
136 gtk_entry_set_width_chars(GTK_ENTRY(win->input_entry), win->input_length);
138 /* Insert pre-entered text if needed */
140 gtk_entry_set_text(GTK_ENTRY(win->input_entry), inserttext);
142 /* Set background color of entry (TODO: implement as property) */
144 gdk_color_parse("grey", &background);
145 gtk_widget_modify_base(win->input_entry, GTK_STATE_NORMAL, &background);
147 g_signal_connect(win->input_entry, "activate", G_CALLBACK(on_input_entry_activate), win);
148 g_signal_connect(win->input_entry, "key-press-event", G_CALLBACK(on_input_entry_key_press_event), win);
149 win->line_input_entry_changed = g_signal_connect(win->input_entry, "changed", G_CALLBACK(on_input_entry_changed), win);
151 gtk_widget_show(win->input_entry);
152 gtk_text_view_add_child_at_anchor(GTK_TEXT_VIEW(win->widget), win->input_entry, win->input_anchor);
154 gtk_widget_grab_focus(win->input_entry);
159 /* Internal function: Request either latin-1 or unicode line input, in a text buffer window. */
161 text_buffer_request_line_event_common(winid_t win, glui32 maxlen, gboolean insert, gchar *inserttext)
163 flush_window_buffer(win);
167 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
169 /* Move the input_position mark to the end of the window_buffer */
170 GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
171 GtkTextIter end_iter;
172 gtk_text_buffer_get_end_iter(buffer, &end_iter);
173 gtk_text_buffer_move_mark(buffer, input_position, &end_iter);
175 /* Set the entire contents of the window_buffer as uneditable
176 * (so input can only be entered at the end) */
177 GtkTextIter start_iter;
178 gtk_text_buffer_get_start_iter(buffer, &start_iter);
179 gtk_text_buffer_remove_tag_by_name(buffer, "uneditable", &start_iter, &end_iter);
180 gtk_text_buffer_apply_tag_by_name(buffer, "uneditable", &start_iter, &end_iter);
182 /* Insert pre-entered text if needed */
184 gtk_text_buffer_insert(buffer, &end_iter, inserttext, -1);
185 gtk_text_buffer_get_end_iter(buffer, &end_iter); /* update after text insertion */
188 /* Apply the correct style to the input prompt */
189 GtkTextIter input_iter;
190 gtk_text_buffer_get_iter_at_mark(buffer, &input_iter, input_position);
191 gtk_text_buffer_apply_tag_by_name(buffer, "input", &input_iter, &end_iter);
193 gtk_text_view_set_editable(GTK_TEXT_VIEW(win->widget), TRUE);
195 g_signal_handler_unblock(buffer, win->insert_text_handler);
196 gtk_widget_grab_focus(win->widget);
202 * glk_request_line_event:
203 * @win: A text buffer or text grid window to request line input on.
204 * @buf: A buffer of at least @maxlen bytes.
205 * @maxlen: Length of the buffer.
206 * @initlen: The number of characters in @buf to pre-enter.
208 * Requests input of a line of Latin-1 characters. A window cannot have requests
209 * for both character and line input at the same time. Nor can it have requests
210 * for line input of both types (Latin-1 and Unicode). It is illegal to call
211 * glk_request_line_event() if the window already has a pending request for
212 * either character or line input.
214 * The @buf argument is a pointer to space where the line input will be stored.
215 * (This may not be %NULL.) @maxlen is the length of this space, in bytes; the
216 * library will not accept more characters than this. If @initlen is nonzero,
217 * then the first @initlen bytes of @buf will be entered as pre-existing input
218 * — just as if the player had typed them himself. (The player can continue
219 * composing after this pre-entered input, or delete it or edit as usual.)
221 * The contents of the buffer are undefined until the input is completed (either
222 * by a line input event, or glk_cancel_line_event(). The library may or may not
223 * fill in the buffer as the player composes, while the input is still pending;
224 * it is illegal to change the contents of the buffer yourself.
227 glk_request_line_event(winid_t win, char *buf, glui32 maxlen, glui32 initlen)
229 VALID_WINDOW(win, return);
230 g_return_if_fail(buf);
231 g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
232 g_return_if_fail(initlen <= maxlen);
234 cancel_old_input_request(win);
236 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
238 /* Register the buffer */
239 if(glk_data->register_arr)
240 win->buffer_rock = (*glk_data->register_arr)(buf, maxlen, "&+#!Cn");
242 win->input_request_type = INPUT_REQUEST_LINE;
243 win->line_input_buffer = buf;
244 win->line_input_buffer_max_len = maxlen;
246 gchar *inserttext = (initlen > 0)? g_strndup(buf, initlen) : g_strdup("");
249 case wintype_TextBuffer:
250 text_buffer_request_line_event_common(win, maxlen, (initlen > 0), inserttext);
252 case wintype_TextGrid:
253 text_grid_request_line_event_common(win, maxlen, (initlen > 0), inserttext);
257 g_signal_handler_unblock(win->widget, win->line_input_keypress_handler);
259 /* Emit the "waiting" signal to let listeners know we are ready for input */
260 g_signal_emit_by_name(glk_data->self, "waiting");
264 * glk_request_line_event_uni:
265 * @win: A text buffer or text grid window to request line input on.
266 * @buf: A buffer of at least @maxlen characters.
267 * @maxlen: Length of the buffer.
268 * @initlen: The number of characters in @buf to pre-enter.
270 * Request input of a line of Unicode characters. This works the same as
271 * glk_request_line_event(), except the result is stored in an array of
272 * <type>glui32</type> values instead of an array of characters, and the values
273 * may be any valid Unicode code points.
275 * The result will be in Unicode Normalization Form C. This basically means that
276 * composite characters will be single characters where possible, instead of
277 * sequences of base and combining marks. See
278 * <ulink url="http://www.unicode.org/reports/tr15/">Unicode Standard Annex
279 * #15</ulink> for the details.
282 glk_request_line_event_uni(winid_t win, glui32 *buf, glui32 maxlen, glui32 initlen)
284 VALID_WINDOW(win, return);
285 g_return_if_fail(buf);
286 g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
287 g_return_if_fail(initlen <= maxlen);
289 cancel_old_input_request(win);
290 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
292 /* Register the buffer */
293 if(glk_data->register_arr)
294 win->buffer_rock = (*glk_data->register_arr)(buf, maxlen, "&+#!Iu");
296 win->input_request_type = INPUT_REQUEST_LINE_UNICODE;
297 win->line_input_buffer_unicode = buf;
298 win->line_input_buffer_max_len = maxlen;
302 utf8 = convert_ucs4_to_utf8(buf, initlen);
311 case wintype_TextBuffer:
312 text_buffer_request_line_event_common(win, maxlen, (initlen > 0), utf8);
314 case wintype_TextGrid:
315 text_grid_request_line_event_common(win, maxlen, (initlen > 0), utf8);
318 g_signal_handler_unblock(win->widget, win->line_input_keypress_handler);
321 /* Emit the "waiting" signal to let listeners know we are ready for input */
322 g_signal_emit_by_name(glk_data->self, "waiting");
326 * glk_cancel_line_event:
327 * @win: A text buffer or text grid window to cancel line input on.
328 * @event: Will be filled in if the user had already input something.
330 * This cancels a pending request for line input. (Either Latin-1 or Unicode.)
332 * The event pointed to by the event argument will be filled in as if the
333 * player had hit <keycap>enter</keycap>, and the input composed so far will be
334 * stored in the buffer; see below. If you do not care about this information,
335 * pass %NULL as the @event argument. (The buffer will still be filled.)
337 * For convenience, it is legal to call glk_cancel_line_event() even if there
338 * is no line input request on that window. The event type will be set to
339 * %evtype_None in this case.
342 glk_cancel_line_event(winid_t win, event_t *event)
344 VALID_WINDOW(win, return);
345 g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
348 event->type = evtype_None;
354 if(win->input_request_type != INPUT_REQUEST_LINE && win->input_request_type != INPUT_REQUEST_LINE_UNICODE)
357 g_signal_handler_block( win->widget, win->line_input_keypress_handler );
359 int chars_written = 0;
362 if(win->type == wintype_TextGrid) {
363 chars_written = finish_text_grid_line_input(win, FALSE);
364 } else if(win->type == wintype_TextBuffer) {
365 gtk_text_view_set_editable( GTK_TEXT_VIEW(win->widget), FALSE );
366 GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
367 g_signal_handler_block(window_buffer, win->insert_text_handler);
368 chars_written = finish_text_buffer_line_input(win, FALSE);
372 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
373 if(glk_data->unregister_arr)
375 if(win->input_request_type == INPUT_REQUEST_LINE_UNICODE)
376 (*glk_data->unregister_arr)(win->line_input_buffer_unicode, win->line_input_buffer_max_len, "&+#!Iu", win->buffer_rock);
378 (*glk_data->unregister_arr)(win->line_input_buffer, win->line_input_buffer_max_len, "&+#!Cn", win->buffer_rock);
381 if(event != NULL && chars_written > 0) {
382 event->type = evtype_LineInput;
383 event->val1 = chars_written;
387 /* Helper function: Turn off shutdown key-press-event signal handler */
389 turn_off_handler(GNode *node)
391 winid_t win = node->data;
392 g_signal_handler_block(win->widget, win->shutdown_keypress_handler);
393 return FALSE; /* don't stop */
396 /* Internal function: Callback for signal key-press-event while waiting for shutdown. */
398 on_shutdown_key_press_event(GtkWidget *widget, GdkEventKey *event, winid_t win)
400 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(widget, CHIMARA_TYPE_GLK));
402 CHIMARA_GLK_USE_PRIVATE(glk, priv);
404 /* Turn off all the signal handlers */
405 if(priv->root_window)
406 g_node_traverse(priv->root_window, G_IN_ORDER, G_TRAVERSE_LEAVES, -1, (GNodeTraverseFunc)turn_off_handler, NULL);
408 /* Signal the Glk library that it can shut everything down now */
409 g_mutex_lock(priv->shutdown_lock);
410 g_cond_signal(priv->shutdown_key_pressed);
411 g_mutex_unlock(priv->shutdown_lock);
413 return TRUE; /* block the event */
416 /* Internal function: General callback for signal key-press-event on a text buffer or text grid window. Used in character input on both text buffers and grids. Blocked when not in use. */
418 on_char_input_key_press_event(GtkWidget *widget, GdkEventKey *event, winid_t win)
420 glui32 keycode = keyval_to_glk_keycode(event->keyval, win->input_request_type == INPUT_REQUEST_CHARACTER_UNICODE);
422 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(widget, CHIMARA_TYPE_GLK));
424 event_throw(glk, evtype_CharInput, win, keycode, 0);
425 g_signal_emit_by_name(glk, "char-input", win->rock, event->keyval);
427 /* Only one keypress will be handled */
428 win->input_request_type = INPUT_REQUEST_NONE;
429 g_signal_handler_block(win->widget, win->char_input_keypress_handler);
435 on_line_input_key_press_event(GtkWidget *widget, GdkEventKey *event, winid_t win)
439 case wintype_TextBuffer:
441 /* History up/down */
442 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up
443 || event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
445 /* Prevent falling off the end of the history list */
446 if(win->history == NULL)
448 if( (event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
449 && win->history_pos && win->history_pos->next == NULL)
451 if( (event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
452 && (win->history_pos == NULL || win->history_pos->prev == NULL) )
455 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
456 GtkTextIter start, end;
457 /* Erase any text that was already typed */
458 GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
459 gtk_text_buffer_get_iter_at_mark(buffer, &start, input_position);
460 gtk_text_buffer_get_end_iter(buffer, &end);
462 if(win->history_pos == NULL) {
463 gchar *current_input = gtk_text_buffer_get_text(buffer, &start, &end, FALSE);
464 win->history = g_list_prepend(win->history, current_input);
465 win->history_pos = win->history;
468 gtk_text_buffer_delete(buffer, &start, &end);
470 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
473 win->history_pos = g_list_next(win->history_pos);
475 win->history_pos = win->history;
478 win->history_pos = g_list_previous(win->history_pos);
480 /* Insert the history item into the window */
481 gtk_text_buffer_get_end_iter(buffer, &end);
483 g_signal_handler_block(buffer, win->insert_text_handler);
484 gtk_text_buffer_insert_with_tags_by_name(buffer, &end, win->history_pos->data, -1, "input", NULL);
485 g_signal_handler_unblock(buffer, win->insert_text_handler);
489 /* Move to beginning/end of input field */
490 else if(event->keyval == GDK_Home) {
491 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
492 GtkTextIter input_iter;
493 GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
494 gtk_text_buffer_get_iter_at_mark(buffer, &input_iter, input_position);
495 gtk_text_buffer_place_cursor(buffer, &input_iter);
498 else if(event->keyval == GDK_End) {
499 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
500 GtkTextIter end_iter;
501 gtk_text_buffer_get_end_iter(buffer, &end_iter);
502 gtk_text_buffer_place_cursor(buffer, &end_iter);
506 /* Handle the enter key, which could occur in the middle of the sentence. */
507 else if(event->keyval == GDK_Return || event->keyval == GDK_KP_Enter) {
508 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
509 GtkTextIter end_iter;
510 gtk_text_buffer_get_end_iter(buffer, &end_iter);
511 gtk_text_buffer_place_cursor(buffer, &end_iter);
517 /* If this is a text grid window, then redirect the key press to the line input GtkEntry */
518 case wintype_TextGrid:
520 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up
521 || event->keyval == GDK_Down || event->keyval == GDK_KP_Down
522 || event->keyval == GDK_Left || event->keyval == GDK_KP_Left
523 || event->keyval == GDK_Right || event->keyval == GDK_KP_Right
524 || event->keyval == GDK_Tab || event->keyval == GDK_KP_Tab
525 || event->keyval == GDK_Page_Up || event->keyval == GDK_KP_Page_Up
526 || event->keyval == GDK_Page_Down || event->keyval == GDK_KP_Page_Down
527 || event->keyval == GDK_Home || event->keyval == GDK_KP_Home
528 || event->keyval == GDK_End || event->keyval == GDK_KP_End)
529 return FALSE; /* Don't redirect these keys */
530 gtk_widget_grab_focus(win->input_entry);
531 gtk_editable_set_position(GTK_EDITABLE(win->input_entry), -1);
532 gboolean retval = TRUE;
533 g_signal_emit_by_name(win->input_entry, "key-press-event", event, &retval);
534 return retval; /* Block this key event if the entry handled it */
540 /* Internal function: finish handling a line input request, for both text grid and text buffer windows. */
542 write_to_window_buffer(winid_t win, const gchar *inserted_text)
546 /* Convert the string from UTF-8 to Latin-1 or Unicode */
547 if(win->input_request_type == INPUT_REQUEST_LINE)
550 gchar *latin1 = convert_utf8_to_latin1(inserted_text, &bytes_written);
555 /* Place input in the echo stream */
556 if(win->echo_stream != NULL)
557 glk_put_string_stream(win->echo_stream, latin1);
559 /* Copy the string (bytes_written does not include the NULL at the end) */
560 copycount = MIN(win->line_input_buffer_max_len, bytes_written);
561 memcpy(win->line_input_buffer, latin1, copycount);
564 else if(win->input_request_type == INPUT_REQUEST_LINE_UNICODE)
567 gunichar *unicode = convert_utf8_to_ucs4(inserted_text, &items_written);
572 /* Place input in the echo stream */
573 if(win->echo_stream != NULL)
574 glk_put_string_stream_uni(win->echo_stream, unicode);
576 /* Copy the string (but not the NULL at the end) */
577 copycount = MIN(win->line_input_buffer_max_len, items_written);
578 memcpy(win->line_input_buffer_unicode, unicode, copycount * sizeof(gunichar));
582 WARNING("Wrong input request type");
584 win->input_request_type = INPUT_REQUEST_NONE;
588 /* Internal function: Retrieves the input of a TextBuffer window and stores it in the window buffer.
589 * Returns the number of characters written, suitable for inclusion in a line input event. */
591 finish_text_buffer_line_input(winid_t win, gboolean emit_signal)
593 VALID_WINDOW(win, return 0);
594 g_return_val_if_fail(win->type == wintype_TextBuffer, 0);
596 GtkTextIter start_iter, end_iter, last_character;
598 GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
599 GtkTextMark *input_position = gtk_text_buffer_get_mark(window_buffer, "input_position");
600 gtk_text_buffer_get_iter_at_mark(window_buffer, &start_iter, input_position);
601 gtk_text_buffer_get_end_iter(window_buffer, &end_iter);
602 gtk_text_buffer_get_end_iter(window_buffer, &last_character);
603 gtk_text_iter_backward_cursor_position(&last_character);
605 gchar* last_char = gtk_text_buffer_get_text(window_buffer, &last_character, &end_iter, FALSE);
607 if( strchr(last_char, '\n') != NULL )
608 gtk_text_iter_backward_cursor_position(&end_iter);
610 gchar* inserted_text = gtk_text_buffer_get_text(window_buffer, &start_iter, &end_iter, FALSE);
612 int chars_written = write_to_window_buffer(win, inserted_text);
615 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
617 g_signal_emit_by_name(glk, "line-input", win->rock, inserted_text);
620 /* Add the text to the window input history */
621 if(win->history_pos != NULL)
623 g_free(win->history->data);
624 win->history = g_list_delete_link(win->history, win->history);
626 if(*inserted_text != 0)
627 win->history = g_list_prepend(win->history, g_strdup(inserted_text));
629 win->history_pos = NULL;
631 g_free(inserted_text);
633 return chars_written;
636 /* Internal function: Retrieves the input of a TextGrid window and stores it in the window buffer.
637 * Returns the number of characters written, suitable for inclusion in a line input event. */
639 finish_text_grid_line_input(winid_t win, gboolean emit_signal)
641 VALID_WINDOW(win, return 0);
642 g_return_val_if_fail(win->type == wintype_TextGrid, 0);
644 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
646 gchar *text = g_strdup( gtk_entry_get_text(GTK_ENTRY(win->input_entry)) );
647 /* Move the focus back into the text view */
648 gtk_widget_grab_focus(win->widget);
649 /* Remove entry widget from text view */
650 /* Should be ok even though this is the widget's own signal handler */
651 gtk_container_remove( GTK_CONTAINER(win->widget), GTK_WIDGET(win->input_entry) );
652 win->input_entry = NULL;
653 /* Delete the child anchor */
654 GtkTextIter start, end;
655 gtk_text_buffer_get_iter_at_child_anchor(buffer, &start, win->input_anchor);
657 gtk_text_iter_forward_char(&end); /* Point after the child anchor */
658 gtk_text_buffer_delete(buffer, &start, &end);
659 win->input_anchor = NULL;
661 gchar *spaces = g_strnfill(win->input_length - g_utf8_strlen(text, -1), ' ');
662 gchar *text_to_insert = g_strconcat(text, spaces, NULL);
664 gtk_text_buffer_insert(buffer, &start, text_to_insert, -1);
665 g_free(text_to_insert);
667 int chars_written = write_to_window_buffer(win, text);
670 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
672 g_signal_emit_by_name(glk, "line-input", win->rock, text);
675 /* Add the text to the window input history */
676 if(win->history_pos != NULL)
678 g_free(win->history->data);
679 win->history = g_list_delete_link(win->history, win->history);
682 win->history = g_list_prepend(win->history, g_strdup(text));
683 win->history_pos = NULL;
686 return chars_written;
689 /* Internal function: Callback for signal insert-text on a text buffer window.
690 Runs after the default handler has already inserted the text.
691 FIXME: This function assumes that newline was the last character typed into the
692 window. That assumption is wrong if, for example, text containing a newline was
693 pasted into the window. */
695 after_window_insert_text(GtkTextBuffer *textbuffer, GtkTextIter *location, gchar *text, gint len, winid_t win)
697 GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
699 /* Set the history position to NULL and erase the text we were already editing */
700 if(win->history_pos != NULL)
702 g_free(win->history->data);
703 win->history = g_list_delete_link(win->history, win->history);
704 win->history_pos = NULL;
706 if( strchr(text, '\n') != NULL )
708 /* Remove signal handlers */
709 g_signal_handler_block(window_buffer, win->insert_text_handler);
710 g_signal_handler_block(win->widget, win->line_input_keypress_handler);
712 /* Make the window uneditable again and retrieve the text that was input */
713 gtk_text_view_set_editable(GTK_TEXT_VIEW(win->widget), FALSE);
715 int chars_written = finish_text_buffer_line_input(win, TRUE);
716 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
717 event_throw(glk, evtype_LineInput, win, chars_written, 0);
720 /* Apply the 'input' style to the text that was entered */
721 GtkTextIter end_iter;
722 gtk_text_buffer_get_end_iter(window_buffer, &end_iter);
723 GtkTextIter input_iter;
724 GtkTextMark *input_position = gtk_text_buffer_get_mark(window_buffer, "input_position");
725 gtk_text_buffer_get_iter_at_mark(window_buffer, &input_iter, input_position);
726 gtk_text_buffer_apply_tag_by_name(window_buffer, "input", &input_iter, &end_iter);
729 /* Internal function: Callback for signal activate on the line input GtkEntry
730 in a text grid window. */
732 on_input_entry_activate(GtkEntry *input_entry, winid_t win)
734 g_signal_handler_block(win->widget, win->line_input_keypress_handler);
736 int chars_written = finish_text_grid_line_input(win, TRUE);
737 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
738 event_throw(glk, evtype_LineInput, win, chars_written, 0);
741 /* Internal function: Callback for signal key-press-event on the line input
742 GtkEntry in a text grid window. */
744 on_input_entry_key_press_event(GtkEntry *input_entry, GdkEventKey *event, winid_t win)
746 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up
747 || event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
749 /* Prevent falling off the end of the history list */
750 if( (event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
751 && win->history_pos && win->history_pos->next == NULL)
753 if( (event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
754 && (win->history_pos == NULL || win->history_pos->prev == NULL) )
757 if(win->history_pos == NULL)
759 const gchar *current_input = gtk_entry_get_text(input_entry);
760 win->history = g_list_prepend(win->history, g_strdup(current_input));
761 win->history_pos = win->history;
764 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
767 win->history_pos = g_list_next(win->history_pos);
769 win->history_pos = win->history;
772 win->history_pos = g_list_previous(win->history_pos);
774 /* Insert the history item into the window */
775 g_signal_handler_block(input_entry, win->line_input_entry_changed);
776 gtk_entry_set_text(input_entry, win->history_pos->data);
777 g_signal_handler_unblock(input_entry, win->line_input_entry_changed);
784 on_input_entry_changed(GtkEditable *editable, winid_t win)
786 /* Set the history position to NULL and erase the text we were already editing */
787 if(win->history_pos != NULL)
789 g_free(win->history->data);
790 win->history = g_list_delete_link(win->history, win->history);
791 win->history_pos = NULL;
796 keyval_to_glk_keycode(guint keyval, gboolean unicode)
801 case GDK_KP_Up: return keycode_Up;
803 case GDK_KP_Down: return keycode_Down;
805 case GDK_KP_Left: return keycode_Left;
807 case GDK_KP_Right: return keycode_Right;
810 case GDK_KP_Enter: return keycode_Return;
813 case GDK_KP_Delete: return keycode_Delete;
814 case GDK_Escape: return keycode_Escape;
816 case GDK_KP_Tab: return keycode_Tab;
818 case GDK_KP_Page_Up: return keycode_PageUp;
820 case GDK_KP_Page_Down: return keycode_PageDown;
822 case GDK_KP_Home: return keycode_Home;
824 case GDK_KP_End: return keycode_End;
826 case GDK_KP_F1: return keycode_Func1;
828 case GDK_KP_F2: return keycode_Func2;
830 case GDK_KP_F3: return keycode_Func3;
832 case GDK_KP_F4: return keycode_Func4;
833 case GDK_F5: return keycode_Func5;
834 case GDK_F6: return keycode_Func6;
835 case GDK_F7: return keycode_Func7;
836 case GDK_F8: return keycode_Func8;
837 case GDK_F9: return keycode_Func9;
838 case GDK_F10: return keycode_Func10;
839 case GDK_F11: return keycode_Func11;
840 case GDK_F12: return keycode_Func12;
842 keycode = gdk_keyval_to_unicode(keyval);
843 /* If keycode is 0, then keyval was not recognized; also return
844 unknown if Latin-1 input was requested and the character is not in
846 if(keycode == 0 || (!unicode && keycode > 255))
847 return keycode_Unknown;
853 force_char_input_from_queue(winid_t win, event_t *event)
855 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
856 guint keyval = GPOINTER_TO_UINT(g_async_queue_pop(glk_data->char_input_queue));
858 glk_cancel_char_event(win);
861 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
863 g_signal_emit_by_name(glk, "char-input", win->rock, keyval);
866 event->type = evtype_CharInput;
868 event->val1 = keyval_to_glk_keycode(keyval, win->input_request_type == INPUT_REQUEST_CHARACTER_UNICODE);
873 force_line_input_from_queue(winid_t win, event_t *event)
875 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
876 const gchar *text = g_async_queue_pop(glk_data->line_input_queue);
877 glui32 chars_written = 0;
880 if(win->type == wintype_TextBuffer)
882 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
883 GtkTextIter start, end;
885 /* Remove signal handlers so the line input doesn't get picked up again */
886 g_signal_handler_block(buffer, win->insert_text_handler);
887 g_signal_handler_block(win->widget, win->line_input_keypress_handler);
889 /* Erase any text that was already typed */
890 GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
891 gtk_text_buffer_get_iter_at_mark(buffer, &start, input_position);
892 gtk_text_buffer_get_end_iter(buffer, &end);
893 gtk_text_buffer_delete(buffer, &start, &end);
895 /* Make the window uneditable again */
896 gtk_text_view_set_editable(GTK_TEXT_VIEW(win->widget), FALSE);
898 /* Insert the forced input into the window */
899 gtk_text_buffer_get_end_iter(buffer, &end);
900 gchar *text_to_insert = g_strconcat(text, "\n", NULL);
901 gtk_text_buffer_insert_with_tags_by_name(buffer, &end, text_to_insert, -1, "input", NULL);
902 chars_written = finish_text_buffer_line_input(win, TRUE);
904 else if(win->type == wintype_TextGrid)
906 /* Remove signal handlers so the line input doesn't get picked up again */
907 g_signal_handler_block(win->widget, win->char_input_keypress_handler);
909 /* Insert the forced input into the window */
910 gtk_entry_set_text(GTK_ENTRY(win->input_entry), text);
911 chars_written = finish_text_grid_line_input(win, TRUE);
915 event->type = evtype_LineInput;
917 event->val1 = chars_written;
921 /*** Internal function: cancels any pending input requests on the window and presents a warning if not INPUT_REQUEST_NONE ***/
923 cancel_old_input_request(winid_t win)
925 switch(win->input_request_type) {
926 case INPUT_REQUEST_NONE:
927 break; /* All is well */
928 case INPUT_REQUEST_CHARACTER:
929 case INPUT_REQUEST_CHARACTER_UNICODE:
930 glk_cancel_char_event(win);
931 WARNING("Cancelling pending char event");
933 case INPUT_REQUEST_LINE:
934 case INPUT_REQUEST_LINE_UNICODE:
935 glk_cancel_line_event(win, NULL);
936 WARNING("Cancelling pending line event");
939 WARNING("Could not cancel pending input request: unknown input request");