Registrable: generify the API + improvements

deadlocklogic · deadlocklogic · commit f903f9502dbf · 2023-12-15T13:50:40.000+02:00
diff --git a/src/Generator/Generators/Registrable/Lua/Sol/LuaSolGenerator.cs b/src/Generator/Generators/Registrable/Lua/Sol/LuaSolGenerator.cs
@@ -3,32 +3,28 @@
 
 namespace CppSharp.Generators.Registrable.Lua.Sol
 {
-    public class LuaSolGenerator : Generator
+    public class LuaSolGenerator : RegistrableGenerator<LuaSolGeneratorOptions, LuaSolHeaders, LuaSolSources>
     {
         public const string Id = "Lua::Sol";
         public static readonly GeneratorKind Kind = new(Id, "lua::sol", typeof(LuaSolGenerator), typeof(LuaSolTypePrinter), new[] { "lua::sol" });
 
-        public LuaSolGeneratorOptions GeneratorOptions
+        public LuaSolGenerator(BindingContext context) : base(context)
         {
-            get;
         }
 
-        public LuaSolGenerator(BindingContext context) : base(context)
+        protected override LuaSolGeneratorOptions CreateOptions(RegistrableGenerator<LuaSolGeneratorOptions, LuaSolHeaders, LuaSolSources> generator)
         {
-            GeneratorOptions = new LuaSolGeneratorOptions(this);
+            return new LuaSolGeneratorOptions(this);
         }
 
-        public override List<CodeGenerator> Generate(IEnumerable<TranslationUnit> units)
+        protected override LuaSolHeaders CreateHeader(RegistrableGenerator<LuaSolGeneratorOptions, LuaSolHeaders, LuaSolSources> generator, IEnumerable<TranslationUnit> units)
         {
-            var outputs = new List<CodeGenerator>();
-
-            var header = new LuaSolHeaders(this, units);
-            outputs.Add(header);
-
-            var source = new LuaSolSources(this, units);
-            outputs.Add(source);
+            return new LuaSolHeaders(this, units);
+        }
 
-            return outputs;
+        protected override LuaSolSources CreateSource(RegistrableGenerator<LuaSolGeneratorOptions, LuaSolHeaders, LuaSolSources> generator, IEnumerable<TranslationUnit> units)
+        {
+            return new LuaSolSources(this, units);
         }
 
         public override bool SetupPasses() => true;
diff --git a/src/Generator/Generators/Registrable/Lua/Sol/LuaSolGeneratorOptions.cs b/src/Generator/Generators/Registrable/Lua/Sol/LuaSolGeneratorOptions.cs
@@ -1,6 +1,6 @@
 ﻿namespace CppSharp.Generators.Registrable.Lua.Sol
 {
-    public class LuaSolGeneratorOptions : RegistrableGeneratorOptions
+    public class LuaSolGeneratorOptions : RegistrableGeneratorOptions<LuaSolGenerator>
     {
         public LuaSolNamingStrategy NamingStrategy;
 
diff --git a/src/Generator/Generators/Registrable/Lua/Sol/LuaSolHeaders.cs b/src/Generator/Generators/Registrable/Lua/Sol/LuaSolHeaders.cs
@@ -27,22 +27,11 @@ public override void Process()
 
         #region TranslationUnit
 
-        public override void GenerateTranslationUnitNamespaceBegin(TranslationUnit translationUnit)
-        {
-            PushBlock(BlockKind.Namespace);
-            WriteLine($"namespace {TranslationUnit.Module.OutputNamespace} {{");
-        }
-
-        public override void GenerateTranslationUnitNamespaceEnd(TranslationUnit translationUnit)
-        {
-            WriteLine($"}}  // namespace {TranslationUnit.Module.OutputNamespace}");
-            PopBlock();
-        }
-
         public virtual void GenerateTranslationUnitRegistrationFunctionDeclaration(TranslationUnit translationUnit)
         {
             NewLine();
-            WriteLine(GetTranslationUnitRegistrationFunctionSignature(translationUnit));
+            GenerateTranslationUnitRegistrationFunctionSignature(translationUnit);
+            WriteLine(";");
             NewLine();
         }
 
diff --git a/src/Generator/Generators/Registrable/Lua/Sol/LuaSolSources.cs b/src/Generator/Generators/Registrable/Lua/Sol/LuaSolSources.cs
@@ -6,16 +6,14 @@
 
 namespace CppSharp.Generators.Registrable.Lua.Sol
 {
-    public class LuaSolSources : CodeGenerator
+    public class LuaSolSources : RegistrableSources<LuaSolGenerator>
     {
-        protected LuaSolGenerator Generator { get; }
         protected LuaSolGenerationContext GenerationContext { get; }
         protected LuaSolNamingStrategy NamingStrategy => Generator.GeneratorOptions.NamingStrategy;
 
         public LuaSolSources(LuaSolGenerator generator, IEnumerable<TranslationUnit> units)
-            : base(generator.Context, units)
+            : base(generator, units)
         {
-            Generator = generator;
             GenerationContext = new LuaSolGenerationContext();
         }
 
@@ -72,13 +70,12 @@ public virtual void GenerateDeclarationContainerList(DeclarationContext declarat
 
         #region TranslationUnit
 
-        public virtual string GetTranslationUnitRegistrationFunctionSignature(TranslationUnit translationUnit)
+        public virtual void GenerateTranslationUnitRegistrationFunctionSignature(TranslationUnit translationUnit)
         {
-            StringBuilder builder = new StringBuilder();
-            builder.Append("void ");
-            builder.Append(Generator.GeneratorOptions.NamingStrategy.GetRegistrationFunctionName(translationUnit));
-            builder.Append("(::sol::state_view& state) {");
-            return builder.ToString();
+            var generatorOptions = Generator.GeneratorOptions;
+            Write("void ");
+            Write(generatorOptions.NamingStrategy.GetRegistrationFunctionName(translationUnit));
+            Write($"({generatorOptions.RootContextType} {generatorOptions.RootContextName})");
         }
 
         public virtual void GenerateTranslationUnitNamespaceBegin(TranslationUnit translationUnit)
@@ -97,7 +94,8 @@ public virtual void GenerateTranslationUnitRegistrationFunctionBegin(Translation
         {
             PushBlock(BlockKind.Function);
             NewLine();
-            WriteLine(GetTranslationUnitRegistrationFunctionSignature(translationUnit));
+            GenerateTranslationUnitRegistrationFunctionSignature(translationUnit);
+            WriteLine(" {");
             Indent();
         }
 
@@ -1194,7 +1192,7 @@ public virtual void GenerateMethod(Class @class, Method method)
                 Write("static_cast<");
                 Write(method.ReturnType.Visit(new CppTypePrinter(Context)));
                 Write("(");
-                Write("*)");
+                Write($"{NamingStrategy.GetMembershipScopeName(method, GenerationContext)}*)");
                 Write("(");
                 var needsComma = false;
                 foreach (var parameter in method.Parameters)
@@ -1259,7 +1257,7 @@ public virtual void GenerateTypedefNameDecl(TypedefNameDecl typedef)
                 string typedefBindingContext = NamingStrategy.GetBindingContext(typedef, GenerationContext);
                 string typedefRootContextName = NamingStrategy.GetRootContextName(GenerationContext);
 
-                WriteLine($"global{typedefRegistrationFunctionName}{{}}({typedefRootContextName}, {typedefBindingContext}, {typedefNameQuoted}); /* directly */");
+                WriteLine($"//TODO: global{typedefRegistrationFunctionName}{{}}({typedefRootContextName}, {typedefBindingContext}, {typedefNameQuoted}); /* directly */");
             }
         }
 
diff --git a/src/Generator/Generators/Registrable/RegistrableCodeGenerator.cs b/src/Generator/Generators/Registrable/RegistrableCodeGenerator.cs
@@ -0,0 +1,16 @@
+﻿using CppSharp.AST;
+using System.Collections.Generic;
+
+namespace CppSharp.Generators.Registrable
+{
+    public abstract class RegistrableCodeGenerator<TGenerator> : CodeGenerator
+        where TGenerator : Generator
+    {
+        public TGenerator Generator { get; set; }
+
+        public RegistrableCodeGenerator(TGenerator generator, IEnumerable<TranslationUnit> units) : base(generator.Context, units)
+        {
+            Generator = generator;
+        }
+    }
+}
diff --git a/src/Generator/Generators/Registrable/RegistrableGenerator.cs b/src/Generator/Generators/Registrable/RegistrableGenerator.cs
@@ -0,0 +1,34 @@
+﻿using CppSharp.AST;
+using System.Collections.Generic;
+
+namespace CppSharp.Generators.Registrable
+{
+    public abstract class RegistrableGenerator<TOptions, THeader, TSource> : Generator
+        where THeader : CodeGenerator
+        where TSource : CodeGenerator
+    {
+        public TOptions GeneratorOptions { get; }
+
+        public RegistrableGenerator(BindingContext context) : base(context)
+        {
+            GeneratorOptions = CreateOptions(this);
+        }
+
+        protected abstract TOptions CreateOptions(RegistrableGenerator<TOptions, THeader, TSource> generator);
+
+        protected abstract THeader CreateHeader(RegistrableGenerator<TOptions, THeader, TSource> generator, IEnumerable<TranslationUnit> units);
+
+        protected abstract TSource CreateSource(RegistrableGenerator<TOptions, THeader, TSource> generator, IEnumerable<TranslationUnit> units);
+
+        public override List<CodeGenerator> Generate(IEnumerable<TranslationUnit> units)
+        {
+            return new List<CodeGenerator>
+            {
+                CreateHeader(this, units),
+                CreateSource(this, units)
+            };
+        }
+
+        public override bool SetupPasses() => true;
+    }
+}
diff --git a/src/Generator/Generators/Registrable/RegistrableGeneratorOptions.cs b/src/Generator/Generators/Registrable/RegistrableGeneratorOptions.cs
@@ -9,11 +9,12 @@ public enum ImportedClassTemplateMode
         Import
     }
 
-    public abstract class RegistrableGeneratorOptions
+    public abstract class RegistrableGeneratorOptions<TGenerator>
+        where TGenerator : Generator
     {
         public delegate string Delegate(string name);
 
-        protected Generator Generator;
+        public TGenerator Generator { get; set; }
 
         public virtual string OutputSubDir { get; }
         public virtual string RootContextType { get; }
@@ -59,7 +60,7 @@ public abstract class RegistrableGeneratorOptions
         public virtual string DefaultStaticCastFunctionTemplateFullyQualifiedName => null;
         public virtual string DefaultDynamicCastFunctionTemplateFullyQualifiedName => null;
 
-        public RegistrableGeneratorOptions(Generator generator)
+        public RegistrableGeneratorOptions(TGenerator generator)
         {
             Generator = generator;
             OutputSubDir = DefaultOutputSubdir;
diff --git a/src/Generator/Generators/Registrable/RegistrableHeaders.cs b/src/Generator/Generators/Registrable/RegistrableHeaders.cs
@@ -0,0 +1,13 @@
+﻿using CppSharp.AST;
+using System.Collections.Generic;
+
+namespace CppSharp.Generators.Registrable
+{
+    public abstract class RegistrableHeaders<TGenerator> : RegistrableCodeGenerator<TGenerator>
+        where TGenerator : Generator
+    {
+        public RegistrableHeaders(TGenerator generator, IEnumerable<TranslationUnit> units) : base(generator, units)
+        {
+        }
+    }
+}
diff --git a/src/Generator/Generators/Registrable/RegistrableNamingStrategy.cs b/src/Generator/Generators/Registrable/RegistrableNamingStrategy.cs
@@ -397,5 +397,17 @@ public virtual string GetCppContext(Declaration entity, RegistrableGeneratorCont
             }
             return GetFullyQualifiedName(entity.OriginalNamespace, option);
         }
+
+        public virtual string GetMembershipScopeName(Function function, RegistrableGeneratorContext context)
+        {
+            if (function is Method method)
+            {
+                return GetCppContext(method, context, new FQNOption()
+                {
+                    IgnoreTemplateTypenameKeyword = true
+                }) + "::";
+            }
+            return "";
+        }
     }
 }
diff --git a/src/Generator/Generators/Registrable/RegistrableSources.cs b/src/Generator/Generators/Registrable/RegistrableSources.cs
@@ -0,0 +1,13 @@
+﻿using CppSharp.AST;
+using System.Collections.Generic;
+
+namespace CppSharp.Generators.Registrable
+{
+    public abstract class RegistrableSources<TGenerator> : RegistrableCodeGenerator<TGenerator>
+        where TGenerator : Generator
+    {
+        public RegistrableSources(TGenerator generator, IEnumerable<TranslationUnit> units) : base(generator, units)
+        {
+        }
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -3,32 +3,28 @@`
`3`	`3`
`4`	`4`	`namespace CppSharp.Generators.Registrable.Lua.Sol`
`5`	`5`	`{`
`6`		`- public class LuaSolGenerator : Generator`
	`6`	`+ public class LuaSolGenerator : RegistrableGenerator<LuaSolGeneratorOptions, LuaSolHeaders, LuaSolSources>`
`7`	`7`	`{`
`8`	`8`	`public const string Id = "Lua::Sol";`
`9`	`9`	`public static readonly GeneratorKind Kind = new(Id, "lua::sol", typeof(LuaSolGenerator), typeof(LuaSolTypePrinter), new[] { "lua::sol" });`
`10`	`10`
`11`		`- public LuaSolGeneratorOptions GeneratorOptions`
	`11`	`+ public LuaSolGenerator(BindingContext context) : base(context)`
`12`	`12`	`{`
`13`		`- get;`
`14`	`13`	`}`
`15`	`14`
`16`		`- public LuaSolGenerator(BindingContext context) : base(context)`
	`15`	`+ protected override LuaSolGeneratorOptions CreateOptions(RegistrableGenerator<LuaSolGeneratorOptions, LuaSolHeaders, LuaSolSources> generator)`
`17`	`16`	`{`
`18`		`- GeneratorOptions = new LuaSolGeneratorOptions(this);`
	`17`	`+ return new LuaSolGeneratorOptions(this);`
`19`	`18`	`}`
`20`	`19`
`21`		`- public override List<CodeGenerator> Generate(IEnumerable<TranslationUnit> units)`
	`20`	`+ protected override LuaSolHeaders CreateHeader(RegistrableGenerator<LuaSolGeneratorOptions, LuaSolHeaders, LuaSolSources> generator, IEnumerable<TranslationUnit> units)`
`22`	`21`	`{`
`23`		`- var outputs = new List<CodeGenerator>();`
`24`		`-`
`25`		`- var header = new LuaSolHeaders(this, units);`
`26`		`- outputs.Add(header);`
`27`		`-`
`28`		`- var source = new LuaSolSources(this, units);`
`29`		`- outputs.Add(source);`
	`22`	`+ return new LuaSolHeaders(this, units);`
	`23`	`+ }`
`30`	`24`
`31`		`- return outputs;`
	`25`	`+ protected override LuaSolSources CreateSource(RegistrableGenerator<LuaSolGeneratorOptions, LuaSolHeaders, LuaSolSources> generator, IEnumerable<TranslationUnit> units)`
	`26`	`+ {`
	`27`	`+ return new LuaSolSources(this, units);`
`32`	`28`	`}`
`33`	`29`
`34`	`30`	`public override bool SetupPasses() => true;`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`namespace CppSharp.Generators.Registrable.Lua.Sol`
`2`	`2`	`{`
`3`		`- public class LuaSolGeneratorOptions : RegistrableGeneratorOptions`
	`3`	`+ public class LuaSolGeneratorOptions : RegistrableGeneratorOptions<LuaSolGenerator>`
`4`	`4`	`{`
`5`	`5`	`public LuaSolNamingStrategy NamingStrategy;`
`6`	`6`
Original file line number	Diff line number	Diff line change
`@@ -6,16 +6,14 @@`
`6`	`6`
`7`	`7`	`namespace CppSharp.Generators.Registrable.Lua.Sol`
`8`	`8`	`{`
`9`		`- public class LuaSolSources : CodeGenerator`
	`9`	`+ public class LuaSolSources : RegistrableSources<LuaSolGenerator>`
`10`	`10`	`{`
`11`		`- protected LuaSolGenerator Generator { get; }`
`12`	`11`	`protected LuaSolGenerationContext GenerationContext { get; }`
`13`	`12`	`protected LuaSolNamingStrategy NamingStrategy => Generator.GeneratorOptions.NamingStrategy;`
`14`	`13`
`15`	`14`	`public LuaSolSources(LuaSolGenerator generator, IEnumerable<TranslationUnit> units)`
`16`		`- : base(generator.Context, units)`
	`15`	`+ : base(generator, units)`
`17`	`16`	`{`
`18`		`- Generator = generator;`
`19`	`17`	`GenerationContext = new LuaSolGenerationContext();`
`20`	`18`	`}`
`21`	`19`
`@@ -72,13 +70,12 @@ public virtual void GenerateDeclarationContainerList(DeclarationContext declarat`
`72`	`70`
`73`	`71`	`#region TranslationUnit`
`74`	`72`
`75`		`- public virtual string GetTranslationUnitRegistrationFunctionSignature(TranslationUnit translationUnit)`
	`73`	`+ public virtual void GenerateTranslationUnitRegistrationFunctionSignature(TranslationUnit translationUnit)`
`76`	`74`	`{`
`77`		`- StringBuilder builder = new StringBuilder();`
`78`		`- builder.Append("void ");`
`79`		`- builder.Append(Generator.GeneratorOptions.NamingStrategy.GetRegistrationFunctionName(translationUnit));`
`80`		`- builder.Append("(::sol::state_view& state) {");`
`81`		`- return builder.ToString();`
	`75`	`+ var generatorOptions = Generator.GeneratorOptions;`
	`76`	`+ Write("void ");`
	`77`	`+ Write(generatorOptions.NamingStrategy.GetRegistrationFunctionName(translationUnit));`
	`78`	`+ Write($"({generatorOptions.RootContextType} {generatorOptions.RootContextName})");`
`82`	`79`	`}`
`83`	`80`
`84`	`81`	`public virtual void GenerateTranslationUnitNamespaceBegin(TranslationUnit translationUnit)`
`@@ -97,7 +94,8 @@ public virtual void GenerateTranslationUnitRegistrationFunctionBegin(Translation`
`97`	`94`	`{`
`98`	`95`	`PushBlock(BlockKind.Function);`
`99`	`96`	`NewLine();`
`100`		`- WriteLine(GetTranslationUnitRegistrationFunctionSignature(translationUnit));`
	`97`	`+ GenerateTranslationUnitRegistrationFunctionSignature(translationUnit);`
	`98`	`+ WriteLine(" {");`
`101`	`99`	`Indent();`
`102`	`100`	`}`
`103`	`101`
`@@ -1194,7 +1192,7 @@ public virtual void GenerateMethod(Class @class, Method method)`
`1194`	`1192`	`Write("static_cast<");`
`1195`	`1193`	`Write(method.ReturnType.Visit(new CppTypePrinter(Context)));`
`1196`	`1194`	`Write("(");`
`1197`		`- Write("*)");`
	`1195`	`+ Write($"{NamingStrategy.GetMembershipScopeName(method, GenerationContext)}*)");`
`1198`	`1196`	`Write("(");`
`1199`	`1197`	`var needsComma = false;`
`1200`	`1198`	`foreach (var parameter in method.Parameters)`
`@@ -1259,7 +1257,7 @@ public virtual void GenerateTypedefNameDecl(TypedefNameDecl typedef)`
`1259`	`1257`	`string typedefBindingContext = NamingStrategy.GetBindingContext(typedef, GenerationContext);`
`1260`	`1258`	`string typedefRootContextName = NamingStrategy.GetRootContextName(GenerationContext);`
`1261`	`1259`
`1262`		`- WriteLine($"global{typedefRegistrationFunctionName}{{}}({typedefRootContextName}, {typedefBindingContext}, {typedefNameQuoted}); /* directly */");`
	`1260`	`+ WriteLine($"//TODO: global{typedefRegistrationFunctionName}{{}}({typedefRootContextName}, {typedefBindingContext}, {typedefNameQuoted}); /* directly */");`
`1263`	`1261`	`}`
`1264`	`1262`	`}`
`1265`	`1263`
Original file line number	Diff line number	Diff line change
`@@ -9,11 +9,12 @@ public enum ImportedClassTemplateMode`
`9`	`9`	`Import`
`10`	`10`	`}`
`11`	`11`
`12`		`- public abstract class RegistrableGeneratorOptions`
	`12`	`+ public abstract class RegistrableGeneratorOptions<TGenerator>`
	`13`	`+ where TGenerator : Generator`
`13`	`14`	`{`
`14`	`15`	`public delegate string Delegate(string name);`
`15`	`16`
`16`		`- protected Generator Generator;`
	`17`	`+ public TGenerator Generator { get; set; }`
`17`	`18`
`18`	`19`	`public virtual string OutputSubDir { get; }`
`19`	`20`	`public virtual string RootContextType { get; }`
`@@ -59,7 +60,7 @@ public abstract class RegistrableGeneratorOptions`
`59`	`60`	`public virtual string DefaultStaticCastFunctionTemplateFullyQualifiedName => null;`
`60`	`61`	`public virtual string DefaultDynamicCastFunctionTemplateFullyQualifiedName => null;`
`61`	`62`
`62`		`- public RegistrableGeneratorOptions(Generator generator)`
	`63`	`+ public RegistrableGeneratorOptions(TGenerator generator)`
`63`	`64`	`{`
`64`	`65`	`Generator = generator;`
`65`	`66`	`OutputSubDir = DefaultOutputSubdir;`
Original file line number	Diff line number	Diff line change
`@@ -397,5 +397,17 @@ public virtual string GetCppContext(Declaration entity, RegistrableGeneratorCont`
`397`	`397`	`}`
`398`	`398`	`return GetFullyQualifiedName(entity.OriginalNamespace, option);`
`399`	`399`	`}`
	`400`	`+`
	`401`	`+ public virtual string GetMembershipScopeName(Function function, RegistrableGeneratorContext context)`
	`402`	`+ {`
	`403`	`+ if (function is Method method)`
	`404`	`+ {`
	`405`	`+ return GetCppContext(method, context, new FQNOption()`
	`406`	`+ {`
	`407`	`+ IgnoreTemplateTypenameKeyword = true`
	`408`	`+ }) + "::";`
	`409`	`+ }`
	`410`	`+ return "";`
	`411`	`+ }`
`400`	`412`	`}`
`401`	`413`	`}`