migrating Preferences class into stand-alone version

Author: AhmedMagedC

app/build.gradle.kts

@@ -97,6 +97,8 @@ compose.desktop {
 
 dependencies {
     implementation(project(":core"))
+    implementation(project(":app:utils"))
+
     runtimeOnly(project(":java"))
 
     implementation(libs.flatlaf)

app/src/processing/app/Preferences.java

@@ -24,11 +24,10 @@
 import java.awt.Color;
 import java.awt.Font;
 import java.awt.SystemColor;
-import java.io.*;
-import java.util.*;
 
 import processing.app.ui.Toolkit;
 import processing.core.*;
+import processing.utils.PreferencesException;
 
 
 /**
@@ -47,36 +46,19 @@
  * such things, we could start using the Java Preferences API. But wow, that
  * sounds like a lot of work. Not unlike writing this paragraph.
  */
-public class Preferences {
-  // had to rename the defaults file because people were editing it
-  static final String DEFAULTS_FILE = "defaults.txt"; //$NON-NLS-1$
-  static final String PREFS_FILE = "preferences.txt"; //$NON-NLS-1$
+public class Preferences extends processing.utils.Preferences {
 
-  static Map<String, String> defaults;
-  static Map<String, String> table = new HashMap<>();
-  static File preferencesFile;
-  private static boolean initialized = false;
-
-
-//  /** @return true if the sketchbook file did not exist */
-//  static public boolean init() {
   static public void init() {
-    initialized = true;
-    // start by loading the defaults, in case something
-    // important was deleted from the user prefs
+    processing.utils.Preferences.initialized = true;
+
     try {
-      // Name changed for 2.1b2 to avoid problems with users modifying or
-      // replacing the file after doing a search for "preferences.txt".
-      load(Base.getLibStream(DEFAULTS_FILE));
-    } catch (Exception e) {
-      Messages.showError(null, "Could not read default settings.\n" +
-                         "You'll need to reinstall Processing.", e);
+      // start by loading the defaults, in case something
+      // important was deleted from the user prefs
+      loadDefaults();
+    } catch (PreferencesException e) {
+      Messages.showError(e.getTitle(), e.getMessage(), e);
     }
 
-    // Clone the defaults, then override any them with the user's preferences.
-    // This ensures that any new/added preference will be present.
-    defaults = new HashMap<>(table);
-
     // other things that have to be set explicitly for the defaults
     setColor("run.window.bgcolor", SystemColor.control); //$NON-NLS-1$
 
@@ -86,21 +68,15 @@ static public void init() {
     }
 
     // next load user preferences file
-    preferencesFile = Base.getSettingsFile(PREFS_FILE);
-    boolean firstRun = !preferencesFile.exists();
-    if (!firstRun) {
-      try {
-        load(new FileInputStream(preferencesFile));
-
-      } catch (Exception ex) {
-        Messages.showError("Error reading preferences",
-                           "Error reading the preferences file. " +
-                           "Please delete (or move)\n" +
-                           preferencesFile.getAbsolutePath() +
-                           " and restart Processing.", ex);
-      }
+    Preferences.setPreferencesFolder(Base.getSettingsFolder());
+    try {
+      loadPreferences();
+    } catch (PreferencesException e) {
+      Messages.showError(e.getTitle(), e.getMessage(), e);
     }
 
+    boolean firstRun = !getPreferencesFile().exists();
+
     if (checkSketchbookPref() || firstRun) {
 //    if (firstRun) {
       // create a new preferences file if none exists
@@ -129,14 +105,6 @@ static public void init() {
   }
 
 
-  /**
-   * For testing, pretend to load preferences without a real file.
-   */
-  static public void skipInit() {
-    initialized = true;
-  }
-
-
   static void handleProxy(String protocol, String hostProp, String portProp) {
     String proxyHost = get("proxy." + protocol + ".host");
     String proxyPort = get("proxy." + protocol + ".port");
@@ -149,185 +117,15 @@ static void handleProxy(String protocol, String hostProp, String portProp) {
   }
 
 
-  static public String getPreferencesPath() {
-    return preferencesFile.getAbsolutePath();
-  }
-
-
-  // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
-
-
-  /**
-   * Load a set of key/value pairs from a UTF-8 encoded file into 'table'.
-   * For 3.0a6, this removes any platform-specific extensions from keys, so
-   * that we don't have platform-specific entries in a user's preferences.txt
-   * file, which would require all prefs to be changed twice, or risk being
-   * overwritten by the unchanged platform-specific version on reload.
-   */
-  static public void load(InputStream input) throws IOException {
-    HashMap<String, String> platformSpecific = new HashMap<>();
-
-    String[] lines = PApplet.loadStrings(input);  // Reads as UTF-8
-    for (String line : lines) {
-      if ((line.length() == 0) ||
-          (line.charAt(0) == '#')) continue;
-
-      // this won't properly handle = signs being in the text
-      int equals = line.indexOf('=');
-      if (equals != -1) {
-        String key = line.substring(0, equals).trim();
-        String value = line.substring(equals + 1).trim();
-        if (!isPlatformSpecific(key, value, platformSpecific)) {
-          table.put(key, value);
-        }
-      }
-    }
-    // Now override the keys with any platform-specific defaults we've found.
-    for (String key : platformSpecific.keySet()) {
-      table.put(key, platformSpecific.get(key));
-    }
-  }
-
-
-  /**
-   * @param key original key (may include platform extension)
-   * @param value the value that goes with the key
-   * @param specific where to put the key/value pairs for *this* platform
-   * @return true if a platform-specific key
-   */
-  static protected boolean isPlatformSpecific(String key, String value,
-                                              Map<String, String> specific) {
-    for (String platform : PConstants.platformNames) {
-      String ext = "." + platform;
-      if (key.endsWith(ext)) {
-        String thisPlatform = PConstants.platformNames[PApplet.platform];
-        if (platform.equals(thisPlatform)) {
-          key = key.substring(0, key.lastIndexOf(ext));
-          // store this for later overrides
-          specific.put(key, value);
-        //} else {
-          // ignore platform-specific defaults for other platforms,
-          // but return 'true' because it needn't be added to the big list
-        }
-        return true;
-      }
-    }
-    return false;
-  }
-
-
-  // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
-
-
-  static public void save() {
-    // On startup, this is null, but ignore it. It's trying to update the
-    // prefs for the open sketch before Preferences.init() has been called.
-    if (preferencesFile != null) {
-      try {
-        File dir = preferencesFile.getParentFile();
-        File preferencesTemp = File.createTempFile("preferences", ".txt", dir);
-        if (!preferencesTemp.setWritable(true, false)) {
-          throw new IOException("Could not set " + preferencesTemp + " writable");
-        }
-
-        // Fix for 0163 to properly use Unicode when writing preferences.txt
-        PrintWriter writer = PApplet.createWriter(preferencesTemp);
-
-        String[] keyList = table.keySet().toArray(new String[0]);
-        // Sorting is really helpful for debugging, diffing, and finding keys
-        keyList = PApplet.sort(keyList);
-        for (String key : keyList) {
-          writer.println(key + "=" + table.get(key)); //$NON-NLS-1$
-        }
-        writer.flush();
-        writer.close();
-
-        // Rename preferences.txt to preferences.old
-        File oldPreferences = new File(dir, "preferences.old");
-        if (oldPreferences.exists()) {
-          if (!oldPreferences.delete()) {
-            throw new IOException("Could not delete preferences.old");
-          }
-        }
-        if (preferencesFile.exists() &&
-            !preferencesFile.renameTo(oldPreferences)) {
-          throw new IOException("Could not replace preferences.old");
-        }
-        // Make the temporary file into the real preferences
-        if (!preferencesTemp.renameTo(preferencesFile)) {
-          throw new IOException("Could not move preferences file into place");
-        }
-
-      } catch (IOException e) {
-        Messages.showWarning("Preferences",
-                             "Could not save the Preferences file.", e);
-      }
-    }
-  }
-
-
-  // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
-
-
-  // all the information from preferences.txt
-
-  static public String get(String attribute /*, String defaultValue */) {
-    if (!initialized) {
-      throw new RuntimeException(
-        "Tried reading preferences prior to initialization."
-      );
-    }
-    return table.get(attribute);
-  }
-
-
-  static public String getDefault(String attribute) {
-    return defaults.get(attribute);
-  }
-
-
-  static public void set(String attribute, String value) {
-    table.put(attribute, value);
-  }
-
-
-  static public void unset(String attribute) {
-    table.remove(attribute);
-  }
-
-
-  static public boolean getBoolean(String attribute) {
-    String value = get(attribute); //, null);
-    return Boolean.parseBoolean(value);
-
-    /*
-      supposedly not needed, because anything besides 'true'
-      (ignoring case) will just be false.. so if malformed -> false
-    if (value == null) return defaultValue;
-
+  static public void save(){
     try {
-      return (new Boolean(value)).booleanValue();
-    } catch (NumberFormatException e) {
-      System.err.println("expecting an integer: " + attribute + " = " + value);
+      processing.utils.Preferences.save();
+    } catch (PreferencesException e ) {
+      Messages.showWarning(e.getTitle(), e.getMessage(), e);
     }
-    return defaultValue;
-    */
-  }
-
-
-  static public void setBoolean(String attribute, boolean value) {
-    set(attribute, value ? "true" : "false"); //$NON-NLS-1$ //$NON-NLS-2$
-  }
-
-
-  static public int getInteger(String attribute /*, int defaultValue*/) {
-    return Integer.parseInt(get(attribute));
   }
 
-
-  static public void setInteger(String key, int value) {
-    set(key, String.valueOf(value));
-  }
+  // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
 
 
   static public Color getColor(String name) {
@@ -358,41 +156,4 @@ static public Font getFont(String familyAttr, String sizeAttr, int style) {
     return new Font(fontFamily, style, fontSize);
   }
 
-
-  // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
-
-
-  /**
-   * Check for a 4.0 sketchbook location, and if none exists,
-   * try to grab it from the 3.0 sketchbook location.
-   * @return true if a location was found and the pref didn't exist
-   */
-  static protected boolean checkSketchbookPref() {
-    // If a 4.0 sketchbook location has never been inited
-    if (getSketchbookPath() == null) {
-      String threePath = get("sketchbook.path.three"); //$NON-NLS-1$
-      // If they've run the 3.0 version, start with that location
-      if (threePath != null) {
-        setSketchbookPath(threePath);
-        return true;  // save the sketchbook right away
-      }
-      // Otherwise it'll be null, and reset properly by Base
-    }
-    return false;
-  }
-
-
-  static public String getOldSketchbookPath() {
-    return get("sketchbook.path.three"); //$NON-NLS-1$
-  }
-
-
-  static public String getSketchbookPath() {
-    return get("sketchbook.path.four"); //$NON-NLS-1$
-  }
-
-
-  static protected void setSketchbookPath(String path) {
-    set("sketchbook.path.four", path); //$NON-NLS-1$
-  }
 }

app/utils/build.gradle.kts

@@ -0,0 +1,40 @@
+plugins {
+    id("java")
+    kotlin("jvm") version libs.versions.kotlin
+}
+
+repositories{
+    mavenCentral()
+    google()
+    maven { url = uri("https://jogamp.org/deployment/maven") }
+}
+
+sourceSets{
+    main{
+        java{
+            srcDirs("src")
+        }
+        kotlin {
+            srcDirs("src")
+        }
+        resources {
+            srcDirs("src/resources")
+        }
+    }
+    test{
+        kotlin{
+            srcDirs("test")
+        }
+    }
+}
+
+dependencies {
+    implementation(project(":core"))
+
+    testImplementation(platform("org.junit:junit-bom:5.10.0"))
+    testImplementation("org.junit.jupiter:junit-jupiter")
+}
+
+tasks.test {
+    useJUnitPlatform()
+}