<?php
namespace Std\Lib\Syntax;

interface SyntaxInterface {
  /**
   * コードを解析する前に呼ばれる（単語表の作成等）
   *
   * @param string $code  ハイライトするコード全体
   * @return void
   */
  public function prepare(string $code): void;

  /**
   * トークンの規則を優先順に返す
   * 各規則：['re' => 正規表現（区切り文字なし）, 'class' => 種類, 'bol' => 行頭のみか]
   * 種類が「ident」の場合、classify()で分類する
   *
   * @return array  規則の配列
   */
  public function getRules(): array;

  /**
   * 識別子を分類する
   *
   * @param string $word  識別子
   * @param array $ctx  文脈（bol, first, prev, prevWord, lineWord, next, nextRaw, nextWord）
   * @return string|null  種類、色を付けない場合はnull
   */
  public function classify(string $word, array $ctx): ?string;

  /**
   * 入れ子可能な複数行コメントの[開始, 終了]（Swift等）
   *
   * @return array|null
   */
  public function getNestedComment(): ?array;

  /**
   * 次の「<…>」をファイル名として扱うプリプロセッサ指令（include等）
   *
   * @return array
   */
  public function getHeaderDirectives(): array;
}