Changeset 9821 in josm for trunk/src/org/openstreetmap/josm/data/preferences

Timestamp:

2016-02-18T11:07:38+01:00 (8 years ago)

Author:

bastiK

Message:

fixed #12522 - Advanced preferences: display default entries consistently

Saves default preference entries to a cache file (cache/default_preferences.xml), so the list of advanced preferences is filled with all known default values consistently from the start and not gradually as you use different features during a session.

Location:

trunk/src/org/openstreetmap/josm/data/preferences

Files:

• AbstractSetting.java (modified) (3 diffs)
• PreferencesReader.java (modified) (6 diffs)
• Setting.java (modified) (2 diffs)

trunk/src/org/openstreetmap/josm/data/preferences/AbstractSetting.java

@@ -12 +12 @@
 public abstract class AbstractSetting<T> implements Setting<T> {
     protected final T value;
+    protected Long time;
+    protected boolean isNew;
     /**
      * Constructs a new {@code AbstractSetting} with the given value
@@ -18 +20 @@
     public AbstractSetting(T value) {
         this.value = value;
+        this.time = null;
+        this.isNew = false;
     }
 
@@ -23 +27 @@
     public T getValue() {
         return value;
+    }
+
+    @Override
+    public void setTime(Long time) {
+        this.time = time;
+    }
+
+    @Override
+    public Long getTime() {
+        return this.time;
+    }
+
+    @Override
+    public void setNew(boolean isNew) {
+        this.isNew = isNew;
+    }
+
+    @Override
+    public boolean isNew() {
+        return isNew;
     }
 

trunk/src/org/openstreetmap/josm/data/preferences/PreferencesReader.java

@@ -38 +38 @@
 public class PreferencesReader {
 
+    private static final String XSI_NS = "http://www.w3.org/2001/XMLSchema-instance";
+
     private final SortedMap<String, Setting<?>> settings = new TreeMap<>();
     private int version = 0;
     private XMLStreamReader parser;
+
+    private final boolean defaults;
+
+    /**
+     * Constructs a new {@code PreferencesReader}.
+     * @param defaults true when reading from the cache file for default preferences,
+     * false for the regular preferences config file
+     */
+    public PreferencesReader(boolean defaults) {
+        this.defaults = defaults;
+    }
 
     /**
@@ -111 +124 @@
         while (true) {
             if (event == XMLStreamConstants.START_ELEMENT) {
+                String topLevelElementName = defaults ? "preferences-defaults" : "preferences";
+                String localName = parser.getLocalName();
+                if (!topLevelElementName.equals(localName)) {
+                    throw new XMLStreamException(tr("Expected element ''{0}'', but got ''{1}''", topLevelElementName, localName), parser.getLocation());
+                }
                 try {
                     version = Integer.parseInt(parser.getAttributeValue(null, "version"));
@@ -138 +156 @@
                 switch(localName) {
                 case "tag":
-                    settings.put(parser.getAttributeValue(null, "key"), new StringSetting(parser.getAttributeValue(null, "value")));
+                    Setting setting;
+                    if (defaults && isNil()) {
+                        setting = new StringSetting(null);
+                    } else {
+                        String value = parser.getAttributeValue(null, "value");
+                        if (value == null) {
+                            throw new XMLStreamException(tr("value expected"), parser.getLocation());
+                        }
+                        setting = new StringSetting(value);
+                    }
+                    if (defaults) {
+                        setting.setTime(Math.round(Double.parseDouble(parser.getAttributeValue(null, "time"))));
+                    }
+                    settings.put(parser.getAttributeValue(null, "key"), setting);
                     jumpToEnd();
                     break;
                 case "list":
-                case "collection":
                 case "lists":
                 case "maps":
@@ -169 +199 @@
     private void parseToplevelList() throws XMLStreamException {
         String key = parser.getAttributeValue(null, "key");
+        Long time = null;
+        if (defaults) {
+            time = Math.round(Double.parseDouble(parser.getAttributeValue(null, "time")));
+        }
         String name = parser.getLocalName();
 
@@ -174 +208 @@
         List<List<String>> lists = null;
         List<Map<String, String>> maps = null;
-        while (true) {
-            int event = parser.next();
-            if (event == XMLStreamConstants.START_ELEMENT) {
-                String localName = parser.getLocalName();
-                switch(localName) {
-                case "entry":
-                    if (entries == null) {
-                        entries = new ArrayList<>();
+        if (defaults && isNil()) {
+            Setting setting;
+            switch (name) {
+                case "lists":
+                    setting = new ListListSetting(null);
+                    break;
+                case "maps":
+                    setting = new MapListSetting(null);
+                    break;
+                default:
+                    setting = new ListSetting(null);
+                    break;
+            }
+            setting.setTime(time);
+            settings.put(key, setting);
+            jumpToEnd();
+        } else {
+            while (true) {
+                int event = parser.next();
+                if (event == XMLStreamConstants.START_ELEMENT) {
+                    String localName = parser.getLocalName();
+                    switch(localName) {
+                    case "entry":
+                        if (entries == null) {
+                            entries = new ArrayList<>();
+                        }
+                        entries.add(parser.getAttributeValue(null, "value"));
+                        jumpToEnd();
+                        break;
+                    case "list":
+                        if (lists == null) {
+                            lists = new ArrayList<>();
+                        }
+                        lists.add(parseInnerList());
+                        break;
+                    case "map":
+                        if (maps == null) {
+                            maps = new ArrayList<>();
+                        }
+                        maps.add(parseMap());
+                        break;
+                    default:
+                        throwException("Unexpected element: "+localName);
                     }
-                    entries.add(parser.getAttributeValue(null, "value"));
-                    jumpToEnd();
-                    break;
-                case "list":
-                    if (lists == null) {
-                        lists = new ArrayList<>();
-                    }
-                    lists.add(parseInnerList());
-                    break;
-                case "map":
-                    if (maps == null) {
-                        maps = new ArrayList<>();
-                    }
-                    maps.add(parseMap());
-                    break;
-                default:
-                    throwException("Unexpected element: "+localName);
-                }
-            } else if (event == XMLStreamConstants.END_ELEMENT) {
-                break;
-            }
-        }
-        if (entries != null) {
-            settings.put(key, new ListSetting(Collections.unmodifiableList(entries)));
-        } else if (lists != null) {
-            settings.put(key, new ListListSetting(Collections.unmodifiableList(lists)));
-        } else if (maps != null) {
-            settings.put(key, new MapListSetting(Collections.unmodifiableList(maps)));
-        } else {
-            if ("lists".equals(name)) {
-                settings.put(key, new ListListSetting(Collections.<List<String>>emptyList()));
-            } else if ("maps".equals(name)) {
-                settings.put(key, new MapListSetting(Collections.<Map<String, String>>emptyList()));
+                } else if (event == XMLStreamConstants.END_ELEMENT) {
+                    break;
+                }
+            }
+            Setting setting;
+            if (entries != null) {
+                setting = new ListSetting(Collections.unmodifiableList(entries));
+            } else if (lists != null) {
+                setting = new ListListSetting(Collections.unmodifiableList(lists));
+            } else if (maps != null) {
+                setting = new MapListSetting(Collections.unmodifiableList(maps));
             } else {
-                settings.put(key, new ListSetting(Collections.<String>emptyList()));
-            }
+                switch (name) {
+                    case "lists":
+                        setting = new ListListSetting(Collections.<List<String>>emptyList());
+                        break;
+                    case "maps":
+                        setting = new MapListSetting(Collections.<Map<String, String>>emptyList());
+                        break;
+                    default:
+                        setting = new ListSetting(Collections.<String>emptyList());
+                        break;
+                }
+            }
+            if (defaults) {
+                setting.setTime(time);
+            }
+            settings.put(key, setting);
         }
     }
@@ -258 +319 @@
     }
 
+    /**
+     * Check if the current element is nil (meaning the value of the setting is null).
+     * @return true, if the current element is nil
+     * @see https://msdn.microsoft.com/en-us/library/2b314yt2(v=vs.85).aspx
+     */
+    private boolean isNil() {
+        String nil = parser.getAttributeValue(XSI_NS, "nil");
+        return "true".equals(nil) || "1".equals(nil);
+    }
+
+    /**
+     * Throw RuntimeException with line and column number.
+     *
+     * Only use this for errors that should not be possible after schema validation.
+     * @param msg the error message
+     */
     private void throwException(String msg) {
         throw new RuntimeException(msg + tr(" (at line {0}, column {1})",

trunk/src/org/openstreetmap/josm/data/preferences/Setting.java

@@ -1 +1 @@
 // License: GPL. For details, see LICENSE file.
 package org.openstreetmap.josm.data.preferences;
+
+import org.openstreetmap.josm.data.Preferences;
 
 /**
@@ -46 +48 @@
      */
     Setting<T> getNullInstance();
+
+    /**
+     * Set the time for this setting.
+     *
+     * For default preferences. They are saved in a cache file. Keeping the
+     * time allows to discard very old default settings.
+     * @param time the time in seconds since epoch
+     */
+    void setTime(Long time);
+
+    /**
+     * Get the time for this setting.
+     * @return the time for this setting
+     * @see #setTime(java.lang.Long)
+     */
+    Long getTime();
+
+    /**
+     * Mark setting as new.
+     *
+     * For default preferences. A setting is marked as new, if it has been seen
+     * in the current session.
+     * Methods like {@link Preferences#get(java.lang.String, java.lang.String)},
+     * can be called from different parts of the code with the same key. In this case,
+     * the supplied default value must match. However, this is only an error if the mismatching
+     * default value has been seen in the same session (and not loaded from cache).
+     * @param isNew true, if it is new
+     */
+    void setNew(boolean isNew);
+
+    /**
+     * Return if the setting has been marked as new.
+     * @return true, if the setting has been marked as new
+     * @see #setNew(boolean)
+     */
+    boolean isNew();
 }