X-Git-Url: https://git.stderr.nl/gitweb?a=blobdiff_plain;f=src%2Fstream.c;h=e51d1f1a9077c43cd86ad2def9854c90cb924e58;hb=47d20aad0aecf8161a3ec94bdc7da9cd42f4ae62;hp=da470ba2b48b41514a3241b7385bba849a12439e;hpb=a8f0931a13cd86f4176a3482a6dfc5353defde9d;p=rodin%2Fchimara.git diff --git a/src/stream.c b/src/stream.c index da470ba..e51d1f1 100644 --- a/src/stream.c +++ b/src/stream.c @@ -1,44 +1,42 @@ #include "stream.h" #include "fileref.h" -#include -#include +#include #include -/* Global current stream */ -static strid_t current_stream = NULL; -/* List of streams currently in existence */ -static GList *stream_list = NULL; +#include "chimara-glk-private.h" +extern ChimaraGlkPrivate *glk_data; /* Internal function: create a window stream to go with window. */ strid_t window_stream_new(winid_t window) { /* Create stream and connect it to window */ - strid_t s = g_new0(struct glk_stream_struct, 1); - s->file_mode = filemode_Write; - s->stream_type = STREAM_TYPE_WINDOW; - s->window = window; + strid_t str = g_new0(struct glk_stream_struct, 1); + str->file_mode = filemode_Write; + str->type = STREAM_TYPE_WINDOW; + str->window = window; + /* Add it to the global stream list */ - stream_list = g_list_prepend(stream_list, s); - s->stream_list = stream_list; + glk_data->stream_list = g_list_prepend(glk_data->stream_list, str); + str->stream_list = glk_data->stream_list; - return s; + return str; } /** * glk_stream_iterate: - * @str: A stream, or #NULL. - * @rockptr: Return location for the next window's rock, or #NULL. + * @str: A stream, or %NULL. + * @rockptr: Return location for the next window's rock, or %NULL. * - * Iterates over the list of streams; if @str is #NULL, it returns the first + * Iterates over the list of streams; if @str is %NULL, it returns the first * stream, otherwise the next stream after @str. If there are no more, it - * returns #NULL. The stream's rock is stored in @rockptr. If you don't want - * the rocks to be returned, you may set @rockptr to #NULL. + * returns %NULL. The stream's rock is stored in @rockptr. If you don't want + * the rocks to be returned, you may set @rockptr to %NULL. * * The order in which streams are returned is arbitrary. The order may change * every time you create or destroy a stream, invalidating the iteration. * - * Returns: the next stream, or #NULL if there are no more. + * Returns: the next stream, or %NULL if there are no more. */ strid_t glk_stream_iterate(strid_t str, glui32 *rockptr) @@ -46,7 +44,7 @@ glk_stream_iterate(strid_t str, glui32 *rockptr) GList *retnode; if(str == NULL) - retnode = stream_list; + retnode = glk_data->stream_list; else retnode = str->stream_list->next; strid_t retval = retnode? (strid_t)retnode->data : NULL; @@ -75,62 +73,68 @@ glk_stream_get_rock(strid_t str) /** * glk_stream_set_current: - * @str: An output stream, or NULL. + * @str: An output stream, or %NULL. * - * Sets the current stream to @str, or to nothing if @str is #NULL. + * Sets the current stream to @str, which must be an output stream. You may set + * the current stream to %NULL, which means the current stream is not set to + * anything. */ void glk_stream_set_current(strid_t str) { - if(str != NULL && str->file_mode != filemode_Write) + if(str != NULL && str->file_mode == filemode_Read) { - g_warning("glk_stream_set_current: " - "Cannot set current stream to non output stream"); + g_warning("%s: Cannot set current stream to non output stream", __func__); return; } - current_stream = str; + glk_data->current_stream = str; } /** * glk_stream_get_current: * - * Returns the current stream, or #NULL if there is none. + * Returns the current stream, or %NULL if there is none. * * Returns: A stream. */ strid_t glk_stream_get_current() { - return current_stream; + return glk_data->current_stream; } /** * glk_put_char: * @ch: A character in Latin-1 encoding. * - * Prints one character @ch to the current stream. + * Prints one character to the current stream. As with all basic functions, the + * character is assumed to be in the Latin-1 character encoding. */ void glk_put_char(unsigned char ch) { - /* Illegal to print to the current stream if it is NULL */ - g_return_if_fail(current_stream != NULL); - glk_put_char_stream(current_stream, ch); + g_return_if_fail(glk_data->current_stream != NULL); + glk_put_char_stream(glk_data->current_stream, ch); } /** * glk_put_string: * @s: A null-terminated string in Latin-1 encoding. * - * Prints @s to the current stream. + * Prints a null-terminated string to the current stream. It is exactly + * equivalent to: + * + * for (ptr = s; *ptr; ptr++) + * glk_put_char(*ptr); + * + * However, it may be more efficient. */ void glk_put_string(char *s) { - /* Illegal to print to the current stream if it is NULL */ - g_return_if_fail(current_stream != NULL); - glk_put_string_stream(current_stream, s); + g_return_if_fail(glk_data->current_stream != NULL); + glk_put_string_stream(glk_data->current_stream, s); } /** @@ -138,164 +142,125 @@ glk_put_string(char *s) * @buf: An array of characters in Latin-1 encoding. * @len: Length of @buf. * - * Prints @buf to the current stream. + * Prints a block of characters to the current stream. It is exactly equivalent + * to: + * + * for (i = 0; i < len; i++) + * glk_put_char(buf[i]); + * + * However, it may be more efficient. */ void glk_put_buffer(char *buf, glui32 len) { - /* Illegal to print to the current stream if it is NULL */ - g_return_if_fail(current_stream != NULL); - glk_put_buffer_stream(current_stream, buf, len); + g_return_if_fail(glk_data->current_stream != NULL); + glk_put_buffer_stream(glk_data->current_stream, buf, len); } /** - * glk_put_char_stream: - * @str: An output stream. - * @ch: A character in Latin-1 encoding. + * glk_stream_open_memory: + * @buf: An allocated buffer, or %NULL. + * @buflen: Length of @buf. + * @fmode: Mode in which the buffer will be opened. Must be one of + * #filemode_Read, #filemode_Write, or #filemode_ReadWrite. + * @rock: The new stream's rock value. + * + * Opens a stream which reads from or writes to a space in memory. @buf points + * to the buffer where output will be read from or written to. @buflen is the + * length of the buffer. + * + * When outputting, if more than @buflen characters are written to the stream, + * all of them beyond the buffer length will be thrown away, so as not to + * overwrite the buffer. (The character count of the stream will still be + * maintained correctly. That is, it will count the number of characters written + * into the stream, not the number that fit into the buffer.) + * + * If @buf is %NULL, or for that matter if @buflen is zero, then + * everything written to the stream is thrown away. This may be + * useful if you are interested in the character count. * - * Prints one character @ch to the stream @str. It is illegal for @str to be - * #NULL, or an input-only stream. + * When inputting, if more than @buflen characters are read from the stream, the + * stream will start returning -1 (signalling end-of-file.) If @buf is %NULL, + * the stream will always return end-of-file. + * + * The data is written to the buffer exactly as it was passed to the printing + * functions (glk_put_char(), etc.); input functions will read the data exactly + * as it exists in memory. No platform-dependent cookery will be done on it. + * (You can write a disk file in text mode, but a memory stream is effectively + * always in binary mode.) + * + * Unicode values (characters greater than 255) cannot be written to the buffer. + * If you try, they will be stored as 0x3F ("?") characters. + * + * Whether reading or writing, the contents of the buffer are undefined until + * the stream is closed. The library may store the data there as it is written, + * or deposit it all in a lump when the stream is closed. It is illegal to + * change the contents of the buffer while the stream is open. */ -void -glk_put_char_stream(strid_t str, unsigned char ch) -{ - g_return_if_fail(str != NULL); - g_return_if_fail(str->file_mode != filemode_Read); - - /* Convert ch to a null-terminated string, call glk_put_string_stream() */ - gchar *s = g_strndup((gchar *)&ch, 1); - glk_put_string_stream(str, s); - g_free(s); -} - -/* Internal function: change illegal (control) characters in a string to a -placeholder character. Must free returned string afterwards. */ -static gchar * -remove_latin1_control_characters(gchar *s) -{ - gchar *retval = g_strdup(s); - unsigned char *ptr; - for(ptr = (unsigned char *)retval; *ptr != '\0'; ptr++) - if( (*ptr < 32 && *ptr != 10) || (*ptr >= 127 && *ptr <= 159) ) - *ptr = '?'; - /* Our placeholder character is '?'; other options are possible, - like printing "0x7F" or something */ - return retval; -} - -/* Internal function: convert a Latin-1 string to a UTF-8 string, replacing -Latin-1 control characters by a placeholder first. The UTF-8 string must be -freed afterwards. Returns NULL on error. */ -static gchar * -convert_latin1_to_utf8(gchar *s) +strid_t +glk_stream_open_memory(char *buf, glui32 buflen, glui32 fmode, glui32 rock) { - GError *error = NULL; - gchar *utf8; - gchar *canonical = remove_latin1_control_characters(s); - utf8 = g_convert(canonical, -1, "UTF-8", "ISO-8859-1", NULL, NULL, &error); - g_free(canonical); - - if(utf8 == NULL) - { - error_dialog(NULL, error, "Error during latin1->utf8 conversion: "); - return NULL; - } + g_return_val_if_fail(fmode != filemode_WriteAppend, NULL); - return utf8; -} + strid_t str = g_new0(struct glk_stream_struct, 1); + str->rock = rock; + str->file_mode = fmode; + str->type = STREAM_TYPE_MEMORY; + str->buffer = buf; + str->mark = 0; + str->buflen = buflen; + str->unicode = FALSE; -/* Internal function: write a UTF-8 string to a window's text buffer. */ -static void -write_utf8_to_window(winid_t win, gchar *s) -{ - GtkTextBuffer *buffer = - gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) ); + /* Add it to the global stream list */ + glk_data->stream_list = g_list_prepend(glk_data->stream_list, str); + str->stream_list = glk_data->stream_list; - GtkTextIter iter; - gtk_text_buffer_get_end_iter(buffer, &iter); - gtk_text_buffer_insert(buffer, &iter, s, -1); + return str; } /** - * glk_put_string_stream: - * @str: An output stream. - * @s: A null-terminated string in Latin-1 encoding. + * glk_stream_open_memory_uni: + * @buf: An allocated buffer, or %NULL. + * @buflen: Length of @buf. + * @fmode: Mode in which the buffer will be opened. Must be one of + * #filemode_Read, #filemode_Write, or #filemode_ReadWrite. + * @rock: The new stream's rock value. * - * Prints @s to the stream @str. It is illegal for @str to be #NULL, or an - * input-only stream. + * Works just like glk_stream_open_memory(), except that the buffer is an array + * of 32-bit words, instead of bytes. This allows you to write and read any + * Unicode character. The @buflen is the number of words, not the number of + * bytes. */ -void -glk_put_string_stream(strid_t str, char *s) +strid_t +glk_stream_open_memory_uni(glui32 *buf, glui32 buflen, glui32 fmode, glui32 rock) { - g_return_if_fail(str != NULL); - g_return_if_fail(str->file_mode != filemode_Read); + g_return_val_if_fail(fmode != filemode_WriteAppend, NULL); + + strid_t str = g_new0(struct glk_stream_struct, 1); + str->rock = rock; + str->file_mode = fmode; + str->type = STREAM_TYPE_MEMORY; + str->ubuffer = buf; + str->mark = 0; + str->buflen = buflen; + str->unicode = TRUE; - switch(str->stream_type) - { - case STREAM_TYPE_WINDOW: - /* Each window type has a different way of printing to it */ - switch(str->window->window_type) - { - /* Printing to a these windows' streams does nothing */ - case wintype_Blank: - case wintype_Pair: - case wintype_Graphics: - current_stream->write_count += strlen(s); - break; - /* Text buffer window */ - case wintype_TextBuffer: - { - gchar *utf8 = convert_latin1_to_utf8(s); - write_utf8_to_window(str->window, utf8); - g_free(utf8); - } - str->write_count += strlen(s); - break; - default: - g_warning("glk_put_string: " - "Writing to this kind of window unsupported."); - } - - /* Now write the same buffer to the window's echo stream */ - if(str->window->echo_stream != NULL) - glk_put_string_stream(str->window->echo_stream, s); - - break; - default: - g_warning("glk_put_string: " - "Writing to this kind of stream unsupported."); - } -} + /* Add it to the global stream list */ + glk_data->stream_list = g_list_prepend(glk_data->stream_list, str); + str->stream_list = glk_data->stream_list; -/** - * glk_put_buffer_stream: - * @str: An output stream. - * @buf: An array of characters in Latin-1 encoding. - * @len: Length of @buf. - * - * Prints @buf to the stream @str. It is illegal for @str to be #NULL, or an - * input-only stream. - */ -void -glk_put_buffer_stream(strid_t str, char *buf, glui32 len) -{ - g_return_if_fail(str != NULL); - g_return_if_fail(str->file_mode != filemode_Read); - - /* Convert buf to a null-terminated string, call glk_put_string_stream() */ - gchar *s = g_strndup(buf, len); - glk_put_string_stream(str, s); - g_free(s); + return str; } /* Internal function: create a stream using the given parameters. */ static strid_t -stream_new(frefid_t fileref, glui32 fmode, glui32 rock, gboolean unicode) +file_stream_new(frefid_t fileref, glui32 fmode, glui32 rock, gboolean unicode) { g_return_val_if_fail(fileref != NULL, NULL); gchar *modestr; - gboolean binary = fileref->usage & fileusage_BinaryMode; + /* Binary mode is 0x000, text mode 0x100 */ + gboolean binary = !(fileref->usage & fileusage_TextMode); switch(fmode) { case filemode_Read: @@ -313,7 +278,11 @@ stream_new(frefid_t fileref, glui32 fmode, glui32 rock, gboolean unicode) modestr = g_strdup(binary? "ab" : "a"); break; case filemode_ReadWrite: - modestr = g_strdup(binary? "r+b" : "r+"); + 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+"); + } break; default: g_warning("glk_stream_open_file: Invalid file mode"); @@ -330,27 +299,37 @@ stream_new(frefid_t fileref, glui32 fmode, glui32 rock, gboolean unicode) /* 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) { + gdk_threads_enter(); + GtkWidget *dialog = gtk_message_dialog_new(NULL, 0, GTK_MESSAGE_QUESTION, GTK_BUTTONS_YES_NO, "File %s already exists. Overwrite?", fileref->filename); gint response = gtk_dialog_run(GTK_DIALOG(dialog)); gtk_widget_destroy(dialog); + + gdk_threads_leave(); + if(response != GTK_RESPONSE_YES) { fclose(fp); return NULL; } } - strid_t s = g_new0(struct glk_stream_struct, 1); - s->file_mode = fmode; - s->stream_type = unicode? STREAM_TYPE_UNICODE_FILE : STREAM_TYPE_FILE; - s->file_pointer = fp; - s->binary = binary; + strid_t str = g_new0(struct glk_stream_struct, 1); + str->rock = rock; + str->file_mode = fmode; + str->type = STREAM_TYPE_FILE; + str->file_pointer = fp; + str->binary = binary; + str->unicode = unicode; + str->filename = g_filename_to_utf8(fileref->filename, -1, NULL, NULL, NULL); + if(str->filename == NULL) + str->filename = g_strdup("Unknown file name"); /* fail silently */ /* Add it to the global stream list */ - stream_list = g_list_prepend(stream_list, s); - s->stream_list = stream_list; + glk_data->stream_list = g_list_prepend(glk_data->stream_list, str); + str->stream_list = glk_data->stream_list; - return s; + return str; } /** @@ -380,7 +359,7 @@ stream_new(frefid_t fileref, glui32 fmode, glui32 rock, gboolean unicode) strid_t glk_stream_open_file(frefid_t fileref, glui32 fmode, glui32 rock) { - return stream_new(fileref, fmode, rock, FALSE); + return file_stream_new(fileref, fmode, rock, FALSE); } /** @@ -401,6 +380,78 @@ glk_stream_open_file(frefid_t fileref, glui32 fmode, glui32 rock) strid_t glk_stream_open_file_uni(frefid_t fileref, glui32 fmode, glui32 rock) { - return stream_new(fileref, fmode, rock, TRUE); + return file_stream_new(fileref, fmode, rock, TRUE); } +/** + * glk_stream_close: + * @str: Stream to close. + * @result: Pointer to a #stream_result_t, or %NULL. + * + * Closes the stream @str. The @result argument points to a structure which is + * filled in with the final character counts of the stream. If you do not care + * about these, you may pass %NULL as the @result argument. + * + * If @str is the current output stream, the current output stream is set to + * %NULL. + * + * You cannot close window streams; use glk_window_close() instead. + */ +void +glk_stream_close(strid_t str, stream_result_t *result) +{ + g_return_if_fail(str != NULL); + + /* Free resources associated with one specific type of stream */ + switch(str->type) + { + case STREAM_TYPE_WINDOW: + g_warning("%s: Attempted to close a window stream. Use glk_window_" + "close() instead.", __func__); + return; + + case STREAM_TYPE_MEMORY: + /* Do nothing */ + break; + + case STREAM_TYPE_FILE: + if(fclose(str->file_pointer) != 0) + g_warning("%s: Failed to close file '%s'.", __func__, + str->filename); + g_free(str->filename); + break; + default: + g_warning("%s: Closing this type of stream not supported.", + __func__); + return; + } + + stream_close_common(str, result); +} + +/* Internal function: Stuff to do upon closing any type of stream. */ +void +stream_close_common(strid_t str, stream_result_t *result) +{ + /* Remove the stream from the global stream list */ + glk_data->stream_list = g_list_delete_link(glk_data->stream_list, str->stream_list); + + /* If it was the current output stream, set that to NULL */ + if(glk_data->current_stream == str) + glk_data->current_stream = NULL; + + /* If it was one or more windows' echo streams, set those to NULL */ + winid_t win; + for(win = glk_window_iterate(NULL, NULL); win; + win = glk_window_iterate(win, NULL)) + if(win->echo_stream == str) + win->echo_stream = NULL; + + /* Return the character counts */ + if(result) + { + result->readcount = str->read_count; + result->writecount = str->write_count; + } + g_free(str); +}