Added the #Var keyword

Author: LSafer

Intellij.md

@@ -122,6 +122,8 @@
         #Paste
         #TEXT
         #Text
+        #VAR
+        #Var
         #WITH
         #With
         #define
@@ -135,6 +137,7 @@
         #make
         #paste
         #text
+        #var
         #with
         ```
     - Ignore case: `unchecked`

README.md

@@ -1,7 +1,8 @@
 ### Jamplate is a C-style pre-processor that mainly made for Java.
 
 ## How To Use
- - `#define` to define a variable
+ - `#define` to define a constant (yet overridable) value to a specified address
+ - `#var` to define a variable (also overridable) value to a specified address
  - `#if` `#elif` `#else` to control the flow and `#endif` to close `#if` statements
  - `#text` for debugging purposes, makes plain text.
  - `#paste` to paste a variable defined in the scope it is located on. 

src/main/java/org/jamplate/parser/ScopeParser.java

@@ -27,7 +27,7 @@
  * The default jamplate parser that parses {@link String}s into {@link Scope}s.
  *
  * @author LSafer
- * @version 0.0.3
+ * @version 0.0.5
  * @since 0.0.1 ~2020.09.19
  */
 public class ScopeParser implements PollParser<Scope> {
@@ -37,6 +37,12 @@ public class ScopeParser implements PollParser<Scope> {
 	 * @since 0.0.2 ~2020.09.21
 	 */
 	protected static final Pattern COMMON_PARAMETERS_ARRAY = Pattern.compile("\\s*(?<PARAMETER>(?:[^|]|(?:(?<=\\\\)[|]))*\\S)\\s*(?=[|]|$)");
+	/**
+	 * Common pattern to extract definition parameters.
+	 *
+	 * @since 0.0.5 ~2020.09.22
+	 */
+	protected static final Pattern COMMON_PARAMETERS_DEF = Pattern.compile("^\\s*(?<ADDRESS>\\S+)\\s*(?<LOGIC>.*)$");
 	/**
 	 * Common pattern to extract single integer parameter.
 	 *
@@ -67,6 +73,7 @@ public class ScopeParser implements PollParser<Scope> {
 	 * @since 0.0.1 ~2020.09.20
 	 */
 	protected static final Pattern COMMON_PARAMETER_PAIR = Pattern.compile("\\s*(?<KEY>\\S+)\\s*:\\s*(?<LOGIC>\\S+)\\s*");
+
 	/**
 	 * A pattern that catches jamplate commands.
 	 *
@@ -85,7 +92,7 @@ public class ScopeParser implements PollParser<Scope> {
 	 *
 	 * @since 0.0.1 ~2020.09.20
 	 */
-	protected static final Pattern PATTERN_DEFINE_PARAMETERS = Pattern.compile("^\\s*(?<ADDRESS>\\S+)\\s*(?<LOGIC>.*)$");
+	protected static final Pattern PATTERN_DEFINE_PARAMETERS = ScopeParser.COMMON_PARAMETERS_DEF;
 
 	/**
 	 * A pattern to be used to detect {@link Elif} commands.
@@ -216,6 +223,19 @@ public class ScopeParser implements PollParser<Scope> {
 	 */
 	protected static final Pattern PATTERN_TEXT_PARAMETERS = Pattern.compile("^\\s*(?<TEXT>.*)$");
 
+	/**
+	 * A pattern to be used to detected {@link Var} commands.
+	 *
+	 * @since 0.0.5 ~2020.09.22
+	 */
+	protected static final Pattern PATTERN_VAR = Pattern.compile("^#VAR", Pattern.CASE_INSENSITIVE);
+	/**
+	 * A pattern to be used to extract the parameters of a {@link Var} command.
+	 *
+	 * @since 0.0.5 ~2020.09.22
+	 */
+	protected static final Pattern PATTERN_VAR_PARAMETER = ScopeParser.COMMON_PARAMETERS_DEF;
+
 	/**
 	 * A pattern to be used to detect {@link With} commands.
 	 *
@@ -309,6 +329,7 @@ public void parse(List poll) {
 		this.parseMakes(poll);
 		this.parsePastes(poll);
 		this.parseTexts(poll);
+		this.parseVars(poll);
 		this.parseWiths(poll);
 
 		//clear leftovers
@@ -348,7 +369,7 @@ protected void parseDefines(List poll) {
 					Matcher valueMatcher = ScopeParser.PATTERN_DEFINE_PARAMETERS.matcher(value);
 
 					if (valueMatcher.find()) {
-						//target value #DEFINE parameters only
+						//target valid #DEFINE parameters only
 						String address = valueMatcher.group("ADDRESS");
 						String logic = valueMatcher.group("LOGIC");
 
@@ -732,6 +753,48 @@ protected void parseTexts(List poll) {
 		}
 	}
 
+	/**
+	 * Parse all the var statements in a {@link String} in the given {@code poll} into {@link Var}
+	 * scopes.
+	 *
+	 * @param poll the poll to parse all the var statements in it.
+	 * @throws NullPointerException if the given {@code poll} is null.
+	 * @throws ParseException       if any parse exception occurs.
+	 * @since 0.0.1 ~2020.09.20
+	 */
+	protected void parseVars(List poll) {
+		Objects.requireNonNull(poll, "poll");
+
+		ListIterator iterator = poll.listIterator();
+		while (iterator.hasNext()) {
+			Object object = iterator.next();
+
+			if (object instanceof String) {
+				//target Strings only
+				String string = (String) object;
+				Matcher matcher = ScopeParser.PATTERN_VAR.matcher(string);
+
+				if (matcher.find()) {
+					//target #VAR commands only
+					String value = string.substring(matcher.end());
+					Matcher valueMatcher = ScopeParser.PATTERN_VAR_PARAMETER.matcher(value);
+
+					if (valueMatcher.find()) {
+						//target valid #VAR parameters only
+						String address = valueMatcher.group("ADDRESS");
+						String logic = valueMatcher.group("LOGIC");
+
+						//Replace
+						iterator.set(new Var(
+								address,
+								this.logic.parse(logic)
+						));
+					}
+				}
+			}
+		}
+	}
+
 	/**
 	 * Parse all the with statements in a {@link String} in the given {@code poll} into {@link With}
 	 * scopes.

src/main/java/org/jamplate/scope/Var.java

@@ -0,0 +1,136 @@
+/*
+ *	Copyright 2020 Cufy
+ *
+ *	Licensed 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 org.jamplate.scope;
+
+import org.jamplate.logic.Constant;
+import org.jamplate.logic.Logic;
+import org.jamplate.memory.ScopeMemory;
+
+import java.io.IOException;
+import java.util.Objects;
+
+/**
+ * A scope that defines a {@link Logic} to an address, and can be modified later.
+ *
+ * @author LSafer
+ * @version 0.0.5
+ * @since 0.0.5 ~2020.09.22
+ */
+public class Var extends AbstractScope {
+	/**
+	 * The address this scope is holding its {@link #value} to.
+	 *
+	 * @since 0.0.5 ~2020.09.22
+	 */
+	protected final String address;
+	/**
+	 * The value this scope is currently mapping to {@link #address}.
+	 *
+	 * @since 0.0.5 ~2020.09.22
+	 */
+	protected Logic value;
+
+	/**
+	 * Create a new scope that can hold a value to the given {@code address}.
+	 *
+	 * @param address the address the constructed scope is holding values to.
+	 * @throws NullPointerException if the given {@code address} is null.
+	 * @since 0.0.5 ~2020.09.22
+	 */
+	public Var(String address) {
+		Objects.requireNonNull(address, "address");
+		this.address = address;
+		this.value = new Constant("");
+	}
+
+	/**
+	 * Create a new scope that defines the given {@code value} to the given {@code address}. The
+	 * created scope's {@code value} can be replaced later.
+	 *
+	 * @param address the address to map the given {@code value} to.
+	 * @param value   the value the created scope will hold initially.
+	 * @throws NullPointerException if the given {@code address} or {@code value} is null.
+	 * @since 0.0.5 ~2020.09.22
+	 */
+	public Var(String address, Logic value) {
+		Objects.requireNonNull(address, "address");
+		Objects.requireNonNull(value, "value");
+		this.address = address;
+		this.value = value;
+	}
+
+	/**
+	 * Return the {@link #address} of this scope.
+	 *
+	 * @return the {@link #address} of this scope.
+	 * @since 0.0.5 ~2020.09.22
+	 */
+	public final String address() {
+		return this.address;
+	}
+
+	/**
+	 * Return the {@link #value} of this scope.
+	 *
+	 * @return the {@link #value} of this scope.
+	 * @since 0.0.5 ~2020.09.22
+	 */
+	public final Logic value() {
+		return this.value;
+	}
+
+	@Override
+	public synchronized Logic memory(String address) {
+		Objects.requireNonNull(address, "address");
+		return this.address.equals(address) ?
+			   this.value :
+			   super.memory(address);
+	}
+
+	@Override
+	protected Appendable invoke(Appendable appendable, ScopeMemory memory) throws IOException {
+		Objects.requireNonNull(appendable, "appendable");
+		Objects.requireNonNull(memory, "memory");
+
+		//little journey to previous scopes :)...
+		for (Scope scope = this.previous; scope != null; scope = scope.previous())
+			if (scope instanceof Var) {
+				//found someone that could understand me!
+				Var var = (Var) scope;
+
+				if (this.address.equals(var.address()))
+					//that was my brother
+					synchronized (this) {
+						//hay brother, could you please update your value and be like me?
+						var.value(this.value);
+					}
+			}
+
+		return super.invoke(appendable, memory);
+	}
+
+	/**
+	 * Update the {@link #value} of this scope.
+	 *
+	 * @param value the value of this scope.
+	 * @throws NullPointerException if the given {@code value} is null.
+	 * @since 0.0.5
+	 */
+	public synchronized void value(Logic value) {
+		Objects.requireNonNull(value, "value");
+		this.value = value;
+	}
+}