[apple/libc.git] / include / util.h

/*
 * Copyright (c) 2000, 2007, 2008 Apple Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*	$NetBSD: util.h,v 1.10 1997/12/01 02:25:46 lukem Exp $	*/

/*-
 * Copyright (c) 1995
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#ifndef _UTIL_H_
#define _UTIL_H_

#include <sys/cdefs.h>
#include <sys/ttycom.h>
#include <sys/types.h>
#include <stdio.h>
#include <pwd.h>
#include <termios.h>
#include <Availability.h>

#define	PIDLOCK_NONBLOCK	1
#define PIDLOCK_USEHOSTNAME	2

/*
 * fparseln() specific operation flags.
 */
#define	FPARSELN_UNESCESC	0x01
#define	FPARSELN_UNESCCONT	0x02
#define	FPARSELN_UNESCCOMM	0x04
#define	FPARSELN_UNESCREST	0x08
#define	FPARSELN_UNESCALL	0x0f

/*
 * opendev() specific operation flags.
 */
#define OPENDEV_PART	0x01		/* Try to open the raw partition. */
#define OPENDEV_BLCK	0x04		/* Open block, not character device. */

__BEGIN_DECLS
#ifdef UNIFDEF_LEGACY_UTMP_APIS
struct utmp; /* forward reference to /usr/include/utmp.h */
void	login(struct utmp *)		__OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0,__MAC_10_5,__IPHONE_NA,__IPHONE_NA);
#endif /* UNIFDEF_LEGACY_UTMP_APIS */
int	login_tty(int);
#ifdef UNIFDEF_LEGACY_UTMP_APIS
int	logout(const char *)		__OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0,__MAC_10_5,__IPHONE_NA,__IPHONE_NA);
#endif /* UNIFDEF_LEGACY_UTMP_APIS */
void	logwtmp(const char *, const char *, const char *) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0,__MAC_10_5,__IPHONE_2_0,__IPHONE_2_0);
int	opendev(char *, int, int, char **);
int	openpty(int *, int *, char *, struct termios *,
		     struct winsize *);
char   *fparseln(FILE *, size_t *, size_t *, const char[3], int);
pid_t	forkpty(int *, char *, struct termios *, struct winsize *);
int	pidlock(const char *, int, pid_t *, const char *);
int	ttylock(const char *, int, pid_t *);
int	ttyunlock(const char *);
int	ttyaction(char *tty, char *act, char *user);
struct iovec;
char   *ttymsg(struct iovec *, int, const char *, int);
__END_DECLS
#ifdef UNIFDEF_LEGACY_UTMP_APIS

/* Include utmp.h last to avoid deprecation warning above */
#include <utmp.h>
#endif /* UNIFDEF_LEGACY_UTMP_APIS */

#endif /* !_UTIL_H_ */
Commit	Line	Data
e9ce8d39	1	/*
b5d655f7	2	* Copyright (c) 2000, 2007, 2008 Apple Inc. All rights reserved.
e9ce8d39 A	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
734aad71 A	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
e9ce8d39 A	15	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
e9ce8d39 A	16	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
734aad71 A	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.
e9ce8d39 A	20	*
	21	* @APPLE_LICENSE_HEADER_END@
	22	*/
5b2abdfb A	23	/* $NetBSD: util.h,v 1.10 1997/12/01 02:25:46 lukem Exp $ */
	24
	25	/*-
	26	* Copyright (c) 1995
e9ce8d39 A	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
5b2abdfb A	58	#ifndef _UTIL_H_
5b2abdfb A	59	#define _UTIL_H_
e9ce8d39	60
5b2abdfb A	61	#include <sys/cdefs.h>
5b2abdfb A	62	#include <sys/ttycom.h>
e9ce8d39	63	#include <sys/types.h>
e9ce8d39	64	#include <stdio.h>
5b2abdfb A	65	#include <pwd.h>
5b2abdfb A	66	#include <termios.h>
b5d655f7	67	#include <Availability.h>
5b2abdfb A	68
	69	#define PIDLOCK_NONBLOCK 1
	70	#define PIDLOCK_USEHOSTNAME 2
	71
9385eb3d A	72	/*
	73	* fparseln() specific operation flags.
	74	*/
5b2abdfb A	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
e9ce8d39	80
9385eb3d A	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
5b2abdfb	87	__BEGIN_DECLS
b5d655f7	88	#ifdef UNIFDEF_LEGACY_UTMP_APIS
224c7076	89	struct utmp; /* forward reference to /usr/include/utmp.h */
b5d655f7 A	90	void login(struct utmp *) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0,__MAC_10_5,__IPHONE_NA,__IPHONE_NA);
b5d655f7 A	91	#endif /* UNIFDEF_LEGACY_UTMP_APIS */
9385eb3d	92	int login_tty(int);
b5d655f7 A	93	#ifdef UNIFDEF_LEGACY_UTMP_APIS
	94	int logout(const char *) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0,__MAC_10_5,__IPHONE_NA,__IPHONE_NA);
	95	#endif /* UNIFDEF_LEGACY_UTMP_APIS */
	96	void logwtmp(const char , const char , const char *) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0,__MAC_10_5,__IPHONE_2_0,__IPHONE_2_0);
9385eb3d A	97	int opendev(char , int, int, char *);
	98	int openpty(int , int , char , struct termios ,
	99	struct winsize *);
	100	char fparseln(FILE , size_t , size_t , const char[3], int);
	101	pid_t forkpty(int , char , struct termios , struct winsize );
	102	int pidlock(const char , int, pid_t , const char *);
	103	int ttylock(const char , int, pid_t );
	104	int ttyunlock(const char *);
	105	int ttyaction(char tty, char act, char *user);
5b2abdfb	106	struct iovec;
9385eb3d	107	char ttymsg(struct iovec , int, const char *, int);
5b2abdfb	108	__END_DECLS
b5d655f7	109	#ifdef UNIFDEF_LEGACY_UTMP_APIS
e9ce8d39	110
224c7076 A	111	/* Include utmp.h last to avoid deprecation warning above */
224c7076 A	112	#include <utmp.h>
b5d655f7	113	#endif /* UNIFDEF_LEGACY_UTMP_APIS */
224c7076	114
5b2abdfb	115	#endif /* !_UTIL_H_ */