-
Notifications
You must be signed in to change notification settings - Fork 160
Expand file tree
/
Copy pathDispatchHelpers.cs
More file actions
335 lines (286 loc) · 14.5 KB
/
DispatchHelpers.cs
File metadata and controls
335 lines (286 loc) · 14.5 KB
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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.
using System;
using System.Collections.Generic;
using System.Linq;
using System.Runtime.InteropServices;
using System.Runtime.InteropServices.ComTypes;
using DISPPARAMS = System.Runtime.InteropServices.ComTypes.DISPPARAMS;
namespace Microsoft.ClearScript.Util.COM
{
internal static class DispatchHelpers
{
private static Guid iid = Guid.Empty;
public static readonly int VariantSize = sizeof(ushort) * 4 + IntPtr.Size * 2;
public static ITypeInfo GetTypeInfo(this IDispatch dispatch)
{
if (HResult.Succeeded(dispatch.GetTypeInfoCount(out var count)) && (count > 0))
{
if (HResult.Succeeded(dispatch.GetTypeInfo(0, 0, out var typeInfo)))
{
return typeInfo;
}
}
return null;
}
public static object GetProperty(this IDispatch dispatch, string name, params object[] args)
{
if (!MiscHelpers.Try(out int dispid, static ctx => ctx.dispatch.GetDispIDForName(ctx.name), (dispatch, name)))
{
return Nonexistent.Value;
}
using (var argVariantArrayBlock = new CoTaskMemVariantArgsBlock(args))
{
using (var resultVariantBlock = new CoTaskMemVariantBlock())
{
var dispArgs = new DISPPARAMS { cArgs = args.Length, rgvarg = argVariantArrayBlock.Addr, cNamedArgs = 0, rgdispidNamedArgs = IntPtr.Zero };
HResult.Check(dispatch.Invoke(dispid, ref iid, 0, DispatchFlags.PropertyGet, ref dispArgs, resultVariantBlock.Addr, out _, out _));
return MiscHelpers.GetObjectForVariant(resultVariantBlock.Addr);
}
}
}
public static void SetProperty(this IDispatch dispatch, string name, params object[] args)
{
if (args.Length < 1)
{
throw new ArgumentException("Invalid argument count", nameof(args));
}
var dispid = dispatch.GetDispIDForName(name);
using (var argVariantArrayBlock = new CoTaskMemVariantArgsBlock(args))
{
using (var namedArgDispidBlock = new CoTaskMemBlock(sizeof(int)))
{
Marshal.WriteInt32(namedArgDispidBlock.Addr, SpecialDispIDs.PropertyPut);
var dispArgs = new DISPPARAMS { cArgs = args.Length, rgvarg = argVariantArrayBlock.Addr, cNamedArgs = 1, rgdispidNamedArgs = namedArgDispidBlock.Addr };
var result = dispatch.Invoke(dispid, ref iid, 0, DispatchFlags.PropertyPut | DispatchFlags.PropertyPutRef, ref dispArgs, IntPtr.Zero, out _, out _);
if (result == HResult.DISP_E_MEMBERNOTFOUND)
{
// VBScript objects can be finicky about property-put dispatch flags
result = dispatch.Invoke(dispid, iid, 0, DispatchFlags.PropertyPut, ref dispArgs, IntPtr.Zero, out _, out _);
if (result == HResult.DISP_E_MEMBERNOTFOUND)
{
result = dispatch.Invoke(dispid, iid, 0, DispatchFlags.PropertyPutRef, ref dispArgs, IntPtr.Zero, out _, out _);
}
}
HResult.Check(result);
}
}
}
public static IEnumerable<string> GetPropertyNames(this IDispatch dispatch)
{
return dispatch.GetMembers().Select(member => member.Name);
}
public static object Invoke(this IDispatch dispatch, params object[] args)
{
using (var argVariantArrayBlock = new CoTaskMemVariantArgsByRefBlock(args))
{
using (var resultVariantBlock = new CoTaskMemVariantBlock())
{
var dispArgs = new DISPPARAMS { cArgs = args.Length, rgvarg = argVariantArrayBlock.Addr, cNamedArgs = 0, rgdispidNamedArgs = IntPtr.Zero };
HResult.Check(dispatch.Invoke(SpecialDispIDs.Default, ref iid, 0, DispatchFlags.Method, ref dispArgs, resultVariantBlock.Addr, out _, out _));
return MiscHelpers.GetObjectForVariant(resultVariantBlock.Addr);
}
}
}
public static object InvokeMethod(this IDispatch dispatch, string name, params object[] args)
{
var dispid = dispatch.GetDispIDForName(name);
if (dispid == SpecialDispIDs.GetEnumerator)
{
return dispatch.GetProperty(SpecialMemberNames.NewEnum, args);
}
using (var argVariantArrayBlock = new CoTaskMemVariantArgsByRefBlock(args))
{
using (var resultVariantBlock = new CoTaskMemVariantBlock())
{
var dispArgs = new DISPPARAMS { cArgs = args.Length, rgvarg = argVariantArrayBlock.Addr, cNamedArgs = 0, rgdispidNamedArgs = IntPtr.Zero };
HResult.Check(dispatch.Invoke(dispid, iid, 0, DispatchFlags.Method, ref dispArgs, resultVariantBlock.Addr, out _, out _));
return MiscHelpers.GetObjectForVariant(resultVariantBlock.Addr);
}
}
}
public static IEnumerable<DispatchMember> GetMembers(this IDispatch dispatch)
{
// ReSharper disable once RedundantEnumerableCastCall
return dispatch.GetMembersRaw().GroupBy(member => member.DispID, DispatchMember.Merge).OfType<DispatchMember>();
}
private static int GetDispIDForName(this IDispatch dispatch, string name)
{
var dispids = new int[1];
var names = new[] { name };
if (HResult.Succeeded(dispatch.GetIDsOfNames(ref iid, names, 1, 0, dispids)))
{
return dispids[0];
}
if (name.IsDispIDName(out dispids[0]))
{
return dispids[0];
}
var member = dispatch.GetMembers().FirstOrDefault(testMember => testMember.Name == name);
if (member is null)
{
throw new MissingMemberException(MiscHelpers.FormatInvariant("The object has no property named '{0}'", name));
}
return member.DispID;
}
private static IEnumerable<DispatchMember> GetMembersRaw(this IDispatch dispatch)
{
var typeInfo = dispatch.GetTypeInfo();
if (typeInfo is null)
{
throw new NotSupportedException("The object does not support late binding");
}
return typeInfo.GetDispatchMembers();
}
}
internal static class DispatchExHelpers
{
public static ITypeInfo GetTypeInfo(this IDispatchEx dispatchEx)
{
if (HResult.Succeeded(dispatchEx.GetTypeInfoCount(out var count)) && (count > 0))
{
if (HResult.Succeeded(dispatchEx.GetTypeInfo(0, 0, out var typeInfo)))
{
return typeInfo;
}
}
return null;
}
public static object GetProperty(this IDispatchEx dispatchEx, string name, bool ignoreCase, params object[] args)
{
if (!MiscHelpers.Try(out int dispid, static ctx => ctx.dispatchEx.GetDispIDForName(ctx.name, false, ctx.ignoreCase), (dispatchEx, name, ignoreCase)))
{
return Nonexistent.Value;
}
using (var argVariantArrayBlock = new CoTaskMemVariantArgsBlock(args))
{
using (var resultVariantBlock = new CoTaskMemVariantBlock())
{
var dispArgs = new DISPPARAMS { cArgs = args.Length, rgvarg = argVariantArrayBlock.Addr, cNamedArgs = 0, rgdispidNamedArgs = IntPtr.Zero };
HResult.Check(dispatchEx.InvokeEx(dispid, 0, DispatchFlags.PropertyGet, ref dispArgs, resultVariantBlock.Addr, out _));
return MiscHelpers.GetObjectForVariant(resultVariantBlock.Addr);
}
}
}
public static void SetProperty(this IDispatchEx dispatchEx, string name, bool ignoreCase, params object[] args)
{
if (args.Length < 1)
{
throw new ArgumentException("Invalid argument count", nameof(args));
}
var dispid = dispatchEx.GetDispIDForName(name, true, ignoreCase);
using (var argVariantArrayBlock = new CoTaskMemVariantArgsBlock(args))
{
using (var namedArgDispidBlock = new CoTaskMemBlock(sizeof(int)))
{
Marshal.WriteInt32(namedArgDispidBlock.Addr, SpecialDispIDs.PropertyPut);
var dispArgs = new DISPPARAMS { cArgs = args.Length, rgvarg = argVariantArrayBlock.Addr, cNamedArgs = 1, rgdispidNamedArgs = namedArgDispidBlock.Addr };
var result = dispatchEx.InvokeEx(dispid, 0, DispatchFlags.PropertyPut | DispatchFlags.PropertyPutRef, ref dispArgs, IntPtr.Zero, out _);
if (result == HResult.DISP_E_MEMBERNOTFOUND)
{
// VBScript objects can be finicky about property-put dispatch flags
result = dispatchEx.InvokeEx(dispid, 0, DispatchFlags.PropertyPut, ref dispArgs, IntPtr.Zero, out _);
if (result == HResult.DISP_E_MEMBERNOTFOUND)
{
result = dispatchEx.InvokeEx(dispid, 0, DispatchFlags.PropertyPutRef, ref dispArgs, IntPtr.Zero, out _);
}
}
HResult.Check(result);
}
}
}
public static bool DeleteProperty(this IDispatchEx dispatchEx, string name, bool ignoreCase)
{
return dispatchEx.DeleteMemberByName(name, ignoreCase ? DispatchNameFlags.CaseInsensitive : DispatchNameFlags.CaseSensitive) == HResult.S_OK;
}
public static IEnumerable<string> GetPropertyNames(this IDispatchEx dispatchEx)
{
return dispatchEx.GetMembers().Select(member => member.Name);
}
public static object Invoke(this IDispatchEx dispatchEx, bool asConstructor, params object[] args)
{
using (var argVariantArrayBlock = new CoTaskMemVariantArgsByRefBlock(args))
{
using (var resultVariantBlock = new CoTaskMemVariantBlock())
{
var dispArgs = new DISPPARAMS { cArgs = args.Length, rgvarg = argVariantArrayBlock.Addr, cNamedArgs = 0, rgdispidNamedArgs = IntPtr.Zero };
HResult.Check(dispatchEx.InvokeEx(SpecialDispIDs.Default, 0, asConstructor ? DispatchFlags.Construct : DispatchFlags.Method, ref dispArgs, resultVariantBlock.Addr, out _));
return MiscHelpers.GetObjectForVariant(resultVariantBlock.Addr);
}
}
}
public static object InvokeMethod(this IDispatchEx dispatchEx, string name, bool ignoreCase, params object[] args)
{
var dispid = dispatchEx.GetDispIDForName(name, false, ignoreCase);
if (dispid == SpecialDispIDs.GetEnumerator)
{
return dispatchEx.GetProperty(SpecialMemberNames.NewEnum, ignoreCase, args);
}
using (var argVariantArrayBlock = new CoTaskMemVariantArgsByRefBlock(args))
{
using (var resultVariantBlock = new CoTaskMemVariantBlock())
{
var dispArgs = new DISPPARAMS { cArgs = args.Length, rgvarg = argVariantArrayBlock.Addr, cNamedArgs = 0, rgdispidNamedArgs = IntPtr.Zero };
HResult.Check(dispatchEx.InvokeEx(dispid, 0, DispatchFlags.Method, ref dispArgs, resultVariantBlock.Addr, out _));
return MiscHelpers.GetObjectForVariant(resultVariantBlock.Addr);
}
}
}
public static IEnumerable<DispatchMember> GetMembers(this IDispatchEx dispatchEx)
{
// ReSharper disable once RedundantEnumerableCastCall
return dispatchEx.GetMembersRaw().GroupBy(member => member.DispID, DispatchMember.Merge).OfType<DispatchMember>();
}
private static int GetDispIDForName(this IDispatchEx dispatchEx, string name, bool ensure, bool ignoreCase)
{
var flags = ignoreCase ? DispatchNameFlags.CaseInsensitive : DispatchNameFlags.CaseSensitive;
if (ensure)
{
flags |= DispatchNameFlags.Ensure;
}
var result = dispatchEx.GetDispID(name, flags, out var dispid);
if (ensure && (result == HResult.DISP_E_UNKNOWNNAME))
{
throw new NotSupportedException("The object does not support dynamic properties");
}
if (HResult.Succeeded(result))
{
return dispid;
}
if (name.IsDispIDName(out dispid))
{
return dispid;
}
var member = dispatchEx.GetMembers().FirstOrDefault(testMember => testMember.Name.Equals(name, ignoreCase ? StringComparison.OrdinalIgnoreCase : StringComparison.Ordinal));
if (member is not null)
{
return member.DispID;
}
throw new MissingMemberException(MiscHelpers.FormatInvariant("The object has no property named '{0}'", name));
}
private static IEnumerable<DispatchMember> GetMembersRaw(this IDispatchEx dispatchEx)
{
var isEnumerable = false;
var result = dispatchEx.GetNextDispID(DispatchEnumFlags.All, SpecialDispIDs.StartEnum, out var dispid);
while (result == HResult.S_OK)
{
if (HResult.Succeeded(dispatchEx.GetMemberName(dispid, out var name)))
{
if (HResult.Succeeded(dispatchEx.GetMemberProperties(dispid, DispatchPropFlags.CanAll, out var flags)))
{
if (dispid == SpecialDispIDs.NewEnum)
{
isEnumerable = true;
}
yield return new DispatchMember(name, dispid, flags);
}
}
result = dispatchEx.GetNextDispID(DispatchEnumFlags.All, dispid, out dispid);
}
if (isEnumerable)
{
yield return new DispatchMember("GetEnumerator", SpecialDispIDs.GetEnumerator, DispatchPropFlags.CanCall);
}
}
}
}