# 通知設計書 73-warnPtrToCstringConv

## 概要

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

### 本通知の処理概要

この通知は、Nimコンパイラがコード解析中に文字配列ポインタ（ptr array[N, char]など）からcstringへの変換を検出した際に発行される警告メッセージである。

**業務上の目的・背景**：ポインタ型からcstringへの変換は、型システムによる安全性保証を迂回する危険な操作である。配列の境界を超えたアクセスや、ヌル終端されていない文字列へのアクセスなど、メモリ安全性を損なう可能性がある。本警告は将来的にコンパイルエラーに昇格予定であり、開発者に明示的なcast操作の使用を促すことを目的とする。

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

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

**通知内容の概要**：警告メッセージには「unsafe conversion to 'cstring' from 'ptr型'; Use a `cast` operation like `cast[cstring](x)`; this will become a compile time error in the future」という形式で、問題のある型と対処方法、将来の挙動変更の予告が含まれる。

**期待されるアクション**：開発者は警告を確認し、`cast[cstring](x)`のような明示的なキャスト操作を使用して意図的な変換であることを示すことが期待される。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
{ファイルパス}({行番号}, {列番号}) Warning: unsafe conversion to 'cstring' from '{型名}'; Use a `cast` operation like `cast[cstring](x)`; this will become a compile time error in the future [PtrToCstringConv]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 変換元の型名 | n[1].typの文字列表現 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル時 | 型変換ノードの解析 | cstringへの変換かつ変換元がcharのポインタ配列 | sempass2でisCharArrayPtr判定 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --warning:PtrToCstringConv:off | コマンドラインで明示的に無効化された場合 |
| {.warning[PtrToCstringConv]:off.} | プラグマで無効化された場合 |
| isCharArrayPtrがfalse | 変換元がchar配列ポインタでない場合 |

## 処理フロー

### 送信フロー

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

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

### 参照テーブル一覧

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

### 内部データ構造

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- ファイルパスが出力に含まれるため、センシティブなパス情報が漏洩する可能性がある
- ポインタからcstringへの変換はバッファオーバーフロー等のセキュリティ脆弱性の原因となり得る
- この警告を無視したコードはメモリ安全性を損なう可能性が高い

## 備考

- 将来的にコンパイルエラーに昇格予定
- `warnCstringConv`は非constからcstringへの変換に対して発行される関連警告
- `cast[cstring](x)`を使用することで警告を回避できるが、責任は開発者に移る

---

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

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

### 推奨読解順序

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

まず、警告の定義とメッセージテンプレートを理解する。

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

**読解のコツ**: このメッセージテンプレートには「Use a `cast` operation」という具体的な対処法が含まれている。

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

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

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

**主要処理フロー**:
1. **1534行目**: 変換先がcstringかチェック（skipTypes(abstractInst)）
2. **1535行目**: isCharArrayPtr関数で変換元がchar配列ポインタか判定
3. **1536-1537行目**: 条件を満たす場合warnPtrToCstringConv警告を発行

#### Step 3: isCharArrayPtr関数を理解する

ポインタ型の判定ロジックを確認する。

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

**読解のコツ**: この関数は`ptr array[N, char]`や`ptr UncheckedArray[char]`などのパターンを検出する。

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

```
track (sempass2.nim:1527)
    │
    ├─ skipTypes (types.nim)
    │      └─ abstractInstをスキップしてtyCstringを検出
    │
    ├─ isCharArrayPtr (sempass2.nim)
    │      └─ tyPtr + tyArray/tyUncheckedArray + tyChar判定
    │
    └─ message (msgs.nim:641)
           └─ liMessage (msgs.nim:536)
                  ├─ getMessageStr (msgs.nim:422)
                  └─ styledMsgWriteln (msgs.nim:401)
```

### データフロー図

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

型変換AST ───▶ sempass2.track関数 ───▶ 警告メッセージ
   │                   │                    │
   │                   ├─ cstring判定        ├─ 標準エラー出力
   │                   │                    │
   └─ 変換元型         └─ isCharArrayPtr    └─ "Use a cast..."
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| 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定義（tyPtr, tyArray等） |
