*** empty log message ***
[kopensolaris-gnu/glibc.git] / dirent / dirent.h
1 /* Copyright (C) 1991, 1992, 1993, 1994, 1995 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, 1992 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 __BEGIN_DECLS
29
30 #include <gnu/types.h>
31
32 /* This file defines `struct dirent'.  */
33 #include <direntry.h>
34
35 #if defined(__USE_BSD) || defined(__USE_MISC)
36 #define d_ino           d_fileno /* Backward compatibility.  */
37 #endif
38
39 #ifdef __USE_BSD
40 /* File types for `d_type'.  */
41 enum
42   {
43     DT_UNKNOWN = 0,
44     DT_FIFO = 1,
45     DT_CHR = 2,
46     DT_DIR = 4,
47     DT_BLK = 6,
48     DT_REG = 8,
49     DT_LNK = 10,
50     DT_SOCK = 12
51   };
52
53 /* Convert between stat structure types and directory types.  */
54 #define IFTODT(mode)    (((mode) & 0170000) >> 12)
55 #define DTTOIF(dirtype) ((dirtype) << 12)
56 #endif
57
58
59 /* This is the data type of directory stream objects.
60    The actual structure is opaque to users.  */
61 typedef struct __dirstream DIR;
62
63 /* Open a directory stream on NAME.
64    Return a DIR stream on the directory, or NULL if it could not be opened.  */
65 extern DIR *opendir __P ((__const char *__name));
66
67 /* Close the directory stream DIRP.
68    Return 0 if successful, -1 if not.  */
69 extern int closedir __P ((DIR * __dirp));
70
71 /* Read a directory entry from DIRP.
72    Return a pointer to a `struct dirent' describing the entry,
73    or NULL for EOF or error.  The storage returned may be overwritten
74    by a later readdir call on the same DIR stream.  */
75 extern struct dirent *readdir __P ((DIR * __dirp));
76
77 /* Rewind DIRP to the beginning of the directory.  */
78 extern void rewinddir __P ((DIR * __dirp));
79
80 #if defined(__USE_BSD) || defined(__USE_MISC)
81
82 /* Return the file descriptor used by DIRP.  */
83 extern int dirfd __P ((DIR *__dirp));
84
85 #if defined (__OPTIMIZE__) && defined (_DIR_dirfd)
86 #define dirfd(dirp)     _DIR_dirfd (dirp)
87 #endif
88
89 #ifndef MAXNAMLEN
90 /* Get the definitions of the POSIX.1 limits.  */
91 #include <posix1_lim.h>
92
93 /* `MAXNAMLEN' is the BSD name for what POSIX calls `NAME_MAX'.  */
94 #ifdef  NAME_MAX
95 #define MAXNAMLEN       NAME_MAX
96 #else
97 #define MAXNAMLEN       255
98 #endif
99 #endif
100
101 #include <gnu/types.h>
102 #define __need_size_t
103 #include <stddef.h>
104
105 /* Seek to position POS on DIRP.  */
106 extern void seekdir __P ((DIR * __dirp, __off_t __pos));
107
108 /* Return the current position of DIRP.  */
109 extern __off_t telldir __P ((DIR * __dirp));
110
111 /* Scan the directory DIR, calling SELECT on each directory entry.
112    Entries for which SELECT returns nonzero are individually malloc'd,
113    sorted using qsort with CMP, and collected in a malloc'd array in
114    *NAMELIST.  Returns the number of entries selected, or -1 on error.  */
115 extern int scandir __P ((__const char *__dir,
116                          struct dirent ***__namelist,
117                          int (*__select) __P ((struct dirent *)),
118                          int (*__cmp) __P ((__const __ptr_t,
119                                             __const __ptr_t))));
120
121 /* Function to compare two `struct dirent's alphabetically.  */
122 extern int alphasort __P ((__const __ptr_t, __const __ptr_t));
123
124
125 /* Read directory entries from FD into BUF, reading at most NBYTES.
126    Reading starts at offset *BASEP, and *BASEP is updated with the new
127    position after reading.  Returns the number of bytes read; zero when at
128    end of directory; or -1 for errors.  */
129 extern __ssize_t __getdirentries __P ((int __fd, char *__buf,
130                                        size_t __nbytes, __off_t *__basep));
131 extern __ssize_t getdirentries __P ((int __fd, char *__buf,
132                                      size_t __nbytes, __off_t *__basep));
133
134
135 #endif /* Use BSD or misc.  */
136
137 __END_DECLS
138
139 #endif /* dirent.h  */