Initial import from FreeBSD RELENG_4:
[dragonfly.git] / lib / libutil / libutil.h
1 /*
2  * Copyright (c) 1996  Peter Wemm <peter@FreeBSD.org>.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, is permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD: src/lib/libutil/libutil.h,v 1.26.2.3 2000/11/22 03:49:49 murray Exp $
27  */
28
29 #ifndef _LIBUTIL_H_
30 #define _LIBUTIL_H_
31
32 #include <sys/cdefs.h>
33
34 #define PROPERTY_MAX_NAME       64
35 #define PROPERTY_MAX_VALUE      512
36
37 /* for properties.c */
38 typedef struct _property {
39         struct _property *next;
40         char *name;
41         char *value;
42 } *properties;
43
44 /* Avoid pulling in all the include files for no need */
45 struct termios;
46 struct winsize;
47 struct utmp;
48 struct in_addr;
49
50 __BEGIN_DECLS
51 void    login __P((struct utmp *_ut));
52 int     login_tty __P((int _fd));
53 int     logout __P((const char *_line));
54 void    logwtmp __P((const char *_line, const char *_name, const char *_host));
55 void    trimdomain __P((char *_fullhost, int _hostsize));
56 int     openpty __P((int *_amaster, int *_aslave, char *_name,
57                      struct termios *_termp, struct winsize *_winp));
58 int     forkpty __P((int *_amaster, char *_name,
59                      struct termios *_termp, struct winsize *_winp));
60 const char *uu_lockerr __P((int _uu_lockresult));
61 int     uu_lock __P((const char *_ttyname));
62 int     uu_unlock __P((const char *_ttyname));
63 int     uu_lock_txfr __P((const char *_ttyname, pid_t _pid));
64 int     _secure_path __P((const char *_path, uid_t _uid, gid_t _gid));
65 properties properties_read __P((int fd));
66 void    properties_free __P((properties list));
67 char    *property_find __P((properties list, const char *name));
68 char    *auth_getval __P((const char *name));
69 int     realhostname __P((char *host, size_t hsize, const struct in_addr *ip));
70 struct sockaddr;
71 int     realhostname_sa __P((char *host, size_t hsize, struct sockaddr *addr,
72                              int addrlen));
73 #ifdef _STDIO_H_        /* avoid adding new includes */
74 char   *fparseln __P((FILE *, size_t *, size_t *, const char[3], int));
75 #endif
76 __END_DECLS
77
78 #define UU_LOCK_INUSE (1)
79 #define UU_LOCK_OK (0)
80 #define UU_LOCK_OPEN_ERR (-1)
81 #define UU_LOCK_READ_ERR (-2)
82 #define UU_LOCK_CREAT_ERR (-3)
83 #define UU_LOCK_WRITE_ERR (-4)
84 #define UU_LOCK_LINK_ERR (-5)
85 #define UU_LOCK_TRY_ERR (-6)
86 #define UU_LOCK_OWNER_ERR (-7)
87
88 /* return values from realhostname() */
89 #define HOSTNAME_FOUND          (0)
90 #define HOSTNAME_INCORRECTNAME  (1)
91 #define HOSTNAME_INVALIDADDR    (2)
92 #define HOSTNAME_INVALIDNAME    (3)
93
94 /* fparseln(3) */
95 #define FPARSELN_UNESCESC       0x01
96 #define FPARSELN_UNESCCONT      0x02
97 #define FPARSELN_UNESCCOMM      0x04
98 #define FPARSELN_UNESCREST      0x08
99 #define FPARSELN_UNESCALL       0x0f
100
101 #endif /* !_LIBUTIL_H_ */