拡張機能のインデックス作成ツール

チャンピオン号: https://github.com/dotnet/csharplang/issues/9856

宣言

構文

拡張インデクサーは、( proposals/csharp-14.0/extensions.md を基準にして) 文法を拡張することで、拡張宣言内の許可されるメンバーのセットに追加されます。

extension_member_declaration
        : method_declaration
        | property_declaration
        | indexer_declaration // new
        | operator_declaration
        ;

通常のインデクサーと同様に、拡張インデクサーには識別子がなく、パラメーター リストによって識別されます。 拡張インデクサーは、通常のインデクサーが現在サポートしている機能の完全なセット (アクセサー本体、式形式のメンバー、参照を返すアクセサー、 scoped パラメーター、属性など) を使用できます。

インデクサーは常にインスタンス メンバーであるため、インデクサーを宣言する拡張ブロックでは、名前付きレシーバー パラメーターを指定する必要があります。

拡張メンバーに関する既存の制限は引き続き適用されます。拡張機能宣言内のインデクサーは、 abstract、 virtual、 override、 new、 sealed、 partial、 protected (または関連するアクセシビリティ修飾子)、または init アクセサーを指定できません。

public static class BitExtensions
{
    extension(int i)
    {
        public bool this[int index]
        {
            get => ...;
        }
    }
}

通常のインデクサーに適用される C# 標準のすべての規則は拡張インデクサーに適用されますが、拡張メンバーには暗黙的または明示的な thisはありません。

既存の拡張メンバー推論規則は引き続き適用されます。メソッド以外の拡張メンバーごとに、拡張ブロックのすべての型パラメーターを拡張機能とメンバーのパラメーターの組み合わせで使用する必要があります。

IndexerName 属性

IndexerNameAttribute 拡張インデクサーに適用できます。 属性はメタデータでは出力されませんが、その値はメンバー間の競合に影響し、メタデータ内のプロパティとアクセサーの名前を決定し、 [DefaultMemberAttribute] を出力するときに使用されます ( メタデータを参照)。

従量課金

インデクサーへのアクセス

インデクサー アクセスの規則が更新されます。インデクサー アクセスの通常の処理で該当するインデクサーが見つからない場合は、拡張機能インデクサー アクセスとしてコンストラクトを処理しようとします。

1. 受信側の型で宣言 (または継承) されたインスタンス インデクサーを使用してバインドを試みます。 該当する候補が見つかった場合、オーバーロードの解決では、現在のインスタンス メンバーの中から選択され、停止します。
2. 受信側の型で宣言 (または継承) された暗黙的なインスタンス インデクサーを使用してバインドを試みます。 該当する候補が見つかった場合、オーバーロードの解決では、現在のインスタンス メンバーの中から選択され、停止します。
3. 拡張インデクサー アクセスとしてバインドを試みます。 このプロセスで該当する候補が見つかると、オーバーロードの解決によって、以下の説明に従ってそれらの拡張メンバーの中から選択され、停止します。
4. 拡張機能の暗黙的なインデクサー アクセスとしてバインドを試みます。 このプロセスで該当する候補が見つかると、オーバーロードの解決によって、以下の説明に従ってそれらの拡張メンバーの中から選択され、停止します。

注: 要素アクセス セクションは、引数が型 dynamicを持つケースを処理するため、インデクサー アクセスとして処理されることはありません。

拡張機能インデクサー アクセス

拡張インデクサーを含む拡張メンバーは、受信側が base_access 式の場合は考慮されません。

注: 受信側が変数または値である場合、 element_access はインデクサー アクセスとしてのみ処理されるため、受信側が型の場合、拡張インデクサーは考慮されません。

element_accessE[A]を考えると、目的は拡張インデクサーを識別することです。

拡張ブロックの型パラメーターと、拡張パラメーターとインデクサーのパラメーターを組み合わせたパラメーター リストで構成される拡張シグネチャが、受信側のEと引数リストのAを組み合わせた引数リストに対して適用できる場合、拡張インデクサー候補は、受信側Eと引数リストAに適用できます。

拡張メソッドのスコープ ウォークを再利用します。拡張メソッドの呼び出しについて参照されているのと同じスコープ (現在および外側の字句スコープ、名前空間またはusing staticのインポートusing含む) を走査します。

次に、各スコープを検討します。

• 現在のスコープ内の非ジェネリック静的クラス宣言の拡張ブロックが考慮されます。
• これらの拡張ブロック内のインデクサーは、候補セットで構成されます。
• アクセスできない候補は、セットから削除されます。
• 該当しない候補 (上記で定義) は、セットから削除されます。
• 結果の候補インデクサーのセットが空の場合は、次のスコープに進みます。または、最後のスコープに達した場合は拡張機能インデクサー アクセスの解決に失敗します (その場合は、引き続き拡張機能の暗黙的なインデクサーとして解決を試みます)。
• それ以外の場合は、オーバーロードの解決が候補セットに適用されます。 1 つの最適なインデクサーを識別できない場合、拡張インデクサーのアクセスがあいまいになり、コンパイル時エラーが発生します。

前の手順で識別されたこの 1 つの最適なインデクサーを使用して、インデクサー アクセスは静的メソッド呼び出しとして処理されます。

使用されるコンテキストに応じて、インデクサー アクセスによって、インデクサーの get_accessor または set_accessor が呼び出されます。
インデクサー アクセスが割り当てのターゲットである場合は、 set_accessor 静的実装メソッドが呼び出され、新しい値が割り当てられます。
それ以外の場合は、 get_accessor 静的実装メソッドが呼び出され、現在の値が取得されます。
いずれの場合も、呼び出しでは、適用性チェック中に推論されたジェネリック引数と、最初の引数として受信側が使用されます。

拡張機能の暗黙的インデクサー アクセス

拡張機能の暗黙的な System.Index (または System.Range) インデクサー アクセスは、次の場合に適用できます。

1. element_accessには、System.Index (またはSystem.Range) 型の 1 つの引数があります。
2. 該当する Length または Count (インスタンスまたは拡張機能) プロパティが受信側の種類で見つかり、
3. 該当する this[int] (または Slice(int, int)) (インスタンスまたは拡張機能) インデクサーが受信側の種類で見つかります。

その他の要素アクセス フォーム

要素アクセス バインディング (null 条件付き要素のアクセスまたは割り当て、オブジェクト初期化子でのインデックスの割り当て、またはリストと拡散パターン) に遅延するコンストラクトは、上記の拡張インデクサー解決に自動的に参加します。

式ツリー

拡張インデクサーは式ツリーでキャプチャできません。

XML ドキュメント

CREF 構文を使用すると、拡張インデクサーとそのアクセサーとその実装メソッドを参照できます。

Example:

/// <see cref="E.extension(int).this[string]"/>
/// <see cref="E.extension(int).get_Item(string)"/>
/// <see cref="E.extension(int).get_Item"/>
/// <see cref="E.extension(int).set_Item(string, int)"/>
/// <see cref="E.extension(int).set_Item"/>
/// <see cref="E.get_Item(int, string)"/>
/// <see cref="E.get_Item"/>
/// <see cref="E.set_Item(int, string, int)"/>
/// <see cref="E.set_Item"/>
public static class E
{
    extension(int i)
    {
        /// <summary></summary>
        public int this[string s]
        {
            get => throw null;
            set => throw null;
        }
    }
}

Metadata

拡張インデクサーは、拡張プロパティと同じ下位モデルに従います。 少なくとも 1 つのインデクサーを含む CLR レベルの拡張機能グループ化の種類ごとに、コンパイラは次を出力します。

• throw NotImplementedException()アクセサー本体と適切な拡張マーカーの種類を参照する[ExtensionMarkerName]属性を持つItem (またはIndexerNameAttributeによって提供される値) という名前の拡張プロパティ。
• 外側の静的クラス get_Item/set_Item という名前の実装メソッド。 これらのメソッドは、受信者パラメーターをパラメーター リストの先頭に追加し、ユーザー定義の本体を含みます。 これらは static され、拡張プロパティの実装メソッドと同じ方法でオーバーロード解決に参加します。

通常のインデクサーの動作をミラー化するために、コンパイラは、1 つ以上の拡張インデクサーを含む拡張グループ化型に対して [DefaultMemberAttribute] も出力します。 属性の MemberName は、インデクサーのメタデータ名 (既定ではItem 、または IndexerNameAttribute の値) と等しくなります。

Example

ソースコード:

static class BitExtensions
{
    extension<T>(T t)
    {
        public bool this[int index]
        {
            get => ...;
            set => ...;
        }
    }
}

出力されたメタデータ (C#に似た構文に簡略化):

[Extension]
static class BitExtensions
{
    [Extension, SpecialName, DefaultMember("Item")]
    public sealed class <G>$T0 // grouping type
    {
        [SpecialName]
        public static class <M>$T_t // marker type
        {
            [SpecialName]
            public static void <Extension>$(T t) { } // marker method
        }

        [ExtensionMarkerName("<M>$T_t")]
        public bool this[int index] // extension indexer
        {
            get => throw new NotImplementedException();
            set => throw new NotImplementedException();
        }
    }

    // accessor implementation methods
    public static bool get_Item<T>(T t, int index) => ...;
    public static void set_Item<T>(T t, int index, bool value) => ...;
}

未解決の課題

int i = 0;
i[42, null] = new object(); // fails inference
E.set_Item(i, 42, null, new object()); // infer `E.set_Item<object>`

public static class E
{
    extension<T>(int i)
    {
        public T this[int j, T t] { set { } }
    }
}

#nullable enable

int i = 0;
i[new object()] = null; // infer `E.extension<object!>` and warn on conversion of null literal to `object!`
E.set_Item(i, new object(), null); // infer `E.set_Item<object?>`

public static class E
{
    extension<T>(int i)
    {
        public T this[T t] { set { } }
    }
}

C c = new C();
_ = c[..]; // Cannot apply indexing with [] to an expression of type 'C'

class C
{
    public int Length => 0;
}

static class E
{
    public static C Slice(this C c, int i, int j) => null!;
}

C c = new C();
var x1 = c[^1];
var x2 = c[1..];

if (c is [.., var y1]) { }
if (c is [_, .. var y2]) { }

class C { }

static class E
{
  extension(C c)
  {
    object this[System.Index] => ...;
    C this[System.Range] => ...;
    int Length => ...;
  }
}

C c = new C();
if (c is [var y1, .. var y2]) { }

class C
{
  C Slice(int i, int j) => ...;
}

static class E
{
  extension(C c)
  {
    object this[System.Index] => ...;
    int Length => ...;
  }
}

C c = new C();
_ = c[^1];

class C
{
  public int Length => ...;
  public int this[int i] => ...;
}

static class E
{
  extension(C c)
  {
    public int this[System.Index i] => ...;
  }
}

_ = c[1..^1];

static class E
{
  extension(C c)
  {
    public int Length => 3;
  }
  public static C Slice(this C c, int i, int j) => ...;
}

C c = new C();
int[] i = [0, .. c]; // Uses Length, if available, to allocate the right size

int[] i = ...;
_ = i[new C()];

public static class E
{
    extension(int[] i)
    {
        public int this[C c] => throw null;
    }
}

string s = "...;
_ = s[new C()];

public static class E
{
    extension(int[] i)
    {
        public int this[C c] => throw null;
    }
}