(UT_TYPE): Define.
[gnulib.git] / lib / readutmp.h
1 /* Declarations for GNU's read utmp module.
2    Copyright (C) 1992-2001 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 #  ifdef HAVE_UTMP_H
35     /* HPUX 10.20 needs utmp.h, for the definition of e.g., UTMP_FILE.  */
36 #   include <utmp.h>
37 #  endif
38 #  include <utmpx.h>
39 #  define UTMP_STRUCT_NAME utmpx
40 #  define UT_TIME_MEMBER(UT_PTR) ((UT_PTR)->ut_tv.tv_sec)
41 #  define SET_UTMP_ENT setutxent
42 #  define GET_UTMP_ENT getutxent
43 #  define END_UTMP_ENT endutxent
44 #  ifdef HAVE_UTMPXNAME
45 #   define UTMP_NAME_FUNCTION utmpxname
46 #  endif
47 # else
48 #  include <utmp.h>
49 #  if !HAVE_DECL_GETUTENT
50     struct utmp *getutent();
51 #  endif
52 #  define UTMP_STRUCT_NAME utmp
53 #  define UT_TIME_MEMBER(UT_PTR) ((UT_PTR)->ut_time)
54 #  define SET_UTMP_ENT setutent
55 #  define GET_UTMP_ENT getutent
56 #  define END_UTMP_ENT endutent
57 #  ifdef HAVE_UTMPNAME
58 #   define UTMP_NAME_FUNCTION utmpname
59 #  endif
60 # endif
61
62 /* Accessor macro for the member named ut_user or ut_name.  */
63 # ifdef HAVE_UTMPX_H
64
65 #  if HAVE_STRUCT_UTMPX_UT_USER
66 #   define UT_USER(Utmp) ((Utmp)->ut_user)
67 #  endif
68 #  if HAVE_STRUCT_UTMPX_UT_NAME
69 #   undef UT_USER
70 #   define UT_USER(Utmp) ((Utmp)->ut_name)
71 #  endif
72 #  if defined HAVE_STRUCT_UTMPX_UT_TYPE
73 #   define UT_TYPE(Utmp) ((Utmp)->ut_type)
74 #  endif
75
76 # else
77
78 #  if HAVE_STRUCT_UTMP_UT_USER
79 #   define UT_USER(Utmp) Utmp->ut_user
80 #  endif
81 #  if HAVE_STRUCT_UTMP_UT_NAME
82 #   undef UT_USER
83 #   define UT_USER(Utmp) Utmp->ut_name
84 #  endif
85 #  if defined HAVE_STRUCT_UTMP_UT_TYPE
86 #   define UT_TYPE(Utmp) ((Utmp)->ut_type)
87 #  endif
88
89 # endif
90
91 typedef struct UTMP_STRUCT_NAME STRUCT_UTMP;
92
93 # include <time.h>
94 # ifdef HAVE_SYS_PARAM_H
95 #  include <sys/param.h>
96 # endif
97
98 # include <errno.h>
99 # ifndef errno
100 extern int errno;
101 # endif
102
103 # if !defined (UTMP_FILE) && defined (_PATH_UTMP)
104 #  define UTMP_FILE _PATH_UTMP
105 # endif
106
107 # if !defined (WTMP_FILE) && defined (_PATH_WTMP)
108 #  define WTMP_FILE _PATH_WTMP
109 # endif
110
111 # ifdef UTMPX_FILE /* Solaris, SysVr4 */
112 #  undef UTMP_FILE
113 #  define UTMP_FILE UTMPX_FILE
114 # endif
115
116 # ifdef WTMPX_FILE /* Solaris, SysVr4 */
117 #  undef WTMP_FILE
118 #  define WTMP_FILE WTMPX_FILE
119 # endif
120
121 # ifndef UTMP_FILE
122 #  define UTMP_FILE "/etc/utmp"
123 # endif
124
125 # ifndef WTMP_FILE
126 #  define WTMP_FILE "/etc/wtmp"
127 # endif
128
129 # undef PARAMS
130 # if defined (__STDC__) && __STDC__
131 #  define PARAMS(Args) Args
132 # else
133 #  define PARAMS(Args) ()
134 # endif
135
136 extern char *extract_trimmed_name PARAMS ((const STRUCT_UTMP *ut));
137 extern int read_utmp PARAMS ((const char *filename,
138                               int *n_entries, STRUCT_UTMP **utmp_buf));
139
140 #endif /* __READUTMP_H__ */