5 #include "chimara-glk-private.h"
7 extern GPrivate *glk_data_key;
9 /* Forward declarations */
10 static int finish_text_buffer_line_input(winid_t win, gboolean emit_signal);
11 static int finish_text_grid_line_input(winid_t win, gboolean emit_signal);
12 static void cancel_old_input_request(winid_t win);
14 /* Internal function: code common to both flavors of char event request */
16 request_char_event_common(winid_t win, gboolean unicode)
18 VALID_WINDOW(win, return);
19 g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
21 cancel_old_input_request(win);
23 flush_window_buffer(win);
25 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
27 win->input_request_type = unicode? INPUT_REQUEST_CHARACTER_UNICODE : INPUT_REQUEST_CHARACTER;
28 g_signal_handler_unblock( win->widget, win->char_input_keypress_handler );
31 gtk_widget_grab_focus( GTK_WIDGET(win->widget) );
34 /* Emit the "waiting" signal to let listeners know we are ready for input */
35 g_signal_emit_by_name(glk_data->self, "waiting");
39 * glk_request_char_event:
40 * @win: A window to request char events from.
42 * Request input of a Latin-1 character or special key. A window cannot have
43 * requests for both character and line input at the same time. Nor can it have
44 * requests for character input of both types (Latin-1 and Unicode). It is
45 * illegal to call glk_request_char_event() if the window already has a pending
46 * request for either character or line input.
49 glk_request_char_event(winid_t win)
51 request_char_event_common(win, FALSE);
55 * glk_request_char_event_uni:
56 * @win: A window to request char events from.
58 * Request input of a Unicode character or special key. See
59 * glk_request_char_event().
62 glk_request_char_event_uni(winid_t win)
64 request_char_event_common(win, TRUE);
68 * glk_cancel_char_event:
69 * @win: A window to cancel the latest char event request on.
71 * This cancels a pending request for character input. (Either Latin-1 or
72 * Unicode.) For convenience, it is legal to call glk_cancel_char_event() even
73 * if there is no charcter input request on that window. Glk will ignore the
77 glk_cancel_char_event(winid_t win)
79 VALID_WINDOW(win, return);
80 g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
82 if(win->input_request_type == INPUT_REQUEST_CHARACTER || win->input_request_type == INPUT_REQUEST_CHARACTER_UNICODE)
84 win->input_request_type = INPUT_REQUEST_NONE;
85 g_signal_handler_block( win->widget, win->char_input_keypress_handler );
89 /* Internal function: Request either latin-1 or unicode line input, in a text grid window. */
91 text_grid_request_line_event_common(winid_t win, glui32 maxlen, gboolean insert, gchar *inserttext)
95 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
97 GtkTextMark *cursor = gtk_text_buffer_get_mark(buffer, "cursor_position");
98 GtkTextIter start_iter, end_iter;
99 gtk_text_buffer_get_iter_at_mark(buffer, &start_iter, cursor);
101 /* Determine the maximum length of the line input */
102 gint cursorpos = gtk_text_iter_get_line_offset(&start_iter);
103 /* Odd; the Glk spec says the maximum input length is
104 windowwidth - 1 - cursorposition. I say no, because if cursorposition is
105 zero, then the input should fill the whole line. FIXME??? */
106 win->input_length = MIN(win->width - cursorpos, win->line_input_buffer_max_len);
107 end_iter = start_iter;
108 gtk_text_iter_set_line_offset(&end_iter, cursorpos + win->input_length);
110 /* If the buffer currently has a selection with one bound in the middle of
111 the input field, then deselect it. Otherwise the input field gets trashed */
112 GtkTextIter start_sel, end_sel;
113 if( gtk_text_buffer_get_selection_bounds(buffer, &start_sel, &end_sel) )
115 if( gtk_text_iter_in_range(&start_sel, &start_iter, &end_iter) )
116 gtk_text_buffer_place_cursor(buffer, &end_sel);
117 if( gtk_text_iter_in_range(&end_sel, &start_iter, &end_iter) )
118 gtk_text_buffer_place_cursor(buffer, &start_sel);
121 /* Erase the text currently in the input field and replace it with a GtkEntry */
122 gtk_text_buffer_delete(buffer, &start_iter, &end_iter);
123 win->input_anchor = gtk_text_buffer_create_child_anchor(buffer, &start_iter);
124 win->input_entry = gtk_entry_new();
125 /* Set the entry's font to match that of the window */
126 GtkRcStyle *style = gtk_widget_get_modifier_style(win->widget); /* Don't free */
127 gtk_widget_modify_font(win->input_entry, style->font_desc);
128 /* Make the entry as small as possible to fit with the text */
129 gtk_entry_set_has_frame(GTK_ENTRY(win->input_entry), FALSE);
130 GtkBorder border = { 0, 0, 0, 0 };
133 #if GTK_CHECK_VERSION(2,10,0)
134 gtk_entry_set_inner_border(GTK_ENTRY(win->input_entry), &border);
136 gtk_entry_set_max_length(GTK_ENTRY(win->input_entry), win->input_length);
137 gtk_entry_set_width_chars(GTK_ENTRY(win->input_entry), win->input_length);
139 /* Insert pre-entered text if needed */
141 gtk_entry_set_text(GTK_ENTRY(win->input_entry), inserttext);
143 /* Set background color of entry (TODO: implement as property) */
145 gdk_color_parse("grey", &background);
146 gtk_widget_modify_base(win->input_entry, GTK_STATE_NORMAL, &background);
148 g_signal_connect(win->input_entry, "activate", G_CALLBACK(on_input_entry_activate), win);
149 g_signal_connect(win->input_entry, "key-press-event", G_CALLBACK(on_input_entry_key_press_event), win);
150 win->line_input_entry_changed = g_signal_connect(win->input_entry, "changed", G_CALLBACK(on_input_entry_changed), win);
152 gtk_widget_show(win->input_entry);
153 gtk_text_view_add_child_at_anchor(GTK_TEXT_VIEW(win->widget), win->input_entry, win->input_anchor);
155 gtk_widget_grab_focus(win->input_entry);
160 /* Internal function: Request either latin-1 or unicode line input, in a text buffer window. */
162 text_buffer_request_line_event_common(winid_t win, glui32 maxlen, gboolean insert, gchar *inserttext)
164 flush_window_buffer(win);
168 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
170 /* Move the input_position mark to the end of the window_buffer */
171 GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
172 GtkTextIter end_iter;
173 gtk_text_buffer_get_end_iter(buffer, &end_iter);
174 gtk_text_buffer_move_mark(buffer, input_position, &end_iter);
176 /* Set the entire contents of the window_buffer as uneditable
177 * (so input can only be entered at the end) */
178 GtkTextIter start_iter;
179 gtk_text_buffer_get_start_iter(buffer, &start_iter);
180 gtk_text_buffer_remove_tag_by_name(buffer, "uneditable", &start_iter, &end_iter);
181 gtk_text_buffer_apply_tag_by_name(buffer, "uneditable", &start_iter, &end_iter);
183 /* Insert pre-entered text if needed */
185 gtk_text_buffer_insert(buffer, &end_iter, inserttext, -1);
186 gtk_text_buffer_get_end_iter(buffer, &end_iter); /* update after text insertion */
189 /* Apply the correct style to the input prompt */
190 GtkTextIter input_iter;
191 gtk_text_buffer_get_iter_at_mark(buffer, &input_iter, input_position);
192 gtk_text_buffer_apply_tag_by_name(buffer, "input", &input_iter, &end_iter);
194 gtk_text_view_set_editable(GTK_TEXT_VIEW(win->widget), TRUE);
196 g_signal_handler_unblock(buffer, win->insert_text_handler);
197 gtk_widget_grab_focus(win->widget);
203 * glk_request_line_event:
204 * @win: A text buffer or text grid window to request line input on.
205 * @buf: A buffer of at least @maxlen bytes.
206 * @maxlen: Length of the buffer.
207 * @initlen: The number of characters in @buf to pre-enter.
209 * Requests input of a line of Latin-1 characters. A window cannot have requests
210 * for both character and line input at the same time. Nor can it have requests
211 * for line input of both types (Latin-1 and Unicode). It is illegal to call
212 * glk_request_line_event() if the window already has a pending request for
213 * either character or line input.
215 * The @buf argument is a pointer to space where the line input will be stored.
216 * (This may not be %NULL.) @maxlen is the length of this space, in bytes; the
217 * library will not accept more characters than this. If @initlen is nonzero,
218 * then the first @initlen bytes of @buf will be entered as pre-existing input
219 * — just as if the player had typed them himself. (The player can continue
220 * composing after this pre-entered input, or delete it or edit as usual.)
222 * The contents of the buffer are undefined until the input is completed (either
223 * by a line input event, or glk_cancel_line_event(). The library may or may not
224 * fill in the buffer as the player composes, while the input is still pending;
225 * it is illegal to change the contents of the buffer yourself.
228 glk_request_line_event(winid_t win, char *buf, glui32 maxlen, glui32 initlen)
230 VALID_WINDOW(win, return);
231 g_return_if_fail(buf);
232 g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
233 g_return_if_fail(initlen <= maxlen);
235 cancel_old_input_request(win);
237 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
239 /* Register the buffer */
240 if(glk_data->register_arr)
241 win->buffer_rock = (*glk_data->register_arr)(buf, maxlen, "&+#!Cn");
243 win->input_request_type = INPUT_REQUEST_LINE;
244 win->line_input_buffer = buf;
245 win->line_input_buffer_max_len = maxlen;
246 win->echo_current_line_input = win->echo_line_input;
248 gchar *inserttext = (initlen > 0)? g_strndup(buf, initlen) : g_strdup("");
251 case wintype_TextBuffer:
252 text_buffer_request_line_event_common(win, maxlen, (initlen > 0), inserttext);
254 case wintype_TextGrid:
255 text_grid_request_line_event_common(win, maxlen, (initlen > 0), inserttext);
259 g_signal_handler_unblock(win->widget, win->line_input_keypress_handler);
261 /* Emit the "waiting" signal to let listeners know we are ready for input */
262 g_signal_emit_by_name(glk_data->self, "waiting");
266 * glk_request_line_event_uni:
267 * @win: A text buffer or text grid window to request line input on.
268 * @buf: A buffer of at least @maxlen characters.
269 * @maxlen: Length of the buffer.
270 * @initlen: The number of characters in @buf to pre-enter.
272 * Request input of a line of Unicode characters. This works the same as
273 * glk_request_line_event(), except the result is stored in an array of
274 * <type>glui32</type> values instead of an array of characters, and the values
275 * may be any valid Unicode code points.
277 * If possible, the library should return fully composed Unicode characters,
278 * rather than strings of base and composition characters.
281 * Fully-composed characters are the norm for Unicode text, so an
282 * implementation that ignores this issue will probably produce the right
283 * result. However, the game may not want to rely on that. Another factor is
284 * that case-folding can (occasionally) produce non-normalized text.
285 * Therefore, to cover all its bases, a game should call
286 * glk_buffer_to_lower_case_uni(), followed by
287 * glk_buffer_canon_normalize_uni(), before parsing.
291 * Earlier versions of this spec said that line input must always be in
292 * Unicode Normalization Form C. However, this has not been universally
293 * implemented. It is also somewhat redundant, for the results noted above.
294 * Therefore, we now merely recommend that line input be fully composed. The
295 * game is ultimately responsible for all case-folding and normalization. See
296 * <link linkend="chimara-Unicode-String-Normalization">Unicode String
297 * Normalization</link>.
301 glk_request_line_event_uni(winid_t win, glui32 *buf, glui32 maxlen, glui32 initlen)
303 VALID_WINDOW(win, return);
304 g_return_if_fail(buf);
305 g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
306 g_return_if_fail(initlen <= maxlen);
308 cancel_old_input_request(win);
309 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
311 /* Register the buffer */
312 if(glk_data->register_arr)
313 win->buffer_rock = (*glk_data->register_arr)(buf, maxlen, "&+#!Iu");
317 win->input_request_type = INPUT_REQUEST_LINE_UNICODE;
318 win->line_input_buffer_unicode = buf;
319 win->line_input_buffer_max_len = maxlen;
323 utf8 = convert_ucs4_to_utf8(buf, initlen);
332 case wintype_TextBuffer:
333 text_buffer_request_line_event_common(win, maxlen, (initlen > 0), utf8);
335 case wintype_TextGrid:
336 text_grid_request_line_event_common(win, maxlen, (initlen > 0), utf8);
339 g_signal_handler_unblock(win->widget, win->line_input_keypress_handler);
342 /* Emit the "waiting" signal to let listeners know we are ready for input */
343 g_signal_emit_by_name(glk_data->self, "waiting");
347 * glk_cancel_line_event:
348 * @win: A text buffer or text grid window to cancel line input on.
349 * @event: Will be filled in if the user had already input something.
351 * This cancels a pending request for line input. (Either Latin-1 or Unicode.)
353 * The event pointed to by the event argument will be filled in as if the
354 * player had hit <keycap>enter</keycap>, and the input composed so far will be
355 * stored in the buffer; see below. If you do not care about this information,
356 * pass %NULL as the @event argument. (The buffer will still be filled.)
358 * For convenience, it is legal to call glk_cancel_line_event() even if there
359 * is no line input request on that window. The event type will be set to
360 * %evtype_None in this case.
363 glk_cancel_line_event(winid_t win, event_t *event)
365 VALID_WINDOW(win, return);
366 g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
369 event->type = evtype_None;
375 if(win->input_request_type != INPUT_REQUEST_LINE && win->input_request_type != INPUT_REQUEST_LINE_UNICODE)
378 g_signal_handler_block( win->widget, win->line_input_keypress_handler );
380 int chars_written = 0;
383 if(win->type == wintype_TextGrid) {
384 chars_written = finish_text_grid_line_input(win, FALSE);
385 } else if(win->type == wintype_TextBuffer) {
386 gtk_text_view_set_editable( GTK_TEXT_VIEW(win->widget), FALSE );
387 GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
388 g_signal_handler_block(window_buffer, win->insert_text_handler);
389 chars_written = finish_text_buffer_line_input(win, FALSE);
393 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
394 if(glk_data->unregister_arr)
396 if(win->input_request_type == INPUT_REQUEST_LINE_UNICODE)
397 (*glk_data->unregister_arr)(win->line_input_buffer_unicode, win->line_input_buffer_max_len, "&+#!Iu", win->buffer_rock);
399 (*glk_data->unregister_arr)(win->line_input_buffer, win->line_input_buffer_max_len, "&+#!Cn", win->buffer_rock);
402 if(event != NULL && chars_written > 0) {
403 event->type = evtype_LineInput;
404 event->val1 = chars_written;
408 /* Helper function: Turn off shutdown key-press-event signal handler */
410 turn_off_handler(GNode *node)
412 winid_t win = node->data;
413 g_signal_handler_block(win->widget, win->shutdown_keypress_handler);
414 return FALSE; /* don't stop */
417 /* Internal function: Callback for signal key-press-event while waiting for shutdown. */
419 on_shutdown_key_press_event(GtkWidget *widget, GdkEventKey *event, winid_t win)
421 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(widget, CHIMARA_TYPE_GLK));
423 CHIMARA_GLK_USE_PRIVATE(glk, priv);
425 /* Turn off all the signal handlers */
426 if(priv->root_window)
427 g_node_traverse(priv->root_window, G_IN_ORDER, G_TRAVERSE_LEAVES, -1, (GNodeTraverseFunc)turn_off_handler, NULL);
429 /* Signal the Glk library that it can shut everything down now */
430 g_mutex_lock(priv->shutdown_lock);
431 g_cond_signal(priv->shutdown_key_pressed);
432 g_mutex_unlock(priv->shutdown_lock);
434 return TRUE; /* block the event */
437 /* 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. */
439 on_char_input_key_press_event(GtkWidget *widget, GdkEventKey *event, winid_t win)
441 /* Ignore modifier keys, otherwise the char input will already trigger on
442 the shift key when the user tries to type a capital letter */
443 if(event->is_modifier)
444 return FALSE; /* don't stop the event */
446 /* All text up to the input position is now regarded as being read by the user */
447 if(win->type == wintype_TextBuffer)
450 glui32 keycode = keyval_to_glk_keycode(event->keyval, win->input_request_type == INPUT_REQUEST_CHARACTER_UNICODE);
452 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(widget, CHIMARA_TYPE_GLK));
454 event_throw(glk, evtype_CharInput, win, keycode, 0);
455 g_signal_emit_by_name(glk, "char-input", win->rock, event->keyval);
457 /* Only one keypress will be handled */
458 win->input_request_type = INPUT_REQUEST_NONE;
459 g_signal_handler_block(win->widget, win->char_input_keypress_handler);
465 on_line_input_key_press_event(GtkWidget *widget, GdkEventKey *event, winid_t win)
469 case wintype_TextBuffer:
470 /* All text up to the input position is now regarded as being read by the user */
473 /* History up/down */
474 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up
475 || event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
477 /* Prevent falling off the end of the history list */
478 if(win->history == NULL)
480 if( (event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
481 && win->history_pos && win->history_pos->next == NULL)
483 if( (event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
484 && (win->history_pos == NULL || win->history_pos->prev == NULL) )
487 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
488 GtkTextIter start, end;
489 /* Erase any text that was already typed */
490 GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
491 gtk_text_buffer_get_iter_at_mark(buffer, &start, input_position);
492 gtk_text_buffer_get_end_iter(buffer, &end);
494 if(win->history_pos == NULL) {
495 gchar *current_input = gtk_text_buffer_get_text(buffer, &start, &end, FALSE);
496 win->history = g_list_prepend(win->history, current_input);
497 win->history_pos = win->history;
500 gtk_text_buffer_delete(buffer, &start, &end);
502 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
505 win->history_pos = g_list_next(win->history_pos);
507 win->history_pos = win->history;
510 win->history_pos = g_list_previous(win->history_pos);
512 /* Insert the history item into the window */
513 gtk_text_buffer_get_end_iter(buffer, &end);
515 g_signal_handler_block(buffer, win->insert_text_handler);
516 gtk_text_buffer_insert_with_tags_by_name(buffer, &end, win->history_pos->data, -1, "default", "input", NULL);
517 g_signal_handler_unblock(buffer, win->insert_text_handler);
521 /* Move to beginning/end of input field */
522 else if(event->keyval == GDK_Home) {
523 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
524 GtkTextIter input_iter;
525 GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
526 gtk_text_buffer_get_iter_at_mark(buffer, &input_iter, input_position);
527 gtk_text_buffer_place_cursor(buffer, &input_iter);
530 else if(event->keyval == GDK_End) {
531 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
532 GtkTextIter end_iter;
533 gtk_text_buffer_get_end_iter(buffer, &end_iter);
534 gtk_text_buffer_place_cursor(buffer, &end_iter);
538 /* Handle the enter key, which could occur in the middle of the sentence. */
539 else if(event->keyval == GDK_Return || event->keyval == GDK_KP_Enter) {
540 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
541 GtkTextIter end_iter;
542 gtk_text_buffer_get_end_iter(buffer, &end_iter);
543 gtk_text_buffer_place_cursor(buffer, &end_iter);
549 /* If this is a text grid window, then redirect the key press to the line input GtkEntry */
550 case wintype_TextGrid:
552 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up
553 || event->keyval == GDK_Down || event->keyval == GDK_KP_Down
554 || event->keyval == GDK_Left || event->keyval == GDK_KP_Left
555 || event->keyval == GDK_Right || event->keyval == GDK_KP_Right
556 || event->keyval == GDK_Tab || event->keyval == GDK_KP_Tab
557 || event->keyval == GDK_Page_Up || event->keyval == GDK_KP_Page_Up
558 || event->keyval == GDK_Page_Down || event->keyval == GDK_KP_Page_Down
559 || event->keyval == GDK_Home || event->keyval == GDK_KP_Home
560 || event->keyval == GDK_End || event->keyval == GDK_KP_End)
561 return FALSE; /* Don't redirect these keys */
562 gtk_widget_grab_focus(win->input_entry);
563 gtk_editable_set_position(GTK_EDITABLE(win->input_entry), -1);
564 gboolean retval = TRUE;
565 g_signal_emit_by_name(win->input_entry, "key-press-event", event, &retval);
566 return retval; /* Block this key event if the entry handled it */
572 /* Internal function: finish handling a line input request, for both text grid and text buffer windows. */
574 write_to_window_buffer(winid_t win, const gchar *inserted_text)
578 /* Convert the string from UTF-8 to Latin-1 or Unicode */
579 if(win->input_request_type == INPUT_REQUEST_LINE)
582 gchar *latin1 = convert_utf8_to_latin1(inserted_text, &bytes_written);
587 /* Place input in the echo stream */
588 if(win->echo_stream != NULL)
589 glk_put_string_stream(win->echo_stream, latin1);
591 /* Copy the string (bytes_written does not include the NULL at the end) */
592 copycount = MIN(win->line_input_buffer_max_len, bytes_written);
593 memcpy(win->line_input_buffer, latin1, copycount);
596 else if(win->input_request_type == INPUT_REQUEST_LINE_UNICODE)
599 gunichar *unicode = convert_utf8_to_ucs4(inserted_text, &items_written);
604 /* Place input in the echo stream */
605 if(win->echo_stream != NULL)
606 glk_put_string_stream_uni(win->echo_stream, unicode);
608 /* Copy the string (but not the NULL at the end) */
609 copycount = MIN(win->line_input_buffer_max_len, items_written);
610 memcpy(win->line_input_buffer_unicode, unicode, copycount * sizeof(gunichar));
614 WARNING("Wrong input request type");
616 win->input_request_type = INPUT_REQUEST_NONE;
620 /* Internal function: Retrieves the input of a TextBuffer window and stores it in the window buffer.
621 * Returns the number of characters written, suitable for inclusion in a line input event. */
623 finish_text_buffer_line_input(winid_t win, gboolean emit_signal)
625 VALID_WINDOW(win, return 0);
626 g_return_val_if_fail(win->type == wintype_TextBuffer, 0);
628 GtkTextIter start_iter, end_iter;
630 GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
631 GtkTextMark *input_position = gtk_text_buffer_get_mark(window_buffer, "input_position");
632 gtk_text_buffer_get_iter_at_mark(window_buffer, &start_iter, input_position);
633 gtk_text_buffer_get_end_iter(window_buffer, &end_iter);
635 gchar *inserted_text = gtk_text_buffer_get_text(window_buffer, &start_iter, &end_iter, FALSE);
637 /* If echoing is turned off, remove the text from the window */
638 if(!win->echo_current_line_input)
639 gtk_text_buffer_delete(window_buffer, &start_iter, &end_iter);
641 /* Don't include the newline in the input */
642 char *last_char = inserted_text + strlen(inserted_text) - 1;
643 if(*last_char == '\n')
646 int chars_written = write_to_window_buffer(win, inserted_text);
649 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
651 g_signal_emit_by_name(glk, "line-input", win->rock, inserted_text);
654 /* Add the text to the window input history */
655 if(win->history_pos != NULL)
657 g_free(win->history->data);
658 win->history = g_list_delete_link(win->history, win->history);
660 if(*inserted_text != 0)
661 win->history = g_list_prepend(win->history, g_strdup(inserted_text));
663 win->history_pos = NULL;
665 g_free(inserted_text);
667 return chars_written;
670 /* Internal function: Retrieves the input of a TextGrid window and stores it in the window buffer.
671 * Returns the number of characters written, suitable for inclusion in a line input event. */
673 finish_text_grid_line_input(winid_t win, gboolean emit_signal)
675 VALID_WINDOW(win, return 0);
676 g_return_val_if_fail(win->type == wintype_TextGrid, 0);
678 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
680 gchar *text = g_strdup( gtk_entry_get_text(GTK_ENTRY(win->input_entry)) );
681 /* Move the focus back into the text view */
682 gtk_widget_grab_focus(win->widget);
683 /* Remove entry widget from text view */
684 /* Should be ok even though this is the widget's own signal handler */
685 gtk_container_remove( GTK_CONTAINER(win->widget), GTK_WIDGET(win->input_entry) );
686 win->input_entry = NULL;
687 /* Delete the child anchor */
688 GtkTextIter start, end;
689 gtk_text_buffer_get_iter_at_child_anchor(buffer, &start, win->input_anchor);
691 gtk_text_iter_forward_char(&end); /* Point after the child anchor */
692 gtk_text_buffer_delete(buffer, &start, &end);
693 win->input_anchor = NULL;
695 gchar *spaces = g_strnfill(win->input_length - g_utf8_strlen(text, -1), ' ');
696 gchar *text_to_insert = g_strconcat(text, spaces, NULL);
698 gtk_text_buffer_insert(buffer, &start, text_to_insert, -1);
699 g_free(text_to_insert);
701 int chars_written = write_to_window_buffer(win, text);
704 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
706 g_signal_emit_by_name(glk, "line-input", win->rock, text);
709 /* Add the text to the window input history */
710 if(win->history_pos != NULL)
712 g_free(win->history->data);
713 win->history = g_list_delete_link(win->history, win->history);
716 win->history = g_list_prepend(win->history, g_strdup(text));
717 win->history_pos = NULL;
720 return chars_written;
723 /* Internal function: Callback for signal insert-text on a text buffer window.
724 Runs after the default handler has already inserted the text.
725 FIXME: This function assumes that newline was the last character typed into the
726 window. That assumption is wrong if, for example, text containing a newline was
727 pasted into the window. */
729 after_window_insert_text(GtkTextBuffer *textbuffer, GtkTextIter *location, gchar *text, gint len, winid_t win)
731 GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
733 /* Set the history position to NULL and erase the text we were already editing */
734 if(win->history_pos != NULL)
736 g_free(win->history->data);
737 win->history = g_list_delete_link(win->history, win->history);
738 win->history_pos = NULL;
740 if( strchr(text, '\n') != NULL )
742 /* Remove signal handlers */
743 g_signal_handler_block(window_buffer, win->insert_text_handler);
744 g_signal_handler_block(win->widget, win->line_input_keypress_handler);
746 /* Make the window uneditable again and retrieve the text that was input */
747 gtk_text_view_set_editable(GTK_TEXT_VIEW(win->widget), FALSE);
749 int chars_written = finish_text_buffer_line_input(win, TRUE);
750 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
751 event_throw(glk, evtype_LineInput, win, chars_written, 0);
754 /* Apply the 'input' style to the text that was entered */
755 GtkTextIter end_iter;
756 gtk_text_buffer_get_end_iter(window_buffer, &end_iter);
757 GtkTextIter input_iter;
758 GtkTextMark *input_position = gtk_text_buffer_get_mark(window_buffer, "input_position");
759 gtk_text_buffer_get_iter_at_mark(window_buffer, &input_iter, input_position);
760 gtk_text_buffer_apply_tag_by_name(window_buffer, "input", &input_iter, &end_iter);
763 /* Internal function: Callback for signal activate on the line input GtkEntry
764 in a text grid window. */
766 on_input_entry_activate(GtkEntry *input_entry, winid_t win)
768 g_signal_handler_block(win->widget, win->line_input_keypress_handler);
770 int chars_written = finish_text_grid_line_input(win, TRUE);
771 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
772 event_throw(glk, evtype_LineInput, win, chars_written, 0);
775 /* Internal function: Callback for signal key-press-event on the line input
776 GtkEntry in a text grid window. */
778 on_input_entry_key_press_event(GtkEntry *input_entry, GdkEventKey *event, winid_t win)
780 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up
781 || event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
783 /* Prevent falling off the end of the history list */
784 if( (event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
785 && win->history_pos && win->history_pos->next == NULL)
787 if( (event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
788 && (win->history_pos == NULL || win->history_pos->prev == NULL) )
791 if(win->history_pos == NULL)
793 const gchar *current_input = gtk_entry_get_text(input_entry);
794 win->history = g_list_prepend(win->history, g_strdup(current_input));
795 win->history_pos = win->history;
798 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
801 win->history_pos = g_list_next(win->history_pos);
803 win->history_pos = win->history;
806 win->history_pos = g_list_previous(win->history_pos);
808 /* Insert the history item into the window */
809 g_signal_handler_block(input_entry, win->line_input_entry_changed);
810 gtk_entry_set_text(input_entry, win->history_pos->data);
811 g_signal_handler_unblock(input_entry, win->line_input_entry_changed);
818 on_input_entry_changed(GtkEditable *editable, winid_t win)
820 /* Set the history position to NULL and erase the text we were already editing */
821 if(win->history_pos != NULL)
823 g_free(win->history->data);
824 win->history = g_list_delete_link(win->history, win->history);
825 win->history_pos = NULL;
830 keyval_to_glk_keycode(guint keyval, gboolean unicode)
835 case GDK_KP_Up: return keycode_Up;
837 case GDK_KP_Down: return keycode_Down;
839 case GDK_KP_Left: return keycode_Left;
841 case GDK_KP_Right: return keycode_Right;
844 case GDK_KP_Enter: return keycode_Return;
847 case GDK_KP_Delete: return keycode_Delete;
848 case GDK_Escape: return keycode_Escape;
850 case GDK_KP_Tab: return keycode_Tab;
852 case GDK_KP_Page_Up: return keycode_PageUp;
854 case GDK_KP_Page_Down: return keycode_PageDown;
856 case GDK_KP_Home: return keycode_Home;
858 case GDK_KP_End: return keycode_End;
860 case GDK_KP_F1: return keycode_Func1;
862 case GDK_KP_F2: return keycode_Func2;
864 case GDK_KP_F3: return keycode_Func3;
866 case GDK_KP_F4: return keycode_Func4;
867 case GDK_F5: return keycode_Func5;
868 case GDK_F6: return keycode_Func6;
869 case GDK_F7: return keycode_Func7;
870 case GDK_F8: return keycode_Func8;
871 case GDK_F9: return keycode_Func9;
872 case GDK_F10: return keycode_Func10;
873 case GDK_F11: return keycode_Func11;
874 case GDK_F12: return keycode_Func12;
876 keycode = gdk_keyval_to_unicode(keyval);
877 /* If keycode is 0, then keyval was not recognized; also return
878 unknown if Latin-1 input was requested and the character is not in
880 if(keycode == 0 || (!unicode && keycode > 255))
881 return keycode_Unknown;
887 force_char_input_from_queue(winid_t win, event_t *event)
889 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
890 guint keyval = GPOINTER_TO_UINT(g_async_queue_pop(glk_data->char_input_queue));
892 glk_cancel_char_event(win);
895 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
897 g_signal_emit_by_name(glk, "char-input", win->rock, keyval);
900 event->type = evtype_CharInput;
902 event->val1 = keyval_to_glk_keycode(keyval, win->input_request_type == INPUT_REQUEST_CHARACTER_UNICODE);
907 force_line_input_from_queue(winid_t win, event_t *event)
909 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
910 const gchar *text = g_async_queue_pop(glk_data->line_input_queue);
911 glui32 chars_written = 0;
914 if(win->type == wintype_TextBuffer)
916 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
917 GtkTextIter start, end;
919 /* Remove signal handlers so the line input doesn't get picked up again */
920 g_signal_handler_block(buffer, win->insert_text_handler);
921 g_signal_handler_block(win->widget, win->line_input_keypress_handler);
923 /* Erase any text that was already typed */
924 GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
925 gtk_text_buffer_get_iter_at_mark(buffer, &start, input_position);
926 gtk_text_buffer_get_end_iter(buffer, &end);
927 gtk_text_buffer_delete(buffer, &start, &end);
929 /* Make the window uneditable again */
930 gtk_text_view_set_editable(GTK_TEXT_VIEW(win->widget), FALSE);
932 /* Insert the forced input into the window */
933 if(win->echo_current_line_input)
935 gtk_text_buffer_get_end_iter(buffer, &end);
936 gchar *text_to_insert = g_strconcat(text, "\n", NULL);
937 gtk_text_buffer_insert_with_tags_by_name(buffer, &end, text_to_insert, -1, "default", "input", NULL);
940 chars_written = finish_text_buffer_line_input(win, TRUE);
942 else if(win->type == wintype_TextGrid)
944 /* Remove signal handlers so the line input doesn't get picked up again */
945 g_signal_handler_block(win->widget, win->char_input_keypress_handler);
947 /* Insert the forced input into the window */
948 gtk_entry_set_text(GTK_ENTRY(win->input_entry), text);
949 chars_written = finish_text_grid_line_input(win, TRUE);
953 event->type = evtype_LineInput;
955 event->val1 = chars_written;
959 /*** Internal function: cancels any pending input requests on the window and presents a warning if not INPUT_REQUEST_NONE ***/
961 cancel_old_input_request(winid_t win)
963 switch(win->input_request_type) {
964 case INPUT_REQUEST_NONE:
965 break; /* All is well */
966 case INPUT_REQUEST_CHARACTER:
967 case INPUT_REQUEST_CHARACTER_UNICODE:
968 glk_cancel_char_event(win);
969 WARNING("Cancelling pending char event");
971 case INPUT_REQUEST_LINE:
972 case INPUT_REQUEST_LINE_UNICODE:
973 glk_cancel_line_event(win, NULL);
974 WARNING("Cancelling pending line event");
977 WARNING("Could not cancel pending input request: unknown input request");
982 * glk_set_echo_line_event:
983 * @win: The window in which to change the echoing behavior.
984 * @val: Zero to turn off echoing, nonzero for normal echoing.
986 * Normally, after line input is completed or cancelled in a buffer window, the
987 * library ensures that the complete input line (or its latest state, after
988 * cancelling) is displayed at the end of the buffer, followed by a newline.
989 * This call allows you to suppress this behavior. If the @val argument is zero,
990 * all <emphasis>subsequent</emphasis> line input requests in the given window
991 * will leave the buffer unchanged after the input is completed or cancelled;
992 * the player's input will not be printed. If @val is nonzero, subsequent input
993 * requests will have the normal printing behavior.
996 * Note that this feature is unrelated to the window's echo stream.
999 * If you turn off line input echoing, you can reproduce the standard input
1000 * behavior by following each line input event (or line input cancellation) by
1001 * printing the input line, in the Input style, followed by a newline in the
1004 * The glk_set_echo_line_event() does not affect a pending line input request.
1005 * It also has no effect in non-buffer windows.
1007 * In a grid window, the game can overwrite the input area at will, so there
1008 * is no need for this distinction.
1011 * Not all libraries support this feature. You can test for it with
1012 * %gestalt_LineInputEcho.
1015 glk_set_echo_line_event(winid_t win, glui32 val)
1017 VALID_WINDOW(win, return);
1019 if(win->type != wintype_TextBuffer)
1020 return; /* Quietly do nothing */
1022 win->echo_line_input = val? TRUE : FALSE;
1026 * glk_set_terminators_line_event:
1027 * @win: The window for which to set the line input terminator keys.
1028 * @keycodes: An array of <code>keycode_</code> constants, of length @count.
1029 * @count: The array length of @keycodes.
1031 * It is possible to request that other keystrokes complete line input as well.
1032 * (This allows a game to intercept function keys or other special keys during
1033 * line input.) To do this, call glk_set_terminators_line_event(), and pass an
1034 * array of @count keycodes. These must all be special keycodes (see <link
1035 * linkend="chimara-Character-Input">Character Input</link>). Do not include
1036 * regular printable characters in the array, nor %keycode_Return (which
1037 * represents the default <keycap>enter</keycap> key and will always be
1038 * recognized). To return to the default behavior, pass a %NULL or empty array.
1040 * The glk_set_terminators_line_event() affects <emphasis>subsequent</emphasis>
1041 * line input requests in the given window. It does not affect a pending line
1045 * This distinction makes life easier for interpreters that set up UI
1046 * callbacks only at the start of input.
1049 * A library may not support this feature; if it does, it may not support all
1050 * special keys as terminators. (Some keystrokes are reserved for OS or
1051 * interpreter control.) You can test for this with %gestalt_LineTerminators and
1052 * %gestalt_LineTerminatorKey.
1055 glk_set_terminators_line_event(winid_t win, glui32 *keycodes, glui32 count)
1057 VALID_WINDOW(win, return);