# 機能設計書 44-splice

## 概要

本ドキュメントは、Hack Standard Library (HSL) の `Str\splice` 関数の機能設計を記載する。この関数は文字列の指定位置から指定長の部分を別の文字列で置換する機能を提供する。PHPの`substr_replace`に相当する機能である。

### 本機能の処理概要

**業務上の目的・背景**：文字列の部分的な置換・挿入は、テキスト編集、データ変換、フォーマット処理など多くの場面で必要とされる基本操作である。本機能は、オフセットと長さを指定して文字列の一部を効率的に置換することを可能にし、柔軟な文字列操作を実現する。

**機能の利用シーン**：
- テキストエディタでの文字列挿入・削除・置換
- フォーマットされた文字列の部分修正
- テンプレート内の特定位置への値挿入
- 文字列の中央部分の削除や置換
- バイナリデータの部分修正

**主要な処理内容**：
1. 対象文字列、置換文字列、オフセット、長さを受け取る
2. オフセットを正規化（負の値は末尾からの位置として解釈）
3. 指定位置から指定長の部分を置換文字列で置き換え
4. 結果文字列を返す

**関連システム・外部連携**：HSL内部の `_Private\_Str\splice_l` 関数に処理を委譲。

**権限による制御**：本機能は純粋関数であり、権限による制御は行わない。

## 関連画面

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

## 機能種別

文字列変換処理（Transform）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| $string | string | Yes | 操作対象の文字列 | なし |
| $replacement | string | Yes | 挿入/置換する文字列 | なし |
| $offset | int | Yes | 置換開始位置（負の値は末尾からの位置） | 範囲外の場合は例外 |
| $length | ?int | No | 置換する長さ（nullの場合は末尾まで） | 負の値は不可 |

### 入力データソース

関数呼び出し時の引数として直接渡される。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| (戻り値) | string | 置換処理が適用された結果文字列 |

### 出力先

関数の戻り値として返却される。

## 処理フロー

### 処理シーケンス

```
1. 引数の受け取り
   └─ $string, $replacement, $offset, $lengthを受け取る
2. オフセットの検証
   └─ 範囲外の場合はInvalidArgumentExceptionをスロー
3. 内部関数への委譲
   └─ _Str\splice_lを呼び出し
4. 結果の返却
   └─ 置換後の文字列を返す
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[引数を受け取る]
    B --> C{オフセットが範囲内?}
    C -->|No| D[InvalidArgumentExceptionをスロー]
    C -->|Yes| E[_Str\splice_l呼び出し]
    E --> F[置換後の文字列を返却]
    F --> G[終了]
    D --> H[異常終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-44-01 | 正オフセット | 正の値は文字列の先頭からの位置 | $offset >= 0 |
| BR-44-02 | 負オフセット | 負の値は文字列の末尾からの位置 | $offset < 0 |
| BR-44-03 | 長さ省略 | $lengthがnullの場合、$offsetから末尾までを置換 | $length === null |
| BR-44-04 | 長さゼロ | $length === 0の場合、$offsetの位置に挿入 | $length === 0 |
| BR-44-05 | 範囲外エラー | $offsetが文字列長を超える場合は例外 | $offset > strlen |

### 計算ロジック

- 結果文字列 = string[0..$offset-1] + $replacement + string[$offset+$length..]
- 負のオフセットは `strlen($string) + $offset` として解釈

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

本機能はデータベース操作を行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | InvalidArgumentException | $offsetが文字列長を超える場合 | 有効な範囲のオフセットを指定 |
| - | InvalidArgumentException | 負の$offsetの絶対値が文字列長を超える場合 | 有効な範囲のオフセットを指定 |

### リトライ仕様

該当なし（同期的な純粋関数）

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

該当なし（データベース操作なし）

## パフォーマンス要件

- 時間計算量: O(n)、n = 結果文字列長
- 空間計算量: O(n)、結果文字列のサイズ

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

- 入力文字列のサニタイズは呼び出し側の責任
- 本関数自体は副作用を持たない純粋関数

## 備考

- PHPの`substr_replace`に相当
- 文字単位（マルチバイト対応）で操作する場合は `Str\splice_l` を使用すること

---

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

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

### 推奨読解順序

#### Step 1: 公開API関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | transform.php | `src/str/transform.php` | 公開関数spliceの定義とドキュメンテーション |

**主要処理フロー**:
1. **337-344行目**: splice関数の定義
2. **343行目**: _Str\splice_lへの委譲

**読解のコツ**: $lengthパラメータはnull許容型（?int）であり、nullの場合は内部でデフォルト動作（末尾まで置換）となる。

#### Step 2: ドキュメンテーションコメントを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | transform.php | `src/str/transform.php` | 315-336行目の詳細なドキュメンテーション |

**主要処理フロー**:
- **327-331行目**: 具体的な使用例（splice("apple", "orange", 0)など）
- **333行目**: PHPのsubstr_replaceとの関連の記載

#### Step 3: テストケースで挙動を確認する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | StrTransformTest.php | `tests/str/StrTransformTest.php` | spliceのテストケースを確認 |

**主要処理フロー**:
- **714-778行目**: provideSpliceで様々な入力パターンと期待結果を確認
- **780-785行目**: 例外発生ケースのテスト

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

```
Str\splice($string, $replacement, $offset, $length)
    │
    └─ _Str\splice_l($string, $replacement, $offset, $length)
           │
           └─ [HHVM内部実装]
```

### データフロー図

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

$string (string) ────────┐
$replacement (string) ───┤
$offset (int) ───────────┼──▶ _Str\splice_l ──▶ 結果文字列
$length (?int) ──────────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| transform.php | `src/str/transform.php` | ソース | 公開API関数の定義 |
| transform_l.php | `src/str/transform_l.php` | ソース | ロケール対応版の定義 |
| StrTransformTest.php | `tests/str/StrTransformTest.php` | テスト | 単体テスト |
