Debian Codegraph @

src/mpt/uuid/guid.hpp

raw
1 /* SPDX-License-Identifier: BSL-1.0 OR BSD-3-Clause */
2
3 #ifndef MPT_UUID_GUID_HPP
4 #define MPT_UUID_GUID_HPP
5
6
7
8 #include "mpt/base/detect.hpp"
9 #include "mpt/base/namespace.hpp"
10 #include "mpt/out_of_memory/out_of_memory.hpp"
11 #include "mpt/string/types.hpp"
12 #include "mpt/string_transcode/transcode.hpp"
13 #include "mpt/uuid/uuid.hpp"
14
15 #include <stdexcept>
16 #include <vector>
17
18 #if MPT_OS_WINDOWS
19 #if MPT_WINNT_AT_LEAST(MPT_WIN_VISTA)
20 #include <guiddef.h>
21 #endif // MPT_WIN_VISTA
22 #include <objbase.h>
23 #include <rpc.h>
24 #endif // MPT_OS_WINDOWS
25
26
27
28 namespace mpt {
29 inline namespace MPT_INLINE_NS {
30
31
32
33 #if MPT_OS_WINDOWS && !defined(MPT_COMPILER_QUIRK_NO_WCHAR)
34
35
36
37 // COM CLSID<->string conversion
38 // A CLSID string is not necessarily a standard UUID string,
39 // it might also be a symbolic name for the interface.
40 // (see CLSIDFromString ( http://msdn.microsoft.com/en-us/library/windows/desktop/ms680589%28v=vs.85%29.aspx ))
41
42 inline mpt::winstring CLSIDToString(CLSID clsid) {
43 std::wstring str;
44 LPOLESTR tmp = nullptr;
45 switch (::StringFromCLSID(clsid, &tmp)) {
46 case S_OK:
47 break;
48 case E_OUTOFMEMORY:
49 if (tmp) {
50 ::CoTaskMemFree(tmp);
51 tmp = nullptr;
52 }
53 mpt::throw_out_of_memory();
54 break;
55 default:
56 if (tmp) {
57 ::CoTaskMemFree(tmp);
58 tmp = nullptr;
59 }
60 throw std::logic_error("StringFromCLSID() failed.");
61 break;
62 }
63 if (!tmp) {
64 throw std::logic_error("StringFromCLSID() failed.");
65 }
66 try {
67 str = tmp;
68 } catch (mpt::out_of_memory e) {
69 ::CoTaskMemFree(tmp);
70 tmp = nullptr;
71 mpt::rethrow_out_of_memory(e);
72 }
73 ::CoTaskMemFree(tmp);
74 tmp = nullptr;
75 return mpt::transcode<mpt::winstring>(str);
76 }
77
78 inline CLSID StringToCLSID(const mpt::winstring & str_) {
79 const std::wstring str = mpt::transcode<std::wstring>(str_);
80 CLSID clsid = CLSID();
81 std::vector<OLECHAR> tmp(str.c_str(), str.c_str() + str.length() + 1);
82 switch (::CLSIDFromString(tmp.data(), &clsid)) {
83 case NOERROR:
84 // nothing
85 break;
86 case E_INVALIDARG:
87 clsid = CLSID();
88 break;
89 case CO_E_CLASSSTRING:
90 clsid = CLSID();
91 break;
92 case REGDB_E_CLASSNOTREG:
93 clsid = CLSID();
94 break;
95 case REGDB_E_READREGDB:
96 clsid = CLSID();
97 throw std::runtime_error("CLSIDFromString() failed: REGDB_E_READREGDB.");
98 break;
99 default:
100 clsid = CLSID();
101 throw std::logic_error("CLSIDFromString() failed.");
102 break;
103 }
104 return clsid;
105 }
106
107 inline bool VerifyStringToCLSID(const mpt::winstring & str_, CLSID & clsid) {
108 const std::wstring str = mpt::transcode<std::wstring>(str_);
109 bool result = false;
110 clsid = CLSID();
111 std::vector<OLECHAR> tmp(str.c_str(), str.c_str() + str.length() + 1);
112 switch (::CLSIDFromString(tmp.data(), &clsid)) {
113 case NOERROR:
114 result = true;
115 break;
116 case E_INVALIDARG:
117 result = false;
118 break;
119 case CO_E_CLASSSTRING:
120 result = false;
121 break;
122 case REGDB_E_CLASSNOTREG:
123 result = false;
124 break;
125 case REGDB_E_READREGDB:
126 throw std::runtime_error("CLSIDFromString() failed: REGDB_E_READREGDB.");
127 break;
128 default:
129 throw std::logic_error("CLSIDFromString() failed.");
130 break;
131 }
132 return result;
133 }
134
135 inline bool IsCLSID(const mpt::winstring & str_) {
136 const std::wstring str = mpt::transcode<std::wstring>(str_);
137 bool result = false;
138 CLSID clsid = CLSID();
139 std::vector<OLECHAR> tmp(str.c_str(), str.c_str() + str.length() + 1);
140 switch (::CLSIDFromString(tmp.data(), &clsid)) {
141 case NOERROR:
142 result = true;
143 break;
144 case E_INVALIDARG:
145 result = false;
146 break;
147 case CO_E_CLASSSTRING:
148 result = false;
149 break;
150 case REGDB_E_CLASSNOTREG:
151 result = false;
152 break;
153 case REGDB_E_READREGDB:
154 result = false;
155 throw std::runtime_error("CLSIDFromString() failed: REGDB_E_READREGDB.");
156 break;
157 default:
158 result = false;
159 throw std::logic_error("CLSIDFromString() failed.");
160 break;
161 }
162 return result;
163 }
164
165
166 // COM IID<->string conversion
167
168 inline IID StringToIID(const mpt::winstring & str_) {
169 const std::wstring str = mpt::transcode<std::wstring>(str_);
170 IID iid = IID();
171 std::vector<OLECHAR> tmp(str.c_str(), str.c_str() + str.length() + 1);
172 switch (::IIDFromString(tmp.data(), &iid)) {
173 case S_OK:
174 // nothing
175 break;
176 case E_OUTOFMEMORY:
177 iid = IID();
178 mpt::throw_out_of_memory();
179 break;
180 case E_INVALIDARG:
181 iid = IID();
182 break;
183 default:
184 iid = IID();
185 throw std::logic_error("IIDFromString() failed.");
186 break;
187 }
188 return iid;
189 }
190
191 inline mpt::winstring IIDToString(IID iid) {
192 std::wstring str;
193 LPOLESTR tmp = nullptr;
194 switch (::StringFromIID(iid, &tmp)) {
195 case S_OK:
196 break;
197 case E_OUTOFMEMORY:
198 if (tmp) {
199 ::CoTaskMemFree(tmp);
200 tmp = nullptr;
201 }
202 mpt::throw_out_of_memory();
203 break;
204 default:
205 if (tmp) {
206 ::CoTaskMemFree(tmp);
207 tmp = nullptr;
208 }
209 throw std::logic_error("StringFromIID() failed.");
210 break;
211 }
212 if (!tmp) {
213 throw std::logic_error("StringFromIID() failed.");
214 }
215 try {
216 str = tmp;
217 } catch (mpt::out_of_memory e) {
218 ::CoTaskMemFree(tmp);
219 tmp = nullptr;
220 mpt::rethrow_out_of_memory(e);
221 }
222 return mpt::transcode<mpt::winstring>(str);
223 }
224
225
226 // General GUID<->string conversion.
227 // The string must/will be in standard GUID format: {4F9A455D-E7EF-4367-B2F0-0C83A38A5C72}
228
229 inline GUID StringToGUID(const mpt::winstring & str) {
230 return StringToIID(str);
231 }
232
233 inline mpt::winstring GUIDToString(GUID guid) {
234 std::vector<OLECHAR> tmp(256);
235 if (::StringFromGUID2(guid, tmp.data(), static_cast<int>(tmp.size())) <= 0) {
236 throw std::logic_error("StringFromGUID2() failed.");
237 }
238 return mpt::transcode<mpt::winstring>(tmp.data());
239 }
240
241
242 // Create a COM GUID
243
244 inline GUID CreateGUID() {
245 GUID guid = GUID();
246 switch (::CoCreateGuid(&guid)) {
247 case S_OK:
248 // nothing
249 break;
250 default:
251 guid = GUID();
252 throw std::runtime_error("CoCreateGuid() failed.");
253 }
254 return guid;
255 }
256
257
258 // Checks the UUID against the NULL UUID. Returns false if it is NULL, true otherwise.
259
260 inline bool IsValid(::UUID uuid) {
261 return false
262 || uuid.Data1 != 0
263 || uuid.Data2 != 0
264 || uuid.Data3 != 0
265 || uuid.Data4[0] != 0
266 || uuid.Data4[1] != 0
267 || uuid.Data4[2] != 0
268 || uuid.Data4[3] != 0
269 || uuid.Data4[4] != 0
270 || uuid.Data4[5] != 0
271 || uuid.Data4[6] != 0
272 || uuid.Data4[7] != 0;
273 }
274
275
276
277 #endif // MPT_OS_WINDOWS && !MPT_COMPILER_QUIRK_NO_WCHAR
278
279
280
281 } // namespace MPT_INLINE_NS
282 } // namespace mpt
283
284
285
286 #endif // MPT_UUID_GUID_HPP