# 通知設計書 19-errFailedMove

## 概要

本ドキュメントは、Nimコンパイラにおけるムーブ操作失敗エラー通知「errFailedMove」の設計について記述する。

### 本通知の処理概要

errFailedMoveは、Nimのムーブセマンティクス（move semantics）において、ensureMove関数内でムーブ操作が実行できず暗黙的なコピーが発生する場合に報告されるエラー通知である。

**業務上の目的・背景**：Nimはリソース管理のためにムーブセマンティクスを採用している。開発者が`ensureMove`を使用して明示的にムーブを要求した場合、暗黙的なコピーが発生すると、パフォーマンス上の意図と異なる動作となる。このエラーは、そのような状況を開発者に通知し、コード構造の見直しを促す。

**通知の送信タイミング**：injectdestructors.nimモジュールでデストラクタ注入処理を行う際に、以下の状況で発生する：
1. ensureMove内でsink引数への暗黙的コピーが発生する場合
2. ムーブできない値をmoveしようとした場合

**通知の受信者**：Nimコンパイラを使用し、ARC/ORC/YRCメモリ管理を使用する開発者。

**通知内容の概要**：エラーが発生したファイル名、行番号、列番号、およびムーブできない値の詳細情報を含むエラーメッセージ。

**期待されるアクション**：開発者はコード構造を見直し、暗黙的なコピーを避けるか、ensureMoveの使用を再検討する。

## 通知種別

コンパイラ標準エラー出力（stderr）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 高（エラー） |
| リトライ | なし |

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

コンパイラのエラー出力設定（`ConfigRef.m.errorOutputs`）に基づいて、標準エラー出力またはフックされたハンドラに送信される。

## 通知テンプレート

### コンソール出力の場合

| 項目 | 内容 |
|-----|------|
| 送信元 | Nimコンパイラ（injectdestructors） |
| 形式 | テキスト |

### 本文テンプレート

```
{ファイルパス}({行番号}, {列番号}) Error: {ムーブ失敗の詳細}
```

具体例：
```
file.nim(10, 5) Error: cannot move 'x', which introduces an implicit copy
file.nim(20, 3) Error: cannot move 'y', passing 'y' to a sink parameter introduces an implicit copy
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | ムーブ失敗の詳細メッセージ | injectdestructors.nimの解析結果 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル | genCopy関数 | inEnsureMove > 0 | ensureMove内でコピーが発生 |
| コンパイル | sink引数処理 | inEnsureMove > 0かつ暗黙コピー | sink引数への暗黙コピー |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| inEnsureMove == 0 | ensureMove外での暗黙コピーはエラーではなく警告（hintPerformance） |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[コンパイル開始] --> B[injectdestructors処理]
    B --> C{ensureMove内?}
    C -->|No| D[通常処理]
    C -->|Yes| E{ムーブ可能?}
    E -->|Yes| F[ムーブ実行]
    E -->|No| G[genCopy呼び出し]
    G --> H{inEnsureMove > 0?}
    H -->|Yes| I[errFailedMove発行]
    H -->|No| J[hintPerformance発行]
    I --> K[localError出力]
    D --> L[終了]
    F --> L
    J --> L
    K --> L
```

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

### 参照テーブル一覧

該当なし

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ensureMove内コピー | ensureMove使用時に暗黙コピー発生 | コード構造見直し、変数を最後の使用箇所に移動 |
| sink引数への暗黙コピー | sink引数に暗黙コピーが必要 | 制御フローを見直し、ムーブ可能な状況に変更 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（コンパイル実行時に即時出力）

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

- 特になし

## 備考

- このエラーはARC/ORC/YRC/AtomicARCメモリ管理モード（`--mm:arc`, `--mm:orc`等）で有効
- ensureMove外での暗黙コピーは警告（hintPerformance）として報告される
- ムーブセマンティクスの詳細はNimマニュアルの「Destructors and Move Semantics」を参照

---

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

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

### 推奨読解順序

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

errFailedMoveの定義とムーブセマンティクス関連の構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型のerrFailedMove定義（48行目） |
| 1-2 | lineinfos.nim | `compiler/lineinfos.nim` | エラーメッセージテンプレート「$1」（139行目） |
| 1-3 | injectdestructors.nim | `compiler/injectdestructors.nim` | Con型のinEnsureMoveフィールド |

**読解のコツ**: inEnsureMoveカウンタがensureMove呼び出しの追跡に使用されている。

#### Step 2: エラー発行箇所を理解する

errFailedMoveの発行箇所を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | injectdestructors.nim | `compiler/injectdestructors.nim` | genCopy関数（354-357行目） |
| 2-2 | injectdestructors.nim | `compiler/injectdestructors.nim` | sink引数処理（494-496行目） |

**主要処理フロー**:
1. **354-357行目**: genCopy関数でinEnsureMove > 0の場合にerrFailedMove発行
2. **494-496行目**: sink引数への暗黙コピー時にinEnsureMove > 0でerrFailedMove発行

#### Step 3: 関連する警告を理解する

ensureMove外での暗黙コピー警告を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | injectdestructors.nim | `compiler/injectdestructors.nim` | hintPerformance発行箇所（490-493行目） |

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

```
nim c --mm:arc (コンパイルコマンド)
    │
    ├─ injectdestructors.nim::injectDestructorCalls
    │      │
    │      └─ p (処理関数)
    │             │
    │             ├─ ensureMove処理
    │             │      └─ inEnsureMove++
    │             │
    │             ├─ genCopy (354-357行目)
    │             │      │
    │             │      └─ inEnsureMove > 0?
    │             │             │
    │             │             └─ localError(errFailedMove)
    │             │
    │             └─ sink引数処理 (490-496行目)
    │                    │
    │                    ├─ hintPerformance [inEnsureMove == 0]
    │                    │
    │                    └─ localError(errFailedMove) [inEnsureMove > 0]
    │
    └─ msgs.nim::localError
           │
           └─ liMessage (エラー出力)
```

### データフロー図

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

Nimソースファイル ───▶ injectdestructors::p ───▶ ムーブ可能性解析
                              │
                              ▼
                         isLastRead / isFirstWrite チェック
                              │
                              ▼ [ムーブ不可]
                         genCopy呼び出し
                              │
                              ▼ [inEnsureMove > 0]
                         localError(errFailedMove)
                              │
                              ▼
                         stderr / 構造化エラーフック
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind列挙型定義 |
| injectdestructors.nim | `compiler/injectdestructors.nim` | ソース | デストラクタ注入、ムーブセマンティクス |
| msgs.nim | `compiler/msgs.nim` | ソース | コンパイラメッセージシステム |
| dfa.nim | `compiler/dfa.nim` | ソース | データフロー解析 |
