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.
32 #include <sys/types.h>
51 gchar utf8_buf[FILENAME_MAX*4];
57 * @path: the path to the directory you are interested in. On Unix
58 * in the on-disk encoding. On Windows in UTF-8
59 * @flags: Currently must be set to 0. Reserved for future use.
60 * @error: return location for a #GError, or %NULL.
61 * If non-%NULL, an error will be set if and only if
64 * Opens a directory for reading. The names of the files in the
65 * directory can then be retrieved using g_dir_read_name().
67 * Return value: a newly allocated #GDir on success, %NULL on failure.
68 * If non-%NULL, you must free the result with g_dir_close()
69 * when you are finished with it.
72 g_dir_open (const gchar *path,
83 g_return_val_if_fail (path != NULL, NULL);
86 wpath = g_utf8_to_utf16 (path, -1, NULL, NULL, error);
91 dir = g_new (GDir, 1);
93 dir->wdirp = _wopendir (wpath);
103 g_file_error_from_errno (errno),
104 _("Error opening directory '%s': %s"),
105 path, g_strerror (errno));
111 dir = g_new (GDir, 1);
113 dir->dirp = opendir (path);
119 utf8_path = g_filename_to_utf8 (path, -1,
123 g_file_error_from_errno (errno),
124 _("Error opening directory '%s': %s"),
125 utf8_path, g_strerror (errno));
136 /* The above function actually is called g_dir_open_utf8, and it's
137 * that what applications compiled with this GLib version will
143 /* Binary compatibility version. Not for newly compiled code. */
146 g_dir_open (const gchar *path,
150 gchar *utf8_path = g_locale_to_utf8 (path, -1, NULL, NULL, error);
153 if (utf8_path == NULL)
156 retval = g_dir_open_utf8 (utf8_path, flags, error);
166 * @dir: a #GDir* created by g_dir_open()
168 * Retrieves the name of the next entry in the directory. The '.' and
169 * '..' entries are omitted. On Windows, the returned name is in
170 * UTF-8. On Unix, it is in the on-disk encoding.
172 * Return value: The entry's name or %NULL if there are no
173 * more entries. The return value is owned by GLib and
174 * must not be modified or freed.
176 G_CONST_RETURN gchar*
177 g_dir_read_name (GDir *dir)
181 struct _wdirent *wentry;
183 struct dirent *entry;
186 g_return_val_if_fail (dir != NULL, NULL);
191 wentry = _wreaddir (dir->wdirp);
193 && (0 == wcscmp (wentry->d_name, L".") ||
194 0 == wcscmp (wentry->d_name, L"..")))
195 wentry = _wreaddir (dir->wdirp);
200 utf8_name = g_utf16_to_utf8 (wentry->d_name, -1, NULL, NULL, NULL);
202 if (utf8_name == NULL)
203 continue; /* Huh, impossible? Skip it anyway */
205 strcpy (dir->utf8_buf, utf8_name);
208 return dir->utf8_buf;
211 entry = readdir (dir->dirp);
213 && (0 == strcmp (entry->d_name, ".") ||
214 0 == strcmp (entry->d_name, "..")))
215 entry = readdir (dir->dirp);
218 return entry->d_name;
226 /* Ditto for g_dir_read_name */
228 #undef g_dir_read_name
230 /* Binary compatibility version. Not for newly compiled code. */
232 G_CONST_RETURN gchar*
233 g_dir_read_name (GDir *dir)
237 const gchar *utf8_name = g_dir_read_name_utf8 (dir);
240 if (utf8_name == NULL)
243 retval = g_locale_from_utf8 (utf8_name, -1, NULL, NULL, NULL);
247 strcpy (dir->utf8_buf, retval);
250 return dir->utf8_buf;
259 * @dir: a #GDir* created by g_dir_open()
261 * Resets the given directory. The next call to g_dir_read_name()
262 * will return the first entry again.
265 g_dir_rewind (GDir *dir)
267 g_return_if_fail (dir != NULL);
270 _wrewinddir (dir->wdirp);
272 rewinddir (dir->dirp);
278 * @dir: a #GDir* created by g_dir_open()
280 * Closes the directory and deallocates all related resources.
283 g_dir_close (GDir *dir)
285 g_return_if_fail (dir != NULL);
288 _wclosedir (dir->wdirp);
290 closedir (dir->dirp);
296 #include "galiasdef.c"