Changeset 18466 in josm for trunk/src/org/openstreetmap/josm/io

Timestamp:

2022-06-06T19:07:05+02:00 (3 years ago)

Author:

taylor.smock

Message:

Fix #21813: Improve marker handling in sessions and #21923: Improve session workflow/Add "save session" (patch by Bjoeni)

• Allow saving a previously saved session
• Add "File" -> "Save Session"
• Add shortcuts for saving sessions
• Add warning if a layer in a session is being removed when saving over the session
• Improve GPX marker handling

Location:

trunk/src/org/openstreetmap/josm/io/session

Files:

• GenericSessionExporter.java (modified) (1 diff)
• GpxTracksSessionExporter.java (modified) (4 diffs)
• GpxTracksSessionImporter.java (modified) (2 diffs)
• MarkerSessionExporter.java (modified) (3 diffs)
• MarkerSessionImporter.java (modified) (1 diff)
• SessionReader.java (modified) (6 diffs)
• SessionWriter.java (modified) (2 diffs)

trunk/src/org/openstreetmap/josm/io/session/GenericSessionExporter.java

@@ -192 +192 @@
             file.appendChild(support.createTextNode(zipPath));
             addDataFile(support.getOutputStreamZip(zipPath));
+            layer.setAssociatedFile(null);
+            if (layer instanceof AbstractModifiableLayer) {
+                ((AbstractModifiableLayer) layer).onPostSaveToFile();
+            }
         } else {
             try {

trunk/src/org/openstreetmap/josm/io/session/GpxTracksSessionExporter.java

@@ -2 +2 @@
 package org.openstreetmap.josm.io.session;
 
+import static org.openstreetmap.josm.tools.I18n.tr;
+
+import java.io.IOException;
 import java.io.OutputStream;
 import java.io.OutputStreamWriter;
@@ -9 +12 @@
 import java.time.Instant;
 
+import javax.swing.JCheckBox;
+import javax.swing.JPanel;
+
 import org.openstreetmap.josm.gui.layer.GpxLayer;
 import org.openstreetmap.josm.io.GpxWriter;
+import org.openstreetmap.josm.io.session.SessionWriter.ExportSupport;
+import org.openstreetmap.josm.tools.GBC;
+import org.w3c.dom.Element;
 
 /**
@@ -19 +28 @@
 
     private Instant metaTime;
+    private JCheckBox chkMarkers;
+    private boolean hasMarkerLayer;
 
     /**
@@ -33 +44 @@
             throw new IllegalArgumentException("GPX layer without data: " + layer);
         }
+
+        hasMarkerLayer = layer.getLinkedMarkerLayer() != null
+                && layer.getLinkedMarkerLayer().data != null
+                && !layer.getLinkedMarkerLayer().data.isEmpty();
+    }
+
+    @Override
+    public JPanel getExportPanel() {
+        JPanel p = super.getExportPanel();
+        if (hasMarkerLayer) {
+            chkMarkers = new JCheckBox();
+            chkMarkers.setText(tr("include marker layer \"{0}\"", layer.getLinkedMarkerLayer().getName()));
+            chkMarkers.setSelected(true);
+            p.add(chkMarkers, GBC.eol().insets(12, 0, 0, 5));
+        }
+        return p;
+    }
+
+    @Override
+    public Element export(ExportSupport support) throws IOException {
+        Element el = super.export(support);
+        if (hasMarkerLayer && (chkMarkers == null || chkMarkers.isSelected())) {
+            Element markerEl = support.createElement("markerLayer");
+            markerEl.setAttribute("index", Integer.toString(support.getLayerIndexOf(layer.getLinkedMarkerLayer())));
+            markerEl.setAttribute("name", layer.getLinkedMarkerLayer().getName());
+            markerEl.setAttribute("visible", Boolean.toString(layer.getLinkedMarkerLayer().isVisible()));
+            if (layer.getLinkedMarkerLayer().getOpacity() != 1) {
+                markerEl.setAttribute("opacity", Double.toString(layer.getLinkedMarkerLayer().getOpacity()));
+            }
+            el.appendChild(markerEl);
+        }
+        return el;
     }
 

trunk/src/org/openstreetmap/josm/io/session/GpxTracksSessionImporter.java

@@ -20 +20 @@
 import org.openstreetmap.josm.gui.progress.ProgressMonitor;
 import org.openstreetmap.josm.io.IllegalDataException;
+import org.openstreetmap.josm.tools.Logging;
 import org.openstreetmap.josm.tools.Utils;
 import org.w3c.dom.Element;
+import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
 
 /**
@@ -58 +61 @@
                     importData.getGpxLayer().data.fromSession = true;
                 }
+                NodeList markerNodes = elem.getElementsByTagName("markerLayer");
+                if (markerNodes.getLength() > 0 && markerNodes.item(0).getNodeType() == Node.ELEMENT_NODE) {
+                    Element markerEl = (Element) markerNodes.item(0);
+                    try {
+                        int index = Integer.parseInt(markerEl.getAttribute("index"));
+                        support.addSubLayer(index, importData.getMarkerLayer(), markerEl);
+                    } catch (NumberFormatException ex) {
+                        Logging.warn(ex);
+                    }
+                }
 
                 support.addPostLayersTask(importData.getPostLayerTask());

trunk/src/org/openstreetmap/josm/io/session/MarkerSessionExporter.java

@@ -35 +35 @@
 
     private Instant metaTime;
+    private boolean canExport = true;
 
     /**
@@ -54 +55 @@
     @Override
     public Component getExportPanel() {
+        export.setSelected(true); //true even when not shown to the user as the index should be reserved for the corresponding GPX layer
+        if (layer.fromLayer != null && layer.fromLayer.getData() != null) {
+            canExport = false;
+            return null;
+        }
         final JPanel p = new JPanel(new GridBagLayout());
-        export.setSelected(true);
         final JLabel lbl = new JLabel(layer.getName(), layer.getIcon(), SwingConstants.LEADING);
         lbl.setToolTipText(layer.getToolTipText());
@@ -67 +72 @@
     @Override
     public boolean requiresZip() {
-        return true;
+        return canExport;
     }
 
     @Override
     public Element export(ExportSupport support) throws IOException {
+        if (!canExport) return null;
+
         Element layerEl = support.createElement("layer");
         layerEl.setAttribute("type", "markers");

trunk/src/org/openstreetmap/josm/io/session/MarkerSessionImporter.java

@@ -49 +49 @@
                 support.addPostLayersTask(importData.getPostLayerTask());
 
+                importData.getGpxLayer().destroy();
                 return importData.getMarkerLayer();
             }

trunk/src/org/openstreetmap/josm/io/session/SessionReader.java

@@ -15 +15 @@
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
+import java.util.AbstractMap.SimpleEntry;
 import java.util.ArrayList;
 import java.util.Collection;
@@ -251 +252 @@
         private final int layerIndex;
         private final List<LayerDependency> layerDependencies;
+        private Map<Integer, Entry<Layer, Element>> subLayers;
 
         /**
@@ -277 +279 @@
         public void addPostLayersTask(Runnable task) {
             postLoadTasks.add(task);
+        }
+
+        /**
+         * Add sub layers
+         * @param idx index
+         * @param layer sub layer
+         * @param el The XML element of the sub layer.
+         *           Should contain "index" and "name" attributes.
+         *           Can contain "opacity" and "visible" attributes
+         * @since 18466
+         */
+        public void addSubLayer(int idx, Layer layer, Element el) {
+            if (subLayers == null) {
+                subLayers = new HashMap<>();
+            }
+            subLayers.put(idx, new SimpleEntry<>(layer, el));
+        }
+
+        /**
+         * Returns the sub layers
+         * @return the sub layers. Can be null.
+         * @since 18466
+         */
+        public Map<Integer, Entry<Layer, Element>> getSubLayers() {
+            return subLayers;
         }
 
@@ -507 +534 @@
         final Map<Integer, Layer> layersMap = new TreeMap<>(Collections.reverseOrder());
         final Map<Integer, SessionLayerImporter> importers = new HashMap<>();
-        final Map<Integer, String> names = new HashMap<>();
 
         progressMonitor.setTicksCount(sorted.size());
@@ -520 +546 @@
             }
             String name = e.getAttribute("name");
-            names.put(idx, name);
             if (!e.hasAttribute("type")) {
                 error(tr("missing mandatory attribute ''type'' for element ''layer''"));
@@ -596 +621 @@
 
                 layersMap.put(idx, layer);
+                setLayerAttributes(layer, e);
+
+                if (support.getSubLayers() != null) {
+                    support.getSubLayers().forEach((Integer markerIndex, Entry<Layer, Element> entry) -> {
+                        Layer subLayer = entry.getKey();
+                        Element subElement = entry.getValue();
+
+                        layersMap.put(markerIndex, subLayer);
+                        setLayerAttributes(subLayer, subElement);
+                    });
+                }
+
             }
             progressMonitor.worked(1);
         }
+
 
         layers = new ArrayList<>();
         for (Entry<Integer, Layer> entry : layersMap.entrySet()) {
             Layer layer = entry.getValue();
-            if (layer == null) {
-                continue;
-            }
-            Element el = elems.get(entry.getKey());
-            if (el.hasAttribute("visible")) {
-                layer.setVisible(Boolean.parseBoolean(el.getAttribute("visible")));
-            }
-            if (el.hasAttribute("opacity")) {
-                try {
-                    double opacity = Double.parseDouble(el.getAttribute("opacity"));
-                    layer.setOpacity(opacity);
-                } catch (NumberFormatException ex) {
-                    Logging.warn(ex);
-                }
-            }
-            layer.setName(names.get(entry.getKey()));
-            layers.add(layer);
+            if (layer != null) {
+                layers.add(layer);
+            }
+        }
+    }
+
+    private static void setLayerAttributes(Layer layer, Element e) {
+        if (layer == null)
+            return;
+
+        if (e.hasAttribute("name")) {
+            layer.setName(e.getAttribute("name"));
+        }
+        if (e.hasAttribute("visible")) {
+            layer.setVisible(Boolean.parseBoolean(e.getAttribute("visible")));
+        }
+        if (e.hasAttribute("opacity")) {
+            try {
+                double opacity = Double.parseDouble(e.getAttribute("opacity"));
+                layer.setOpacity(opacity);
+            } catch (NumberFormatException ex) {
+                Logging.warn(ex);
+            }
         }
     }

trunk/src/org/openstreetmap/josm/io/session/SessionWriter.java

@@ -175 +175 @@
 
         /**
+         * Get the index of the specified layer
+         * @param layer the layer
+         * @return the index of the specified layer
+         * @since 18466
+         */
+        public int getLayerIndexOf(Layer layer) {
+            return layers.indexOf(layer) + 1;
+        }
+
+        /**
          * Create a file inside the zip archive.
          *
@@ -235 +245 @@
             ExportSupport support = new ExportSupport(doc, index+1);
             Element el = exporter.export(support);
+            if (el == null) continue;
             el.setAttribute("index", Integer.toString(index+1));
             el.setAttribute("name", layer.getName());