Home | History | Annotate | Line # | Download | only in prop 
      1 /*	$NetBSD: prop_ingest.h,v 1.3 2008/04/28 20:22:51 martin 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  *
     19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29  * POSSIBILITY OF SUCH DAMAGE.
     30  */
     31 
     32 #ifndef _PROPLIB_PROP_INGEST_H_
     33 #define	_PROPLIB_PROP_INGEST_H_
     34 
     35 #include <prop/prop_dictionary.h>
     36 
     37 typedef enum {
     38 	PROP_INGEST_ERROR_NO_ERROR		= 0,
     39 	PROP_INGEST_ERROR_NO_KEY		= 1,
     40 	PROP_INGEST_ERROR_WRONG_TYPE		= 2,
     41 	PROP_INGEST_ERROR_HANDLER_FAILED	= 3
     42 } prop_ingest_error_t;
     43 
     44 typedef enum {
     45 	PROP_INGEST_FLAG_OPTIONAL		= 0x01
     46 } prop_ingest_flag_t;
     47 
     48 typedef struct _prop_ingest_context *prop_ingest_context_t;
     49 
     50 typedef bool (*prop_ingest_handler_t)(prop_ingest_context_t, prop_object_t);
     51 
     52 typedef struct {
     53 	const char *pite_key;
     54 	prop_type_t pite_type;
     55 	unsigned int pite_flags;
     56 	prop_ingest_handler_t pite_handler;
     57 } prop_ingest_table_entry;
     58 
     59 #define	PROP_INGEST(key_, type_, handler_)				\
     60 	{ .pite_key = key_ ,						\
     61 	  .pite_type = type_ ,						\
     62 	  .pite_flags = 0 ,						\
     63 	  .pite_handler = handler_ }
     64 
     65 #define	PROP_INGEST_OPTIONAL(key_, type_, handler_)			\
     66 	{ .pite_key = key_ ,						\
     67 	  .pite_type = type_ ,						\
     68 	  .pite_flags = PROP_INGEST_FLAG_OPTIONAL ,			\
     69 	  .pite_handler = handler_ }
     70 
     71 #define	PROP_INGEST_END							\
     72 	{ .pite_key = NULL }
     73 
     74 __BEGIN_DECLS
     75 prop_ingest_context_t
     76 		prop_ingest_context_alloc(void *);
     77 void		prop_ingest_context_free(prop_ingest_context_t);
     78 
     79 prop_ingest_error_t
     80 		prop_ingest_context_error(prop_ingest_context_t);
     81 prop_type_t	prop_ingest_context_type(prop_ingest_context_t);
     82 const char *	prop_ingest_context_key(prop_ingest_context_t);
     83 void *		prop_ingest_context_private(prop_ingest_context_t);
     84 
     85 bool		prop_dictionary_ingest(prop_dictionary_t,
     86 				       const prop_ingest_table_entry[],
     87 				       prop_ingest_context_t);
     88 __END_DECLS
     89 
     90 #endif /* _PROPLIB_PROP_INGEST_H_ */
     91