# 通知設計書 22-warnOctalEscape

## 概要

本ドキュメントは、Nimコンパイラにおける警告通知「warnOctalEscape」の設計仕様を定義する。この警告は、ソースコード内で8進数エスケープシーケンスのような記法（先頭にゼロを持つ数値）が検出された場合に発生する。

### 本通知の処理概要

この通知は、字句解析（レキサー）段階で文字列リテラルや文字リテラル内のエスケープシーケンスを解析中に、'0'で始まる数値が検出された場合に発生する。Nim言語では8進数エスケープシーケンスはサポートされていないため、この警告を発して先頭のゼロが無視されることをユーザーに通知する。

**業務上の目的・背景**：CやC++など他の言語から移行してきた開発者は、8進数エスケープシーケンス（\0XX形式）を使用する習慣がある可能性がある。Nimでは8進数エスケープシーケンスは存在せず、先頭のゼロは無視されるため、意図しない動作を防ぐために警告を発する。これにより、開発者は明示的に16進数エスケープ（\xXX）や10進数エスケープを使用するよう促される。

**通知の送信タイミング**：コンパイル時の字句解析フェーズにおいて、文字列リテラルまたは文字リテラル内のエスケープシーケンスが `\0` で始まり、その後に `0`-`9` の数字が続く場合（例：`\012`）に送信される。

**通知の受信者**：Nimソースコードをコンパイルしている開発者（標準エラー出力またはIDEツール経由）。

**通知内容の概要**：「octal escape sequences do not exist; leading zero is ignored」というメッセージが出力され、8進数エスケープシーケンスがNimでは存在せず、先頭のゼロが無視されることを通知する。

**期待されるアクション**：開発者はエスケープシーケンスを確認し、意図した文字コードを正しく指定するために16進数エスケープ（\xXX）または10進数エスケープ（\XX）を使用するようコードを修正する。

## 通知種別

コンパイラ警告メッセージ（標準エラー出力 / IDE連携）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 中（Warning） |
| リトライ | 無し |

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

標準エラー出力（stderr）に出力される。IDEツール（nimsuggest等）使用時は、構造化されたエラーフック経由でIDEに通知される。`--stdout`オプション指定時は標準出力に出力される。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 出力先 | stderr（デフォルト）/ stdout（--stdout指定時） |
| 形式 | テキスト |

### 本文テンプレート

```
{ファイル名}({行},{列}) Warning: octal escape sequences do not exist; leading zero is ignored [OctalEscape]
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| - | 固定メッセージのため変数なし | - | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル | 字句解析フェーズ | `\0` で始まるエスケープシーケンスで次の文字が数字 | matchTwoChars(L, '0', {'0'..'9'})がtrueの場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --warning:OctalEscape:off | この特定の警告が無効化されている場合 |
| --warnings:off | 全ての警告が無効化されている場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ソースコード読み込み] --> B[字句解析開始]
    B --> C[エスケープシーケンス検出]
    C --> D{バックスラッシュ後の文字}
    D -->|'0'-'9'| E{先頭が'0'で次も数字?}
    D -->|その他| F[他のエスケープ処理]
    E -->|Yes| G[warnOctalEscape発行]
    E -->|No| H[通常の10進数処理]
    G --> I[lexMessage呼び出し]
    I --> J[liMessage呼び出し]
    J --> K[styledMsgWriteln出力]
    K --> L[先頭ゼロを無視して処理継続]
    H --> L
```

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

### 参照テーブル一覧

該当なし（ソースコード解析のみ）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| - | この警告自体はエラーではない | 警告を出力し処理継続 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- ソースコードの内容（エスケープシーケンス）が警告メッセージに含まれることはない
- ファイルパスと行番号のみが出力される
- セキュリティリスクは低い

## 備考

- C言語からの移行者向けの警告として設計されている
- Nimでは8進数リテラルには `0o` プレフィックスを使用する（例：`0o755`）
- エスケープシーケンスでは16進数（\xXX）または10進数を使用する

---

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

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

### 推奨読解順序

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

まず、メッセージ種別の定義と警告メッセージの文字列を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でwarnOctalEscapeの定義（51行目）、MsgKindToStr配列でメッセージ文字列の定義（142行目） |

**読解のコツ**: warnOctalEscapeはwarnCannotOpenFileの直後に定義されている。メッセージ文字列「octal escape sequences do not exist; leading zero is ignored」は固定で、変数を含まない。

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

警告が発生する具体的なコード箇所を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | lexer.nim | `compiler/lexer.nim` | getEscapedChar関数内（728-730行目）でmatchTwoCharsを使用して8進数パターンを検出 |

**主要処理フロー**:
1. **728行目**: `of '0'..'9':` で数字エスケープを検出
2. **729行目**: `if matchTwoChars(L, '0', {'0'..'9'}):` で先頭ゼロ+数字を判定
3. **730行目**: `lexMessage(L, warnOctalEscape)` で警告を発行

#### Step 3: エスケープシーケンス処理全体を理解する

getEscapedChar関数の全体構造を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | lexer.nim | `compiler/lexer.nim` | getEscapedChar関数（679行目〜）でバックスラッシュ後の各文字に対する処理を定義 |

**主要処理フロー**:
- **679行目**: getEscapedChar関数開始
- **680行目**: バックスラッシュ位置をインクリメント
- **681行目**: case文で後続文字を判定
- **728-734行目**: 数字エスケープの処理（8進数警告を含む）

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

```
lexer.getString (compiler/lexer.nim:756)
    │
    └─ getEscapedChar (compiler/lexer.nim:679)
           │
           ├─ matchTwoChars (compiler/lexer.nim判定)
           │      └─ '0' + {'0'..'9'} パターン検出
           │
           └─ lexMessage (compiler/lexer.nim)
                  │
                  └─ liMessage (compiler/msgs.nim:536)
                         │
                         └─ styledMsgWriteln (compiler/msgs.nim:401)
```

### データフロー図

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

ソースコード ───▶ Lexer ───▶ getEscapedChar ───▶ warnOctalEscape ───▶ stderr
    │                            │
    └─ "\012" ──────────────────┘
       8進数風エスケープ検出
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind列挙型とメッセージ文字列の定義 |
| lexer.nim | `compiler/lexer.nim` | ソース | 字句解析器、warnOctalEscape発行箇所 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力関数群の実装 |
| nimlexbase.nim | `compiler/nimlexbase.nim` | ソース | レキサーの基底クラス |
