Merge pull request #95 from hadashiA/ku/custom-formatter

[mruby] Support custom formatter
hadashiA · Oct 21, 2024 · fe85171 · fe85171
2 parents 274764e + 696c6a6
commit fe85171
Show file tree

Hide file tree

Showing 9 changed files with 66 additions and 42 deletions.
diff --git a/README.md b/README.md
@@ -1182,6 +1182,43 @@ See the table below for the support status of mutually convertible types.
 | `[Int, Int, Int, Int]`               | `RectInt`, `BoundsInt`, `Color32`                                                                                                                                                                                                                                                                                                                                                       |
 | `nil`                                | `T?`, `Nullable<T>`                                                                                                                                                                                                                                                                                                                                                                     |
 
+If you want to customize the formatting behavior, implement `IMrbValueFormatter` . 
+
+```csharp
+// Example type...
+public struct UserId
+{
+    public int Value;
+}
+
+public class UserIdFormatter : IMrbValueFormatter<UserId>
+{
+    public static readonly UserIdFormatter Instance = new();
+
+    public UserId Deserialize(MrbValue mrbValue, MRubyContext context, MrbValueSerializerOptions options)
+    {
+        if (mrbValue.IsNil) return default;
+        retun new UserId { Value = mrbValue.IntValue };
+    }
+}
+```
+
+To enable the custom formatter, set MrbValueSerializerOptions as follows.
+
+```csharp
+StaticCompositeResolver.Instance
+    .AddFormatters(UserIdFormatter.Instance)  // < Yoru custom formatters
+    .AddResolvers(StandardResolver.Instance); // < Default behaviours 
+
+// Set serializer options to context.
+var context = MRubyContext.Create(...);
+context.SerializerOptions = new MrbValueSerializerOptions
+{
+    Resolver = StaticCompositeResolver
+};
+```
+
+
 ### MRubyContext
 
 `MRubyContext` provides several APIs for executing mruby scripts.

diff --git a/src/VitalRouter.SourceGenerator.MRuby/VitalRouterMRubyIncrementalSourceGenerator.cs b/src/VitalRouter.SourceGenerator.MRuby/VitalRouterMRubyIncrementalSourceGenerator.cs
@@ -11,21 +11,6 @@ namespace VitalRouter.SourceGenerator.MRuby;
 [Generator]
 public class VitalRouterMRubyIncrementalSourceGenerator : IIncrementalGenerator
 {
-    class Comparer : IEqualityComparer<GeneratorAttributeSyntaxContext>
-    {
-        public static readonly Comparer Instance = new();
-
-        public bool Equals(GeneratorAttributeSyntaxContext x, GeneratorAttributeSyntaxContext y)
-        {
-            return x.TargetNode.Equals(y.TargetNode);
-        }
-
-        public int GetHashCode(GeneratorAttributeSyntaxContext obj)
-        {
-            return obj.TargetNode.GetHashCode();
-        }
-    }
-
     public void Initialize(IncrementalGeneratorInitializationContext context)
     {
         var commandPresetProvider = context.SyntaxProvider
@@ -536,7 +521,7 @@ partial class {{commandPresetTypeMeta.TypeName}}
         {
             if (!__Names.TryGetValue(commandName, out var index))
             {
-                script.Fail(new ArgumentOutOfRangeException(nameof(commandName), $"No such command {commandName} in {GetType().Name}. Please use `[MRubyCommand(...)]` attribute and register it."));
+                script.Fail(new ArgumentOutOfRangeException(nameof(commandName), $"No such command `{commandName}` in {GetType().Name}. Please use `[MRubyCommand(...)]` attribute and register it."));
                 return;
             }
 

diff --git a/src/VitalRouter.Unity/Assets/VitalRouter.MRuby/Runtime/MRubyContext.cs b/src/VitalRouter.Unity/Assets/VitalRouter.MRuby/Runtime/MRubyContext.cs
@@ -1,6 +1,5 @@
 using System;
 using System.Runtime.CompilerServices;
-using System.Runtime.ExceptionServices;
 using System.Runtime.InteropServices;
 using AOT;
 using Unity.Collections;
@@ -102,6 +101,9 @@ public class MRubyContext : SafeHandle
         [ThreadStatic]
         static bool captureScriptErrors;
 
+        public static Action<Exception> GlobalErrorHandler { get; set; } = OnScriptError;
+        public static Action<string> GlobalLogHandler { get; set; } = UnityEngine.Debug.Log;
+
         public static unsafe MRubyContext Create()
         {
             NativeMethods.MrbAllocfSet(MRubyAllocator.AllocPersistent);
@@ -120,9 +122,6 @@ public static MRubyContext Create(Router router, MRubyCommandPreset commandPrese
             return context;
         }
 
-        public static Action<Exception> GlobalErrorHandler { get; set; } = OnScriptError;
-        public static Action<string> GlobalLogHandler { get; set; } = UnityEngine.Debug.Log;
-
         static void OnScriptError(Exception ex)
         {
             if (captureScriptErrors)
@@ -136,6 +135,7 @@ static void OnScriptError(Exception ex)
         }
 
         public MRubySharedState SharedState { get; }
+        public MrbValueSerializerOptions SerializerOptions { get; set; } = MrbValueSerializerOptions.Default;
 
         public Router Router
         {
@@ -187,13 +187,13 @@ public void Load(ReadOnlySpan<byte> rubySource)
         public T? Evaluate<T>(string rubySource, MrbValueSerializerOptions? options = null)
         {
             var bytes = System.Text.Encoding.UTF8.GetBytes(rubySource);
-            return Evaluate<T>(bytes);
+            return Evaluate<T>(bytes, options);
         }
 
         public T? Evaluate<T>(ReadOnlySpan<byte> rubySource, MrbValueSerializerOptions? options = null)
         {
             using var result = EvaluateUnsafe(rubySource);
-            return MrbValueSerializer.Deserialize<T>(result.RawValue, this, options);
+            return MrbValueSerializer.Deserialize<T>(result.RawValue, this, options ?? SerializerOptions);
         }
 
         public MrbValueHandle EvaluateUnsafe(string rubySource)

diff --git a/src/VitalRouter.Unity/Assets/VitalRouter.MRuby/Runtime/NativeMethods.cs b/src/VitalRouter.Unity/Assets/VitalRouter.MRuby/Runtime/NativeMethods.cs
@@ -61,10 +61,12 @@ public struct MrbValueUnion
     [StructLayout(LayoutKind.Sequential)]
     public struct MrbValue
     {
-        public MrbValueUnion Value;
+        MrbValueUnion value;
         public MrbVtype TT;
 
-        public bool IsNil => TT == MrbVtype.MRB_TT_FALSE && Value.I == 0;
+        public bool IsNil => TT == MrbVtype.MRB_TT_FALSE && value.I == 0;
+        public long IntValue => value.I;
+        public double FlaotValue => value.F;
 
         public unsafe string ToString(MRubyContext context)
         {

diff --git a/src/VitalRouter.Unity/Assets/VitalRouter.MRuby/Runtime/Serialization/FixnumFormatters.cs b/src/VitalRouter.Unity/Assets/VitalRouter.MRuby/Runtime/Serialization/FixnumFormatters.cs
@@ -10,7 +10,7 @@ public byte Deserialize(MrbValue mrbValue, MRubyContext context, MrbValueSeriali
             {
                 throw new MRubySerializationException($"value is not a Integer. {mrbValue.TT}");
             }
-            return checked((byte)mrbValue.Value.I);
+            return checked((byte)mrbValue.IntValue);
         }
     }
 
@@ -24,7 +24,7 @@ public sbyte Deserialize(MrbValue mrbValue, MRubyContext context, MrbValueSerial
             {
                 throw new MRubySerializationException($"value is not a Integer. {mrbValue.TT}");
             }
-            return checked((sbyte)mrbValue.Value.I);
+            return checked((sbyte)mrbValue.IntValue);
         }
     }
 
@@ -38,7 +38,7 @@ public char Deserialize(MrbValue mrbValue, MRubyContext context, MrbValueSeriali
             {
                 throw new MRubySerializationException($"value is not a Integer. {mrbValue.TT}");
             }
-            return checked((char)mrbValue.Value.I);
+            return checked((char)mrbValue.IntValue);
         }
     }
 
@@ -52,7 +52,7 @@ public short Deserialize(MrbValue mrbValue, MRubyContext context, MrbValueSerial
             {
                 throw new MRubySerializationException($"value is not a Integer. {mrbValue.TT}");
             }
-            return checked((short)mrbValue.Value.I);
+            return checked((short)mrbValue.IntValue);
         }
     }
 
@@ -66,7 +66,7 @@ public int Deserialize(MrbValue mrbValue, MRubyContext context, MrbValueSerializ
             {
                 throw new MRubySerializationException($"value is not a Integer. {mrbValue.TT}");
             }
-            return checked((int)mrbValue.Value.I);
+            return checked((int)mrbValue.IntValue);
         }
     }
 
@@ -80,7 +80,7 @@ public long Deserialize(MrbValue mrbValue, MRubyContext context, MrbValueSeriali
             {
                 throw new MRubySerializationException($"value is not a Integer. {mrbValue.TT}");
             }
-            return checked((long)mrbValue.Value.I);
+            return checked((long)mrbValue.IntValue);
         }
     }
 
@@ -94,7 +94,7 @@ public ushort Deserialize(MrbValue mrbValue, MRubyContext context, MrbValueSeria
             {
                 throw new MRubySerializationException($"value is not a Integer. {mrbValue.TT}");
             }
-            return checked((ushort)mrbValue.Value.I);
+            return checked((ushort)mrbValue.IntValue);
         }
     }
 
@@ -108,7 +108,7 @@ public uint Deserialize(MrbValue mrbValue, MRubyContext context, MrbValueSeriali
             {
                 throw new MRubySerializationException($"value is not a Integer. {mrbValue.TT}");
             }
-            return checked((uint)mrbValue.Value.I);
+            return checked((uint)mrbValue.IntValue);
         }
     }
 
@@ -122,7 +122,7 @@ public ulong Deserialize(MrbValue mrbValue, MRubyContext context, MrbValueSerial
             {
                 throw new MRubySerializationException($"value is not a Integer. {mrbValue.TT}");
             }
-            return checked((ulong)mrbValue.Value.I);
+            return checked((ulong)mrbValue.IntValue);
         }
     }
 }
diff --git a/src/VitalRouter.Unity/Assets/VitalRouter.MRuby/Runtime/Serialization/FloatFormatter.cs b/src/VitalRouter.Unity/Assets/VitalRouter.MRuby/Runtime/Serialization/FloatFormatter.cs
@@ -8,8 +8,8 @@ public float Deserialize(MrbValue mrbValue, MRubyContext context, MrbValueSerial
         {
             return mrbValue.TT switch
             {
-                MrbVtype.MRB_TT_FLOAT => (float)mrbValue.Value.F,
-                MrbVtype.MRB_TT_INTEGER => mrbValue.Value.I,
+                MrbVtype.MRB_TT_FLOAT => (float)mrbValue.FlaotValue,
+                MrbVtype.MRB_TT_INTEGER => mrbValue.IntValue,
                 _ => throw new MRubySerializationException($"mrb_value cannot deserialize as float: {mrbValue.TT}")
             };
         }
@@ -23,8 +23,8 @@ public double Deserialize(MrbValue mrbValue, MRubyContext context, MrbValueSeria
         {
             return mrbValue.TT switch
             {
-                MrbVtype.MRB_TT_FLOAT => (float)mrbValue.Value.F,
-                MrbVtype.MRB_TT_INTEGER => mrbValue.Value.I,
+                MrbVtype.MRB_TT_FLOAT => (float)mrbValue.FlaotValue,
+                MrbVtype.MRB_TT_INTEGER => mrbValue.IntValue,
                 _ => throw new MRubySerializationException($"mrb_value cannot deserialize as double: {mrbValue.TT}")
             };
         }
@@ -38,8 +38,8 @@ public decimal Deserialize(MrbValue mrbValue, MRubyContext context, MrbValueSeri
         {
             return mrbValue.TT switch
             {
-                MrbVtype.MRB_TT_FLOAT => (decimal)mrbValue.Value.F,
-                MrbVtype.MRB_TT_INTEGER => mrbValue.Value.I,
+                MrbVtype.MRB_TT_FLOAT => (decimal)mrbValue.FlaotValue,
+                MrbVtype.MRB_TT_INTEGER => mrbValue.IntValue,
                 _ => throw new MRubySerializationException($"mrb_value cannot deserialize as decimal: {mrbValue.TT}")
             };
         }

diff --git a/src/VitalRouter.Unity/Assets/VitalRouter.MRuby/Runtime/Serialization/MrbValueSerializer.cs b/src/VitalRouter.Unity/Assets/VitalRouter.MRuby/Runtime/Serialization/MrbValueSerializer.cs
@@ -4,7 +4,7 @@ public static class MrbValueSerializer
     {
         public static T? Deserialize<T>(MrbValue mrbValue, MRubyContext context, MrbValueSerializerOptions? options = null)
         {
-            options ??= MrbValueSerializerOptions.Default;
+            options ??= context.SerializerOptions;
             return options.Resolver.GetFormatterWithVerify<T>()
                 .Deserialize(mrbValue, context, options);
        }

diff --git a/...alRouter.Unity/Assets/VitalRouter.MRuby/Runtime/Serialization/PrimitiveObjectFormatter.cs b/...alRouter.Unity/Assets/VitalRouter.MRuby/Runtime/Serialization/PrimitiveObjectFormatter.cs
@@ -20,9 +20,9 @@ public class PrimitiveObjectFormatter : IMrbValueFormatter<object?>
                 case MrbVtype.MRB_TT_TRUE:
                     return true;
                 case MrbVtype.MRB_TT_INTEGER:
-                    return (long)value.Value.I;
+                    return value.IntValue;
                 case MrbVtype.MRB_TT_FLOAT:
-                    return value.Value.F;
+                    return value.FlaotValue;
                 case MrbVtype.MRB_TT_SYMBOL:
                 case MrbVtype.MRB_TT_STRING:
                     return value.ToString(context);

diff --git a/src/VitalRouter.Unity/Assets/VitalRouter.MRuby/Runtime/VitalRouter.SourceGenerator.MRuby.dll b/src/VitalRouter.Unity/Assets/VitalRouter.MRuby/Runtime/VitalRouter.SourceGenerator.MRuby.dll