56#define WINSTD_STRING_IMPL(x) #x
61#define WINSTD_STRING(x) WINSTD_STRING_IMPL(x)
66#define WINSTD_NONCOPYABLE(C) \
68 C (_In_ const C &h) noexcept; \
69 C& operator=(_In_ const C &h) noexcept;
74#define WINSTD_NONMOVABLE(C) \
76 C (_Inout_ C &&h) noexcept; \
77 C& operator=(_Inout_ C &&h) noexcept;
79#ifndef WINSTD_STACK_BUFFER_BYTES
93#define WINSTD_STACK_BUFFER_BYTES 1024
105#define PRINTF_LPTSTR "ls"
107#define PRINTF_LPTSTR "s"
114#define PRINTF_LPOLESTR "hs"
116#define PRINTF_LPOLESTR "ls"
123#define _tcin (std::wcin )
125#define _tcin (std::cin )
132#define _tcout (std::wcout)
134#define _tcout (std::cout)
141#define _tcerr (std::wcerr)
143#define _tcerr (std::cerr)
150#define _tclog (std::wclog)
152#define _tclog (std::clog)
163#define WINSTD_HANDLE_IMPL(C, INVAL) \
166 C (_In_opt_ handle_type h) noexcept : handle<handle_type, INVAL>( h ) { } \
167 C (_Inout_ C &&h) noexcept : handle<handle_type, INVAL>(std::move(h)) { } \
168 C& operator=(_In_opt_ handle_type h) noexcept { handle<handle_type, INVAL>::operator=( h ); return *this; } \
169 C& operator=(_Inout_ C &&h) noexcept { handle<handle_type, INVAL>::operator=(std::move(h)); return *this; } \
175#define WINSTD_DPLHANDLE_IMPL(C, INVAL) \
178 C (_In_opt_ handle_type h) noexcept : dplhandle<handle_type, INVAL>( h ) { } \
179 C (_In_ const C &h) noexcept : dplhandle<handle_type, INVAL>(duplicate_internal(h.m_h)) { } \
180 C (_Inout_ C &&h) noexcept : dplhandle<handle_type, INVAL>(std::move (h )) { } \
181 C& operator=(_In_opt_ handle_type h) noexcept { dplhandle<handle_type, INVAL>::operator=( h ); return *this; } \
182 C& operator=(_In_ const C &h) noexcept { dplhandle<handle_type, INVAL>::operator=( h ); return *this; } \
183 C& operator=(_Inout_ C &&h) noexcept { dplhandle<handle_type, INVAL>::operator=(std::move(h)); return *this; } \
188#ifndef _FormatMessage_format_string_
189#define _FormatMessage_format_string_ _In_z_
193#ifndef _LPCBYTE_DEFINED
194#define _LPCBYTE_DEFINED
195typedef const BYTE *LPCBYTE;
202#pragma warning(disable: 4995)
203#pragma warning(disable: 4996)
204#pragma warning(disable: 4505)
220static int vsnprintf(_Out_z_cap_(capacity)
char *str, _In_
size_t capacity, _In_z_ _Printf_format_string_
const char *format, _In_ va_list arg)
222 return _vsnprintf(str, capacity, format, arg);
236static int vsnprintf(_Out_z_cap_(capacity)
wchar_t *str, _In_
size_t capacity, _In_z_ _Printf_format_string_
const wchar_t *format, _In_ va_list arg)
noexcept
238 return _vsnwprintf(str, capacity, format, arg);
250template<
class _Elem,
class _Traits,
class _Ax>
251static int vsprintf(_Inout_ std::basic_string<_Elem, _Traits, _Ax> &str, _In_z_ _Printf_format_string_
const _Elem *format, _In_ va_list arg)
256 int count =
vsnprintf(buf, _countof(buf) - 1, format, arg);
259 str.assign(buf, count);
263 auto buf_dyn = std::make_unique<_Elem[]>(capacity);
264 count =
vsnprintf(buf_dyn.get(), capacity - 1, format, arg);
266 str.assign(buf_dyn.get(), count);
283template<
class _Elem,
class _Traits,
class _Ax>
284static int sprintf(_Inout_ std::basic_string<_Elem, _Traits, _Ax> &str, _In_z_ _Printf_format_string_
const _Elem *format, ...)
287 va_start(arg, format);
288 const int res =
vsprintf(str, format, arg);
298template<
class _Traits,
class _Ax>
299static DWORD
FormatMessage(_In_ DWORD dwFlags, _In_opt_ LPCVOID lpSource, _In_ DWORD dwMessageId, _In_ DWORD dwLanguageId, _Inout_ std::basic_string<char, _Traits, _Ax> &str, _In_opt_ va_list *Arguments)
301 std::unique_ptr<CHAR[], winstd::LocalFree_delete<CHAR[]> > lpBuffer;
302 DWORD dwResult = FormatMessageA(dwFlags | FORMAT_MESSAGE_ALLOCATE_BUFFER, lpSource, dwMessageId, dwLanguageId,
reinterpret_cast<LPSTR
>((LPSTR*)get_ptr(lpBuffer)), 0, Arguments);
304 str.assign(lpBuffer.get(), dwResult);
313template<
class _Traits,
class _Ax>
314static DWORD
FormatMessage(_In_ DWORD dwFlags, _In_opt_ LPCVOID lpSource, _In_ DWORD dwMessageId, _In_ DWORD dwLanguageId, _Inout_ std::basic_string<wchar_t, _Traits, _Ax> &str, _In_opt_ va_list *Arguments)
316 std::unique_ptr<WCHAR[], winstd::LocalFree_delete<WCHAR[]> > lpBuffer;
317 DWORD dwResult = FormatMessageW(dwFlags | FORMAT_MESSAGE_ALLOCATE_BUFFER, lpSource, dwMessageId, dwLanguageId,
reinterpret_cast<LPWSTR
>((LPWSTR*)get_ptr(lpBuffer)), 0, Arguments);
319 str.assign(lpBuffer.get(), dwResult);
396 template<
class _Other>
441 m_data = (T*)GlobalLock(hMem);
472 template<
class _Ty,
class _Dx>
483 m_ptr(owner.release())
495 other.m_ptr =
nullptr;
503 if (
m_ptr !=
nullptr)
512 operator typename _Ty**()
522 operator typename _Ty*&()
539 template<
class _Ty,
class _Dx>
549 template<
class _Ty,
class _Dx>
560 m_ptr(owner.release())
572 other.m_ptr =
nullptr;
580 if (
m_ptr !=
nullptr)
589 operator typename _Ty**()
noexcept
599 operator typename _Ty*&()
617 template<
class _Ty,
class _Dx>
633 template <
class T, const T INVAL>
678 handle<handle_type, INVAL>& operator=(_In_
const handle<handle_type, INVAL> &h)
noexcept {};
697 #pragma warning(suppress: 26432)
700 if (
this != std::addressof(h)) {
892 template <class T, const T INVAL>
898 template <class T, T INVAL>
932 dplhandle<handle_type, INVAL>(_Inout_ dplhandle<handle_type, INVAL> &&h) noexcept : handle<handle_type, INVAL>(std::move(h))
954 if (
this != std::addressof(h)) {
977 #pragma warning(disable: 26432)
1027 template <
typename _Tn>
1122 if (
FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS, 0, m_num, dwLanguageId, str, NULL)) {
1124 str.erase(str.find_last_not_of(_T(
" \t\n\r\f\v")) + 1);
1126 sprintf(str, m_num >= 0x10000 ? _T(
"Error 0x%X") : _T(
"Error %u"), m_num);
1139 template<
class _Elem,
class _Traits,
class _Ax>
1154 va_start(arg, format);
1173 ATLENSURE(format.LoadString(hInstance, nFormatID));
1176 va_start(arg, nFormatID);
1191 ATLENSURE(format.LoadString(hInstance, nFormatID, wLanguageID));
1194 va_start(arg, nFormatID);
1224 template<
class _Elem,
class _Traits,
class _Ax>
1239 va_start(arg, format);
1240 FormatMessage(FORMAT_MESSAGE_FROM_STRING, format, 0, 0, *
this, &arg);
1257 _Myt format(GetManager());
1258 ATLENSURE(format.LoadString(hInstance, nFormatID));
1261 va_start(arg, nFormatID);
1262 FormatMessage(FORMAT_MESSAGE_FROM_STRING, format, 0, 0, *
this, &arg);
1275 _Myt format(GetManager());
1276 ATLENSURE(format.LoadString(hInstance, nFormatID, wLanguageID));
1279 va_start(arg, nFormatID);
1280 FormatMessage(FORMAT_MESSAGE_FROM_STRING, format, 0, 0, *
this, &arg);
1291 basic_string_msg(_In_ DWORD dwFlags, _In_opt_ LPCVOID lpSource, _In_ DWORD dwMessageId, _In_ DWORD dwLanguageId, _In_opt_ va_list *Arguments)
1293 FormatMessage(dwFlags & ~FORMAT_MESSAGE_ARGUMENT_ARRAY, lpSource, dwMessageId, dwLanguageId, *
this, Arguments);
1301 basic_string_msg(_In_ DWORD dwFlags, _In_opt_ LPCVOID lpSource, _In_ DWORD dwMessageId, _In_ DWORD dwLanguageId, _In_opt_ DWORD_PTR *Arguments)
1303 FormatMessage(dwFlags | FORMAT_MESSAGE_ARGUMENT_ARRAY, lpSource, dwMessageId, dwLanguageId, *
this, (va_list*)Arguments);
1313 FormatMessage(dwFlags & ~FORMAT_MESSAGE_ARGUMENT_ARRAY | FORMAT_MESSAGE_FROM_STRING, pszFormat, 0, 0, *
this, Arguments);
1323 FormatMessage(dwFlags | FORMAT_MESSAGE_ARGUMENT_ARRAY | FORMAT_MESSAGE_FROM_STRING, pszFormat, 0, 0, *
this, (va_list*)Arguments);
1349 template<
class _Elem,
class _Traits,
class _Ax>
1364 sprintf<_Elem, _Traits, _Ax>(*
this, format,
1368 guid.Data4[0], guid.Data4[1],
1369 guid.Data4[2], guid.Data4[3], guid.Data4[4], guid.Data4[5], guid.Data4[6], guid.Data4[7]);
1390 basic_string_guid<char, std::char_traits<char>, std::allocator<char> >(guid,
"{%08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X}")
1412 basic_string_guid<wchar_t, std::char_traits<wchar_t>, std::allocator<wchar_t> >(guid, L
"{%08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X}")
1434 #pragma warning(push)
1435 #pragma warning(disable: 4100)
1453 template<
class _Other>
1476 template<
class _Other>
1487 SecureZeroMemory(_Ptr, _Size);
1488 _Mybase::deallocate(_Ptr, _Size);
1492 #pragma warning(pop)
1533 ZeroMemory(m_data, N);
1541 SecureZeroMemory(m_data, N);
1545 unsigned char m_data[N];
Base template class to support converting GUID to string.
Definition: Common.h:1351
basic_string_guid(const GUID &guid, const _Elem *format)
Initializes a new string and formats its contents to string representation of given GUID.
Definition: Common.h:1362
Base template class to support string formatting using FormatMessage() style templates.
Definition: Common.h:1226
basic_string_msg(DWORD dwFlags, LPCVOID lpSource, DWORD dwMessageId, DWORD dwLanguageId, DWORD_PTR *Arguments)
Initializes a new string and formats its contents using FormatMessage() style.
Definition: Common.h:1301
basic_string_msg(DWORD dwFlags, LPCTSTR pszFormat, va_list *Arguments)
Initializes a new string and formats its contents using FormatMessage() style.
Definition: Common.h:1311
basic_string_msg(HINSTANCE hInstance, WORD wLanguageID, UINT nFormatID,...)
Initializes a new string and formats its contents using FormatMessage() style template in resources.
Definition: Common.h:1273
basic_string_msg(DWORD dwFlags, LPCVOID lpSource, DWORD dwMessageId, DWORD dwLanguageId, va_list *Arguments)
Initializes a new string and formats its contents using FormatMessage() style.
Definition: Common.h:1291
basic_string_msg(const _Elem *format,...)
Initializes a new string and formats its contents using FormatMessage() style template.
Definition: Common.h:1236
basic_string_msg(HINSTANCE hInstance, UINT nFormatID,...)
Initializes a new string and formats its contents using FormatMessage() style template in resources.
Definition: Common.h:1255
basic_string_msg(DWORD dwFlags, LPCTSTR pszFormat, DWORD_PTR *Arguments)
Initializes a new string and formats its contents using FormatMessage() style.
Definition: Common.h:1321
Base template class to support string formatting using printf() style templates.
Definition: Common.h:1141
basic_string_printf(const _Elem *format,...)
Initializes a new string and formats its contents using printf() style template.
Definition: Common.h:1151
basic_string_printf(HINSTANCE hInstance, WORD wLanguageID, UINT nFormatID,...)
Initializes a new string and formats its contents using printf() style template in resources.
Definition: Common.h:1188
basic_string_printf(HINSTANCE hInstance, UINT nFormatID,...)
Initializes a new string and formats its contents using printf() style template in resources.
Definition: Common.h:1170
Base abstract template class to support object handle keeping for objects that support trivial handle...
Definition: Common.h:900
virtual handle_type duplicate_internal(handle_type h) const =0
Abstract member function that must be implemented by child classes to do the actual object handle dup...
dplhandle< handle_type, INVAL > & operator=(handle_type h) noexcept
Attaches already available object handle.
Definition: Common.h:941
handle_type duplicate() const
Duplicates and returns a new object handle.
Definition: Common.h:989
dplhandle< handle_type, INVAL > & operator=(dplhandle< handle_type, INVAL > &&h) noexcept
Moves the object.
Definition: Common.h:978
void attach_duplicated(handle_type h)
Duplicates an object handle and sets a new object handle.
Definition: Common.h:999
dplhandle(handle_type h) noexcept
Initializes a new class instance with an already available object handle.
Definition: Common.h:914
dplhandle< handle_type, INVAL > & operator=(const dplhandle< handle_type, INVAL > &h) noexcept
Duplicates the object.
Definition: Common.h:952
dplhandle() noexcept
Initializes a new class instance with the object handle set to INVAL.
Definition: Common.h:905
Context scope automatic GlobalAlloc (un)access.
Definition: Common.h:429
HGLOBAL m_h
memory handle
Definition: Common.h:465
virtual ~globalmem_accessor()
Decrements the lock count associated with a memory object.
Definition: Common.h:451
T * m_data
memory pointer
Definition: Common.h:466
T * data() const noexcept
Return data pointer.
Definition: Common.h:459
globalmem_accessor(HGLOBAL hMem)
Locks a global memory object and returns a pointer to the first byte of the object's memory block.
Definition: Common.h:439
Base abstract template class to support generic object handle keeping.
Definition: Common.h:635
handle_type *& operator*() const
Returns the object handle value when the object handle is a pointer to a value (class,...
Definition: Common.h:725
virtual void free_internal() noexcept=0
Abstract member function that must be implemented by child classes to do the actual object destructio...
handle() noexcept
Initializes a new class instance with the object handle set to INVAL.
Definition: Common.h:650
bool operator>=(handle_type h) const
Is handle greater than or equal to?
Definition: Common.h:801
handle_type operator->() const
Provides object handle member access when the object handle is a pointer to a class or struct.
Definition: Common.h:746
handle_type * operator&()
Returns the object handle reference.
Definition: Common.h:735
T handle_type
Datatype of the object handle this template class handles.
Definition: Common.h:640
handle(handle_type h) noexcept
Initializes a new class instance with an already available object handle.
Definition: Common.h:659
bool operator<(handle_type h) const
Is handle less than?
Definition: Common.h:775
handle< handle_type, INVAL > & operator=(handle_type h) noexcept
Attaches already available object handle.
Definition: Common.h:686
bool operator!() const
Tests if the object handle is invalid.
Definition: Common.h:762
handle< handle_type, INVAL > & operator=(handle< handle_type, INVAL > &&h) noexcept
Move assignment.
Definition: Common.h:698
bool operator!=(handle_type h) const
Is handle not equal to?
Definition: Common.h:827
void free()
Destroys the object.
Definition: Common.h:874
handle_type m_h
Object handle.
Definition: Common.h:889
void attach(handle_type h) noexcept
Sets a new object handle for the class.
Definition: Common.h:852
bool operator==(handle_type h) const
Is handle equal to?
Definition: Common.h:840
handle(handle< handle_type, INVAL > &&h) noexcept
Move constructor.
Definition: Common.h:668
handle_type detach()
Dismisses the object handle from this class.
Definition: Common.h:864
bool operator>(handle_type h) const
Is handle greater than?
Definition: Common.h:814
bool operator<=(handle_type h) const
Is handle less than or equal to?
Definition: Common.h:788
Numerical runtime error.
Definition: Common.h:1029
num_runtime_error(error_type num, const char *msg=nullptr)
Constructs an exception.
Definition: Common.h:1052
num_runtime_error(error_type num, const std::string &msg)
Constructs an exception.
Definition: Common.h:1040
error_type number() const
Returns the Windows error number.
Definition: Common.h:1061
_Tn error_type
Error number type.
Definition: Common.h:1031
error_type m_num
Numeric error code.
Definition: Common.h:1067
std::unique_ptr< _Ty[], _Dx > & m_own
Original owner of the pointer.
Definition: Common.h:605
ref_unique_ptr(ref_unique_ptr< _Ty[], _Dx > &&other)
Moves object.
Definition: Common.h:568
virtual ~ref_unique_ptr()
Returns ownership of the pointer.
Definition: Common.h:578
ref_unique_ptr(std::unique_ptr< _Ty[], _Dx > &owner) noexcept
Takes ownership of the pointer.
Definition: Common.h:558
_Ty * m_ptr
Pointer.
Definition: Common.h:606
Helper class for returning pointers to std::unique_ptr.
Definition: Common.h:474
std::unique_ptr< _Ty, _Dx > & m_own
Original owner of the pointer.
Definition: Common.h:528
_Ty * m_ptr
Pointer.
Definition: Common.h:529
ref_unique_ptr(ref_unique_ptr< _Ty, _Dx > &&other)
Moves object.
Definition: Common.h:491
~ref_unique_ptr()
Returns ownership of the pointer.
Definition: Common.h:501
ref_unique_ptr(std::unique_ptr< _Ty, _Dx > &owner)
Takes ownership of the pointer.
Definition: Common.h:481
An allocator template that sanitizes each memory block before it is destroyed or reallocated.
Definition: Common.h:1446
sanitizing_allocator(const sanitizing_allocator< _Ty > &_Othr)
Construct by copying.
Definition: Common.h:1469
void deallocate(pointer _Ptr, size_type _Size)
Deallocate object at _Ptr sanitizing its content first.
Definition: Common.h:1484
sanitizing_allocator(const sanitizing_allocator< _Other > &_Othr) noexcept
Construct from a related allocator.
Definition: Common.h:1477
std::allocator< _Ty > _Mybase
Base type.
Definition: Common.h:1448
sanitizing_allocator() noexcept
Construct default allocator.
Definition: Common.h:1462
Sanitizing BLOB.
Definition: Common.h:1526
sanitizing_blob()
Constructs uninitialized BLOB.
Definition: Common.h:1531
~sanitizing_blob()
Sanitizes BLOB.
Definition: Common.h:1539
Single-byte character implementation of a class to support converting GUID to string.
Definition: Common.h:1379
string_guid(const GUID &guid)
Initializes a new string and formats its contents to string representation of given GUID.
Definition: Common.h:1389
Windows runtime error.
Definition: Common.h:1074
tstring msg(DWORD dwLanguageId=0) const
Returns a user-readable Windows error message.
Definition: Common.h:1119
win_runtime_error(error_type num, const char *msg=nullptr)
Constructs an exception.
Definition: Common.h:1092
win_runtime_error(const std::string &msg)
Constructs an exception using GetLastError()
Definition: Common.h:1101
win_runtime_error(const char *msg=nullptr)
Constructs an exception using GetLastError()
Definition: Common.h:1110
win_runtime_error(error_type num, const std::string &msg)
Constructs an exception.
Definition: Common.h:1082
Wide character implementation of a class to support converting GUID to string.
Definition: Common.h:1401
wstring_guid(const GUID &guid)
Initializes a new string and formats its contents to string representation of given GUID.
Definition: Common.h:1411
#define WINSTD_NONCOPYABLE(C)
Declares a class as non-copyable.
Definition: Common.h:66
#define WINSTD_STACK_BUFFER_BYTES
Size of the stack buffer in bytes used for initial system function call.
Definition: Common.h:93
std::string tstring
Multi-byte / Wide-character string (according to _UNICODE)
Definition: Common.h:338
ref_unique_ptr< _Ty, _Dx > get_ptr(std::unique_ptr< _Ty, _Dx > &owner) noexcept
Helper function template for returning pointers to std::unique_ptr.
Definition: Common.h:540
#define WINSTD_NONMOVABLE(C)
Declares a class as non-movable.
Definition: Common.h:74
std::basic_string< wchar_t, std::char_traits< wchar_t >, sanitizing_allocator< wchar_t > > sanitizing_wstring
A sanitizing variant of std::wstring.
Definition: Common.h:1510
sanitizing_string sanitizing_tstring
Multi-byte / Wide-character sanitizing string (according to _UNICODE)
Definition: Common.h:1518
std::basic_string< char, std::char_traits< char >, sanitizing_allocator< char > > sanitizing_string
A sanitizing variant of std::string.
Definition: Common.h:1501
static const T invalid
Invalid handle value.
Definition: Common.h:645
Deleter for unique_ptr using GlobalFree.
Definition: Common.h:407
GlobalFree_delete()
Default construct.
Definition: Common.h:411
void operator()(HGLOBAL _Ptr) const
Delete a pointer.
Definition: Common.h:418
LocalFree_delete() noexcept
Default construct.
Definition: Common.h:381
LocalFree_delete< _Ty > _Myt
This type.
Definition: Common.h:376
void operator()(_Other *) const
Delete a pointer of another type.
Definition: Common.h:397
void operator()(_Ty *_Ptr) const noexcept
Delete a pointer.
Definition: Common.h:386
Deleter for unique_ptr using LocalFree.
Definition: Common.h:346
LocalFree_delete< _Ty > _Myt
This type.
Definition: Common.h:347
LocalFree_delete(const LocalFree_delete< _Ty2 > &)
Construct from another LocalFree_delete.
Definition: Common.h:357
void operator()(_Ty *_Ptr) const
Delete a pointer.
Definition: Common.h:364
LocalFree_delete()
Default construct.
Definition: Common.h:352
Convert this type to sanitizing_allocator<_Other>
Definition: Common.h:1455
sanitizing_allocator< _Other > other
Other type.
Definition: Common.h:1456