Add an additional, restricted type of context for use only by plugins.

2026-09-22 03:12:33 +00:00 · 2017-11-23 02:21:06 -08:00
parent 095d374949
commit 9fdb3fc0d9
16 changed files with 153 additions and 116 deletions
--- a/core/src/main/kotlin/org/nwapw/abacus/context/MutableEvaluationContext.kt
+++ b/core/src/main/kotlin/org/nwapw/abacus/context/MutableEvaluationContext.kt
@@ -9,14 +9,15 @@ import org.nwapw.abacus.tree.nodes.*

 /**
 * A reduction context that is mutable.
+ *
 * @param parent the parent of this context.
 * @param numberImplementation the number implementation used in this context.
- * @param reducer the reducer used in this context
+ * @param abacus the abacus instance used.
 */
 class MutableEvaluationContext(parent: EvaluationContext? = null,
                               numberImplementation: NumberImplementation? = null,
                               abacus: Abacus? = null) :
-        EvaluationContext(parent, numberImplementation, abacus) {
+        PluginEvaluationContext(parent, numberImplementation, abacus) {

    override var numberImplementation: NumberImplementation? = super.numberImplementation
    override var abacus: Abacus? = super.abacus
@@ -35,42 +36,11 @@ class MutableEvaluationContext(parent: EvaluationContext? = null,
        }
    }

-    /**
-     * Sets a variable to a certain [value].
-     * @param name the name of the variable.
-     * @param value the value of the variable.
-     */
-    fun setVariable(name: String, value: NumberInterface) {
-        variableMap[name] = value
-    }
-
-    /**
-     * Set a definition to a certain [value].
-     * @param name the name of the definition.
-     * @param value the value of the definition.
-     */
-    fun setDefinition(name: String, value: TreeNode) {
-        definitionMap[name] = value
-    }
-
-    /**
-     * Clears the variables defined in this context.
-     */
-    fun clearVariables(){
-        variableMap.clear()
-    }
-
-    /**
-     * Clears the definitions defined in this context.
-     */
-    fun clearDefinitions(){
-        definitionMap.clear()
-    }
-
    override fun reduceNode(treeNode: TreeNode, vararg children: Any): NumberInterface {
+        val oldNumberImplementation = numberImplementation
        val abacus = inheritedAbacus
        val promotionManager = abacus.promotionManager
-        return when(treeNode){
+        val toReturn = when(treeNode){
            is NumberNode -> {
                inheritedNumberImplementation.instanceForString(treeNode.number)
            }
@@ -114,6 +84,8 @@ class MutableEvaluationContext(parent: EvaluationContext? = null,
            }
            else -> throw ReductionException("unrecognized tree node.")
        }
+        numberImplementation = oldNumberImplementation
+        return toReturn
    }

 }
--- a/core/src/main/kotlin/org/nwapw/abacus/context/PluginEvaluationContext.kt
+++ b/core/src/main/kotlin/org/nwapw/abacus/context/PluginEvaluationContext.kt
@@ -0,0 +1,58 @@
+package org.nwapw.abacus.context
+
+import org.nwapw.abacus.Abacus
+import org.nwapw.abacus.number.NumberInterface
+import org.nwapw.abacus.plugin.NumberImplementation
+import org.nwapw.abacus.tree.nodes.TreeNode
+
+/**
+ * An evaluation context with limited mutability.
+ *
+ * An evaluation context that is mutable but in a limited way, that is, not allowing the modifications
+ * of variables whose changes might cause issues outside of the function. An example of this would be
+ * the modification of the [numberImplementation], which would cause code paths such as the parsing
+ * of NumberNodes to produce a different type of number than if the function did not run, whcih is unacceptable.
+ *
+ * @param parent the parent of this context.
+ * @param numberImplementation the number implementation used in this context.
+ * @param abacus the abacus instance used.
+ */
+abstract class PluginEvaluationContext(parent: EvaluationContext? = null,
+                                       numberImplementation: NumberImplementation? = null,
+                                       abacus: Abacus? = null) :
+        EvaluationContext(parent, numberImplementation, abacus) {
+
+    /**
+     * Sets a variable to a certain [value].
+     * @param name the name of the variable.
+     * @param value the value of the variable.
+     */
+    fun setVariable(name: String, value: NumberInterface) {
+        variableMap[name] = value
+    }
+
+    /**
+     * Set a definition to a certain [value].
+     * @param name the name of the definition.
+     * @param value the value of the definition.
+     */
+    fun setDefinition(name: String, value: TreeNode) {
+        definitionMap[name] = value
+    }
+
+    /**
+     * Clears the variables defined in this context.
+     */
+    fun clearVariables(){
+        variableMap.clear()
+    }
+
+    /**
+     * Clears the definitions defined in this context.
+     */
+    fun clearDefinitions(){
+        definitionMap.clear()
+    }
+
+
+}
--- a/core/src/main/kotlin/org/nwapw/abacus/function/Applicable.kt
+++ b/core/src/main/kotlin/org/nwapw/abacus/function/Applicable.kt
@@ -1,6 +1,7 @@
 package org.nwapw.abacus.function

 import org.nwapw.abacus.context.MutableEvaluationContext
+import org.nwapw.abacus.context.PluginEvaluationContext
 import org.nwapw.abacus.exception.DomainException

 /**
@@ -18,7 +19,7 @@ interface Applicable<in T : Any, out O : Any> {
     * @param params the parameter array to verify for compatibility.
     * @return whether the array can be used with applyInternal.
     */
-    fun matchesParams(context: MutableEvaluationContext, params: Array<out T>): Boolean
+    fun matchesParams(context: PluginEvaluationContext, params: Array<out T>): Boolean

    /**
     * Applies the applicable object to the given parameters,
@@ -26,7 +27,7 @@ interface Applicable<in T : Any, out O : Any> {
     * @param params the parameters to apply to.
     * @return the result of the application.
     */
-    fun applyInternal(context: MutableEvaluationContext, params: Array<out T>): O
+    fun applyInternal(context: PluginEvaluationContext, params: Array<out T>): O

    /**
     * If the parameters can be used with this applicable, returns
@@ -35,7 +36,7 @@ interface Applicable<in T : Any, out O : Any> {
     * @param params the parameters to apply to.
     * @return the result of the operation, or null if parameters do not match.
     */
-    fun apply(context: MutableEvaluationContext, vararg params: T): O {
+    fun apply(context: PluginEvaluationContext, vararg params: T): O {
        if (!matchesParams(context, params))
            throw DomainException("parameters do not match function requirements.")
        return applyInternal(context, params)
--- a/core/src/main/kotlin/org/nwapw/abacus/plugin/standard/operator/OperatorAdd.kt
+++ b/core/src/main/kotlin/org/nwapw/abacus/plugin/standard/operator/OperatorAdd.kt
@@ -1,6 +1,6 @@
 package org.nwapw.abacus.plugin.standard.operator

-import org.nwapw.abacus.context.MutableEvaluationContext
+import org.nwapw.abacus.context.PluginEvaluationContext
 import org.nwapw.abacus.function.OperatorAssociativity
 import org.nwapw.abacus.function.OperatorType
 import org.nwapw.abacus.function.interfaces.NumberOperator
@@ -13,9 +13,9 @@ import org.nwapw.abacus.number.NumberInterface
 */
 class OperatorAdd: NumberOperator(OperatorAssociativity.LEFT, OperatorType.BINARY_INFIX, 0) {

-    override fun matchesParams(context: MutableEvaluationContext, params: Array<out NumberInterface>) =
+    override fun matchesParams(context: PluginEvaluationContext, params: Array<out NumberInterface>) =
            params.size == 2
-    override fun applyInternal(context: MutableEvaluationContext, params: Array<out NumberInterface>) =
+    override fun applyInternal(context: PluginEvaluationContext, params: Array<out NumberInterface>) =
            params[0] + params[1]

 }
--- a/core/src/main/kotlin/org/nwapw/abacus/plugin/standard/operator/OperatorCaret.kt
+++ b/core/src/main/kotlin/org/nwapw/abacus/plugin/standard/operator/OperatorCaret.kt
@@ -1,6 +1,6 @@
 package org.nwapw.abacus.plugin.standard.operator

-import org.nwapw.abacus.context.MutableEvaluationContext
+import org.nwapw.abacus.context.PluginEvaluationContext
 import org.nwapw.abacus.function.OperatorAssociativity
 import org.nwapw.abacus.function.OperatorType
 import org.nwapw.abacus.function.interfaces.NumberOperator
@@ -14,12 +14,12 @@ import org.nwapw.abacus.plugin.standard.StandardPlugin.*
 */
 class OperatorCaret: NumberOperator(OperatorAssociativity.RIGHT, OperatorType.BINARY_INFIX, 2) {

-    override fun matchesParams(context: MutableEvaluationContext, params: Array<out NumberInterface>) =
+    override fun matchesParams(context: PluginEvaluationContext, params: Array<out NumberInterface>) =
            params.size == 2
                    && !(params[0].signum() == 0 && params[1].signum() == 0)
                    && !(params[0].signum() == -1 && !params[1].isInteger())

-    override fun applyInternal(context: MutableEvaluationContext, params: Array<out NumberInterface>): NumberInterface {
+    override fun applyInternal(context: PluginEvaluationContext, params: Array<out NumberInterface>): NumberInterface {
        val implementation = context.inheritedNumberImplementation
        if (params[0].signum() == 0)
            return implementation.instanceForString("0")
--- a/core/src/main/kotlin/org/nwapw/abacus/plugin/standard/operator/OperatorDefine.kt
+++ b/core/src/main/kotlin/org/nwapw/abacus/plugin/standard/operator/OperatorDefine.kt
@@ -1,6 +1,6 @@
 package org.nwapw.abacus.plugin.standard.operator

-import org.nwapw.abacus.context.MutableEvaluationContext
+import org.nwapw.abacus.context.PluginEvaluationContext
 import org.nwapw.abacus.function.OperatorAssociativity
 import org.nwapw.abacus.function.OperatorType
 import org.nwapw.abacus.function.interfaces.TreeValueOperator
@@ -16,10 +16,10 @@ import org.nwapw.abacus.tree.nodes.VariableNode
 */
 class OperatorDefine: TreeValueOperator(OperatorAssociativity.LEFT, OperatorType.BINARY_INFIX, 0) {

-    override fun matchesParams(context: MutableEvaluationContext, params: Array<out TreeNode>) =
+    override fun matchesParams(context: PluginEvaluationContext, params: Array<out TreeNode>) =
            params.size == 2 && params[0] is VariableNode

-    override fun applyInternal(context: MutableEvaluationContext, params: Array<out TreeNode>): NumberInterface {
+    override fun applyInternal(context: PluginEvaluationContext, params: Array<out TreeNode>): NumberInterface {
        val assignTo = (params[0] as VariableNode).variable
        context.setDefinition(assignTo, params[1])
        return params[1].reduce(context)
--- a/core/src/main/kotlin/org/nwapw/abacus/plugin/standard/operator/OperatorDivide.kt
+++ b/core/src/main/kotlin/org/nwapw/abacus/plugin/standard/operator/OperatorDivide.kt
@@ -1,6 +1,6 @@
 package org.nwapw.abacus.plugin.standard.operator

-import org.nwapw.abacus.context.MutableEvaluationContext
+import org.nwapw.abacus.context.PluginEvaluationContext
 import org.nwapw.abacus.function.OperatorAssociativity
 import org.nwapw.abacus.function.OperatorType
 import org.nwapw.abacus.function.interfaces.NumberOperator
@@ -13,9 +13,9 @@ import org.nwapw.abacus.number.NumberInterface
 */
 class OperatorDivide: NumberOperator(OperatorAssociativity.LEFT, OperatorType.BINARY_INFIX, 1) {

-    override fun matchesParams(context: MutableEvaluationContext, params: Array<out NumberInterface>) =
+    override fun matchesParams(context: PluginEvaluationContext, params: Array<out NumberInterface>) =
            params.size == 2
-    override fun applyInternal(context: MutableEvaluationContext, params: Array<out NumberInterface>) =
+    override fun applyInternal(context: PluginEvaluationContext, params: Array<out NumberInterface>) =
            params[0] / params[1]

 }
--- a/core/src/main/kotlin/org/nwapw/abacus/plugin/standard/operator/OperatorFactorial.kt
+++ b/core/src/main/kotlin/org/nwapw/abacus/plugin/standard/operator/OperatorFactorial.kt
@@ -1,6 +1,6 @@
 package org.nwapw.abacus.plugin.standard.operator

-import org.nwapw.abacus.context.MutableEvaluationContext
+import org.nwapw.abacus.context.PluginEvaluationContext
 import org.nwapw.abacus.function.OperatorAssociativity
 import org.nwapw.abacus.function.OperatorType
 import org.nwapw.abacus.function.interfaces.NumberOperator
@@ -13,12 +13,12 @@ import org.nwapw.abacus.number.NumberInterface
 */
 class OperatorFactorial: NumberOperator(OperatorAssociativity.LEFT, OperatorType.UNARY_POSTFIX, 0) {

-    override fun matchesParams(context: MutableEvaluationContext, params: Array<out NumberInterface>) =
+    override fun matchesParams(context: PluginEvaluationContext, params: Array<out NumberInterface>) =
        params.size == 1
                && params[0].isInteger()
                && params[0].signum() >= 0

-    override fun applyInternal(context: MutableEvaluationContext, params: Array<out NumberInterface>): NumberInterface {
+    override fun applyInternal(context: PluginEvaluationContext, params: Array<out NumberInterface>): NumberInterface {
        val implementation = context.inheritedNumberImplementation
        val one = implementation.instanceForString("1")
        if (params[0].signum() == 0) {
--- a/core/src/main/kotlin/org/nwapw/abacus/plugin/standard/operator/OperatorMultiply.kt
+++ b/core/src/main/kotlin/org/nwapw/abacus/plugin/standard/operator/OperatorMultiply.kt
@@ -1,6 +1,6 @@
 package org.nwapw.abacus.plugin.standard.operator

-import org.nwapw.abacus.context.MutableEvaluationContext
+import org.nwapw.abacus.context.PluginEvaluationContext
 import org.nwapw.abacus.function.OperatorAssociativity
 import org.nwapw.abacus.function.OperatorType
 import org.nwapw.abacus.function.interfaces.NumberOperator
@@ -13,9 +13,9 @@ import org.nwapw.abacus.number.NumberInterface
 */
 class OperatorMultiply: NumberOperator(OperatorAssociativity.LEFT, OperatorType.BINARY_INFIX, 1) {

-    override fun matchesParams(context: MutableEvaluationContext, params: Array<out NumberInterface>) =
+    override fun matchesParams(context: PluginEvaluationContext, params: Array<out NumberInterface>) =
            params.size == 2
-    override fun applyInternal(context: MutableEvaluationContext, params: Array<out NumberInterface>) =
+    override fun applyInternal(context: PluginEvaluationContext, params: Array<out NumberInterface>) =
            params[0] * params[1]

 }
--- a/core/src/main/kotlin/org/nwapw/abacus/plugin/standard/operator/OperatorNcr.kt
+++ b/core/src/main/kotlin/org/nwapw/abacus/plugin/standard/operator/OperatorNcr.kt
@@ -1,6 +1,6 @@
 package org.nwapw.abacus.plugin.standard.operator

-import org.nwapw.abacus.context.MutableEvaluationContext
+import org.nwapw.abacus.context.PluginEvaluationContext
 import org.nwapw.abacus.function.OperatorAssociativity
 import org.nwapw.abacus.function.OperatorType
 import org.nwapw.abacus.function.interfaces.NumberOperator
@@ -16,11 +16,11 @@ import org.nwapw.abacus.plugin.standard.StandardPlugin.OP_NPR
 */
 class OperatorNcr: NumberOperator(OperatorAssociativity.RIGHT, OperatorType.BINARY_INFIX, 0) {

-    override fun matchesParams(context: MutableEvaluationContext, params: Array<out NumberInterface>) =
+    override fun matchesParams(context: PluginEvaluationContext, params: Array<out NumberInterface>) =
            params.size == 2 && params[0].isInteger()
                    && params[1].isInteger()

-    override fun applyInternal(context: MutableEvaluationContext, params: Array<out NumberInterface>) =
+    override fun applyInternal(context: PluginEvaluationContext, params: Array<out NumberInterface>) =
            OP_NPR.apply(context, *params) / OP_FACTORIAL.apply(context, params[1])

 }
--- a/core/src/main/kotlin/org/nwapw/abacus/plugin/standard/operator/OperatorNegate.kt
+++ b/core/src/main/kotlin/org/nwapw/abacus/plugin/standard/operator/OperatorNegate.kt
@@ -1,6 +1,6 @@
 package org.nwapw.abacus.plugin.standard.operator

-import org.nwapw.abacus.context.MutableEvaluationContext
+import org.nwapw.abacus.context.PluginEvaluationContext
 import org.nwapw.abacus.function.OperatorAssociativity
 import org.nwapw.abacus.function.OperatorType
 import org.nwapw.abacus.function.interfaces.NumberOperator
@@ -13,10 +13,10 @@ import org.nwapw.abacus.number.NumberInterface
 */
 class OperatorNegate: NumberOperator(OperatorAssociativity.LEFT, OperatorType.UNARY_PREFIX, 0) {

-    override fun matchesParams(context: MutableEvaluationContext, params: Array<out NumberInterface>) =
+    override fun matchesParams(context: PluginEvaluationContext, params: Array<out NumberInterface>) =
            params.size == 1

-    override fun applyInternal(context: MutableEvaluationContext, params: Array<out NumberInterface>) =
+    override fun applyInternal(context: PluginEvaluationContext, params: Array<out NumberInterface>) =
            -params[0]

 }
--- a/core/src/main/kotlin/org/nwapw/abacus/plugin/standard/operator/OperatorNpr.kt
+++ b/core/src/main/kotlin/org/nwapw/abacus/plugin/standard/operator/OperatorNpr.kt
@@ -1,6 +1,6 @@
 package org.nwapw.abacus.plugin.standard.operator

-import org.nwapw.abacus.context.MutableEvaluationContext
+import org.nwapw.abacus.context.PluginEvaluationContext
 import org.nwapw.abacus.function.OperatorAssociativity
 import org.nwapw.abacus.function.OperatorType
 import org.nwapw.abacus.function.interfaces.NumberOperator
@@ -14,11 +14,11 @@ import org.nwapw.abacus.number.NumberInterface
 */
 class OperatorNpr: NumberOperator(OperatorAssociativity.RIGHT, OperatorType.BINARY_INFIX, 0) {

-    override fun matchesParams(context: MutableEvaluationContext, params: Array<out NumberInterface>) =
+    override fun matchesParams(context: PluginEvaluationContext, params: Array<out NumberInterface>) =
            params.size == 2 && params[0].isInteger()
                    && params[1].isInteger()

-    override fun applyInternal(context: MutableEvaluationContext, params: Array<out NumberInterface>): NumberInterface {
+    override fun applyInternal(context: PluginEvaluationContext, params: Array<out NumberInterface>): NumberInterface {
        val implementation = context.inheritedNumberImplementation
        if (params[0] < params[1] ||
                params[0].signum() < 0 ||
--- a/core/src/main/kotlin/org/nwapw/abacus/plugin/standard/operator/OperatorSet.kt
+++ b/core/src/main/kotlin/org/nwapw/abacus/plugin/standard/operator/OperatorSet.kt
@@ -1,6 +1,6 @@
 package org.nwapw.abacus.plugin.standard.operator

-import org.nwapw.abacus.context.MutableEvaluationContext
+import org.nwapw.abacus.context.PluginEvaluationContext
 import org.nwapw.abacus.function.OperatorAssociativity
 import org.nwapw.abacus.function.OperatorType
 import org.nwapw.abacus.function.interfaces.TreeValueOperator
@@ -15,10 +15,10 @@ import org.nwapw.abacus.tree.nodes.VariableNode
 */
 class OperatorSet: TreeValueOperator(OperatorAssociativity.LEFT, OperatorType.BINARY_INFIX, 0) {

-    override fun matchesParams(context: MutableEvaluationContext, params: Array<out TreeNode>) =
+    override fun matchesParams(context: PluginEvaluationContext, params: Array<out TreeNode>) =
            params.size == 2 && params[0] is VariableNode

-    override fun applyInternal(context: MutableEvaluationContext, params: Array<out TreeNode>): NumberInterface {
+    override fun applyInternal(context: PluginEvaluationContext, params: Array<out TreeNode>): NumberInterface {
        val assignTo = (params[0] as VariableNode).variable
        val value = params[1].reduce(context)
        context.setVariable(assignTo, value)
--- a/core/src/main/kotlin/org/nwapw/abacus/plugin/standard/operator/OperatorSubtract.kt
+++ b/core/src/main/kotlin/org/nwapw/abacus/plugin/standard/operator/OperatorSubtract.kt
@@ -1,6 +1,6 @@
 package org.nwapw.abacus.plugin.standard.operator

-import org.nwapw.abacus.context.MutableEvaluationContext
+import org.nwapw.abacus.context.PluginEvaluationContext
 import org.nwapw.abacus.function.OperatorAssociativity
 import org.nwapw.abacus.function.OperatorType
 import org.nwapw.abacus.function.interfaces.NumberOperator
@@ -13,9 +13,9 @@ import org.nwapw.abacus.number.NumberInterface
 */
 class OperatorSubtract: NumberOperator(OperatorAssociativity.LEFT, OperatorType.BINARY_INFIX, 0) {

-    override fun matchesParams(context: MutableEvaluationContext, params: Array<out NumberInterface>) =
+    override fun matchesParams(context: PluginEvaluationContext, params: Array<out NumberInterface>) =
            params.size == 2
-    override fun applyInternal(context: MutableEvaluationContext, params: Array<out NumberInterface>) =
+    override fun applyInternal(context: PluginEvaluationContext, params: Array<out NumberInterface>) =
            params[0] - params[1]

 }