Only use G_LIKELY in g_assert() and g_return_[val]_if_fail() if it is
[platform/upstream/glib.git] / glib / gdir.h
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 #ifndef __G_DIR_H__
24 #define __G_DIR_H__
25
26 #include <glib/gerror.h>
27
28 G_BEGIN_DECLS
29
30 typedef struct _GDir GDir;
31
32 GDir    *               g_dir_open      (const gchar  *path,
33                                          guint         flags,
34                                          GError      **error);
35 G_CONST_RETURN gchar   *g_dir_read_name (GDir         *dir);
36 void                    g_dir_rewind    (GDir         *dir);
37 void                    g_dir_close     (GDir         *dir);
38
39 G_END_DECLS
40
41 #endif /* __G_DIR_H__ */