Did some API design for user settings, and moved GUI to a new package

6 files changed, 420 insertions, 0 deletions

diff --git a/src/main/java/sevenUnitsGUI/ExpressionConversionView.java b/src/main/java/sevenUnitsGUI/ExpressionConversionView.java
new file mode 100644
index 0000000..5a587d4
--- /dev/null
+++ b/src/main/java/sevenUnitsGUI/ExpressionConversionView.java
@@ -0,0 +1,48 @@
+/**
+ * Copyright (C) 2021 Adrien Hopkins
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package sevenUnitsGUI;
+
+/**
+ * A View that can convert unit expressions
+ * 
+ * @author Adrien Hopkins
+ * @since 2021-12-15
+ */
+public interface ExpressionConversionView extends View {
+	/**
+	 * @return unit expression to convert <em>from</em>
+	 * @since 2021-12-15
+	 */
+	String getFromExpression();
+	
+	/**
+	 * @return unit expression to convert <em>to</em>
+	 * @since 2021-12-15
+	 */
+	String getToExpression();
+	
+	/**
+	 * Shows the output of an expression conversion to the user.
+	 * 
+	 * @param fromExpression expression converted from
+	 * @param toExpression   expression converted to
+	 * @param value          conversion factor between two expressions
+	 * @since 2021-12-15
+	 */
+	void showExpressionConversionOutput(String fromExpression,
+			String toExpression, double value);
+}
diff --git a/src/main/java/sevenUnitsGUI/Presenter.java b/src/main/java/sevenUnitsGUI/Presenter.java
new file mode 100644
index 0000000..4373049
--- /dev/null
+++ b/src/main/java/sevenUnitsGUI/Presenter.java
@@ -0,0 +1,146 @@
+/**
+ * Copyright (C) 2021 Adrien Hopkins
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package sevenUnitsGUI;
+
+import java.util.List;
+import java.util.function.Function;
+import java.util.function.Predicate;
+
+import sevenUnits.unit.UnitDatabase;
+import sevenUnits.unit.UnitPrefix;
+import sevenUnits.utils.UncertainDouble;
+
+/**
+ * An object that handles interactions between the view and the backend code
+ * 
+ * @author Adrien Hopkins
+ * @since 2021-12-15
+ */
+public final class Presenter {
+	/**
+	 * The view that this presenter communicates with
+	 */
+	private final View view;
+	
+	/**
+	 * The database that this presenter communicates with (effectively the model)
+	 */
+	private final UnitDatabase database;
+	
+	// ====== SETTINGS ======
+	
+	/**
+	 * The rule used for parsing input numbers. Any number-string inputted into
+	 * this program will be parsed using this method.
+	 */
+	private Function<String, UncertainDouble> numberParsingRule;
+	
+	/**
+	 * The rule used for displaying the results of unit conversions. The result
+	 * of unit conversions will be put into this function, and the resulting
+	 * string will be used in the output.
+	 */
+	private Function<UncertainDouble, String> numberDisplayRule;
+	
+	/**
+	 * A predicate that determines whether or not a certain combination of
+	 * prefixes is allowed. If it returns false, a combination of prefixes will
+	 * not be allowed. Prefixes are put in the list from right to left.
+	 */
+	private Predicate<List<UnitPrefix>> prefixRepetitionRule;
+	
+	/**
+	 * If this is true, views that show units as a list will have metric units
+	 * removed from the From unit list and imperial/USC units removed from the To
+	 * unit list.
+	 */
+	private boolean oneWayConversion;
+	
+	/**
+	 * If this is false, duplicate units will be removed from the unit view in
+	 * views that show units as a list to choose from.
+	 */
+	private boolean showDuplicateUnits;
+	
+	/**
+	 * Creates a Presenter
+	 * 
+	 * @param view the view that this presenter communicates with
+	 * @since 2021-12-15
+	 */
+	public Presenter(View view) {
+		this.view = view;
+		this.database = new UnitDatabase();
+	}
+	
+	/**
+	 * Sets the dimension of the view's From and To units.
+	 * 
+	 * @throws UnsupportedOperationException if the view does not support
+	 *                                       unit-based conversion (does not
+	 *                                       implement
+	 *                                       {@link UnitConversionView})
+	 * @since 2021-12-15
+	 */
+	public void applyDimensionFilter() {}
+	
+	/**
+	 * Gets settings from the view and applies them to both view and presenter.
+	 * 
+	 * @since 2021-12-15
+	 */
+	public void applySettings() {}
+	
+	/**
+	 * Converts from the view's input expression to its output expression.
+	 * Displays an error message if any of the required fields are invalid.
+	 * 
+	 * @throws UnsupportedOperationException if the view does not support
+	 *                                       expression-based conversion (does
+	 *                                       not implement
+	 *                                       {@link ExpressionConversionView})
+	 * @since 2021-12-15
+	 */
+	public void convertExpressions() {}
+	
+	/**
+	 * Converts from the view's input unit to its output unit. Displays an error
+	 * message if any of the required fields are invalid.
+	 * 
+	 * @throws UnsupportedOperationException if the view does not support
+	 *                                       unit-based conversion (does not
+	 *                                       implement
+	 *                                       {@link UnitConversionView})
+	 * @since 2021-12-15
+	 */
+	public void convertUnits() {}
+	
+	/**
+	 * Loads settings from the user's settings file and applies them to the view.
+	 * 
+	 * @since 2021-12-15
+	 */
+	public void loadSettings() {}
+	
+	/**
+	 * Gets user settings from the view then saves them to the user's settings
+	 * file.
+	 * 
+	 * @since 2021-12-15
+	 */
+	public void saveSettings() {}
+}
diff --git a/src/main/java/sevenUnitsGUI/StandardDisplayRules.java b/src/main/java/sevenUnitsGUI/StandardDisplayRules.java
new file mode 100644
index 0000000..331f598
--- /dev/null
+++ b/src/main/java/sevenUnitsGUI/StandardDisplayRules.java
@@ -0,0 +1,74 @@
+/**
+ * Copyright (C) 2021 Adrien Hopkins
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package sevenUnitsGUI;
+
+import java.util.function.Function;
+
+import sevenUnits.utils.UncertainDouble;
+
+/**
+ * The default rules for displaying numbers.
+ * 
+ * Unless otherwise stated, all of this class's functions throw
+ * {@link NullPointerException} when they receive a null parameter.
+ *
+ * @since 2021-12-24
+ */
+final class StandardDisplayRules {
+	/**
+	 * Rounds using UncertainDouble's toString method.
+	 */
+	private static final Function<UncertainDouble, String> SCIENTIFIC_ROUNDING_RULE = new Function<>() {
+		@Override
+		public String apply(UncertainDouble t) {
+			return t.toString(false);
+		}
+		
+		@Override
+		public String toString() {
+			return "Scientific Rounding";
+		}
+	};
+	
+	/**
+	 * @return a rule that rounds using UncertainDouble's own toString(false)
+	 *         function.
+	 * @since 2021-12-24
+	 */
+	public static final Function<UncertainDouble, String> getScientificRule() {
+		return SCIENTIFIC_ROUNDING_RULE;
+	}
+	
+	/**
+	 * Gets one of the standard rules from its string representation.
+	 *
+	 * @param ruleToString string representation of the display rule
+	 * @return display rule
+	 * @throws IllegalArgumentException if the provided string is not that of a
+	 *                                  standard rule.
+	 * @since 2021-12-24
+	 */
+	public static final Function<UncertainDouble, String> getStandardRule(
+			String ruleToString) {
+		throw new UnsupportedOperationException("Not implemented yet");
+	}
+	
+	private StandardDisplayRules() {
+		throw new AssertionError(
+				"This is a static utility class, you may not get instances of it.");
+	}
+}
diff --git a/src/main/java/sevenUnitsGUI/UnitConversionView.java b/src/main/java/sevenUnitsGUI/UnitConversionView.java
new file mode 100644
index 0000000..f653051
--- /dev/null
+++ b/src/main/java/sevenUnitsGUI/UnitConversionView.java
@@ -0,0 +1,94 @@
+/**
+ * Copyright (C) 2021 Adrien Hopkins
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package sevenUnitsGUI;
+
+import java.util.List;
+import java.util.Optional;
+
+import sevenUnits.unit.BaseDimension;
+import sevenUnits.unit.Unit;
+import sevenUnits.utils.NamedObjectProduct;
+import sevenUnits.utils.ObjectProduct;
+
+/**
+ * A View that supports single unit-based conversion
+ * 
+ * @author Adrien Hopkins
+ * @since 2021-12-15
+ */
+public interface UnitConversionView extends View {
+	/**
+	 * @return unit to convert <em>from</em>
+	 * @since 2021-12-15
+	 */
+	Optional<Unit> getFromSelection();
+	
+	/**
+	 * @return value to convert between the units (specifically, the numeric
+	 *         string provided by the user)
+	 * @since 2021-12-15
+	 */
+	Optional<String> getInputValue();
+	
+	/**
+	 * @return selected dimension
+	 * @since 2021-12-15
+	 */
+	Optional<ObjectProduct<BaseDimension>> getSelectedDimension();
+	
+	/**
+	 * @return unit to convert <em>to</em>
+	 * @since 2021-12-15
+	 */
+	Optional<Unit> getToSelection();
+	
+	/**
+	 * Sets the available dimensions for filtering.
+	 *
+	 * @param dimensions dimensions to use
+	 * @since 2021-12-15
+	 */
+	void setDimensions(List<NamedObjectProduct<BaseDimension>> dimensions);
+	
+	/**
+	 * Sets the available units to convert from. {@link #getFromSelection} is not
+	 * required to use one of these units; this method is to be used for views
+	 * that allow the user to select units from a list.
+	 *
+	 * @param units units to convert from
+	 * @since 2021-12-15
+	 */
+	void setFromUnits(List<? extends Unit> units);
+	
+	/**
+	 * Sets the available units to convert to. {@link #getToSelection} is not
+	 * required to use one of these units; this method is to be used for views
+	 * that allow the user to select units from a list.
+	 *
+	 * @param units units to convert to
+	 * @since 2021-12-15
+	 */
+	void setToUnits(List<? extends Unit> units);
+	
+	/**
+	 * Shows the output of a unit conversion.
+	 * 
+	 * @param outputString string that shows output of conversion
+	 * @since 2021-12-24
+	 */
+	void showUnitConversionOutput(String outputString);
+}
diff --git a/src/main/java/sevenUnitsGUI/View.java b/src/main/java/sevenUnitsGUI/View.java
new file mode 100644
index 0000000..a93c76a
--- /dev/null
+++ b/src/main/java/sevenUnitsGUI/View.java
@@ -0,0 +1,35 @@
+/**
+ * Copyright (C) 2021 Adrien Hopkins
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package sevenUnitsGUI;
+
+/**
+ * An object that controls user interaction with 7Units
+ * 
+ * @author Adrien Hopkins
+ * @since 2021-12-15
+ */
+public interface View {
+	/**
+	 * Shows an error message.
+	 *
+	 * @param title   title of error message; on any view that uses an error
+	 *                dialog, this should be the title of the error dialog.
+	 * @param message error message
+	 * @since 2021-12-15
+	 */
+	void showErrorMessage(String title, String message);
+}
diff --git a/src/main/java/sevenUnitsGUI/package-info.java b/src/main/java/sevenUnitsGUI/package-info.java
new file mode 100644
index 0000000..cff1ded
--- /dev/null
+++ b/src/main/java/sevenUnitsGUI/package-info.java
@@ -0,0 +1,23 @@
+/**
+ * Copyright (C) 2021 Adrien Hopkins
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+/**
+ * The MVP GUI of SevenUnits
+ * 
+ * @author Adrien Hopkins
+ * @since 2021-12-15
+ */
+package sevenUnitsGUI;
\ No newline at end of file