* Fixed flush_text_buffer() function. It always assumed a newline at the end and...
[rodin/chimara.git] / src / input.c
index c9775fc77623465c2172ff31b1347aa724375dad..89356fae2ff913d8f9a6c07e085ca9556dad067a 100644 (file)
@@ -1,4 +1,5 @@
 #include "charset.h"
+#include "magic.h"
 #include "input.h"
 
 /** 
@@ -14,7 +15,7 @@
 void
 glk_request_char_event(winid_t win)
 {
-       g_return_if_fail(win);
+       VALID_WINDOW(win, return);
        g_return_if_fail(win->input_request_type == INPUT_REQUEST_NONE);
        g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
 
@@ -32,7 +33,7 @@ glk_request_char_event(winid_t win)
 void
 glk_request_char_event_uni(winid_t win)
 {
-       g_return_if_fail(win);
+       VALID_WINDOW(win, return);
        g_return_if_fail(win->input_request_type == INPUT_REQUEST_NONE);
        g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
 
@@ -40,8 +41,30 @@ glk_request_char_event_uni(winid_t win)
        g_signal_handler_unblock( G_OBJECT(win->widget), win->keypress_handler );
 }
 
-/* Internal function: Request either latin-1 or unicode line input, in a text grid window. */
+/**
+ * glk_cancel_char_event:
+ * @win: A window to cancel the latest char event request on.
+ *
+ * This cancels a pending request for character input. (Either Latin-1 or
+ * Unicode.) For convenience, it is legal to call glk_cancel_char_event() even
+ * if there is no charcter input request on that window. Glk will ignore the
+ * call in this case.
+ */
 void
+glk_cancel_char_event(winid_t win)
+{
+       VALID_WINDOW(win, return);
+       g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
+       
+       if(win->input_request_type == INPUT_REQUEST_CHARACTER || win->input_request_type == INPUT_REQUEST_CHARACTER_UNICODE)
+       {
+               win->input_request_type = INPUT_REQUEST_NONE;
+               g_signal_handler_block( G_OBJECT(win->widget), win->keypress_handler );
+       }
+}
+
+/* Internal function: Request either latin-1 or unicode line input, in a text grid window. */
+static void
 text_grid_request_line_event_common(winid_t win, glui32 maxlen, gboolean insert, gchar *inserttext)
 {
        GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
@@ -59,6 +82,17 @@ text_grid_request_line_event_common(winid_t win, glui32 maxlen, gboolean insert,
     end_iter = start_iter;
     gtk_text_iter_set_line_offset(&end_iter, cursorpos + win->input_length);
     
+       /* If the buffer currently has a selection with one bound in the middle of
+       the input field, then deselect it. Otherwise the input field gets trashed */
+       GtkTextIter start_sel, end_sel;
+       if( gtk_text_buffer_get_selection_bounds(buffer, &start_sel, &end_sel) )
+       {
+               if( gtk_text_iter_in_range(&start_sel, &start_iter, &end_iter) )
+                       gtk_text_buffer_place_cursor(buffer, &end_sel);
+               if( gtk_text_iter_in_range(&end_sel, &start_iter, &end_iter) )
+                       gtk_text_buffer_place_cursor(buffer, &start_sel);
+       }
+       
     /* Erase the text currently in the input field and replace it with a GtkEntry */
     gtk_text_buffer_delete(buffer, &start_iter, &end_iter);
     win->input_anchor = gtk_text_buffer_create_child_anchor(buffer, &start_iter);
@@ -91,7 +125,7 @@ text_grid_request_line_event_common(winid_t win, glui32 maxlen, gboolean insert,
 }
     
 /* Internal function: Request either latin-1 or unicode line input, in a text buffer window. */
-void
+static void
 text_buffer_request_line_event_common(winid_t win, glui32 maxlen, gboolean insert, gchar *inserttext)
 {
        GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
@@ -137,7 +171,7 @@ text_buffer_request_line_event_common(winid_t win, glui32 maxlen, gboolean inser
  * (This may not be %NULL.) @maxlen is the length of this space, in bytes; the
  * library will not accept more characters than this. If @initlen is nonzero,
  * then the first @initlen bytes of @buf will be entered as pre-existing input
- * -- just as if the player had typed them himself. (The player can continue
+ * — just as if the player had typed them himself. (The player can continue
  * composing after this pre-entered input, or delete it or edit as usual.)
  * 
  * The contents of the buffer are undefined until the input is completed (either
@@ -148,7 +182,7 @@ text_buffer_request_line_event_common(winid_t win, glui32 maxlen, gboolean inser
 void
 glk_request_line_event(winid_t win, char* buf, glui32 maxlen, glui32 initlen)
 {
-       g_return_if_fail(win);
+       VALID_WINDOW(win, return);
        g_return_if_fail(buf);
        g_return_if_fail(win->input_request_type == INPUT_REQUEST_NONE);
        g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
@@ -167,8 +201,6 @@ glk_request_line_event(winid_t win, char* buf, glui32 maxlen, glui32 initlen)
            case wintype_TextGrid:
                text_grid_request_line_event_common(win, maxlen, (initlen > 0), inserttext);
                break;
-        default:
-            g_assert_not_reached();
     }
        g_free(inserttext);
 }
@@ -194,7 +226,7 @@ glk_request_line_event(winid_t win, char* buf, glui32 maxlen, glui32 initlen)
 void
 glk_request_line_event_uni(winid_t win, glui32 *buf, glui32 maxlen, glui32 initlen)
 {
-       g_return_if_fail(win);
+       VALID_WINDOW(win, return);
        g_return_if_fail(buf);
        g_return_if_fail(win->input_request_type == INPUT_REQUEST_NONE);
        g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
@@ -221,12 +253,58 @@ glk_request_line_event_uni(winid_t win, glui32 *buf, glui32 maxlen, glui32 initl
            case wintype_TextGrid:
                text_grid_request_line_event_common(win, maxlen, (initlen > 0), utf8);
                break;
-        default:
-            g_assert_not_reached();
     }          
        g_free(utf8);
 }
 
+/**
+ * glk_cancel_line_event:
+ * @win: A text buffer or text grid window to cancel line input on.
+ * @event: Will be filled in if the user had already input something.
+ *
+ * This cancels a pending request for line input. (Either Latin-1 or Unicode.)
+ *
+ * The event pointed to by the event argument will be filled in as if the
+ * player had hit <keycap>enter</keycap>, and the input composed so far will be stored in the
+ * buffer; see below. If you do not care about this information, pass %NULL as
+ * the @event argument. (The buffer will still be filled.) 
+ *
+ * For convenience, it is legal to call glk_cancel_line_event() even if there
+ * is no line input request on that window. The event type will be set to
+ * #evtype_None in this case.
+ */
+void
+glk_cancel_line_event(winid_t win, event_t *event)
+{
+       /* TODO: write me */
+       VALID_WINDOW(win, return);
+       g_return_if_fail(win->input_request_type != INPUT_REQUEST_NONE);
+       g_return_if_fail(win->type != wintype_TextBuffer || win->type != wintype_TextGrid);
+
+       event->type = evtype_None;
+       event->win = win;
+       event->val1 = 0;
+       event->val2 = 0;
+
+       g_signal_handler_block( G_OBJECT(win->widget), win->keypress_handler );
+
+       int chars_written = 0;
+
+       if(win->type == wintype_TextGrid) {
+               g_signal_handler_block( G_OBJECT(win->widget), win->keypress_handler );
+               chars_written = flush_text_grid(win);
+       } else if(win->type == wintype_TextBuffer) {
+               GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
+               g_signal_handler_block(window_buffer, win->insert_text_handler);
+               chars_written = flush_text_buffer(win);
+       }
+
+       if(chars_written > 0) {
+               event->type = evtype_LineInput;
+               event->val1 = chars_written;
+       }
+}
+
 /* 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, and also in line input on grids, to redirect keystrokes to the line input field. Blocked when not in use. */
 gboolean
 on_window_key_press_event(GtkWidget *widget, GdkEventKey *event, winid_t win)
@@ -317,9 +395,11 @@ on_window_key_press_event(GtkWidget *widget, GdkEventKey *event, winid_t win)
 }
 
 /* Internal function: finish handling a line input request, for both text grid and text buffer windows. */
-static void
-end_line_input_request(winid_t win, const gchar *inserted_text)
+static int
+write_to_window_buffer(winid_t win, const gchar *inserted_text)
 {
+       int copycount = 0;
+
     /* Convert the string from UTF-8 to Latin-1 or Unicode */
     if(win->input_request_type == INPUT_REQUEST_LINE) 
     {
@@ -327,20 +407,16 @@ end_line_input_request(winid_t win, const gchar *inserted_text)
         gchar *latin1 = convert_utf8_to_latin1(inserted_text, &bytes_written);
         
         if(latin1 == NULL)
-        {
-            event_throw(evtype_LineInput, win, 0, 0);
-            return;
-        }
+            return 0;
 
         /* Place input in the echo stream */
         if(win->echo_stream != NULL) 
             glk_put_string_stream(win->echo_stream, latin1);
 
         /* Copy the string (bytes_written does not include the NULL at the end) */
-        int copycount = MIN(win->line_input_buffer_max_len, bytes_written);
+        copycount = MIN(win->line_input_buffer_max_len, bytes_written);
         memcpy(win->line_input_buffer, latin1, copycount);
         g_free(latin1);
-        event_throw(evtype_LineInput, win, copycount, 0);
     }
     else if(win->input_request_type == INPUT_REQUEST_LINE_UNICODE) 
     {
@@ -348,71 +424,70 @@ end_line_input_request(winid_t win, const gchar *inserted_text)
         gunichar *unicode = convert_utf8_to_ucs4(inserted_text, &items_written);
         
         if(unicode == NULL)
-        {
-            event_throw(evtype_LineInput, win, 0, 0);
-            return;
-        }
+            return 0;
 
         /* Place input in the echo stream */
         if(win->echo_stream != NULL) 
             glk_put_string_stream_uni(win->echo_stream, unicode);
 
         /* Copy the string (but not the NULL at the end) */
-        int copycount = MIN(win->line_input_buffer_max_len, items_written);
+        copycount = MIN(win->line_input_buffer_max_len, items_written);
         memcpy(win->line_input_buffer_unicode, unicode, copycount * sizeof(gunichar));
         g_free(unicode);
-        event_throw(evtype_LineInput, win, copycount, 0);
     }
     else 
-        g_warning("%s: Wrong input request type.", __func__);
+        WARNING("Wrong input request type");
 
     win->input_request_type = INPUT_REQUEST_NONE;
+       return copycount;
 }
 
-/* Internal function: Callback for signal insert-text on a text buffer window.
-Runs after the default handler has already inserted the text.
-FIXME: This function assumes that newline was the last character typed into the
-window. That assumption is wrong if, for example, text containing a newline was
-pasted into the window. */
-void
-after_window_insert_text(GtkTextBuffer *textbuffer, GtkTextIter *location, gchar *text, gint len, winid_t win) 
+/* Internal function: Retrieves the input of a TextBuffer window and stores it in the window buffer.
+ * Returns the number of characters written, suitable for inclusion in a line input event. */
+static int
+flush_text_buffer(winid_t win)
 {
-       if( strchr(text, '\n') != NULL ) 
-       {
-               /* Remove signal handlers */
-               GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
-               g_signal_handler_block(window_buffer, win->insert_text_handler);
-               
-               /* Make the window uneditable again and retrieve the text that was input */
-               gchar *inserted_text;
-               GtkTextIter start_iter, end_iter;
+       VALID_WINDOW(win, return 0);
+       g_return_val_if_fail(win->type == wintype_TextBuffer, 0);
 
-        gtk_text_view_set_editable(GTK_TEXT_VIEW(win->widget), FALSE);
-        GtkTextMark *input_position = gtk_text_buffer_get_mark(window_buffer, "input_position");
-        gtk_text_buffer_get_iter_at_mark(window_buffer, &start_iter, input_position);
-        gtk_text_buffer_get_end_iter(window_buffer, &end_iter);
-               gtk_text_iter_backward_cursor_position(&end_iter); /* don't include \n */
-        
-        inserted_text = gtk_text_buffer_get_text(window_buffer, &start_iter, &end_iter, FALSE);
+       GtkTextIter start_iter, end_iter, last_character;
 
-        end_line_input_request(win, inserted_text);
-        g_free(inserted_text);
-       }
+       GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
+       GtkTextMark *input_position = gtk_text_buffer_get_mark(window_buffer, "input_position");
+       gtk_text_buffer_get_iter_at_mark(window_buffer, &start_iter, input_position);
+       gtk_text_buffer_get_end_iter(window_buffer, &end_iter);
+       gtk_text_buffer_get_end_iter(window_buffer, &last_character);
+       gtk_text_iter_backward_cursor_position(&last_character);
+
+       gchar* last_char = gtk_text_buffer_get_text(window_buffer, &last_character, &end_iter, FALSE);
+
+       if( strchr(last_char, '\n') != NULL )
+               gtk_text_iter_backward_cursor_position(&end_iter);
+
+       gchar* inserted_text = gtk_text_buffer_get_text(window_buffer, &start_iter, &end_iter, FALSE);
+
+       int chars_written = write_to_window_buffer(win, inserted_text);
+       g_free(inserted_text);
+
+       return chars_written;
 }
 
-/* Internal function: Callback for signal activate on the line input GtkEntry
-in a text grid window. */
-void
-on_input_entry_activate(GtkEntry *input_entry, winid_t win)
+/* Internal function: Retrieves the input of a TextGrid window and stores it in the window buffer.
+ * Returns the number of characters written, suitable for inclusion in a line input event. */
+static int
+flush_text_grid(winid_t win)
 {
+       VALID_WINDOW(win, return 0);
+       g_return_val_if_fail(win->type == wintype_TextBuffer, 0);
+
        GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
        
-       gchar *text = g_strdup(gtk_entry_get_text(input_entry));
+       gchar *text = g_strdup( gtk_entry_get_text(GTK_ENTRY(win->input_entry)) );
        /* Move the focus back into the text view */
        gtk_widget_grab_focus(win->widget);
        /* Remove entry widget from text view */
        /* Should be ok even though this is the widget's own signal handler */
-       gtk_container_remove( GTK_CONTAINER(win->widget), GTK_WIDGET(input_entry) );
+       gtk_container_remove( GTK_CONTAINER(win->widget), GTK_WIDGET(win->input_entry) );
        win->input_entry = NULL;
        /* Delete the child anchor */
        GtkTextIter start, end;
@@ -428,9 +503,42 @@ on_input_entry_activate(GtkEntry *input_entry, winid_t win)
     gtk_text_buffer_insert(buffer, &start, text_to_insert, -1);
     g_free(text_to_insert);
     
-       g_signal_handler_block( G_OBJECT(win->widget), win->keypress_handler );
-       
-    end_line_input_request(win, text);
+    int chars_written = write_to_window_buffer(win, text);
        g_free(text);
+
+       return chars_written;
+}
+
+/* Internal function: Callback for signal insert-text on a text buffer window.
+Runs after the default handler has already inserted the text.
+FIXME: This function assumes that newline was the last character typed into the
+window. That assumption is wrong if, for example, text containing a newline was
+pasted into the window. */
+void
+after_window_insert_text(GtkTextBuffer *textbuffer, GtkTextIter *location, gchar *text, gint len, winid_t win) 
+{
+       if( strchr(text, '\n') != NULL ) 
+       {
+               /* Remove signal handlers */
+               GtkTextBuffer *window_buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
+               g_signal_handler_block(window_buffer, win->insert_text_handler);
+               
+               /* Make the window uneditable again and retrieve the text that was input */
+        gtk_text_view_set_editable(GTK_TEXT_VIEW(win->widget), FALSE);
+
+        int chars_written = flush_text_buffer(win);
+               event_throw(evtype_LineInput, win, chars_written, 0);
+       }
+}
+
+/* Internal function: Callback for signal activate on the line input GtkEntry
+in a text grid window. */
+void
+on_input_entry_activate(GtkEntry *input_entry, winid_t win)
+{
+       g_signal_handler_block( G_OBJECT(win->widget), win->keypress_handler );
+
+       int chars_written = flush_text_grid(win);
+       event_throw(evtype_LineInput, win, chars_written, 0);
 }