Merge branch 'master' into variable-parsing

Add dokka plugin to generate documentation.

build.gradle

@@ -1,6 +1,22 @@
+buildscript {
+    ext.kotlin_version = '1.1.3'
+    ext.dokka_version = '0.9.15'
+
+    repositories {
+        jcenter()
+    }
+
+    dependencies {
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+        classpath "org.jetbrains.dokka:dokka-gradle-plugin:$dokka_version"
+    }
+}
+
 subprojects {
 
     apply plugin: 'java'
+    apply plugin: 'kotlin'
+    apply plugin: 'org.jetbrains.dokka'
 
     repositories {
         mavenCentral()

core/build.gradle

@@ -1,7 +1,3 @@
-plugins {
-    id 'org.jetbrains.kotlin.jvm' version '1.1.3'
-}
-
 dependencies {
     compile 'com.moandjiezana.toml:toml4j:0.7.1'
     testCompile 'junit:junit:4.12'

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

@@ -53,7 +53,7 @@ public class Abacus {
         numberReducer = new NumberReducer(this);
         this.configuration = new Configuration(configuration);
         LexerTokenizer lexerTokenizer = new LexerTokenizer();
-        ShuntingYardParser shuntingYardParser = new ShuntingYardParser(this);
+        ShuntingYardParser shuntingYardParser = new ShuntingYardParser();
         treeBuilder = new TreeBuilder<>(lexerTokenizer, shuntingYardParser);
 
         pluginManager.addListener(shuntingYardParser);

core/src/main/java/org/nwapw/abacus/function/DocumentationType.java

@@ -1,5 +1,9 @@
 package org.nwapw.abacus.function;
 
+/**
+ * Enum that holds the type of documentation that has been
+ * registered with Abacus.
+ */
 public enum DocumentationType {
 
     FUNCTION

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

@@ -13,6 +13,7 @@ public abstract class NumberInterface {
         if (Thread.currentThread().isInterrupted())
             throw new ComputationInterruptedException();
     }
+
     /**
      * The maximum precision to which this number operates.
      *
@@ -219,6 +220,7 @@ public abstract class NumberInterface {
      * Returns the fractional part of the number, specifically x - floor(x).
      * Also, checks if the thread has been interrupted,
      * and if so, throws an exception.
+     *
      * @return the fractional part of the number.
      */
     public final NumberInterface fractionalPart() {
@@ -260,6 +262,7 @@ public abstract class NumberInterface {
     /**
      * Returns the smallest error this instance can tolerate depending
      * on its precision and value.
+     *
      * @return the smallest error that should be permitted in calculations.
      */
     public abstract NumberInterface getMaxError();

core/src/main/java/org/nwapw/abacus/parsing/LexerTokenizer.java

@@ -34,6 +34,7 @@ public class LexerTokenizer implements Tokenizer<Match<TokenType>>, PluginListen
             register(" ", TokenType.WHITESPACE);
             register(",", TokenType.COMMA);
             register("[0-9]*(\\.[0-9]+)?", TokenType.NUM);
+            register("[a-zA-Z]+", TokenType.VARIABLE);
             register("\\(", TokenType.OPEN_PARENTH);
             register("\\)", TokenType.CLOSE_PARENTH);
         }};

core/src/main/java/org/nwapw/abacus/parsing/ShuntingYardParser.java

@@ -1,6 +1,5 @@
 package org.nwapw.abacus.parsing;
 
-import org.nwapw.abacus.Abacus;
 import org.nwapw.abacus.function.Operator;
 import org.nwapw.abacus.function.OperatorAssociativity;
 import org.nwapw.abacus.function.OperatorType;
@@ -17,10 +16,6 @@ import java.util.*;
  */
 public class ShuntingYardParser implements Parser<Match<TokenType>>, PluginListener {
 
-    /**
-     * The Abacus instance used to create number instances.
-     */
-    private Abacus abacus;
     /**
      * Map of operator precedences, loaded from the plugin operators.
      */
@@ -35,12 +30,9 @@ public class ShuntingYardParser implements Parser<Match<TokenType>>, PluginListe
     private Map<String, OperatorType> typeMap;
 
     /**
-     * Creates a new Shunting Yard parser with the given Abacus instance.
-     *
-     * @param abacus the abacus instance.
+     * Creates a new Shunting Yard parser.
      */
-    public ShuntingYardParser(Abacus abacus) {
-        this.abacus = abacus;
+    public ShuntingYardParser() {
         precedenceMap = new HashMap<>();
         associativityMap = new HashMap<>();
         typeMap = new HashMap<>();
@@ -61,7 +53,7 @@ public class ShuntingYardParser implements Parser<Match<TokenType>>, PluginListe
             Match<TokenType> match = from.remove(0);
             previousType = matchType;
             matchType = match.getType();
-            if (matchType == TokenType.NUM) {
+            if (matchType == TokenType.NUM || matchType == TokenType.VARIABLE) {
                 output.add(match);
             } else if (matchType == TokenType.FUNCTION) {
                 output.add(new Match<>("", TokenType.INTERNAL_FUNCTION_END));
@@ -143,7 +135,9 @@ public class ShuntingYardParser implements Parser<Match<TokenType>>, PluginListe
                 else return new UnaryNode(operator, applyTo);
             }
         } else if (matchType == TokenType.NUM) {
-            return new NumberNode(abacus.numberFromString(match.getContent()));
+            return new NumberNode(match.getContent());
+        } else if (matchType == TokenType.VARIABLE) {
+            return new VariableNode(match.getContent());
         } else if (matchType == TokenType.FUNCTION) {
             String functionName = match.getContent();
             FunctionNode node = new FunctionNode(functionName);

core/src/main/java/org/nwapw/abacus/plugin/Plugin.java

@@ -6,10 +6,6 @@ import org.nwapw.abacus.function.Function;
 import org.nwapw.abacus.function.Operator;
 import org.nwapw.abacus.number.NumberInterface;
 
-import java.util.HashMap;
-import java.util.Map;
-import java.util.Set;
-
 /**
  * A plugin class that can be externally implemented and loaded via the
  * plugin manager. Plugins provide functionality to the calculator
@@ -99,6 +95,7 @@ public abstract class Plugin {
     /**
      * To be used in load(). Registers a documentation instance
      * used to explain some element of the plugin to the user.
+     *
      * @param documentation the documentation instance.
      */
     protected final void registerDocumentation(Documentation documentation) {

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

@@ -8,7 +8,10 @@ import org.nwapw.abacus.function.Operator;
 import org.nwapw.abacus.number.NumberInterface;
 
 import java.lang.reflect.InvocationTargetException;
-import java.util.*;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
 
 /**
  * A class that controls instances of plugins, allowing for them
@@ -79,6 +82,7 @@ public class PluginManager {
 
     /**
      * Registers a function under the given name.
+     *
      * @param name     the name of the function.
      * @param function the function to register.
      */
@@ -88,6 +92,7 @@ public class PluginManager {
 
     /**
      * Registers an operator under the given name.
+     *
      * @param name     the name of the operator.
      * @param operator the operator to register.
      */
@@ -97,6 +102,7 @@ public class PluginManager {
 
     /**
      * Registers a number implementation under the given name.
+     *
      * @param name           the name of the number implementation.
      * @param implementation the number implementation to register.
      */
@@ -107,6 +113,7 @@ public class PluginManager {
     /**
      * Registers the given documentation with the plugin manager,
      * making it accessible to the plugin manager etc.
+     *
      * @param documentation the documentation to register.
      */
     public void registerDocumentation(Documentation documentation) {
@@ -115,6 +122,7 @@ public class PluginManager {
 
     /**
      * Gets the function registered under the given name.
+     *
      * @param name the name of the function.
      * @return the function, or null if it was not found.
      */
@@ -124,6 +132,7 @@ public class PluginManager {
 
     /**
      * Gets the operator registered under the given name.
+     *
      * @param name the name of the operator.
      * @return the operator, or null if it was not found.
      */
@@ -133,6 +142,7 @@ public class PluginManager {
 
     /**
      * Gets the number implementation registered under the given name.
+     *
      * @param name the name of the number implementation.
      * @return the number implementation, or null if it was not found.
      */
@@ -142,6 +152,7 @@ public class PluginManager {
 
     /**
      * Gets the documentation for the given entity of the given type.
+     *
      * @param name the name of the entity to search for.
      * @param type the type that this entity is, to filter out similarly named documentation.
      * @return the documentation object.
@@ -226,6 +237,7 @@ public class PluginManager {
 
     /**
      * Removes the plugin with the given class from the manager.
+     *
      * @param toRemove the plugin to remove.
      */
     public void removeClass(Class<? extends Plugin> toRemove) {

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

@@ -1,19 +1,12 @@
 package org.nwapw.abacus.plugin;
 
 import org.nwapw.abacus.function.*;
-import org.nwapw.abacus.lexing.pattern.Match;
 import org.nwapw.abacus.number.NaiveNumber;
 import org.nwapw.abacus.number.NumberInterface;
 import org.nwapw.abacus.number.PreciseNumber;
-import org.nwapw.abacus.parsing.Parser;
-import org.nwapw.abacus.parsing.ShuntingYardParser;
-import org.nwapw.abacus.tree.TokenType;
-import org.nwapw.abacus.tree.TreeNode;
 
 import java.util.ArrayList;
-import java.util.Date;
 import java.util.HashMap;
-import java.util.List;
 import java.util.function.BiFunction;
 
 /**
@@ -22,11 +15,6 @@ import java.util.function.BiFunction;
  */
 public class StandardPlugin extends Plugin {
 
-    /**
-     * Stores objects of NumberInterface with integer values for reuse.
-     */
-    private final static HashMap<Class<? extends NumberInterface>, HashMap<Integer, NumberInterface>> integerValues = new HashMap<>();
-
     /**
      * The addition operator, +
      */
@@ -92,6 +80,75 @@ public class StandardPlugin extends Plugin {
             return product;
         }
     });
+    /**
+     * The combination operator.
+     */
+    public static final Operator OP_NCR = new Operator(OperatorAssociativity.RIGHT, OperatorType.BINARY_INFIX, 0, new Function() {
+        @Override
+        protected boolean matchesParams(NumberInterface[] params) {
+            return params.length == 2 && params[0].fractionalPart().signum() == 0
+                    && params[1].fractionalPart().signum() == 0;
+        }
+
+        @Override
+        protected NumberInterface applyInternal(NumberInterface[] params) {
+            return OP_NPR.getFunction().apply(params).divide(OP_FACTORIAL.getFunction().apply(params[1]));
+        }
+    });
+    /**
+     * The implementation for double-based naive numbers.
+     */
+    public static final NumberImplementation IMPLEMENTATION_NAIVE = new NumberImplementation(NaiveNumber.class, 0) {
+        @Override
+        public NumberInterface instanceForString(String string) {
+            return new NaiveNumber(string);
+        }
+
+        @Override
+        public NumberInterface instanceForPi() {
+            return new NaiveNumber(Math.PI);
+        }
+    };
+    /**
+     * The implementation for the infinite-precision BigDecimal.
+     */
+    public static final NumberImplementation IMPLEMENTATION_PRECISE = new NumberImplementation(PreciseNumber.class, 0) {
+        @Override
+        public NumberInterface instanceForString(String string) {
+            return new PreciseNumber(string);
+        }
+
+        @Override
+        public NumberInterface instanceForPi() {
+            NumberInterface C = FUNCTION_SQRT.apply(new PreciseNumber("10005")).multiply(new PreciseNumber("426880"));
+            NumberInterface M = PreciseNumber.ONE;
+            NumberInterface L = new PreciseNumber("13591409");
+            NumberInterface X = M;
+            NumberInterface sum = L;
+            int termsNeeded = C.getMaxPrecision() / 13 + 1;
+
+            NumberInterface lSummand = new PreciseNumber("545140134");
+            NumberInterface xMultiplier = new PreciseNumber("262537412")
+                    .multiply(new PreciseNumber("1000000000"))
+                    .add(new PreciseNumber("640768000"))
+                    .negate();
+            for (int i = 0; i < termsNeeded; i++) {
+                M = M
+                        .multiply(new PreciseNumber((12 * i + 2) + ""))
+                        .multiply(new PreciseNumber((12 * i + 6) + ""))
+                        .multiply(new PreciseNumber((12 * i + 10) + ""))
+                        .divide(new PreciseNumber(Math.pow(i + 1, 3) + ""));
+                L = L.add(lSummand);
+                X = X.multiply(xMultiplier);
+                sum = sum.add(M.multiply(L).divide(X));
+            }
+            return C.divide(sum);
+        }
+    };
+    /**
+     * Stores objects of NumberInterface with integer values for reuse.
+     */
+    private final static HashMap<Class<? extends NumberInterface>, HashMap<Integer, NumberInterface>> integerValues = new HashMap<>();
     /**
      * The division operator, /
      */
@@ -168,21 +225,6 @@ public class StandardPlugin extends Plugin {
             return total;
         }
     });
-    /**
-     * The combination operator.
-     */
-    public static final Operator OP_NCR = new Operator(OperatorAssociativity.RIGHT, OperatorType.BINARY_INFIX, 0, new Function() {
-        @Override
-        protected boolean matchesParams(NumberInterface[] params) {
-            return params.length == 2 && params[0].fractionalPart().signum() == 0
-                    && params[1].fractionalPart().signum() == 0;
-        }
-
-        @Override
-        protected NumberInterface applyInternal(NumberInterface[] params) {
-            return OP_NPR.getFunction().apply(params).divide(OP_FACTORIAL.getFunction().apply(params[1]));
-        }
-    });
     /**
      * The absolute value function, abs(-3) = 3
      */
@@ -277,20 +319,6 @@ public class StandardPlugin extends Plugin {
             return sum;
         }
     };
-    /**
-     * The square root function.
-     */
-    public static final Function FUNCTION_SQRT = new Function() {
-        @Override
-        protected boolean matchesParams(NumberInterface[] params) {
-            return params.length == 1;
-        }
-
-        @Override
-        protected NumberInterface applyInternal(NumberInterface[] params) {
-            return OP_CARET.getFunction().apply(params[0], ((new NaiveNumber(0.5)).promoteTo(params[0].getClass())));
-        }
-    };
     /**
      * Gets a random number smaller or equal to the given number's integer value.
      */
@@ -306,53 +334,47 @@ public class StandardPlugin extends Plugin {
         }
     };
     /**
-     * The implementation for double-based naive numbers.
+     * The caret / pow operator, ^
      */
-    public static final NumberImplementation IMPLEMENTATION_NAIVE = new NumberImplementation(NaiveNumber.class, 0) {
+    public static final Operator OP_CARET = new Operator(OperatorAssociativity.RIGHT, OperatorType.BINARY_INFIX, 2, new Function() {
         @Override
-        public NumberInterface instanceForString(String string) {
-            return new NaiveNumber(string);
+        protected boolean matchesParams(NumberInterface[] params) {
+            NumberInterface zero = fromInt(params[0].getClass(), 0);
+            return params.length == 2
+                    && !(params[0].compareTo(zero) == 0
+                    && params[1].compareTo(zero) == 0)
+                    && !(params[0].signum() == -1 && params[1].fractionalPart().compareTo(zero) != 0);
         }
 
         @Override
-        public NumberInterface instanceForPi() {
-            return new NaiveNumber(Math.PI);
+        protected NumberInterface applyInternal(NumberInterface[] params) {
+            NumberInterface zero = fromInt(params[0].getClass(), 0);
+            if (params[0].compareTo(zero) == 0)
+                return zero;
+            else if (params[1].compareTo(zero) == 0)
+                return fromInt(params[0].getClass(), 1);
+            //Detect integer bases:
+            if (params[0].fractionalPart().compareTo(fromInt(params[0].getClass(), 0)) == 0
+                    && FUNCTION_ABS.apply(params[1]).compareTo(fromInt(params[0].getClass(), Integer.MAX_VALUE)) < 0
+                    && FUNCTION_ABS.apply(params[1]).compareTo(fromInt(params[1].getClass(), 1)) >= 0) {
+                NumberInterface[] newParams = {params[0], params[1].fractionalPart()};
+                return params[0].intPow(params[1].floor().intValue()).multiply(applyInternal(newParams));
             }
-    };
+            return FUNCTION_EXP.apply(FUNCTION_LN.apply(FUNCTION_ABS.apply(params[0])).multiply(params[1]));
+        }
+    });
     /**
-     * The implementation for the infinite-precision BigDecimal.
+     * The square root function.
      */
-    public static final NumberImplementation IMPLEMENTATION_PRECISE = new NumberImplementation(PreciseNumber.class, 0) {
+    public static final Function FUNCTION_SQRT = new Function() {
         @Override
-        public NumberInterface instanceForString(String string) {
-            return new PreciseNumber(string);
+        protected boolean matchesParams(NumberInterface[] params) {
+            return params.length == 1;
         }
 
         @Override
-        public NumberInterface instanceForPi() {
-            NumberInterface C = FUNCTION_SQRT.apply(new PreciseNumber("10005")).multiply(new PreciseNumber("426880"));
-            NumberInterface M = PreciseNumber.ONE;
-            NumberInterface L = new PreciseNumber("13591409");
-            NumberInterface X = M;
-            NumberInterface sum = L;
-            int termsNeeded = C.getMaxPrecision() / 13 + 1;
-
-            NumberInterface lSummand = new PreciseNumber("545140134");
-            NumberInterface xMultiplier = new PreciseNumber("262537412")
-                    .multiply(new PreciseNumber("1000000000"))
-                    .add(new PreciseNumber("640768000"))
-                    .negate();
-            for (int i = 0; i < termsNeeded; i++) {
-                M = M
-                        .multiply(new PreciseNumber((12 * i + 2) + ""))
-                        .multiply(new PreciseNumber((12 * i + 6) + ""))
-                        .multiply(new PreciseNumber((12 * i + 10) + ""))
-                        .divide(new PreciseNumber(Math.pow(i + 1, 3) + ""));
-                L = L.add(lSummand);
-                X = X.multiply(xMultiplier);
-                sum = sum.add(M.multiply(L).divide(X));
-            }
-            return C.divide(sum);
+        protected NumberInterface applyInternal(NumberInterface[] params) {
+            return OP_CARET.getFunction().apply(params[0], ((new NaiveNumber(0.5)).promoteTo(params[0].getClass())));
         }
     };
     private static final HashMap<Class<? extends NumberInterface>, ArrayList<NumberInterface>> FACTORIAL_LISTS = new HashMap<>();
@@ -393,36 +415,6 @@ public class StandardPlugin extends Plugin {
             }
         }
     };
-    /**
-     * The caret / pow operator, ^
-     */
-    public static final Operator OP_CARET = new Operator(OperatorAssociativity.RIGHT, OperatorType.BINARY_INFIX, 2, new Function() {
-        @Override
-        protected boolean matchesParams(NumberInterface[] params) {
-            NumberInterface zero = fromInt(params[0].getClass(), 0);
-            return params.length == 2
-                    && !(params[0].compareTo(zero) == 0
-                    && params[1].compareTo(zero) == 0)
-                    && !(params[0].signum() == -1 && params[1].fractionalPart().compareTo(zero) != 0);
-        }
-
-        @Override
-        protected NumberInterface applyInternal(NumberInterface[] params) {
-            NumberInterface zero = fromInt(params[0].getClass(), 0);
-            if (params[0].compareTo(zero) == 0)
-                return zero;
-            else if (params[1].compareTo(zero) == 0)
-                return fromInt(params[0].getClass(), 1);
-            //Detect integer bases:
-            if(params[0].fractionalPart().compareTo(fromInt(params[0].getClass(), 0)) == 0
-                    && FUNCTION_ABS.apply(params[1]).compareTo(fromInt(params[0].getClass(), Integer.MAX_VALUE)) < 0
-                    && FUNCTION_ABS.apply(params[1]).compareTo(fromInt(params[1].getClass(), 1)) >= 0){
-                NumberInterface[] newParams = {params[0], params[1].fractionalPart()};
-                return params[0].intPow(params[1].floor().intValue()).multiply(applyInternal(newParams));
-            }
-            return FUNCTION_EXP.apply(FUNCTION_LN.apply(FUNCTION_ABS.apply(params[0])).multiply(params[1]));
-        }
-    });
     /**
      * The sine function (the argument is interpreted in radians).
      */
@@ -737,6 +729,7 @@ public class StandardPlugin extends Plugin {
 
     /**
      * Returns a number of class numType with value n.
+     *
      * @param numType class of number to return.
      * @param n       value of returned number.
      * @return numClass instance with value n.

core/src/main/java/org/nwapw/abacus/tree/NumberReducer.java

@@ -27,7 +27,9 @@ public class NumberReducer implements Reducer<NumberInterface> {
     @Override
     public NumberInterface reduceNode(TreeNode node, Object... children) {
         if (node instanceof NumberNode) {
-            return ((NumberNode) node).getNumber();
+            return abacus.numberFromString(((NumberNode) node).getNumber());
+        } else if(node instanceof VariableNode) {
+            return abacus.numberFromString("0");
         } else if (node instanceof BinaryNode) {
             NumberInterface left = (NumberInterface) children[0];
             NumberInterface right = (NumberInterface) children[1];

core/src/main/java/org/nwapw/abacus/tree/TokenType.java

@@ -7,7 +7,7 @@ package org.nwapw.abacus.tree;
 public enum TokenType {
 
     INTERNAL_FUNCTION_END(-1),
-    ANY(0), WHITESPACE(1), COMMA(2), OP(3), NUM(4), FUNCTION(5), OPEN_PARENTH(6), CLOSE_PARENTH(7);
+    ANY(0), WHITESPACE(1), COMMA(2), OP(3), NUM(4), VARIABLE(5), FUNCTION(6), OPEN_PARENTH(7), CLOSE_PARENTH(8);
 
     /**
      * The priority by which this token gets sorted.

core/src/main/kotlin/org/nwapw/abacus/tree/NumberNode.kt

@@ -10,14 +10,14 @@ import org.nwapw.abacus.number.NumberInterface
  *
  * @number the number value of this node.
  */
-data class NumberNode(val number: NumberInterface) : TreeNode() {
+data class NumberNode(val number: String) : TreeNode() {
 
     override fun <T : Any> reduce(reducer: Reducer<T>): T? {
         return reducer.reduceNode(this)
     }
 
     override fun toString(): String {
-        return number.toString()
+        return number
     }
 
 }

core/src/main/kotlin/org/nwapw/abacus/tree/VariableNode.kt

@@ -0,0 +1,21 @@
+package org.nwapw.abacus.tree
+
+/**
+ * A tree node that holds a placeholder variable.
+ *
+ * This node holds a variable string, and acts similarly to a number,
+ * with the key difference of not actually holding a value at runtime.
+ *
+ * @param variable the actual variable name that this node represents.
+ */
+data class VariableNode(val variable: String) : TreeNode() {
+
+    override fun <T : Any> reduce(reducer: Reducer<T>): T? {
+        return reducer.reduceNode(this)
+    }
+
+    override fun toString(): String {
+        return variable
+    }
+
+}

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

@@ -101,7 +101,7 @@ public class CalculationTests {
         testOutput("2^50", "(2^50)", "112589990684262");
         testOutput("7^(-sqrt2*17)", "(7^((sqrt(2)*17))`)", "4.81354609155297814551845300063563");
         testEvalError("0^0", "(0^0)");
-        testEvalError("(-13)^.9999", "((13)`^0.9999)");
+        testEvalError("(-13)^.9999", "((13)`^.9999)");
     }
 
 }

docs/404.html

@@ -0,0 +1,7 @@
+---
+layout: base 
+---
+<h1>404</h1>
+
+<p><strong>Page not found :(</strong></p>
+<p>The requested page could not be found.</p>

docs/Gemfile

@@ -0,0 +1,27 @@
+source "https://rubygems.org"
+
+# Hello! This is where you manage which Jekyll version is used to run.
+# When you want to use a different version, change it below, save the
+# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
+#
+#     bundle exec jekyll serve
+#
+# This will help ensure the proper Jekyll version is running.
+# Happy Jekylling!
+gem "jekyll", "3.5.2"
+
+# This is the default theme for new Jekyll sites. You may change this to anything you like.
+gem "minima", "~> 2.0"
+
+# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
+# uncomment the line below. To upgrade, run `bundle update github-pages`.
+# gem "github-pages", group: :jekyll_plugins
+
+# If you have any plugins, put them here!
+group :jekyll_plugins do
+   gem "jekyll-feed", "~> 0.6"
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
+

docs/Gemfile.lock

@@ -0,0 +1,58 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.1)
+      public_suffix (~> 2.0, >= 2.0.2)
+    colorator (1.1.0)
+    ffi (1.9.18)
+    forwardable-extended (2.6.0)
+    jekyll (3.5.2)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 1.1)
+      kramdown (~> 1.3)
+      liquid (~> 4.0)
+      mercenary (~> 0.3.3)
+      pathutil (~> 0.9)
+      rouge (~> 1.7)
+      safe_yaml (~> 1.0)
+    jekyll-feed (0.9.2)
+      jekyll (~> 3.3)
+    jekyll-sass-converter (1.5.0)
+      sass (~> 3.4)
+    jekyll-watch (1.5.0)
+      listen (~> 3.0, < 3.1)
+    kramdown (1.14.0)
+    liquid (4.0.0)
+    listen (3.0.8)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    mercenary (0.3.6)
+    minima (2.1.1)
+      jekyll (~> 3.3)
+    pathutil (0.14.0)
+      forwardable-extended (~> 2.6)
+    public_suffix (2.0.5)
+    rb-fsevent (0.10.2)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rouge (1.11.1)
+    safe_yaml (1.0.4)
+    sass (3.5.1)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jekyll (= 3.5.2)
+  jekyll-feed (~> 0.6)
+  minima (~> 2.0)
+  tzinfo-data
+
+BUNDLED WITH
+   1.15.3

docs/_config.yml

@@ -0,0 +1,43 @@
+# Welcome to Jekyll!
+#
+# This config file is meant for settings that affect your whole blog, values
+# which you are expected to set up once and rarely edit after that. If you find
+# yourself editing this file very often, consider using Jekyll's data files
+# feature for the data you need to update frequently.
+#
+# For technical reasons, this file is *NOT* reloaded automatically when you use
+# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
+
+# Site settings
+# These are used to personalize your new site. If you look in the HTML files,
+# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
+# You can create any custom variable you would like, and they will be accessible
+# in the templates via {{ site.myvariable }}.
+title: Abacus
+email: danila.fedorin@gmail.com
+description: > # this means to ignore newlines until "baseurl:"
+  This is the home page of Abacus,
+  a calculator developed during
+  the summer of 2017 as a tool
+  for the more tech-savvy users.
+baseurl: "/abacus" # the subpath of your site, e.g. /blog
+url: "htts://danilafe.github.io" # the base hostname & protocol for your site, e.g. http://example.com
+github_username: DanilaFe 
+include: ['_pages']
+
+# Build settings
+markdown: kramdown
+plugins:
+  - jekyll-feed
+
+# Exclude from processing.
+# The following items will not be processed, by default. Create a custom list
+# to override the default setting.
+# exclude:
+#   - Gemfile
+#   - Gemfile.lock
+#   - node_modules
+#   - vendor/bundle/
+#   - vendor/cache/
+#   - vendor/gems/
+#   - vendor/ruby/

docs/_includes/head.html

@@ -0,0 +1,17 @@
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+
+  <title>{% if page.title %}{{ page.title | escape }}{% else %}{{ site.title | escape }}{% endif %}</title>
+  <meta name="description" content="{{ page.excerpt | default: site.description | strip_html | normalize_whitespace | truncate: 160 | escape }}">
+
+  <link rel="stylesheet" href="{{ "assets/css/main.css" | relative_url }}">
+  <link rel="canonical" href="{{ page.url | replace:'index.html','' | absolute_url }}">
+  <link rel="alternate" type="application/rss+xml" title="{{ site.title | escape }}" href="{{ "/feed.xml" | relative_url }}">
+  
+  {% if jekyll.environment == 'production' and site.google_analytics %}
+  {% include google-analytics.html %}
+  {% endif %}
+</head>
+

docs/_includes/header.html

@@ -0,0 +1,10 @@
+<nav>
+  <div class="center">
+    <a href="{{ "/" | relative_url }}" class="primary-link">{{ site.title }}</a>
+    {% for page in site.pages %}
+    {% if page.in_header %}
+    <a href="{{ page.url | relative_url }}">{{ page.title }}</a>
+    {% endif %}
+    {% endfor %}
+  </div>
+</nav>

docs/_layouts/base.html

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+
+  {% include head.html %}
+
+  <body>
+    {% include header.html %}
+
+    <div class="content center">
+      {{ content }}
+    </div>
+
+    {% include footer.html %}
+  </body>
+
+
+</html>

docs/_layouts/home.html

@@ -0,0 +1,46 @@
+<!DOCTYPE html>
+<html>
+  {% include head.html %}
+  <style>
+  body {
+    margin-top: 100px;
+    color: white;
+    text-align: center;
+  }
+  h1, h2, h3, h4, h5, h6 {
+    font-family: "Source Code Pro"
+  }
+
+  img {
+    margin: auto;
+    width: 100%;
+    max-width: 432px;
+  }
+
+  div#buttons {
+    margin-top: 40px;
+    margin-bottom: 40px;
+  }
+
+  a {
+    background-color: white;
+    color: #06e8a4;
+  }
+
+  a:hover {
+    background-color: #06e8a4;
+    color: white;
+  }
+  </style>
+  <body>
+  <h1>Abacus</h1>
+  <h2>The programmer's calculator</h2>
+  <div id="buttons">
+    <a class="button inverted" href="{{ "/download" | relative_url }}">Download</a>
+    <a class="button inverted" href="{{ "/about" | relative_url }}">About</a>
+    <a class="button inverted" href="https://github.com/DanilaFe/abacus">Contribute</a>
+    <a class="button inverted" href="https://github.com/DanilaFe/abacus/wiki">Wiki</a>
+  </div>
+  <img src="http://i.imgur.com/Min70QY.png" title="source: imgur.com" />
+  </body>
+</html>

docs/_layouts/page.html

@@ -0,0 +1,5 @@
+---
+layout: base
+---
+<h1>{{ page.title }}</h1>
+{{ content }}

docs/_pages/about.md

@@ -0,0 +1,27 @@
+---
+in_header: true
+layout: page
+title: About
+permalink: /about/
+---
+
+## So... what IS Abacus?
+It's a calculator. Obviously. But what makes it better than
+what already exists? There's a few things. Abacus is:
+* Programmable, and not in TI Basic.
+* Precise. With the "precise" option, Abacus can keep up to 50 significant figures.
+* Capable. Ever wonder what 2<sup>700</sup> is? How about 8!!? Abacus can tell you!
+* Offline. While Wolfram Alpha can do powerful math, it needs internet connection!
+* Built for the desktop. Why use buttons on the screen when there's buttons on the keyboard?
+* Open source. Don't like something? Help is always welcome!
+
+## Why was Abacus made?
+The initial project was proposed for the [Northwest Advanced Programming Workshop](http://nwapw.org/about/).
+You can read the project proposal on the main GitHub page, although the idea has
+changed quite a bit, mostly in shifting from "fast" to "precise".
+
+## What is Abacus made with?
+Java and Kotlin. Java provides a good layer of abstraction and a great standard
+library, while Kotlin allows for the reduction of boilerplate code and null
+safety. Using JVM-based languages also allows Abacus to expose its entire
+API to plugins, and load them at runtime.

docs/_pages/download.md

@@ -0,0 +1,34 @@
+---
+in_header: true
+layout: page
+title: Download
+permalink: /download/
+---
+
+Currently, we do not provide standalone executables due to our unfamiliarity with
+including 3rd-party software. Abacus uses a number of open source libraries,
+and we do not want to breach the license terms for any of them. As soon as
+as we figure out the correct way to distribute Abacus, we will make a
+standalone distribution available. In the meantime, please use the below
+steps to run Abacus from source.
+
+## Getting the Code
+Abacus is an open source project, and is distributed under the MIT license.
+If you would like to download the source code, simply clone it from
+[GitHub](https://github.com/DanilaFe/abacus).
+Alternatively, if you don't want the bleeding edge version, check out the
+[releases](https://github.com/DanilaFe/abacus/releases).
+
+## Running from Source
+Once you have unpacked the source code, you can simply run it from
+the command line via the shell command:
+```
+./gradlew run
+```
+If you're on Windows, the command is similar:
+```
+gradlew run
+```
+This should download a distribution of Gradle, a build system that is
+used to compile Abacus. After some time, the Abacus window should appear.
+From there, you can use it normally.

docs/assets/css/main.scss

@@ -0,0 +1,119 @@
+---
+---
+@import url('https://fonts.googleapis.com/css?family=Source+Code+Pro|Open+Sans|Raleway');
+
+$background-color: #19d69e;
+$code-color: #efefef;
+$accent-color: #00AFE8;
+$clear-color: white;
+$title-font: "Open Sans";
+$text-font: Helvetica;
+$code-font: "Source Code Pro";
+$max-width: 850px;
+
+a {
+  text-decoration: none;
+  color: $background-color;
+
+  &.button {
+    display: inline-block;
+    background-color: $background-color;
+    color: $clear-color;
+    padding: 10px;
+    text-decoration: none;
+    border-radius: 2px;
+
+    margin: 10px;
+    transition: background-color .25s;
+
+    &:hover {
+      background-color: $clear-color;
+      color: $background-color;
+    }
+
+    &.inverted {
+      background-color: $clear-color;
+      color: $background-color;
+
+      &:hover {
+        background-color: $background-color;
+        color: $clear-color;
+      }
+    }
+  }
+}
+
+h1, h2, h3, h4, h5, h6 {
+  font: {
+    family: $title-font;
+  }
+}
+
+h1 {
+  font-size: 50px;
+}
+
+nav {
+  box-sizing: border-box;
+  background-color: $clear-color;
+  width: 100%;
+  padding: 20px;
+
+  a {
+    text-decoration: none;
+    color: $background-color;
+    font-size: 20px;
+    margin-right: 10px;
+
+    &.primary-link {
+      font-size: 30px;
+      margin-right: 20px;
+    }
+
+    &:hover {
+      color: $accent-color;
+    }
+
+    transition: color .25s;
+  }
+}
+
+body {
+  background-color: $background-color;
+  font: {
+    family: $text-font;
+  }
+  margin: 0px;
+}
+
+.center {
+  box-sizing: border-box;
+  width: 100%;
+  max-width: $max-width;
+
+  @media (min-width: $max-width) {
+    margin: {
+      left: auto;
+      right: auto;
+    }
+  }
+}
+
+.content {
+  margin-top: 20px;
+  padding: 30px;
+  background-color: $clear-color;
+}
+
+code {
+  background-color: $code-color;
+  display: inline-block;
+  padding: 5px;
+  font-family: $code-font;
+
+  pre & {
+    padding: 10px;
+    display: block;
+    width: 100%;
+  }
+}

docs/index.md

@@ -0,0 +1,6 @@
+---
+# You don't need to edit this file, it's empty on purpose.
+# Edit theme's home layout instead if you wanna make some changes
+# See: https://jekyllrb.com/docs/themes/#overriding-theme-defaults
+layout: home
+---

fx/build.gradle

@@ -1,6 +1,3 @@
-plugins {
-  id 'org.jetbrains.kotlin.jvm' version '1.1.3'
-}
 apply plugin: 'application'
 
 dependencies {

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

@@ -17,6 +17,10 @@ public class AbacusApplication extends Application {
      */
     private AbacusController controller;
 
+    public static void main(String[] args) {
+        launch(args);
+    }
+
     @Override
     public void start(Stage primaryStage) throws Exception {
         FXMLLoader loader = new FXMLLoader(getClass().getResource("/abacus.fxml"));
@@ -34,8 +38,4 @@ public class AbacusApplication extends Application {
         controller.performStop();
     }
 
-    public static void main(String[] args){
-        launch(args);
-    }
-
 }

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

@@ -1,13 +1,10 @@
 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.collections.transformation.FilteredList;
 import javafx.fxml.FXML;
-import javafx.scene.Node;
 import javafx.scene.control.*;
 import javafx.scene.control.cell.CheckBoxListCell;
 import javafx.scene.text.Text;
@@ -136,30 +133,6 @@ public class AbacusController implements PluginListener {
      * The abacus instance used for changing the plugin configuration.
      */
     private Abacus abacus;
-
-    /**
-     * Boolean which represents whether changes were made to the configuration.
-     */
-    private boolean changesMade;
-    /**
-     * Whether an alert about changes to the configuration was already shown.
-     */
-    private boolean reloadAlertShown;
-    /**
-     * 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.
      */
@@ -197,6 +170,18 @@ public class AbacusController implements PluginListener {
             });
         }
     };
+    /**
+     * Boolean which represents whether changes were made to the configuration.
+     */
+    private boolean changesMade;
+    /**
+     * Whether an alert about changes to the configuration was already shown.
+     */
+    private boolean reloadAlertShown;
+    /**
+     * The alert shown when a press to "apply" is needed.
+     */
+    private Alert reloadAlert;
     /**
      * The thread that is waiting to pause the calculation.
      */
@@ -205,6 +190,18 @@ public class AbacusController implements PluginListener {
      * The thread in which the computation runs.
      */
     private Thread calculationThread;
+    /**
+     * 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) {
+        }
+    };
 
     /**
      * Alerts the user if the changes they made