X-Git-Url: https://git.stderr.nl/gitweb?a=blobdiff_plain;f=libchimara%2Fchimara-if.c;h=2fb74c85e3477e5f845730abc5985904ec978ba2;hb=17743f862a0295c3b9bdead66d05a74deaddea0e;hp=939d734a9c990875ce7ee2f9511440b71db0c134;hpb=71d99f09c08f67aa8850679707ae98579fc17cba;p=projects%2Fchimara%2Fchimara.git diff --git a/libchimara/chimara-if.c b/libchimara/chimara-if.c index 939d734..2fb74c8 100644 --- a/libchimara/chimara-if.c +++ b/libchimara/chimara-if.c @@ -6,28 +6,38 @@ #include #include "chimara-if.h" #include "chimara-glk.h" +#include "chimara-glk-private.h" #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: chimara/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 * setting properties on the widget. + * + * Using it in a GTK program is similar to using #ChimaraGlk (which see). + * Threads must be initialized before using #ChimaraIF and the call to + * gtk_main() must be bracketed between gdk_threads_enter() and + * gdk_threads_leave(). Use chimara_if_run_game() to start playing an + * interactive fiction game. */ 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"), @@ -38,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 { @@ -60,6 +70,7 @@ typedef struct _ChimaraIFPrivate { ChimaraIFZmachineVersion interpreter_number; gint random_seed; gboolean random_seed_set; + gchar *graphics_file; /* Holding buffers for input and response */ gchar *input; GString *response; @@ -77,7 +88,8 @@ enum { PROP_TYPO_CORRECTION, PROP_INTERPRETER_NUMBER, PROP_RANDOM_SEED, - PROP_RANDOM_SEED_SET + PROP_RANDOM_SEED_SET, + PROP_GRAPHICS_FILE }; enum { @@ -97,7 +109,9 @@ chimara_if_waiting(ChimaraGlk *glk) gchar *response = g_string_free(priv->response, FALSE); priv->response = g_string_new(""); + gdk_threads_enter(); g_signal_emit_by_name(glk, "command", priv->input, response); + gdk_threads_leave(); g_free(priv->input); g_free(response); @@ -117,7 +131,18 @@ chimara_if_stopped(ChimaraGlk *glk) } static void -chimara_if_line_input(ChimaraGlk *glk, guint32 win_rock, gchar *input) +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); + + gchar outbuf[6]; + gint outbuflen = g_unichar_to_utf8(gdk_keyval_to_unicode(keysym), outbuf); + priv->input = g_strndup(outbuf, outbuflen); +} + +static void +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); @@ -125,7 +150,7 @@ chimara_if_line_input(ChimaraGlk *glk, guint32 win_rock, gchar *input) } 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); @@ -134,9 +159,11 @@ chimara_if_text_buffer_output(ChimaraGlk *glk, guint32 win_rock, gchar *output) 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; @@ -145,13 +172,12 @@ 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(""); /* Connect to signals of ChimaraGlk parent */ g_signal_connect(self, "stopped", G_CALLBACK(chimara_if_stopped), NULL); g_signal_connect(self, "waiting", G_CALLBACK(chimara_if_waiting), NULL); + g_signal_connect(self, "char-input", G_CALLBACK(chimara_if_char_input), NULL); g_signal_connect(self, "line-input", G_CALLBACK(chimara_if_line_input), NULL); g_signal_connect(self, "text-buffer-output", G_CALLBACK(chimara_if_text_buffer_output), NULL); } @@ -166,28 +192,40 @@ chimara_if_set_property(GObject *object, guint prop_id, const GValue *value, GPa { case PROP_PIRACY_MODE: PROCESS_FLAG(priv->flags, CHIMARA_IF_PIRACY_MODE, g_value_get_boolean(value)); + g_object_notify(object, "piracy-mode"); break; case PROP_TANDY_BIT: PROCESS_FLAG(priv->flags, CHIMARA_IF_TANDY_BIT, g_value_get_boolean(value)); + g_object_notify(object, "tandy-bit"); break; case PROP_EXPAND_ABBREVIATIONS: PROCESS_FLAG(priv->flags, CHIMARA_IF_EXPAND_ABBREVIATIONS, g_value_get_boolean(value)); + g_object_notify(object, "expand-abbreviations"); break; case PROP_IGNORE_ERRORS: PROCESS_FLAG(priv->flags, CHIMARA_IF_IGNORE_ERRORS, g_value_get_boolean(value)); + g_object_notify(object, "ignore-errors"); break; case PROP_TYPO_CORRECTION: PROCESS_FLAG(priv->flags, CHIMARA_IF_TYPO_CORRECTION, g_value_get_boolean(value)); + g_object_notify(object, "typo-correction"); break; case PROP_INTERPRETER_NUMBER: priv->interpreter_number = g_value_get_uint(value); + g_object_notify(object, "interpreter-number"); break; case PROP_RANDOM_SEED: priv->random_seed = g_value_get_int(value); + g_object_notify(object, "random-seed"); break; case PROP_RANDOM_SEED_SET: 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); } @@ -223,6 +261,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); } @@ -231,20 +272,11 @@ 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_OBJECT_CLASS(chimara_if_parent_class)->finalize(object); } -static void -chimara_if_command(ChimaraIF *self, gchar *input, gchar *response) -{ - /* Default signal handler */ -} - -/* G_PARAM_STATIC_STRINGS only appeared in GTK 2.13.0 */ -#ifndef G_PARAM_STATIC_STRINGS -#define G_PARAM_STATIC_STRINGS (G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB) -#endif - static void chimara_if_class_init(ChimaraIFClass *klass) { @@ -255,22 +287,24 @@ 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 - * @input: The command typed into the game + * @input: The command typed into the game, or %NULL * @response: The game's response to the command * * Emitted once for each input-response cycle of an interactive fiction * game. Note that games with nontraditional input systems (i.e. not all - * taking place in the same text buffer window) may throw this signal for a - * loop. + * taking place in the same text buffer window) may confuse this signal. + * + * It may happen that @input is %NULL, in which case @response is not due to + * a user command, but contains the text printed at the beginning of the + * game, up until the first prompt. */ chimara_if_signals[COMMAND] = g_signal_new("command", G_OBJECT_CLASS_TYPE(klass), 0, G_STRUCT_OFFSET(ChimaraIFClass, command), NULL, NULL, - chimara_marshal_VOID__STRING_STRING, + _chimara_marshal_VOID__STRING_STRING, G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_STRING); /* Properties */ @@ -422,7 +456,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)); } @@ -494,7 +542,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 @@ -506,27 +554,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 */ @@ -562,7 +611,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: @@ -611,6 +659,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); @@ -621,10 +677,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(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) @@ -640,6 +703,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.