refactoring

Author: raydac

jcp/src/main/java/com/igormaznitsa/jcp/containers/FileInfoContainer.java

@@ -23,6 +23,7 @@
 
 import static java.util.Objects.requireNonNull;
 
+import com.igormaznitsa.jcp.context.CommentTextProcessor;
 import com.igormaznitsa.jcp.context.PreprocessingState;
 import com.igormaznitsa.jcp.context.PreprocessorContext;
 import com.igormaznitsa.jcp.directives.AbstractDirectiveHandler;
@@ -133,12 +134,14 @@ private static String findTailRemover(final String str, final PreprocessorContex
 
   /**
    * Check that text line starts with two commented dollar chars
-   * @param line text line to be examined, must not be null
+   *
+   * @param line               text line to be examined, must not be null
    * @param allowedWhitespaces if true then whitespaces allowed after line comment
    * @return true if the line starts with two commented dollar chars, false otherwise
    * @since 7.0.6
    */
-  public static boolean isDoubleDollarPrefixed(final String line, final boolean allowedWhitespaces) {
+  public static boolean isDoubleDollarPrefixed(final String line,
+                                               final boolean allowedWhitespaces) {
     if (allowedWhitespaces) {
       return DIRECTIVE_TWO_DOLLARS_PREFIXED.matcher(line).matches();
     } else {
@@ -165,12 +168,14 @@ public static boolean isDoubleDollarBlockPrefixed(final String line,
 
   /**
    * Check that text line starts with single dollar chars
-   * @param line text line to be examined, must not be null
+   *
+   * @param line               text line to be examined, must not be null
    * @param allowedWhitespaces if true then whitespaces allowed after line comment
    * @return true if the line starts with single dollar chars, false otherwise
    * @since 7.0.6
    */
-  public static boolean isSingleDollarPrefixed(final String line, final boolean allowedWhitespaces) {
+  public static boolean isSingleDollarPrefixed(final String line,
+                                               final boolean allowedWhitespaces) {
     if (allowedWhitespaces) {
       return DIRECTIVE_SINGLE_DOLLAR_PREFIXED.matcher(line).matches();
     } else {
@@ -180,7 +185,8 @@ public static boolean isSingleDollarPrefixed(final String line, final boolean al
 
   /**
    * Allows to check that a text line can be considered as a JCP directive or special line.
-   * @param line text line to be examined
+   *
+   * @param line               text line to be examined
    * @param allowedWhitespaces if true then whitespaces allowed after line comment
    * @return true if the line can be considered as JCP one, false otherwise
    * @since 7.0.6
@@ -193,7 +199,7 @@ public static boolean isJcpCommentLine(final String line, final boolean allowedW
   /**
    * Check that a text line contains comment directive.
    *
-   * @param line string to be examined
+   * @param line             string to be examined
    * @param allowWhitespaces flag to allow spaces betwee hash and started comment chars
    * @return true if the line contains a directive, false otherwise
    * @since 7.0.6
@@ -395,13 +401,33 @@ private String extractSingleDollarPrefixedDirective(final String line,
     return tail;
   }
 
-  private void flushTextBufferForRemovedComments(final StringBuilder text,
+  private void flushTextBufferForRemovedComments(final StringBuilder textBuffer,
                                                  final ResetablePrinter resetablePrinter,
+                                                 final PreprocessingState state,
                                                  final PreprocessorContext context)
       throws IOException {
-    if (text.length() > 0) {
-      resetablePrinter.print(text.toString());
-      text.setLength(0);
+    if (textBuffer.length() > 0) {
+      final List<CommentTextProcessor> processors = context.getCommentTextProcessors();
+      final String origText = textBuffer.toString();
+      textBuffer.setLength(0);
+      String text = origText;
+
+      if (!processors.isEmpty()) {
+        processors.forEach(x -> {
+          try {
+            final String result = x.processCommentText(origText, this, context, state);
+            textBuffer.append(result);
+          } catch (Exception ex) {
+            throw new PreprocessorException(
+                "Error during external comment text processor call",
+                origText, state.makeIncludeStack(), ex);
+          }
+        });
+
+        text = textBuffer.toString();
+        textBuffer.setLength(0);
+      }
+      resetablePrinter.print(text);
     }
   }
 
@@ -457,7 +483,7 @@ public PreprocessingState preprocessFile(final PreprocessingState state,
         }
 
         if (rawString == null) {
-          this.flushTextBufferForRemovedComments(textBlockBuffer, thePrinter, context);
+          this.flushTextBufferForRemovedComments(textBlockBuffer, thePrinter, state, context);
           lastTextFileDataContainer = preprocessingState.popTextContainer();
           if (preprocessingState.isIncludeStackEmpty()) {
             break;
@@ -485,7 +511,7 @@ public PreprocessingState preprocessFile(final PreprocessingState state,
         final boolean doPrintLn = presentedNextLine || !context.isCareForLastEol();
 
         if (isHashPrefixed(stringToBeProcessed, context)) {
-          this.flushTextBufferForRemovedComments(textBlockBuffer, thePrinter, context);
+          this.flushTextBufferForRemovedComments(textBlockBuffer, thePrinter, state, context);
           final String extractedDirective =
               extractHashPrefixedDirective(stringToBeProcessed, context);
           switch (processDirective(preprocessingState, extractedDirective, context, false)) {
@@ -522,7 +548,8 @@ public PreprocessingState preprocessFile(final PreprocessingState state,
         if (preprocessingState.isDirectiveCanBeProcessed() &&
             !preprocessingState.getPreprocessingFlags()
                 .contains(PreprocessingFlag.TEXT_OUTPUT_DISABLED)) {
-          final boolean startsWithTwoDollars = isDoubleDollarPrefixed(leftTrimmedString, context.isAllowWhitespaces());
+          final boolean startsWithTwoDollars =
+              isDoubleDollarPrefixed(leftTrimmedString, context.isAllowWhitespaces());
 
           if (!startsWithTwoDollars) {
             stringToBeProcessed = PreprocessorUtils.processMacroses(leftTrimmedString, context);
@@ -540,12 +567,12 @@ public PreprocessingState preprocessFile(final PreprocessingState state,
                 textBlockBuffer.append(context.getEol());
               }
             } else {
-              this.flushTextBufferForRemovedComments(textBlockBuffer, thePrinter, context);
+              this.flushTextBufferForRemovedComments(textBlockBuffer, thePrinter, state, context);
               textBlockBuffer.append(stringPrefix).append(text);
               if (doPrintLn) {
                 textBlockBuffer.append(context.getEol());
               }
-              this.flushTextBufferForRemovedComments(textBlockBuffer, thePrinter, context);
+              this.flushTextBufferForRemovedComments(textBlockBuffer, thePrinter, state, context);
             }
           } else if (isSingleDollarPrefixed(stringToBeProcessed, context.isAllowWhitespaces())) {
             // Output the tail of the string to the output stream without comments
@@ -560,16 +587,16 @@ public PreprocessingState preprocessFile(final PreprocessingState state,
                 textBlockBuffer.append(context.getEol());
               }
             } else {
-              this.flushTextBufferForRemovedComments(textBlockBuffer, thePrinter, context);
+              this.flushTextBufferForRemovedComments(textBlockBuffer, thePrinter, state, context);
               textBlockBuffer.append(stringPrefix).append(text);
               if (doPrintLn) {
                 textBlockBuffer.append(context.getEol());
               }
-              this.flushTextBufferForRemovedComments(textBlockBuffer, thePrinter, context);
+              this.flushTextBufferForRemovedComments(textBlockBuffer, thePrinter, state, context);
             }
           } else {
             // Just string
-            this.flushTextBufferForRemovedComments(textBlockBuffer, thePrinter, context);
+            this.flushTextBufferForRemovedComments(textBlockBuffer, thePrinter, state, context);
 
             final String strToOut = findTailRemover(stringToBeProcessed, context);
 
@@ -588,7 +615,7 @@ public PreprocessingState preprocessFile(final PreprocessingState state,
             }
           }
         } else if (context.isKeepLines()) {
-          flushTextBufferForRemovedComments(textBlockBuffer, thePrinter, context);
+          flushTextBufferForRemovedComments(textBlockBuffer, thePrinter, state, context);
           final String text = AbstractDirectiveHandler.PREFIX_FOR_KEEPING_LINES + rawString;
           if (doPrintLn) {
             thePrinter.println(text, context.getEol());

jcp/src/main/java/com/igormaznitsa/jcp/context/CommentTextProcessor.java

@@ -0,0 +1,30 @@
+package com.igormaznitsa.jcp.context;
+
+import com.igormaznitsa.jcp.containers.FileInfoContainer;
+import java.io.IOException;
+
+/**
+ * Custom processor to detect and process text line or text block
+ * defined through //$ and //$$ directives. It can return the same value or
+ * changed one.
+ *
+ * @since 7.2.0
+ */
+@FunctionalInterface
+public interface CommentTextProcessor {
+  /**
+   * Process text value.
+   *
+   * @param text              the source text
+   * @param fileInfoContainer the source file info container, must not be null
+   * @param context           the source preprocessor context, must not be null
+   * @param state             the current preprocess state, must not be null
+   * @return must return value as the same text or as the changed one.
+   * @throws IOException if any IO error during operation
+   */
+  String processCommentText(
+      String text,
+      FileInfoContainer fileInfoContainer,
+      PreprocessorContext context,
+      PreprocessingState state) throws IOException;
+}