1 /* $NetBSD: prop_ingest.h,v 1.2 2007/08/16 16:28:17 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_INGEST_H_ 40 #define _PROPLIB_PROP_INGEST_H_ 41 42 #include <prop/prop_dictionary.h> 43 44 typedef enum { 45 PROP_INGEST_ERROR_NO_ERROR = 0, 46 PROP_INGEST_ERROR_NO_KEY = 1, 47 PROP_INGEST_ERROR_WRONG_TYPE = 2, 48 PROP_INGEST_ERROR_HANDLER_FAILED = 3 49 } prop_ingest_error_t; 50 51 typedef enum { 52 PROP_INGEST_FLAG_OPTIONAL = 0x01 53 } prop_ingest_flag_t; 54 55 typedef struct _prop_ingest_context *prop_ingest_context_t; 56 57 typedef bool (*prop_ingest_handler_t)(prop_ingest_context_t, prop_object_t); 58 59 typedef struct { 60 const char *pite_key; 61 prop_type_t pite_type; 62 unsigned int pite_flags; 63 prop_ingest_handler_t pite_handler; 64 } prop_ingest_table_entry; 65 66 #define PROP_INGEST(key_, type_, handler_) \ 67 { .pite_key = key_ , \ 68 .pite_type = type_ , \ 69 .pite_flags = 0 , \ 70 .pite_handler = handler_ } 71 72 #define PROP_INGEST_OPTIONAL(key_, type_, handler_) \ 73 { .pite_key = key_ , \ 74 .pite_type = type_ , \ 75 .pite_flags = PROP_INGEST_FLAG_OPTIONAL , \ 76 .pite_handler = handler_ } 77 78 #define PROP_INGEST_END \ 79 { .pite_key = NULL } 80 81 __BEGIN_DECLS 82 prop_ingest_context_t 83 prop_ingest_context_alloc(void *); 84 void prop_ingest_context_free(prop_ingest_context_t); 85 86 prop_ingest_error_t 87 prop_ingest_context_error(prop_ingest_context_t); 88 prop_type_t prop_ingest_context_type(prop_ingest_context_t); 89 const char * prop_ingest_context_key(prop_ingest_context_t); 90 void * prop_ingest_context_private(prop_ingest_context_t); 91 92 bool prop_dictionary_ingest(prop_dictionary_t, 93 const prop_ingest_table_entry[], 94 prop_ingest_context_t); 95 __END_DECLS 96 97 #endif /* _PROPLIB_PROP_INGEST_H_ */ 98