# 通知設計書 45-warnEachIdentIsTuple

## 概要

本ドキュメントは、Nimコンパイラの警告メッセージ `warnEachIdentIsTuple`（各識別子がタプル警告）に関する設計書です。

### 本通知の処理概要

この警告は、Nimプログラムにおいて複数の変数宣言でタプルを代入する際、各変数がタプル全体を受け取ることを開発者に通知する警告メッセージです。`var a, b = (1, 2)`のような宣言で、aとbの両方が`(1, 2)`というタプル全体を受け取り、aが1、bが2というアンパック動作ではないことを警告します。

**業務上の目的・背景**：Nimの変数宣言構文では、`var a, b = (1, 2)`と書いた場合、タプルのアンパックではなく、aとbの両方に同じタプル値が代入されます。これは他のプログラミング言語（Python等）に慣れた開発者にとって直感に反する動作であり、意図しないバグの原因となる可能性があります。この警告により、開発者は明示的にタプルアンパック構文を使用するか、意図的にタプル全体を代入する場合はコードの意図を明確にすることが促されます。

**通知の送信タイミング**：コンパイル時のセマンティック解析フェーズ（semstmts.nim）において、変数宣言文（var/let）を解析する際に、タプル型の値が複数の識別子に代入されていることが検出された場合に警告が発生します。

**通知の受信者**：Nimプログラムをコンパイルする開発者がこの警告を受け取ります。コンパイラの標準出力または標準エラー出力に警告メッセージが表示されます。

**通知内容の概要**：「each identifier is a tuple」というメッセージが表示され、各変数がタプル全体を受け取ることを通知します。

**期待されるアクション**：開発者は、意図がタプルアンパックの場合は`var (a, b) = (1, 2)`のように明示的なアンパック構文を使用し、意図的に各変数にタプル全体を代入する場合は警告を認識した上でコードを維持するか、個別の代入文に分けることが期待されます。

## 通知種別

コンパイラ警告（Warning）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（コンパイル時） |
| 優先度 | 中（警告レベル） |
| リトライ | なし |

### 送信先決定ロジック

コンパイラを実行している開発者のコンソールに直接出力されます。警告の有効/無効は `--warning[EachIdentIsTuple]:on/off` オプションで制御可能です。

## 通知テンプレート

### コンパイラ警告の場合

| 項目 | 内容 |
|-----|------|
| メッセージID | EachIdentIsTuple |
| 警告レベル | Warning |
| 形式 | テキスト |

### 本文テンプレート

```
{ファイル名}({行番号}, {列番号}) Warning: each identifier is a tuple [EachIdentIsTuple]
```

### 添付ファイル

該当なし（コンパイラ警告のため添付ファイルは存在しない）

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| ファイル名 | ソースファイルのパス | TLineInfo.fileIndex | Yes |
| 行番号 | 警告発生行（変数宣言の行） | a.info.line | Yes |
| 列番号 | 警告発生列 | a.info.col | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル時 | var/let宣言解析 | タプル代入かつ複数識別子 | semstmts.nim:921-924行目で検出 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| `--warning[EachIdentIsTuple]:off` | コマンドラインオプションで警告を無効化 |
| `{.warning[EachIdentIsTuple]:off.}` | プラグマで警告を無効化 |
| 識別子が2つ以下の場合 | `a.len <= 3`（識別子1つ+型+値で3要素以下） |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[var/let宣言解析] --> B{タプル型?}
    B -->|No| C[通常処理]
    B -->|Yes| D{代入値がタプルコンストラクタ?}
    D -->|No| C
    D -->|Yes| E{識別子が3つ以上?}
    E -->|No| C
    E -->|Yes| F[warnEachIdentIsTuple発行]
    F --> C
```

## データベース参照・更新仕様

### 参照テーブル一覧

該当なし（コンパイラ内部処理のため外部データベース参照なし）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 該当なし | - | - |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（リトライなし） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 制限なし |

### 配信時間帯

コンパイル実行時に即座に出力される（時間帯制限なし）

## セキュリティ考慮事項

- 本警告はセキュリティに直接影響しない
- ただし、意図しない値の代入はロジックエラーにつながる可能性がある

## 備考

- `var (a, b) = (1, 2)`のように明示的なタプルアンパック構文を使用すると、この警告は発生しない
- `a.len > 3`の条件は、IdentDefs構造が [識別子1, 識別子2, ..., 型, 代入値] の形式であることに基づく
- Pythonなどでは`a, b = (1, 2)`がアンパックとなるため、その動作を期待する開発者への注意喚起となる

---

## コードリーディングガイド

本通知を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

まず、警告メッセージの種類を定義するデータ構造を理解することが重要です。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でwarnEachIdentIsTupleの定義を確認（68行目） |
| 1-2 | lineinfos.nim | `compiler/lineinfos.nim` | MsgKindToStr配列で警告メッセージテンプレートを確認（166行目） |

**読解のコツ**: メッセージテンプレートにはパラメータがなく、固定メッセージ「each identifier is a tuple」です。

#### Step 2: エントリーポイントを理解する

警告を発生させるsemVarOrLet関数のコードを確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | semstmts.nim | `compiler/semstmts.nim` | 921-924行目で警告発生条件を確認 |

**主要処理フロー**:
1. **920行目**: `else:`ブロックに入る（タプルアンパックでない場合）
2. **921行目**: `tup.kind == tyTuple`でタプル型かチェック
3. **921行目**: `def.kind in {nkPar, nkTupleConstr}`で代入値がタプルコンストラクタかチェック
4. **922行目**: `a.len > 3`で識別子が複数あるかチェック
5. **924行目**: 条件を満たす場合にwarnEachIdentIsTuple警告を発行

#### Step 3: AST構造を理解する

変数宣言のAST構造を理解します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | ast.nim | `compiler/ast.nim` | nkIdentDefs、nkPar、nkTupleConstrの定義を確認 |

**主要処理フロー**:
- nkIdentDefs: [識別子, 識別子, ..., 型, 代入値]の構造
- a.len > 3 は識別子が2つ以上あることを意味する

### プログラム呼び出し階層図

```
semstmts.nim::semVarOrLet()
    │
    └─ 変数定義ループ（各IdentDefに対して）
           │
           ├─ nkVarTupleチェック（914行目）→ タプルアンパック処理
           │
           └─ else（920行目）→ 通常の変数定義
                  │
                  ├─ tup.kind == tyTuple?（921行目）
                  │
                  ├─ def.kind in {nkPar, nkTupleConstr}?（921行目）
                  │
                  └─ a.len > 3?（922行目）
                         │
                         └─ message(warnEachIdentIsTuple)（924行目）
                                │
                                └─ コンソール出力
```

### データフロー図

```
[入力]                              [処理]                         [出力]

var a, b = (1, 2)
    │
    ▼
nkIdentDefs
├─ [0]: nkIdent "a"
├─ [1]: nkIdent "b"
├─ [2]: 型（空）
└─ [3]: nkTupleConstr (1, 2)
    │
    ▼
semVarOrLet() ───▶ tyTuple? ───▶ nkTupleConstr? ───▶ len > 3?
                                                        │
                                                        ▼
                                                  警告メッセージ
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | 警告種別の定義とメッセージテンプレート |
| semstmts.nim | `compiler/semstmts.nim` | ソース | 変数宣言解析と警告発生ロジック |
| ast.nim | `compiler/ast.nim` | ソース | ASTノード種別の定義 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力機能 |
