Rename "Parser" to the "TypeParser"

Author: SerafimArts

docs/Writerside/topics/parser.md

@@ -26,7 +26,7 @@ To create a parser instance, the `TypeLang\Parser\Parser` class is used.
 To run code analysis, you should use the `parse()` method.
 
 ```php
-$parser = new TypeLang\Parser\Parser();
+$parser = new TypeLang\Parser\TypeParser();
 
 $result = $parser->parse('example');
 ```
@@ -56,7 +56,7 @@ partial support of the functionality. Such a feature allows you to conveniently
 implement more strict functionality.
 
 ```php
-$parser = new TypeLang\Parser\Parser(
+$parser = new TypeLang\Parser\TypeParser(
     literals: false,
 );
 

docs/Writerside/topics/parser/features.md

@@ -20,7 +20,7 @@ implement more strict functionality.
 To enable or disable literals, use the `literals: bool` flag.
 
 ```php
-$parser = new TypeLang\Parser\Parser(
+$parser = new TypeLang\Parser\TypeParser(
     literals: false,
 );
 
@@ -38,7 +38,7 @@ To enable or disable template arguments (generics), use
 the `generics: bool` flag.
 
 ```php
-$parser = new TypeLang\Parser\Parser(
+$parser = new TypeLang\Parser\TypeParser(
     generics: false,
 );
 
@@ -56,7 +56,7 @@ To enable or disable template argument hints (argument modifiers), use the
 `hints: bool` flag.
 
 ```php
-$parser = new TypeLang\Parser\Parser(
+$parser = new TypeLang\Parser\TypeParser(
     hints: false,
 );
 
@@ -74,7 +74,7 @@ To enable or disable type lists (legacy/short syntax for iterable types), use
 the `list: bool` flag.
 
 ```php
-$parser = new TypeLang\Parser\Parser(
+$parser = new TypeLang\Parser\TypeParser(
     list: false,
 );
 
@@ -93,7 +93,7 @@ Square bracket list types not allowed in "Example[]"
 To enable or disable type offsets, use the `offsets: bool` flag.
 
 ```php
-$parser = new TypeLang\Parser\Parser(
+$parser = new TypeLang\Parser\TypeParser(
     offsets: false,
 );
 
@@ -111,7 +111,7 @@ Type offsets not allowed in "Example[Type]"
 To enable or disable callables (delegates), use the `callables: bool` flag.
 
 ```php
-$parser = new TypeLang\Parser\Parser(
+$parser = new TypeLang\Parser\TypeParser(
     callables: false,
 );
 
@@ -128,7 +128,7 @@ Callable types not allowed in "fn()"
 To enable or disable shape fields, use the `shapes: bool` flag.
 
 ```php
-$parser = new TypeLang\Parser\Parser(
+$parser = new TypeLang\Parser\TypeParser(
     shapes: false,
 );
 
@@ -150,7 +150,7 @@ Shape fields not allowed in "array{\n foo: T,\n ...\n}"
 To enable or disable union types, use the `union: bool` flag.
 
 ```php
-$parser = new TypeLang\Parser\Parser(
+$parser = new TypeLang\Parser\TypeParser(
     union: false,
 );
 
@@ -167,7 +167,7 @@ Union types not allowed in "T|U"
 To enable or disable union types, use the `intersection: bool` flag.
 
 ```php
-$parser = new TypeLang\Parser\Parser(
+$parser = new TypeLang\Parser\TypeParser(
     intersection: false,
 );
 
@@ -184,7 +184,7 @@ Intersection types not allowed in "T&U"
 To enable or disable conditional types (expressions), use the `conditional: bool` flag.
 
 ```php
-$parser = new TypeLang\Parser\Parser(
+$parser = new TypeLang\Parser\TypeParser(
     conditional: false,
 );
 
@@ -201,7 +201,7 @@ Conditional expressions not allowed in "T is U ? 23 : 42"
 To enable or disable attributes, use the `attributes: bool` flag.
 
 ```php
-$parser = new TypeLang\Parser\Parser(
+$parser = new TypeLang\Parser\TypeParser(
     attributes: false,
 );
 

docs/Writerside/topics/parser/tolerant-mode.md

@@ -9,7 +9,7 @@ Such a mode will be convenient to use, for example, for analyzing phpdoc
 docblocks, separating types from their descriptions.
 
 ```php
-$parser = new TypeLang\Parser\Parser(
+$parser = new TypeLang\Parser\TypeParser(
     // enable "tolerant" mode
     tolerant: true,
 );
@@ -19,7 +19,7 @@ As an example, let's try to parse the contents of the "`@return`" docblock.
 Similar actions can be implemented for other annotations.
 
 ```php
-$parser = new TypeLang\Parser\Parser(
+$parser = new TypeLang\Parser\TypeParser(
     tolerant: true,
 );
 

docs/Writerside/topics/printer.md

@@ -40,7 +40,7 @@ contains an `print()` method for displaying ASTs as formatted strings.
 <tab title="PrettyPrinter">
 
 ```php
-$parser = new TypeLang\Parser\Parser();
+$parser = new TypeLang\Parser\TypeParser();
 $printer = new TypeLang\Printer\PrettyPrinter();
 
 $result = $parser->parse(<<<'PHP'
@@ -64,7 +64,7 @@ echo $printer->print($result);
 <tab title="NativeTypePrinter">
 
 ```php
-$parser = new TypeLang\Parser\Parser();
+$parser = new TypeLang\Parser\TypeParser();
 $printer = new TypeLang\Printer\NativeTypePrinter();
 
 $result = $parser->parse(<<<'PHP'
@@ -89,7 +89,7 @@ echo $printer->print($result);
 <tab title="PrettyPrinter">
 
 ```php
-$parser = new TypeLang\Parser\Parser();
+$parser = new TypeLang\Parser\TypeParser();
 $printer = new TypeLang\Printer\PrettyPrinter();
 
 $result = $parser->parse(<<<'PHP'
@@ -108,7 +108,7 @@ echo $printer->print($result);
 <tab title="NativeTypePrinter">
 
 ```php
-$parser = new TypeLang\Parser\Parser();
+$parser = new TypeLang\Parser\TypeParser();
 $printer = new TypeLang\Printer\NativeTypePrinter();
 
 $result = $parser->parse(<<<'PHP'
@@ -132,7 +132,7 @@ echo $printer->print($result);
 <tab title="PrettyPrinter">
 
 ```php
-$parser = new TypeLang\Parser\Parser();
+$parser = new TypeLang\Parser\TypeParser();
 $printer = new TypeLang\Printer\PrettyPrinter();
 
 $result = $parser->parse(<<<'PHP'
@@ -151,7 +151,7 @@ echo $printer->print($result);
 <tab title="NativeTypePrinter">
 
 ```php
-$parser = new TypeLang\Parser\Parser();
+$parser = new TypeLang\Parser\TypeParser();
 $printer = new TypeLang\Printer\NativeTypePrinter();
 
 $result = $parser->parse(<<<'PHP'

libs/parser/README.md

@@ -36,7 +36,7 @@ composer require type-lang/parser
 ## Quick Start
 
 ```php
-$parser = new \TypeLang\Parser\Parser();
+$parser = new \TypeLang\Parser\TypeParser();
 
 $type = $parser->parse(<<<'PHP'
     array{

libs/parser/src/InMemoryCachedParser.php libs/parser/src/InMemoryTypeParser.phplibs/parser/src/InMemoryCachedParser.php renamed to libs/parser/src/InMemoryTypeParser.php

@@ -11,7 +11,7 @@
 use TypeLang\Node\Type\TypeNode;
 use TypeLang\Parser\Exception\ParserExceptionInterface;
 
-final class InMemoryCachedParser implements ParserInterface
+final class InMemoryTypeParser implements TypeParserInterface
 {
     /**
      * @var array<non-empty-string, TypeNode>
@@ -24,7 +24,7 @@ final class InMemoryCachedParser implements ParserInterface
     private array $sequences = [];
 
     public function __construct(
-        private readonly ParserInterface $parser = new Parser(),
+        private readonly TypeParserInterface $parser = new TypeParser(),
         private readonly SourceFactoryInterface $sources = new SourceFactory(),
     ) {}
 

libs/parser/src/Internal/ExecutionContext.php

@@ -22,7 +22,7 @@
 use TypeLang\Node\Type\Literal\StringLiteralNode;
 use TypeLang\Node\Type\TypeNode;
 use TypeLang\Parser\ParsedResult;
-use TypeLang\Parser\ParserFeatures;
+use TypeLang\Parser\TypeParserFeatures;
 
 /**
  * @phpstan-type GrammarConfigArrayType array{
@@ -71,7 +71,7 @@ public function __construct(
         /**
          * @api this property is accessible inside the grammar reducers
          */
-        protected ParserFeatures $features,
+        protected TypeParserFeatures $features,
         /**
          * @api this property is accessible inside the grammar reducers
          */

libs/parser/src/Traverser/MatcherVisitor.php

@@ -8,7 +8,11 @@
 
 class MatcherVisitor extends Visitor
 {
-    private ?Node $found = null;
+    public private(set) ?Node $found = null;
+
+    public bool $isFound {
+        get => $this->found !== null;
+    }
 
     private bool $shouldContinue = false;
 
@@ -21,16 +25,6 @@ public function __construct(
         private readonly ?\Closure $break = null,
     ) {}
 
-    public function isFound(): bool
-    {
-        return $this->found !== null;
-    }
-
-    public function getFoundNode(): ?Node
-    {
-        return $this->found;
-    }
-
     public function before(): void
     {
         $this->found = null;

libs/parser/src/Traverser/StreamDumperVisitor.php

@@ -6,14 +6,16 @@
 
 final class StreamDumperVisitor extends DumperVisitor
 {
+    public const string DEFAULT_OUTPUT_STREAM = 'php://stderr';
+
     /**
      * @var resource
      */
     private readonly mixed $stream;
 
     public function __construct(
         bool $simplifyNames = true,
-        string $stream = 'php://stderr',
+        string $stream = self::DEFAULT_OUTPUT_STREAM,
     ) {
         parent::__construct($simplifyNames);
 

libs/parser/src/Parser.php libs/parser/src/TypeParser.phplibs/parser/src/Parser.php renamed to libs/parser/src/TypeParser.php

@@ -17,7 +17,7 @@
 use TypeLang\Parser\Exception\SemanticException;
 use TypeLang\Parser\Internal\ExecutionContext;
 
-final class Parser implements ParserInterface
+final class TypeParser implements TypeParserInterface
 {
     private ExecutionContext $strict {
         get => $this->strict ??= new ExecutionContext($this->features, false);
@@ -28,7 +28,7 @@ final class Parser implements ParserInterface
     }
 
     public function __construct(
-        public readonly ParserFeatures $features = new ParserFeatures(),
+        public readonly TypeParserFeatures $features = new TypeParserFeatures(),
         private readonly SourceFactoryInterface $sources = new SourceFactory(),
     ) {}