5 #include "chimara-glk-private.h"
8 extern GPrivate *glk_data_key;
10 /* Forward declarations */
11 static int finish_text_buffer_line_input(winid_t win, gboolean emit_signal);
12 static int finish_text_grid_line_input(winid_t win, gboolean emit_signal);
13 static void cancel_old_input_request(winid_t win);
15 /* Internal function: code common to both flavors of char event request */
17 request_char_event_common(winid_t win, gboolean unicode)
19 VALID_WINDOW(win, return);
20 g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
22 cancel_old_input_request(win);
24 flush_window_buffer(win);
26 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
28 win->input_request_type = unicode? INPUT_REQUEST_CHARACTER_UNICODE : INPUT_REQUEST_CHARACTER;
29 g_signal_handler_unblock( win->widget, win->char_input_keypress_handler );
32 gtk_widget_grab_focus( GTK_WIDGET(win->widget) );
35 /* Emit the "waiting" signal to let listeners know we are ready for input */
36 g_signal_emit_by_name(glk_data->self, "waiting");
40 * glk_request_char_event:
41 * @win: A window to request char events from.
43 * Request input of a Latin-1 character or special key. A window cannot have
44 * requests for both character and line input at the same time. Nor can it have
45 * requests for character input of both types (Latin-1 and Unicode). It is
46 * illegal to call glk_request_char_event() if the window already has a pending
47 * request for either character or line input.
50 glk_request_char_event(winid_t win)
52 request_char_event_common(win, FALSE);
56 * glk_request_char_event_uni:
57 * @win: A window to request char events from.
59 * Request input of a Unicode character or special key. See
60 * glk_request_char_event().
63 glk_request_char_event_uni(winid_t win)
65 request_char_event_common(win, TRUE);
69 * glk_cancel_char_event:
70 * @win: A window to cancel the latest char event request on.
72 * This cancels a pending request for character input. (Either Latin-1 or
73 * Unicode.) For convenience, it is legal to call glk_cancel_char_event() even
74 * if there is no charcter input request on that window. Glk will ignore the
78 glk_cancel_char_event(winid_t win)
80 VALID_WINDOW(win, return);
81 g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
83 if(win->input_request_type == INPUT_REQUEST_CHARACTER || win->input_request_type == INPUT_REQUEST_CHARACTER_UNICODE)
85 win->input_request_type = INPUT_REQUEST_NONE;
86 g_signal_handler_block( win->widget, win->char_input_keypress_handler );
90 /* Internal function: Request either latin-1 or unicode line input, in a text grid window. */
92 text_grid_request_line_event_common(winid_t win, glui32 maxlen, gboolean insert, gchar *inserttext)
96 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
98 GtkTextMark *cursor = gtk_text_buffer_get_mark(buffer, "cursor_position");
99 GtkTextIter start_iter, end_iter;
100 gtk_text_buffer_get_iter_at_mark(buffer, &start_iter, cursor);
102 /* Determine the maximum length of the line input */
103 gint cursorpos = gtk_text_iter_get_line_offset(&start_iter);
104 /* Odd; the Glk spec says the maximum input length is
105 windowwidth - 1 - cursorposition. I say no, because if cursorposition is
106 zero, then the input should fill the whole line. FIXME??? */
107 win->input_length = MIN(win->width - cursorpos, win->line_input_buffer_max_len);
108 end_iter = start_iter;
109 gtk_text_iter_set_line_offset(&end_iter, cursorpos + win->input_length);
111 /* If the buffer currently has a selection with one bound in the middle of
112 the input field, then deselect it. Otherwise the input field gets trashed */
113 GtkTextIter start_sel, end_sel;
114 if( gtk_text_buffer_get_selection_bounds(buffer, &start_sel, &end_sel) )
116 if( gtk_text_iter_in_range(&start_sel, &start_iter, &end_iter) )
117 gtk_text_buffer_place_cursor(buffer, &end_sel);
118 if( gtk_text_iter_in_range(&end_sel, &start_iter, &end_iter) )
119 gtk_text_buffer_place_cursor(buffer, &start_sel);
122 /* Erase the text currently in the input field and replace it with a GtkEntry */
123 gtk_text_buffer_delete(buffer, &start_iter, &end_iter);
124 win->input_anchor = gtk_text_buffer_create_child_anchor(buffer, &start_iter);
125 win->input_entry = gtk_entry_new();
126 /* Set the entry's font to match that of the window */
127 GtkRcStyle *style = gtk_widget_get_modifier_style(win->widget); /* Don't free */
128 gtk_widget_modify_font(win->input_entry, style->font_desc);
129 /* Make the entry as small as possible to fit with the text */
130 gtk_entry_set_has_frame(GTK_ENTRY(win->input_entry), FALSE);
131 GtkBorder border = { 0, 0, 0, 0 };
134 #if GTK_CHECK_VERSION(2,10,0)
135 gtk_entry_set_inner_border(GTK_ENTRY(win->input_entry), &border);
137 gtk_entry_set_max_length(GTK_ENTRY(win->input_entry), win->input_length);
138 gtk_entry_set_width_chars(GTK_ENTRY(win->input_entry), win->input_length);
140 /* Insert pre-entered text if needed */
142 gtk_entry_set_text(GTK_ENTRY(win->input_entry), inserttext);
144 /* Set background color of entry (TODO: implement as property) */
146 gdk_color_parse("grey", &background);
147 gtk_widget_modify_base(win->input_entry, GTK_STATE_NORMAL, &background);
149 g_signal_connect(win->input_entry, "activate", G_CALLBACK(on_input_entry_activate), win);
150 g_signal_connect(win->input_entry, "key-press-event", G_CALLBACK(on_input_entry_key_press_event), win);
151 win->line_input_entry_changed = g_signal_connect(win->input_entry, "changed", G_CALLBACK(on_input_entry_changed), win);
153 gtk_widget_show(win->input_entry);
154 gtk_text_view_add_child_at_anchor(GTK_TEXT_VIEW(win->widget), win->input_entry, win->input_anchor);
156 gtk_widget_grab_focus(win->input_entry);
161 /* Internal function: Request either latin-1 or unicode line input, in a text buffer window. */
163 text_buffer_request_line_event_common(winid_t win, glui32 maxlen, gboolean insert, gchar *inserttext)
165 flush_window_buffer(win);
169 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
171 /* Move the input_position mark to the end of the window_buffer */
172 GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
173 GtkTextIter end_iter;
174 gtk_text_buffer_get_end_iter(buffer, &end_iter);
175 gtk_text_buffer_move_mark(buffer, input_position, &end_iter);
177 /* Set the entire contents of the window_buffer as uneditable
178 * (so input can only be entered at the end) */
179 GtkTextIter start_iter;
180 gtk_text_buffer_get_start_iter(buffer, &start_iter);
181 gtk_text_buffer_remove_tag_by_name(buffer, "uneditable", &start_iter, &end_iter);
182 gtk_text_buffer_apply_tag_by_name(buffer, "uneditable", &start_iter, &end_iter);
184 /* Insert pre-entered text if needed */
186 gtk_text_buffer_insert(buffer, &end_iter, inserttext, -1);
187 gtk_text_buffer_get_end_iter(buffer, &end_iter); /* update after text insertion */
190 /* Apply the correct style to the input prompt */
191 GtkTextIter input_iter;
192 gtk_text_buffer_get_iter_at_mark(buffer, &input_iter, input_position);
193 gtk_text_buffer_apply_tag_by_name(buffer, "input", &input_iter, &end_iter);
195 gtk_text_view_set_editable(GTK_TEXT_VIEW(win->widget), TRUE);
197 g_signal_handler_unblock(buffer, win->insert_text_handler);
198 gtk_widget_grab_focus(win->widget);
204 * glk_request_line_event:
205 * @win: A text buffer or text grid window to request line input on.
206 * @buf: A buffer of at least @maxlen bytes.
207 * @maxlen: Length of the buffer.
208 * @initlen: The number of characters in @buf to pre-enter.
210 * Requests input of a line of Latin-1 characters. A window cannot have requests
211 * for both character and line input at the same time. Nor can it have requests
212 * for line input of both types (Latin-1 and Unicode). It is illegal to call
213 * glk_request_line_event() if the window already has a pending request for
214 * either character or line input.
216 * The @buf argument is a pointer to space where the line input will be stored.
217 * (This may not be %NULL.) @maxlen is the length of this space, in bytes; the
218 * library will not accept more characters than this. If @initlen is nonzero,
219 * then the first @initlen bytes of @buf will be entered as pre-existing input
220 * — just as if the player had typed them himself. (The player can continue
221 * composing after this pre-entered input, or delete it or edit as usual.)
223 * The contents of the buffer are undefined until the input is completed (either
224 * by a line input event, or glk_cancel_line_event(). The library may or may not
225 * fill in the buffer as the player composes, while the input is still pending;
226 * it is illegal to change the contents of the buffer yourself.
229 glk_request_line_event(winid_t win, char *buf, glui32 maxlen, glui32 initlen)
231 VALID_WINDOW(win, return);
232 g_return_if_fail(buf);
233 g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
234 g_return_if_fail(initlen <= maxlen);
236 cancel_old_input_request(win);
238 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
240 /* Register the buffer */
241 if(glk_data->register_arr)
242 win->buffer_rock = (*glk_data->register_arr)(buf, maxlen, "&+#!Cn");
244 win->input_request_type = INPUT_REQUEST_LINE;
245 win->line_input_buffer = buf;
246 win->line_input_buffer_max_len = maxlen;
247 win->echo_current_line_input = win->echo_line_input;
248 win->current_extra_line_terminators = g_slist_copy(win->extra_line_terminators);
250 gchar *inserttext = (initlen > 0)? g_strndup(buf, initlen) : g_strdup("");
253 case wintype_TextBuffer:
254 text_buffer_request_line_event_common(win, maxlen, (initlen > 0), inserttext);
256 case wintype_TextGrid:
257 text_grid_request_line_event_common(win, maxlen, (initlen > 0), inserttext);
261 g_signal_handler_unblock(win->widget, win->line_input_keypress_handler);
263 /* Emit the "waiting" signal to let listeners know we are ready for input */
264 g_signal_emit_by_name(glk_data->self, "waiting");
268 * glk_request_line_event_uni:
269 * @win: A text buffer or text grid window to request line input on.
270 * @buf: A buffer of at least @maxlen characters.
271 * @maxlen: Length of the buffer.
272 * @initlen: The number of characters in @buf to pre-enter.
274 * Request input of a line of Unicode characters. This works the same as
275 * glk_request_line_event(), except the result is stored in an array of
276 * <type>glui32</type> values instead of an array of characters, and the values
277 * may be any valid Unicode code points.
279 * If possible, the library should return fully composed Unicode characters,
280 * rather than strings of base and composition characters.
283 * Fully-composed characters are the norm for Unicode text, so an
284 * implementation that ignores this issue will probably produce the right
285 * result. However, the game may not want to rely on that. Another factor is
286 * that case-folding can (occasionally) produce non-normalized text.
287 * Therefore, to cover all its bases, a game should call
288 * glk_buffer_to_lower_case_uni(), followed by
289 * glk_buffer_canon_normalize_uni(), before parsing.
293 * Earlier versions of this spec said that line input must always be in
294 * Unicode Normalization Form C. However, this has not been universally
295 * implemented. It is also somewhat redundant, for the results noted above.
296 * Therefore, we now merely recommend that line input be fully composed. The
297 * game is ultimately responsible for all case-folding and normalization. See
298 * <link linkend="chimara-Unicode-String-Normalization">Unicode String
299 * Normalization</link>.
303 glk_request_line_event_uni(winid_t win, glui32 *buf, glui32 maxlen, glui32 initlen)
305 VALID_WINDOW(win, return);
306 g_return_if_fail(buf);
307 g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
308 g_return_if_fail(initlen <= maxlen);
310 cancel_old_input_request(win);
311 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
313 /* Register the buffer */
314 if(glk_data->register_arr)
315 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;
320 win->current_extra_line_terminators = g_slist_copy(win->extra_line_terminators);
324 utf8 = convert_ucs4_to_utf8(buf, initlen);
333 case wintype_TextBuffer:
334 text_buffer_request_line_event_common(win, maxlen, (initlen > 0), utf8);
336 case wintype_TextGrid:
337 text_grid_request_line_event_common(win, maxlen, (initlen > 0), utf8);
340 g_signal_handler_unblock(win->widget, win->line_input_keypress_handler);
343 /* Emit the "waiting" signal to let listeners know we are ready for input */
344 g_signal_emit_by_name(glk_data->self, "waiting");
348 * glk_cancel_line_event:
349 * @win: A text buffer or text grid window to cancel line input on.
350 * @event: Will be filled in if the user had already input something.
352 * This cancels a pending request for line input. (Either Latin-1 or Unicode.)
354 * The event pointed to by the event argument will be filled in as if the
355 * player had hit <keycap>enter</keycap>, and the input composed so far will be
356 * stored in the buffer; see below. If you do not care about this information,
357 * pass %NULL as the @event argument. (The buffer will still be filled.)
359 * For convenience, it is legal to call glk_cancel_line_event() even if there
360 * is no line input request on that window. The event type will be set to
361 * %evtype_None in this case.
364 glk_cancel_line_event(winid_t win, event_t *event)
366 VALID_WINDOW(win, return);
367 g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
370 event->type = evtype_None;
376 if(win->input_request_type != INPUT_REQUEST_LINE && win->input_request_type != INPUT_REQUEST_LINE_UNICODE)
379 g_signal_handler_block( win->widget, win->line_input_keypress_handler );
381 int chars_written = 0;
384 if(win->type == wintype_TextGrid) {
385 chars_written = finish_text_grid_line_input(win, FALSE);
386 } else if(win->type == wintype_TextBuffer) {
387 gtk_text_view_set_editable( GTK_TEXT_VIEW(win->widget), FALSE );
388 GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
389 g_signal_handler_block(window_buffer, win->insert_text_handler);
390 chars_written = finish_text_buffer_line_input(win, FALSE);
394 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
395 if(glk_data->unregister_arr)
397 if(win->input_request_type == INPUT_REQUEST_LINE_UNICODE)
398 (*glk_data->unregister_arr)(win->line_input_buffer_unicode, win->line_input_buffer_max_len, "&+#!Iu", win->buffer_rock);
400 (*glk_data->unregister_arr)(win->line_input_buffer, win->line_input_buffer_max_len, "&+#!Cn", win->buffer_rock);
403 if(event != NULL && chars_written > 0) {
404 event->type = evtype_LineInput;
405 event->val1 = chars_written;
409 /* Helper function: Turn off shutdown key-press-event signal handler */
411 turn_off_handler(GNode *node)
413 winid_t win = node->data;
414 g_signal_handler_block(win->widget, win->shutdown_keypress_handler);
415 return FALSE; /* don't stop */
418 /* Internal function: Callback for signal key-press-event while waiting for shutdown. */
420 on_shutdown_key_press_event(GtkWidget *widget, GdkEventKey *event, winid_t win)
422 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(widget, CHIMARA_TYPE_GLK));
424 CHIMARA_GLK_USE_PRIVATE(glk, priv);
426 /* Turn off all the signal handlers */
427 if(priv->root_window)
428 g_node_traverse(priv->root_window, G_IN_ORDER, G_TRAVERSE_LEAVES, -1, (GNodeTraverseFunc)turn_off_handler, NULL);
430 /* Signal the Glk library that it can shut everything down now */
431 g_mutex_lock(priv->shutdown_lock);
432 g_cond_signal(priv->shutdown_key_pressed);
433 g_mutex_unlock(priv->shutdown_lock);
435 return TRUE; /* block the event */
438 /* 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. */
440 on_char_input_key_press_event(GtkWidget *widget, GdkEventKey *event, winid_t win)
442 /* Ignore modifier keys, otherwise the char input will already trigger on
443 the shift key when the user tries to type a capital letter */
444 if(event->is_modifier)
445 return FALSE; /* don't stop the event */
447 /* All text up to the input position is now regarded as being read by the user */
448 if(win->type == wintype_TextBuffer)
451 glui32 keycode = keyval_to_glk_keycode(event->keyval, win->input_request_type == INPUT_REQUEST_CHARACTER_UNICODE);
453 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(widget, CHIMARA_TYPE_GLK));
455 event_throw(glk, evtype_CharInput, win, keycode, 0);
456 g_signal_emit_by_name(glk, "char-input", win->rock, event->keyval);
458 /* Only one keypress will be handled */
459 win->input_request_type = INPUT_REQUEST_NONE;
460 g_signal_handler_block(win->widget, win->char_input_keypress_handler);
466 on_line_input_key_press_event(GtkWidget *widget, GdkEventKey *event, winid_t win)
470 case wintype_TextBuffer:
471 /* All text up to the input position is now regarded as being read by the user */
474 /* History up/down */
475 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up
476 || event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
478 /* Prevent falling off the end of the history list */
479 if(win->history == NULL)
481 if( (event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
482 && win->history_pos && win->history_pos->next == NULL)
484 if( (event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
485 && (win->history_pos == NULL || win->history_pos->prev == NULL) )
488 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
489 GtkTextIter start, end;
490 /* Erase any text that was already typed */
491 GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
492 gtk_text_buffer_get_iter_at_mark(buffer, &start, input_position);
493 gtk_text_buffer_get_end_iter(buffer, &end);
495 if(win->history_pos == NULL) {
496 gchar *current_input = gtk_text_buffer_get_text(buffer, &start, &end, FALSE);
497 win->history = g_list_prepend(win->history, current_input);
498 win->history_pos = win->history;
501 gtk_text_buffer_delete(buffer, &start, &end);
503 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
506 win->history_pos = g_list_next(win->history_pos);
508 win->history_pos = win->history;
511 win->history_pos = g_list_previous(win->history_pos);
513 /* Insert the history item into the window */
514 gtk_text_buffer_get_end_iter(buffer, &end);
516 g_signal_handler_block(buffer, win->insert_text_handler);
517 gtk_text_buffer_insert_with_tags_by_name(buffer, &end, win->history_pos->data, -1, "default", "input", NULL);
518 g_signal_handler_unblock(buffer, win->insert_text_handler);
522 /* Move to beginning/end of input field */
523 else if(event->keyval == GDK_Home) {
524 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
525 GtkTextIter input_iter;
526 GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
527 gtk_text_buffer_get_iter_at_mark(buffer, &input_iter, input_position);
528 gtk_text_buffer_place_cursor(buffer, &input_iter);
531 else if(event->keyval == GDK_End) {
532 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
533 GtkTextIter end_iter;
534 gtk_text_buffer_get_end_iter(buffer, &end_iter);
535 gtk_text_buffer_place_cursor(buffer, &end_iter);
539 /* Handle the enter key, which could occur in the middle of the sentence. */
540 else if(event->keyval == GDK_Return || event->keyval == GDK_KP_Enter) {
541 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
542 GtkTextIter end_iter;
543 gtk_text_buffer_get_end_iter(buffer, &end_iter);
544 gtk_text_buffer_place_cursor(buffer, &end_iter);
550 /* If this is a text grid window, then redirect the key press to the line input GtkEntry */
551 case wintype_TextGrid:
553 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up
554 || event->keyval == GDK_Down || event->keyval == GDK_KP_Down
555 || event->keyval == GDK_Left || event->keyval == GDK_KP_Left
556 || event->keyval == GDK_Right || event->keyval == GDK_KP_Right
557 || event->keyval == GDK_Tab || event->keyval == GDK_KP_Tab
558 || event->keyval == GDK_Page_Up || event->keyval == GDK_KP_Page_Up
559 || event->keyval == GDK_Page_Down || event->keyval == GDK_KP_Page_Down
560 || event->keyval == GDK_Home || event->keyval == GDK_KP_Home
561 || event->keyval == GDK_End || event->keyval == GDK_KP_End)
562 return FALSE; /* Don't redirect these keys */
563 gtk_widget_grab_focus(win->input_entry);
564 gtk_editable_set_position(GTK_EDITABLE(win->input_entry), -1);
565 gboolean retval = TRUE;
566 g_signal_emit_by_name(win->input_entry, "key-press-event", event, &retval);
567 return retval; /* Block this key event if the entry handled it */
573 /* Internal function: finish handling a line input request, for both text grid and text buffer windows. */
575 write_to_window_buffer(winid_t win, const gchar *inserted_text)
579 /* Convert the string from UTF-8 to Latin-1 or Unicode */
580 if(win->input_request_type == INPUT_REQUEST_LINE)
583 gchar *latin1 = convert_utf8_to_latin1(inserted_text, &bytes_written);
588 /* Place input in the echo stream */
589 if(win->echo_stream != NULL)
590 glk_put_string_stream(win->echo_stream, latin1);
592 /* Copy the string (bytes_written does not include the NULL at the end) */
593 copycount = MIN(win->line_input_buffer_max_len, bytes_written);
594 memcpy(win->line_input_buffer, latin1, copycount);
597 else if(win->input_request_type == INPUT_REQUEST_LINE_UNICODE)
600 gunichar *unicode = convert_utf8_to_ucs4(inserted_text, &items_written);
605 /* Place input in the echo stream */
606 if(win->echo_stream != NULL)
607 glk_put_string_stream_uni(win->echo_stream, unicode);
609 /* Copy the string (but not the NULL at the end) */
610 copycount = MIN(win->line_input_buffer_max_len, items_written);
611 memcpy(win->line_input_buffer_unicode, unicode, copycount * sizeof(gunichar));
615 WARNING("Wrong input request type");
617 win->input_request_type = INPUT_REQUEST_NONE;
621 /* Internal function: Retrieves the input of a TextBuffer window and stores it in the window buffer.
622 * Returns the number of characters written, suitable for inclusion in a line input event. */
624 finish_text_buffer_line_input(winid_t win, gboolean emit_signal)
626 VALID_WINDOW(win, return 0);
627 g_return_val_if_fail(win->type == wintype_TextBuffer, 0);
629 GtkTextIter start_iter, end_iter;
631 GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
632 GtkTextMark *input_position = gtk_text_buffer_get_mark(window_buffer, "input_position");
633 gtk_text_buffer_get_iter_at_mark(window_buffer, &start_iter, input_position);
634 gtk_text_buffer_get_end_iter(window_buffer, &end_iter);
636 gchar *inserted_text = gtk_text_buffer_get_text(window_buffer, &start_iter, &end_iter, FALSE);
638 /* If echoing is turned off, remove the text from the window */
639 if(!win->echo_current_line_input)
640 gtk_text_buffer_delete(window_buffer, &start_iter, &end_iter);
642 /* Don't include the newline in the input */
643 char *last_char = inserted_text + strlen(inserted_text) - 1;
644 if(*last_char == '\n')
647 int chars_written = write_to_window_buffer(win, inserted_text);
650 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
652 g_signal_emit_by_name(glk, "line-input", win->rock, inserted_text);
655 /* Add the text to the window input history */
656 if(win->history_pos != NULL)
658 g_free(win->history->data);
659 win->history = g_list_delete_link(win->history, win->history);
661 if(*inserted_text != 0)
662 win->history = g_list_prepend(win->history, g_strdup(inserted_text));
664 win->history_pos = NULL;
666 g_free(inserted_text);
668 return chars_written;
671 /* Internal function: Retrieves the input of a TextGrid window and stores it in the window buffer.
672 * Returns the number of characters written, suitable for inclusion in a line input event. */
674 finish_text_grid_line_input(winid_t win, gboolean emit_signal)
676 VALID_WINDOW(win, return 0);
677 g_return_val_if_fail(win->type == wintype_TextGrid, 0);
679 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
681 gchar *text = g_strdup( gtk_entry_get_text(GTK_ENTRY(win->input_entry)) );
682 /* Move the focus back into the text view */
683 gtk_widget_grab_focus(win->widget);
684 /* Remove entry widget from text view */
685 /* Should be ok even though this is the widget's own signal handler */
686 gtk_container_remove( GTK_CONTAINER(win->widget), GTK_WIDGET(win->input_entry) );
687 win->input_entry = NULL;
688 /* Delete the child anchor */
689 GtkTextIter start, end;
690 gtk_text_buffer_get_iter_at_child_anchor(buffer, &start, win->input_anchor);
692 gtk_text_iter_forward_char(&end); /* Point after the child anchor */
693 gtk_text_buffer_delete(buffer, &start, &end);
694 win->input_anchor = NULL;
696 gchar *spaces = g_strnfill(win->input_length - g_utf8_strlen(text, -1), ' ');
697 gchar *text_to_insert = g_strconcat(text, spaces, NULL);
699 gtk_text_buffer_insert(buffer, &start, text_to_insert, -1);
700 g_free(text_to_insert);
702 int chars_written = write_to_window_buffer(win, text);
705 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
707 g_signal_emit_by_name(glk, "line-input", win->rock, text);
710 /* Add the text to the window input history */
711 if(win->history_pos != NULL)
713 g_free(win->history->data);
714 win->history = g_list_delete_link(win->history, win->history);
717 win->history = g_list_prepend(win->history, g_strdup(text));
718 win->history_pos = NULL;
721 return chars_written;
724 /* Internal function: Callback for signal insert-text on a text buffer window.
725 Runs after the default handler has already inserted the text.
726 FIXME: This function assumes that newline was the last character typed into the
727 window. That assumption is wrong if, for example, text containing a newline was
728 pasted into the window. */
730 after_window_insert_text(GtkTextBuffer *textbuffer, GtkTextIter *location, gchar *text, gint len, winid_t win)
732 GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
734 /* Set the history position to NULL and erase the text we were already editing */
735 if(win->history_pos != NULL)
737 g_free(win->history->data);
738 win->history = g_list_delete_link(win->history, win->history);
739 win->history_pos = NULL;
741 if( strchr(text, '\n') != NULL )
743 /* Remove signal handlers */
744 g_signal_handler_block(window_buffer, win->insert_text_handler);
745 g_signal_handler_block(win->widget, win->line_input_keypress_handler);
747 /* Make the window uneditable again and retrieve the text that was input */
748 gtk_text_view_set_editable(GTK_TEXT_VIEW(win->widget), FALSE);
750 int chars_written = finish_text_buffer_line_input(win, TRUE);
751 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
752 event_throw(glk, evtype_LineInput, win, chars_written, 0);
755 /* Apply the 'input' style to the text that was entered */
756 GtkTextIter end_iter;
757 gtk_text_buffer_get_end_iter(window_buffer, &end_iter);
758 GtkTextIter input_iter;
759 GtkTextMark *input_position = gtk_text_buffer_get_mark(window_buffer, "input_position");
760 gtk_text_buffer_get_iter_at_mark(window_buffer, &input_iter, input_position);
761 gtk_text_buffer_apply_tag_by_name(window_buffer, "input", &input_iter, &end_iter);
764 /* Internal function: Callback for signal activate on the line input GtkEntry
765 in a text grid window. */
767 on_input_entry_activate(GtkEntry *input_entry, winid_t win)
769 g_signal_handler_block(win->widget, win->line_input_keypress_handler);
771 int chars_written = finish_text_grid_line_input(win, TRUE);
772 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
773 event_throw(glk, evtype_LineInput, win, chars_written, 0);
776 /* Internal function: Callback for signal key-press-event on the line input
777 GtkEntry in a text grid window. */
779 on_input_entry_key_press_event(GtkEntry *input_entry, GdkEventKey *event, winid_t win)
781 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up
782 || event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
784 /* Prevent falling off the end of the history list */
785 if( (event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
786 && win->history_pos && win->history_pos->next == NULL)
788 if( (event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
789 && (win->history_pos == NULL || win->history_pos->prev == NULL) )
792 if(win->history_pos == NULL)
794 const gchar *current_input = gtk_entry_get_text(input_entry);
795 win->history = g_list_prepend(win->history, g_strdup(current_input));
796 win->history_pos = win->history;
799 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
802 win->history_pos = g_list_next(win->history_pos);
804 win->history_pos = win->history;
807 win->history_pos = g_list_previous(win->history_pos);
809 /* Insert the history item into the window */
810 g_signal_handler_block(input_entry, win->line_input_entry_changed);
811 gtk_entry_set_text(input_entry, win->history_pos->data);
812 g_signal_handler_unblock(input_entry, win->line_input_entry_changed);
819 on_input_entry_changed(GtkEditable *editable, winid_t win)
821 /* Set the history position to NULL and erase the text we were already editing */
822 if(win->history_pos != NULL)
824 g_free(win->history->data);
825 win->history = g_list_delete_link(win->history, win->history);
826 win->history_pos = NULL;
831 keyval_to_glk_keycode(guint keyval, gboolean unicode)
836 case GDK_KP_Up: return keycode_Up;
838 case GDK_KP_Down: return keycode_Down;
840 case GDK_KP_Left: return keycode_Left;
842 case GDK_KP_Right: return keycode_Right;
845 case GDK_KP_Enter: return keycode_Return;
848 case GDK_KP_Delete: return keycode_Delete;
849 case GDK_Escape: return keycode_Escape;
851 case GDK_KP_Tab: return keycode_Tab;
853 case GDK_KP_Page_Up: return keycode_PageUp;
855 case GDK_KP_Page_Down: return keycode_PageDown;
857 case GDK_KP_Home: return keycode_Home;
859 case GDK_KP_End: return keycode_End;
861 case GDK_KP_F1: return keycode_Func1;
863 case GDK_KP_F2: return keycode_Func2;
865 case GDK_KP_F3: return keycode_Func3;
867 case GDK_KP_F4: return keycode_Func4;
868 case GDK_F5: return keycode_Func5;
869 case GDK_F6: return keycode_Func6;
870 case GDK_F7: return keycode_Func7;
871 case GDK_F8: return keycode_Func8;
872 case GDK_F9: return keycode_Func9;
873 case GDK_F10: return keycode_Func10;
874 case GDK_F11: return keycode_Func11;
875 case GDK_F12: return keycode_Func12;
877 keycode = gdk_keyval_to_unicode(keyval);
878 /* If keycode is 0, then keyval was not recognized; also return
879 unknown if Latin-1 input was requested and the character is not in
881 if(keycode == 0 || (!unicode && keycode > 255))
882 return keycode_Unknown;
888 force_char_input_from_queue(winid_t win, event_t *event)
890 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
891 guint keyval = GPOINTER_TO_UINT(g_async_queue_pop(glk_data->char_input_queue));
893 glk_cancel_char_event(win);
896 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
898 g_signal_emit_by_name(glk, "char-input", win->rock, keyval);
901 event->type = evtype_CharInput;
903 event->val1 = keyval_to_glk_keycode(keyval, win->input_request_type == INPUT_REQUEST_CHARACTER_UNICODE);
908 force_line_input_from_queue(winid_t win, event_t *event)
910 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
911 const gchar *text = g_async_queue_pop(glk_data->line_input_queue);
912 glui32 chars_written = 0;
915 if(win->type == wintype_TextBuffer)
917 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
918 GtkTextIter start, end;
920 /* Remove signal handlers so the line input doesn't get picked up again */
921 g_signal_handler_block(buffer, win->insert_text_handler);
922 g_signal_handler_block(win->widget, win->line_input_keypress_handler);
924 /* Erase any text that was already typed */
925 GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
926 gtk_text_buffer_get_iter_at_mark(buffer, &start, input_position);
927 gtk_text_buffer_get_end_iter(buffer, &end);
928 gtk_text_buffer_delete(buffer, &start, &end);
930 /* Make the window uneditable again */
931 gtk_text_view_set_editable(GTK_TEXT_VIEW(win->widget), FALSE);
933 /* Insert the forced input into the window */
934 if(win->echo_current_line_input)
936 gtk_text_buffer_get_end_iter(buffer, &end);
937 gchar *text_to_insert = g_strconcat(text, "\n", NULL);
938 gtk_text_buffer_insert_with_tags_by_name(buffer, &end, text_to_insert, -1, "default", "input", NULL);
941 chars_written = finish_text_buffer_line_input(win, TRUE);
943 else if(win->type == wintype_TextGrid)
945 /* Remove signal handlers so the line input doesn't get picked up again */
946 g_signal_handler_block(win->widget, win->char_input_keypress_handler);
948 /* Insert the forced input into the window */
949 gtk_entry_set_text(GTK_ENTRY(win->input_entry), text);
950 chars_written = finish_text_grid_line_input(win, TRUE);
954 event->type = evtype_LineInput;
956 event->val1 = chars_written;
960 /*** Internal function: cancels any pending input requests on the window and presents a warning if not INPUT_REQUEST_NONE ***/
962 cancel_old_input_request(winid_t win)
964 switch(win->input_request_type) {
965 case INPUT_REQUEST_NONE:
966 break; /* All is well */
967 case INPUT_REQUEST_CHARACTER:
968 case INPUT_REQUEST_CHARACTER_UNICODE:
969 glk_cancel_char_event(win);
970 WARNING("Cancelling pending char event");
972 case INPUT_REQUEST_LINE:
973 case INPUT_REQUEST_LINE_UNICODE:
974 glk_cancel_line_event(win, NULL);
975 WARNING("Cancelling pending line event");
978 WARNING("Could not cancel pending input request: unknown input request");
983 * glk_set_echo_line_event:
984 * @win: The window in which to change the echoing behavior.
985 * @val: Zero to turn off echoing, nonzero for normal echoing.
987 * Normally, after line input is completed or cancelled in a buffer window, the
988 * library ensures that the complete input line (or its latest state, after
989 * cancelling) is displayed at the end of the buffer, followed by a newline.
990 * This call allows you to suppress this behavior. If the @val argument is zero,
991 * all <emphasis>subsequent</emphasis> line input requests in the given window
992 * will leave the buffer unchanged after the input is completed or cancelled;
993 * the player's input will not be printed. If @val is nonzero, subsequent input
994 * requests will have the normal printing behavior.
997 * Note that this feature is unrelated to the window's echo stream.
1000 * If you turn off line input echoing, you can reproduce the standard input
1001 * behavior by following each line input event (or line input cancellation) by
1002 * printing the input line, in the Input style, followed by a newline in the
1005 * The glk_set_echo_line_event() does not affect a pending line input request.
1006 * It also has no effect in non-buffer windows.
1008 * In a grid window, the game can overwrite the input area at will, so there
1009 * is no need for this distinction.
1012 * Not all libraries support this feature. You can test for it with
1013 * %gestalt_LineInputEcho.
1016 glk_set_echo_line_event(winid_t win, glui32 val)
1018 VALID_WINDOW(win, return);
1020 if(win->type != wintype_TextBuffer)
1021 return; /* Quietly do nothing */
1023 win->echo_line_input = val? TRUE : FALSE;
1026 /* Internal function to convert from a Glk keycode to a GDK keyval. */
1028 keycode_to_gdk_keyval(glui32 keycode)
1040 case keycode_Return:
1042 case keycode_Delete:
1044 case keycode_Escape:
1048 case keycode_PageUp:
1050 case keycode_PageDown:
1051 return GDK_Page_Down;
1074 case keycode_Func10:
1076 case keycode_Func11:
1078 case keycode_Func12:
1081 return GDK_BackSpace;
1083 unsigned keyval = gdk_unicode_to_keyval(keycode);
1084 if(keyval < 0x01000000) /* magic number meaning illegal unicode point */
1089 /* Internal function to decide whether @keycode is a valid line terminator. */
1091 is_valid_line_terminator(glui32 keycode)
1100 * glk_set_terminators_line_event:
1101 * @win: The window for which to set the line input terminator keys.
1102 * @keycodes: An array of <code>keycode_</code> constants, of length @count.
1103 * @count: The array length of @keycodes.
1105 * It is possible to request that other keystrokes complete line input as well.
1106 * (This allows a game to intercept function keys or other special keys during
1107 * line input.) To do this, call glk_set_terminators_line_event(), and pass an
1108 * array of @count keycodes. These must all be special keycodes (see <link
1109 * linkend="chimara-Character-Input">Character Input</link>). Do not include
1110 * regular printable characters in the array, nor %keycode_Return (which
1111 * represents the default <keycap>enter</keycap> key and will always be
1112 * recognized). To return to the default behavior, pass a %NULL or empty array.
1114 * The glk_set_terminators_line_event() affects <emphasis>subsequent</emphasis>
1115 * line input requests in the given window. It does not affect a pending line
1119 * This distinction makes life easier for interpreters that set up UI
1120 * callbacks only at the start of input.
1123 * A library may not support this feature; if it does, it may not support all
1124 * special keys as terminators. (Some keystrokes are reserved for OS or
1125 * interpreter control.) You can test for this with %gestalt_LineTerminators and
1126 * %gestalt_LineTerminatorKey.
1129 glk_set_terminators_line_event(winid_t win, glui32 *keycodes, glui32 count)
1131 VALID_WINDOW(win, return);
1133 g_slist_free(win->extra_line_terminators);
1134 win->extra_line_terminators = NULL;
1136 if(keycodes == NULL || count == 0)
1140 for(i = 0; i < count; i++)
1142 unsigned key = keycode_to_gdk_keyval(keycodes[i]);
1143 if(is_valid_line_terminator(keycodes[i]))
1144 win->extra_line_terminators = g_slist_prepend(win->extra_line_terminators, GUINT_TO_POINTER(key));
1146 WARNING_S("Ignoring invalid line terminator", gdk_keyval_name(key));