Add missing comments.

0c16bb4e9b

src/main/java/org/nwapw/abacus/Abacus.java

@@ -6,16 +6,12 @@ import org.nwapw.abacus.number.NumberInterface;
 import org.nwapw.abacus.parsing.LexerTokenizer;
 import org.nwapw.abacus.parsing.ShuntingYardParser;
 import org.nwapw.abacus.parsing.TreeBuilder;
-import org.nwapw.abacus.plugin.ClassFinder;
 import org.nwapw.abacus.plugin.NumberImplementation;
 import org.nwapw.abacus.plugin.PluginManager;
 import org.nwapw.abacus.plugin.StandardPlugin;
 import org.nwapw.abacus.tree.NumberReducer;
 import org.nwapw.abacus.tree.TreeNode;
 
-import java.io.File;
-import java.io.IOException;
-
 /**
  * The main calculator class. This is responsible
  * for piecing together all of the components, allowing
@@ -27,10 +23,6 @@ public class Abacus {
      * The default number implementation to be used if no other one is available / selected.
      */
     public static final NumberImplementation DEFAULT_IMPLEMENTATION = StandardPlugin.IMPLEMENTATION_NAIVE;
-    /**
-     * The file used for saving and loading configuration.
-     */
-    public static final File CONFIG_FILE = new File("config.toml");
 
     /**
      * The plugin manager responsible for
@@ -54,26 +46,19 @@ public class Abacus {
 
     /**
      * Creates a new instance of the Abacus calculator.
+     *
+     * @param configuration the configuration object for this Abacus instance.
      */
-    public Abacus() {
+    public Abacus(Configuration configuration) {
         pluginManager = new PluginManager(this);
         numberReducer = new NumberReducer(this);
-        configuration = new Configuration(CONFIG_FILE);
+        this.configuration = new Configuration(configuration);
-        configuration.saveTo(CONFIG_FILE);
         LexerTokenizer lexerTokenizer = new LexerTokenizer();
         ShuntingYardParser shuntingYardParser = new ShuntingYardParser(this);
         treeBuilder = new TreeBuilder<>(lexerTokenizer, shuntingYardParser);
 
-        pluginManager.addListener(lexerTokenizer);
         pluginManager.addListener(shuntingYardParser);
-        pluginManager.addInstantiated(new StandardPlugin(pluginManager));
+        pluginManager.addListener(lexerTokenizer);
-        try {
-            ClassFinder.loadJars("plugins")
-                    .forEach(plugin -> pluginManager.addClass(plugin));
-        } catch (IOException | ClassNotFoundException e) {
-            e.printStackTrace();
-        }
-        pluginManager.load();
     }
 
     public static void main(String[] args) {

src/main/java/org/nwapw/abacus/config/Configuration.java

@@ -30,6 +30,10 @@ public class Configuration {
      */
     private static final TomlWriter TOML_WRITER = new TomlWriter();
 
+    /**
+     * The computation delay for which the thread can run without interruption.
+     */
+    private double computationDelay = 0;
     /**
      * The implementation of the number that should be used.
      */
@@ -39,13 +43,24 @@ public class Configuration {
      */
     private Set<String> disabledPlugins = new HashSet<>();
 
+    /**
+     * Creates a new configuration form the given configuration.
+     *
+     * @param copyFrom the configuration to copy.
+     */
+    public Configuration(Configuration copyFrom){
+        copyFrom(copyFrom);
+    }
+
     /**
      * Creates a new configuration with the given values.
      *
+     * @param computationDelay     the delay before the computation gets killed.
      * @param numberImplementation the number implementation, like "naive" or "precise"
      * @param disabledPlugins      the list of disabled plugins.
      */
-    public Configuration(String numberImplementation, String[] disabledPlugins) {
+    public Configuration(double computationDelay, String numberImplementation, String[] disabledPlugins) {
+        this.computationDelay = computationDelay;
         this.numberImplementation = numberImplementation;
         this.disabledPlugins.addAll(Arrays.asList(disabledPlugins));
     }
@@ -66,6 +81,7 @@ public class Configuration {
      * @param otherConfiguration the configuration to copy from.
      */
     public void copyFrom(Configuration otherConfiguration) {
+        this.computationDelay = otherConfiguration.computationDelay;
         this.numberImplementation = otherConfiguration.numberImplementation;
         this.disabledPlugins.addAll(otherConfiguration.disabledPlugins);
     }
@@ -85,6 +101,15 @@ public class Configuration {
         }
     }
 
+    /**
+     * Gets the value of this configuration as a string.
+     *
+     * @return the string that represents this configuration.
+     */
+    public String asTomlString(){
+        return TOML_WRITER.write(this);
+    }
+
     /**
      * Gets the number implementation from this configuration.
      *
@@ -112,4 +137,23 @@ public class Configuration {
         return disabledPlugins;
     }
 
+
+    /**
+     * Gets the computation delay specified in the configuration.
+     *
+     * @return the computaton delay.
+     */
+    public double getComputationDelay() {
+        return computationDelay;
+    }
+
+    /**
+     * Sets the computation delay.
+     *
+     * @param computationDelay the new computation delay.
+     */
+    public void setComputationDelay(double computationDelay) {
+        this.computationDelay = computationDelay;
+    }
+
 }

src/main/java/org/nwapw/abacus/function/Operator.java

@@ -26,6 +26,7 @@ public class Operator {
      * Creates a new operator with the given parameters.
      *
      * @param associativity the associativity of the operator.
+     * @param operatorType  the type of this operator, like binary infix or unary postfix.
      * @param precedence    the precedence of the operator.
      * @param function      the function that the operator calls.
      */

src/main/java/org/nwapw/abacus/fx/AbacusApplication.java

@@ -12,13 +12,25 @@ import javafx.stage.Stage;
  */
 public class AbacusApplication extends Application {
 
+    /**
+     * The controller currently managing the application.
+     */
+    private AbacusController controller;
+
     @Override
     public void start(Stage primaryStage) throws Exception {
-        Parent parent = FXMLLoader.load(getClass().getResource("/abacus.fxml"));
+        FXMLLoader loader = new FXMLLoader(getClass().getResource("/abacus.fxml"));
+        Parent parent = loader.load();
+        controller = loader.getController();
         Scene mainScene = new Scene(parent, 320, 480);
         primaryStage.setScene(mainScene);
         primaryStage.setTitle("Abacus");
         primaryStage.show();
     }
 
+    @Override
+    public void stop() throws Exception {
+        super.stop();
+        controller.performStop();
+    }
 }

src/main/java/org/nwapw/abacus/fx/AbacusController.java

@@ -1,6 +1,8 @@
 package org.nwapw.abacus.fx;
 
 import javafx.application.Platform;
+import javafx.beans.value.ChangeListener;
+import javafx.beans.value.ObservableValue;
 import javafx.collections.FXCollections;
 import javafx.collections.ObservableList;
 import javafx.fxml.FXML;
@@ -13,10 +15,14 @@ import org.nwapw.abacus.Abacus;
 import org.nwapw.abacus.config.Configuration;
 import org.nwapw.abacus.number.ComputationInterruptedException;
 import org.nwapw.abacus.number.NumberInterface;
+import org.nwapw.abacus.plugin.ClassFinder;
 import org.nwapw.abacus.plugin.PluginListener;
 import org.nwapw.abacus.plugin.PluginManager;
+import org.nwapw.abacus.plugin.StandardPlugin;
 import org.nwapw.abacus.tree.TreeNode;
 
+import java.io.File;
+import java.io.IOException;
 import java.util.Set;
 
 
@@ -26,6 +32,10 @@ import java.util.Set;
  */
 public class AbacusController implements PluginListener {
 
+    /**
+     * The file used for saving and loading configuration.
+     */
+    public static final File CONFIG_FILE = new File("config.toml");
     /**
      * The title for the apply alert dialog.
      */
@@ -81,6 +91,8 @@ public class AbacusController implements PluginListener {
     private ComboBox<String> numberImplementationBox;
     @FXML
     private ListView<ToggleablePlugin> enabledPluginView;
+    @FXML
+    private TextField computationLimitField;
 
     /**
      * The list of history entries, created by the users.
@@ -116,6 +128,17 @@ public class AbacusController implements PluginListener {
      * The alert shown when a press to "apply" is needed.
      */
     private Alert reloadAlert;
+    /**
+     * The runnable that takes care of killing computations that take too long.
+     */
+    private final Runnable TIMER_RUNNABLE = () -> {
+        try {
+            Configuration abacusConfig = abacus.getConfiguration();
+            if(abacusConfig.getComputationDelay() == 0) return;
+            Thread.sleep((long) (abacusConfig.getComputationDelay() * 1000));
+            performStop();
+        } catch (InterruptedException e) { }
+    };
     /**
      * The runnable used to perform the calculation.
      */
@@ -153,6 +176,10 @@ public class AbacusController implements PluginListener {
             });
         }
     };
+    /**
+     * The thread that is waiting to pause the calculation.
+     */
+    private Thread computationLimitThread;
     /**
      * The thread in which the computation runs.
      */
@@ -205,9 +232,25 @@ public class AbacusController implements PluginListener {
             if (oldValue.equals(settingsTab)) alertIfApplyNeeded(true);
         });
 
-        abacus = new Abacus();
+        abacus = new Abacus(new Configuration(CONFIG_FILE));
-        abacus.getPluginManager().addListener(this);
+        PluginManager abacusPluginManager = abacus.getPluginManager();
-        abacus.getPluginManager().reload();
+        abacusPluginManager.addListener(this);
+        abacusPluginManager.addInstantiated(new StandardPlugin(abacus.getPluginManager()));
+        try {
+            ClassFinder.loadJars("plugins").forEach(abacusPluginManager::addClass);
+        } catch (IOException | ClassNotFoundException e) {
+            e.printStackTrace();
+        }
+        abacusPluginManager.reload();
+
+        computationLimitField.setText(Double.toString(abacus.getConfiguration().getComputationDelay()));
+        computationLimitField.textProperty().addListener((observable, oldValue, newValue) -> {
+            if(!newValue.matches("(\\d+(\\.\\d*)?)?")) {
+                computationLimitField.setText(oldValue);
+            } else {
+                changesMade = true;
+            }
+        });
 
         changesMade = false;
         reloadAlertShown = false;
@@ -219,21 +262,29 @@ public class AbacusController implements PluginListener {
     }
 
     @FXML
-    private void performCalculation() {
+    public void performCalculation() {
         inputButton.setDisable(true);
         stopButton.setDisable(false);
         calculationThread = new Thread(CALCULATION_RUNNABLE);
         calculationThread.start();
+        computationLimitThread = new Thread(TIMER_RUNNABLE);
+        computationLimitThread.start();
     }
 
     @FXML
-    private void performStop(){
+    public void performStop(){
-        if(calculationThread != null)
+        if(calculationThread != null) {
             calculationThread.interrupt();
+            calculationThread = null;
+        }
+        if(computationLimitThread != null){
+            computationLimitThread.interrupt();
+            computationLimitThread = null;
+        }
     }
 
     @FXML
-    private void performSaveAndReload() {
+    public void performSaveAndReload() {
         performSave();
         performReload();
         changesMade = false;
@@ -241,13 +292,13 @@ public class AbacusController implements PluginListener {
     }
 
     @FXML
-    private void performReload() {
+    public void performReload() {
         alertIfApplyNeeded(true);
         abacus.getPluginManager().reload();
     }
 
     @FXML
-    private void performSave() {
+    public void performSave() {
         Configuration configuration = abacus.getConfiguration();
         configuration.setNumberImplementation(numberImplementationBox.getSelectionModel().getSelectedItem());
         Set<String> disabledPlugins = configuration.getDisabledPlugins();
@@ -255,7 +306,9 @@ public class AbacusController implements PluginListener {
         for (ToggleablePlugin pluginEntry : enabledPlugins) {
             if (!pluginEntry.isEnabled()) disabledPlugins.add(pluginEntry.getClassName());
         }
-        configuration.saveTo(Abacus.CONFIG_FILE);
+        if(computationLimitField.getText().matches("\\d*(\\.\\d+)?") && computationLimitField.getText().length() != 0)
+            configuration.setComputationDelay(Double.parseDouble(computationLimitField.getText()));
+        configuration.saveTo(CONFIG_FILE);
         changesMade = false;
         reloadAlertShown = false;
     }
@@ -281,4 +334,5 @@ public class AbacusController implements PluginListener {
         enabledPlugins.clear();
         numberImplementationOptions.clear();
     }
+
 }

src/main/java/org/nwapw/abacus/lexing/pattern/ValueNode.java

@@ -15,7 +15,7 @@ public class ValueNode<T> extends PatternNode<T> {
     /**
      * Creates a new node that matches the given character.
      *
-     * @param value
+     * @param value the character value of the node.
      */
     public ValueNode(char value) {
         this.value = value;

src/main/java/org/nwapw/abacus/number/NumberInterface.java

@@ -182,7 +182,7 @@ public abstract class NumberInterface {
      * Also, checks if the thread has been interrupted, and if so, throws
      * an exception.
      *
-     * @return the least integer >= the number, if int can hold the value.
+     * @return the least integer bigger or equal to the number, if int can hold the value.
      */
     public final NumberInterface ceiling(){
         checkInterrupted();
@@ -192,7 +192,7 @@ public abstract class NumberInterface {
     /**
      * Return the greatest integer less than or equal to the number.
      *
-     * @return the greatest int >= the number, if int can hold the value.
+     * @return the greatest integer smaller or equal the number, if int can hold the value.
      */
     protected abstract NumberInterface floorInternal();
 
@@ -230,7 +230,7 @@ public abstract class NumberInterface {
      * Returns the integer representation of this number, discarding any fractional part,
      * if int can hold the value.
      *
-     * @return
+     * @return the integer value of this number.
      */
     public abstract int intValue();
 

src/main/java/org/nwapw/abacus/plugin/NumberImplementation.java

@@ -28,7 +28,7 @@ public abstract class NumberImplementation {
      * Creates a new number implementation with the given data.
      *
      * @param implementation the implementation class.
-     * @param priority       the priority, higher -> more likely to be converted into.
+     * @param priority       the priority, higher means more likely to be converted into.
      */
     public NumberImplementation(Class<? extends NumberInterface> implementation, int priority) {
         this.implementation = implementation;

src/main/java/org/nwapw/abacus/plugin/PluginManager.java

@@ -70,6 +70,8 @@ public class PluginManager {
 
     /**
      * Creates a new plugin manager.
+     *
+     * @param abacus the abacus instance.
      */
     public PluginManager(Abacus abacus) {
         this.abacus = abacus;

src/main/java/org/nwapw/abacus/plugin/StandardPlugin.java

@@ -439,7 +439,7 @@ public class StandardPlugin extends Plugin {
 
         @Override
         protected NumberInterface applyInternal(NumberInterface[] params) {
-            return functionCos.apply(params[0]).divide(functionCos.apply(params[0]));
+            return functionCos.apply(params[0]).divide(functionSin.apply(params[0]));
         }
     };
 
@@ -531,22 +531,6 @@ public class StandardPlugin extends Plugin {
         return theta;
     }
 
-    public static NumberInterface intPow(NumberInterface number, Class<? extends NumberInterface> numberClass, NumberInterface exponent) {
-        if (exponent.compareTo((new NaiveNumber(0)).promoteTo(numberClass)) == 0) {
-            return (new NaiveNumber(1)).promoteTo(numberClass);
-        }
-        boolean takeReciprocal = exponent.compareTo((new NaiveNumber(0)).promoteTo(numberClass)) < 0;
-        exponent = FUNCTION_ABS.apply(exponent);
-        NumberInterface power = number;
-        for (NumberInterface currentExponent = (new NaiveNumber(1)).promoteTo(numberClass); currentExponent.compareTo(exponent) < 0; currentExponent = currentExponent.add((new NaiveNumber(1)).promoteTo(numberClass))) {
-            power = power.multiply(number);
-        }
-        if (takeReciprocal) {
-            power = (new NaiveNumber(1)).promoteTo(numberClass).divide(power);
-        }
-        return power;
-    }
-
     @Override
     public void onEnable() {
         registerNumberImplementation("naive", IMPLEMENTATION_NAIVE);

src/main/resources/abacus.fxml

@@ -50,7 +50,9 @@
                     <ListView fx:id="enabledPluginView"
                               GridPane.rowIndex="1" GridPane.columnIndex="0"
                               GridPane.columnSpan="2" maxHeight="100"/>
-                    <FlowPane GridPane.columnIndex="0" GridPane.columnSpan="2" GridPane.rowIndex="2" hgap="10"
+                    <Text GridPane.columnIndex="0" GridPane.rowIndex="2" text="Computation Limit"/>
+                    <TextField fx:id="computationLimitField" GridPane.columnIndex="1" GridPane.rowIndex="2"/>
+                    <FlowPane GridPane.columnIndex="0" GridPane.columnSpan="2" GridPane.rowIndex="3" hgap="10"
                               vgap="10">
                         <Button text="Apply" onAction="#performSave"/>
                         <Button text="Reload Plugins" onAction="#performReload"/>

src/test/java/org/nwapw/abacus/tests/CalculationTests.java

@@ -0,0 +1,104 @@
+package org.nwapw.abacus.tests;
+
+import org.junit.Assert;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.nwapw.abacus.Abacus;
+import org.nwapw.abacus.config.Configuration;
+import org.nwapw.abacus.number.NumberInterface;
+import org.nwapw.abacus.plugin.StandardPlugin;
+import org.nwapw.abacus.tree.TreeNode;
+
+public class CalculationTests {
+
+    private static Abacus abacus = new Abacus(new Configuration(0, "precise", new String[]{}));
+
+    @BeforeClass
+    public static void prepareTests(){
+        abacus.getPluginManager().addInstantiated(new StandardPlugin(abacus.getPluginManager()));
+        abacus.getPluginManager().load();
+    }
+
+    private void testOutput(String input, String parseOutput, String output){
+        TreeNode parsedTree = abacus.parseString(input);
+        Assert.assertNotNull(parsedTree);
+        Assert.assertEquals(parsedTree.toString(), parseOutput);
+        NumberInterface result = abacus.evaluateTree(parsedTree);
+        Assert.assertNotNull(result);
+        Assert.assertTrue(result.toString().startsWith(output));
+    }
+
+    private void testEvalError(String input, String parseOutput){
+        TreeNode parsedTree = abacus.parseString(input);
+        Assert.assertNotNull(parsedTree);
+        Assert.assertEquals(parsedTree.toString(), parseOutput);
+        Assert.assertNull(abacus.evaluateTree(parsedTree));
+    }
+
+    @Test
+    public void testAddition(){
+        testOutput("9.5+10", "(9.5+10)", "19.5");
+    }
+
+    @Test
+    public void testSubtraction(){
+        testOutput("9.5-10", "(9.5-10)", "-0.5");
+    }
+
+    @Test
+    public void testMultiplication(){
+        testOutput("9.5*10", "(9.5*10)", "95");
+    }
+
+    @Test
+    public void testDivision(){
+        testOutput("9.5/2", "(9.5/2)", "4.75");
+    }
+
+    @Test
+    public void testNegation(){
+        testOutput("-9.5", "(9.5)`", "-9.5");
+    }
+
+    @Test
+    public void testFactorial(){
+        testOutput("7!", "(7)!", "5040");
+    }
+
+    @Test
+    public void testAbs(){
+        testOutput("abs(-1)", "abs((1)`)", "1");
+        testOutput("abs(1)", "abs(1)", "1");
+    }
+
+    @Test
+    public void testLn(){
+        testEvalError("ln(-1)", "ln((1)`)");
+        testOutput("ln2", "ln(2)", "0.6931471805599453094172321214581765680755");
+    }
+
+    @Test
+    public void testSqrt(){
+        testOutput("sqrt0", "sqrt(0)", "0");
+        testOutput("sqrt4", "sqrt(4)", "2");
+        testOutput("sqrt2", "sqrt(2)", "1.4142135623730950488016887242096980785696");
+    }
+
+    @Test
+    public void testExp(){
+        testOutput("exp0", "exp(0)", "1");
+        testOutput("exp1", "exp(1)", "2.718281828459045235360287471352662497757247");
+        testOutput("exp300", "exp(300)", "19424263952412559365842088360176992193662086");
+        testOutput("exp300", "exp(300)", "19424263952412559365842088360176992193662086");
+    }
+
+    @Test
+    public void testPow(){
+        testOutput("0^2", "(0^2)", "0");
+        testOutput("2^0", "(2^0)", "1");
+        testOutput("2^1", "(2^1)", "2");
+        testOutput("2^-1", "(2^(1)`)", "0.5");
+        testOutput("2^50", "(2^50)", "112589990684262");
+    }
+
+}

src/test/java/org/nwapw/abacus/tests/TokenizerTests.java

@@ -4,6 +4,7 @@ import org.junit.Assert;
 import org.junit.BeforeClass;
 import org.junit.Test;
 import org.nwapw.abacus.Abacus;
+import org.nwapw.abacus.config.Configuration;
 import org.nwapw.abacus.function.Function;
 import org.nwapw.abacus.function.Operator;
 import org.nwapw.abacus.function.OperatorAssociativity;
@@ -18,7 +19,7 @@ import java.util.List;
 
 public class TokenizerTests {
 
-    private static Abacus abacus = new Abacus();
+    private static Abacus abacus = new Abacus(new Configuration(0, "precise", new String[]{}));
     private static LexerTokenizer lexerTokenizer = new LexerTokenizer();
     private static Function subtractFunction = new Function() {
         @Override