# 通知設計書 72-warnCstringConv

## 概要

本ドキュメントは、Nimコンパイラの警告メッセージ「warnCstringConv」（cstring変換警告）に関する通知設計書である。非constな場所からcstringへの暗黙的な変換が行われた際に、開発者にメモリ安全性に関する警告を発する機能について記載する。

### 本通知の処理概要

この通知は、Nimコンパイラがコード解析中に非constな文字列からcstringへの暗黙的な変換を検出した際に発行される警告メッセージである。

**業務上の目的・背景**：Nimの`cstring`型はCの文字列ポインタと互換性があり、ガベージコレクタによる管理対象外となる。非constな場所（変数など）からcstringへの暗黙変換は、参照元のメモリがGCによって解放された後もcstringが無効なメモリを指し続ける「ダングリングポインタ」問題を引き起こす可能性がある。本警告は将来的にコンパイルエラーに昇格予定であり、早期にコードの修正を促すことを目的とする。

**通知の送信タイミング**：コンパイル時、セマンティック解析フェーズ（sempass2）において、`nkHiddenStdConv`、`nkHiddenSubConv`ノードが処理される際に、変換先の型がcstringであり、かつ変換元が非constな場所である場合に発行される。

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

**通知内容の概要**：警告メッセージには「implicit conversion to 'cstring' from a non-const location: 変換式; this will become a compile time error in the future」という形式で、問題のある変換式と将来の挙動変更の予告が含まれる。

**期待されるアクション**：開発者は警告を確認し、文字列をconst宣言にするか、または明示的なキャストを使用して意図的な変換であることを示すことが期待される。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
{ファイルパス}({行番号}, {列番号}) Warning: implicit conversion to 'cstring' from a non-const location: {変換式}; this will become a compile time error in the future [CStringConv]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 変換式の文字列表現 | AST（n[1]）の文字列化結果 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル時 | 型変換ノードの解析 | cstringへの暗黙変換かつ非const | sempass2でnkHiddenStdConv等を処理時に検出 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --warning:CStringConv:off | コマンドラインで明示的に無効化された場合 |
| {.warning[CStringConv]:off.} | プラグマで無効化された場合 |
| allowCStringConv(n[1])がtrue | 変換元がcstring変換を許可される形式の場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[型変換ノード検出] --> B{変換先がcstring?}
    B -->|No| I[終了]
    B -->|Yes| C{allowCStringConv判定}
    C -->|許可| I
    C -->|不許可| D[warnCstringConv発行]
    D --> E[message関数呼び出し]
    E --> F[出力先に警告表示]
    F --> G[警告カウンタ増加]
    G --> I
```

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

### 参照テーブル一覧

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

### 内部データ構造

| 構造体 | 用途 | 備考 |
|--------|------|------|
| PType | 型情報 | tyCstringを識別 |
| TLineInfo | 位置情報 | ファイル/行/列を保持 |
| ConfigRef | 設定 | 警告の有効/無効状態を保持 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 警告の昇格 | --warningAsError:CStringConv指定時 | エラーとして扱いコンパイル中断 |
| 将来的なエラー化 | 将来バージョン | 本警告はコンパイルエラーに昇格予定 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- ファイルパスが出力に含まれるため、センシティブなパス情報が漏洩する可能性がある
- cstring変換の安全でない使用はバッファオーバーフロー等のセキュリティ脆弱性につながる可能性がある

## 備考

- 将来的にコンパイルエラーに昇格予定
- `warnPtrToCstringConv`はポインタからcstringへの変換に対して発行される関連警告
- 安全なcstring使用パターンについてはNimのドキュメントを参照

---

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

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

### 推奨読解順序

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

まず、cstring型とその変換に関する型定義を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | 85行目: warnCstringConvの定義を確認 |
| 1-2 | lineinfos.nim | `compiler/lineinfos.nim` | 194行目: メッセージテンプレート「$1」の定義を確認 |

**読解のコツ**: warnCstringConvはCStringConvという文字列キーに関連付けられている。

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

警告発行の起点となるセマンティック解析処理を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sempass2.nim | `compiler/sempass2.nim` | 1527-1537行目: track関数内のcstring変換チェック部分 |

**主要処理フロー**:
1. **1527行目**: nkHiddenStdConv, nkHiddenSubConv, nkConvノードのcase分岐開始
2. **1528-1529行目**: 変換先がcstringかチェック
3. **1530行目**: allowCStringConv関数で変換が許可されるか判定
4. **1531-1533行目**: 不許可の場合warnCstringConv警告を発行

#### Step 3: 変換許可判定を理解する

allowCStringConv関数の実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sempass2.nim | `compiler/sempass2.nim` | allowCStringConv関数の定義箇所 |

**読解のコツ**: この関数はリテラル文字列やconst定義など、安全にcstringに変換できるケースを判定する。

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

```
track (sempass2.nim:1527)
    │
    ├─ skipTypes (types.nim)
    │      └─ abstractInstをスキップしてtyCstringを検出
    │
    ├─ allowCStringConv (sempass2.nim)
    │      └─ const/リテラル判定
    │
    └─ message (msgs.nim:641)
           └─ liMessage (msgs.nim:536)
                  ├─ getMessageStr (msgs.nim:422)
                  └─ styledMsgWriteln (msgs.nim:401)
```

### データフロー図

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

型変換AST ───▶ sempass2.track関数 ───▶ 警告メッセージ
   │                   │                    │
   │                   ├─ cstring判定        ├─ 標準エラー出力
   │                   │                    │
   └─ 変換元式         └─ allowCStringConv   └─ "this will become..."
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | メッセージ種別とテンプレートの定義 |
| sempass2.nim | `compiler/sempass2.nim` | ソース | セマンティック解析第2パス、警告発行のトリガー |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力の実装 |
| types.nim | `compiler/types.nim` | ソース | 型操作ユーティリティ |
| ast.nim | `compiler/ast.nim` | ソース | AST定義（tyCstring等） |
