# バッチ設計書 18---visualize

## 概要

本ドキュメントは、ASTを可視化するCLIコマンド `--visualize` のバッチ設計書です。

### 本バッチの処理概要

このCLIコマンドは、指定されたLuaソースファイルを解析し、そのAST（Abstract Syntax Tree：抽象構文木）をGraphviz DOT形式で標準出力に出力します。コードの構造を視覚的に理解するためのデバッグ・学習用ツールです。

**業務上の目的・背景**：Lua言語サーバーの開発やデバッグにおいて、パーサーがソースコードをどのように解釈しているかを視覚的に確認することは重要です。このコマンドにより、複雑なLuaコードの構造を木構造として表示し、パーサーの動作確認や言語サーバーの機能開発に活用できます。また、Luaの構文を学習する際の教材としても利用できます。

**バッチの実行タイミング**：開発時のデバッグ、パーサー動作確認、学習目的で手動実行されます。

**主要な処理内容**：
1. 指定されたLuaファイルの読み込み
2. パーサーによるソースコードの解析
3. ASTノードの走査とDOT形式への変換
4. Graphviz互換のDOT形式出力

**前後の処理との関連**：出力されたDOT形式のデータは、Graphvizツール（dot、neato等）で画像ファイル（PNG、SVG等）に変換できます。

**影響範囲**：標準出力のみ。ファイルシステムには影響しません。

## バッチ種別

解析ツール・可視化出力

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動実行） |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | 手動 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| lua-language-server実行可能ファイルが存在 | CLIを実行するための本体 |
| 有効なLuaファイルパスの指定 | 解析対象のLuaファイルが存在すること |

### 実行可否判定

`--visualize` オプションでLuaファイルパスが指定されている場合、AST可視化モードで起動します。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| --visualize | string | Yes | - | 解析対象のLuaファイルパス |
| LUA_VER | string | No | Lua 5.4 | 解析に使用するLuaバージョン |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Luaソースファイル | .lua | 解析対象のソースコード |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | Graphviz DOT形式 | AST構造の定義 |
| 終了コード | 整数 | 0: 成功、1: 失敗 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | なし（標準出力） |
| 出力先 | stdout |
| 文字コード | UTF-8 |
| 区切り文字 | - |

## 処理フロー

### 処理シーケンス

```
1. CLI引数の解析
   └─ main.luaでグローバル変数VISUALIZEにファイルパスを設定

2. 可視化モード判定
   └─ cli/init.luaでVISUALIZEが設定されているか確認

3. cli/visualize.lua:runCLI()の呼び出し
   └─ ロケール設定
   └─ ファイルパスの取得

4. ファイル読み込み
   └─ io.openでファイルを開く
   └─ 全内容を読み込み

5. AST生成
   └─ parser.compile()でソースコードを解析
   └─ Luaバージョンを指定（デフォルト: Lua 5.4）

6. DOT形式出力
   └─ digraph ASTヘッダー出力
   └─ ノード定義出力
   └─ getVisualizeVisitor()で再帰的にノードを走査
   └─ 各ノードのラベルとツールチップを生成
   └─ 親子関係をエッジとして出力

7. 終了
   └─ 正常終了: 0
   └─ エラー発生: 1
```

### フローチャート

```mermaid
flowchart TD
    A[コマンド実行] --> B[引数解析]
    B --> C{--visualize指定?}
    C -->|No| D[通常処理へ]
    C -->|Yes| E[runCLI呼び出し]
    E --> F[ファイル読み込み]
    F --> G{読み込み成功?}
    G -->|No| H[エラー出力]
    H --> I[終了コード 1]
    G -->|Yes| J[parser.compile]
    J --> K[DOTヘッダー出力]
    K --> L[ノード走査開始]
    L --> M{子ノードあり?}
    M -->|Yes| N[ノード情報出力]
    N --> O[エッジ出力]
    O --> M
    M -->|No| P[DOTフッター出力]
    P --> Q[終了コード 0]
```

## データベース操作仕様

### 操作別データベース影響一覧

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| - | - | - | データベースは使用しない |

### テーブル別操作詳細

データベース操作は行いません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | ファイル読み込みエラー | 指定されたファイルが存在しないまたは読み込めない | ファイルパスを確認する |
| - | パースエラー | Luaコードに構文エラーがある | ソースコードを修正する |

### リトライ仕様

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

### 障害時対応

ファイル読み込みエラーの場合はstderrにエラーメッセージを出力して終了コード1を返します。

## トランザクション仕様

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし（読み取り専用） |
| コミットタイミング | - |
| ロールバック条件 | - |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 単一ファイル |
| 目標処理時間 | ミリ秒〜秒単位 |
| メモリ使用量上限 | ファイルサイズに依存 |

## 排他制御

排他制御は不要です。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| エラーログ | ファイル読み込み失敗時 | stderrにエラーメッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| なし | - | - |

## 備考

- このコマンドは `script/cli/visualize.lua` で実装されています
- 出力形式はGraphviz DOT言語です
- 各ノードには以下の情報が含まれます：
  - ノードID: `type:start:finish` 形式
  - ラベル: ノードタイプとキー名
  - ツールチップ: start、finish、その他のプロパティ
- 長い文字列は20文字に切り詰められます（shorten関数）
- 改行は `\\n` にエスケープされます
- バイナリ/単項演算子はオペレータタイプがキー名として表示されます
- label/gotoノードはラベル名がキー名として表示されます
- 配列要素が15を超える場合は省略表示されます
- 使用例：
  ```bash
  lua-language-server --visualize=myfile.lua > ast.dot
  dot -Tpng ast.dot -o ast.png
  ```
