added way to find PreprocessorExtension and SpecialVariableProcessor among Java services

Author: raydac

changelog.txt

@@ -1,5 +1,6 @@
 __7.3.0 (SNAPSHOT)__
 
+- added way to find `PreprocessorExtension` and `SpecialVariableProcessor` among Java services
 - refactoring of API for `SpecialVariableProcessor` and `CommentTextProcessor`
 - replaced single string property `actionPreprocessorExtension` by string list `actionPreprocessorExtensions` to provide way for many preprocessor extensions.
 - internal refactoring

jcp/src/main/java/com/igormaznitsa/jcp/JcpPreprocessor.java

@@ -22,7 +22,7 @@
 package com.igormaznitsa.jcp;
 
 import static com.igormaznitsa.jcp.InfoHelper.makeTextForHelpInfo;
-import static com.igormaznitsa.jcp.utils.PreprocessorUtils.findAndInstantiateAllServices;
+import static com.igormaznitsa.jcp.utils.PreprocessorUtils.fillContextByFoundServices;
 import static com.igormaznitsa.jcp.utils.PreprocessorUtils.readWholeTextFileIntoArray;
 import static com.igormaznitsa.jcp.utils.PreprocessorUtils.throwPreprocessorException;
 
@@ -51,7 +51,6 @@
 import com.igormaznitsa.jcp.cmdline.UnknownAsFalseHandler;
 import com.igormaznitsa.jcp.cmdline.VerboseHandler;
 import com.igormaznitsa.jcp.containers.FileInfoContainer;
-import com.igormaznitsa.jcp.context.CommentTextProcessor;
 import com.igormaznitsa.jcp.context.PreprocessingState;
 import com.igormaznitsa.jcp.context.PreprocessorContext;
 import com.igormaznitsa.jcp.directives.ExcludeIfDirectiveHandler;
@@ -73,7 +72,6 @@
 import java.util.Locale;
 import java.util.Objects;
 import java.util.Set;
-import java.util.stream.Collectors;
 import lombok.Data;
 import org.apache.commons.io.FileUtils;
 import org.apache.commons.io.FilenameUtils;
@@ -192,14 +190,7 @@ private static PreprocessorContext processCommandLine(final File baseDir,
       }
     }
 
-    final List<CommentTextProcessor> commentTextProcessors = findAndInstantiateAllServices(
-        CommentTextProcessor.class);
-    if (!commentTextProcessors.isEmpty()) {
-      System.out.printf("Detected comment text processors: %s%n",
-          commentTextProcessors.stream().map(x -> x.getClass().getCanonicalName())
-              .collect(Collectors.joining(",")));
-      commentTextProcessors.forEach(result::addCommentTextProcessor);
-    }
+    fillContextByFoundServices(result);
 
     return result;
   }

jcp/src/main/java/com/igormaznitsa/jcp/ant/PreprocessTask.java

@@ -21,11 +21,10 @@
 
 package com.igormaznitsa.jcp.ant;
 
-import static com.igormaznitsa.jcp.utils.PreprocessorUtils.findAndInstantiateAllServices;
+import static com.igormaznitsa.jcp.utils.PreprocessorUtils.fillContextByFoundServices;
 
 import com.igormaznitsa.jcp.JcpPreprocessor;
 import com.igormaznitsa.jcp.context.CommentRemoverType;
-import com.igormaznitsa.jcp.context.CommentTextProcessor;
 import com.igormaznitsa.jcp.context.PreprocessorContext;
 import com.igormaznitsa.jcp.context.SpecialVariableProcessor;
 import com.igormaznitsa.jcp.exceptions.PreprocessorException;
@@ -188,20 +187,11 @@ PreprocessorContext makePreprocessorContext() {
                   x.trim())));
     }
 
-    final List<CommentTextProcessor> commentTextProcessors = findAndInstantiateAllServices(
-        CommentTextProcessor.class);
-    if (!commentTextProcessors.isEmpty()) {
-      info(String.format("Detected %d external comment text processing services",
-          commentTextProcessors.size()));
-      info(String.format("Detected comment text processors: %s",
-          commentTextProcessors.stream().map(x -> x.getClass().getCanonicalName())
-              .collect(Collectors.joining(","))));
-      commentTextProcessors.forEach(context::addCommentTextProcessor);
-    }
-
     this.registerConfigFiles(context);
     this.fillGlobalVars(context);
 
+    fillContextByFoundServices(context);
+
     return context;
   }
 

jcp/src/main/java/com/igormaznitsa/jcp/gradle/JcpTask.java

@@ -1,12 +1,11 @@
 package com.igormaznitsa.jcp.gradle;
 
-import static com.igormaznitsa.jcp.utils.PreprocessorUtils.findAndInstantiateAllServices;
+import static com.igormaznitsa.jcp.utils.PreprocessorUtils.fillContextByFoundServices;
 import static com.igormaznitsa.jcp.utils.PreprocessorUtils.findAndInstantiatePreprocessorExtensionForClassName;
 import static com.igormaznitsa.jcp.utils.PreprocessorUtils.findCommentRemoverForId;
 import static java.util.Collections.emptyMap;
 
 import com.igormaznitsa.jcp.JcpPreprocessor;
-import com.igormaznitsa.jcp.context.CommentTextProcessor;
 import com.igormaznitsa.jcp.context.PreprocessorContext;
 import com.igormaznitsa.jcp.expression.Value;
 import com.igormaznitsa.jcp.logger.PreprocessorLogger;
@@ -456,6 +455,8 @@ public void warning(final String message) {
     preprocessorContext.setUnknownVariableAsFalse(this.unknownVarAsFalse.get());
     preprocessorContext.setVerbose(this.verbose.get());
 
+    fillContextByFoundServices(preprocessorContext);
+
     if (!this.actionPreprocessorExtensions.get().isEmpty()) {
       this.actionPreprocessorExtensions.get()
           .forEach(x -> {
@@ -467,17 +468,6 @@ public void warning(final String message) {
           });
     }
 
-    final List<CommentTextProcessor> commentTextProcessors = findAndInstantiateAllServices(
-        CommentTextProcessor.class);
-    if (!commentTextProcessors.isEmpty()) {
-      logger.info("Detected {} external comment text processing services",
-          commentTextProcessors.size());
-      logger.info("Detected comment text processors: {}",
-          commentTextProcessors.stream().map(x -> x.getClass().getCanonicalName())
-              .collect(Collectors.joining(",")));
-      commentTextProcessors.forEach(preprocessorContext::addCommentTextProcessor);
-    }
-
     this.vars.getOrElse(emptyMap()).entrySet().stream()
         .filter(e -> {
           if (e.getValue() == null) {

jcp/src/main/java/com/igormaznitsa/jcp/maven/PreprocessMojo.java

@@ -22,11 +22,10 @@
 package com.igormaznitsa.jcp.maven;
 
 import static com.igormaznitsa.jcp.utils.GetUtils.ensureNonNull;
-import static com.igormaznitsa.jcp.utils.PreprocessorUtils.findAndInstantiateAllServices;
+import static com.igormaznitsa.jcp.utils.PreprocessorUtils.fillContextByFoundServices;
 
 import com.igormaznitsa.jcp.JcpPreprocessor;
 import com.igormaznitsa.jcp.context.CommentRemoverType;
-import com.igormaznitsa.jcp.context.CommentTextProcessor;
 import com.igormaznitsa.jcp.context.PreprocessorContext;
 import com.igormaznitsa.jcp.exceptions.PreprocessorException;
 import com.igormaznitsa.jcp.expression.Value;
@@ -480,22 +479,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
       final PreprocessorContext context;
       try {
         context = makePreprocessorContext();
-        final List<CommentTextProcessor> commentTextProcessors = findAndInstantiateAllServices(
-            CommentTextProcessor.class);
-        if (!commentTextProcessors.isEmpty()) {
-          getLog().info("Detected " + commentTextProcessors.size() +
-              " external comment text processing services");
-          if (this.isVerbose()) {
-            getLog().info("Detected comment text processors: " +
-                commentTextProcessors.stream().map(x -> x.getClass().getCanonicalName())
-                    .collect(Collectors.joining(",")));
-          } else {
-            getLog().debug("Detected comment text processors: " +
-                commentTextProcessors.stream().map(x -> x.getClass().getCanonicalName())
-                    .collect(Collectors.joining(",")));
-          }
-          commentTextProcessors.forEach(context::addCommentTextProcessor);
-        }
+        fillContextByFoundServices(context);
       } catch (Exception ex) {
         final PreprocessorException newException =
             PreprocessorException.extractPreprocessorException(ex);

jcp/src/main/java/com/igormaznitsa/jcp/utils/PreprocessorUtils.java

@@ -28,7 +28,9 @@
 import com.igormaznitsa.jcp.containers.FileInfoContainer;
 import com.igormaznitsa.jcp.containers.TextFileDataContainer;
 import com.igormaznitsa.jcp.context.CommentRemoverType;
+import com.igormaznitsa.jcp.context.CommentTextProcessor;
 import com.igormaznitsa.jcp.context.PreprocessorContext;
+import com.igormaznitsa.jcp.context.SpecialVariableProcessor;
 import com.igormaznitsa.jcp.exceptions.FilePositionInfo;
 import com.igormaznitsa.jcp.exceptions.PreprocessorException;
 import com.igormaznitsa.jcp.expression.Expression;
@@ -113,6 +115,47 @@ public static Optional<FileInfoContainer> findLastActiveFileContainer(
         .flatMap(context::findFileInfoContainer);
   }
 
+  /**
+   * Find all services in class path and register them in provided context.
+   *
+   * @param context target context must not be null
+   * @since 7.3.0
+   */
+  public static void fillContextByFoundServices(final PreprocessorContext context) {
+    final List<CommentTextProcessor> commentTextProcessors = findAndInstantiateAllServices(
+        CommentTextProcessor.class);
+    if (!commentTextProcessors.isEmpty()) {
+      context.getPreprocessorLogger()
+          .info(String.format("Detected %d comment text processing service(s): %s",
+              commentTextProcessors.size(),
+              commentTextProcessors.stream().map(x -> x.getClass().getCanonicalName())
+                  .collect(Collectors.joining(","))));
+      commentTextProcessors.forEach(context::addCommentTextProcessor);
+    }
+
+    final List<SpecialVariableProcessor> specialVariableProcessors = findAndInstantiateAllServices(
+        SpecialVariableProcessor.class);
+    if (!specialVariableProcessors.isEmpty()) {
+      context.getPreprocessorLogger()
+          .info(String.format("Detected %d special variable service(s): %s",
+              specialVariableProcessors.size(),
+              specialVariableProcessors.stream().map(x -> x.getClass().getCanonicalName())
+                  .collect(Collectors.joining(","))));
+      specialVariableProcessors.forEach(context::registerSpecialVariableProcessor);
+    }
+
+    final List<PreprocessorExtension> preprocessorExtensions = findAndInstantiateAllServices(
+        PreprocessorExtension.class);
+    if (!preprocessorExtensions.isEmpty()) {
+      context.getPreprocessorLogger()
+          .info(String.format("Detected %d preprocessor extension service(s): %s",
+              preprocessorExtensions.size(),
+              preprocessorExtensions.stream().map(x -> x.getClass().getCanonicalName())
+                  .collect(Collectors.joining(","))));
+      preprocessorExtensions.forEach(context::addPreprocessorExtension);
+    }
+  }
+
   /**
    * Find and instantiate a preprocessor extension for its class name. <b>Class must have default constructor.</b>
    * The preprocessor extension will be called for action directives.