Don't use parameter names from global namespace in prototypes.
[kopensolaris-gnu/glibc.git] / io / ftw.h
1 /* Copyright (C) 1992, 1996, 1997 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 not,
16    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17    Boston, MA 02111-1307, USA.  */
18
19 /*
20  *      X/Open Portability Guide 4.2: ftw.h
21  */
22
23 #ifndef _FTW_H
24 #define _FTW_H  1
25
26 #include <features.h>
27
28 #include <sys/types.h>
29 #include <bits/stat.h>
30
31
32 __BEGIN_DECLS
33
34 /* Values for the FLAG argument to the user function passed to `ftw'
35    and 'nftw'.  */
36 enum
37 {
38   FTW_F,                /* Regular file.  */
39 #define FTW_F    FTW_F
40   FTW_D,                /* Directory.  */
41 #define FTW_D    FTW_D
42   FTW_DNR,              /* Unreadable directory.  */
43 #define FTW_DNR  FTW_DNR
44   FTW_NS,               /* Unstatable file.  */
45 #define FTW_NS   FTW_NS
46
47 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
48
49   FTW_SL,               /* Symbolic link.  */
50 # define FTW_SL  FTW_SL
51 #endif
52
53 #ifdef __USE_XOPEN_EXTENDED
54 /* These flags are only passed from the `nftw' function.  */
55   FTW_DP,               /* Directory, all subdirs have been visited. */
56 # define FTW_DP  FTW_DP
57   FTW_SLN               /* Symbolic link naming non-existing file.  */
58 # define FTW_SLN FTW_SLN
59
60 #endif  /* extended X/Open */
61 };
62
63
64 #ifdef __USE_XOPEN_EXTENDED
65 /* Flags for fourth argument of `nftw'.  */
66 enum
67 {
68   FTW_PHYS = 1,         /* Perform physical walk, ignore symlinks.  */
69 # define FTW_PHYS       FTW_PHYS
70   FTW_MOUNT = 2,        /* Report only files on same file system as the
71                            argument.  */
72 # define FTW_MOUNT      FTW_MOUNT
73   FTW_CHDIR = 4,        /* Change to current directory while processing it.  */
74 # define FTW_CHDIR      FTW_CHDIR
75   FTW_DEPTH = 8         /* Report files in directory before directory itself.*/
76 # define FTW_DEPTH      FTW_DEPTH
77 };
78
79 /* Structure used for fourth argument to callback function for `nftw'.  */
80 struct FTW
81   {
82     int base;
83     int level;
84   };
85 #endif  /* extended X/Open */
86
87
88 /* Convenient types for callback functions.  */
89 typedef int (*__ftw_func_t) __P ((__const char *__filename,
90                                   __const struct stat *__status, int __flag));
91 #ifdef __USE_XOPEN_EXTENDED
92 typedef int (*__nftw_func_t) __P ((__const char *__filename,
93                                    __const struct stat *__status, int __flag,
94                                    struct FTW *__info));
95 #endif
96
97 /* Call a function on every element in a directory tree.  */
98 extern int ftw __P ((__const char *__dir, __ftw_func_t __func,
99                      int __descriptors));
100
101 #ifdef __USE_XOPEN_EXTENDED
102 /* Call a function on every element in a directory tree.  FLAG allows
103    to specify the behaviour more detailed.  */
104 extern int nftw __P ((__const char *__dir, __nftw_func_t __func,
105                       int __descriptors, int __flag));
106 #endif
107
108 __END_DECLS
109
110 #endif  /* ftw.h */