# 画面設計書 25-nimsuggest highlight（ハイライト）

## 概要

本ドキュメントは、Nimsuggestツールの`highlight`（ハイライト）サブコマンドに関する画面設計書である。

### 本画面の処理概要

nimsuggest highlightコマンドは、IDE/エディタ連携において、カーソル位置のシンボルと同一のシンボルがファイル内のどこで使用されているかをハイライト表示するための位置情報を提供する機能である。

**業務上の目的・背景**：コード編集中に、特定のシンボル（変数名、関数名など）が同じファイル内でどこに出現するかを視覚的に確認できることは、コード理解とリファクタリングに有用である。この機能により、エディタはカーソル位置のシンボルと同一の識別子をハイライト表示でき、変数のスコープ確認やローカルな名前変更の影響範囲把握が容易になる。

**画面へのアクセス方法**：nimsuggestサーバーが起動した状態で、クライアント（エディタ/IDE）から以下のコマンド形式でリクエストを送信する。
- TCP接続の場合: `highlight "file.nim":line:col`
- stdin/EPCモードでも同様のコマンド形式を使用
- 通常、カーソル移動時に自動的にトリガーされる

**主要な操作・処理内容**：
1. クライアントからhighlightコマンドとファイル位置情報を受信
2. 指定位置のシンボルを特定
3. 同一ファイル内で同じシンボルの使用箇所を検索
4. 各使用位置の情報を返却

**画面遷移**：
- 遷移元: エディタ/IDEからのハイライトリクエスト
- 遷移先: 結果はクライアントに返却され、ハイライト表示に使用

**権限による表示制御**：本ツールはCLI/サーバーベースであり、権限による表示制御は存在しない。

## 関連機能

| 機能No | 機能名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 25 | Nimsuggest | 主機能 | ideHighlightコマンドによる構文ハイライト情報提供 |

## 画面種別

コマンドライン / サーバーレスポンス（ハイライト位置一覧）

## URL/ルーティング

```
# コマンド形式
highlight "filepath.nim":line:col
highlight "filepath.nim";"dirtyfile.nim":line:col

# TCPモード
nimsuggest --port:6000 project.nim
# その後、ソケット接続して上記コマンドを送信
```

## 入出力項目

### 入力項目

| 項目名 | 型 | 必須 | 説明 |
|--------|-----|------|------|
| file | string | Yes | 対象ファイルのパス |
| dirtyfile | string | No | 編集中の一時ファイルパス |
| line | int | Yes | 行番号（1始まり） |
| col | int | Yes | カラム番号（0始まり） |

### 出力項目（複数行で返却）

| 項目名 | 型 | 説明 |
|--------|-----|------|
| section | IdeCmd | `ideHighlight`固定 |
| filePath | string | ハイライト位置のファイルパス |
| line | int | ハイライト位置の行番号 |
| column | int | ハイライト位置のカラム番号 |

## 表示項目

ハイライト位置一覧として以下の情報がクライアントに返される:

| 表示項目 | 説明 | 例 |
|---------|------|-----|
| ファイルパス | 対象ファイル（通常は同一ファイル） | `/path/to/myfile.nim` |
| 行番号 | シンボル使用位置の行番号 | `15` |
| カラム番号 | シンボル使用位置のカラム番号 | `8` |

## イベント仕様

### 1-highlightコマンド受信

1. クライアントからhighlightコマンドを受信
2. `execCmd`関数でコマンドをパース（行524: `of "highlight": conf.ideCmd = ideHighlight`）
3. ファイル、行、カラム情報を抽出
4. `execute`関数を呼び出してハイライト検索処理を実行

### 2-ハイライト位置の検索

1. 指定位置のシンボルを特定（`findSymData`）
2. ファイル内のシンボルデータベース（`fileSymbols`）を取得
3. 同一シンボルの使用箇所を収集
4. 各使用位置を`suggestResult`で送信

## データベース更新仕様

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

| 操作（イベント） | 対象テーブル | 操作種別 | 概要 |
|----------------|-------------|---------|------|
| - | - | - | データベースへの更新は発生しない |

## メッセージ仕様

| メッセージ種別 | メッセージ | 発生条件 |
|---------------|----------|---------|
| 成功 | ハイライト位置リスト（複数行） | 正常に使用箇所が見つかった場合 |
| 情報 | 空の結果 | シンボルが見つからない場合 |

## 例外処理

| 例外状況 | 処理内容 |
|---------|---------|
| ファイルが存在しない | エラーメッセージを返却 |
| シンボルが見つからない | 空の結果を返却 |

## 備考

- highlightコマンドは同一ファイル内でのシンボル使用箇所のみを検索する（useコマンドはプロジェクト全体）
- 結果にはシンボルの使用数も含まれる（ログ出力）
- 部分コンパイルが必要な場合は自動的に実行される

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | suggestsymdb.nim | `compiler/suggestsymdb.nim` | SuggestFileSymbolDatabase構造 |

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | nimsuggest.nim | `nimsuggest/nimsuggest.nim` | 行524でideHighlightを設定 |

**主要処理フロー**:
1. **行524**: `of "highlight": conf.ideCmd = ideHighlight`

#### Step 3: ハイライト検索処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | nimsuggest.nim | `nimsuggest/nimsuggest.nim` | 行1135-1145 - ideHighlight処理 |

**主要処理フロー**:
- **行1135-1145**: ideHighlight処理ブロック
```nim
of ideHighlight:
  let sym = graph.findSymData(file, line, col)
  if not sym.isNil:
    let fs = graph.fileSymbols(fileIndex)
    var usages: seq[SymInfoPair] = @[]
    for i in fs.lineInfo.low..fs.lineInfo.high:
      if fs.sym[i] == sym.sym:
        usages.add(fs.getSymInfoPair(i))
    myLog fmt "Found {usages.len} usages in {file.string}"
    for s in usages:
      graph.suggestResult(s.sym, s.info)
```

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

```
execCmd (行494)
    │
    ├─ parseIdent - "highlight"コマンド解析 (行524)
    │
    └─ executeNoHooksV3 (行1066)
           │
           ├─ recompilePartially (必要時)
           │
           ├─ findSymData - 対象シンボル特定
           │
           ├─ fileSymbols - ファイル内シンボル取得
           │
           └─ suggestResult - 各結果送信
```

### データフロー図

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

クライアント                  nimsuggestサーバー           クライアント
    │                             │                          │
    │  highlight "file":line:col  │                          │
    │────────────────────────────>│                          │
    │                             │                          │
    │                        シンボル特定                    │
    │                             │                          │
    │                        ファイル内走査                  │
    │                             │                          │
    │                        同一シンボル収集                │
    │                             │                          │
    │                             │  Suggest[] (複数)        │
    │<───────────────────────────────────────────────────────│
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| nimsuggest.nim | `nimsuggest/nimsuggest.nim` | ソース | ideHighlight処理 |
| suggestsymdb.nim | `compiler/suggestsymdb.nim` | ソース | ファイル別シンボルDB |
