added streq() macro and defined default BUF_LEN
[strongswan.git] / src / libstrongswan / definitions.h
1 /**
2 * @file definitions.h
3 *
4 * @brief General purpose definitions and macros.
5 *
6 */
7
8 /*
9 * Copyright (C) 2005 Jan Hutter, Martin Willi
10 * Hochschule fuer Technik Rapperswil
11 * Copyright (C) 1998, 1999 D. Hugh Redelmeier. (Endian stuff)
12 *
13 * This program is free software; you can redistribute it and/or modify it
14 * under the terms of the GNU General Public License as published by the
15 * Free Software Foundation; either version 2 of the License, or (at your
16 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
17 *
18 * This program is distributed in the hope that it will be useful, but
19 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
20 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 * for more details.
22 */
23
24 #ifndef DEFINITIONS_H_
25 #define DEFINITIONS_H_
26
27
28
29 /* stolen from strongswan */
30 #if linux
31 # if defined(i386) && !defined(__i386__)
32 # define __i386__ 1
33 # define MYHACKFORTHIS 1
34 # endif
35 # include <endian.h>
36 # ifdef MYHACKFORTHIS
37 # undef __i386__
38 # undef MYHACKFORTHIS
39 # endif
40 #elif !(defined(BIG_ENDIAN) && defined(LITTLE_ENDIAN) && defined(BYTE_ORDER))
41 /* we don't know how to do this, so we require the macros to be defined
42 * with compiler flags:
43 * -DBIG_ENDIAN=4321 -DLITTLE_ENDIAN=1234 -DBYTE_ORDER=BIG_ENDIAN
44 * or -DBIG_ENDIAN=4321 -DLITTLE_ENDIAN=1234 -DBYTE_ORDER=LITTLE_ENDIAN
45 * Thse match the GNU definitions
46 */
47 # include <sys/endian.h>
48 #endif
49
50 #ifndef BIG_ENDIAN
51 #error "BIG_ENDIAN must be defined"
52 #endif
53
54 #ifndef LITTLE_ENDIAN
55 #error "LITTLE_ENDIAN must be defined"
56 #endif
57
58 #ifndef BYTE_ORDER
59 #error "BYTE_ORDER must be defined"
60 #endif
61
62 /**
63 * Default length for various auxiliary text buffers
64 */
65 #define BUF_LEN 512
66
67 /**
68 * Macro compares to strings for equality
69 */
70 #define streq(x,y) (strcmp(x, y) == 0)
71
72 /**
73 * Macro gives back larger of two values.
74 */
75 #define max(x,y) ((x) > (y) ? (x):(y))
76
77 /**
78 * Macro gives back smaller of two values.
79 */
80 #define min(x,y) ((x) < (y) ? (x):(y))
81
82 /**
83 * Debug macro to follow control flow
84 */
85 #define POS printf("%s, line %d\n", __FILE__, __LINE__)
86
87 /**
88 * Macro to allocate a sized type.
89 *
90 * @param thing object on which a sizeof is performed
91 * @return poiner to allocated memory
92 */
93 #define malloc_thing(thing) ((thing*)malloc(sizeof(thing)))
94
95
96 /**
97 * Mapping entry which defines the end of a mapping_t array.
98 */
99 #define MAPPING_END (-1)
100
101 typedef struct mapping_t mapping_t;
102
103 /**
104 * @brief Mapping entry, where enum-to-string mappings are stored.
105 */
106 struct mapping_t
107 {
108 /**
109 * Enumeration value.
110 */
111 int value;
112
113 /**
114 * Mapped string.
115 */
116 char *string;
117 };
118
119
120 /**
121 * @brief Find a mapping_string in the mapping[].
122 *
123 * @param mappings mappings array
124 * @param value enum-value to get the string from
125 *
126 */
127 char *mapping_find(mapping_t *mappings, int value);
128
129 #endif /*DEFINITIONS_H_*/