X-Git-Url: https://git.stderr.nl/gitweb?a=blobdiff_plain;f=libchimara%2Fchimara-glk.c;h=6bd6a2ffb5cd3e5c2038c71b6d0d3f698750e6ac;hb=2fe03fa2bb6ccf5450e644dcbd08c51d971aab66;hp=a200b6ba46ad8f8189a71efb8f8ac1032b5ccb28;hpb=3ce5b9f501ea360ab84ee35f4ef0b1f1066dee9d;p=projects%2Fchimara%2Fchimara.git

diff --git a/libchimara/chimara-glk.c b/libchimara/chimara-glk.c
index a200b6b..6bd6a2f 100644
--- a/libchimara/chimara-glk.c
+++ b/libchimara/chimara-glk.c
@@ -127,7 +127,8 @@ enum {
 	PROP_SPACING,
 	PROP_PROGRAM_NAME,
 	PROP_PROGRAM_INFO,
-	PROP_STORY_NAME
+	PROP_STORY_NAME,
+	PROP_RUNNING
 };
 
 enum {
@@ -149,7 +150,9 @@ G_DEFINE_TYPE(ChimaraGlk, chimara_glk, GTK_TYPE_CONTAINER);
 static void
 chimara_glk_init(ChimaraGlk *self)
 {
-    GTK_WIDGET_SET_FLAGS(GTK_WIDGET(self), GTK_NO_WINDOW);
+	chimara_init(); /* This is a library entry point */
+
+    gtk_widget_set_has_window(GTK_WIDGET(self), FALSE);
 
     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
     
@@ -246,6 +249,9 @@ chimara_glk_get_property(GObject *object, guint prop_id, GValue *value, GParamSp
 		case PROP_STORY_NAME:
 			g_value_set_string(value, priv->story_name);
 			break;
+		case PROP_RUNNING:
+			g_value_set_boolean(value, priv->running);
+			break;
 		default:
             G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
     }
@@ -302,6 +308,9 @@ chimara_glk_finalize(GObject *object)
 	/* 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);
+	/* Destroy callback data if ownership retained */
+	if(priv->resource_load_callback_destroy_data)
+		priv->resource_load_callback_destroy_data(priv->resource_load_callback_data);
 	
 	/* Free other stuff */
 	g_free(priv->current_dir);
@@ -315,92 +324,35 @@ chimara_glk_finalize(GObject *object)
     G_OBJECT_CLASS(chimara_glk_parent_class)->finalize(object);
 }
 
-/* Internal function: Recursively get the Glk window tree's size request */
-static void
-request_recurse(winid_t win, GtkRequisition *requisition, guint spacing)
+/* Implementation of get_request_mode(): Always request constant size */
+static GtkSizeRequestMode
+chimara_glk_get_request_mode(GtkWidget *widget)
 {
-	if(win->type == wintype_Pair)
-	{
-		/* Get children's size requests */
-		GtkRequisition child1, child2;
-		request_recurse(win->window_node->children->data, &child1, spacing);
-		request_recurse(win->window_node->children->next->data, &child2, spacing);
+	return GTK_SIZE_REQUEST_CONSTANT_SIZE;
+}
 
-		glui32 division = win->split_method & winmethod_DivisionMask;
-		glui32 direction = win->split_method & winmethod_DirMask;
-		unsigned border = ((win->split_method & winmethod_BorderMask) == winmethod_NoBorder)? 0 : spacing;
+/* Minimal implementation of width request. Allocation in Glk is
+strictly top-down, so we just request our current size by returning 1. */
+static void
+chimara_glk_get_preferred_width(GtkWidget *widget, int *minimal, int *natural)
+{
+    g_return_if_fail(widget || CHIMARA_IS_GLK(widget));
+    g_return_if_fail(minimal);
+    g_return_if_fail(natural);
 
-		/* If the split is fixed, get the size of the fixed child */
-		if(division == winmethod_Fixed)
-		{
-			switch(direction)
-			{
-				case winmethod_Left:
-					child1.width = win->key_window?
-						win->constraint_size * win->key_window->unit_width
-						: 0;
-					break;
-				case winmethod_Right:
-					child2.width = win->key_window?
-						win->constraint_size * win->key_window->unit_width
-						: 0;
-					break;
-				case winmethod_Above:
-					child1.height = win->key_window?
-						win->constraint_size * win->key_window->unit_height
-						: 0;
-					break;
-				case winmethod_Below:
-					child2.height = win->key_window?
-						win->constraint_size * win->key_window->unit_height
-						: 0;
-					break;
-			}
-		}
-		
-		/* Add the children's requests */
-		switch(direction)
-		{
-			case winmethod_Left:
-			case winmethod_Right:
-				requisition->width = child1.width + child2.width + border;
-				requisition->height = MAX(child1.height, child2.height);
-				break;
-			case winmethod_Above:
-			case winmethod_Below:
-				requisition->width = MAX(child1.width, child2.width);
-				requisition->height = child1.height + child2.height + border;
-				break;
-		}
-	}
-	
-	/* For non-pair windows, just use the size that GTK requests */
-	else
-		gtk_widget_size_request(win->frame, requisition);
+    *minimal = *natural = 1;
 }
 
-/* Overrides gtk_widget_size_request */
+/* Minimal implementation of height request. Allocation in Glk is
+strictly top-down, so we just request our current size by returning 1. */
 static void
-chimara_glk_size_request(GtkWidget *widget, GtkRequisition *requisition)
+chimara_glk_get_preferred_height(GtkWidget *widget, int *minimal, int *natural)
 {
-    g_return_if_fail(widget);
-    g_return_if_fail(requisition);
-    g_return_if_fail(CHIMARA_IS_GLK(widget));
-    
-    ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
-    
-    /* For now, just pass the size request on to the root Glk window */
-    if(priv->root_window) 
-	{
-		request_recurse(priv->root_window->data, requisition, priv->spacing);
-		requisition->width += 2 * GTK_CONTAINER(widget)->border_width;
-		requisition->height += 2 * GTK_CONTAINER(widget)->border_width;
-	} 
-	else 
-	{
-        requisition->width = CHIMARA_GLK_MIN_WIDTH + 2 * GTK_CONTAINER(widget)->border_width;
-        requisition->height = CHIMARA_GLK_MIN_HEIGHT + 2 * GTK_CONTAINER(widget)->border_width;
-    }
+    g_return_if_fail(widget || CHIMARA_IS_GLK(widget));
+    g_return_if_fail(minimal);
+    g_return_if_fail(natural);
+
+    *minimal = *natural = 1;
 }
 
 /* Recursively give the Glk windows their allocated space. Returns a window
@@ -519,8 +471,10 @@ allocate_recurse(winid_t win, GtkAllocation *allocation, guint spacing)
 		/* It says in the spec that when a text grid window is resized smaller,
 		 the bottom or right area is thrown away; when it is resized larger, the
 		 bottom or right area is filled with blanks. */
-		glui32 newwidth = (glui32)(win->widget->allocation.width / win->unit_width);
-		glui32 newheight = (glui32)(win->widget->allocation.height / win->unit_height);
+		GtkAllocation widget_allocation;
+		gtk_widget_get_allocation(win->widget, &widget_allocation);
+		glui32 newwidth = (glui32)(widget_allocation.width / win->unit_width);
+		glui32 newheight = (glui32)(widget_allocation.height / win->unit_height);
 		gint line;
 		GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
 		GtkTextIter start, end;
@@ -595,16 +549,12 @@ chimara_glk_size_allocate(GtkWidget *widget, GtkAllocation *allocation)
     
     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
     
-    widget->allocation = *allocation;
-            
+    gtk_widget_set_allocation(widget, allocation);
+
     if(priv->root_window) {
-		GtkAllocation child;
-		child.x = allocation->x + GTK_CONTAINER(widget)->border_width;
-		child.y = allocation->y + GTK_CONTAINER(widget)->border_width;
-		child.width = CLAMP(allocation->width - 2 * GTK_CONTAINER(widget)->border_width, 0, allocation->width);
-		child.height = CLAMP(allocation->height - 2 * GTK_CONTAINER(widget)->border_width, 0, allocation->height);
+		GtkAllocation child = *allocation;
 		winid_t arrange = allocate_recurse(priv->root_window->data, &child, priv->spacing);
-		
+
 		/* arrange points to a window that contains all text grid and graphics
 		 windows which have been resized */
 		g_mutex_lock(priv->arrange_lock);
@@ -701,18 +651,6 @@ chimara_glk_iliad_screen_update(ChimaraGlk *self, gboolean typing)
 	/* Default signal handler */
 }
 
-/* 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
 chimara_glk_class_init(ChimaraGlkClass *klass)
 {
@@ -723,11 +661,15 @@ chimara_glk_class_init(ChimaraGlkClass *klass)
     object_class->finalize = chimara_glk_finalize;
     
     GtkWidgetClass *widget_class = GTK_WIDGET_CLASS(klass);
-    widget_class->size_request = chimara_glk_size_request;
+    widget_class->get_request_mode = chimara_glk_get_request_mode;
+    widget_class->get_preferred_width = chimara_glk_get_preferred_width;
+    widget_class->get_preferred_height = chimara_glk_get_preferred_height;
     widget_class->size_allocate = chimara_glk_size_allocate;
 
     GtkContainerClass *container_class = GTK_CONTAINER_CLASS(klass);
     container_class->forall = chimara_glk_forall;
+    /* Automatically handle the GtkContainer:border-width property */
+    gtk_container_class_handle_border_width(container_class);
 
     /* Signals */
     klass->stopped = chimara_glk_stopped;
@@ -919,6 +861,17 @@ chimara_glk_class_init(ChimaraGlkClass *klass)
 		NULL,
 		G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
 	
+	/**
+	 * ChimaraGlk:running:
+	 *
+	 * Whether this Glk widget is currently running a game or not.
+	 */
+	g_object_class_install_property(object_class, PROP_RUNNING,
+		g_param_spec_boolean("running", _("Running"),
+		_("Whether there is a program currently running"),
+		FALSE,
+		G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
+
 	/* Private data */
     g_type_class_add_private(klass, sizeof(ChimaraGlkPrivate));
 }
@@ -1229,8 +1182,7 @@ chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GE
     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() );
+	chimara_glk_unload_plugin(glk);
 	/* Open the module to run */
     priv->program = g_module_open(plugin, G_MODULE_BIND_LAZY);
     
@@ -1272,6 +1224,35 @@ chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GE
 	return !(priv->thread == NULL);
 }
 
+/**
+ * chimara_glk_run_file:
+ * @self: a #ChimaraGlk widget
+ * @plugin_file: a #GFile pointing to a plugin module compiled with <filename
+ * class="header">glk.h</filename>
+ * @argc: Number of command line arguments in @argv
+ * @argv: Array of command line arguments to pass to the plugin
+ * @error: location to store a <link
+ * linkend="glib-Error-Reporting">GError</link>, or %NULL
+ *
+ * Opens a Glk program compiled as a plugin, from a #GFile. See
+ * chimara_glk_run() for details.
+ *
+ * Return value: %TRUE if the Glk program was started successfully.
+ */
+gboolean
+chimara_glk_run_file(ChimaraGlk *self, GFile *plugin_file, int argc, char *argv[], GError **error)
+{
+	g_return_val_if_fail(self || CHIMARA_IS_GLK(self), FALSE);
+	g_return_val_if_fail(plugin_file || G_IS_FILE(plugin_file), FALSE);
+	g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
+
+	char *path = g_file_get_path(plugin_file);
+	gboolean retval = chimara_glk_run(self, path, argc, argv, error);
+	g_free(path);
+
+	return retval;
+}
+
 /**
  * chimara_glk_stop:
  * @glk: a #ChimaraGlk widget
@@ -1279,6 +1260,8 @@ chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GE
  * Signals the Glk program running in @glk to abort. Note that if the program is
  * caught in an infinite loop in which glk_tick() is not called, this may not
  * work.
+ *
+ * This function does nothing if no Glk program is running.
  */
 void
 chimara_glk_stop(ChimaraGlk *glk)
@@ -1309,6 +1292,8 @@ chimara_glk_stop(ChimaraGlk *glk)
  *
  * Holds up the main thread and waits for the Glk program running in @glk to 
  * finish.
+ *
+ * This function does nothing if no Glk program is running.
  */
 void
 chimara_glk_wait(ChimaraGlk *glk)
@@ -1324,6 +1309,26 @@ chimara_glk_wait(ChimaraGlk *glk)
 	gdk_threads_enter();
 }
 
+/**
+ * chimara_glk_unload_plugin:
+ * @glk: a #ChimaraGlk widget
+ *
+ * The plugin containing the Glk program is unloaded as late as possible before
+ * loading a new plugin, in order to prevent crashes while printing stack
+ * backtraces during debugging. Sometimes this behavior is not desirable. This
+ * function forces @glk to unload the plugin running in it.
+ *
+ * This function does nothing if there is no plugin loaded.
+ */
+void
+chimara_glk_unload_plugin(ChimaraGlk *glk)
+{
+	g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
+    CHIMARA_GLK_USE_PRIVATE(glk, priv);
+	if( priv->program && !g_module_close(priv->program) )
+		g_warning( "Error closing module :%s", g_module_error() );
+}
+
 /**
  * chimara_glk_get_running:
  * @glk: a #ChimaraGlk widget
@@ -1519,6 +1524,7 @@ chimara_glk_update_style(ChimaraGlk *glk)
  * @glk: a #ChimaraGlk widget
  * @func: a function to call for loading resources, or %NULL
  * @user_data: user data to pass to @func, or %NULL
+ * @destroy_user_data: a function to call for freeing @user_data, or %NULL
  *
  * Sometimes it is preferable to load image and sound resources from somewhere
  * else than a Blorb file, for example while developing a game. Section 14 of
@@ -1531,12 +1537,27 @@ chimara_glk_update_style(ChimaraGlk *glk)
  * Note that @func is only called if no Blorb resource map has been set; having
  * a resource map in place overrides this function.
  *
+ * If you pass non-%NULL for @destroy_user_data, then @glk takes ownership of
+ * @user_data. When it is not needed anymore, it will be freed by calling
+ * @destroy_user_data on it. If you wish to retain ownership of @user_data, pass
+ * %NULL for @destroy_user_data.
+ *
  * To deactivate the callback, call this function with @func set to %NULL.
  */
 void
-chimara_glk_set_resource_load_callback(ChimaraGlk *glk, ChimaraResourceLoadFunc func, gpointer user_data)
+chimara_glk_set_resource_load_callback(ChimaraGlk *glk, ChimaraResourceLoadFunc func, gpointer user_data, GDestroyNotify destroy_user_data)
 {
 	CHIMARA_GLK_USE_PRIVATE(glk, priv);
+
+	if(priv->resource_load_callback == func
+		&& priv->resource_load_callback_data == user_data
+		&& priv->resource_load_callback_destroy_data == destroy_user_data)
+		return;
+
+	if(priv->resource_load_callback_destroy_data)
+		priv->resource_load_callback_destroy_data(priv->resource_load_callback_data);
+
 	priv->resource_load_callback = func;
 	priv->resource_load_callback_data = user_data;
+	priv->resource_load_callback_destroy_data = destroy_user_data;
 }