Issue #14814: refactor findmatch into iteration method

mohitsatr · rdiachenko · commit 9db390971544 · 2024-10-31T00:43:28.000-07:00
diff --git a/config/checker-framework-suppressions/checker-nullness-optional-interning-suppressions.xml b/config/checker-framework-suppressions/checker-nullness-optional-interning-suppressions.xml
@@ -4572,13 +4572,6 @@
     <lineContent>/* package */ MultilineDetector(DetectorOptions options) {</lineContent>
   </checkerFrameworkError>
 
-  <checkerFrameworkError unstable="false">
-    <fileName>src/main/java/com/puppycrawl/tools/checkstyle/checks/regexp/RegexpCheck.java</fileName>
-    <specifier>initialization.field.uninitialized</specifier>
-    <message>the default constructor does not initialize field matcher</message>
-    <lineContent>private Matcher matcher;</lineContent>
-  </checkerFrameworkError>
-
   <checkerFrameworkError unstable="false">
     <fileName>src/main/java/com/puppycrawl/tools/checkstyle/checks/regexp/RegexpCheck.java</fileName>
     <specifier>initialization.field.uninitialized</specifier>
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/regexp/RegexpCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/regexp/RegexpCheck.java
@@ -207,18 +207,9 @@ public class RegexpCheck extends AbstractCheck {
     /** Boolean to say if we should check for duplicates. */
     private boolean checkForDuplicates;
 
-    /** Tracks number of matches made. */
-    private int matchCount;
-
-    /** Tracks number of errors. */
-    private int errorCount;
-
     /** Specify the pattern to match against. */
     private Pattern format = Pattern.compile("^$", Pattern.MULTILINE);
 
-    /** The matcher. */
-    private Matcher matcher;
-
     /**
      * Setter to specify message which is used to notify about violations,
      * if empty then the default (hard-coded) message is used.
@@ -300,73 +291,54 @@ public int[] getRequiredTokens() {
         return CommonUtil.EMPTY_INT_ARRAY;
     }
 
-    // suppress deprecation until https://github.com/checkstyle/checkstyle/issues/11166
-    @SuppressWarnings("deprecation")
     @Override
     public void beginTree(DetailAST rootAST) {
-        matcher = format.matcher(getFileContents().getText().getFullText());
-        matchCount = 0;
-        errorCount = 0;
-        findMatch();
+        processRegexpMatches();
     }
 
     /**
-     * Recursive method that finds the matches.
+     * Processes the regexp matches and logs the number of errors in the file.
      *
-     * @noinspection TailRecursion
-     * @noinspectionreason TailRecursion - until issue #14814
      */
     // suppress deprecation until https://github.com/checkstyle/checkstyle/issues/11166
     @SuppressWarnings("deprecation")
-    private void findMatch() {
-        final boolean foundMatch = matcher.find();
-        if (foundMatch) {
-            final FileText text = getFileContents().getText();
+    private void processRegexpMatches() {
+        final Matcher matcher = format.matcher(getFileContents().getText().getFullText());
+        int errorCount = 0;
+        int matchCount = 0;
+        final FileText text = getFileContents().getText();
+        while (errorCount < errorLimit && matcher.find()) {
             final LineColumn start = text.lineColumn(matcher.start());
             final int startLine = start.getLine();
 
-            final boolean ignore = isIgnore(startLine, text, start);
-
+            final boolean ignore = isIgnore(startLine, text, start, matcher);
             if (!ignore) {
                 matchCount++;
                 if (illegalPattern || checkForDuplicates
                         && matchCount - 1 > duplicateLimit) {
                     errorCount++;
-                    logMessage(startLine);
+                    logMessage(startLine, errorCount);
                 }
             }
-            if (canContinueValidation(ignore)) {
-                findMatch();
-            }
         }
-        else if (!illegalPattern && matchCount == 0) {
-            final String msg = getMessage();
+        if (!illegalPattern && matchCount == 0) {
+            final String msg = getMessage(errorCount);
             log(1, MSG_REQUIRED_REGEXP, msg);
         }
     }
 
-    /**
-     * Check if we can stop validation.
-     *
-     * @param ignore flag
-     * @return true is we can continue
-     */
-    private boolean canContinueValidation(boolean ignore) {
-        return errorCount <= errorLimit - 1
-                && (ignore || illegalPattern || checkForDuplicates);
-    }
-
     /**
      * Detect ignore situation.
      *
      * @param startLine position of line
      * @param text file text
      * @param start line column
+     * @param matcher The matcher
      * @return true is that need to be ignored
      */
     // suppress deprecation until https://github.com/checkstyle/checkstyle/issues/11166
     @SuppressWarnings("deprecation")
-    private boolean isIgnore(int startLine, FileText text, LineColumn start) {
+    private boolean isIgnore(int startLine, FileText text, LineColumn start, Matcher matcher) {
         final LineColumn end;
         if (matcher.end() == 0) {
             end = text.lineColumn(0);
@@ -390,9 +362,10 @@ private boolean isIgnore(int startLine, FileText text, LineColumn start) {
      * Displays the right message.
      *
      * @param lineNumber the line number the message relates to.
+     * @param errorCount number of errors in the file.
      */
-    private void logMessage(int lineNumber) {
-        final String msg = getMessage();
+    private void logMessage(int lineNumber, int errorCount) {
+        final String msg = getMessage(errorCount);
 
         if (illegalPattern) {
             log(lineNumber, MSG_ILLEGAL_REGEXP, msg);
@@ -405,9 +378,10 @@ private void logMessage(int lineNumber) {
     /**
      * Provide right message.
      *
+     * @param errorCount number of errors in the file.
      * @return message for violation.
      */
-    private String getMessage() {
+    private String getMessage(int errorCount) {
         String msg;
 
         if (message == null || message.isEmpty()) {
@@ -423,5 +397,4 @@ private String getMessage() {
 
         return msg;
     }
-
 }
