df2203b70f0357f7179e1d155c1b4146d25b89a9
[projects/chimara/chimara.git] / libchimara / input.c
1 #include "charset.h"
2 #include "magic.h"
3 #include "input.h"
4 #include "pager.h"
5 #include "chimara-glk-private.h"
6 #include "garglk.h"
7
8 extern GPrivate *glk_data_key;
9
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);
14
15 /* Internal function: code common to both flavors of char event request */
16 void
17 request_char_event_common(winid_t win, gboolean unicode)
18 {
19         VALID_WINDOW(win, return);
20         g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
21
22         cancel_old_input_request(win);
23
24         flush_window_buffer(win);
25
26         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
27
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 );
30
31         gdk_threads_enter();
32         gtk_widget_grab_focus( GTK_WIDGET(win->widget) );
33         gdk_threads_leave();
34
35         /* Emit the "waiting" signal to let listeners know we are ready for input */
36         g_signal_emit_by_name(glk_data->self, "waiting");
37 }
38
39 /**
40  * glk_request_char_event:
41  * @win: A window to request char events from.
42  *
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.
48  */
49 void
50 glk_request_char_event(winid_t win)
51 {
52         request_char_event_common(win, FALSE);
53 }
54
55 /**
56  * glk_request_char_event_uni:
57  * @win: A window to request char events from.
58  *
59  * Request input of a Unicode character or special key. See
60  * glk_request_char_event().
61  */
62 void
63 glk_request_char_event_uni(winid_t win)
64 {
65         request_char_event_common(win, TRUE);
66 }
67
68 /**
69  * glk_cancel_char_event:
70  * @win: A window to cancel the latest char event request on.
71  *
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
75  * call in this case.
76  */
77 void
78 glk_cancel_char_event(winid_t win)
79 {
80         VALID_WINDOW(win, return);
81         g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
82
83         if(win->input_request_type == INPUT_REQUEST_CHARACTER || win->input_request_type == INPUT_REQUEST_CHARACTER_UNICODE)
84         {
85                 win->input_request_type = INPUT_REQUEST_NONE;
86                 g_signal_handler_block( win->widget, win->char_input_keypress_handler );
87         }
88 }
89
90 /* Internal function: Request either latin-1 or unicode line input, in a text grid window. */
91 static void
92 text_grid_request_line_event_common(winid_t win, glui32 maxlen, gboolean insert, gchar *inserttext)
93 {
94         gdk_threads_enter();
95
96         GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
97
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);
101
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);
110
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) )
115         {
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);
120         }
121
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 };
132
133         /* COMPAT: */
134 #if GTK_CHECK_VERSION(2,10,0)
135         gtk_entry_set_inner_border(GTK_ENTRY(win->input_entry), &border);
136 #endif
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);
139
140     /* Insert pre-entered text if needed */
141     if(insert)
142         gtk_entry_set_text(GTK_ENTRY(win->input_entry), inserttext);
143
144     /* Set background color of entry (TODO: implement as property) */
145     GdkColor background;
146         gdk_color_parse("grey", &background);
147     gtk_widget_modify_base(win->input_entry, GTK_STATE_NORMAL, &background);
148
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);
152
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);
155
156         gtk_widget_grab_focus(win->input_entry);
157
158         gdk_threads_leave();
159 }
160
161 /* Internal function: Request either latin-1 or unicode line input, in a text buffer window. */
162 static void
163 text_buffer_request_line_event_common(winid_t win, glui32 maxlen, gboolean insert, gchar *inserttext)
164 {
165         flush_window_buffer(win);
166
167         gdk_threads_enter();
168
169         GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
170
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);
176
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);
183
184     /* Insert pre-entered text if needed */
185     if(insert) {
186         gtk_text_buffer_insert(buffer, &end_iter, inserttext, -1);
187                 gtk_text_buffer_get_end_iter(buffer, &end_iter); /* update after text insertion */
188         }
189
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);
194
195     gtk_text_view_set_editable(GTK_TEXT_VIEW(win->widget), TRUE);
196
197         g_signal_handler_unblock(buffer, win->insert_text_handler);
198         gtk_widget_grab_focus(win->widget);
199
200         gdk_threads_leave();
201 }
202
203 /**
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.
209  *
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.
215  *
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.)
222  *
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.
227  */
228 void
229 glk_request_line_event(winid_t win, char *buf, glui32 maxlen, glui32 initlen)
230 {
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);
235
236         cancel_old_input_request(win);
237
238         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
239
240         /* Register the buffer */
241         if(glk_data->register_arr)
242         win->buffer_rock = (*glk_data->register_arr)(buf, maxlen, "&+#!Cn");
243
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);
249
250         gchar *inserttext = (initlen > 0)? g_strndup(buf, initlen) : g_strdup("");
251         switch(win->type)
252         {
253             case wintype_TextBuffer:
254                 text_buffer_request_line_event_common(win, maxlen, (initlen > 0), inserttext);
255                 break;
256             case wintype_TextGrid:
257                 text_grid_request_line_event_common(win, maxlen, (initlen > 0), inserttext);
258                 break;
259     }
260         g_free(inserttext);
261         g_signal_handler_unblock(win->widget, win->line_input_keypress_handler);
262
263         /* Emit the "waiting" signal to let listeners know we are ready for input */
264         g_signal_emit_by_name(glk_data->self, "waiting");
265 }
266
267 /**
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.
273  *
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.
278  *
279  * If possible, the library should return fully composed Unicode characters,
280  * rather than strings of base and composition characters.
281  *
282  * <note><para>
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.
290  * </para></note>
291  *
292  * <note><para>
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>.
300  * </para></note>
301  */
302 void
303 glk_request_line_event_uni(winid_t win, glui32 *buf, glui32 maxlen, glui32 initlen)
304 {
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);
309
310         cancel_old_input_request(win);
311         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
312
313         /* Register the buffer */
314         if(glk_data->register_arr)
315         win->buffer_rock = (*glk_data->register_arr)(buf, maxlen, "&+#!Iu");
316
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->echo_current_line_input = win->echo_line_input;
321         win->current_extra_line_terminators = g_slist_copy(win->extra_line_terminators);
322
323         gchar *utf8;
324         if(initlen > 0) {
325                 utf8 = convert_ucs4_to_utf8(buf, initlen);
326                 if(utf8 == NULL)
327                         return;
328         }
329         else
330                 utf8 = g_strdup("");
331
332     switch(win->type)
333         {
334             case wintype_TextBuffer:
335                 text_buffer_request_line_event_common(win, maxlen, (initlen > 0), utf8);
336                 break;
337             case wintype_TextGrid:
338                 text_grid_request_line_event_common(win, maxlen, (initlen > 0), utf8);
339                 break;
340     }
341     g_signal_handler_unblock(win->widget, win->line_input_keypress_handler);
342         g_free(utf8);
343
344         /* Emit the "waiting" signal to let listeners know we are ready for input */
345         g_signal_emit_by_name(glk_data->self, "waiting");
346 }
347
348 /**
349  * glk_cancel_line_event:
350  * @win: A text buffer or text grid window to cancel line input on.
351  * @event: Will be filled in if the user had already input something.
352  *
353  * This cancels a pending request for line input. (Either Latin-1 or Unicode.)
354  *
355  * The event pointed to by the event argument will be filled in as if the
356  * player had hit <keycap>enter</keycap>, and the input composed so far will be
357  * stored in the buffer; see below. If you do not care about this information,
358  * pass %NULL as the @event argument. (The buffer will still be filled.)
359  *
360  * For convenience, it is legal to call glk_cancel_line_event() even if there
361  * is no line input request on that window. The event type will be set to
362  * %evtype_None in this case.
363  */
364 void
365 glk_cancel_line_event(winid_t win, event_t *event)
366 {
367         VALID_WINDOW(win, return);
368         g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
369
370         if(event != NULL) {
371                 event->type = evtype_None;
372                 event->win = win;
373                 event->val1 = 0;
374                 event->val2 = 0;
375         }
376
377         if(win->input_request_type != INPUT_REQUEST_LINE && win->input_request_type != INPUT_REQUEST_LINE_UNICODE)
378                 return;
379
380         g_signal_handler_block( win->widget, win->line_input_keypress_handler );
381
382         int chars_written = 0;
383
384         gdk_threads_enter();
385         if(win->type == wintype_TextGrid) {
386                 chars_written = finish_text_grid_line_input(win, FALSE);
387         } else if(win->type == wintype_TextBuffer) {
388                 gtk_text_view_set_editable( GTK_TEXT_VIEW(win->widget), FALSE );
389                 GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
390                 g_signal_handler_block(window_buffer, win->insert_text_handler);
391                 chars_written = finish_text_buffer_line_input(win, FALSE);
392         }
393         gdk_threads_leave();
394
395         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
396         if(glk_data->unregister_arr)
397         {
398                 if(win->input_request_type == INPUT_REQUEST_LINE_UNICODE)
399                         (*glk_data->unregister_arr)(win->line_input_buffer_unicode, win->line_input_buffer_max_len, "&+#!Iu", win->buffer_rock);
400                 else
401                 (*glk_data->unregister_arr)(win->line_input_buffer, win->line_input_buffer_max_len, "&+#!Cn", win->buffer_rock);
402     }
403
404         if(event != NULL && chars_written > 0) {
405                 event->type = evtype_LineInput;
406                 event->val1 = chars_written;
407         }
408 }
409
410 /* Helper function: Turn off shutdown key-press-event signal handler */
411 static gboolean
412 turn_off_handler(GNode *node)
413 {
414         winid_t win = node->data;
415         g_signal_handler_block(win->widget, win->shutdown_keypress_handler);
416         return FALSE; /* don't stop */
417 }
418
419 /* Internal function: Callback for signal key-press-event while waiting for shutdown. */
420 gboolean
421 on_shutdown_key_press_event(GtkWidget *widget, GdkEventKey *event, winid_t win)
422 {
423         ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(widget, CHIMARA_TYPE_GLK));
424         g_assert(glk);
425         CHIMARA_GLK_USE_PRIVATE(glk, priv);
426         
427         /* Turn off all the signal handlers */
428         if(priv->root_window)
429                 g_node_traverse(priv->root_window, G_IN_ORDER, G_TRAVERSE_LEAVES, -1, (GNodeTraverseFunc)turn_off_handler, NULL);
430         
431         /* Signal the Glk library that it can shut everything down now */
432         g_mutex_lock(priv->shutdown_lock);
433         g_cond_signal(priv->shutdown_key_pressed);
434         g_mutex_unlock(priv->shutdown_lock);
435         
436         return TRUE; /* block the event */
437 }
438
439 /* 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 gboolean
441 on_char_input_key_press_event(GtkWidget *widget, GdkEventKey *event, winid_t win)
442 {
443         /* Ignore modifier keys, otherwise the char input will already trigger on 
444         the shift key when the user tries to type a capital letter */
445         if(event->is_modifier)
446                 return FALSE; /* don't stop the event */
447
448         /* All text up to the input position is now regarded as being read by the user */
449         if(win->type == wintype_TextBuffer)
450                 pager_update(win);
451         
452         glui32 keycode = keyval_to_glk_keycode(event->keyval, win->input_request_type == INPUT_REQUEST_CHARACTER_UNICODE);
453
454         ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(widget, CHIMARA_TYPE_GLK));
455         g_assert(glk);
456         event_throw(glk, evtype_CharInput, win, keycode, 0);
457         g_signal_emit_by_name(glk, "char-input", win->rock, event->keyval);
458
459         /* Only one keypress will be handled */
460         win->input_request_type = INPUT_REQUEST_NONE;
461         g_signal_handler_block(win->widget, win->char_input_keypress_handler);
462
463         return TRUE;
464 }
465
466 gboolean
467 on_line_input_key_press_event(GtkWidget *widget, GdkEventKey *event, winid_t win)
468 {
469         switch(win->type)
470         {
471                 case wintype_TextBuffer:
472                         /* All text up to the input position is now regarded as being read by the user */
473                         pager_update(win);
474
475                         /* History up/down */
476                         if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up
477                                 || event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
478                         {
479                                 /* Prevent falling off the end of the history list */
480                                 if(win->history == NULL)
481                                         return TRUE;
482                                 if( (event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
483                                         && win->history_pos && win->history_pos->next == NULL)
484                                         return TRUE;
485                                 if( (event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
486                                         && (win->history_pos == NULL || win->history_pos->prev == NULL) )
487                                         return TRUE;
488
489                                 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
490                                 GtkTextIter start, end;
491                                 /* Erase any text that was already typed */
492                                 GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
493                                 gtk_text_buffer_get_iter_at_mark(buffer, &start, input_position);
494                                 gtk_text_buffer_get_end_iter(buffer, &end);
495
496                                 if(win->history_pos == NULL) {
497                                         gchar *current_input = gtk_text_buffer_get_text(buffer, &start, &end, FALSE);
498                                         win->history = g_list_prepend(win->history, current_input);
499                                         win->history_pos = win->history;
500                                 }
501
502                                 gtk_text_buffer_delete(buffer, &start, &end);
503
504                                 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
505                                 {
506                                         if(win->history_pos)
507                                                 win->history_pos = g_list_next(win->history_pos);
508                                         else
509                                                 win->history_pos = win->history;
510                                 }
511                                 else /* down */
512                                         win->history_pos = g_list_previous(win->history_pos);
513
514                                 /* Insert the history item into the window */
515                                 gtk_text_buffer_get_end_iter(buffer, &end);
516
517                                 g_signal_handler_block(buffer, win->insert_text_handler);
518                                 gtk_text_buffer_insert_with_tags_by_name(buffer, &end, win->history_pos->data, -1, "default", "input", NULL);
519                                 g_signal_handler_unblock(buffer, win->insert_text_handler);
520                                 return TRUE;
521                         }
522
523                         /* Move to beginning/end of input field */
524                         else if(event->keyval == GDK_Home) {
525                                 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
526                                 GtkTextIter input_iter;
527                                 GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
528                                 gtk_text_buffer_get_iter_at_mark(buffer, &input_iter, input_position);
529                                 gtk_text_buffer_place_cursor(buffer, &input_iter);
530                                 return TRUE;
531                         }
532                         else if(event->keyval == GDK_End) {
533                                 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
534                                 GtkTextIter end_iter;
535                                 gtk_text_buffer_get_end_iter(buffer, &end_iter);
536                                 gtk_text_buffer_place_cursor(buffer, &end_iter);
537                                 return TRUE;
538                         }
539
540                         /* Handle the enter key, which could occur in the middle of the sentence. */
541                         else if(event->keyval == GDK_Return || event->keyval == GDK_KP_Enter) {
542                                 GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
543                                 GtkTextIter end_iter;
544                                 gtk_text_buffer_get_end_iter(buffer, &end_iter);
545                                 gtk_text_buffer_place_cursor(buffer, &end_iter);
546                                 return FALSE; 
547                         }
548
549                         return FALSE;
550
551                 /* If this is a text grid window, then redirect the key press to the line input GtkEntry */
552                 case wintype_TextGrid:
553                 {
554                         if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up
555                                 || event->keyval == GDK_Down || event->keyval == GDK_KP_Down
556                                 || event->keyval == GDK_Left || event->keyval == GDK_KP_Left
557                                 || event->keyval == GDK_Right || event->keyval == GDK_KP_Right
558                                 || event->keyval == GDK_Tab || event->keyval == GDK_KP_Tab
559                                 || event->keyval == GDK_Page_Up || event->keyval == GDK_KP_Page_Up
560                                 || event->keyval == GDK_Page_Down || event->keyval == GDK_KP_Page_Down
561                                 || event->keyval == GDK_Home || event->keyval == GDK_KP_Home
562                                 || event->keyval == GDK_End || event->keyval == GDK_KP_End)
563                                 return FALSE; /* Don't redirect these keys */
564                         gtk_widget_grab_focus(win->input_entry);
565                         gtk_editable_set_position(GTK_EDITABLE(win->input_entry), -1);
566                         gboolean retval = TRUE;
567                         g_signal_emit_by_name(win->input_entry, "key-press-event", event, &retval);
568                         return retval; /* Block this key event if the entry handled it */
569                 }
570         }
571         return FALSE;
572 }
573
574 /* Internal function: finish handling a line input request, for both text grid and text buffer windows. */
575 static int
576 write_to_window_buffer(winid_t win, const gchar *inserted_text)
577 {
578         int copycount = 0;
579
580     /* Convert the string from UTF-8 to Latin-1 or Unicode */
581     if(win->input_request_type == INPUT_REQUEST_LINE)
582     {
583         gsize bytes_written;
584         gchar *latin1 = convert_utf8_to_latin1(inserted_text, &bytes_written);
585
586         if(latin1 == NULL)
587             return 0;
588
589         /* Place input in the echo stream */
590         if(win->echo_stream != NULL)
591             glk_put_string_stream(win->echo_stream, latin1);
592
593         /* Copy the string (bytes_written does not include the NULL at the end) */
594         copycount = MIN(win->line_input_buffer_max_len, bytes_written);
595         memcpy(win->line_input_buffer, latin1, copycount);
596         g_free(latin1);
597     }
598     else if(win->input_request_type == INPUT_REQUEST_LINE_UNICODE)
599     {
600         glong items_written;
601         gunichar *unicode = convert_utf8_to_ucs4(inserted_text, &items_written);
602
603         if(unicode == NULL)
604             return 0;
605
606         /* Place input in the echo stream */
607         if(win->echo_stream != NULL)
608             glk_put_string_stream_uni(win->echo_stream, unicode);
609
610         /* Copy the string (but not the NULL at the end) */
611         copycount = MIN(win->line_input_buffer_max_len, items_written);
612         memcpy(win->line_input_buffer_unicode, unicode, copycount * sizeof(gunichar));
613         g_free(unicode);
614     }
615     else
616         WARNING("Wrong input request type");
617
618     win->input_request_type = INPUT_REQUEST_NONE;
619         return copycount;
620 }
621
622 /* Internal function: Retrieves the input of a TextBuffer window and stores it in the window buffer.
623  * Returns the number of characters written, suitable for inclusion in a line input event. */
624 static int
625 finish_text_buffer_line_input(winid_t win, gboolean emit_signal)
626 {
627         VALID_WINDOW(win, return 0);
628         g_return_val_if_fail(win->type == wintype_TextBuffer, 0);
629
630         GtkTextIter start_iter, end_iter;
631
632         GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
633         GtkTextMark *input_position = gtk_text_buffer_get_mark(window_buffer, "input_position");
634         gtk_text_buffer_get_iter_at_mark(window_buffer, &start_iter, input_position);
635         gtk_text_buffer_get_end_iter(window_buffer, &end_iter);
636
637         gchar *inserted_text = gtk_text_buffer_get_text(window_buffer, &start_iter, &end_iter, FALSE);
638
639         /* If echoing is turned off, remove the text from the window */
640         if(!win->echo_current_line_input)
641                 gtk_text_buffer_delete(window_buffer, &start_iter, &end_iter);
642
643         /* Don't include the newline in the input */
644         char *last_char = inserted_text + strlen(inserted_text) - 1;
645         if(*last_char == '\n')
646                 *last_char = '\0';
647
648         int chars_written = write_to_window_buffer(win, inserted_text);
649         if(emit_signal)
650         {
651                 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
652                 g_assert(glk);
653                 g_signal_emit_by_name(glk, "line-input", win->rock, inserted_text);
654         }
655
656         /* Add the text to the window input history */
657         if(win->history_pos != NULL)
658         {
659                 g_free(win->history->data);
660                 win->history = g_list_delete_link(win->history, win->history);
661         }
662         if(*inserted_text != 0)
663                 win->history = g_list_prepend(win->history, g_strdup(inserted_text));
664
665         win->history_pos = NULL;
666
667         g_free(inserted_text);
668
669         return chars_written;
670 }
671
672 /* Internal function: Retrieves the input of a TextGrid window and stores it in the window buffer.
673  * Returns the number of characters written, suitable for inclusion in a line input event. */
674 static int
675 finish_text_grid_line_input(winid_t win, gboolean emit_signal)
676 {
677         VALID_WINDOW(win, return 0);
678         g_return_val_if_fail(win->type == wintype_TextGrid, 0);
679
680         GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
681
682         gchar *text = g_strdup( gtk_entry_get_text(GTK_ENTRY(win->input_entry)) );
683         /* Move the focus back into the text view */
684         gtk_widget_grab_focus(win->widget);
685         /* Remove entry widget from text view */
686         /* Should be ok even though this is the widget's own signal handler */
687         gtk_container_remove( GTK_CONTAINER(win->widget), GTK_WIDGET(win->input_entry) );
688         win->input_entry = NULL;
689         /* Delete the child anchor */
690         GtkTextIter start, end;
691         gtk_text_buffer_get_iter_at_child_anchor(buffer, &start, win->input_anchor);
692         end = start;
693         gtk_text_iter_forward_char(&end); /* Point after the child anchor */
694         gtk_text_buffer_delete(buffer, &start, &end);
695         win->input_anchor = NULL;
696
697     gchar *spaces = g_strnfill(win->input_length - g_utf8_strlen(text, -1), ' ');
698     gchar *text_to_insert = g_strconcat(text, spaces, NULL);
699         g_free(spaces);
700     gtk_text_buffer_insert(buffer, &start, text_to_insert, -1);
701     g_free(text_to_insert);
702
703     int chars_written = write_to_window_buffer(win, text);
704     if(emit_signal)
705     {
706                 ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
707                 g_assert(glk);
708                 g_signal_emit_by_name(glk, "line-input", win->rock, text);
709     }
710
711         /* Add the text to the window input history */
712         if(win->history_pos != NULL)
713         {
714                 g_free(win->history->data);
715                 win->history = g_list_delete_link(win->history, win->history);
716         }
717         if(*text != 0)
718                 win->history = g_list_prepend(win->history, g_strdup(text));
719         win->history_pos = NULL;
720
721         g_free(text);
722         return chars_written;
723 }
724
725 /* Internal function: Callback for signal insert-text on a text buffer window.
726 Runs after the default handler has already inserted the text.
727 FIXME: This function assumes that newline was the last character typed into the
728 window. That assumption is wrong if, for example, text containing a newline was
729 pasted into the window. */
730 void
731 after_window_insert_text(GtkTextBuffer *textbuffer, GtkTextIter *location, gchar *text, gint len, winid_t win)
732 {
733         GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
734
735         /* Set the history position to NULL and erase the text we were already editing */
736         if(win->history_pos != NULL)
737         {
738                 g_free(win->history->data);
739                 win->history = g_list_delete_link(win->history, win->history);
740                 win->history_pos = NULL;
741         }
742         if( strchr(text, '\n') != NULL )
743         {
744                 /* Remove signal handlers */
745                 g_signal_handler_block(window_buffer, win->insert_text_handler);
746                 g_signal_handler_block(win->widget, win->line_input_keypress_handler);
747
748                 /* Make the window uneditable again and retrieve the text that was input */
749         gtk_text_view_set_editable(GTK_TEXT_VIEW(win->widget), FALSE);
750
751         int chars_written = finish_text_buffer_line_input(win, TRUE);
752         ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
753                 event_throw(glk, evtype_LineInput, win, chars_written, 0);
754         }
755
756         /* Apply the 'input' style to the text that was entered */
757         GtkTextIter end_iter;
758         gtk_text_buffer_get_end_iter(window_buffer, &end_iter);
759         GtkTextIter input_iter;
760         GtkTextMark *input_position = gtk_text_buffer_get_mark(window_buffer, "input_position");
761         gtk_text_buffer_get_iter_at_mark(window_buffer, &input_iter, input_position);
762         gtk_text_buffer_apply_tag_by_name(window_buffer, "input", &input_iter, &end_iter);
763 }
764
765 /* Internal function: Callback for signal activate on the line input GtkEntry
766 in a text grid window. */
767 void
768 on_input_entry_activate(GtkEntry *input_entry, winid_t win)
769 {
770         g_signal_handler_block(win->widget, win->line_input_keypress_handler);
771
772         int chars_written = finish_text_grid_line_input(win, TRUE);
773         ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
774         event_throw(glk, evtype_LineInput, win, chars_written, 0);
775 }
776
777 /* Internal function: Callback for signal key-press-event on the line input
778 GtkEntry in a text grid window. */
779 gboolean
780 on_input_entry_key_press_event(GtkEntry *input_entry, GdkEventKey *event, winid_t win)
781 {
782         if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up
783                 || event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
784         {
785                 /* Prevent falling off the end of the history list */
786                 if( (event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
787                         && win->history_pos && win->history_pos->next == NULL)
788                         return TRUE;
789                 if( (event->keyval == GDK_Down || event->keyval == GDK_KP_Down)
790                         && (win->history_pos == NULL || win->history_pos->prev == NULL) )
791                         return TRUE;
792
793                 if(win->history_pos == NULL)
794                 {
795                         const gchar *current_input = gtk_entry_get_text(input_entry);
796                         win->history = g_list_prepend(win->history, g_strdup(current_input));
797                         win->history_pos = win->history;
798                 }
799
800                 if(event->keyval == GDK_Up || event->keyval == GDK_KP_Up)
801                 {
802                         if(win->history_pos)
803                                 win->history_pos = g_list_next(win->history_pos);
804                         else
805                                 win->history_pos = win->history;
806                 }
807                 else /* down */
808                         win->history_pos = g_list_previous(win->history_pos);
809
810                 /* Insert the history item into the window */
811                 g_signal_handler_block(input_entry, win->line_input_entry_changed);
812                 gtk_entry_set_text(input_entry, win->history_pos->data);
813                 g_signal_handler_unblock(input_entry, win->line_input_entry_changed);
814                 return TRUE;
815         }
816         return FALSE;
817 }
818
819 void
820 on_input_entry_changed(GtkEditable *editable, winid_t win)
821 {
822         /* Set the history position to NULL and erase the text we were already editing */
823         if(win->history_pos != NULL)
824         {
825                 g_free(win->history->data);
826                 win->history = g_list_delete_link(win->history, win->history);
827                 win->history_pos = NULL;
828         }
829 }
830
831 glui32
832 keyval_to_glk_keycode(guint keyval, gboolean unicode)
833 {
834         glui32 keycode;
835         switch(keyval) {
836                 case GDK_Up:
837                 case GDK_KP_Up: return keycode_Up;
838                 case GDK_Down:
839                 case GDK_KP_Down: return keycode_Down;
840                 case GDK_Left:
841                 case GDK_KP_Left: return keycode_Left;
842                 case GDK_Right:
843                 case GDK_KP_Right: return keycode_Right;
844                 case GDK_Linefeed:
845                 case GDK_Return:
846                 case GDK_KP_Enter: return keycode_Return;
847                 case GDK_Delete:
848                 case GDK_BackSpace:
849                 case GDK_KP_Delete: return keycode_Delete;
850                 case GDK_Escape: return keycode_Escape;
851                 case GDK_Tab:
852                 case GDK_KP_Tab: return keycode_Tab;
853                 case GDK_Page_Up:
854                 case GDK_KP_Page_Up: return keycode_PageUp;
855                 case GDK_Page_Down:
856                 case GDK_KP_Page_Down: return keycode_PageDown;
857                 case GDK_Home:
858                 case GDK_KP_Home: return keycode_Home;
859                 case GDK_End:
860                 case GDK_KP_End: return keycode_End;
861                 case GDK_F1:
862                 case GDK_KP_F1: return keycode_Func1;
863                 case GDK_F2:
864                 case GDK_KP_F2: return keycode_Func2;
865                 case GDK_F3:
866                 case GDK_KP_F3: return keycode_Func3;
867                 case GDK_F4:
868                 case GDK_KP_F4: return keycode_Func4;
869                 case GDK_F5: return keycode_Func5;
870                 case GDK_F6: return keycode_Func6;
871                 case GDK_F7: return keycode_Func7;
872                 case GDK_F8: return keycode_Func8;
873                 case GDK_F9: return keycode_Func9;
874                 case GDK_F10: return keycode_Func10;
875                 case GDK_F11: return keycode_Func11;
876                 case GDK_F12: return keycode_Func12;
877                 default:
878                         keycode = gdk_keyval_to_unicode(keyval);
879                         /* If keycode is 0, then keyval was not recognized; also return
880                         unknown if Latin-1 input was requested and the character is not in
881                         Latin-1 */
882                         if(keycode == 0 || (!unicode && keycode > 255))
883                                 return keycode_Unknown;
884                         return keycode;
885         }
886 }
887
888 void
889 force_char_input_from_queue(winid_t win, event_t *event)
890 {
891         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
892         guint keyval = GPOINTER_TO_UINT(g_async_queue_pop(glk_data->char_input_queue));
893
894         glk_cancel_char_event(win);
895
896         gdk_threads_enter();
897         ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
898         g_assert(glk);
899         g_signal_emit_by_name(glk, "char-input", win->rock, keyval);
900         gdk_threads_leave();
901
902         event->type = evtype_CharInput;
903         event->win = win;
904         event->val1 = keyval_to_glk_keycode(keyval, win->input_request_type == INPUT_REQUEST_CHARACTER_UNICODE);
905         event->val2 = 0;
906 }
907
908 void
909 force_line_input_from_queue(winid_t win, event_t *event)
910 {
911         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
912         const gchar *text = g_async_queue_pop(glk_data->line_input_queue);
913         glui32 chars_written = 0;
914
915         gdk_threads_enter();
916         if(win->type == wintype_TextBuffer)
917         {
918                 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
919                 GtkTextIter start, end;
920
921                 /* Remove signal handlers so the line input doesn't get picked up again */
922                 g_signal_handler_block(buffer, win->insert_text_handler);
923                 g_signal_handler_block(win->widget, win->line_input_keypress_handler);
924
925                 /* Erase any text that was already typed */
926                 GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
927                 gtk_text_buffer_get_iter_at_mark(buffer, &start, input_position);
928                 gtk_text_buffer_get_end_iter(buffer, &end);
929                 gtk_text_buffer_delete(buffer, &start, &end);
930
931                 /* Make the window uneditable again */
932                 gtk_text_view_set_editable(GTK_TEXT_VIEW(win->widget), FALSE);
933
934                 /* Insert the forced input into the window */
935                 if(win->echo_current_line_input)
936                 {
937                         gtk_text_buffer_get_end_iter(buffer, &end);
938                         gchar *text_to_insert = g_strconcat(text, "\n", NULL);
939                         gtk_text_buffer_insert_with_tags_by_name(buffer, &end, text_to_insert, -1, "default", "input", NULL);
940                 }
941
942                 chars_written = finish_text_buffer_line_input(win, TRUE);
943         }
944         else if(win->type == wintype_TextGrid)
945         {
946                 /* Remove signal handlers so the line input doesn't get picked up again */
947                 g_signal_handler_block(win->widget, win->char_input_keypress_handler);
948
949                 /* Insert the forced input into the window */
950                 gtk_entry_set_text(GTK_ENTRY(win->input_entry), text);
951                 chars_written = finish_text_grid_line_input(win, TRUE);
952         }
953         gdk_threads_leave();
954
955         event->type = evtype_LineInput;
956         event->win = win;
957         event->val1 = chars_written;
958         event->val2 = 0;
959 }
960
961 /*** Internal function: cancels any pending input requests on the window and presents a warning if not INPUT_REQUEST_NONE ***/
962 void
963 cancel_old_input_request(winid_t win)
964 {
965         switch(win->input_request_type) {
966         case INPUT_REQUEST_NONE:
967                 break; /* All is well */
968         case INPUT_REQUEST_CHARACTER:
969         case INPUT_REQUEST_CHARACTER_UNICODE:
970                 glk_cancel_char_event(win);
971                 WARNING("Cancelling pending char event");
972                 break;
973         case INPUT_REQUEST_LINE:
974         case INPUT_REQUEST_LINE_UNICODE:
975                 glk_cancel_line_event(win, NULL);
976                 WARNING("Cancelling pending line event");
977                 break;
978         default:
979                 WARNING("Could not cancel pending input request: unknown input request");
980         }
981 }
982
983 /**
984  * glk_set_echo_line_event:
985  * @win: The window in which to change the echoing behavior.
986  * @val: Zero to turn off echoing, nonzero for normal echoing.
987  *
988  * Normally, after line input is completed or cancelled in a buffer window, the
989  * library ensures that the complete input line (or its latest state, after
990  * cancelling) is displayed at the end of the buffer, followed by a newline.
991  * This call allows you to suppress this behavior. If the @val argument is zero,
992  * all <emphasis>subsequent</emphasis> line input requests in the given window
993  * will leave the buffer unchanged after the input is completed or cancelled;
994  * the player's input will not be printed. If @val is nonzero, subsequent input
995  * requests will have the normal printing behavior.
996  *
997  * <note><para>
998  *   Note that this feature is unrelated to the window's echo stream.
999  * </para></note>
1000  *
1001  * If you turn off line input echoing, you can reproduce the standard input
1002  * behavior by following each line input event (or line input cancellation) by
1003  * printing the input line, in the Input style, followed by a newline in the
1004  * original style.
1005  *
1006  * The glk_set_echo_line_event() does not affect a pending line input request.
1007  * It also has no effect in non-buffer windows.
1008  * <note><para>
1009  *   In a grid window, the game can overwrite the input area at will, so there
1010  *   is no need for this distinction.
1011  * </para></note>
1012  *
1013  * Not all libraries support this feature. You can test for it with
1014  * %gestalt_LineInputEcho.
1015  */
1016 void
1017 glk_set_echo_line_event(winid_t win, glui32 val)
1018 {
1019         VALID_WINDOW(win, return);
1020
1021         if(win->type != wintype_TextBuffer)
1022                 return; /* Quietly do nothing */
1023
1024         win->echo_line_input = val? TRUE : FALSE;
1025 }
1026
1027 /* Internal function to convert from a Glk keycode to a GDK keyval. */
1028 static unsigned
1029 keycode_to_gdk_keyval(glui32 keycode)
1030 {
1031         switch (keycode)
1032         {
1033                 case keycode_Left:
1034                         return GDK_Left;
1035                 case keycode_Right:
1036                         return GDK_Right;
1037                 case keycode_Up:
1038                         return GDK_Up;
1039                 case keycode_Down:
1040                         return GDK_Down;
1041                 case keycode_Return:
1042                         return GDK_Return;
1043                 case keycode_Delete:
1044                         return GDK_Delete;
1045                 case keycode_Escape:
1046                         return GDK_Escape;
1047                 case keycode_Tab:
1048                         return GDK_Tab;
1049                 case keycode_PageUp:
1050                         return GDK_Page_Up;
1051                 case keycode_PageDown:
1052                         return GDK_Page_Down;
1053                 case keycode_Home:
1054                         return GDK_Home;
1055                 case keycode_End:
1056                         return GDK_End;
1057                 case keycode_Func1:
1058                         return GDK_F1;
1059                 case keycode_Func2:
1060                         return GDK_F2;
1061                 case keycode_Func3:
1062                         return GDK_F3;
1063                 case keycode_Func4:
1064                         return GDK_F4;
1065                 case keycode_Func5:
1066                         return GDK_F5;
1067                 case keycode_Func6:
1068                         return GDK_F6;
1069                 case keycode_Func7:
1070                         return GDK_F7;
1071                 case keycode_Func8:
1072                         return GDK_F8;
1073                 case keycode_Func9:
1074                         return GDK_F9;
1075                 case keycode_Func10:
1076                         return GDK_F10;
1077                 case keycode_Func11:
1078                         return GDK_F11;
1079                 case keycode_Func12:
1080                         return GDK_F12;
1081                 case keycode_Erase:
1082                         return GDK_BackSpace;
1083         }
1084         unsigned keyval = gdk_unicode_to_keyval(keycode);
1085         if(keyval < 0x01000000) /* magic number meaning illegal unicode point */
1086                 return keyval;
1087         return 0;
1088 }
1089
1090 /* Internal function to decide whether @keycode is a valid line terminator. */
1091 gboolean
1092 is_valid_line_terminator(glui32 keycode)
1093 {
1094         switch(keycode) {
1095                 default:
1096                         return FALSE;
1097         }
1098 }
1099
1100 /**
1101  * glk_set_terminators_line_event:
1102  * @win: The window for which to set the line input terminator keys.
1103  * @keycodes: An array of <code>keycode_</code> constants, of length @count.
1104  * @count: The array length of @keycodes.
1105  *
1106  * It is possible to request that other keystrokes complete line input as well.
1107  * (This allows a game to intercept function keys or other special keys during
1108  * line input.) To do this, call glk_set_terminators_line_event(), and pass an
1109  * array of @count keycodes. These must all be special keycodes (see <link
1110  * linkend="chimara-Character-Input">Character Input</link>). Do not include
1111  * regular printable characters in the array, nor %keycode_Return (which
1112  * represents the default <keycap>enter</keycap> key and will always be
1113  * recognized). To return to the default behavior, pass a %NULL or empty array.
1114  *
1115  * The glk_set_terminators_line_event() affects <emphasis>subsequent</emphasis>
1116  * line input requests in the given window. It does not affect a pending line
1117  * input request.
1118  *
1119  * <note><para>
1120  *   This distinction makes life easier for interpreters that set up UI
1121  *   callbacks only at the start of input.
1122  * </para></note>
1123  *
1124  * A library may not support this feature; if it does, it may not support all
1125  * special keys as terminators. (Some keystrokes are reserved for OS or
1126  * interpreter control.) You can test for this with %gestalt_LineTerminators and
1127  * %gestalt_LineTerminatorKey.
1128  */
1129 void
1130 glk_set_terminators_line_event(winid_t win, glui32 *keycodes, glui32 count)
1131 {
1132         VALID_WINDOW(win, return);
1133
1134         g_slist_free(win->extra_line_terminators);
1135         win->extra_line_terminators = NULL;
1136
1137         if(keycodes == NULL || count == 0)
1138                 return;
1139
1140         int i;
1141         for(i = 0; i < count; i++)
1142         {
1143                 unsigned key = keycode_to_gdk_keyval(keycodes[i]);
1144                 if(is_valid_line_terminator(keycodes[i]))
1145                         win->extra_line_terminators = g_slist_prepend(win->extra_line_terminators, GUINT_TO_POINTER(key));
1146                 else
1147                    WARNING_S("Ignoring invalid line terminator", gdk_keyval_name(key));
1148         }
1149 }