# 機能設計書 17-compare

## 概要

本ドキュメントは、Hack Standard Library（HSL）のStr名前空間における`compare`関数の機能設計を記述する。この関数は、2つの文字列の大小比較を行い、比較結果を整数で返す。

### 本機能の処理概要

`compare`関数は、2つの文字列を辞書順で比較し、その結果を整数で返す。大文字と小文字を区別した比較を行い、ロケールに基づいた照合（collation）を使用する。

**業務上の目的・背景**：文字列のソートや順序付け、条件分岐での文字列比較など、あらゆるテキスト処理において文字列の大小比較は基本的な操作である。PHPの`strcmp`に相当するが、型安全かつロケール対応の比較を提供する。

**機能の利用シーン**：文字列配列のソート処理、辞書順での順序判定、文字列の等価性チェック、二分探索での比較関数、ソートアルゴリズムのコンパレータとしての使用など、文字列の順序関係を判定する場面で使用される。

**主要な処理内容**：
1. 2つの文字列を受け取る
2. ロケールに基づいた照合関数（strcoll_l）を呼び出す
3. 比較結果を整数で返す（負/0/正）

**関連システム・外部連携**：内部で`_Str\strcoll_l`を使用し、ロケールに基づいた文字列比較を行う。

**権限による制御**：特段の権限制御はない。純粋関数として動作する。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 1 | 画面なし | - | 本プロジェクトはUIを持たないライブラリのため画面機能マッピングは該当しない |

## 機能種別

文字列比較 / 純粋関数

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| string1 | string | Yes | 比較する最初の文字列 | - |
| string2 | string | Yes | 比較する2番目の文字列 | - |

### 入力データソース

関数の引数として渡される文字列

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | int | 比較結果: string1 < string2 の場合は負の値、string1 > string2 の場合は正の値、等しい場合は0 |

### 出力先

呼び出し元に整数を返す

## 処理フロー

### 処理シーケンス

```
1. 引数の2つの文字列を受け取る
2. _Str\strcoll_l関数を呼び出す
   └─ ロケールに基づいた照合比較を実行
3. 比較結果の整数を返す
```

### フローチャート

```mermaid
flowchart TD
    A[compare呼び出し] --> B[strcoll_l実行]
    B --> C{比較結果}
    C -->|string1 < string2| D[負の値を返却]
    C -->|string1 = string2| E[0を返却]
    C -->|string1 > string2| F[正の値を返却]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | 大文字小文字区別 | 大文字と小文字を区別して比較する | 常時適用 |
| BR-02 | ロケール照合 | ロケールに基づいた照合順序を使用 | 常時適用 |
| BR-03 | 純粋関数 | 副作用なし、同じ入力には同じ出力 | 常時適用 |

### 計算ロジック

```
戻り値 = strcoll_l(string1, string2)
```

- 戻り値 < 0: string1がstring2より小さい
- 戻り値 = 0: string1とstring2が等しい
- 戻り値 > 0: string1がstring2より大きい

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

該当なし（本機能は純粋な文字列操作でデータベースを使用しない）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| なし | - | この関数は例外をスローしない | - |

### リトライ仕様

該当なし

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

該当なし

## パフォーマンス要件

- 計算量: O(min(len(string1), len(string2)))
- メモリ: 追加のメモリ割り当てなし

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

- タイミング攻撃に対して脆弱な可能性がある（パスワード比較には使用しないこと）
- パスワードやトークンの比較には定数時間比較関数を使用すること

## 備考

- 大文字小文字を無視した比較には`Str\compare_ci()`を使用
- 関連ガイド: /hack/built-in-types/string

---

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

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

### 推奨読解順序

#### Step 1: 関数定義を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | introspect.php | `src/str/introspect.php` | compare関数の定義と実装 |

**読解のコツ**: Hackの関数属性`()[]: int`は、この関数が純粋関数（副作用なし、コンテキスト非依存）であることを示している。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | introspect.php | `src/str/introspect.php` | compare関数の実装詳細 |

**主要処理フロー**:
1. **15-22行目**: docコメント。戻り値の意味と関連関数への参照
2. **23-27行目**: compare関数本体
3. **23-26行目**: 関数シグネチャ。2つのstring引数を受け取り、intを返す
4. **27行目**: _Str\strcoll_l関数の呼び出し

#### Step 3: 内部実装を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | _Str名前空間 | 内部実装 | strcoll_l関数の内部動作（ネイティブ実装） |

**主要処理フロー**:
- **strcoll_l**: ロケールに基づいた文字列照合を実行するネイティブ関数

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

```
Str\compare(string1, string2)
    │
    └─ _Str\strcoll_l(string1, string2)
           │
           └─ ロケールベースの照合比較
                  │
                  └─ 整数結果を返却
```

### データフロー図

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

string1 ─────────────┐
                     ├──▶ Str\compare() ──────────────▶ int
string2 ─────────────┘         │
                               ▼
                         strcoll_l()
                               │
                         ┌─────┼─────┐
                         ▼     ▼     ▼
                        < 0    0    > 0
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| introspect.php | `src/str/introspect.php` | ソース | compare関数およびその他の文字列検査関数 |
| introspect_l.php | `src/str/introspect_l.php` | ソース | ロケール対応版の文字列検査関数 |
