# API

shikiphp nabízí dva vstupní body: statickou fasádu `Shikiphp` pro běžné případy a instanci `Highlighter` pro vše ostatní (výstup HAST, vlastní gramatiky a motivy, varianty motivů a prohlížení obsahu balíčku).

## Fasáda `Shikiphp`

`Shikiphp\Shikiphp` je jednoduchá statická fasáda nad sdruženým zvýrazňovačem, který se vytvoří až při prvním použití a poté se ukládá do cache.

### `Shikiphp::codeToHtml`

```php
public static function codeToHtml(string $code, array $options): string
```

Tokenizuje `$code` a vykreslí celý blok `<pre class="shiki …">` HTML. Pole options vždy obsahuje `lang` a také buď `theme`, nebo mapu `themes` spolu s libovolnými možnostmi vykreslování [options](https://shikiphp.inline0.dev/cs/docs/options).

```php
use Shikiphp\Shikiphp;

echo Shikiphp::codeToHtml($code, ['lang' => 'php', 'theme' => 'github-dark']);
```

### `Shikiphp::codeToTokens`

```php
/** @return list<list<ThemedToken>> */
public static function codeToTokens(string $code, array $options): array
```

Vrací samotnou dvourozměrnou mřížku tokenů (vnitřní seznam pro každý řádek) objektů `Shikiphp\Render\ThemedToken` namísto HTML.

```php
use Shikiphp\Shikiphp;

$lines = Shikiphp::codeToTokens($code, ['lang' => 'js', 'theme' => 'nord']);

foreach ($lines as $line) {
    foreach ($line as $token) {
        // $token->content, $token->color, $token->fontStyle,
        // $token->bgColor, $token->htmlStyle, $token->offset
    }
}
```

### `Shikiphp::codeToTokensBase`

```php
/** @return list<list<ThemedToken>> */
public static function codeToTokensBase(string $code, array $options): array
```

Alias pro `codeToTokens`, který odpovídá názvu `codeToTokensBase` Shiki.

### `Shikiphp::codeToTokensResult`

```php
public static function codeToTokensResult(string $code, array $options): TokensResult
```

Vrací bohatý výsledek odpovídající nejvyšší úrovni `codeToTokens` v Shiki: mřížku tokenů spolu s vyřešenými barvami, názvem motivu, kořenovým stylem pro dva motivy a výsledným stavem gramatiky. Viz [`TokensResult`](#tokensresult) níže.

```php
use Shikiphp\Shikiphp;

$result = Shikiphp::codeToTokensResult($code, [
    'lang'  => 'php',
    'theme' => 'github-dark',
]);

$result->tokens;       // list<list<ThemedToken>>
$result->fg;           // "#e1e4e8"
$result->bg;           // "#24292e"
$result->themeName;    // "github-dark"
$result->grammarState; // GrammarState
```

### `Shikiphp::getLastGrammarState`

```php
public static function getLastGrammarState(string $code, array $options): GrammarState
```

Tokenizuje `$code` a vrací stav gramatiky na konci (`getLastGrammarState` v Shiki). Předejte jej zpět pomocí volby [`grammarState`](https://shikiphp.inline0.dev/cs/docs/options) a pokračujte v tokenizaci další části od stejného stavu — hodí se pro průběžné zvýrazňování. Pokud je `lang` rovno `'ansi'`, vyvolá chybu (ANSI nemá stav gramatiky).

```php
use Shikiphp\Shikiphp;

$state = Shikiphp::getLastGrammarState("/* unterminated comment", [
    'lang'  => 'js',
    'theme' => 'nord',
]);

$html = Shikiphp::codeToHtml("still inside the comment */", [
    'lang'         => 'js',
    'theme'        => 'nord',
    'grammarState' => $state,
]);
```

### `Shikiphp::highlighter`

```php
public static function highlighter(): Highlighter
```

Vrací sdílený sdružený objekt `Highlighter` a při prvním použití jej vytvoří. Použijte jej k přístupu k metodám instance níže.

### `Shikiphp::use` a `Shikiphp::reset`

```php
public static function use(Highlighter $highlighter): void
public static function reset(): void
```

`use` vymění instanci za vlastní `Highlighter` (například instanci, do níž jste načetli vlastní gramatiky nebo motivy), na kterou pak fasáda deleguje. `reset` vymaže instanci z cache, takže se při dalším volání znovu vytvoří výchozí sdružený zvýrazňovač.

## `Highlighter`

`Shikiphp\Highlighter` poskytuje úplné rozhraní. Získejte sdílenou sdruženou instanci pomocí `Shikiphp::highlighter()` nebo ji vytvořte explicitně:

```php
use Shikiphp\Highlighter;

$highlighter = Highlighter::createBundled();
```

Implementuje `codeToHtml`, `codeToTokens`, `codeToTokensBase`, `codeToTokensResult` a `getLastGrammarState` se stejnými signaturami jako fasáda a navíc následující metody.

### `Highlighter::codeToHast`

```php
public function codeToHast(string $code, array $options): \Shikiphp\Hast\Element
```

Vytvoří stejný strom HAST Shiki jako `pre.shiki > code > (span.line > span)*`, připravený k procházení, úpravám nebo vlastní serializaci. Právě tento strom `codeToHtml` interně serializuje.

```php
use Shikiphp\Shikiphp;

$hast = Shikiphp::highlighter()->codeToHast($code, [
    'lang'  => 'rust',
    'theme' => 'nord',
]);
```

### `Highlighter::codeToTokensWithThemes`

```php
/** @return list<list<ThemedTokenWithVariants>> */
public function codeToTokensWithThemes(string $code, array $options): array
```

Tokenizuje jednou pro každý motiv a sloučí výsledky do mapy `variants` pro jednotlivé tokeny, klíčované podle klíče motivu, stejně jako Shiki v `codeToTokensWithThemes`. Vyžaduje mapu `themes`.

```php
use Shikiphp\Shikiphp;

$lines = Shikiphp::highlighter()->codeToTokensWithThemes($code, [
    'lang'   => 'ts',
    'themes' => ['light' => 'github-light', 'dark' => 'github-dark'],
]);

$lines[0][0]->content;            // token text
$lines[0][0]->variants['light'];  // ThemedTokenStyle for the light theme
$lines[0][0]->variants['dark'];   // ThemedTokenStyle for the dark theme
```

### `Highlighter::loadGrammar` a `Highlighter::loadTheme`

```php
public function loadGrammar(
    array $rawTmLanguage,
    ?string $langId = null,
    array $aliases = [],
    array $embedded = [],
): void

public function loadTheme(array $rawTheme): void
```

Zaregistrujte vlastní gramatiku TextMate nebo motiv VS Code z dekódovaného JSON. Viz [Vlastní jazyky a motivy](https://shikiphp.inline0.dev/cs/docs/custom-languages-themes).

### Přehled obsahu balíčku

```php
/** @return list<string> */ public function loadedLanguages(): array
/** @return list<string> */ public function loadedThemes(): array
/** @return list<string> */ public function bundledLanguages(): array
/** @return list<string> */ public function bundledThemes(): array
```

`loadedLanguages`/`loadedThemes` vypisují všechny momentálně použitelné identifikátory (sdružené i vlastní, které jste zaregistrovali). `bundledLanguages`/`bundledThemes` vypisují jen identifikátory obsažené v balíčku. Viz [Jazyky](https://shikiphp.inline0.dev/cs/docs/languages) a [Motivy](https://shikiphp.inline0.dev/cs/docs/themes).

## Objekty hodnot

### `ThemedToken`

`Shikiphp\Render\ThemedToken` představuje jeden stylovaný úsek textu:

```php
final class ThemedToken
{
    public readonly string $content;
    public readonly ?string $color;
    public readonly int $fontStyle;      // FontStyle bitmask
    public readonly ?string $bgColor;
    public readonly ?string $htmlStyle;  // pre-built inline style (dual themes / ANSI)
    public readonly int $offset;         // UTF-16 code-unit offset into the source
}
```

`fontStyle` je bitová maska z `Shikiphp\Theme\FontStyle` (`NONE`, `ITALIC`, `BOLD`, `UNDERLINE`, `STRIKETHROUGH`).

### `TokensResult`

`Shikiphp\TokensResult` je návratovou hodnotou `codeToTokensResult`:

```php
final class TokensResult
{
    public readonly array $tokens;             // list<list<ThemedToken>>
    public readonly ?string $fg;               // resolved foreground
    public readonly ?string $bg;               // resolved background
    public readonly ?string $themeName;        // single id, or "shiki-themes …"
    public readonly string|false|null $rootStyle; // dual-theme root style (or null)
    public readonly ?GrammarState $grammarState;
}
```

### `GrammarState`

`Shikiphp\GrammarState` uchovává zásobník pravidel tokenizeru (klíčovaný podle názvu motivu), aby bylo možné pokračovat ve zvýrazňování od mezilehlého bodu.

```php
final class GrammarState
{
    public readonly string $lang;

    public function theme(): string;          // first theme name
    public function themes(): array;          // list<string>
    public function getScopes(?string $theme = null): array; // scopes in effect, innermost first
    public function withTheme(string $theme): self;
}
```