Formerly ../dirent/dirent.h.~9~
[kopensolaris-gnu/glibc.git] / dirent / dirent.h
1 /* Copyright (C) 1991, 1992 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
3
4 The GNU C Library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Library General Public License as
6 published by the Free Software Foundation; either version 2 of the
7 License, or (at your option) any later version.
8
9 The GNU C Library is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 Library General Public License for more details.
13
14 You should have received a copy of the GNU Library General Public
15 License along with the GNU C Library; see the file COPYING.LIB.  If
16 not, write to the Free Software Foundation, Inc., 675 Mass Ave,
17 Cambridge, MA 02139, USA.  */
18
19 /*
20  *      POSIX Standard: 5.1.2 Directory Operations      <dirent.h>
21  */
22
23 #ifndef _DIRENT_H
24
25 #define _DIRENT_H       1
26 #include <features.h>
27
28 #ifdef  __cplusplus
29 extern "C" {
30 #endif
31
32 #include <gnu/types.h>
33
34 #define __need_size_t
35 #include <stddef.h>
36
37
38 /* Directory entry structure.  */
39 struct dirent
40   {
41     __ino_t d_fileno;   /* File serial number.  */
42     size_t d_namlen;    /* Length of the file name.  */
43
44     /* Only this member is in the POSIX standard.  */
45     char d_name[1];     /* File name (actually longer).  */
46   };
47
48 #if defined(__USE_BSD) || defined(__USE_MISC)
49 #define d_ino           d_fileno        /* Backward compatibility.  */
50 #endif
51
52 /* Directory stream type.  */
53 typedef struct
54   {
55     int __fd;                   /* File descriptor.  */
56
57     char *__data;               /* Directory block.  */
58     size_t __allocation;        /* Space allocated for the block.  */
59     size_t __offset;            /* Current offset into the block.  */
60     size_t __size;              /* Total valid data in the block.  */
61
62     struct dirent __entry;      /* Returned by `readdir'.  */
63   } DIR;
64
65
66 /* Open a directory stream on NAME.
67    Return a DIR stream on the directory, or NULL if it could not be opened.  */
68 extern DIR *EXFUN(opendir, (CONST char *__name));
69
70 /* Close the directory stream DIRP.
71    Return 0 if successful, -1 if not.  */
72 extern int EXFUN(closedir, (DIR *__dirp));
73
74 /* Read a directory entry from DIRP.
75    Return a pointer to a `struct dirent' describing the entry,
76    or NULL for EOF or error.  The storage returned may be overwritten
77    by a later readdir call on the same DIR stream.  */
78 extern struct dirent *EXFUN(readdir, (DIR *__dirp));
79
80 /* Rewind DIRP to the beginning of the directory.  */
81 extern void EXFUN(rewinddir, (DIR *__dirp));
82
83 #if defined(__USE_BSD) || defined(__USE_MISC)
84
85 #ifndef MAXNAMLEN
86 /* Get the definitions of the POSIX.1 limits.  */
87 #include <posix1_lim.h>
88
89 /* `MAXNAMLEN' is the BSD name for what POSIX calls `NAME_MAX'.  */
90 #ifdef  NAME_MAX
91 #define MAXNAMLEN       NAME_MAX
92 #else
93 #define MAXNAMLEN       255
94 #endif
95 #endif
96
97 #include <gnu/types.h>
98
99 /* Seek to position POS on DIRP.  */
100 extern void EXFUN(seekdir, (DIR *__dirp, __off_t __pos));
101
102 /* Return the current position of DIRP.  */
103 extern __off_t EXFUN(telldir, (DIR *__dirp));
104
105 /* Scan the directory DIR, calling SELECT on each directory entry.
106    Entries for which SELECT returns nonzero are individually malloc'd,
107    sorted using qsort with CMP, and collected in a malloc'd array in
108    *NAMELIST.  Returns the number of entries selected, or -1 on error.  */
109 extern int EXFUN(scandir, (CONST char *__dir,
110                            struct dirent ***__namelist,
111                            int EXFUN((*__select), (struct dirent *));
112                            int EXFUN((*__cmp), (CONST PTR, CONST PTR))));
113
114 /* Function to compare two `struct dirent's alphabetically.  */
115 extern int EXFUN(alphasort, (CONST PTR, CONST PTR));
116
117
118 /* Read directory entries from FD into BUF, reading at most NBYTES.
119    Reading starts at offset *BASEP, and *BASEP is updated with the new
120    position after reading.  Returns the number of bytes read; zero when at
121    end of directory; or -1 for errors.  */
122 extern __ssize_t EXFUN(__getdirentries, (int __fd, char *__buf,
123                                          size_t __nbytes, __off_t *__basep));
124 extern __ssize_t EXFUN(getdirentries, (int __fd, char *__buf,
125                                        size_t __nbytes, __off_t *__basep));
126
127
128 #endif  /* Use BSD or misc.  */
129
130 #ifdef  __cplusplus
131 }
132 #endif
133
134 #endif  /* dirent.h  */