NullableUnitGenerator v0.0.2.94 — nugetz

using NullableUnitGenerator;

[UnitOf(typeof(int))]
public readonly partial struct UserId { }

[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
    { ... }
}

[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
    { ... }
}

[Flags]
enum UnitGenOpts
{
    None = 0,
    ImplicitOperator = 1,
    ParseMethod = 2,
    MinMaxMethod = 4,
    ArithmeticOperator = 8,
    ValueArithmeticOperator = 16,
    Comparable = 32,
    Validate = 64,
    JsonConverter = 128,
    MessagePackFormatter = 256,  // Unsupported
    DapperTypeHandler = 512,
    EntityFrameworkValueConverter = 1024,  // Unsupported
    WithoutComparisonOperator = 2048,
    JsonConverterDictionaryKey = 4096
}

[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));
        }
    }
}

namespace UnitGenerator
{
    [AttributeUsage(AttributeTargets.Struct, AllowMultiple = false)]
    internal class UnitOfAttribute : Attribute
    {
        public UnitOfAttribute(Type type, UnitGenOpts options = UnitGenOpts.None, string toStringFormat = null)
    }
}

[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 { }

public static bool operator true(Foo x) => x.value;
public static bool operator false(Foo x) => !x.value;
public static bool operator !(Foo x) => !x.value;

public static GroupId New();
public static GroupId NewGroupId();

[Flags]
internal enum UnitGenOpts
{
    None = 0,
    ImplicitOperator = 1,
    ParseMethod = 2,
    MinMaxMethod = 4,
    ArithmeticOperator = 8,
    ValueArithmeticOperator = 16,
    Comparable = 32,
    Validate = 64,
    JsonConverter = 128,
    MessagePackFormatter = 256,
    DapperTypeHandler = 512,
    EntityFrameworkValueConverter = 1024,
}

[UnitOf(typeof(int), UnitGenOpts.ArithmeticOperator | UnitGenOpts.ValueArithmeticOperator | UnitGenOpts.Comparable | UnitGenOpts.MinMaxMethod)]
public readonly partial struct Strength { }

[UnitOf(typeof(DateTime), UnitGenOpts.Validate | UnitGenOpts.ParseMethod | UnitGenOpts.Comparable)]
public readonly partial struct EndDate { }

[UnitOf(typeof(double), UnitGenOpts.ParseMethod | UnitGenOpts.MinMaxMethod | UnitGenOpts.ArithmeticOperator | UnitGenOpts.ValueArithmeticOperator | UnitGenOpts.Comparable | UnitGenOpts.Validate | UnitGenOpts.JsonConverter | UnitGenOpts.MessagePackFormatter | UnitGenOpts.DapperTypeHandler | UnitGenOpts.EntityFrameworkValueConverter)]
public readonly partial struct AllOptionsStruct { }

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 { }

// 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);

public static T Parse(string s)
public static bool TryParse(string s, out T result)

public static T Min(T x, T y)
public static T Max(T x, T y)

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)));

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)));

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;

[UnitOf(typeof(Guid), UnitGenOpts.Comparable | UnitGenOpts.WithoutComparisonOperator)]
public readonly partial struct FooId { }

// You can implement this custom validate method.
[UnitOf(typeof(int), UnitGenOpts.Validate)]
public readonly partial struct SampleValidate
{
    // impl here.
    private partial void Validate()
    {
        if (value > 9999) throw new Exception("Invalid value range: " + value);
    }
}

// Source generator generate this codes.
public T(int value)
{
    this.value = value;
    this.Validate();
}

private partial void Validate();

[JsonConverter(typeof(UserIdJsonConverter))]
public readonly partial struct UserId
{
    class UserIdJsonConverter : JsonConverter<UserId>
}

var dict = Dictionary<UserId, int>
JsonSerializer.Serialize(dict);

public readonly partial struct UserId
{
    public class UserIdTypeHandler : Dapper.SqlMapper.TypeHandler<UserId>
}

[ModuleInitializer]
public static void AddTypeHandler()
{
    Dapper.SqlMapper.AddTypeHandler(new A.ATypeHandler());
}

Explanation in UnitGenerager (UnitGeneragerでの説明)

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.

C#ソースジェネレータ機能は、C#10に依存しています。Unity 2021.2を使用している場合、Source Generatorsをサポートしています。リリースページ](https://github.com/Cysharp/UnitGenerator/releases)から`UnitGenerator.dll`を追加し、Any Platformを無効にし、Include all platformsを無効にし、ラベルをRoslynAnalyzerと設定します。 Unity Editorでは動作しますが、IDEではUnityがアナライザー参照を生成しないため、動作しません。CsprojModifer](https://github.com/Cysharp/CsprojModifier)を提供し、生成された.csprojにアナライザ参照を追加することで、IDEとUnity Editorの両方をサポートします。 Unity(2020)はC#10をサポートしていないため、直接使用することはできません。ただし、C# Source Genertorはソースをファイルとして出力することが可能です。

Create UnitSourceGen.csproj.

<Project Sdk="Microsoft.NET.Sdk">
    <PropertyGroup>
        <TargetFramework>net5.0</TargetFramework>

        <!-- add this two lines and configure output path -->
        <EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
        <CompilerGeneratedFilesOutputPath>$(ProjectDir)..\Generated</CompilerGeneratedFilesOutputPath>
    </PropertyGroup>

    <ItemGroup>
        <!-- reference UnitGenerator -->
        <PackageReference Include="UnitGenerator" Version="1.0.0" />

        <!-- add target sources path from Unity -->
        <Compile Include="..\MyUnity\Assets\Scripts\Models\**\*.cs" />
    </ItemGroup>
</Project>

install .NET SDK and run this command.

dotnet build UnitSourceGen.csproj

SEKIYA.Tomokuni/NullableUnitGeneratorv0.0.2.94

Get Started

Readme

This document is a work in progress. (このドキュメントは書きかけです。)

NullableUnitGenerator

GitHub: NullableUnitGenerator

NuGet: NullableUnitGenerator

Thanks

MessagePackFormatter, EntityFrameworkValueConverter, and Unity are not yet supported.

Introduction

Table of Contents

UnitOfAttribute

UnitGenOpts

ImplicitOperator

ParseMethod

MinMaxMethod

ArithmeticOperator

ValueArithmeticOperator

Comparable

WithoutComparisonOperator

Validate

JsonConverter

JsonConverterDictionaryKey

DapperTypeHandler

MessagePackFormatter

EntityFrameworkValueConverter

Use for Unity

generated file and folder

License