#48 added way to define custom class through its name as action preprocessor extension

raydac · raydac · commit 3a5dadc00125 · 2024-05-26T15:55:55.000+03:00
diff --git a/jcp-tests/jcp-test-android/app/build.gradle b/jcp-tests/jcp-test-android/app/build.gradle
@@ -43,6 +43,7 @@ dependencies {
 preprocess {
     sources = android.sourceSets.main.java.srcDirs
     keepComments = false
+    actionPreprocessorExtension = "com.igormaznitsa.jcp.extension.LogPreprocessorExtension"
     vars = [
             'action.text'  : 'Non-secret action!',
             'remove.secret': 'true'
diff --git a/jcp-tests/jcp-test-ant/src/test/resources/build.xml b/jcp-tests/jcp-test-ant/src/test/resources/build.xml
@@ -20,6 +20,7 @@
                 targetEncoding="UTF-8"
                 preserveIndents="true"
                 dontOverwriteSameContent="false"
+                actionPreprocessorExtension="com.igormaznitsa.jcp.extension.LogPreprocessorExtension"
         >
             <excludeFolders>
                 <folder>**/excluded1</folder>
diff --git a/jcp-tests/jcp-test-gradle-5/build.gradle b/jcp-tests/jcp-test-gradle-5/build.gradle
@@ -56,6 +56,7 @@ preprocess {
     allowWhitespaces = true
     preserveIndents = true
     dontOverwriteSameContent = false
+    actionPreprocessorExtension = "com.igormaznitsa.jcp.extension.LogPreprocessorExtension"
     vars = ['some.test.global': 'Some Test Global Value']
 }
 task(changeSourceFolder) {
diff --git a/jcp-tests/jcp-test-gradle-6/build.gradle b/jcp-tests/jcp-test-gradle-6/build.gradle
@@ -56,6 +56,7 @@ preprocess {
     allowWhitespaces = true
     preserveIndents = true
     dontOverwriteSameContent = false
+    actionPreprocessorExtension = "com.igormaznitsa.jcp.extension.LogPreprocessorExtension"
     vars = ['some.test.global': 'Some Test Global Value']
 }
 task(changeSourceFolder) {
diff --git a/jcp-tests/jcp-test-gradle-7/build.gradle b/jcp-tests/jcp-test-gradle-7/build.gradle
@@ -56,6 +56,7 @@ preprocess {
     allowWhitespaces = true
     preserveIndents = true
     dontOverwriteSameContent = false
+    actionPreprocessorExtension = "com.igormaznitsa.jcp.extension.LogPreprocessorExtension"
     vars = ['some.test.global': 'Some Test Global Value']
 }
 task(changeSourceFolder) {
diff --git a/jcp-tests/jcp-test-gradle-8/build.gradle b/jcp-tests/jcp-test-gradle-8/build.gradle
@@ -56,6 +56,7 @@ preprocess {
     allowWhitespaces = true
     preserveIndents = true
     dontOverwriteSameContent = false
+    actionPreprocessorExtension = "com.igormaznitsa.jcp.extension.LogPreprocessorExtension"
     vars = ['some.test.global': 'Some Test Global Value']
 }
 task(changeSourceFolder) {
diff --git a/jcp-tests/jcp-test-maven/pom.xml b/jcp-tests/jcp-test-maven/pom.xml
@@ -47,6 +47,8 @@
               <vars>
                 <some.test.global>Some Test Global Value</some.test.global>
               </vars>
+              <actionPreprocessorExtension>com.igormaznitsa.jcp.extension.LogPreprocessorExtension
+              </actionPreprocessorExtension>
               <sourceEncoding>UTF-8</sourceEncoding>
               <targetEncoding>UTF-8</targetEncoding>
               <ignoreMissingSources>false</ignoreMissingSources>
diff --git a/jcp-tests/jcp-test-maven/src/main/java/com/igormaznitsa/jcp/it/maven/Main.java b/jcp-tests/jcp-test-maven/src/main/java/com/igormaznitsa/jcp/it/maven/Main.java
@@ -3,6 +3,7 @@
 
 //$public class MainTwo {
 //#//
+//#action 1,2,3
 public class Main {
 
   //$$public MainTwo(){
@@ -25,6 +26,7 @@ public Main(){
     }
   }
 
+  //#action $hello1("getProperty")
   public String getProperty() {
     return "/*$mvn.project.property.my.custom.property$*/";
   }
diff --git a/jcp/src/main/java/com/igormaznitsa/jcp/JcpPreprocessor.java b/jcp/src/main/java/com/igormaznitsa/jcp/JcpPreprocessor.java
@@ -25,6 +25,7 @@
 import static com.igormaznitsa.jcp.utils.PreprocessorUtils.readWholeTextFileIntoArray;
 import static com.igormaznitsa.jcp.utils.PreprocessorUtils.throwPreprocessorException;
 
+import com.igormaznitsa.jcp.cmdline.ActionPreprocessorExtensionHandler;
 import com.igormaznitsa.jcp.cmdline.AllowWhitespaceDirectiveHandler;
 import com.igormaznitsa.jcp.cmdline.CareForLastEolHandler;
 import com.igormaznitsa.jcp.cmdline.ClearTargetHandler;
@@ -104,6 +105,7 @@ public final class JcpPreprocessor {
       new PreserveIndentDirectiveHandler(),
       new ExcludeFoldersHandler(),
       new KeepAttributesHandler(),
+      new ActionPreprocessorExtensionHandler(),
       new UnknownAsFalseHandler()
   };
   private final PreprocessorContext context;
diff --git a/jcp/src/main/java/com/igormaznitsa/jcp/ant/PreprocessTask.java b/jcp/src/main/java/com/igormaznitsa/jcp/ant/PreprocessTask.java
@@ -78,6 +78,7 @@ public class PreprocessTask extends Task implements PreprocessorLogger, SpecialV
   private boolean allowWhitespaces = false;
   private boolean preserveIndents = false;
   private boolean dontOverwriteSameContent = false;
+  private String actionPreprocessorExtension = null;
   private Map<String, Value> antVariables = new HashMap<>();
 
   private void registerConfigFiles(final PreprocessorContext context) {
@@ -169,6 +170,13 @@ PreprocessorContext makePreprocessorContext() {
       );
     }
 
+    if (this.getActionPreprocessorExtension() != null) {
+      info("Instantiating action preprocessor extension: " + this.getActionPreprocessorExtension());
+      context.setPreprocessorExtension(
+          PreprocessorUtils.findAndInstantiatePreprocessorExtensionForClassName(
+              this.getActionPreprocessorExtension().trim()));
+    }
+
     this.registerConfigFiles(context);
     this.fillGlobalVars(context);
 
diff --git a/jcp/src/main/java/com/igormaznitsa/jcp/cmdline/ActionPreprocessorExtensionHandler.java b/jcp/src/main/java/com/igormaznitsa/jcp/cmdline/ActionPreprocessorExtensionHandler.java
@@ -0,0 +1,40 @@
+package com.igormaznitsa.jcp.cmdline;
+
+import com.igormaznitsa.jcp.context.PreprocessorContext;
+import com.igormaznitsa.jcp.extension.PreprocessorExtension;
+import com.igormaznitsa.jcp.utils.PreprocessorUtils;
+import java.util.Locale;
+
+public class ActionPreprocessorExtensionHandler implements CommandLineHandler {
+
+  private static final String ARG_NAME = "/EA:";
+
+  @Override
+  public String getDescription() {
+    return "class to be used for action directives, the class must be in the classpath and contain default constructor.";
+  }
+
+  @Override
+  public boolean processCommandLineKey(final String key, final PreprocessorContext context) {
+    boolean result = false;
+
+    if (!key.isEmpty() && key.toUpperCase(Locale.ENGLISH).startsWith(ARG_NAME)) {
+      final String tail = PreprocessorUtils.extractTrimmedTail(ARG_NAME, key);
+
+      if (tail.isEmpty()) {
+        result = true;
+      } else {
+        final PreprocessorExtension preprocessorExtension =
+            PreprocessorUtils.findAndInstantiatePreprocessorExtensionForClassName(tail);
+        context.setPreprocessorExtension(preprocessorExtension);
+        result = true;
+      }
+    }
+    return result;
+  }
+
+  @Override
+  public String getKeyName() {
+    return ARG_NAME;
+  }
+}
diff --git a/jcp/src/main/java/com/igormaznitsa/jcp/cmdline/ExcludedFileExtensionsHandler.java b/jcp/src/main/java/com/igormaznitsa/jcp/cmdline/ExcludedFileExtensionsHandler.java
@@ -39,7 +39,7 @@ public class ExcludedFileExtensionsHandler implements CommandLineHandler {
   @Override
   public String getDescription() {
     return
-        "comma separated file extensions (case insensetive) to be excluded from preprocess and copy (by default " +
+        "comma separated file extensions (case insensitive) to be excluded from preprocess and copy (by default " +
             String.join(",", PreprocessorContext.DEFAULT_EXCLUDED_EXTENSIONS) + ')';
   }
 
diff --git a/jcp/src/main/java/com/igormaznitsa/jcp/directives/ActionDirectiveHandler.java b/jcp/src/main/java/com/igormaznitsa/jcp/directives/ActionDirectiveHandler.java
@@ -34,7 +34,6 @@
 import java.io.StringReader;
 import java.util.ArrayList;
 import java.util.List;
-import java.util.Objects;
 
 /**
  * The class implements the //#action directive handler
@@ -44,25 +43,21 @@
 public class ActionDirectiveHandler extends AbstractDirectiveHandler {
 
   @Override
-
   public String getName() {
     return "action";
   }
 
   @Override
-
   public String getReference() {
     return "call user extension with comma separated arguments";
   }
 
   @Override
-
   public DirectiveArgumentType getArgumentType() {
     return DirectiveArgumentType.MULTIEXPRESSION;
   }
 
   @Override
-
   public AfterDirectiveProcessingBehaviour execute(final String string,
                                                    final PreprocessorContext context) {
     if (context.getPreprocessorExtension() != null) {
@@ -77,9 +72,14 @@ public AfterDirectiveProcessingBehaviour execute(final String string,
           results[index++] = val;
         }
 
-        if (!Objects.requireNonNull(context.getPreprocessorExtension())
-            .processAction(context, results)) {
-          throw context.makeException("Extension can't process action ", null);
+        if (context.getPreprocessorExtension() == null) {
+          throw context.makeException(
+              "Detected action directive but there is no any provided action preprocessor extension to process it",
+              null);
+        }
+
+        if (!context.getPreprocessorExtension().processAction(context, results)) {
+          throw context.makeException("Unable to process an action", null);
         }
       } catch (IOException ex) {
         throw context.makeException("Unexpected string detected [" + string + ']', ex);
diff --git a/jcp/src/main/java/com/igormaznitsa/jcp/exceptions/PreprocessorException.java b/jcp/src/main/java/com/igormaznitsa/jcp/exceptions/PreprocessorException.java
@@ -35,7 +35,7 @@ public class PreprocessorException extends RuntimeException {
   private static final long serialVersionUID = 2857499664112391862L;
 
   private final String processingString;
-  private transient final FilePositionInfo[] includeStack;
+  private final transient FilePositionInfo[] includeStack;
 
   public PreprocessorException(final String message, final String processedText,
                                final FilePositionInfo[] includeStack, final Throwable cause) {
@@ -139,7 +139,7 @@ public int getLineNumber() {
 
 
   public String getProcessingString() {
-    return processingString;
+    return this.processingString;
   }
 
 
diff --git a/jcp/src/main/java/com/igormaznitsa/jcp/expression/functions/FunctionDefinedByUser.java b/jcp/src/main/java/com/igormaznitsa/jcp/expression/functions/FunctionDefinedByUser.java
@@ -74,7 +74,7 @@ public int getArity() {
   public Value execute(final PreprocessorContext context, final Value[] values) {
     return Objects.requireNonNull(
         context.getPreprocessorExtension(), "Preprocessor extension must not be null")
-        .processUserFunction(name, values);
+        .processUserFunction(context, name, values);
   }
 
   @Override
diff --git a/jcp/src/main/java/com/igormaznitsa/jcp/extension/LogPreprocessorExtension.java b/jcp/src/main/java/com/igormaznitsa/jcp/extension/LogPreprocessorExtension.java
@@ -0,0 +1,61 @@
+package com.igormaznitsa.jcp.extension;
+
+
+import com.igormaznitsa.jcp.containers.TextFileDataContainer;
+import com.igormaznitsa.jcp.context.PreprocessorContext;
+import com.igormaznitsa.jcp.expression.Value;
+import java.util.Arrays;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+/**
+ * Preprocessor extension which just make info logging for arguments of action calls and also
+ * can log user function calls, their arity should be provided in the end of function name like '$hello2(1,2)'
+ *
+ * @since 7.1.2
+ */
+public class LogPreprocessorExtension implements PreprocessorExtension {
+
+  private static final Pattern PATTERN = Pattern.compile("^(\\D+)(\\d+)?$");
+
+  private static String findPosition(final PreprocessorContext context) {
+    if (context == null) {
+      return "";
+    }
+    if (context.getPreprocessingState().getCurrentIncludeStack().isEmpty()) {
+      return "";
+    } else {
+      final TextFileDataContainer dataContainer =
+          context.getPreprocessingState().getCurrentIncludeStack().get(0);
+      return (dataContainer.getFile() == null ? "<unknown>" : dataContainer.getFile().getName())
+          + ':'
+          + (dataContainer.getLastReadStringIndex() + 1);
+    }
+  }
+
+  @Override
+  public boolean processAction(final PreprocessorContext context, final Value[] parameters) {
+    context.logInfo(String.format("Called action: %s at %s", Arrays.toString(parameters),
+        findPosition(context)));
+    return true;
+  }
+
+  @Override
+  public Value processUserFunction(final PreprocessorContext context, final String functionName,
+                                   final Value[] arguments) {
+    context.logInfo(
+        String.format("Called user function '%s'(%s) at %s",
+            functionName, Arrays.toString(arguments),
+            findPosition(context)));
+    return Value.BOOLEAN_TRUE;
+  }
+
+  @Override
+  public int getUserFunctionArity(final String functionName) {
+    final Matcher matcher = PATTERN.matcher(functionName);
+    if (matcher.find() && matcher.group(2) != null) {
+      return Integer.parseInt(matcher.group(2));
+    }
+    return 0;
+  }
+}
diff --git a/jcp/src/main/java/com/igormaznitsa/jcp/extension/PreprocessorExtension.java b/jcp/src/main/java/com/igormaznitsa/jcp/extension/PreprocessorExtension.java
@@ -50,9 +50,29 @@ public interface PreprocessorExtension {
    *                     must not be null
    * @param arguments    the function arguments as an array, must not be null
    * @return a calculated value, it must not be null
+   * @see #processUserFunction(PreprocessorContext, String, Value[])
+   * @deprecated since 7.1.2
    */
+  @Deprecated
+  default Value processUserFunction(String functionName, Value[] arguments) {
+    throw new UnsupportedOperationException("Use version with PreprocessorContext for call");
+  }
 
-  Value processUserFunction(String functionName, Value[] arguments);
+  /**
+   * Call to process a user function (such functions start with $)
+   *
+   * @param context      the current preprocessor context, must not be null
+   * @param functionName the name of the function (without $ and in low case),
+   *                     must not be null
+   * @param arguments    the function arguments as an array, must not be null
+   * @return a calculated value, it must not be null
+   * @see #processUserFunction(String, Value[])
+   * @since 7.1.2
+   */
+  default Value processUserFunction(PreprocessorContext context, String functionName,
+                                    Value[] arguments) {
+    return this.processUserFunction(functionName, arguments);
+  }
 
   /**
    * When a preprocessor meets a user defined function (the function starts with
diff --git a/jcp/src/main/java/com/igormaznitsa/jcp/gradle/JcpTask.java b/jcp/src/main/java/com/igormaznitsa/jcp/gradle/JcpTask.java
@@ -1,5 +1,6 @@
 package com.igormaznitsa.jcp.gradle;
 
+import static com.igormaznitsa.jcp.utils.PreprocessorUtils.findAndInstantiatePreprocessorExtensionForClassName;
 import static com.igormaznitsa.jcp.utils.PreprocessorUtils.findCommentRemoverForId;
 import static java.util.Collections.emptyMap;
 
@@ -66,6 +67,12 @@ public class JcpTask extends DefaultTask {
    * Encoding for text write operations.
    */
   private final Property<String> targetEncoding;
+  /**
+   * Property contains preprocessor action extension class name or blank string if not provided.
+   *
+   * @since 7.1.2
+   */
+  private final Property<String> actionPreprocessorExtension;
   /**
    * Flag to ignore missing source folders, if false then mojo fail for any
    * missing source folder, if true then missing folder will be ignored.
@@ -157,6 +164,7 @@ public class JcpTask extends DefaultTask {
 
   @Inject
   public JcpTask(final ObjectFactory factory) {
+    this.actionPreprocessorExtension = factory.property(String.class).convention("");
     this.allowWhitespaces = factory.property(Boolean.class).convention(false);
     this.careForLastEol = factory.property(Boolean.class).convention(false);
     this.clearTarget = factory.property(Boolean.class).convention(false);
@@ -278,6 +286,11 @@ public Property<File> getBaseDir() {
     return baseDir;
   }
 
+  @Input
+  public Property<String> getActionPreprocessorExtension() {
+    return actionPreprocessorExtension;
+  }
+
   @Input
   public Property<Boolean> getCareForLastEol() {
     return careForLastEol;
@@ -415,6 +428,14 @@ public void warning(final String message) {
     preprocessorContext.setUnknownVariableAsFalse(this.unknownVarAsFalse.get());
     preprocessorContext.setVerbose(this.verbose.get());
 
+    if (!this.actionPreprocessorExtension.get().trim().isEmpty()) {
+      final String className = this.actionPreprocessorExtension.get().trim();
+      logger.info(
+          String.format("Detected action preprocessor extension class name: %s", className));
+      preprocessorContext.setPreprocessorExtension(
+          findAndInstantiatePreprocessorExtensionForClassName(className));
+    }
+
     this.vars.getOrElse(emptyMap()).entrySet().stream()
         .filter(e -> {
           if (e.getValue() == null) {
diff --git a/jcp/src/main/java/com/igormaznitsa/jcp/maven/PreprocessMojo.java b/jcp/src/main/java/com/igormaznitsa/jcp/maven/PreprocessMojo.java
diff --git a/jcp/src/main/java/com/igormaznitsa/jcp/utils/PreprocessorUtils.java b/jcp/src/main/java/com/igormaznitsa/jcp/utils/PreprocessorUtils.java
diff --git a/jcp/src/test/java/com/igormaznitsa/jcp/cmdline/ActionPreprocessorExtensionHandlerTest.java b/jcp/src/test/java/com/igormaznitsa/jcp/cmdline/ActionPreprocessorExtensionHandlerTest.java
diff --git a/jcp/src/test/java/com/igormaznitsa/jcp/expression/functions/FunctionDefinedByUserTest.java b/jcp/src/test/java/com/igormaznitsa/jcp/expression/functions/FunctionDefinedByUserTest.java
diff --git a/jcp/src/test/java/com/igormaznitsa/jcp/usecases/UserFunctionTest.java b/jcp/src/test/java/com/igormaznitsa/jcp/usecases/UserFunctionTest.java

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@`
`20`	`20`	`targetEncoding="UTF-8"`
`21`	`21`	`preserveIndents="true"`
`22`	`22`	`dontOverwriteSameContent="false"`
	`23`	`+ actionPreprocessorExtension="com.igormaznitsa.jcp.extension.LogPreprocessorExtension"`
`23`	`24`	`>`
`24`	`25`	`<excludeFolders>`
`25`	`26`	`<folder>**/excluded1</folder>`
Original file line number	Diff line number	Diff line change
`@@ -56,6 +56,7 @@ preprocess {`
`56`	`56`	`allowWhitespaces = true`
`57`	`57`	`preserveIndents = true`
`58`	`58`	`dontOverwriteSameContent = false`
	`59`	`+ actionPreprocessorExtension = "com.igormaznitsa.jcp.extension.LogPreprocessorExtension"`
`59`	`60`	`vars = ['some.test.global': 'Some Test Global Value']`
`60`	`61`	`}`
`61`	`62`	`task(changeSourceFolder) {`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`
`4`	`4`	`//$public class MainTwo {`
`5`	`5`	`//#//`
	`6`	`+//#action 1,2,3`
`6`	`7`	`public class Main {`
`7`	`8`
`8`	`9`	`//$$public MainTwo(){`
`@@ -25,6 +26,7 @@ public Main(){`
`25`	`26`	`}`
`26`	`27`	`}`
`27`	`28`
	`29`	`+ //#action $hello1("getProperty")`
`28`	`30`	`public String getProperty() {`
`29`	`31`	`return "/$mvn.project.property.my.custom.property$/";`
`30`	`32`	`}`