1 /* gfileutils.c - File utility functions
3 * Copyright 2000 Red Hat, Inc.
5 * GLib is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU Lesser General Public License as
7 * published by the Free Software Foundation; either version 2 of the
8 * License, or (at your option) any later version.
10 * GLib is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with GLib; see the file COPYING.LIB. If not,
17 * see <http://www.gnu.org/licenses/>.
21 #include "glibconfig.h"
29 #include <sys/types.h>
40 #endif /* G_OS_WIN32 */
50 #include "gfileutils.h"
55 #ifdef HAVE_LINUX_MAGIC_H /* for btrfs check */
56 #include <linux/magic.h>
63 * @title: File Utilities
64 * @short_description: various file-related functions
66 * There is a group of functions which wrap the common POSIX functions
67 * dealing with filenames (g_open(), g_rename(), g_mkdir(), g_stat(),
68 * g_unlink(), g_remove(), g_fopen(), g_freopen()). The point of these
69 * wrappers is to make it possible to handle file names with any Unicode
70 * characters in them on Windows without having to use ifdefs and the
71 * wide character API in the application code.
73 * The pathname argument should be in the GLib file name encoding.
74 * On POSIX this is the actual on-disk encoding which might correspond
75 * to the locale settings of the process (or the `G_FILENAME_ENCODING`
76 * environment variable), or not.
78 * On Windows the GLib file name encoding is UTF-8. Note that the
79 * Microsoft C library does not use UTF-8, but has separate APIs for
80 * current system code page and wide characters (UTF-16). The GLib
81 * wrappers call the wide character API if present (on modern Windows
82 * systems), otherwise convert to/from the system code page.
84 * Another group of functions allows to open and read directories
85 * in the GLib file name encoding. These are g_dir_open(),
86 * g_dir_read_name(), g_dir_rewind(), g_dir_close().
91 * @G_FILE_ERROR_EXIST: Operation not permitted; only the owner of
92 * the file (or other resource) or processes with special privileges
93 * can perform the operation.
94 * @G_FILE_ERROR_ISDIR: File is a directory; you cannot open a directory
95 * for writing, or create or remove hard links to it.
96 * @G_FILE_ERROR_ACCES: Permission denied; the file permissions do not
97 * allow the attempted operation.
98 * @G_FILE_ERROR_NAMETOOLONG: Filename too long.
99 * @G_FILE_ERROR_NOENT: No such file or directory. This is a "file
100 * doesn't exist" error for ordinary files that are referenced in
101 * contexts where they are expected to already exist.
102 * @G_FILE_ERROR_NOTDIR: A file that isn't a directory was specified when
103 * a directory is required.
104 * @G_FILE_ERROR_NXIO: No such device or address. The system tried to
105 * use the device represented by a file you specified, and it
106 * couldn't find the device. This can mean that the device file was
107 * installed incorrectly, or that the physical device is missing or
108 * not correctly attached to the computer.
109 * @G_FILE_ERROR_NODEV: The underlying file system of the specified file
110 * does not support memory mapping.
111 * @G_FILE_ERROR_ROFS: The directory containing the new link can't be
112 * modified because it's on a read-only file system.
113 * @G_FILE_ERROR_TXTBSY: Text file busy.
114 * @G_FILE_ERROR_FAULT: You passed in a pointer to bad memory.
115 * (GLib won't reliably return this, don't pass in pointers to bad
117 * @G_FILE_ERROR_LOOP: Too many levels of symbolic links were encountered
118 * in looking up a file name. This often indicates a cycle of symbolic
120 * @G_FILE_ERROR_NOSPC: No space left on device; write operation on a
121 * file failed because the disk is full.
122 * @G_FILE_ERROR_NOMEM: No memory available. The system cannot allocate
123 * more virtual memory because its capacity is full.
124 * @G_FILE_ERROR_MFILE: The current process has too many files open and
125 * can't open any more. Duplicate descriptors do count toward this
127 * @G_FILE_ERROR_NFILE: There are too many distinct file openings in the
129 * @G_FILE_ERROR_BADF: Bad file descriptor; for example, I/O on a
130 * descriptor that has been closed or reading from a descriptor open
131 * only for writing (or vice versa).
132 * @G_FILE_ERROR_INVAL: Invalid argument. This is used to indicate
133 * various kinds of problems with passing the wrong argument to a
135 * @G_FILE_ERROR_PIPE: Broken pipe; there is no process reading from the
136 * other end of a pipe. Every library function that returns this
137 * error code also generates a 'SIGPIPE' signal; this signal
138 * terminates the program if not handled or blocked. Thus, your
139 * program will never actually see this code unless it has handled
140 * or blocked 'SIGPIPE'.
141 * @G_FILE_ERROR_AGAIN: Resource temporarily unavailable; the call might
142 * work if you try again later.
143 * @G_FILE_ERROR_INTR: Interrupted function call; an asynchronous signal
144 * occurred and prevented completion of the call. When this
145 * happens, you should try the call again.
146 * @G_FILE_ERROR_IO: Input/output error; usually used for physical read
147 * or write errors. i.e. the disk or other physical device hardware
148 * is returning errors.
149 * @G_FILE_ERROR_PERM: Operation not permitted; only the owner of the
150 * file (or other resource) or processes with special privileges can
151 * perform the operation.
152 * @G_FILE_ERROR_NOSYS: Function not implemented; this indicates that
153 * the system is missing some functionality.
154 * @G_FILE_ERROR_FAILED: Does not correspond to a UNIX error code; this
155 * is the standard "failed for unspecified reason" error code present
156 * in all #GError error code enumerations. Returned if no specific
159 * Values corresponding to @errno codes returned from file operations
160 * on UNIX. Unlike @errno codes, GFileError values are available on
161 * all systems, even Windows. The exact meaning of each code depends
162 * on what sort of file operation you were performing; the UNIX
163 * documentation gives more details. The following error code descriptions
164 * come from the GNU C Library manual, and are under the copyright
167 * It's not very portable to make detailed assumptions about exactly
168 * which errors will be returned from a given operation. Some errors
169 * don't occur on some systems, etc., sometimes there are subtle
170 * differences in when a system will report a given error, etc.
176 * Error domain for file operations. Errors in this domain will
177 * be from the #GFileError enumeration. See #GError for information
183 * @G_FILE_TEST_IS_REGULAR: %TRUE if the file is a regular file
184 * (not a directory). Note that this test will also return %TRUE
185 * if the tested file is a symlink to a regular file.
186 * @G_FILE_TEST_IS_SYMLINK: %TRUE if the file is a symlink.
187 * @G_FILE_TEST_IS_DIR: %TRUE if the file is a directory.
188 * @G_FILE_TEST_IS_EXECUTABLE: %TRUE if the file is executable.
189 * @G_FILE_TEST_EXISTS: %TRUE if the file exists. It may or may not
192 * A test to perform on a file using g_file_test().
196 * g_mkdir_with_parents:
197 * @pathname: a pathname in the GLib file name encoding
198 * @mode: permissions to use for newly created directories
200 * Create a directory if it doesn't already exist. Create intermediate
201 * parent directories as needed, too.
203 * Returns: 0 if the directory already exists, or was successfully
204 * created. Returns -1 if an error occurred, with errno set.
209 g_mkdir_with_parents (const gchar
*pathname
,
214 if (pathname
== NULL
|| *pathname
== '\0')
220 fn
= g_strdup (pathname
);
222 if (g_path_is_absolute (fn
))
223 p
= (gchar
*) g_path_skip_root (fn
);
229 while (*p
&& !G_IS_DIR_SEPARATOR (*p
))
237 if (!g_file_test (fn
, G_FILE_TEST_EXISTS
))
239 if (g_mkdir (fn
, mode
) == -1 && errno
!= EEXIST
)
241 int errno_save
= errno
;
247 else if (!g_file_test (fn
, G_FILE_TEST_IS_DIR
))
255 *p
++ = G_DIR_SEPARATOR
;
256 while (*p
&& G_IS_DIR_SEPARATOR (*p
))
269 * @filename: a filename to test in the GLib file name encoding
270 * @test: bitfield of #GFileTest flags
272 * Returns %TRUE if any of the tests in the bitfield @test are
273 * %TRUE. For example, `(G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR)`
274 * will return %TRUE if the file exists; the check whether it's a
275 * directory doesn't matter since the existence test is %TRUE. With
276 * the current set of available tests, there's no point passing in
277 * more than one test at a time.
279 * Apart from %G_FILE_TEST_IS_SYMLINK all tests follow symbolic links,
280 * so for a symbolic link to a regular file g_file_test() will return
281 * %TRUE for both %G_FILE_TEST_IS_SYMLINK and %G_FILE_TEST_IS_REGULAR.
283 * Note, that for a dangling symbolic link g_file_test() will return
284 * %TRUE for %G_FILE_TEST_IS_SYMLINK and %FALSE for all other flags.
286 * You should never use g_file_test() to test whether it is safe
287 * to perform an operation, because there is always the possibility
288 * of the condition changing before you actually perform the operation.
289 * For example, you might think you could use %G_FILE_TEST_IS_SYMLINK
290 * to know whether it is safe to write to a file without being
291 * tricked into writing into a different location. It doesn't work!
292 * |[<!-- language="C" -->
294 * if (!g_file_test (filename, G_FILE_TEST_IS_SYMLINK))
296 * fd = g_open (filename, O_WRONLY);
301 * Another thing to note is that %G_FILE_TEST_EXISTS and
302 * %G_FILE_TEST_IS_EXECUTABLE are implemented using the access()
303 * system call. This usually doesn't matter, but if your program
304 * is setuid or setgid it means that these tests will give you
305 * the answer for the real user ID and group ID, rather than the
306 * effective user ID and group ID.
308 * On Windows, there are no symlinks, so testing for
309 * %G_FILE_TEST_IS_SYMLINK will always return %FALSE. Testing for
310 * %G_FILE_TEST_IS_EXECUTABLE will just check that the file exists and
311 * its name indicates that it is executable, checking for well-known
312 * extensions and those listed in the `PATHEXT` environment variable.
314 * Returns: whether a test was %TRUE
317 g_file_test (const gchar
*filename
,
321 /* stuff missing in std vc6 api */
322 # ifndef INVALID_FILE_ATTRIBUTES
323 # define INVALID_FILE_ATTRIBUTES -1
325 # ifndef FILE_ATTRIBUTE_DEVICE
326 # define FILE_ATTRIBUTE_DEVICE 64
329 wchar_t *wfilename
= g_utf8_to_utf16 (filename
, -1, NULL
, NULL
, NULL
);
331 if (wfilename
== NULL
)
334 attributes
= GetFileAttributesW (wfilename
);
338 if (attributes
== INVALID_FILE_ATTRIBUTES
)
341 if (test
& G_FILE_TEST_EXISTS
)
344 if (test
& G_FILE_TEST_IS_REGULAR
)
346 if ((attributes
& (FILE_ATTRIBUTE_DIRECTORY
| FILE_ATTRIBUTE_DEVICE
)) == 0)
350 if (test
& G_FILE_TEST_IS_DIR
)
352 if ((attributes
& FILE_ATTRIBUTE_DIRECTORY
) != 0)
356 /* "while" so that we can exit this "loop" with a simple "break" */
357 while (test
& G_FILE_TEST_IS_EXECUTABLE
)
359 const gchar
*lastdot
= strrchr (filename
, '.');
360 const gchar
*pathext
= NULL
, *p
;
366 if (_stricmp (lastdot
, ".exe") == 0 ||
367 _stricmp (lastdot
, ".cmd") == 0 ||
368 _stricmp (lastdot
, ".bat") == 0 ||
369 _stricmp (lastdot
, ".com") == 0)
372 /* Check if it is one of the types listed in %PATHEXT% */
374 pathext
= g_getenv ("PATHEXT");
378 pathext
= g_utf8_casefold (pathext
, -1);
380 lastdot
= g_utf8_casefold (lastdot
, -1);
381 extlen
= strlen (lastdot
);
386 const gchar
*q
= strchr (p
, ';');
389 if (extlen
== q
- p
&&
390 memcmp (lastdot
, p
, extlen
) == 0)
392 g_free ((gchar
*) pathext
);
393 g_free ((gchar
*) lastdot
);
402 g_free ((gchar
*) pathext
);
403 g_free ((gchar
*) lastdot
);
409 if ((test
& G_FILE_TEST_EXISTS
) && (access (filename
, F_OK
) == 0))
412 if ((test
& G_FILE_TEST_IS_EXECUTABLE
) && (access (filename
, X_OK
) == 0))
417 /* For root, on some POSIX systems, access (filename, X_OK)
418 * will succeed even if no executable bits are set on the
419 * file. We fall through to a stat test to avoid that.
423 test
&= ~G_FILE_TEST_IS_EXECUTABLE
;
425 if (test
& G_FILE_TEST_IS_SYMLINK
)
429 if ((lstat (filename
, &s
) == 0) && S_ISLNK (s
.st_mode
))
433 if (test
& (G_FILE_TEST_IS_REGULAR
|
435 G_FILE_TEST_IS_EXECUTABLE
))
439 if (stat (filename
, &s
) == 0)
441 if ((test
& G_FILE_TEST_IS_REGULAR
) && S_ISREG (s
.st_mode
))
444 if ((test
& G_FILE_TEST_IS_DIR
) && S_ISDIR (s
.st_mode
))
447 /* The extra test for root when access (file, X_OK) succeeds.
449 if ((test
& G_FILE_TEST_IS_EXECUTABLE
) &&
450 ((s
.st_mode
& S_IXOTH
) ||
451 (s
.st_mode
& S_IXUSR
) ||
452 (s
.st_mode
& S_IXGRP
)))
461 G_DEFINE_QUARK (g
-file
-error
-quark
, g_file_error
)
464 * g_file_error_from_errno:
465 * @err_no: an "errno" value
467 * Gets a #GFileError constant based on the passed-in @err_no.
468 * For example, if you pass in `EEXIST` this function returns
469 * #G_FILE_ERROR_EXIST. Unlike `errno` values, you can portably
470 * assume that all #GFileError values will exist.
472 * Normally a #GFileError value goes into a #GError returned
473 * from a function that manipulates files. So you would use
474 * g_file_error_from_errno() when constructing a #GError.
476 * Returns: #GFileError corresponding to the given @errno
479 g_file_error_from_errno (gint err_no
)
485 return G_FILE_ERROR_EXIST
;
490 return G_FILE_ERROR_ISDIR
;
495 return G_FILE_ERROR_ACCES
;
500 return G_FILE_ERROR_NAMETOOLONG
;
505 return G_FILE_ERROR_NOENT
;
510 return G_FILE_ERROR_NOTDIR
;
515 return G_FILE_ERROR_NXIO
;
520 return G_FILE_ERROR_NODEV
;
525 return G_FILE_ERROR_ROFS
;
530 return G_FILE_ERROR_TXTBSY
;
535 return G_FILE_ERROR_FAULT
;
540 return G_FILE_ERROR_LOOP
;
545 return G_FILE_ERROR_NOSPC
;
550 return G_FILE_ERROR_NOMEM
;
555 return G_FILE_ERROR_MFILE
;
560 return G_FILE_ERROR_NFILE
;
565 return G_FILE_ERROR_BADF
;
570 return G_FILE_ERROR_INVAL
;
575 return G_FILE_ERROR_PIPE
;
580 return G_FILE_ERROR_AGAIN
;
585 return G_FILE_ERROR_INTR
;
590 return G_FILE_ERROR_IO
;
595 return G_FILE_ERROR_PERM
;
600 return G_FILE_ERROR_NOSYS
;
604 return G_FILE_ERROR_FAILED
;
609 format_error_message (const gchar
*filename
,
610 const gchar
*format_string
,
611 int saved_errno
) G_GNUC_FORMAT(2);
613 #pragma GCC diagnostic push
614 #pragma GCC diagnostic ignored "-Wformat-nonliteral"
617 format_error_message (const gchar
*filename
,
618 const gchar
*format_string
,
624 display_name
= g_filename_display_name (filename
);
625 msg
= g_strdup_printf (format_string
, display_name
, g_strerror (saved_errno
));
626 g_free (display_name
);
631 #pragma GCC diagnostic pop
633 /* format string must have two '%s':
635 * - the place for the filename
636 * - the place for the strerror
639 set_file_error (GError
**error
,
640 const gchar
*filename
,
641 const gchar
*format_string
,
644 char *msg
= format_error_message (filename
, format_string
, saved_errno
);
646 g_set_error_literal (error
, G_FILE_ERROR
, g_file_error_from_errno (saved_errno
),
652 get_contents_stdio (const gchar
*filename
,
659 gsize bytes
; /* always <= sizeof(buf) */
661 gsize total_bytes
= 0;
662 gsize total_allocated
= 0;
664 gchar
*display_filename
;
666 g_assert (f
!= NULL
);
672 bytes
= fread (buf
, 1, sizeof (buf
), f
);
675 if (total_bytes
> G_MAXSIZE
- bytes
)
678 /* Possibility of overflow eliminated above. */
679 while (total_bytes
+ bytes
>= total_allocated
)
683 if (total_allocated
> G_MAXSIZE
/ 2)
685 total_allocated
*= 2;
689 total_allocated
= MIN (bytes
+ 1, sizeof (buf
));
692 tmp
= g_try_realloc (str
, total_allocated
);
696 display_filename
= g_filename_display_name (filename
);
700 g_dngettext (GETTEXT_PACKAGE
, "Could not allocate %lu byte to read file \"%s\"", "Could not allocate %lu bytes to read file \"%s\"", (gulong
)total_allocated
),
701 (gulong
) total_allocated
,
703 g_free (display_filename
);
713 display_filename
= g_filename_display_name (filename
);
716 g_file_error_from_errno (save_errno
),
717 _("Error reading file '%s': %s"),
719 g_strerror (save_errno
));
720 g_free (display_filename
);
725 g_assert (str
!= NULL
);
726 memcpy (str
+ total_bytes
, buf
, bytes
);
728 total_bytes
+= bytes
;
733 if (total_allocated
== 0)
735 str
= g_new (gchar
, 1);
739 str
[total_bytes
] = '\0';
742 *length
= total_bytes
;
749 display_filename
= g_filename_display_name (filename
);
753 _("File \"%s\" is too large"),
755 g_free (display_filename
);
768 get_contents_regfile (const gchar
*filename
,
769 struct stat
*stat_buf
,
779 gchar
*display_filename
;
781 size
= stat_buf
->st_size
;
783 alloc_size
= size
+ 1;
784 buf
= g_try_malloc (alloc_size
);
788 display_filename
= g_filename_display_name (filename
);
792 g_dngettext (GETTEXT_PACKAGE
, "Could not allocate %lu byte to read file \"%s\"", "Could not allocate %lu bytes to read file \"%s\"", (gulong
)alloc_size
),
795 g_free (display_filename
);
800 while (bytes_read
< size
)
804 rc
= read (fd
, buf
+ bytes_read
, size
- bytes_read
);
810 int save_errno
= errno
;
813 display_filename
= g_filename_display_name (filename
);
816 g_file_error_from_errno (save_errno
),
817 _("Failed to read from file '%s': %s"),
819 g_strerror (save_errno
));
820 g_free (display_filename
);
830 buf
[bytes_read
] = '\0';
833 *length
= bytes_read
;
849 get_contents_posix (const gchar
*filename
,
854 struct stat stat_buf
;
857 /* O_BINARY useful on Cygwin */
858 fd
= open (filename
, O_RDONLY
|O_BINARY
);
862 int saved_errno
= errno
;
863 set_file_error (error
,
865 _("Failed to open file '%s': %s"),
871 /* I don't think this will ever fail, aside from ENOMEM, but. */
872 if (fstat (fd
, &stat_buf
) < 0)
874 int saved_errno
= errno
;
875 set_file_error (error
,
877 _("Failed to get attributes of file '%s': fstat() failed: %s"),
884 if (stat_buf
.st_size
> 0 && S_ISREG (stat_buf
.st_mode
))
886 gboolean retval
= get_contents_regfile (filename
,
900 f
= fdopen (fd
, "r");
904 int saved_errno
= errno
;
905 set_file_error (error
,
907 _("Failed to open file '%s': fdopen() failed: %s"),
913 retval
= get_contents_stdio (filename
, f
, contents
, length
, error
);
919 #else /* G_OS_WIN32 */
922 get_contents_win32 (const gchar
*filename
,
930 f
= g_fopen (filename
, "rb");
934 int saved_errno
= errno
;
935 set_file_error (error
,
937 _("Failed to open file '%s': %s"),
943 retval
= get_contents_stdio (filename
, f
, contents
, length
, error
);
951 * g_file_get_contents:
952 * @filename: (type filename): name of a file to read contents from, in the GLib file name encoding
953 * @contents: (out) (array length=length) (element-type guint8): location to store an allocated string, use g_free() to free
954 * the returned string
955 * @length: (allow-none): location to store length in bytes of the contents, or %NULL
956 * @error: return location for a #GError, or %NULL
958 * Reads an entire file into allocated memory, with good error
961 * If the call was successful, it returns %TRUE and sets @contents to the file
962 * contents and @length to the length of the file contents in bytes. The string
963 * stored in @contents will be nul-terminated, so for text files you can pass
964 * %NULL for the @length argument. If the call was not successful, it returns
965 * %FALSE and sets @error. The error domain is #G_FILE_ERROR. Possible error
966 * codes are those in the #GFileError enumeration. In the error case,
967 * @contents is set to %NULL and @length is set to zero.
969 * Returns: %TRUE on success, %FALSE if an error occurred
972 g_file_get_contents (const gchar
*filename
,
977 g_return_val_if_fail (filename
!= NULL
, FALSE
);
978 g_return_val_if_fail (contents
!= NULL
, FALSE
);
985 return get_contents_win32 (filename
, contents
, length
, error
);
987 return get_contents_posix (filename
, contents
, length
, error
);
992 rename_file (const char *old_name
,
993 const char *new_name
,
997 if (g_rename (old_name
, new_name
) == -1)
999 int save_errno
= errno
;
1000 gchar
*display_old_name
= g_filename_display_name (old_name
);
1001 gchar
*display_new_name
= g_filename_display_name (new_name
);
1005 g_file_error_from_errno (save_errno
),
1006 _("Failed to rename file '%s' to '%s': g_rename() failed: %s"),
1009 g_strerror (save_errno
));
1011 g_free (display_old_name
);
1012 g_free (display_new_name
);
1021 write_to_temp_file (const gchar
*contents
,
1023 const gchar
*dest_file
,
1032 tmp_name
= g_strdup_printf ("%s.XXXXXX", dest_file
);
1035 fd
= g_mkstemp_full (tmp_name
, O_RDWR
| O_BINARY
, 0666);
1039 int saved_errno
= errno
;
1040 set_file_error (err
,
1041 tmp_name
, _("Failed to create file '%s': %s"),
1046 #ifdef HAVE_FALLOCATE
1049 /* We do this on a 'best effort' basis... It may not be supported
1050 * on the underlying filesystem.
1052 (void) fallocate (fd
, 0, 0, length
);
1059 s
= write (fd
, contents
, length
);
1063 int saved_errno
= errno
;
1064 if (saved_errno
== EINTR
)
1067 set_file_error (err
,
1068 tmp_name
, _("Failed to write file '%s': write() failed: %s"),
1071 g_unlink (tmp_name
);
1076 g_assert (s
<= length
);
1082 #ifdef BTRFS_SUPER_MAGIC
1086 /* On Linux, on btrfs, skip the fsync since rename-over-existing is
1087 * guaranteed to be atomic and this is the only case in which we
1088 * would fsync() anyway.
1091 if (fstatfs (fd
, &buf
) == 0 && buf
.f_type
== BTRFS_SUPER_MAGIC
)
1098 struct stat statbuf
;
1101 /* If the final destination exists and is > 0 bytes, we want to sync the
1102 * newly written file to ensure the data is on disk when we rename over
1103 * the destination. Otherwise if we get a system crash we can lose both
1104 * the new and the old file on some filesystems. (I.E. those that don't
1105 * guarantee the data is written to the disk before the metadata.)
1107 if (g_lstat (dest_file
, &statbuf
) == 0 && statbuf
.st_size
> 0 && fsync (fd
) != 0)
1109 int saved_errno
= errno
;
1110 set_file_error (err
,
1111 tmp_name
, _("Failed to write file '%s': fsync() failed: %s"),
1114 g_unlink (tmp_name
);
1121 #ifdef BTRFS_SUPER_MAGIC
1126 if (!g_close (fd
, err
))
1128 g_unlink (tmp_name
);
1133 retval
= g_strdup (tmp_name
);
1142 * g_file_set_contents:
1143 * @filename: (type filename): name of a file to write @contents to, in the GLib file name
1145 * @contents: (array length=length) (element-type guint8): string to write to the file
1146 * @length: length of @contents, or -1 if @contents is a nul-terminated string
1147 * @error: return location for a #GError, or %NULL
1149 * Writes all of @contents to a file named @filename, with good error checking.
1150 * If a file called @filename already exists it will be overwritten.
1152 * This write is atomic in the sense that it is first written to a temporary
1153 * file which is then renamed to the final name. Notes:
1155 * - On UNIX, if @filename already exists hard links to @filename will break.
1156 * Also since the file is recreated, existing permissions, access control
1157 * lists, metadata etc. may be lost. If @filename is a symbolic link,
1158 * the link itself will be replaced, not the linked file.
1160 * - On Windows renaming a file will not remove an existing file with the
1161 * new name, so on Windows there is a race condition between the existing
1162 * file being removed and the temporary file being renamed.
1164 * - On Windows there is no way to remove a file that is open to some
1165 * process, or mapped into memory. Thus, this function will fail if
1166 * @filename already exists and is open.
1168 * If the call was successful, it returns %TRUE. If the call was not successful,
1169 * it returns %FALSE and sets @error. The error domain is #G_FILE_ERROR.
1170 * Possible error codes are those in the #GFileError enumeration.
1172 * Note that the name for the temporary file is constructed by appending up
1173 * to 7 characters to @filename.
1175 * Returns: %TRUE on success, %FALSE if an error occurred
1180 g_file_set_contents (const gchar
*filename
,
1181 const gchar
*contents
,
1185 gchar
*tmp_filename
;
1187 GError
*rename_error
= NULL
;
1189 g_return_val_if_fail (filename
!= NULL
, FALSE
);
1190 g_return_val_if_fail (error
== NULL
|| *error
== NULL
, FALSE
);
1191 g_return_val_if_fail (contents
!= NULL
|| length
== 0, FALSE
);
1192 g_return_val_if_fail (length
>= -1, FALSE
);
1195 length
= strlen (contents
);
1197 tmp_filename
= write_to_temp_file (contents
, length
, filename
, error
);
1205 if (!rename_file (tmp_filename
, filename
, &rename_error
))
1209 g_unlink (tmp_filename
);
1210 g_propagate_error (error
, rename_error
);
1214 #else /* G_OS_WIN32 */
1216 /* Renaming failed, but on Windows this may just mean
1217 * the file already exists. So if the target file
1218 * exists, try deleting it and do the rename again.
1220 if (!g_file_test (filename
, G_FILE_TEST_EXISTS
))
1222 g_unlink (tmp_filename
);
1223 g_propagate_error (error
, rename_error
);
1228 g_error_free (rename_error
);
1230 if (g_unlink (filename
) == -1)
1232 int saved_errno
= errno
;
1233 set_file_error (error
,
1235 _("Existing file '%s' could not be removed: g_unlink() failed: %s"),
1237 g_unlink (tmp_filename
);
1242 if (!rename_file (tmp_filename
, filename
, error
))
1244 g_unlink (tmp_filename
);
1255 g_free (tmp_filename
);
1260 * get_tmp_file based on the mkstemp implementation from the GNU C library.
1261 * Copyright (C) 1991,92,93,94,95,96,97,98,99 Free Software Foundation, Inc.
1263 typedef gint (*GTmpFileCallback
) (const gchar
*, gint
, gint
);
1266 get_tmp_file (gchar
*tmpl
,
1273 static const char letters
[] =
1274 "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
1275 static const int NLETTERS
= sizeof (letters
) - 1;
1278 static int counter
= 0;
1280 g_return_val_if_fail (tmpl
!= NULL
, -1);
1282 /* find the last occurrence of "XXXXXX" */
1283 XXXXXX
= g_strrstr (tmpl
, "XXXXXX");
1285 if (!XXXXXX
|| strncmp (XXXXXX
, "XXXXXX", 6))
1291 /* Get some more or less random data. */
1292 g_get_current_time (&tv
);
1293 value
= (tv
.tv_usec
^ tv
.tv_sec
) + counter
++;
1295 for (count
= 0; count
< 100; value
+= 7777, ++count
)
1299 /* Fill in the random bits. */
1300 XXXXXX
[0] = letters
[v
% NLETTERS
];
1302 XXXXXX
[1] = letters
[v
% NLETTERS
];
1304 XXXXXX
[2] = letters
[v
% NLETTERS
];
1306 XXXXXX
[3] = letters
[v
% NLETTERS
];
1308 XXXXXX
[4] = letters
[v
% NLETTERS
];
1310 XXXXXX
[5] = letters
[v
% NLETTERS
];
1312 fd
= f (tmpl
, flags
, mode
);
1316 else if (errno
!= EEXIST
)
1317 /* Any other error will apply also to other names we might
1318 * try, and there are 2^32 or so of them, so give up now.
1323 /* We got out of the loop because we ran out of combinations to try. */
1328 /* Some GTmpFileCallback implementations.
1330 * Note: we cannot use open() or g_open() directly because even though
1331 * they appear compatible, they may be vararg functions and calling
1332 * varargs functions through a non-varargs type is undefined.
1335 wrap_g_mkdir (const gchar
*filename
,
1336 int flags G_GNUC_UNUSED
,
1339 /* tmpl is in UTF-8 on Windows, thus use g_mkdir() */
1340 return g_mkdir (filename
, mode
);
1344 wrap_g_open (const gchar
*filename
,
1348 return g_open (filename
, flags
, mode
);
1353 * @tmpl: (type filename): template directory name
1354 * @mode: permissions to create the temporary directory with
1356 * Creates a temporary directory. See the mkdtemp() documentation
1357 * on most UNIX-like systems.
1359 * The parameter is a string that should follow the rules for
1360 * mkdtemp() templates, i.e. contain the string "XXXXXX".
1361 * g_mkdtemp() is slightly more flexible than mkdtemp() in that the
1362 * sequence does not have to occur at the very end of the template
1363 * and you can pass a @mode. The X string will be modified to form
1364 * the name of a directory that didn't exist. The string should be
1365 * in the GLib file name encoding. Most importantly, on Windows it
1366 * should be in UTF-8.
1368 * Returns: A pointer to @tmpl, which has been modified
1369 * to hold the directory name. In case of errors, %NULL is
1370 * returned, and %errno will be set.
1375 g_mkdtemp_full (gchar
*tmpl
,
1378 if (get_tmp_file (tmpl
, wrap_g_mkdir
, 0, mode
) == -1)
1386 * @tmpl: (type filename): template directory name
1388 * Creates a temporary directory. See the mkdtemp() documentation
1389 * on most UNIX-like systems.
1391 * The parameter is a string that should follow the rules for
1392 * mkdtemp() templates, i.e. contain the string "XXXXXX".
1393 * g_mkdtemp() is slightly more flexible than mkdtemp() in that the
1394 * sequence does not have to occur at the very end of the template
1395 * and you can pass a @mode and additional @flags. The X string will
1396 * be modified to form the name of a directory that didn't exist.
1397 * The string should be in the GLib file name encoding. Most importantly,
1398 * on Windows it should be in UTF-8.
1400 * Returns: A pointer to @tmpl, which has been modified
1401 * to hold the directory name. In case of errors, %NULL is
1402 * returned and %errno will be set.
1407 g_mkdtemp (gchar
*tmpl
)
1409 return g_mkdtemp_full (tmpl
, 0700);
1414 * @tmpl: (type filename): template filename
1415 * @flags: flags to pass to an open() call in addition to O_EXCL
1416 * and O_CREAT, which are passed automatically
1417 * @mode: permissions to create the temporary file with
1419 * Opens a temporary file. See the mkstemp() documentation
1420 * on most UNIX-like systems.
1422 * The parameter is a string that should follow the rules for
1423 * mkstemp() templates, i.e. contain the string "XXXXXX".
1424 * g_mkstemp_full() is slightly more flexible than mkstemp()
1425 * in that the sequence does not have to occur at the very end of the
1426 * template and you can pass a @mode and additional @flags. The X
1427 * string will be modified to form the name of a file that didn't exist.
1428 * The string should be in the GLib file name encoding. Most importantly,
1429 * on Windows it should be in UTF-8.
1431 * Returns: A file handle (as from open()) to the file
1432 * opened for reading and writing. The file handle should be
1433 * closed with close(). In case of errors, -1 is returned
1434 * and %errno will be set.
1439 g_mkstemp_full (gchar
*tmpl
,
1443 /* tmpl is in UTF-8 on Windows, thus use g_open() */
1444 return get_tmp_file (tmpl
, wrap_g_open
,
1445 flags
| O_CREAT
| O_EXCL
, mode
);
1450 * @tmpl: (type filename): template filename
1452 * Opens a temporary file. See the mkstemp() documentation
1453 * on most UNIX-like systems.
1455 * The parameter is a string that should follow the rules for
1456 * mkstemp() templates, i.e. contain the string "XXXXXX".
1457 * g_mkstemp() is slightly more flexible than mkstemp() in that the
1458 * sequence does not have to occur at the very end of the template.
1459 * The X string will be modified to form the name of a file that
1460 * didn't exist. The string should be in the GLib file name encoding.
1461 * Most importantly, on Windows it should be in UTF-8.
1463 * Returns: A file handle (as from open()) to the file
1464 * opened for reading and writing. The file is opened in binary
1465 * mode on platforms where there is a difference. The file handle
1466 * should be closed with close(). In case of errors, -1 is
1467 * returned and %errno will be set.
1470 g_mkstemp (gchar
*tmpl
)
1472 return g_mkstemp_full (tmpl
, O_RDWR
| O_BINARY
, 0600);
1476 g_get_tmp_name (const gchar
*tmpl
,
1492 if ((slash
= strchr (tmpl
, G_DIR_SEPARATOR
)) != NULL
1494 || (strchr (tmpl
, '/') != NULL
&& (slash
= "/"))
1498 gchar
*display_tmpl
= g_filename_display_name (tmpl
);
1505 G_FILE_ERROR_FAILED
,
1506 _("Template '%s' invalid, should not contain a '%s'"),
1508 g_free (display_tmpl
);
1513 if (strstr (tmpl
, "XXXXXX") == NULL
)
1515 gchar
*display_tmpl
= g_filename_display_name (tmpl
);
1518 G_FILE_ERROR_FAILED
,
1519 _("Template '%s' doesn't contain XXXXXX"),
1521 g_free (display_tmpl
);
1525 tmpdir
= g_get_tmp_dir ();
1527 if (G_IS_DIR_SEPARATOR (tmpdir
[strlen (tmpdir
) - 1]))
1530 sep
= G_DIR_SEPARATOR_S
;
1532 fulltemplate
= g_strconcat (tmpdir
, sep
, tmpl
, NULL
);
1534 retval
= get_tmp_file (fulltemplate
, f
, flags
, mode
);
1537 int saved_errno
= errno
;
1538 set_file_error (error
,
1540 _("Failed to create file '%s': %s"),
1542 g_free (fulltemplate
);
1546 *name_used
= fulltemplate
;
1553 * @tmpl: (type filename) (allow-none): Template for file name, as in
1554 * g_mkstemp(), basename only, or %NULL for a default template
1555 * @name_used: (out) (type filename): location to store actual name used,
1557 * @error: return location for a #GError
1559 * Opens a file for writing in the preferred directory for temporary
1560 * files (as returned by g_get_tmp_dir()).
1562 * @tmpl should be a string in the GLib file name encoding containing
1563 * a sequence of six 'X' characters, as the parameter to g_mkstemp().
1564 * However, unlike these functions, the template should only be a
1565 * basename, no directory components are allowed. If template is
1566 * %NULL, a default template is used.
1568 * Note that in contrast to g_mkstemp() (and mkstemp()) @tmpl is not
1569 * modified, and might thus be a read-only literal string.
1571 * Upon success, and if @name_used is non-%NULL, the actual name used
1572 * is returned in @name_used. This string should be freed with g_free()
1573 * when not needed any longer. The returned name is in the GLib file
1576 * Returns: A file handle (as from open()) to the file opened for
1577 * reading and writing. The file is opened in binary mode on platforms
1578 * where there is a difference. The file handle should be closed with
1579 * close(). In case of errors, -1 is returned and @error will be set.
1582 g_file_open_tmp (const gchar
*tmpl
,
1586 gchar
*fulltemplate
;
1589 result
= g_get_tmp_name (tmpl
, &fulltemplate
,
1591 O_CREAT
| O_EXCL
| O_RDWR
| O_BINARY
,
1597 *name_used
= fulltemplate
;
1599 g_free (fulltemplate
);
1607 * @tmpl: (type filename) (allow-none): Template for directory name,
1608 * as in g_mkdtemp(), basename only, or %NULL for a default template
1609 * @error: return location for a #GError
1611 * Creates a subdirectory in the preferred directory for temporary
1612 * files (as returned by g_get_tmp_dir()).
1614 * @tmpl should be a string in the GLib file name encoding containing
1615 * a sequence of six 'X' characters, as the parameter to g_mkstemp().
1616 * However, unlike these functions, the template should only be a
1617 * basename, no directory components are allowed. If template is
1618 * %NULL, a default template is used.
1620 * Note that in contrast to g_mkdtemp() (and mkdtemp()) @tmpl is not
1621 * modified, and might thus be a read-only literal string.
1623 * Returns: (type filename): The actual name used. This string
1624 * should be freed with g_free() when not needed any longer and is
1625 * is in the GLib file name encoding. In case of errors, %NULL is
1626 * returned and @error will be set.
1631 g_dir_make_tmp (const gchar
*tmpl
,
1634 gchar
*fulltemplate
;
1636 if (g_get_tmp_name (tmpl
, &fulltemplate
, wrap_g_mkdir
, 0, 0700, error
) == -1)
1639 return fulltemplate
;
1643 g_build_path_va (const gchar
*separator
,
1644 const gchar
*first_element
,
1649 gint separator_len
= strlen (separator
);
1650 gboolean is_first
= TRUE
;
1651 gboolean have_leading
= FALSE
;
1652 const gchar
*single_element
= NULL
;
1653 const gchar
*next_element
;
1654 const gchar
*last_trailing
= NULL
;
1657 result
= g_string_new (NULL
);
1660 next_element
= str_array
[i
++];
1662 next_element
= first_element
;
1666 const gchar
*element
;
1672 element
= next_element
;
1674 next_element
= str_array
[i
++];
1676 next_element
= va_arg (*args
, gchar
*);
1681 /* Ignore empty elements */
1689 while (strncmp (start
, separator
, separator_len
) == 0)
1690 start
+= separator_len
;
1693 end
= start
+ strlen (start
);
1697 while (end
>= start
+ separator_len
&&
1698 strncmp (end
- separator_len
, separator
, separator_len
) == 0)
1699 end
-= separator_len
;
1701 last_trailing
= end
;
1702 while (last_trailing
>= element
+ separator_len
&&
1703 strncmp (last_trailing
- separator_len
, separator
, separator_len
) == 0)
1704 last_trailing
-= separator_len
;
1708 /* If the leading and trailing separator strings are in the
1709 * same element and overlap, the result is exactly that element
1711 if (last_trailing
<= start
)
1712 single_element
= element
;
1714 g_string_append_len (result
, element
, start
- element
);
1715 have_leading
= TRUE
;
1718 single_element
= NULL
;
1725 g_string_append (result
, separator
);
1727 g_string_append_len (result
, start
, end
- start
);
1733 g_string_free (result
, TRUE
);
1734 return g_strdup (single_element
);
1739 g_string_append (result
, last_trailing
);
1741 return g_string_free (result
, FALSE
);
1747 * @separator: a string used to separator the elements of the path.
1748 * @args: (array zero-terminated=1): %NULL-terminated array of strings containing the path elements.
1750 * Behaves exactly like g_build_path(), but takes the path elements
1751 * as a string array, instead of varargs. This function is mainly
1752 * meant for language bindings.
1754 * Returns: a newly-allocated string that must be freed with g_free().
1759 g_build_pathv (const gchar
*separator
,
1765 return g_build_path_va (separator
, NULL
, NULL
, args
);
1771 * @separator: a string used to separator the elements of the path.
1772 * @first_element: the first element in the path
1773 * @...: remaining elements in path, terminated by %NULL
1775 * Creates a path from a series of elements using @separator as the
1776 * separator between elements. At the boundary between two elements,
1777 * any trailing occurrences of separator in the first element, or
1778 * leading occurrences of separator in the second element are removed
1779 * and exactly one copy of the separator is inserted.
1781 * Empty elements are ignored.
1783 * The number of leading copies of the separator on the result is
1784 * the same as the number of leading copies of the separator on
1785 * the first non-empty element.
1787 * The number of trailing copies of the separator on the result is
1788 * the same as the number of trailing copies of the separator on
1789 * the last non-empty element. (Determination of the number of
1790 * trailing copies is done without stripping leading copies, so
1791 * if the separator is `ABA`, then `ABABA` has 1 trailing copy.)
1793 * However, if there is only a single non-empty element, and there
1794 * are no characters in that element not part of the leading or
1795 * trailing separators, then the result is exactly the original value
1798 * Other than for determination of the number of leading and trailing
1799 * copies of the separator, elements consisting only of copies
1800 * of the separator are ignored.
1802 * Returns: a newly-allocated string that must be freed with g_free().
1805 g_build_path (const gchar
*separator
,
1806 const gchar
*first_element
,
1812 g_return_val_if_fail (separator
!= NULL
, NULL
);
1814 va_start (args
, first_element
);
1815 str
= g_build_path_va (separator
, first_element
, &args
, NULL
);
1824 g_build_pathname_va (const gchar
*first_element
,
1828 /* Code copied from g_build_pathv(), and modified to use two
1829 * alternative single-character separators.
1832 gboolean is_first
= TRUE
;
1833 gboolean have_leading
= FALSE
;
1834 const gchar
*single_element
= NULL
;
1835 const gchar
*next_element
;
1836 const gchar
*last_trailing
= NULL
;
1837 gchar current_separator
= '\\';
1840 result
= g_string_new (NULL
);
1843 next_element
= str_array
[i
++];
1845 next_element
= first_element
;
1849 const gchar
*element
;
1855 element
= next_element
;
1857 next_element
= str_array
[i
++];
1859 next_element
= va_arg (*args
, gchar
*);
1864 /* Ignore empty elements */
1873 (*start
== '\\' || *start
== '/'))
1875 current_separator
= *start
;
1880 end
= start
+ strlen (start
);
1884 while (end
>= start
+ 1 &&
1885 (end
[-1] == '\\' || end
[-1] == '/'))
1887 current_separator
= end
[-1];
1891 last_trailing
= end
;
1892 while (last_trailing
>= element
+ 1 &&
1893 (last_trailing
[-1] == '\\' || last_trailing
[-1] == '/'))
1898 /* If the leading and trailing separator strings are in the
1899 * same element and overlap, the result is exactly that element
1901 if (last_trailing
<= start
)
1902 single_element
= element
;
1904 g_string_append_len (result
, element
, start
- element
);
1905 have_leading
= TRUE
;
1908 single_element
= NULL
;
1915 g_string_append_len (result
, ¤t_separator
, 1);
1917 g_string_append_len (result
, start
, end
- start
);
1923 g_string_free (result
, TRUE
);
1924 return g_strdup (single_element
);
1929 g_string_append (result
, last_trailing
);
1931 return g_string_free (result
, FALSE
);
1938 * g_build_filenamev:
1939 * @args: (array zero-terminated=1): %NULL-terminated array of strings containing the path elements.
1941 * Behaves exactly like g_build_filename(), but takes the path elements
1942 * as a string array, instead of varargs. This function is mainly
1943 * meant for language bindings.
1945 * Returns: a newly-allocated string that must be freed with g_free().
1950 g_build_filenamev (gchar
**args
)
1955 str
= g_build_path_va (G_DIR_SEPARATOR_S
, NULL
, NULL
, args
);
1957 str
= g_build_pathname_va (NULL
, NULL
, args
);
1965 * @first_element: the first element in the path
1966 * @...: remaining elements in path, terminated by %NULL
1968 * Creates a filename from a series of elements using the correct
1969 * separator for filenames.
1971 * On Unix, this function behaves identically to `g_build_path
1972 * (G_DIR_SEPARATOR_S, first_element, ....)`.
1974 * On Windows, it takes into account that either the backslash
1975 * (`\` or slash (`/`) can be used as separator in filenames, but
1976 * otherwise behaves as on UNIX. When file pathname separators need
1977 * to be inserted, the one that last previously occurred in the
1978 * parameters (reading from left to right) is used.
1980 * No attempt is made to force the resulting filename to be an absolute
1981 * path. If the first element is a relative path, the result will
1982 * be a relative path.
1984 * Returns: a newly-allocated string that must be freed with g_free().
1987 g_build_filename (const gchar
*first_element
,
1993 va_start (args
, first_element
);
1995 str
= g_build_path_va (G_DIR_SEPARATOR_S
, first_element
, &args
, NULL
);
1997 str
= g_build_pathname_va (first_element
, &args
, NULL
);
2006 * @filename: the symbolic link
2007 * @error: return location for a #GError
2009 * Reads the contents of the symbolic link @filename like the POSIX
2010 * readlink() function. The returned string is in the encoding used
2011 * for filenames. Use g_filename_to_utf8() to convert it to UTF-8.
2013 * Returns: A newly-allocated string with the contents of the symbolic link,
2014 * or %NULL if an error occurred.
2019 g_file_read_link (const gchar
*filename
,
2022 #ifdef HAVE_READLINK
2028 buffer
= g_malloc (size
);
2032 read_size
= readlink (filename
, buffer
, size
);
2035 int saved_errno
= errno
;
2036 set_file_error (error
,
2038 _("Failed to read the symbolic link '%s': %s"),
2044 if (read_size
< size
)
2046 buffer
[read_size
] = 0;
2051 buffer
= g_realloc (buffer
, size
);
2054 g_set_error_literal (error
,
2057 _("Symbolic links not supported"));
2064 * g_path_is_absolute:
2065 * @file_name: a file name
2067 * Returns %TRUE if the given @file_name is an absolute file name.
2068 * Note that this is a somewhat vague concept on Windows.
2070 * On POSIX systems, an absolute file name is well-defined. It always
2071 * starts from the single root directory. For example "/usr/local".
2073 * On Windows, the concepts of current drive and drive-specific
2074 * current directory introduce vagueness. This function interprets as
2075 * an absolute file name one that either begins with a directory
2076 * separator such as "\Users\tml" or begins with the root on a drive,
2077 * for example "C:\Windows". The first case also includes UNC paths
2078 * such as "\\myserver\docs\foo". In all cases, either slashes or
2079 * backslashes are accepted.
2081 * Note that a file name relative to the current drive root does not
2082 * truly specify a file uniquely over time and across processes, as
2083 * the current drive is a per-process value and can be changed.
2085 * File names relative the current directory on some specific drive,
2086 * such as "D:foo/bar", are not interpreted as absolute by this
2087 * function, but they obviously are not relative to the normal current
2088 * directory as returned by getcwd() or g_get_current_dir()
2089 * either. Such paths should be avoided, or need to be handled using
2090 * Windows-specific code.
2092 * Returns: %TRUE if @file_name is absolute
2095 g_path_is_absolute (const gchar
*file_name
)
2097 g_return_val_if_fail (file_name
!= NULL
, FALSE
);
2099 if (G_IS_DIR_SEPARATOR (file_name
[0]))
2103 /* Recognize drive letter on native Windows */
2104 if (g_ascii_isalpha (file_name
[0]) &&
2105 file_name
[1] == ':' && G_IS_DIR_SEPARATOR (file_name
[2]))
2114 * @file_name: a file name
2116 * Returns a pointer into @file_name after the root component,
2117 * i.e. after the "/" in UNIX or "C:\" under Windows. If @file_name
2118 * is not an absolute path it returns %NULL.
2120 * Returns: (nullable): a pointer into @file_name after the root component
2123 g_path_skip_root (const gchar
*file_name
)
2125 g_return_val_if_fail (file_name
!= NULL
, NULL
);
2127 #ifdef G_PLATFORM_WIN32
2128 /* Skip \\server\share or //server/share */
2129 if (G_IS_DIR_SEPARATOR (file_name
[0]) &&
2130 G_IS_DIR_SEPARATOR (file_name
[1]) &&
2132 !G_IS_DIR_SEPARATOR (file_name
[2]))
2135 p
= strchr (file_name
+ 2, G_DIR_SEPARATOR
);
2141 q
= strchr (file_name
+ 2, '/');
2142 if (p
== NULL
|| (q
!= NULL
&& q
< p
))
2147 if (p
&& p
> file_name
+ 2 && p
[1])
2151 while (file_name
[0] && !G_IS_DIR_SEPARATOR (file_name
[0]))
2154 /* Possibly skip a backslash after the share name */
2155 if (G_IS_DIR_SEPARATOR (file_name
[0]))
2158 return (gchar
*)file_name
;
2163 /* Skip initial slashes */
2164 if (G_IS_DIR_SEPARATOR (file_name
[0]))
2166 while (G_IS_DIR_SEPARATOR (file_name
[0]))
2168 return (gchar
*)file_name
;
2173 if (g_ascii_isalpha (file_name
[0]) &&
2174 file_name
[1] == ':' &&
2175 G_IS_DIR_SEPARATOR (file_name
[2]))
2176 return (gchar
*)file_name
+ 3;
2184 * @file_name: the name of the file
2186 * Gets the name of the file without any leading directory
2187 * components. It returns a pointer into the given file name
2190 * Returns: the name of the file without any leading
2191 * directory components
2193 * Deprecated:2.2: Use g_path_get_basename() instead, but notice
2194 * that g_path_get_basename() allocates new memory for the
2195 * returned string, unlike this function which returns a pointer
2196 * into the argument.
2199 g_basename (const gchar
*file_name
)
2203 g_return_val_if_fail (file_name
!= NULL
, NULL
);
2205 base
= strrchr (file_name
, G_DIR_SEPARATOR
);
2210 q
= strrchr (file_name
, '/');
2211 if (base
== NULL
|| (q
!= NULL
&& q
> base
))
2220 if (g_ascii_isalpha (file_name
[0]) && file_name
[1] == ':')
2221 return (gchar
*) file_name
+ 2;
2224 return (gchar
*) file_name
;
2228 * g_path_get_basename:
2229 * @file_name: the name of the file
2231 * Gets the last component of the filename.
2233 * If @file_name ends with a directory separator it gets the component
2234 * before the last slash. If @file_name consists only of directory
2235 * separators (and on Windows, possibly a drive letter), a single
2236 * separator is returned. If @file_name is empty, it gets ".".
2238 * Returns: a newly allocated string containing the last
2239 * component of the filename
2242 g_path_get_basename (const gchar
*file_name
)
2245 gssize last_nonslash
;
2249 g_return_val_if_fail (file_name
!= NULL
, NULL
);
2251 if (file_name
[0] == '\0')
2252 return g_strdup (".");
2254 last_nonslash
= strlen (file_name
) - 1;
2256 while (last_nonslash
>= 0 && G_IS_DIR_SEPARATOR (file_name
[last_nonslash
]))
2259 if (last_nonslash
== -1)
2260 /* string only containing slashes */
2261 return g_strdup (G_DIR_SEPARATOR_S
);
2264 if (last_nonslash
== 1 &&
2265 g_ascii_isalpha (file_name
[0]) &&
2266 file_name
[1] == ':')
2267 /* string only containing slashes and a drive */
2268 return g_strdup (G_DIR_SEPARATOR_S
);
2270 base
= last_nonslash
;
2272 while (base
>=0 && !G_IS_DIR_SEPARATOR (file_name
[base
]))
2277 g_ascii_isalpha (file_name
[0]) &&
2278 file_name
[1] == ':')
2280 #endif /* G_OS_WIN32 */
2282 len
= last_nonslash
- base
;
2283 retval
= g_malloc (len
+ 1);
2284 memcpy (retval
, file_name
+ base
+ 1, len
);
2285 retval
[len
] = '\0';
2292 * @file_name: the name of the file
2294 * Gets the directory components of a file name.
2296 * If the file name has no directory components "." is returned.
2297 * The returned string should be freed when no longer needed.
2299 * Returns: the directory components of the file
2301 * Deprecated: use g_path_get_dirname() instead
2305 * g_path_get_dirname:
2306 * @file_name: the name of the file
2308 * Gets the directory components of a file name.
2310 * If the file name has no directory components "." is returned.
2311 * The returned string should be freed when no longer needed.
2313 * Returns: the directory components of the file
2316 g_path_get_dirname (const gchar
*file_name
)
2321 g_return_val_if_fail (file_name
!= NULL
, NULL
);
2323 base
= strrchr (file_name
, G_DIR_SEPARATOR
);
2328 q
= strrchr (file_name
, '/');
2329 if (base
== NULL
|| (q
!= NULL
&& q
> base
))
2337 if (g_ascii_isalpha (file_name
[0]) && file_name
[1] == ':')
2339 gchar drive_colon_dot
[4];
2341 drive_colon_dot
[0] = file_name
[0];
2342 drive_colon_dot
[1] = ':';
2343 drive_colon_dot
[2] = '.';
2344 drive_colon_dot
[3] = '\0';
2346 return g_strdup (drive_colon_dot
);
2349 return g_strdup (".");
2352 while (base
> file_name
&& G_IS_DIR_SEPARATOR (*base
))
2356 /* base points to the char before the last slash.
2358 * In case file_name is the root of a drive (X:\) or a child of the
2359 * root of a drive (X:\foo), include the slash.
2361 * In case file_name is the root share of an UNC path
2362 * (\\server\share), add a slash, returning \\server\share\ .
2364 * In case file_name is a direct child of a share in an UNC path
2365 * (\\server\share\foo), include the slash after the share name,
2366 * returning \\server\share\ .
2368 if (base
== file_name
+ 1 &&
2369 g_ascii_isalpha (file_name
[0]) &&
2370 file_name
[1] == ':')
2372 else if (G_IS_DIR_SEPARATOR (file_name
[0]) &&
2373 G_IS_DIR_SEPARATOR (file_name
[1]) &&
2375 !G_IS_DIR_SEPARATOR (file_name
[2]) &&
2376 base
>= file_name
+ 2)
2378 const gchar
*p
= file_name
+ 2;
2379 while (*p
&& !G_IS_DIR_SEPARATOR (*p
))
2383 len
= (guint
) strlen (file_name
) + 1;
2384 base
= g_new (gchar
, len
+ 1);
2385 strcpy (base
, file_name
);
2386 base
[len
-1] = G_DIR_SEPARATOR
;
2390 if (G_IS_DIR_SEPARATOR (*p
))
2393 while (*p
&& !G_IS_DIR_SEPARATOR (*p
))
2401 len
= (guint
) 1 + base
- file_name
;
2402 base
= g_new (gchar
, len
+ 1);
2403 memmove (base
, file_name
, len
);
2409 #if defined(MAXPATHLEN)
2410 #define G_PATH_LENGTH MAXPATHLEN
2411 #elif defined(PATH_MAX)
2412 #define G_PATH_LENGTH PATH_MAX
2413 #elif defined(_PC_PATH_MAX)
2414 #define G_PATH_LENGTH sysconf(_PC_PATH_MAX)
2416 #define G_PATH_LENGTH 2048
2420 * g_get_current_dir:
2422 * Gets the current directory.
2424 * The returned string should be freed when no longer needed.
2425 * The encoding of the returned string is system defined.
2426 * On Windows, it is always UTF-8.
2428 * Since GLib 2.40, this function will return the value of the "PWD"
2429 * environment variable if it is set and it happens to be the same as
2430 * the current directory. This can make a difference in the case that
2431 * the current directory is the target of a symbolic link.
2433 * Returns: the current directory
2436 g_get_current_dir (void)
2441 wchar_t dummy
[2], *wdir
;
2444 len
= GetCurrentDirectoryW (2, dummy
);
2445 wdir
= g_new (wchar_t, len
);
2447 if (GetCurrentDirectoryW (len
, wdir
) == len
- 1)
2448 dir
= g_utf16_to_utf8 (wdir
, -1, NULL
, NULL
, NULL
);
2453 dir
= g_strdup ("\\");
2459 gchar
*buffer
= NULL
;
2461 static gulong max_len
= 0;
2462 struct stat pwdbuf
, dotbuf
;
2464 pwd
= g_getenv ("PWD");
2466 g_stat (".", &dotbuf
) == 0 && g_stat (pwd
, &pwdbuf
) == 0 &&
2467 dotbuf
.st_dev
== pwdbuf
.st_dev
&& dotbuf
.st_ino
== pwdbuf
.st_ino
)
2468 return g_strdup (pwd
);
2471 max_len
= (G_PATH_LENGTH
== -1) ? 2048 : G_PATH_LENGTH
;
2473 while (max_len
< G_MAXULONG
/ 2)
2476 buffer
= g_new (gchar
, max_len
+ 1);
2478 dir
= getcwd (buffer
, max_len
);
2480 if (dir
|| errno
!= ERANGE
)
2486 if (!dir
|| !*buffer
)
2488 /* hm, should we g_error() out here?
2489 * this can happen if e.g. "./" has mode \0000
2491 buffer
[0] = G_DIR_SEPARATOR
;
2495 dir
= g_strdup (buffer
);
2500 #endif /* !G_OS_WIN32 */
2504 /* NOTE : Keep this part last to ensure nothing in this file uses thn
2505 * below binary compatibility versions.
2507 #if defined (G_OS_WIN32) && !defined (_WIN64)
2509 /* Binary compatibility versions. Will be called by code compiled
2510 * against quite old (pre-2.8, I think) headers only, not from more
2511 * recently compiled code.
2517 g_file_test (const gchar
*filename
,
2520 gchar
*utf8_filename
= g_locale_to_utf8 (filename
, -1, NULL
, NULL
, NULL
);
2523 if (utf8_filename
== NULL
)
2526 retval
= g_file_test_utf8 (utf8_filename
, test
);
2528 g_free (utf8_filename
);
2533 #undef g_file_get_contents
2536 g_file_get_contents (const gchar
*filename
,
2541 gchar
*utf8_filename
= g_locale_to_utf8 (filename
, -1, NULL
, NULL
, error
);
2544 if (utf8_filename
== NULL
)
2547 retval
= g_file_get_contents_utf8 (utf8_filename
, contents
, length
, error
);
2549 g_free (utf8_filename
);
2557 wrap_libc_open (const gchar
*filename
,
2561 return open (filename
, flags
, mode
);
2565 g_mkstemp (gchar
*tmpl
)
2567 /* This is the backward compatibility system codepage version,
2568 * thus use normal open().
2570 return get_tmp_file (tmpl
, wrap_libc_open
,
2571 O_RDWR
| O_CREAT
| O_EXCL
, 0600);
2574 #undef g_file_open_tmp
2577 g_file_open_tmp (const gchar
*tmpl
,
2581 gchar
*utf8_tmpl
= g_locale_to_utf8 (tmpl
, -1, NULL
, NULL
, error
);
2582 gchar
*utf8_name_used
;
2585 if (utf8_tmpl
== NULL
)
2588 retval
= g_file_open_tmp_utf8 (utf8_tmpl
, &utf8_name_used
, error
);
2594 *name_used
= g_locale_from_utf8 (utf8_name_used
, -1, NULL
, NULL
, NULL
);
2596 g_free (utf8_name_used
);
2601 #undef g_get_current_dir
2604 g_get_current_dir (void)
2606 gchar
*utf8_dir
= g_get_current_dir_utf8 ();
2607 gchar
*dir
= g_locale_from_utf8 (utf8_dir
, -1, NULL
, NULL
, NULL
);