LuaObjectGenerator.Emit.cs 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500
  1. using Microsoft.CodeAnalysis;
  2. using Microsoft.CodeAnalysis.CSharp;
  3. using Microsoft.CodeAnalysis.CSharp.Syntax;
  4. namespace Lua.SourceGenerator;
  5. partial class LuaObjectGenerator
  6. {
  7. static bool TryEmit(TypeMetadata typeMetadata, CodeBuilder builder, SymbolReferences references, Compilation compilation, in SourceProductionContext context, Dictionary<INamedTypeSymbol, TypeMetadata> metaDict)
  8. {
  9. try
  10. {
  11. var error = false;
  12. // must be partial
  13. if (!typeMetadata.IsPartial())
  14. {
  15. context.ReportDiagnostic(Diagnostic.Create(
  16. DiagnosticDescriptors.MustBePartial,
  17. typeMetadata.Syntax.Identifier.GetLocation(),
  18. typeMetadata.Symbol.Name));
  19. error = true;
  20. }
  21. // nested is not allowed
  22. if (typeMetadata.IsNested())
  23. {
  24. context.ReportDiagnostic(Diagnostic.Create(
  25. DiagnosticDescriptors.NestedNotAllowed,
  26. typeMetadata.Syntax.Identifier.GetLocation(),
  27. typeMetadata.Symbol.Name));
  28. error = true;
  29. }
  30. // verify abstract/interface
  31. if (typeMetadata.Symbol.IsAbstract)
  32. {
  33. context.ReportDiagnostic(Diagnostic.Create(
  34. DiagnosticDescriptors.AbstractNotAllowed,
  35. typeMetadata.Syntax.Identifier.GetLocation(),
  36. typeMetadata.TypeName));
  37. error = true;
  38. }
  39. if (!ValidateMembers(typeMetadata, compilation, references, context, metaDict))
  40. {
  41. error = true;
  42. }
  43. if (error)
  44. {
  45. return false;
  46. }
  47. builder.AppendLine("// <auto-generated />");
  48. builder.AppendLine("#nullable enable");
  49. builder.AppendLine("#pragma warning disable CS0162 // Unreachable code");
  50. builder.AppendLine("#pragma warning disable CS0219 // Variable assigned but never used");
  51. builder.AppendLine("#pragma warning disable CS8600 // Converting null literal or possible null value to non-nullable type.");
  52. builder.AppendLine("#pragma warning disable CS8601 // Possible null reference assignment");
  53. builder.AppendLine("#pragma warning disable CS8602 // Possible null return");
  54. builder.AppendLine("#pragma warning disable CS8604 // Possible null reference argument for parameter");
  55. builder.AppendLine("#pragma warning disable CS8631 // The type cannot be used as type parameter in the generic type or method");
  56. builder.AppendLine();
  57. var ns = typeMetadata.Symbol.ContainingNamespace;
  58. if (!ns.IsGlobalNamespace)
  59. {
  60. builder.AppendLine($"namespace {ns}");
  61. builder.BeginBlock();
  62. }
  63. var typeDeclarationKeyword = (typeMetadata.Symbol.IsRecord, typeMetadata.Symbol.IsValueType) switch
  64. {
  65. (true, true) => "record struct",
  66. (true, false) => "record",
  67. (false, true) => "struct",
  68. (false, false) => "class",
  69. };
  70. using var _ = builder.BeginBlockScope($"partial {typeDeclarationKeyword} {typeMetadata.TypeName} : global::Lua.ILuaUserData");
  71. var metamethodSet = new HashSet<LuaObjectMetamethod>();
  72. if (!TryEmitMethods(typeMetadata, builder, references, metamethodSet, context))
  73. {
  74. return false;
  75. }
  76. if (!TryEmitIndexMetamethod(typeMetadata, builder, context))
  77. {
  78. return false;
  79. }
  80. if (!TryEmitNewIndexMetamethod(typeMetadata, builder, context))
  81. {
  82. return false;
  83. }
  84. if (!TryEmitMetatable(builder, metamethodSet, context))
  85. {
  86. return false;
  87. }
  88. // implicit operator
  89. builder.AppendLine($"public static implicit operator global::Lua.LuaValue({typeMetadata.FullTypeName} value)");
  90. using (builder.BeginBlockScope())
  91. {
  92. builder.AppendLine("return new(value);");
  93. }
  94. if (!ns.IsGlobalNamespace) builder.EndBlock();
  95. builder.AppendLine("#pragma warning restore CS0162 // Unreachable code");
  96. builder.AppendLine("#pragma warning restore CS0219 // Variable assigned but never used");
  97. builder.AppendLine("#pragma warning restore CS8600 // Converting null literal or possible null value to non-nullable type.");
  98. builder.AppendLine("#pragma warning restore CS8601 // Possible null reference assignment");
  99. builder.AppendLine("#pragma warning restore CS8602 // Possible null return");
  100. builder.AppendLine("#pragma warning restore CS8604 // Possible null reference argument for parameter");
  101. builder.AppendLine("#pragma warning restore CS8631 // The type cannot be used as type parameter in the generic type or method");
  102. return true;
  103. }
  104. catch (Exception)
  105. {
  106. return false;
  107. }
  108. }
  109. static bool ValidateMembers(TypeMetadata typeMetadata, Compilation compilation, SymbolReferences references, in SourceProductionContext context, Dictionary<INamedTypeSymbol, TypeMetadata> metaDict)
  110. {
  111. var isValid = true;
  112. foreach (var property in typeMetadata.Properties)
  113. {
  114. if (SymbolEqualityComparer.Default.Equals(property.Type, references.LuaValue)) continue;
  115. if (SymbolEqualityComparer.Default.Equals(property.Type, typeMetadata.Symbol)) continue;
  116. var conversion = compilation.ClassifyConversion(property.Type, references.LuaValue);
  117. if (!conversion.Exists && (property.Type is not INamedTypeSymbol namedTypeSymbol || !metaDict.ContainsKey(namedTypeSymbol)))
  118. {
  119. context.ReportDiagnostic(Diagnostic.Create(
  120. DiagnosticDescriptors.InvalidPropertyType,
  121. property.Symbol.Locations.FirstOrDefault(),
  122. property.Type.Name));
  123. isValid = false;
  124. }
  125. }
  126. foreach (var method in typeMetadata.Methods)
  127. {
  128. if (!method.Symbol.ReturnsVoid)
  129. {
  130. var typeSymbol = method.Symbol.ReturnType;
  131. if (method.IsAsync)
  132. {
  133. var namedType = (INamedTypeSymbol)typeSymbol;
  134. if (namedType.TypeArguments.Length == 0) goto PARAMETERS;
  135. typeSymbol = namedType.TypeArguments[0];
  136. }
  137. if (SymbolEqualityComparer.Default.Equals(typeSymbol, references.LuaValue)) goto PARAMETERS;
  138. if (SymbolEqualityComparer.Default.Equals(typeSymbol, typeMetadata.Symbol)) goto PARAMETERS;
  139. var conversion = compilation.ClassifyConversion(typeSymbol, references.LuaValue);
  140. if (!conversion.Exists && (typeSymbol is not INamedTypeSymbol namedTypeSymbol || !metaDict.ContainsKey(namedTypeSymbol)))
  141. {
  142. context.ReportDiagnostic(Diagnostic.Create(
  143. DiagnosticDescriptors.InvalidReturnType,
  144. typeSymbol.Locations.FirstOrDefault(),
  145. typeSymbol.Name));
  146. isValid = false;
  147. }
  148. }
  149. PARAMETERS:
  150. for (int index = 0; index < method.Symbol.Parameters.Length; index++)
  151. {
  152. IParameterSymbol? parameterSymbol = method.Symbol.Parameters[index];
  153. var typeSymbol = parameterSymbol.Type;
  154. if(index == method.Symbol.Parameters.Length - 1 && SymbolEqualityComparer.Default.Equals(typeSymbol, references.CancellationToken))
  155. {
  156. continue;
  157. }
  158. if (SymbolEqualityComparer.Default.Equals(typeSymbol, references.LuaValue)) continue;
  159. if (SymbolEqualityComparer.Default.Equals(typeSymbol, typeMetadata.Symbol)) continue;
  160. var conversion = compilation.ClassifyConversion(typeSymbol, references.LuaValue);
  161. if (!conversion.Exists && (typeSymbol is not INamedTypeSymbol namedTypeSymbol || !metaDict.ContainsKey(namedTypeSymbol)))
  162. {
  163. context.ReportDiagnostic(Diagnostic.Create(
  164. DiagnosticDescriptors.InvalidParameterType,
  165. typeSymbol.Locations.FirstOrDefault(),
  166. typeSymbol.Name));
  167. isValid = false;
  168. }
  169. }
  170. }
  171. return isValid;
  172. }
  173. static bool TryEmitIndexMetamethod(TypeMetadata typeMetadata, CodeBuilder builder, in SourceProductionContext context)
  174. {
  175. builder.AppendLine(@"static readonly global::Lua.LuaFunction __metamethod_index = new global::Lua.LuaFunction(""index"", (context, ct) =>");
  176. using (builder.BeginBlockScope())
  177. {
  178. builder.AppendLine($"var userData = context.GetArgument<{typeMetadata.FullTypeName}>(0);");
  179. builder.AppendLine($"var key = context.GetArgument<global::System.String>(1);");
  180. builder.AppendLine("var result = key switch");
  181. using (builder.BeginBlockScope())
  182. {
  183. foreach (var propertyMetadata in typeMetadata.Properties)
  184. {
  185. if (propertyMetadata.IsStatic)
  186. {
  187. builder.AppendLine(@$"""{propertyMetadata.LuaMemberName}"" => new global::Lua.LuaValue({typeMetadata.FullTypeName}.{propertyMetadata.Symbol.Name}),");
  188. }
  189. else
  190. {
  191. builder.AppendLine(@$"""{propertyMetadata.LuaMemberName}"" => new global::Lua.LuaValue(userData.{propertyMetadata.Symbol.Name}),");
  192. }
  193. }
  194. foreach (var methodMetadata in typeMetadata.Methods
  195. .Where(x => x.HasMemberAttribute))
  196. {
  197. builder.AppendLine(@$"""{methodMetadata.LuaMemberName}"" => new global::Lua.LuaValue(__function_{methodMetadata.LuaMemberName}),");
  198. }
  199. builder.AppendLine(@$"_ => global::Lua.LuaValue.Nil,");
  200. }
  201. builder.AppendLine(";");
  202. builder.AppendLine("return new global::System.Threading.Tasks.ValueTask<int>(context.Return(result));");
  203. }
  204. builder.AppendLine(");");
  205. return true;
  206. }
  207. static bool TryEmitNewIndexMetamethod(TypeMetadata typeMetadata, CodeBuilder builder, in SourceProductionContext context)
  208. {
  209. builder.AppendLine(@"static readonly global::Lua.LuaFunction __metamethod_newindex = new global::Lua.LuaFunction(""newindex"", (context, ct) =>");
  210. using (builder.BeginBlockScope())
  211. {
  212. builder.AppendLine($"var userData = context.GetArgument<{typeMetadata.FullTypeName}>(0);");
  213. builder.AppendLine($"var key = context.GetArgument<global::System.String>(1);");
  214. builder.AppendLine("switch (key)");
  215. using (builder.BeginBlockScope())
  216. {
  217. foreach (var propertyMetadata in typeMetadata.Properties)
  218. {
  219. builder.AppendLine(@$"case ""{propertyMetadata.LuaMemberName}"":");
  220. using (builder.BeginIndentScope())
  221. {
  222. if (propertyMetadata.IsReadOnly)
  223. {
  224. builder.AppendLine($@"throw new global::Lua.LuaRuntimeException(context.Thread, $""'{{key}}' cannot overwrite."");");
  225. }
  226. else if (propertyMetadata.IsStatic)
  227. {
  228. builder.AppendLine(@$"{typeMetadata.FullTypeName}.{propertyMetadata.Symbol.Name} = context.GetArgument<{propertyMetadata.TypeFullName}>(2);");
  229. builder.AppendLine("break;");
  230. }
  231. else
  232. {
  233. builder.AppendLine(@$"userData.{propertyMetadata.Symbol.Name} = context.GetArgument<{propertyMetadata.TypeFullName}>(2);");
  234. builder.AppendLine("break;");
  235. }
  236. }
  237. }
  238. foreach (var methodMetadata in typeMetadata.Methods
  239. .Where(x => x.HasMemberAttribute))
  240. {
  241. builder.AppendLine(@$"case ""{methodMetadata.LuaMemberName}"":");
  242. using (builder.BeginIndentScope())
  243. {
  244. builder.AppendLine($@"throw new global::Lua.LuaRuntimeException(context.Thread, $""'{{key}}' cannot overwrite."");");
  245. }
  246. }
  247. builder.AppendLine(@$"default:");
  248. using (builder.BeginIndentScope())
  249. {
  250. builder.AppendLine(@$"throw new global::Lua.LuaRuntimeException(context.Thread, $""'{{key}}' not found."");");
  251. }
  252. }
  253. builder.AppendLine("return new global::System.Threading.Tasks.ValueTask<int>(context.Return());");
  254. }
  255. builder.AppendLine(");");
  256. return true;
  257. }
  258. static bool TryEmitMethods(TypeMetadata typeMetadata, CodeBuilder builder, SymbolReferences references, HashSet<LuaObjectMetamethod> metamethodSet, in SourceProductionContext context)
  259. {
  260. builder.AppendLine();
  261. foreach (var methodMetadata in typeMetadata.Methods)
  262. {
  263. string? functionName = null;
  264. if (methodMetadata.HasMemberAttribute)
  265. {
  266. functionName = $"__function_{methodMetadata.LuaMemberName}";
  267. EmitMethodFunction(functionName, methodMetadata.LuaMemberName, typeMetadata, methodMetadata, builder, references);
  268. }
  269. if (methodMetadata.HasMetamethodAttribute)
  270. {
  271. if (!metamethodSet.Add(methodMetadata.Metamethod))
  272. {
  273. context.ReportDiagnostic(Diagnostic.Create(
  274. DiagnosticDescriptors.DuplicateMetamethod,
  275. methodMetadata.Symbol.Locations.FirstOrDefault(),
  276. typeMetadata.TypeName,
  277. methodMetadata.Metamethod
  278. ));
  279. continue;
  280. }
  281. if (functionName == null)
  282. {
  283. EmitMethodFunction($"__metamethod_{methodMetadata.Metamethod}", methodMetadata.Metamethod.ToString().ToLower(), typeMetadata, methodMetadata, builder, references);
  284. }
  285. else
  286. {
  287. builder.AppendLine($"static global::Lua.LuaFunction __metamethod_{methodMetadata.Metamethod} => {functionName};");
  288. }
  289. }
  290. }
  291. return true;
  292. }
  293. static void EmitMethodFunction(string functionName, string chunkName, TypeMetadata typeMetadata, MethodMetadata methodMetadata, CodeBuilder builder, SymbolReferences references)
  294. {
  295. builder.AppendLine($@"static readonly global::Lua.LuaFunction {functionName} = new global::Lua.LuaFunction(""{chunkName}"", {(methodMetadata.IsAsync ? "async" : "")} (context, ct) =>");
  296. using (builder.BeginBlockScope())
  297. {
  298. var index = 0;
  299. if (!methodMetadata.IsStatic)
  300. {
  301. builder.AppendLine($"var userData = context.GetArgument<{typeMetadata.FullTypeName}>(0);");
  302. index++;
  303. }
  304. bool hasCancellationToken = false;
  305. for (int i = 0; i < methodMetadata.Symbol.Parameters.Length; i++)
  306. {
  307. IParameterSymbol? parameter = methodMetadata.Symbol.Parameters[i];
  308. var parameterType = parameter.Type;
  309. var isParameterLuaValue = SymbolEqualityComparer.Default.Equals(parameterType, references.LuaValue);
  310. if (i == methodMetadata.Symbol.Parameters.Length - 1 && SymbolEqualityComparer.Default.Equals(parameterType, references.CancellationToken))
  311. {
  312. hasCancellationToken = true;
  313. break;
  314. }
  315. if (parameter.HasExplicitDefaultValue)
  316. {
  317. var syntax = (ParameterSyntax)parameter.DeclaringSyntaxReferences[0].GetSyntax();
  318. if (isParameterLuaValue)
  319. {
  320. builder.AppendLine($"var arg{index} = context.HasArgument({index}) ? context.GetArgument({index}) : {syntax.Default!.Value.ToFullString()};");
  321. }
  322. else
  323. {
  324. builder.AppendLine($"var arg{index} = context.HasArgument({index}) ? context.GetArgument<{parameterType.ToDisplayString(SymbolDisplayFormat.FullyQualifiedFormat)}>({index}) : {syntax.Default!.Value.ToFullString()};");
  325. }
  326. }
  327. else
  328. {
  329. if (isParameterLuaValue)
  330. {
  331. builder.AppendLine($"var arg{index} = context.GetArgument({index});");
  332. }
  333. else
  334. {
  335. builder.AppendLine($"var arg{index} = context.GetArgument<{parameterType.ToDisplayString(SymbolDisplayFormat.FullyQualifiedFormat)}>({index});");
  336. }
  337. }
  338. index++;
  339. }
  340. if (methodMetadata.HasReturnValue)
  341. {
  342. builder.Append("var result = ");
  343. }
  344. if (methodMetadata.IsAsync)
  345. {
  346. builder.Append("await ", false);
  347. }
  348. if (methodMetadata.IsStatic)
  349. {
  350. builder.Append($"{typeMetadata.FullTypeName}.{methodMetadata.Symbol.Name}(", false);
  351. builder.Append(string.Join(",", Enumerable.Range(0, index).Select(x => $"arg{x}")), false);
  352. if (hasCancellationToken)
  353. {
  354. builder.Append(index > 0?",ct":"ct", false);
  355. }
  356. builder.AppendLine(");", false);
  357. }
  358. else
  359. {
  360. builder.Append($"userData.{methodMetadata.Symbol.Name}(");
  361. builder.Append(string.Join(",", Enumerable.Range(1, index - 1).Select(x => $"arg{x}")), false);
  362. if (hasCancellationToken)
  363. {
  364. builder.Append(index > 1 ? ",ct" : "ct", false);
  365. }
  366. builder.AppendLine(");", false);
  367. }
  368. builder.Append("return ");
  369. if (methodMetadata.HasReturnValue)
  370. {
  371. if (SymbolEqualityComparer.Default.Equals(methodMetadata.Symbol.ReturnType, references.LuaValue))
  372. {
  373. builder.AppendLine(methodMetadata.IsAsync ? "context.Return(result));" : "new global::System.Threading.Tasks.ValueTask<int>(context.Return(result));");
  374. }
  375. else
  376. {
  377. builder.AppendLine(methodMetadata.IsAsync ? "context.Return(new global::Lua.LuaValue(result))));" : "new global::System.Threading.Tasks.ValueTask<int>(context.Return(new global::Lua.LuaValue(result)));");
  378. }
  379. }
  380. else
  381. {
  382. builder.AppendLine(methodMetadata.IsAsync ? "context.Return();" : "new global::System.Threading.Tasks.ValueTask<int>(context.Return());");
  383. }
  384. }
  385. builder.AppendLine(");");
  386. builder.AppendLine();
  387. }
  388. static bool TryEmitMetatable(CodeBuilder builder, IEnumerable<LuaObjectMetamethod> metamethods, in SourceProductionContext context)
  389. {
  390. builder.AppendLine("global::Lua.LuaTable? global::Lua.ILuaUserData.Metatable");
  391. using (builder.BeginBlockScope())
  392. {
  393. builder.AppendLine("get");
  394. using (builder.BeginBlockScope())
  395. {
  396. builder.AppendLine("if (__metatable != null) return __metatable;");
  397. builder.AppendLine();
  398. builder.AppendLine("__metatable = new();");
  399. builder.AppendLine("__metatable[global::Lua.Runtime.Metamethods.Index] = __metamethod_index;");
  400. builder.AppendLine("__metatable[global::Lua.Runtime.Metamethods.NewIndex] = __metamethod_newindex;");
  401. foreach (var metamethod in metamethods)
  402. {
  403. builder.AppendLine($"__metatable[global::Lua.Runtime.Metamethods.{metamethod}] = __metamethod_{metamethod};");
  404. }
  405. builder.AppendLine("return __metatable;");
  406. }
  407. builder.AppendLine("set");
  408. using (builder.BeginBlockScope())
  409. {
  410. builder.AppendLine("__metatable = value;");
  411. }
  412. }
  413. builder.AppendLine("static global::Lua.LuaTable? __metatable;");
  414. builder.AppendLine();
  415. return true;
  416. }
  417. }