Remove phplrt dependency and speedup comment lexing

php-type-language · Mar 30, 2024 · dda2004 · dda2004
1 parent 4933040
commit dda2004
Show file tree

Hide file tree

Showing 8 changed files with 124 additions and 168 deletions.
diff --git a/composer.json b/composer.json
@@ -9,9 +9,7 @@
         "issues": "https://github.com/php-type-language/phpdoc/issues"
     },
     "require": {
-        "php": "^8.1",
-        "phplrt/lexer": "^3.6",
-        "phplrt/source": "^3.6"
+        "php": "^8.1"
     },
     "autoload": {
         "psr-4": {

diff --git a/src/Exception/InvalidTagNameException.php b/src/Exception/InvalidTagNameException.php
@@ -4,8 +4,6 @@
 
 namespace TypeLang\PHPDoc\Exception;
 
-use Phplrt\Contracts\Source\ReadableInterface;
-
 class InvalidTagNameException extends InvalidTagException
 {
     final public const ERROR_CODE_EMPTY = 0x01 + parent::CODE_LAST;
@@ -33,7 +31,7 @@ public static function fromEmptyTag(int $offset = 0): static
      *
      * @param int<0, max> $offset
      */
-    public static function fromEmptyTagName(ReadableInterface|string $source, int $offset = 0): static
+    public static function fromEmptyTagName(string $source, int $offset = 0): static
     {
         $message = 'Tag name cannot be empty';
 
@@ -45,7 +43,7 @@ public static function fromEmptyTagName(ReadableInterface|string $source, int $o
      *
      * @param int<0, max> $offset
      */
-    public static function fromInvalidTagPrefix(ReadableInterface|string $source, int $offset = 0): static
+    public static function fromInvalidTagPrefix(string $source, int $offset = 0): static
     {
         $message = 'The tag name must starts with the "@" character';
 

diff --git a/src/Exception/ParsingException.php b/src/Exception/ParsingException.php
@@ -4,31 +4,24 @@
 
 namespace TypeLang\PHPDoc\Exception;
 
-use Phplrt\Contracts\Source\ReadableInterface;
-use Phplrt\Source\Source;
-
 class ParsingException extends \RuntimeException implements RuntimeExceptionInterface
 {
     final public const ERROR_CODE_INTERNAL = 0x01;
 
     protected const CODE_LAST = self::ERROR_CODE_INTERNAL;
 
-    public readonly ReadableInterface $source;
+    public readonly string $source;
 
     /**
      * @param int<0, max> $offset
      */
     final public function __construct(
-        ReadableInterface|string $source,
+        string $source,
         public readonly int $offset = 0,
         string $message = "",
         int $code = 0,
         ?\Throwable $previous = null
     ) {
-        if (\is_string($source)) {
-            $source = new Source($source);
-        }
-
         $this->source = $source;
 
         parent::__construct($message, $code, $previous);
@@ -37,7 +30,7 @@ final public function __construct(
     /**
      * @param int<0, max> $offset
      */
-    public static function fromInternalError(ReadableInterface|string $source, int $offset, \Throwable $e): self
+    public static function fromInternalError(string $source, int $offset, \Throwable $e): self
     {
         return new static(
             source: $source,
@@ -51,7 +44,7 @@ public static function fromInternalError(ReadableInterface|string $source, int $
     /**
      * @param int<0, max> $offset
      */
-    public function withSource(ReadableInterface|string $source, int $offset): self
+    public function withSource(string $source, int $offset): self
     {
         return new static(
             source: $source,
@@ -62,7 +55,7 @@ public function withSource(ReadableInterface|string $source, int $offset): self
         );
     }
 
-    public function getSource(): ReadableInterface
+    public function getSource(): string
     {
         return $this->source;
     }

diff --git a/src/Exception/RuntimeExceptionInterface.php b/src/Exception/RuntimeExceptionInterface.php
@@ -4,8 +4,6 @@
 
 namespace TypeLang\PHPDoc\Exception;
 
-use Phplrt\Contracts\Source\ReadableInterface;
-
 /**
  * Error occurring while processing phpdoc content.
  */
@@ -16,12 +14,12 @@ interface RuntimeExceptionInterface extends PHPDocExceptionInterface
      *
      * @param int<0, max> $offset
      */
-    public function withSource(ReadableInterface|string $source, int $offset): self;
+    public function withSource(string $source, int $offset): self;
 
     /**
      * Returns the full content in which the error occurred.
      */
-    public function getSource(): ReadableInterface;
+    public function getSource(): string;
 
     /**
      * Returns the byte offset at the location where the error occurs.

diff --git a/src/Parser.php b/src/Parser.php
@@ -5,13 +5,10 @@
 namespace TypeLang\PHPDoc;
 
 use JetBrains\PhpStorm\Language;
-use Phplrt\Contracts\Lexer\LexerExceptionInterface;
-use Phplrt\Contracts\Lexer\LexerRuntimeExceptionInterface;
-use Phplrt\Contracts\Source\SourceExceptionInterface;
 use TypeLang\PHPDoc\Exception\ParsingException;
 use TypeLang\PHPDoc\Exception\RuntimeExceptionInterface;
 use TypeLang\PHPDoc\Parser\Comment\CommentParserInterface;
-use TypeLang\PHPDoc\Parser\Comment\LexerAwareCommentParser;
+use TypeLang\PHPDoc\Parser\Comment\RegexCommentParser;
 use TypeLang\PHPDoc\Parser\Comment\Segment;
 use TypeLang\PHPDoc\Parser\Description\DescriptionParserInterface;
 use TypeLang\PHPDoc\Parser\Description\SprintfDescriptionReader;
@@ -25,7 +22,7 @@
 class Parser implements ParserInterface
 {
     public function __construct(
-        private readonly CommentParserInterface $comments = new LexerAwareCommentParser(),
+        private readonly CommentParserInterface $comments = new RegexCommentParser(),
         private readonly DescriptionParserInterface $descriptions = new SprintfDescriptionReader(),
         private readonly TagParserInterface $tags = new TagParser(),
     ) {}
@@ -64,10 +61,7 @@ public function parse(#[Language('PHP')] string $docblock): DocBlock
     /**
      * @return \Generator<array-key, Segment, void, DocBlock>
      *
-     * @throws LexerExceptionInterface
-     * @throws LexerRuntimeExceptionInterface
      * @throws RuntimeExceptionInterface
-     * @throws SourceExceptionInterface
      */
     private function analyze(string $docblock): \Generator
     {
@@ -106,10 +100,6 @@ private function analyze(string $docblock): \Generator
 
     /**
      * @return \Generator<array-key, Segment, void, non-empty-list<string>>
-     *
-     * @throws LexerExceptionInterface
-     * @throws LexerRuntimeExceptionInterface
-     * @throws SourceExceptionInterface
      */
     private function groupByCommentSections(string $docblock): \Generator
     {

diff --git a/src/Parser/Comment/LexerAwareCommentParser.php b/src/Parser/Comment/LexerAwareCommentParser.php