.
[kopensolaris-gnu/glibc.git] / dirent / dirent.h
index 9caf272..ed4147d 100644 (file)
@@ -1,33 +1,48 @@
-/* Copyright (C) 1991, 92, 93, 94, 95, 96, 97 Free Software Foundation, Inc.
+/* Copyright (C) 1991-2000, 2003, 2004, 2005 Free Software Foundation, Inc.
    This file is part of the GNU C Library.
 
    The GNU C Library is free software; you can redistribute it and/or
-   modify it under the terms of the GNU Library General Public License as
-   published by the Free Software Foundation; either version 2 of the
-   License, or (at your option) any later version.
+   modify it under the terms of the GNU Lesser General Public
+   License as published by the Free Software Foundation; either
+   version 2.1 of the License, or (at your option) any later version.
 
    The GNU C Library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-   Library General Public License for more details.
+   Lesser General Public License for more details.
 
-   You should have received a copy of the GNU Library General Public
-   License along with the GNU C Library; see the file COPYING.LIB.  If not,
-   write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-   Boston, MA 02111-1307, USA.  */
+   You should have received a copy of the GNU Lesser General Public
+   License along with the GNU C Library; if not, write to the Free
+   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+   02111-1307 USA.  */
 
 /*
  *     POSIX Standard: 5.1.2 Directory Operations      <dirent.h>
  */
 
 #ifndef        _DIRENT_H
-
 #define        _DIRENT_H       1
+
 #include <features.h>
 
 __BEGIN_DECLS
 
-#include <gnu/types.h>
+#include <bits/types.h>
+
+#ifdef __USE_XOPEN
+# ifndef __ino_t_defined
+#  ifndef __USE_FILE_OFFSET64
+typedef __ino_t ino_t;
+#  else
+typedef __ino64_t ino_t;
+#  endif
+#  define __ino_t_defined
+# endif
+# if defined __USE_LARGEFILE64 && !defined __ino64_t_defined
+typedef __ino64_t ino64_t;
+#  define __ino64_t_defined
+# endif
+#endif
 
 /* This file defines `struct dirent'.
 
@@ -44,7 +59,7 @@ __BEGIN_DECLS
    member that gives the type of the file.
  */
 
-#include <direntry.h>
+#include <bits/dirent.h>
 
 #if (defined __USE_BSD || defined __USE_MISC) && !defined d_fileno
 # define d_ino d_fileno                 /* Backward compatibility.  */
@@ -83,13 +98,23 @@ __BEGIN_DECLS
 enum
   {
     DT_UNKNOWN = 0,
+# define DT_UNKNOWN    DT_UNKNOWN
     DT_FIFO = 1,
+# define DT_FIFO       DT_FIFO
     DT_CHR = 2,
+# define DT_CHR                DT_CHR
     DT_DIR = 4,
+# define DT_DIR                DT_DIR
     DT_BLK = 6,
+# define DT_BLK                DT_BLK
     DT_REG = 8,
+# define DT_REG                DT_REG
     DT_LNK = 10,
-    DT_SOCK = 12
+# define DT_LNK                DT_LNK
+    DT_SOCK = 12,
+# define DT_SOCK       DT_SOCK
+    DT_WHT = 14
+# define DT_WHT                DT_WHT
   };
 
 /* Convert between stat structure types and directory types.  */
@@ -103,38 +128,100 @@ enum
 typedef struct __dirstream DIR;
 
 /* Open a directory stream on NAME.
-   Return a DIR stream on the directory, or NULL if it could not be opened.  */
-extern DIR *__opendir __P ((__const char *__name));
-extern DIR *opendir __P ((__const char *__name));
+   Return a DIR stream on the directory, or NULL if it could not be opened.
+
+   This function is a possible cancellation point and therefore not
+   marked with __THROW.  */
+extern DIR *opendir (__const char *__name) __nonnull ((1));
+
+#ifdef __USE_GNU
+/* Same as opendir, but open the stream on the file descriptor FD.
+
+   This function is a possible cancellation point and therefore not
+   marked with __THROW.  */
+extern DIR *fdopendir (int __fd);
+#endif
 
 /* Close the directory stream DIRP.
-   Return 0 if successful, -1 if not.  */
-extern int __closedir __P ((DIR *__dirp));
-extern int closedir __P ((DIR *__dirp));
+   Return 0 if successful, -1 if not.
+
+   This function is a possible cancellation point and therefore not
+   marked with __THROW.  */
+extern int closedir (DIR *__dirp) __nonnull ((1));
+
+/* Read a directory entry from DIRP.  Return a pointer to a `struct
+   dirent' describing the entry, or NULL for EOF or error.  The
+   storage returned may be overwritten by a later readdir call on the
+   same DIR stream.
+
+   If the Large File Support API is selected we have to use the
+   appropriate interface.
 
-/* Read a directory entry from DIRP.
-   Return a pointer to a `struct dirent' describing the entry,
-   or NULL for EOF or error.  The storage returned may be overwritten
-   by a later readdir call on the same DIR stream.  */
-extern struct dirent *__readdir __P ((DIR *__dirp));
-extern struct dirent *readdir __P ((DIR *__dirp));
+   This function is a possible cancellation point and therefore not
+   marked with __THROW.  */
+#ifndef __USE_FILE_OFFSET64
+extern struct dirent *readdir (DIR *__dirp) __nonnull ((1));
+#else
+# ifdef __REDIRECT
+extern struct dirent *__REDIRECT (readdir, (DIR *__dirp), readdir64)
+     __nonnull ((1));
+# else
+#  define readdir readdir64
+# endif
+#endif
+
+#ifdef __USE_LARGEFILE64
+extern struct dirent64 *readdir64 (DIR *__dirp) __nonnull ((1));
+#endif
 
 #if defined __USE_POSIX || defined __USE_MISC
 /* Reentrant version of `readdir'.  Return in RESULT a pointer to the
-   next entry.  */
-extern int __readdir_r __P ((DIR *__dirp, struct dirent *__entry,
-                            struct dirent **__result));
-extern int readdir_r __P ((DIR *__dirp, struct dirent *__entry,
-                          struct dirent **__result));
+   next entry.
+
+   This function is a possible cancellation point and therefore not
+   marked with __THROW.  */
+# ifndef __USE_FILE_OFFSET64
+extern int readdir_r (DIR *__restrict __dirp,
+                     struct dirent *__restrict __entry,
+                     struct dirent **__restrict __result)
+     __nonnull ((1, 2, 3));
+# else
+#  ifdef __REDIRECT
+extern int __REDIRECT (readdir_r,
+                      (DIR *__restrict __dirp,
+                       struct dirent *__restrict __entry,
+                       struct dirent **__restrict __result),
+                      readdir64_r) __nonnull ((1, 2, 3));
+#  else
+#   define readdir_r readdir64_r
+#  endif
+# endif
+
+# ifdef __USE_LARGEFILE64
+extern int readdir64_r (DIR *__restrict __dirp,
+                       struct dirent64 *__restrict __entry,
+                       struct dirent64 **__restrict __result)
+     __nonnull ((1, 2, 3));
+# endif
 #endif /* POSIX or misc */
 
 /* Rewind DIRP to the beginning of the directory.  */
-extern void rewinddir __P ((DIR *__dirp));
+extern void rewinddir (DIR *__dirp) __THROW __nonnull ((1));
+
+#if defined __USE_BSD || defined __USE_MISC || defined __USE_XOPEN
+# include <bits/types.h>
+
+/* Seek to position POS on DIRP.  */
+extern void seekdir (DIR *__dirp, long int __pos) __THROW __nonnull ((1));
+
+/* Return the current position of DIRP.  */
+extern long int telldir (DIR *__dirp) __THROW __nonnull ((1));
+#endif
 
 #if defined __USE_BSD || defined __USE_MISC
 
 /* Return the file descriptor used by DIRP.  */
-extern int dirfd __P ((DIR *__dirp));
+extern int dirfd (DIR *__dirp) __THROW __nonnull ((1));
 
 # if defined __OPTIMIZE__ && defined _DIR_dirfd
 #  define dirfd(dirp)  _DIR_dirfd (dirp)
@@ -142,7 +229,7 @@ extern int dirfd __P ((DIR *__dirp));
 
 # ifndef MAXNAMLEN
 /* Get the definitions of the POSIX.1 limits.  */
-#  include <posix1_lim.h>
+#  include <bits/posix1_lim.h>
 
 /* `MAXNAMLEN' is the BSD name for what POSIX calls `NAME_MAX'.  */
 #  ifdef NAME_MAX
@@ -152,43 +239,110 @@ extern int dirfd __P ((DIR *__dirp));
 #  endif
 # endif
 
-# include <gnu/types.h>
 # define __need_size_t
 # include <stddef.h>
 
-/* Seek to position POS on DIRP.  */
-extern void seekdir __P ((DIR *__dirp, __off_t __pos));
-
-/* Return the current position of DIRP.  */
-extern __off_t telldir __P ((DIR *__dirp));
-
 /* Scan the directory DIR, calling SELECTOR on each directory entry.
    Entries for which SELECT returns nonzero are individually malloc'd,
    sorted using qsort with CMP, and collected in a malloc'd array in
    *NAMELIST.  Returns the number of entries selected, or -1 on error.  */
-extern int scandir __P ((__const char *__dir,
-                        struct dirent ***__namelist,
-                        int (*__selector) __P ((struct dirent *)),
-                        int (*__cmp) __P ((__const __ptr_t,
-                                           __const __ptr_t))));
+# ifndef __USE_FILE_OFFSET64
+extern int scandir (__const char *__restrict __dir,
+                   struct dirent ***__restrict __namelist,
+                   int (*__selector) (__const struct dirent *),
+                   int (*__cmp) (__const void *, __const void *))
+     __nonnull ((1, 2));
+# else
+#  ifdef __REDIRECT
+extern int __REDIRECT (scandir,
+                      (__const char *__restrict __dir,
+                       struct dirent ***__restrict __namelist,
+                       int (*__selector) (__const struct dirent *),
+                       int (*__cmp) (__const void *, __const void *)),
+                      scandir64) __nonnull ((1, 2));
+#  else
+#   define scandir scandir64
+#  endif
+# endif
+
+# if defined __USE_GNU && defined __USE_LARGEFILE64
+/* This function is like `scandir' but it uses the 64bit dirent structure.
+   Please note that the CMP function must now work with struct dirent64 **.  */
+extern int scandir64 (__const char *__restrict __dir,
+                     struct dirent64 ***__restrict __namelist,
+                     int (*__selector) (__const struct dirent64 *),
+                     int (*__cmp) (__const void *, __const void *))
+     __nonnull ((1, 2));
+# endif
 
 /* Function to compare two `struct dirent's alphabetically.  */
-extern int alphasort __P ((__const __ptr_t, __const __ptr_t));
+# ifndef __USE_FILE_OFFSET64
+extern int alphasort (__const void *__e1, __const void *__e2)
+     __THROW __attribute_pure__ __nonnull ((1, 2));
+# else
+#  ifdef __REDIRECT
+extern int __REDIRECT_NTH (alphasort,
+                          (__const void *__e1, __const void *__e2),
+                          alphasort64) __attribute_pure__ __nonnull ((1, 2));
+#  else
+#   define alphasort alphasort64
+#  endif
+# endif
+
+# if defined __USE_GNU && defined __USE_LARGEFILE64
+extern int alphasort64 (__const void *__e1, __const void *__e2)
+     __THROW __attribute_pure__ __nonnull ((1, 2));
+# endif
 
 # ifdef __USE_GNU
 /* Function to compare two `struct dirent's by name & version.  */
-extern int versionsort __P ((__const __ptr_t, __const __ptr_t));
-#endif
+#  ifndef __USE_FILE_OFFSET64
+extern int versionsort (__const void *__e1, __const void *__e2)
+     __THROW __attribute_pure__ __nonnull ((1, 2));
+#  else
+#   ifdef __REDIRECT
+extern int __REDIRECT_NTH (versionsort,
+                          (__const void *__e1, __const void *__e2),
+                          versionsort64)
+     __attribute_pure__ __nonnull ((1, 2));
+#   else
+#    define versionsort versionsort64
+#   endif
+#  endif
+
+#  ifdef __USE_LARGEFILE64
+extern int versionsort64 (__const void *__e1, __const void *__e2)
+     __THROW __attribute_pure__ __nonnull ((1, 2));
+#  endif
+# endif
 
 /* Read directory entries from FD into BUF, reading at most NBYTES.
    Reading starts at offset *BASEP, and *BASEP is updated with the new
    position after reading.  Returns the number of bytes read; zero when at
    end of directory; or -1 for errors.  */
-extern __ssize_t __getdirentries __P ((int __fd, char *__buf,
-                                      size_t __nbytes, __off_t *__basep));
-extern __ssize_t getdirentries __P ((int __fd, char *__buf,
-                                    size_t __nbytes, __off_t *__basep));
+# ifndef __USE_FILE_OFFSET64
+extern __ssize_t getdirentries (int __fd, char *__restrict __buf,
+                               size_t __nbytes,
+                               __off_t *__restrict __basep)
+     __THROW __nonnull ((2, 4));
+# else
+#  ifdef __REDIRECT
+extern __ssize_t __REDIRECT_NTH (getdirentries,
+                                (int __fd, char *__restrict __buf,
+                                 size_t __nbytes,
+                                 __off64_t *__restrict __basep),
+                                getdirentries64) __nonnull ((2, 4));
+#  else
+#   define getdirentries getdirentries64
+#  endif
+# endif
 
+# ifdef __USE_LARGEFILE64
+extern __ssize_t getdirentries64 (int __fd, char *__restrict __buf,
+                                 size_t __nbytes,
+                                 __off64_t *__restrict __basep)
+     __THROW __nonnull ((2, 4));
+# endif
 
 #endif /* Use BSD or misc.  */