glib/gstdio.h

   1 /* gstdio.h - GFilename wrappers for C library functions
   2  *
   3  * Copyright 2004 Tor Lillqvist
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library 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.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public License
  16  * along with this library; if not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #ifndef __G_STDIO_H__
  20 #define __G_STDIO_H__
  21
  22 #include <glib/gprintf.h>
  23
  24 #include <sys/stat.h>
  25
  26 G_BEGIN_DECLS
  27
  28 #if (defined (__MINGW64_VERSION_MAJOR) || defined (_MSC_VER)) && !defined(_WIN64)
  29
  30 /* Make it clear that we mean the struct with 32-bit st_size and
  31  * 32-bit st_*time fields as that is how the 32-bit GLib DLL normally
  32  * has been compiled. If you get a compiler warning when calling
  33  * g_stat(), do take it seriously and make sure that the type of
  34  * struct stat the code in GLib fills in matches the struct the type
  35  * of struct stat you pass to g_stat(). To avoid hassle, to get file
  36  * attributes just use the GIO API instead which doesn't use struct
  37  * stat.
  38  *
  39  * Sure, it would be nicer to use a struct with 64-bit st_size and
  40  * 64-bit st_*time fields, but changing that now would break ABI. And
  41  * in MinGW, a plain "struct stat" is the one with 32-bit st_size and
  42  * st_*time fields.
  43  */
  44
  45 typedef struct _stat32 GStatBuf;
  46
  47 #else
  48
  49 typedef struct stat GStatBuf;
  50
  51 #endif
  52
  53 #if defined(G_OS_UNIX) && !defined(G_STDIO_NO_WRAP_ON_UNIX)
  54
  55 /* Just pass on to the system functions, so there's no potential for data
  56  * format mismatches, especially with large file interfaces.
  57  * A few functions can't be handled in this way, since they are not defined
  58  * in a portable system header that we could include here.
  59  */
  60
  61 #ifndef __GTK_DOC_IGNORE__
  62 #define g_chmod   chmod
  63 #define g_open    open
  64 #define g_creat   creat
  65 #define g_rename  rename
  66 #define g_mkdir   mkdir
  67 #define g_stat    stat
  68 #define g_lstat   lstat
  69 #define g_remove  remove
  70 #define g_fopen   fopen
  71 #define g_freopen freopen
  72 #define g_utime   utime
  73 #endif
  74
  75 GLIB_AVAILABLE_IN_ALL
  76 int g_access (const gchar *filename,
  77               int          mode);
  78
  79 GLIB_AVAILABLE_IN_ALL
  80 int g_chdir  (const gchar *path);
  81
  82 GLIB_AVAILABLE_IN_ALL
  83 int g_unlink (const gchar *filename);
  84
  85 GLIB_AVAILABLE_IN_ALL
  86 int g_rmdir  (const gchar *filename);
  87
  88 #else /* ! G_OS_UNIX */
  89
  90 /* Wrappers for C library functions that take pathname arguments. On
  91  * Unix, the pathname is a file name as it literally is in the file
  92  * system. On well-maintained systems with consistent users who know
  93  * what they are doing and no exchange of files with others this would
  94  * be a well-defined encoding, preferably UTF-8. On Windows, the
  95  * pathname is always in UTF-8, even if that is not the on-disk
  96  * encoding, and not the encoding accepted by the C library or Win32
  97  * API.
  98  */
  99
 100 GLIB_AVAILABLE_IN_ALL
 101 int g_access    (const gchar *filename,
 102                  int          mode);
 103
 104 GLIB_AVAILABLE_IN_ALL
 105 int g_chmod     (const gchar *filename,
 106                  int          mode);
 107
 108 GLIB_AVAILABLE_IN_ALL
 109 int g_open      (const gchar *filename,
 110                  int          flags,
 111                  int          mode);
 112
 113 GLIB_AVAILABLE_IN_ALL
 114 int g_creat     (const gchar *filename,
 115                  int          mode);
 116
 117 GLIB_AVAILABLE_IN_ALL
 118 int g_rename    (const gchar *oldfilename,
 119                  const gchar *newfilename);
 120
 121 GLIB_AVAILABLE_IN_ALL
 122 int g_mkdir     (const gchar *filename,
 123                  int          mode);
 124
 125 GLIB_AVAILABLE_IN_ALL
 126 int g_chdir     (const gchar *path);
 127
 128 GLIB_AVAILABLE_IN_ALL
 129 int g_stat      (const gchar *filename,
 130                  GStatBuf    *buf);
 131
 132 GLIB_AVAILABLE_IN_ALL
 133 int g_lstat     (const gchar *filename,
 134                  GStatBuf    *buf);
 135
 136 GLIB_AVAILABLE_IN_ALL
 137 int g_unlink    (const gchar *filename);
 138
 139 GLIB_AVAILABLE_IN_ALL
 140 int g_remove    (const gchar *filename);
 141
 142 GLIB_AVAILABLE_IN_ALL
 143 int g_rmdir     (const gchar *filename);
 144
 145 GLIB_AVAILABLE_IN_ALL
 146 FILE *g_fopen   (const gchar *filename,
 147                  const gchar *mode);
 148
 149 GLIB_AVAILABLE_IN_ALL
 150 FILE *g_freopen (const gchar *filename,
 151                  const gchar *mode,
 152                  FILE        *stream);
 153
 154 struct utimbuf;                 /* Don't need the real definition of struct utimbuf when just
 155                                  * including this header.
 156                                  */
 157
 158 GLIB_AVAILABLE_IN_ALL
 159 int g_utime     (const gchar    *filename,
 160                  struct utimbuf *utb);
 161
 162 #endif /* G_OS_UNIX */
 163
 164 GLIB_AVAILABLE_IN_2_36
 165 gboolean g_close (gint       fd,
 166                   GError   **error);
 167
 168 G_END_DECLS
 169
 170 #endif /* __G_STDIO_H__ */