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 * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
22 #include "glibconfig.h"
24 #define G_STDIO_NO_WRAP_ON_UNIX
26 #include <sys/types.h>
40 #include <sys/utime.h>
49 #if !defined (G_OS_UNIX) && !defined (G_OS_WIN32)
50 #error Please port this to your operating system
53 #if defined (_MSC_VER) && !defined(_WIN64)
55 #define _wstat _wstat32
60 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
61 * @mode: as in access()
63 * A wrapper for the POSIX access() function. This function is used to
64 * test a pathname for one or several of read, write or execute
65 * permissions, or just existence.
67 * On Windows, the file protection mechanism is not at all POSIX-like,
68 * and the underlying function in the C library only checks the
69 * FAT-style READONLY attribute, and does not look at the ACL of a
70 * file at all. This function is this in practise almost useless on
71 * Windows. Software that needs to handle file permissions on Windows
72 * more exactly should use the Win32 API.
74 * See your C library manual for more details about access().
76 * Returns: zero if the pathname refers to an existing file system
77 * object that has all the tested permissions, or -1 otherwise
83 g_access (const gchar *filename,
87 wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
91 if (wfilename == NULL)
101 retval = _waccess (wfilename, mode & ~X_OK);
109 return access (filename, mode);
115 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
116 * @mode: as in chmod()
118 * A wrapper for the POSIX chmod() function. The chmod() function is
119 * used to set the permissions of a file system object.
121 * On Windows the file protection mechanism is not at all POSIX-like,
122 * and the underlying chmod() function in the C library just sets or
123 * clears the FAT-style READONLY attribute. It does not touch any
124 * ACL. Software that needs to manage file permissions on Windows
125 * exactly should use the Win32 API.
127 * See your C library manual for more details about chmod().
129 * Returns: 0 if the operation succeeded, -1 on error
134 g_chmod (const gchar *filename,
138 wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
142 if (wfilename == NULL)
148 retval = _wchmod (wfilename, mode);
156 return chmod (filename, mode);
161 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
162 * @flags: as in open()
163 * @mode: as in open()
165 * A wrapper for the POSIX open() function. The open() function is
166 * used to convert a pathname into a file descriptor.
168 * On POSIX systems file descriptors are implemented by the operating
169 * system. On Windows, it's the C library that implements open() and
170 * file descriptors. The actual Win32 API for opening files is quite
171 * different, see MSDN documentation for CreateFile(). The Win32 API
172 * uses file handles, which are more randomish integers, not small
173 * integers like file descriptors.
175 * Because file descriptors are specific to the C library on Windows,
176 * the file descriptor returned by this function makes sense only to
177 * functions in the same C library. Thus if the GLib-using code uses a
178 * different C library than GLib does, the file descriptor returned by
179 * this function cannot be passed to C library functions like write()
182 * See your C library manual for more details about open().
184 * Returns: a new file descriptor, or -1 if an error occurred.
185 * The return value can be used exactly like the return value
191 g_open (const gchar *filename,
196 wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
200 if (wfilename == NULL)
206 retval = _wopen (wfilename, flags, mode);
216 fd = open (filename, flags, mode);
217 while (G_UNLIKELY (fd == -1 && errno == EINTR));
224 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
225 * @mode: as in creat()
227 * A wrapper for the POSIX creat() function. The creat() function is
228 * used to convert a pathname into a file descriptor, creating a file
231 * On POSIX systems file descriptors are implemented by the operating
232 * system. On Windows, it's the C library that implements creat() and
233 * file descriptors. The actual Windows API for opening files is
234 * different, see MSDN documentation for CreateFile(). The Win32 API
235 * uses file handles, which are more randomish integers, not small
236 * integers like file descriptors.
238 * Because file descriptors are specific to the C library on Windows,
239 * the file descriptor returned by this function makes sense only to
240 * functions in the same C library. Thus if the GLib-using code uses a
241 * different C library than GLib does, the file descriptor returned by
242 * this function cannot be passed to C library functions like write()
245 * See your C library manual for more details about creat().
247 * Returns: a new file descriptor, or -1 if an error occurred.
248 * The return value can be used exactly like the return value
254 g_creat (const gchar *filename,
258 wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
262 if (wfilename == NULL)
268 retval = _wcreat (wfilename, mode);
276 return creat (filename, mode);
282 * @oldfilename: a pathname in the GLib file name encoding (UTF-8 on Windows)
283 * @newfilename: a pathname in the GLib file name encoding
285 * A wrapper for the POSIX rename() function. The rename() function
286 * renames a file, moving it between directories if required.
288 * See your C library manual for more details about how rename() works
289 * on your system. It is not possible in general on Windows to rename
290 * a file that is open to some process.
292 * Returns: 0 if the renaming succeeded, -1 if an error occurred
297 g_rename (const gchar *oldfilename,
298 const gchar *newfilename)
301 wchar_t *woldfilename = g_utf8_to_utf16 (oldfilename, -1, NULL, NULL, NULL);
302 wchar_t *wnewfilename;
306 if (woldfilename == NULL)
312 wnewfilename = g_utf8_to_utf16 (newfilename, -1, NULL, NULL, NULL);
314 if (wnewfilename == NULL)
316 g_free (woldfilename);
321 if (MoveFileExW (woldfilename, wnewfilename, MOVEFILE_REPLACE_EXISTING))
326 switch (GetLastError ())
328 #define CASE(a,b) case ERROR_##a: save_errno = b; break
329 CASE (FILE_NOT_FOUND, ENOENT);
330 CASE (PATH_NOT_FOUND, ENOENT);
331 CASE (ACCESS_DENIED, EACCES);
332 CASE (NOT_SAME_DEVICE, EXDEV);
333 CASE (LOCK_VIOLATION, EACCES);
334 CASE (SHARING_VIOLATION, EACCES);
335 CASE (FILE_EXISTS, EEXIST);
336 CASE (ALREADY_EXISTS, EEXIST);
338 default: save_errno = EIO;
342 g_free (woldfilename);
343 g_free (wnewfilename);
348 return rename (oldfilename, newfilename);
354 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
355 * @mode: permissions to use for the newly created directory
357 * A wrapper for the POSIX mkdir() function. The mkdir() function
358 * attempts to create a directory with the given name and permissions.
359 * The mode argument is ignored on Windows.
361 * See your C library manual for more details about mkdir().
363 * Returns: 0 if the directory was successfully created, -1 if an error
369 g_mkdir (const gchar *filename,
373 wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
377 if (wfilename == NULL)
383 retval = _wmkdir (wfilename);
391 return mkdir (filename, mode);
397 * @path: a pathname in the GLib file name encoding (UTF-8 on Windows)
399 * A wrapper for the POSIX chdir() function. The function changes the
400 * current directory of the process to @path.
402 * See your C library manual for more details about chdir().
404 * Returns: 0 on success, -1 if an error occurred.
409 g_chdir (const gchar *path)
412 wchar_t *wpath = g_utf8_to_utf16 (path, -1, NULL, NULL, NULL);
422 retval = _wchdir (wpath);
437 * A type corresponding to the appropriate struct type for the stat()
438 * system call, depending on the platform and/or compiler being used.
440 * See g_stat() for more information.
444 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
445 * @buf: a pointer to a stat struct, which will be filled with the file
448 * A wrapper for the POSIX stat() function. The stat() function
449 * returns information about a file. On Windows the stat() function in
450 * the C library checks only the FAT-style READONLY attribute and does
451 * not look at the ACL at all. Thus on Windows the protection bits in
452 * the @st_mode field are a fabrication of little use.
454 * On Windows the Microsoft C libraries have several variants of the
455 * stat struct and stat() function with names like _stat(), _stat32(),
456 * _stat32i64() and _stat64i32(). The one used here is for 32-bit code
457 * the one with 32-bit size and time fields, specifically called _stat32().
459 * In Microsoft's compiler, by default struct stat means one with
460 * 64-bit time fields while in MinGW struct stat is the legacy one
461 * with 32-bit fields. To hopefully clear up this messs, the gstdio.h
462 * header defines a type #GStatBuf which is the appropriate struct type
463 * depending on the platform and/or compiler being used. On POSIX it
464 * is just struct stat, but note that even on POSIX platforms, stat()
467 * See your C library manual for more details about stat().
469 * Returns: 0 if the information was successfully retrieved,
470 * -1 if an error occurred
475 g_stat (const gchar *filename,
479 wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
484 if (wfilename == NULL)
490 len = wcslen (wfilename);
491 while (len > 0 && G_IS_DIR_SEPARATOR (wfilename[len-1]))
494 (!g_path_is_absolute (filename) || len > g_path_skip_root (filename) - filename))
495 wfilename[len] = '\0';
497 retval = _wstat (wfilename, buf);
505 return stat (filename, buf);
511 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
512 * @buf: a pointer to a stat struct, which will be filled with the file
515 * A wrapper for the POSIX lstat() function. The lstat() function is
516 * like stat() except that in the case of symbolic links, it returns
517 * information about the symbolic link itself and not the file that it
518 * refers to. If the system does not support symbolic links g_lstat()
519 * is identical to g_stat().
521 * See your C library manual for more details about lstat().
523 * Returns: 0 if the information was successfully retrieved,
524 * -1 if an error occurred
529 g_lstat (const gchar *filename,
533 /* This can't be Win32, so don't do the widechar dance. */
534 return lstat (filename, buf);
536 return g_stat (filename, buf);
542 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
544 * A wrapper for the POSIX unlink() function. The unlink() function
545 * deletes a name from the filesystem. If this was the last link to the
546 * file and no processes have it opened, the diskspace occupied by the
549 * See your C library manual for more details about unlink(). Note
550 * that on Windows, it is in general not possible to delete files that
551 * are open to some process, or mapped into memory.
553 * Returns: 0 if the name was successfully deleted, -1 if an error
559 g_unlink (const gchar *filename)
562 wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
566 if (wfilename == NULL)
572 retval = _wunlink (wfilename);
580 return unlink (filename);
586 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
588 * A wrapper for the POSIX remove() function. The remove() function
589 * deletes a name from the filesystem.
591 * See your C library manual for more details about how remove() works
592 * on your system. On Unix, remove() removes also directories, as it
593 * calls unlink() for files and rmdir() for directories. On Windows,
594 * although remove() in the C library only works for files, this
595 * function tries first remove() and then if that fails rmdir(), and
596 * thus works for both files and directories. Note however, that on
597 * Windows, it is in general not possible to remove a file that is
598 * open to some process, or mapped into memory.
600 * If this function fails on Windows you can't infer too much from the
601 * errno value. rmdir() is tried regardless of what caused remove() to
602 * fail. Any errno value set by remove() will be overwritten by that
605 * Returns: 0 if the file was successfully removed, -1 if an error
611 g_remove (const gchar *filename)
614 wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
618 if (wfilename == NULL)
624 retval = _wremove (wfilename);
626 retval = _wrmdir (wfilename);
634 return remove (filename);
640 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
642 * A wrapper for the POSIX rmdir() function. The rmdir() function
643 * deletes a directory from the filesystem.
645 * See your C library manual for more details about how rmdir() works
648 * Returns: 0 if the directory was successfully removed, -1 if an error
654 g_rmdir (const gchar *filename)
657 wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
661 if (wfilename == NULL)
667 retval = _wrmdir (wfilename);
675 return rmdir (filename);
681 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
682 * @mode: a string describing the mode in which the file should be opened
684 * A wrapper for the stdio fopen() function. The fopen() function
685 * opens a file and associates a new stream with it.
687 * Because file descriptors are specific to the C library on Windows,
688 * and a file descriptor is part of the FILE struct, the FILE* returned
689 * by this function makes sense only to functions in the same C library.
690 * Thus if the GLib-using code uses a different C library than GLib does,
691 * the FILE* returned by this function cannot be passed to C library
692 * functions like fprintf() or fread().
694 * See your C library manual for more details about fopen().
696 * Returns: A FILE* if the file was successfully opened, or %NULL if
702 g_fopen (const gchar *filename,
706 wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
711 if (wfilename == NULL)
717 wmode = g_utf8_to_utf16 (mode, -1, NULL, NULL, NULL);
726 retval = _wfopen (wfilename, wmode);
735 return fopen (filename, mode);
741 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
742 * @mode: a string describing the mode in which the file should be opened
743 * @stream: (allow-none): an existing stream which will be reused, or %NULL
745 * A wrapper for the POSIX freopen() function. The freopen() function
746 * opens a file and associates it with an existing stream.
748 * See your C library manual for more details about freopen().
750 * Returns: A FILE* if the file was successfully opened, or %NULL if
756 g_freopen (const gchar *filename,
761 wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
766 if (wfilename == NULL)
772 wmode = g_utf8_to_utf16 (mode, -1, NULL, NULL, NULL);
781 retval = _wfreopen (wfilename, wmode, stream);
790 return freopen (filename, mode, stream);
796 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
797 * @utb: a pointer to a struct utimbuf.
799 * A wrapper for the POSIX utime() function. The utime() function
800 * sets the access and modification timestamps of a file.
802 * See your C library manual for more details about how utime() works
805 * Returns: 0 if the operation was successful, -1 if an error occurred
810 g_utime (const gchar *filename,
814 wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
818 if (wfilename == NULL)
824 retval = _wutime (wfilename, (struct _utimbuf*) utb);
832 return utime (filename, utb);
838 * @fd: A file descriptor
841 * This wraps the close() call; in case of error, %errno will be
842 * preserved, but the error will also be stored as a #GError in @error.
844 * Besides using #GError, there is another major reason to prefer this
845 * function over the call provided by the system; on Unix, it will
846 * attempt to correctly handle %EINTR, which has platform-specific
857 /* Just ignore EINTR for now; a retry loop is the wrong thing to do
858 * on Linux at least. Anyone who wants to add a conditional check
859 * for e.g. HP-UX is welcome to do so later...
861 * http://lkml.indiana.edu/hypermail/linux/kernel/0509.1/0877.html
862 * https://bugzilla.gnome.org/show_bug.cgi?id=682819
863 * http://utcc.utoronto.ca/~cks/space/blog/unix/CloseEINTR
864 * https://sites.google.com/site/michaelsafyan/software-engineering/checkforeintrwheninvokingclosethinkagain
866 if (G_UNLIKELY (res == -1 && errno == EINTR))
871 g_set_error_literal (error, G_FILE_ERROR,
872 g_file_error_from_errno (errsv),