glib/gstdio.c

   1 /* gstdio.c - wrappers for C library functions
   2  *
   3  * Copyright 2004 Tor Lillqvist
   4  *
   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.
   9  *
  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.
  14  *
  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.
  19  */
  20
  21 #include "config.h"
  22 #include "galias.h"
  23
  24 #include "glib.h"
  25
  26 #include <sys/types.h>
  27 #include <sys/stat.h>
  28 #include <fcntl.h>
  29
  30 #ifdef HAVE_UNISTD_H
  31 #include <unistd.h>
  32 #endif
  33
  34 #ifdef G_OS_WIN32
  35 #include <errno.h>
  36 #include <wchar.h>
  37 #include <direct.h>
  38 #include <io.h>
  39 #endif
  40
  41 #include "gstdio.h"
  42
  43 #if !defined (G_OS_UNIX) && !defined (G_OS_WIN32)
  44 #error Please port this to your operating system
  45 #endif
  46
  47
  48 /**
  49  * g_open:
  50  * @filename: a pathname in the GLib file name encoding
  51  * @flags: as in open()
  52  * @mode: as in open()
  53  *
  54  * A wrapper for the POSIX open() function. The open() function is
  55  * used to convert a pathname into a file descriptor. Note that on
  56  * POSIX systems file descriptors are implemented by the operating
  57  * system. On Windows, it's the C library that implements open() and
  58  * file descriptors. The actual Windows API for opening files is
  59  * something different.
  60  *
  61  * See the C library manual for more details about open().
  62  *
  63  * Returns: a new file descriptor, or -1 if an error occurred. The
  64  * return value can be used exactly like the return value from open().
  65  *
  66  * Since: 2.6
  67  */
  68 int
  69 g_open (const gchar *filename,
  70         int          flags,
  71         int          mode)
  72 {
  73 #ifdef G_OS_WIN32
  74   if (G_WIN32_HAVE_WIDECHAR_API ())
  75     {
  76       wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
  77       int retval = _wopen (wfilename, flags, mode);
  78       int save_errno = errno;
  79
  80       g_free (wfilename);
  81
  82       errno = save_errno;
  83       return retval;
  84     }
  85   else
  86     {
  87       gchar *cp_filename = g_locale_from_utf8 (filename, -1, NULL, NULL, NULL);
  88       int retval = open (cp_filename, flags, mode);
  89       int save_errno = errno;
  90
  91       g_free (cp_filename);
  92
  93       errno = save_errno;
  94       return retval;
  95     }
  96 #else
  97   return open (filename, flags, mode);
  98 #endif
  99 }
 100
 101 /**
 102  * g_rename:
 103  * @oldfilename: a pathname in the GLib file name encoding
 104  * @newfilename: a pathname in the GLib file name encoding
 105  *
 106  * A wrapper for the POSIX rename() function. The rename() function
 107  * renames a file, moving it between directories if required.
 108  *
 109  * See the C library manual for more details about rename().
 110  *
 111  * Returns: 0 if the renaming succeeded, -1 if an error occurred
 112  *
 113  * Since: 2.6
 114  */
 115 int
 116 g_rename (const gchar *oldfilename,
 117           const gchar *newfilename)
 118 {
 119 #ifdef G_OS_WIN32
 120   if (G_WIN32_HAVE_WIDECHAR_API ())
 121     {
 122       wchar_t *woldfilename = g_utf8_to_utf16 (oldfilename, -1, NULL, NULL, NULL);
 123       wchar_t *wnewfilename = g_utf8_to_utf16 (newfilename, -1, NULL, NULL, NULL);
 124       int retval = _wrename (woldfilename, wnewfilename);
 125       int save_errno = errno;
 126
 127       g_free (woldfilename);
 128       g_free (wnewfilename);
 129
 130       errno = save_errno;
 131       return retval;
 132     }
 133   else
 134     {
 135       gchar *cp_oldfilename = g_locale_from_utf8 (oldfilename, -1, NULL, NULL, NULL);
 136       gchar *cp_newfilename = g_locale_from_utf8 (newfilename, -1, NULL, NULL, NULL);
 137       int retval = rename (cp_oldfilename, cp_newfilename);
 138       int save_errno = errno;
 139
 140       g_free (cp_oldfilename);
 141       g_free (cp_newfilename);
 142
 143       errno = save_errno;
 144       return retval;
 145     }
 146 #else
 147   return rename (oldfilename, newfilename);
 148 #endif
 149 }
 150
 151 /**
 152  * g_mkdir:
 153  * @filename: a pathname in the GLib file name encoding
 154  * @mode: permissions to use for the newly created directory
 155  *
 156  * A wrapper for the POSIX mkdir() function. The mkdir() function
 157  * attempts to create a directory with the given name and permissions.
 158  *
 159  * See the C library manual for more details about mkdir().
 160  *
 161  * Returns: 0 if the directory was successfully created, -1 if an error
 162  *    occurred
 163  *
 164  * Since: 2.6
 165  */
 166 int
 167 g_mkdir (const gchar *filename,
 168          int          mode)
 169 {
 170 #ifdef G_OS_WIN32
 171   if (G_WIN32_HAVE_WIDECHAR_API ())
 172     {
 173       wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
 174       int retval = _wmkdir (wfilename);
 175       int save_errno = errno;
 176
 177       g_free (wfilename);
 178
 179       errno = save_errno;
 180       return retval;
 181     }
 182   else
 183     {
 184       gchar *cp_filename = g_locale_from_utf8 (filename, -1, NULL, NULL, NULL);
 185       int retval = mkdir (cp_filename);
 186       int save_errno = errno;
 187
 188       g_free (cp_filename);
 189
 190       errno = save_errno;
 191       return retval;
 192     }
 193 #else
 194   return mkdir (filename, mode);
 195 #endif
 196 }
 197
 198 /**
 199  * g_stat:
 200  * @filename: a pathname in the GLib file name encoding
 201  * @buf: a pointer to a <structname>stat</structname> struct, which
 202  *    will be filled with the file information
 203  *
 204  * A wrapper for the POSIX stat() function. The stat() function
 205  * returns information about a file.
 206  *
 207  * See the C library manual for more details about stat().
 208  *
 209  * Returns: 0 if the directory was successfully created, -1 if an error
 210  *    occurred
 211  *
 212  * Since: 2.6
 213  */
 214 int
 215 g_stat (const gchar *filename,
 216         struct stat *buf)
 217 {
 218 #ifdef G_OS_WIN32
 219   if (G_WIN32_HAVE_WIDECHAR_API ())
 220     {
 221       wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
 222       int retval = _wstat (wfilename, (struct _stat *) buf);
 223       int save_errno = errno;
 224
 225       g_free (wfilename);
 226
 227       errno = save_errno;
 228       return retval;
 229     }
 230   else
 231     {
 232       gchar *cp_filename = g_locale_from_utf8 (filename, -1, NULL, NULL, NULL);
 233       int retval = stat (cp_filename, buf);
 234       int save_errno = errno;
 235
 236       g_free (cp_filename);
 237
 238       errno = save_errno;
 239       return retval;
 240     }
 241 #else
 242   return stat (filename, buf);
 243 #endif
 244 }
 245
 246 /**
 247  * g_unlink:
 248  * @filename: a pathname in the GLib file name encoding
 249  *
 250  * A wrapper for the POSIX unlink() function. The unlink() function
 251  * deletes a name from the filesystem. If this was the last link to the
 252  * file and no processes have it opened, the diskspace occupied by the
 253  * file is freed.
 254  *
 255  * See the C library manual for more details about unlink().
 256  *
 257  * Returns: 0 if the directory was successfully created, -1 if an error
 258  *    occurred
 259  *
 260  * Since: 2.6
 261  */
 262 int
 263 g_unlink (const gchar *filename)
 264 {
 265 #ifdef G_OS_WIN32
 266   if (G_WIN32_HAVE_WIDECHAR_API ())
 267     {
 268       wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
 269       int retval = _wunlink (wfilename);
 270       int save_errno = errno;
 271
 272       g_free (wfilename);
 273
 274       errno = save_errno;
 275       return retval;
 276     }
 277   else
 278     {
 279       gchar *cp_filename = g_locale_from_utf8 (filename, -1, NULL, NULL, NULL);
 280       int retval = unlink (cp_filename);
 281       int save_errno = errno;
 282
 283       g_free (cp_filename);
 284
 285       errno = save_errno;
 286       return retval;
 287     }
 288 #else
 289   return unlink (filename);
 290 #endif
 291 }
 292
 293 /**
 294  * g_remove:
 295  * @filename: a pathname in the GLib file name encoding
 296  *
 297  * A wrapper for the POSIX remove() function. The remove() function
 298  * deletes a name from the filesystem. It calls unlink() for files
 299  * and rmdir() for directories.
 300  *
 301  * See the C library manual for more details about remove().
 302  *
 303  * Returns: 0 if the directory was successfully created, -1 if an error
 304  *    occurred
 305  *
 306  * Since: 2.6
 307  */
 308 int
 309 g_remove (const gchar *filename)
 310 {
 311 #ifdef G_OS_WIN32
 312   if (G_WIN32_HAVE_WIDECHAR_API ())
 313     {
 314       wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
 315       int retval = _wremove (wfilename);
 316       int save_errno = errno;
 317
 318       g_free (wfilename);
 319
 320       errno = save_errno;
 321       return retval;
 322     }
 323   else
 324     {
 325       gchar *cp_filename = g_locale_from_utf8 (filename, -1, NULL, NULL, NULL);
 326       int retval = remove (cp_filename);
 327       int save_errno = errno;
 328
 329       g_free (cp_filename);
 330
 331       errno = save_errno;
 332       return retval;
 333     }
 334 #else
 335   return remove (filename);
 336 #endif
 337 }
 338
 339 /**
 340  * g_fopen:
 341  * @filename: a pathname in the GLib file name encoding
 342  * @mode: a string describing the mode in which the file should be
 343  *   opened
 344  *
 345  * A wrapper for the POSIX fopen() function. The fopen() function opens
 346  * a file and associates a new stream with it.
 347  *
 348  * See the C library manual for more details about fopen().
 349  *
 350  * Returns: A <typename>FILE</typename> pointer if the file was successfully
 351  *    opened, or %NULL if an error occurred
 352  *
 353  * Since: 2.6
 354  */
 355 FILE *
 356 g_fopen (const gchar *filename,
 357          const gchar *mode)
 358 {
 359 #ifdef G_OS_WIN32
 360   if (G_WIN32_HAVE_WIDECHAR_API ())
 361     {
 362       wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
 363       wchar_t *wmode = g_utf8_to_utf16 (mode, -1, NULL, NULL, NULL);
 364       FILE *retval = _wfopen (wfilename, wmode);
 365       int save_errno = errno;
 366
 367       g_free (wfilename);
 368       g_free (wmode);
 369
 370       errno = save_errno;
 371       return retval;
 372     }
 373   else
 374     {
 375       gchar *cp_filename = g_locale_from_utf8 (filename, -1, NULL, NULL, NULL);
 376       FILE *retval = fopen (cp_filename, mode);
 377       int save_errno = errno;
 378
 379       g_free (cp_filename);
 380
 381       errno = save_errno;
 382       return retval;
 383     }
 384 #else
 385   return fopen (filename, mode);
 386 #endif
 387 }
 388
 389 /**
 390  * g_freopen:
 391  * @filename: a pathname in the GLib file name encoding
 392  * @mode: a string describing the mode in which the file should be
 393  *   opened
 394  * @stream: an existing stream which will be reused, or %NULL
 395  *
 396  * A wrapper for the POSIX freopen() function. The freopen() function
 397  * opens a file and associates it with an existing stream.
 398  *
 399  * See the C library manual for more details about freopen().
 400  *
 401  * Returns: A <typename>FILE</typename> pointer if the file was successfully
 402  *    opened, or %NULL if an error occurred.
 403  *
 404  * Since: 2.6
 405  */
 406 FILE *
 407 g_freopen (const gchar *filename,
 408            const gchar *mode,
 409            FILE        *stream)
 410 {
 411 #ifdef G_OS_WIN32
 412   if (G_WIN32_HAVE_WIDECHAR_API ())
 413     {
 414       wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
 415       wchar_t *wmode = g_utf8_to_utf16 (mode, -1, NULL, NULL, NULL);
 416       FILE *retval = _wfreopen (wfilename, wmode, stream);
 417       int save_errno = errno;
 418
 419       g_free (wfilename);
 420       g_free (wmode);
 421
 422       errno = save_errno;
 423       return retval;
 424     }
 425   else
 426     {
 427       gchar *cp_filename = g_locale_from_utf8 (filename, -1, NULL, NULL, NULL);
 428       FILE *retval = freopen (cp_filename, mode, stream);
 429       int save_errno = errno;
 430
 431       g_free (cp_filename);
 432
 433       errno = save_errno;
 434       return retval;
 435     }
 436 #else
 437   return freopen (filename, mode, stream);
 438 #endif
 439 }