typesafe_cb: fix promotable types being incorrectly accepted by cast_if_type.
[ccan] / ccan / typesafe_cb / typesafe_cb.h
1 #ifndef CCAN_CAST_IF_TYPE_H
2 #define CCAN_CAST_IF_TYPE_H
3 #include "config.h"
4
5 #if HAVE_TYPEOF && HAVE_BUILTIN_CHOOSE_EXPR && HAVE_BUILTIN_TYPES_COMPATIBLE_P
6 /**
7  * cast_if_type - only cast an expression if test matches a given type
8  * @desttype: the type to cast to
9  * @expr: the expression to cast
10  * @test: the expression to test
11  * @oktype: the type we allow
12  *
13  * This macro is used to create functions which allow multiple types.
14  * The result of this macro is used somewhere that a @desttype type is
15  * expected: if @test is exactly of type @oktype, then @expr will be
16  * cast to @desttype type, otherwise left alone.
17  *
18  * This macro can be used in static initializers.
19  *
20  * This is merely useful for warnings: if the compiler does not
21  * support the primitives required for cast_if_type(), it becomes an
22  * unconditional cast, and the @test and @oktype argument is not used.  In
23  * particular, this means that @oktype can be a type which uses
24  * the "typeof": it will not be evaluated if typeof is not supported.
25  *
26  * Example:
27  *      // We can take either an unsigned long or a void *.
28  *      void _set_some_value(void *val);
29  *      #define set_some_value(e)                       \
30  *              _set_some_value(cast_if_type(void *, (e), (e), unsigned long))
31  */
32 #define cast_if_type(desttype, expr, test, oktype)                      \
33         __builtin_choose_expr(__builtin_types_compatible_p(typeof(test), oktype), \
34                         (desttype)(expr), (expr))
35 #else
36 #define cast_if_type(desttype, expr, test, oktype) ((desttype)(expr))
37 #endif
38
39 /**
40  * cast_if_any - only cast an expression if it is one of the three given types
41  * @desttype: the type to cast to
42  * @expr: the expression to cast
43  * @test: the expression to test
44  * @ok1: the first type we allow
45  * @ok2: the second type we allow
46  * @ok3: the third type we allow
47  *
48  * This is a convenient wrapper for multiple cast_if_type() calls.  You can
49  * chain them inside each other (ie. use cast_if_any() for expr) if you need
50  * more than 3 arguments.
51  *
52  * Example:
53  *      // We can take either a long, unsigned long, void * or a const void *.
54  *      void _set_some_value(void *val);
55  *      #define set_some_value(expr)                                    \
56  *              _set_some_value(cast_if_any(void *, (expr), (expr),     \
57  *                                          long, unsigned long, const void *))
58  */
59 #define cast_if_any(desttype, expr, test, ok1, ok2, ok3)                \
60         cast_if_type(desttype,                                          \
61                      cast_if_type(desttype,                             \
62                                   cast_if_type(desttype, (expr), (test), ok1), \
63                                   (test),                               \
64                                   ok2),                                 \
65                      (test),                                            \
66                      ok3)
67
68 /**
69  * typesafe_cb - cast a callback function if it matches the arg
70  * @rtype: the return type of the callback function
71  * @fn: the callback function to cast
72  * @arg: the (pointer) argument to hand to the callback function.
73  *
74  * If a callback function takes a single argument, this macro does
75  * appropriate casts to a function which takes a single void * argument if the
76  * callback provided matches the @arg (or a const or volatile version).
77  *
78  * It is assumed that @arg is of pointer type: usually @arg is passed
79  * or assigned to a void * elsewhere anyway.
80  *
81  * Example:
82  *      void _register_callback(void (*fn)(void *arg), void *arg);
83  *      #define register_callback(fn, arg) \
84  *              _register_callback(typesafe_cb(void, (fn), (arg)), (arg))
85  */
86 #define typesafe_cb(rtype, fn, arg)                     \
87         cast_if_type(rtype (*)(void *), (fn), (fn)(arg), rtype)
88
89 /**
90  * typesafe_cb_const - cast a const callback function if it matches the arg
91  * @rtype: the return type of the callback function
92  * @fn: the callback function to cast
93  * @arg: the (pointer) argument to hand to the callback function.
94  *
95  * If a callback function takes a single argument, this macro does appropriate
96  * casts to a function which takes a single const void * argument if the
97  * callback provided matches the @arg.
98  *
99  * It is assumed that @arg is of pointer type: usually @arg is passed
100  * or assigned to a void * elsewhere anyway.
101  *
102  * Example:
103  *      void _register_callback(void (*fn)(const void *arg), const void *arg);
104  *      #define register_callback(fn, arg) \
105  *              _register_callback(typesafe_cb_const(void, (fn), (arg)), (arg))
106  */
107 #define typesafe_cb_const(rtype, fn, arg)                       \
108         cast_if_type(rtype (*)(const void *), (fn), (fn)(arg), rtype)
109
110 /**
111  * typesafe_cb_preargs - cast a callback function if it matches the arg
112  * @rtype: the return type of the callback function
113  * @fn: the callback function to cast
114  * @arg: the (pointer) argument to hand to the callback function.
115  *
116  * This is a version of typesafe_cb() for callbacks that take other arguments
117  * before the @arg.
118  *
119  * Example:
120  *      void _register_callback(void (*fn)(int, void *arg), void *arg);
121  *      #define register_callback(fn, arg) \
122  *              _register_callback(typesafe_cb_preargs(void, (fn), (arg), int),\
123  *                                 (arg))
124  */
125 #define typesafe_cb_preargs(rtype, fn, arg, ...)                        \
126         cast_if_type(rtype (*)(__VA_ARGS__, void *), (fn), &*(fn),      \
127                      rtype (*)(__VA_ARGS__, typeof(arg)))
128
129 /**
130  * typesafe_cb_postargs - cast a callback function if it matches the arg
131  * @rtype: the return type of the callback function
132  * @fn: the callback function to cast
133  * @arg: the (pointer) argument to hand to the callback function.
134  *
135  * This is a version of typesafe_cb() for callbacks that take other arguments
136  * after the @arg.
137  *
138  * Example:
139  *      void _register_callback(void (*fn)(void *arg, int), void *arg);
140  *      #define register_callback(fn, arg) \
141  *              _register_callback(typesafe_cb_postargs(void, (fn), (arg), int),\
142  *                                 (arg))
143  */
144 #define typesafe_cb_postargs(rtype, fn, arg, ...)                       \
145         cast_if_type(rtype (*)(void *, __VA_ARGS__), (fn), &*(fn),      \
146                      rtype (*)(typeof(arg), __VA_ARGS__))
147
148 /**
149  * typesafe_cb_cmp - cast a compare function if it matches the arg
150  * @rtype: the return type of the callback function
151  * @fn: the callback function to cast
152  * @arg: the (pointer) argument(s) to hand to the compare function.
153  *
154  * If a callback function takes two matching-type arguments, this macro does
155  * appropriate casts to a function which takes two const void * arguments if
156  * the callback provided takes two a const pointers to @arg.
157  *
158  * It is assumed that @arg is of pointer type: usually @arg is passed
159  * or assigned to a void * elsewhere anyway.  Note also that the type
160  * arg points to must be defined.
161  *
162  * Example:
163  *      void _my_qsort(void *base, size_t nmemb, size_t size,
164  *                     int (*cmp)(const void *, const void *));
165  *      #define my_qsort(base, nmemb, cmpfn) \
166  *              _my_qsort((base), (nmemb), sizeof(*(base)), \
167  *                        typesafe_cb_cmp(int, (cmpfn), (base)), (arg))
168  */
169 #define typesafe_cb_cmp(rtype, cmpfn, arg)                              \
170         cast_if_type(rtype (*)(const void *, const void *), (cmpfn), &*(cmpfn), \
171                      rtype (*)(const typeof(*arg)*, const typeof(*arg)*))
172                      
173 #endif /* CCAN_CAST_IF_TYPE_H */