# 通知設計書 85-warnLongLiterals

## 概要

本ドキュメントは、Nimコンパイラの警告通知「warnLongLiterals」（長いリテラル警告）に関する設計仕様を記載する。

### 本通知の処理概要

本通知は、数値リテラルの桁数がその型で表現可能な最大桁数を超えている場合に警告を発行するものである。これにより、リテラル値が切り捨てられる可能性や意図しない値になる可能性を開発者に通知する。

**業務上の目的・背景**：Nimでは数値リテラルを16進数（0x）、8進数（0o）、2進数（0b）などで記述できる。各数値型には表現可能なビット幅があり、そのビット幅で表現できる最大桁数が決まっている。例えば、32ビット整数の16進数表現では最大8桁（32/4=8）となる。この警告は、型のビット幅を超える桁数のリテラルを検出し、値の切り捨てや意図しない動作を防止する。

**通知の送信タイミング**：字句解析フェーズ（lexer.nim内）において、数値リテラルをパースする際に、桁数が型の最大桁数を超えていることを検出した時点で発行される。

**通知の受信者**：コンパイルを実行している開発者。ターミナルまたはIDEの出力ウィンドウに表示される。

**通知内容の概要**：「number has {実際の桁数} digits but type only supports {最大桁数} digits: '{リテラル}'」という形式で、桁数の不一致を示す。

**期待されるアクション**：開発者は警告を確認し、以下のいずれかの対応を行うことが期待される：(1) より大きな型を使用する、(2) リテラル値を修正する、(3) 意図的な切り捨てであれば警告を抑制する。

## 通知種別

コンパイラ警告（Warning） - ターミナル/IDE出力

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（コンパイル処理中に即座に出力） |
| 優先度 | 中（Warning） |
| リトライ | なし |

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

コンパイラの標準エラー出力（stderr）または設定されたwritelnHookに出力される。`--stdout`オプション指定時は標準出力に出力される。

## 通知テンプレート

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

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

### 本文テンプレート

```
{ファイル名}({行番号}, {列番号}) Warning: number has {桁数} digits but type only supports {最大桁数} digits: '{リテラル}' [LongLiterals]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 警告メッセージ本文 | lexer.nim内で動的生成 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 字句解析処理 | 数値リテラルのパース | 桁数が型の最大桁数を超過 | lexer.nim内での数値リテラル解析時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --warning:LongLiterals:off | コマンドラインオプションで抑制可能 |
| {.warning[LongLiterals]:off.} | プラグマで抑制可能 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[数値リテラル解析開始] --> B[基数と桁数を計算]
    B --> C[型のビット幅を取得]
    C --> D[最大桁数を計算]
    D --> E{実際の桁数 > 最大桁数?}
    E -->|No| F[通常処理継続]
    E -->|Yes| G[警告メッセージ生成]
    G --> H[lexMessageLitNum呼び出し]
    H --> F
```

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

### 参照テーブル一覧

本通知はデータベースを使用しない。

### 更新テーブル一覧

本通知はデータベースを使用しない。

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

なし。コンパイラ警告メッセージであり、機密情報を含まない。

## 備考

- 警告IDは "LongLiterals"
- 16進数、8進数、2進数リテラルに適用
- 最大桁数の計算：(ビット幅 + 基数のビット数 - 1) / 基数のビット数
  - 例：32ビット、16進数（4ビット/桁）→ (32 + 4 - 1) / 4 = 8桁

---

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

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

### 推奨読解順序

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

警告メッセージの種類と定義を理解する。

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

**読解のコツ**: メッセージテンプレートは "$1" であり、実際のメッセージはlexer.nimで動的に構築される。

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

警告が発行される箇所を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | lexer.nim | `compiler/lexer.nim` | 330-339行目で桁数チェックと警告発行処理を確認 |

**主要処理フロー**:
1. **330-333行目**: トークン型からビット幅を計算
2. **335行目**: 最大桁数を計算（ceil(bitWidth / bitsPerDigit)）
3. **336行目**: 実際の桁数と最大桁数を比較
4. **337-339行目**: 超過している場合にlexMessageLitNum関数を呼び出して警告を出力

#### Step 3: レキサーの文脈を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | lexer.nim | `compiler/lexer.nim` | lexMessageLitNum関数の実装を確認し、警告メッセージの構築方法を理解する |

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

```
lexer.nim: getNumber (数値リテラル解析)
    │
    ├─ ビット幅計算（トークン型から）
    │
    ├─ 最大桁数計算
    │
    └─ lexer.nim: lexMessageLitNum (警告発行)
           │
           └─ msgs.nim: message (メッセージ処理)
```

### データフロー図

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

数値リテラル ───▶ lexer.nim ───▶ 桁数チェック
 (ソースコード)    getNumber         │
                                     ▼
                              最大桁数超過検出
                                     │
                                     ▼
                              lexMessageLitNum ───▶ stderr/stdout
                                                    (警告メッセージ)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | 警告種別定義とメッセージテンプレート |
| lexer.nim | `compiler/lexer.nim` | ソース | 字句解析、警告発行トリガー |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力処理 |
