Major refactor: TypePrinter: improve modular design + cleanup (#1796)

deadlocklogic · web-flow · commit 8c2da6d542d3 · 2023-11-13T20:00:41.000Z
diff --git a/src/Generator/Generator.cs b/src/Generator/Generator.cs
@@ -28,9 +28,12 @@ public abstract class Generator : IDisposable
     {
         public BindingContext Context { get; }
 
+        protected readonly TypePrinter typePrinter;
+
         protected Generator(BindingContext context)
         {
             Context = context;
+            typePrinter = Context.Options.GeneratorKind.CreateTypePrinter(context);
             CppSharp.AST.Type.TypePrinterDelegate += TypePrinterDelegate;
         }
 
@@ -155,7 +158,10 @@ public virtual GeneratorOutput GenerateModule(Module module)
             return output;
         }
 
-        protected abstract string TypePrinterDelegate(CppSharp.AST.Type type);
+        protected virtual string TypePrinterDelegate(CppSharp.AST.Type type)
+        {
+            return type.Visit(typePrinter);
+        }
 
         public static string GeneratedIdentifier(string id) =>
             $"__{(id.StartsWith("@") ? id.Substring(1) : id)}";
diff --git a/src/Generator/GeneratorKind.cs b/src/Generator/GeneratorKind.cs
@@ -20,25 +20,32 @@ public class GeneratorKind : IEquatable<GeneratorKind>
 
         public string ID { get; }
         public string Name { get; }
-        public System.Type Type { get; }
+        public System.Type GeneratorType { get; }
+        public System.Type TypePrinterType { get; }
         public string[] CLIOptions { get; }
 
-        public GeneratorKind(string id, string name, System.Type type, string[] cLIOptions = null)
+        public GeneratorKind(string id, string name, System.Type generatorType, System.Type typePrinterType, string[] cLIOptions = null)
         {
             if (Registered.Any(kind => kind.ID == id))
             {
                 throw new Exception($"GeneratorKind has an already registered ID: {ID}");
             }
             ID = id;
             Name = name;
-            Type = type;
+            GeneratorType = generatorType;
+            TypePrinterType = typePrinterType;
             CLIOptions = cLIOptions;
             Registered.Add(this);
         }
 
         public Generator CreateGenerator(BindingContext context)
         {
-            return (Generator)Activator.CreateInstance(Type, context);
+            return (Generator)Activator.CreateInstance(GeneratorType, context);
+        }
+
+        public TypePrinter CreateTypePrinter(BindingContext context)
+        {
+            return (TypePrinter)Activator.CreateInstance(TypePrinterType, context);
         }
 
         public bool IsCLIOptionMatch(string cliOption)
@@ -93,37 +100,44 @@ public override int GetHashCode()
         }
 
         public const string CLI_ID = "CLI";
-        public static readonly GeneratorKind CLI = new(CLI_ID, "C++/CLI", typeof(CLIGenerator), new[] { "cli" });
+        public static readonly GeneratorKind CLI = new(CLI_ID, "C++/CLI", typeof(CLIGenerator), typeof(CLITypePrinter), new[] { "cli" });
 
         public const string CSharp_ID = "CSharp";
-        public static readonly GeneratorKind CSharp = new(CSharp_ID, "C#", typeof(CSharpGenerator), new[] { "csharp" });
+        public static readonly GeneratorKind CSharp = new(CSharp_ID, "C#", typeof(CSharpGenerator), typeof(CSharpTypePrinter), new[] { "csharp" });
 
         public const string C_ID = "C";
-        public static readonly GeneratorKind C = new(C_ID, "C", typeof(CGenerator), new[] { "c" });
+        public static readonly GeneratorKind C = new(C_ID, "C", typeof(CGenerator), typeof(CppTypePrinter), new[] { "c" });
 
         public const string CPlusPlus_ID = "CPlusPlus";
-        public static readonly GeneratorKind CPlusPlus = new(CPlusPlus_ID, "CPlusPlus", typeof(CppGenerator), new[] { "cpp" });
+        public static readonly GeneratorKind CPlusPlus = new(CPlusPlus_ID, "CPlusPlus", typeof(CppGenerator), typeof(CppTypePrinter), new[] { "cpp" });
 
         public const string Emscripten_ID = "Emscripten";
-        public static readonly GeneratorKind Emscripten = new(Emscripten_ID, "Emscripten", typeof(EmscriptenGenerator), new[] { "emscripten" });
+        public static readonly GeneratorKind Emscripten = new(Emscripten_ID, "Emscripten", typeof(EmscriptenGenerator), typeof(EmscriptenTypePrinter), new[] { "emscripten" });
 
         public const string ObjectiveC_ID = "ObjectiveC";
-        public static readonly GeneratorKind ObjectiveC = new(ObjectiveC_ID, "ObjectiveC", typeof(NotImplementedGenerator));
+        public static readonly GeneratorKind ObjectiveC = new(ObjectiveC_ID, "ObjectiveC", typeof(NotImplementedGenerator), typeof(NotImplementedTypePrinter));
 
         public const string Java_ID = "Java";
-        public static readonly GeneratorKind Java = new(Java_ID, "Java", typeof(NotImplementedGenerator));
+        public static readonly GeneratorKind Java = new(Java_ID, "Java", typeof(NotImplementedGenerator), typeof(NotImplementedTypePrinter));
 
         public const string Swift_ID = "Swift";
-        public static readonly GeneratorKind Swift = new(Swift_ID, "Swift", typeof(NotImplementedGenerator));
+        public static readonly GeneratorKind Swift = new(Swift_ID, "Swift", typeof(NotImplementedGenerator), typeof(NotImplementedTypePrinter));
 
         public const string QuickJS_ID = "QuickJS";
-        public static readonly GeneratorKind QuickJS = new(QuickJS_ID, "QuickJS", typeof(QuickJSGenerator), new[] { "qjs" });
+        public static readonly GeneratorKind QuickJS = new(QuickJS_ID, "QuickJS", typeof(QuickJSGenerator), typeof(QuickJSTypePrinter), new[] { "qjs" });
 
         public const string NAPI_ID = "NAPI";
-        public static readonly GeneratorKind NAPI = new(NAPI_ID, "N-API", typeof(NAPIGenerator), new[] { "napi" });
+        public static readonly GeneratorKind NAPI = new(NAPI_ID, "N-API", typeof(NAPIGenerator), typeof(NAPITypePrinter), new[] { "napi" });
 
         public const string TypeScript_ID = "TypeScript";
-        public static readonly GeneratorKind TypeScript = new(TypeScript_ID, "TypeScript", typeof(TSGenerator), new[] { "ts", "typescript" });
+        public static readonly GeneratorKind TypeScript = new(TypeScript_ID, "TypeScript", typeof(TSGenerator), typeof(TSTypePrinter), new[] { "ts", "typescript" });
+    }
+
+    public class NotImplementedTypePrinter : TypePrinter
+    {
+        public NotImplementedTypePrinter(BindingContext context) : base(context)
+        {
+        }
     }
 
     public class NotImplementedGenerator : Generator
@@ -142,10 +156,5 @@ public override bool SetupPasses()
         {
             throw new NotImplementedException();
         }
-
-        protected override string TypePrinterDelegate(CppSharp.AST.Type type)
-        {
-            throw new NotImplementedException();
-        }
     }
 }
diff --git a/src/Generator/Generators/C/CGenerator.cs b/src/Generator/Generators/C/CGenerator.cs
@@ -10,11 +10,8 @@ namespace CppSharp.Generators.C
     /// </summary>
     public class CGenerator : Generator
     {
-        private readonly CppTypePrinter typePrinter;
-
         public CGenerator(BindingContext context) : base(context)
         {
-            typePrinter = new CppTypePrinter(Context);
         }
 
         public override List<CodeGenerator> Generate(IEnumerable<TranslationUnit> units)
@@ -31,10 +28,5 @@ public override List<CodeGenerator> Generate(IEnumerable<TranslationUnit> units)
         }
 
         public override bool SetupPasses() => true;
-
-        protected override string TypePrinterDelegate(Type type)
-        {
-            return type.Visit(typePrinter).ToString();
-        }
     }
 }
diff --git a/src/Generator/Generators/C/CppGenerator.cs b/src/Generator/Generators/C/CppGenerator.cs
@@ -11,11 +11,8 @@ namespace CppSharp.Generators.Cpp
     /// </summary>
     public class CppGenerator : CGenerator
     {
-        private readonly CppTypePrinter typePrinter;
-
         public CppGenerator(BindingContext context) : base(context)
         {
-            typePrinter = new CppTypePrinter(Context);
         }
 
         public override List<CodeGenerator> Generate(IEnumerable<TranslationUnit> units)
@@ -44,11 +41,6 @@ public static bool ShouldGenerateClassNativeInstanceField(Class @class)
 
             return @class.IsRefType && (!@class.HasBase || !@class.HasRefBase());
         }
-
-        protected override string TypePrinterDelegate(Type type)
-        {
-            return type.Visit(typePrinter).ToString();
-        }
     }
 
     /// <summary>
diff --git a/src/Generator/Generators/C/CppTypePrinter.cs b/src/Generator/Generators/C/CppTypePrinter.cs
@@ -28,18 +28,13 @@ public class CppTypePrinter : TypePrinter
 
         public TypePrintScopeKind MethodScopeKind = TypePrintScopeKind.Qualified;
 
-        public CppTypePrinter() : base(TypePrinterContextKind.Native)
+        public CppTypePrinter(BindingContext context) : base(context, TypePrinterContextKind.Native)
         {
             PrintFlavorKind = CppTypePrintFlavorKind.Cpp;
             PrintTypeQualifiers = true;
             PrintTypeModifiers = true;
         }
 
-        public CppTypePrinter(BindingContext context) : this()
-        {
-            Context = context;
-        }
-
         public TypeMapDatabase TypeMapDatabase => Context.TypeMaps;
         public DriverOptions Options => Context.Options;
 
diff --git a/src/Generator/Generators/CLI/CLIGenerator.cs b/src/Generator/Generators/CLI/CLIGenerator.cs
@@ -10,11 +10,8 @@ namespace CppSharp.Generators.CLI
     /// </summary>
     public class CLIGenerator : Generator
     {
-        private readonly CppTypePrinter typePrinter;
-
         public CLIGenerator(BindingContext context) : base(context)
         {
-            typePrinter = new CLITypePrinter(context);
         }
 
         public override List<CodeGenerator> Generate(IEnumerable<TranslationUnit> units)
@@ -39,10 +36,5 @@ public static bool ShouldGenerateClassNativeField(Class @class)
 
             return @class.IsRefType && (!@class.NeedsBase || !@class.HasRefBase());
         }
-
-        protected override string TypePrinterDelegate(Type type)
-        {
-            return type.Visit(typePrinter).ToString();
-        }
     }
 }
diff --git a/src/Generator/Generators/CSharp/CSharpGenerator.cs b/src/Generator/Generators/CSharp/CSharpGenerator.cs
@@ -7,18 +7,15 @@ namespace CppSharp.Generators.CSharp
 {
     public class CSharpGenerator : Generator
     {
-        private readonly CSharpTypePrinter typePrinter;
-
         public CSharpGenerator(BindingContext context) : base(context)
         {
-            typePrinter = new CSharpTypePrinter(context);
         }
 
         public override List<CodeGenerator> Generate(IEnumerable<TranslationUnit> units)
         {
             var outputs = new List<CodeGenerator>();
 
-            var gen = new CSharpSources(Context, units) { TypePrinter = typePrinter };
+            var gen = new CSharpSources(Context, units) { TypePrinter = (CSharpTypePrinter)typePrinter };
             outputs.Add(gen);
 
             return outputs;
@@ -42,10 +39,5 @@ public override bool SetupPasses()
 
             return true;
         }
-
-        protected override string TypePrinterDelegate(Type type)
-        {
-            return type.Visit(typePrinter);
-        }
     }
 }
diff --git a/src/Generator/Generators/CSharp/CSharpTypePrinter.cs b/src/Generator/Generators/CSharp/CSharpTypePrinter.cs
@@ -21,15 +21,10 @@ public class CSharpTypePrinter : TypePrinter
 
         public bool PrintModuleOutputNamespace = true;
 
-        public CSharpTypePrinter()
+        public CSharpTypePrinter(BindingContext context) : base(context)
         {
         }
 
-        public CSharpTypePrinter(BindingContext context)
-        {
-            Context = context;
-        }
-
         public string QualifiedType(string name)
         {
             return IsGlobalQualifiedScope ? $"global::{name}" : name;
diff --git a/src/Generator/Generators/Marshal.cs b/src/Generator/Generators/Marshal.cs
@@ -1,13 +1,13 @@
 ﻿using CppSharp.AST;
 using CppSharp.Generators.C;
+using System;
 
 namespace CppSharp.Generators
 {
     public class MarshalContext : TypePrinter
     {
-        public MarshalContext(BindingContext context, uint indentation)
+        public MarshalContext(BindingContext context, uint indentation) : base(context)
         {
-            Context = context;
             Before = new TextGenerator { CurrentIndentation = indentation };
             Return = new TextGenerator { CurrentIndentation = indentation };
             Cleanup = new TextGenerator { CurrentIndentation = indentation };
@@ -34,16 +34,16 @@ public MarshalContext(BindingContext context, uint indentation)
         public uint Indentation { get; }
     }
 
-    public abstract class MarshalPrinter<C, P> : AstVisitor where C : MarshalContext where P : TypePrinter, new()
+    public abstract class MarshalPrinter<C, P> : AstVisitor where C : MarshalContext where P : TypePrinter
     {
         public C Context { get; }
 
         protected MarshalPrinter(C ctx)
         {
             Context = ctx;
-            typePrinter.Context = ctx.Context;
+            typePrinter = (P)Activator.CreateInstance(typeof(P), ctx.Context);
         }
 
-        protected P typePrinter = new P();
+        protected P typePrinter;
     }
 }
diff --git a/src/Generator/Generators/NAPI/NAPITypePrinter.cs b/src/Generator/Generators/NAPI/NAPITypePrinter.cs
@@ -0,0 +1,11 @@
+using CppSharp.Generators.C;
+
+namespace CppSharp.Generators.C
+{
+    public class NAPITypePrinter : CppTypePrinter
+    {
+        public NAPITypePrinter(BindingContext context) : base(context)
+        {
+        }
+    }
+}
diff --git a/src/Generator/Generators/TS/TSGenerator.cs b/src/Generator/Generators/TS/TSGenerator.cs
@@ -11,11 +11,8 @@ namespace CppSharp.Generators.TS
     /// </summary>
     public class TSGenerator : CGenerator
     {
-        private readonly TSTypePrinter typePrinter;
-
         public TSGenerator(BindingContext context) : base(context)
         {
-            typePrinter = new TSTypePrinter(Context);
         }
 
         public override List<CodeGenerator> Generate(IEnumerable<TranslationUnit> units)
@@ -32,10 +29,5 @@ public override bool SetupPasses()
         {
             return true;
         }
-
-        protected override string TypePrinterDelegate(Type type)
-        {
-            return type.Visit(typePrinter).ToString();
-        }
     }
 }
diff --git a/src/Generator/Generators/TypePrinter.cs b/src/Generator/Generators/TypePrinter.cs
@@ -64,8 +64,9 @@ public class TypePrinter : ITypePrinter<TypePrinterResult>,
         public TypePrintScopeKind ScopeKind => scopeKinds.Peek();
         public bool IsGlobalQualifiedScope => ScopeKind == TypePrintScopeKind.GlobalQualified;
 
-        public TypePrinter(TypePrinterContextKind contextKind = TypePrinterContextKind.Managed)
+        public TypePrinter(BindingContext context, TypePrinterContextKind contextKind = TypePrinterContextKind.Managed)
         {
+            Context = context;
             contexts = new Stack<TypePrinterContextKind>();
             marshalKinds = new Stack<MarshalKind>();
             scopeKinds = new Stack<TypePrintScopeKind>();
diff --git a/src/Generator/Passes/CheckDuplicatedNamesPass.cs b/src/Generator/Passes/CheckDuplicatedNamesPass.cs

Original file line number	Diff line number	Diff line change
`@@ -28,9 +28,12 @@ public abstract class Generator : IDisposable`
`28`	`28`	`{`
`29`	`29`	`public BindingContext Context { get; }`
`30`	`30`
	`31`	`+ protected readonly TypePrinter typePrinter;`
	`32`	`+`
`31`	`33`	`protected Generator(BindingContext context)`
`32`	`34`	`{`
`33`	`35`	`Context = context;`
	`36`	`+ typePrinter = Context.Options.GeneratorKind.CreateTypePrinter(context);`
`34`	`37`	`CppSharp.AST.Type.TypePrinterDelegate += TypePrinterDelegate;`
`35`	`38`	`}`
`36`	`39`
`@@ -155,7 +158,10 @@ public virtual GeneratorOutput GenerateModule(Module module)`
`155`	`158`	`return output;`
`156`	`159`	`}`
`157`	`160`
`158`		`- protected abstract string TypePrinterDelegate(CppSharp.AST.Type type);`
	`161`	`+ protected virtual string TypePrinterDelegate(CppSharp.AST.Type type)`
	`162`	`+ {`
	`163`	`+ return type.Visit(typePrinter);`
	`164`	`+ }`
`159`	`165`
`160`	`166`	`public static string GeneratedIdentifier(string id) =>`
`161`	`167`	`$"__{(id.StartsWith("@") ? id.Substring(1) : id)}";`
Original file line number	Diff line number	Diff line change
`@@ -10,11 +10,8 @@ namespace CppSharp.Generators.C`
`10`	`10`	`/// </summary>`
`11`	`11`	`public class CGenerator : Generator`
`12`	`12`	`{`
`13`		`- private readonly CppTypePrinter typePrinter;`
`14`		`-`
`15`	`13`	`public CGenerator(BindingContext context) : base(context)`
`16`	`14`	`{`
`17`		`- typePrinter = new CppTypePrinter(Context);`
`18`	`15`	`}`
`19`	`16`
`20`	`17`	`public override List<CodeGenerator> Generate(IEnumerable<TranslationUnit> units)`
`@@ -31,10 +28,5 @@ public override List<CodeGenerator> Generate(IEnumerable<TranslationUnit> units)`
`31`	`28`	`}`
`32`	`29`
`33`	`30`	`public override bool SetupPasses() => true;`
`34`		`-`
`35`		`- protected override string TypePrinterDelegate(Type type)`
`36`		`- {`
`37`		`- return type.Visit(typePrinter).ToString();`
`38`		`- }`
`39`	`31`	`}`
`40`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,11 +11,8 @@ namespace CppSharp.Generators.Cpp`
`11`	`11`	`/// </summary>`
`12`	`12`	`public class CppGenerator : CGenerator`
`13`	`13`	`{`
`14`		`- private readonly CppTypePrinter typePrinter;`
`15`		`-`
`16`	`14`	`public CppGenerator(BindingContext context) : base(context)`
`17`	`15`	`{`
`18`		`- typePrinter = new CppTypePrinter(Context);`
`19`	`16`	`}`
`20`	`17`
`21`	`18`	`public override List<CodeGenerator> Generate(IEnumerable<TranslationUnit> units)`
`@@ -44,11 +41,6 @@ public static bool ShouldGenerateClassNativeInstanceField(Class @class)`
`44`	`41`
`45`	`42`	`return @class.IsRefType && (!@class.HasBase \|\| !@class.HasRefBase());`
`46`	`43`	`}`
`47`		`-`
`48`		`- protected override string TypePrinterDelegate(Type type)`
`49`		`- {`
`50`		`- return type.Visit(typePrinter).ToString();`
`51`		`- }`
`52`	`44`	`}`
`53`	`45`
`54`	`46`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -7,18 +7,15 @@ namespace CppSharp.Generators.CSharp`
`7`	`7`	`{`
`8`	`8`	`public class CSharpGenerator : Generator`
`9`	`9`	`{`
`10`		`- private readonly CSharpTypePrinter typePrinter;`
`11`		`-`
`12`	`10`	`public CSharpGenerator(BindingContext context) : base(context)`
`13`	`11`	`{`
`14`		`- typePrinter = new CSharpTypePrinter(context);`
`15`	`12`	`}`
`16`	`13`
`17`	`14`	`public override List<CodeGenerator> Generate(IEnumerable<TranslationUnit> units)`
`18`	`15`	`{`
`19`	`16`	`var outputs = new List<CodeGenerator>();`
`20`	`17`
`21`		`- var gen = new CSharpSources(Context, units) { TypePrinter = typePrinter };`
	`18`	`+ var gen = new CSharpSources(Context, units) { TypePrinter = (CSharpTypePrinter)typePrinter };`
`22`	`19`	`outputs.Add(gen);`
`23`	`20`
`24`	`21`	`return outputs;`
`@@ -42,10 +39,5 @@ public override bool SetupPasses()`
`42`	`39`
`43`	`40`	`return true;`
`44`	`41`	`}`
`45`		`-`
`46`		`- protected override string TypePrinterDelegate(Type type)`
`47`		`- {`
`48`		`- return type.Visit(typePrinter);`
`49`		`- }`
`50`	`42`	`}`
`51`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,15 +21,10 @@ public class CSharpTypePrinter : TypePrinter`
`21`	`21`
`22`	`22`	`public bool PrintModuleOutputNamespace = true;`
`23`	`23`
`24`		`- public CSharpTypePrinter()`
	`24`	`+ public CSharpTypePrinter(BindingContext context) : base(context)`
`25`	`25`	`{`
`26`	`26`	`}`
`27`	`27`
`28`		`- public CSharpTypePrinter(BindingContext context)`
`29`		`- {`
`30`		`- Context = context;`
`31`		`- }`
`32`		`-`
`33`	`28`	`public string QualifiedType(string name)`
`34`	`29`	`{`
`35`	`30`	`return IsGlobalQualifiedScope ? $"global::{name}" : name;`
Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,13 @@`
`1`	`1`	`using CppSharp.AST;`
`2`	`2`	`using CppSharp.Generators.C;`
	`3`	`+using System;`
`3`	`4`
`4`	`5`	`namespace CppSharp.Generators`
`5`	`6`	`{`
`6`	`7`	`public class MarshalContext : TypePrinter`
`7`	`8`	`{`
`8`		`- public MarshalContext(BindingContext context, uint indentation)`
	`9`	`+ public MarshalContext(BindingContext context, uint indentation) : base(context)`
`9`	`10`	`{`
`10`		`- Context = context;`
`11`	`11`	`Before = new TextGenerator { CurrentIndentation = indentation };`
`12`	`12`	`Return = new TextGenerator { CurrentIndentation = indentation };`
`13`	`13`	`Cleanup = new TextGenerator { CurrentIndentation = indentation };`
`@@ -34,16 +34,16 @@ public MarshalContext(BindingContext context, uint indentation)`
`34`	`34`	`public uint Indentation { get; }`
`35`	`35`	`}`
`36`	`36`
`37`		`- public abstract class MarshalPrinter<C, P> : AstVisitor where C : MarshalContext where P : TypePrinter, new()`
	`37`	`+ public abstract class MarshalPrinter<C, P> : AstVisitor where C : MarshalContext where P : TypePrinter`
`38`	`38`	`{`
`39`	`39`	`public C Context { get; }`
`40`	`40`
`41`	`41`	`protected MarshalPrinter(C ctx)`
`42`	`42`	`{`
`43`	`43`	`Context = ctx;`
`44`		`- typePrinter.Context = ctx.Context;`
	`44`	`+ typePrinter = (P)Activator.CreateInstance(typeof(P), ctx.Context);`
`45`	`45`	`}`
`46`	`46`
`47`		`- protected P typePrinter = new P();`
	`47`	`+ protected P typePrinter;`
`48`	`48`	`}`
`49`	`49`	`}`