Merge pull request #30 from Cysharp/hadashiA/numeric

Add options to define arithmetic operators separately
Cysharp · Aug 17, 2023 · 41a364b · 41a364b
2 parents 3deabf1 + 4670481
commit 41a364b
Show file tree

Hide file tree

Showing 14 changed files with 707 additions and 133 deletions.
diff --git a/README.md b/README.md
@@ -60,7 +60,25 @@ public readonly partial struct Hp { }
 // -- generates
 
 [System.ComponentModel.TypeConverter(typeof(HpTypeConverter))]
-public readonly partial struct Hp : IEquatable<Hp> , IComparable<Hp>
+public readonly partial struct Hp
+    : IEquatable<Hp>
+#if NET7_0_OR_GREATER
+    , IEqualityOperators<Hp, Hp, bool>
+#endif    
+    , IComparable<Hp>
+#if NET7_0_OR_GREATER
+    , IComparisonOperators<Hp, Hp, bool>
+#endif
+#if NET7_0_OR_GREATER
+    , IAdditionOperators<Hp, Hp, Hp>
+    , ISubtractionOperators<Hp, Hp, Hp>
+    , IMultiplyOperators<Hp, Hp, Hp>
+    , IDivisionOperators<Hp, Hp, Hp>
+    , IUnaryPlusOperators<Hp, Hp>
+    , IUnaryNegationOperators<Hp, Hp>
+    , IIncrementOperators<Hp>
+    , IDecrementOperators<Hp>
+#endif    
 {
     readonly int value;
 
@@ -81,25 +99,27 @@ public readonly partial struct Hp : IEquatable<Hp> , IComparable<Hp>
     private class HpTypeConverter : System.ComponentModel.TypeConverter { /* snip... */ }
 
     // UnitGenerateOptions.ArithmeticOperator
-    public static Hp operator +(in Hp x, in Hp y) => new Hp(checked((int)(x.value + y.value)));
-    public static Hp operator -(in Hp x, in Hp y) => new Hp(checked((int)(x.value - y.value)));
-    public static Hp operator *(in Hp x, in Hp y) => new Hp(checked((int)(x.value * y.value)));
-    public static Hp operator /(in Hp x, in Hp y) => new Hp(checked((int)(x.value / y.value)));
+    public static Hp operator +(Hp x, Hp y) => new Hp(checked((int)(x.value + y.value)));
+    public static Hp operator -(Hp x, Hp y) => new Hp(checked((int)(x.value - y.value)));
+    public static Hp operator *(Hp x, Hp y) => new Hp(checked((int)(x.value * y.value)));
+    public static Hp operator /(Hp x, Hp y) => new Hp(checked((int)(x.value / y.value)));
+    public static Hp operator ++(Hp x) => new Hp(checked((int)(x.value + 1)));
+    public static Hp operator --(Hp x) => new Hp(checked((int)(x.value - 1)));
+    public static Hp operator +(A value) => new((int)(+value.value));
+    public static Hp operator -(A value) => new((int)(-value.value));
 
     // UnitGenerateOptions.ValueArithmeticOperator
-    public static Hp operator ++(in Hp x) => new Hp(checked((int)(x.value + 1)));
-    public static Hp operator --(in Hp x) => new Hp(checked((int)(x.value - 1)));
-    public static Hp operator +(in Hp x, in int y) => new Hp(checked((int)(x.value + y)));
-    public static Hp operator -(in Hp x, in int y) => new Hp(checked((int)(x.value - y)));
-    public static Hp operator *(in Hp x, in int y) => new Hp(checked((int)(x.value * y)));
-    public static Hp operator /(in Hp x, in int y) => new Hp(checked((int)(x.value / y)));
+    public static Hp operator +(Hp x, in int y) => new Hp(checked((int)(x.value + y)));
+    public static Hp operator -(Hp x, in int y) => new Hp(checked((int)(x.value - y)));
+    public static Hp operator *(Hp x, in int y) => new Hp(checked((int)(x.value * y)));
+    public static Hp operator /(Hp x, in int y) => new Hp(checked((int)(x.value / y)));
 
     // UnitGenerateOptions.Comparable
     public int CompareTo(Hp other) => value.CompareTo(other.value);
-    public static bool operator >(in Hp x, in Hp y) => x.value > y.value;
-    public static bool operator <(in Hp x, in Hp y) => x.value < y.value;
-    public static bool operator >=(in Hp x, in Hp y) => x.value >= y.value;
-    public static bool operator <=(in Hp x, in Hp y) => x.value <= y.value;
+    public static bool operator >(Hp x, Hp y) => x.value > y.value;
+    public static bool operator <(Hp x, Hp y) => x.value < y.value;
+    public static bool operator >=(Hp x, Hp y) => x.value >= y.value;
+    public static bool operator <=(Hp x, Hp y) => x.value <= y.value;
 
     // UnitGenerateOptions.MinMaxMethod
     public static Hp Min(Hp x, Hp y) => new Hp(Math.Min(x.value, y.value));
@@ -193,7 +213,12 @@ namespace UnitGenerator
     [AttributeUsage(AttributeTargets.Struct, AllowMultiple = false)]
     internal class UnitOfAttribute : Attribute
     {
-        public UnitOfAttribute(Type type, UnitGenerateOptions options = UnitGenerateOptions.None, string toStringFormat = null)
+        public Type Type { get; }
+        public UnitGenerateOptions Options { get; }
+        public UnitArithmeticOperators ArithmeticOperators { get; set; }
+        public string ToStringFormat { get; set; }
+
+        public UnitOfAttribute(Type type, UnitGenerateOptions options = UnitGenerateOptions.None) { ... }
     }
 }
 ```
@@ -241,7 +266,9 @@ public static GroupId NewGroupId();
 
 Second parameter `UnitGenerateOptions options` can configure which method to implement, default is `None`.
 
-Third parameter `strign toStringFormat` can configure `ToString` format. Default is null and output as $`{0}`.
+Optional named parameter: `ArithmeticOperators` can configure which generates operators specifically. Default is `Number`. (This can be used if UnitGenerateOptions.ArithmeticOperator is specified.)
+
+Optional named parameter: `ToStringFormat` can configure `ToString` format. Default is null and output as $`{0}`.
 
 ## UnitGenerateOptions
 
@@ -324,13 +351,36 @@ public static T operator +(in T x, in T y) => new T(checked((U)(x.value + y.valu
 public static T operator -(in T x, in T y) => new T(checked((U)(x.value - y.value)));
 public static T operator *(in T x, in T y) => new T(checked((U)(x.value * y.value)));
 public static T operator /(in T x, in T y) => new T(checked((U)(x.value / y.value)));
+public static T operator +(T value) => new((U)(+value.value));
+public static T operator -(T value) => new((U)(-value.value));
+public static T operator ++(T x) => new T(checked((U)(x.value + 1)));
+public static T operator --(T x) => new T(checked((U)(x.value - 1)));
+```
+
+In addition,  all members conforming to [System.Numerics.INumber<T>](https://learn.microsoft.com/ja-jp/dotnet/api/system.numerics.inumber-1) are generated.
+
+If you want to suppress this and generate only certain operators, you can use the the `ArithmeticOperatros` option of `[UnitOf]` attribute as follows:
+
+```csharp
+[UnitOf(
+    typeof(int), 
+    UnitGenerateOptions.ArithmeticOperator,
+    ArithmeticOperators = UnitArithmeticOperators.Addition | UnitArithmeticOperators.Subtraction)]
+public readonly partial struct Hp { }
 ```
 
+| Value                               | Generates                                                                              | 
+|-------------------------------------|----------------------------------------------------------------------------------------|
+| UnitArithmeticOperators.Addition    | `T operator +(T, T)`                                            |
+| UnitArithmeticOperators.Subtraction | `T operator -(T, T)`                                             |
+| UnitArithmeticOperators.Multiply    | `T operator *(T, T)`,  `T operator +(T)`, `T operator-(T)` |
+| UnitArithmeticOperators.Division    | `T operator /(T, T)`,  `T operator +(T)`, `T operator-(T)` |
+| UnitArithmeticOperators.Increment   | `T operator ++(T)`                                                                     |
+| UnitArithmeticOperators.Decrement   | `T operator --(T)`                                                                     |
+
 ### ValueArithmeticOperator
 
 ```csharp
-public static T operator ++(in T x) => new T(checked((U)(x.value + 1)));
-public static T operator --(in T x) => new T(checked((U)(x.value - 1)));
 public static T operator +(in T x, in U y) => new T(checked((U)(x.value + y)));
 public static T operator -(in T x, in U y) => new T(checked((U)(x.value - y)));
 public static T operator *(in T x, in U y) => new T(checked((U)(x.value * y)));

diff --git a/sandbox/ConsoleApp/AllPrimitives.cs b/sandbox/ConsoleApp/AllPrimitives.cs
@@ -1,6 +1,8 @@
 using System;
 using System.Collections.Generic;
+using System.Globalization;
 using System.Linq;
+using System.Numerics;
 using System.Text;
 using System.Text.Json;
 using System.Text.Json.Serialization;

diff --git a/sandbox/ConsoleApp/ConsoleApp.csproj b/sandbox/ConsoleApp/ConsoleApp.csproj
@@ -2,7 +2,7 @@
 
     <PropertyGroup>
         <OutputType>Exe</OutputType>
-        <TargetFramework>net6.0</TargetFramework>
+        <TargetFramework>net7.0</TargetFramework>
         <Nullable>enable</Nullable>
         <IsPackable>false</IsPackable>
     </PropertyGroup>

diff --git a/sandbox/ConsoleApp/Operators.cs b/sandbox/ConsoleApp/Operators.cs
@@ -0,0 +1,37 @@
+using UnitGenerator;
+
+namespace ConsoleApp
+{
+    namespace ConsoleApp
+    {
+        [UnitOf(typeof(int), UnitGenerateOptions.ArithmeticOperator | UnitGenerateOptions.ValueArithmeticOperator, ArithmeticOperators = UnitArithmeticOperators.Addition)]
+        public readonly partial struct Add
+        {
+        }
+
+        [UnitOf(typeof(int), UnitGenerateOptions.ArithmeticOperator | UnitGenerateOptions.ValueArithmeticOperator, ArithmeticOperators = UnitArithmeticOperators.Subtraction)]
+        public readonly partial struct Sub
+        {
+        }
+
+        [UnitOf(typeof(int), UnitGenerateOptions.ArithmeticOperator | UnitGenerateOptions.ValueArithmeticOperator, ArithmeticOperators = UnitArithmeticOperators.Multiply)]
+        public readonly partial struct Mul
+        {
+        }
+
+        [UnitOf(typeof(int), UnitGenerateOptions.ArithmeticOperator | UnitGenerateOptions.ValueArithmeticOperator, ArithmeticOperators = UnitArithmeticOperators.Division)]
+        public readonly partial struct Div
+        {
+        }
+
+        [UnitOf(typeof(int), UnitGenerateOptions.ArithmeticOperator | UnitGenerateOptions.ValueArithmeticOperator, ArithmeticOperators = UnitArithmeticOperators.Increment)]
+        public readonly partial struct Inc
+        {
+        }
+
+        [UnitOf(typeof(int), UnitGenerateOptions.ArithmeticOperator | UnitGenerateOptions.ValueArithmeticOperator, ArithmeticOperators = UnitArithmeticOperators.Decrement)]
+        public readonly partial struct Dec
+        {
+        }
+    }
+}
diff --git a/sandbox/ConsoleApp/Program.cs b/sandbox/ConsoleApp/Program.cs
@@ -35,8 +35,7 @@ public readonly partial struct BarId { }
 
 namespace Sample
 {
-
-    [UnitOf(typeof(int), UnitGenerateOptions.ArithmeticOperator | UnitGenerateOptions.ValueArithmeticOperator | UnitGenerateOptions.Comparable | UnitGenerateOptions.MinMaxMethod | UnitGenerateOptions.JsonConverter | UnitGenerateOptions.JsonConverterDictionaryKeySupport)]
+    [UnitOf(typeof(int), UnitGenerateOptions.ArithmeticOperator | UnitGenerateOptions.Comparable | UnitGenerateOptions.MinMaxMethod | UnitGenerateOptions.JsonConverter | UnitGenerateOptions.JsonConverterDictionaryKeySupport)]
     public readonly partial struct Hp
     {
         // public static Hp operator +(in Hp x, in Hp y) => new Hp(checked((int)(x.value + y.value)));
@@ -83,7 +82,7 @@ public void Foo()
             _ = AsPrimitive();
         }
     }
-    
+
     [UnitOf(typeof(string), UnitGenerateOptions.ParseMethod)]
     public readonly partial struct StringId { }
 }

diff --git a/sandbox/FileGenerate/FileGenerate.csproj b/sandbox/FileGenerate/FileGenerate.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
 	<PropertyGroup>
-		<TargetFramework>net6.0</TargetFramework>
+		<TargetFramework>net7.0</TargetFramework>
 
 		<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
 		<CompilerGeneratedFilesOutputPath>$(ProjectDir)..\Generated</CompilerGeneratedFilesOutputPath>

diff --git a/sandbox/FileGenerate/SimplePrimitive.cs b/sandbox/FileGenerate/SimplePrimitive.cs
@@ -1,9 +1,4 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
-using UnitGenerator;
+using UnitGenerator;
 
 namespace FileGenerate
 {
@@ -16,4 +11,9 @@ public readonly partial struct A
     public readonly partial struct B
     {
     }
+
+    [UnitOf(typeof(int), UnitGenerateOptions.Comparable | UnitGenerateOptions.ArithmeticOperator | UnitGenerateOptions.ValueArithmeticOperator)]
+    public readonly partial struct C
+    {
+    }
 }
diff --git a/sandbox/Generated/UnitGenerator/UnitGenerator.SourceGenerator/FileGenerate.A.Generated.cs b/sandbox/Generated/UnitGenerator/UnitGenerator.SourceGenerator/FileGenerate.A.Generated.cs
@@ -3,10 +3,18 @@
 // </auto-generated>
 #pragma warning disable CS8669
 using System;
+using System.Globalization;
+#if NET7_0_OR_GREATER
+using System.Numerics;
+#endif
 namespace FileGenerate
 {
     [System.ComponentModel.TypeConverter(typeof(ATypeConverter))]
-    readonly partial struct A : IEquatable<A>
+    readonly partial struct A 
+        : IEquatable<A>
+#if NET7_0_OR_GREATER
+        , IEqualityOperators<A, A, bool>
+#endif    
     {
         readonly int value;
 
@@ -47,28 +55,29 @@ public override bool Equals(object obj)
 
             return value.Equals(obj);
         }
-
-        public override int GetHashCode()
+        
+        public static bool operator ==(A x, A y)
         {
-            return value.GetHashCode();
+            return x.value.Equals(y.value);
         }
 
-        public override string ToString()
+        public static bool operator !=(A x, A y)
         {
-            return value.ToString();
+            return !x.value.Equals(y.value);
         }
 
-        public static bool operator ==(in A x, in A y)
+        public override int GetHashCode()
         {
-            return x.value.Equals(y.value);
+            return value.GetHashCode();
         }
 
-        public static bool operator !=(in A x, in A y)
+        public override string ToString()
         {
-            return !x.value.Equals(y.value);
+            return value.ToString();
         }
 
         // Default
+
         private class ATypeConverter : System.ComponentModel.TypeConverter
         {
             private static readonly Type WrapperType = typeof(A);

diff --git a/sandbox/Generated/UnitGenerator/UnitGenerator.SourceGenerator/FileGenerate.B.Generated.cs b/sandbox/Generated/UnitGenerator/UnitGenerator.SourceGenerator/FileGenerate.B.Generated.cs
@@ -3,10 +3,18 @@
 // </auto-generated>
 #pragma warning disable CS8669
 using System;
+using System.Globalization;
+#if NET7_0_OR_GREATER
+using System.Numerics;
+#endif
 namespace FileGenerate
 {
     [System.ComponentModel.TypeConverter(typeof(BTypeConverter))]
-    readonly partial struct B : IEquatable<B>
+    readonly partial struct B 
+        : IEquatable<B>
+#if NET7_0_OR_GREATER
+        , IEqualityOperators<B, B, bool>
+#endif    
     {
         readonly string value;
 
@@ -47,28 +55,29 @@ public override bool Equals(object obj)
 
             return value.Equals(obj);
         }
-
-        public override int GetHashCode()
+        
+        public static bool operator ==(B x, B y)
         {
-            return value.GetHashCode();
+            return x.value.Equals(y.value);
         }
 
-        public override string ToString()
+        public static bool operator !=(B x, B y)
         {
-            return value.ToString();
+            return !x.value.Equals(y.value);
         }
 
-        public static bool operator ==(in B x, in B y)
+        public override int GetHashCode()
         {
-            return x.value.Equals(y.value);
+            return value.GetHashCode();
         }
 
-        public static bool operator !=(in B x, in B y)
+        public override string ToString()
         {
-            return !x.value.Equals(y.value);
+            return value.ToString();
         }
 
         // Default
+
         private class BTypeConverter : System.ComponentModel.TypeConverter
         {
             private static readonly Type WrapperType = typeof(B);