[apple/xnu.git] / osfmk / UserNotification / KUNCUserNotifications.h

/*
 * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 *
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 *
 * This 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 OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 *
 * @APPLE_LICENSE_HEADER_END@
 */

#ifndef __USERNOTIFICATION_KUNCUSERNOTIFICATIONS_H
#define __USERNOTIFICATION_KUNCUSERNOTIFICATIONS_H

#include <sys/cdefs.h>


#include <mach/message.h>
#include <mach/kern_return.h>
#include <UserNotification/UNDTypes.h>

__BEGIN_DECLS

/*
 * non blocking notice call.
 */
kern_return_t
KUNCUserNotificationDisplayNotice(
	int		noticeTimeout,
	unsigned	flags,
	char		*iconPath,
	char		*soundPath,
	char		*localizationPath,
	char		*alertHeader,
	char		*alertMessage,
	char		*defaultButtonTitle);

/*
 * ***BLOCKING*** alert call, returned int value corresponds to the
 * pressed button, spin this off in a thread only, or expect your kext to block.
 */
kern_return_t
KUNCUserNotificationDisplayAlert(
	int		alertTimeout,
	unsigned	flags,
	char		*iconPath,
	char		*soundPath,
	char		*localizationPath,
	char		*alertHeader,
	char		*alertMessage,
	char 		*defaultButtonTitle,
	char		*alternateButtonTitle,
	char		*otherButtonTitle,
	unsigned	*responseFlags);

/*
 * Execute a userland executable with the given path, user and type
 */
 
#define kOpenApplicationPath 	0	/* essentially executes the path */
#define kOpenPreferencePanel    1	/* runs the preferences with the foo.preference opened.  foo.preference must exist in /System/Library/Preferences */
#define kOpenApplication	2	/* essentially runs /usr/bin/open on the passed in application name */
 
 
#define kOpenAppAsRoot		0
#define kOpenAppAsConsoleUser	1 
 
kern_return_t
KUNCExecute(
	char	*executionPath,
	int	openAsUser,
	int	pathExecutionType);


/* KUNC User Notification XML Keys
 *
 * These are the keys used in the xml plist file passed in to the
 * KUNCUserNotitificationDisplayFrom* calls
 *
 * KUNC Notifications are completely dependent on CFUserNotifications in
 * user land.  The same restrictions apply, including the number of text fields,
 * types of information displayable, etc.
 *
 *  Key			Type
 * Header			string (header displayed on dialog)
 * 				corresponds to kCFUserNotificationAlertHeaderKey
 *
 * Icon URL			string (url of the icon to display)
 * 				corresponds to kCFUserNotificationIconURLKey
 *
 * Sound URL			string (url of the sound to play on display)
 * 				corresponds to kCFUserNotificationSoundURLKey
 *
 * Localization URL		string (url of bundle to retrieve localization
 *				info from, using Localizable.strings files)
 * 				corresponds to kCFUserNotificationLocalizationURLKey
 *
 * Message			string (text of the message, can contain %@'s
 *				which are filled from tokenString passed in) 
 * 				corresponds to kCFUserNotificationAlertMessageKey
 *
 * OK Button Title 		string (title of the "main" button)
 * 				corresponds to kCFUserNotificationDefaultButtonTitleKey
 *
 * Alternate Button Title 	string (title of the "alternate" button,  usually cancel)
 * 				corresponds to kCFUserNotificationAlternateButtonTitleKey
 *
 * Other Button Title	 	string (title of the "other" button)
 * 				corresponds to kCFUserNotificationOtherButtonTitleKey
 *
 * Timeout			string (numeric, int - seconds until the dialog
 *				goes away on it's own)
 *
 * Alert Level			string (Stop, Notice, Alert)
 *
 * Blocking Message		string (numeric, 1 or 0 - if 1, the dialog will
 *				have no buttons)
 *
 * Text Field Strings		array of strings (each becomes a text field)
 * 				corresponds to kCFUserNotificationTextFieldTitlesKey
 *
 * Password Fields		array of strings (numeric - each indicates a
 *				pwd field)
 *
 * Popup Button Strings		array of strings (each entry becomes a popup
 *				button string)
 *
 * Radio Button Strings		array of strings (each becomes a radio button)
 *
 * Check Box Strings		array of strings (each becomes a check box)
 * 				corresponds to kCFUserNotificationCheckBoxTitlesKey
 *
 * Selected Radio		string (numeric - which radio is selected)
 *
 * Checked Boxes		array of strings (numeric - each indicates a
 *				checked field)
 *
 * Selected Popup		string (numeric - which popup entry is selected)
 *
 */

/*
 * Bundle Calls
 *
 *	Arguments
 *
 *	bundleIdentifier
 *		path to the actual bundle (not inside of it)
 *	        (i.e. "/System/Library/Extensions/Foo.kext")
 *		***NOTE***
 *		This WILL change soon to expect the CFBundleIdentifier instead of a bundle path
 *	fileName
 *		filename in bundle to retrive the xml from (i.e. "Messages")
 *	fileExtension 
 *		if fileName has an extension, it goes here (i.e., "dict");
 *	messageKey
 *		name of the xml key in the dictionary in the file to retrieve
 *		the info from (i.e., "Error Message")
 *	tokenString
 *		a string in the form of "foo@bar" where each element is
 *		seperated by the @ character.  This string can be used to
 *		replace values of the form %@ in the message key in the provided
 *		dictionary in the xml plist
 *	specialKey
 *		user specified key for notification, use this to match return
 *		values with your requested notification, this value is passed
 *		back to the client in the callback pararmeter contextKey
 */

typedef int KUNCUserNotificationID;

/*
 * Reponse value checking & default setting
 *
 * The reponse value returned in the response Flags of the
 * KUNCUserNotificationCallBack can be tested against the following
 * enum and 2 defines to determine the state.
 */

enum {
    kKUNCDefaultResponse	= 0,
    kKUNCAlternateResponse	= 1,
    kKUNCOtherResponse		= 2,
    kKUNCCancelResponse		= 3
};

#define KUNCCheckBoxChecked(i)	(1 << (8 + i))   /* can be used for radio's too */
#define KUNCPopUpSelection(n)	(n << 24)

/*
 * Callback function for KUNCNotifications
 */
typedef void
(*KUNCUserNotificationCallBack)(
	int		contextKey,
	int		responseFlags,
	void		*xmlData);

/*
 * Get a notification ID
 */
KUNCUserNotificationID KUNCGetNotificationID(void);


/* This function currently requires a bundle path, which kexts cannot currently get.  In the future, the CFBundleIdentiofier of the kext will be pass in in place of the bundlePath. */

kern_return_t
KUNCUserNotificationDisplayFromBundle(
	KUNCUserNotificationID		notificationID,
	char				*bundleIdentifier,
	char				*fileName,
	char				*fileExtension,
	char				*messageKey,
	char				*tokenString,
	KUNCUserNotificationCallBack	callback,
	int				contextKey);


kern_return_t
KUNCUserNotificationCancel(
	KUNCUserNotificationID	notification);


__END_DECLS

#endif  /* __USERNOTIFICATION_KUNCUSERNOTIFICATIONS_H */
Commit	Line	Data
1c79356b	1	/*
91447636	2	* Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
1c79356b A	3	*
1c79356b A	4	* @APPLE_LICENSE_HEADER_START@
37839358 A	5	*
	6	* The contents of this file constitute Original Code as defined in and
	7	* are subject to the Apple Public Source License Version 1.1 (the
	8	* "License"). You may not use this file except in compliance with the
	9	* License. Please obtain a copy of the License at
	10	* http://www.apple.com/publicsource and read it before using this file.
	11	*
	12	* This Original Code and all software distributed under the License are
	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
37839358 A	16	* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
	17	* License for the specific language governing rights and limitations
	18	* under the License.
	19	*
1c79356b A	20	* @APPLE_LICENSE_HEADER_END@
	21	*/
	22
	23	#ifndef __USERNOTIFICATION_KUNCUSERNOTIFICATIONS_H
	24	#define __USERNOTIFICATION_KUNCUSERNOTIFICATIONS_H
	25
	26	#include <sys/cdefs.h>
	27
	28
	29	#include <mach/message.h>
	30	#include <mach/kern_return.h>
	31	#include <UserNotification/UNDTypes.h>
	32
	33	__BEGIN_DECLS
	34
	35	/*
	36	* non blocking notice call.
	37	*/
	38	kern_return_t
	39	KUNCUserNotificationDisplayNotice(
91447636	40	int noticeTimeout,
1c79356b A	41	unsigned flags,
	42	char *iconPath,
	43	char *soundPath,
	44	char *localizationPath,
	45	char *alertHeader,
	46	char *alertMessage,
	47	char *defaultButtonTitle);
	48
	49	/*
	50	* *BLOCKING* alert call, returned int value corresponds to the
	51	* pressed button, spin this off in a thread only, or expect your kext to block.
	52	*/
	53	kern_return_t
	54	KUNCUserNotificationDisplayAlert(
91447636	55	int alertTimeout,
1c79356b A	56	unsigned flags,
	57	char *iconPath,
	58	char *soundPath,
	59	char *localizationPath,
	60	char *alertHeader,
	61	char *alertMessage,
	62	char *defaultButtonTitle,
	63	char *alternateButtonTitle,
	64	char *otherButtonTitle,
	65	unsigned *responseFlags);
	66
	67	/*
	68	* Execute a userland executable with the given path, user and type
	69	*/
	70
	71	#define kOpenApplicationPath 0 /* essentially executes the path */
	72	#define kOpenPreferencePanel 1 /* runs the preferences with the foo.preference opened. foo.preference must exist in /System/Library/Preferences */
	73	#define kOpenApplication 2 /* essentially runs /usr/bin/open on the passed in application name */
	74
	75
	76	#define kOpenAppAsRoot 0
	77	#define kOpenAppAsConsoleUser 1
	78
	79	kern_return_t
	80	KUNCExecute(
	81	char *executionPath,
	82	int openAsUser,
	83	int pathExecutionType);
	84
	85
	86	/* KUNC User Notification XML Keys
	87	*
	88	* These are the keys used in the xml plist file passed in to the
	89	* KUNCUserNotitificationDisplayFrom* calls
	90	*
	91	* KUNC Notifications are completely dependent on CFUserNotifications in
	92	* user land. The same restrictions apply, including the number of text fields,
	93	* types of information displayable, etc.
	94	*
	95	* Key Type
	96	* Header string (header displayed on dialog)
91447636 A	97	* corresponds to kCFUserNotificationAlertHeaderKey
91447636 A	98	*
1c79356b	99	* Icon URL string (url of the icon to display)
91447636 A	100	* corresponds to kCFUserNotificationIconURLKey
91447636 A	101	*
1c79356b	102	* Sound URL string (url of the sound to play on display)
91447636 A	103	* corresponds to kCFUserNotificationSoundURLKey
91447636 A	104	*
1c79356b A	105	* Localization URL string (url of bundle to retrieve localization
1c79356b A	106	* info from, using Localizable.strings files)
91447636 A	107	* corresponds to kCFUserNotificationLocalizationURLKey
91447636 A	108	*
1c79356b A	109	* Message string (text of the message, can contain %@'s
1c79356b A	110	* which are filled from tokenString passed in)
91447636 A	111	* corresponds to kCFUserNotificationAlertMessageKey
91447636 A	112	*
1c79356b	113	* OK Button Title string (title of the "main" button)
91447636 A	114	* corresponds to kCFUserNotificationDefaultButtonTitleKey
	115	*
	116	* Alternate Button Title string (title of the "alternate" button, usually cancel)
	117	* corresponds to kCFUserNotificationAlternateButtonTitleKey
	118	*
1c79356b	119	* Other Button Title string (title of the "other" button)
91447636 A	120	* corresponds to kCFUserNotificationOtherButtonTitleKey
91447636 A	121	*
1c79356b A	122	* Timeout string (numeric, int - seconds until the dialog
1c79356b A	123	* goes away on it's own)
91447636 A	124	*
	125	* Alert Level string (Stop, Notice, Alert)
	126	*
1c79356b A	127	* Blocking Message string (numeric, 1 or 0 - if 1, the dialog will
1c79356b A	128	* have no buttons)
91447636	129	*
1c79356b	130	* Text Field Strings array of strings (each becomes a text field)
91447636 A	131	* corresponds to kCFUserNotificationTextFieldTitlesKey
91447636 A	132	*
1c79356b A	133	* Password Fields array of strings (numeric - each indicates a
1c79356b A	134	* pwd field)
91447636	135	*
1c79356b A	136	* Popup Button Strings array of strings (each entry becomes a popup
1c79356b A	137	* button string)
91447636	138	*
1c79356b	139	* Radio Button Strings array of strings (each becomes a radio button)
91447636	140	*
1c79356b	141	* Check Box Strings array of strings (each becomes a check box)
91447636 A	142	* corresponds to kCFUserNotificationCheckBoxTitlesKey
91447636 A	143	*
1c79356b	144	* Selected Radio string (numeric - which radio is selected)
91447636	145	*
1c79356b A	146	* Checked Boxes array of strings (numeric - each indicates a
1c79356b A	147	* checked field)
91447636	148	*
1c79356b	149	* Selected Popup string (numeric - which popup entry is selected)
91447636	150	*
1c79356b A	151	*/
	152
	153	/*
	154	* Bundle Calls
	155	*
	156	* Arguments
	157	*
	158	* bundleIdentifier
	159	* path to the actual bundle (not inside of it)
	160	* (i.e. "/System/Library/Extensions/Foo.kext")
	161	* *NOTE*
	162	* This WILL change soon to expect the CFBundleIdentifier instead of a bundle path
	163	* fileName
	164	* filename in bundle to retrive the xml from (i.e. "Messages")
	165	* fileExtension
	166	* if fileName has an extension, it goes here (i.e., "dict");
	167	* messageKey
	168	* name of the xml key in the dictionary in the file to retrieve
	169	* the info from (i.e., "Error Message")
	170	* tokenString
	171	* a string in the form of "foo@bar" where each element is
	172	* seperated by the @ character. This string can be used to
	173	* replace values of the form %@ in the message key in the provided
	174	* dictionary in the xml plist
	175	* specialKey
	176	* user specified key for notification, use this to match return
	177	* values with your requested notification, this value is passed
	178	* back to the client in the callback pararmeter contextKey
	179	*/
	180
	181	typedef int KUNCUserNotificationID;
	182
	183	/*
	184	* Reponse value checking & default setting
	185	*
	186	* The reponse value returned in the response Flags of the
	187	* KUNCUserNotificationCallBack can be tested against the following
	188	* enum and 2 defines to determine the state.
	189	*/
	190
	191	enum {
	192	kKUNCDefaultResponse = 0,
	193	kKUNCAlternateResponse = 1,
	194	kKUNCOtherResponse = 2,
	195	kKUNCCancelResponse = 3
	196	};
	197
	198	#define KUNCCheckBoxChecked(i) (1 << (8 + i)) /* can be used for radio's too */
	199	#define KUNCPopUpSelection(n) (n << 24)
	200
	201	/*
	202	* Callback function for KUNCNotifications
	203	*/
	204	typedef void
	205	(*KUNCUserNotificationCallBack)(
91447636 A	206	int contextKey,
	207	int responseFlags,
	208	void *xmlData);
1c79356b A	209
	210	/*
	211	* Get a notification ID
	212	*/
91447636	213	KUNCUserNotificationID KUNCGetNotificationID(void);
1c79356b A	214
	215
	216	/* This function currently requires a bundle path, which kexts cannot currently get. In the future, the CFBundleIdentiofier of the kext will be pass in in place of the bundlePath. */
	217
	218	kern_return_t
	219	KUNCUserNotificationDisplayFromBundle(
	220	KUNCUserNotificationID notificationID,
	221	char *bundleIdentifier,
	222	char *fileName,
	223	char *fileExtension,
	224	char *messageKey,
	225	char *tokenString,
	226	KUNCUserNotificationCallBack callback,
	227	int contextKey);
	228
	229
	230	kern_return_t
	231	KUNCUserNotificationCancel(
	232	KUNCUserNotificationID notification);
	233
	234
	235	__END_DECLS
	236
	237	#endif /* __USERNOTIFICATION_KUNCUSERNOTIFICATIONS_H */