EmitCSharp.cs 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666
  1. // #define USENEWTONSOFT
  2. using System;
  3. using System.Collections.Generic;
  4. using System.Linq;
  5. using System.Reflection;
  6. using System.Text;
  7. using static System.FormattableString;
  8. namespace SharpGLTF.CodeGen
  9. {
  10. using SchemaReflection;
  11. /// <summary>
  12. /// Takes a <see cref="SchemaReflection.SchemaType.Context"/> and emits
  13. /// all its enums and classes as c# source code
  14. /// </summary>
  15. class CSharpEmitter
  16. {
  17. #region runtime names
  18. class _RuntimeType
  19. {
  20. internal _RuntimeType(SchemaType t) { _PersistentType = t; }
  21. private readonly SchemaType _PersistentType;
  22. public string RuntimeName { get; set; }
  23. private readonly Dictionary<string, _RuntimeField> _Fields = new Dictionary<string, _RuntimeField>();
  24. private readonly Dictionary<string, _RuntimeEnum> _Enums = new Dictionary<string, _RuntimeEnum>();
  25. public _RuntimeField UseField(FieldInfo finfo)
  26. {
  27. var key = $"{finfo.PersistentName}";
  28. if (_Fields.TryGetValue(key, out _RuntimeField rfield)) return rfield;
  29. rfield = new _RuntimeField(finfo);
  30. _Fields[key] = rfield;
  31. return rfield;
  32. }
  33. public _RuntimeEnum UseEnum(string name)
  34. {
  35. var key = name;
  36. if (_Enums.TryGetValue(key, out _RuntimeEnum renum)) return renum;
  37. renum = new _RuntimeEnum(name);
  38. _Enums[key] = renum;
  39. return renum;
  40. }
  41. }
  42. class _RuntimeEnum
  43. {
  44. internal _RuntimeEnum(string name) { _Name = name; }
  45. private readonly string _Name;
  46. }
  47. class _RuntimeField
  48. {
  49. internal _RuntimeField(FieldInfo f) { _PersistentField = f; }
  50. private readonly FieldInfo _PersistentField;
  51. public string PrivateField { get; set; }
  52. public string PublicProperty { get; set; }
  53. public string CollectionContainer { get; set; }
  54. public string DictionaryContainer { get; set; }
  55. // MinVal, MaxVal, readonly, static
  56. // serialization sections
  57. // deserialization sections
  58. // validation sections
  59. // clone sections
  60. }
  61. private readonly Dictionary<string, _RuntimeType> _Types = new Dictionary<string, _RuntimeType>();
  62. private string _DefaultCollectionContainer = "TItem[]";
  63. #endregion
  64. #region setup & declaration
  65. private string _SanitizeName(string name)
  66. {
  67. return name.Replace(" ", "");
  68. }
  69. private _RuntimeType _UseType(SchemaType stype)
  70. {
  71. var key = $"{stype.PersistentName}";
  72. if (_Types.TryGetValue(key, out _RuntimeType rtype)) return rtype;
  73. rtype = new _RuntimeType(stype)
  74. {
  75. RuntimeName = _SanitizeName(stype.PersistentName)
  76. };
  77. _Types[key] = rtype;
  78. return rtype;
  79. }
  80. private _RuntimeField _UseField(FieldInfo finfo) { return _UseType(finfo.DeclaringClass).UseField(finfo); }
  81. public void SetRuntimeName(SchemaType stype, string newName) { _UseType(stype).RuntimeName = newName; }
  82. public void SetRuntimeName(string persistentName, string runtimeName)
  83. {
  84. if (!_Types.TryGetValue(persistentName, out _RuntimeType t)) return;
  85. t.RuntimeName = runtimeName;
  86. }
  87. public void SetFieldName(FieldInfo finfo, string name) { _UseField(finfo).PrivateField = name; }
  88. public string GetFieldRuntimeName(FieldInfo finfo) { return _UseField(finfo).PrivateField; }
  89. public void SetPropertyName(FieldInfo finfo, string name) { _UseField(finfo).PublicProperty = name; }
  90. public string GetPropertyName(FieldInfo finfo) { return _UseField(finfo).PublicProperty; }
  91. public void SetCollectionContainer(string container) { _DefaultCollectionContainer = container; }
  92. public void SetCollectionContainer(FieldInfo finfo, string container) { _UseField(finfo).CollectionContainer = container; }
  93. public void DeclareClass(ClassType type)
  94. {
  95. _UseType(type);
  96. foreach(var f in type.Fields)
  97. {
  98. var runtimeName = _SanitizeName(f.PersistentName).Replace("@","at");
  99. SetFieldName(f, $"_{runtimeName}");
  100. SetPropertyName(f, runtimeName);
  101. }
  102. }
  103. public void DeclareEnum(EnumType type)
  104. {
  105. _UseType(type);
  106. foreach (var f in type.Values)
  107. {
  108. // SetFieldName(f, $"_{runtimeName}");
  109. // SetPropertyName(f, runtimeName);
  110. }
  111. }
  112. public void DeclareContext(SchemaType.Context context)
  113. {
  114. foreach(var ctype in context.Classes)
  115. {
  116. DeclareClass(ctype);
  117. }
  118. foreach (var etype in context.Enumerations)
  119. {
  120. DeclareEnum(etype);
  121. }
  122. }
  123. internal string _GetRuntimeName(SchemaType type) { return _GetRuntimeName(type, null); }
  124. private string _GetRuntimeName(SchemaType type, _RuntimeField extra)
  125. {
  126. switch (type)
  127. {
  128. case ObjectType anyType: return anyType.PersistentName;
  129. case StringType strType: return strType.PersistentName;
  130. case BlittableType blitType:
  131. {
  132. var tname = blitType.DataType.Name;
  133. return blitType.IsNullable ? $"{tname}?" : tname;
  134. }
  135. case ArrayType arrayType:
  136. {
  137. var container = extra?.CollectionContainer;
  138. if (string.IsNullOrWhiteSpace(container)) container = _DefaultCollectionContainer;
  139. return container.Replace("TItem", _GetRuntimeName(arrayType.ItemType));
  140. }
  141. case DictionaryType dictType:
  142. {
  143. var key = _GetRuntimeName(dictType.KeyType);
  144. var val = _GetRuntimeName(dictType.ValueType);
  145. return $"Dictionary<{key},{val}>";
  146. }
  147. case EnumType enumType: return _UseType(enumType).RuntimeName;
  148. case ClassType classType: return _UseType(classType).RuntimeName;
  149. default: throw new NotImplementedException();
  150. }
  151. }
  152. private string _GetConstantRuntimeName(SchemaType type)
  153. {
  154. switch (type)
  155. {
  156. case StringType strType: return $"const {typeof(string).Name}";
  157. case BlittableType blitType:
  158. {
  159. var tname = blitType.DataType.Name;
  160. if (blitType.DataType == typeof(int)) return $"const {tname}";
  161. if (blitType.DataType == typeof(float)) return $"const {tname}";
  162. if (blitType.DataType == typeof(double)) return $"const {tname}";
  163. return $"static readonly {tname}";
  164. }
  165. case EnumType enumType: return $"const {_UseType(enumType).RuntimeName}";
  166. case ArrayType aType: return $"static readonly {_UseType(aType).RuntimeName}";
  167. default: throw new NotImplementedException();
  168. }
  169. }
  170. private Object _GetConstantRuntimeValue(SchemaType type, Object value)
  171. {
  172. if (value == null) throw new ArgumentNullException();
  173. switch (type)
  174. {
  175. case StringType stype: if (value is string) return value;
  176. return value == null
  177. ? null
  178. : Convert.ChangeType(value, typeof(string), System.Globalization.CultureInfo.InvariantCulture);
  179. case BlittableType btype:
  180. {
  181. if (btype.DataType == typeof(bool).GetTypeInfo())
  182. {
  183. if (value is bool) return value;
  184. var str = value as string;
  185. if (str.ToLowerInvariant() == "false") return false;
  186. if (str.ToLowerInvariant() == "true") return true;
  187. throw new NotImplementedException();
  188. }
  189. if (value is string) return value;
  190. return value == null
  191. ? null
  192. : Convert.ChangeType(value, btype.DataType.AsType(), System.Globalization.CultureInfo.InvariantCulture);
  193. }
  194. case EnumType etype:
  195. {
  196. var etypeName = _GetRuntimeName(type);
  197. if (value is string) return $"{etypeName}.{value}";
  198. else return $"({etypeName}){value}";
  199. }
  200. case ArrayType aType:
  201. {
  202. var atypeName = _GetRuntimeName(type);
  203. return value.ToString();
  204. }
  205. default: throw new NotImplementedException();
  206. }
  207. }
  208. #endregion
  209. #region emit
  210. public string EmitContext(SchemaType.Context context)
  211. {
  212. var sb = new StringBuilder();
  213. sb.AppendLine("// <auto-generated/>");
  214. sb.AppendLine();
  215. sb.AppendLine("//------------------------------------------------------------------------------------------------");
  216. sb.AppendLine("// This file has been programatically generated; DON´T EDIT!");
  217. sb.AppendLine("//------------------------------------------------------------------------------------------------");
  218. sb.AppendLine();
  219. sb.AppendLine("#pragma warning disable SA1001");
  220. sb.AppendLine("#pragma warning disable SA1027");
  221. sb.AppendLine("#pragma warning disable SA1028");
  222. sb.AppendLine("#pragma warning disable SA1121");
  223. sb.AppendLine("#pragma warning disable SA1205");
  224. sb.AppendLine("#pragma warning disable SA1309");
  225. sb.AppendLine("#pragma warning disable SA1402");
  226. sb.AppendLine("#pragma warning disable SA1505");
  227. sb.AppendLine("#pragma warning disable SA1507");
  228. sb.AppendLine("#pragma warning disable SA1508");
  229. sb.AppendLine("#pragma warning disable SA1652");
  230. sb.AppendLine();
  231. sb.AppendLine("using System;");
  232. sb.AppendLine("using System.Collections.Generic;");
  233. sb.AppendLine("using System.Linq;");
  234. sb.AppendLine("using System.Text;");
  235. sb.AppendLine("using System.Numerics;");
  236. #if USENEWTONSOFT
  237. sb.AppendLine("using Newtonsoft.Json;");
  238. #else
  239. sb.AppendLine("using System.Text.Json;");
  240. #endif
  241. sb.AppendLine();
  242. sb.AppendLine($"namespace {Constants.OutputNamespace}");
  243. sb.AppendLine("{");
  244. sb.AppendLine("using Collections;".Indent(1));
  245. sb.AppendLine();
  246. foreach (var etype in context.Enumerations)
  247. {
  248. var cout = EmitEnum(etype);
  249. sb.AppendLine(cout);
  250. sb.AppendLine();
  251. }
  252. foreach (var ctype in context.Classes)
  253. {
  254. if (ctype.IgnoredByEmitter) continue;
  255. var cout = EmitClass(ctype);
  256. sb.AppendLine(cout);
  257. sb.AppendLine();
  258. }
  259. sb.AppendLine("}");
  260. return sb.ToString();
  261. }
  262. public string EmitEnum(EnumType type)
  263. {
  264. var sb = new StringBuilder();
  265. foreach (var l in type.Description.EmitSummary(0)) sb.EmitLine(1, l);
  266. sb.EmitLine(1, $"public enum {_GetRuntimeName(type)}");
  267. sb.EmitLine(1, "{");
  268. if (type.UseIntegers)
  269. {
  270. foreach (var kvp in type.Values)
  271. {
  272. var k = kvp.Key;
  273. sb.EmitLine(2, $"{k} = {kvp.Value},");
  274. }
  275. }
  276. else
  277. {
  278. foreach (var kvp in type.Values)
  279. {
  280. var k = kvp.Key;
  281. sb.EmitLine(2, $"{k},");
  282. }
  283. }
  284. sb.EmitLine(1, "}");
  285. return sb.ToString();
  286. }
  287. public string EmitClass(ClassType type)
  288. {
  289. var xclass = new CSharpClassEmitter(this)
  290. {
  291. ClassSummary = type.Description,
  292. ClassDeclaration = _GetClassDeclaration(type),
  293. HasBaseClass = type.BaseClass != null
  294. };
  295. xclass.AddFields(type);
  296. return String.Join("\r\n",xclass.EmitCode().Indent(1));
  297. }
  298. private string _GetClassDeclaration(ClassType type)
  299. {
  300. var classDecl = string.Empty;
  301. classDecl += "partial ";
  302. classDecl += "class ";
  303. classDecl += _GetRuntimeName(type);
  304. if (type.BaseClass != null) classDecl += $" : {_GetRuntimeName(type.BaseClass)}";
  305. return classDecl;
  306. }
  307. internal IEnumerable<string> _GetClassField(FieldInfo f)
  308. {
  309. var tdecl = _GetRuntimeName(f.FieldType, _UseField(f));
  310. var fname = GetFieldRuntimeName(f);
  311. string defval = string.Empty;
  312. if (f.DefaultValue != null)
  313. {
  314. var tconst = _GetConstantRuntimeName(f.FieldType);
  315. var vconst = _GetConstantRuntimeValue(f.FieldType, f.DefaultValue);
  316. // fix boolean value
  317. if (vconst is Boolean bconst) vconst = bconst ? "true" : "false";
  318. defval = $"{fname}Default";
  319. yield return Invariant($"private {tconst} {defval} = {vconst};");
  320. }
  321. if (f.ExclusiveMinimumValue != null)
  322. {
  323. var tconst = _GetConstantRuntimeName(f.FieldType);
  324. var vconst = _GetConstantRuntimeValue(f.FieldType, f.ExclusiveMinimumValue);
  325. yield return Invariant($"private {tconst} {fname}ExclusiveMinimum = {vconst};");
  326. }
  327. if (f.InclusiveMinimumValue != null)
  328. {
  329. var tconst = _GetConstantRuntimeName(f.FieldType);
  330. var vconst = _GetConstantRuntimeValue(f.FieldType, f.InclusiveMinimumValue);
  331. yield return Invariant($"private {tconst} {fname}Minimum = {vconst};");
  332. }
  333. if (f.InclusiveMaximumValue != null)
  334. {
  335. var tconst = _GetConstantRuntimeName(f.FieldType);
  336. var vconst = _GetConstantRuntimeValue(f.FieldType, f.InclusiveMaximumValue);
  337. yield return Invariant($"private {tconst} {fname}Maximum = {vconst};");
  338. }
  339. if (f.ExclusiveMaximumValue != null)
  340. {
  341. var tconst = _GetConstantRuntimeName(f.FieldType);
  342. var vconst = _GetConstantRuntimeValue(f.FieldType, f.ExclusiveMaximumValue);
  343. yield return Invariant($"private {tconst} {fname}ExclusiveMaximum = {vconst};");
  344. }
  345. if (f.MinItems > 0)
  346. {
  347. yield return $"private const int {fname}MinItems = {f.MinItems};";
  348. }
  349. if (f.MaxItems > 0 && f.MaxItems < int.MaxValue)
  350. {
  351. yield return $"private const int {fname}MaxItems = {f.MaxItems};";
  352. }
  353. if (f.FieldType is EnumType etype && etype.IsNullable) tdecl = tdecl + "?";
  354. yield return string.IsNullOrEmpty(defval) ? $"private {tdecl} {fname};" : $"private {tdecl} {fname} = {defval};";
  355. yield return string.Empty;
  356. }
  357. #endregion
  358. }
  359. /// <summary>
  360. /// Utility class to emit a <see cref="SchemaReflection.ClassType"/>
  361. /// as c# source code
  362. /// </summary>
  363. class CSharpClassEmitter
  364. {
  365. #region constructor
  366. public CSharpClassEmitter(CSharpEmitter emitter)
  367. {
  368. _Emitter = emitter;
  369. }
  370. #endregion
  371. #region data
  372. private readonly CSharpEmitter _Emitter;
  373. private readonly List<string> _Fields = new List<string>();
  374. private readonly List<string> _SerializerBody = new List<string>();
  375. private readonly List<string> _DeserializerSwitchBody = new List<string>();
  376. public string ClassSummary { get; set; }
  377. public string ClassDeclaration { get; set; }
  378. public bool HasBaseClass { get; set; }
  379. private const string _READERMODIFIER = "ref ";
  380. #endregion
  381. #region API
  382. public void AddFields(ClassType type)
  383. {
  384. foreach (var f in type.Fields)
  385. {
  386. var trname = _Emitter._GetRuntimeName(f.FieldType);
  387. var frname = _Emitter.GetFieldRuntimeName(f);
  388. _Fields.AddRange(_Emitter._GetClassField(f));
  389. if (f.FieldType is EnumType etype)
  390. {
  391. // emit serializer
  392. var smethod = etype.UseIntegers ? "SerializePropertyEnumValue" : "SerializePropertyEnumSymbol";
  393. smethod = $"{smethod}<{trname}>(writer, \"{f.PersistentName}\", {frname}";
  394. if (f.DefaultValue != null) smethod += $", {frname}Default";
  395. smethod += ");";
  396. this.AddFieldSerializerCase(smethod);
  397. // emit deserializer
  398. this.AddFieldDeserializerCase(f.PersistentName, $"{frname} = DeserializePropertyValue<{_Emitter._GetRuntimeName(etype)}>({_READERMODIFIER}reader);");
  399. continue;
  400. }
  401. this.AddFieldSerializerCase(_GetJSonSerializerMethod(f));
  402. this.AddFieldDeserializerCase(f.PersistentName, _GetJSonDeserializerMethod(f));
  403. }
  404. }
  405. private string _GetJSonSerializerMethod(FieldInfo f)
  406. {
  407. var pname = f.PersistentName;
  408. var fname = _Emitter.GetFieldRuntimeName(f);
  409. if (f.FieldType is ClassType ctype)
  410. {
  411. return $"SerializePropertyObject(writer, \"{pname}\", {fname});";
  412. }
  413. if (f.FieldType is ArrayType atype)
  414. {
  415. if (f.MinItems > 0) return $"SerializeProperty(writer, \"{pname}\", {fname}, {fname}MinItems);";
  416. return $"SerializeProperty(writer,\"{pname}\",{fname});";
  417. }
  418. if (f.DefaultValue != null) return $"SerializeProperty(writer, \"{pname}\", {fname}, {fname}Default);";
  419. return $"SerializeProperty(writer, \"{pname}\", {fname});";
  420. }
  421. private string _GetJSonDeserializerMethod(FieldInfo f)
  422. {
  423. var fname = _Emitter.GetFieldRuntimeName(f);
  424. if (f.FieldType is ArrayType atype)
  425. {
  426. var titem = _Emitter._GetRuntimeName(atype.ItemType);
  427. return $"DeserializePropertyList<{titem}>({_READERMODIFIER}reader, {fname});";
  428. }
  429. else if (f.FieldType is DictionaryType dtype)
  430. {
  431. var titem = _Emitter._GetRuntimeName(dtype.ValueType);
  432. return $"DeserializePropertyDictionary<{titem}>({_READERMODIFIER}reader, {fname});";
  433. }
  434. return $"{fname} = DeserializePropertyValue<{_Emitter._GetRuntimeName(f.FieldType)}>({_READERMODIFIER}reader);";
  435. }
  436. public void AddFieldSerializerCase(string line) { _SerializerBody.Add(line); }
  437. public void AddFieldDeserializerCase(string persistentName, string line)
  438. {
  439. _DeserializerSwitchBody.Add($"case \"{persistentName}\": {line} break;");
  440. }
  441. public IEnumerable<string> EmitCode()
  442. {
  443. #if USENEWTONSOFT
  444. var readerType = "JsonReader";
  445. var writerType = "JsonWriter";
  446. #else
  447. var readerType = "ref Utf8JsonReader";
  448. var writerType = "Utf8JsonWriter";
  449. #endif
  450. foreach (var l in ClassSummary.EmitSummary(0)) yield return l;
  451. yield return "#if NET6_0_OR_GREATER";
  452. yield return "[System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructors | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)]";
  453. yield return "#endif";
  454. yield return "[global::System.CodeDom.Compiler.GeneratedCodeAttribute(\"SharpGLTF.CodeGen\", \"1.0.0.0\")]";
  455. yield return ClassDeclaration;
  456. yield return "{";
  457. yield return string.Empty;
  458. foreach (var l in _Fields.Indent(1)) yield return l;
  459. yield return string.Empty;
  460. // yield return "/// <inheritdoc />".Indent(1);
  461. yield return $"protected override void SerializeProperties({writerType} writer)".Indent(1);
  462. yield return "{".Indent(1);
  463. if (HasBaseClass) yield return "base.SerializeProperties(writer);".Indent(2);
  464. foreach (var l in _SerializerBody.Indent(2)) yield return l;
  465. yield return "}".Indent(1);
  466. yield return string.Empty;
  467. // yield return "/// <inheritdoc />".Indent(1);
  468. yield return $"protected override void DeserializeProperty(string jsonPropertyName, {readerType} reader)".Indent(1);
  469. yield return "{".Indent(1);
  470. yield return "switch (jsonPropertyName)".Indent(2);
  471. yield return "{".Indent(2);
  472. foreach (var l in _DeserializerSwitchBody.Indent(3)) yield return l;
  473. if (HasBaseClass) yield return $"default: base.DeserializeProperty(jsonPropertyName,{_READERMODIFIER}reader); break;".Indent(3);
  474. else yield return "default: throw new NotImplementedException();".Indent(3);
  475. yield return "}".Indent(2);
  476. yield return "}".Indent(1);
  477. yield return string.Empty;
  478. yield return "}";
  479. }
  480. #endregion
  481. }
  482. }