{"id":108494,"date":"2023-07-27T07:00:00","date_gmt":"2023-07-27T14:00:00","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/oldnewthing\/?p=108494"},"modified":"2023-07-27T07:02:43","modified_gmt":"2023-07-27T14:02:43","slug":"20230727-00","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/oldnewthing\/20230727-00\/?p=108494","title":{"rendered":"Perfect forwarding forwards objects, not braced things that are trying to become objects"},"content":{"rendered":"

In C++, perfect forwarding is the act of passing a function’s parameters to another function while preserving its reference category. It is commonly used by wrapper methods that want to pass their parameters through to another function, often a constructor.<\/p>\n

template<typename T, typename... Args>\r\nstd::unique_ptr<T> make_unique(Args&&... args)\r\n{\r\n    return std::unique_ptr<T>(\r\n        new T(std::forward<Args>(args)...));\r\n}\r\n<\/pre>\n
The make_unique<\/code> function takes its parameters, forwards them to the T<\/code> constructor, and then puts the pointer to the newly-constructed T<\/code> inside a unique_ptr<\/code>. Those parameters are forwarded perfectly into the constructor: If the original parameters were rvalue reference, then the constructor receives rvalue reference. If the original parameters were lvalue references, then the constructor receives lvalue reference.<\/p>\n
But the catch is that it can forward only objects<\/i>. It can’t forward “braced things that are trying to become objects”.<\/p>\n
struct Point\r\n{\r\n    int x, y;\r\n};\r\n\r\nstruct Segment\r\n{\r\n    Segment(Point p1, Point p2);\r\n};\r\n\r\nvoid test()\r\n{\r\n    \/\/ This works\r\n    Segment s({ 1, 1 }, { 2, 2 });\r\n\r\n    \/\/ This doesn't\r\n    auto p = std::make_unique<Segment>(\r\n        { 1, 1 }, { 2, 2 });\r\n}\r\n<\/pre>\n
The constructor of Segment<\/code> says that it wants two Point<\/code>s, and if you pass some stuff enclosed in braces, the compiler knows, “Well, I should make a Point<\/code> out of this.”<\/p>\n
On the other hand, the parameters to make_unique<\/code> are generic and are eventually forwarded to the constructor. But at the time the compiler sees the call to std::make_unique<\/code>, all it sees is a bunch of stuff inside curly braces.<\/p>\n
And a bunch of stuff inside curly braces is not an object.\u00b9 It’s a thing that can help initialize an object, but it’s not itself an object. It has no type, and it cannot be stored in a variable or parameter. I mean, we know by our powers of clairvoyance that the stuff inside curly braces is eventually going to be used to construct a Point<\/code>, and that make_unique<\/code> doesn’t ever do anything that needs to know its type; it doesn’t do decltype(arg1)<\/code> or auto arg1_copy = arg1;<\/code>.<\/p>\n
We know that because we read ahead and saw what the make_unique<\/code> function does with the parameters. But the compiler doesn’t look that far ahead.\u00b2<\/p>\n
Perfect forwarding is not perfect.<\/p>\n
You can work around this by providing your own wrappers that accept the same parameters as the constructors. Since these parameters have types, the compiler knows what “things inside braces” are supposed to be.<\/p>\n
struct Segment\r\n{\r\n    Segment(Point p1, Point p2);\r\n\r\n    static std::unique_ptr<Segment> make_unique(\r\n        Point p1, Point p2)\r\n    {\r\n        return std::make_unique<Segment>(p1, p2);\r\n    }\r\n};\r\n<\/pre>\n
Now, we are kind of cheating here because we are copying the Point<\/code> objects all over the place. We get away with it because a Point<\/code> is a very lightweight class. On the other hand, if it were more expensive (or even impossible) to copy a Point<\/code>, we could accept a reference and forward it. This time, we can use a forwarding reference, but give the template types a hint<\/i>:<\/p>\n
struct Segment\r\n{\r\n    Segment(Point p1, Point p2);\r\n\r\n    template<typename Arg1 = Point,\r\n             typename Arg2 = Point>\r\n    static std::unique_ptr<Segment> make_unique(\r\n        Arg1&& p1, Arg2&& p2)\r\n    {\r\n        return std::make_unique<Segment>(\r\n            std::forward<Arg1>(p1),\r\n            std::forward<Arg2>(p2));\r\n    }\r\n};\r\n<\/pre>\n
This accepts anything for the two parameters and forwards them perfectly to std::make_unique<\/code>. Providing defaults for the Arg1<\/code> and Arg2<\/code> template type parameters tells the compiler, “And if you can’t figure out what type it is, try this.” That way, if the caller passes a bunch of junk inside curly braces, the compiler will try to use it to construct a Point<\/code>.<\/p>\n
\u00b9 Okay, it might become an initializer_list<\/code>, but that comes later.<\/p>\n
\u00b2 And in the case where the function being called is visible only as a prototype, the compiler couldn’t look into the body even if it wanted to.<\/p>\n","protected":false},"excerpt":{"rendered":"
Before you can forward something, it needs to be a something.<\/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-108494","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-oldnewthing","tag-code"],"acf":[],"blog_post_summary":"
Before you can forward something, it needs to be a something.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/108494","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=108494"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/108494\/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=108494"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/categories?post=108494"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/tags?post=108494"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}