# 通知設計書 51-OpenHyperlink

## 概要

本ドキュメントは、Windows Terminal における OpenHyperlink イベント通知の設計仕様を記述する。ターミナル出力中のハイパーリンクをユーザーが操作した際に発火し、OS既定のブラウザやアプリケーションでURIを開く処理をトリガーするアクション通知である。

### 本通知の処理概要

OpenHyperlink は、ターミナル画面上に表示されたハイパーリンク（URL等）をユーザーが操作した際に発火するイベントである。このイベントは ControlCore、ControlInteractivity、TermControl の3層を経由して TerminalPage まで伝搬し、最終的に ShellExecute を用いてOSレベルでURIを開く。

**業務上の目的・背景**：ターミナル出力にはURLやファイルパスなどのハイパーリンクが頻繁に含まれる。ユーザーがこれらを手動でコピー＆ペーストする手間を省き、直接クリックやキーボード操作でリンクを開けるようにすることで、開発者の作業効率を大幅に向上させることが目的である。

**通知の送信タイミング**：マウスクリック（Ctrl+クリック等）によるハイパーリンクの選択時、またはマーク選択モードで Ctrl+Enter を押下した際に発火する。ControlCore ではキーバインド経由（Ctrl+Enter）、ControlInteractivity ではマウスクリック経由の2つのパスがある。

**通知の受信者**：TermControl が ControlCore および ControlInteractivity の両方から OpenHyperlink イベントを受信し、_HyperlinkHandler コルーチンで処理する。さらに TerminalPage が TermControl の OpenHyperlink イベントを購読し、最終的にURIを開く処理を実行する。

**通知内容の概要**：OpenHyperlinkEventArgs オブジェクトが渡され、Uri プロパティにハイパーリンクのURI文字列が含まれる。URIが存在しない場合は選択テキストがURIとして使用される。

**期待されるアクション**：受信側（TerminalPage）はURIの妥当性を検証し、サポートされているスキームであれば ShellExecute でOSに処理を委譲する。サポートされていないスキームの場合はエラーダイアログ（CouldNotOpenUriDialog）を表示する。

## 通知種別

アプリ内イベント通知（WinRT TypedEventHandler）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（UIスレッドへのディスパッチ） |
| 優先度 | 中 |
| リトライ | 無 |

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

イベントハンドラチェーンにより決定される。ControlCore / ControlInteractivity から TermControl へ、TermControl から TerminalPage へと伝搬する。TermControl の _HyperlinkHandler は co_await winrt::resume_foreground(Dispatcher()) でUIスレッドに切り替えてからイベントを再発火する。

## 通知テンプレート

### イベント引数

| 項目 | 内容 |
|-----|------|
| イベント型 | `OpenHyperlinkEventArgs` |
| 定義元 | `EventArgs.idl` / `EventArgs.h` |
| プロパティ | `Uri` (String) |

### イベントデータ構造

```cpp
runtimeclass OpenHyperlinkEventArgs
{
    OpenHyperlinkEventArgs(String uri);
    String Uri { get; };
}
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| Uri | 開くべきハイパーリンクのURI文字列 | ControlCore._terminal->GetHyperlinkAtBufferPosition() または選択テキスト | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| キーボード操作 | Ctrl+Enter（マーク選択モード） | 選択アンカーが存在すること | ControlCore.cpp L607,613: マーク選択モードでCtrl+Enter押下時 |
| マウス操作 | マウスクリック | ハイパーリンク上でのクリック | ControlInteractivity.cpp L647: マウスクリックによるハイパーリンク検出時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| URIが空文字 | ControlCore ではハイパーリンクが見つからない場合、選択テキストをURIとして使用するため空にはならない |
| サポート外スキーム | TerminalPage._IsUriSupported() で検証し、非サポートの場合はダイアログを表示（イベント自体は発火される） |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ユーザー操作: Ctrl+Enter or クリック] --> B{操作種別}
    B -->|キーボード| C[ControlCore::TryMarkModeKeybinding]
    B -->|マウス| D[ControlInteractivity::_hyperlinkHandler]
    C --> E[GetHyperlinkAtBufferPosition]
    E -->|URI検出| F[OpenHyperlink.raise with URI]
    E -->|URI未検出| G[選択テキスト取得]
    G --> F
    D --> F
    F --> H[TermControl::_HyperlinkHandler]
    H --> I[resume_foreground UIスレッド]
    I --> J[TermControl::OpenHyperlink.raise]
    J --> K[TerminalPage::_OpenHyperlinkHandler]
    K --> L{URI検証}
    L -->|サポート済| M[ShellExecute で開く]
    L -->|非サポート| N[CouldNotOpenUriDialog 表示]
```

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

### 参照テーブル一覧

該当なし（データベースは使用しない）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| URI解析失敗 | 不正なURI文字列 | 例外をキャッチし、CouldNotOpenUriDialog を表示 |
| 非サポートスキーム | http/https以外のスキーム | _IsUriSupported チェックにより CouldNotOpenUriDialog を表示 |
| ShellExecute失敗 | OS側でのURI処理失敗 | 例外をキャッチしログ出力 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（ユーザー操作起点のため常時利用可能）

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

- URIスキームの検証により、サポートされていないスキーム（例: file://）のリンクを開くことを防止している
- ShellExecute を使用するため、OSのセキュリティポリシーに従って処理される
- _HyperlinkHandler ではUIスレッドへのディスパッチ前に co_await を使用し、ロック保持中の呼び出しによるデッドロックを回避している（GH#7994対応）

## 備考

- ControlCore と ControlInteractivity の両方から OpenHyperlink が発火し得る。TermControl はその両方を同一の _HyperlinkHandler で処理する
- OpenHyperlinkEventArgs は BASIC_FACTORY マクロによりファクトリが定義されている（EventArgs.h L272）

---

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

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

### 推奨読解順序

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

まず、OpenHyperlinkEventArgs のデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | EventArgs.idl | `src/cascadia/TerminalControl/EventArgs.idl` | L71-75: OpenHyperlinkEventArgs の WinRT 定義。Uri プロパティのみを持つシンプルな構造 |
| 1-2 | EventArgs.h | `src/cascadia/TerminalControl/EventArgs.h` | L104-114: C++ 実装。コンストラクタで hstring uri を受け取り、private メンバに保持 |

**読解のコツ**: WinRT の runtimeclass 定義（IDL）と C++ 実装（.h/.cpp）の対応関係を把握すること。IDL で定義されたプロパティが C++ でどのように実装されるかを確認する。

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

処理の起点は2箇所ある。キーボード操作（ControlCore）とマウス操作（ControlInteractivity）である。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | ControlCore.cpp | `src/cascadia/TerminalControl/ControlCore.cpp` | L602-614: TryMarkModeKeybinding 内の Ctrl+Enter ハンドリング。GetHyperlinkAtBufferPosition でURI取得を試み、無い場合は選択テキストを使用 |
| 2-2 | ControlInteractivity.cpp | `src/cascadia/TerminalControl/ControlInteractivity.cpp` | L645-648: _hyperlinkHandler コールバック。マウスクリックによるハイパーリンク検出時に直接 OpenHyperlink.raise を呼び出す |

**主要処理フロー**:
1. **L602-607**: ControlCore - Ctrl+Enter 検出、GetHyperlinkAtBufferPosition でURI検索
2. **L607**: URI が見つかった場合 OpenHyperlink.raise(uri)
3. **L611-613**: URI が見つからない場合、選択テキストを取得して OpenHyperlink.raise(selectedText)

#### Step 3: イベント伝搬層を理解する

TermControl が中継層として機能し、UIスレッドへのディスパッチを行う。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | TermControl.cpp | `src/cascadia/TerminalControl/TermControl.cpp` | L316-317: _core.OpenHyperlink と _interactivity.OpenHyperlink の両方を _HyperlinkHandler に接続 |
| 3-2 | TermControl.cpp | `src/cascadia/TerminalControl/TermControl.cpp` | L3273-3286: _HyperlinkHandler コルーチン。resume_foreground でUIスレッドに切り替え後、OpenHyperlink.raise で再発火 |

**主要処理フロー**:
- **L3277**: get_strong() で強参照を保持
- **L3283**: co_await winrt::resume_foreground(Dispatcher()) でUIスレッドへ
- **L3285**: OpenHyperlink.raise(*strongThis, args) で TerminalPage へ伝搬

#### Step 4: 最終処理層を理解する

TerminalPage が最終的にURIを開く処理を行う。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | TerminalPage.cpp | `src/cascadia/TerminalApp/TerminalPage.cpp` | L1960: _RegisterTerminalEvents でハンドラ登録 |
| 4-2 | TerminalPage.cpp | `src/cascadia/TerminalApp/TerminalPage.cpp` | L3055-3070: _OpenHyperlinkHandler。URI 解析、スキーム検証、ShellExecute 実行 |

**主要処理フロー**:
- **L3059**: winrt::Windows::Foundation::Uri でパース
- **L3060**: _IsUriSupported でスキーム検証
- **L3062**: ShellExecute でOS既定アプリで開く
- **L3066**: 非サポートスキームの場合 _ShowCouldNotOpenDialog 表示

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

```
ControlCore::TryMarkModeKeybinding (Ctrl+Enter)
    |
    +-- _terminal->GetHyperlinkAtBufferPosition()
    +-- OpenHyperlink.raise(OpenHyperlinkEventArgs)
            |
            v
ControlInteractivity::_hyperlinkHandler (マウスクリック)
    |
    +-- OpenHyperlink.raise(OpenHyperlinkEventArgs)
            |
            v
TermControl::_HyperlinkHandler
    |
    +-- co_await resume_foreground(Dispatcher())
    +-- OpenHyperlink.raise (UIスレッドで再発火)
            |
            v
TerminalPage::_OpenHyperlinkHandler
    |
    +-- Windows::Foundation::Uri (パース)
    +-- _IsUriSupported (検証)
    +-- ShellExecute (OS処理委譲)
    +-- _ShowCouldNotOpenDialog (エラー時)
```

### データフロー図

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

ユーザー操作             ControlCore/                   ShellExecute
(Ctrl+Enter/クリック)    ControlInteractivity           (OS既定アプリ)
        |                     |                              ^
        v                     v                              |
ハイパーリンク検出 ----> OpenHyperlinkEventArgs ----> TerminalPage
                        (Uri: string)                _OpenHyperlinkHandler
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| EventArgs.idl | `src/cascadia/TerminalControl/EventArgs.idl` | IDL定義 | OpenHyperlinkEventArgs の WinRT 定義 |
| EventArgs.h | `src/cascadia/TerminalControl/EventArgs.h` | ソース | OpenHyperlinkEventArgs の C++ 実装 |
| EventArgs.cpp | `src/cascadia/TerminalControl/EventArgs.cpp` | ソース | ファクトリ実装 |
| ControlCore.idl | `src/cascadia/TerminalControl/ControlCore.idl` | IDL定義 | OpenHyperlink イベントの宣言（L214） |
| ControlCore.cpp | `src/cascadia/TerminalControl/ControlCore.cpp` | ソース | キーボード経由のイベント発火 |
| ControlCore.h | `src/cascadia/TerminalControl/ControlCore.h` | ヘッダ | ControlCore クラス宣言 |
| ControlInteractivity.idl | `src/cascadia/TerminalControl/ControlInteractivity.idl` | IDL定義 | OpenHyperlink イベントの宣言 |
| ControlInteractivity.cpp | `src/cascadia/TerminalControl/ControlInteractivity.cpp` | ソース | マウス経由のイベント発火 |
| TermControl.idl | `src/cascadia/TerminalControl/TermControl.idl` | IDL定義 | OpenHyperlink イベントの宣言（L67） |
| TermControl.cpp | `src/cascadia/TerminalControl/TermControl.cpp` | ソース | イベント中継・UIスレッドディスパッチ |
| TerminalPage.cpp | `src/cascadia/TerminalApp/TerminalPage.cpp` | ソース | 最終処理（URI検証・ShellExecute） |
| TerminalPage.h | `src/cascadia/TerminalApp/TerminalPage.h` | ヘッダ | ハンドラ宣言 |
| AppActionHandlers.cpp | `src/cascadia/TerminalApp/AppActionHandlers.cpp` | ソース | アクション関連処理 |
