| | | 1 | | // Copyright (c) NexusLabs. All rights reserved. |
| | | 2 | | // Licensed under the MIT License. |
| | | 3 | | |
| | | 4 | | using System.Text; |
| | | 5 | | |
| | | 6 | | namespace NexusLabs.Needlr.Generators.CodeGen; |
| | | 7 | | |
| | | 8 | | /// <summary> |
| | | 9 | | /// Emits a minimal <c>TypeRegistry</c> and module-initializer bootstrap for an assembly that |
| | | 10 | | /// declares <c>[GenerateTypeRegistry]</c> but has nothing to register. |
| | | 11 | | /// </summary> |
| | | 12 | | /// <remarks> |
| | | 13 | | /// The emitted code depends only on the attributes package (<c>InjectableTypeInfo</c>, |
| | | 14 | | /// <c>PluginTypeInfo</c>, and <c>NeedlrSourceGenBootstrap</c>) — never on the injection packages. |
| | | 15 | | /// A project must reference the attributes package to use <c>[GenerateTypeRegistry]</c> at all, so |
| | | 16 | | /// this registry always compiles, even for a project that references no Needlr injection packages |
| | | 17 | | /// (a documentation, contracts, or abstractions library). Emitting it keeps a type-less participant |
| | | 18 | | /// force-loadable by consumers (<c>typeof(<Assembly>.Generated.TypeRegistry)</c>) without the |
| | | 19 | | /// <c>CS0234</c> failure that omitting it would cause. |
| | | 20 | | /// </remarks> |
| | | 21 | | internal static class EmptyTypeRegistryCodeGenerator |
| | | 22 | | { |
| | | 23 | | /// <summary> |
| | | 24 | | /// Emits the empty <c>TypeRegistry</c> exposing empty injectable and plugin providers. |
| | | 25 | | /// </summary> |
| | | 26 | | /// <param name="assemblyName">The assembly the registry is generated for.</param> |
| | | 27 | | /// <param name="breadcrumbs">The breadcrumb writer supplied by the orchestration method.</param> |
| | | 28 | | /// <returns>The generated C# source for the empty <c>TypeRegistry</c>.</returns> |
| | | 29 | | internal static string GenerateTypeRegistrySource(string assemblyName, BreadcrumbWriter breadcrumbs) |
| | | 30 | | { |
| | 9 | 31 | | var builder = new StringBuilder(); |
| | 9 | 32 | | var safeAssemblyName = GeneratorHelpers.SanitizeIdentifier(assemblyName); |
| | | 33 | | |
| | 9 | 34 | | breadcrumbs.WriteFileHeader(builder, assemblyName, "Needlr Type Registry (empty)"); |
| | 9 | 35 | | builder.AppendLine("#nullable enable"); |
| | 9 | 36 | | builder.AppendLine(); |
| | 9 | 37 | | builder.AppendLine($"namespace {safeAssemblyName}.Generated;"); |
| | 9 | 38 | | builder.AppendLine(); |
| | 9 | 39 | | builder.AppendLine("/// <summary>"); |
| | 9 | 40 | | builder.AppendLine("/// Compile-time generated registry for an assembly that declares [GenerateTypeRegistry]"); |
| | 9 | 41 | | builder.AppendLine("/// but contains no registerable types. Exposes empty providers so that consumers which"); |
| | 9 | 42 | | builder.AppendLine("/// force-load this type compile, without depending on the Needlr injection packages."); |
| | 9 | 43 | | builder.AppendLine("/// </summary>"); |
| | 9 | 44 | | builder.AppendLine("[global::System.CodeDom.Compiler.GeneratedCodeAttribute(\"NexusLabs.Needlr.Generators\", \"1 |
| | 9 | 45 | | builder.AppendLine("public static class TypeRegistry"); |
| | 9 | 46 | | builder.AppendLine("{"); |
| | 9 | 47 | | builder.AppendLine(" private static readonly global::NexusLabs.Needlr.Generators.InjectableTypeInfo[] _types |
| | 9 | 48 | | builder.AppendLine(" private static readonly global::NexusLabs.Needlr.Generators.PluginTypeInfo[] _plugins = |
| | 9 | 49 | | builder.AppendLine(); |
| | 9 | 50 | | builder.AppendLine(" /// <summary>Gets all injectable types discovered at compile time (none).</summary>"); |
| | 9 | 51 | | builder.AppendLine(" /// <returns>An empty read-only list.</returns>"); |
| | 9 | 52 | | builder.AppendLine(" public static global::System.Collections.Generic.IReadOnlyList<global::NexusLabs.Needlr. |
| | 9 | 53 | | builder.AppendLine(); |
| | 9 | 54 | | builder.AppendLine(" /// <summary>Gets all plugin types discovered at compile time (none).</summary>"); |
| | 9 | 55 | | builder.AppendLine(" /// <returns>An empty read-only list.</returns>"); |
| | 9 | 56 | | builder.AppendLine(" public static global::System.Collections.Generic.IReadOnlyList<global::NexusLabs.Needlr. |
| | 9 | 57 | | builder.AppendLine("}"); |
| | | 58 | | |
| | 9 | 59 | | return builder.ToString(); |
| | | 60 | | } |
| | | 61 | | |
| | | 62 | | /// <summary> |
| | | 63 | | /// Emits the module-initializer bootstrap that registers the empty providers with |
| | | 64 | | /// <c>NeedlrSourceGenBootstrap</c>. |
| | | 65 | | /// </summary> |
| | | 66 | | /// <param name="assemblyName">The assembly the bootstrap is generated for.</param> |
| | | 67 | | /// <param name="breadcrumbs">The breadcrumb writer supplied by the orchestration method.</param> |
| | | 68 | | /// <returns>The generated C# source for the module-initializer bootstrap.</returns> |
| | | 69 | | /// <remarks> |
| | | 70 | | /// Uses the registry-identity <c>Register</c> overload (no decorator applier, no options registrar), |
| | | 71 | | /// which takes no <c>IServiceCollection</c>/<c>IConfiguration</c> parameters and therefore keeps |
| | | 72 | | /// the emitted code free of any Microsoft.Extensions.DependencyInjection dependency. |
| | | 73 | | /// </remarks> |
| | | 74 | | internal static string GenerateBootstrapSource(string assemblyName, BreadcrumbWriter breadcrumbs) |
| | | 75 | | { |
| | 9 | 76 | | var builder = new StringBuilder(); |
| | 9 | 77 | | var safeAssemblyName = GeneratorHelpers.SanitizeIdentifier(assemblyName); |
| | | 78 | | |
| | 9 | 79 | | breadcrumbs.WriteFileHeader(builder, assemblyName, "Needlr Source-Gen Bootstrap (empty)"); |
| | 9 | 80 | | builder.AppendLine("#nullable enable"); |
| | 9 | 81 | | builder.AppendLine(); |
| | 9 | 82 | | builder.AppendLine($"namespace {safeAssemblyName}.Generated;"); |
| | 9 | 83 | | builder.AppendLine(); |
| | 9 | 84 | | builder.AppendLine("internal static class NeedlrSourceGenModuleInitializer"); |
| | 9 | 85 | | builder.AppendLine("{"); |
| | 9 | 86 | | builder.AppendLine(" [global::System.Runtime.CompilerServices.ModuleInitializer]"); |
| | 9 | 87 | | builder.AppendLine(" internal static void Initialize()"); |
| | 9 | 88 | | builder.AppendLine(" {"); |
| | 9 | 89 | | builder.AppendLine(" global::NexusLabs.Needlr.Generators.NeedlrSourceGenBootstrap.Register("); |
| | 9 | 90 | | builder.AppendLine($" typeof(global::{safeAssemblyName}.Generated.TypeRegistry),"); |
| | 9 | 91 | | builder.AppendLine($" global::{safeAssemblyName}.Generated.TypeRegistry.GetInjectableTypes,"); |
| | 9 | 92 | | builder.AppendLine($" global::{safeAssemblyName}.Generated.TypeRegistry.GetPluginTypes);"); |
| | 9 | 93 | | builder.AppendLine(" }"); |
| | 9 | 94 | | builder.AppendLine("}"); |
| | | 95 | | |
| | 9 | 96 | | return builder.ToString(); |
| | | 97 | | } |
| | | 98 | | } |