{"id":2143,"date":"2012-10-05T09:45:00","date_gmt":"2012-10-05T09:45:00","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/vcblog\/2012\/10\/05\/ccx-part-3-of-n-under-construction\/"},"modified":"2019-02-18T18:41:31","modified_gmt":"2019-02-18T18:41:31","slug":"ccx-part-3-of-n-under-construction","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/cppblog\/ccx-part-3-of-n-under-construction\/","title":{"rendered":"C++\/CX Part 3 of [n]: Under Construction"},"content":{"rendered":"

See C++\/CX Part 0 of [n]: An Introduction<\/a> for an introduction to this series and a table of contents with links to each article in the series.<\/em><\/p>\n

In this article, we’ll take a look at the how runtime classes are constructed. We’ll use the following Widget<\/code> runtime class throughout this article:<\/p>\n

    public<\/span> ref<\/span> class<\/span> Widget<\/span> sealed<\/span>\n    {\n    public<\/span>:\n    \n        Widget()           : _number(0)      { }\n        Widget(int<\/span> number<\/span>) : _number(number<\/span>) { }\n    \n        int<\/span> GetNumber() { return<\/span> _number; }\n    \n    private<\/span>:\n        int<\/span> _number;\n    };<\/pre>\n
This type has both a default constructor and a constructor with an int<\/code> parameter. C++\/CX runtime class constructors are largely the same as constructors for ordinary C++ class types. Like ordinary member functions, any constructor that is part of the public interface of the runtime class can only use Windows Runtime types in its signature. This rule applies to public and protected constructors of public runtime classes, because these form the interface of the runtime class. Otherwise, there isn’t much more to say about runtime class constructors.<\/p>\n
C++\/CX adds a new operator, ref new<\/code>, that is used to construct an instance of a runtime class. For example, we can easily construct a Widget<\/code> instance using either of its constructors:<\/p>\n
    <\/span>Widget<\/span>^ widgetZero   = ref<\/span> new<\/span> Widget<\/span>();\n    Widget<\/span>^ widgetAnswer = ref<\/span> new<\/span> Widget<\/span>(42); <\/pre>\n
The behavior of ref new<\/code> is comparable to that of new<\/code>: it takes the runtime class to be constructed and a set of arguments to be passed to the constructor of that runtime class, and it constructs an instance of that type. Whereas new T()<\/code> yields a T*<\/code> pointing to the new object, ref new T()<\/code> yields a T^<\/code>. In this respect, ref new<\/code> is similar to the make_shared<\/code> helper function that can be used to safely construct a shared_ptr<\/code>.<\/p>\n
Much as we saw in the previous articles, aside from the syntactic tags that tell the compiler that Widget<\/code> is a Windows Runtime type (e.g., ^<\/code> and ref<\/code>), this code looks almost exactly like equivalent C++ code that works with ordinary C++ types. Constructors are declared the same way, and ref new<\/code> is largely used in the same way as new<\/code> is used. However, this syntactic simplicity hides quite a bit of complex machinery, which is what we’re going to investigate here.<\/p>\n
Because C++\/CX hides all of the complexity here, we’ll instead use WRL to explain how object construction works. So that we have somewhere to start, we’ll translate our Widget<\/code> type into WRL. First the IDL that declares the Widget<\/code> runtime type and its default interface, IWidget<\/code>:<\/p>\n
    [exclusiveto<\/span>(Widget)]\n    [uuid<\/span>(ada06666-5abd-4691-8a44-56703e020d64)]\n    [version<\/span>(1.0)]\n    interface<\/span> IWidget : IInspectable\n    {\n        HRESULT GetNumber([out<\/span>] [retval<\/span>] int<\/span>* number);\n    }\n     \n    [version<\/span>(1.0)]\n    runtimeclass <\/span>Widget\n    {\n        [default<\/span>] interface<\/span> IWidget;\n    }<\/pre>\n
And the C++ definition of the Widget<\/code> type:<\/p>\n
    class<\/span> Widget<\/span> : public<\/span> RuntimeClass<\/span><IWidget<\/span>>\n    {\n        InspectableClass<\/span>(RuntimeClass_WRLWidgetComponent_Widget, BaseTrust<\/span>)\n  \n    public<\/span>:\n    \n        Widget()           : _number(0)      { }\n        Widget(int<\/span> number<\/span>) : _number(number<\/span>) { }\n    \n        STDMETHODIMP<\/span> GetNumber(int<\/span>* number<\/span>) { *number<\/span> = _number; return<\/span> S_OK<\/span>; }\n    \n    private<\/span>:\n    \n        INT32<\/span> _number;\n    };<\/pre>\n
Please note: for brevity, error handling code has been omitted from most of the examples in this article. When writing real code, please be sure to handle error conditions, including null pointers and failed HRESULTs.<\/em><\/p>\n
Where Do Widgets Come From?<\/h2>\n
The structure of a runtime class is an implementation detail of the particular language and framework that are used to implement the runtime class; thus, the way in which an object of such a type is constructed is also an implementation detail, since construction is inexorably linked to the structure of the type. Windows Runtime components are consumable from any language that supports the Windows Runtime, so we need a language-neutral mechanism for constructing runtime class objects.<\/p>\n
The Windows Runtime uses activation factories<\/em> for constructing runtime class objects. An activation factory is a runtime class whose purpose is to construct objects of a particular runtime class type. We will define a WidgetFactory<\/code> activation factory that constructs Widget<\/code> objects.<\/p>\n
Like any other runtime class, an activation factory implements a set of interfaces. Every activation factory must implement the IActivationFactory<\/code><\/a> interface, which declares a single member function: ActivateInstance<\/code>. The ActivateInstance<\/code> interface function takes no arguments and returns a default-constructed object. An activation factory can also implement user-defined factory interfaces that define other “construction” functions. For our WidgetFactory<\/code>, we’ll use the following factory interface:<\/p>\n
    [exclusiveto<\/span>(Widget)]\n    [uuid<\/span>(5b197688-2f57-4d01-92cd-a888f10dcd90)]\n    [version<\/span>(1.0)]\n    interface<\/span> IWidgetFactory : IInspectable\n    {\n        HRESULT CreateInstance([in<\/span>] int<\/span> value, [out<\/span>] [retval<\/span>] Widget** widget);\n    }<\/pre>\n
A factory interface may only declare factory functions: each function must take one or more arguments and must return an instance of the runtime class. The Widget<\/code> runtime class has only one non-default constructor, so we only need to declare a single factory function here, but it’s possible to define as many factory functions as are needed. When using C++\/CX, the compiler automatically generates a factory interface for each public ref class<\/code>, with factory functions whose arguments correspond to those of each of the constructors of the ref class<\/code>.<\/p>\n
In addition to defining a factory interface for the Widget<\/code> type, we also need to annotate it in the IDL as being activatable<\/em>. We do so using the activatable<\/code> attribute, which has two forms, both of which we will use for our Widget<\/code> type:<\/p>\n
    [activatable<\/span>(1.0)]\n    [activatable<\/span>(IWidgetFactory, 1.0)]<\/pre>\n
The first form declares the type as being default constructible. The second form declares that the IWidgetFactory<\/code> is a factory interface for the runtime class. (The 1.0<\/em> in each is a version number; it is not relevant for this discussion.) When the midlrt compiler compiles the IDL file into a Windows Metadata (WinMD) file, it will use these attributes to add the correct set of constructors to the metadata for the runtime class.<\/p>\n
Next, we need to implement a WidgetFactory<\/code> type that implements both the IActivationFactory<\/code> and the IWidgetFactory<\/code> interfaces. Instead of using the WRL RuntimeClass<\/code> base class template, we’ll use the ActivationFactory<\/code> base class template, which is designed to support activation factories.<\/p>\n
    class<\/span> WidgetFactory<\/span> : public<\/span> ActivationFactory<\/span><IWidgetFactory<\/span>>\n    {\n        InspectableClassStatic<\/span>(RuntimeClass_WRLWidgetComponent_Widget, BaseTrust<\/span>)\n    \n    public<\/span>:\n    \n        STDMETHODIMP<\/span> ActivateInstance(IInspectable<\/span>** widget<\/span>) override<\/span>\n        {\n            *widget<\/span> = Make<Widget<\/span>>().Detach();\n            return<\/span> *widget<\/span> != nullptr<\/span> ? S_OK<\/span> : E_OUTOFMEMORY<\/span>;\n        }\n    \n        STDMETHODIMP<\/span> CreateInstance(int<\/span> value<\/span>, IWidget<\/span>** widget<\/span>) override<\/span>\n        {\n            *widget<\/span> = Make<Widget<\/span>>(value<\/span>).Detach();\n            return<\/span> *widget<\/span> != nullptr<\/span> ? S_OK<\/span> : E_OUTOFMEMORY<\/span>;\n        }\n    };<\/pre>\n
ActivationFactory<\/code> provides a default implementation of the IActivationFactory<\/code> interface; this default implementation simply defines ActivateInstance<\/code> as returning E_NOTIMPL<\/code>. This is suitable for runtime classes that are not default constructible; for runtime classes that are default constructible (like Widget<\/code>), we need to override ActivateInstance<\/code> to actually default construct an object.<\/p>\n
Make<Widget>()<\/code> is effectively equivalent to new (nothrow) Widget()<\/code>: it dynamically allocates memory for a Widget<\/code> and passes the provided arguments to the Widget<\/code> constructor. Like new (nothrow)<\/code>, it yields nullptr<\/code> if allocation fails (remember, we can’t throw an exception from a function implementing an interface, we must return an HRESULT). It returns a ComPtr<Widget><\/code>; since we are returning the interface pointer, we simply detach the pointer and return it (the caller is responsible for calling Release<\/code> on all returned interface pointers).<\/p>\n
That’s all we need to implement the WidgetFactory<\/code> activation factory. If we can get an instance of the factory, we can easily create Widget<\/code> objects. For example,<\/p>\n
    void<\/span> Test(ComPtr<\/span><IWidgetFactory<\/span>> const<\/span>& factory<\/span>)\n    {\n        ComPtr<\/span><IWidget<\/span>> widget;\n        factory<\/span>->CreateInstance(42, widget.GetAddressOf());\n        \/\/ Hooray, we have a widget!<\/span>\n    } <\/pre>\n
Where Do Widget Factories Come From?<\/h2>\n
To enable construction of Widget<\/code> objects, we built a WidgetFactory<\/code>, so to enable construction of WidgetFactory<\/code> objects, we’ll build a WidgetFactoryFactory<\/code>. Then, to enable construction of those… Ha! Just kidding. \ud83d\ude09<\/p>\n
Each activatable runtime class is defined in a module (DLL). Each module that defines one or more activatable runtime classes must export an entry point named DllGetActivationFactory<\/code><\/a>. It is declared as follows:<\/p>\n
    HRESULT<\/span> WINAPI<\/span> DllGetActivationFactory(HSTRING<\/span>              activatableClassId<\/span>,\n                                           IActivationFactory<\/span>** factory<\/span>);<\/pre>\n
Conceptually, we can think of the function as being implemented like so:<\/p>\n
    HRESULT<\/span> WINAPI<\/span> DllGetActivationFactory(HSTRING<\/span>              activatableClassId<\/span>,\n                                           IActivationFactory<\/span>** factory<\/span>)\n    {\n        \/\/ Convert the HSTRING to a C string for easier comparison:<\/span>\n        wchar_t<\/span> const<\/span>* className = WindowsGetStringRawBuffer(activatableClassId<\/span>, nullptr<\/span>);\n    \n        \/\/ Are we being asked for the Widget factory?  If so, return an instance:<\/span>\n        if<\/span> (wcscmp(className, L\"WidgetComponent.Widget\"<\/span>) == 0)\n        {\n            *factory<\/span> = Make<WidgetFactory<\/span>>().Detach();\n            return<\/span> S_OK<\/span>;\n        }\n    \n        \/\/ If our module defines other activatable types, we'd check for them here.<\/span>\n    \n        \/\/ Otherwise, we return that we failed to satisfy the request:<\/span>\n        *factory<\/span> = nullptr<\/span>;\n        return<\/span> E_NOINTERFACE<\/span>;\n    }<\/pre>\n
    ActivatableClassWithFactory<\/span>(Widget<\/span>, WidgetFactory<\/span>)\n<\/pre>\n
Because many types only permit default construction, and because default construction makes use of the IActivationFactory<\/code> interface and doesn’t require any custom, type-specific logic, WRL also provides a helpful form of this macro, ActivatableClass<\/code>. This macro generates a simple activation factory that allows default construction, and registers the generated activation factory. We used this macro in Part 1 when we translated the Number<\/code> class from C++\/CX into WRL.<\/p>\n
If all of the activatable runtime classes are registered with WRL, we can simply have DllGetActivationFactory<\/code> delegate to WRL and let WRL do all of the hard work.<\/p>\n
    HRESULT<\/span> WINAPI<\/span> DllGetActivationFactory(HSTRING<\/span>              activatibleClassId<\/span>,\n                                           IActivationFactory<\/span>** factory<\/span>)\n    {\n        auto<\/span> &module = Microsoft::WRL::Module<\/span><Microsoft::WRL::InProc<\/span>>::GetModule();\n        return<\/span> module.GetActivationFactory(activatibleClassId<\/span>, factory<\/span>);\n    }\n<\/pre>\n
At this point, we have everything that we need to make a runtime class constructible: we have a factory that can construct instances of our runtime class and we have a well-defined way to obtain the factory for any activatable runtime class, so long as we know the module in which that runtime class is defined.<\/p>\n
Creating an Instance<\/h2>\n
We’ve finished implementing our activatable runtime class; now let’s take a look at ref new<\/code> and what happens when we create a Widget<\/code> instance. At the beginning of this article, we started off with the following:<\/p>\n
    Widget<\/span>^ widget = ref<\/span> new<\/span> Widget<\/span>(42); \n<\/pre>\n
We can translate this into the following C++ code that uses WRL instead of C++\/CX:<\/p>\n
    HStringReference<\/span> classId(RuntimeClass_WidgetComponent_Widget);\n    \n    ComPtr<\/span><IWidgetFactory<\/span>> factory;\n    RoGetActivationFactory(\n        classId.Get(),\n        __uuidof<\/span>(IWidgetFactory<\/span>),\n        reinterpret_cast<\/span><void<\/span>**>(factory.GetAddressOf()));\n    \n    ComPtr<\/span><IWidget<\/span>> widget;\n    factory->CreateInstance(42, widget.GetAddressOf());<\/pre>\n
Instantiation is a two-step process: first we need to get the activation factory for the Widget<\/code> type, then we can construct a Widget<\/code> instance using that factory. These two steps are quite clear in the WRL code. RoGetActivationFactory<\/code><\/a> is a part of the Windows Runtime itself. It:<\/p>\n
    \n
  1. finds the module that defines the named runtime type,<\/li>\n
  2. loads the module (if it hasn’t already been loaded),<\/li>\n
  3. obtains a pointer to the module’s DllGetActivationFactory<\/code> entry point,<\/li>\n
  4. calls that DllGetActivationFactory<\/code> function to get an instance of the activation factory,<\/li>\n
  5. calls QueryInterface<\/code> on the factory to get a pointer to the requested interface, and<\/li>\n
  6. returns the resulting interface pointer.<\/li>\n<\/ol>\n
    Most of these are straightforward and require no further comment. The exception is the first item: how, exactly, does the Windows Runtime determine which module to load to instantiate a particular type? While there is a requirement that the metadata<\/em> for a type be defined in a WinMD file whose name is similar to the type name, there is no such requirement for the naming of modules: the Widget<\/code> type may be defined in any module.<\/p>\n
    Every Windows Store app contains a file named AppXManifest.xml. This manifest contains all sorts of important information about the app, including its identity, name, and logo. The manifest also contains a section containing extensions<\/em>: this section contains a list of all of the modules that define activatable types and a list of all of the activatable types defined by each of those modules. For example, the following entry is similar to what we would find for the Widget<\/code> type:<\/p>\n
        <Extension Category=\"windows.activatableClass.inProcessServer\">
     <\/code>     <InProcessServer>
     <\/code>       <Path>WidgetComponent.dll<\/Path>
            <ActivatableClass ActivatableClassId=\"WidgetComponent.Widget\" ThreadingModel=\"both\" \/>
          <\/InProcessServer>
        <\/Extension> <\/code><\/pre>\n
    The list includes only types defined by modules contained in the app package; types provided by Windows (i.e., types in the Windows namespaces<\/a>) are registered globally, in the registry, and are not included in the AppXManifest.xml manifest.<\/p>\n
    For most projects, this manifest is created as part of the app packaging task that runs after an app is built. The contents of the extensions section is automatically populated via examination of the WinMD files for any referenced components and the manifests from any referenced Extension SDKs<\/a>. When our app calls RoGetActivationFactory<\/code>, the Windows Runtime uses this list to find the module it needs to load for the Widget<\/code> type.<\/p>\n
    It should be noted that, for performance, activation factories may be cached on both sides of the ABI boundary: our component that defines the Widget<\/code> type really only needs to create a single instance of the WidgetFactory<\/code>; it doesn’t need to create a new instance every time it is asked for the factory. Similarly, our app can cache the factory it got back from RoGetActivationFactory<\/code> to avoid having to round-trip through the runtime every time it needs to construct a Widget<\/code>. If our app creates lots of Widget<\/code>s, this may make a huge difference. Both WRL and C++\/CX are pretty smart with respect to this caching.<\/p>\n
    In Conclusion<\/h2>\n
    It suffices to say that the C++\/CX syntax hides a substantial amount of complexity! We started off with what were effectively four lines of C++\/CX: two lines to declare the constructors, and two statements to demonstrate use of those constructors. We have ended up with, well, an awful lot more than that. For the two constructors, we have a Widget<\/code>-specific factory interface, an activation factory that implements that interface and the IActivationFactory<\/code> interface, and a module entry point that creates factories. For the ref new<\/code> expressions, we have a round-trip through the Windows Runtime infrastructure.<\/p>\n
    Note that everything described here applies to the general case of defining a constructible type in one module and instantiating that type from another module. That is, this is the mechanism for constructing objects through the ABI. If the type is defined in the same module as the code that is instantiating the type, the compiler is able to avoid much of the overhead that is required for calls across the ABI boundary.  A future article will discuss how things work within a single module, but know that things are often much simpler in that case.<\/p>\n
    If you’ve found these articles useful, we’d love to hear from you in the comments!  Let us know if you have any questions, ideas, or requests, either about this series of articles or about C++\/CX in general.  You can also follow me on Twitter (@JamesMcNellis<\/a>), where I tweet about a wide range of C++-related topics.<\/p>\n
    UnderConstructionSolution.zip<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
    See C++\/CX Part 0 of [n]: An Introduction for an introduction to this series and a table of contents with links to each article in the series. In this article, we’ll take a look at the how runtime classes are constructed. We’ll use the following Widget runtime class throughout this article:     public ref class Widget sealed     {     public:      […]<\/p>\n","protected":false},"author":282,"featured_media":35994,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[121,132,160],"class_list":["post-2143","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-cplusplus","tag-ccx","tag-windows-8","tag-windows-store-apps"],"acf":[],"blog_post_summary":"
    See C++\/CX Part 0 of [n]: An Introduction for an introduction to this series and a table of contents with links to each article in the series. In this article, we’ll take a look at the how runtime classes are constructed. We’ll use the following Widget runtime class throughout this article:     public ref class Widget sealed     {     public:      […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/posts\/2143","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/users\/282"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/comments?post=2143"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/posts\/2143\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/media\/35994"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/media?parent=2143"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/categories?post=2143"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/tags?post=2143"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
In practice, we should never have to do much work to implement this function. When C++\/CX is used to build a component, the compiler will implement this function automatically if the _WINRT_DLL<\/code> macro is defined (this macro is defined by default in the Windows Runtime Component project template in Visual Studio). With WRL, a bit of work is required, but it’s quite straightforward. Each activatable class must be registered with WRL using one of the ActivatableClass<\/code> macros<\/a>. For example, to register our Widget<\/code> type with its WidgetFactory<\/code> activation factory, we can use the ActivatableClassWithFactory<\/code> macro:<\/p>\n
This function is, in a sense, a factory for activation factories: it takes as an argument the name of a runtime class (activatableClassId<\/code>) and it returns via the out parameter factory<\/code> an instance of the activation factory for the named type. If the module does not have an activation factory for the named type, it returns a failure error code. (Aside: HSTRING<\/code><\/a> is the Windows Runtime string type, which we’ll discuss in a future article.<\/em>)<\/p>\n
While this C++ Widget<\/code> class defines two constructors, these constructors are implementation details<\/em> of the Widget<\/code> type. Recall from Part 1<\/a> that we only ever interact with a runtime class object via an interface pointer: since the constructors are not declared by any interface, they are not part of the public interface of the runtime class.<\/p>\n