forked from SharpGenTools/SharpGenTools
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathInterfaceTransform.cs
More file actions
348 lines (289 loc) · 13.6 KB
/
Copy pathInterfaceTransform.cs
File metadata and controls
348 lines (289 loc) · 13.6 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
336
337
338
339
340
341
342
343
344
345
346
347
348
// Copyright (c) 2010-2014 SharpDX - Alexandre Mutel
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
using System.Collections.Generic;
using System.Linq;
using System.Text.RegularExpressions;
using SharpGen.Config;
using SharpGen.CppModel;
using SharpGen.Model;
namespace SharpGen.Transform;
/// <summary>
/// Transforms a C++ interface to a C# interface.
/// </summary>
public class InterfaceTransform : TransformBase<CsInterface, CppInterface>, ITransformPreparer<CppInterface, CsInterface>, ITransformer<CsInterface>
{
private readonly Dictionary<Regex, InnerInterfaceMethod> _mapMoveMethodToInnerInterface = new();
private TypeRegistry TypeRegistry => Ioc.TypeRegistry;
private readonly NamespaceRegistry namespaceRegistry;
private readonly IInteropSignatureTransform interopSignatureTransform;
private readonly PropertyBuilder propertyBuilder;
private readonly MethodOverloadBuilder methodOverloadBuilder;
private readonly CsInterface DefaultCallbackable;
private readonly CsInterface CppObjectType;
public InterfaceTransform(NamingRulesManager namingRules,
ITransformPreparer<CppMethod, CsMethod> methodPreparer,
ITransformer<CsMethod> methodTransformer,
NamespaceRegistry namespaceRegistry,
IInteropSignatureTransform interopSignatureTransform,
Ioc ioc) : base(namingRules, ioc)
{
MethodPreparer = methodPreparer;
MethodTransformer = methodTransformer;
this.namespaceRegistry = namespaceRegistry;
this.interopSignatureTransform = interopSignatureTransform;
propertyBuilder = new PropertyBuilder(Ioc);
methodOverloadBuilder = new MethodOverloadBuilder(Ioc);
var globalNamespace = Ioc.GlobalNamespace;
CppObjectType = new CsInterface(null, globalNamespace.GetTypeName(WellKnownName.CppObject));
DefaultCallbackable = new CsInterface(null, globalNamespace.GetTypeName(WellKnownName.ICallbackable))
{
VtblName = globalNamespace.GetTypeName(WellKnownName.CppObjectVtbl)
};
}
/// <summary>
/// Gets the method transformer.
/// </summary>
/// <value>The method transformer.</value>
private ITransformPreparer<CppMethod, CsMethod> MethodPreparer { get; }
private ITransformer<CsMethod> MethodTransformer { get; }
/// <summary>
/// Moves the methods to an inner C# interface.
/// </summary>
/// <param name="methodNameRegExp">The method name regexp query.</param>
/// <param name="innerInterface">The C# inner interface.</param>
/// <param name="propertyNameAccess">The name of the property to access the inner interface.</param>
/// <param name="inheritedInterfaceName">Name of the inherited interface.</param>
public void MoveMethodsToInnerInterface(string methodNameRegExp, string innerInterface, string propertyNameAccess,
string inheritedInterfaceName = null)
{
_mapMoveMethodToInnerInterface.Add(new Regex("^" + methodNameRegExp + "$"),
new InnerInterfaceMethod(innerInterface, propertyNameAccess,
inheritedInterfaceName));
}
/// <summary>
/// Prepares the specified C++ element to a C# element.
/// </summary>
/// <param name="cppInterface">The C++ element.</param>
/// <returns>The C# element created and registered to the <see cref="TransformManager"/></returns>
public override CsInterface Prepare(CppInterface cppInterface)
{
// IsFullyMapped to false => The structure is being mapped
CsInterface cSharpInterface = new(cppInterface, NamingRules.Rename(cppInterface))
{
IsFullyMapped = false
};
var nameSpace = namespaceRegistry.ResolveNamespace(cppInterface);
nameSpace.Add(cSharpInterface);
TypeRegistry.BindType(cppInterface.Name, cSharpInterface, source: cppInterface.ParentInclude?.Name);
if (cppInterface.Rule.AutoGenerateShadow is { })
Logger.Message("Interface [{0}] has redundant shadow generation flag", cppInterface.FullName);
if (cppInterface.Rule.AutoGenerateVtbl == true)
Logger.Message("Interface [{0}] has redundant vtbl generation flag", cppInterface.FullName);
if (cppInterface.Rule.StaticShadowVtbl == true)
Logger.Message("Interface [{0}] has redundant static vtbl generation flag", cppInterface.FullName);
if (cppInterface.Rule.VtblVisibility == Visibility.ProtectedInternal)
Logger.Message("Interface [{0}] has redundant vtbl visibility specification", cppInterface.FullName);
foreach (var cppMethod in cppInterface.Methods)
{
cSharpInterface.Add(MethodPreparer.Prepare(cppMethod));
}
return cSharpInterface;
}
/// <summary>
/// Processes the specified interface type.
/// </summary>
/// <param name="interfaceType">Type of the interface.</param>
public override void Process(CsInterface interfaceType)
{
if (interfaceType.IsFullyMapped)
return;
// Set IsFullyMapped to avoid recursive mapping
interfaceType.IsFullyMapped = true;
var cppInterface = (CppInterface)interfaceType.CppElement;
var baseType = TypeRegistry.FindBoundType(cppInterface.Base);
if (baseType != null)
{
interfaceType.Base = (CsInterface)baseType;
// Process base if it's not mapped already
if (!interfaceType.Base.IsFullyMapped)
Process(interfaceType.Base);
}
else
{
if (!interfaceType.IsCallback)
interfaceType.Base = CppObjectType;
}
// Handle Methods
var methods = interfaceType.MethodList;
List<CsMethod> specialOverloads = new();
foreach (var cSharpMethod in methods)
{
MethodTransformer.Process(cSharpMethod);
// Add specialized method overloads
specialOverloads.AddRange(GenerateSpecialOverloads(cSharpMethod));
}
foreach (var overload in specialOverloads)
{
interfaceType.Add(overload);
MethodTransform.CreateNativeInteropSignatures(interopSignatureTransform, overload);
}
MoveMethodsToInnerInterfaces(interfaceType);
// If interfaceType is DualCallback, then need to generate a default implementation
if (interfaceType.IsDualCallback)
{
var nativeCallback = CreateNativeCallbackType(interfaceType);
interfaceType.Parent.Add(nativeCallback);
CreateProperties(nativeCallback.Methods);
}
else if (!interfaceType.IsCallback && interfaceType.Base is {IsDualCallback: true})
{
interfaceType.Base = interfaceType.Base.GetNativeImplementationOrThis();
}
// N.B. Implicit dependency on CreateNativeCallbackType having already executed.
// Otherwise Native type gets ICallbackable instead of CppObject as a base.
if (interfaceType.IsCallback)
interfaceType.Base ??= DefaultCallbackable;
CreateProperties(methods);
}
private void MoveMethodsToInnerInterfaces(CsInterface interfaceType)
{
// Dispatch method to inner interface if any
var mapInnerInterface = new Dictionary<string, CsInterface>();
// Make a copy of the methods
var methods = interfaceType.Methods.ToList();
foreach (var csMethod in methods)
{
var cppName = interfaceType.CppElementName + "::" + csMethod.CppElement.Name;
foreach (var keyValuePair in _mapMoveMethodToInnerInterface)
{
if (!keyValuePair.Key.Match(cppName).Success)
continue;
var innerInterfaceName = keyValuePair.Value.InnerInterface;
var parentInterfaceName = keyValuePair.Value.InheritedInterfaceName;
CsInterface parentCsInterface = null;
if (parentInterfaceName != null)
{
if (!mapInnerInterface.TryGetValue(parentInterfaceName, out parentCsInterface))
{
parentCsInterface = new CsInterface(null, parentInterfaceName);
mapInnerInterface.Add(parentInterfaceName, parentCsInterface);
}
}
if (!mapInnerInterface.TryGetValue(innerInterfaceName, out CsInterface innerCsInterface))
{
// TODO custom cppInterface?
innerCsInterface = new CsInterface((CppInterface)interfaceType.CppElement, innerInterfaceName)
{
PropertyAccessName = keyValuePair.Value.PropertyAccessName,
Base = parentCsInterface ?? CppObjectType
};
// Add inner interface to root interface
interfaceType.Add(innerCsInterface);
interfaceType.Parent.Add(innerCsInterface);
// Move method to inner interface
mapInnerInterface.Add(innerInterfaceName, innerCsInterface);
}
interfaceType.Remove(csMethod);
innerCsInterface.Add(csMethod);
break;
}
}
}
private CsInterface CreateNativeCallbackType(CsInterface interfaceType)
{
var cppInterface = (CppInterface) interfaceType.CppElement;
var tagForInterface = cppInterface.Rule;
var nativeCallbackBase = interfaceType.Base;
var interfaceTypeName = tagForInterface.NativeCallbackName switch
{
{ } name => name,
_ => interfaceType.Name + "Native"
};
CsInterface nativeCallback = new(cppInterface, interfaceTypeName)
{
IsCallback = false,
IsDualCallback = true,
IBase = interfaceType,
Base = nativeCallbackBase switch
{
// If Parent is a DualInterface, then inherit from Default Callback
{IsDualCallback: true} baseInterface => baseInterface.GetNativeImplementationOrThis(),
_ => nativeCallbackBase ?? CppObjectType
}
};
// Update nativeCallback from tag
if (tagForInterface.NativeCallbackVisibility is {} visibility)
nativeCallback.Visibility = visibility;
interfaceType.NativeImplementation = nativeCallback;
foreach (var method in interfaceType.MethodList)
{
var newCsMethod = (CsMethod) method.Clone();
newCsMethod.Hidden = false;
MethodTransform.CreateNativeInteropSignatures(interopSignatureTransform, newCsMethod);
if (!method.IsPublicVisibilityForced(interfaceType))
{
newCsMethod.Visibility = Visibility.Internal;
newCsMethod.SuffixName("_");
}
nativeCallback.Add(newCsMethod);
}
return nativeCallback;
}
/// <summary>
/// Creates C# properties for the given set of methods.
/// </summary>
/// <param name="methods">The methods.</param>
private void CreateProperties(IEnumerable<CsMethod> methods)
{
var cSharpProperties = propertyBuilder.CreateProperties(methods);
// Add the property to the parentContainer
foreach (var property in cSharpProperties.Values)
{
propertyBuilder.AttachPropertyToParent(property);
}
}
private IEnumerable<CsMethod> GenerateSpecialOverloads(CsMethod csMethod)
{
var hasInterfaceArrayLike = csMethod.PublicParameters.Any(param => param.IsInInterfaceArrayLike);
if (hasInterfaceArrayLike)
{
yield return methodOverloadBuilder.CreateInterfaceArrayOverload(csMethod);
}
if (hasInterfaceArrayLike || csMethod.RequestRawPtr)
{
yield return methodOverloadBuilder.CreateRawPtrOverload(csMethod);
}
}
/// <summary>
/// Private class used for inner interface method creation.
/// </summary>
private class InnerInterfaceMethod
{
public readonly string InnerInterface;
public readonly string PropertyAccessName;
public readonly string InheritedInterfaceName;
public InnerInterfaceMethod(string innerInterface, string propertyAccess, string inheritedInterfaceName)
{
InnerInterface = innerInterface;
PropertyAccessName = propertyAccess;
InheritedInterfaceName = inheritedInterfaceName;
}
}
}