1 /* gstdio.c - wrappers for C library functions
3 * Copyright 2004 Tor Lillqvist
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"
23 #define G_STDIO_NO_WRAP_ON_UNIX
25 #include <sys/types.h>
39 #include <sys/utime.h>
48 #if !defined (G_OS_UNIX) && !defined (G_OS_WIN32)
49 #error Please port this to your operating system
52 #if defined (_MSC_VER) && !defined(_WIN64)
54 #define _wstat _wstat32
59 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
60 * @mode: as in access()
62 * A wrapper for the POSIX access() function. This function is used to
63 * test a pathname for one or several of read, write or execute
64 * permissions, or just existence.
66 * On Windows, the file protection mechanism is not at all POSIX-like,
67 * and the underlying function in the C library only checks the
68 * FAT-style READONLY attribute, and does not look at the ACL of a
69 * file at all. This function is this in practise almost useless on
70 * Windows. Software that needs to handle file permissions on Windows
71 * more exactly should use the Win32 API.
73 * See your C library manual for more details about access().
75 * Returns: zero if the pathname refers to an existing file system
76 * object that has all the tested permissions, or -1 otherwise
82 g_access (const gchar
*filename
,
86 wchar_t *wfilename
= g_utf8_to_utf16 (filename
, -1, NULL
, NULL
, NULL
);
90 if (wfilename
== NULL
)
100 retval
= _waccess (wfilename
, mode
& ~X_OK
);
108 return access (filename
, mode
);
114 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
115 * @mode: as in chmod()
117 * A wrapper for the POSIX chmod() function. The chmod() function is
118 * used to set the permissions of a file system object.
120 * On Windows the file protection mechanism is not at all POSIX-like,
121 * and the underlying chmod() function in the C library just sets or
122 * clears the FAT-style READONLY attribute. It does not touch any
123 * ACL. Software that needs to manage file permissions on Windows
124 * exactly should use the Win32 API.
126 * See your C library manual for more details about chmod().
128 * Returns: 0 if the operation succeeded, -1 on error
133 g_chmod (const gchar
*filename
,
137 wchar_t *wfilename
= g_utf8_to_utf16 (filename
, -1, NULL
, NULL
, NULL
);
141 if (wfilename
== NULL
)
147 retval
= _wchmod (wfilename
, mode
);
155 return chmod (filename
, mode
);
160 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
161 * @flags: as in open()
162 * @mode: as in open()
164 * A wrapper for the POSIX open() function. The open() function is
165 * used to convert a pathname into a file descriptor.
167 * On POSIX systems file descriptors are implemented by the operating
168 * system. On Windows, it's the C library that implements open() and
169 * file descriptors. The actual Win32 API for opening files is quite
170 * different, see MSDN documentation for CreateFile(). The Win32 API
171 * uses file handles, which are more randomish integers, not small
172 * integers like file descriptors.
174 * Because file descriptors are specific to the C library on Windows,
175 * the file descriptor returned by this function makes sense only to
176 * functions in the same C library. Thus if the GLib-using code uses a
177 * different C library than GLib does, the file descriptor returned by
178 * this function cannot be passed to C library functions like write()
181 * See your C library manual for more details about open().
183 * Returns: a new file descriptor, or -1 if an error occurred.
184 * The return value can be used exactly like the return value
190 g_open (const gchar
*filename
,
195 wchar_t *wfilename
= g_utf8_to_utf16 (filename
, -1, NULL
, NULL
, NULL
);
199 if (wfilename
== NULL
)
205 retval
= _wopen (wfilename
, flags
, mode
);
215 fd
= open (filename
, flags
, mode
);
216 while (G_UNLIKELY (fd
== -1 && errno
== EINTR
));
223 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
224 * @mode: as in creat()
226 * A wrapper for the POSIX creat() function. The creat() function is
227 * used to convert a pathname into a file descriptor, creating a file
230 * On POSIX systems file descriptors are implemented by the operating
231 * system. On Windows, it's the C library that implements creat() and
232 * file descriptors. The actual Windows API for opening files is
233 * different, see MSDN documentation for CreateFile(). The Win32 API
234 * uses file handles, which are more randomish integers, not small
235 * integers like file descriptors.
237 * Because file descriptors are specific to the C library on Windows,
238 * the file descriptor returned by this function makes sense only to
239 * functions in the same C library. Thus if the GLib-using code uses a
240 * different C library than GLib does, the file descriptor returned by
241 * this function cannot be passed to C library functions like write()
244 * See your C library manual for more details about creat().
246 * Returns: a new file descriptor, or -1 if an error occurred.
247 * The return value can be used exactly like the return value
253 g_creat (const gchar
*filename
,
257 wchar_t *wfilename
= g_utf8_to_utf16 (filename
, -1, NULL
, NULL
, NULL
);
261 if (wfilename
== NULL
)
267 retval
= _wcreat (wfilename
, mode
);
275 return creat (filename
, mode
);
281 * @oldfilename: a pathname in the GLib file name encoding (UTF-8 on Windows)
282 * @newfilename: a pathname in the GLib file name encoding
284 * A wrapper for the POSIX rename() function. The rename() function
285 * renames a file, moving it between directories if required.
287 * See your C library manual for more details about how rename() works
288 * on your system. It is not possible in general on Windows to rename
289 * a file that is open to some process.
291 * Returns: 0 if the renaming succeeded, -1 if an error occurred
296 g_rename (const gchar
*oldfilename
,
297 const gchar
*newfilename
)
300 wchar_t *woldfilename
= g_utf8_to_utf16 (oldfilename
, -1, NULL
, NULL
, NULL
);
301 wchar_t *wnewfilename
;
305 if (woldfilename
== NULL
)
311 wnewfilename
= g_utf8_to_utf16 (newfilename
, -1, NULL
, NULL
, NULL
);
313 if (wnewfilename
== NULL
)
315 g_free (woldfilename
);
320 if (MoveFileExW (woldfilename
, wnewfilename
, MOVEFILE_REPLACE_EXISTING
))
325 switch (GetLastError ())
327 #define CASE(a,b) case ERROR_##a: save_errno = b; break
328 CASE (FILE_NOT_FOUND
, ENOENT
);
329 CASE (PATH_NOT_FOUND
, ENOENT
);
330 CASE (ACCESS_DENIED
, EACCES
);
331 CASE (NOT_SAME_DEVICE
, EXDEV
);
332 CASE (LOCK_VIOLATION
, EACCES
);
333 CASE (SHARING_VIOLATION
, EACCES
);
334 CASE (FILE_EXISTS
, EEXIST
);
335 CASE (ALREADY_EXISTS
, EEXIST
);
337 default: save_errno
= EIO
;
341 g_free (woldfilename
);
342 g_free (wnewfilename
);
347 return rename (oldfilename
, newfilename
);
353 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
354 * @mode: permissions to use for the newly created directory
356 * A wrapper for the POSIX mkdir() function. The mkdir() function
357 * attempts to create a directory with the given name and permissions.
358 * The mode argument is ignored on Windows.
360 * See your C library manual for more details about mkdir().
362 * Returns: 0 if the directory was successfully created, -1 if an error
368 g_mkdir (const gchar
*filename
,
372 wchar_t *wfilename
= g_utf8_to_utf16 (filename
, -1, NULL
, NULL
, NULL
);
376 if (wfilename
== NULL
)
382 retval
= _wmkdir (wfilename
);
390 return mkdir (filename
, mode
);
396 * @path: a pathname in the GLib file name encoding (UTF-8 on Windows)
398 * A wrapper for the POSIX chdir() function. The function changes the
399 * current directory of the process to @path.
401 * See your C library manual for more details about chdir().
403 * Returns: 0 on success, -1 if an error occurred.
408 g_chdir (const gchar
*path
)
411 wchar_t *wpath
= g_utf8_to_utf16 (path
, -1, NULL
, NULL
, NULL
);
421 retval
= _wchdir (wpath
);
436 * A type corresponding to the appropriate struct type for the stat()
437 * system call, depending on the platform and/or compiler being used.
439 * See g_stat() for more information.
443 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
444 * @buf: a pointer to a stat struct, which will be filled with the file
447 * A wrapper for the POSIX stat() function. The stat() function
448 * returns information about a file. On Windows the stat() function in
449 * the C library checks only the FAT-style READONLY attribute and does
450 * not look at the ACL at all. Thus on Windows the protection bits in
451 * the @st_mode field are a fabrication of little use.
453 * On Windows the Microsoft C libraries have several variants of the
454 * stat struct and stat() function with names like _stat(), _stat32(),
455 * _stat32i64() and _stat64i32(). The one used here is for 32-bit code
456 * the one with 32-bit size and time fields, specifically called _stat32().
458 * In Microsoft's compiler, by default struct stat means one with
459 * 64-bit time fields while in MinGW struct stat is the legacy one
460 * with 32-bit fields. To hopefully clear up this messs, the gstdio.h
461 * header defines a type #GStatBuf which is the appropriate struct type
462 * depending on the platform and/or compiler being used. On POSIX it
463 * is just struct stat, but note that even on POSIX platforms, stat()
466 * See your C library manual for more details about stat().
468 * Returns: 0 if the information was successfully retrieved,
469 * -1 if an error occurred
474 g_stat (const gchar
*filename
,
478 wchar_t *wfilename
= g_utf8_to_utf16 (filename
, -1, NULL
, NULL
, NULL
);
483 if (wfilename
== NULL
)
489 len
= wcslen (wfilename
);
490 while (len
> 0 && G_IS_DIR_SEPARATOR (wfilename
[len
-1]))
493 (!g_path_is_absolute (filename
) || len
> g_path_skip_root (filename
) - filename
))
494 wfilename
[len
] = '\0';
496 retval
= _wstat (wfilename
, buf
);
504 return stat (filename
, buf
);
510 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
511 * @buf: a pointer to a stat struct, which will be filled with the file
514 * A wrapper for the POSIX lstat() function. The lstat() function is
515 * like stat() except that in the case of symbolic links, it returns
516 * information about the symbolic link itself and not the file that it
517 * refers to. If the system does not support symbolic links g_lstat()
518 * is identical to g_stat().
520 * See your C library manual for more details about lstat().
522 * Returns: 0 if the information was successfully retrieved,
523 * -1 if an error occurred
528 g_lstat (const gchar
*filename
,
532 /* This can't be Win32, so don't do the widechar dance. */
533 return lstat (filename
, buf
);
535 return g_stat (filename
, buf
);
541 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
543 * A wrapper for the POSIX unlink() function. The unlink() function
544 * deletes a name from the filesystem. If this was the last link to the
545 * file and no processes have it opened, the diskspace occupied by the
548 * See your C library manual for more details about unlink(). Note
549 * that on Windows, it is in general not possible to delete files that
550 * are open to some process, or mapped into memory.
552 * Returns: 0 if the name was successfully deleted, -1 if an error
558 g_unlink (const gchar
*filename
)
561 wchar_t *wfilename
= g_utf8_to_utf16 (filename
, -1, NULL
, NULL
, NULL
);
565 if (wfilename
== NULL
)
571 retval
= _wunlink (wfilename
);
579 return unlink (filename
);
585 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
587 * A wrapper for the POSIX remove() function. The remove() function
588 * deletes a name from the filesystem.
590 * See your C library manual for more details about how remove() works
591 * on your system. On Unix, remove() removes also directories, as it
592 * calls unlink() for files and rmdir() for directories. On Windows,
593 * although remove() in the C library only works for files, this
594 * function tries first remove() and then if that fails rmdir(), and
595 * thus works for both files and directories. Note however, that on
596 * Windows, it is in general not possible to remove a file that is
597 * open to some process, or mapped into memory.
599 * If this function fails on Windows you can't infer too much from the
600 * errno value. rmdir() is tried regardless of what caused remove() to
601 * fail. Any errno value set by remove() will be overwritten by that
604 * Returns: 0 if the file was successfully removed, -1 if an error
610 g_remove (const gchar
*filename
)
613 wchar_t *wfilename
= g_utf8_to_utf16 (filename
, -1, NULL
, NULL
, NULL
);
617 if (wfilename
== NULL
)
623 retval
= _wremove (wfilename
);
625 retval
= _wrmdir (wfilename
);
633 return remove (filename
);
639 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
641 * A wrapper for the POSIX rmdir() function. The rmdir() function
642 * deletes a directory from the filesystem.
644 * See your C library manual for more details about how rmdir() works
647 * Returns: 0 if the directory was successfully removed, -1 if an error
653 g_rmdir (const gchar
*filename
)
656 wchar_t *wfilename
= g_utf8_to_utf16 (filename
, -1, NULL
, NULL
, NULL
);
660 if (wfilename
== NULL
)
666 retval
= _wrmdir (wfilename
);
674 return rmdir (filename
);
680 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
681 * @mode: a string describing the mode in which the file should be opened
683 * A wrapper for the stdio fopen() function. The fopen() function
684 * opens a file and associates a new stream with it.
686 * Because file descriptors are specific to the C library on Windows,
687 * and a file descriptor is part of the FILE struct, the FILE* returned
688 * by this function makes sense only to functions in the same C library.
689 * Thus if the GLib-using code uses a different C library than GLib does,
690 * the FILE* returned by this function cannot be passed to C library
691 * functions like fprintf() or fread().
693 * See your C library manual for more details about fopen().
695 * Returns: A FILE* if the file was successfully opened, or %NULL if
701 g_fopen (const gchar
*filename
,
705 wchar_t *wfilename
= g_utf8_to_utf16 (filename
, -1, NULL
, NULL
, NULL
);
710 if (wfilename
== NULL
)
716 wmode
= g_utf8_to_utf16 (mode
, -1, NULL
, NULL
, NULL
);
725 retval
= _wfopen (wfilename
, wmode
);
734 return fopen (filename
, mode
);
740 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
741 * @mode: a string describing the mode in which the file should be opened
742 * @stream: (allow-none): an existing stream which will be reused, or %NULL
744 * A wrapper for the POSIX freopen() function. The freopen() function
745 * opens a file and associates it with an existing stream.
747 * See your C library manual for more details about freopen().
749 * Returns: A FILE* if the file was successfully opened, or %NULL if
755 g_freopen (const gchar
*filename
,
760 wchar_t *wfilename
= g_utf8_to_utf16 (filename
, -1, NULL
, NULL
, NULL
);
765 if (wfilename
== NULL
)
771 wmode
= g_utf8_to_utf16 (mode
, -1, NULL
, NULL
, NULL
);
780 retval
= _wfreopen (wfilename
, wmode
, stream
);
789 return freopen (filename
, mode
, stream
);
795 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
796 * @utb: a pointer to a struct utimbuf.
798 * A wrapper for the POSIX utime() function. The utime() function
799 * sets the access and modification timestamps of a file.
801 * See your C library manual for more details about how utime() works
804 * Returns: 0 if the operation was successful, -1 if an error occurred
809 g_utime (const gchar
*filename
,
813 wchar_t *wfilename
= g_utf8_to_utf16 (filename
, -1, NULL
, NULL
, NULL
);
817 if (wfilename
== NULL
)
823 retval
= _wutime (wfilename
, (struct _utimbuf
*) utb
);
831 return utime (filename
, utb
);
837 * @fd: A file descriptor
840 * This wraps the close() call; in case of error, %errno will be
841 * preserved, but the error will also be stored as a #GError in @error.
843 * Besides using #GError, there is another major reason to prefer this
844 * function over the call provided by the system; on Unix, it will
845 * attempt to correctly handle %EINTR, which has platform-specific
848 * Returns: %TRUE on success, %FALSE if there was an error.
858 /* Just ignore EINTR for now; a retry loop is the wrong thing to do
859 * on Linux at least. Anyone who wants to add a conditional check
860 * for e.g. HP-UX is welcome to do so later...
862 * http://lkml.indiana.edu/hypermail/linux/kernel/0509.1/0877.html
863 * https://bugzilla.gnome.org/show_bug.cgi?id=682819
864 * http://utcc.utoronto.ca/~cks/space/blog/unix/CloseEINTR
865 * https://sites.google.com/site/michaelsafyan/software-engineering/checkforeintrwheninvokingclosethinkagain
867 if (G_UNLIKELY (res
== -1 && errno
== EINTR
))
872 g_set_error_literal (error
, G_FILE_ERROR
,
873 g_file_error_from_errno (errsv
),