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
 *  Character string to generic type map.
 */
 
#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"
 
/** Internal magic value for a&nbsp;map consistency check.
 */
#define GENERIC_CHAR_MAP_MAGIC_VALUE    0x12345622
 
/** Character string to generic type map declaration.
 *  @param name Name of the map. Input parameter.
 *  @param type Inner object type. Input parameter
 */
#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 );
 
/** Character string to generic type map implementation.
 *  Should follow declaration with the same parameters.
 *  @param name Name of the map. Input parameter.
 *  @param type Inner object type. Input parameter
 */
#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 @ 4756 – Rev 4505 → 4704

Rev 4505		Rev 4704
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	* Character string to generic type map.
34	*/	35	*/
35		36
36	#ifndef __GENERIC_CHAR_MAP_H__	37	#ifndef __GENERIC_CHAR_MAP_H__
37	#define __GENERIC_CHAR_MAP_H__	38	#define __GENERIC_CHAR_MAP_H__
38		39
39	#include <errno.h>	40	#include <errno.h>
40	#include <unistd.h>	41	#include <unistd.h>
41		42
42	#include "../err.h"	43	#include "../err.h"
43		44
44	#include "char_map.h"	45	#include "char_map.h"
45	#include "generic_field.h"	46	#include "generic_field.h"
46		47
-		48	/** Internal magic value for a map consistency check.
-		49	*/
47	#define GENERIC_CHAR_MAP_MAGIC_VALUE 0x12345622	50	#define GENERIC_CHAR_MAP_MAGIC_VALUE 0x12345622
48		51
-		52	/** Character string to generic type map declaration.
-		53	* @param name Name of the map. Input parameter.
-		54	* @param type Inner object type. Input parameter
-		55	*/
49	#define GENERIC_CHAR_MAP_DECLARE( name, type ) \	56	#define GENERIC_CHAR_MAP_DECLARE( name, type ) \
50	\	57	\
51	GENERIC_FIELD_DECLARE( name##_items, type ) \	58	GENERIC_FIELD_DECLARE( name##_items, type ) \
52	\	59	\
53	typedef struct name name##_t; \	60	typedef struct name name##_t; \
54	typedef name##_t * name##_ref; \	61	typedef name##_t * name##_ref; \
55	\	62	\
56	struct name{ \	63	struct name{ \
57	char_map_t names; \	64	char_map_t names; \
58	name##_items_t values; \	65	name##_items_t values; \
59	int magic; \	66	int magic; \
60	}; \	67	}; \
61	\	68	\
62	int name##_add( name##_ref map, const char * name, const size_t length, type * value ); \	69	int name##_add( name##_ref map, const char * name, const size_t length, type * value ); \
63	int name##_count( name##_ref map ); \	70	int name##_count( name##_ref map ); \
64	void name##_destroy( name##_ref map ); \	71	void name##_destroy( name##_ref map ); \
65	void name##_exclude( name##_ref map, const char * name, const size_t length ); \	72	void name##_exclude( name##_ref map, const char * name, const size_t length ); \
66	type * name##_find( name##_ref map, const char * name, const size_t length ); \	73	type * name##_find( name##_ref map, const char * name, const size_t length ); \
67	type * name##_get_index( name##_ref map, int index ); \	74	type * name##_get_index( name##_ref map, int index ); \
68	int name##_initialize( name##_ref map ); \	75	int name##_initialize( name##_ref map ); \
69	int name##_is_valid( name##_ref map );	76	int name##_is_valid( name##_ref map );
70		77
-		78	/** Character string to generic type map implementation.
-		79	* Should follow declaration with the same parameters.
-		80	* @param name Name of the map. Input parameter.
-		81	* @param type Inner object type. Input parameter
-		82	*/
71	#define GENERIC_CHAR_MAP_IMPLEMENT( name, type ) \	83	#define GENERIC_CHAR_MAP_IMPLEMENT( name, type ) \
72	\	84	\
73	GENERIC_FIELD_IMPLEMENT( name##_items, type ) \	85	GENERIC_FIELD_IMPLEMENT( name##_items, type ) \
74	\	86	\
75	int name##_add( name##_ref map, const char * name, const size_t length, type * value ){ \	87	int name##_add( name##_ref map, const char * name, const size_t length, type * value ){ \
76	ERROR_DECLARE; \	88	ERROR_DECLARE; \
77	\	89	\
78	int index; \	90	int index; \
79	\	91	\
80	if( ! name##_is_valid( map )) return EINVAL; \	92	if( ! name##_is_valid( map )) return EINVAL; \
81	index = name##_items_add( & map->values, value ); \	93	index = name##_items_add( & map->values, value ); \
82	if( index < 0 ) return index; \	94	if( index < 0 ) return index; \
83	if( ERROR_OCCURRED( char_map_add( & map->names, name, length, index ))){ \	95	if( ERROR_OCCURRED( char_map_add( & map->names, name, length, index ))){ \
84	name##_items_exclude_index( & map->values, index ); \	96	name##_items_exclude_index( & map->values, index ); \
85	return ERROR_CODE; \	97	return ERROR_CODE; \
86	} \	98	} \
87	return EOK; \	99	return EOK; \
88	} \	100	} \
89	\	101	\
90	int name##_count( name##_ref map ){ \	102	int name##_count( name##_ref map ){ \
91	return name##_is_valid( map ) ? name##_items_count( & map->values ) : -1; \	103	return name##_is_valid( map ) ? name##_items_count( & map->values ) : -1; \
92	} \	104	} \
93	\	105	\
94	void name##_destroy( name##_ref map ){ \	106	void name##_destroy( name##_ref map ){ \
95	if( name##_is_valid( map )){ \	107	if( name##_is_valid( map )){ \
96	char_map_destroy( & map->names ); \	108	char_map_destroy( & map->names ); \
97	name##_items_destroy( & map->values ); \	109	name##_items_destroy( & map->values ); \
98	} \	110	} \
99	} \	111	} \
100	\	112	\
101	void name##_exclude( name##_ref map, const char * name, const size_t length ){ \	113	void name##_exclude( name##_ref map, const char * name, const size_t length ){ \
102	if( name##_is_valid( map )){ \	114	if( name##_is_valid( map )){ \
103	int index; \	115	int index; \
104	\	116	\
105	index = char_map_exclude( & map->names, name, length ); \	117	index = char_map_exclude( & map->names, name, length ); \
106	if( index != CHAR_MAP_NULL ){ \	118	if( index != CHAR_MAP_NULL ){ \
107	name##_items_exclude_index( & map->values, index ); \	119	name##_items_exclude_index( & map->values, index ); \
108	} \	120	} \
109	} \	121	} \
110	} \	122	} \
111	\	123	\
112	type * name##_find( name##_ref map, const char * name, const size_t length ){ \	124	type * name##_find( name##_ref map, const char * name, const size_t length ){ \
113	if( name##_is_valid( map )){ \	125	if( name##_is_valid( map )){ \
114	int index; \	126	int index; \
115	\	127	\
116	index = char_map_find( & map->names, name, length ); \	128	index = char_map_find( & map->names, name, length ); \
117	if( index != CHAR_MAP_NULL ){ \	129	if( index != CHAR_MAP_NULL ){ \
118	return name##_items_get_index( & map->values, index ); \	130	return name##_items_get_index( & map->values, index ); \
119	} \	131	} \
120	} \	132	} \
121	return NULL; \	133	return NULL; \
122	} \	134	} \
123	\	135	\
124	int name##_initialize( name##_ref map ){ \	136	int name##_initialize( name##_ref map ){ \
125	ERROR_DECLARE; \	137	ERROR_DECLARE; \
126	\	138	\
127	if( ! map ) return EINVAL; \	139	if( ! map ) return EINVAL; \
128	ERROR_PROPAGATE( char_map_initialize( & map->names )); \	140	ERROR_PROPAGATE( char_map_initialize( & map->names )); \
129	if( ERROR_OCCURRED( name##_items_initialize( & map->values ))){ \	141	if( ERROR_OCCURRED( name##_items_initialize( & map->values ))){ \
130	char_map_destroy( & map->names ); \	142	char_map_destroy( & map->names ); \
131	return ERROR_CODE; \	143	return ERROR_CODE; \
132	} \	144	} \
133	map->magic = GENERIC_CHAR_MAP_MAGIC_VALUE; \	145	map->magic = GENERIC_CHAR_MAP_MAGIC_VALUE; \
134	return EOK; \	146	return EOK; \
135	} \	147	} \
136	\	148	\
137	int name##_is_valid( name##_ref map ){ \	149	int name##_is_valid( name##_ref map ){ \
138	return map && ( map->magic == GENERIC_CHAR_MAP_MAGIC_VALUE ); \	150	return map && ( map->magic == GENERIC_CHAR_MAP_MAGIC_VALUE ); \
139	}	151	}
140		152
141	#endif	153	#endif
142		154
143	/** @}	155	/** @}
144	*/	156	*/
145		157