# 通知設計書 78-warnUnnamedBreak

## 概要

本ドキュメントは、Nimコンパイラの警告メッセージ「warnUnnamedBreak」（無名break警告）に関する通知設計書である。blockステートメント内で名前なしbreakが使用された場合に、開発者に非推奨警告を発する機能について記載する。

### 本通知の処理概要

この通知は、Nimコンパイラがblock文の中で名前を指定しないbreak文（無名break）を検出した際に発行される警告メッセージである。

**業務上の目的・背景**：Nimのblock文はラベル（名前）を持つことができ、break文でそのラベルを指定して制御フローを脱出できる。しかし、block内で名前なしbreakを使用すると、コードの意図が不明確になり、保守性が低下する。特にネストしたblock構造では、どのブロックからbreakするのかが曖昧になる。本警告は、名前付きblockと名前付きbreakの使用を促進し、コードの可読性と保守性を向上させることを目的とする。

**通知の送信タイミング**：コンパイル時、セマンティック解析フェーズ（semstmts）において、break文が解析される際に、blockのネストカウンタが0より大きく、かつloop内でないbreak文を検出した場合に発行される。

**通知の受信者**：Nimコンパイラを使用してコードをコンパイルしている開発者。警告メッセージは標準エラー出力またはコンパイラの設定に応じた出力先に送信される。

**通知内容の概要**：警告メッセージには「Using an unnamed break in a block is deprecated; Use a named block with a named break instead」という形式で、問題点と対処方法が含まれる。

**期待されるアクション**：開発者は警告を確認し、block文に名前を付けて`block myBlock:`のように定義し、break文も`break myBlock`のように名前を指定することが期待される。

## 通知種別

コンパイラ警告メッセージ（標準エラー出力/構造化出力）

## 送信仕様

### 基本情報

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

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

コンパイラの標準エラー出力、または`--stdout`オプション指定時は標準出力に送信。`structuredErrorHook`が設定されている場合はフック関数を通じて送信される。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 送信元 | Nimコンパイラ |
| 形式 | テキスト |
| 重大度 | Warning |

### 本文テンプレート

```
{ファイルパス}({行番号}, {列番号}) Warning: Using an unnamed break in a block is deprecated; Use a named block with a named break instead [UnnamedBreak]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| (なし) | 固定メッセージ | lineinfos.nimで定義 | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル時 | break文解析 | nestedBlockCounter > 0 かつ breakInLoop = false | semstmts.nimで検出 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --warning:UnnamedBreak:off | コマンドラインで明示的に無効化された場合 |
| {.warning[UnnamedBreak]:off.} | プラグマで無効化された場合 |
| loop内のbreak | breakInLoop = trueの場合は対象外 |
| 名前付きbreak | break文にラベルが指定されている場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[break文解析開始] --> B{nkBreakStmt?}
    B -->|No| I[終了]
    B -->|Yes| C{nestedBlockCounter > 0?}
    C -->|No| I
    C -->|Yes| D{breakInLoop?}
    D -->|Yes| I
    D -->|No| E[warnUnnamedBreak発行]
    E --> F[localError関数呼び出し]
    F --> I
```

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

### 参照テーブル一覧

コンパイラはデータベースを使用せず、メモリ上のAST（抽象構文木）とコンテキスト情報を参照する。

### 内部データ構造

| 構造体 | 用途 | 備考 |
|--------|------|------|
| PContext | コンパイルコンテキスト | nestedBlockCounter, breakInLoopを保持 |
| TLineInfo | 位置情報 | ファイル/行/列を保持 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 警告の昇格 | --warningAsError:UnnamedBreak指定時 | エラーとして扱いコンパイル中断 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

コンパイル実行時に即時発行

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

- ファイルパスが出力に含まれるため、センシティブなパス情報が漏洩する可能性がある
- 制御フローの曖昧さはセキュリティ脆弱性の原因となり得る

## 備考

- 非推奨パターンであり、名前付きブロックの使用が推奨される
- loop（while, for）内のbreakは対象外
- continue文には別のエラーハンドリングがある

---

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

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

### 推奨読解順序

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

警告の定義とコンテキストカウンタを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | 91行目: warnUnnamedBreakの定義を確認 |
| 1-2 | lineinfos.nim | `compiler/lineinfos.nim` | 200行目: 詳細メッセージテンプレートを確認 |

**読解のコツ**: メッセージには「Use a named block with a named break instead」という具体的な対処法が含まれている。

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

警告発行の起点となるbreak文解析処理を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | semstmts.nim | `compiler/semstmts.nim` | 90-91行目: break文の無名使用検出と警告発行部分 |

**主要処理フロー**:
1. **90行目**: nestedBlockCounter > 0, nkBreakStmt, breakInLoop条件チェック
2. **91行目**: localError関数でwarnUnnamedBreak発行

#### Step 3: コンテキストカウンタを理解する

nestedBlockCounterとbreakInLoopの管理を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | semstmts.nim | `compiler/semstmts.nim` | block文とloop文でのカウンタ操作箇所 |

**読解のコツ**: block文に入るとnestedBlockCounterが増加、loop文に入るとbreakInLoopがtrueに設定される。

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

```
semStmt (semstmts.nim)
    │
    ├─ semBreakOrContinue (semstmts.nim)
    │      │
    │      ├─ nestedBlockCounterチェック
    │      │
    │      ├─ breakInLoopチェック
    │      │
    │      └─ localError (msgs.nim)
    │             └─ warnUnnamedBreak
    │
    └─ semBlock / semWhile
           └─ カウンタ管理
```

### データフロー図

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

break文AST ───▶ semBreakOrContinue ───▶ 警告メッセージ
   │                   │                    │
   │                   ├─ カウンタ確認       ├─ 標準エラー出力
   │                   │                    │
   └─ 位置情報         └─ loop内判定         └─ [UnnamedBreak]
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | メッセージ種別とテンプレートの定義 |
| semstmts.nim | `compiler/semstmts.nim` | ソース | break/continue文のセマンティック解析 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力の実装 |
| sem.nim | `compiler/sem.nim` | ソース | PContext定義（nestedBlockCounter等） |
