provided way to set special variables in //#local

Author: raydac

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

@@ -187,24 +187,35 @@ public Value getVariable(final String varName, final PreprocessorContext context
     }
   }
 
+  private void assertNotGlobalPhase(final String varName, final PreprocessorContext context) {
+    if (context.getPreprocessingState().isGlobalPhase()) {
+      throw context.makeException(
+          "Variable '" + varName + "' is not allowed to set during global phase", null);
+    }
+  }
+
   @Override
   public void setVariable(final String varName, final Value value,
                           final PreprocessorContext context) {
     final PreprocessingState state = context.getPreprocessingState();
     switch (varName) {
       case VAR_JCP_BUFFER_ALL: {
+        this.assertNotGlobalPhase(varName, context);
         state.setBufferText(value.toString());
       }
       break;
       case VAR_JCP_BUFFER_POSTFIX: {
+        this.assertNotGlobalPhase(varName, context);
         state.setBufferText(value.toString(), PreprocessingState.PrinterType.POSTFIX);
       }
       break;
       case VAR_JCP_BUFFER_MIDDLE: {
+        this.assertNotGlobalPhase(varName, context);
         state.setBufferText(value.toString(), PreprocessingState.PrinterType.NORMAL);
       }
       break;
       case VAR_JCP_BUFFER_PREFIX: {
+        this.assertNotGlobalPhase(varName, context);
         state.setBufferText(value.toString(), PreprocessingState.PrinterType.PREFIX);
       }
       break;

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

@@ -296,6 +296,7 @@ public Set<FileInfoContainer> findPreprocessedResources() {
 
   /**
    * Send notification about context start to all registered listeners.
+   *
    * @param initedList list accumulating successfully processed listeners, must not be immutable and must not be null
    * @since 7.2.0
    */
@@ -639,14 +640,19 @@ public PreprocessorContext setLocalVariable(final String name, final Value value
       throw makeException("Not defined variable name", null);
     }
 
-    if (mapVariableNameToSpecialVarProcessor.containsKey(normalized) ||
-        globalVarTable.containsKey(normalized)) {
+    if (this.mapVariableNameToSpecialVarProcessor.containsKey(normalized)) {
+      final SpecialVariableProcessor enabledProcessor =
+          findAllowedSpecialVariableProcessor(normalized)
+              .orElseThrow(() -> this.makeException("Set of local variable '" + normalized +
+                  "' is not allowed in the point by its processor", null));
+      enabledProcessor.setVariable(normalized, value, this);
+    } else if (this.globalVarTable.containsKey(normalized)) {
       throw makeException(
-          "Attempting to set either a global variable or a special variable as a local one [" +
+          "Cannot override global variable with a local variable of the same name [" +
               normalized + ']', null);
+    } else {
+      this.localVarTable.put(normalized, value);
     }
-
-    localVarTable.put(normalized, value);
     return this;
   }
 
@@ -754,10 +760,22 @@ public boolean containsLocalVariable(final String name) {
    * @return this preprocessor context
    */
   public PreprocessorContext clearLocalVariables() {
-    localVarTable.clear();
+    this.localVarTable.clear();
     return this;
   }
 
+  private Optional<SpecialVariableProcessor> findAllowedSpecialVariableProcessor(
+      final String normalizedName) {
+    return this.mapVariableNameToSpecialVarProcessor.get(normalizedName)
+        .stream()
+        .filter(x -> x.isAllowed(
+            findLastActiveFileContainer(this).orElse(null),
+            this.getPreprocessingState().findLastPositionInfoInStack().orElse(null),
+            this,
+            this.getPreprocessingState()
+        )).findFirst();
+  }
+
   /**
    * Set a global variable value
    *
@@ -779,22 +797,12 @@ public PreprocessorContext setGlobalVariable(final String name, final Value valu
 
     if (this.mapVariableNameToSpecialVarProcessor.containsKey(normalizedName)) {
       final SpecialVariableProcessor firstActiveProcessor =
-          this.mapVariableNameToSpecialVarProcessor.get(normalizedName)
-              .stream()
-              .filter(x -> x.isAllowed(
-                  findLastActiveFileContainer(this).orElse(null),
-                  this.getPreprocessingState().findLastPositionInfoInStack().orElse(null),
-                  this,
-                  this.getPreprocessingState()
-              )).findFirst().orElse(null);
-
-      if (firstActiveProcessor == null) {
-        throw this.makeException(
-            "Can't set special variable because no any allowed variable processor in the position",
-            null);
-      } else {
-        firstActiveProcessor.setVariable(normalizedName, value, this);
-      }
+          this.findAllowedSpecialVariableProcessor(normalizedName)
+              .orElseThrow(() -> this.makeException(
+                  "Cannot set special variable '" + normalizedName +
+                      "' no valid processor available here, may be it is read only",
+                  null));
+      firstActiveProcessor.setVariable(normalizedName, value, this);
     } else {
       if (isVerbose()) {
         final String valueAsStr = value.toString();

jcp/src/test/java/com/igormaznitsa/jcp/usecases/UsePrefixAsMultilineTest.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2002-2019 Igor Maznitsa (http://www.igormaznitsa.com)
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package com.igormaznitsa.jcp.usecases;
+
+import static org.junit.Assert.assertEquals;
+
+import com.igormaznitsa.jcp.JcpPreprocessor;
+import com.igormaznitsa.jcp.context.PreprocessorContext;
+
+public class UsePrefixAsMultilineTest extends AbstractUseCaseTest {
+
+  @Override
+  public void check(PreprocessorContext context, JcpPreprocessor.Statistics stat) throws Exception {
+    assertEquals(0, stat.getCopied());
+    assertEquals(1, stat.getPreprocessed());
+  }
+
+}

jcp/src/test/resources/com/igormaznitsa/jcp/usecases/TextBufferVariablesTest/etl/text.txt

@@ -1,7 +1,4 @@
-Some block text which
-will be placed into a variable as multiline text
-and prefix buffer is used to accumulate it
----
+set prefix---
 Some block text which
 will be placed into a variable as multiline text
 and prefix buffer is used to accumulate it
@@ -15,4 +12,4 @@ and prefix buffer is used to accumulate it
 ===
 
 ...
-defined postfix
+set postfix

jcp/src/test/resources/com/igormaznitsa/jcp/usecases/TextBufferVariablesTest/src/text.txt

@@ -7,8 +7,8 @@ will be placed into a variable as multiline text
 and prefix buffer is used to accumulate it
 //#prefix-
 //#local multiline_prefix = jcp.text.buffer.prefix
-//#global jcp.text.buffer.prefix="set prefix"
-//#global jcp.text.buffer.postfix="set postfix"
+//#local jcp.text.buffer.prefix="set prefix"
+//#local jcp.text.buffer.postfix="set postfix"
 ---
 //$/*$multiline_prefix$*/
 ===

jcp/src/test/resources/com/igormaznitsa/jcp/usecases/UsePrefixAsMultilineTest/etl/text.txt

@@ -0,0 +1,13 @@
+package test;
+
+public class Main {
+ public static final int mul(int a, b) {
+     return a * b;
+ }
+
+
+ public static final int div(int a, b) {
+     return a / b;
+ }
+
+}

jcp/src/test/resources/com/igormaznitsa/jcp/usecases/UsePrefixAsMultilineTest/src/text.txt

@@ -0,0 +1,21 @@
+//#prefix+
+//$ public static final int mul(int a, b) {
+//$     return a * b;
+//$ }
+//#prefix-
+//#postfix+
+//$ public static final int div(int a, b) {
+//$     return a / b;
+//$ }
+//#postfix-
+//#local mul_func = jcp.text.buffer.prefix
+//#local div_func = jcp.text.buffer.postfix
+//#local jcp.text.buffer.prefix = ""
+//#local jcp.text.buffer.postfix = ""
+package test;
+
+public class Main {
+/*$mul_func$*/
+
+/*$div_func$*/
+}