str->file_mode = fmode;
str->type = STREAM_TYPE_MEMORY;
str->mark = 0;
+ str->endmark = 0;
str->unicode = FALSE;
if(buf && buflen)
str->file_mode = fmode;
str->type = STREAM_TYPE_MEMORY;
str->mark = 0;
+ str->endmark = 0;
str->unicode = TRUE;
if(buf && buflen)
{
VALID_FILEREF(fileref, return NULL);
- gchar *modestr;
+ const gchar *modestr;
/* Binary mode is 0x000, text mode 0x100 */
gboolean binary = !(fileref->usage & fileusage_TextMode);
switch(fmode)
ILLEGAL_PARAM("Tried to open a nonexistent file, '%s', in read mode", fileref->filename);
return NULL;
}
- modestr = g_strdup(binary? "rb" : "r");
+ modestr = binary? "rb" : "r";
break;
case filemode_Write:
- modestr = g_strdup(binary? "wb" : "w");
+ modestr = binary? "wb" : "w";
break;
case filemode_WriteAppend:
- modestr = g_strdup(binary? "ab" : "a");
- break;
case filemode_ReadWrite:
- if( g_file_test(fileref->filename, G_FILE_TEST_EXISTS) ) {
- modestr = g_strdup(binary? "r+b" : "r+");
- } else {
- modestr = g_strdup(binary? "w+b" : "w+");
+ {
+ /* We have to open the file first and then close it, in order to
+ both make sure it exists and be able to seek in it later */
+ FILE *fp = g_fopen(fileref->filename, binary? "ab" : "a");
+ if(fclose(fp) != 0) {
+ IO_WARNING( "Error opening file", fileref->filename, g_strerror(errno) );
+ return NULL;
}
+ modestr = binary? "r+b" : "r+";
+ }
break;
default:
ILLEGAL_PARAM("Invalid file mode: %u", fmode);
}
FILE *fp = g_fopen(fileref->filename, modestr);
- g_free(modestr);
if(fp == NULL) {
IO_WARNING( "Error opening file", fileref->filename, g_strerror(errno) );
return NULL;
}
+ /* Fast-forward to the end if we are appending */
+ if(fmode == filemode_WriteAppend && fseek(fp, 0, SEEK_END) != 0) {
+ IO_WARNING("Error fast-forwarding file to end", fileref->filename, g_strerror(errno));
+ return NULL;
+ }
+
/* If they opened a file in write mode but didn't specifically get
permission to do so, complain if the file already exists */
if(fileref->orig_filemode == filemode_Read && fmode != filemode_Read) {
#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 ********************************************
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;
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);
}
}
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);
}
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;
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);
}
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);
}
/* 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 |
/* 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;
(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;
{
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++;
}
else /* Regular file */
{
+ ensure_file_operation(str, filemode_Read);
int ch = fgetc(str->file_pointer);
if(ch == EOF)
return -1;
}
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;
{
/* 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)
}
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;
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++;
{
/* 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)
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++)
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++;
* <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.
*
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;
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';
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;
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;
{
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;
}
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:
--- /dev/null
+/* Test for file I/O bug */
+
+#include <libchimara/glk.h>
+#include <glib.h>
+#include <string.h>
+
+#define MAGIC_STRING "Zapp\xF6licious.\n"
+#define BUFLEN 80
+
+static void
+delete_if_exists(frefid_t ref)
+{
+ if(glk_fileref_does_file_exist(ref) == 1) {
+ g_print("(Deleting existing file) ");
+ glk_fileref_delete_file(ref);
+ }
+}
+
+void
+glk_main(void)
+{
+ char buffer[BUFLEN + 1];
+
+ g_print("Test getline... ");
+
+ /* Open a temporary file */
+ frefid_t ref = glk_fileref_create_temp(fileusage_Data | fileusage_BinaryMode, 0);
+ strid_t file = glk_stream_open_file_uni(ref, filemode_Write, 0);
+
+ /* Write the string to the file */
+ glk_put_string_stream(file, MAGIC_STRING);
+
+ /* Close and check result counts */
+ stream_result_t counts;
+ glk_stream_close(file, &counts);
+ g_assert_cmpint(counts.readcount, ==, 0);
+ g_assert_cmpint(counts.writecount, ==, 14);
+
+ file = glk_stream_open_file_uni(ref, filemode_Read, 0);
+ glui32 readcount = glk_get_line_stream(file, buffer, BUFLEN);
+ g_print("(String: %s) ", buffer);
+ g_assert_cmpint(readcount, ==, strlen(buffer));
+
+ g_print("PASS\n");
+
+ glk_stream_close(file, &counts);
+ glk_fileref_destroy(ref);
+
+ /* testfile7 - append, seek, write, close, read. */
+ g_print("Test append-seek-write-close-read... ");
+
+ ref = glk_fileref_create_by_name(fileusage_Data | fileusage_BinaryMode, "testfile7", 0);
+ delete_if_exists(ref);
+ strid_t str = glk_stream_open_file(ref, filemode_WriteAppend, 0);
+ glk_put_string_stream(str, "Purple monkey chef.\n");
+ glk_stream_set_position(str, 14, seekmode_Start);
+ g_assert_cmpuint(glk_stream_get_position(str), ==, 14);
+ glk_put_string_stream(str, "dishwasher.\n");
+ glk_stream_close(str, &counts);
+ g_assert_cmpuint(counts.readcount, ==, 0);
+ g_assert_cmpuint(counts.writecount, ==, 32);
+
+ str = glk_stream_open_file(ref, filemode_Read, 0);
+ readcount = glk_get_buffer_stream(str, buffer, BUFLEN);
+ buffer[readcount] = '\0';
+ g_assert_cmpstr(buffer, ==, "Purple monkey dishwasher.\n");
+
+ glk_stream_close(str, &counts);
+ g_assert_cmpuint(counts.readcount, ==, 26);
+ g_assert_cmpuint(counts.writecount, ==, 0);
+
+ g_print("PASS\n");
+
+ /* testfile10 - Write, close, read, write, close, read. */
+ g_print("Test write-close-read-write-close-read... ");
+
+ ref = glk_fileref_create_by_name(fileusage_Data | fileusage_BinaryMode, "testfile10", 0);
+ delete_if_exists(ref);
+ str = glk_stream_open_file(ref, filemode_ReadWrite, 0);
+ glk_put_string_stream(str, "Purple synchroscopes.\n");
+ glk_stream_close(str, &counts);
+ g_assert_cmpuint(counts.readcount, ==, 0);
+ g_assert_cmpuint(counts.writecount, ==, 22);
+
+ str = glk_stream_open_file(ref, filemode_ReadWrite, 0);
+ readcount = glk_get_buffer_stream(str, buffer, 7);
+ buffer[readcount] = '\0';
+ g_assert_cmpstr(buffer, ==, "Purple ");
+ g_assert_cmpuint(glk_stream_get_position(str), ==, 7);
+ glk_put_string_stream(str, "monkey dishwasher.\n");
+ glk_stream_set_position(str, 0, seekmode_Start);
+ g_assert_cmpuint(glk_stream_get_position(str), ==, 0);
+ readcount = glk_get_buffer_stream(str, buffer, BUFLEN);
+ buffer[readcount] = '\0';
+ g_assert_cmpstr(buffer, ==, "Purple monkey dishwasher.\n");
+ glk_stream_close(str, &counts);
+ g_assert_cmpuint(counts.readcount, ==, 33);
+ g_assert_cmpuint(counts.writecount, ==, 19);
+
+ g_print("PASS\n");
+}