Add target binding tracing.

For platforms which do not support TraceSource, the tracing code is nop.

Author: yfakariya

Sync.xml

@@ -44,6 +44,7 @@
     <Preserve Path="Serialization\NonGenericMessagePackSerializer.cs" />
     <Preserve Path="Serialization\TypedMessagePackSerializerWrapper`1.cs" />
     <Preserve Path="Serialization\EnumTypedMessagePackSerializerWrapper`1.cs" />
+    <Preserve Path="Serialization\Tracer.cs" />
     <Preserve Path="CorLibOnlyHelper*.tt" />
     <Preserve Path="CorLibOnlyHelper*.cs" />
     <Preserve Path="MPContract.cs" />

src/MsgPack.Unity.Full/MsgPack.Unity.Full.csproj

@@ -38,7 +38,8 @@
   <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'CodeAnalysis|AnyCPU'">
     <OutputPath>bin\CodeAnalysis\</OutputPath>
     <DefineConstants>TRACE;UNITY_IPHONE;MSGPACK_UNITY_FULL;AOT;CODE_ANALYSIS</DefineConstants>
-    <DocumentationFile></DocumentationFile>
+    <DocumentationFile>
+    </DocumentationFile>
     <Optimize>true</Optimize>
     <NoWarn>3001,3002</NoWarn>
     <DebugType>pdbonly</DebugType>
@@ -709,6 +710,9 @@
     <Compile Include="..\MsgPack\Serialization\SerializingMember.cs">
       <Link>Serialization\SerializingMember.cs</Link>
     </Compile>
+    <Compile Include="..\MsgPack\Serialization\Tracer.cs">
+      <Link>Serialization\Tracer.cs</Link>
+    </Compile>
     <Compile Include="..\MsgPack\Serialization\TypeKeyRepository.cs">
       <Link>Serialization\TypeKeyRepository.cs</Link>
     </Compile>

src/MsgPack.Unity/MsgPack.Unity.csproj

@@ -719,6 +719,9 @@
     <Compile Include="..\MsgPack\Serialization\SerializingMember.cs">
       <Link>Serialization\SerializingMember.cs</Link>
     </Compile>
+    <Compile Include="..\MsgPack\Serialization\Tracer.cs">
+      <Link>Serialization\Tracer.cs</Link>
+    </Compile>
     <Compile Include="..\MsgPack\Serialization\TypeKeyRepository.cs">
       <Link>Serialization\TypeKeyRepository.cs</Link>
     </Compile>

src/MsgPack/Serialization/SerializationTarget.cs

@@ -31,6 +31,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Diagnostics;
 #if CORE_CLR || UNITY || NETSTANDARD1_1
 using Contract = MsgPack.MPContract;
 #else
@@ -70,6 +71,7 @@ internal class SerializationTarget
 
 		private SerializationTarget( IList<SerializingMember> members, ConstructorInfo constructor, string[] correspondingMemberNames, bool canDeserialize )
 		{
+			Trace( "SerializationTarget::ctor(canDeserialize: {0})", canDeserialize );
 			this.Members = members;
 			this.DeserializationConstructor = constructor;
 			this.IsConstructorDeserialization = constructor != null && constructor.GetParameters().Any();
@@ -286,21 +288,26 @@ private static bool DetermineCanDeserialize( ConstructorKind kind, Serialization
 		{
 			if ( HasUnpackableInterface( targetType, context ) )
 			{
+				Trace( "SerializationTarget::DetermineCanDeserialize({0}, {1}) -> true: HasUnpackableInterface", targetType, kind );
 				return true;
 			}
 
 			switch ( kind )
 			{
 				case ConstructorKind.Marked:
 				{
+					Trace( "SerializationTarget::DetermineCanDeserialize({0}, {1}) -> true: Marked", targetType, kind );
 					return true;
 				}
 				case ConstructorKind.Parameterful:
 				{
-					return HasAnyCorrespondingMembers( correspondingMemberNames );
+					var result = HasAnyCorrespondingMembers( correspondingMemberNames );
+					Trace( "SerializationTarget::DetermineCanDeserialize({0}, {1}) -> {2}: HasAnyCorrespondingMembers", targetType, kind, result );
+					return result;
 				}
 				case ConstructorKind.Default:
 				{
+					Trace( "SerializationTarget::DetermineCanDeserialize({0}, {1}) -> {2}: Default", targetType, kind, allowDefault );
 					return allowDefault;
 				}
 				default:
@@ -317,7 +324,7 @@ private static MemberInfo[] GetDistinctMembers( Type type )
 			var returningMemberNamesSet = new HashSet<string>();
 			while ( type != typeof( object ) && type != null )
 			{
-				var members = 
+				var members =
 #if !NETSTANDARD1_1 && !NETSTANDARD1_3
 					type.FindMembers(
 						MemberTypes.Field | MemberTypes.Property,
@@ -507,6 +514,9 @@ private static ConstructorInfo FindDeserializationConstructor( SerializationCont
 			// A constructor which has most parameters will be used.
 			var mostRichConstructors =
 				constructors.GroupBy( ctor => ctor.GetParameters().Length ).OrderByDescending( g => g.Key ).First().ToArray();
+#if DEBUG
+			Trace( "SerializationTarget::FindDeserializationConstructor.MostRich({0}) -> {1}", targetType, String.Join( ";", mostRichConstructors.Select( x => x.ToString() ).ToArray() ) );
+#endif // DEBUG
 			switch ( mostRichConstructors.Length )
 			{
 				case 1:
@@ -830,6 +840,14 @@ public override int GetHashCode( KeyValuePair<string, Type> obj )
 			}
 		}
 
+		[Conditional( "DEBUG" )]
+		private static void Trace( string format, params object[] args )
+		{
+#if !SILVERLIGHT && !WINDOWS_PHONE && !NETFX_CORE
+			Tracer.Binding.TraceEvent( Tracer.EventType.Trace, Tracer.EventId.Trace, format, args );
+#endif // !SILVERLIGHT && !WINDOWS_PHONE && !NETFX_CORE
+		}
+
 		private enum ConstructorKind
 		{
 			None = 0,

src/MsgPack/Serialization/Tracer.cs

@@ -1,8 +1,8 @@
-#region -- License Terms --
+#region -- License Terms --
 //
 // MessagePack for CLI
 //
-// Copyright (C) 2010-2016 FUJIWARA, Yusuke
+// Copyright (C) 2010-2017 FUJIWARA, Yusuke
 //
 //    Licensed under the Apache License, Version 2.0 (the "License");
 //    you may not use this file except in compliance with the License.
@@ -18,17 +18,22 @@
 //
 #endregion -- License Terms --
 
+#if UNITY_5 || UNITY_STANDALONE || UNITY_WEBPLAYER || UNITY_WII || UNITY_IPHONE || UNITY_ANDROID || UNITY_PS3 || UNITY_XBOX360 || UNITY_FLASH || UNITY_BKACKBERRY || UNITY_WINRT
+#define UNITY
+#endif
+
 using System;
 using System.Diagnostics;
-#if NETSTANDARD1_1 || NETSTANDARD1_3
+#if NETSTANDARD1_1 || NETSTANDARD1_3 || ( UNITY && !MSGPACK_UNITY_FULL )
 using System.Globalization;
-#endif // NETSTANDARD1_1 || NETSTANDARD1_3
+#endif // NETSTANDARD1_1 || NETSTANDARD1_3 || ( UNITY && !MSGPACK_UNITY_FULL )
 
 namespace MsgPack.Serialization
 {
 	internal static class Tracer
 	{
 		public static readonly TraceSource Emit = new TraceSource( "MsgPack.Serialization.Emit" );
+		public static readonly TraceSource Binding = new TraceSource( "MsgPack.Serialization.Binding" );
 		public static readonly TraceSource Tracing = new TraceSource( "MsgPack.Serialization.Tracing" );
 
 		public static class EventId
@@ -56,7 +61,7 @@ public static class EventType
 		}
 	}
 
-#if NETSTANDARD1_1 || NETSTANDARD1_3
+#if NETSTANDARD1_1 || NETSTANDARD1_3 || ( UNITY && !MSGPACK_UNITY_FULL )
 	internal enum TraceEventType
 	{
 		Critical = 1,
@@ -78,13 +83,17 @@ public TraceSource( string name )
 		[Conditional( "TRACE" )]
 		public void TraceEvent( TraceEventType eventType, int id, string format, params object[] args )
 		{
+#if !UNITY
 			Debug.WriteLine( String.Format( CultureInfo.InvariantCulture, "{0} {1}: {2} : {3}", this._name, eventType, id, String.Format( CultureInfo.InvariantCulture, format, args ) ) );
+#endif // !UNITY
 		}
 
 		[Conditional( "TRACE" )]
 		public void TraceData( TraceEventType eventType, int id, object data )
 		{
+#if !UNITY
 			Debug.WriteLine( String.Format( CultureInfo.InvariantCulture, "{0} {1}: {2} : {3}", this._name, eventType, id, data ) );
+#endif // !UNITY
 		}
 	}
 #endif // NETSTANDARD1_1 || NETSTANDARD1_3

test/MsgPack.UnitTest.Unity.Il2cpp.Full.Desktop/MsgPack.UnitTest.Unity.Il2cpp.Full.Desktop.csproj

@@ -755,6 +755,7 @@
       <Link>UnpackingTest.Scalar.cs</Link>
     </Compile>
     <Compile Include="Properties\AssemblyInfo.cs" />
+    <Compile Include="UnityTestHelper.cs" />
   </ItemGroup>
   <ItemGroup>
     <Service Include="{82A7F48D-3B50-4B1E-B82E-3ADA8210C358}" />

test/MsgPack.UnitTest.Unity.Il2cpp.Full.Desktop/UnityTestHelper.cs

@@ -0,0 +1,56 @@
+#region -- License Terms --
+//
+// MessagePack for CLI
+//
+// Copyright (C) 2010-2017 FUJIWARA, Yusuke
+//
+//    Licensed under the Apache License, Version 2.0 (the "License");
+//    you may not use this file except in compliance with the License.
+//    You may obtain a copy of the License at
+//
+//        http://www.apache.org/licenses/LICENSE-2.0
+//
+//    Unless required by applicable law or agreed to in writing, software
+//    distributed under the License is distributed on an "AS IS" BASIS,
+//    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//    See the License for the specific language governing permissions and
+//    limitations under the License.
+//
+#endregion -- License Terms --
+
+using System;
+using System.Diagnostics;
+
+using MsgPack.Serialization;
+
+namespace MsgPack
+{
+	public static class UnityTestHelper
+	{
+		public static void AddBindingTraceLogger( Action<string> logger )
+		{
+			Tracer.Binding.Switch.Level = SourceLevels.All;
+			Tracer.Binding.Listeners.Add( new DelegateTraceListener( logger ) );
+		}
+
+		private sealed class DelegateTraceListener : TraceListener
+		{
+			private readonly Action<string> _logger;
+
+			public DelegateTraceListener( Action<string> logger )
+			{
+			    this._logger = logger;
+			}
+
+			public override void Write( string message )
+			{
+				this._logger( message );
+			}
+
+			public override void WriteLine( string message )
+			{
+				this._logger( message );
+			}
+		}
+	}
+}

test/MsgPack.UnitTest.Unity.Il2cpp.Full/Assets/UnitTests/TestDrivers/UnitTestDriver.cs

@@ -94,6 +94,7 @@ private static void InitializeTestEngine()
 			TestExecutionContext context = new TestExecutionContext();
 			context.WorkDirectory = Environment.CurrentDirectory;
 			CallContext.SetData( "NUnit.Framework.TestContext", context );
+			//UnityTestHelper.AddBindingTraceLogger( m => UnityEngine.Debug.Log( m ) );
 		}
 
 		/// <summary>