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 };
130 gtk_entry_set_inner_border(GTK_ENTRY(win->input_entry), &border);
131 gtk_entry_set_max_length(GTK_ENTRY(win->input_entry), win->input_length);
132 gtk_entry_set_width_chars(GTK_ENTRY(win->input_entry), win->input_length);
134 /* Insert pre-entered text if needed */
136 gtk_entry_set_text(GTK_ENTRY(win->input_entry), inserttext);
138 /* Set background color of entry (TODO: implement as property) */
140 gdk_color_parse("grey", &background);
141 gtk_widget_modify_base(win->input_entry, GTK_STATE_NORMAL, &background);
143 g_signal_connect(win->input_entry, "activate", G_CALLBACK(on_input_entry_activate), win);
144 g_signal_connect(win->input_entry, "key-press-event", G_CALLBACK(on_input_entry_key_press_event), win);
145 win->line_input_entry_changed = g_signal_connect(win->input_entry, "changed", G_CALLBACK(on_input_entry_changed), win);
147 gtk_widget_show(win->input_entry);
148 gtk_text_view_add_child_at_anchor(GTK_TEXT_VIEW(win->widget), win->input_entry, win->input_anchor);
150 gtk_widget_grab_focus(win->input_entry);
155 /* Internal function: Request either latin-1 or unicode line input, in a text buffer window. */
157 text_buffer_request_line_event_common(winid_t win, glui32 maxlen, gboolean insert, gchar *inserttext)
159 flush_window_buffer(win);
163 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
165 /* Move the input_position mark to the end of the window_buffer */
166 GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
167 GtkTextIter end_iter;
168 gtk_text_buffer_get_end_iter(buffer, &end_iter);
169 gtk_text_buffer_move_mark(buffer, input_position, &end_iter);
171 /* Set the entire contents of the window_buffer as uneditable
172 * (so input can only be entered at the end) */
173 GtkTextIter start_iter;
174 gtk_text_buffer_get_start_iter(buffer, &start_iter);
175 gtk_text_buffer_remove_tag_by_name(buffer, "uneditable", &start_iter, &end_iter);
176 gtk_text_buffer_apply_tag_by_name(buffer, "uneditable", &start_iter, &end_iter);
178 /* Insert pre-entered text if needed */
180 gtk_text_buffer_insert(buffer, &end_iter, inserttext, -1);
181 gtk_text_buffer_get_end_iter(buffer, &end_iter); /* update after text insertion */
184 /* Apply the correct style to the input prompt */
185 GtkTextIter input_iter;
186 gtk_text_buffer_get_iter_at_mark(buffer, &input_iter, input_position);
187 gtk_text_buffer_apply_tag_by_name(buffer, "input", &input_iter, &end_iter);
189 gtk_text_view_set_editable(GTK_TEXT_VIEW(win->widget), TRUE);
191 g_signal_handler_unblock(buffer, win->insert_text_handler);
192 gtk_widget_grab_focus(win->widget);
198 * glk_request_line_event:
199 * @win: A text buffer or text grid window to request line input on.
200 * @buf: A buffer of at least @maxlen bytes.
201 * @maxlen: Length of the buffer.
202 * @initlen: The number of characters in @buf to pre-enter.
204 * Requests input of a line of Latin-1 characters. A window cannot have requests
205 * for both character and line input at the same time. Nor can it have requests
206 * for line input of both types (Latin-1 and Unicode). It is illegal to call
207 * glk_request_line_event() if the window already has a pending request for
208 * either character or line input.
210 * The @buf argument is a pointer to space where the line input will be stored.
211 * (This may not be %NULL.) @maxlen is the length of this space, in bytes; the
212 * library will not accept more characters than this. If @initlen is nonzero,
213 * then the first @initlen bytes of @buf will be entered as pre-existing input
214 * — just as if the player had typed them himself. (The player can continue
215 * composing after this pre-entered input, or delete it or edit as usual.)
217 * The contents of the buffer are undefined until the input is completed (either
218 * by a line input event, or glk_cancel_line_event(). The library may or may not
219 * fill in the buffer as the player composes, while the input is still pending;
220 * it is illegal to change the contents of the buffer yourself.
223 glk_request_line_event(winid_t win, char *buf, glui32 maxlen, glui32 initlen)
225 VALID_WINDOW(win, return);
226 g_return_if_fail(buf);
227 g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
228 g_return_if_fail(initlen <= maxlen);
230 cancel_old_input_request(win);
232 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
234 /* Register the buffer */
235 if(glk_data->register_arr)
236 win->buffer_rock = (*glk_data->register_arr)(buf, maxlen, "&+#!Cn");
238 win->input_request_type = INPUT_REQUEST_LINE;
239 win->line_input_buffer = buf;
240 win->line_input_buffer_max_len = maxlen;
242 gchar *inserttext = (initlen > 0)? g_strndup(buf, initlen) : g_strdup("");
245 case wintype_TextBuffer:
246 text_buffer_request_line_event_common(win, maxlen, (initlen > 0), inserttext);
248 case wintype_TextGrid:
249 text_grid_request_line_event_common(win, maxlen, (initlen > 0), inserttext);
253 g_signal_handler_unblock(win->widget, win->line_input_keypress_handler);
255 /* Emit the "waiting" signal to let listeners know we are ready for input */
256 g_signal_emit_by_name(glk_data->self, "waiting");
260 * glk_request_line_event_uni:
261 * @win: A text buffer or text grid window to request line input on.
262 * @buf: A buffer of at least @maxlen characters.
263 * @maxlen: Length of the buffer.
264 * @initlen: The number of characters in @buf to pre-enter.
266 * Request input of a line of Unicode characters. This works the same as
267 * glk_request_line_event(), except the result is stored in an array of
268 * <type>glui32</type> values instead of an array of characters, and the values
269 * may be any valid Unicode code points.
271 * The result will be in Unicode Normalization Form C. This basically means that
272 * composite characters will be single characters where possible, instead of
273 * sequences of base and combining marks. See
274 * <ulink url="http://www.unicode.org/reports/tr15/">Unicode Standard Annex
275 * #15</ulink> for the details.
278 glk_request_line_event_uni(winid_t win, glui32 *buf, glui32 maxlen, glui32 initlen)
280 VALID_WINDOW(win, return);
281 g_return_if_fail(buf);
282 g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
283 g_return_if_fail(initlen <= maxlen);
285 cancel_old_input_request(win);
286 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
288 /* Register the buffer */
289 if(glk_data->register_arr)
290 win->buffer_rock = (*glk_data->register_arr)(buf, maxlen, "&+#!Iu");
292 win->input_request_type = INPUT_REQUEST_LINE_UNICODE;
293 win->line_input_buffer_unicode = buf;
294 win->line_input_buffer_max_len = maxlen;
298 utf8 = convert_ucs4_to_utf8(buf, initlen);
307 case wintype_TextBuffer:
308 text_buffer_request_line_event_common(win, maxlen, (initlen > 0), utf8);
310 case wintype_TextGrid:
311 text_grid_request_line_event_common(win, maxlen, (initlen > 0), utf8);
314 g_signal_handler_unblock(win->widget, win->line_input_keypress_handler);
317 /* Emit the "waiting" signal to let listeners know we are ready for input */
318 g_signal_emit_by_name(glk_data->self, "waiting");
322 * glk_cancel_line_event:
323 * @win: A text buffer or text grid window to cancel line input on.
324 * @event: Will be filled in if the user had already input something.
326 * This cancels a pending request for line input. (Either Latin-1 or Unicode.)
328 * The event pointed to by the event argument will be filled in as if the
329 * player had hit <keycap>enter</keycap>, and the input composed so far will be
330 * stored in the buffer; see below. If you do not care about this information,
331 * pass %NULL as the @event argument. (The buffer will still be filled.)
333 * For convenience, it is legal to call glk_cancel_line_event() even if there
334 * is no line input request on that window. The event type will be set to
335 * %evtype_None in this case.
338 glk_cancel_line_event(winid_t win, event_t *event)
340 VALID_WINDOW(win, return);
341 g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
344 event->type = evtype_None;
350 if(win->input_request_type != INPUT_REQUEST_LINE && win->input_request_type != INPUT_REQUEST_LINE_UNICODE)
353 g_signal_handler_block( win->widget, win->line_input_keypress_handler );
355 int chars_written = 0;
358 if(win->type == wintype_TextGrid) {
359 chars_written = finish_text_grid_line_input(win, FALSE);
360 } else if(win->type == wintype_TextBuffer) {
361 gtk_text_view_set_editable( GTK_TEXT_VIEW(win->widget), FALSE );
362 GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
363 g_signal_handler_block(window_buffer, win->insert_text_handler);
364 chars_written = finish_text_buffer_line_input(win, FALSE);
368 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
369 if(glk_data->unregister_arr)
371 if(win->input_request_type == INPUT_REQUEST_LINE_UNICODE)
372 (*glk_data->unregister_arr)(win->line_input_buffer_unicode, win->line_input_buffer_max_len, "&+#!Iu", win->buffer_rock);
374 (*glk_data->unregister_arr)(win->line_input_buffer, win->line_input_buffer_max_len, "&+#!Cn", win->buffer_rock);
377 if(event != NULL && chars_written > 0) {
378 event->type = evtype_LineInput;
379 event->val1 = chars_written;
383 /* Helper function: Turn off shutdown key-press-event signal handler */
385 turn_off_handler(GNode *node)
387 winid_t win = node->data;
388 g_signal_handler_block(win->widget, win->shutdown_keypress_handler);
389 return FALSE; /* don't stop */
392 /* Internal function: Callback for signal key-press-event while waiting for shutdown. */
394 on_shutdown_key_press_event(GtkWidget *widget, GdkEventKey *event, winid_t win)
396 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(widget, CHIMARA_TYPE_GLK));
398 CHIMARA_GLK_USE_PRIVATE(glk, priv);
400 /* Turn off all the signal handlers */
401 if(priv->root_window)
402 g_node_traverse(priv->root_window, G_IN_ORDER, G_TRAVERSE_LEAVES, -1, (GNodeTraverseFunc)turn_off_handler, NULL);
404 /* Signal the Glk library that it can shut everything down now */
405 g_mutex_lock(priv->shutdown_lock);
406 g_cond_signal(priv->shutdown_key_pressed);
407 g_mutex_unlock(priv->shutdown_lock);
409 return TRUE; /* block the event */
412 /* 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. */
414 on_char_input_key_press_event(GtkWidget *widget, GdkEventKey *event, winid_t win)
416 glui32 keycode = keyval_to_glk_keycode(event->keyval, win->input_request_type == INPUT_REQUEST_CHARACTER_UNICODE);
418 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(widget, CHIMARA_TYPE_GLK));
420 event_throw(glk, evtype_CharInput, win, keycode, 0);
421 g_signal_emit_by_name(glk, "char-input", win->rock, event->keyval);
423 /* Only one keypress will be handled */
424 win->input_request_type = INPUT_REQUEST_NONE;
425 g_signal_handler_block(win->widget, win->char_input_keypress_handler);
431 on_line_input_key_press_event(GtkWidget *widget, GdkEventKey *event, winid_t win)
435 case wintype_TextBuffer:
437 /* History up/down */
438 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up
439 || event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
441 /* Prevent falling off the end of the history list */
442 if(win->history == NULL)
444 if( (event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
445 && win->history_pos && win->history_pos->next == NULL)
447 if( (event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
448 && (win->history_pos == NULL || win->history_pos->prev == NULL) )
451 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
452 GtkTextIter start, end;
453 /* Erase any text that was already typed */
454 GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
455 gtk_text_buffer_get_iter_at_mark(buffer, &start, input_position);
456 gtk_text_buffer_get_end_iter(buffer, &end);
458 if(win->history_pos == NULL) {
459 gchar *current_input = gtk_text_buffer_get_text(buffer, &start, &end, FALSE);
460 win->history = g_list_prepend(win->history, current_input);
461 win->history_pos = win->history;
464 gtk_text_buffer_delete(buffer, &start, &end);
466 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
469 win->history_pos = g_list_next(win->history_pos);
471 win->history_pos = win->history;
474 win->history_pos = g_list_previous(win->history_pos);
476 /* Insert the history item into the window */
477 gtk_text_buffer_get_end_iter(buffer, &end);
479 g_signal_handler_block(buffer, win->insert_text_handler);
480 gtk_text_buffer_insert_with_tags_by_name(buffer, &end, win->history_pos->data, -1, "input", NULL);
481 g_signal_handler_unblock(buffer, win->insert_text_handler);
485 /* Move to beginning/end of input field */
486 else if(event->keyval == GDK_Home) {
487 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
488 GtkTextIter input_iter;
489 GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
490 gtk_text_buffer_get_iter_at_mark(buffer, &input_iter, input_position);
491 gtk_text_buffer_place_cursor(buffer, &input_iter);
494 else if(event->keyval == GDK_End) {
495 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
496 GtkTextIter end_iter;
497 gtk_text_buffer_get_end_iter(buffer, &end_iter);
498 gtk_text_buffer_place_cursor(buffer, &end_iter);
502 /* Handle the enter key, which could occur in the middle of the sentence. */
503 else if(event->keyval == GDK_Return || event->keyval == GDK_KP_Enter) {
504 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
505 GtkTextIter end_iter;
506 gtk_text_buffer_get_end_iter(buffer, &end_iter);
507 gtk_text_buffer_place_cursor(buffer, &end_iter);
513 /* If this is a text grid window, then redirect the key press to the line input GtkEntry */
514 case wintype_TextGrid:
516 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up
517 || event->keyval == GDK_Down || event->keyval == GDK_KP_Down
518 || event->keyval == GDK_Left || event->keyval == GDK_KP_Left
519 || event->keyval == GDK_Right || event->keyval == GDK_KP_Right
520 || event->keyval == GDK_Tab || event->keyval == GDK_KP_Tab
521 || event->keyval == GDK_Page_Up || event->keyval == GDK_KP_Page_Up
522 || event->keyval == GDK_Page_Down || event->keyval == GDK_KP_Page_Down
523 || event->keyval == GDK_Home || event->keyval == GDK_KP_Home
524 || event->keyval == GDK_End || event->keyval == GDK_KP_End)
525 return FALSE; /* Don't redirect these keys */
526 gtk_widget_grab_focus(win->input_entry);
527 gtk_editable_set_position(GTK_EDITABLE(win->input_entry), -1);
528 gboolean retval = TRUE;
529 g_signal_emit_by_name(win->input_entry, "key-press-event", event, &retval);
530 return retval; /* Block this key event if the entry handled it */
536 /* Internal function: finish handling a line input request, for both text grid and text buffer windows. */
538 write_to_window_buffer(winid_t win, const gchar *inserted_text)
542 /* Convert the string from UTF-8 to Latin-1 or Unicode */
543 if(win->input_request_type == INPUT_REQUEST_LINE)
546 gchar *latin1 = convert_utf8_to_latin1(inserted_text, &bytes_written);
551 /* Place input in the echo stream */
552 if(win->echo_stream != NULL)
553 glk_put_string_stream(win->echo_stream, latin1);
555 /* Copy the string (bytes_written does not include the NULL at the end) */
556 copycount = MIN(win->line_input_buffer_max_len, bytes_written);
557 memcpy(win->line_input_buffer, latin1, copycount);
560 else if(win->input_request_type == INPUT_REQUEST_LINE_UNICODE)
563 gunichar *unicode = convert_utf8_to_ucs4(inserted_text, &items_written);
568 /* Place input in the echo stream */
569 if(win->echo_stream != NULL)
570 glk_put_string_stream_uni(win->echo_stream, unicode);
572 /* Copy the string (but not the NULL at the end) */
573 copycount = MIN(win->line_input_buffer_max_len, items_written);
574 memcpy(win->line_input_buffer_unicode, unicode, copycount * sizeof(gunichar));
578 WARNING("Wrong input request type");
580 win->input_request_type = INPUT_REQUEST_NONE;
584 /* Internal function: Retrieves the input of a TextBuffer window and stores it in the window buffer.
585 * Returns the number of characters written, suitable for inclusion in a line input event. */
587 finish_text_buffer_line_input(winid_t win, gboolean emit_signal)
589 VALID_WINDOW(win, return 0);
590 g_return_val_if_fail(win->type == wintype_TextBuffer, 0);
592 GtkTextIter start_iter, end_iter, last_character;
594 GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
595 GtkTextMark *input_position = gtk_text_buffer_get_mark(window_buffer, "input_position");
596 gtk_text_buffer_get_iter_at_mark(window_buffer, &start_iter, input_position);
597 gtk_text_buffer_get_end_iter(window_buffer, &end_iter);
598 gtk_text_buffer_get_end_iter(window_buffer, &last_character);
599 gtk_text_iter_backward_cursor_position(&last_character);
601 gchar* last_char = gtk_text_buffer_get_text(window_buffer, &last_character, &end_iter, FALSE);
603 if( strchr(last_char, '\n') != NULL )
604 gtk_text_iter_backward_cursor_position(&end_iter);
606 gchar* inserted_text = gtk_text_buffer_get_text(window_buffer, &start_iter, &end_iter, FALSE);
608 int chars_written = write_to_window_buffer(win, inserted_text);
611 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
613 g_signal_emit_by_name(glk, "line-input", win->rock, inserted_text);
616 /* Add the text to the window input history */
617 if(win->history_pos != NULL)
619 g_free(win->history->data);
620 win->history = g_list_delete_link(win->history, win->history);
622 if(*inserted_text != 0)
623 win->history = g_list_prepend(win->history, g_strdup(inserted_text));
625 win->history_pos = NULL;
627 g_free(inserted_text);
629 return chars_written;
632 /* Internal function: Retrieves the input of a TextGrid window and stores it in the window buffer.
633 * Returns the number of characters written, suitable for inclusion in a line input event. */
635 finish_text_grid_line_input(winid_t win, gboolean emit_signal)
637 VALID_WINDOW(win, return 0);
638 g_return_val_if_fail(win->type == wintype_TextGrid, 0);
640 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
642 gchar *text = g_strdup( gtk_entry_get_text(GTK_ENTRY(win->input_entry)) );
643 /* Move the focus back into the text view */
644 gtk_widget_grab_focus(win->widget);
645 /* Remove entry widget from text view */
646 /* Should be ok even though this is the widget's own signal handler */
647 gtk_container_remove( GTK_CONTAINER(win->widget), GTK_WIDGET(win->input_entry) );
648 win->input_entry = NULL;
649 /* Delete the child anchor */
650 GtkTextIter start, end;
651 gtk_text_buffer_get_iter_at_child_anchor(buffer, &start, win->input_anchor);
653 gtk_text_iter_forward_char(&end); /* Point after the child anchor */
654 gtk_text_buffer_delete(buffer, &start, &end);
655 win->input_anchor = NULL;
657 gchar *spaces = g_strnfill(win->input_length - g_utf8_strlen(text, -1), ' ');
658 gchar *text_to_insert = g_strconcat(text, spaces, NULL);
660 gtk_text_buffer_insert(buffer, &start, text_to_insert, -1);
661 g_free(text_to_insert);
663 int chars_written = write_to_window_buffer(win, text);
666 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
668 g_signal_emit_by_name(glk, "line-input", win->rock, text);
671 /* Add the text to the window input history */
672 if(win->history_pos != NULL)
674 g_free(win->history->data);
675 win->history = g_list_delete_link(win->history, win->history);
678 win->history = g_list_prepend(win->history, g_strdup(text));
679 win->history_pos = NULL;
682 return chars_written;
685 /* Internal function: Callback for signal insert-text on a text buffer window.
686 Runs after the default handler has already inserted the text.
687 FIXME: This function assumes that newline was the last character typed into the
688 window. That assumption is wrong if, for example, text containing a newline was
689 pasted into the window. */
691 after_window_insert_text(GtkTextBuffer *textbuffer, GtkTextIter *location, gchar *text, gint len, winid_t win)
693 GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
695 /* Set the history position to NULL and erase the text we were already editing */
696 if(win->history_pos != NULL)
698 g_free(win->history->data);
699 win->history = g_list_delete_link(win->history, win->history);
700 win->history_pos = NULL;
702 if( strchr(text, '\n') != NULL )
704 /* Remove signal handlers */
705 g_signal_handler_block(window_buffer, win->insert_text_handler);
706 g_signal_handler_block(win->widget, win->line_input_keypress_handler);
708 /* Make the window uneditable again and retrieve the text that was input */
709 gtk_text_view_set_editable(GTK_TEXT_VIEW(win->widget), FALSE);
711 int chars_written = finish_text_buffer_line_input(win, TRUE);
712 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
713 event_throw(glk, evtype_LineInput, win, chars_written, 0);
716 /* Apply the 'input' style to the text that was entered */
717 GtkTextIter end_iter;
718 gtk_text_buffer_get_end_iter(window_buffer, &end_iter);
719 GtkTextIter input_iter;
720 GtkTextMark *input_position = gtk_text_buffer_get_mark(window_buffer, "input_position");
721 gtk_text_buffer_get_iter_at_mark(window_buffer, &input_iter, input_position);
722 gtk_text_buffer_apply_tag_by_name(window_buffer, "input", &input_iter, &end_iter);
725 /* Internal function: Callback for signal activate on the line input GtkEntry
726 in a text grid window. */
728 on_input_entry_activate(GtkEntry *input_entry, winid_t win)
730 g_signal_handler_block(win->widget, win->line_input_keypress_handler);
732 int chars_written = finish_text_grid_line_input(win, TRUE);
733 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
734 event_throw(glk, evtype_LineInput, win, chars_written, 0);
737 /* Internal function: Callback for signal key-press-event on the line input
738 GtkEntry in a text grid window. */
740 on_input_entry_key_press_event(GtkEntry *input_entry, GdkEventKey *event, winid_t win)
742 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up
743 || event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
745 /* Prevent falling off the end of the history list */
746 if( (event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
747 && win->history_pos && win->history_pos->next == NULL)
749 if( (event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
750 && (win->history_pos == NULL || win->history_pos->prev == NULL) )
753 if(win->history_pos == NULL)
755 const gchar *current_input = gtk_entry_get_text(input_entry);
756 win->history = g_list_prepend(win->history, g_strdup(current_input));
757 win->history_pos = win->history;
760 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
763 win->history_pos = g_list_next(win->history_pos);
765 win->history_pos = win->history;
768 win->history_pos = g_list_previous(win->history_pos);
770 /* Insert the history item into the window */
771 g_signal_handler_block(input_entry, win->line_input_entry_changed);
772 gtk_entry_set_text(input_entry, win->history_pos->data);
773 g_signal_handler_unblock(input_entry, win->line_input_entry_changed);
780 on_input_entry_changed(GtkEditable *editable, winid_t win)
782 /* Set the history position to NULL and erase the text we were already editing */
783 if(win->history_pos != NULL)
785 g_free(win->history->data);
786 win->history = g_list_delete_link(win->history, win->history);
787 win->history_pos = NULL;
792 keyval_to_glk_keycode(guint keyval, gboolean unicode)
797 case GDK_KP_Up: return keycode_Up;
799 case GDK_KP_Down: return keycode_Down;
801 case GDK_KP_Left: return keycode_Left;
803 case GDK_KP_Right: return keycode_Right;
806 case GDK_KP_Enter: return keycode_Return;
809 case GDK_KP_Delete: return keycode_Delete;
810 case GDK_Escape: return keycode_Escape;
812 case GDK_KP_Tab: return keycode_Tab;
814 case GDK_KP_Page_Up: return keycode_PageUp;
816 case GDK_KP_Page_Down: return keycode_PageDown;
818 case GDK_KP_Home: return keycode_Home;
820 case GDK_KP_End: return keycode_End;
822 case GDK_KP_F1: return keycode_Func1;
824 case GDK_KP_F2: return keycode_Func2;
826 case GDK_KP_F3: return keycode_Func3;
828 case GDK_KP_F4: return keycode_Func4;
829 case GDK_F5: return keycode_Func5;
830 case GDK_F6: return keycode_Func6;
831 case GDK_F7: return keycode_Func7;
832 case GDK_F8: return keycode_Func8;
833 case GDK_F9: return keycode_Func9;
834 case GDK_F10: return keycode_Func10;
835 case GDK_F11: return keycode_Func11;
836 case GDK_F12: return keycode_Func12;
838 keycode = gdk_keyval_to_unicode(keyval);
839 /* If keycode is 0, then keyval was not recognized; also return
840 unknown if Latin-1 input was requested and the character is not in
842 if(keycode == 0 || (!unicode && keycode > 255))
843 return keycode_Unknown;
849 force_char_input_from_queue(winid_t win, event_t *event)
851 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
852 guint keyval = GPOINTER_TO_UINT(g_async_queue_pop(glk_data->char_input_queue));
854 glk_cancel_char_event(win);
857 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
859 g_signal_emit_by_name(glk, "char-input", win->rock, keyval);
862 event->type = evtype_CharInput;
864 event->val1 = keyval_to_glk_keycode(keyval, win->input_request_type == INPUT_REQUEST_CHARACTER_UNICODE);
869 force_line_input_from_queue(winid_t win, event_t *event)
871 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
872 const gchar *text = g_async_queue_pop(glk_data->line_input_queue);
873 glui32 chars_written = 0;
876 if(win->type == wintype_TextBuffer)
878 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
879 GtkTextIter start, end;
881 /* Remove signal handlers so the line input doesn't get picked up again */
882 g_signal_handler_block(buffer, win->insert_text_handler);
883 g_signal_handler_block(win->widget, win->line_input_keypress_handler);
885 /* Erase any text that was already typed */
886 GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
887 gtk_text_buffer_get_iter_at_mark(buffer, &start, input_position);
888 gtk_text_buffer_get_end_iter(buffer, &end);
889 gtk_text_buffer_delete(buffer, &start, &end);
891 /* Make the window uneditable again */
892 gtk_text_view_set_editable(GTK_TEXT_VIEW(win->widget), FALSE);
894 /* Insert the forced input into the window */
895 gtk_text_buffer_get_end_iter(buffer, &end);
896 gchar *text_to_insert = g_strconcat(text, "\n", NULL);
897 gtk_text_buffer_insert_with_tags_by_name(buffer, &end, text_to_insert, -1, "input", NULL);
898 chars_written = finish_text_buffer_line_input(win, TRUE);
900 else if(win->type == wintype_TextGrid)
902 /* Remove signal handlers so the line input doesn't get picked up again */
903 g_signal_handler_block(win->widget, win->char_input_keypress_handler);
905 /* Insert the forced input into the window */
906 gtk_entry_set_text(GTK_ENTRY(win->input_entry), text);
907 chars_written = finish_text_grid_line_input(win, TRUE);
911 event->type = evtype_LineInput;
913 event->val1 = chars_written;
917 /*** Internal function: cancels any pending input requests on the window and presents a warning if not INPUT_REQUEST_NONE ***/
919 cancel_old_input_request(winid_t win)
921 switch(win->input_request_type) {
922 case INPUT_REQUEST_NONE:
923 break; /* All is well */
924 case INPUT_REQUEST_CHARACTER:
925 case INPUT_REQUEST_CHARACTER_UNICODE:
926 glk_cancel_char_event(win);
927 WARNING("Cancelling pending char event");
929 case INPUT_REQUEST_LINE:
930 case INPUT_REQUEST_LINE_UNICODE:
931 glk_cancel_line_event(win, NULL);
932 WARNING("Cancelling pending line event");
935 WARNING("Could not cancel pending input request: unknown input request");