Name templates

Author: NikolayPianikov

src/Pure.DI.Core/Components/Api.g.cs

@@ -1879,7 +1879,7 @@ internal interface IConfiguration
         /// </example>
         /// </summary>
         /// <typeparam name="T">The type of dependency to be bound.</typeparam>
-        /// <param name="name">Specifies the unique name of the root of the composition. If the value is empty, a private root will be created, which can be used when calling <c>Resolve</c> methods.</param>
+        /// <param name="name">Specifies the name template of the root of the composition. If the value is empty, a private root will be created, which can be used when calling <c>Resolve</c> methods.</param>
         /// <param name="kind">The Optional argument specifying the kind for the root of the Composition.</param>
         /// <param name="tags">The optional argument that specifies tags for a particular type of dependency binding. If is is not empty, the first tag is used for the root.</param>
         /// <returns>Reference to the setup continuation chain.</returns>
@@ -2016,7 +2016,7 @@ internal interface IConfiguration
         /// </code>
         /// </example>
         /// </summary>
-        /// <param name="name">The argument name.</param>
+        /// <param name="name">The argument name template.</param>
         /// <param name="tags">The optional argument that specifies the tags for the argument.</param>
         /// <typeparam name="T">The argument type.</typeparam>
         /// <returns>Reference to the setup continuation chain.</returns>
@@ -2031,7 +2031,7 @@ internal interface IConfiguration
         /// </code>
         /// </example>
         /// </summary>
-        /// <param name="name">The argument name.</param>
+        /// <param name="name">The argument name tamplate.</param>
         /// <param name="tags">The optional argument that specifies the tags for the argument.</param>
         /// <typeparam name="T">The argument type.</typeparam>
         /// <returns>Reference to the setup continuation chain.</returns>
@@ -2046,7 +2046,7 @@ internal interface IConfiguration
         /// </code>
         /// </example>
         /// </summary>
-        /// <param name="name">Specifies the unique name of the root of the composition. If the value is empty, a private root will be created, which can be used when calling <c>Resolve</c> methods.</param>
+        /// <param name="name">Specifies the name template of the root of the composition. If the value is empty, a private root will be created, which can be used when calling <c>Resolve</c> methods.</param>
         /// <param name="tag">Optional argument specifying the tag for the root of the Composition.</param>
         /// <param name="kind">The Optional argument specifying the kind for the root of the Composition.</param>
         /// <typeparam name="T">The Composition root type.</typeparam>
@@ -2062,10 +2062,11 @@ internal interface IConfiguration
         /// </code>
         /// </example>
         /// </summary>
+        /// <param name="name">Specifies the name template of the roots of the composition. If the value is empty, private roots will be created, which can be used when calling <c>Resolve</c> methods.</param>
         /// <param name="kind">The Optional argument specifying the kind for the root of the Composition.</param>
         /// <typeparam name="T">The Composition root base type.</typeparam>
         /// <returns>Reference to the setup continuation chain.</returns>
-        IConfiguration Roots<T>(RootKinds kind = RootKinds.Default);
+        IConfiguration Roots<T>(string name = "", RootKinds kind = RootKinds.Default);
 
         /// <summary>
         /// Specifies the method of the composition builder. The first argument to the method will always be the instance to be built. The remaining arguments to this method will be listed in the order in which they are defined in the setup.Specifies to create a composition builder method. The first argument to the method will always be the instance to be built. The remaining arguments to this method will be listed in the order in which they are defined in the setup.
@@ -2076,7 +2077,7 @@ internal interface IConfiguration
         /// </code>
         /// </example>
         /// </summary>
-        /// <param name="name">Specifies the unique name of the builder. The default name is "BuildUp".</param>
+        /// <param name="name">Specifies the name template of the builder. The default name tamplate is "BuildUp".</param>
         /// <param name="kind">The Optional argument specifying the kind for the root of the Composition.</param>
         /// <typeparam name="T">The Composition root type.</typeparam>
         /// <returns>Reference to the setup continuation chain.</returns>
@@ -2091,7 +2092,7 @@ internal interface IConfiguration
         /// </code>
         /// </example>
         /// </summary>
-        /// <param name="name">Specifies the unique name of the builders. The default name is "BuildUp".</param>
+        /// <param name="name">Specifies the name template of the builders. The default name tamplate is "BuildUp".</param>
         /// <param name="kind">The Optional argument specifying the kind for the root of the Composition.</param>
         /// <typeparam name="T">The Composition root base type.</typeparam>
         /// <returns>Reference to the setup continuation chain.</returns>
@@ -2962,27 +2963,26 @@ public IConfiguration RootArg<T>(string name, params object[] tags)
                 return Configuration.Shared;
             }
 
-
             /// <inheritdoc />
             public IConfiguration Root<T>(string name, object tag, RootKinds rootKind)
             {
                 return Configuration.Shared;
             }
 
             /// <inheritdoc />
-            public IConfiguration Roots<T>(RootKinds kind = RootKinds.Default)
+            public IConfiguration Roots<T>(string name, RootKinds kind)
             {
                 return Configuration.Shared;
             }
 
             /// <inheritdoc />
-            public IConfiguration Builder<T>(string name = "BuildUp", RootKinds kind = RootKinds.Default)
+            public IConfiguration Builder<T>(string name, RootKinds kind)
             {
                 return Configuration.Shared;
             }
 
             /// <inheritdoc />
-            public IConfiguration Builders<T>(string name = "BuildUp", RootKinds kind = RootKinds.Default)
+            public IConfiguration Builders<T>(string name, RootKinds kind = RootKinds.Default)
             {
                 return Configuration.Shared;
             }

src/Pure.DI.Core/Core/ApiInvocationProcessor.cs

@@ -11,7 +11,8 @@ internal class ApiInvocationProcessor(
     ISemantic semantic,
     ISymbolNames symbolNames,
     [Tag(Tag.UniqueTag)] IdGenerator idGenerator,
-    IBaseSymbolsProvider baseSymbolsProvider)
+    IBaseSymbolsProvider baseSymbolsProvider,
+    INameFormatter nameFormatter)
     : IApiInvocationProcessor
 {
     private static readonly char[] TypeNamePartsSeparators = ['.'];
@@ -285,8 +286,9 @@ MemberAccessExpressionSyntax memberAccess when memberAccess.Kind() == SyntaxKind
                             return;
                         }
 
-                        var rootsArgs = arguments.GetArgs(invocation.ArgumentList, "kind");
-                        var kind = rootsArgs[0] is { } kindArg ? semantic.GetConstantValue<RootKinds>(semanticModel, kindArg.Expression) : RootKinds.Default;
+                        var rootsArgs = arguments.GetArgs(invocation.ArgumentList, "name", "kind");
+                        var rootsName = rootsArgs[0] is { } nameArg ? semantic.GetConstantValue<string>(semanticModel, nameArg.Expression) ?? "" : "";
+                        var kind = rootsArgs[1] is { } kindArg ? semantic.GetConstantValue<RootKinds>(semanticModel, kindArg.Expression) : RootKinds.Default;
                         var rootTypes = semanticModel
                             .LookupNamespacesAndTypes(invocation.Span.Start)
                             .OfType<INamedTypeSymbol>()
@@ -296,7 +298,8 @@ MemberAccessExpressionSyntax memberAccess when memberAccess.Kind() == SyntaxKind
 
                         foreach (var rootType in rootTypes)
                         {
-                            metadataVisitor.VisitRoot(new MdRoot(invocation, semanticModel, rootType, "", new MdTag(0, null), kind, invocationComments, false));
+                            var rootName = GetName((SyntaxNode?)rootsArgs[1] ?? invocation, semanticModel, rootsName, rootType) ?? "";
+                            metadataVisitor.VisitRoot(new MdRoot(invocation, semanticModel, rootType, rootName, new MdTag(0, null), kind, invocationComments, false));
                         }
 
                         break;
@@ -496,7 +499,9 @@ private void VisitBuilder(
 
         // Root
         var rootArgs = arguments.GetArgs(invocationSource.ArgumentList, "name", "tag", "kind");
-        var builderName = rootArgs[0] is { } nameArg ? semantic.GetConstantValue<string>(semanticModel, nameArg.Expression) ?? Names.DefaultBuilderName : Names.DefaultBuilderName;
+        var builderName = rootArgs[0] is { } nameArg ?
+            GetName(nameArg, semanticModel, semantic.GetConstantValue<string>(semanticModel, nameArg.Expression), builderType) ?? Names.DefaultBuilderName
+            : Names.DefaultBuilderName;
         var kind = rootArgs[2] is { } kindArg ? semantic.GetConstantValue<RootKinds>(semanticModel, kindArg.Expression) : RootKinds.Default;
         metadataVisitor.VisitRoot(new MdRoot(invocationSource, semanticModel, builderType, builderName, builderTag, kind, invocationComments, true));
     }
@@ -589,11 +594,13 @@ private void VisitRoot(
         SemanticModel semanticModel,
         InvocationExpressionSyntax invocation,
         IReadOnlyCollection<string> invocationComments,
-        ITypeSymbol rootSymbol)
+        INamedTypeSymbol rootSymbol)
     {
         var rootArgs = arguments.GetArgs(invocation.ArgumentList, "name", "tag", "kind");
-        var name = rootArgs[0] is { } nameArg ? semantic.GetConstantValue<string>(semanticModel, nameArg.Expression) ?? "" : "";
         var tag = rootArgs[1] is { } tagArg ? semantic.GetConstantValue<object>(semanticModel, tagArg.Expression) : null;
+        var name = rootArgs[0] is { } nameArg
+            ? GetName(nameArg, semanticModel, semantic.GetConstantValue<string>(semanticModel, nameArg.Expression), rootSymbol, tag) ?? ""
+            : "";
         var kind = rootArgs[2] is { } kindArg ? semantic.GetConstantValue<RootKinds>(semanticModel, kindArg.Expression) : RootKinds.Default;
         metadataVisitor.VisitRoot(new MdRoot(invocation, semanticModel, rootSymbol, name, new MdTag(0, tag), kind, invocationComments, false));
     }
@@ -604,11 +611,13 @@ private void VisitRoot(
         SemanticModel semanticModel,
         InvocationExpressionSyntax invocation,
         IReadOnlyCollection<string> invocationComments,
-        ITypeSymbol rootSymbol)
+        INamedTypeSymbol rootSymbol)
     {
         tag ??= new MdTag(0, null);
         var rootArgs = arguments.GetArgs(invocation.ArgumentList, "name", "kind");
-        var name = rootArgs[0] is { } nameArg ? semantic.GetConstantValue<string>(semanticModel, nameArg.Expression) ?? "" : "";
+        var name = rootArgs[0] is { } nameArg
+            ? GetName(nameArg, semanticModel, semantic.GetConstantValue<string>(semanticModel, nameArg.Expression), rootSymbol, tag.Value.Value) ?? ""
+            : "";
         var kind = rootArgs[1] is { } kindArg ? semantic.GetConstantValue<RootKinds>(semanticModel, kindArg.Expression) : RootKinds.Default;
         metadataVisitor.VisitRoot(new MdRoot(invocation, semanticModel, rootSymbol, name, tag, kind, invocationComments, false));
     }
@@ -903,4 +912,30 @@ private static CompositionName CreateCompositionName(
 
         return new CompositionName(className, newNamespace, source);
     }
+
+    private string? GetName(
+        SyntaxNode source,
+        SemanticModel semanticModel,
+        string? nameTemplate,
+        INamedTypeSymbol? type = null,
+        object? tag = null)
+    {
+        if (string.IsNullOrWhiteSpace(nameTemplate))
+        {
+            return nameTemplate;
+        }
+
+        var name = nameFormatter.Format(semanticModel, nameTemplate, type, tag);
+        if (string.IsNullOrWhiteSpace(name))
+        {
+            return name;
+        }
+
+        if (!SyntaxFacts.IsValidIdentifier(name))
+        {
+            throw new CompileErrorException($"Invalid identifier \"{name}\".", source.GetLocation(), LogId.ErrorInvalidMetadata);
+        }
+
+        return name;
+    }
 }

src/Pure.DI.Core/Core/INameFormatter.cs

@@ -0,0 +1,10 @@
+namespace Pure.DI.Core;
+
+internal interface INameFormatter
+{
+    string? Format(
+        SemanticModel semanticModel,
+        string? nameTemplate,
+        INamedTypeSymbol? type,
+        object? tag);
+}

src/Pure.DI.Core/Core/InjectionSiteFactory.cs

@@ -11,16 +11,10 @@ internal class InjectionSiteFactory : IInjectionSiteFactory
     static InjectionSiteFactory()
     {
         NameTagQualifiedFormat = new SymbolDisplayFormat(
-            genericsOptions:
-            SymbolDisplayGenericsOptions.IncludeTypeParameters,
-            typeQualificationStyle:
-            SymbolDisplayTypeQualificationStyle.NameAndContainingTypesAndNamespaces,
-            memberOptions:
-            SymbolDisplayMemberOptions.IncludeType |
-            SymbolDisplayMemberOptions.IncludeContainingType,
-            miscellaneousOptions:
-            SymbolDisplayMiscellaneousOptions.UseSpecialTypes
-            | SymbolDisplayMiscellaneousOptions.CollapseTupleTypes
+            genericsOptions: SymbolDisplayGenericsOptions.IncludeTypeParameters,
+            typeQualificationStyle: SymbolDisplayTypeQualificationStyle.NameAndContainingTypesAndNamespaces,
+            memberOptions: SymbolDisplayMemberOptions.IncludeType | SymbolDisplayMemberOptions.IncludeContainingType,
+            miscellaneousOptions: SymbolDisplayMiscellaneousOptions.UseSpecialTypes | SymbolDisplayMiscellaneousOptions.CollapseTupleTypes
         );
 
         var qualifiedNameArityFormat = NameTagQualifiedFormat.GetType().GetField("QualifiedNameArityFormat", BindingFlags.Static | BindingFlags.NonPublic);

src/Pure.DI.Core/Core/NameFormatter.cs

@@ -0,0 +1,41 @@
+namespace Pure.DI.Core;
+
+internal class NameFormatter : INameFormatter
+{
+    private static readonly SymbolDisplayFormat TypeFormat = new(
+        globalNamespaceStyle: SymbolDisplayGlobalNamespaceStyle.Omitted,
+        genericsOptions: SymbolDisplayGenericsOptions.IncludeTypeParameters,
+        typeQualificationStyle: SymbolDisplayTypeQualificationStyle.NameOnly,
+        miscellaneousOptions: SymbolDisplayMiscellaneousOptions.UseSpecialTypes | SymbolDisplayMiscellaneousOptions.CollapseTupleTypes | SymbolDisplayMiscellaneousOptions.RemoveAttributeSuffix
+    );
+
+    public string? Format(
+        SemanticModel semanticModel,
+        string? nameTemplate,
+        INamedTypeSymbol? type,
+        object? tag)
+    {
+        if (string.IsNullOrWhiteSpace(nameTemplate))
+        {
+            return nameTemplate;
+        }
+
+        if (!nameTemplate.Contains('{'))
+        {
+            return nameTemplate;
+        }
+
+        var name = nameTemplate!.Trim();
+        if (type is not null)
+        {
+            name = name.Replace("{type}", type.ToDisplayString(NullableFlowState.NotNull, TypeFormat));
+        }
+
+        if (tag is not null)
+        {
+            name = name.Replace("{tag}", tag.ToString());
+        }
+
+        return name;
+    }
+}

src/Pure.DI.Core/Generator.cs

@@ -83,6 +83,7 @@ private void Setup() => DI.Setup()
                 .Bind().To<TriviaTools>()
                 .Bind().To<InstanceDpProvider>()
                 .Bind().To<Injections>()
+                .Bind().To<NameFormatter>()
 
                 // Validators
                 .Bind(Type).To<MetadataValidator>()