AutoInvoke.Generator by Patrick Kranz
Nuget / site data
Details
Info
Name: AutoInvoke.Generator
A generator that invokes a specified Metohd for ever Type in your Project that sattisfis a defined constraint
Author: Patrick Kranz
NuGet: https://www.nuget.org/packages/AutoInvoke.Generator/
You can find more details at https://github.com/LokiMidgard/AutoInvoke.Generator
Source : https://github.com/LokiMidgard/AutoInvoke.Generator
Original Readme
AutoInvoke
This Generator let you anotate an Parameterless Generic Method with exactly one TypeArgument.
It will then generate a method with the same name and no type arguments that calls your anotated method for every (non static) Type decleared in your project, that satisfies the type constraints.
Sample
Assume you have the following Interface:
internal interface IFileLoder {
public abstract static IFileLoder Init(string path);
public abstract static string FileExtension { get; }
}
This describes a File loader for different types in our project.
And following implementation:
internal class AudioLoader : IFileLoder {
public static string FileExtension => ".mp3";
public static IFileLoder Init(string Path) {
return new AudioLoader(path);
}
// the rest of the code...
}
Which defines how we want to load mp3 files.
We now want to automaticly get a list of all IFileLoader so we know what files we can handle,
and we do not want to manualy handel such a list.
An Implementation could look like this:
internal delegate IFileLoder LoadFile(string path);
internal partial class FileHandler {
private readonly Dictionary<string, LoadFile> loaders = new();
public FileHandler() {
LoadLoaders();
}
public void LoadFile(string file) {
if (loaders.TryGetValue(Path.GetExtension(file), out var loaderFactory)) {
var loader = loaderFactory(file);
// use loader to do things
}
}
[AutoInvoke.Generator.FindAndInvoke]
public void LoadLoaders<T>() where T : IFileLoder {
this.loaders.Add(T.FileExtension, T.Init);
}
}
The field loaders will have all extensions our code can handle, and has to every extension
the corresponding Init-Method.
The Generated code will look like this:
partial class FileHandler {
private void LoadLoaders() {
LoadLoaders<AutoInvoke.Generator.Example.AudioLoader>();
}
}
Featurs and limitations
- You can control wich type of types shold get called. E.g. by default no calls are generated for abstract classes or types defined in referenced Assemblys. But you can overide this setting
- The anotated method can be static
- If the anotated method has parameters the generated method has the same parametrs
- If the return type is not
voidthe generated methods returntype is an array of the return type of the attributed method
Limitations
- When using multiple Type Parameters, one Type Parameter must contain all others (transitiv) like
Foo<T1, T2, T3>() where T1: IComparable<T2> where T2 : IComparable<T3> - You can't call static Types. Generics do not allow this.
About
Finding all implementation of an interface/class and invoke them.
How to use
Example ( source csproj, source files )
- CSharp Project
- Program.cs
- RemoteCollection.cs
- PCRemote.cs
- TVRemote.cs
This is the CSharp Project that references AutoInvoke.Generator
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="AutoInvoke.Generator" Version="0.0.9">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
</ItemGroup>
<PropertyGroup>
<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
<CompilerGeneratedFilesOutputPath>$(BaseIntermediateOutputPath)\GX</CompilerGeneratedFilesOutputPath>
</PropertyGroup>
</Project>
This is the use of AutoInvoke.Generator in Program.cs
using AutoAdd;
RemoteCollection rc=new();
foreach(var item in rc.loaders)
{
item.Execute();
}
This is the use of AutoInvoke.Generator in RemoteCollection.cs
namespace AutoAdd;
partial class RemoteCollection
{
public List<IRemoteCommand> loaders = new ();
public RemoteCollection()
{
LoadLoaders();
}
[AutoInvoke.FindAndInvoke]
public void LoadLoaders<T>() where T : IRemoteCommand,new()
{
loaders.Add(new T());
}
}
This is the use of AutoInvoke.Generator in PCRemote.cs
namespace AutoAdd;
internal class PCRemote : IRemoteCommand
{
public void Execute()
{
Console.WriteLine("start PC");
}
}
This is the use of AutoInvoke.Generator in TVRemote.cs
namespace AutoAdd;
internal class TVRemote : IRemoteCommand
{
public void Execute()
{
Console.WriteLine("start TV");
}
}
Generated Files
Those are taken from $(BaseIntermediateOutputPath)\GX
- attribute.g.cs
- AutoAdd.class.LoadLoaders.g.cs
// <auto-generated/>
#nullable enable
namespace AutoInvoke;
[System.AttributeUsage(System.AttributeTargets.Method, Inherited = false, AllowMultiple = true)]
[System.Diagnostics.Conditional("AutoNotifyGenerator_DEBUG")]
internal sealed class FindAndInvokeAttribute : System.Attribute
{
#pragma warning disable CS0169 // Remove unused parameter
#pragma warning disable IDE0060 // Remove unused parameter
#pragma warning disable CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider declaring as nullable.
public FindAndInvokeAttribute()
{
}
public FindAndInvokeAttribute(string pattern)
{
}
public bool ScanExternalAssamblies { get; set; }
public string MethodName { get; set; }
public bool CallForAbstractClasses { get; set; }
public bool CallForInterfaces { get; set; }
public bool CallForStructs { get; set; }
public bool CallForClasses { get; set; }
public bool CallForRecords { get; set; }
#pragma warning restore CS0169 // Remove unused parameter
#pragma warning restore IDE0060 // Remove unused parameter
#pragma warning restore CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider declaring as nullable.
}
// <auto-generated/>
#nullable enable
namespace AutoAdd;
partial class RemoteCollection {
private void LoadLoaders() {
LoadLoaders<global::AutoAdd.PCRemote>();
LoadLoaders<global::AutoAdd.TVRemote>();
}
}
Usefull
Download Example (.NET C# )
Share AutoInvoke.Generator
https://ignatandrei.github.io/RSCG_Examples/v2/docs/AutoInvoke.Generator