WebSVN – HelenOS – Diff – /branches/network/uspace/srv/net/structures/generic_char_map.h


/*
 * Copyright (c) 2009 Lukas Mejdrech
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - 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.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
 */
 
/** @addtogroup net
 *  @{
 */
 
/** @file
 */
 
#ifndef __GENERIC_CHAR_MAP_H__
#define __GENERIC_CHAR_MAP_H__
 
#include <errno.h>
#include <unistd.h>
 
#include "../err.h"
 
#include "char_map.h"
#include "generic_field.h"
 
#define GENERIC_CHAR_MAP_MAGIC_VALUE    0x12345622
 
#define GENERIC_CHAR_MAP_DECLARE( name, type )                                  \
                                                                                \
GENERIC_FIELD_DECLARE( name##_items, type )                                     \
                                                                                \
typedef struct name     name##_t;                                               \
typedef name##_t *      name##_ref;                                             \
                                                                                \
struct  name{                                                                   \
    char_map_t      names;                                                      \
    name##_items_t  values;                                                     \
    int             magic;                                                      \
};                                                                              \
                                                                                \
int name##_add( name##_ref map, const char * name, const size_t length, type * value ); \
int name##_count( name##_ref map );                                             \
void    name##_destroy( name##_ref map );                                       \
void    name##_exclude( name##_ref map, const char * name, const size_t length );   \
type *  name##_find( name##_ref map, const char * name, const size_t length );  \
type *  name##_get_index( name##_ref map, int index );                          \
int name##_initialize( name##_ref map );                                        \
int name##_is_valid( name##_ref map );
 
#define GENERIC_CHAR_MAP_IMPLEMENT( name, type )                                \
                                                                                \
GENERIC_FIELD_IMPLEMENT( name##_items, type )                                   \
                                                                                \
int name##_add( name##_ref map, const char * name, const size_t length, type * value ){ \
    ERROR_DECLARE;                                                              \
                                                                                \
    int index;                                                                  \
                                                                                \
    if( ! name##_is_valid( map )) return EINVAL;                                \
    index = name##_items_add( & map->values, value );                           \
    if( index < 0 ) return index;                                               \
    if( ERROR_OCCURRED( char_map_add( & map->names, name, length, index ))){        \
        name##_items_exclude_index( & map->values, index );                     \
        return ERROR_CODE;                                                      \
    }                                                                           \
    return EOK;                                                                 \
}                                                                               \
                                                                                \
int name##_count( name##_ref map ){                                             \
    return name##_is_valid( map ) ? name##_items_count( & map->values ) : -1;   \
}                                                                               \
                                                                                \
void name##_destroy( name##_ref map ){                                          \
    if( name##_is_valid( map )){                                                \
        char_map_destroy( & map->names );                                       \
        name##_items_destroy( & map->values );                                  \
    }                                                                           \
}                                                                               \
                                                                                \
void name##_exclude( name##_ref map, const char * name, const size_t length ){  \
    if( name##_is_valid( map )){                                                \
        int index;                                                              \
                                                                                \
        index = char_map_exclude( & map->names, name, length );                 \
        if( index != CHAR_MAP_NULL ){                                           \
            name##_items_exclude_index( & map->values, index );                 \
        }                                                                       \
    }                                                                           \
}                                                                               \
                                                                                \
type * name##_find( name##_ref map, const char * name, const size_t length ){   \
    if( name##_is_valid( map )){                                                \
        int index;                                                              \
                                                                                \
        index = char_map_find( & map->names, name, length );                    \
        if( index != CHAR_MAP_NULL ){                                           \
            return name##_items_get_index( & map->values, index );              \
        }                                                                       \
    }                                                                           \
    return NULL;                                                                \
}                                                                               \
                                                                                \
int name##_initialize( name##_ref map ){                                        \
    ERROR_DECLARE;                                                              \
                                                                                \
    if( ! map ) return EINVAL;                                                  \
    ERROR_PROPAGATE( char_map_initialize( & map->names ));                      \
    if( ERROR_OCCURRED( name##_items_initialize( & map->values ))){             \
        char_map_destroy( & map->names );                                       \
        return ERROR_CODE;                                                      \
    }                                                                           \
    map->magic = GENERIC_CHAR_MAP_MAGIC_VALUE;                                  \
    return EOK;                                                                 \
}                                                                               \
                                                                                \
int name##_is_valid( name##_ref map ){                                          \
    return map && ( map->magic == GENERIC_CHAR_MAP_MAGIC_VALUE );               \
}
 
#endif
 
/** @}
 */
 

Subversion Repositories HelenOS

(root)/branches/network/uspace/srv/net/structures/generic_char_map.h @ 3912 – Rev 3912 → 4505

Rev 3912		Rev 4505
1	/*	1	/*
2	* Copyright (c) 2009 Lukas Mejdrech	2	* Copyright (c) 2009 Lukas Mejdrech
3	* All rights reserved.	3	* All rights reserved.
4	*	4	*
5	* Redistribution and use in source and binary forms, with or without	5	* Redistribution and use in source and binary forms, with or without
6	* modification, are permitted provided that the following conditions	6	* modification, are permitted provided that the following conditions
7	* are met:	7	* are met:
8	*	8	*
9	* - Redistributions of source code must retain the above copyright	9	* - Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.	10	* notice, this list of conditions and the following disclaimer.
11	* - Redistributions in binary form must reproduce the above copyright	11	* - Redistributions in binary form must reproduce the above copyright
12	* notice, this list of conditions and the following disclaimer in the	12	* notice, this list of conditions and the following disclaimer in the
13	* documentation and/or other materials provided with the distribution.	13	* documentation and/or other materials provided with the distribution.
14	* - The name of the author may not be used to endorse or promote products	14	* - The name of the author may not be used to endorse or promote products
15	* derived from this software without specific prior written permission.	15	* derived from this software without specific prior written permission.
16	*	16	*
17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR	17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES	18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,	20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT	21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,	22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY	23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT	24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF	25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.	26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27	*/	27	*/
28		28
29	/** @addtogroup net	29	/** @addtogroup net
30	* @{	30	* @{
31	*/	31	*/
32		32
33	/** @file	33	/** @file
34	*/	34	*/
35		35
36	#ifndef __GENERIC_CHAR_MAP_H__	36	#ifndef __GENERIC_CHAR_MAP_H__
37	#define __GENERIC_CHAR_MAP_H__	37	#define __GENERIC_CHAR_MAP_H__
38		38
-		39	#include <errno.h>
39	#include <unistd.h>	40	#include <unistd.h>
40		41
41	#include "../err.h"	42	#include "../err.h"
42		43
43	#include "char_map.h"	44	#include "char_map.h"
44	#include "generic_field.h"	45	#include "generic_field.h"
45		46
46	#define GENERIC_CHAR_MAP_MAGIC_VALUE 0x12345622	47	#define GENERIC_CHAR_MAP_MAGIC_VALUE 0x12345622
47		48
48	#define GENERIC_CHAR_MAP_DECLARE( name, type ) \	49	#define GENERIC_CHAR_MAP_DECLARE( name, type ) \
49	\	50	\
50	GENERIC_FIELD_DECLARE( name##_items, type ) \	51	GENERIC_FIELD_DECLARE( name##_items, type ) \
51	\	52	\
52	typedef struct name name##_t; \	53	typedef struct name name##_t; \
53	typedef name##_t * name##_ref; \	54	typedef name##_t * name##_ref; \
54	\	55	\
55	struct name{ \	56	struct name{ \
56	char_map_t names; \	57	char_map_t names; \
57	name##_items_t values; \	58	name##_items_t values; \
58	int magic; \	59	int magic; \
59	}; \	60	}; \
60	\	61	\
61	int name##_add( name##_ref map, const char * name, const size_t length, type * value ); \	62	int name##_add( name##_ref map, const char * name, const size_t length, type * value ); \
62	int name##_count( name##_ref map ); \	63	int name##_count( name##_ref map ); \
63	void name##_destroy( name##_ref map ); \	64	void name##_destroy( name##_ref map ); \
64	void name##_exclude( name##_ref map, const char * name, const size_t length ); \	65	void name##_exclude( name##_ref map, const char * name, const size_t length ); \
65	type * name##_find( name##_ref map, const char * name, const size_t length ); \	66	type * name##_find( name##_ref map, const char * name, const size_t length ); \
66	type * name##_get_index( name##_ref map, int index ); \	67	type * name##_get_index( name##_ref map, int index ); \
67	int name##_initialize( name##_ref map ); \	68	int name##_initialize( name##_ref map ); \
68	int name##_is_valid( name##_ref map );	69	int name##_is_valid( name##_ref map );
69		70
70	#define GENERIC_CHAR_MAP_IMPLEMENT( name, type ) \	71	#define GENERIC_CHAR_MAP_IMPLEMENT( name, type ) \
71	\	72	\
72	GENERIC_FIELD_IMPLEMENT( name##_items, type ) \	73	GENERIC_FIELD_IMPLEMENT( name##_items, type ) \
73	\	74	\
74	int name##_add( name##_ref map, const char * name, const size_t length, type * value ){ \	75	int name##_add( name##_ref map, const char * name, const size_t length, type * value ){ \
75	ERROR_DECLARE; \	76	ERROR_DECLARE; \
76	\	77	\
77	int index; \	78	int index; \
78	\	79	\
79	if( ! name##_is_valid( map )) return EINVAL; \	80	if( ! name##_is_valid( map )) return EINVAL; \
80	index = name##_items_add( & map->values, value ); \	81	index = name##_items_add( & map->values, value ); \
81	if( index < 0 ) return index; \	82	if( index < 0 ) return index; \
82	if( ERROR_OCCURRED( char_map_add( & map->names, name, length, index ))){ \	83	if( ERROR_OCCURRED( char_map_add( & map->names, name, length, index ))){ \
83	name##_items_exclude_index( & map->values, index ); \	84	name##_items_exclude_index( & map->values, index ); \
84	return ERROR_CODE; \	85	return ERROR_CODE; \
85	} \	86	} \
86	return EOK; \	87	return EOK; \
87	} \	88	} \
88	\	89	\
89	int name##_count( name##_ref map ){ \	90	int name##_count( name##_ref map ){ \
90	return name##_is_valid( map ) ? name##_items_count( & map->values ) : -1; \	91	return name##_is_valid( map ) ? name##_items_count( & map->values ) : -1; \
91	} \	92	} \
92	\	93	\
93	void name##_destroy( name##_ref map ){ \	94	void name##_destroy( name##_ref map ){ \
94	if( name##_is_valid( map )){ \	95	if( name##_is_valid( map )){ \
95	char_map_destroy( & map->names ); \	96	char_map_destroy( & map->names ); \
96	name##_items_destroy( & map->values ); \	97	name##_items_destroy( & map->values ); \
97	} \	98	} \
98	} \	99	} \
99	\	100	\
100	void name##_exclude( name##_ref map, const char * name, const size_t length ){ \	101	void name##_exclude( name##_ref map, const char * name, const size_t length ){ \
101	if( name##_is_valid( map )){ \	102	if( name##_is_valid( map )){ \
102	int index; \	103	int index; \
103	\	104	\
104	index = char_map_exclude( & map->names, name, length ); \	105	index = char_map_exclude( & map->names, name, length ); \
105	if( index != CHAR_MAP_NULL ){ \	106	if( index != CHAR_MAP_NULL ){ \
106	name##_items_exclude_index( & map->values, index ); \	107	name##_items_exclude_index( & map->values, index ); \
107	} \	108	} \
108	} \	109	} \
109	} \	110	} \
110	\	111	\
111	type * name##_find( name##_ref map, const char * name, const size_t length ){ \	112	type * name##_find( name##_ref map, const char * name, const size_t length ){ \
112	if( name##_is_valid( map )){ \	113	if( name##_is_valid( map )){ \
113	int index; \	114	int index; \
114	\	115	\
115	index = char_map_find( & map->names, name, length ); \	116	index = char_map_find( & map->names, name, length ); \
116	if( index != CHAR_MAP_NULL ){ \	117	if( index != CHAR_MAP_NULL ){ \
117	return name##_items_get_index( & map->values, index ); \	118	return name##_items_get_index( & map->values, index ); \
118	} \	119	} \
119	} \	120	} \
120	return NULL; \	121	return NULL; \
121	} \	122	} \
122	\	123	\
123	int name##_initialize( name##_ref map ){ \	124	int name##_initialize( name##_ref map ){ \
124	ERROR_DECLARE; \	125	ERROR_DECLARE; \
125	\	126	\
126	if( ! map ) return EINVAL; \	127	if( ! map ) return EINVAL; \
127	ERROR_PROPAGATE( char_map_initialize( & map->names )); \	128	ERROR_PROPAGATE( char_map_initialize( & map->names )); \
128	if( ERROR_OCCURRED( name##_items_initialize( & map->values ))){ \	129	if( ERROR_OCCURRED( name##_items_initialize( & map->values ))){ \
129	char_map_destroy( & map->names ); \	130	char_map_destroy( & map->names ); \
130	return ERROR_CODE; \	131	return ERROR_CODE; \
131	} \	132	} \
132	map->magic = GENERIC_CHAR_MAP_MAGIC_VALUE; \	133	map->magic = GENERIC_CHAR_MAP_MAGIC_VALUE; \
133	return EOK; \	134	return EOK; \
134	} \	135	} \
135	\	136	\
136	int name##_is_valid( name##_ref map ){ \	137	int name##_is_valid( name##_ref map ){ \
137	return map && ( map->magic == GENERIC_CHAR_MAP_MAGIC_VALUE ); \	138	return map && ( map->magic == GENERIC_CHAR_MAP_MAGIC_VALUE ); \
138	}	139	}
139		140
140	#endif	141	#endif
141		142
142	/** @}	143	/** @}
143	*/	144	*/
144		145