<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
<details>
<summary>Explanation in UnitGenerager (UnitGeneragerでの説明)</summary>
</details>
<details>
<summary>Explanation in UnitGenerager (UnitGeneragerでの説明)</summary>
</details>
<details>
<summary>Explanation in UnitGenerager (UnitGeneragerでの説明)</summary>
</details>
MessagePackFormatter, EntityFrameworkValueConverter, and Unity are not yet supported.
MessagePackFormatter, EntityFrameworkValueConverter, and Unity are supported by UnitGenerator.
However, NullableUnitGenerator does not yet support them.
They are described in this document, but cannot be used with NullableUnitGenerator.
using NullableUnitGenerator;
[UnitOf(typeof(int))]
public readonly partial struct UserId { }
will generates
以下のようなコードが自動生成されます。
[System.ComponentModel.TypeConverter(typeof(UserIdTypeConverter))]
public readonly partial struct UserId : IEquatable<UserId>, IEqualityComparer<UserId>
{
// backing field
readonly int m_value = default;
readonly UnitState m_state = UnitState.Undef;
// Constructor
public UserId(in UserId value) { (m_state, m_value) = (value.m_state, value.m_value); }
public UserId(in UnitState state, in int value = default) => ...;
public UserId(in int value) { (m_state, m_value) = (UnitState.Value, value); }
public UserId(in int? value) => ...;
// get state
public bool IsUndef => m_state == UnitState.Undef;
public bool IsNull => m_state == UnitState.Null;
public bool IsUndefOrNull => m_state != UnitState.Value;
public bool HasValue => m_state == UnitState.Value;
public UnitState State => m_state;
// get value
public int Value => GetOrThrow();
public int AsPrimitive() => Value;
public int GetRawValue() => m_value;
public int GetOr(in int defaultValue) => HasValue ? m_value : defaultValue;
public int? GetOr(in int? defaultValue) => HasValue ? m_value : defaultValue;
public int GetOrDefault() => GetOr(default);
public int? GetOrNull() => GetOr(null);
public int GetOrThrow() => ...;
public bool TryGet(out int value, in int defaultValue = default) => ...;
// GetHashCode, ToString
public override int GetHashCode() => (m_state, m_value).GetHashCode();
public int GetHashCode(UserId obj) => (obj.m_state, obj.m_value).GetHashCode();
public override string ToString() => ValueString;
// implicit, explicit operator
public static explicit operator int(in UserId value) => (int)value.GetOrThrow();
public static explicit operator UserId(in int value) => new(value);
public static explicit operator int?(in UserId value) => (int?)value.GetOrNull();
public static explicit operator UserId(in int? value) => new(value);
// Equals, IEquatable<UserId>
public bool Equals(UserId other) => ...;
public bool Equals(UserId x, UserId y) => x.Equals(y);
public override bool Equals(object? obj) => obj is UserId ts && Equals(ts);
// ==, != operator
public static bool operator ==(in UserId x, in UserId y) => x.Equals(y);
public static bool operator !=(in UserId x, in UserId y) => !(x == y);
// TypeConverter
private class UserIdTypeConverter : System.ComponentModel.TypeConverter
{ ... }
}
However, Hp in games, should not be allowed to be assigned to other types, but should support arithmetic operations with int. For example double heal = target.Hp = Hp.Min(target.Hp * 2, target.MaxHp).
[UnitOf(typeof(int), UnitGenOpts.ImplicitOperator
| UnitGenOpts.ParseMethod
| UnitGenOpts.MinMaxMethod
| UnitGenOpts.ArithmeticOperator
| UnitGenOpts.ValueArithmeticOperator
| UnitGenOpts.Comparable)]
public readonly partial struct Hp { }
// -- generates
[System.ComponentModel.TypeConverter(typeof(HpTypeConverter))]
public readonly partial struct Hp : IEquatable<Hp> , IComparable<Hp>
{
// backing field
readonly int m_value = default;
readonly UnitState m_state = UnitState.Undef;
// Constructor
public Hp(in Hp value) => ...;
public Hp(in UnitState state, in int value = default) => ...;
public Hp(in int value) => ...;
public Hp(in int? value) => ...;
// get state
public bool IsUndef => ...;
public bool IsNull => ...;
public bool IsUndefOrNull => ...;
public bool HasValue => ...;
public UnitState State => ...;
// get value
public int Value => ...;
public int AsPrimitive() => ...;
public int GetRawValue() => ...;
public int GetOr(in int defaultValue) => ...;
public int? GetOr(in int? defaultValue) => ...;
public int GetOrDefault() => ...;
public int? GetOrNull() => ...;
public int GetOrThrow() => ...;
public bool TryGet(out int value, in int defaultValue = default) => ...;
// GetHashCode, ToString
public override int GetHashCode() => ...;
public int GetHashCode(Hp obj) => ...;
public override string ToString() => ...;
// implicit, explicit operator // UnitGenOpts.ImplicitOperator
public static implicit operator int(in Hp value) => ...;
public static implicit operator Hp(in int value) => ...;
public static implicit operator int?(in Hp value) => ...;
public static implicit operator Hp(in int? value) => ...;
// Equals, IEquatable<Hp>
public bool Equals(Hp other) => ...;
public bool Equals(Hp x, Hp y) => ...;
public override bool Equals(object? obj) => ...;
// ==, != operator
public static bool operator ==(in Hp x, in Hp y) => ...;
public static bool operator !=(in Hp x, in Hp y) => ...;
// CompareTo, IComparable<Hp> // UnitGenOpts.Comparable
public int CompareTo(Hp other) => ...;
// >, <, >=, <= operator // UnitGenOpts.Comparable and WithoutComparisonOperator
public static bool operator >(in Hp x, in Hp y) => ...;
public static bool operator <(in Hp x, in Hp y) => ...;
public static bool operator >=(in Hp x, in Hp y) => ...;
public static bool operator <=(in Hp x, in Hp y) => ...;
// Parse, TryParse // UnitGenOpts.ParseMethod
public static Hp Parse(string s) => ...;
public static bool TryParse(string s, out Hp result) => ...;
// Min, Max // UnitGenOpts.MinMaxMethod
public static Hp Min(Hp x, Hp y) => ...;
public static Hp Max(Hp x, Hp y) => ...;
// +, -, *, /, % operator UnitGenOpts.ArithmeticOperator
public static Hp operator +(in Hp x, in Hp y) => ...;
public static Hp operator -(in Hp x, in Hp y) => ...;
public static Hp operator *(in Hp x, in Hp y) => ...;
public static Hp operator /(in Hp x, in Hp y) => ...;
public static Hp operator %(in Hp x, in Hp y) => ...;
// ++, --, +, -, *, /, % operator // UnitGenOpts.ValueArithmeticOperator
public static Hp operator ++(in Hp x) => ...;
public static Hp operator --(in Hp x) => ...;
public static Hp operator +(in Hp x, in int y) => ...;
public static Hp operator -(in Hp x, in int y) => ...;
public static Hp operator *(in Hp x, in int y) => ...;
public static Hp operator /(in Hp x, in int y) => ...;
public static Hp operator %(in Hp x, in int y) => ...;
// TypeConverter
private class HpTypeConverter : System.ComponentModel.TypeConverter
{ ... }
}
You can configure with UnitGenOpts, which method to implement.
UnitGenOpts has some serializer support. For example, a result like Serialize(userId) => { Value = 1111 } is awful. The value-object should be serialized natively, i.e. Serialize(useId) => 1111, and should be able to be added directly to a database, etc.
Currently UnitGenerator supports System.Text.Json(JsonSerializer), Dapper, MessagePack for C# and EntityFrameworkCore.
UnitGenOptsには、いくつかのシリアライザーサポートがあります。例えば、Serialize(userId) => { Value = 1111 }のような結果はひどいものです。値オブジェクトはネイティブにシリアライズされるべきで、すなわち Serialize(useId) => 1111 となり、データベースなどに直接追加できるようにすべきです。
現在、UnitGeneratorは、System.Text.Json(JsonSerializer)、Dapper、MessagePack for C#、EntityFrameworkCore をサポートしています。。
[UnitOf(typeof(int), UnitGenOpts.MessagePackFormatter)]
public readonly partial struct UserId { }
// -- generates
[MessagePackFormatter(typeof(UserIdMessagePackFormatter))]
public readonly partial struct UserId
{
class UserIdMessagePackFormatter : IMessagePackFormatter<UserId>
{
public void Serialize(ref MessagePackWriter writer, UserId value, MessagePackSerializerOptions options)
{
options.Resolver.GetFormatterWithVerify<int>().Serialize(ref writer, value.value, options);
}
public UserId Deserialize(ref MessagePackReader reader, MessagePackSerializerOptions options)
{
return new UserId(options.Resolver.GetFormatterWithVerify<int>().Deserialize(ref reader, options));
}
}
}
[UnitOf(typeof(Guid))]
public readonly partial struct GroupId { }
[UnitOf(typeof(string))]
public readonly partial struct Message { }
[UnitOf(typeof(long))]
public readonly partial struct Power { }
[UnitOf(typeof(byte[]))]
public readonly partial struct Image { }
[UnitOf(typeof(DateTime))]
public readonly partial struct StartDate { }
[UnitOf(typeof((string street, string city)))]
public readonly partial struct StreetAddress { }
Standard UnitOf(UnitGenOpts.None) generates value constructor, explicit operator, implement IEquatable<T>, override GetHashCode, override ToString, == and != operator, TypeConverter for ASP.NET Core binding, AsPrimitive method.
If you want to retrieve primitive value, use AsPrimitive() instead of .Value. This is intended to avoid casual getting of primitive values (using the arithmetic operator option if available).
When type is bool, also implements true, false, ! operators.
public static GroupId New();
public static GroupId NewGroupId();
Second parameter UnitGenOpts 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}.
internal static class UnitOfOptions
{
public const UnitGenOpts Default = UnitGenOpts.ArithmeticOperator | UnitGenOpts.ValueArithmeticOperator | UnitGenOpts.Comparable | UnitGenOpts.MinMaxMethod;
}
[UnitOf(typeof(int), UnitOfOptions.Default)]
public readonly partial struct Hp { }
ImplicitOperator
// Default
public static explicit operator U(T value) => value.value;
public static explicit operator T(U value) => new T(value);
// UnitGenOpts.ImplicitOperator
public static implicit operator U(T value) => value.value;
public static implicit operator T(U value) => new T(value);
ParseMethod
public static T Parse(string s)
public static bool TryParse(string s, out T result)
MinMaxMethod
public static T Min(T x, T y)
public static T Max(T x, T y)
ArithmeticOperator
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 /(in T x, in T y) => new T(checked((U)(x.value / y.value)));
ValueArithmeticOperator
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)));
public static T operator /(in T x, in U y) => new T(checked((U)(x.value / y)));
Comparable
Implements IComparable<T> and >, <, >=, <= operators.
IComparable<T>と >, <, >=, <= 演算子を実装しています。
public U CompareTo(T other) => value.CompareTo(other.value);
public static bool operator >(in T x, in T y) => x.value > y.value;
public static bool operator <(in T x, in T y) => x.value < y.value;
public static bool operator >=(in T x, in T y) => x.value >= y.value;
public static bool operator <=(in T x, in T y) => x.value <= y.value;
WithoutComparisonOperator
Without implements >, <, >=, <= operators. For example, useful for Guid.
public readonly partial struct UserId
{
public class UserIdValueConverter : ValueConverter<UserId, int>
}
// setup handler manually
builder.HasConversion(new UserId.UserIdValueConverter());
Use for Unity
C# Source Generator feature is rely on C#10. If you are using Unity 2021.2, that supports Source Generators. Add the UnitGenerator.dll from the releases page, disable Any Platform, disable Include all platforms and set label as RoslynAnalyzer.
It works in Unity Editor however does not work on IDE because Unity does not generate analyzer reference to .csproj. We provides CsprojModifer to analyzer support, uses Add analyzer references to generated .csproj supports both IDE and Unity Editor.
Unity(2020) does not support C#10 so can not use directly. However, C# Source Genertor supports output source as file.
File will be generated under NullableUnitGenerator\NullableUnitGenerator.SourceGenerator\*.g.cs. UnitOfAttribute is also included in generated folder, so at first, run build command and get attribute to configure.
