redo it on per-header basis
[gnulib.git] / lib / readutmp.h
1 /* Declarations for GNU's read utmp module.
2    Copyright (C) 1992-2000 Free Software Foundation, Inc.
3
4    This program is free software; you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation; either version 2, or (at your option)
7    any later version.
8
9    This program 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
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program; if not, write to the Free Software Foundation,
16    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
17
18 /* Written by jla; revised by djm */
19
20 #ifndef __READUTMP_H__
21 # define __READUTMP_H__
22
23 # ifndef PARAMS
24 #  if defined PROTOTYPES || (defined __STDC__ && __STDC__)
25 #   define PARAMS(Args) Args
26 #  else
27 #   define PARAMS(Args) ()
28 #  endif
29 # endif
30
31 # include <sys/types.h>
32
33 # ifdef HAVE_UTMPX_H
34 #  include <utmpx.h>
35 #  define UTMP_STRUCT_NAME utmpx
36 #  define UT_TIME_MEMBER(UT_PTR) ((UT_PTR)->ut_tv.tv_sec)
37 #  define SET_UTMP_ENT setutxent
38 #  define GET_UTMP_ENT getutxent
39 #  define END_UTMP_ENT endutxent
40 #  define UTMP_NAME_FUNCTION utmpxname
41 # else
42 #  include <utmp.h>
43 #  define UTMP_STRUCT_NAME utmp
44 #  define UT_TIME_MEMBER(UT_PTR) ((UT_PTR)->ut_time)
45 #  define SET_UTMP_ENT setutent
46 #  define GET_UTMP_ENT getutent
47 #  define END_UTMP_ENT endutent
48 #  define UTMP_NAME_FUNCTION utmpname
49 # endif
50
51 /* Accessor macro for the member named ut_user or ut_name.  */
52 # ifdef HAVE_UTMPX_H
53
54 #  if HAVE_STRUCT_UTMPX_UT_USER
55 #   define UT_USER(Utmp) Utmp->ut_user
56 #  endif
57 #  if HAVE_STRUCT_UTMPX_UT_NAME
58 #   undef UT_USER
59 #   define UT_USER(Utmp) Utmp->ut_name
60 #  endif
61
62 # else
63
64 #  if HAVE_STRUCT_UTMP_UT_USER
65 #   define UT_USER(Utmp) Utmp->ut_user
66 #  endif
67 #  if HAVE_STRUCT_UTMP_UT_NAME
68 #   undef UT_USER
69 #   define UT_USER(Utmp) Utmp->ut_name
70 #  endif
71
72 # endif
73
74 typedef struct UTMP_STRUCT_NAME STRUCT_UTMP;
75
76 # include <time.h>
77 # ifdef HAVE_SYS_PARAM_H
78 #  include <sys/param.h>
79 # endif
80
81 # include <errno.h>
82 # ifndef errno
83 extern int errno;
84 # endif
85
86 # if !defined (UTMP_FILE) && defined (_PATH_UTMP)
87 #  define UTMP_FILE _PATH_UTMP
88 # endif
89
90 # if !defined (WTMP_FILE) && defined (_PATH_WTMP)
91 #  define WTMP_FILE _PATH_WTMP
92 # endif
93
94 # ifdef UTMPX_FILE /* Solaris, SysVr4 */
95 #  undef UTMP_FILE
96 #  define UTMP_FILE UTMPX_FILE
97 # endif
98
99 # ifdef WTMPX_FILE /* Solaris, SysVr4 */
100 #  undef WTMP_FILE
101 #  define WTMP_FILE WTMPX_FILE
102 # endif
103
104 # ifndef UTMP_FILE
105 #  define UTMP_FILE "/etc/utmp"
106 # endif
107
108 # ifndef WTMP_FILE
109 #  define WTMP_FILE "/etc/wtmp"
110 # endif
111
112 # undef PARAMS
113 # if defined (__STDC__) && __STDC__
114 #  define PARAMS(Args) Args
115 # else
116 #  define PARAMS(Args) ()
117 # endif
118
119 extern char *extract_trimmed_name PARAMS ((const STRUCT_UTMP *ut));
120 extern int read_utmp PARAMS ((const char *filename,
121                               int *n_entries, STRUCT_UTMP **utmp_buf));
122
123 #endif /* __READUTMP_H__ */