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  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 #include "config.h"
  25
  26 #include <errno.h>
  27 #include <string.h> /* strerror, strcmp */
  28
  29 #ifdef HAVE_DIRENT_H
  30 #include <dirent.h>
  31 #endif
  32
  33 #include "glib.h"
  34 #include "gdir.h"
  35
  36 #include "glibintl.h"
  37
  38 struct _GDir
  39 {
  40   DIR *dir;
  41 };
  42
  43 /**
  44  * g_dir_open:
  45  * @path: the path to the directory you are interested in
  46  * @flags: Currently must be set to 0. Reserved for future use.
  47  * @error: return location for a #GError, or %NULL.
  48  *         If non-%NULL, an error will be set if and only if
  49  *         g_dir_open_fails.
  50  *
  51  * Opens a directory for reading. The names of the files
  52  * in the directory can then be retrieved using
  53  * g_dir_get_name().
  54  *
  55  * Return value: a newly allocated #GDir on success, %NULL on failure.
  56  *   If non-%NULL, you must free the result with g_dir_close()
  57  *   when you are finished with it.
  58  **/
  59 GDir *
  60 g_dir_open (const gchar  *path,
  61             guint         flags,
  62             GError      **error)
  63 {
  64   GDir *dir = g_new (GDir, 1);
  65
  66   dir->dir = opendir (path);
  67
  68   if (dir->dir)
  69     return dir;
  70
  71   /* error case */
  72   g_set_error (error,
  73                G_FILE_ERROR,
  74                g_file_error_from_errno (errno),
  75                _("Error opening directory '%s': %s"),
  76                path, strerror (errno));
  77
  78   g_free (dir);
  79   return NULL;
  80 }
  81
  82 /**
  83  * g_dir_read_name:
  84  * @dir: a #GDir* created by g_dir_open()
  85  *
  86  * Retrieves the name of the next entry in the directory.
  87  * The '.' and '..' entries are omitted.
  88  *
  89  * Return value: The entries name or %NULL if there are no
  90  *   more entries. The return value is owned by GLib and
  91  *   must not be modified or freed.
  92  **/
  93 G_CONST_RETURN gchar*
  94 g_dir_read_name (GDir *dir)
  95 {
  96   struct dirent *entry;
  97
  98   g_return_val_if_fail (dir != NULL, NULL);
  99
 100   entry = readdir (dir->dir);
 101   while (entry
 102          && (0 == strcmp (entry->d_name, ".") ||
 103              0 == strcmp (entry->d_name, "..")))
 104     entry = readdir (dir->dir);
 105
 106   if (entry)
 107     return entry->d_name;
 108   else
 109     return NULL;
 110 }
 111
 112 /**
 113  * g_dir_rewind:
 114  * @dir: a #GDir* created by g_dir_open()
 115  *
 116  * Resets the given directory. The next call to g_dir_read_name()
 117  * will return the first entry again.
 118  **/
 119 void
 120 g_dir_rewind (GDir *dir)
 121 {
 122   g_return_if_fail (dir != NULL);
 123
 124   rewinddir (dir->dir);
 125 }
 126
 127 /**
 128  * g_dir_close:
 129  * @dir: a #GDir* created by g_dir_open()
 130  *
 131  * Closes the directory and deallocates all related resources.
 132  **/
 133 void
 134 g_dir_close (GDir *dir)
 135 {
 136   g_return_if_fail (dir != NULL);
 137
 138   closedir (dir->dir);
 139   g_free (dir);
 140 }