X-Git-Url: https://git.stderr.nl/gitweb?a=blobdiff_plain;f=libchimara%2Fchimara-if.c;h=6310dc54ed3aa4f093a5ea8c1d478ee8bc537264;hb=6b441df0e3b55bc050229deb94566f8e6b0d395b;hp=4e8c1d9490b4fcbc38f0e471703a2fcc35fd5c29;hpb=0fef3cbbff5ee03c5d62143a3874484d024327f3;p=projects%2Fchimara%2Fchimara.git

diff --git a/libchimara/chimara-if.c b/libchimara/chimara-if.c
index 4e8c1d9..6310dc5 100644
--- a/libchimara/chimara-if.c
+++ b/libchimara/chimara-if.c
@@ -10,11 +10,14 @@
 #include "chimara-marshallers.h"
 #include "init.h"
 
+#ifndef PLUGINDIR
+#define PLUGINDIR "."
+#endif
+
 /**
  * SECTION:chimara-if
  * @short_description: Widget which plays an interactive fiction game
  * @stability: Unstable
- * @include: libchimara/chimara-if.h
  *
  * The #ChimaraIF widget, given an interactive fiction game file to run, selects
  * an appropriate interpreter plugin and runs it. Interpreter options are set by
@@ -28,13 +31,13 @@
  */
 
 static gboolean supported_formats[CHIMARA_IF_NUM_FORMATS][CHIMARA_IF_NUM_INTERPRETERS] = {
-	/* Frotz Nitfol Glulxe Git */
-	{ TRUE,  TRUE,  FALSE, FALSE }, /* Z5 */
-	{ TRUE,  TRUE,  FALSE, FALSE }, /* Z6 */
-	{ TRUE,  TRUE,  FALSE, FALSE }, /* Z8 */
-	{ TRUE,  TRUE,  FALSE, FALSE }, /* Zblorb */
-	{ FALSE, FALSE, TRUE,  TRUE  }, /* Glulx */
-	{ FALSE, FALSE, TRUE,  TRUE  }  /* Gblorb */
+	/* Frotz Nitfol Glulxe Git    Bocfel */
+	{ TRUE,  TRUE,  FALSE, FALSE, TRUE  }, /* Z5 */
+	{ TRUE,  TRUE,  FALSE, FALSE, TRUE  }, /* Z6 */
+	{ TRUE,  TRUE,  FALSE, FALSE, TRUE  }, /* Z8 */
+	{ TRUE,  TRUE,  FALSE, FALSE, TRUE  }, /* Zblorb */
+	{ FALSE, FALSE, TRUE,  TRUE,  FALSE }, /* Glulx */
+	{ FALSE, FALSE, TRUE,  TRUE,  FALSE }  /* Gblorb */
 };
 static gchar *format_names[CHIMARA_IF_NUM_FORMATS] = {
 	N_("Z-code version 5"),
@@ -45,10 +48,10 @@ static gchar *format_names[CHIMARA_IF_NUM_FORMATS] = {
 	N_("Blorbed Glulx")
 };
 static gchar *interpreter_names[CHIMARA_IF_NUM_INTERPRETERS] = {
-	N_("Frotz"), N_("Nitfol"), N_("Glulxe"), N_("Git")
+	N_("Frotz"), N_("Nitfol"), N_("Glulxe"), N_("Git"), N_("Bocfel")
 };
 static gchar *plugin_names[CHIMARA_IF_NUM_INTERPRETERS] = {
-	"frotz", "nitfol", "glulxe", "git"
+	"frotz", "nitfol", "glulxe", "git", "bocfel"
 };
 
 typedef enum _ChimaraIFFlags {
@@ -67,11 +70,18 @@ typedef struct _ChimaraIFPrivate {
 	ChimaraIFZmachineVersion interpreter_number;
 	gint random_seed;
 	gboolean random_seed_set;
-	/* Holding buffers for input and response */
-	gchar *input;
-	GString *response;
+	gchar *graphics_file;
+	/* Holding buffers for inputs and responses */
+	GHashTable *active_inputs;
+	GSList *window_librock_list;
 } ChimaraIFPrivate;
 
+typedef struct {
+	char *input;
+	GString *response;
+	gboolean active;
+} InputResponse;
+
 #define CHIMARA_IF_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), CHIMARA_TYPE_IF, ChimaraIFPrivate))
 #define CHIMARA_IF_USE_PRIVATE(o, n) ChimaraIFPrivate *n = CHIMARA_IF_PRIVATE(o)
 
@@ -84,7 +94,8 @@ enum {
 	PROP_TYPO_CORRECTION,
 	PROP_INTERPRETER_NUMBER,
 	PROP_RANDOM_SEED,
-	PROP_RANDOM_SEED_SET
+	PROP_RANDOM_SEED_SET,
+	PROP_GRAPHICS_FILE
 };
 
 enum {
@@ -96,21 +107,62 @@ static guint chimara_if_signals[LAST_SIGNAL] = { 0 };
 
 G_DEFINE_TYPE(ChimaraIF, chimara_if, CHIMARA_TYPE_GLK);
 
+static InputResponse *
+input_response_new(void)
+{
+	InputResponse *retval = g_slice_new0(InputResponse);
+	retval->response = g_string_new("");
+	return retval;
+}
+
 static void
-chimara_if_waiting(ChimaraGlk *glk)
+input_response_destroy(InputResponse *inp)
+{
+	g_free(inp->input);
+	g_string_free(inp->response, TRUE);
+	g_slice_free(InputResponse, inp);
+}
+
+static InputResponse *
+ensure_input_response_object(ChimaraIFPrivate *priv, char *string_id)
+{
+	InputResponse *retval = g_hash_table_lookup(priv->active_inputs, string_id);
+	if(retval == NULL)
+	{
+		char *new_key = g_strdup(string_id);
+		priv->window_librock_list = g_slist_prepend(priv->window_librock_list, new_key);
+		retval = input_response_new();
+		g_hash_table_insert(priv->active_inputs, new_key, retval);
+	}
+	return retval;
+}
+
+static void
+emit_command_signal_on_active_inputs(char *window_librock, ChimaraGlk *glk)
 {
 	CHIMARA_IF_USE_PRIVATE(glk, priv);
+	InputResponse *inp = g_hash_table_lookup(priv->active_inputs, window_librock);
+	if(!inp->active)
+		return;
 
-	gchar *response = g_string_free(priv->response, FALSE);
-	priv->response = g_string_new("");
+	char *response = g_strdup(inp->response->str);
+	g_string_truncate(inp->response, 0);
 
 	gdk_threads_enter();
-	g_signal_emit_by_name(glk, "command", priv->input, response);
+	g_signal_emit_by_name(glk, "command", inp->input, response);
 	gdk_threads_leave();
 
-	g_free(priv->input);
+	g_free(inp->input);
 	g_free(response);
-	priv->input = NULL;
+	inp->input = NULL;
+	inp->active = FALSE;
+}
+
+static void
+chimara_if_waiting(ChimaraGlk *glk)
+{
+	CHIMARA_IF_USE_PRIVATE(glk, priv);
+	g_slist_foreach(priv->window_librock_list, (GFunc)emit_command_signal_on_active_inputs, glk);
 }
 
 static void
@@ -118,45 +170,53 @@ chimara_if_stopped(ChimaraGlk *glk)
 {
 	CHIMARA_IF_USE_PRIVATE(glk, priv);
 
-	if(priv->input || priv->response->len > 0)
-		chimara_if_waiting(glk); /* Send one last command signal */
+	/* Send one last command signal for any active inputs */
+	g_slist_foreach(priv->window_librock_list, (GFunc)emit_command_signal_on_active_inputs, glk);
 
 	priv->format = CHIMARA_IF_FORMAT_NONE;
 	priv->interpreter = CHIMARA_IF_INTERPRETER_NONE;
 }
 
 static void
-chimara_if_char_input(ChimaraGlk *glk, guint32 win_rock, guint keysym)
+chimara_if_char_input(ChimaraGlk *glk, guint32 win_rock, char *string_id, unsigned keysym)
 {
 	CHIMARA_IF_USE_PRIVATE(glk, priv);
-	g_assert(priv->input == NULL);
+	InputResponse *inp = ensure_input_response_object(priv, string_id);
+	g_assert(!inp->active);
 
 	gchar outbuf[6];
 	gint outbuflen = g_unichar_to_utf8(gdk_keyval_to_unicode(keysym), outbuf);
-	priv->input = g_strndup(outbuf, outbuflen);
+	inp->input = g_strndup(outbuf, outbuflen);
+	inp->active = TRUE;
 }
 
 static void
-chimara_if_line_input(ChimaraGlk *glk, guint32 win_rock, gchar *input)
+chimara_if_line_input(ChimaraGlk *glk, guint32 win_rock, char *string_id, char *input)
 {
 	CHIMARA_IF_USE_PRIVATE(glk, priv);
-	g_assert(priv->input == NULL);
-	priv->input = g_strdup(input);
+	InputResponse *inp = ensure_input_response_object(priv, string_id);
+	g_assert(!inp->active);
+	inp->input = g_strdup(input);
+	inp->active = TRUE;
 }
 
 static void
-chimara_if_text_buffer_output(ChimaraGlk *glk, guint32 win_rock, gchar *output)
+chimara_if_text_buffer_output(ChimaraGlk *glk, guint32 win_rock, char *string_id, char *output)
 {
 	CHIMARA_IF_USE_PRIVATE(glk, priv);
-	g_string_append(priv->response, output);
+	InputResponse *inp = ensure_input_response_object(priv, string_id);
+	g_string_append(inp->response, output);
+	inp->active = TRUE;
 }
 
 static void
 chimara_if_init(ChimaraIF *self)
 {
+	chimara_init(); /* This is a library entry point */
+
 	CHIMARA_IF_USE_PRIVATE(self, priv);
 	priv->preferred_interpreter[CHIMARA_IF_FORMAT_Z5] = CHIMARA_IF_INTERPRETER_FROTZ;
-	priv->preferred_interpreter[CHIMARA_IF_FORMAT_Z6] = CHIMARA_IF_INTERPRETER_FROTZ;
+	priv->preferred_interpreter[CHIMARA_IF_FORMAT_Z6] = CHIMARA_IF_INTERPRETER_NITFOL;
 	priv->preferred_interpreter[CHIMARA_IF_FORMAT_Z8] = CHIMARA_IF_INTERPRETER_FROTZ;
 	priv->preferred_interpreter[CHIMARA_IF_FORMAT_Z_BLORB] = CHIMARA_IF_INTERPRETER_FROTZ;
 	priv->preferred_interpreter[CHIMARA_IF_FORMAT_GLULX] = CHIMARA_IF_INTERPRETER_GLULXE;
@@ -165,9 +225,8 @@ chimara_if_init(ChimaraIF *self)
 	priv->interpreter = CHIMARA_IF_INTERPRETER_NONE;
 	priv->flags = CHIMARA_IF_TYPO_CORRECTION;
 	priv->interpreter_number = CHIMARA_IF_ZMACHINE_DEFAULT;
-	priv->random_seed_set = FALSE;
-	priv->input = NULL;
-	priv->response = g_string_new("");
+	priv->active_inputs = g_hash_table_new_full(g_str_hash, g_str_equal,
+		(GDestroyNotify)g_free, (GDestroyNotify)input_response_destroy);
 
 	/* Connect to signals of ChimaraGlk parent */
 	g_signal_connect(self, "stopped", G_CALLBACK(chimara_if_stopped), NULL);
@@ -217,6 +276,10 @@ chimara_if_set_property(GObject *object, guint prop_id, const GValue *value, GPa
     		priv->random_seed_set = g_value_get_boolean(value);
     		g_object_notify(object, "random-seed-set");
     		break;
+		case PROP_GRAPHICS_FILE:
+			priv->graphics_file = g_strdup(g_value_get_string(value));
+			g_object_notify(object, "graphics-file");
+			break;
         default:
             G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
     }
@@ -252,6 +315,9 @@ chimara_if_get_property(GObject *object, guint prop_id, GValue *value, GParamSpe
     	case PROP_RANDOM_SEED_SET:
     		g_value_set_boolean(value, priv->random_seed_set);
     		break;
+		case PROP_GRAPHICS_FILE:
+			g_value_set_string(value, priv->graphics_file);
+			break;
         default:
             G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
     }
@@ -260,27 +326,13 @@ chimara_if_get_property(GObject *object, guint prop_id, GValue *value, GParamSpe
 static void
 chimara_if_finalize(GObject *object)
 {
+	CHIMARA_IF_USE_PRIVATE(object, priv);
+	g_free(priv->graphics_file);
+	g_hash_table_destroy(priv->active_inputs);
+	g_slist_free(priv->window_librock_list); /* values are already freed in hashtable */
     G_OBJECT_CLASS(chimara_if_parent_class)->finalize(object);
 }
 
-static void
-chimara_if_command(ChimaraIF *self, gchar *input, gchar *response)
-{
-	/* 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_if_class_init(ChimaraIFClass *klass)
 {
@@ -291,7 +343,6 @@ chimara_if_class_init(ChimaraIFClass *klass)
 	object_class->finalize = chimara_if_finalize;
 
 	/* Signals */
-	klass->command = chimara_if_command;
 	/**
 	 * ChimaraIF::command:
 	 * @self: The widget that received the signal
@@ -461,7 +512,21 @@ chimara_if_class_init(ChimaraIFClass *klass)
 		g_param_spec_boolean("random-seed-set", _("Random seed set"),
 		_("Whether the seed for the random number generator should be set manually"), FALSE,
 		G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS));
-
+	/**
+	 * ChimaraIF:graphics-file:
+	 *
+	 * Some Z-machine interpreters accept an extra argument that indicates a
+	 * separate Blorb file containing graphics and sound resources. The
+	 * interpreter will check if the file specified in this property really
+	 * exists, and if so, use it as a resource file. If this property is set to 
+	 * %NULL, the interpreter will not look for an extra file.
+	 *
+	 * Only affects Frotz and Nitfol.
+	 */
+	g_object_class_install_property(object_class, PROP_GRAPHICS_FILE,
+	    g_param_spec_string("graphics-file", _("Graphics file"),
+	    _("Location in which to look for a separate graphics Blorb file"), NULL,
+	    G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS));
 	/* Private data */
 	g_type_class_add_private(klass, sizeof(ChimaraIFPrivate));
 }
@@ -533,7 +598,7 @@ chimara_if_get_preferred_interpreter(ChimaraIF *self, ChimaraIFFormat format)
 /**
  * chimara_if_run_game:
  * @self: A #ChimaraIF widget.
- * @gamefile: Path to an interactive fiction game file.
+ * @game_path: Path to an interactive fiction game file.
  * @error: Return location for an error, or %NULL.
  *
  * Autodetects the type of a game file and runs it using an appropriate
@@ -545,27 +610,28 @@ chimara_if_get_preferred_interpreter(ChimaraIF *self, ChimaraIFFormat format)
  * case @error is set.
  */
 gboolean
-chimara_if_run_game(ChimaraIF *self, gchar *gamefile, GError **error)
+chimara_if_run_game(ChimaraIF *self, const char *game_path, GError **error)
 {
 	g_return_val_if_fail(self && CHIMARA_IS_IF(self), FALSE);
-	g_return_val_if_fail(gamefile, FALSE);
+	g_return_val_if_fail(game_path, FALSE);
+	g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
 
 	CHIMARA_IF_USE_PRIVATE(self, priv);
 
 	/* Find out what format the game is */
 	/* TODO: Look inside the file instead of just looking at the extension */
 	ChimaraIFFormat format = CHIMARA_IF_FORMAT_Z5;
-	if(g_str_has_suffix(gamefile, ".z5"))
+	if(g_str_has_suffix(game_path, ".z5"))
 		format = CHIMARA_IF_FORMAT_Z5;
-	else if(g_str_has_suffix(gamefile, ".z6"))
+	else if(g_str_has_suffix(game_path, ".z6"))
 		format = CHIMARA_IF_FORMAT_Z6;
-	else if(g_str_has_suffix(gamefile, ".z8"))
+	else if(g_str_has_suffix(game_path, ".z8"))
 		format = CHIMARA_IF_FORMAT_Z8;
-	else if(g_str_has_suffix(gamefile, ".zlb") || g_str_has_suffix(gamefile, ".zblorb"))
+	else if(g_str_has_suffix(game_path, ".zlb") || g_str_has_suffix(game_path, ".zblorb"))
 		format = CHIMARA_IF_FORMAT_Z_BLORB;
-	else if(g_str_has_suffix(gamefile, ".ulx"))
+	else if(g_str_has_suffix(game_path, ".ulx"))
 		format = CHIMARA_IF_FORMAT_GLULX;
-	else if(g_str_has_suffix(gamefile, ".blb") || g_str_has_suffix(gamefile, ".blorb") || g_str_has_suffix(gamefile, ".glb") || g_str_has_suffix(gamefile, ".gblorb"))
+	else if(g_str_has_suffix(game_path, ".blb") || g_str_has_suffix(game_path, ".blorb") || g_str_has_suffix(game_path, ".glb") || g_str_has_suffix(game_path, ".gblorb"))
 		format = CHIMARA_IF_FORMAT_GLULX_BLORB;
 
 	/* Now decide what interpreter to use */
@@ -601,7 +667,6 @@ chimara_if_run_game(ChimaraIF *self, gchar *gamefile, GError **error)
 	GSList *args = NULL;
 	gchar *terpnumstr = NULL, *randomstr = NULL;
 	args = g_slist_prepend(args, pluginpath);
-	args = g_slist_prepend(args, gamefile);
 	switch(interpreter)
 	{
 		case CHIMARA_IF_INTERPRETER_FROTZ:
@@ -650,6 +715,14 @@ chimara_if_run_game(ChimaraIF *self, gchar *gamefile, GError **error)
 			;
 	}
 
+	/* Game file and external blorb file */
+	args = g_slist_prepend(args, (gpointer)game_path);
+	if(priv->graphics_file
+		&& (interpreter == CHIMARA_IF_INTERPRETER_FROTZ || interpreter == CHIMARA_IF_INTERPRETER_NITFOL)
+	    && g_file_test(priv->graphics_file, G_FILE_TEST_EXISTS)) {
+		args = g_slist_prepend(args, priv->graphics_file);
+	}
+
 	/* Allocate argv to hold the arguments */
 	int argc = g_slist_length(args);
 	args = g_slist_prepend(args, NULL);
@@ -660,17 +733,17 @@ chimara_if_run_game(ChimaraIF *self, gchar *gamefile, GError **error)
 	int count;
 	GSList *ptr;
 	for(count = 0, ptr = args; ptr; count++, ptr = g_slist_next(ptr))
-		argv[count] = ptr->data;
-		
+		argv[count] = g_strdup(ptr->data);
+
 	/* Set the story name */
 	/* We peek into ChimaraGlk's private data here, because GObject has no
 	equivalent to "protected" */
 	CHIMARA_GLK_USE_PRIVATE(self, glk_priv);
-	glk_priv->story_name = g_path_get_basename(gamefile);
+	glk_priv->story_name = g_path_get_basename(game_path);
 	g_object_notify(G_OBJECT(self), "story-name");
 	
 	gboolean retval = chimara_glk_run(CHIMARA_GLK(self), pluginpath, argc, argv, error);
-	g_free(argv);
+	g_strfreev(argv);
 	if(terpnumstr)
 		g_free(terpnumstr);
 	if(randomstr)
@@ -686,6 +759,31 @@ chimara_if_run_game(ChimaraIF *self, gchar *gamefile, GError **error)
 	return retval;
 }
 
+/**
+ * chimara_if_run_game_file:
+ * @self: A #ChimaraIF widget.
+ * @game_file: a #GFile pointing to an interactive fiction game file.
+ * @error: Return location for an error, or %NULL.
+ *
+ * Autodetects the type of a game file and runs it using an appropriate
+ * interpreter plugin. See chimara_if_run_game() for more information.
+ *
+ * Returns: %TRUE if the game was started successfully, %FALSE if not, in which
+ * case @error is set.
+ */
+gboolean
+chimara_if_run_game_file(ChimaraIF *self, GFile *game_file, GError **error)
+{
+	g_return_val_if_fail(self || CHIMARA_IS_IF(self), FALSE);
+	g_return_val_if_fail(game_file || G_IS_FILE(game_file), FALSE);
+	g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
+
+	char *path = g_file_get_path(game_file);
+	gboolean retval = chimara_if_run_game(self, path, error);
+	g_free(path);
+	return retval;
+}
+
 /**
  * chimara_if_get_format:
  * @self: A #ChimaraIF widget.