{"id":107944,"date":"2023-03-16T07:00:00","date_gmt":"2023-03-16T14:00:00","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/oldnewthing\/?p=107944"},"modified":"2023-03-16T10:00:31","modified_gmt":"2023-03-16T17:00:31","slug":"20230316-00","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/oldnewthing\/20230316-00\/?p=107944","title":{"rendered":"Mind your C++\/WinRT namespaces"},"content":{"rendered":"

When you implement a Windows Runtime class in C++\/WinRT, each class name appears in three different namespace, so you need to mind your namespaces.<\/p>\n\n\n\n\n\n
Projection<\/th>\nwinrt::Namespace::ClassName<\/code><\/td>\n<\/tr>\n
Factory<\/th>\nwinrt::Namespace::factory_implementation::ClassName<\/code><\/td>\n<\/tr>\n
Implementation<\/th>\nwinrt::Namespace::implementation::ClassName<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

If you write an unqualified ClassName<\/code>, the compiler searches for the name in the current namespace, then the parent namespace, then the grandparent namespace, and so on until it reaches the global namespace.<\/p>\n

Now, when you say ClassName<\/code>, there’s a decent chance that you intend to refer to the name in the projection namespace, particularly if you copy\/pasta’d some code from a tutorial or from another project. What you didn’t realize is that the code you copied was intended to be compiled outside the implementation namespaces. But if you happen to be in one of the implementation namespaces, you will pick up the name in that other namespace by mistake.<\/p>\n

namespace winrt::MyNamespace::implementation\r\n{\r\n    struct ClassName : ClassNameT<ClassName>\r\n    {\r\n        ClassName CreateChild()\r\n        { return make<ClassName>(...); }\r\n\r\n        Windows::Foundation::IAsyncOperation<ClassName>\r\n            CreateChildAsync()\r\n        {\r\n            \/* do stuff *\/\r\n            co_return make<ClassName>(...);\r\n        }\r\n    };\r\n}\r\n\r\nnamespace winrt::MyNamespace::factory_implementation\r\n{\r\n    struct ClassName : ClassNameT<ClassName, implementation::ClassName>\r\n    {\r\n        static ClassName Create()\r\n        { return make<ClassName>(); }\r\n    };\r\n}\r\n<\/pre>\n
The above code wants the CreateChild()<\/code> method to return a Windows Runtime ClassName<\/code> object, but since the name ClassName<\/code> is being used inside the winrt::Namespace::implementation<\/code> namespace, it actually refers to the winrt::Namespace::implementation::ClassName<\/code> implementation type, not the projection type.<\/p>\n
Similarly, the Create()<\/code> method on the factory class intends to return a Windows Runtime ClassName<\/code> object, but instead it returns a winrt::Namespace::factory_implementation::ClassName<\/code> object.<\/p>\n
The result of this incorrect name lookup is usually a pair of really confusing error messages.<\/p>\n
You get one error message when the compiler realizes that the return make<ClassName>(...)<\/code> is trying to return a projected type, but the declared return type is one of the implementation types, so you are scolded that there is no conversion from the projection type to the implementation type.<\/p>\n
You get a second error message when the compiler instantiates the ClassNameT<\/code> template, which uses the  Curiously Recurring Template Pattern<\/a> (commonly known as CRTP). The ClassNameT<\/code> template expects the CreateChild()<\/code> and Create()<\/code> methods to return the projected type, but their declared return type is an implementation type, and you get scolded a second time because there is no conversion from the implementation type to the projection type.<\/p>\n
The CreateChildAsync()<\/code> method is even worse. In this case, we accidentally said that it returns an IAsyncOperation<implementation::ClassName><\/code>. This mistake is also rewarded with not just two but three<\/i> confusing error messages, which could be reported in any order.<\/p>\n
As before, there is a problem from the CRTP code that the declared return type doesn’t match what the CRTP code expects.<\/p>\n
And analogously, you get an error at the co_return<\/code> because the coroutine expects you to co_return<\/code> the implementation type (since that’s the accidental template type parameter to IAsyncOperation<\/code>), but you co_return<\/code>ed the projection type. This error message is a little confusing because it is typically reported as a problem with the promise’s return_value<\/code> method, since the argument to co_return<\/code>  gets passed to the promise’s return_value<\/code> method<\/a>.<\/p>\n
The third mysterious error message comes from IAsyncOperation<\/code> because one of the requirements is that the template type parameter (the thing produced by the IAsyncOperation<\/code>) must be a Windows Runtime type, and the Windows Runtime type is your projection type, not the implementation types.<\/p>\n
Okay, so we learned that using an unqualified type name from inside the implementation or factory implementation namespace gives you the corresponding implementation type, not the projection type. But what if you want the implementation type?<\/p>\n
In theory, you could type the full name winrt::Namespace::ClassName<\/code>, but really, all you have to say is Namespace::ClassName<\/code>. The lookup proceeds through the parent namespaces, and it finds a match when it gets to winrt<\/code>.<\/p>\n
This shortcut is particularly handy when you have a deep namespace. Instead of the full name winrt::Grandparent::Parent::Namespace::ClassName<\/code>, you can write just Namespace::ClassName<\/code>.<\/p>\n
Bonus chatter<\/b>: All this confusion stems from the fact that we used the same name in three namespaces. We could have avoided this by using different names for our two implementation classes, so that they don’t collide with the projected class name, or with each other.<\/p>\n
namespace winrt::MyNamespace::implementation\r\n{\r\n    struct ClassNameImpl<\/span> : ClassNameT<ClassNameImpl<\/span>>\r\n    {\r\n        ClassName CreateChild()\r\n        { return make<ClassNameImpl<\/span>>(...); }\r\n\r\n        Windows::Foundation::IAsyncOperation<ClassName>\r\n            CreateChildAsync()\r\n        {\r\n            \/* do stuff *\/\r\n            co_return make<ClassNameImpl<\/span>>(...);\r\n        }\r\n    };\r\n}\r\n\r\nnamespace winrt::MyNamespace::factory_implementation\r\n{\r\n    struct ClassNameFact<\/span> : ClassNameT<ClassNameFact<\/span>, implementation::ClassNameImpl<\/span>>\r\n    {\r\n        static ClassName Create()\r\n        { return make<ClassNameFact<\/span>>(); }\r\n    };\r\n}\r\n<\/pre>\n
This way, ClassName<\/code> always refers to the projection class.<\/p>\n","protected":false},"excerpt":{"rendered":"
What you say changes meaning depending on where you are.<\/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-107944","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-oldnewthing","tag-code"],"acf":[],"blog_post_summary":"
What you say changes meaning depending on where you are.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/107944","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=107944"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/107944\/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=107944"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/categories?post=107944"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/tags?post=107944"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}