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
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.
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.
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.
27 #include <string.h> /* strcmp */
30 #include <sys/types.h>
46 * @path: the path to the directory you are interested in
47 * @flags: Currently must be set to 0. Reserved for future use.
48 * @error: return location for a #GError, or %NULL.
49 * If non-%NULL, an error will be set if and only if
52 * Opens a directory for reading. The names of the files
53 * in the directory can then be retrieved using
56 * Return value: a newly allocated #GDir on success, %NULL on failure.
57 * If non-%NULL, you must free the result with g_dir_close()
58 * when you are finished with it.
61 g_dir_open (const gchar
*path
,
67 g_return_val_if_fail (path
!= NULL
, NULL
);
69 dir
= g_new (GDir
, 1);
71 dir
->dir
= opendir (path
);
79 g_file_error_from_errno (errno
),
80 _("Error opening directory '%s': %s"),
81 path
, g_strerror (errno
));
89 * @dir: a #GDir* created by g_dir_open()
91 * Retrieves the name of the next entry in the directory.
92 * The '.' and '..' entries are omitted. The returned name is in
93 * the encoding used for filenames. Use g_filename_to_utf8() to
94 * convert it to UTF-8.
96 * Return value: The entries name or %NULL if there are no
97 * more entries. The return value is owned by GLib and
98 * must not be modified or freed.
100 G_CONST_RETURN gchar
*
101 g_dir_read_name (GDir
*dir
)
103 struct dirent
*entry
;
105 g_return_val_if_fail (dir
!= NULL
, NULL
);
107 entry
= readdir (dir
->dir
);
109 && (0 == strcmp (entry
->d_name
, ".") ||
110 0 == strcmp (entry
->d_name
, "..")))
111 entry
= readdir (dir
->dir
);
114 return entry
->d_name
;
121 * @dir: a #GDir* created by g_dir_open()
123 * Resets the given directory. The next call to g_dir_read_name()
124 * will return the first entry again.
127 g_dir_rewind (GDir
*dir
)
129 g_return_if_fail (dir
!= NULL
);
131 rewinddir (dir
->dir
);
136 * @dir: a #GDir* created by g_dir_open()
138 * Closes the directory and deallocates all related resources.
141 g_dir_close (GDir
*dir
)
143 g_return_if_fail (dir
!= NULL
);