xref: /trueos/include/util.h (revision 0f8eb4123024ffec2f2cfcdb493793aea43f0cac)
1 /*
2  * Copyright (c) 2000, 2007, 2008 Apple Inc. All rights reserved.
3  *
4  * @APPLE_LICENSE_HEADER_START@
5  *
6  * This file contains Original Code and/or Modifications of Original Code
7  * as defined in and that are subject to the Apple Public Source License
8  * Version 2.0 (the 'License'). You may not use this file except in
9  * compliance with the License. Please obtain a copy of the License at
10  * http://www.opensource.apple.com/apsl/ and read it before using this
11  * file.
12  *
13  * The Original Code and all software distributed under the License are
14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18  * Please see the License for the specific language governing rights and
19  * limitations under the License.
20  *
21  * @APPLE_LICENSE_HEADER_END@
22  */
23 /*	$NetBSD: util.h,v 1.10 1997/12/01 02:25:46 lukem Exp $	*/
24 
25 /*-
26  * Copyright (c) 1995
27  *	The Regents of the University of California.  All rights reserved.
28  *
29  * Redistribution and use in source and binary forms, with or without
30  * modification, are permitted provided that the following conditions
31  * are met:
32  * 1. Redistributions of source code must retain the above copyright
33  *    notice, this list of conditions and the following disclaimer.
34  * 2. Redistributions in binary form must reproduce the above copyright
35  *    notice, this list of conditions and the following disclaimer in the
36  *    documentation and/or other materials provided with the distribution.
37  * 3. All advertising materials mentioning features or use of this software
38  *    must display the following acknowledgement:
39  *	This product includes software developed by the University of
40  *	California, Berkeley and its contributors.
41  * 4. Neither the name of the University nor the names of its contributors
42  *    may be used to endorse or promote products derived from this software
43  *    without specific prior written permission.
44  *
45  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
46  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
47  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
48  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
49  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
50  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
51  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
52  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
53  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
54  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
55  * SUCH DAMAGE.
56  */
57 
58 #ifndef _UTIL_H_
59 #define _UTIL_H_
60 
61 #include <sys/cdefs.h>
62 #include <sys/ttycom.h>
63 #include <sys/types.h>
64 #include <stdio.h>
65 #include <pwd.h>
66 #include <termios.h>
67 #include <Availability.h>
68 
69 #define	PIDLOCK_NONBLOCK	1
70 #define PIDLOCK_USEHOSTNAME	2
71 
72 /*
73  * fparseln() specific operation flags.
74  */
75 #define	FPARSELN_UNESCESC	0x01
76 #define	FPARSELN_UNESCCONT	0x02
77 #define	FPARSELN_UNESCCOMM	0x04
78 #define	FPARSELN_UNESCREST	0x08
79 #define	FPARSELN_UNESCALL	0x0f
80 
81 /*
82  * opendev() specific operation flags.
83  */
84 #define OPENDEV_PART	0x01		/* Try to open the raw partition. */
85 #define OPENDEV_BLCK	0x04		/* Open block, not character device. */
86 
87 __BEGIN_DECLS
88 struct utmp; /* forward reference to /usr/include/utmp.h */
89 void	login(struct utmp *)		__OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0,__MAC_10_5,__IPHONE_NA,__IPHONE_NA);
90 int	login_tty(int);
91 int	logout(const char *)		__OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0,__MAC_10_5,__IPHONE_NA,__IPHONE_NA);
92 void	logwtmp(const char *, const char *, const char *) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0,__MAC_10_5,__IPHONE_2_0,__IPHONE_2_0);
93 int	opendev(char *, int, int, char **);
94 int	openpty(int *, int *, char *, struct termios *,
95 		     struct winsize *);
96 char   *fparseln(FILE *, size_t *, size_t *, const char[3], int);
97 pid_t	forkpty(int *, char *, struct termios *, struct winsize *);
98 int	pidlock(const char *, int, pid_t *, const char *);
99 int	ttylock(const char *, int, pid_t *);
100 int	ttyunlock(const char *);
101 int	ttyaction(char *tty, char *act, char *user);
102 struct iovec;
103 char   *ttymsg(struct iovec *, int, const char *, int);
104 __END_DECLS
105 
106 /* Include utmp.h last to avoid deprecation warning above */
107 #include <utmp.h>
108 
109 #endif /* !_UTIL_H_ */
110