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.
23 #define G_STDIO_NO_WRAP_ON_UNIX
27 #include <sys/types.h>
41 #include <sys/utime.h>
50 #if !defined (G_OS_UNIX) && !defined (G_OS_WIN32) && !defined (G_OS_BEOS)
51 #error Please port this to your operating system
57 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
58 * @mode: as in access()
60 * A wrapper for the POSIX access() function. This function is used to
61 * test a pathname for one or several of read, write or execute
62 * permissions, or just existence.
64 * On Windows, the file protection mechanism is not at all POSIX-like,
65 * and the underlying function in the C library only checks the
66 * FAT-style READONLY attribute, and does not look at the ACL of a
67 * file at all. This function is this in practise almost useless on
68 * Windows. Software that needs to handle file permissions on Windows
69 * more exactly should use the Win32 API.
71 * See your C library manual for more details about access().
73 * Returns: zero if the pathname refers to an existing file system
74 * object that has all the tested permissions, or -1 otherwise or on
80 g_access (const gchar
*filename
,
84 wchar_t *wfilename
= g_utf8_to_utf16 (filename
, -1, NULL
, NULL
, NULL
);
88 if (wfilename
== NULL
)
98 retval
= _waccess (wfilename
, mode
& ~X_OK
);
106 return access (filename
, mode
);
112 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
113 * @mode: as in chmod()
115 * A wrapper for the POSIX chmod() function. The chmod() function is
116 * used to set the permissions of a file system object.
118 * On Windows the file protection mechanism is not at all POSIX-like,
119 * and the underlying chmod() function in the C library just sets or
120 * clears the FAT-style READONLY attribute. It does not touch any
121 * ACL. Software that needs to manage file permissions on Windows
122 * exactly should use the Win32 API.
124 * See your C library manual for more details about chmod().
126 * Returns: zero if the operation succeeded, -1 on error.
131 g_chmod (const gchar
*filename
,
135 wchar_t *wfilename
= g_utf8_to_utf16 (filename
, -1, NULL
, NULL
, NULL
);
139 if (wfilename
== NULL
)
145 retval
= _wchmod (wfilename
, mode
);
153 return chmod (filename
, mode
);
158 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
159 * @flags: as in open()
160 * @mode: as in open()
162 * A wrapper for the POSIX open() function. The open() function is
163 * used to convert a pathname into a file descriptor.
165 * On POSIX systems file descriptors are implemented by the operating
166 * system. On Windows, it's the C library that implements open() and
167 * file descriptors. The actual Win32 API for opening files is quite
168 * different, see MSDN documentation for CreateFile(). The Win32 API
169 * uses file handles, which are more randomish integers, not small
170 * integers like file descriptors.
172 * Because file descriptors are specific to the C library on Windows,
173 * the file descriptor returned by this function makes sense only to
174 * functions in the same C library. Thus if the GLib-using code uses a
175 * different C library than GLib does, the file descriptor returned by
176 * this function cannot be passed to C library functions like write()
179 * See your C library manual for more details about open().
181 * Returns: a new file descriptor, or -1 if an error occurred. The
182 * return value can be used exactly like the return value from open().
187 g_open (const gchar
*filename
,
192 wchar_t *wfilename
= g_utf8_to_utf16 (filename
, -1, NULL
, NULL
, NULL
);
196 if (wfilename
== NULL
)
202 retval
= _wopen (wfilename
, flags
, mode
);
210 return open (filename
, flags
, mode
);
216 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
217 * @mode: as in creat()
219 * A wrapper for the POSIX creat() function. The creat() function is
220 * used to convert a pathname into a file descriptor, creating a file
223 * On POSIX systems file descriptors are implemented by the operating
224 * system. On Windows, it's the C library that implements creat() and
225 * file descriptors. The actual Windows API for opening files is
226 * different, see MSDN documentation for CreateFile(). The Win32 API
227 * uses file handles, which are more randomish integers, not small
228 * integers like file descriptors.
230 * Because file descriptors are specific to the C library on Windows,
231 * the file descriptor returned by this function makes sense only to
232 * functions in the same C library. Thus if the GLib-using code uses a
233 * different C library than GLib does, the file descriptor returned by
234 * this function cannot be passed to C library functions like write()
237 * See your C library manual for more details about creat().
239 * Returns: a new file descriptor, or -1 if an error occurred. The
240 * return value can be used exactly like the return value from creat().
245 g_creat (const gchar
*filename
,
249 wchar_t *wfilename
= g_utf8_to_utf16 (filename
, -1, NULL
, NULL
, NULL
);
253 if (wfilename
== NULL
)
259 retval
= _wcreat (wfilename
, mode
);
267 return creat (filename
, mode
);
273 * @oldfilename: a pathname in the GLib file name encoding (UTF-8 on Windows)
274 * @newfilename: a pathname in the GLib file name encoding
276 * A wrapper for the POSIX rename() function. The rename() function
277 * renames a file, moving it between directories if required.
279 * See your C library manual for more details about how rename() works
280 * on your system. It is not possible in general on Windows to rename
281 * a file that is open to some process.
283 * Returns: 0 if the renaming succeeded, -1 if an error occurred
288 g_rename (const gchar
*oldfilename
,
289 const gchar
*newfilename
)
292 wchar_t *woldfilename
= g_utf8_to_utf16 (oldfilename
, -1, NULL
, NULL
, NULL
);
293 wchar_t *wnewfilename
;
297 if (woldfilename
== NULL
)
303 wnewfilename
= g_utf8_to_utf16 (newfilename
, -1, NULL
, NULL
, NULL
);
305 if (wnewfilename
== NULL
)
307 g_free (woldfilename
);
312 if (MoveFileExW (woldfilename
, wnewfilename
, MOVEFILE_REPLACE_EXISTING
))
317 switch (GetLastError ())
319 #define CASE(a,b) case ERROR_##a: save_errno = b; break
320 CASE (FILE_NOT_FOUND
, ENOENT
);
321 CASE (PATH_NOT_FOUND
, ENOENT
);
322 CASE (ACCESS_DENIED
, EACCES
);
323 CASE (NOT_SAME_DEVICE
, EXDEV
);
324 CASE (LOCK_VIOLATION
, EACCES
);
325 CASE (SHARING_VIOLATION
, EACCES
);
326 CASE (FILE_EXISTS
, EEXIST
);
327 CASE (ALREADY_EXISTS
, EEXIST
);
329 default: save_errno
= EIO
;
333 g_free (woldfilename
);
334 g_free (wnewfilename
);
339 return rename (oldfilename
, newfilename
);
345 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
346 * @mode: permissions to use for the newly created directory
348 * A wrapper for the POSIX mkdir() function. The mkdir() function
349 * attempts to create a directory with the given name and permissions.
350 * The mode argument is ignored on Windows.
352 * See your C library manual for more details about mkdir().
354 * Returns: 0 if the directory was successfully created, -1 if an error
360 g_mkdir (const gchar
*filename
,
364 wchar_t *wfilename
= g_utf8_to_utf16 (filename
, -1, NULL
, NULL
, NULL
);
368 if (wfilename
== NULL
)
374 retval
= _wmkdir (wfilename
);
382 return mkdir (filename
, mode
);
388 * @path: a pathname in the GLib file name encoding (UTF-8 on Windows)
390 * A wrapper for the POSIX chdir() function. The function changes the
391 * current directory of the process to @path.
393 * See your C library manual for more details about chdir().
395 * Returns: 0 on success, -1 if an error occurred.
400 g_chdir (const gchar
*path
)
403 wchar_t *wpath
= g_utf8_to_utf16 (path
, -1, NULL
, NULL
, NULL
);
413 retval
= _wchdir (wpath
);
427 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
428 * @buf: a pointer to a <structname>stat</structname> struct, which
429 * will be filled with the file information
431 * A wrapper for the POSIX stat() function. The stat() function
432 * returns information about a file. On Windows the stat() function in
433 * the C library checks only the FAT-style READONLY attribute and does
434 * not look at the ACL at all. Thus on Windows the protection bits in
435 * the st_mode field are a fabrication of little use.
437 * See your C library manual for more details about stat().
439 * Returns: 0 if the information was successfully retrieved, -1 if an error
445 g_stat (const gchar
*filename
,
449 wchar_t *wfilename
= g_utf8_to_utf16 (filename
, -1, NULL
, NULL
, NULL
);
454 if (wfilename
== NULL
)
460 len
= wcslen (wfilename
);
461 while (len
> 0 && G_IS_DIR_SEPARATOR (wfilename
[len
-1]))
464 (!g_path_is_absolute (filename
) || len
> g_path_skip_root (filename
) - filename
))
465 wfilename
[len
] = '\0';
467 retval
= _wstat (wfilename
, (struct _stat
*) buf
);
475 return stat (filename
, buf
);
481 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
482 * @buf: a pointer to a <structname>stat</structname> struct, which
483 * will be filled with the file information
485 * A wrapper for the POSIX lstat() function. The lstat() function is
486 * like stat() except that in the case of symbolic links, it returns
487 * information about the symbolic link itself and not the file that it
488 * refers to. If the system does not support symbolic links g_lstat()
489 * is identical to g_stat().
491 * See your C library manual for more details about lstat().
493 * Returns: 0 if the information was successfully retrieved, -1 if an error
499 g_lstat (const gchar
*filename
,
503 /* This can't be Win32, so don't do the widechar dance. */
504 return lstat (filename
, buf
);
506 return g_stat (filename
, buf
);
512 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
514 * A wrapper for the POSIX unlink() function. The unlink() function
515 * deletes a name from the filesystem. If this was the last link to the
516 * file and no processes have it opened, the diskspace occupied by the
519 * See your C library manual for more details about unlink(). Note
520 * that on Windows, it is in general not possible to delete files that
521 * are open to some process, or mapped into memory.
523 * Returns: 0 if the name was successfully deleted, -1 if an error
529 g_unlink (const gchar
*filename
)
532 wchar_t *wfilename
= g_utf8_to_utf16 (filename
, -1, NULL
, NULL
, NULL
);
536 if (wfilename
== NULL
)
542 retval
= _wunlink (wfilename
);
550 return unlink (filename
);
556 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
558 * A wrapper for the POSIX remove() function. The remove() function
559 * deletes a name from the filesystem.
561 * See your C library manual for more details about how remove() works
562 * on your system. On Unix, remove() removes also directories, as it
563 * calls unlink() for files and rmdir() for directories. On Windows,
564 * although remove() in the C library only works for files, this
565 * function tries first remove() and then if that fails rmdir(), and
566 * thus works for both files and directories. Note however, that on
567 * Windows, it is in general not possible to remove a file that is
568 * open to some process, or mapped into memory.
570 * If this function fails on Windows you can't infer too much from the
571 * errno value. rmdir() is tried regardless of what caused remove() to
572 * fail. Any errno value set by remove() will be overwritten by that
575 * Returns: 0 if the file was successfully removed, -1 if an error
581 g_remove (const gchar
*filename
)
584 wchar_t *wfilename
= g_utf8_to_utf16 (filename
, -1, NULL
, NULL
, NULL
);
588 if (wfilename
== NULL
)
594 retval
= _wremove (wfilename
);
596 retval
= _wrmdir (wfilename
);
604 return remove (filename
);
610 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
612 * A wrapper for the POSIX rmdir() function. The rmdir() function
613 * deletes a directory from the filesystem.
615 * See your C library manual for more details about how rmdir() works
618 * Returns: 0 if the directory was successfully removed, -1 if an error
624 g_rmdir (const gchar
*filename
)
627 wchar_t *wfilename
= g_utf8_to_utf16 (filename
, -1, NULL
, NULL
, NULL
);
631 if (wfilename
== NULL
)
637 retval
= _wrmdir (wfilename
);
645 return rmdir (filename
);
651 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
652 * @mode: a string describing the mode in which the file should be
655 * A wrapper for the stdio fopen() function. The fopen() function
656 * opens a file and associates a new stream with it.
658 * Because file descriptors are specific to the C library on Windows,
659 * and a file descriptor is partof the <type>FILE</type> struct, the
660 * <type>FILE</type> pointer returned by this function makes sense
661 * only to functions in the same C library. Thus if the GLib-using
662 * code uses a different C library than GLib does, the
663 * <type>FILE</type> pointer returned by this function cannot be
664 * passed to C library functions like fprintf() or fread().
666 * See your C library manual for more details about fopen().
668 * Returns: A <type>FILE</type> pointer if the file was successfully
669 * opened, or %NULL if an error occurred
674 g_fopen (const gchar
*filename
,
678 wchar_t *wfilename
= g_utf8_to_utf16 (filename
, -1, NULL
, NULL
, NULL
);
683 if (wfilename
== NULL
)
689 wmode
= g_utf8_to_utf16 (mode
, -1, NULL
, NULL
, NULL
);
698 retval
= _wfopen (wfilename
, wmode
);
707 return fopen (filename
, mode
);
713 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
714 * @mode: a string describing the mode in which the file should be
716 * @stream: an existing stream which will be reused, or %NULL
718 * A wrapper for the POSIX freopen() function. The freopen() function
719 * opens a file and associates it with an existing stream.
721 * See your C library manual for more details about freopen().
723 * Returns: A <type>FILE</type> pointer if the file was successfully
724 * opened, or %NULL if an error occurred.
729 g_freopen (const gchar
*filename
,
734 wchar_t *wfilename
= g_utf8_to_utf16 (filename
, -1, NULL
, NULL
, NULL
);
739 if (wfilename
== NULL
)
745 wmode
= g_utf8_to_utf16 (mode
, -1, NULL
, NULL
, NULL
);
754 retval
= _wfreopen (wfilename
, wmode
, stream
);
763 return freopen (filename
, mode
, stream
);
769 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
770 * @utb: a pointer to a struct utimbuf.
772 * A wrapper for the POSIX utime() function. The utime() function
773 * sets the access and modification timestamps of a file.
775 * See your C library manual for more details about how utime() works
778 * Returns: 0 if the operation was successful, -1 if an error
784 g_utime (const gchar
*filename
,
788 wchar_t *wfilename
= g_utf8_to_utf16 (filename
, -1, NULL
, NULL
, NULL
);
792 if (wfilename
== NULL
)
798 retval
= _wutime (wfilename
, (struct _utimbuf
*) utb
);
806 return utime (filename
, utb
);
810 #define __G_STDIO_C__
811 #include "galiasdef.c"