# Alimoduulit

Git alimoduulia upottaa yhden arkiston toisen sisään. Puu edustaa alimoduulia emoarkistossa gitlink-merkintänä (tila `160000`), joka osoittaa tiettyyn commit-merkintään alimoduuliarkistossa. Alimoduulin URL ja polku määritellään tiedostossa `.gitmodules`.

## Käsitteet

Emoarkiston puussa:

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

Gitlink-merkintä tallentaa tiedon siitä, mikä alimoduulin commit tulisi ottaa käyttöön. Varsinainen alimoduuliarkisto sijaitsee kohteessa `.git/modules/<name>/`.

## SubmoduleManager

```php
use Pitmaster\Submodule\SubmoduleManager;

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

### Alimoduulien luettelo

```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";
    }
}
```

### Alimoduulin arvokohde

```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)
```

## .gitmodules-tiedoston jäsentäminen

`.gitmodules`-tiedosto määrittää alimoduulin asetukset:

```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";
}
```

Jäsennin käsittelee seuraavat:
- Osio-otsakkeet: `[submodule "<name>"]`
- Avain-arvo-parit: `path = ...`, `url = ...`, `branch = ...`
- Kommentit (rivit, jotka alkavat merkillä `#`)
- Tyhjemerkit ja sisennykset

Merkinnät, joista puuttuu joko `path` tai `url`, ohitetaan. Arvojen lainausmerkkejä ei poisteta.

## Gitlink-merkinnät

Gitlink-merkinnät ovat tilan `160000` puumerkintöjä. Ne osoittavat commit-merkintään (eivät puuhun tai blobiin) alimoduuliarkistossa.

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

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

### TreeEntry-tunnistus

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

## Alimoduulien alustaminen

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

Jokaiselle kohteessa `.gitmodules` määritetylle alimoduulille:
1. Luodaan tyhjä `.git/modules/<name>/`-hakemisto
2. Luodaan alimoduulin polun hakemisto, jos sitä ei ole
3. Tallennetaan `submodule.<name>.active = true` ja `submodule.<name>.url` kohteeseen `.git/config`

Se ei hae eikä ota mitään käyttöön, eikä kirjoita alimoduulin `.git`-tiedostoa.

## Alimoduulien päivittäminen

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

Jokaiselle annetussa puussa kiinnitetylle alimoduulille `update()` kopioi lähdearkiston git-hakemiston kohteeseen `.git/modules/<name>/`, korvaa alimoduulin työhakemiston tiedostot lähteen tiedostoilla, kirjoittaa `.git`-tiedoston osoittamaan moduulihakemistoon, asettaa arvon `core.worktree` ja irrottaa HEADin kiinnitettyyn commitiin.

Alimoduulin URL on oltava paikallinen polku: absoluuttinen tai suhteessa emoarkiston työhakemistoon (git ratkaisee suhteelliset URL-osoitteet emon etäosoitteen URL perusteella). URL, jossa on skeema (`https://...`), aiheuttaa `RuntimeException('Submodule update currently supports only local paths: ...')`-poikkeuksen.

Päivityksen jälkeen voit avata jokaisen alimoduulin erillisenä arkistona:

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

## Kiinnitettyjen commitien tarkistaminen

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

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

`pinnedCommit()`-metodi käy puuhierarkian läpi, etsii gitlink-merkinnän annetusta polusta ja palauttaa sen kohdecommitin tiivisteen.

## Alimoduulin tila

```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";
}
```

Tilan kentät:
- `name`: alimoduulin nimi
- `path`: polku työhakemistossa
- `expected`: emoarkiston puuhun kiinnitetty commit-tiiviste (null, jos sitä ei ole)
- `actual`: alimoduulin nykyinen HEAD (null, jos sitä ei ole alustettu)
- `dirty`: true, kun molemmat commitit tunnetaan ja ne eroavat toisistaan. Alimoduulin työhakemiston muutoksia ei tarkisteta.

## Hakemistorakenne

```
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
```

## Alimoduulien työnkulku

```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";
```