Add new resource stream unit test
[projects/chimara/chimara.git] / libchimara / strio.c
index bc645b9a6c6bfb926d08dbffaa276f10cbbadc11..41146f24fd6613bb159cc7d653093bcbaf5f5835 100644 (file)
@@ -7,6 +7,23 @@
 #include <glib.h>
 #include <glib/gstdio.h>
 
+/* Internal function: ensure that an fseek() is called on a file pointer in
+ between reading and writing operations, and vice versa. This will only come up
+ for ReadWrite or WriteAppend files. */
+static void
+ensure_file_operation(strid_t str, glui32 op)
+{
+       if(str->lastop != 0 && str->lastop != op)
+       {
+               long pos = ftell(str->file_pointer);
+               if(pos == -1)
+                       WARNING_S("ftell() failed", g_strerror(errno));
+               if(fseek(str->file_pointer, pos, SEEK_SET) != 0)
+                       WARNING_S("fseek() failed", g_strerror(errno));
+       }
+       str->lastop = op; /* Not 0, because we are about to do the operation anyway */
+}
+
 /*
  *
  **************** WRITING FUNCTIONS ********************************************
@@ -31,6 +48,9 @@ write_utf8_to_window_buffer(winid_t win, gchar *s)
 void
 flush_window_buffer(winid_t win)
 {
+#ifdef DEBUG_STYLES
+       g_printf("%s\n", win->buffer->str);
+#endif
        if(win->type != wintype_TextBuffer && win->type != wintype_TextGrid)
                return;
 
@@ -58,15 +78,15 @@ flush_window_buffer(winid_t win)
                gtk_text_buffer_insert(buffer, &end, win->buffer->str, -1);
                gtk_text_buffer_get_iter_at_offset(buffer, &start, start_offset);
 
-               // Default style
-               gtk_text_buffer_apply_tag(buffer, default_tag, &start, &end);
-
                // Player's style overrides
                gtk_text_buffer_apply_tag(buffer, style_tag, &start, &end);
 
                // GLK Program's style overrides
                gtk_text_buffer_apply_tag(buffer, glk_style_tag, &start, &end);
 
+               // Default style
+               gtk_text_buffer_apply_tag(buffer, default_tag, &start, &end);
+
                // Link style overrides
                if(win->window_stream->hyperlink_mode) {
                        GtkTextTag *link_style_tag = gtk_text_tag_table_lookup(tags, "hyperlink");
@@ -76,8 +96,14 @@ flush_window_buffer(winid_t win)
                }
 
                // GLK Program's style overrides using garglk_set_zcolors()
-               if(win->zcolor != NULL)
+               if(win->zcolor != NULL) {
                        gtk_text_buffer_apply_tag(buffer, win->zcolor, &start, &end);
+               }
+
+               // GLK Program's style overrides using garglk_set_reversevideo()
+               if(win->zcolor_reversed != NULL) {
+                       gtk_text_buffer_apply_tag(buffer, win->zcolor_reversed, &start, &end);
+               }
 
                ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(win->widget, CHIMARA_TYPE_GLK));
                g_assert(glk);
@@ -102,14 +128,15 @@ flush_window_buffer(winid_t win)
                gint available_space = win->width - gtk_text_iter_get_line_offset(&insert);
                
                GtkTextTagTable *tags = gtk_text_buffer_get_tag_table(buffer);
+
                GtkTextTag *default_tag = gtk_text_tag_table_lookup(tags, "default");
                GtkTextTag *style_tag = gtk_text_tag_table_lookup(tags, win->window_stream->style);
                GtkTextTag *glk_style_tag = gtk_text_tag_table_lookup(tags, win->window_stream->glk_style);
                GtkTextTag *link_style_tag = gtk_text_tag_table_lookup(tags, "hyperlink");
 
-               while(chars_left > available_space && !gtk_text_iter_is_end(&start))
+               while(chars_left > available_space && !gtk_text_iter_is_end(&insert))
                {
-                       GtkTextIter end = start;
+                       GtkTextIter end = insert;
                        gtk_text_iter_forward_to_line_end(&end);
                        gtk_text_buffer_delete(buffer, &insert, &end);
 
@@ -134,11 +161,13 @@ flush_window_buffer(winid_t win)
                        }
 
                        // GLK Program's style overrides using garglk_set_zcolors()
-                       /*
                        if(win->zcolor != NULL)
                                gtk_text_buffer_apply_tag(buffer, win->zcolor, &start, &insert);
-                               */
 
+                       // GLK Program's style overrides using garglk_set_reversevideo()
+                       if(win->zcolor_reversed != NULL) {
+                               gtk_text_buffer_apply_tag(buffer, win->zcolor_reversed, &start, &insert);
+                       }
 
                        chars_left -= available_space;
                        gtk_text_iter_forward_line(&insert);
@@ -171,10 +200,13 @@ flush_window_buffer(winid_t win)
                        }
 
                        // GLK Program's style overrides using garglk_set_zcolors()
-                       /*
                        if(win->zcolor != NULL)
                                gtk_text_buffer_apply_tag(buffer, win->zcolor, &start, &insert);
-                               */
+
+                       // GLK Program's style overrides using garglk_set_reversevideo()
+                       if(win->zcolor_reversed != NULL) {
+                               gtk_text_buffer_apply_tag(buffer, win->zcolor_reversed, &start, &insert);
+                       }
                }
                
                gtk_text_buffer_move_mark(buffer, cursor, &start);
@@ -206,6 +238,44 @@ write_buffer_to_stream(strid_t str, gchar *buf, glui32 len)
                                        
                            /* Text grid/buffer windows */
                            case wintype_TextGrid:
+                               {
+                               gchar *utf8 = convert_latin1_to_utf8(buf, len);
+                               if(utf8 != NULL) {
+                                               /* Deal with newlines */
+                                               int i;
+                                               gchar *line = utf8;
+                                               for(i=0; i<len; i++) {
+                                                       if(utf8[i] == '\n') {
+                                                               utf8[i] = '\0';
+                                                               write_utf8_to_window_buffer(str->window, line);
+                                                               flush_window_buffer(str->window);
+
+                                                               /* Move cursor position forward to the next line */
+                                                               gdk_threads_enter();
+                                                               GtkTextIter cursor_pos;
+                                                               GtkTextView *textview = GTK_TEXT_VIEW(str->window->widget);
+                                                               GtkTextBuffer *buffer = gtk_text_view_get_buffer(textview);
+                                                               GtkTextMark *cursor_mark = gtk_text_buffer_get_mark(buffer, "cursor_position");
+
+                                                           gtk_text_buffer_get_iter_at_mark( buffer, &cursor_pos, cursor_mark);
+                                                               gtk_text_view_forward_display_line(textview, &cursor_pos);
+                                                               gtk_text_view_backward_display_line_start(textview, &cursor_pos);
+                                                               gtk_text_buffer_move_mark(buffer, cursor_mark, &cursor_pos);
+                                                               gdk_threads_leave();
+
+                                                               line = utf8 + (i < len-1 ? (i+1):(len-1));
+                                                       }
+                                               }
+                                                               
+                                               /* No more newlines left. */
+                                               write_utf8_to_window_buffer(str->window, line);
+                                               g_free(utf8);
+                                       }
+
+                                       str->write_count += len;
+                               }
+                                       break;
+
                                case wintype_TextBuffer:
                            {
                                gchar *utf8 = convert_latin1_to_utf8(buf, len);
@@ -240,6 +310,10 @@ write_buffer_to_stream(strid_t str, gchar *buf, glui32 len)
                                str->mark += copycount;
                        }
 
+                       /* Move the EOF marker if we wrote past it */
+                       if(str->mark > str->endmark)
+                               str->endmark = str->mark;
+
                        str->write_count += len;
                        break;
                        
@@ -249,11 +323,13 @@ write_buffer_to_stream(strid_t str, gchar *buf, glui32 len)
                                if(str->unicode) 
                                {
                                        gchar *writebuffer = convert_latin1_to_ucs4be_string(buf, len);
+                                       ensure_file_operation(str, filemode_Write);
                                        fwrite(writebuffer, sizeof(gchar), len * 4, str->file_pointer);
                                        g_free(writebuffer);
                                } 
                                else /* Regular file */
                                {
+                                       ensure_file_operation(str, filemode_Write);
                                        fwrite(buf, sizeof(gchar), len, str->file_pointer);
                                }
                        }
@@ -262,6 +338,7 @@ write_buffer_to_stream(strid_t str, gchar *buf, glui32 len)
                                gchar *utf8 = convert_latin1_to_utf8(buf, len);
                                if(utf8 != NULL)
                                {
+                                       ensure_file_operation(str, filemode_Write);
                                        g_fprintf(str->file_pointer, "%s", utf8);
                                        g_free(utf8);
                                }
@@ -329,6 +406,10 @@ write_buffer_to_stream_uni(strid_t str, glui32 *buf, glui32 len)
                                str->mark += copycount;
                        }
 
+                       /* Move the EOF marker if we wrote past it */
+                       if(str->mark > str->endmark)
+                               str->endmark = str->mark;
+
                        str->write_count += len;
                        break;
                        
@@ -338,12 +419,14 @@ write_buffer_to_stream_uni(strid_t str, glui32 *buf, glui32 len)
                                if(str->unicode) 
                                {
                                        gchar *writebuffer = convert_ucs4_to_ucs4be_string(buf, len);
+                                       ensure_file_operation(str, filemode_Write);
                                        fwrite(writebuffer, sizeof(gchar), len * 4, str->file_pointer);
                                        g_free(writebuffer);
                                } 
                                else /* Regular file */
                                {
                                        gchar *latin1 = convert_ucs4_to_latin1_binary(buf, len);
+                                       ensure_file_operation(str, filemode_Write);
                                        fwrite(latin1, sizeof(gchar), len, str->file_pointer);
                                        g_free(latin1);
                                }
@@ -353,6 +436,7 @@ write_buffer_to_stream_uni(strid_t str, glui32 *buf, glui32 len)
                                gchar *utf8 = convert_ucs4_to_utf8(buf, len);
                                if(utf8 != NULL) 
                                {
+                                       ensure_file_operation(str, filemode_Write);
                                        g_fprintf(str->file_pointer, "%s", utf8);
                                        g_free(utf8);
                                }
@@ -501,10 +585,11 @@ glk_put_buffer_stream_uni(strid_t str, glui32 *buf, glui32 len)
 /* Internal function: Read one big-endian four-byte character from file fp and
 return it as a Unicode code point, or -1 on EOF */
 static glsi32
-read_ucs4be_char_from_file(FILE *fp)
+read_ucs4be_char_from_file(strid_t str)
 {
        unsigned char readbuffer[4];
-       if(fread(readbuffer, sizeof(unsigned char), 4, fp) < 4)
+       ensure_file_operation(str, filemode_Read);
+       if(fread(readbuffer, sizeof(unsigned char), 4, str->file_pointer) < 4)
                return -1; /* EOF */
        return
                readbuffer[0] << 24 | 
@@ -516,14 +601,15 @@ read_ucs4be_char_from_file(FILE *fp)
 /* Internal function: Read one UTF-8 character, which may be more than one byte,
 from file fp and return it as a Unicode code point, or -1 on EOF */
 static glsi32
-read_utf8_char_from_file(FILE *fp)
+read_utf8_char_from_file(strid_t str)
 {
        gchar readbuffer[4] = {0, 0, 0, 0}; /* Max UTF-8 width */
        int foo;
        gunichar charresult = (gunichar)-2;
+       ensure_file_operation(str, filemode_Read);
        for(foo = 0; foo < 4 && charresult == (gunichar)-2; foo++) 
        {
-               int ch = fgetc(fp);
+               int ch = fgetc(str->file_pointer);
                if(ch == EOF)
                        return -1;
                readbuffer[foo] = (gchar)ch;
@@ -542,16 +628,18 @@ file pointer and eight-bit flag are included in case the newline is a CR
 (U+000D). If the next character is LF (U+000A) then it also belongs to the
 newline. */
 static gboolean
-is_unicode_newline(glsi32 ch, FILE *fp, gboolean utf8)
+is_unicode_newline(glsi32 ch, strid_t str, gboolean utf8)
 {
        if(ch == 0x0A || ch == 0x85 || ch == 0x0C || ch == 0x2028 || ch == 0x2029)
                return TRUE;
        if(ch == 0x0D) {
-               glsi32 ch2 = utf8? read_utf8_char_from_file(fp) : 
-                       read_ucs4be_char_from_file(fp);
-               if(ch2 != 0x0A)
-                       if(fseek(fp, utf8? -1 : -4, SEEK_CUR) == -1);
+               glsi32 ch2 = utf8? read_utf8_char_from_file(str) :
+                       read_ucs4be_char_from_file(str);
+               if(ch2 != 0x0A) {
+                       if(fseek(str->file_pointer, utf8? -1 : -4, SEEK_CUR) == -1)
                                WARNING_S("Seek failed on stream", g_strerror(errno) );
+                       str->lastop = 0; /* can read or write after a seek */
+               }
                return TRUE;
        }
        return FALSE;
@@ -589,7 +677,7 @@ get_char_stream_common(strid_t str)
                        {
                                if(str->unicode) 
                                {
-                                       glsi32 ch = read_ucs4be_char_from_file(str->file_pointer);
+                                       glsi32 ch = read_ucs4be_char_from_file(str);
                                        if(ch == -1)
                                                return -1;
                                        str->read_count++;
@@ -597,6 +685,7 @@ get_char_stream_common(strid_t str)
                                }
                                else /* Regular file */
                                {
+                                       ensure_file_operation(str, filemode_Read);
                                        int ch = fgetc(str->file_pointer);
                                        if(ch == EOF)
                                                return -1;
@@ -607,7 +696,7 @@ get_char_stream_common(strid_t str)
                        }
                        else /* Text mode is the same for Unicode and regular files */
                        {
-                               glsi32 ch = read_utf8_char_from_file(str->file_pointer);
+                               glsi32 ch = read_utf8_char_from_file(str);
                                if(ch == -1)
                                        return -1;
                                        
@@ -662,8 +751,8 @@ glk_get_char_stream(strid_t str)
  * glk_get_char_stream_uni:
  * @str: An input stream.
  *
- * Reads one character from the stream @str. The result will be between 0 and 
- * 0x7FFFFFFF. If the end of the stream has been reached, the result will be -1.
+ * Reads one character from the stream @str. If the end of the stream has been
+ * reached, the result will be -1.
  *
  * Returns: A value between 0 and 0x7FFFFFFF, or -1 on end of stream.
  */
@@ -725,6 +814,7 @@ glk_get_buffer_stream(strid_t str, char *buf, glui32 len)
                                {
                                        /* Read len characters of 4 bytes each */
                                        unsigned char *readbuffer = g_new0(unsigned char, 4 * len);
+                                       ensure_file_operation(str, filemode_Read);
                                        size_t count = fread(readbuffer, sizeof(unsigned char), 4 * len, str->file_pointer);
                                        /* If there was an incomplete character */
                                        if(count % 4 != 0) 
@@ -748,6 +838,7 @@ glk_get_buffer_stream(strid_t str, char *buf, glui32 len)
                                }
                                else /* Regular binary file */
                                {
+                                       ensure_file_operation(str, filemode_Read);
                                        size_t count = fread(buf, sizeof(char), len, str->file_pointer);
                                        str->read_count += count;
                                        return count;
@@ -759,7 +850,7 @@ glk_get_buffer_stream(strid_t str, char *buf, glui32 len)
                                int foo;
                                for(foo = 0; foo < len; foo++)
                                {
-                                       glsi32 ch = read_utf8_char_from_file(str->file_pointer);
+                                       glsi32 ch = read_utf8_char_from_file(str);
                                        if(ch == -1)
                                                break;
                                        str->read_count++;
@@ -822,6 +913,7 @@ glk_get_buffer_stream_uni(strid_t str, glui32 *buf, glui32 len)
                                {
                                        /* Read len characters of 4 bytes each */
                                        unsigned char *readbuffer = g_new0(unsigned char, 4 * len);
+                                       ensure_file_operation(str, filemode_Read);
                                        size_t count = fread(readbuffer, sizeof(unsigned char), 4 * len, str->file_pointer);
                                        /* If there was an incomplete character */
                                        if(count % 4 != 0) 
@@ -843,6 +935,7 @@ glk_get_buffer_stream_uni(strid_t str, glui32 *buf, glui32 len)
                                else /* Regular binary file */
                                {
                                        unsigned char *readbuffer = g_new0(unsigned char, len);
+                                       ensure_file_operation(str, filemode_Read);
                                        size_t count = fread(readbuffer, sizeof(unsigned char), len, str->file_pointer);
                                        int foo;
                                        for(foo = 0; foo < count; foo++)
@@ -858,7 +951,7 @@ glk_get_buffer_stream_uni(strid_t str, glui32 *buf, glui32 len)
                                int foo;
                                for(foo = 0; foo < len; foo++)
                                {
-                                       glsi32 ch = read_utf8_char_from_file(str->file_pointer);
+                                       glsi32 ch = read_utf8_char_from_file(str);
                                        if(ch == -1)
                                                break;
                                        str->read_count++;
@@ -884,7 +977,7 @@ glk_get_buffer_stream_uni(strid_t str, glui32 *buf, glui32 len)
  *   <mathphrase>@len - 1</mathphrase>
  * </inlineequation>
  * characters have been read or a newline has been read. It then puts a
- * terminal null (<code>'\0'</code>) aracter on
+ * terminal null (<code>'\0'</code>) character on
  * the end. It returns the number of characters actually read, including the
  * newline (if there is one) but not including the terminal null.
  *
@@ -946,29 +1039,30 @@ glk_get_line_stream(strid_t str, char *buf, glui32 len)
                                if(str->unicode) /* Binary file with 4-byte characters */
                                {
                                        /* Do it character-by-character */
-                                       int foo;
-                                       for(foo = 0; foo < len - 1; foo++)
+                                       int copycount;
+                                       for(copycount = 0; copycount < len - 1; copycount++)
                                        {
-                                               glsi32 ch = read_ucs4be_char_from_file(str->file_pointer);
+                                               glsi32 ch = read_ucs4be_char_from_file(str);
                                                if(ch == -1) 
                                                {
-                                                       buf[foo] = '\0';
-                                                       return foo - 1;
+                                                       buf[copycount] = '\0';
+                                                       return copycount;
                                                }
                                                str->read_count++;
-                                               if(is_unicode_newline(ch, str->file_pointer, FALSE))
+                                               if(is_unicode_newline(ch, str, FALSE))
                                                {
-                                                       buf[foo] = '\n';
-                                                       buf[foo + 1] = '\0';
-                                                       return foo;
+                                                       buf[copycount++] = '\n';
+                                                       buf[copycount] = '\0';
+                                                       return copycount;
                                                }
-                                               buf[foo] = (ch > 0xFF)? '?' : (char)ch;
+                                               buf[copycount] = (ch > 0xFF)? '?' : (char)ch;
                                        }
                                        buf[len] = '\0';
-                                       return foo;
+                                       return copycount;
                                }
                                else /* Regular binary file */
                                {
+                                       ensure_file_operation(str, filemode_Read);
                                        if( !fgets(buf, len, str->file_pointer) ) {
                                                *buf = 0;
                                                return 0;
@@ -985,14 +1079,14 @@ glk_get_line_stream(strid_t str, char *buf, glui32 len)
                                int foo;
                                for(foo = 0; foo < len - 1; foo++)
                                {
-                                       glsi32 ch = read_utf8_char_from_file(str->file_pointer);
+                                       glsi32 ch = read_utf8_char_from_file(str);
                                        if(ch == -1)
                                        {
                                                buf[foo] = '\0';
                                                return foo - 1;
                                        }
                                        str->read_count++;
-                                       if(is_unicode_newline(ch, str->file_pointer, TRUE))
+                                       if(is_unicode_newline(ch, str, TRUE))
                                        {
                                                buf[foo] = '\n';
                                                buf[foo + 1] = '\0';
@@ -1088,30 +1182,31 @@ glk_get_line_stream_uni(strid_t str, glui32 *buf, glui32 len)
                                if(str->unicode) /* Binary file with 4-byte characters */
                                {
                                        /* Do it character-by-character */
-                                       int foo;
-                                       for(foo = 0; foo < len - 1; foo++)
+                                       int copycount;
+                                       for(copycount = 0; copycount < len - 1; copycount++)
                                        {
-                                               glsi32 ch = read_ucs4be_char_from_file(str->file_pointer);
+                                               glsi32 ch = read_ucs4be_char_from_file(str);
                                                if(ch == -1) 
                                                {
-                                                       buf[foo] = 0;
-                                                       return foo - 1;
+                                                       buf[copycount] = 0;
+                                                       return copycount;
                                                }
                                                str->read_count++;
-                                               if(is_unicode_newline(ch, str->file_pointer, FALSE))
+                                               if(is_unicode_newline(ch, str, FALSE))
                                                {
-                                                       buf[foo] = ch; /* Preserve newline types??? */
-                                                       buf[foo + 1] = 0;
-                                                       return foo;
+                                                       buf[copycount++] = ch; /* Preserve newline types??? */
+                                                       buf[copycount] = 0;
+                                                       return copycount;
                                                }
-                                               buf[foo] = ch;
+                                               buf[copycount] = ch;
                                        }
                                        buf[len] = 0;
-                                       return foo;
+                                       return copycount;
                                }
                                else /* Regular binary file */
                                {
                                        gchar *readbuffer = g_new0(gchar, len);
+                                       ensure_file_operation(str, filemode_Read);
                                        if( !fgets(readbuffer, len, str->file_pointer) ) {
                                                *buf = 0;
                                                return 0;
@@ -1131,14 +1226,14 @@ glk_get_line_stream_uni(strid_t str, glui32 *buf, glui32 len)
                                int foo;
                                for(foo = 0; foo < len - 1; foo++)
                                {
-                                       glsi32 ch = read_utf8_char_from_file(str->file_pointer);
+                                       glsi32 ch = read_utf8_char_from_file(str);
                                        if(ch == -1)
                                        {
                                                buf[foo] = 0;
                                                return foo - 1;
                                        }
                                        str->read_count++;
-                                       if(is_unicode_newline(ch, str->file_pointer, TRUE))
+                                       if(is_unicode_newline(ch, str, TRUE))
                                        {
                                                buf[foo] = ch; /* Preserve newline types??? */
                                                buf[foo + 1] = 0;
@@ -1184,6 +1279,14 @@ glk_get_line_stream_uni(strid_t str, glui32 *buf, glui32 len)
  *   good for much anyhow.
  * </para></note>
  *
+ * glk_stream_get_position() on a window stream will always return zero.
+ *
+ * <note><para>
+ *   It might make more sense to return the number of characters written to the
+ *   window, but existing libraries do not support this and it's not really
+ *   worth adding the feature.
+ * </para></note>
+ *
  * Returns: position of the read/write mark in @str.
  */
 glui32
@@ -1197,6 +1300,8 @@ glk_stream_get_position(strid_t str)
                        return str->mark;
                case STREAM_TYPE_FILE:
                        return ftell(str->file_pointer);
+               case STREAM_TYPE_WINDOW:
+                       return 0;
                default:
                        ILLEGAL_PARAM("Seeking illegal on stream type: %u", str->type);
                        return 0;
@@ -1228,6 +1333,9 @@ glk_stream_get_position(strid_t str)
  *
  * Again, in Latin-1 streams, characters are bytes. In Unicode streams,
  * characters are 32-bit words, or four bytes each.
+ *
+ * A window stream doesn't have a movable mark, so calling
+ * glk_stream_set_position() has no effect.
  */
 void
 glk_stream_set_position(strid_t str, glsi32 pos, glui32 seekmode)
@@ -1243,7 +1351,7 @@ glk_stream_set_position(strid_t str, glsi32 pos, glui32 seekmode)
                        {
                                case seekmode_Start:   str->mark = pos;  break;
                                case seekmode_Current: str->mark += pos; break;
-                               case seekmode_End:     str->mark = str->buflen + pos; break;
+                               case seekmode_End:     str->mark = str->endmark + pos; break;
                                default:
                                        g_return_if_reached();
                                        return;
@@ -1263,8 +1371,11 @@ glk_stream_set_position(strid_t str, glsi32 pos, glui32 seekmode)
                        }
                        if(fseek(str->file_pointer, pos, whence) == -1)
                                WARNING("Seek failed on file stream");
+                       str->lastop = 0; /* Either reading or writing is legal after fseek() */
                        break;
                }
+               case STREAM_TYPE_WINDOW:
+                       break; /* Quietly do nothing */
                default:
                        ILLEGAL_PARAM("Seeking illegal on stream type: %u", str->type);
                        return;