Deprecate exceptions

ChangeLog.md

@@ -79,6 +79,38 @@ Incoming
      * Deprecate `Pattern.list()`
      * Deprecate `PatternList`
      * Deprecate `Pattern.mask()`
+  * Deprecate exceptions unqualified for release candidate.
+     * Deprecate `EmptyOptionalException`
+     * Deprecate `ExplicitDelimiterRequiredException`, to be refactored to `DelimiterException`
+     * Deprecate `GroupNotMatchedException`, to be refactored to `GroupException`
+     * Deprecate `IntegerFormatException`
+     * Deprecate `IntegerOverflowException`
+     * Deprecate `InternalCleanRegexException`
+     * Deprecate `InvalidIntegerTypeException`
+     * Deprecate `InvalidReplacementException`, to be refactored to `\UnexpectedValueException`
+     * Deprecate `InvalidReturnValueException`
+     * Deprecate `MalformedPcreTemplateException`, to be refactored to `SyntaxException`
+     * Deprecate `MaskMalformedPatternException`
+     * Deprecate `NonexistentGroupException`, to be refactored to `GroupException`
+     * Deprecate `NoSuchNthElementException`
+     * Deprecate `NoSuchStreamElementException`
+     * Deprecate `PatternMalformedPatternException`
+     * Deprecate `PlaceholderFigureException`
+     * Deprecate `ReplacementExpectationFailedException`
+     * Deprecate `SubjectNotMatchedException`, to be refactored to `NoMatchException`
+     * Deprecate `UnevenCutException`
+     * Deprecate `MalformedPatternException`, to be refactored to `SyntaxException`
+     * Deprecate `PatternSyntaxException`
+     * Deprecate `CatastrophicBacktrackingException`, to be refactored to `BacktrackException`
+     * Deprecate `CompilePregException`, to be refactored to `SyntaxException`
+     * Deprecate `JitStackLimitException`, to be refactored to `JitException`
+     * Deprecate `PatternStructureException`
+     * Deprecate `PregException`
+     * Deprecate `PregMalformedPatternException`, to be refactored to `SyntaxException`
+     * Deprecate `RuntimePregException`, to be refactored to `MatchException`
+     * Deprecate `SubjectEncodingException`, to be refactored to `UnicodeException`
+     * Deprecate `SuspectedReturnPregException`
+     * Deprecate `UnicodeOffsetException`, to be refactored to `UnicodeException`
 
 Added in 0.41.5
 ---------------

src/CleanRegex/Exception/EmptyOptionalException.php

@@ -1,6 +1,9 @@
 <?php
 namespace TRegx\CleanRegex\Exception;
 
+/**
+ * @deprecated
+ */
 class EmptyOptionalException extends \RuntimeException
 {
 }

src/CleanRegex/Exception/ExplicitDelimiterRequiredException.php

@@ -1,6 +1,9 @@
 <?php
 namespace TRegx\CleanRegex\Exception;
 
+/**
+ * @deprecated
+ */
 class ExplicitDelimiterRequiredException extends \RuntimeException implements PatternException
 {
     public function __construct(string $template)

src/CleanRegex/Exception/GroupNotMatchedException.php

@@ -1,6 +1,9 @@
 <?php
 namespace TRegx\CleanRegex\Exception;
 
+/**
+ * @deprecated
+ */
 class GroupNotMatchedException extends \RuntimeException implements PatternException
 {
 }

src/CleanRegex/Exception/IntegerFormatException.php

@@ -1,6 +1,9 @@
 <?php
 namespace TRegx\CleanRegex\Exception;
 
+/**
+ * @deprecated
+ */
 class IntegerFormatException extends \RuntimeException implements PatternException
 {
 }

src/CleanRegex/Exception/IntegerOverflowException.php

@@ -1,6 +1,9 @@
 <?php
 namespace TRegx\CleanRegex\Exception;
 
+/**
+ * @deprecated
+ */
 class IntegerOverflowException extends \RuntimeException implements PatternException
 {
 }

src/CleanRegex/Exception/InternalCleanRegexException.php

@@ -1,6 +1,9 @@
 <?php
 namespace TRegx\CleanRegex\Exception;
 
+/**
+ * @deprecated
+ */
 class InternalCleanRegexException extends \RuntimeException implements PatternException
 {
 }

src/CleanRegex/Exception/InvalidIntegerTypeException.php

@@ -1,6 +1,9 @@
 <?php
 namespace TRegx\CleanRegex\Exception;
 
+/**
+ * @deprecated
+ */
 class InvalidIntegerTypeException extends \RuntimeException implements PatternException
 {
 }

src/CleanRegex/Exception/InvalidReplacementException.php

@@ -3,6 +3,9 @@
 
 use TRegx\CleanRegex\Internal\Type\Type;
 
+/**
+ * @deprecated
+ */
 class InvalidReplacementException extends InvalidReturnValueException
 {
     public function __construct(Type $replacementType)

src/CleanRegex/Exception/InvalidReturnValueException.php

@@ -3,6 +3,9 @@
 
 use TRegx\CleanRegex\Internal\Type\Type;
 
+/**
+ * @deprecated
+ */
 class InvalidReturnValueException extends \RuntimeException implements PatternException
 {
     public function __construct(string $methodName, string $expectedReturnType, Type $type)

src/CleanRegex/Exception/MalformedPcreTemplateException.php

@@ -1,6 +1,9 @@
 <?php
 namespace TRegx\CleanRegex\Exception;
 
+/**
+ * @deprecated
+ */
 class MalformedPcreTemplateException extends PatternMalformedPatternException
 {
     public function __construct(string $message)

src/CleanRegex/Exception/MaskMalformedPatternException.php

@@ -1,6 +1,9 @@
 <?php
 namespace TRegx\CleanRegex\Exception;
 
+/**
+ * @deprecated
+ */
 class MaskMalformedPatternException extends PatternMalformedPatternException
 {
 }

src/CleanRegex/Exception/NoSuchNthElementException.php

@@ -1,6 +1,9 @@
 <?php
 namespace TRegx\CleanRegex\Exception;
 
+/**
+ * @deprecated
+ */
 class NoSuchNthElementException extends \RuntimeException implements PatternException
 {
     public static function forSubject(int $index, int $total): self

src/CleanRegex/Exception/NoSuchStreamElementException.php

@@ -1,6 +1,9 @@
 <?php
 namespace TRegx\CleanRegex\Exception;
 
+/**
+ * @deprecated
+ */
 class NoSuchStreamElementException extends \RuntimeException implements PatternException
 {
 }

src/CleanRegex/Exception/NonexistentGroupException.php

@@ -3,6 +3,9 @@
 
 use TRegx\CleanRegex\Internal\GroupKey\GroupKey;
 
+/**
+ * @deprecated
+ */
 class NonexistentGroupException extends \RuntimeException implements PatternException
 {
     public function __construct(GroupKey $group)

src/CleanRegex/Exception/PatternMalformedPatternException.php

@@ -3,6 +3,9 @@
 
 use TRegx\Exception\MalformedPatternException;
 
+/**
+ * @deprecated
+ */
 class PatternMalformedPatternException extends \RuntimeException implements PatternException, MalformedPatternException
 {
 }

src/CleanRegex/Exception/PlaceholderFigureException.php

@@ -1,6 +1,9 @@
 <?php
 namespace TRegx\CleanRegex\Exception;
 
+/**
+ * @deprecated
+ */
 class PlaceholderFigureException extends \RuntimeException implements PatternException
 {
 }

src/CleanRegex/Exception/ReplacementExpectationFailedException.php

@@ -1,6 +1,9 @@
 <?php
 namespace TRegx\CleanRegex\Exception;
 
+/**
+ * @deprecated
+ */
 class ReplacementExpectationFailedException extends \RuntimeException implements PatternException
 {
 }

src/CleanRegex/Exception/SubjectNotMatchedException.php

@@ -1,6 +1,9 @@
 <?php
 namespace TRegx\CleanRegex\Exception;
 
+/**
+ * @deprecated
+ */
 class SubjectNotMatchedException extends \RuntimeException implements PatternException
 {
     public function __construct()

src/CleanRegex/Exception/UnevenCutException.php

@@ -1,6 +1,9 @@
 <?php
 namespace TRegx\CleanRegex\Exception;
 
+/**
+ * @deprecated
+ */
 class UnevenCutException extends \RuntimeException implements PatternException
 {
 }

src/Exception/MalformedPatternException.php

@@ -1,6 +1,9 @@
 <?php
 namespace TRegx\Exception;
 
+/**
+ * @deprecated
+ */
 interface MalformedPatternException extends PatternSyntaxException
 {
 }

src/Exception/PatternSyntaxException.php

@@ -1,6 +1,9 @@
 <?php
 namespace TRegx\Exception;
 
+/**
+ * @deprecated
+ */
 interface PatternSyntaxException extends RegexException
 {
 }

src/SafeRegex/Exception/CatastrophicBacktrackingException.php

@@ -1,6 +1,9 @@
 <?php
 namespace TRegx\SafeRegex\Exception;
 
+/**
+ * @deprecated
+ */
 class CatastrophicBacktrackingException extends RuntimePregException implements PatternStructureException
 {
     public function __construct($pattern, string $methodName, int $errorCode, string $errorName)

src/SafeRegex/Exception/CompilePregException.php

@@ -3,6 +3,9 @@
 
 use TRegx\SafeRegex\Internal\PhpError;
 
+/**
+ * @deprecated
+ */
 class CompilePregException extends \RuntimeException implements PregException
 {
     /** @var PhpError */

src/SafeRegex/Exception/InvalidReturnValueException.php

@@ -1,6 +1,9 @@
 <?php
 namespace TRegx\SafeRegex\Exception;
 
+/**
+ * @deprecated
+ */
 class InvalidReturnValueException extends \RuntimeException implements PregException
 {
     /** @var string */

src/SafeRegex/Exception/JitStackLimitException.php

@@ -1,6 +1,9 @@
 <?php
 namespace TRegx\SafeRegex\Exception;
 
+/**
+ * @deprecated
+ */
 class JitStackLimitException extends RuntimePregException implements PatternStructureException
 {
     public function __construct($pattern, string $methodName, int $errorCode, string $errorName)

src/SafeRegex/Exception/PatternStructureException.php

@@ -1,6 +1,9 @@
 <?php
 namespace TRegx\SafeRegex\Exception;
 
+/**
+ * @deprecated
+ */
 interface PatternStructureException extends PregException
 {
 }

src/SafeRegex/Exception/PregException.php

@@ -3,6 +3,9 @@
 
 use TRegx\Exception\RegexException;
 
+/**
+ * @deprecated
+ */
 interface PregException extends RegexException
 {
     public function getInvokingMethod(): string;

src/SafeRegex/Exception/PregMalformedPatternException.php

@@ -3,6 +3,9 @@
 
 use TRegx\Exception\MalformedPatternException;
 
+/**
+ * @deprecated
+ */
 class PregMalformedPatternException extends CompilePregException implements MalformedPatternException
 {
 }

src/SafeRegex/Exception/RuntimePregException.php

@@ -1,6 +1,9 @@
 <?php
 namespace TRegx\SafeRegex\Exception;
 
+/**
+ * @deprecated
+ */
 class RuntimePregException extends \RuntimeException implements PregException
 {
     /** @var string */

src/SafeRegex/Exception/SubjectEncodingException.php

@@ -1,6 +1,9 @@
 <?php
 namespace TRegx\SafeRegex\Exception;
 
+/**
+ * @deprecated
+ */
 class SubjectEncodingException extends RuntimePregException
 {
     public function __construct($pattern, string $methodName, int $errorCode, string $errorName)

src/SafeRegex/Exception/SuspectedReturnPregException.php

@@ -1,6 +1,9 @@
 <?php
 namespace TRegx\SafeRegex\Exception;
 
+/**
+ * @deprecated
+ */
 class SuspectedReturnPregException extends \RuntimeException implements PregException
 {
     /** @var string */

src/SafeRegex/Exception/UnicodeOffsetException.php

@@ -1,6 +1,9 @@
 <?php
 namespace TRegx\SafeRegex\Exception;
 
+/**
+ * @deprecated
+ */
 class UnicodeOffsetException extends RuntimePregException
 {
     public function __construct($pattern, string $methodName, int $errorCode, string $errorName)