aboutsummaryrefslogtreecommitdiff
path: root/Src/external_dependencies/openmpt-trunk/src/mpt/uuid/guid.hpp
blob: b941b7536e48dc6871574d4ff5e041880ac13b0d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
/* SPDX-License-Identifier: BSL-1.0 OR BSD-3-Clause */

#ifndef MPT_UUID_GUID_HPP
#define MPT_UUID_GUID_HPP



#include "mpt/base/detect.hpp"
#include "mpt/base/namespace.hpp"
#include "mpt/out_of_memory/out_of_memory.hpp"
#include "mpt/string/types.hpp"
#include "mpt/string_transcode/transcode.hpp"
#include "mpt/uuid/uuid.hpp"

#include <stdexcept>
#include <vector>

#if MPT_OS_WINDOWS
#if defined(_WIN32_WINNT) && (_WIN32_WINNT >= 0x0600)
#include <guiddef.h>
#endif // _WIN32_WINNT
#include <objbase.h>
#include <rpc.h>
#endif // MPT_OS_WINDOWS



namespace mpt {
inline namespace MPT_INLINE_NS {



#if MPT_OS_WINDOWS



// COM CLSID<->string conversion
// A CLSID string is not necessarily a standard UUID string,
// it might also be a symbolic name for the interface.
// (see CLSIDFromString ( http://msdn.microsoft.com/en-us/library/windows/desktop/ms680589%28v=vs.85%29.aspx ))

inline mpt::winstring CLSIDToString(CLSID clsid) {
	std::wstring str;
	LPOLESTR tmp = nullptr;
	switch (::StringFromCLSID(clsid, &tmp)) {
		case S_OK:
			break;
		case E_OUTOFMEMORY:
			if (tmp) {
				::CoTaskMemFree(tmp);
				tmp = nullptr;
			}
			mpt::throw_out_of_memory();
			break;
		default:
			if (tmp) {
				::CoTaskMemFree(tmp);
				tmp = nullptr;
			}
			throw std::logic_error("StringFromCLSID() failed.");
			break;
	}
	if (!tmp) {
		throw std::logic_error("StringFromCLSID() failed.");
	}
	try {
		str = tmp;
	} catch (mpt::out_of_memory e) {
		::CoTaskMemFree(tmp);
		tmp = nullptr;
		mpt::rethrow_out_of_memory(e);
	}
	::CoTaskMemFree(tmp);
	tmp = nullptr;
	return mpt::transcode<mpt::winstring>(str);
}

inline CLSID StringToCLSID(const mpt::winstring & str_) {
	const std::wstring str = mpt::transcode<std::wstring>(str_);
	CLSID clsid = CLSID();
	std::vector<OLECHAR> tmp(str.c_str(), str.c_str() + str.length() + 1);
	switch (::CLSIDFromString(tmp.data(), &clsid)) {
		case NOERROR:
			// nothing
			break;
		case E_INVALIDARG:
			clsid = CLSID();
			break;
		case CO_E_CLASSSTRING:
			clsid = CLSID();
			break;
		case REGDB_E_CLASSNOTREG:
			clsid = CLSID();
			break;
		case REGDB_E_READREGDB:
			clsid = CLSID();
			throw std::runtime_error("CLSIDFromString() failed: REGDB_E_READREGDB.");
			break;
		default:
			clsid = CLSID();
			throw std::logic_error("CLSIDFromString() failed.");
			break;
	}
	return clsid;
}

inline bool VerifyStringToCLSID(const mpt::winstring & str_, CLSID & clsid) {
	const std::wstring str = mpt::transcode<std::wstring>(str_);
	bool result = false;
	clsid = CLSID();
	std::vector<OLECHAR> tmp(str.c_str(), str.c_str() + str.length() + 1);
	switch (::CLSIDFromString(tmp.data(), &clsid)) {
		case NOERROR:
			result = true;
			break;
		case E_INVALIDARG:
			result = false;
			break;
		case CO_E_CLASSSTRING:
			result = false;
			break;
		case REGDB_E_CLASSNOTREG:
			result = false;
			break;
		case REGDB_E_READREGDB:
			throw std::runtime_error("CLSIDFromString() failed: REGDB_E_READREGDB.");
			break;
		default:
			throw std::logic_error("CLSIDFromString() failed.");
			break;
	}
	return result;
}

inline bool IsCLSID(const mpt::winstring & str_) {
	const std::wstring str = mpt::transcode<std::wstring>(str_);
	bool result = false;
	CLSID clsid = CLSID();
	std::vector<OLECHAR> tmp(str.c_str(), str.c_str() + str.length() + 1);
	switch (::CLSIDFromString(tmp.data(), &clsid)) {
		case NOERROR:
			result = true;
			break;
		case E_INVALIDARG:
			result = false;
			break;
		case CO_E_CLASSSTRING:
			result = false;
			break;
		case REGDB_E_CLASSNOTREG:
			result = false;
			break;
		case REGDB_E_READREGDB:
			result = false;
			throw std::runtime_error("CLSIDFromString() failed: REGDB_E_READREGDB.");
			break;
		default:
			result = false;
			throw std::logic_error("CLSIDFromString() failed.");
			break;
	}
	return result;
}


// COM IID<->string conversion

inline IID StringToIID(const mpt::winstring & str_) {
	const std::wstring str = mpt::transcode<std::wstring>(str_);
	IID iid = IID();
	std::vector<OLECHAR> tmp(str.c_str(), str.c_str() + str.length() + 1);
	switch (::IIDFromString(tmp.data(), &iid)) {
		case S_OK:
			// nothing
			break;
		case E_OUTOFMEMORY:
			iid = IID();
			mpt::throw_out_of_memory();
			break;
		case E_INVALIDARG:
			iid = IID();
			break;
		default:
			iid = IID();
			throw std::logic_error("IIDFromString() failed.");
			break;
	}
	return iid;
}

inline mpt::winstring IIDToString(IID iid) {
	std::wstring str;
	LPOLESTR tmp = nullptr;
	switch (::StringFromIID(iid, &tmp)) {
		case S_OK:
			break;
		case E_OUTOFMEMORY:
			if (tmp) {
				::CoTaskMemFree(tmp);
				tmp = nullptr;
			}
			mpt::throw_out_of_memory();
			break;
		default:
			if (tmp) {
				::CoTaskMemFree(tmp);
				tmp = nullptr;
			}
			throw std::logic_error("StringFromIID() failed.");
			break;
	}
	if (!tmp) {
		throw std::logic_error("StringFromIID() failed.");
	}
	try {
		str = tmp;
	} catch (mpt::out_of_memory e) {
		::CoTaskMemFree(tmp);
		tmp = nullptr;
		mpt::rethrow_out_of_memory(e);
	}
	return mpt::transcode<mpt::winstring>(str);
}


// General GUID<->string conversion.
// The string must/will be in standard GUID format: {4F9A455D-E7EF-4367-B2F0-0C83A38A5C72}

inline GUID StringToGUID(const mpt::winstring & str) {
	return StringToIID(str);
}

inline mpt::winstring GUIDToString(GUID guid) {
	std::vector<OLECHAR> tmp(256);
	if (::StringFromGUID2(guid, tmp.data(), static_cast<int>(tmp.size())) <= 0) {
		throw std::logic_error("StringFromGUID2() failed.");
	}
	return mpt::transcode<mpt::winstring>(tmp.data());
}


// Create a COM GUID

inline GUID CreateGUID() {
	GUID guid = GUID();
	switch (::CoCreateGuid(&guid)) {
		case S_OK:
			// nothing
			break;
		default:
			guid = GUID();
			throw std::runtime_error("CoCreateGuid() failed.");
	}
	return guid;
}


// Checks the UUID against the NULL UUID. Returns false if it is NULL, true otherwise.

inline bool IsValid(::UUID uuid) {
	return false
		|| uuid.Data1 != 0
		|| uuid.Data2 != 0
		|| uuid.Data3 != 0
		|| uuid.Data4[0] != 0
		|| uuid.Data4[1] != 0
		|| uuid.Data4[2] != 0
		|| uuid.Data4[3] != 0
		|| uuid.Data4[4] != 0
		|| uuid.Data4[5] != 0
		|| uuid.Data4[6] != 0
		|| uuid.Data4[7] != 0;
}



#endif // MPT_OS_WINDOWS



} // namespace MPT_INLINE_NS
} // namespace mpt



#endif // MPT_UUID_GUID_HPP