Merge branch 'develop'

Author: ChebanovDD

src/UnityUxmlGenerator.UnityPackage/Assets/Plugins/UnityUxmlGenerator/Runtime/UnityUxmlGenerator.dll

@@ -0,0 +1,20 @@
+using Microsoft.CodeAnalysis.CSharp.Syntax;
+using UnityUxmlGenerator.Extensions;
+
+namespace UnityUxmlGenerator.Captures;
+
+internal abstract class BaseCapture
+{
+    protected BaseCapture(ClassDeclarationSyntax @class)
+    {
+        Class = @class;
+        ClassName = @class.Identifier.Text;
+        ClassNamespace = @class.GetParent<NamespaceDeclarationSyntax>()!.Name.ToString();
+    }
+
+    public string ClassName { get; }
+    public string ClassNamespace { get; }
+    public abstract string ClassTag { get; }
+
+    public ClassDeclarationSyntax Class { get; }
+}

src/UnityUxmlGenerator/Captures/BaseCapture.cs

@@ -1,19 +1,12 @@
 using Microsoft.CodeAnalysis.CSharp.Syntax;
-using UnityUxmlGenerator.Extensions;
 
 namespace UnityUxmlGenerator.Captures;
 
-internal sealed class UxmlFactoryCapture
+internal sealed class UxmlFactoryCapture : BaseCapture
 {
-    public UxmlFactoryCapture(ClassDeclarationSyntax @class)
+    public UxmlFactoryCapture(ClassDeclarationSyntax @class) : base(@class)
     {
-        Class = @class;
-        ClassName = @class.Identifier.Text;
-        ClassNamespace = @class.GetParent<NamespaceDeclarationSyntax>()!.Name.ToString();
     }
 
-    public string ClassName { get; }
-    public string ClassNamespace { get; }
-
-    public ClassDeclarationSyntax Class { get; }
+    public override string ClassTag => "UxmlFactory";
 }

src/UnityUxmlGenerator/Captures/UxmlFactoryCapture.cs

@@ -1,27 +1,19 @@
 using Microsoft.CodeAnalysis.CSharp.Syntax;
-using UnityUxmlGenerator.Extensions;
 
 namespace UnityUxmlGenerator.Captures;
 
-internal sealed class UxmlTraitsCapture
+internal sealed class UxmlTraitsCapture : BaseCapture
 {
-    public UxmlTraitsCapture(ClassDeclarationSyntax @class, TypeSyntax baseClassType)
+    public UxmlTraitsCapture(ClassDeclarationSyntax @class, TypeSyntax baseClassType) : base(@class)
     {
-        Class = @class;
-        ClassName = @class.Identifier.Text;
-        ClassNamespace = @class.GetParent<NamespaceDeclarationSyntax>()!.Name.ToString();
-
         BaseClassType = baseClassType;
-        Properties = new List<(string PropertyName, string? DefaultValue)>();
+        Properties = new List<(PropertyDeclarationSyntax property, string? DefaultValue)>();
     }
 
-    public string ClassName { get; }
-    public string ClassNamespace { get; }
+    public override string ClassTag => "UxmlTraits";
 
     public TypeSyntax BaseClassType { get; }
-    public ClassDeclarationSyntax Class { get; }
-
-    public List<(string PropertyName, string? DefaultValue)> Properties { get; }
+    public List<(PropertyDeclarationSyntax property, string? DefaultValue)> Properties { get; }
 
     public string GetBaseClassName(out TypeSyntax? genericTypeSyntax)
     {

src/UnityUxmlGenerator/Captures/UxmlTraitsCapture.cs

@@ -0,0 +1,30 @@
+using Microsoft.CodeAnalysis;
+
+namespace UnityUxmlGenerator.Diagnostics;
+
+internal static class DiagnosticDescriptors
+{
+    public static readonly DiagnosticDescriptor ClassHasNoBaseClassError = new(
+        id: "UXMLG001",
+        title: "Class has no base class",
+        messageFormat: "Class '{0}' must be declared as a partial and be inherited from 'VisualElement' or one of its derived classes.",
+        category: typeof(UxmlGenerator).FullName,
+        defaultSeverity: DiagnosticSeverity.Error,
+        isEnabledByDefault: true);
+
+    public static readonly DiagnosticDescriptor ClassDoesNotInheritFromVisualElementError = new(
+        id: "UXMLG002",
+        title: "Class does not inherit from VisualElement",
+        messageFormat: "Class '{0}' must be declared as a partial and be inherited from 'VisualElement' or one of its derived classes.",
+        category: typeof(UxmlGenerator).FullName,
+        defaultSeverity: DiagnosticSeverity.Error,
+        isEnabledByDefault: true);
+
+    public static readonly DiagnosticDescriptor PropertyAndDefaultValueTypesMismatchError = new(
+        id: "UXMLG003",
+        title: "Types mismatch",
+        messageFormat: "UxmlAttribute for '{0}' property was not created. The default property and attribute value must be of the same type.",
+        category: typeof(UxmlGenerator).FullName,
+        defaultSeverity: DiagnosticSeverity.Error,
+        isEnabledByDefault: true);
+}

src/UnityUxmlGenerator/Diagnostics/DiagnosticDescriptors.cs

@@ -0,0 +1,11 @@
+using Microsoft.CodeAnalysis;
+
+namespace UnityUxmlGenerator.Diagnostics;
+
+internal static class DiagnosticExtensions
+{
+    public static Diagnostic CreateDiagnostic(this DiagnosticDescriptor descriptor, Location location, params object[] args)
+    {
+        return Diagnostic.Create(descriptor, location, args);
+    }
+}

src/UnityUxmlGenerator/Diagnostics/DiagnosticExtensions.cs

@@ -6,6 +6,11 @@ namespace UnityUxmlGenerator.Extensions;
 
 internal static class BaseTypeDeclarationSyntaxExtensions
 {
+    public static bool InheritsFromAnyType(this BaseTypeDeclarationSyntax? @class)
+    {
+        return @class?.BaseList is not null && @class.BaseList.Types.Count != 0;
+    }
+
     public static bool InheritsFromFullyQualifiedName(this BaseTypeDeclarationSyntax @class,
         GeneratorExecutionContext context, string name)
     {

src/UnityUxmlGenerator/Extensions/BaseTypeDeclarationSyntaxExtensions.cs

@@ -0,0 +1,11 @@
+using Microsoft.CodeAnalysis.CSharp.Syntax;
+
+namespace UnityUxmlGenerator.Extensions;
+
+internal static class PropertySyntaxExtensions
+{
+    public static string GetName(this PropertyDeclarationSyntax property)
+    {
+        return property.Identifier.Text;
+    }
+}

src/UnityUxmlGenerator/Extensions/PropertySyntaxExtensions.cs

@@ -4,6 +4,11 @@ namespace UnityUxmlGenerator.Extensions;
 
 internal static class StringExtensions
 {
+    public static string FirstCharToUpper(this string str)
+    {
+        return $"{char.ToUpper(str[0])}{str.Substring(1)}";
+    }
+
     public static string ToPrivateFieldName(this string propertyName)
     {
         return string.Concat("_", char.ToLower(propertyName[0]), propertyName.Substring(1));

src/UnityUxmlGenerator/Extensions/StringExtensions.cs

@@ -0,0 +1,70 @@
+using Microsoft.CodeAnalysis.CSharp;
+using Microsoft.CodeAnalysis.CSharp.Syntax;
+
+namespace UnityUxmlGenerator.Extensions;
+
+internal static class TypeSyntaxExtensions
+{
+    public static bool IsBoolType(this TypeSyntax typeSyntax)
+    {
+        if (typeSyntax is PredefinedTypeSyntax predefinedTypeSyntax)
+        {
+            return IsBoolType(predefinedTypeSyntax);
+        }
+
+        return IsBoolKind(typeSyntax.RawKind);
+    }
+
+    public static bool IsBoolType(this PredefinedTypeSyntax typeSyntax)
+    {
+        return IsBoolKind(typeSyntax.Keyword.RawKind);
+    }
+
+    public static bool IsStringType(this TypeSyntax typeSyntax)
+    {
+        if (typeSyntax is PredefinedTypeSyntax predefinedTypeSyntax)
+        {
+            return IsStringType(predefinedTypeSyntax);
+        }
+
+        return IsStringKind(typeSyntax.RawKind);
+    }
+
+    public static bool IsStringType(this PredefinedTypeSyntax typeSyntax)
+    {
+        return IsStringKind(typeSyntax.Keyword.RawKind);
+    }
+
+    public static bool IsNumericType(this TypeSyntax typeSyntax)
+    {
+        if (typeSyntax is PredefinedTypeSyntax predefinedTypeSyntax)
+        {
+            return IsNumericType(predefinedTypeSyntax);
+        }
+
+        return IsNumericKind(typeSyntax.RawKind);
+    }
+
+    public static bool IsNumericType(this PredefinedTypeSyntax typeSyntax)
+    {
+        return IsNumericKind(typeSyntax.Keyword.RawKind);
+    }
+
+    private static bool IsBoolKind(int rawKind)
+    {
+        return rawKind == (int) SyntaxKind.BoolKeyword;
+    }
+
+    private static bool IsStringKind(int rawKind)
+    {
+        return rawKind == (int) SyntaxKind.StringKeyword;
+    }
+
+    private static bool IsNumericKind(int rawKind)
+    {
+        return rawKind == (int) SyntaxKind.IntKeyword ||
+               rawKind == (int) SyntaxKind.LongKeyword ||
+               rawKind == (int) SyntaxKind.FloatKeyword ||
+               rawKind == (int) SyntaxKind.DoubleKeyword;
+    }
+}

src/UnityUxmlGenerator/Extensions/TypeSyntaxExtensions.cs

@@ -0,0 +1,11 @@
+using Microsoft.CodeAnalysis.CSharp.Syntax;
+
+namespace UnityUxmlGenerator.Structs;
+
+public ref struct UxmlAttributeInfo
+{
+    public string TypeIdentifier { get; set; }
+    public string PrivateFieldName { get; set; }
+    public string AttributeUxmlName { get; set; }
+    public ExpressionSyntax DefaultValueAssignmentExpression { get; set; }
+}

src/UnityUxmlGenerator/Structs/UxmlAttributeInfo.cs

@@ -0,0 +1,19 @@
+using Microsoft.CodeAnalysis;
+using UnityUxmlGenerator.Diagnostics;
+
+namespace UnityUxmlGenerator.SyntaxReceivers;
+
+internal abstract class BaseReceiver : ISyntaxReceiver
+{
+    private readonly List<Diagnostic> _diagnostics = new();
+
+    public IEnumerable<Diagnostic> Diagnostics => _diagnostics;
+
+    public abstract void OnVisitSyntaxNode(SyntaxNode syntaxNode);
+
+    protected void RegisterDiagnostic(DiagnosticDescriptor diagnosticDescriptor, Location location,
+        params object[] args)
+    {
+        _diagnostics.Add(diagnosticDescriptor.CreateDiagnostic(location, args));
+    }
+}

src/UnityUxmlGenerator/SyntaxReceivers/BaseReceiver.cs

@@ -5,15 +5,15 @@
 
 namespace UnityUxmlGenerator.SyntaxReceivers;
 
-internal sealed class UxmlFactoryReceiver : ISyntaxReceiver
+internal sealed class UxmlFactoryReceiver : BaseReceiver
 {
     private const string AttributeName = "UxmlElement";
 
     private readonly List<UxmlFactoryCapture> _captures = new();
 
     public IEnumerable<UxmlFactoryCapture> Captures => _captures;
 
-    public void OnVisitSyntaxNode(SyntaxNode syntaxNode)
+    public override void OnVisitSyntaxNode(SyntaxNode syntaxNode)
     {
         if (syntaxNode is not AttributeSyntax
             {
@@ -25,11 +25,13 @@ public void OnVisitSyntaxNode(SyntaxNode syntaxNode)
 
         var @class = attribute.GetParent<ClassDeclarationSyntax>();
 
-        if (@class?.BaseList is null || @class.BaseList.Types.Count == 0)
+        if (@class.InheritsFromAnyType())
         {
-            return;
+            _captures.Add(new UxmlFactoryCapture(@class!));
+        }
+        else if (@class is not null)
+        {
+            RegisterDiagnostic(ClassHasNoBaseClassError, @class.GetLocation(), @class.Identifier.Text);
         }
-
-        _captures.Add(new UxmlFactoryCapture(@class));
     }
 }