Skip to content
Open
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions include/wil/common.h
Original file line number Diff line number Diff line change
Expand Up @@ -398,6 +398,15 @@ check fails as opposed to the invalid parameter handler that the STL invokes. Th
// Until we'll have C++17 enabled in our code base, we're falling back to SAL
#define WI_NODISCARD __WI_LIBCPP_NODISCARD_ATTRIBUTE

#ifdef __has_cpp_attribute
#if __has_cpp_attribute(nodiscard) >= 201907L
#define WI_NODISCARD_REASON(x) [[nodiscard(x)]]
#endif
#endif
#ifndef WI_NODISCARD_REASON
#define WI_NODISCARD_REASON(x) WI_NODISCARD
#endif

#define __R_ENABLE_IF_IS_CLASS(ptrType) wistd::enable_if_t<wistd::is_class<ptrType>::value, void*> = nullptr
#define __R_ENABLE_IF_IS_NOT_CLASS(ptrType) wistd::enable_if_t<!wistd::is_class<ptrType>::value, void*> = nullptr

Expand Down
120 changes: 120 additions & 0 deletions include/wil/cppwinrt_authoring.h
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,126 @@ struct single_threaded_rw_property : single_threaded_property<T>

#endif // __WIL_CPPWINRT_AUTHORING_PROPERTIES_INCLUDED

#if (!defined(__WIL_CPPWINRT_AUTHORING_INCLUDED_ICLASSFACTORY) && defined(__IClassFactory_INTERFACE_DEFINED__)) || \
defined(WIL_DOXYGEN) // class factory
/// @cond
#define __WIL_CPPWINRT_AUTHORING_INCLUDED_ICLASSFACTORY
/// @endcond

template <typename T, typename... Rest>
struct class_factory : winrt::implements<class_factory<T, Rest...>, IClassFactory, winrt::no_weak_ref, Rest...>
{
HRESULT __stdcall CreateInstance(IUnknown* outer, GUID const& iid, void** result) noexcept final
try
{
*result = nullptr;

if (!outer)
{
return winrt::make_self<T>().as(iid, result);
}
else
{
return CLASS_E_NOAGGREGATION;
}
}
CATCH_RETURN()

HRESULT __stdcall LockServer(BOOL lock) noexcept final
try
{
if (lock)
{
++winrt::get_module_lock();
}
else
{
--winrt::get_module_lock();
}

return S_OK;
}
CATCH_RETURN()
};

#endif // !defined(__WIL_CPPWINRT_AUTHORING_INCLUDED_ICLASSFACTORY) && defined(__IClassFactory_INTERFACE_DEFINED__)

#if (!defined(__WIL_CPPWINRT_AUTHORING_INCLUDED_COM_SERVER) && defined(__WIL_CPPWINRT_AUTHORING_INCLUDED_ICLASSFACTORY) && defined(_COMBASEAPI_H_)) || \
defined(WIL_DOXYGEN) // COM server
/// @cond
#define __WIL_CPPWINRT_AUTHORING_INCLUDED_COM_SERVER
/// @endcond

template <typename T>
WI_NODISCARD_REASON("The class is unregistered when the returned value is destructed")
unique_com_class_object_cookie
register_com_server(GUID const& guid, DWORD context = CLSCTX_LOCAL_SERVER, DWORD flags = REGCLS_MULTIPLEUSE)
{
unique_com_class_object_cookie registration;
winrt::check_hresult(CoRegisterClassObject(
guid, winrt::make<class_factory<T, winrt::no_module_lock>>().get(), context, flags, registration.put()));
return registration;
}

template <typename... Types>
struct clsid_array
{
std::array<GUID, sizeof...(Types)> value;
};

template <typename... Ts>
WI_NODISCARD_REASON("The classes are unregistered when the returned value is destructed")
std::vector<unique_com_class_object_cookie> register_com_server(
wil::clsid_array<Ts...> const& clsids, DWORD context = CLSCTX_LOCAL_SERVER, DWORD flags = REGCLS_MULTIPLEUSE)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would recommend keeping the std::array parameter and making clsid_array a new overload.

The overload can simply pass it on to the std::array version

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't mind that, but let's see what @dunhor vote for.

Copy link
Member

@dunhor dunhor Aug 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd tend to agree with @sylveon here, but I'll take it one step further - I don't really see a value for the clsid_array type at all. In fact, I'd say that it harms the API overall. Consider the way that most people will use this funciton:

std::array<GUID> clsids = { CLSID_Foo, CLSID_Bar };
auto unregister = wil::register_com_server<Foo, Bar>(clsids);

Tying the type names of the GUIDs to the array parameter is actively harmful and violates your "don't repeat twice" principle (I'd need to provide the type names in the type of clsid_array in this case).

I'd say remove this type altogether. A type alias might be fine, but still probably unnecessary.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The benefit is when you are using __uuidof or winrt::guid_of, tying the types to the array allows template type deduction to work, preventing you from typing the name twice.

Like this:

wil::register_com_server(wil::make_array_of_uuid<Foo, Bar>());

But we definitely need to keep the untyped array overloads for examples like the one you have.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gotcha, I see.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Additionally, you state that you are getting ambiguous overload errors. I'm wondering if that's because the tests are calling using double braces ({{ CLSID_A, CLSID_B, ... }}). If you switch the tests over to single braces, I wonder if that resolves the errors.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The double braces are required for std::array. We would've needed std::initializer_list for single braces.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

std::array supports aggregate initialization, so single braces should be fine https://godbolt.org/z/o5cPPjYKx

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uh, I could swear that wasn't the case in specific instances. Guess I was wrong.

Copy link
Member

@dunhor dunhor Aug 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See: https://en.cppreference.com/w/cpp/language/aggregate_initialization.html#Appertainment

Specifically:

Otherwise, elem is an aggregate and that subaggregate is replaced in the list of aggregate elements by the sequence of its own aggregate elements, and the appertainment analysis resumes with the first such element and the same initializer clause. In other words, these rules apply recursively to the aggregate’s subaggregates.

Which probably makes my previous statement about ambiguous overloads incorrect, at least as long as clsid_array is an aggregate. I.e. it would need a constructor, however that constructor would not need to be explicit (though, frankly, it's probably good to be explicit anyway)

{
std::vector<wil::unique_com_class_object_cookie> registrations;
registrations.reserve(sizeof...(Ts));

std::size_t i = 0;
(registrations.push_back(wil::register_com_server<Ts>(clsids.value[i++], context, flags | REGCLS_SUSPENDED)), ...);

// allow the user to keep class objects suspended if they've explicitly passed REGCLS_SUSPENDED.
if (!WI_IsFlagSet(flags, REGCLS_SUSPENDED))
{
winrt::check_hresult(CoResumeClassObjects());
}

return registrations;
}

namespace details
{
template <typename T>
struct has_iid
{
template <typename U = T, std::enable_if_t<std::is_same_v<GUID, std::decay_t<decltype(__uuidof(U))>>, int> = 0>
static std::true_type invoke(int);

template <typename U = T>
static std::false_type invoke(float);

static constexpr bool value = decltype(invoke(0))::value;
};

template <typename T>
constexpr bool has_iid_v = has_iid<T>::value;
}

template <typename... Types>
constexpr auto make_array_of_uuid()
Copy link
Member

@dunhor dunhor Aug 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I like the names make_clsid_array_uuid and make_clsid_array_guid (or perhaps make_clsid_array_uuidof and make_clsid_array_guid_of to make it more explicit which operation is being used to form the CLSIDs). This makes it clearer what the function's purpose is. What do others think here?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose that the __uuidof version could be useful outside of the scope of CLSIDs, e.g. if you were to implement something like RuntimeClass and wanted an array of IIDs when implementing QueryInterface etc.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about make_clsid_array and make_clsid_array_winrt? I don't particularly like uuid vs guid because it is not clear what are the differences.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about make_clsid_array and make_clsid_array_winrt? I don't particularly like uuid vs guid because it is not clear what are the differences.

Seems dunhor's suggestion can answer the question? I'd expect user typing make_clsid_array_ and then seeing uuidof vs guid_of would be able to tell which is which

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

guid/uuid are the most generic. clsid and iid are specializations.
it is odd that clsid_array is the building block. I'd expect guid/uuid to be at the bottom.

these are all aliases for the same thing, so using different names can be dangerous due to the false sense of type safety.

{
return clsid_array<Types...>{std::array<GUID, sizeof...(Types)>{__uuidof(Types)...}};
}

template <typename... Types>
constexpr auto make_array_of_guid()
{
static_assert(!(... && details::has_iid_v<Types>), "Use make_array_of_uuid for COM class instead");
return clsid_array<Types...>{std::array<GUID, sizeof...(Types)>{winrt::guid_of<Types>()...}};
}

#endif // (!defined(__WIL_CPPWINRT_AUTHORING_INCLUDED_COM_SERVER) && defined(__WIL_CPPWINRT_AUTHORING_INCLUDED_ICLASSFACTORY) && defined(_COMBASEAPI_H_))

#if (!defined(__WIL_CPPWINRT_AUTHORING_INCLUDED_FOUNDATION) && defined(WINRT_Windows_Foundation_H)) || \
defined(WIL_DOXYGEN) // WinRT / XAML helpers
/// @cond
Expand Down
112 changes: 0 additions & 112 deletions include/wil/cppwinrt_notifiable_module_lock.h

This file was deleted.

81 changes: 81 additions & 0 deletions include/wil/cppwinrt_notifiable_server_lock.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
//*********************************************************
//
// Copyright (c) Microsoft. All rights reserved.
// This code is licensed under the MIT License.
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
// ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
// TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
// PARTICULAR PURPOSE AND NONINFRINGEMENT.
//
//*********************************************************
//! @file
//! A server lock that runs a callback once all references are released.

#ifndef __WIL_CPPWINRT_NOTIFIABLE_MODULE_LOCK_INCLUDED
#define __WIL_CPPWINRT_NOTIFIABLE_MODULE_LOCK_INCLUDED

#ifdef WINRT_BASE_H
#error You must include this header before including any winrt header
#endif

#ifndef WINRT_CUSTOM_MODULE_LOCK
#error You must define 'WINRT_CUSTOM_MODULE_LOCK' at the project level
#endif

#include <combaseapi.h>
#include <cstdint>
#include <functional>

namespace wil
{
struct notifiable_server_lock
{
uint32_t operator++() noexcept
{
return CoAddRefServerProcess();
}

uint32_t operator--()
{
const auto ref = CoReleaseServerProcess();
if (ref == 0 && notifier)
{
notifier();
}

return ref;
}

template <typename Func>
void set_notifier(Func&& func)
{
notifier = std::forward<Func>(func);
}

void set_notifier(std::nullptr_t) noexcept
{
notifier = nullptr;
}

static notifiable_server_lock& instance() noexcept
{
static notifiable_server_lock lock;
return lock;
}

private:
notifiable_server_lock() = default;

std::function<void()> notifier;
};
} // namespace wil

namespace winrt
{
auto& get_module_lock() noexcept
{
return wil::notifiable_server_lock::instance();
}
} // namespace winrt

#endif
Loading