{"id":111271,"date":"2025-06-16T07:00:00","date_gmt":"2025-06-16T14:00:00","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/oldnewthing\/?p=111271"},"modified":"2025-06-17T15:27:44","modified_gmt":"2025-06-17T22:27:44","slug":"20250616-00","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/oldnewthing\/20250616-00\/?p=111271","title":{"rendered":"Writing a helper class for generating a particular category of C callback wrappers around C++ methods"},"content":{"rendered":"

A common pattern for C callbacks is to accept a function pointer and a void*<\/code>, and then the callback function receives that pointer in addition to the parameters specific to the callback.<\/p>\n

\/\/ Hypothetical callback\r\ntypedef int (*callback_t)(\r\n    void* context,\r\n    int arg1, char const* arg2, double arg3);\r\n\r\nvoid RegisterCallback(callback_t callback, void* context);\r\n<\/pre>\n
If you’re writing code in C++, it’s more convenient to write the callback as a class member function.<\/p>\n
struct Widget\r\n{\r\n    int OnCallback(\r\n        int arg1, char const* arg2, double arg3);\r\n\r\n    static int OnCallbackStatic(void* context,\r\n        int arg1, char const* arg2, double arg3)\r\n    {\r\n        auto self = (Widget*)context;\r\n        return self->OnCallback(arg1, arg2, arg3);\r\n    }\r\n\r\n    void Register()\r\n    {\r\n        RegisterCallback(OnCallbackStatic, this);\r\n    }\r\n};\r\n<\/pre>\n
Is there a way to simplify this boilerplate?<\/p>\n
My idea was to use the conversion operator to deduce the callback function signature, and give the wrapper function the same signature. The wrapper function then forwards the parameters to the member function and propagates the result. Doing it this way means that the member function need not have the exact same signature, as long as the inputs and outputs are convertible.<\/p>\n
template<auto F>\r\nstruct CallbackWrapperMaker\r\n{\r\n    template<typename Ret, typename...Args>\r\n    static Ret callback(void* p, Args...args)\r\n        { auto obj = (???*)p;\r\n          return (obj->*F)((Args)args...); }\r\n\r\n    template<typename Ret, typename...Args>\r\n    using StaticCallback = Ret(*)(void*, Args...);\r\n\r\n    template<typename Ret, typename...Args>\r\n    operator StaticCallback<Ret, Args...>()\r\n        { return callback<Ret, Args...>; }\r\n};\r\n\r\ntemplate<auto F>\r\ninline CallbackWrapperMaker<F> CallbackWrapper =\r\n    CallbackWrapperMaker<F>();\r\n\r\nstruct Widget\r\n{\r\n    int OnCallback(\r\n        int arg1, char const* arg2, double arg3);\r\n\r\n    void Register()\r\n    {\r\n        RegisterCallback(                        <\/span>\r\n            CallbackWrapper<&Widget::OnCallback>,<\/span>\r\n            this);                               <\/span>\r\n    }\r\n};\r\n<\/pre>\n
\/\/ usage:<\/p>\n
The CallbackWrapper<\/code> is an empty object whose job is merely to be convertible to a C-style callback function. We use the conversion operator to detect the signature that we need to produce, and we use those template type parameters to generate the correct version of the callback<\/code> function.<\/p>\n
The part we haven’t written yet is the code to cast the context parameter p<\/code> back to the original object type, like Widget<\/code>. To do that, we use a helper traits type that can extract the parent object from a pointer to member function.<\/p>\n
template<typename F> struct MemberFunctionTraits;\r\n\r\ntemplate<typename Ret, typename T, typename...Args>\r\nstruct MemberFunctionTraits<Ret(T::*)(Args...)>\r\n{\r\n    using Object = T;\r\n};\r\n\r\n\r\ntemplate<auto F>\r\nstruct CallbackWrapperMaker\r\n{\r\n    template<typename Ret, typename...Args>\r\n    static Ret callback(void* p, Args...args)\r\n        { auto obj = (typename MemberFunctionTraits<decltype(F)>::<\/span>\r\n                                 Object*)<\/span>p;                       <\/span>\r\n          return (obj->*F)((Args)args...); }\r\n\r\n    \u27e6 ... rest as before ... \u27e7\r\n};\r\n<\/pre>\n
The nice thing about forwarding to the member function is that the member function need not accept the parameters in the same way as the callback. For example, we could have written<\/p>\n
struct Widget\r\n{\r\n    short<\/span> OnCallback(\r\n        long<\/span> arg1, char const* arg2, double arg3);\r\n\r\n    void Register()\r\n    {\r\n        RegisterCallback(\r\n            CallbackWrapper<&Widget::OnCallback>,\r\n            this);\r\n    }\r\n};\r\n<\/pre>\n
and the compiler will automatically apply the normal integral promotions of arg1<\/code> from int<\/code> to long<\/code> and the return value from short<\/code> to int<\/code>.<\/p>\n","protected":false},"excerpt":{"rendered":"
Another exercise in C++ template programming.<\/p>\n","protected":false},"author":1069,"featured_media":111744,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[25],"class_list":["post-111271","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-oldnewthing","tag-code"],"acf":[],"blog_post_summary":"
Another exercise in C++ template programming.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/111271","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/users\/1069"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/comments?post=111271"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/111271\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/media\/111744"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/media?parent=111271"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/categories?post=111271"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/tags?post=111271"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}