Standardize the multiple-include protect.
[kopensolaris-gnu/glibc.git] / grp / grp.h
1 /* Copyright (C) 1991, 1992, 1995, 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  *      POSIX Standard: 9.2.1 Group Database Access     <grp.h>
21  */
22
23 #ifndef _GRP_H
24 #define _GRP_H  1
25
26 #include <features.h>
27
28 __BEGIN_DECLS
29
30 #include <bits/types.h>
31
32 #define __need_size_t
33 #include <stddef.h>
34
35
36 /* The group structure.  */
37 struct group
38   {
39     char *gr_name;              /* Group name.  */
40     char *gr_passwd;            /* Password.    */
41     __gid_t gr_gid;             /* Group ID.    */
42     char **gr_mem;              /* Member list. */
43   };
44
45
46 #if defined(__USE_SVID) || defined(__USE_GNU)
47 #define __need_FILE
48 #include <stdio.h>
49 #endif
50
51 #ifdef  __USE_GNU
52 /* Return a new stream open on the group file.  */
53 extern FILE *__grpopen __P ((void));
54
55 /* Read a group entry from STREAM, filling in G.
56    Return the `struct group' of G if successful, NULL on failure.  */
57 extern struct group *__grpread __P ((FILE *__stream, __ptr_t __g));
58
59 /* Return a chunk of memory containing pre-initialized data for __grpread.  */
60 extern __ptr_t __grpalloc __P ((void));
61
62 /* Scan the group file, filling in G, until SELECTOR returns nonzero for an
63    entry.  Return the `struct group' of G if successful, NULL on failure.  */
64 extern struct group *__grpscan __P ((__ptr_t *__p,
65                                      int (*__selector) (struct group *)));
66 #endif
67
68
69 #if defined(__USE_SVID) || defined (__USE_BSD) || defined(__USE_XOPEN_EXTENDED)
70 /* Rewind the group-file stream.  */
71 extern void setgrent __P ((void));
72
73 /* Close the group-file stream.  */
74 extern void endgrent __P ((void));
75
76 /* Read an entry from the group-file stream, opening it if necessary.  */
77 extern struct group *getgrent __P ((void));
78 #endif
79
80 #ifdef  __USE_SVID
81 /* Read a group entry from STREAM.  */
82 extern struct group *fgetgrent __P ((FILE *__stream));
83 #endif
84
85 /* Search for an entry with a matching group ID.  */
86 extern struct group *getgrgid __P ((__gid_t __gid));
87
88 /* Search for an entry with a matching group name.  */
89 extern struct group *getgrnam __P ((__const char *__name));
90
91 #if defined __USE_POSIX || defined __USE_MISC
92
93 #ifdef __USE_MISC
94 /* Reasonable value for the buffer sized used in the reentrant
95    functions below.  But better use `sysconf'.  */
96 #define NSS_BUFLEN_GROUP        1024
97 #endif
98
99 /* Reentrant versions of some of the functions above.
100
101    PLEASE NOTE: the `getgrent_r' function is not (yet) standardized.
102    The interface may change in later versions of this library.  But
103    the interface is designed following the principals used for the
104    other reentrant functions so the chances are good this is what the
105    POSIX people would choose.  */
106
107 #if defined(__USE_SVID) || defined (__USE_BSD) || defined(__USE_XOPEN_EXTENDED)
108 extern int __getgrent_r __P ((struct group *__resultbuf, char *buffer,
109                               size_t __buflen, struct group **__result));
110 extern int getgrent_r __P ((struct group *__resultbuf, char *buffer,
111                             size_t __buflen, struct group **__result));
112 #endif
113
114 /* Search for an entry with a matching group ID.  */
115 extern int getgrgid_r __P ((__gid_t __gid, struct group *__resultbuf,
116                             char *buffer, size_t __buflen,
117                             struct group **__result));
118
119 /* Search for an entry with a matching group name.  */
120 extern int getgrnam_r __P ((__const char *__name, struct group *__resultbuf,
121                             char *buffer, size_t __buflen,
122                             struct group **__result));
123
124 #ifdef  __USE_SVID
125 /* Read a group entry from STREAM.  This function is not standardized
126    an probably never will.  */
127 extern int __fgetgrent_r __P ((FILE * __stream, struct group *__resultbuf,
128                                char *buffer, size_t __buflen,
129                                struct group **__result));
130 extern int fgetgrent_r __P ((FILE * __stream, struct group *__resultbuf,
131                              char *buffer, size_t __buflen,
132                              struct group **__result));
133 #endif
134
135 #endif  /* POSIX or reentrant */
136
137
138 #ifdef  __USE_BSD
139
140 #define __need_size_t
141 #include <stddef.h>
142
143 /* Set the group set for the current user to GROUPS (N of them).  */
144 extern int setgroups __P ((size_t __n, __const __gid_t *__groups));
145
146 /* Initialize the group set for the current user
147    by reading the group database and using all groups
148    of which USER is a member.  Also include GROUP.  */
149 extern int initgroups __P ((__const char *__user, __gid_t __group));
150
151 #endif /* Use BSD.  */
152
153 __END_DECLS
154
155 #endif /* grp.h  */