{"id":110908,"date":"2025-02-26T07:00:00","date_gmt":"2025-02-26T15:00:00","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/oldnewthing\/?p=110908"},"modified":"2025-02-27T09:41:08","modified_gmt":"2025-02-27T17:41:08","slug":"20250226-00","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/oldnewthing\/20250226-00\/?p=110908","title":{"rendered":"C++\/WinRT implementation inheritance: Notes on winrt::implements<\/CODE>, part 6"},"content":{"rendered":"

Last time, we were looking for a way to allow a winrt::implements<\/code>-based base class to defer implementation of a method to its derived class<\/a>. The problem is that if you use winrt::implements<\/code> to implement an interface, you have to implement all the methods. But you might also want to leave some of the methods for the derived class to implement in a manner of its choosing (for example, choosing whether the parameters are references or values, or allowing the parameters to be templated), which means that the virtual method approach doesn’t work. Something has to give.<\/p>\n

There are multiple solutions, depending on which requirement you want to weaken.<\/p>\n

You can weaken the “leave some of the methods for the derived class to implement” requirement by implementing it yourself but forwarding the call to the derived class via CRTP.<\/p>\n

\/\/ A simple copy drop target provides no custom feedback\r\n\/\/ and accepts anything by copy.\r\ntemplate<typename D><\/span>\r\nstruct SimpleCopyDropTarget :\r\n    winrt::implements<SimpleCopyDropTarget<D><\/span>,\r\n    winrt::ICoreDropOperationTarget>\r\n{\r\n    winrt::IAsyncOperation<winrt::DataPackageOperation>\r\n        EnterAsync(winrt::CoreDragInfo const& info,\r\n                   winrt::CoreDragUIOverride const&)\r\n    {\r\n        co_return GetOperation(info);\r\n    }\r\n\r\n    winrt::IAsyncOperation<winrt::DataPackageOperation>\r\n        OverAsync(winrt::CoreDragInfo const& info,\r\n                  winrt::CoreDragUIOverride const&)\r\n    {\r\n        co_return GetOperation(info);\r\n    }\r\n\r\n    winrt::IAsyncAction\r\n        LeaveAsync(winrt::CoreDragInfo const&)\r\n    {\r\n        co_return;\r\n    }\r\n\r\n    winrt::IAsyncOperation<winrt::DataPackageOperation><\/span>\r\n        DropAsync(winrt::CoreDragInfo const& info)     <\/span>\r\n    {                                                  <\/span>\r\n        return static_cast<D*>(this)->                 <\/span>\r\n            DropAsyncImpl(info);                       <\/span>\r\n    }                                                  <\/span>\r\n\r\nprotected:\r\n    winrt::DataPackageOperation GetOperation(\r\n        winrt::CoreDragInfo const& info)\r\n    {\r\n        return info.AllowedOperations() &\r\n               winrt::DataPackageOperation::Copy;\r\n    }\r\n};\r\n\r\nstruct Derived : winrt::implements<\r\n    Derived,\r\n    SimpleCopyDropTarget<Derived><\/span>>\r\n{\r\n    winrt::IAsyncOperation<winrt::DataPackageOperation>\r\n        DropAsyncImpl<\/span>(winrt::CoreDragInfo info)\r\n    {\r\n        auto lifetime = get_strong();\r\n\r\n        auto operation = GetOperation(info);\r\n        if (!(operation & winrt::DataPackageOperation::Copy)) {\r\n            co_return winrt::DataPackageOperation::None;\r\n        }\r\n\r\n        \u27e6 process the drop \u27e7\r\n\r\n        co_return winrt::DataPackageOperation::Copy;\r\n    }\r\n};\r\n<\/pre>\n
We implement DropAsync<\/code> in the base class but immediately forward the call out to the derived class’s Drop\u00adAsync\u00adImpl<\/code> method. This is done via CRTP so that the derived class has full flexibility in deciding how to accept the parameters.<\/p>\n
If you have access to “deducing this”, then you can let the “this” deduction do the work instead of CRTP.<\/p>\n
\/\/ A simple copy drop target provides no custom feedback\r\n\/\/ and accepts anything by copy.\r\nstruct SimpleCopyDropTarget :\r\n    winrt::implements<SimpleCopyDropTarget,\r\n    winrt::ICoreDropOperationTarget>\r\n{\r\n    winrt::IAsyncOperation<winrt::DataPackageOperation>\r\n        EnterAsync(winrt::CoreDragInfo const& info,\r\n                   winrt::CoreDragUIOverride const&)\r\n    {\r\n        co_return GetOperation(info);\r\n    }\r\n\r\n    winrt::IAsyncOperation<winrt::DataPackageOperation>\r\n        OverAsync(winrt::CoreDragInfo const& info,\r\n                  winrt::CoreDragUIOverride const&)\r\n    {\r\n        co_return GetOperation(info);\r\n    }\r\n\r\n    winrt::IAsyncAction\r\n        LeaveAsync(winrt::CoreDragInfo const&)\r\n    {\r\n        co_return;\r\n    }\r\n\r\n    winrt::IAsyncOperation<winrt::DataPackageOperation><\/span>\r\n        DropAsync(this auto&& self,                    <\/span>\r\n                  winrt::CoreDragInfo const& info)     <\/span>\r\n    {                                                  <\/span>\r\n        return self.DropAsyncImpl(info);               <\/span>\r\n    }                                                  <\/span>\r\n\r\nprotected:\r\n    winrt::DataPackageOperation GetOperation(\r\n        winrt::CoreDragInfo const& info)\r\n    {\r\n        return info.AllowedOperations() &\r\n               winrt::DataPackageOperation::Copy;\r\n    }\r\n};\r\n\r\nstruct Derived : winrt::implements<\r\n    Derived,\r\n    SimpleCopyDropTarget>\r\n{\r\n    winrt::IAsyncOperation<winrt::DataPackageOperation>\r\n        DropAsyncImpl<\/span>(winrt::CoreDragInfo info)\r\n    {\r\n        auto lifetime = get_strong();\r\n\r\n        auto operation = GetOperation(info);\r\n        if (!(operation & winrt::DataPackageOperation::Copy)) {\r\n            co_return winrt::DataPackageOperation::None;\r\n        }\r\n\r\n        \u27e6 process the drop \u27e7\r\n\r\n        co_return winrt::DataPackageOperation::Copy;\r\n    }\r\n};\r\n<\/pre>\n
Another option is to weaken the “implement an interface” part of “use winrt::implements<\/code> to implement an interface”. We can simply omit ICore\u00adDrop\u00adOperation\u00adTarget<\/code> from the list of interfaces implemented by the base class, since our base class doesn’t contain a full implementation. Instead, let the derived class finish the implementation and declare the interface there.<\/p>\n
\/\/ A simple copy drop target provides no custom feedback\r\n\/\/ and accepts anything by copy.\r\nstruct SimpleCopyDropTarget :\r\n    winrt::implements<SimpleCopyDropTarget,\r\n    winrt::IInspectable<\/span>> \/\/ no ICoreDropOperationTarget\r\n{\r\n    winrt::IAsyncOperation<winrt::DataPackageOperation>\r\n        EnterAsync(winrt::CoreDragInfo const& info,\r\n                   winrt::CoreDragUIOverride const&)\r\n    {\r\n        co_return GetOperation(info);\r\n    }\r\n\r\n    winrt::IAsyncOperation<winrt::DataPackageOperation>\r\n        OverAsync(winrt::CoreDragInfo const& info,\r\n                  winrt::CoreDragUIOverride const&)\r\n    {\r\n        co_return GetOperation(info);\r\n    }\r\n\r\n    winrt::IAsyncAction\r\n        LeaveAsync(winrt::CoreDragInfo const&)\r\n    {\r\n        co_return;\r\n    }\r\n\r\n    \/\/ DropAsync must be implemented by derived class<\/span>\r\n\r\nprotected:\r\n    winrt::DataPackageOperation GetOperation(\r\n        winrt::CoreDragInfo const& info)\r\n    {\r\n        return info.AllowedOperations() &\r\n               winrt::DataPackageOperation::Copy;\r\n    }\r\n};\r\n\r\nstruct Derived : winrt::implements<\r\n    Derived,\r\n    SimpleCopyDropTarget,\r\n    winrt::ICoreDropOperationTarget<\/span>>\r\n{\r\n    winrt::IAsyncOperation<winrt::DataPackageOperation>\r\n        DropAsync<\/span>(winrt::CoreDragInfo info)\r\n    {\r\n        auto lifetime = get_strong();\r\n\r\n        auto operation = GetOperation(info);\r\n        if (!(operation & winrt::DataPackageOperation::Copy)) {\r\n            co_return winrt::DataPackageOperation::None;\r\n        }\r\n\r\n        \u27e6 process the drop \u27e7\r\n\r\n        co_return winrt::DataPackageOperation::Copy;\r\n    }\r\n};\r\n<\/pre>\n
Our Simple\u00adCopy\u00adDrop\u00adTarget<\/code> no longer implements I\u00adCore\u00adDrop\u00adOperation\u00adTarget<\/code>. Instead, it is Derived<\/code> which implements I\u00adCore\u00adDrop\u00adOperation\u00adTarget<\/code>. The Simple\u00adCopy\u00adDrop\u00adTarget<\/code> happens to provide some really handy implementations of I\u00adCore\u00adDrop\u00adOperation\u00adTarget<\/code> methods, but they aren’t actually hooked up to the I\u00adCore\u00adDrop\u00adOperation\u00adTarget<\/code> interface until the Derived<\/code> class says, “And I implement I\u00adCore\u00adDrop\u00adOperation\u00adTarget<\/code>.”<\/p>\n
The upside of this is that you don’t have to use CRTP or forwarders. The downside of this is that the Derived<\/code> class has to remember to say “And I implement I\u00adCore\u00adDrop\u00adOperation\u00adTarget<\/code>,” because if nobody says it, then the interface isn’t implemented by anybody!<\/p>\n
But wait, the Simple\u00adCopy\u00adDrop\u00adTarget<\/code> doesn’t implement anything interesting any more. Why are we even bothering?<\/p>\n
Next time, we’ll solve the problem a third way: Don’t even bother.<\/p>\n","protected":false},"excerpt":{"rendered":"
Using CRTP to delegate the method.<\/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-110908","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-oldnewthing","tag-code"],"acf":[],"blog_post_summary":"
Using CRTP to delegate the method.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/110908","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=110908"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/110908\/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=110908"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/categories?post=110908"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/tags?post=110908"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}