X-Git-Url: https://git.stderr.nl/gitweb?p=rodin%2Fchimara.git;a=blobdiff_plain;f=libchimara%2Fchimara-glk.c;h=63849189a1788347e3427795e4e5b140599a869c;hp=d8f071d5efa6bd25b63ee4fd68188bf018b3543d;hb=7ef4ef1fecab7ae0f724e59f7de1315a96822152;hpb=0ce15daa50a3fe259576430e99f3d6324a5716c6 diff --git a/libchimara/chimara-glk.c b/libchimara/chimara-glk.c index d8f071d..6384918 100644 --- a/libchimara/chimara-glk.c +++ b/libchimara/chimara-glk.c @@ -1,5 +1,10 @@ /* licensing and copyright information here */ +#include +#include +#include +#include +#include #include #include #include @@ -11,10 +16,12 @@ #include "chimara-marshallers.h" #include "glk.h" #include "abort.h" +#include "stream.h" #include "window.h" #include "glkstart.h" #include "glkunix.h" #include "init.h" +#include "magic.h" #define CHIMARA_GLK_MIN_WIDTH 0 #define CHIMARA_GLK_MIN_HEIGHT 0 @@ -51,9 +58,7 @@ enum { PROP_0, PROP_INTERACTIVE, PROP_PROTECT, - PROP_DEFAULT_FONT_DESCRIPTION, - PROP_MONOSPACE_FONT_DESCRIPTION, - PROP_SPACING + PROP_SPACING, }; enum { @@ -81,11 +86,10 @@ chimara_glk_init(ChimaraGlk *self) priv->self = self; priv->interactive = TRUE; priv->protect = FALSE; - priv->default_font_desc = pango_font_description_from_string("Sans"); - priv->monospace_font_desc = pango_font_description_from_string("Monospace"); - priv->css_file = "style.css"; priv->default_styles = g_new0(StyleSet,1); priv->current_styles = g_new0(StyleSet,1); + priv->pager_attr_list = pango_attr_list_new(); + priv->final_message = g_strdup("[ The game has finished ]"); priv->running = FALSE; priv->program = NULL; priv->thread = NULL; @@ -95,11 +99,20 @@ chimara_glk_init(ChimaraGlk *self) priv->event_queue_not_full = g_cond_new(); priv->abort_lock = g_mutex_new(); priv->abort_signalled = FALSE; + priv->shutdown_lock = g_mutex_new(); + priv->shutdown_key_pressed = g_cond_new(); priv->arrange_lock = g_mutex_new(); priv->rearranged = g_cond_new(); priv->needs_rearrange = FALSE; priv->ignore_next_arrange_event = FALSE; - priv->interrupt_handler = NULL; + priv->char_input_queue = g_async_queue_new(); + priv->line_input_queue = g_async_queue_new(); + /* Should be g_async_queue_new_full(g_free); but only in GTK >= 2.16 */ + priv->resource_lock = g_mutex_new(); + priv->resource_loaded = g_cond_new(); + priv->resource_info_available = g_cond_new(); + priv->image_cache = NULL; + priv->interrupt_handler = NULL; priv->root_window = NULL; priv->fileref_list = NULL; priv->current_stream = NULL; @@ -107,6 +120,8 @@ chimara_glk_init(ChimaraGlk *self) priv->timer_id = 0; priv->in_startup = FALSE; priv->current_dir = NULL; + + style_init(self); } static void @@ -122,12 +137,6 @@ chimara_glk_set_property(GObject *object, guint prop_id, const GValue *value, GP case PROP_PROTECT: chimara_glk_set_protect( glk, g_value_get_boolean(value) ); break; - case PROP_DEFAULT_FONT_DESCRIPTION: - chimara_glk_set_default_font_description( glk, (PangoFontDescription *)g_value_get_pointer(value) ); - break; - case PROP_MONOSPACE_FONT_DESCRIPTION: - chimara_glk_set_monospace_font_description( glk, (PangoFontDescription *)g_value_get_pointer(value) ); - break; case PROP_SPACING: chimara_glk_set_spacing( glk, g_value_get_uint(value) ); break; @@ -149,12 +158,6 @@ chimara_glk_get_property(GObject *object, guint prop_id, GValue *value, GParamSp case PROP_PROTECT: g_value_set_boolean(value, priv->protect); break; - case PROP_DEFAULT_FONT_DESCRIPTION: - g_value_set_pointer(value, priv->default_font_desc); - break; - case PROP_MONOSPACE_FONT_DESCRIPTION: - g_value_set_pointer(value, priv->monospace_font_desc); - break; case PROP_SPACING: g_value_set_uint(value, priv->spacing); break; @@ -167,8 +170,17 @@ static void chimara_glk_finalize(GObject *object) { ChimaraGlk *self = CHIMARA_GLK(object); - ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self); - + CHIMARA_GLK_USE_PRIVATE(self, priv); + + /* Free widget properties */ + g_free(priv->final_message); + /* Free styles */ + g_hash_table_destroy(priv->default_styles->text_buffer); + g_hash_table_destroy(priv->default_styles->text_grid); + g_hash_table_destroy(priv->current_styles->text_buffer); + g_hash_table_destroy(priv->current_styles->text_grid); + pango_attr_list_unref(priv->pager_attr_list); + /* Free the event queue */ g_mutex_lock(priv->event_lock); g_queue_foreach(priv->event_queue, (GFunc)g_free, NULL); @@ -178,30 +190,38 @@ chimara_glk_finalize(GObject *object) priv->event_queue = NULL; g_mutex_unlock(priv->event_lock); g_mutex_free(priv->event_lock); - - /* Free the abort signaling mechanism */ + /* Free the abort signaling mechanism */ g_mutex_lock(priv->abort_lock); /* Make sure no other thread is busy with this */ g_mutex_unlock(priv->abort_lock); g_mutex_free(priv->abort_lock); priv->abort_lock = NULL; - + /* Free the shutdown keypress signaling mechanism */ + g_mutex_lock(priv->shutdown_lock); + g_cond_free(priv->shutdown_key_pressed); + g_mutex_unlock(priv->shutdown_lock); + priv->shutdown_lock = NULL; /* Free the window arrangement signaling */ g_mutex_lock(priv->arrange_lock); g_cond_free(priv->rearranged); g_mutex_unlock(priv->arrange_lock); g_mutex_free(priv->arrange_lock); priv->arrange_lock = NULL; + g_mutex_lock(priv->resource_lock); + g_cond_free(priv->resource_loaded); + g_cond_free(priv->resource_info_available); + g_mutex_unlock(priv->resource_lock); + g_mutex_free(priv->resource_lock); + g_slist_foreach(priv->image_cache, (GFunc)clear_image_cache, NULL); + g_slist_free(priv->image_cache); + /* Unref input queues (this should destroy them since any Glk thread has stopped by now */ + g_async_queue_unref(priv->char_input_queue); + g_async_queue_unref(priv->line_input_queue); - /* Free private data */ - pango_font_description_free(priv->default_font_desc); - pango_font_description_free(priv->monospace_font_desc); + /* Free other stuff */ g_free(priv->current_dir); - g_hash_table_destroy(priv->default_styles->text_buffer); - g_hash_table_destroy(priv->default_styles->text_grid); - g_hash_table_destroy(priv->current_styles->text_buffer); - g_hash_table_destroy(priv->current_styles->text_grid); - + + /* Chain up to parent */ G_OBJECT_CLASS(chimara_glk_parent_class)->finalize(object); } @@ -544,10 +564,6 @@ chimara_glk_stopped(ChimaraGlk *self) { CHIMARA_GLK_USE_PRIVATE(self, priv); priv->running = FALSE; - - /* Free the plugin */ - if( priv->program && !g_module_close(priv->program) ) - g_warning( "Error closing module: %s", g_module_error() ); } static void @@ -581,9 +597,16 @@ chimara_glk_text_buffer_output(ChimaraGlk *self, guint window_rock, gchar *text) /* Default signal handler */ } -/* G_PARAM_STATIC_STRINGS only appeared in GTK 2.13.0 */ +/* COMPAT: G_PARAM_STATIC_STRINGS only appeared in GTK 2.13.0 */ #ifndef G_PARAM_STATIC_STRINGS + +/* COMPAT: G_PARAM_STATIC_NAME and friends only appeared in GTK 2.8 */ +#if GTK_CHECK_VERSION(2,8,0) #define G_PARAM_STATIC_STRINGS (G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB) +#else +#define G_PARAM_STATIC_STRINGS (0) +#endif + #endif static void @@ -617,7 +640,7 @@ chimara_glk_class_init(ChimaraGlkClass *klass) * it ended normally, or was interrupted. */ chimara_glk_signals[STOPPED] = g_signal_new("stopped", - G_OBJECT_CLASS_TYPE(klass), 0, + G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST, /* FIXME: Should be G_SIGNAL_RUN_CLEANUP but that segfaults??! */ G_STRUCT_OFFSET(ChimaraGlkClass, stopped), NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0); @@ -628,7 +651,7 @@ chimara_glk_class_init(ChimaraGlkClass *klass) * Emitted when a Glk program starts executing in the widget. */ chimara_glk_signals[STARTED] = g_signal_new ("started", - G_OBJECT_CLASS_TYPE(klass), 0, + G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST, G_STRUCT_OFFSET(ChimaraGlkClass, started), NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0); /** @@ -714,36 +737,6 @@ chimara_glk_class_init(ChimaraGlkClass *klass) FALSE, G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) ); - /* We can't use G_PARAM_CONSTRUCT on these because then the constructor will - initialize them with NULL */ - /** - * ChimaraGlk:default-font-description: - * - * Pointer to a #PangoFontDescription describing the default proportional - * font, to be used in text buffer windows for example. - * - * Default value: font description created from the string - * Sans - */ - g_object_class_install_property(object_class, PROP_DEFAULT_FONT_DESCRIPTION, - g_param_spec_pointer("default-font-description", _("Default Font"), - _("Font description of the default proportional font"), - G_PARAM_READWRITE | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) ); - - /** - * ChimaraGlk:monospace-font-description: - * - * Pointer to a #PangoFontDescription describing the default monospace font, - * to be used in text grid windows and %style_Preformatted, for example. - * - * Default value: font description created from the string - * Monospace - */ - g_object_class_install_property(object_class, PROP_MONOSPACE_FONT_DESCRIPTION, - g_param_spec_pointer("monospace-font-description", _("Monospace Font"), - _("Font description of the default monospace font"), - G_PARAM_READWRITE | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) ); - /** * ChimaraGlk:spacing: * @@ -806,6 +799,7 @@ chimara_glk_set_interactive(ChimaraGlk *glk, gboolean interactive) ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk); priv->interactive = interactive; + g_object_notify(G_OBJECT(glk), "interactive"); } /** @@ -842,6 +836,7 @@ chimara_glk_set_protect(ChimaraGlk *glk, gboolean protect) ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk); priv->protect = protect; + g_object_notify(G_OBJECT(glk), "protect"); } /** @@ -863,137 +858,90 @@ chimara_glk_get_protect(ChimaraGlk *glk) } /** - * chimara_glk_set_default_font_description: + * chimara_glk_set_css_to_default: * @glk: a #ChimaraGlk widget - * @font: a #PangoFontDescription * - * Sets @glk's default proportional font. See - * #ChimaraGlk:default-font-description. + * Resets the styles for text buffer and text grid windows to their defaults. + * + * This function is not implemented yet. + * */ -void -chimara_glk_set_default_font_description(ChimaraGlk *glk, PangoFontDescription *font) +void +chimara_glk_set_css_to_default(ChimaraGlk *glk) { - g_return_if_fail(glk || CHIMARA_IS_GLK(glk)); - g_return_if_fail(font); - - ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk); - pango_font_description_free(priv->default_font_desc); - priv->default_font_desc = pango_font_description_copy(font); - - /* TODO: Apply the font description to all the windows and recalculate the sizes */ + reset_default_styles(glk); } /** - * chimara_glk_set_default_font_string: + * chimara_glk_set_css_from_file: * @glk: a #ChimaraGlk widget - * @font: string representation of a font description + * @filename: path to a CSS file, or %NULL + * @error: location to store a GError, or + * %NULL * - * Sets @glk's default proportional font according to the string @font, which - * must be a string in the form FAMILY-LIST - * [STYLE-OPTIONS] - * [SIZE], such as Charter,Utopia - * Italic 12 or Sans. See - * #ChimaraGlk:default-font-description. - */ -void -chimara_glk_set_default_font_string(ChimaraGlk *glk, const gchar *font) -{ - g_return_if_fail(glk || CHIMARA_IS_GLK(glk)); - g_return_if_fail(font || *font); - - PangoFontDescription *fontdesc = pango_font_description_from_string(font); - g_return_if_fail(fontdesc); - - ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk); - pango_font_description_free(priv->default_font_desc); - priv->default_font_desc = fontdesc; - - /* TODO: Apply the font description to all the windows and recalculate the sizes */ -} - -/** - * chimara_glk_get_default_font_description: - * @glk: a #ChimaraGlk widget - * - * Returns @glk's default proportional font. + * Sets the styles for text buffer and text grid windows according to the CSS + * file @filename. Note that the styles are set cumulatively on top of whatever + * the styles are at the time this function is called; to reset the styles to + * their defaults, use chimara_glk_set_css_to_default(). * - * Return value: a newly-allocated #PangoFontDescription which must be freed - * using pango_font_description_free(), or %NULL on error. + * Returns: %TRUE on success, %FALSE if an error occurred, in which case @error + * will be set. */ -PangoFontDescription * -chimara_glk_get_default_font_description(ChimaraGlk *glk) +gboolean +chimara_glk_set_css_from_file(ChimaraGlk *glk, const gchar *filename, GError **error) { - g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), NULL); - - ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk); - return pango_font_description_copy(priv->default_font_desc); -} + g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE); + g_return_val_if_fail(filename, FALSE); + g_return_val_if_fail(error == NULL || *error == NULL, FALSE); -/** - * chimara_glk_set_monospace_font_description: - * @glk: a #ChimaraGlk widget - * @font: a #PangoFontDescription - * - * Sets @glk's default monospace font. See - * #ChimaraGlk:monospace-font-description. - */ -void -chimara_glk_set_monospace_font_description(ChimaraGlk *glk, PangoFontDescription *font) -{ - g_return_if_fail(glk || CHIMARA_IS_GLK(glk)); - g_return_if_fail(font); - - ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk); - pango_font_description_free(priv->monospace_font_desc); - priv->monospace_font_desc = pango_font_description_copy(font); + int fd = open(filename, O_RDONLY); + if(fd == -1) { + *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno), + _("Error opening file \"%s\": %s"), filename, g_strerror(errno)); + return FALSE; + } + + GScanner *scanner = create_css_file_scanner(); + g_scanner_input_file(scanner, fd); + scanner->input_name = filename; + scan_css_file(scanner, glk); + + /* Set the current style to a copy of the default style */ + /* FIXME this is not correct */ + copy_default_styles_to_current_styles(glk); - /* TODO: Apply the font description to all the windows and recalculate the sizes */ + if(close(fd) == -1) { + *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno), + _("Error closing file \"%s\": %s"), filename, g_strerror(errno)); + return FALSE; + } + return TRUE; } /** - * chimara_glk_set_monospace_font_string: + * chimara_glk_set_css_from_string: * @glk: a #ChimaraGlk widget - * @font: string representation of a font description + * @filename: a string containing CSS code * - * Sets @glk's default monospace font according to the string @font, which must - * be a string in the form FAMILY-LIST - * [STYLE-OPTIONS] - * [SIZE], such as Courier - * Bold 12 or Monospace. See - * #ChimaraGlk:monospace-font-description. + * Sets the styles for text buffer and text grid windows according to the CSS + * code @css. Note that the styles are set cumulatively on top of whatever the + * styles are at the time this function is called; to reset the styles to their + * defaults, use chimara_glk_set_css_to_default(). */ void -chimara_glk_set_monospace_font_string(ChimaraGlk *glk, const gchar *font) +chimara_glk_set_css_from_string(ChimaraGlk *glk, const gchar *css) { g_return_if_fail(glk || CHIMARA_IS_GLK(glk)); - g_return_if_fail(font || *font); - - PangoFontDescription *fontdesc = pango_font_description_from_string(font); - g_return_if_fail(fontdesc); - - ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk); - pango_font_description_free(priv->monospace_font_desc); - priv->monospace_font_desc = fontdesc; + g_return_if_fail(css || *css); - /* TODO: Apply the font description to all the windows and recalculate the sizes */ -} - -/** - * chimara_glk_get_monospace_font_description: - * @glk: a #ChimaraGlk widget - * - * Returns @glk's default monospace font. - * - * Return value: a newly-allocated #PangoFontDescription which must be freed - * using pango_font_description_free(), or %NULL on error. - */ -PangoFontDescription * -chimara_glk_get_monospace_font_description(ChimaraGlk *glk) -{ - g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), NULL); - - ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk); - return pango_font_description_copy(priv->monospace_font_desc); + GScanner *scanner = create_css_file_scanner(); + g_scanner_input_text(scanner, css, strlen(css)); + scanner->input_name = ""; + scan_css_file(scanner, glk); + + /* Set the current style to a copy of the default style */ + /* FIXME this is not correct */ + copy_default_styles_to_current_styles(glk); } /** @@ -1011,6 +959,7 @@ chimara_glk_set_spacing(ChimaraGlk *glk, guint spacing) ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk); priv->spacing = spacing; + g_object_notify(G_OBJECT(glk), "spacing"); } /** @@ -1044,6 +993,10 @@ glk_enter(struct StartupData *startup) extern GPrivate *glk_data_key; g_private_set(glk_data_key, startup->glk_data); + /* Acquire the Glk thread's references to the input queues */ + g_async_queue_ref(startup->glk_data->char_input_queue); + g_async_queue_ref(startup->glk_data->line_input_queue); + /* Run startup function */ if(startup->glkunix_startup_code) { startup->glk_data->in_startup = TRUE; @@ -1060,11 +1013,15 @@ glk_enter(struct StartupData *startup) } /* Run main function */ + glk_main_t glk_main = startup->glk_main; + + /* COMPAT: avoid usage of slices */ + g_free(startup); g_signal_emit_by_name(startup->glk_data->self, "started"); - (startup->glk_main)(); - g_signal_emit_by_name(startup->glk_data->self, "stopped"); - g_slice_free(struct StartupData, startup); - return NULL; + glk_main(); + glk_exit(); /* Run shutdown code in glk_exit() even if glk_main() returns normally */ + g_assert_not_reached(); /* because glk_exit() calls g_thread_exit() */ + return NULL; } /** @@ -1092,12 +1049,24 @@ chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GE { g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE); g_return_val_if_fail(plugin, FALSE); + g_return_val_if_fail(error == NULL || *error == NULL, FALSE); + + if(chimara_glk_get_running(glk)) { + g_set_error(error, CHIMARA_ERROR, CHIMARA_PLUGIN_ALREADY_RUNNING, _("There was already a plugin running.")); + return FALSE; + } ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk); - struct StartupData *startup = g_slice_new0(struct StartupData); - - /* Open the module to run */ + + /* COMPAT: avoid usage of slices */ + struct StartupData *startup = g_new0(struct StartupData,1); + g_assert( g_module_supported() ); + /* If there is already a module loaded, free it first -- you see, we want to + * keep modules loaded as long as possible to avoid crashes in stack unwinding */ + if( priv->program && !g_module_close(priv->program) ) + g_warning( "Error closing module :%s", g_module_error() ); + /* Open the module to run */ priv->program = g_module_open(plugin, G_MODULE_BIND_LAZY); if(!priv->program) @@ -1147,6 +1116,7 @@ chimara_glk_stop(ChimaraGlk *glk) { g_return_if_fail(glk || CHIMARA_IS_GLK(glk)); CHIMARA_GLK_USE_PRIVATE(glk, priv); + /* Don't do anything if not running a program */ if(!priv->running) return; @@ -1157,6 +1127,10 @@ chimara_glk_stop(ChimaraGlk *glk) g_mutex_unlock(priv->abort_lock); /* Stop blocking on the event queue condition */ event_throw(glk, evtype_Abort, NULL, 0, 0); + /* Stop blocking on the shutdown key press condition */ + g_mutex_lock(priv->shutdown_lock); + g_cond_signal(priv->shutdown_key_pressed); + g_mutex_unlock(priv->shutdown_lock); } } @@ -1175,7 +1149,10 @@ chimara_glk_wait(ChimaraGlk *glk) /* Don't do anything if not running a program */ if(!priv->running) return; + /* Unlock GDK mutex, because the Glk program might need to use it for shutdown */ + gdk_threads_leave(); g_thread_join(priv->thread); + gdk_threads_enter(); } /** @@ -1194,3 +1171,47 @@ chimara_glk_get_running(ChimaraGlk *glk) CHIMARA_GLK_USE_PRIVATE(glk, priv); return priv->running; } + +/** + * chimara_glk_feed_char_input: + * @glk: a #ChimaraGlk widget + * @keyval: a key symbol as defined in gdk/gdkkeysyms.h + * + * Pretend that a key was pressed in the Glk program as a response to a + * character input request. You can call this function even when no window has + * requested character input, in which case the key will be saved for the + * following window that requests character input. This has the disadvantage + * that if more than one window has requested character input, it is arbitrary + * which one gets the key press. + */ +void +chimara_glk_feed_char_input(ChimaraGlk *glk, guint keyval) +{ + g_return_if_fail(glk || CHIMARA_IS_GLK(glk)); + CHIMARA_GLK_USE_PRIVATE(glk, priv); + g_async_queue_push(priv->char_input_queue, GUINT_TO_POINTER(keyval)); + event_throw(glk, evtype_ForcedCharInput, NULL, 0, 0); +} + +/** + * chimara_glk_feed_line_input: + * @glk: a #ChimaraGlk widget + * @text: text to pass to the next line input request + * + * Pretend that @text was typed in the Glk program as a response to a line input + * request. @text does not need to end with a newline. You can call this + * function even when no window has requested line input, in which case the text + * will be saved for the following window that requests line input. This has the + * disadvantage that if more than one window has requested character input, it + * is arbitrary which one gets the text. + */ +void +chimara_glk_feed_line_input(ChimaraGlk *glk, const gchar *text) +{ + g_return_if_fail(glk || CHIMARA_IS_GLK(glk)); + g_return_if_fail(text); + CHIMARA_GLK_USE_PRIVATE(glk, priv); + g_async_queue_push(priv->line_input_queue, g_strdup(text)); + event_throw(glk, evtype_ForcedLineInput, NULL, 0, 0); +}