4143e9ce047e225b932a5df57c47f0ef5bc5ca3e
[debian/tar] / gnu / openat.h
1 /* -*- buffer-read-only: t -*- vi: set ro: */
2 /* DO NOT EDIT! GENERATED AUTOMATICALLY! */
3 /* provide a replacement openat function
4    Copyright (C) 2004-2006, 2008-2013 Free Software Foundation, Inc.
5
6    This program is free software: you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 3 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
18
19 /* written by Jim Meyering */
20
21 #ifndef _GL_HEADER_OPENAT
22 #define _GL_HEADER_OPENAT
23
24 #include <fcntl.h>
25
26 #include <sys/types.h>
27 #include <sys/stat.h>
28 #include <unistd.h>
29 #include <stdbool.h>
30
31 _GL_INLINE_HEADER_BEGIN
32
33 #if !HAVE_OPENAT
34
35 int openat_permissive (int fd, char const *file, int flags, mode_t mode,
36                        int *cwd_errno);
37 bool openat_needs_fchdir (void);
38
39 #else
40
41 # define openat_permissive(Fd, File, Flags, Mode, Cwd_errno) \
42     openat (Fd, File, Flags, Mode)
43 # define openat_needs_fchdir() false
44
45 #endif
46
47 _Noreturn void openat_restore_fail (int);
48 _Noreturn void openat_save_fail (int);
49
50 /* Using these function names makes application code
51    slightly more readable than it would be with
52    fchownat (..., 0) or fchownat (..., AT_SYMLINK_NOFOLLOW).  */
53
54 #if GNULIB_FCHOWNAT
55
56 # ifndef FCHOWNAT_INLINE
57 #  define FCHOWNAT_INLINE _GL_INLINE
58 # endif
59
60 FCHOWNAT_INLINE int
61 chownat (int fd, char const *file, uid_t owner, gid_t group)
62 {
63   return fchownat (fd, file, owner, group, 0);
64 }
65
66 FCHOWNAT_INLINE int
67 lchownat (int fd, char const *file, uid_t owner, gid_t group)
68 {
69   return fchownat (fd, file, owner, group, AT_SYMLINK_NOFOLLOW);
70 }
71
72 #endif
73
74 #if GNULIB_FCHMODAT
75
76 # ifndef FCHMODAT_INLINE
77 #  define FCHMODAT_INLINE _GL_INLINE
78 # endif
79
80 FCHMODAT_INLINE int
81 chmodat (int fd, char const *file, mode_t mode)
82 {
83   return fchmodat (fd, file, mode, 0);
84 }
85
86 FCHMODAT_INLINE int
87 lchmodat (int fd, char const *file, mode_t mode)
88 {
89   return fchmodat (fd, file, mode, AT_SYMLINK_NOFOLLOW);
90 }
91
92 #endif
93
94 #if GNULIB_STATAT
95
96 # ifndef STATAT_INLINE
97 #  define STATAT_INLINE _GL_INLINE
98 # endif
99
100 STATAT_INLINE int
101 statat (int fd, char const *name, struct stat *st)
102 {
103   return fstatat (fd, name, st, 0);
104 }
105
106 STATAT_INLINE int
107 lstatat (int fd, char const *name, struct stat *st)
108 {
109   return fstatat (fd, name, st, AT_SYMLINK_NOFOLLOW);
110 }
111
112 #endif
113
114 /* For now, there are no wrappers named laccessat or leuidaccessat,
115    since gnulib doesn't support faccessat(,AT_SYMLINK_NOFOLLOW) and
116    since access rights on symlinks are of limited utility.  Likewise,
117    wrappers are not provided for accessat or euidaccessat, so as to
118    avoid dragging in -lgen on some platforms.  */
119
120 _GL_INLINE_HEADER_END
121
122 #endif /* _GL_HEADER_OPENAT */