railt/lexer

<?php
/**
 * This file is part of Railt package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
declare(strict_types=1);

namespace Railt\Component\Lexer;

/**
 * The lexical token that returns from stream.
 */
interface TokenInterface
{
    /**
     * Token name.
     *
     * @return string
     */
    public function getName(): string;

    /**
     * Token position in bytes.
     *
     * @return int
     */
    public function getOffset(): int;

    /**
     * Returns the value of the captured subgroup.
     *
     * @param int $group Number of subgroup
     * @return string|null If the group is not found, the null will return.
     */
    public function getValue(int $group = 0): ?string;

    /**
     * Returns the list of the captured subgroups.
     *
     * @return iterable
     */
    public function getGroups(): iterable;

    /**
     * The token value size in bytes.
     *
     * @return int
     */
    public function getBytes(): int;

    /**
     * The token value size in chars (multibyte encodings contain several bytes).
     *
     * @return int
     */
    public function getLength(): int;
}