# バッチ設計書 5-CMakeLists.txt（docs/code）

## 概要

本ドキュメントは、libuvプロジェクトのドキュメント内サンプルコード用CMakeビルド設定ファイル `docs/code/CMakeLists.txt` の設計仕様を定義する。

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

`docs/code/CMakeLists.txt` は、libuvドキュメントに掲載されているサンプルプログラムの自動ビルド設定を提供するCMakeファイルである。libuv本体を静的ライブラリ（uv_a）としてビルドし、各サンプルプログラムをそれにリンクして実行可能バイナリを生成する。

**業務上の目的・背景**：libuvのドキュメントには、ライブラリの使い方を示すサンプルプログラムが多数含まれている（helloworld、dns、spawn等）。これらのサンプルが常にコンパイル可能であることを保証するために、CIワークフロー（No.10: CI-sample.yml）でサンプルコードのビルドを自動検証する必要がある。本CMakeファイルはそのビルド設定を提供する。

**バッチの実行タイミング**：CI-sample.yml（No.10）ワークフロー実行時にcmakeコマンドで処理される。開発者がサンプルコードをローカルでビルド・実行する際にも使用される。

**主要な処理内容**：
1. CMake最低バージョン（3.5）の指定
2. libuv_sampleプロジェクトの定義
3. 親ディレクトリ（../../）のlibuv本体をサブディレクトリとして追加
4. 全プラットフォーム共通サンプル18種の定義（cgi、helloworld、dns、detach、default-loop、idle-basic、idle-compute、interfaces、locks、onchange、pipe-echo-server、ref-timer、spawn、tcp-echo-server、thread-create、udp-dhcp、uvcat、uvstop、uvtee）
5. Unix限定サンプル6種の追加（signal、progress、queue-cancel、queue-work、tty、tty-gravity）
6. foreachによる各サンプルの実行可能バイナリ生成とuv_aへのリンク
7. CURL検出時のuvwgetサンプル追加ビルド

**前後の処理との関連**：ルートのCMakeLists.txt（No.4）をadd_subdirectory経由で参照し、uv_aターゲットを利用する。CI-sample.yml（No.10）ワークフローから呼び出される。

**影響範囲**：docs/code/ 配下のサンプルプログラムのビルド成否に影響する。ドキュメントの品質保証に寄与する。

## バッチ種別

ビルドシステム設定（サンプルコード）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（CIワークフローまたは手動実行） |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | CI-sample.yml によるPR/push時の自動実行 / 手動cmake実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| CMake 3.5以上 | cmake_minimum_required(VERSION 3.5) で指定 |
| Cコンパイラ利用可能 | Cコンパイラがインストールされていること |
| libuv ソースコード配置 | 親ディレクトリ（../../）にlibuvのルートCMakeLists.txtが存在すること |
| サンプルソース配置 | 各サンプルディレクトリ（helloworld/main.c 等）が存在すること |
| CURL（オプション） | uvwgetサンプルのビルドにはlibcurlが必要 |

### 実行可否判定

親ディレクトリにCMakeLists.txtが存在しない場合、add_subdirectoryが失敗する。各サンプルのmain.cが存在しない場合、add_executableが失敗する。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| （なし） | - | - | - | 固有のオプション定義はなし |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| docs/code/{sample}/main.c | Cソースファイル | 各サンプルプログラムのソースコード |
| ../../CMakeLists.txt | CMake設定 | libuv本体のCMake設定（uv_aターゲットを提供） |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| build/{sample} | 実行ファイル | 各サンプルプログラムの実行可能バイナリ（helloworld、dns、spawn等） |
| build/uvwget | 実行ファイル | CURL検出時のみ生成されるwgetサンプル |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | サンプル名と同名の実行ファイル |
| 出力先 | build/ ディレクトリ |
| 文字コード | バイナリ |
| 区切り文字 | 該当なし |

## 処理フロー

### 処理シーケンス

```
1. プロジェクト定義
   └─ project(libuv_sample)
2. libuv本体のサブディレクトリ追加
   └─ add_subdirectory("../../" build) でルートCMakeLists.txtを処理
3. 共通サンプル定義（18種）
   └─ SIMPLE_SAMPLES リストに cgi、helloworld、dns 等を追加
4. Unix限定サンプル追加（6種）
   └─ NOT WIN32 条件で signal、progress、queue-cancel 等を追加
5. 各サンプルのビルド
   └─ foreach で add_executable(${X} ${X}/main.c) + target_link_libraries(${X} uv_a)
6. CURL検出
   └─ FIND_PACKAGE(CURL) でlibcurlの有無を確認
7. uvwgetサンプルビルド（条件付き）
   └─ CURL検出時のみ add_executable(uvwget ...) + target_link_libraries(uvwget uv_a ${CURL_LIBRARIES})
```

### フローチャート

```mermaid
flowchart TD
    A[CMake処理開始] --> B[project定義]
    B --> C[libuv本体をサブディレクトリとして追加]
    C --> D[共通サンプル18種を定義]
    D --> E{WIN32?}
    E -->|No| F[Unix限定サンプル6種を追加]
    E -->|Yes| G[foreachでサンプルビルド]
    F --> G
    G --> H{CURL検出?}
    H -->|Yes| I[uvwgetサンプルビルド]
    H -->|No| J[処理完了]
    I --> J
```

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

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

該当なし（本ファイルはCMake設定ファイルであり、データベースは使用しない）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | サブディレクトリ不在 | ../../CMakeLists.txtが存在しない場合 | docs/code/からの相対パスでlibuvルートが参照できるようにする |
| - | ソースファイル不在 | サンプルのmain.cが存在しない場合 | 不足するサンプルソースを配置する |
| - | コンパイルエラー | サンプルコードがlibuvのAPI変更に追従していない場合 | サンプルコードを最新APIに合わせて修正する |

### リトライ仕様

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

### 障害時対応

ビルドエラーはコンパイラ出力で確認する。サンプルコードの修正が必要な場合は、対応するmain.cを修正する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 全プラットフォーム共通18種 + Unix限定6種 + uvwget（オプション）= 最大25個のサンプルをビルド |
| 目標処理時間 | 数十秒（libuv本体のビルドを含む） |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

CMakeの並列ビルドをサポート。同一ビルドディレクトリでの複数cmake実行は競合する可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| コンパイルログ | cmake --build実行時 | 各サンプルのコンパイル結果 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| cmake --build終了コード | 0以外 | CI-sample.ymlワークフロー |

## 備考

- 全サンプルは静的ライブラリ（uv_a）にリンクされるため、実行時にlibuv共有ライブラリのインストールは不要
- Unix限定サンプル（signal、tty等）はWIN32環境ではビルド対象から除外される
- uvwgetサンプルはlibcurlに依存するため、CURL未検出時はスキップされる
- CMAKE_EXPORT_COMPILE_COMMANDS=ON が設定されており、compile_commands.json が生成される
