fix il codegen: should skip process type which is not an INodeData (#156)

quabug · web-flow · commit 08f60a8aa0e4 · 2021-03-06T01:12:53.000+08:00
* able to ignore certain behavior node for testing purpose.

* fix il codegen: should skip process type which is not an `INodeData`

* update version.
diff --git a/.gitignore b/.gitignore
@@ -67,3 +67,5 @@ Assets/Plugins/Animancer/Examples.meta
 /Packages/samples/Samples
 /Packages/samples/Samples.meta
 !/Packages/samples/Samples~
+Assets/Plugins/
+Assets/Plugins.meta
diff --git a/Packages/codegen.meta b/Packages/codegen.meta
diff --git a/Packages/codegen/Editor/AccessorAttributeILPostProcessor.cs b/Packages/codegen/Editor/AccessorAttributeILPostProcessor.cs
@@ -15,7 +15,7 @@ public bool Generate(AssemblyDefinition assemblyDefinition)
         {
             Logger.Debug($"generate accessor attributes for {assemblyDefinition.Name}");
             var methods = assemblyDefinition.MainModule.GetAllTypes()
-                .Where(type => typeof(INodeData).IsAssignableFrom(type) && type.IsClass && !type.IsAbstract)
+                .Where(type => type.IsClass && !type.IsAbstract && type.TypeImplements(typeof(INodeData)))
                 .SelectMany(FetchNodeDataMethods)
                 .Where(method => !method.CustomAttributes.FindAccessorAttributes().Any())
             ;
diff --git a/Packages/codegen/Editor/CecilExtension.cs b/Packages/codegen/Editor/CecilExtension.cs
@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Reflection;
+using EntitiesBT.Core;
 using JetBrains.Annotations;
 using Mono.Cecil;
 using Mono.Collections.Generic;
@@ -177,5 +178,7 @@ public static string GetCodeName(this FieldDefinition fieldDefinition)
 	        }
 	        return name;
         }
+        public static bool IsINodeDataStruct(this TypeDefinition typeDefinition) =>
+            typeDefinition.TypeImplements(typeof(INodeData)) && typeDefinition.IsValueType();
     }
 }
diff --git a/Packages/codegen/Editor/Unity.EntitiesBT.CodeGen.asmdef b/Packages/codegen/Editor/Unity.EntitiesBT.CodeGen.asmdef
@@ -2,7 +2,8 @@
     "name": "Unity.EntitiesBT.CodeGen",
     "rootNamespace": "EntitiesBT.CodeGen.Editor",
     "references": [
-        "GUID:c7babe7561eb244059259745ef27b866"
+        "GUID:c7babe7561eb244059259745ef27b866",
+        "GUID:3d9288551f5f1b14b9fcbd11fd97a391"
     ],
     "includePlatforms": [],
     "excludePlatforms": [],
diff --git a/Packages/codegen/EntitiesExtension.meta b/Packages/codegen/EntitiesExtension.meta
diff --git a/Packages/codegen/EntitiesExtension/Unity.Entities.CodeGen.Ref.asmref b/Packages/codegen/EntitiesExtension/Unity.Entities.CodeGen.Ref.asmref
@@ -0,0 +1,3 @@
+{
+    "reference": "GUID:3d9288551f5f1b14b9fcbd11fd97a391"
+}
diff --git a/Packages/codegen/EntitiesExtension/Unity.Entities.CodeGen.Ref.asmref.meta b/Packages/codegen/EntitiesExtension/Unity.Entities.CodeGen.Ref.asmref.meta
diff --git a/Packages/codegen/EntitiesExtension/UnityEntitiesExtensions.cs b/Packages/codegen/EntitiesExtension/UnityEntitiesExtensions.cs
@@ -0,0 +1,15 @@
+using System;
+using Mono.Cecil;
+using Unity.Entities.CodeGen;
+
+namespace EntitiesBT.CodeGen.Editor
+{
+    public static class UnityEntitiesExtensions
+    {
+        public static bool IsValueType(this TypeReference typeReference) =>
+            TypeReferenceExtensions.IsValueType(typeReference);
+
+        public static bool TypeImplements(this TypeReference typeReference, Type interfaceType) =>
+            TypeReferenceExtensions.TypeImplements(typeReference, interfaceType);
+    }
+}
diff --git a/Packages/codegen/EntitiesExtension/UnityEntitiesExtensions.cs.meta b/Packages/codegen/EntitiesExtension/UnityEntitiesExtensions.cs.meta
diff --git a/Packages/codegen/Tests~/TestCodeGenForNode.cs b/Packages/codegen/Tests~/TestCodeGenForNode.cs
@@ -29,9 +29,10 @@ public void should_avoid_generate_attributes_on_method_already_has_attributes()
             // Assert.AreEqual(ComponentType.ReadOnly<bool>(), resetRO.Single());
         }
 
+        [BehaviorNode("E683A98D-96D3-4EFE-B5E4-250F92441B3B", Ignore = true)]
         class TestManualNode : INodeData
         {
-            [ReadWrite(typeof(ulong))]
+            [ReadWrite(typeof(double))]
             public NodeState Tick<TNodeBlob, TBlackboard>(int index, ref TNodeBlob blob, ref TBlackboard bb) where TNodeBlob : struct, INodeBlob where TBlackboard : struct, IBlackboard
             {
                 bb.GetData<int>();
@@ -71,12 +72,14 @@ public void should_generate_accessor_attribute_by_function_call_of_method()
         struct FooComponent : IComponentData {}
         struct BarComponent : IComponentData {}
 
+        [BehaviorNode("D4C33711-96CB-448B-BD6E-182271E2D69F", Ignore = true)]
         class TestNode : INodeData
         {
+
             public NodeState Tick<TNodeBlob, TBlackboard>(int index, ref TNodeBlob blob, ref TBlackboard bb) where TNodeBlob : struct, INodeBlob where TBlackboard : struct, IBlackboard
             {
                 bb.GetData<FooComponent>();
-                bb.GetDataPtrRW(typeof(byte));
+                bb.GetDataPtrRW(typeof(double));
                 ReadOnlyCalli(typeof(int));
                 ReadOnlyCallvirt<float>();
                 ReadWriteBar();
@@ -88,7 +91,7 @@ public void Reset<TNodeBlob, TBlackboard>(int index, ref TNodeBlob blob, ref TBl
             {
                 ReadOnlyDelgate readOnlyDelegate = ReadOnlyCalli;
                 readOnlyDelegate(typeof(FooComponent));
-                ComplexCall<ulong, float>(0);
+                ComplexCall<long, float>(0);
             }
 
             delegate void ReadOnlyDelgate([ReadOnly] Type type);
@@ -102,7 +105,7 @@ public virtual void ReadOnlyCallvirt<[ReadOnly] T>() {}
             [ReadWrite(typeof(long)), ReadOnly(typeof(ushort), typeof(uint))]
             public void ComplexCall<[ReadOnly] T, [ReadWrite] U>([ReadWrite] double d) {}
 
-            static void StaticCall([ReadOnly] ulong _) {}
+            static void StaticCall([ReadOnly] long _) {}
         }
     }
 }
diff --git a/Packages/codegen/package.json b/Packages/codegen/package.json
@@ -1,7 +1,7 @@
 {
   "name": "com.quabug.entities-bt.codegen",
   "description": "Behavior Tree for Unity Entities - ILCodeGen",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "unity": "2020.2",
   "displayName": "EntitiesBT - IL CodeGen",
   "samples": [
diff --git a/Packages/essential/Runtime/Core/BehaviorNodeAttribute.cs b/Packages/essential/Runtime/Core/BehaviorNodeAttribute.cs
@@ -18,7 +18,8 @@ public class BehaviorNodeAttribute : Attribute
         public Guid Guid { get; } 
         public int Id { get; }
         public BehaviorNodeType Type { get; }
-        
+        public bool Ignore = false;
+
         public BehaviorNodeAttribute([NotNull] string guid, BehaviorNodeType type = BehaviorNodeType.Action)
         {
             Type = type;
diff --git a/Packages/essential/Runtime/Core/MetaNodeRegister.cs b/Packages/essential/Runtime/Core/MetaNodeRegister.cs
@@ -61,7 +61,7 @@ static MetaNodeRegister()
             foreach (var type in BEHAVIOR_TREE_ASSEMBLY_TYPES.Value)
             {
                 var attribute = type.GetCustomAttribute<BehaviorNodeAttribute>();
-                if (attribute == null) continue;
+                if (attribute == null || attribute.Ignore) continue;
                 if (nodes.ContainsKey(attribute.Id)) throw new DuplicateNameException($"Node {type}[{attribute.Id}] already registered");
 
                 nodes[attribute.Id] = new Node(
@@ -133,8 +133,8 @@ static MetaNodeRegister()
             {
                 var attribute = type.GetCustomAttribute<BehaviorNodeAttribute>();
                 nodes[attribute.Id] = new Node {
-                  Reset = CreateDelegate<ResetFunc>("Reset", type)
-                  , Tick = CreateDelegate<TickFunc>("Tick", type)
+                  Reset = CreateDelegate<ResetFunc>(nameof(Reset), type)
+                  , Tick = CreateDelegate<TickFunc>(nameof(Tick), type)
                 };
             }
             NODES = new ReadOnlyDictionary<int, Node>(nodes);
diff --git a/Packages/essential/package.json b/Packages/essential/package.json
@@ -1,11 +1,11 @@
 {
   "name": "com.quabug.entities-bt.essential",
   "description": "Behavior Tree for Unity Entities - Essential",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "unity": "2020.2",
   "displayName": "EntitiesBT - Essential",
   "dependencies": {
     "com.unity.entities": "0.14.0-preview.19",
-    "com.quabug.entities-bt.codegen": "1.0.1"
+    "com.quabug.entities-bt.codegen": "1.0.2"
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public bool Generate(AssemblyDefinition assemblyDefinition)`
`15`	`15`	`{`
`16`	`16`	`Logger.Debug($"generate accessor attributes for {assemblyDefinition.Name}");`
`17`	`17`	`var methods = assemblyDefinition.MainModule.GetAllTypes()`
`18`		`- .Where(type => typeof(INodeData).IsAssignableFrom(type) && type.IsClass && !type.IsAbstract)`
	`18`	`+ .Where(type => type.IsClass && !type.IsAbstract && type.TypeImplements(typeof(INodeData)))`
`19`	`19`	`.SelectMany(FetchNodeDataMethods)`
`20`	`20`	`.Where(method => !method.CustomAttributes.FindAccessorAttributes().Any())`
`21`	`21`	`;`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`	`using System.Collections.Generic;`
`3`	`3`	`using System.Linq;`
`4`	`4`	`using System.Reflection;`
	`5`	`+using EntitiesBT.Core;`
`5`	`6`	`using JetBrains.Annotations;`
`6`	`7`	`using Mono.Cecil;`
`7`	`8`	`using Mono.Collections.Generic;`
`@@ -177,5 +178,7 @@ public static string GetCodeName(this FieldDefinition fieldDefinition)`
`177`	`178`	`}`
`178`	`179`	`return name;`
`179`	`180`	`}`
	`181`	`+ public static bool IsINodeDataStruct(this TypeDefinition typeDefinition) =>`
	`182`	`+ typeDefinition.TypeImplements(typeof(INodeData)) && typeDefinition.IsValueType();`
`180`	`183`	`}`
`181`	`184`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "reference": "GUID:3d9288551f5f1b14b9fcbd11fd97a391"`
	`3`	`+}`