0d9979741a819385b2131dc046c971ace2bc2b65
[projects/chimara/chimara.git] / libchimara / chimara-if.c
1 #include <errno.h>
2 #include <stdlib.h>
3 #include <glib.h>
4 #include <glib-object.h>
5 #include <config.h>
6 #include <glib/gi18n-lib.h>
7 #include "chimara-if.h"
8 #include "chimara-glk.h"
9 #include "chimara-glk-private.h"
10 #include "chimara-marshallers.h"
11 #include "init.h"
12
13 #ifndef PLUGINDIR
14 #define PLUGINDIR "."
15 #endif
16
17 /**
18  * SECTION:chimara-if
19  * @short_description: Widget which plays an interactive fiction game
20  * @stability: Unstable
21  *
22  * The #ChimaraIF widget, given an interactive fiction game file to run, selects
23  * an appropriate interpreter plugin and runs it. Interpreter options are set by
24  * setting properties on the widget.
25  *
26  * Using it in a GTK program is similar to using #ChimaraGlk (which see). 
27  * Threads must be initialized before using #ChimaraIF and the call to 
28  * gtk_main() must be bracketed between gdk_threads_enter() and 
29  * gdk_threads_leave(). Use chimara_if_run_game() to start playing an
30  * interactive fiction game.
31  */
32
33 static gboolean supported_formats[CHIMARA_IF_NUM_FORMATS][CHIMARA_IF_NUM_INTERPRETERS] = {
34         /* Frotz Nitfol Glulxe Git    Bocfel */
35         { TRUE,  TRUE,  FALSE, FALSE, TRUE  }, /* Z5 */
36         { TRUE,  TRUE,  FALSE, FALSE, TRUE  }, /* Z6 */
37         { TRUE,  TRUE,  FALSE, FALSE, TRUE  }, /* Z8 */
38         { TRUE,  TRUE,  FALSE, FALSE, TRUE  }, /* Zblorb */
39         { FALSE, FALSE, TRUE,  TRUE,  FALSE }, /* Glulx */
40         { FALSE, FALSE, TRUE,  TRUE,  FALSE }  /* Gblorb */
41 };
42 static gchar *format_names[CHIMARA_IF_NUM_FORMATS] = {
43         N_("Z-code version 5"),
44         N_("Z-code version 6"),
45         N_("Z-code version 8"),
46         N_("Blorbed Z-code"),
47         N_("Glulx"),
48         N_("Blorbed Glulx")
49 };
50 static gchar *interpreter_names[CHIMARA_IF_NUM_INTERPRETERS] = {
51         N_("Frotz"), N_("Nitfol"), N_("Glulxe"), N_("Git"), N_("Bocfel")
52 };
53 static gchar *plugin_names[CHIMARA_IF_NUM_INTERPRETERS] = {
54         "frotz", "nitfol", "glulxe", "git", "bocfel"
55 };
56
57 typedef enum _ChimaraIFFlags {
58         CHIMARA_IF_PIRACY_MODE = 1 << 0,
59         CHIMARA_IF_TANDY_BIT = 1 << 1,
60         CHIMARA_IF_EXPAND_ABBREVIATIONS = 1 << 2,
61         CHIMARA_IF_IGNORE_ERRORS = 1 << 3,
62         CHIMARA_IF_TYPO_CORRECTION = 1 << 4
63 } ChimaraIFFlags;
64
65 typedef struct _ChimaraIFPrivate {
66         ChimaraIFInterpreter preferred_interpreter[CHIMARA_IF_NUM_FORMATS];
67         ChimaraIFFormat format;
68         ChimaraIFInterpreter interpreter;
69         ChimaraIFFlags flags;
70         ChimaraIFZmachineVersion interpreter_number;
71         gint random_seed;
72         gboolean random_seed_set;
73         gchar *graphics_file;
74         /* Holding buffers for input and response */
75         gchar *input;
76         GString *response;
77 } ChimaraIFPrivate;
78
79 #define CHIMARA_IF_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), CHIMARA_TYPE_IF, ChimaraIFPrivate))
80 #define CHIMARA_IF_USE_PRIVATE(o, n) ChimaraIFPrivate *n = CHIMARA_IF_PRIVATE(o)
81
82 enum {
83         PROP_0,
84         PROP_PIRACY_MODE,
85         PROP_TANDY_BIT,
86         PROP_EXPAND_ABBREVIATIONS,
87         PROP_IGNORE_ERRORS,
88         PROP_TYPO_CORRECTION,
89         PROP_INTERPRETER_NUMBER,
90         PROP_RANDOM_SEED,
91         PROP_RANDOM_SEED_SET,
92         PROP_GRAPHICS_FILE
93 };
94
95 enum {
96         COMMAND,
97         LAST_SIGNAL
98 };
99
100 static guint chimara_if_signals[LAST_SIGNAL] = { 0 };
101
102 G_DEFINE_TYPE(ChimaraIF, chimara_if, CHIMARA_TYPE_GLK);
103
104 static void
105 chimara_if_waiting(ChimaraGlk *glk)
106 {
107         CHIMARA_IF_USE_PRIVATE(glk, priv);
108
109         gchar *response = g_string_free(priv->response, FALSE);
110         priv->response = g_string_new("");
111
112         gdk_threads_enter();
113         g_signal_emit_by_name(glk, "command", priv->input, response);
114         gdk_threads_leave();
115
116         g_free(priv->input);
117         g_free(response);
118         priv->input = NULL;
119 }
120
121 static void
122 chimara_if_stopped(ChimaraGlk *glk)
123 {
124         CHIMARA_IF_USE_PRIVATE(glk, priv);
125
126         if(priv->input || priv->response->len > 0)
127                 chimara_if_waiting(glk); /* Send one last command signal */
128
129         priv->format = CHIMARA_IF_FORMAT_NONE;
130         priv->interpreter = CHIMARA_IF_INTERPRETER_NONE;
131 }
132
133 static void
134 chimara_if_char_input(ChimaraGlk *glk, guint32 win_rock, guint keysym)
135 {
136         CHIMARA_IF_USE_PRIVATE(glk, priv);
137         g_assert(priv->input == NULL);
138
139         gchar outbuf[6];
140         gint outbuflen = g_unichar_to_utf8(gdk_keyval_to_unicode(keysym), outbuf);
141         priv->input = g_strndup(outbuf, outbuflen);
142 }
143
144 static void
145 chimara_if_line_input(ChimaraGlk *glk, guint32 win_rock, gchar *input)
146 {
147         CHIMARA_IF_USE_PRIVATE(glk, priv);
148         g_assert(priv->input == NULL);
149         priv->input = g_strdup(input);
150 }
151
152 static void
153 chimara_if_text_buffer_output(ChimaraGlk *glk, guint32 win_rock, gchar *output)
154 {
155         CHIMARA_IF_USE_PRIVATE(glk, priv);
156         g_string_append(priv->response, output);
157 }
158
159 static void
160 chimara_if_init(ChimaraIF *self)
161 {
162         chimara_init(); /* This is a library entry point */
163
164         CHIMARA_IF_USE_PRIVATE(self, priv);
165         priv->preferred_interpreter[CHIMARA_IF_FORMAT_Z5] = CHIMARA_IF_INTERPRETER_FROTZ;
166         priv->preferred_interpreter[CHIMARA_IF_FORMAT_Z6] = CHIMARA_IF_INTERPRETER_NITFOL;
167         priv->preferred_interpreter[CHIMARA_IF_FORMAT_Z8] = CHIMARA_IF_INTERPRETER_FROTZ;
168         priv->preferred_interpreter[CHIMARA_IF_FORMAT_Z_BLORB] = CHIMARA_IF_INTERPRETER_FROTZ;
169         priv->preferred_interpreter[CHIMARA_IF_FORMAT_GLULX] = CHIMARA_IF_INTERPRETER_GLULXE;
170         priv->preferred_interpreter[CHIMARA_IF_FORMAT_GLULX_BLORB] = CHIMARA_IF_INTERPRETER_GLULXE;
171         priv->format = CHIMARA_IF_FORMAT_NONE;
172         priv->interpreter = CHIMARA_IF_INTERPRETER_NONE;
173         priv->flags = CHIMARA_IF_TYPO_CORRECTION;
174         priv->interpreter_number = CHIMARA_IF_ZMACHINE_DEFAULT;
175         priv->response = g_string_new("");
176
177         /* Connect to signals of ChimaraGlk parent */
178         g_signal_connect(self, "stopped", G_CALLBACK(chimara_if_stopped), NULL);
179         g_signal_connect(self, "waiting", G_CALLBACK(chimara_if_waiting), NULL);
180         g_signal_connect(self, "char-input", G_CALLBACK(chimara_if_char_input), NULL);
181         g_signal_connect(self, "line-input", G_CALLBACK(chimara_if_line_input), NULL);
182         g_signal_connect(self, "text-buffer-output", G_CALLBACK(chimara_if_text_buffer_output), NULL);
183 }
184
185 #define PROCESS_FLAG(flags, flag, val) (flags) = (val)? (flags) | (flag) : (flags) & ~(flag)
186
187 static void
188 chimara_if_set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
189 {
190         CHIMARA_IF_USE_PRIVATE(object, priv);
191     switch(prop_id)
192     {
193         case PROP_PIRACY_MODE:
194                 PROCESS_FLAG(priv->flags, CHIMARA_IF_PIRACY_MODE, g_value_get_boolean(value));
195                 g_object_notify(object, "piracy-mode");
196                 break;
197         case PROP_TANDY_BIT:
198                 PROCESS_FLAG(priv->flags, CHIMARA_IF_TANDY_BIT, g_value_get_boolean(value));
199                 g_object_notify(object, "tandy-bit");
200                 break;
201         case PROP_EXPAND_ABBREVIATIONS:
202                 PROCESS_FLAG(priv->flags, CHIMARA_IF_EXPAND_ABBREVIATIONS, g_value_get_boolean(value));
203                 g_object_notify(object, "expand-abbreviations");
204                 break;
205         case PROP_IGNORE_ERRORS:
206                 PROCESS_FLAG(priv->flags, CHIMARA_IF_IGNORE_ERRORS, g_value_get_boolean(value));
207                 g_object_notify(object, "ignore-errors");
208                 break;
209         case PROP_TYPO_CORRECTION:
210                 PROCESS_FLAG(priv->flags, CHIMARA_IF_TYPO_CORRECTION, g_value_get_boolean(value));
211                 g_object_notify(object, "typo-correction");
212                 break;
213         case PROP_INTERPRETER_NUMBER:
214                 priv->interpreter_number = g_value_get_uint(value);
215                 g_object_notify(object, "interpreter-number");
216                 break;
217         case PROP_RANDOM_SEED:
218                 priv->random_seed = g_value_get_int(value);
219                 g_object_notify(object, "random-seed");
220                 break;
221         case PROP_RANDOM_SEED_SET:
222                 priv->random_seed_set = g_value_get_boolean(value);
223                 g_object_notify(object, "random-seed-set");
224                 break;
225                 case PROP_GRAPHICS_FILE:
226                         priv->graphics_file = g_strdup(g_value_get_string(value));
227                         g_object_notify(object, "graphics-file");
228                         break;
229         default:
230             G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
231     }
232 }
233
234 static void
235 chimara_if_get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
236 {
237         CHIMARA_IF_USE_PRIVATE(object, priv);
238     switch(prop_id)
239     {
240         case PROP_PIRACY_MODE:
241                 g_value_set_boolean(value, priv->flags & CHIMARA_IF_PIRACY_MODE);
242                 break;
243         case PROP_TANDY_BIT:
244                 g_value_set_boolean(value, priv->flags & CHIMARA_IF_TANDY_BIT);
245                 break;
246         case PROP_EXPAND_ABBREVIATIONS:
247                 g_value_set_boolean(value, priv->flags & CHIMARA_IF_EXPAND_ABBREVIATIONS);
248                 break;
249         case PROP_IGNORE_ERRORS:
250                 g_value_set_boolean(value, priv->flags & CHIMARA_IF_IGNORE_ERRORS);
251                 break;
252         case PROP_TYPO_CORRECTION:
253                 g_value_set_boolean(value, priv->flags & CHIMARA_IF_TYPO_CORRECTION);
254                 break;
255         case PROP_INTERPRETER_NUMBER:
256                 g_value_set_uint(value, priv->interpreter_number);
257                 break;
258         case PROP_RANDOM_SEED:
259                 g_value_set_int(value, priv->random_seed);
260                 break;
261         case PROP_RANDOM_SEED_SET:
262                 g_value_set_boolean(value, priv->random_seed_set);
263                 break;
264                 case PROP_GRAPHICS_FILE:
265                         g_value_set_string(value, priv->graphics_file);
266                         break;
267         default:
268             G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
269     }
270 }
271
272 static void
273 chimara_if_finalize(GObject *object)
274 {
275         CHIMARA_IF_USE_PRIVATE(object, priv);
276         g_free(priv->graphics_file);
277     G_OBJECT_CLASS(chimara_if_parent_class)->finalize(object);
278 }
279
280 static void
281 chimara_if_class_init(ChimaraIFClass *klass)
282 {
283         /* Override methods of parent classes */
284         GObjectClass *object_class = G_OBJECT_CLASS(klass);
285         object_class->set_property = chimara_if_set_property;
286         object_class->get_property = chimara_if_get_property;
287         object_class->finalize = chimara_if_finalize;
288
289         /* Signals */
290         /**
291          * ChimaraIF::command:
292          * @self: The widget that received the signal
293          * @input: The command typed into the game, or %NULL
294          * @response: The game's response to the command
295          *
296          * Emitted once for each input-response cycle of an interactive fiction
297          * game. Note that games with nontraditional input systems (i.e. not all
298          * taking place in the same text buffer window) may confuse this signal.
299          *
300          * It may happen that @input is %NULL, in which case @response is not due to
301          * a user command, but contains the text printed at the beginning of the
302          * game, up until the first prompt.
303          */
304         chimara_if_signals[COMMAND] = g_signal_new("command",
305                 G_OBJECT_CLASS_TYPE(klass), 0,
306                 G_STRUCT_OFFSET(ChimaraIFClass, command), NULL, NULL,
307                 _chimara_marshal_VOID__STRING_STRING,
308                 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_STRING);
309
310         /* Properties */
311         /**
312          * ChimaraIF:piracy-mode:
313          *
314          * The Z-machine specification defines a facility for games to ask the
315          * interpreter they are running on whether this copy of the game is pirated.
316          * How the interpreter is supposed to magically determine that it is running
317          * pirate software is unclear, and so the majority of games and interpreters
318          * ignore this feature. Set this property to %TRUE if you want the
319          * interpreter to pretend it has detected a pirated game.
320          *
321          * Only affects Z-machine interpreters.
322          */
323         g_object_class_install_property(object_class, PROP_PIRACY_MODE,
324                 g_param_spec_boolean("piracy-mode", _("Piracy mode"),
325                 _("Pretend the game is pirated"), FALSE,
326                 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS));
327         /**
328          * ChimaraIF:tandy-bit:
329          *
330          * Some early Infocom games were sold by the Tandy Corporation. Setting this
331          * property to %TRUE changes the wording of some Version 3 Infocom games
332          * slightly, so as to be less offensive. See <ulink
333          * url="http://www.ifarchive.org/if-archive/infocom/info/tandy_bits.html">
334          * http://www.ifarchive.org/if-archive/infocom/info/tandy_bits.html</ulink>.
335          *
336          * Only affects Z-machine interpreters.
337          */
338         g_object_class_install_property(object_class, PROP_TANDY_BIT,
339                 g_param_spec_boolean("tandy-bit", _("Tandy bit"),
340                 _("Censor certain Infocom games"), FALSE,
341                 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS));
342         /**
343          * ChimaraIF:expand-abbreviations:
344          *
345          * Most Z-machine games, in particular ones compiled with the Inform
346          * library, support the following one-letter abbreviations:
347          * <simplelist>
348          * <member>D &mdash; Down</member>
349          * <member>E &mdash; East</member>
350          * <member>G &mdash; aGain</member>
351          * <member>I &mdash; Inventory</member>
352          * <member>L &mdash; Look</member>
353          * <member>N &mdash; North</member>
354          * <member>O &mdash; Oops</member>
355          * <member>Q &mdash; Quit</member>
356          * <member>S &mdash; South</member>
357          * <member>U &mdash; Up</member>
358          * <member>W &mdash; West</member>
359          * <member>X &mdash; eXamine</member>
360          * <member>Y &mdash; Yes</member>
361          * <member>Z &mdash; wait (ZZZZ...)</member>
362          * </simplelist>
363          * Some early Infocom games might not recognize these abbreviations. Setting
364          * this property to %TRUE will cause the interpreter to expand the
365          * abbreviations to the full words before passing the commands on to the
366          * game. Frotz only expands G, X, and Z; Nitfol expands all of the above
367          * plus the following nonstandard ones:
368          * <simplelist>
369          * <member>C &mdash; Close</member>
370          * <member>K &mdash; attacK</member>
371          * <member>P &mdash; oPen</member>
372          * <member>R &mdash; dRop</member>
373          * <member>T &mdash; Take</member>
374          * </simplelist>
375          *
376          * Only affects Z-machine interpreters. Behaves differently on Frotz and
377          * Nitfol.
378          */
379         g_object_class_install_property(object_class, PROP_EXPAND_ABBREVIATIONS,
380                 g_param_spec_boolean("expand-abbreviations", _("Expand abbreviations"),
381                 _("Expand abbreviations such as X for EXAMINE"), FALSE,
382                 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS));
383         /**
384          * ChimaraIF:ignore-errors:
385          *
386          * Setting this property to %TRUE will cause the interpreter to ignore
387          * certain Z-machine runtime errors. Frotz will ignore any fatal errors.
388          * Nitfol by default warns about any shady behavior, and this property will
389          * turn those warnings off.
390          *
391          * Only affects Z-machine interpreters. Behaves differently on Frotz and
392          * Nitfol.
393          */
394         g_object_class_install_property(object_class, PROP_IGNORE_ERRORS,
395                 g_param_spec_boolean("ignore-errors", _("Ignore errors"),
396                 _("Do not warn the user about Z-machine errors"), FALSE,
397                 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS));
398         /**
399          * ChimaraIF:typo-correction:
400          *
401          * Nitfol has an automatic typo-correction facility, where it searches the
402          * game dictionary for words which differ by one letter from any unknown
403          * input words. Set this property to %FALSE to turn this feature off.
404          *
405          * Only affects Nitfol.
406          */
407         g_object_class_install_property(object_class, PROP_TYPO_CORRECTION,
408                 g_param_spec_boolean("typo-correction", _("Typo correction"),
409                 _("Try to remedy typos if the interpreter supports it"), TRUE,
410                 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS));
411         /**
412          * ChimaraIF:interpreter-number:
413          *
414          * Infocom gave each port of their interpreter a different number. The Frotz
415          * and Nitfol plugins can emulate any of these platforms. Some games behave
416          * slightly differently depending on what platform they are on. Set this
417          * property to a #ChimaraIFZmachineVersion value to emulate a certain
418          * platform.
419          *
420          * Note that Nitfol pretends to be an Apple IIe by default.
421          *
422          * Only affects Z-machine interpreters.
423          */
424         g_object_class_install_property(object_class, PROP_INTERPRETER_NUMBER,
425                 g_param_spec_uint("interpreter-number", _("Interpreter number"),
426                 _("Platform the Z-machine should pretend it is running on"),
427                 CHIMARA_IF_ZMACHINE_DEFAULT, CHIMARA_IF_ZMACHINE_MAXVAL, CHIMARA_IF_ZMACHINE_DEFAULT,
428                 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS));
429         /**
430          * ChimaraIF:random-seed:
431          *
432          * If the #ChimaraIF:random-seed-set property is %TRUE, then the interpreter
433          * will use the value of this property as a seed for the random number
434          * generator. Use this feature to duplicate sequences of random numbers
435          * for testing games.
436          *
437          * Note that the value -1 is a valid random number seed for
438          * Nitfol, whereas it will cause Frotz to pick an arbitrary seed even when
439          * #ChimaraIF:random-seed-set is %TRUE.
440          *
441          * Only affects Z-machine interpreters. Behaves slightly differently on
442          * Frotz and Nitfol.
443          */
444         g_object_class_install_property(object_class, PROP_RANDOM_SEED,
445                 g_param_spec_int("random-seed", _("Random seed"),
446                 _("Seed for the random number generator"), G_MININT, G_MAXINT, 0,
447                 G_PARAM_READWRITE | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS));
448         /**
449          * ChimaraIF:random-seed-set:
450          *
451          * Whether to use or ignore the #ChimaraIF:random-seed property.
452          *
453          * Only affects Z-machine interpreters.
454          */
455         g_object_class_install_property(object_class, PROP_RANDOM_SEED_SET,
456                 g_param_spec_boolean("random-seed-set", _("Random seed set"),
457                 _("Whether the seed for the random number generator should be set manually"), FALSE,
458                 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS));
459         /**
460          * ChimaraIF:graphics-file:
461          *
462          * Some Z-machine interpreters accept an extra argument that indicates a
463          * separate Blorb file containing graphics and sound resources. The
464          * interpreter will check if the file specified in this property really
465          * exists, and if so, use it as a resource file. If this property is set to 
466          * %NULL, the interpreter will not look for an extra file.
467          *
468          * Only affects Frotz and Nitfol.
469          */
470         g_object_class_install_property(object_class, PROP_GRAPHICS_FILE,
471             g_param_spec_string("graphics-file", _("Graphics file"),
472             _("Location in which to look for a separate graphics Blorb file"), NULL,
473             G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS));
474         /* Private data */
475         g_type_class_add_private(klass, sizeof(ChimaraIFPrivate));
476 }
477
478 /* PUBLIC FUNCTIONS */
479
480 /**
481  * chimara_if_new:
482  *
483  * Creates and initializes a new #ChimaraIF widget.
484  *
485  * Return value: a #ChimaraIF widget, with a floating reference.
486  */
487 GtkWidget *
488 chimara_if_new(void)
489 {
490         /* This is a library entry point; initialize the library */
491         chimara_init();
492     return GTK_WIDGET(g_object_new(CHIMARA_TYPE_IF, NULL));
493 }
494
495 /**
496  * chimara_if_set_preferred_interpreter:
497  * @self: A #ChimaraIF widget.
498  * @format: The game format to set the preferred interpreter plugin for.
499  * @interpreter: The preferred interpreter plugin for @format.
500  *
501  * The function chimara_if_run_game() picks an appropriate interpreter for the
502  * type of game file it is given. This function sets which interpreter is picked
503  * for a certain game file format. Most formats, notably the Z-machine, have
504  * had many different interpreters written for them over the years, all with
505  * slightly different quirks and capabilities, so there is plenty of choice.
506  */
507 void
508 chimara_if_set_preferred_interpreter(ChimaraIF *self, ChimaraIFFormat format, ChimaraIFInterpreter interpreter)
509 {
510         g_return_if_fail(self && CHIMARA_IS_IF(self));
511         g_return_if_fail(format < CHIMARA_IF_NUM_FORMATS);
512         g_return_if_fail(interpreter < CHIMARA_IF_NUM_INTERPRETERS);
513
514         CHIMARA_IF_USE_PRIVATE(self, priv);
515
516         if(supported_formats[format][interpreter])
517                 priv->preferred_interpreter[format] = interpreter;
518         else
519                 g_warning("Format '%s' is not supported by interpreter '%s'", format_names[format], interpreter_names[interpreter]);
520 }
521
522 /**
523  * chimara_if_get_preferred_interpreter:
524  * @self: A #ChimaraIF widget.
525  * @format: The game format to query the preferred interpreter plugin for.
526  *
527  * Looks up the preferred interpreter for the game file format @format. See
528  * chimara_if_set_preferred_interpreter().
529  *
530  * Returns: a #ChimaraIFInterpreter value representing the preferred interpreter
531  * plugin for @format.
532  */
533 ChimaraIFInterpreter
534 chimara_if_get_preferred_interpreter(ChimaraIF *self, ChimaraIFFormat format)
535 {
536         g_return_val_if_fail(self && CHIMARA_IS_IF(self), -1);
537         g_return_val_if_fail(format < CHIMARA_IF_NUM_FORMATS, -1);
538         CHIMARA_IF_USE_PRIVATE(self, priv);
539         return priv->preferred_interpreter[format];
540 }
541
542 /**
543  * chimara_if_run_game:
544  * @self: A #ChimaraIF widget.
545  * @game_path: Path to an interactive fiction game file.
546  * @error: Return location for an error, or %NULL.
547  *
548  * Autodetects the type of a game file and runs it using an appropriate
549  * interpreter plugin. If there is more than one interpreter that supports the
550  * file format, the preferred one will be picked, according to
551  * chimara_if_set_preferred_interpreter().
552  *
553  * Returns: %TRUE if the game was started successfully, %FALSE if not, in which
554  * case @error is set.
555  */
556 gboolean
557 chimara_if_run_game(ChimaraIF *self, const char *game_path, GError **error)
558 {
559         g_return_val_if_fail(self && CHIMARA_IS_IF(self), FALSE);
560         g_return_val_if_fail(game_path, FALSE);
561         g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
562
563         CHIMARA_IF_USE_PRIVATE(self, priv);
564
565         /* Find out what format the game is */
566         /* TODO: Look inside the file instead of just looking at the extension */
567         ChimaraIFFormat format = CHIMARA_IF_FORMAT_Z5;
568         if(g_str_has_suffix(game_path, ".z5"))
569                 format = CHIMARA_IF_FORMAT_Z5;
570         else if(g_str_has_suffix(game_path, ".z6"))
571                 format = CHIMARA_IF_FORMAT_Z6;
572         else if(g_str_has_suffix(game_path, ".z8"))
573                 format = CHIMARA_IF_FORMAT_Z8;
574         else if(g_str_has_suffix(game_path, ".zlb") || g_str_has_suffix(game_path, ".zblorb"))
575                 format = CHIMARA_IF_FORMAT_Z_BLORB;
576         else if(g_str_has_suffix(game_path, ".ulx"))
577                 format = CHIMARA_IF_FORMAT_GLULX;
578         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"))
579                 format = CHIMARA_IF_FORMAT_GLULX_BLORB;
580
581         /* Now decide what interpreter to use */
582         ChimaraIFInterpreter interpreter = priv->preferred_interpreter[format];
583         gchar *pluginfile = g_strconcat(plugin_names[interpreter], "." G_MODULE_SUFFIX, NULL);
584
585         gchar *pluginpath;
586 #ifdef DEBUG
587 #ifndef LT_OBJDIR
588 #define LT_OBJDIR ".libs" /* Pre-2.2 libtool, so take a wild guess */
589 #endif /* LT_OBJDIR */
590         /* If there is a plugin in the source tree, use that */
591         pluginpath = g_build_filename(PLUGINSOURCEDIR, plugin_names[interpreter], LT_OBJDIR, pluginfile, NULL);
592         if( !g_file_test(pluginpath, G_FILE_TEST_EXISTS) )
593         {
594                 g_free(pluginpath);
595 #endif /* DEBUG */
596                 pluginpath = g_build_filename(PLUGINDIR, pluginfile, NULL);
597                 if( !g_file_test(pluginpath, G_FILE_TEST_EXISTS) )
598                 {
599                         g_free(pluginpath);
600                         g_free(pluginfile);
601                         g_set_error(error, CHIMARA_ERROR, CHIMARA_PLUGIN_NOT_FOUND, _("No appropriate %s interpreter plugin was found"), interpreter_names[interpreter]);
602                         return FALSE;
603                 }
604 #ifdef DEBUG
605         }
606 #endif
607         g_free(pluginfile);
608
609         /* Decide what arguments to pass to the interpreters; currently only the
610         Z-machine interpreters accept command line arguments other than the game */
611         GSList *args = NULL;
612         gchar *terpnumstr = NULL, *randomstr = NULL;
613         args = g_slist_prepend(args, pluginpath);
614         switch(interpreter)
615         {
616                 case CHIMARA_IF_INTERPRETER_FROTZ:
617                         if(priv->flags & CHIMARA_IF_PIRACY_MODE)
618                                 args = g_slist_prepend(args, "-P");
619                         if(priv->flags & CHIMARA_IF_TANDY_BIT)
620                                 args = g_slist_prepend(args, "-t");
621                         if(priv->flags & CHIMARA_IF_EXPAND_ABBREVIATIONS)
622                                 args = g_slist_prepend(args, "-x");
623                         if(priv->flags & CHIMARA_IF_IGNORE_ERRORS)
624                                 args = g_slist_prepend(args, "-i");
625                         if(priv->interpreter_number != CHIMARA_IF_ZMACHINE_DEFAULT)
626                         {
627                                 terpnumstr = g_strdup_printf("-I%u", priv->interpreter_number);
628                                 args = g_slist_prepend(args, terpnumstr);
629                         }
630                         if(priv->random_seed_set)
631                         {
632                                 randomstr = g_strdup_printf("-s%d", priv->random_seed);
633                                 args = g_slist_prepend(args, randomstr);
634                         }
635                         break;
636                 case CHIMARA_IF_INTERPRETER_NITFOL:
637                         if(priv->flags & CHIMARA_IF_PIRACY_MODE)
638                                 args = g_slist_prepend(args, "-pirate");
639                         if(priv->flags & CHIMARA_IF_TANDY_BIT)
640                                 args = g_slist_prepend(args, "-tandy");
641                         if(!(priv->flags & CHIMARA_IF_EXPAND_ABBREVIATIONS))
642                                 args = g_slist_prepend(args, "-no-expand");
643                         if(priv->flags & CHIMARA_IF_IGNORE_ERRORS)
644                                 args = g_slist_prepend(args, "-ignore");
645                         if(!(priv->flags & CHIMARA_IF_TYPO_CORRECTION))
646                                 args = g_slist_prepend(args, "-no-spell");
647                         if(priv->interpreter_number != CHIMARA_IF_ZMACHINE_DEFAULT)
648                         {
649                                 terpnumstr = g_strdup_printf("-terpnum%u", priv->interpreter_number);
650                                 args = g_slist_prepend(args, terpnumstr);
651                         }
652                         if(priv->random_seed_set)
653                         {
654                                 randomstr = g_strdup_printf("-random%d", priv->random_seed);
655                                 args = g_slist_prepend(args, randomstr);
656                         }
657                         break;
658                 default:
659                         ;
660         }
661
662         /* Game file and external blorb file */
663         args = g_slist_prepend(args, (gpointer)game_path);
664         if(priv->graphics_file
665                 && (interpreter == CHIMARA_IF_INTERPRETER_FROTZ || interpreter == CHIMARA_IF_INTERPRETER_NITFOL)
666             && g_file_test(priv->graphics_file, G_FILE_TEST_EXISTS)) {
667                 args = g_slist_prepend(args, priv->graphics_file);
668         }
669
670         /* Allocate argv to hold the arguments */
671         int argc = g_slist_length(args);
672         args = g_slist_prepend(args, NULL);
673         char **argv = g_new0(char *, argc + 1);
674
675         /* Fill argv */
676         args = g_slist_reverse(args);
677         int count;
678         GSList *ptr;
679         for(count = 0, ptr = args; ptr; count++, ptr = g_slist_next(ptr))
680                 argv[count] = g_strdup(ptr->data);
681
682         /* Set the story name */
683         /* We peek into ChimaraGlk's private data here, because GObject has no
684         equivalent to "protected" */
685         CHIMARA_GLK_USE_PRIVATE(self, glk_priv);
686         glk_priv->story_name = g_path_get_basename(game_path);
687         g_object_notify(G_OBJECT(self), "story-name");
688         
689         gboolean retval = chimara_glk_run(CHIMARA_GLK(self), pluginpath, argc, argv, error);
690         g_strfreev(argv);
691         if(terpnumstr)
692                 g_free(terpnumstr);
693         if(randomstr)
694                 g_free(randomstr);
695         g_free(pluginpath);
696
697         /* Set current format and interpreter if plugin was started successfully */
698         if(retval)
699         {
700                 priv->format = format;
701                 priv->interpreter = interpreter;
702         }
703         return retval;
704 }
705
706 /**
707  * chimara_if_run_game_file:
708  * @self: A #ChimaraIF widget.
709  * @game_file: a #GFile pointing to an interactive fiction game file.
710  * @error: Return location for an error, or %NULL.
711  *
712  * Autodetects the type of a game file and runs it using an appropriate
713  * interpreter plugin. See chimara_if_run_game() for more information.
714  *
715  * Returns: %TRUE if the game was started successfully, %FALSE if not, in which
716  * case @error is set.
717  */
718 gboolean
719 chimara_if_run_game_file(ChimaraIF *self, GFile *game_file, GError **error)
720 {
721         g_return_val_if_fail(self || CHIMARA_IS_IF(self), FALSE);
722         g_return_val_if_fail(game_file || G_IS_FILE(game_file), FALSE);
723         g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
724
725         char *path = g_file_get_path(game_file);
726         gboolean retval = chimara_if_run_game(self, path, error);
727         g_free(path);
728         return retval;
729 }
730
731 /**
732  * chimara_if_get_format:
733  * @self: A #ChimaraIF widget.
734  *
735  * Returns the file format of the currently running game.
736  *
737  * Returns: a #ChimaraIFFormat constant.
738  */
739 ChimaraIFFormat
740 chimara_if_get_format(ChimaraIF *self)
741 {
742         g_return_val_if_fail(self && CHIMARA_IS_IF(self), CHIMARA_IF_FORMAT_NONE);
743         CHIMARA_IF_USE_PRIVATE(self, priv);
744         return priv->format;
745 }
746
747 /**
748  * chimara_if_get_interpreter:
749  * @self: A #ChimaraIF widget.
750  *
751  * Returns the interpreter plugin currently running.
752  *
753  * Returns: a #ChimaraIFInterpreter constant.
754  */
755 ChimaraIFInterpreter
756 chimara_if_get_interpreter(ChimaraIF *self)
757 {
758         g_return_val_if_fail(self && CHIMARA_IS_IF(self), CHIMARA_IF_FORMAT_NONE);
759         CHIMARA_IF_USE_PRIVATE(self, priv);
760         return priv->interpreter;
761 }