prop_dictionary.h revision 1.5
1/* $NetBSD: prop_dictionary.h,v 1.5 2006/09/22 04:20:23 thorpej Exp $ */ 2 3/*- 4 * Copyright (c) 2006 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Jason R. Thorpe. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 3. All advertising materials mentioning features or use of this software 19 * must display the following acknowledgement: 20 * This product includes software developed by the NetBSD 21 * Foundation, Inc. and its contributors. 22 * 4. Neither the name of The NetBSD Foundation nor the names of its 23 * contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 36 * POSSIBILITY OF SUCH DAMAGE. 37 */ 38 39#ifndef _PROPLIB_PROP_DICTIONARY_H_ 40#define _PROPLIB_PROP_DICTIONARY_H_ 41 42#include <prop/prop_object.h> 43 44typedef struct _prop_dictionary *prop_dictionary_t; 45typedef struct _prop_dictionary_keysym *prop_dictionary_keysym_t; 46 47__BEGIN_DECLS 48prop_dictionary_t prop_dictionary_create(void); 49prop_dictionary_t prop_dictionary_create_with_capacity(unsigned int); 50 51prop_dictionary_t prop_dictionary_copy(prop_dictionary_t); 52prop_dictionary_t prop_dictionary_copy_mutable(prop_dictionary_t); 53 54unsigned int prop_dictionary_capacity(prop_dictionary_t); 55unsigned int prop_dictionary_count(prop_dictionary_t); 56boolean_t prop_dictionary_ensure_capacity(prop_dictionary_t, 57 unsigned int); 58 59void prop_dictionary_make_immutable(prop_dictionary_t); 60boolean_t prop_dictionary_mutable(prop_dictionary_t); 61 62prop_object_iterator_t prop_dictionary_iterator(prop_dictionary_t); 63 64prop_object_t prop_dictionary_get(prop_dictionary_t, const char *); 65boolean_t prop_dictionary_set(prop_dictionary_t, const char *, 66 prop_object_t); 67void prop_dictionary_remove(prop_dictionary_t, const char *); 68 69prop_object_t prop_dictionary_get_keysym(prop_dictionary_t, 70 prop_dictionary_keysym_t); 71boolean_t prop_dictionary_set_keysym(prop_dictionary_t, 72 prop_dictionary_keysym_t, 73 prop_object_t); 74void prop_dictionary_remove_keysym(prop_dictionary_t, 75 prop_dictionary_keysym_t); 76 77boolean_t prop_dictionary_equals(prop_dictionary_t, prop_dictionary_t); 78 79char * prop_dictionary_externalize(prop_dictionary_t); 80prop_dictionary_t prop_dictionary_internalize(const char *); 81 82boolean_t prop_dictionary_externalize_to_file(prop_dictionary_t, 83 const char *); 84prop_dictionary_t prop_dictionary_internalize_from_file(const char *); 85 86const char * prop_dictionary_keysym_cstring_nocopy(prop_dictionary_keysym_t); 87 88boolean_t prop_dictionary_keysym_equals(prop_dictionary_keysym_t, 89 prop_dictionary_keysym_t); 90 91#if defined(__NetBSD__) 92#if !defined(_KERNEL) && !defined(_STANDALONE) 93int prop_dictionary_send_ioctl(prop_dictionary_t, int, 94 unsigned long); 95int prop_dictionary_recv_ioctl(int, unsigned long, 96 prop_dictionary_t *); 97int prop_dictionary_sendrecv_ioctl(prop_dictionary_t, 98 int, unsigned long, 99 prop_dictionary_t *); 100#elif defined(_KERNEL) 101struct plistref; 102 103int prop_dictionary_copyin_ioctl(const struct plistref *, 104 const u_long, 105 prop_dictionary_t *); 106int prop_dictionary_copyout_ioctl(struct plistref *, 107 const u_long, 108 prop_dictionary_t); 109#endif 110#endif /* __NetBSD__ */ 111__END_DECLS 112 113#endif /* _PROPLIB_PROP_DICTIONARY_H_ */ 114