1 /* $NetBSD: enum.h,v 1.9 2020/09/01 20:34:51 rillig Exp $ */
4 Copyright (c) 2020 Roland Illig <rillig@NetBSD.org>
7 Redistribution and use in source and binary forms, with or without
8 modification, are permitted provided that the following conditions
11 1. Redistributions of source code must retain the above copyright
12 notice, this list of conditions and the following disclaimer.
13 2. Redistributions in binary form must reproduce the above copyright
14 notice, this list of conditions and the following disclaimer in the
15 documentation and/or other materials provided with the distribution.
17 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20 PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS
21 BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 POSSIBILITY OF SUCH DAMAGE.
33 /* Generate string representations for bitmasks and simple enums. */
42 const char *Enum_FlagsToString(char *, size_t, int, const EnumToStringSpec *);
43 const char *Enum_ValueToString(int, const EnumToStringSpec *);
45 /* For Enum_FlagsToString, the separator between flags. */
48 /* Generate the string that joins all possible flags, to see how large the
50 #define ENUM__JOIN_STR_1(v1) \
52 #define ENUM__JOIN_STR_2(v1, v2) \
53 ENUM__JOIN_STR_1(v1) ENUM__SEP \
55 #define ENUM__JOIN_STR_4(v1, v2, v3, v4) \
56 ENUM__JOIN_STR_2(v1, v2) ENUM__SEP \
57 ENUM__JOIN_STR_2(v3, v4)
58 #define ENUM__JOIN_STR_8(v1, v2, v3, v4, v5, v6, v7, v8) \
59 ENUM__JOIN_STR_4(v1, v2, v3, v4) ENUM__SEP \
60 ENUM__JOIN_STR_4(v5, v6, v7, v8)
61 #define ENUM__JOIN_STR_16(v01, v02, v03, v04, v05, v06, v07, v08, \
62 v09, v10, v11, v12, v13, v14, v15, v16) \
63 ENUM__JOIN_STR_8(v01, v02, v03, v04, v05, v06, v07, v08) ENUM__SEP \
64 ENUM__JOIN_STR_8(v09, v10, v11, v12, v13, v14, v15, v16)
66 #define ENUM__JOIN_2(part1, part2) \
68 #define ENUM__JOIN_3(part1, part2, part3) \
69 part1 ENUM__SEP part2 ENUM__SEP part3
70 #define ENUM__JOIN_4(part1, part2, part3, part4) \
71 part1 ENUM__SEP part2 ENUM__SEP part3 ENUM__SEP part4
72 #define ENUM__JOIN_5(part1, part2, part3, part4, part5) \
73 part1 ENUM__SEP part2 ENUM__SEP part3 ENUM__SEP part4 ENUM__SEP part5
75 /* List the pairs of enum value and corresponding name. */
76 #define ENUM__SPEC_1(v1) \
78 #define ENUM__SPEC_2(v1, v2) \
81 #define ENUM__SPEC_4(v1, v2, v3, v4) \
82 ENUM__SPEC_2(v1, v2), \
84 #define ENUM__SPEC_8(v1, v2, v3, v4, v5, v6, v7, v8) \
85 ENUM__SPEC_4(v1, v2, v3, v4), \
86 ENUM__SPEC_4(v5, v6, v7, v8)
87 #define ENUM__SPEC_16(v01, v02, v03, v04, v05, v06, v07, v08, \
88 v09, v10, v11, v12, v13, v14, v15, v16) \
89 ENUM__SPEC_8(v01, v02, v03, v04, v05, v06, v07, v08), \
90 ENUM__SPEC_8(v09, v10, v11, v12, v13, v14, v15, v16)
92 #define ENUM__SPECS_2(part1, part2) \
93 { part1, part2, { 0, "" } }
94 #define ENUM__SPECS_3(part1, part2, part3) \
95 { part1, part2, part3, { 0, "" } }
96 #define ENUM__SPECS_4(part1, part2, part3, part4) \
97 { part1, part2, part3, part4, { 0, "" } }
98 #define ENUM__SPECS_5(part1, part2, part3, part4, part5) \
99 { part1, part2, part3, part4, part5, { 0, "" } }
101 /* Declare the necessary data structures for calling Enum_ValueToString. */
102 #define ENUM__VALUE_RTTI(typnam, specs) \
103 static const EnumToStringSpec typnam ## _ ## ToStringSpecs[] = specs
105 /* Declare the necessary data structures for calling Enum_FlagsToString. */
106 #define ENUM__FLAGS_RTTI(typnam, specs, joined) \
107 static const EnumToStringSpec typnam ## _ ## ToStringSpecs[] = specs; \
108 enum { typnam ## _ ## ToStringSize = sizeof joined }
110 /* Declare the necessary data structures for calling Enum_FlagsToString
111 * for an enum with 3 flags. */
112 #define ENUM_FLAGS_RTTI_3(typnam, v1, v2, v3) \
113 ENUM__FLAGS_RTTI(typnam, \
115 ENUM__SPEC_2(v1, v2), \
118 ENUM__JOIN_STR_2(v1, v2), \
119 ENUM__JOIN_STR_1(v3)))
121 /* Declare the necessary data structures for calling Enum_FlagsToString
122 * for an enum with 8 flags. */
123 #define ENUM_FLAGS_RTTI_8(typnam, v1, v2, v3, v4, v5, v6, v7, v8) \
124 ENUM__FLAGS_RTTI(typnam, \
126 ENUM__SPEC_4(v1, v2, v3, v4), \
127 ENUM__SPEC_4(v5, v6, v7, v8)), \
129 ENUM__JOIN_STR_4(v1, v2, v3, v4), \
130 ENUM__JOIN_STR_4(v5, v6, v7, v8)))
132 /* Declare the necessary data structures for calling Enum_ValueToString
133 * for an enum with 8 constants. */
134 #define ENUM_VALUE_RTTI_8(typnam, v1, v2, v3, v4, v5, v6, v7, v8) \
135 ENUM__VALUE_RTTI(typnam, \
137 ENUM__SPEC_4(v1, v2, v3, v4), \
138 ENUM__SPEC_4(v5, v6, v7, v8)))
140 /* Declare the necessary data structures for calling Enum_FlagsToString
141 * for an enum with 10 flags. */
142 #define ENUM_FLAGS_RTTI_10(typnam, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10) \
143 ENUM__FLAGS_RTTI(typnam, \
145 ENUM__SPEC_8(v1, v2, v3, v4, v5, v6, v7, v8), \
146 ENUM__SPEC_2(v9, v10)), \
148 ENUM__JOIN_STR_8(v1, v2, v3, v4, v5, v6, v7, v8), \
149 ENUM__JOIN_STR_2(v9, v10)))
151 /* Declare the necessary data structures for calling Enum_FlagsToString
152 * for an enum with 31 flags. */
153 #define ENUM_FLAGS_RTTI_31(typnam, \
154 v01, v02, v03, v04, v05, v06, v07, v08, \
155 v09, v10, v11, v12, v13, v14, v15, v16, \
156 v17, v18, v19, v20, v21, v22, v23, v24, \
157 v25, v26, v27, v28, v29, v30, v31) \
158 ENUM__FLAGS_RTTI(typnam, \
160 ENUM__SPEC_16(v01, v02, v03, v04, v05, v06, v07, v08, \
161 v09, v10, v11, v12, v13, v14, v15, v16), \
162 ENUM__SPEC_8(v17, v18, v19, v20, v21, v22, v23, v24), \
163 ENUM__SPEC_4(v25, v26, v27, v28), \
164 ENUM__SPEC_2(v29, v30), \
165 ENUM__SPEC_1(v31)), \
167 ENUM__JOIN_STR_16(v01, v02, v03, v04, v05, v06, v07, v08, \
168 v09, v10, v11, v12, v13, v14, v15, v16), \
169 ENUM__JOIN_STR_8(v17, v18, v19, v20, v21, v22, v23, v24), \
170 ENUM__JOIN_STR_4(v25, v26, v27, v28), \
171 ENUM__JOIN_STR_2(v29, v30), \
172 ENUM__JOIN_STR_1(v31)))
174 /* Declare the necessary data structures for calling Enum_FlagsToString
175 * for an enum with 32 flags. */
176 #define ENUM_FLAGS_RTTI_32(typnam, \
177 v01, v02, v03, v04, v05, v06, v07, v08, \
178 v09, v10, v11, v12, v13, v14, v15, v16, \
179 v17, v18, v19, v20, v21, v22, v23, v24, \
180 v25, v26, v27, v28, v29, v30, v31, v32) \
181 ENUM__FLAGS_RTTI(typnam, \
183 ENUM__SPEC_16(v01, v02, v03, v04, v05, v06, v07, v08, \
184 v09, v10, v11, v12, v13, v14, v15, v16), \
185 ENUM__SPEC_16(v17, v18, v19, v20, v21, v22, v23, v24, \
186 v25, v26, v27, v28, v29, v30, v31, v32)), \
188 ENUM__JOIN_STR_16(v01, v02, v03, v04, v05, v06, v07, v08, \
189 v09, v10, v11, v12, v13, v14, v15, v16), \
190 ENUM__JOIN_STR_16(v17, v18, v19, v20, v21, v22, v23, v24, \
191 v25, v26, v27, v28, v29, v30, v31, v32)))