Brought documentation up to date
[rodin/chimara.git] / libchimara / chimara-if.c
index e3553b1c3248b353013a3f9854345d2042dff79b..7b91830acdce059d12ab64193a28355cbf6c75df 100644 (file)
@@ -9,6 +9,17 @@
 #include "chimara-marshallers.h"
 #include "init.h"
 
+/**
+ * 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.
+ */
+
 static gboolean supported_formats[CHIMARA_IF_NUM_FORMATS][CHIMARA_IF_NUM_INTERPRETERS] = {
        /* Frotz Nitfol Glulxe Git */
        { TRUE,  TRUE,  FALSE, FALSE }, /* Z5 */
@@ -33,20 +44,44 @@ static gchar *plugin_names[CHIMARA_IF_NUM_INTERPRETERS] = {
        "frotz", "nitfol", "glulxe", "git"
 };
 
+typedef enum _ChimaraIFFlags {
+       CHIMARA_IF_PIRACY_MODE = 1 << 0,
+       CHIMARA_IF_TANDY_BIT = 1 << 1,
+       CHIMARA_IF_EXPAND_ABBREVIATIONS = 1 << 2,
+       CHIMARA_IF_IGNORE_ERRORS = 1 << 3,
+       CHIMARA_IF_TYPO_CORRECTION = 1 << 4
+} ChimaraIFFlags;
+
 typedef struct _ChimaraIFPrivate {
        ChimaraIFInterpreter preferred_interpreter[CHIMARA_IF_NUM_FORMATS];
+       ChimaraIFFormat format;
+       ChimaraIFInterpreter interpreter;
+       ChimaraIFFlags flags;
+       ChimaraIFZmachineVersion interpreter_number;
+       gint random_seed;
+       gboolean random_seed_set;
+       /* Holding buffers for input and response */
+       gchar *input;
+       GString *response;
 } ChimaraIFPrivate;
 
 #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)
 
 enum {
-       PROP_0
+       PROP_0,
+       PROP_PIRACY_MODE,
+       PROP_TANDY_BIT,
+       PROP_EXPAND_ABBREVIATIONS,
+       PROP_IGNORE_ERRORS,
+       PROP_TYPO_CORRECTION,
+       PROP_INTERPRETER_NUMBER,
+       PROP_RANDOM_SEED,
+       PROP_RANDOM_SEED_SET
 };
 
 enum {
        COMMAND,
-
        LAST_SIGNAL
 };
 
@@ -54,6 +89,48 @@ static guint chimara_if_signals[LAST_SIGNAL] = { 0 };
 
 G_DEFINE_TYPE(ChimaraIF, chimara_if, CHIMARA_TYPE_GLK);
 
+static void
+chimara_if_waiting(ChimaraGlk *glk)
+{
+       CHIMARA_IF_USE_PRIVATE(glk, priv);
+
+       gchar *response = g_string_free(priv->response, FALSE);
+       priv->response = g_string_new("");
+
+       g_signal_emit_by_name(glk, "command", priv->input, response);
+
+       g_free(priv->input);
+       g_free(response);
+       priv->input = NULL;
+}
+
+static void
+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 */
+
+       priv->format = CHIMARA_IF_FORMAT_NONE;
+       priv->interpreter = CHIMARA_IF_INTERPRETER_NONE;
+}
+
+static void
+chimara_if_line_input(ChimaraGlk *glk, guint32 win_rock, gchar *input)
+{
+       CHIMARA_IF_USE_PRIVATE(glk, priv);
+       g_assert(priv->input == NULL);
+       priv->input = g_strdup(input);
+}
+
+static void
+chimara_if_text_buffer_output(ChimaraGlk *glk, guint32 win_rock, gchar *output)
+{
+       CHIMARA_IF_USE_PRIVATE(glk, priv);
+       g_string_append(priv->response, output);
+}
+
 static void
 chimara_if_init(ChimaraIF *self)
 {
@@ -64,13 +141,61 @@ chimara_if_init(ChimaraIF *self)
        priv->preferred_interpreter[CHIMARA_IF_FORMAT_Z_BLORB] = CHIMARA_IF_INTERPRETER_FROTZ;
        priv->preferred_interpreter[CHIMARA_IF_FORMAT_GLULX] = CHIMARA_IF_INTERPRETER_GLULXE;
        priv->preferred_interpreter[CHIMARA_IF_FORMAT_GLULX_BLORB] = CHIMARA_IF_INTERPRETER_GLULXE;
+       priv->format = CHIMARA_IF_FORMAT_NONE;
+       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, "line-input", G_CALLBACK(chimara_if_line_input), NULL);
+       g_signal_connect(self, "text-buffer-output", G_CALLBACK(chimara_if_text_buffer_output), NULL);
 }
 
+#define PROCESS_FLAG(flags, flag, val) (flags) = (val)? (flags) | (flag) : (flags) & ~(flag)
+
 static void
 chimara_if_set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
 {
+       CHIMARA_IF_USE_PRIVATE(object, priv);
     switch(prop_id)
     {
+       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;
         default:
             G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
     }
@@ -79,9 +204,33 @@ chimara_if_set_property(GObject *object, guint prop_id, const GValue *value, GPa
 static void
 chimara_if_get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
 {
+       CHIMARA_IF_USE_PRIVATE(object, priv);
     switch(prop_id)
     {
-
+       case PROP_PIRACY_MODE:
+               g_value_set_boolean(value, priv->flags & CHIMARA_IF_PIRACY_MODE);
+               break;
+       case PROP_TANDY_BIT:
+               g_value_set_boolean(value, priv->flags & CHIMARA_IF_TANDY_BIT);
+               break;
+       case PROP_EXPAND_ABBREVIATIONS:
+               g_value_set_boolean(value, priv->flags & CHIMARA_IF_EXPAND_ABBREVIATIONS);
+               break;
+       case PROP_IGNORE_ERRORS:
+               g_value_set_boolean(value, priv->flags & CHIMARA_IF_IGNORE_ERRORS);
+               break;
+       case PROP_TYPO_CORRECTION:
+               g_value_set_boolean(value, priv->flags & CHIMARA_IF_TYPO_CORRECTION);
+               break;
+       case PROP_INTERPRETER_NUMBER:
+               g_value_set_uint(value, priv->interpreter_number);
+               break;
+       case PROP_RANDOM_SEED:
+               g_value_set_int(value, priv->random_seed);
+               break;
+       case PROP_RANDOM_SEED_SET:
+               g_value_set_boolean(value, priv->random_seed_set);
+               break;
         default:
             G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
     }
@@ -99,6 +248,18 @@ 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)
 {
@@ -110,7 +271,16 @@ chimara_if_class_init(ChimaraIFClass *klass)
 
        /* Signals */
        klass->command = chimara_if_command;
-       /* Gtk-Doc for command */
+       /**
+        * ChimaraIF::command:
+        * @self: The widget that received the signal
+        * @input: The command typed into the game
+        * @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 confuse this signal.
+        */
        chimara_if_signals[COMMAND] = g_signal_new("command",
                G_OBJECT_CLASS_TYPE(klass), 0,
                G_STRUCT_OFFSET(ChimaraIFClass, command), NULL, NULL,
@@ -118,8 +288,154 @@ chimara_if_class_init(ChimaraIFClass *klass)
                G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_STRING);
 
        /* Properties */
-       /* Gtk-Doc for property */
-       /* g_object_class_install_property(object_class, PROPERTY, ...); */
+       /**
+        * ChimaraIF:piracy-mode:
+        *
+        * The Z-machine specification defines a facility for games to ask the
+        * interpreter they are running on whether this copy of the game is pirated.
+        * How the interpreter is supposed to magically determine that it is running
+        * pirate software is unclear, and so the majority of games and interpreters
+        * ignore this feature. Set this property to %TRUE if you want the
+        * interpreter to pretend it has detected a pirated game.
+        *
+        * Only affects Z-machine interpreters.
+        */
+       g_object_class_install_property(object_class, PROP_PIRACY_MODE,
+               g_param_spec_boolean("piracy-mode", _("Piracy mode"),
+               _("Pretend the game is pirated"), FALSE,
+               G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS));
+       /**
+        * ChimaraIF:tandy-bit:
+        *
+        * Some early Infocom games were sold by the Tandy Corporation. Setting this
+        * property to %TRUE changes the wording of some Version 3 Infocom games
+        * slightly, so as to be less offensive. See <ulink
+        * url="http://www.ifarchive.org/if-archive/infocom/info/tandy_bits.html">
+        * http://www.ifarchive.org/if-archive/infocom/info/tandy_bits.html</ulink>.
+        *
+        * Only affects Z-machine interpreters.
+        */
+       g_object_class_install_property(object_class, PROP_TANDY_BIT,
+               g_param_spec_boolean("tandy-bit", _("Tandy bit"),
+               _("Censor certain Infocom games"), FALSE,
+               G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS));
+       /**
+        * ChimaraIF:expand-abbreviations:
+        *
+        * Most Z-machine games, in particular ones compiled with the Inform
+        * library, support the following one-letter abbreviations:
+        * <simplelist>
+        * <member>D &mdash; Down</member>
+        * <member>E &mdash; East</member>
+        * <member>G &mdash; aGain</member>
+        * <member>I &mdash; Inventory</member>
+        * <member>L &mdash; Look</member>
+        * <member>N &mdash; North</member>
+        * <member>O &mdash; Oops</member>
+        * <member>Q &mdash; Quit</member>
+        * <member>S &mdash; South</member>
+        * <member>U &mdash; Up</member>
+        * <member>W &mdash; West</member>
+        * <member>X &mdash; eXamine</member>
+        * <member>Y &mdash; Yes</member>
+        * <member>Z &mdash; wait (ZZZZ...)</member>
+        * </simplelist>
+        * Some early Infocom games might not recognize these abbreviations. Setting
+        * this property to %TRUE will cause the interpreter to expand the
+        * abbreviations to the full words before passing the commands on to the
+        * game. Frotz only expands G, X, and Z; Nitfol expands all of the above
+        * plus the following nonstandard ones:
+        * <simplelist>
+        * <member>C &mdash; Close</member>
+        * <member>K &mdash; attacK</member>
+        * <member>P &mdash; oPen</member>
+        * <member>R &mdash; dRop</member>
+        * <member>T &mdash; Take</member>
+        * </simplelist>
+        *
+        * Only affects Z-machine interpreters. Behaves differently on Frotz and
+        * Nitfol.
+        */
+       g_object_class_install_property(object_class, PROP_EXPAND_ABBREVIATIONS,
+               g_param_spec_boolean("expand-abbreviations", _("Expand abbreviations"),
+               _("Expand abbreviations such as X for EXAMINE"), FALSE,
+               G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS));
+       /**
+        * ChimaraIF:ignore-errors:
+        *
+        * Setting this property to %TRUE will cause the interpreter to ignore
+        * certain Z-machine runtime errors. Frotz will ignore any fatal errors.
+        * Nitfol by default warns about any shady behavior, and this property will
+        * turn those warnings off.
+        *
+        * Only affects Z-machine interpreters. Behaves differently on Frotz and
+        * Nitfol.
+        */
+       g_object_class_install_property(object_class, PROP_IGNORE_ERRORS,
+               g_param_spec_boolean("ignore-errors", _("Ignore errors"),
+               _("Do not warn the user about Z-machine errors"), FALSE,
+               G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS));
+       /**
+        * ChimaraIF:typo-correction:
+        *
+        * Nitfol has an automatic typo-correction facility, where it searches the
+        * game dictionary for words which differ by one letter from any unknown
+        * input words. Set this property to %FALSE to turn this feature off.
+        *
+        * Only affects Nitfol.
+        */
+       g_object_class_install_property(object_class, PROP_TYPO_CORRECTION,
+               g_param_spec_boolean("typo-correction", _("Typo correction"),
+               _("Try to remedy typos if the interpreter supports it"), TRUE,
+               G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS));
+       /**
+        * ChimaraIF:interpreter-number:
+        *
+        * Infocom gave each port of their interpreter a different number. The Frotz
+        * and Nitfol plugins can emulate any of these platforms. Some games behave
+        * slightly differently depending on what platform they are on. Set this
+        * property to a #ChimaraIFZmachineVersion value to emulate a certain
+        * platform.
+        *
+        * Note that Nitfol pretends to be an Apple IIe by default.
+        *
+        * Only affects Z-machine interpreters.
+        */
+       g_object_class_install_property(object_class, PROP_INTERPRETER_NUMBER,
+               g_param_spec_uint("interpreter-number", _("Interpreter number"),
+               _("Platform the Z-machine should pretend it is running on"),
+               CHIMARA_IF_ZMACHINE_DEFAULT, CHIMARA_IF_ZMACHINE_MAXVAL, CHIMARA_IF_ZMACHINE_DEFAULT,
+               G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS));
+       /**
+        * ChimaraIF:random-seed:
+        *
+        * If the #ChimaraIF:random-seed-set property is %TRUE, then the interpreter
+        * will use the value of this property as a seed for the random number
+        * generator. Use this feature to duplicate sequences of random numbers
+        * for testing games.
+        *
+        * Note that the value -1 is a valid random number seed for
+        * Nitfol, whereas it will cause Frotz to pick an arbitrary seed even when
+        * #ChimaraIF:random-seed-set is %TRUE.
+        *
+        * Only affects Z-machine interpreters. Behaves slightly differently on
+        * Frotz and Nitfol.
+        */
+       g_object_class_install_property(object_class, PROP_RANDOM_SEED,
+               g_param_spec_int("random-seed", _("Random seed"),
+               _("Seed for the random number generator"), G_MININT, G_MAXINT, 0,
+               G_PARAM_READWRITE | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS));
+       /**
+        * ChimaraIF:random-seed-set:
+        *
+        * Whether to use or ignore the #ChimaraIF:random-seed property.
+        *
+        * Only affects Z-machine interpreters.
+        */
+       g_object_class_install_property(object_class, PROP_RANDOM_SEED_SET,
+               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));
 
        /* Private data */
        g_type_class_add_private(klass, sizeof(ChimaraIFPrivate));
@@ -142,12 +458,24 @@ chimara_if_new(void)
     return GTK_WIDGET(g_object_new(CHIMARA_TYPE_IF, NULL));
 }
 
+/**
+ * chimara_if_set_preferred_interpreter:
+ * @self: A #ChimaraIF widget.
+ * @format: The game format to set the preferred interpreter plugin for.
+ * @interpreter: The preferred interpreter plugin for @format.
+ *
+ * The function chimara_if_run_game() picks an appropriate interpreter for the
+ * type of game file it is given. This function sets which interpreter is picked
+ * for a certain game file format. Most formats, notably the Z-machine, have
+ * had many different interpreters written for them over the years, all with
+ * slightly different quirks and capabilities, so there is plenty of choice.
+ */
 void
 chimara_if_set_preferred_interpreter(ChimaraIF *self, ChimaraIFFormat format, ChimaraIFInterpreter interpreter)
 {
        g_return_if_fail(self && CHIMARA_IS_IF(self));
        g_return_if_fail(format < CHIMARA_IF_NUM_FORMATS);
-       g_return_if_fail(format < CHIMARA_IF_NUM_INTERPRETERS);
+       g_return_if_fail(interpreter < CHIMARA_IF_NUM_INTERPRETERS);
 
        CHIMARA_IF_USE_PRIVATE(self, priv);
 
@@ -157,6 +485,17 @@ chimara_if_set_preferred_interpreter(ChimaraIF *self, ChimaraIFFormat format, Ch
                g_warning("Format '%s' is not supported by interpreter '%s'", format_names[format], interpreter_names[interpreter]);
 }
 
+/**
+ * chimara_if_get_preferred_interpreter:
+ * @self: A #ChimaraIF widget.
+ * @format: The game format to query the preferred interpreter plugin for.
+ *
+ * Looks up the preferred interpreter for the game file format @format. See
+ * chimara_if_set_preferred_interpreter().
+ *
+ * Returns: a #ChimaraIFInterpreter value representing the preferred interpreter
+ * plugin for @format.
+ */
 ChimaraIFInterpreter
 chimara_if_get_preferred_interpreter(ChimaraIF *self, ChimaraIFFormat format)
 {
@@ -166,50 +505,26 @@ chimara_if_get_preferred_interpreter(ChimaraIF *self, ChimaraIFFormat format)
        return priv->preferred_interpreter[format];
 }
 
-/* Opens a '.la' file and finds the name of the plugin library. g_free() the
- * string when done. */
-static gchar *
-find_dlname(const gchar *pluginfile, GError **error)
-{
-       /* Find the name of the shared library */
-       gchar *dlname;
-       FILE *plugin = fopen(pluginfile, "r");
-       if(!plugin)
-       {
-               g_set_error(error, G_FILE_ERROR, errno, "Error opening '%s': %s", pluginfile, g_strerror(errno));
-               return NULL;
-       }
-       gchar *line = NULL;
-       size_t buflen;
-       ssize_t length;
-       while((length = getline(&line, &buflen, plugin)) != -1)
-       {       
-               if(g_str_has_prefix(line, "dlname='"))
-               {
-                       dlname = g_strndup(line + 8, length - 10);
-                       break;
-               }
-       }
-       free(line);
-       if(!dlname)
-       {
-               g_set_error(error, G_FILE_ERROR, errno, "Error reading '%s': %s", pluginfile, g_strerror(errno));
-               return NULL;
-       }
-       if(fclose(plugin))
-       {
-               g_set_error(error, G_FILE_ERROR, errno, "Error closing '%s': %s", pluginfile, g_strerror(errno));
-               return NULL;
-       }
-       return dlname;
-}
-
-gboolean 
+/**
+ * chimara_if_run_game:
+ * @self: A #ChimaraIF widget.
+ * @gamefile: 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
+ * interpreter plugin. If there is more than one interpreter that supports the
+ * file format, the preferred one will be picked, according to
+ * chimara_if_set_preferred_interpreter().
+ *
+ * Returns: %TRUE if the game was started successfully, %FALSE if not, in which
+ * case @error is set.
+ */
+gboolean
 chimara_if_run_game(ChimaraIF *self, gchar *gamefile, GError **error)
 {
        g_return_val_if_fail(self && CHIMARA_IS_IF(self), FALSE);
        g_return_val_if_fail(gamefile, FALSE);
-       
+
        CHIMARA_IF_USE_PRIVATE(self, priv);
 
        /* Find out what format the game is */
@@ -227,48 +542,146 @@ chimara_if_run_game(ChimaraIF *self, gchar *gamefile, GError **error)
                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"))
                format = CHIMARA_IF_FORMAT_GLULX_BLORB;
-       
+
        /* Now decide what interpreter to use */
        ChimaraIFInterpreter interpreter = priv->preferred_interpreter[format];
-       gchar *libtoolfile = g_strconcat(plugin_names[interpreter], ".la", NULL);
-#ifndef RELEASE
+       gchar *pluginfile = g_strconcat(plugin_names[interpreter], "." G_MODULE_SUFFIX, NULL);
+
+       gchar *pluginpath;
+#ifdef DEBUG
+#ifndef LT_OBJDIR
+#define LT_OBJDIR ".libs" /* Pre-2.2 libtool, so take a wild guess */
+#endif /* LT_OBJDIR */
        /* If there is a plugin in the source tree, use that */
-       gboolean use_installed = FALSE;
-       gchar *libtoolpath = g_build_filename("..", "interpreters", plugin_names[interpreter], libtoolfile, NULL);
-       if( !g_file_test(libtoolpath, G_FILE_TEST_EXISTS) ) 
+       pluginpath = g_build_filename(PLUGINSOURCEDIR, plugin_names[interpreter], LT_OBJDIR, pluginfile, NULL);
+       if( !g_file_test(pluginpath, G_FILE_TEST_EXISTS) )
        {
-               g_free(libtoolpath);
-#endif
-               gchar *libtoolpath = g_build_filename(PLUGINDIR, libtoolfile, NULL);
-               if( !g_file_test(libtoolpath, G_FILE_TEST_EXISTS) ) 
+               g_free(pluginpath);
+#endif /* DEBUG */
+               pluginpath = g_build_filename(PLUGINDIR, pluginfile, NULL);
+               if( !g_file_test(pluginpath, G_FILE_TEST_EXISTS) )
                {
-                       g_free(libtoolpath);
-                       g_free(libtoolfile);
-                       g_warning("Cannot open %s plugin file", interpreter_names[interpreter]);
-                       /* TODO: set error */
+                       g_free(pluginpath);
+                       g_free(pluginfile);
+                       g_set_error(error, CHIMARA_ERROR, CHIMARA_PLUGIN_NOT_FOUND, _("No appropriate %s interpreter plugin was found"), interpreter_names[interpreter]);
                        return FALSE;
                }
-#ifndef RELEASE
-               use_installed = TRUE;
+#ifdef DEBUG
        }
 #endif
-       g_free(libtoolfile);
-       
-       gchar *dlname = find_dlname(libtoolpath, error);
-       g_free(libtoolpath);
-       if(!dlname)
-               return FALSE;
-       gchar *pluginpath;
-#ifndef RELEASE
-       if(use_installed)
-#endif
-               pluginpath = g_build_filename(PLUGINDIR, dlname, NULL);
-#ifndef RELEASE
-       else
-               pluginpath = g_build_filename("..", "interpreters", plugin_names[interpreter], LT_OBJDIR, dlname, NULL);
-#endif
-       char *argv[3] = { pluginpath, gamefile, NULL };
-       gboolean retval = chimara_glk_run(CHIMARA_GLK(self), pluginpath, 2, argv, error);
-       g_free(dlname);
+       g_free(pluginfile);
+
+       /* Decide what arguments to pass to the interpreters; currently only the
+       Z-machine interpreters accept command line arguments other than the game */
+       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:
+                       if(priv->flags & CHIMARA_IF_PIRACY_MODE)
+                               args = g_slist_prepend(args, "-P");
+                       if(priv->flags & CHIMARA_IF_TANDY_BIT)
+                               args = g_slist_prepend(args, "-t");
+                       if(priv->flags & CHIMARA_IF_EXPAND_ABBREVIATIONS)
+                               args = g_slist_prepend(args, "-x");
+                       if(priv->flags & CHIMARA_IF_IGNORE_ERRORS)
+                               args = g_slist_prepend(args, "-i");
+                       if(priv->interpreter_number != CHIMARA_IF_ZMACHINE_DEFAULT)
+                       {
+                               terpnumstr = g_strdup_printf("-I%u", priv->interpreter_number);
+                               args = g_slist_prepend(args, terpnumstr);
+                       }
+                       if(priv->random_seed_set)
+                       {
+                               randomstr = g_strdup_printf("-s%d", priv->random_seed);
+                               args = g_slist_prepend(args, randomstr);
+                       }
+                       break;
+               case CHIMARA_IF_INTERPRETER_NITFOL:
+                       if(priv->flags & CHIMARA_IF_PIRACY_MODE)
+                               args = g_slist_prepend(args, "-pirate");
+                       if(priv->flags & CHIMARA_IF_TANDY_BIT)
+                               args = g_slist_prepend(args, "-tandy");
+                       if(!(priv->flags & CHIMARA_IF_EXPAND_ABBREVIATIONS))
+                               args = g_slist_prepend(args, "-no-expand");
+                       if(priv->flags & CHIMARA_IF_IGNORE_ERRORS)
+                               args = g_slist_prepend(args, "-ignore");
+                       if(!(priv->flags & CHIMARA_IF_TYPO_CORRECTION))
+                               args = g_slist_prepend(args, "-no-spell");
+                       if(priv->interpreter_number != CHIMARA_IF_ZMACHINE_DEFAULT)
+                       {
+                               terpnumstr = g_strdup_printf("-terpnum%u", priv->interpreter_number);
+                               args = g_slist_prepend(args, terpnumstr);
+                       }
+                       if(priv->random_seed_set)
+                       {
+                               randomstr = g_strdup_printf("-random%d", priv->random_seed);
+                               args = g_slist_prepend(args, randomstr);
+                       }
+                       break;
+               default:
+                       ;
+       }
+
+       /* Allocate argv to hold the arguments */
+       int argc = g_slist_length(args);
+       args = g_slist_prepend(args, NULL);
+       char **argv = g_new0(char *, argc + 1);
+
+       /* Fill argv */
+       args = g_slist_reverse(args);
+       int count;
+       GSList *ptr;
+       for(count = 0, ptr = args; ptr; count++, ptr = g_slist_next(ptr))
+               argv[count] = ptr->data;
+
+       gboolean retval = chimara_glk_run(CHIMARA_GLK(self), pluginpath, argc, argv, error);
+       g_free(argv);
+       if(terpnumstr)
+               g_free(terpnumstr);
+       if(randomstr)
+               g_free(randomstr);
+       g_free(pluginpath);
+
+       /* Set current format and interpreter if plugin was started successfully */
+       if(retval)
+       {
+               priv->format = format;
+               priv->interpreter = interpreter;
+       }
        return retval;
 }
+
+/**
+ * chimara_if_get_format:
+ * @self: A #ChimaraIF widget.
+ *
+ * Returns the file format of the currently running game.
+ *
+ * Returns: a #ChimaraIFFormat constant.
+ */
+ChimaraIFFormat
+chimara_if_get_format(ChimaraIF *self)
+{
+       g_return_val_if_fail(self && CHIMARA_IS_IF(self), CHIMARA_IF_FORMAT_NONE);
+       CHIMARA_IF_USE_PRIVATE(self, priv);
+       return priv->format;
+}
+
+/**
+ * chimara_if_get_interpreter:
+ * @self: A #ChimaraIF widget.
+ *
+ * Returns the interpreter plugin currently running.
+ *
+ * Returns: a #ChimaraIFInterpreter constant.
+ */
+ChimaraIFInterpreter
+chimara_if_get_interpreter(ChimaraIF *self)
+{
+       g_return_val_if_fail(self && CHIMARA_IS_IF(self), CHIMARA_IF_FORMAT_NONE);
+       CHIMARA_IF_USE_PRIVATE(self, priv);
+       return priv->interpreter;
+}