6 #include <glib/gstdio.h>
7 #include <glib/gi18n-lib.h>
10 #include "chimara-glk-private.h"
13 extern GPrivate *glk_data_key;
15 /* Internal function: create a fileref using the given parameters. */
17 fileref_new(gchar *filename, glui32 rock, glui32 usage, glui32 orig_filemode)
19 g_return_val_if_fail(filename != NULL, NULL);
21 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
23 frefid_t f = g_new0(struct glk_fileref_struct, 1);
24 f->magic = MAGIC_FILEREF;
26 if(glk_data->register_obj)
27 f->disprock = (*glk_data->register_obj)(f, gidisp_Class_Fileref);
29 f->filename = g_strdup(filename);
31 f->orig_filemode = orig_filemode;
33 /* Add it to the global fileref list */
34 glk_data->fileref_list = g_list_prepend(glk_data->fileref_list, f);
35 f->fileref_list = glk_data->fileref_list;
41 fileref_close_common(frefid_t fref)
43 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
45 glk_data->fileref_list = g_list_delete_link(glk_data->fileref_list, fref->fileref_list);
47 if(glk_data->unregister_obj)
49 (*glk_data->unregister_obj)(fref, gidisp_Class_Fileref, fref->disprock);
50 fref->disprock.ptr = NULL;
54 g_free(fref->filename);
56 fref->magic = MAGIC_FREE;
61 * glk_fileref_iterate:
62 * @fref: A file reference, or %NULL.
63 * @rockptr: Return location for the next fileref's rock, or %NULL.
65 * Iterates through all the existing filerefs. See <link
66 * linkend="chimara-Iterating-Through-Opaque-Objects">Iterating Through Opaque
69 * Returns: the next file reference, or %NULL if there are no more.
72 glk_fileref_iterate(frefid_t fref, glui32 *rockptr)
74 VALID_FILEREF_OR_NULL(fref, return NULL);
76 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
80 retnode = glk_data->fileref_list;
82 retnode = fref->fileref_list->next;
83 frefid_t retval = retnode? (frefid_t)retnode->data : NULL;
85 /* Store the fileref's rock in rockptr */
87 *rockptr = glk_fileref_get_rock(retval);
93 * glk_fileref_get_rock:
94 * @fref: A file reference.
96 * Retrieves the file reference @fref's rock value. See <link
97 * linkend="chimara-Rocks">Rocks</link>.
99 * Returns: A rock value.
102 glk_fileref_get_rock(frefid_t fref)
104 VALID_FILEREF(fref, return 0);
109 * glk_fileref_create_temp:
110 * @usage: Bitfield with one or more of the <code>fileusage_</code> constants.
111 * @rock: The new fileref's rock value.
113 * Creates a reference to a temporary file. It is always a new file (one which
114 * does not yet exist). The file (once created) will be somewhere out of the
118 * This is why no name is specified; the player will never need to know it.
121 * A temporary file should never be used for long-term storage. It may be
122 * deleted automatically when the program exits, or at some later time, say
123 * when the machine is turned off or rebooted. You do not have to worry about
124 * deleting it yourself.
126 * Returns: A new fileref, or #NULL if the fileref creation failed.
129 glk_fileref_create_temp(glui32 usage, glui32 rock)
131 /* Get a temp file */
132 GError *error = NULL;
133 gchar *filename = NULL;
134 gint handle = g_file_open_tmp("glkXXXXXX", &filename, &error);
137 WARNING_S("Error creating temporary file", error->message);
142 if(close(handle) == -1) /* There is no g_close() */
144 IO_WARNING( "Error closing temporary file", filename, g_strerror(errno) );
150 frefid_t f = fileref_new(filename, rock, usage, filemode_Write);
156 * glk_fileref_create_by_prompt:
157 * @usage: Bitfield with one or more of the <code>fileusage_</code> constants.
158 * @fmode: File mode, contolling the dialog's behavior.
159 * @rock: The new fileref's rock value.
161 * Creates a reference to a file by asking the player to locate it. The library
162 * may simply prompt the player to type a name, or may use a platform-native
163 * file navigation tool. (The prompt, if any, is inferred from the usage
166 * <note><title>Chimara</title>
168 * Chimara uses a <link
169 * linkend="GtkFileChooserDialog">GtkFileChooserDialog</link>. The default
170 * starting location for the dialog may be set with glkunix_set_base_file().
173 * @fmode must be one of these values:
176 * <term>%filemode_Read</term>
177 * <listitem><para>The file must already exist; and the player will be asked
178 * to select from existing files which match the usage.</para></listitem>
181 * <term>%filemode_Write</term>
182 * <listitem><para>The file should not exist; if the player selects an
183 * existing file, he will be warned that it will be replaced.
187 * <term>%filemode_ReadWrite</term>
188 * <listitem><para>The file may or may not exist; if it already exists, the
189 * player will be warned that it will be modified.</para></listitem>
192 * <term>%filemode_WriteAppend</term>
193 * <listitem><para>Same behavior as %filemode_ReadWrite.</para></listitem>
197 * The @fmode argument should generally match the @fmode which will be used to
201 * It is likely that the prompt or file tool will have a <quote>cancel</quote>
202 * option. If the player chooses this, glk_fileref_create_by_prompt() will
203 * return %NULL. This is a major reason why you should make sure the return
204 * value is valid before you use it.
207 * The recommended file suffixes for files are <filename>.glkdata</filename> for
208 * %fileusage_Data, <filename>.glksave</filename> for %fileusage_SavedGame,
209 * <filename>.txt</filename> for %fileusage_Transcript and
210 * %fileusage_InputRecord.
212 * Returns: A new fileref, or #NULL if the fileref creation failed or the
213 * dialog was canceled.
216 glk_fileref_create_by_prompt(glui32 usage, glui32 fmode, glui32 rock)
218 /* TODO: Remember current working directory and last used filename
222 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
229 chooser = gtk_file_chooser_dialog_new("Select a file to open", NULL,
230 GTK_FILE_CHOOSER_ACTION_OPEN,
231 GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
232 GTK_STOCK_OPEN, GTK_RESPONSE_ACCEPT,
234 gtk_file_chooser_set_action(GTK_FILE_CHOOSER(chooser), GTK_FILE_CHOOSER_ACTION_OPEN);
237 chooser = gtk_file_chooser_dialog_new("Select a file to save to", NULL,
238 GTK_FILE_CHOOSER_ACTION_SAVE,
239 GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
240 GTK_STOCK_SAVE, GTK_RESPONSE_ACCEPT,
242 gtk_file_chooser_set_action(GTK_FILE_CHOOSER(chooser), GTK_FILE_CHOOSER_ACTION_SAVE);
245 #if GTK_CHECK_VERSION(2,8,0)
246 gtk_file_chooser_set_do_overwrite_confirmation(GTK_FILE_CHOOSER(chooser), TRUE);
249 case filemode_ReadWrite:
250 case filemode_WriteAppend:
251 chooser = gtk_file_chooser_dialog_new("Select a file to save to", NULL,
252 GTK_FILE_CHOOSER_ACTION_SAVE,
253 GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
254 GTK_STOCK_SAVE, GTK_RESPONSE_ACCEPT,
256 gtk_file_chooser_set_action(GTK_FILE_CHOOSER(chooser), GTK_FILE_CHOOSER_ACTION_SAVE);
259 ILLEGAL_PARAM("Unknown file mode: %u", fmode);
264 if(glk_data->current_dir)
265 gtk_file_chooser_set_current_folder(GTK_FILE_CHOOSER(chooser), glk_data->current_dir);
267 if(gtk_dialog_run( GTK_DIALOG(chooser) ) != GTK_RESPONSE_ACCEPT)
269 gtk_widget_destroy(chooser);
273 gchar *filename = gtk_file_chooser_get_filename( GTK_FILE_CHOOSER(chooser) );
274 frefid_t f = fileref_new(filename, rock, usage, fmode);
276 gtk_widget_destroy(chooser);
283 * glk_fileref_create_by_name:
284 * @usage: Bitfield with one or more of the <code>fileusage_</code> constants.
286 * @rock: The new fileref's rock value.
288 * This creates a reference to a file with a specific name. The file will be
289 * in a fixed location relevant to your program, and visible to the player.
292 * This usually means <quote>in the same directory as your program.</quote>
294 * <note><title>Chimara</title>
296 * In Chimara, the file is created in the directory last set by
297 * glkunix_set_base_file(), and otherwise in the current working directory.
300 * Earlier versions of the Glk spec specified that the library may have to
301 * extend, truncate, or change your name argument in order to produce a legal
302 * native filename. This remains true. However, since Glk was originally
303 * proposed, the world has largely reached consensus about what a filename looks
304 * like. Therefore, it is worth including some recommended library behavior
305 * here. Libraries that share this behavior will more easily be able to exchange
306 * files, which may be valuable both to authors (distributing data files for
307 * games) and for players (moving data between different computers or different
310 * The library should take the given filename argument, and delete any
311 * characters illegal for a filename. This will include all of the following
312 * characters (and more, if the OS requires it): slash, backslash, angle
313 * brackets (less-than and greater-than), colon, double-quote, pipe (vertical
314 * bar), question-mark, asterisk. The library should also truncate the argument
315 * at the first period (delete the first period and any following characters).
316 * If the result is the empty string, change it to the string
317 * <code>"null"</code>.
319 * It should then append an appropriate suffix, depending on the usage:
320 * <filename>.glkdata</filename> for %fileusage_Data,
321 * <filename>.glksave</filename> for %fileusage_SavedGame,
322 * <filename>.txt</filename> for %fileusage_Transcript and
323 * %fileusage_InputRecord.
325 * The above behavior is not a requirement of the Glk spec. Older
326 * implementations can continue doing what they do. Some programs (e.g.
327 * web-based interpreters) may not have access to a traditional filesystem at
328 * all, and to them these recommendations will be meaningless.
330 * On the other side of the coin, the game file should not press these
331 * limitations. Best practice is for the game to pass a filename containing only
332 * letters and digits, beginning with a letter, and not mixing upper and lower
333 * case. Avoid overly-long filenames.
336 * The earlier Glk spec gave more stringent recommendations: <quote>No more
337 * than 8 characters, consisting entirely of upper-case letters and numbers,
338 * starting with a letter</quote>. The DOS era is safely contained, if not
339 * over, so this has been relaxed. The I7 manual recommends <quote>23
340 * characters or fewer</quote>.
344 * To address other complications:</para>
347 * Some filesystems are case-insensitive. If you create two filerefs with
348 * the names <filename>File</filename> and <filename>FILE</filename>, they
349 * may wind up pointing to the same file, or they may not. Avoid doing
353 * Some programs will look for all files in the same directory as the
354 * program itself (or, for interpreted games, in the same directory as the
355 * game file). Others may keep files in a data-specific directory
356 * appropriate for the user (e.g., <filename
357 * class="directory">~/Library</filename> on MacOS).
360 * If a game interpreter uses a data-specific directory, there is a
361 * question of whether to use a common location, or divide it into
362 * game-specific subdirectories. (Or to put it another way: should the
363 * namespace of named files be per-game or app-wide?) Since data files may
364 * be exchanged between games, they should be given an app-wide namespace.
365 * In contrast, saved games should be per-game, as they can never be
366 * exchanged. Transcripts and input records can go either way.
369 * When updating an older library to follow these recommendations,
370 * consider backwards compatibility for games already installed. When
371 * opening an existing file (that is, not in a write-only mode) it may be
372 * worth looking under the older name (suffix) if the newer one does not
376 * Game-save files are already stored with a variety of file suffixes,
377 * since that usage goes back to the oldest IF interpreters, long
378 * predating Glk. It is reasonable to treat them in some special way,
379 * while hewing closer to these recommendations for data files.
384 * Returns: A new fileref, or %NULL if the fileref creation failed.
387 glk_fileref_create_by_name(glui32 usage, char *name, glui32 rock)
389 g_return_val_if_fail(name != NULL && strlen(name) > 0, NULL);
391 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
393 /* Do any string-munging here to remove illegal Latin-1 characters from
394 filename. On ext3, the only illegal characters are '/' and '\0'. */
395 g_strdelimit(name, "/", '_');
397 /* Find out what encoding filenames are in */
398 const gchar **charsets; /* Do not free */
399 g_get_filename_charsets(&charsets);
401 /* Convert name to that encoding */
402 GError *error = NULL;
403 gchar *osname = g_convert(name, -1, charsets[0], "ISO-8859-1", NULL, NULL,
407 WARNING_S("Error during latin1->filename conversion", error->message);
412 if(glk_data->current_dir)
413 path = g_build_filename(glk_data->current_dir, osname, NULL);
415 path = g_strdup(osname);
418 frefid_t f = fileref_new(path, rock, usage, filemode_ReadWrite);
424 * glk_fileref_create_from_fileref:
425 * @usage: Bitfield with one or more of the <code>fileusage_</code> constants.
426 * @fref: Fileref to copy.
427 * @rock: The new fileref's rock value.
429 * This copies an existing file reference @fref, but changes the usage. (The
430 * original fileref is not modified.)
432 * The use of this function can be tricky. If you change the type of the fileref
433 * (%fileusage_Data, %fileusage_SavedGame, etc), the new reference may or may
434 * not point to the same actual disk file.
437 * Most platforms use suffixes to indicate file type, so it typically will
438 * not. See the earlier comments about recommended file suffixes.
441 * If you do this, and open both file references for writing, the results are
442 * unpredictable. It is safest to change the type of a fileref only if it refers
443 * to a nonexistent file.
445 * If you change the mode of a fileref (%fileusage_TextMode,
446 * %fileusage_BinaryMode), but leave the rest of the type unchanged, the new
447 * fileref will definitely point to the same disk file as the old one.
449 * Obviously, if you write to a file in text mode and then read from it in
450 * binary mode, the results are platform-dependent.
452 * Returns: A new fileref, or %NULL if the fileref creation failed.
455 glk_fileref_create_from_fileref(glui32 usage, frefid_t fref, glui32 rock)
457 VALID_FILEREF(fref, return NULL);
458 return fileref_new(fref->filename, rock, usage, fref->orig_filemode);
462 * glk_fileref_destroy:
463 * @fref: Fileref to destroy.
465 * Destroys a fileref which you have created. This does <emphasis>not</emphasis>
466 * affect the disk file; it just reclaims the resources allocated by the
467 * <code>glk_fileref_create...</code> function.
469 * It is legal to destroy a fileref after opening a file with it (while the
470 * file is still open.) The fileref is only used for the opening operation,
471 * not for accessing the file stream.
474 glk_fileref_destroy(frefid_t fref)
476 VALID_FILEREF(fref, return);
477 fileref_close_common(fref);
481 * glk_fileref_delete_file:
482 * @fref: A refrence to the file to delete.
484 * Deletes the file referred to by @fref. It does not destroy @fref itself.
486 * You should only call this with a fileref that refers to an existing file.
489 glk_fileref_delete_file(frefid_t fref)
491 VALID_FILEREF(fref, return);
492 if( glk_fileref_does_file_exist(fref) )
494 if(g_unlink(fref->filename) == -1)
495 IO_WARNING( "Error deleting file", fref->filename, g_strerror(errno) );
499 ILLEGAL(_("Tried to delete a fileref that does not refer to an existing file."));
505 * glk_fileref_does_file_exist:
506 * @fref: A fileref to check.
508 * Checks whether the file referred to by @fref exists.
510 * Returns: %TRUE (1) if @fref refers to an existing file, and %FALSE (0) if
514 glk_fileref_does_file_exist(frefid_t fref)
516 VALID_FILEREF(fref, return 0);
517 if( g_file_test(fref->filename, G_FILE_TEST_EXISTS) )