Merge branch 'master' of ssh://swildner@crater.dragonflybsd.org/repository/git/dragonfly
[dragonfly.git] / lib / libutil / libutil.h
blob12eeed987ab072a7312227fbdc7182ccd71a047e
1 /*
2 * Copyright (c) 1996 Peter Wemm <peter@FreeBSD.org>.
3 * All rights reserved.
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.
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.
26 * $FreeBSD: src/lib/libutil/libutil.h,v 1.26.2.3 2000/11/22 03:49:49 murray Exp $
27 * $DragonFly: src/lib/libutil/libutil.h,v 1.8 2008/09/14 20:04:59 swildner Exp $
30 #ifndef _LIBUTIL_H_
31 #define _LIBUTIL_H_
33 #include <sys/cdefs.h>
35 #ifdef _PWD_H_
36 #define _PWSCAN_MASTER 0x01
37 #define _PWSCAN_WARN 0x02
38 #endif
40 #define PROPERTY_MAX_NAME 64
41 #define PROPERTY_MAX_VALUE 512
43 /* for properties.c */
44 typedef struct _property {
45 struct _property *next;
46 char *name;
47 char *value;
48 } *properties;
50 /* Avoid pulling in all the include files for no need */
51 struct termios;
52 struct winsize;
53 struct utmp;
54 struct in_addr;
55 struct sockaddr;
57 __BEGIN_DECLS
58 int flopen(const char *, int, ...);
59 void login(struct utmp *);
60 int login_tty(int);
61 int logout(const char *);
62 void logwtmp(const char *, const char *, const char *);
63 void trimdomain(char *, int);
64 int openpty(int *, int *, char *, struct termios *, struct winsize *);
65 int forkpty(int *, char *, struct termios *, struct winsize *);
66 int dehumanize_number(const char *, int64_t *);
67 int humanize_number(char *, size_t, int64_t, const char *, int, int);
68 const char *uu_lockerr(int);
69 int uu_lock(const char *);
70 int uu_unlock(const char *);
71 int uu_lock_txfr(const char *, pid_t);
72 int _secure_path(const char *, uid_t, gid_t);
73 int pidfile(const char *);
74 properties properties_read(int fd);
75 void properties_free(properties);
76 char *property_find(properties, const char *);
77 char *auth_getval(const char *);
78 int realhostname(char *, size_t, const struct in_addr *);
79 int realhostname_sa(char *, size_t, struct sockaddr *, int);
80 #ifdef _STDIO_H_ /* avoid adding new includes */
81 char *fparseln(FILE *, size_t *, size_t *, const char[3], int);
82 #endif
84 #ifdef _PWD_H_
85 int __pw_scan(char *, struct passwd *, int);
86 int pw_copy(int _ffd, int _tfd, const struct passwd *_pw, struct passwd *_old_pw);
87 struct passwd *pw_dup(const struct passwd *_pw);
88 int pw_edit(int _notsetuid);
89 int pw_equal(const struct passwd *_pw1, const struct passwd *_pw2);
90 void pw_fini(void);
91 int pw_init(const char *_dir, const char *_master);
92 char *pw_make(const struct passwd *_pw);
93 int pw_mkdb(const char *_user);
94 int pw_lock(void);
95 struct passwd *pw_scan(const char *_line, int _flags);
96 const char *pw_tempname(void);
97 int pw_tmp(int _mfd);
98 #endif
99 __END_DECLS
101 #define UU_LOCK_INUSE (1)
102 #define UU_LOCK_OK (0)
103 #define UU_LOCK_OPEN_ERR (-1)
104 #define UU_LOCK_READ_ERR (-2)
105 #define UU_LOCK_CREAT_ERR (-3)
106 #define UU_LOCK_WRITE_ERR (-4)
107 #define UU_LOCK_LINK_ERR (-5)
108 #define UU_LOCK_TRY_ERR (-6)
109 #define UU_LOCK_OWNER_ERR (-7)
111 /* return values from realhostname() */
112 #define HOSTNAME_FOUND (0)
113 #define HOSTNAME_INCORRECTNAME (1)
114 #define HOSTNAME_INVALIDADDR (2)
115 #define HOSTNAME_INVALIDNAME (3)
117 /* fparseln(3) */
118 #define FPARSELN_UNESCESC 0x01
119 #define FPARSELN_UNESCCONT 0x02
120 #define FPARSELN_UNESCCOMM 0x04
121 #define FPARSELN_UNESCREST 0x08
122 #define FPARSELN_UNESCALL 0x0f
124 /* humanize_number(3) */
125 #define HN_DECIMAL 0x01
126 #define HN_NOSPACE 0x02
127 #define HN_B 0x04
128 #define HN_DIVISOR_1000 0x08
129 #define HN_GETSCALE 0x10
130 #define HN_AUTOSCALE 0x20
132 #endif /* !_LIBUTIL_H_ */