railt / console

src/Language/Language.php

<?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\Console\Language;

use Railt\Io\Readable;
use Railt\Lexer\Factory;
use Railt\Lexer\LexerInterface;
use Railt\Lexer\Result\Eoi;

/**
 * Class Language
 */
abstract class Language implements LanguageInterface
{
    /**
     * @var string[]
     */
    public const DEFAULT_COLORS = [
        'T_COMMENT'  => 'fg=cyan',
        'T_KEYWORD'  => 'fg=magenta',
        'T_STRING'   => 'fg=green',
        'T_DIGIT'    => 'fg=green',
        'T_VARIABLE' => 'fg=yellow',
    ];

    /**
     * @var string[]
     */
    public const DEFAULT_TOKENS = [
        'T_WHITESPACE'    => '\s+',
    ];

    /**
     * @var LexerInterface
     */
    private $lexer;

    /**
     * @var array
     */
    private $colors;

    /**
     * Language constructor.
     * @throws \InvalidArgumentException
     * @throws \Railt\Lexer\Exception\BadLexemeException
     */
    public function __construct()
    {
        $this->lexer  = Factory::create(\array_merge(self::DEFAULT_TOKENS, $this->tokens()), [Eoi::T_NAME]);
        $this->colors = \array_merge(self::DEFAULT_COLORS, $this->colors());
    }

    /**
     * @return array|string[]
     */
    abstract public function tokens(): array;

    /**
     * @return array|string[]
     */
    abstract public function colors(): array;

    /**
     * @param Readable $file
     * @param array $extensions
     * @return bool
     */
    protected function matchExtension(Readable $file, array $extensions): bool
    {
        $ext = \mb_strtolower(\pathinfo($file->getPathname(), \PATHINFO_EXTENSION));

        return \in_array($ext, $extensions, true);
    }

    /**
     * @param Readable $file
     * @return iterable
     */
    public function lex(Readable $file): iterable
    {
        return $this->lexer->lex($file);

The expression $this->lexer->lex($file); of type Traversable|Railt\Lexer\TokenInterface[] adds the type Traversable to the return on line 89 which is incompatible with the return type declared by the interface Railt\Console\Language\LanguageInterface::lex of type Railt\Console\Language\iterable|Railt\Lexer\TokenInterface[].

    }

    /**
     * @param string $token
     * @param string $content
     * @return string
     */
    public function highlight(string $token, string $content): string
    {
        $color   = $this->colors[$token] ?? null;
        $content = \str_replace('\\', "\u{0000}", $content);
        $content = $color === null ? $content : \sprintf('<%s>%s</>', $color, $content);

        return $content;
    }

    /**
     * @param array $tokens
     * @return string
     */
    protected function oneOf(array $tokens): string
    {
        return \sprintf('(%s)\b', \implode('|', $tokens));
    }
}