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