{"id":109250,"date":"2024-01-08T07:00:00","date_gmt":"2024-01-08T15:00:00","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/oldnewthing\/?p=109250"},"modified":"2024-01-08T09:29:14","modified_gmt":"2024-01-08T17:29:14","slug":"20240108-00","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/oldnewthing\/20240108-00\/?p=109250","title":{"rendered":"How do I prevent my C++\/WinRT implementation class from participating in COM aggregation?"},"content":{"rendered":"

In the Windows Runtime there are these things which are called “composable classes”. Composable classes allow the Windows Runtime to expose classes which applications can derive from, or at least do something that looks like<\/i> class derivation, even though under the covers it’s COM aggregation.<\/p>\n

In C++\/WinRT, you can give your implementation class the winrt::composable<\/code> tag to make it composable. And if you apply the unsealed<\/code> keyword to your runtimeclass<\/code> in the IDL file, then the C++\/WinRT autogenerated implementation templates will specify winrt::composable<\/code> automatically.<\/p>\n

But what if you don’t want to be composable? How can you force a build break if somebody tries to enable composability?<\/p>\n

From looking at the C++\/WinRT code, it appears that you can detect whether the class is composable by snooping at the outer()<\/code> method. For non-composing classes<\/a>, outer()<\/code> is defined as<\/p>\n

static constexpr inspectable_abi* outer() noexcept { return nullptr; }\r\n<\/pre>\n
Whereas  for composing classes<\/a>, outer()<\/code> is defined as<\/p>\n
inspectable_abi* outer() noexcept { return m_outer; }\r\n<\/pre>\n
Therefore, we can distinguish them by seeing whether outer()<\/code> is a constexpr nullptr.<\/p>\n
struct Widget : WidgetT<Widget>\r\n{\r\n  Widget()\r\n  {\r\n    static_assert(!outer(),                         <\/span>\r\n                  \"Widget must not be composable.\");<\/span>\r\n  }\r\n\r\n  \u27e6 ... \u27e7\r\n};\r\n<\/pre>\n
If we are not composing, then outer()<\/code> is a constexpr function that indeed returns nullptr<\/code>, so everything passes.<\/p>\n
If we are composing, then outer()<\/code> is a non-constexpr function, and the static_assert<\/code> fails because you are trying to assert a runtime expression at compile time.<\/p>\n
Unfortunately, the error message doesn’t use the static assertion text, because the problem occurred even before the compiler could decide whether the expression passed the assertion.<\/p>\n
error C2131: expression did not evaluate to a constant\r\n<\/pre>\n
But at least the line number points to the static_assert<\/code>, so the developer will be taken to your assertion string.<\/p>\n","protected":false},"excerpt":{"rendered":"
Looking for a clue.<\/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-109250","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-oldnewthing","tag-code"],"acf":[],"blog_post_summary":"
Looking for a clue.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/109250","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=109250"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/109250\/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=109250"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/categories?post=109250"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/tags?post=109250"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}