com.wallstop-studios.dxmessaging 1.0.6 → 2.0.0-rc02

package/Editor/Analyzers/Microsoft.CodeAnalysis.CSharp.dll.meta

@@ -0,0 +1,33 @@
+fileFormatVersion: 2
+guid: f3159f12192b58547a5f8576eeca5fcf
+PluginImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  iconMap: {}
+  executionOrder: {}
+  defineConstraints: []
+  isPreloaded: 0
+  isOverridable: 1
+  isExplicitlyReferenced: 0
+  validateReferences: 1
+  platformData:
+  - first:
+      Any: 
+    second:
+      enabled: 0
+      settings: {}
+  - first:
+      Editor: Editor
+    second:
+      enabled: 1
+      settings:
+        DefaultValueInitialized: true
+  - first:
+      Windows Store Apps: WindowsStoreApps
+    second:
+      enabled: 0
+      settings:
+        CPU: AnyCPU
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Editor/Analyzers/Microsoft.CodeAnalysis.dll.meta

@@ -0,0 +1,33 @@
+fileFormatVersion: 2
+guid: 8292b8f0b3241d94db97183f9ebc34bd
+PluginImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  iconMap: {}
+  executionOrder: {}
+  defineConstraints: []
+  isPreloaded: 0
+  isOverridable: 1
+  isExplicitlyReferenced: 0
+  validateReferences: 1
+  platformData:
+  - first:
+      Any: 
+    second:
+      enabled: 1
+      settings: {}
+  - first:
+      Editor: Editor
+    second:
+      enabled: 0
+      settings:
+        DefaultValueInitialized: true
+  - first:
+      Windows Store Apps: WindowsStoreApps
+    second:
+      enabled: 0
+      settings:
+        CPU: AnyCPU
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Editor/Analyzers/System.Reflection.Metadata.dll.meta

@@ -0,0 +1,33 @@
+fileFormatVersion: 2
+guid: b8c642df60408714396e9c4b38f80233
+PluginImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  iconMap: {}
+  executionOrder: {}
+  defineConstraints: []
+  isPreloaded: 0
+  isOverridable: 1
+  isExplicitlyReferenced: 0
+  validateReferences: 1
+  platformData:
+  - first:
+      Any: 
+    second:
+      enabled: 1
+      settings: {}
+  - first:
+      Editor: Editor
+    second:
+      enabled: 0
+      settings:
+        DefaultValueInitialized: true
+  - first:
+      Windows Store Apps: WindowsStoreApps
+    second:
+      enabled: 0
+      settings:
+        CPU: AnyCPU
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Editor/Analyzers/WallstopStudios.DxMessaging.SourceGenerators.dll.meta

@@ -0,0 +1,71 @@
+fileFormatVersion: 2
+guid: 6276058efb4d05248b64a4295f60baf6
+labels:
+- RoslynAnalyzer
+PluginImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  iconMap: {}
+  executionOrder: {}
+  defineConstraints: []
+  isPreloaded: 0
+  isOverridable: 1
+  isExplicitlyReferenced: 0
+  validateReferences: 1
+  platformData:
+  - first:
+      : Any
+    second:
+      enabled: 0
+      settings:
+        Exclude Editor: 1
+        Exclude Linux64: 1
+        Exclude OSXUniversal: 1
+        Exclude Win: 1
+        Exclude Win64: 1
+  - first:
+      Any: 
+    second:
+      enabled: 0
+      settings: {}
+  - first:
+      Editor: Editor
+    second:
+      enabled: 0
+      settings:
+        CPU: AnyCPU
+        DefaultValueInitialized: true
+        OS: AnyOS
+  - first:
+      Standalone: Linux64
+    second:
+      enabled: 0
+      settings:
+        CPU: AnyCPU
+  - first:
+      Standalone: OSXUniversal
+    second:
+      enabled: 0
+      settings:
+        CPU: None
+  - first:
+      Standalone: Win
+    second:
+      enabled: 0
+      settings:
+        CPU: x86
+  - first:
+      Standalone: Win64
+    second:
+      enabled: 0
+      settings:
+        CPU: x86_64
+  - first:
+      Windows Store Apps: WindowsStoreApps
+    second:
+      enabled: 0
+      settings:
+        CPU: AnyCPU
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Editor/Analyzers.meta

@@ -0,0 +1,8 @@
+fileFormatVersion: 2
+guid: 4272e6b69476a4b469ebd2f65090da2b
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Editor/SetupCscRsp.cs

@@ -0,0 +1,146 @@
+#if UNITY_EDITOR
+
+namespace DxMessaging.Editor
+{
+    using System;
+    using System.Collections.Generic;
+    using System.IO;
+    using System.Linq;
+    using UnityEditor;
+    using UnityEngine;
+    using Object = UnityEngine.Object;
+
+    [InitializeOnLoad]
+    public static class SetupCscRsp
+    {
+        private static readonly string RspFilePath =
+            Path.Combine(Application.dataPath, "..", "csc.rsp").Replace("\\", "/");
+
+        private static readonly string AnalyzerPathRelative =
+            "Packages/com.wallstop-studios.dxmessaging/Editor/Analyzers/";
+
+        private static readonly string LibraryPathRelative =
+            "Library/PackageCache/com.wallstop-studios.dxmessaging/Editor/Analyzers/";
+
+        private static readonly string SourceGeneratorDllName = "WallstopStudios.DxMessaging.SourceGenerators.dll";
+
+        private static readonly string[] RequiredDllNames =
+        {
+            SourceGeneratorDllName,
+            "Microsoft.CodeAnalysis.dll",
+            "Microsoft.CodeAnalysis.CSharp.dll",
+            "System.Reflection.Metadata.dll"
+        };
+
+        private static readonly string LibraryArgument = $"-a:\"{LibraryPathRelative}\"";
+
+        static SetupCscRsp()
+        {
+            EditorApplication.delayCall += EnsureCscRsp;
+            EditorApplication.delayCall += EnsureDLLsExistInAssets;
+        }
+
+        private static void EnsureDLLsExistInAssets()
+        {
+            HashSet<string> dllNames = new();
+            foreach (string dllGuid in AssetDatabase.FindAssets("t:DefaultAsset", new[] { "Assets" }))
+            {
+                string dllPath = AssetDatabase.GUIDToAssetPath(dllGuid);
+                if (!dllPath.EndsWith(".dll"))
+                {
+                    continue;
+                }
+
+                string dllName = Path.GetFileName(dllPath);
+                dllNames.Add(dllName);
+            }
+
+            string[] dllRelativeDirectories = { LibraryPathRelative, AnalyzerPathRelative };
+
+            bool anyFound = false;
+            foreach (string requiredDllName in RequiredDllNames.Where(dllName => !dllNames.Contains(dllName)))
+            {
+                bool found = false;
+                foreach (string relativeDirectory in dllRelativeDirectories)
+                {
+                    try
+                    {
+                        string sourceFile = $"{relativeDirectory}{requiredDllName}";
+                        if (!File.Exists(sourceFile))
+                        {
+                            continue;
+                        }
+
+                        const string pluginsDirectory = "Assets/Plugins/WallstopStudios.DxMessaging/";
+                        string outputAsset = $"{pluginsDirectory}{requiredDllName}";
+                        Directory.CreateDirectory(pluginsDirectory);
+                        if (!File.Exists(outputAsset))
+                        {
+                            File.Copy($"{relativeDirectory}{requiredDllName}", outputAsset);
+                            AssetDatabase.ImportAsset(outputAsset);
+                            found = true;
+                        }
+
+                        if (requiredDllName == SourceGeneratorDllName)
+                        {
+                            Object loadedDll = AssetDatabase.LoadMainAssetAtPath(outputAsset);
+                            AssetDatabase.SetLabels(loadedDll, new[] { "RoslynAnalyzer" });
+                        }
+                        
+                        PluginImporter importer = AssetImporter.GetAtPath(outputAsset) as PluginImporter;
+                        if (importer != null)
+                        {
+                            importer.SetCompatibleWithAnyPlatform(false);
+                            importer.SetExcludeFromAnyPlatform("Editor", false);
+                            importer.SetExcludeFromAnyPlatform("Standalone", false);
+                            importer.SaveAndReimport();
+                        }
+
+                        break;
+                    }
+                    catch (Exception e)
+                    {
+                        Debug.LogError($"Failed to copy {requiredDllName} to Assets, failed with {e}.");
+                    }
+                }
+
+                anyFound |= found;
+                Debug.Log(
+                    $"Missing required dll '{requiredDllName}', " +
+                    $"{(found ? "creation successful." : "WARNING! Manual creation required.")}");
+            }
+
+            if (anyFound)
+            {
+                AssetDatabase.Refresh();
+            }
+        }
+
+        private static void EnsureCscRsp()
+        {
+            try
+            {
+                if (!File.Exists(RspFilePath))
+                {
+                    File.WriteAllText(RspFilePath, string.Empty);
+                    AssetDatabase.ImportAsset("csc.rsp");
+                }
+
+                string rspContent = File.ReadAllText(RspFilePath);
+                if (rspContent.Contains(LibraryArgument))
+                {
+                    return;
+                }
+
+                File.AppendAllText(RspFilePath, $"{LibraryArgument}\n");
+                AssetDatabase.ImportAsset("csc.rsp");
+                Debug.Log("Updated csc.rsp.");
+            }
+            catch (IOException ex)
+            {
+                Debug.LogError($"Failed to modify csc.rsp: {ex}");
+            }
+        }
+    }
+}
+#endif

package/Editor/SetupCscRsp.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 54bd01ff5fd34bbc9950a1c7230a15d8
+timeCreated: 1730841461

package/Editor/WallstopStudios.DxMessaging.Editor.asmdef

@@ -0,0 +1,18 @@
+{
+    "name": "WallstopStudios.DxMessaging.Editor",
+    "rootNamespace": "DxMessaging.Editor",
+    "references": [
+        "WallstopStudios.DxMessaging"
+    ],
+    "includePlatforms": [
+        "Editor"
+    ],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [],
+    "autoReferenced": true,
+    "defineConstraints": [],
+    "versionDefines": [],
+    "noEngineReferences": false
+}

package/Editor/WallstopStudios.DxMessaging.Editor.asmdef.meta

@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 4be90ea11db262f43913b0e065a25c7f
+AssemblyDefinitionImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/README.md

@@ -17,12 +17,12 @@ This project has a dependency on my [`Unity Helpers`](https://github.com/wallsto
 DxMessaging is currently a bit slower (2-3x) than Unity's built in messaging solution (when running in Unity). [Source](./Tests/Runtime/Benchmarks/PerformanceTests.cs).
 | Message Tech | Operations / Second |
 | ------------ | ------------------- |
-| Unity | 1,908,539 |
-| DxMessaging (GameObject) - Normal | 729,221 |
-| DxMessaging (Component) - Normal | 740,140 |
-| DxMessaging (GameObject) - No-Copy | 720,678 |
-| DxMessaging (Component) - No-Copy | 754,243 |
-| DxMessaging (Untargeted) - No-Copy | 1,176,809 |
+| Unity | 2,101,721 |
+| DxMessaging (GameObject) - Normal | 889,760 |
+| DxMessaging (Component) - Normal | 869,437 |
+| DxMessaging (GameObject) - No-Copy | 871,880 |
+| DxMessaging (Component) - No-Copy | 899,361 |
+| DxMessaging (Untargeted) - No-Copy | 1,239,673 |
 
 # Functionality
 While not as fast, DxMessaging offers *additional functionality* as compared to Unity's messaging solution.
@@ -69,6 +69,43 @@ Please note, if you want to receive messages and inherit off of the `MessageAwar
 
 If you wish to use any of these methods in components that inherit from `MessageAwareComponent`, please make sure to have the overrides call the base methods, otherwise messaging *may break* or not work as expected.
 
+## Integration - Source Generators (v2 and above)
+I'm piloting some new tech in version 2 of this library. Currently, if implementing any of the message interfaces, there will be boxing performed on the messages, if they are structs. This is due to the nature of default interface methods, which I was not aware of.
+
+To get around this, I have updated both the Unity Helpers dependent package, as well as this package, to take advantage of Roslyn Source Generators.
+
+Requirements:
+1. Use one of `DxTargetedMessage, DxBroadcastMessage, DxUntargetedMessage` depending on message requirement.
+2. Ensure that the struct or class is marked as `partial`. 
+
+To use:
+```csharp
+[DxTargetedMessage]
+public partial struct SimpleTargetedMessage // No longer needed : ITargetedMessage<SimpleTargetedMessage>
+{
+}
+
+[DxBroadcastMessage]
+public partial struct SimpleBroadcastMessage // No longer needed : IBroadcastMessage<SimpleBroadcastMessage>
+{
+}
+
+[DxUntargetedMessage]
+public partial struct SimpleUntargetedMessage // No longer needed : IUntargetedMesssage<SimpleUntargetedMessage>
+{
+}
+```
+
+Or, if you already have messages, you can leave the interface implementations as-is and get a no-boxing implementation with the `DxAutoMessageType` attribute. `partial` is still required.
+
+To use:
+```csharp
+[DxAutoMessageType]
+public partial struct SimpleTargetedMessage : ITargetedMessage<SimpleTargetedMessage>
+{
+}
+```
+
 ## Integration
 See the [tests](./Tests/Runtime/Scripts/) directory for examples about how to integrate with the MessageAwareComponent. But, for some starters:
 ```csharp

package/Runtime/Core/Attributes/DxAutoMessageTypeAttribute.cs

@@ -0,0 +1,9 @@
+namespace DxMessaging.Core.Attributes
+{
+    using System;
+
+    [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct)]
+    public sealed class DxAutoMessageTypeAttribute : Attribute
+    {
+    }
+}

package/Runtime/Core/Attributes/DxAutoMessageTypeAttribute.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 01e2bf7a935a4389be6e63a79b36723e
+timeCreated: 1730779085

package/Runtime/Core/Attributes/DxBroadcastMessageAttribute.cs

@@ -0,0 +1,10 @@
+namespace DxMessaging.Core.Attributes
+{
+    using System;
+
+    [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct)]
+    public sealed class DxBroadcastMessageAttribute : Attribute
+    {
+        
+    }
+}

package/Runtime/Core/Attributes/DxBroadcastMessageAttribute.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 73fd653a34be4f36b5773dce342ae9fa
+timeCreated: 1730779174

package/Runtime/Core/Attributes/DxTargetedMessageAttribute.cs

@@ -0,0 +1,10 @@
+namespace DxMessaging.Core.Attributes
+{
+    using System;
+
+    [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct)]
+    public sealed class DxTargetedMessageAttribute : Attribute
+    {
+        
+    }
+}

package/Runtime/Core/Attributes/DxTargetedMessageAttribute.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: ab2509dd51f5467d95b4fca1cb794b29
+timeCreated: 1730779159

package/Runtime/Core/Attributes/DxUntargetedMessageAttribute.cs

@@ -0,0 +1,10 @@
+namespace DxMessaging.Core.Attributes
+{
+    using System;
+
+    [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct)]
+    public sealed class DxUntargetedMessageAttribute : Attribute
+    {
+        
+    }
+}

package/Runtime/Core/Attributes/DxUntargetedMessageAttribute.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 418b461df3764ef6896dc86524a00132
+timeCreated: 1730779131

package/Runtime/Core/Attributes.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: e2cb23a56cf1416ba06dccca58c8297f
+timeCreated: 1730779055

package/Runtime/WallstopStudios.DxMessaging.asmdef

@@ -1,18 +1,16 @@
-{
-    "name": "WallstopStudios.DxMessaging",
-    "rootNamespace": "DxMessaging",
-    "references": [],
-    "includePlatforms": [],
-    "excludePlatforms": [],
-    "allowUnsafeCode": false,
-    "overrideReferences": true,
-    "precompiledReferences": [
-        "System.Runtime.CompilerServices.Unsafe.dll"
-    ],
-    "autoReferenced": true,
-    "defineConstraints": [
-        "UNITY_2017_1_OR_NEWER"
-    ],
-    "versionDefines": [],
-    "noEngineReferences": false
+{
+    "name": "WallstopStudios.DxMessaging",
+    "rootNamespace": "DxMessaging",
+    "references": [],
+    "includePlatforms": [],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [
+        "System.Runtime.CompilerServices.Unsafe.dll"
+    ],
+    "autoReferenced": true,
+    "defineConstraints": [],
+    "versionDefines": [],
+    "noEngineReferences": false
 }

package/Runtime/WallstopStudios.DxMessaging.asmdef.meta

@@ -1,7 +1,7 @@
-fileFormatVersion: 2
-guid: 184635fd03dde55408891bd932619c81
-AssemblyDefinitionImporter:
-  externalObjects: {}
-  userData: 
-  assetBundleName: 
-  assetBundleVariant: 
+fileFormatVersion: 2
+guid: 184635fd03dde55408891bd932619c81
+AssemblyDefinitionImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/SourceGenerators/WallstopStudios.DxMessaging.SourceGenerators/DxAutoMessageTypeGenerator.cs

@@ -0,0 +1,75 @@
+namespace WallstopStudios.DxMessaging.SourceGenerators;
+
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using Microsoft.CodeAnalysis;
+using Microsoft.CodeAnalysis.CSharp;
+using Microsoft.CodeAnalysis.CSharp.Syntax;
+using Microsoft.CodeAnalysis.Text;
+
+[Generator]
+public sealed class DxAutoMessageTypeGenerator : ISourceGenerator
+{
+    public void Initialize(GeneratorInitializationContext context)
+    {
+        context.RegisterForSyntaxNotifications(() => new SyntaxReceiver());
+    }
+
+    public void Execute(GeneratorExecutionContext context)
+    {
+        if (context.SyntaxReceiver is not SyntaxReceiver receiver)
+        {
+            return;
+        }
+
+        INamedTypeSymbol attributeSymbol = context.Compilation.GetTypeByMetadataName("DxMessaging.Core.Attributes.DxAutoMessageTypeAttribute");
+
+        foreach (TypeDeclarationSyntax classDeclaration in receiver.CandidateClasses)
+        {
+            SemanticModel model = context.Compilation.GetSemanticModel(classDeclaration.SyntaxTree);
+            ISymbol classSymbol = ModelExtensions.GetDeclaredSymbol(model, classDeclaration);
+
+            if (classSymbol.GetAttributes().Any(
+                    attributeData => attributeData.AttributeClass.Equals(
+                        attributeSymbol, SymbolEqualityComparer.Default)))
+            {
+                string namespaceName = classSymbol.ContainingNamespace.ToDisplayString();
+                string className = classSymbol.Name;
+                string typeKind = classDeclaration.Kind() == SyntaxKind.ClassDeclaration ? "class" : "struct";
+
+                string source = $$"""
+
+                                  namespace {{namespaceName}}
+                                  {
+                                      public partial {{typeKind}} {{className}}
+                                      {
+                                          public System.Type MessageType => typeof({{className}});
+                                      }
+                                  }
+
+                                  """;
+
+                context.AddSource($"{className}_DxAutoMessageType.g.cs", SourceText.From(source, Encoding.UTF8));
+            }
+        }
+    }
+
+    private sealed class SyntaxReceiver : ISyntaxReceiver
+    {
+        public List<TypeDeclarationSyntax> CandidateClasses { get; } = [];
+
+        public void OnVisitSyntaxNode(SyntaxNode syntaxNode)
+        {
+            if (syntaxNode is TypeDeclarationSyntax typeDeclarationSyntax)
+            {
+                if (typeDeclarationSyntax.AttributeLists.Count > 0 &&
+                    (typeDeclarationSyntax.Kind() == SyntaxKind.ClassDeclaration ||
+                     typeDeclarationSyntax.Kind() == SyntaxKind.StructDeclaration))
+                {
+                    CandidateClasses.Add(typeDeclarationSyntax);
+                }
+            }
+        }
+    }
+}

package/SourceGenerators/WallstopStudios.DxMessaging.SourceGenerators/DxAutoMessageTypeGenerator.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: f6d3fd5024b56ce48b255e4d9b802b3b
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: