glib/gdir.c

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * gdir.c: Simplified wrapper around the DIRENT functions.
   5  *
   6  * Copyright 2001 Hans Breuer
   7  * Copyright 2004 Tor Lillqvist
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2.1 of the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  21  */
  22
  23 #include "config.h"
  24
  25 #include <errno.h>
  26 #include <string.h>
  27 #include <stdio.h>
  28 #include <sys/stat.h>
  29
  30 #ifdef HAVE_DIRENT_H
  31 #include <sys/types.h>
  32 #include <dirent.h>
  33 #endif
  34
  35 #include "gdir.h"
  36
  37 #include "gconvert.h"
  38 #include "gfileutils.h"
  39 #include "gstrfuncs.h"
  40 #include "gstrfuncsprivate.h"
  41 #include "gtestutils.h"
  42 #include "glibintl.h"
  43
  44 #if defined (_MSC_VER) && !defined (HAVE_DIRENT_H)
  45 #include "dirent/dirent.h"
  46 #endif
  47
  48 #include "glib-private.h" /* g_dir_open_with_errno, g_dir_new_from_dirp */
  49
  50 /**
  51  * GDir:
  52  *
  53  * An opaque structure representing an opened directory.
  54  */
  55
  56 struct _GDir
  57 {
  58 #ifdef G_OS_WIN32
  59   _WDIR *wdirp;
  60 #else
  61   DIR *dirp;
  62 #endif
  63 #ifdef G_OS_WIN32
  64   gchar utf8_buf[FILENAME_MAX*4];
  65 #endif
  66 };
  67
  68 /*< private >
  69  * g_dir_open_with_errno:
  70  * @path: the path to the directory you are interested in.
  71  * @flags: Currently must be set to 0. Reserved for future use.
  72  *
  73  * Opens a directory for reading.
  74  *
  75  * This function is equivalent to g_dir_open() except in the error case,
  76  * errno will be set accordingly.
  77  *
  78  * This is useful if you want to construct your own error message.
  79  *
  80  * Returns: a newly allocated #GDir on success, or %NULL on failure,
  81  *   with errno set accordingly.
  82  *
  83  * Since: 2.38
  84  */
  85 GDir *
  86 g_dir_open_with_errno (const gchar *path,
  87                        guint        flags)
  88 {
  89   GDir dir;
  90 #ifdef G_OS_WIN32
  91   gint saved_errno;
  92   wchar_t *wpath;
  93 #endif
  94
  95   g_return_val_if_fail (path != NULL, NULL);
  96
  97 #ifdef G_OS_WIN32
  98   wpath = g_utf8_to_utf16 (path, -1, NULL, NULL, NULL);
  99
 100   g_return_val_if_fail (wpath != NULL, NULL);
 101
 102   dir.wdirp = _wopendir (wpath);
 103   saved_errno = errno;
 104   g_free (wpath);
 105   errno = saved_errno;
 106
 107   if (dir.wdirp == NULL)
 108     return NULL;
 109 #else
 110   dir.dirp = opendir (path);
 111
 112   if (dir.dirp == NULL)
 113     return NULL;
 114 #endif
 115
 116   return g_memdup2 (&dir, sizeof dir);
 117 }
 118
 119 /**
 120  * g_dir_open:
 121  * @path: the path to the directory you are interested in. On Unix
 122  *         in the on-disk encoding. On Windows in UTF-8
 123  * @flags: Currently must be set to 0. Reserved for future use.
 124  * @error: return location for a #GError, or %NULL.
 125  *         If non-%NULL, an error will be set if and only if
 126  *         g_dir_open() fails.
 127  *
 128  * Opens a directory for reading. The names of the files in the
 129  * directory can then be retrieved using g_dir_read_name().  Note
 130  * that the ordering is not defined.
 131  *
 132  * Returns: a newly allocated #GDir on success, %NULL on failure.
 133  *   If non-%NULL, you must free the result with g_dir_close()
 134  *   when you are finished with it.
 135  **/
 136 GDir *
 137 g_dir_open (const gchar  *path,
 138             guint         flags,
 139             GError      **error)
 140 {
 141   gint saved_errno;
 142   GDir *dir;
 143
 144   dir = g_dir_open_with_errno (path, flags);
 145
 146   if (dir == NULL)
 147     {
 148       gchar *utf8_path;
 149
 150       saved_errno = errno;
 151
 152       utf8_path = g_filename_to_utf8 (path, -1, NULL, NULL, NULL);
 153
 154       g_set_error (error, G_FILE_ERROR, g_file_error_from_errno (saved_errno),
 155                    _("Error opening directory “%s”: %s"), utf8_path, g_strerror (saved_errno));
 156       g_free (utf8_path);
 157     }
 158
 159   return dir;
 160 }
 161
 162 /*< private >
 163  * g_dir_new_from_dirp:
 164  * @dirp: a #DIR* created by opendir() or fdopendir()
 165  *
 166  * Creates a #GDir object from the DIR object that is created using
 167  * opendir() or fdopendir().  The created #GDir assumes ownership of the
 168  * passed-in #DIR pointer.
 169  *
 170  * @dirp must not be %NULL.
 171  *
 172  * This function never fails.
 173  *
 174  * Returns: a newly allocated #GDir, which should be closed using
 175  *     g_dir_close().
 176  *
 177  * Since: 2.38
 178  **/
 179 GDir *
 180 g_dir_new_from_dirp (gpointer dirp)
 181 {
 182 #ifdef G_OS_UNIX
 183   GDir *dir;
 184
 185   g_return_val_if_fail (dirp != NULL, NULL);
 186
 187   dir = g_new (GDir, 1);
 188   dir->dirp = dirp;
 189
 190   return dir;
 191 #else
 192   g_assert_not_reached ();
 193
 194   return NULL;
 195 #endif
 196 }
 197
 198 /**
 199  * g_dir_read_name:
 200  * @dir: a #GDir* created by g_dir_open()
 201  *
 202  * Retrieves the name of another entry in the directory, or %NULL.
 203  * The order of entries returned from this function is not defined,
 204  * and may vary by file system or other operating-system dependent
 205  * factors.
 206  *
 207  * %NULL may also be returned in case of errors. On Unix, you can
 208  * check `errno` to find out if %NULL was returned because of an error.
 209  *
 210  * On Unix, the '.' and '..' entries are omitted, and the returned
 211  * name is in the on-disk encoding.
 212  *
 213  * On Windows, as is true of all GLib functions which operate on
 214  * filenames, the returned name is in UTF-8.
 215  *
 216  * Returns: (type filename): The entry's name or %NULL if there are no
 217  *   more entries. The return value is owned by GLib and
 218  *   must not be modified or freed.
 219  **/
 220 const gchar *
 221 g_dir_read_name (GDir *dir)
 222 {
 223 #ifdef G_OS_WIN32
 224   gchar *utf8_name;
 225   struct _wdirent *wentry;
 226 #else
 227   struct dirent *entry;
 228 #endif
 229
 230   g_return_val_if_fail (dir != NULL, NULL);
 231
 232 #ifdef G_OS_WIN32
 233   while (1)
 234     {
 235       wentry = _wreaddir (dir->wdirp);
 236       while (wentry
 237              && (0 == wcscmp (wentry->d_name, L".") ||
 238                  0 == wcscmp (wentry->d_name, L"..")))
 239         wentry = _wreaddir (dir->wdirp);
 240
 241       if (wentry == NULL)
 242         return NULL;
 243
 244       utf8_name = g_utf16_to_utf8 (wentry->d_name, -1, NULL, NULL, NULL);
 245
 246       if (utf8_name == NULL)
 247         continue;               /* Huh, impossible? Skip it anyway */
 248
 249       strcpy (dir->utf8_buf, utf8_name);
 250       g_free (utf8_name);
 251
 252       return dir->utf8_buf;
 253     }
 254 #else
 255   entry = readdir (dir->dirp);
 256   while (entry
 257          && (0 == strcmp (entry->d_name, ".") ||
 258              0 == strcmp (entry->d_name, "..")))
 259     entry = readdir (dir->dirp);
 260
 261   if (entry)
 262     return entry->d_name;
 263   else
 264     return NULL;
 265 #endif
 266 }
 267
 268 /**
 269  * g_dir_rewind:
 270  * @dir: a #GDir* created by g_dir_open()
 271  *
 272  * Resets the given directory. The next call to g_dir_read_name()
 273  * will return the first entry again.
 274  **/
 275 void
 276 g_dir_rewind (GDir *dir)
 277 {
 278   g_return_if_fail (dir != NULL);
 279
 280 #ifdef G_OS_WIN32
 281   _wrewinddir (dir->wdirp);
 282 #else
 283   rewinddir (dir->dirp);
 284 #endif
 285 }
 286
 287 /**
 288  * g_dir_close:
 289  * @dir: a #GDir* created by g_dir_open()
 290  *
 291  * Closes the directory and deallocates all related resources.
 292  **/
 293 void
 294 g_dir_close (GDir *dir)
 295 {
 296   g_return_if_fail (dir != NULL);
 297
 298 #ifdef G_OS_WIN32
 299   _wclosedir (dir->wdirp);
 300 #else
 301   closedir (dir->dirp);
 302 #endif
 303   g_free (dir);
 304 }
 305
 306 #ifdef G_OS_WIN32
 307
 308 /* Binary compatibility versions. Not for newly compiled code. */
 309
 310 _GLIB_EXTERN GDir        *g_dir_open_utf8      (const gchar  *path,
 311                                                 guint         flags,
 312                                                 GError      **error);
 313 _GLIB_EXTERN const gchar *g_dir_read_name_utf8 (GDir         *dir);
 314
 315 GDir *
 316 g_dir_open_utf8 (const gchar  *path,
 317                  guint         flags,
 318                  GError      **error)
 319 {
 320   return g_dir_open (path, flags, error);
 321 }
 322
 323 const gchar *
 324 g_dir_read_name_utf8 (GDir *dir)
 325 {
 326   return g_dir_read_name (dir);
 327 }
 328
 329 #endif