1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * gdir.c: Simplified wrapper around the DIRENT functions.
6 * Copyright 2001 Hans Breuer
7 * Copyright 2004 Tor Lillqvist
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 of the License, or (at your option) any later version.
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.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the
21 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 * Boston, MA 02111-1307, USA.
33 #include <sys/types.h>
40 #include "gfileutils.h"
41 #include "gstrfuncs.h"
42 #include "gtestutils.h"
46 #if defined (_MSC_VER) && !defined (HAVE_DIRENT_H)
47 #include "../build/win32/dirent/dirent.h"
48 #include "../build/win32/dirent/wdirent.c"
59 gchar utf8_buf[FILENAME_MAX*4];
65 * @path: the path to the directory you are interested in. On Unix
66 * in the on-disk encoding. On Windows in UTF-8
67 * @flags: Currently must be set to 0. Reserved for future use.
68 * @error: return location for a #GError, or %NULL.
69 * If non-%NULL, an error will be set if and only if
72 * Opens a directory for reading. The names of the files in the
73 * directory can then be retrieved using g_dir_read_name().
75 * Return value: a newly allocated #GDir on success, %NULL on failure.
76 * If non-%NULL, you must free the result with g_dir_close()
77 * when you are finished with it.
80 g_dir_open (const gchar *path,
92 g_return_val_if_fail (path != NULL, NULL);
95 wpath = g_utf8_to_utf16 (path, -1, NULL, NULL, error);
100 dir = g_new (GDir, 1);
102 dir->wdirp = _wopendir (wpath);
113 g_file_error_from_errno (errsv),
114 _("Error opening directory '%s': %s"),
115 path, g_strerror (errsv));
121 dir = g_new (GDir, 1);
123 dir->dirp = opendir (path);
131 utf8_path = g_filename_to_utf8 (path, -1,
136 g_file_error_from_errno (errsv),
137 _("Error opening directory '%s': %s"),
138 utf8_path, g_strerror (errsv));
147 #if defined (G_OS_WIN32) && !defined (_WIN64)
149 /* The above function actually is called g_dir_open_utf8, and it's
150 * that what applications compiled with this GLib version will
156 /* Binary compatibility version. Not for newly compiled code. */
159 g_dir_open (const gchar *path,
163 gchar *utf8_path = g_locale_to_utf8 (path, -1, NULL, NULL, error);
166 if (utf8_path == NULL)
169 retval = g_dir_open_utf8 (utf8_path, flags, error);
179 * @dir: a #GDir* created by g_dir_open()
181 * Retrieves the name of the next entry in the directory. The '.' and
182 * '..' entries are omitted. On Windows, the returned name is in
183 * UTF-8. On Unix, it is in the on-disk encoding.
185 * Return value: The entry's name or %NULL if there are no
186 * more entries. The return value is owned by GLib and
187 * must not be modified or freed.
189 G_CONST_RETURN gchar*
190 g_dir_read_name (GDir *dir)
194 struct _wdirent *wentry;
196 struct dirent *entry;
199 g_return_val_if_fail (dir != NULL, NULL);
204 wentry = _wreaddir (dir->wdirp);
206 && (0 == wcscmp (wentry->d_name, L".") ||
207 0 == wcscmp (wentry->d_name, L"..")))
208 wentry = _wreaddir (dir->wdirp);
213 utf8_name = g_utf16_to_utf8 (wentry->d_name, -1, NULL, NULL, NULL);
215 if (utf8_name == NULL)
216 continue; /* Huh, impossible? Skip it anyway */
218 strcpy (dir->utf8_buf, utf8_name);
221 return dir->utf8_buf;
224 entry = readdir (dir->dirp);
226 && (0 == strcmp (entry->d_name, ".") ||
227 0 == strcmp (entry->d_name, "..")))
228 entry = readdir (dir->dirp);
231 return entry->d_name;
237 #if defined (G_OS_WIN32) && !defined (_WIN64)
239 /* Ditto for g_dir_read_name */
241 #undef g_dir_read_name
243 /* Binary compatibility version. Not for newly compiled code. */
245 G_CONST_RETURN gchar*
246 g_dir_read_name (GDir *dir)
250 const gchar *utf8_name = g_dir_read_name_utf8 (dir);
253 if (utf8_name == NULL)
256 retval = g_locale_from_utf8 (utf8_name, -1, NULL, NULL, NULL);
260 strcpy (dir->utf8_buf, retval);
263 return dir->utf8_buf;
272 * @dir: a #GDir* created by g_dir_open()
274 * Resets the given directory. The next call to g_dir_read_name()
275 * will return the first entry again.
278 g_dir_rewind (GDir *dir)
280 g_return_if_fail (dir != NULL);
283 _wrewinddir (dir->wdirp);
285 rewinddir (dir->dirp);
291 * @dir: a #GDir* created by g_dir_open()
293 * Closes the directory and deallocates all related resources.
296 g_dir_close (GDir *dir)
298 g_return_if_fail (dir != NULL);
301 _wclosedir (dir->wdirp);
303 closedir (dir->dirp);