5 #include <glib/gstdio.h>
8 #include "chimara-glk-private.h"
10 extern GPrivate *glk_data_key;
13 * glk_fileref_iterate:
14 * @fref: A file reference, or %NULL.
15 * @rockptr: Return location for the next fileref's rock, or %NULL.
17 * Iterates through all the existing filerefs. See <link
18 * linkend="chimara-Iterating-Through-Opaque-Objects">Iterating Through Opaque
21 * Returns: the next file reference, or %NULL if there are no more.
24 glk_fileref_iterate(frefid_t fref, glui32 *rockptr)
26 VALID_FILEREF_OR_NULL(fref, return NULL);
28 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
32 retnode = glk_data->fileref_list;
34 retnode = fref->fileref_list->next;
35 frefid_t retval = retnode? (frefid_t)retnode->data : NULL;
37 /* Store the fileref's rock in rockptr */
39 *rockptr = glk_fileref_get_rock(retval);
45 * glk_fileref_get_rock:
46 * @fref: A file reference.
48 * Retrieves the file reference @fref's rock value. See <link
49 * linkend="chimara-Rocks">Rocks</link>.
51 * Returns: A rock value.
54 glk_fileref_get_rock(frefid_t fref)
56 VALID_FILEREF(fref, return 0);
60 /* Internal function: create a fileref using the given parameters. */
62 fileref_new(gchar *filename, glui32 rock, glui32 usage, glui32 orig_filemode)
64 g_return_val_if_fail(filename != NULL, NULL);
66 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
68 frefid_t f = g_new0(struct glk_fileref_struct, 1);
69 f->magic = MAGIC_FILEREF;
71 f->filename = g_strdup(filename);
73 f->orig_filemode = orig_filemode;
75 /* Add it to the global fileref list */
76 glk_data->fileref_list = g_list_prepend(glk_data->fileref_list, f);
77 f->fileref_list = glk_data->fileref_list;
83 * glk_fileref_create_temp:
84 * @usage: Bitfield with one or more of the <code>fileusage_</code> constants.
85 * @rock: The new fileref's rock value.
87 * Creates a reference to a temporary file. It is always a new file (one which
88 * does not yet exist). The file (once created) will be somewhere out of the
92 * This is why no name is specified; the player will never need to know it.
95 * A temporary file should never be used for long-term storage. It may be
96 * deleted automatically when the program exits, or at some later time, say
97 * when the machine is turned off or rebooted. You do not have to worry about
98 * deleting it yourself.
100 * Returns: A new fileref, or #NULL if the fileref creation failed.
103 glk_fileref_create_temp(glui32 usage, glui32 rock)
105 /* Get a temp file */
106 GError *error = NULL;
107 gchar *filename = NULL;
108 gint handle = g_file_open_tmp("glkXXXXXX", &filename, &error);
111 WARNING_S("Error creating temporary file", error->message);
116 if(close(handle) == -1) /* There is no g_close() */
118 IO_WARNING( "Error closing temporary file", filename, g_strerror(errno) );
124 frefid_t f = fileref_new(filename, rock, usage, filemode_Write);
130 * glk_fileref_create_by_prompt:
131 * @usage: Bitfield with one or more of the <code>fileusage_</code> constants.
132 * @fmode: File mode, contolling the dialog's behavior.
133 * @rock: The new fileref's rock value.
135 * Creates a reference to a file by asking the player to locate it. The library
136 * may simply prompt the player to type a name, or may use a platform-native
137 * file navigation tool. (The prompt, if any, is inferred from the usage
140 * <note><title>Chimara</title>
142 * Chimara uses a <link
143 * linkend="gtk-GtkFileChooserDialog">GtkFileChooserDialog</link>. The default
144 * starting location for the dialog may be set with glkunix_set_base_file().
147 * @fmode must be one of these values:
150 * <term>%filemode_Read</term>
151 * <listitem><para>The file must already exist; and the player will be asked
152 * to select from existing files which match the usage.</para></listitem>
155 * <term>%filemode_Write</term>
156 * <listitem><para>The file should not exist; if the player selects an
157 * existing file, he will be warned that it will be replaced.
161 * <term>%filemode_ReadWrite</term>
162 * <listitem><para>The file may or may not exist; if it already exists, the
163 * player will be warned that it will be modified.</para></listitem>
166 * <term>%filemode_WriteAppend</term>
167 * <listitem><para>Same behavior as %filemode_ReadWrite.</para></listitem>
171 * The @fmode argument should generally match the @fmode which will be used to
175 * It is possible that the prompt or file tool will have a
176 * <quote>cancel</quote> option. If the player chooses this,
177 * glk_fileref_create_by_prompt() will return %NULL. This is a major reason
178 * why you should make sure the return value is valid before you use it.
181 * Returns: A new fileref, or #NULL if the fileref creation failed or the
182 * dialog was canceled.
185 glk_fileref_create_by_prompt(glui32 usage, glui32 fmode, glui32 rock)
187 /* TODO: Remember current working directory and last used filename
191 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
198 chooser = gtk_file_chooser_dialog_new("Select a file to open", NULL,
199 GTK_FILE_CHOOSER_ACTION_OPEN,
200 GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
201 GTK_STOCK_OPEN, GTK_RESPONSE_ACCEPT,
203 gtk_file_chooser_set_action(GTK_FILE_CHOOSER(chooser),
204 GTK_FILE_CHOOSER_ACTION_OPEN);
207 chooser = gtk_file_chooser_dialog_new("Select a file to save to", NULL,
208 GTK_FILE_CHOOSER_ACTION_SAVE,
209 GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
210 GTK_STOCK_SAVE, GTK_RESPONSE_ACCEPT,
212 gtk_file_chooser_set_action(GTK_FILE_CHOOSER(chooser),
213 GTK_FILE_CHOOSER_ACTION_SAVE);
214 gtk_file_chooser_set_do_overwrite_confirmation(
215 GTK_FILE_CHOOSER(chooser), TRUE);
217 case filemode_ReadWrite:
218 case filemode_WriteAppend:
219 chooser = gtk_file_chooser_dialog_new("Select a file to save to", NULL,
220 GTK_FILE_CHOOSER_ACTION_SAVE,
221 GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
222 GTK_STOCK_SAVE, GTK_RESPONSE_ACCEPT,
224 gtk_file_chooser_set_action(GTK_FILE_CHOOSER(chooser),
225 GTK_FILE_CHOOSER_ACTION_SAVE);
228 ILLEGAL_PARAM("Unknown file mode: %u", fmode);
233 if(glk_data->current_dir)
234 gtk_file_chooser_set_current_folder(GTK_FILE_CHOOSER(chooser), glk_data->current_dir);
236 if(gtk_dialog_run( GTK_DIALOG(chooser) ) != GTK_RESPONSE_ACCEPT)
238 gtk_widget_destroy(chooser);
243 gtk_file_chooser_get_filename( GTK_FILE_CHOOSER(chooser) );
244 frefid_t f = fileref_new(filename, rock, usage, fmode);
246 gtk_widget_destroy(chooser);
253 * glk_fileref_create_by_name:
254 * @usage: Bitfield with one or more of the <code>fileusage_</code> constants.
256 * @rock: The new fileref's rock value.
258 * This creates a reference to a file with a specific name. The file will be
259 * in a fixed location relevant to your program, and visible to the player.
262 * This usually means <quote>in the same directory as your program.</quote>
264 * <note><title>Chimara</title>
266 * In Chimara, the file is created in the directory last set by
267 * glkunix_set_base_file(), and otherwise in the current working directory.
270 * Since filenames are highly platform-specific, you should use
271 * glk_fileref_create_by_name() with care. It is legal to pass any string in the
272 * name argument. However, the library may have to mangle, transform, or
273 * truncate the string to make it a legal native filename.
276 * For example, if you create two filerefs with the names <quote>File</quote>
277 * and <quote>FILE</quote>, they may wind up pointing to the same file; the
278 * platform may not support case distinctions in file names. Another example:
279 * on a platform where file type is specified by filename suffix, the library
280 * will add an appropriate suffix based on the usage; any suffix in the string
281 * will be overwritten or added to. For that matter, remember that the period
282 * is not a legal character in Acorn filenames...
285 * The most conservative approach is to pass a string of no more than 8
286 * characters, consisting entirely of upper-case letters and numbers, starting
287 * with a letter. You can then be reasonably sure that the resulting filename
288 * will display all the characters you specify — in some form.
290 * Returns: A new fileref, or %NULL if the fileref creation failed.
293 glk_fileref_create_by_name(glui32 usage, char *name, glui32 rock)
295 g_return_val_if_fail(name != NULL && strlen(name) > 0, NULL);
297 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
299 /* Do any string-munging here to remove illegal Latin-1 characters from
300 filename. On ext3, the only illegal characters are '/' and '\0'. */
301 g_strdelimit(name, "/", '_');
303 /* Find out what encoding filenames are in */
304 const gchar **charsets; /* Do not free */
305 g_get_filename_charsets(&charsets);
307 /* Convert name to that encoding */
308 GError *error = NULL;
309 gchar *osname = g_convert(name, -1, charsets[0], "ISO-8859-1", NULL, NULL,
313 WARNING_S("Error during latin1->filename conversion", error->message);
318 if(glk_data->current_dir)
319 path = g_build_filename(glk_data->current_dir, osname, NULL);
321 path = g_strdup(osname);
324 frefid_t f = fileref_new(path, rock, usage, filemode_ReadWrite);
330 * glk_fileref_create_from_fileref:
331 * @usage: Bitfield with one or more of the <code>fileusage_</code> constants.
332 * @fref: Fileref to copy.
333 * @rock: The new fileref's rock value.
335 * This copies an existing file reference @fref, but changes the usage. (The
336 * original fileref is not modified.)
338 * The use of this function can be tricky. If you change the type of the fileref
339 * (%fileusage_Data, %fileusage_SavedGame, etc), the new reference may or may
340 * not point to the same actual disk file.
343 * This generally depends on whether the platform uses suffixes to indicate
347 * If you do this, and open both file references for writing, the results are
348 * unpredictable. It is safest to change the type of a fileref only if it refers
349 * to a nonexistent file.
351 * If you change the mode of a fileref (%fileusage_TextMode,
352 * %fileusage_BinaryMode), but leave the rest of the type unchanged, the new
353 * fileref will definitely point to the same disk file as the old one.
355 * Obviously, if you write to a file in text mode and then read from it in
356 * binary mode, the results are platform-dependent.
358 * Returns: A new fileref, or %NULL if the fileref creation failed.
361 glk_fileref_create_from_fileref(glui32 usage, frefid_t fref, glui32 rock)
363 VALID_FILEREF(fref, return NULL);
364 return fileref_new(fref->filename, rock, usage, fref->orig_filemode);
368 * glk_fileref_destroy:
369 * @fref: Fileref to destroy.
371 * Destroys a fileref which you have created. This does <emphasis>not</emphasis>
372 * affect the disk file; it just reclaims the resources allocated by the
373 * <code>glk_fileref_create...</code> function.
375 * It is legal to destroy a fileref after opening a file with it (while the
376 * file is still open.) The fileref is only used for the opening operation,
377 * not for accessing the file stream.
380 glk_fileref_destroy(frefid_t fref)
382 VALID_FILEREF(fref, return);
384 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
386 glk_data->fileref_list = g_list_delete_link(glk_data->fileref_list, fref->fileref_list);
388 g_free(fref->filename);
390 fref->magic = MAGIC_FREE;
395 * glk_fileref_delete_file:
396 * @fref: A refrence to the file to delete.
398 * Deletes the file referred to by @fref. It does not destroy @fref itself.
401 glk_fileref_delete_file(frefid_t fref)
403 VALID_FILEREF(fref, return);
404 if( glk_fileref_does_file_exist(fref) )
405 if(g_unlink(fref->filename) == -1)
406 IO_WARNING( "Error deleting file", fref->filename, g_strerror(errno) );
410 * glk_fileref_does_file_exist:
411 * @fref: A fileref to check.
413 * Checks whether the file referred to by @fref exists.
415 * Returns: %TRUE (1) if @fref refers to an existing file, and %FALSE (0) if
419 glk_fileref_does_file_exist(frefid_t fref)
421 VALID_FILEREF(fref, return 0);
422 if( g_file_test(fref->filename, G_FILE_TEST_EXISTS) )