BadVPN – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 office 1 /**
2 * @file CHash_header.h
3 * @author Ambroz Bizjak <ambrop7@gmail.com>
4 *
5 * @section LICENSE
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. Neither the name of the author nor the
15 * names of its contributors may be used to endorse or promote products
16 * derived from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
22 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29  
30 // Preprocessor inputs:
31 // CHASH_PARAM_NAME - name of this data structure
32 // CHASH_PARAM_ENTRY - type of entry
33 // CHASH_PARAM_LINK - type of entry link (usually a pointer or index to an array)
34 // CHASH_PARAM_KEY - type of key
35 // CHASH_PARAM_ARG - type of argument pass through to comparisons
36 // CHASH_PARAM_NULL - invalid link
37 // CHASH_PARAM_DEREF(arg, link) - dereference a non-null link
38 // CHASH_PARAM_ENTRYHASH(arg, entry) - hash function for entries; returns size_t
39 // CHASH_PARAM_KEYHASH(arg, key) - hash function for keys; returns size_t
40 // CHASH_PARAM_ENTRYHASH_IS_CHEAP - define to 1 if CHASH_PARAM_ENTRYHASH is cheap (e.g. hashes are precomputed)
41 // CHASH_PARAM_COMPARE_ENTRIES(arg, entry1, entry2) - compares two entries; returns 1 for equality, 0 otherwise
42 // CHASH_PARAM_COMPARE_KEY_ENTRY(arg, key1, entry2) - compares key and entry; returns 1 for equality, 0 otherwise
43 // CHASH_PARAM_ENTRY_NEXT - next member in entry
44  
45 #ifndef BADVPN_CHASH_H
46 #error CHash.h has not been included
47 #endif
48  
49 // types
50 #define CHash CHASH_PARAM_NAME
51 #define CHashEntry CHASH_PARAM_ENTRY
52 #define CHashLink CHASH_PARAM_LINK
53 #define CHashRef MERGE(CHash, Ref)
54 #define CHashArg CHASH_PARAM_ARG
55 #define CHashKey CHASH_PARAM_KEY
56  
57 // non-object public functions
58 #define CHashNullLink MERGE(CHash, NullLink)
59 #define CHashNullRef MERGE(CHash, NullRef)
60 #define CHashIsNullLink MERGE(CHash, IsNullLink)
61 #define CHashIsNullRef MERGE(CHash, IsNullRef)
62 #define CHashDerefMayNull MERGE(CHash, DerefMayNull)
63 #define CHashDerefNonNull MERGE(CHash, DerefNonNull)
64  
65 // public functions
66 #define CHash_Init MERGE(CHash, _Init)
67 #define CHash_Free MERGE(CHash, _Free)
68 #define CHash_Insert MERGE(CHash, _Insert)
69 #define CHash_InsertMulti MERGE(CHash, _InsertMulti)
70 #define CHash_Remove MERGE(CHash, _Remove)
71 #define CHash_Lookup MERGE(CHash, _Lookup)
72 #define CHash_GetNextEqual MERGE(CHash, _GetNextEqual)
73 #define CHash_MultiplyBuckets MERGE(CHash, _MultiplyBuckets)
74 #define CHash_Verify MERGE(CHash, _Verify)
75  
76 // private things
77 #define CHash_next(entry) ((entry).ptr->CHASH_PARAM_ENTRY_NEXT)
78 #define CHash_assert_valid_entry MERGE(CHash, _assert_valid_entry)