tests: Add tests for the thumbnail verification code in GIO
[glib.git] / glib / gstdio.c
blobcca4ff56669884435259c588e3b2d8de59ac799c
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.
21 #include "config.h"
22 #include "glibconfig.h"
24 #define G_STDIO_NO_WRAP_ON_UNIX
26 #include <sys/types.h>
27 #include <sys/stat.h>
28 #include <fcntl.h>
30 #ifdef HAVE_UNISTD_H
31 #include <unistd.h>
32 #endif
34 #ifdef G_OS_WIN32
35 #include <windows.h>
36 #include <errno.h>
37 #include <wchar.h>
38 #include <direct.h>
39 #include <io.h>
40 #include <sys/utime.h>
41 #else
42 #include <utime.h>
43 #include <errno.h>
44 #endif
46 #include "gstdio.h"
49 #if !defined (G_OS_UNIX) && !defined (G_OS_WIN32) && !defined (G_OS_BEOS)
50 #error Please port this to your operating system
51 #endif
53 #if defined (_MSC_VER) && !defined(_WIN64)
54 #undef _wstat
55 #define _wstat _wstat32
56 #endif
58 /**
59 * g_access:
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 or on
78 * error.
80 * Since: 2.8
82 int
83 g_access (const gchar *filename,
84 int mode)
86 #ifdef G_OS_WIN32
87 wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
88 int retval;
89 int save_errno;
91 if (wfilename == NULL)
93 errno = EINVAL;
94 return -1;
97 #ifndef X_OK
98 #define X_OK 1
99 #endif
101 retval = _waccess (wfilename, mode & ~X_OK);
102 save_errno = errno;
104 g_free (wfilename);
106 errno = save_errno;
107 return retval;
108 #else
109 return access (filename, mode);
110 #endif
114 * g_chmod:
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: zero if the operation succeeded, -1 on error.
131 * Since: 2.8
134 g_chmod (const gchar *filename,
135 int mode)
137 #ifdef G_OS_WIN32
138 wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
139 int retval;
140 int save_errno;
142 if (wfilename == NULL)
144 errno = EINVAL;
145 return -1;
148 retval = _wchmod (wfilename, mode);
149 save_errno = errno;
151 g_free (wfilename);
153 errno = save_errno;
154 return retval;
155 #else
156 return chmod (filename, mode);
157 #endif
160 * g_open:
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()
180 * or read().
182 * See your C library manual for more details about open().
184 * Returns: a new file descriptor, or -1 if an error occurred. The
185 * return value can be used exactly like the return value from open().
187 * Since: 2.6
190 g_open (const gchar *filename,
191 int flags,
192 int mode)
194 #ifdef G_OS_WIN32
195 wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
196 int retval;
197 int save_errno;
199 if (wfilename == NULL)
201 errno = EINVAL;
202 return -1;
205 retval = _wopen (wfilename, flags, mode);
206 save_errno = errno;
208 g_free (wfilename);
210 errno = save_errno;
211 return retval;
212 #else
213 int fd;
215 fd = open (filename, flags, mode);
216 while (G_UNLIKELY (fd == -1 && errno == EINTR));
217 return fd;
218 #endif
222 * g_creat:
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
228 * if necessary.
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()
242 * or read().
244 * See your C library manual for more details about creat().
246 * Returns: a new file descriptor, or -1 if an error occurred. The
247 * return value can be used exactly like the return value from creat().
249 * Since: 2.8
252 g_creat (const gchar *filename,
253 int mode)
255 #ifdef G_OS_WIN32
256 wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
257 int retval;
258 int save_errno;
260 if (wfilename == NULL)
262 errno = EINVAL;
263 return -1;
266 retval = _wcreat (wfilename, mode);
267 save_errno = errno;
269 g_free (wfilename);
271 errno = save_errno;
272 return retval;
273 #else
274 return creat (filename, mode);
275 #endif
279 * g_rename:
280 * @oldfilename: a pathname in the GLib file name encoding (UTF-8 on Windows)
281 * @newfilename: a pathname in the GLib file name encoding
283 * A wrapper for the POSIX rename() function. The rename() function
284 * renames a file, moving it between directories if required.
286 * See your C library manual for more details about how rename() works
287 * on your system. It is not possible in general on Windows to rename
288 * a file that is open to some process.
290 * Returns: 0 if the renaming succeeded, -1 if an error occurred
292 * Since: 2.6
295 g_rename (const gchar *oldfilename,
296 const gchar *newfilename)
298 #ifdef G_OS_WIN32
299 wchar_t *woldfilename = g_utf8_to_utf16 (oldfilename, -1, NULL, NULL, NULL);
300 wchar_t *wnewfilename;
301 int retval;
302 int save_errno = 0;
304 if (woldfilename == NULL)
306 errno = EINVAL;
307 return -1;
310 wnewfilename = g_utf8_to_utf16 (newfilename, -1, NULL, NULL, NULL);
312 if (wnewfilename == NULL)
314 g_free (woldfilename);
315 errno = EINVAL;
316 return -1;
319 if (MoveFileExW (woldfilename, wnewfilename, MOVEFILE_REPLACE_EXISTING))
320 retval = 0;
321 else
323 retval = -1;
324 switch (GetLastError ())
326 #define CASE(a,b) case ERROR_##a: save_errno = b; break
327 CASE (FILE_NOT_FOUND, ENOENT);
328 CASE (PATH_NOT_FOUND, ENOENT);
329 CASE (ACCESS_DENIED, EACCES);
330 CASE (NOT_SAME_DEVICE, EXDEV);
331 CASE (LOCK_VIOLATION, EACCES);
332 CASE (SHARING_VIOLATION, EACCES);
333 CASE (FILE_EXISTS, EEXIST);
334 CASE (ALREADY_EXISTS, EEXIST);
335 #undef CASE
336 default: save_errno = EIO;
340 g_free (woldfilename);
341 g_free (wnewfilename);
343 errno = save_errno;
344 return retval;
345 #else
346 return rename (oldfilename, newfilename);
347 #endif
351 * g_mkdir:
352 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
353 * @mode: permissions to use for the newly created directory
355 * A wrapper for the POSIX mkdir() function. The mkdir() function
356 * attempts to create a directory with the given name and permissions.
357 * The mode argument is ignored on Windows.
359 * See your C library manual for more details about mkdir().
361 * Returns: 0 if the directory was successfully created, -1 if an error
362 * occurred
364 * Since: 2.6
367 g_mkdir (const gchar *filename,
368 int mode)
370 #ifdef G_OS_WIN32
371 wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
372 int retval;
373 int save_errno;
375 if (wfilename == NULL)
377 errno = EINVAL;
378 return -1;
381 retval = _wmkdir (wfilename);
382 save_errno = errno;
384 g_free (wfilename);
386 errno = save_errno;
387 return retval;
388 #else
389 return mkdir (filename, mode);
390 #endif
394 * g_chdir:
395 * @path: a pathname in the GLib file name encoding (UTF-8 on Windows)
397 * A wrapper for the POSIX chdir() function. The function changes the
398 * current directory of the process to @path.
400 * See your C library manual for more details about chdir().
402 * Returns: 0 on success, -1 if an error occurred.
404 * Since: 2.8
407 g_chdir (const gchar *path)
409 #ifdef G_OS_WIN32
410 wchar_t *wpath = g_utf8_to_utf16 (path, -1, NULL, NULL, NULL);
411 int retval;
412 int save_errno;
414 if (wpath == NULL)
416 errno = EINVAL;
417 return -1;
420 retval = _wchdir (wpath);
421 save_errno = errno;
423 g_free (wpath);
425 errno = save_errno;
426 return retval;
427 #else
428 return chdir (path);
429 #endif
433 * GStatBuf:
435 * A type corresponding to the appropriate struct type for the stat
436 * system call, depending on the platform and/or compiler being used.
438 * See g_stat() for more information.
441 * g_stat:
442 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
443 * @buf: a pointer to a <structname>stat</structname> struct, which
444 * will be filled with the file information
446 * A wrapper for the POSIX stat() function. The stat() function
447 * returns information about a file. On Windows the stat() function in
448 * the C library checks only the FAT-style READONLY attribute and does
449 * not look at the ACL at all. Thus on Windows the protection bits in
450 * the st_mode field are a fabrication of little use.
452 * On Windows the Microsoft C libraries have several variants of the
453 * <structname>stat</structname> struct and stat() function with names
454 * like "_stat", "_stat32", "_stat32i64" and "_stat64i32". The one
455 * used here is for 32-bit code the one with 32-bit size and time
456 * 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,
464 * "stat" might be a macro.
466 * See your C library manual for more details about stat().
468 * Returns: 0 if the information was successfully retrieved, -1 if an error
469 * occurred
471 * Since: 2.6
474 g_stat (const gchar *filename,
475 GStatBuf *buf)
477 #ifdef G_OS_WIN32
478 wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
479 int retval;
480 int save_errno;
481 int len;
483 if (wfilename == NULL)
485 errno = EINVAL;
486 return -1;
489 len = wcslen (wfilename);
490 while (len > 0 && G_IS_DIR_SEPARATOR (wfilename[len-1]))
491 len--;
492 if (len > 0 &&
493 (!g_path_is_absolute (filename) || len > g_path_skip_root (filename) - filename))
494 wfilename[len] = '\0';
496 retval = _wstat (wfilename, buf);
497 save_errno = errno;
499 g_free (wfilename);
501 errno = save_errno;
502 return retval;
503 #else
504 return stat (filename, buf);
505 #endif
509 * g_lstat:
510 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
511 * @buf: a pointer to a <structname>stat</structname> struct, which
512 * will be filled with the file information
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, -1 if an error
523 * occurred
525 * Since: 2.6
528 g_lstat (const gchar *filename,
529 GStatBuf *buf)
531 #ifdef HAVE_LSTAT
532 /* This can't be Win32, so don't do the widechar dance. */
533 return lstat (filename, buf);
534 #else
535 return g_stat (filename, buf);
536 #endif
540 * g_unlink:
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
546 * file is freed.
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
553 * occurred
555 * Since: 2.6
558 g_unlink (const gchar *filename)
560 #ifdef G_OS_WIN32
561 wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
562 int retval;
563 int save_errno;
565 if (wfilename == NULL)
567 errno = EINVAL;
568 return -1;
571 retval = _wunlink (wfilename);
572 save_errno = errno;
574 g_free (wfilename);
576 errno = save_errno;
577 return retval;
578 #else
579 return unlink (filename);
580 #endif
584 * g_remove:
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
602 * set by rmdir().
604 * Returns: 0 if the file was successfully removed, -1 if an error
605 * occurred
607 * Since: 2.6
610 g_remove (const gchar *filename)
612 #ifdef G_OS_WIN32
613 wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
614 int retval;
615 int save_errno;
617 if (wfilename == NULL)
619 errno = EINVAL;
620 return -1;
623 retval = _wremove (wfilename);
624 if (retval == -1)
625 retval = _wrmdir (wfilename);
626 save_errno = errno;
628 g_free (wfilename);
630 errno = save_errno;
631 return retval;
632 #else
633 return remove (filename);
634 #endif
638 * g_rmdir:
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
645 * on your system.
647 * Returns: 0 if the directory was successfully removed, -1 if an error
648 * occurred
650 * Since: 2.6
653 g_rmdir (const gchar *filename)
655 #ifdef G_OS_WIN32
656 wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
657 int retval;
658 int save_errno;
660 if (wfilename == NULL)
662 errno = EINVAL;
663 return -1;
666 retval = _wrmdir (wfilename);
667 save_errno = errno;
669 g_free (wfilename);
671 errno = save_errno;
672 return retval;
673 #else
674 return rmdir (filename);
675 #endif
679 * g_fopen:
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
682 * 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 partof the <type>FILE</type> struct, the
689 * <type>FILE</type> pointer returned by this function makes sense
690 * only to functions in the same C library. Thus if the GLib-using
691 * code uses a different C library than GLib does, the
692 * <type>FILE</type> pointer returned by this function cannot be
693 * passed to C library functions like fprintf() or fread().
695 * See your C library manual for more details about fopen().
697 * Returns: A <type>FILE</type> pointer if the file was successfully
698 * opened, or %NULL if an error occurred
700 * Since: 2.6
702 FILE *
703 g_fopen (const gchar *filename,
704 const gchar *mode)
706 #ifdef G_OS_WIN32
707 wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
708 wchar_t *wmode;
709 FILE *retval;
710 int save_errno;
712 if (wfilename == NULL)
714 errno = EINVAL;
715 return NULL;
718 wmode = g_utf8_to_utf16 (mode, -1, NULL, NULL, NULL);
720 if (wmode == NULL)
722 g_free (wfilename);
723 errno = EINVAL;
724 return NULL;
727 retval = _wfopen (wfilename, wmode);
728 save_errno = errno;
730 g_free (wfilename);
731 g_free (wmode);
733 errno = save_errno;
734 return retval;
735 #else
736 return fopen (filename, mode);
737 #endif
741 * g_freopen:
742 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
743 * @mode: a string describing the mode in which the file should be
744 * opened
745 * @stream: (allow-none): an existing stream which will be reused, or %NULL
747 * A wrapper for the POSIX freopen() function. The freopen() function
748 * opens a file and associates it with an existing stream.
750 * See your C library manual for more details about freopen().
752 * Returns: A <literal>FILE</literal> pointer if the file was successfully
753 * opened, or %NULL if an error occurred.
755 * Since: 2.6
757 FILE *
758 g_freopen (const gchar *filename,
759 const gchar *mode,
760 FILE *stream)
762 #ifdef G_OS_WIN32
763 wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
764 wchar_t *wmode;
765 FILE *retval;
766 int save_errno;
768 if (wfilename == NULL)
770 errno = EINVAL;
771 return NULL;
774 wmode = g_utf8_to_utf16 (mode, -1, NULL, NULL, NULL);
776 if (wmode == NULL)
778 g_free (wfilename);
779 errno = EINVAL;
780 return NULL;
783 retval = _wfreopen (wfilename, wmode, stream);
784 save_errno = errno;
786 g_free (wfilename);
787 g_free (wmode);
789 errno = save_errno;
790 return retval;
791 #else
792 return freopen (filename, mode, stream);
793 #endif
797 * g_utime:
798 * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
799 * @utb: a pointer to a struct utimbuf.
801 * A wrapper for the POSIX utime() function. The utime() function
802 * sets the access and modification timestamps of a file.
804 * See your C library manual for more details about how utime() works
805 * on your system.
807 * Returns: 0 if the operation was successful, -1 if an error
808 * occurred
810 * Since: 2.18
813 g_utime (const gchar *filename,
814 struct utimbuf *utb)
816 #ifdef G_OS_WIN32
817 wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
818 int retval;
819 int save_errno;
821 if (wfilename == NULL)
823 errno = EINVAL;
824 return -1;
827 retval = _wutime (wfilename, (struct _utimbuf*) utb);
828 save_errno = errno;
830 g_free (wfilename);
832 errno = save_errno;
833 return retval;
834 #else
835 return utime (filename, utb);
836 #endif
840 * g_close:
841 * @fd: A file descriptor
842 * @error: a #GError
844 * This wraps the close() call; in case of error, %errno will be
845 * preserved, but the error will also be stored as a #GError in @error.
847 * Besides using #GError, there is another major reason to prefer this
848 * function over the call provided by the system; on Unix, it will
849 * attempt to correctly handle %EINTR, which has platform-specific
850 * semantics.
852 * Since: 2.36
854 gboolean
855 g_close (gint fd,
856 GError **error)
858 int res;
859 res = close (fd);
860 /* Just ignore EINTR for now; a retry loop is the wrong thing to do
861 * on Linux at least. Anyone who wants to add a conditional check
862 * for e.g. HP-UX is welcome to do so later...
864 * http://lkml.indiana.edu/hypermail/linux/kernel/0509.1/0877.html
865 * https://bugzilla.gnome.org/show_bug.cgi?id=682819
866 * http://utcc.utoronto.ca/~cks/space/blog/unix/CloseEINTR
867 * https://sites.google.com/site/michaelsafyan/software-engineering/checkforeintrwheninvokingclosethinkagain
869 if (G_UNLIKELY (res == -1 && errno == EINTR))
870 return TRUE;
871 else if (res == -1)
873 int errsv = errno;
874 g_set_error_literal (error, G_FILE_ERROR,
875 g_file_error_from_errno (errsv),
876 g_strerror (errsv));
877 errno = errsv;
878 return FALSE;
880 return TRUE;