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, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 #ifndef __G_DIR_H__
  23 #define __G_DIR_H__
  24
  25 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  26 #error "Only <glib.h> can be included directly."
  27 #endif
  28
  29 #include <glib/gerror.h>
  30
  31 #ifdef G_OS_UNIX
  32 #include <dirent.h>
  33 #endif
  34
  35 G_BEGIN_DECLS
  36
  37 typedef struct _GDir GDir;
  38
  39 GLIB_AVAILABLE_IN_ALL
  40 GDir    *                g_dir_open           (const gchar  *path,
  41                                                guint         flags,
  42                                                GError      **error);
  43 GLIB_AVAILABLE_IN_ALL
  44 const gchar *            g_dir_read_name      (GDir         *dir);
  45 GLIB_AVAILABLE_IN_ALL
  46 void                     g_dir_rewind         (GDir         *dir);
  47 GLIB_AVAILABLE_IN_ALL
  48 void                     g_dir_close          (GDir         *dir);
  49
  50 #ifndef __GTK_DOC_IGNORE__
  51 #ifdef G_OS_WIN32
  52 #define g_dir_open      g_dir_open_utf8
  53 #define g_dir_read_name g_dir_read_name_utf8
  54
  55 GLIB_AVAILABLE_IN_ALL
  56 GDir        *g_dir_open_utf8      (const gchar  *path,
  57                                    guint         flags,
  58                                    GError      **error);
  59 GLIB_AVAILABLE_IN_ALL
  60 const gchar *g_dir_read_name_utf8 (GDir         *dir);
  61 #endif /* G_OS_WIN32 */
  62 #endif /* __GTK_DOC_IGNORE__ */
  63
  64 G_END_DECLS
  65
  66 #endif /* __G_DIR_H__ */