change how new prefs are loaded and platform-specific handling

benfry · benfry · commit 71b87e93cb84 · 2015-04-09T15:00:03.000-04:00
diff --git a/app/src/processing/app/Preferences.java b/app/src/processing/app/Preferences.java
@@ -50,7 +50,7 @@ public class Preferences {
   static final String PREFS_FILE = "preferences.txt"; //$NON-NLS-1$
 
   static HashMap<String, String> defaults;
-  static HashMap<String, String> table = new HashMap<String,String>();
+  static HashMap<String, String> table = new HashMap<String, String>();
   static File preferencesFile;
 
   static final String PROMPT_YES     = Language.text("prompt.yes");
@@ -66,9 +66,6 @@ public class Preferences {
   static public int BUTTON_WIDTH =
     Integer.parseInt(Language.text("preferences.button.width"));
 
-//  /** height of the EditorHeader, EditorToolbar, and EditorStatus */
-//  static final int GRID_SIZE = 32;
-
   // Indents and spacing standards. These probably need to be modified
   // per platform as well, because Mac OS X is so huge, Windows is smaller,
   // and Linux is all over the map. Consider these deprecated.
@@ -90,6 +87,8 @@ static public void init() {
                            "You'll need to reinstall Processing.", e);
     }
 
+    /* provisionally removed in 3.0a6, see changes in load()
+
     // check for platform-specific properties in the defaults
     String platformExt = "." + PConstants.platformNames[PApplet.platform]; //$NON-NLS-1$
     int platformExtLength = platformExt.length();
@@ -109,9 +108,10 @@ static public void init() {
       String value = get(key);
       set(actualKey, value);
     }
+    */
 
-    // clone the hash table
-    //defaults = (HashMap<String, String>) table.clone();
+    // 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<String, String>(table);
 
     // other things that have to be set explicitly for the defaults
@@ -158,10 +158,19 @@ static protected String getPreferencesPath() {
   }
 
 
-  // .................................................................
+  // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
 
 
+  /**
+   * 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) ||
@@ -172,13 +181,46 @@ static public void load(InputStream input) throws IOException {
       if (equals != -1) {
         String key = line.substring(0, equals).trim();
         String value = line.substring(equals + 1).trim();
-        table.put(key, value);
+        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
+   * @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 protected void save() {
@@ -191,6 +233,7 @@ static protected void save() {
     PrintWriter writer = PApplet.createWriter(preferencesFile);
 
     String[] keyList = table.keySet().toArray(new String[table.size()]);
+    // 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$
@@ -201,7 +244,7 @@ static protected void save() {
   }
 
 
-  // .................................................................
+  // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
 
 
   // all the information from preferences.txt
