# Submoduly

Git Submoduly vkládají jeden repozitář do jiného. Submodul je v nadřazeném stromu reprezentován položkou gitlink (režim `160000`), která odkazuje na konkrétní commit v repozitáři submodulu. URL submodulu a jeho cesta jsou deklarovány v souboru `.gitmodules`.

## Základní pojmy

Ve stromu nadřazeného repozitáře:

```
100644 blob abc123...  README.md
040000 tree def456...  src/
160000 commit 789012... lib/external    <-- gitlink entry (submodule)
```

Položka gitlink zaznamenává, který commit submodulu se má zkontrolovat. Skutečný repozitář submodulu se nachází v `.git/modules/<name>/`.

## SubmoduleManager

```php
use Pitmaster\Submodule\SubmoduleManager;

$manager = new SubmoduleManager(
    $repo->objectDatabase(),
    $repo->workDir(),
    $repo->gitDir(),
);
```

### Výpis submodulů

```php
$submodules = $manager->list();

foreach ($submodules as $sub) {
    echo "{$sub->name}: {$sub->url} at {$sub->path}\n";
    if ($sub->branch !== null) {
        echo "  tracks branch: {$sub->branch}\n";
    }
}
```

### Objekt hodnoty submodulu

```php
use Pitmaster\Submodule\Submodule;

$sub->name;     // Submodule name (from .gitmodules section header)
$sub->path;     // Path in the working tree
$sub->url;      // Remote URL
$sub->branch;   // Tracked branch (nullable)
```

## Parsování .gitmodules

Soubor `.gitmodules` deklaruje konfiguraci submodulů:

```ini
[submodule "lib/external"]
    path = lib/external
    url = https://github.com/vendor/lib.git
    branch = main

[submodule "tools/helper"]
    path = tools/helper
    url = https://github.com/vendor/helper.git
```

```php
$content = file_get_contents('.gitmodules');
$submodules = SubmoduleManager::parseGitmodules($content);

foreach ($submodules as $sub) {
    echo "{$sub->name} -> {$sub->url}\n";
}
```

Parser zpracovává:
- Hlavičky oddílů: `[submodule "<name>"]`
- Dvojice klíč–hodnota: `path = ...`, `url = ...`, `branch = ...`
- Komentáře (řádky začínající na `#`)
- Bílé znaky a odsazení

Položky bez `path` i `url` se přeskočí. Hodnoty se neodstraňují z uvozovek.

## Položky gitlink

Položky gitlink jsou položky stromu s režimem `160000`. Odkazují na commit (nikoli strom nebo blob) v repozitáři submodulu.

```php
$tree = $repo->readObject($treeHash);

foreach ($tree->entries as $entry) {
    if ($entry->isGitlink()) {
        echo "Submodule at {$entry->name}: commit {$entry->hash->hex}\n";
    }
}
```

### Rozpoznání TreeEntry

```php
$entry->isGitlink();  // true if mode is '160000'
$entry->mode;         // '160000'
```

## Inicializace submodulů

```php
$manager->init();
```

Pro každý submodul deklarovaný v `.gitmodules` se provede toto:
1. Vytvoří se prázdný adresář `.git/modules/<name>/`
2. Vytvoří se adresář cesty submodulu, pokud ještě neexistuje
3. Do `.git/config` se zaznamenají hodnoty `submodule.<name>.active = true` a `submodule.<name>.url`

Nic se nestahuje ani nekontroluje a nezapisuje se soubor `.git` submodulu.

## Aktualizace submodulů

```php
$manager->update($repo->head()->tree);
```

Pro každý submodul připnutý v zadaném stromu `update()` zkopíruje adresář git zdrojového repozitáře do `.git/modules/<name>/`, nahradí pracovní soubory submodulu soubory ze zdroje, zapíše soubor `.git` odkazující na adresář modulu, nastaví `core.worktree` a odpojí HEAD na připnutém commitu.

Submodul URL musí být místní cesta: absolutní nebo relativní vůči pracovnímu stromu nadřazeného repozitáře (git místo toho řeší relativní URL vůči vzdálenému URL nadřazeného repozitáře). URL se schématem (`https://...`) vyvolá `RuntimeException('Submodule update currently supports only local paths: ...')`.

Po aktualizaci můžete každý submodul otevřít jako samostatný repozitář:

```php
$subRepo = Pitmaster::open($repo->workDir() . '/lib/external');
```

## Kontrola připnutých commitů

```php
$headCommit = $repo->head();
$pinnedId = $manager->pinnedCommit('lib/external', $headCommit->tree);

if ($pinnedId !== null) {
    echo "lib/external is pinned to commit {$pinnedId->hex}\n";
}
```

Metoda `pinnedCommit()` prochází hierarchii stromu, aby našla položku gitlink na zadané cestě, a vrací hash cílového commitu.

## Stav submodulu

```php
$headCommit = $repo->head();
$statuses = $manager->status($headCommit->tree);

foreach ($statuses as $status) {
    $expected = $status['expected'] ?? 'not pinned';
    $actual = $status['actual'] ?? 'not initialized';
    $dirty = $status['dirty'] ? ' (dirty)' : '';

    echo "{$status['name']}: expected={$expected}, actual={$actual}{$dirty}\n";
}
```

Pole stavu:
- `name`: název submodulu
- `path`: cesta v pracovním stromu
- `expected`: hash commitu připnutého v nadřazeném stromu (null, pokud není přítomen)
- `actual`: aktuální HEAD submodulu (null, pokud není inicializován)
- `dirty`: true, když jsou oba commity známé a liší se. Změny uvnitř pracovního stromu submodulu se nekontrolují.

## Struktura adresářů

```
project/
  .git/
    modules/
      lib/
        external/          # Submodule's actual git directory (.git/modules/<name>)
        HEAD
        objects/
        refs/
        ...
  .gitmodules              # Submodule declarations
  lib/
    external/
      .git                 # File: "gitdir: ../../.git/modules/lib/external"
      src/
      README.md
  src/
  README.md
```

## Práce se submoduly

```php
// 1. Open the parent repo
$repo = Pitmaster::open('/path/to/project');

// 2. List submodules
$manager = new SubmoduleManager(
    $repo->objectDatabase(),
    $repo->workDir(),
    $repo->gitDir(),
);

$submodules = $manager->list();

// 3. Populate the submodules pinned at HEAD (local source paths only)
$manager->update($repo->head()->tree);

// 4. Check status
$statuses = $manager->status($repo->head()->tree);

// 5. Open a submodule as its own repo
$subRepo = Pitmaster::open($repo->workDir() . '/lib/external');
$subHead = $subRepo->head();
echo "Submodule HEAD: {$subHead->id->hex}\n";
```