WinStd
Windows Win32 API using Standard C++
Loading...
Searching...
No Matches
Common.h
1/*
2 SPDX-License-Identifier: MIT
3 Copyright © 1991-2022 Amebis
4 Copyright © 2016 GÉANT
5*/
6
7#pragma once
8
9#include <Windows.h>
10#include <assert.h>
11#include <stdarg.h>
12#include <tchar.h>
13#include <iostream>
14#include <memory>
15#include <stdexcept>
16#include <string>
17#include <vector>
18
35
38
42#ifndef __L
43#define __L(x) L ## x
44#endif
45
49#ifndef _L
50#define _L(x) __L(x)
51#endif
52
56#define WINSTD_STRING_IMPL(x) #x
57
61#define WINSTD_STRING(x) WINSTD_STRING_IMPL(x)
62
66#define WINSTD_NONCOPYABLE(C) \
67private: \
68 C (_In_ const C &h) noexcept; \
69 C& operator=(_In_ const C &h) noexcept;
70
74#define WINSTD_NONMOVABLE(C) \
75private: \
76 C (_Inout_ C &&h) noexcept; \
77 C& operator=(_Inout_ C &&h) noexcept;
78
79#ifndef WINSTD_STACK_BUFFER_BYTES
93#define WINSTD_STACK_BUFFER_BYTES 1024
94#endif
95
97
100
104#ifdef UNICODE
105#define PRINTF_LPTSTR "ls"
106#else
107#define PRINTF_LPTSTR "s"
108#endif
109
113#ifdef OLE2ANSI
114#define PRINTF_LPOLESTR "hs"
115#else
116#define PRINTF_LPOLESTR "ls"
117#endif
118
122#ifdef _UNICODE
123#define _tcin (std::wcin )
124#else
125#define _tcin (std::cin )
126#endif
127
131#ifdef _UNICODE
132#define _tcout (std::wcout)
133#else
134#define _tcout (std::cout)
135#endif
136
140#ifdef _UNICODE
141#define _tcerr (std::wcerr)
142#else
143#define _tcerr (std::cerr)
144#endif
145
149#ifdef _UNICODE
150#define _tclog (std::wclog)
151#else
152#define _tclog (std::clog)
153#endif
154
156
159
163#define WINSTD_HANDLE_IMPL(C, INVAL) \
164public: \
165 C ( ) noexcept { } \
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; } \
170WINSTD_NONCOPYABLE(C)
171
175#define WINSTD_DPLHANDLE_IMPL(C, INVAL) \
176public: \
177 C ( ) noexcept { } \
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; } \
184private:
185
187
188#ifndef _FormatMessage_format_string_
189#define _FormatMessage_format_string_ _In_z_
190#endif
191
193#ifndef _LPCBYTE_DEFINED
194#define _LPCBYTE_DEFINED
195typedef const BYTE *LPCBYTE;
196#endif
198
199#pragma warning(push)
200// Do not use _vsnprintf_s/_vsnwprintf_s(), since it terminates string by force even when we explicitly want to write unterminated string.
201// Threfore turn off compiler warning instead. ;)
202#pragma warning(disable: 4995)
203#pragma warning(disable: 4996)
204#pragma warning(disable: 4505) // Don't warn on unused code
205
208
219#if _MSC_VER <= 1600
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)
221{
222 return _vsnprintf(str, capacity, format, arg);
223}
224#endif
225
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
237{
238 return _vsnwprintf(str, capacity, format, arg);
239}
240
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)
252{
253 _Elem buf[WINSTD_STACK_BUFFER_BYTES/sizeof(_Elem)];
254
255 // Try with stack buffer first.
256 int count = vsnprintf(buf, _countof(buf) - 1, format, arg);
257 if (count >= 0) {
258 // Copy from stack.
259 str.assign(buf, count);
260 } else {
261 for (size_t capacity = 2*WINSTD_STACK_BUFFER_BYTES/sizeof(_Elem);; capacity *= 2) {
262 // Allocate on heap and retry.
263 auto buf_dyn = std::make_unique<_Elem[]>(capacity);
264 count = vsnprintf(buf_dyn.get(), capacity - 1, format, arg);
265 if (count >= 0) {
266 str.assign(buf_dyn.get(), count);
267 break;
268 }
269 }
270 }
271
272 return count;
273}
274
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, ...)
285{
286 va_list arg;
287 va_start(arg, format);
288 const int res = vsprintf(str, format, arg);
289 va_end(arg);
290 return res;
291}
292
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)
300{
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);
303 if (dwResult)
304 str.assign(lpBuffer.get(), dwResult);
305 return dwResult;
306}
307
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)
315{
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);
318 if (dwResult)
319 str.assign(lpBuffer.get(), dwResult);
320 return dwResult;
321}
322
324
325#pragma warning(pop)
326
327namespace winstd
328{
331
335#ifdef _UNICODE
336 typedef std::wstring tstring;
337#else
338 typedef std::string tstring;
339#endif
340
344 template <class _Ty>
346 {
348
353
357 template <class _Ty2> LocalFree_delete(const LocalFree_delete<_Ty2>&) {}
358
364 void operator()(_Ty *_Ptr) const
365 {
366 LocalFree(_Ptr);
367 }
368 };
369
373 template <class _Ty>
374 struct LocalFree_delete<_Ty[]>
375 {
377
381 LocalFree_delete() noexcept {}
382
386 void operator()(_Frees_ptr_opt_ _Ty *_Ptr) const noexcept
387 {
388 LocalFree(_Ptr);
389 }
390
396 template<class _Other>
397 void operator()(_Other *) const
398 {
399 LocalFree(_Ptr);
400 }
401 };
402
406 template<class _Ty, class _Dx>
408 {
409 public:
415 ref_unique_ptr(_Inout_ std::unique_ptr<_Ty, _Dx> &owner) :
416 m_own(owner),
417 m_ptr(owner.release())
418 {}
419
426 m_own(other.m_own),
427 m_ptr(other.m_ptr)
428 {
429 other.m_ptr = nullptr;
430 }
431
436 {
437 if (m_ptr != nullptr)
438 m_own.reset(m_ptr);
439 }
440
446 operator typename _Ty**()
447 {
448 return &m_ptr;
449 }
450
456 operator typename _Ty*&()
457 {
458 return m_ptr;
459 }
460
461 protected:
462 std::unique_ptr<_Ty, _Dx> &m_own;
463 _Ty *m_ptr;
464 };
465
473 template<class _Ty, class _Dx>
474 ref_unique_ptr<_Ty, _Dx> get_ptr(_Inout_ std::unique_ptr<_Ty, _Dx> &owner) noexcept
475 {
476 return ref_unique_ptr<_Ty, _Dx>(owner);
477 }
478
483 template<class _Ty, class _Dx>
484 class ref_unique_ptr<_Ty[], _Dx>
485 {
486 public:
492 ref_unique_ptr(_Inout_ std::unique_ptr<_Ty[], _Dx> &owner) noexcept :
493 m_own(owner),
494 m_ptr(owner.release())
495 {}
496
502 ref_unique_ptr(_Inout_ ref_unique_ptr<_Ty[], _Dx> &&other) :
503 m_own(other.m_own),
504 m_ptr(other.m_ptr)
505 {
506 other.m_ptr = nullptr;
507 }
508
513 {
514 if (m_ptr != nullptr)
515 m_own.reset(m_ptr);
516 }
517
523 operator typename _Ty**() noexcept
524 {
525 return &m_ptr;
526 }
527
533 operator typename _Ty*&()
534 {
535 return m_ptr;
536 }
537
538 protected:
539 std::unique_ptr<_Ty[], _Dx> &m_own;
540 _Ty *m_ptr;
541 };
542
551 template<class _Ty, class _Dx>
552 ref_unique_ptr<_Ty[], _Dx> get_ptr(_Inout_ std::unique_ptr<_Ty[], _Dx>& owner) noexcept
553 {
554 return ref_unique_ptr<_Ty[], _Dx>(owner);
555 }
556
558
561
567 template <class T, const T INVAL>
568 class handle
569 {
570 public:
574 typedef T handle_type;
575
579 static const T invalid;
580
584 handle() noexcept : m_h(invalid)
585 {
586 }
587
593 handle(_In_opt_ handle_type h) noexcept : m_h(h)
594 {
595 }
596
602 handle(_Inout_ handle<handle_type, INVAL> &&h) noexcept
603 {
604 // Transfer handle.
605 m_h = h.m_h;
606 h.m_h = invalid;
607 }
608
609 private:
610 // This class is noncopyable.
611 handle(_In_ const handle<handle_type, INVAL> &h) noexcept {};
612 handle<handle_type, INVAL>& operator=(_In_ const handle<handle_type, INVAL> &h) noexcept {};
613
614 public:
621 {
622 attach(h);
623 return *this;
624 }
625
631 #pragma warning(suppress: 26432) // Move constructor is also present, but not detected by code analysis somehow.
633 {
634 if (this != std::addressof(h)) {
635 // Transfer handle.
636 if (m_h != invalid)
638 m_h = h.m_h;
639 h.m_h = invalid;
640 }
641 return *this;
642 }
643
649 operator handle_type() const
650 {
651 return m_h;
652 }
653
660 {
661 assert(m_h != invalid);
662 return *m_h;
663 }
664
670 {
671 assert(m_h == invalid);
672 return &m_h;
673 }
674
681 {
682 assert(m_h != invalid);
683 return m_h;
684 }
685
696 bool operator!() const
697 {
698 return m_h == invalid;
699 }
700
709 bool operator<(_In_opt_ handle_type h) const
710 {
711 return m_h < h;
712 }
713
722 bool operator<=(_In_opt_ handle_type h) const
723 {
724 return !operator>(h);
725 }
726
735 bool operator>=(_In_opt_ handle_type h) const
736 {
737 return !operator<(h);
738 }
739
748 bool operator>(_In_opt_ handle_type h) const
749 {
750 return h < m_h;
751 }
752
761 bool operator!=(_In_opt_ handle_type h) const
762 {
763 return !operator==(h);
764 }
765
774 bool operator==(_In_opt_ handle_type h) const
775 {
776 return m_h == h;
777 }
778
786 void attach(_In_opt_ handle_type h) noexcept
787 {
788 if (m_h != invalid)
790 m_h = h;
791 }
792
799 {
800 handle_type h = m_h;
801 m_h = invalid;
802 return h;
803 }
804
808 void free()
809 {
810 if (m_h != invalid) {
812 m_h = invalid;
813 }
814 }
815
816 protected:
820 virtual void free_internal() noexcept = 0;
821
822 protected:
824 };
825
826 template <class T, const T INVAL>
827 const T handle<T, INVAL>::invalid = INVAL;
828
832 template <class T, T INVAL>
833 class dplhandle : public handle<T, INVAL>
834 {
835 public:
839 dplhandle() noexcept
840 {
841 }
842
849 {
850 }
851
857 dplhandle<handle_type, INVAL>(_In_ const dplhandle<handle_type, INVAL> &h) noexcept : handle<handle_type, INVAL>(duplicate_internal(h.m_h))
858 {
859 }
860
866 dplhandle<handle_type, INVAL>(_Inout_ dplhandle<handle_type, INVAL> &&h) noexcept : handle<handle_type, INVAL>(std::move(h))
867 {
868 }
869
876 {
878 return *this;
879 }
880
887 {
888 if (this != std::addressof(h)) {
889 if (h.m_h != invalid) {
890 handle_type h_new = duplicate_internal(h.m_h);
891 if (h_new != invalid) {
892 if (m_h != invalid)
894
895 m_h = h_new;
896 } else
897 assert(0); // Could not duplicate the handle
898 } else {
899 if (m_h != invalid)
901
902 m_h = invalid;
903 }
904 }
905 return *this;
906 }
907
913 #pragma warning(disable: 26432) // Move constructor is also present, but not detected by code analysis somehow.
915 {
917 return *this;
918 }
919
926 {
927 return m_h != invalid ? duplicate_internal(m_h) : invalid;
928 }
929
940 {
941 if (m_h != invalid)
943
944 return h != invalid ? (m_h = duplicate_internal(h)) != invalid : (m_h = invalid, true);
945 }
946
947 protected:
955 virtual handle_type duplicate_internal(_In_ handle_type h) const noexcept = 0;
956 };
957
959
962
966 template <typename _Tn>
967 class num_runtime_error : public std::runtime_error
968 {
969 public:
970 typedef _Tn error_type;
971
972 public:
979 num_runtime_error(_In_ error_type num, _In_ const std::string& msg) :
980 m_num(num),
981 runtime_error(msg)
982 {
983 }
984
991 num_runtime_error(_In_ error_type num, _In_opt_z_ const char *msg = nullptr) :
992 m_num(num),
993 runtime_error(msg)
994 {
995 }
996
1001 {
1002 return m_num;
1003 }
1004
1005 protected:
1007 };
1008
1013 {
1014 public:
1021 win_runtime_error(_In_ error_type num, _In_ const std::string& msg) : num_runtime_error<DWORD>(num, msg)
1022 {
1023 }
1024
1031 win_runtime_error(_In_ error_type num, _In_opt_z_ const char *msg = nullptr) : num_runtime_error<DWORD>(num, msg)
1032 {
1033 }
1034
1040 win_runtime_error(_In_ const std::string& msg) : num_runtime_error<DWORD>(GetLastError(), msg)
1041 {
1042 }
1043
1049 win_runtime_error(_In_opt_z_ const char *msg = nullptr) : num_runtime_error<DWORD>(GetLastError(), msg)
1050 {
1051 }
1052
1058 tstring msg(_In_opt_ DWORD dwLanguageId = 0) const
1059 {
1060 tstring str;
1061 if (FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS, 0, m_num, dwLanguageId, str, NULL)) {
1062 // Stock Windows error messages contain CRLF. Well... Trim all the trailing white space.
1063 str.erase(str.find_last_not_of(_T(" \t\n\r\f\v")) + 1);
1064 } else
1065 sprintf(str, m_num >= 0x10000 ? _T("Error 0x%X") : _T("Error %u"), m_num);
1066 return str;
1067 }
1068 };
1069
1071
1074
1078 template<class _Elem, class _Traits, class _Ax>
1079 class basic_string_printf : public std::basic_string<_Elem, _Traits, _Ax>
1080 {
1081 public:
1084
1090 basic_string_printf(_In_z_ _Printf_format_string_ const _Elem *format, ...)
1091 {
1092 va_list arg;
1093 va_start(arg, format);
1094 vsprintf(*this, format, arg);
1095 va_end(arg);
1096 }
1097
1099
1102
1109 basic_string_printf(_In_ HINSTANCE hInstance, _In_ UINT nFormatID, ...)
1110 {
1111 _Myt format;
1112 ATLENSURE(format.LoadString(hInstance, nFormatID));
1113
1114 va_list arg;
1115 va_start(arg, nFormatID);
1116 vsprintf(*this, format, arg);
1117 va_end(arg);
1118 }
1119
1127 basic_string_printf(_In_ HINSTANCE hInstance, _In_ WORD wLanguageID, _In_ UINT nFormatID, ...)
1128 {
1129 _Myt format;
1130 ATLENSURE(format.LoadString(hInstance, nFormatID, wLanguageID));
1131
1132 va_list arg;
1133 va_start(arg, nFormatID);
1134 vsprintf(*this, format, arg);
1135 va_end(arg);
1136 }
1137
1139 };
1140
1145
1150
1154#ifdef _UNICODE
1156#else
1158#endif
1159
1163 template<class _Elem, class _Traits, class _Ax>
1164 class basic_string_msg : public std::basic_string<_Elem, _Traits, _Ax>
1165 {
1166 public:
1169
1175 basic_string_msg(_In_z_ _FormatMessage_format_string_ const _Elem *format, ...)
1176 {
1177 va_list arg;
1178 va_start(arg, format);
1179 FormatMessage(FORMAT_MESSAGE_FROM_STRING, format, 0, 0, *this, &arg);
1180 va_end(arg);
1181 }
1182
1184
1187
1194 basic_string_msg(_In_ HINSTANCE hInstance, _In_ UINT nFormatID, ...)
1195 {
1196 _Myt format(GetManager());
1197 ATLENSURE(format.LoadString(hInstance, nFormatID));
1198
1199 va_list arg;
1200 va_start(arg, nFormatID);
1201 FormatMessage(FORMAT_MESSAGE_FROM_STRING, format, 0, 0, *this, &arg);
1202 va_end(arg);
1203 }
1204
1212 basic_string_msg(_In_ HINSTANCE hInstance, _In_ WORD wLanguageID, _In_ UINT nFormatID, ...)
1213 {
1214 _Myt format(GetManager());
1215 ATLENSURE(format.LoadString(hInstance, nFormatID, wLanguageID));
1216
1217 va_list arg;
1218 va_start(arg, nFormatID);
1219 FormatMessage(FORMAT_MESSAGE_FROM_STRING, format, 0, 0, *this, &arg);
1220 va_end(arg);
1221 }
1222
1224
1230 basic_string_msg(_In_ DWORD dwFlags, _In_opt_ LPCVOID lpSource, _In_ DWORD dwMessageId, _In_ DWORD dwLanguageId, _In_opt_ va_list *Arguments)
1231 {
1232 FormatMessage(dwFlags & ~FORMAT_MESSAGE_ARGUMENT_ARRAY, lpSource, dwMessageId, dwLanguageId, *this, Arguments);
1233 }
1234
1240 basic_string_msg(_In_ DWORD dwFlags, _In_opt_ LPCVOID lpSource, _In_ DWORD dwMessageId, _In_ DWORD dwLanguageId, _In_opt_ DWORD_PTR *Arguments)
1241 {
1242 FormatMessage(dwFlags | FORMAT_MESSAGE_ARGUMENT_ARRAY, lpSource, dwMessageId, dwLanguageId, *this, (va_list*)Arguments);
1243 }
1244
1250 basic_string_msg(_In_ DWORD dwFlags, _In_z_ LPCTSTR pszFormat, _In_opt_ va_list *Arguments)
1251 {
1252 FormatMessage(dwFlags & ~FORMAT_MESSAGE_ARGUMENT_ARRAY | FORMAT_MESSAGE_FROM_STRING, pszFormat, 0, 0, *this, Arguments);
1253 }
1254
1260 basic_string_msg(_In_ DWORD dwFlags, _In_z_ LPCTSTR pszFormat, _In_opt_ DWORD_PTR *Arguments)
1261 {
1262 FormatMessage(dwFlags | FORMAT_MESSAGE_ARGUMENT_ARRAY | FORMAT_MESSAGE_FROM_STRING, pszFormat, 0, 0, *this, (va_list*)Arguments);
1263 }
1264 };
1265
1270
1275
1279#ifdef _UNICODE
1280 typedef wstring_msg tstring_msg;
1281#else
1283#endif
1284
1288 template<class _Elem, class _Traits, class _Ax>
1289 class basic_string_guid : public std::basic_string<_Elem, _Traits, _Ax>
1290 {
1291 public:
1294
1301 basic_string_guid(_In_ const GUID &guid, _In_z_ _Printf_format_string_ const _Elem *format)
1302 {
1303 sprintf<_Elem, _Traits, _Ax>(*this, format,
1304 guid.Data1,
1305 guid.Data2,
1306 guid.Data3,
1307 guid.Data4[0], guid.Data4[1],
1308 guid.Data4[2], guid.Data4[3], guid.Data4[4], guid.Data4[5], guid.Data4[6], guid.Data4[7]);
1309 }
1310
1312 };
1313
1317 class string_guid : public basic_string_guid<char, std::char_traits<char>, std::allocator<char> >
1318 {
1319 public:
1322
1328 string_guid(_In_ const GUID &guid) :
1329 basic_string_guid<char, std::char_traits<char>, std::allocator<char> >(guid, "{%08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X}")
1330 {
1331 }
1332
1334 };
1335
1339 class wstring_guid : public basic_string_guid<wchar_t, std::char_traits<wchar_t>, std::allocator<wchar_t> >
1340 {
1341 public:
1344
1350 wstring_guid(_In_ const GUID &guid) :
1351 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}")
1352 {
1353 }
1354
1356 };
1357
1361#ifdef _UNICODE
1362 typedef wstring_guid tstring_guid;
1363#else
1365#endif
1366
1368
1371
1372 // winstd::sanitizing_allocator::destroy() member generates _Ptr parameter not used warning for primitive datatypes _Ty.
1373 #pragma warning(push)
1374 #pragma warning(disable: 4100)
1375
1383 template<class _Ty>
1384 class sanitizing_allocator : public std::allocator<_Ty>
1385 {
1386 public:
1387 typedef std::allocator<_Ty> _Mybase;
1388
1392 template<class _Other>
1393 struct rebind
1394 {
1396 };
1397
1402 {
1403 }
1404
1409 {
1410 }
1411
1415 template<class _Other>
1416 sanitizing_allocator(_In_ const sanitizing_allocator<_Other> &_Othr) noexcept : _Mybase(_Othr)
1417 {
1418 }
1419
1423 void deallocate(_In_ pointer _Ptr, _In_ size_type _Size)
1424 {
1425 // Sanitize then free.
1426 SecureZeroMemory(_Ptr, _Size);
1427 _Mybase::deallocate(_Ptr, _Size);
1428 }
1429 };
1430
1431 #pragma warning(pop)
1432
1440 typedef std::basic_string<char, std::char_traits<char>, sanitizing_allocator<char> > sanitizing_string;
1441
1449 typedef std::basic_string<wchar_t, std::char_traits<wchar_t>, sanitizing_allocator<wchar_t> > sanitizing_wstring;
1450
1454#ifdef _UNICODE
1456#else
1458#endif
1459
1463 template<size_t N>
1465 {
1466 public:
1471 {
1472 ZeroMemory(m_data, N);
1473 }
1474
1479 {
1480 SecureZeroMemory(m_data, N);
1481 }
1482
1483 public:
1484 unsigned char m_data[N];
1485 };
1486
1488}
Base template class to support converting GUID to string.
Definition: Common.h:1290
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:1301
Base template class to support string formatting using FormatMessage() style templates.
Definition: Common.h:1165
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:1240
basic_string_msg(DWORD dwFlags, LPCTSTR pszFormat, va_list *Arguments)
Initializes a new string and formats its contents using FormatMessage() style.
Definition: Common.h:1250
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:1212
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:1230
basic_string_msg(const _Elem *format,...)
Initializes a new string and formats its contents using FormatMessage() style template.
Definition: Common.h:1175
basic_string_msg(HINSTANCE hInstance, UINT nFormatID,...)
Initializes a new string and formats its contents using FormatMessage() style template in resources.
Definition: Common.h:1194
basic_string_msg(DWORD dwFlags, LPCTSTR pszFormat, DWORD_PTR *Arguments)
Initializes a new string and formats its contents using FormatMessage() style.
Definition: Common.h:1260
Base template class to support string formatting using printf() style templates.
Definition: Common.h:1080
basic_string_printf(const _Elem *format,...)
Initializes a new string and formats its contents using printf() style template.
Definition: Common.h:1090
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:1127
basic_string_printf(HINSTANCE hInstance, UINT nFormatID,...)
Initializes a new string and formats its contents using printf() style template in resources.
Definition: Common.h:1109
Base abstract template class to support object handle keeping for objects that support trivial handle...
Definition: Common.h:834
dplhandle< handle_type, INVAL > & operator=(handle_type h) noexcept
Attaches already available object handle.
Definition: Common.h:875
handle_type duplicate() const
Duplicates and returns a new object handle.
Definition: Common.h:925
dplhandle< handle_type, INVAL > & operator=(dplhandle< handle_type, INVAL > &&h) noexcept
Moves the object.
Definition: Common.h:914
bool attach_duplicated(handle_type h)
Duplicates an object handle and sets a new object handle.
Definition: Common.h:939
virtual handle_type duplicate_internal(handle_type h) const noexcept=0
Abstract member function that must be implemented by child classes to do the actual object handle dup...
dplhandle(handle_type h) noexcept
Initializes a new class instance with an already available object handle.
Definition: Common.h:848
dplhandle< handle_type, INVAL > & operator=(const dplhandle< handle_type, INVAL > &h) noexcept
Duplicates the object.
Definition: Common.h:886
dplhandle() noexcept
Initializes a new class instance with the object handle set to INVAL.
Definition: Common.h:839
Base abstract template class to support generic object handle keeping.
Definition: Common.h:569
handle_type *& operator*() const
Returns the object handle value when the object handle is a pointer to a value (class,...
Definition: Common.h:659
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:584
bool operator>=(handle_type h) const
Is handle greater than or equal to?
Definition: Common.h:735
handle_type operator->() const
Provides object handle member access when the object handle is a pointer to a class or struct.
Definition: Common.h:680
handle_type * operator&()
Returns the object handle reference.
Definition: Common.h:669
T handle_type
Datatype of the object handle this template class handles.
Definition: Common.h:574
handle(handle_type h) noexcept
Initializes a new class instance with an already available object handle.
Definition: Common.h:593
bool operator<(handle_type h) const
Is handle less than?
Definition: Common.h:709
handle< handle_type, INVAL > & operator=(handle_type h) noexcept
Attaches already available object handle.
Definition: Common.h:620
bool operator!() const
Tests if the object handle is invalid.
Definition: Common.h:696
handle< handle_type, INVAL > & operator=(handle< handle_type, INVAL > &&h) noexcept
Move assignment.
Definition: Common.h:632
bool operator!=(handle_type h) const
Is handle not equal to?
Definition: Common.h:761
void free()
Destroys the object.
Definition: Common.h:808
handle_type m_h
Object handle.
Definition: Common.h:823
void attach(handle_type h) noexcept
Sets a new object handle for the class.
Definition: Common.h:786
bool operator==(handle_type h) const
Is handle equal to?
Definition: Common.h:774
handle(handle< handle_type, INVAL > &&h) noexcept
Move constructor.
Definition: Common.h:602
handle_type detach()
Dismisses the object handle from this class.
Definition: Common.h:798
bool operator>(handle_type h) const
Is handle greater than?
Definition: Common.h:748
bool operator<=(handle_type h) const
Is handle less than or equal to?
Definition: Common.h:722
Numerical runtime error.
Definition: Common.h:968
num_runtime_error(error_type num, const char *msg=nullptr)
Constructs an exception.
Definition: Common.h:991
num_runtime_error(error_type num, const std::string &msg)
Constructs an exception.
Definition: Common.h:979
error_type number() const
Returns the Windows error number.
Definition: Common.h:1000
_Tn error_type
Error number type.
Definition: Common.h:970
error_type m_num
Numeric error code.
Definition: Common.h:1006
std::unique_ptr< _Ty[], _Dx > & m_own
Original owner of the pointer.
Definition: Common.h:539
ref_unique_ptr(ref_unique_ptr< _Ty[], _Dx > &&other)
Moves object.
Definition: Common.h:502
virtual ~ref_unique_ptr()
Returns ownership of the pointer.
Definition: Common.h:512
ref_unique_ptr(std::unique_ptr< _Ty[], _Dx > &owner) noexcept
Takes ownership of the pointer.
Definition: Common.h:492
_Ty * m_ptr
Pointer.
Definition: Common.h:540
Helper class for returning pointers to std::unique_ptr.
Definition: Common.h:408
std::unique_ptr< _Ty, _Dx > & m_own
Original owner of the pointer.
Definition: Common.h:462
_Ty * m_ptr
Pointer.
Definition: Common.h:463
ref_unique_ptr(ref_unique_ptr< _Ty, _Dx > &&other)
Moves object.
Definition: Common.h:425
~ref_unique_ptr()
Returns ownership of the pointer.
Definition: Common.h:435
ref_unique_ptr(std::unique_ptr< _Ty, _Dx > &owner)
Takes ownership of the pointer.
Definition: Common.h:415
An allocator template that sanitizes each memory block before it is destroyed or reallocated.
Definition: Common.h:1385
sanitizing_allocator(const sanitizing_allocator< _Ty > &_Othr)
Construct by copying.
Definition: Common.h:1408
void deallocate(pointer _Ptr, size_type _Size)
Deallocate object at _Ptr sanitizing its content first.
Definition: Common.h:1423
sanitizing_allocator(const sanitizing_allocator< _Other > &_Othr) noexcept
Construct from a related allocator.
Definition: Common.h:1416
std::allocator< _Ty > _Mybase
Base type.
Definition: Common.h:1387
sanitizing_allocator() noexcept
Construct default allocator.
Definition: Common.h:1401
Sanitizing BLOB.
Definition: Common.h:1465
sanitizing_blob()
Constructs uninitialized BLOB.
Definition: Common.h:1470
~sanitizing_blob()
Sanitizes BLOB.
Definition: Common.h:1478
Single-byte character implementation of a class to support converting GUID to string.
Definition: Common.h:1318
string_guid(const GUID &guid)
Initializes a new string and formats its contents to string representation of given GUID.
Definition: Common.h:1328
Windows runtime error.
Definition: Common.h:1013
tstring msg(DWORD dwLanguageId=0) const
Returns a user-readable Windows error message.
Definition: Common.h:1058
win_runtime_error(error_type num, const char *msg=nullptr)
Constructs an exception.
Definition: Common.h:1031
win_runtime_error(const std::string &msg)
Constructs an exception using GetLastError()
Definition: Common.h:1040
win_runtime_error(const char *msg=nullptr)
Constructs an exception using GetLastError()
Definition: Common.h:1049
win_runtime_error(error_type num, const std::string &msg)
Constructs an exception.
Definition: Common.h:1021
Wide character implementation of a class to support converting GUID to string.
Definition: Common.h:1340
wstring_guid(const GUID &guid)
Initializes a new string and formats its contents to string representation of given GUID.
Definition: Common.h:1350
#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:474
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:1449
sanitizing_string sanitizing_tstring
Multi-byte / Wide-character sanitizing string (according to _UNICODE)
Definition: Common.h:1457
std::basic_string< char, std::char_traits< char >, sanitizing_allocator< char > > sanitizing_string
A sanitizing variant of std::string.
Definition: Common.h:1440
basic_string_printf< wchar_t, std::char_traits< wchar_t >, std::allocator< wchar_t > > wstring_printf
Wide character implementation of a class to support string formatting using printf() style templates.
Definition: Common.h:1149
string_guid tstring_guid
Multi-byte / Wide-character string GUID (according to _UNICODE)
Definition: Common.h:1364
basic_string_msg< wchar_t, std::char_traits< wchar_t >, std::allocator< wchar_t > > wstring_msg
Wide character implementation of a class to support string formatting using FormatMessage() style tem...
Definition: Common.h:1274
static int vsprintf(std::basic_string< _Elem, _Traits, _Ax > &str, const _Elem *format, va_list arg)
Formats string using printf().
Definition: Common.h:251
static DWORD FormatMessage(DWORD dwFlags, LPCVOID lpSource, DWORD dwMessageId, DWORD dwLanguageId, std::basic_string< char, _Traits, _Ax > &str, va_list *Arguments)
Formats a message string.
Definition: Common.h:299
basic_string_printf< char, std::char_traits< char >, std::allocator< char > > string_printf
Single-byte character implementation of a class to support string formatting using printf() style tem...
Definition: Common.h:1144
static int vsnprintf(char *str, size_t capacity, const char *format, va_list arg)
Formats string using printf().
Definition: Common.h:220
string_printf tstring_printf
Multi-byte / Wide-character formatted string (according to _UNICODE)
Definition: Common.h:1157
static int sprintf(std::basic_string< _Elem, _Traits, _Ax > &str, const _Elem *format,...)
Formats string using printf().
Definition: Common.h:284
basic_string_msg< char, std::char_traits< char >, std::allocator< char > > string_msg
Single-byte character implementation of a class to support string formatting using FormatMessage() st...
Definition: Common.h:1269
string_msg tstring_msg
Multi-byte / Wide-character formatted string (according to _UNICODE)
Definition: Common.h:1282
static const T invalid
Invalid handle value.
Definition: Common.h:579
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:1394
sanitizing_allocator< _Other > other
Other type.
Definition: Common.h:1395