X-Git-Url: https://git.stderr.nl/gitweb?a=blobdiff_plain;f=libchimara%2Fchimara-glk.c;h=4af716b40e70883d5f458fc7874a3c812035304c;hb=cc7434f897ab31bb797b519404100aae1da4fd81;hp=e0b60592b2e842ff988e35f53c5cb4fd8c70e184;hpb=2ce0ccd78003fce557bb76883c87ca2cb101608d;p=rodin%2Fchimara.git diff --git a/libchimara/chimara-glk.c b/libchimara/chimara-glk.c index e0b6059..4af716b 100644 --- a/libchimara/chimara-glk.c +++ b/libchimara/chimara-glk.c @@ -8,12 +8,15 @@ #include #include "chimara-glk.h" #include "chimara-glk-private.h" +#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 @@ -24,7 +27,7 @@ * @stability: Unstable * @include: chimara/chimara-glk.h * - * The ChimaraGlk widget opens and runs a Glk program. The program must be + * The #ChimaraGlk widget opens and runs a Glk program. The program must be * compiled as a plugin module, with a function glk_main() * that the Glk library can hook into. * @@ -52,12 +55,16 @@ enum { PROP_PROTECT, PROP_DEFAULT_FONT_DESCRIPTION, PROP_MONOSPACE_FONT_DESCRIPTION, - PROP_SPACING + PROP_SPACING, }; enum { STOPPED, STARTED, + WAITING, + CHAR_INPUT, + LINE_INPUT, + TEXT_BUFFER_OUTPUT, LAST_SIGNAL }; @@ -76,23 +83,36 @@ 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->default_font_desc = pango_font_description_from_string("Serif"); priv->monospace_font_desc = pango_font_description_from_string("Monospace"); priv->css_file = "style.css"; - priv->default_styles = g_hash_table_new(g_str_hash, g_str_equal); + priv->default_styles = g_new0(StyleSet,1); + priv->current_styles = g_new0(StyleSet,1); + priv->style_initialized = FALSE; + priv->final_message = g_strdup("[ The game has finished ]"); + priv->running = FALSE; priv->program = NULL; priv->thread = NULL; - priv->event_queue = NULL; - priv->event_lock = NULL; - priv->event_queue_not_empty = NULL; - priv->event_queue_not_full = NULL; - priv->abort_lock = NULL; + priv->event_queue = g_queue_new(); + priv->event_lock = g_mutex_new(); + priv->event_queue_not_empty = g_cond_new(); + priv->event_queue_not_full = g_cond_new(); + priv->abort_lock = g_mutex_new(); priv->abort_signalled = FALSE; - priv->arrange_lock = NULL; - priv->rearranged = NULL; + 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; @@ -160,8 +180,19 @@ 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 */ + pango_font_description_free(priv->default_font_desc); + pango_font_description_free(priv->monospace_font_desc); + 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); + priv->style_initialized = FALSE; + /* Free the event queue */ g_mutex_lock(priv->event_lock); g_queue_foreach(priv->event_queue, (GFunc)g_free, NULL); @@ -171,27 +202,39 @@ chimara_glk_finalize(GObject *object) priv->event_queue = NULL; g_mutex_unlock(priv->event_lock); g_mutex_free(priv->event_lock); - - /* Free the abort signalling 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 window arrangement signalling */ + /* 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); - g_free(priv->current_dir); - g_hash_table_destroy(priv->default_styles); - + /* Free other stuff */ + if(priv->current_dir) + g_free(priv->current_dir); + + /* Chain up to parent */ G_OBJECT_CLASS(chimara_glk_parent_class)->finalize(object); } @@ -532,17 +575,44 @@ chimara_glk_forall(GtkContainer *container, gboolean include_internals, GtkCallb static void chimara_glk_stopped(ChimaraGlk *self) { - ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(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() ); + priv->program = NULL; } static void chimara_glk_started(ChimaraGlk *self) { - /* TODO: Add default signal handler implementation here */ + CHIMARA_GLK_USE_PRIVATE(self, priv); + priv->running = TRUE; +} + +static void +chimara_glk_waiting(ChimaraGlk *self) +{ + /* Default signal handler */ +} + +static void +chimara_glk_char_input(ChimaraGlk *self, guint window_rock, guint keysym) +{ + /* Default signal handler */ +} + +static void +chimara_glk_line_input(ChimaraGlk *self, guint window_rock, gchar *text) +{ + /* Default signal handler */ +} + +static void +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 */ @@ -569,28 +639,85 @@ chimara_glk_class_init(ChimaraGlkClass *klass) /* Signals */ klass->stopped = chimara_glk_stopped; klass->started = chimara_glk_started; + klass->waiting = chimara_glk_waiting; + klass->char_input = chimara_glk_char_input; + klass->line_input = chimara_glk_line_input; + klass->text_buffer_output = chimara_glk_text_buffer_output; /** * ChimaraGlk::stopped: * @glk: The widget that received the signal * - * The ::stopped signal is emitted when the a Glk program finishes - * executing in the widget, whether it ended normally, or was interrupted. + * Emitted when the a Glk program finishes executing in the widget, whether + * 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); /** * ChimaraGlk::started: * @glk: The widget that received the signal * - * The ::started signal is emitted when a Glk program starts executing in - * the widget. + * 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); + /** + * ChimaraGlk::waiting: + * @glk: The widget that received the signal + * + * Emitted when glk_select() is called by the Glk program and the event + * queue is empty, which means that the widget is waiting for input. + */ + chimara_glk_signals[WAITING] = g_signal_new("waiting", + G_OBJECT_CLASS_TYPE(klass), 0, + G_STRUCT_OFFSET(ChimaraGlkClass, waiting), NULL, NULL, + g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0); + /** + * ChimaraGlk::char-input: + * @glk: The widget that received the signal + * @window_rock: The rock value of the window that received character input + * (see Rocks) + * @keysym: The key that was typed, in the form of a key symbol from + * gdk/gdkkeysyms.h + * + * Emitted when a Glk window receives character input. + */ + chimara_glk_signals[CHAR_INPUT] = g_signal_new("char-input", + G_OBJECT_CLASS_TYPE(klass), 0, + G_STRUCT_OFFSET(ChimaraGlkClass, char_input), NULL, NULL, + chimara_marshal_VOID__UINT_UINT, + G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_UINT); + /** + * ChimaraGlk::line-input: + * @glk: The widget that received the signal + * @window_rock: The rock value of the window that received line input (see + * Rocks) + * @text: The text that was typed + * + * Emitted when a Glk window receives line input. + */ + chimara_glk_signals[LINE_INPUT] = g_signal_new("line-input", + G_OBJECT_CLASS_TYPE(klass), 0, + G_STRUCT_OFFSET(ChimaraGlkClass, line_input), NULL, NULL, + chimara_marshal_VOID__UINT_STRING, + G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING); + /** + * ChimaraGlk::text-buffer-output: + * @glk: The widget that received the signal + * @window_rock: The rock value of the window that was printed to (see Rocks) + * + * Emitted when text is printed to a text buffer window. + */ + chimara_glk_signals[TEXT_BUFFER_OUTPUT] = g_signal_new("text-buffer-output", + G_OBJECT_CLASS_TYPE(klass), 0, + G_STRUCT_OFFSET(ChimaraGlkClass, text_buffer_output), NULL, NULL, + chimara_marshal_VOID__UINT_STRING, + G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING); /* Properties */ /** @@ -668,6 +795,21 @@ chimara_glk_class_init(ChimaraGlkClass *klass) /* PUBLIC FUNCTIONS */ +/** + * chimara_error_quark: + * + * The error domain for errors from Chimara widgets. + * + * Returns: The string chimara-error-quark as a GQuark. + */ +GQuark +chimara_error_quark(void) +{ + chimara_init(); /* This is a library entry point */ + return g_quark_from_static_string("chimara-error-quark"); +} + /** * chimara_glk_new: * @@ -681,18 +823,7 @@ chimara_glk_new(void) /* This is a library entry point; initialize the library */ chimara_init(); - ChimaraGlk *self = CHIMARA_GLK(g_object_new(CHIMARA_TYPE_GLK, NULL)); - ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self); - - priv->event_queue = g_queue_new(); - priv->event_lock = g_mutex_new(); - priv->event_queue_not_empty = g_cond_new(); - priv->event_queue_not_full = g_cond_new(); - priv->abort_lock = g_mutex_new(); - priv->arrange_lock = g_mutex_new(); - priv->rearranged = g_cond_new(); - - return GTK_WIDGET(self); + return GTK_WIDGET(g_object_new(CHIMARA_TYPE_GLK, NULL)); } /** @@ -709,6 +840,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"); } /** @@ -745,6 +877,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"); } /** @@ -782,7 +915,7 @@ chimara_glk_set_default_font_description(ChimaraGlk *glk, PangoFontDescription * ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk); pango_font_description_free(priv->default_font_desc); priv->default_font_desc = pango_font_description_copy(font); - + g_object_notify(G_OBJECT(glk), "default-font-description"); /* TODO: Apply the font description to all the windows and recalculate the sizes */ } @@ -810,6 +943,7 @@ chimara_glk_set_default_font_string(ChimaraGlk *glk, const gchar *font) ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk); pango_font_description_free(priv->default_font_desc); priv->default_font_desc = fontdesc; + g_object_notify(G_OBJECT(glk), "default-font-description"); /* TODO: Apply the font description to all the windows and recalculate the sizes */ } @@ -849,6 +983,7 @@ chimara_glk_set_monospace_font_description(ChimaraGlk *glk, PangoFontDescription ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk); pango_font_description_free(priv->monospace_font_desc); priv->monospace_font_desc = pango_font_description_copy(font); + g_object_notify(G_OBJECT(glk), "monospace-font-description"); /* TODO: Apply the font description to all the windows and recalculate the sizes */ } @@ -877,6 +1012,7 @@ chimara_glk_set_monospace_font_string(ChimaraGlk *glk, const gchar *font) ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk); pango_font_description_free(priv->monospace_font_desc); priv->monospace_font_desc = fontdesc; + g_object_notify(G_OBJECT(glk), "monospace-font-description"); /* TODO: Apply the font description to all the windows and recalculate the sizes */ } @@ -914,6 +1050,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"); } /** @@ -947,6 +1084,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; @@ -963,11 +1104,13 @@ glk_enter(struct StartupData *startup) } /* Run main function */ - g_signal_emit_by_name(startup->glk_data->self, "started"); - (startup->glk_main)(); - g_signal_emit_by_name(startup->glk_data->self, "stopped"); + glk_main_t glk_main = startup->glk_main; g_slice_free(struct StartupData, startup); - return NULL; + g_signal_emit_by_name(startup->glk_data->self, "started"); + 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; } /** @@ -991,26 +1134,30 @@ glk_enter(struct StartupData *startup) * Return value: %TRUE if the Glk program was started successfully. */ gboolean -chimara_glk_run(ChimaraGlk *glk, gchar *plugin, int argc, char *argv[], GError **error) +chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GError **error) { g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE); g_return_val_if_fail(plugin, 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 */ g_assert( g_module_supported() ); priv->program = g_module_open(plugin, G_MODULE_BIND_LAZY); if(!priv->program) { - g_warning( "Error opening module: %s", g_module_error() ); + g_set_error(error, CHIMARA_ERROR, CHIMARA_LOAD_MODULE_ERROR, _("Error opening module: %s"), g_module_error()); return FALSE; } if( !g_module_symbol(priv->program, "glk_main", (gpointer *) &startup->glk_main) ) { - g_warning( "Error finding glk_main(): %s", g_module_error() ); + g_set_error(error, CHIMARA_ERROR, CHIMARA_NO_GLK_MAIN, _("Error finding glk_main(): %s"), g_module_error()); return FALSE; } @@ -1049,14 +1196,22 @@ void chimara_glk_stop(ChimaraGlk *glk) { g_return_if_fail(glk || CHIMARA_IS_GLK(glk)); - /* TODO: check if glk is actually running a program */ - ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk); + CHIMARA_GLK_USE_PRIVATE(glk, priv); + + /* Don't do anything if not running a program */ + if(!priv->running) + return; + if(priv->abort_lock) { g_mutex_lock(priv->abort_lock); priv->abort_signalled = TRUE; 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); } } @@ -1071,7 +1226,73 @@ void chimara_glk_wait(ChimaraGlk *glk) { g_return_if_fail(glk || CHIMARA_IS_GLK(glk)); - - ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk); + CHIMARA_GLK_USE_PRIVATE(glk, priv); + /* 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(); +} + +/** + * chimara_glk_get_running: + * @glk: a #ChimaraGlk widget + * + * Use this function to tell whether a program is currently running in the + * widget. + * + * Returns: %TRUE if @glk is executing a Glk program, %FALSE otherwise. + */ +gboolean +chimara_glk_get_running(ChimaraGlk *glk) +{ + g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE); + 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); }