Changeset 10452 in josm

Timestamp:

2016-06-21T23:41:42+02:00 (8 years ago)

Author:

Don-vip

Message:

fix #13019 - Make commands trigger an implicit layer redraw (patch by michael2402) - gsoc-core

Location:

trunk

Files:

• src/org/openstreetmap/josm/command/Command.java (modified) (2 diffs)
• src/org/openstreetmap/josm/command/SequenceCommand.java (modified) (1 diff)
• src/org/openstreetmap/josm/data/UndoRedoHandler.java (modified) (10 diffs)
• src/org/openstreetmap/josm/gui/dialogs/ValidatorDialog.java (modified) (3 diffs)
• test/unit/org/openstreetmap/josm/actions/mapmode/DrawActionTest.java (modified) (2 diffs)

trunk/src/org/openstreetmap/josm/command/Command.java

@@ -148 +148 @@
      * Executes the command on the dataset. This implementation will remember all
      * primitives returned by fillModifiedData for restoring them on undo.
+     * <p>
+     * The layer should be invalidated after execution so that it can be re-painted.
      * @return true
+     * @see #invalidateAffectedLayers()
      */
     public boolean executeCommand() {
@@ -300 +303 @@
                 Objects.equals(layer, command.layer);
     }
+
+    /**
+     * Invalidate all layers that were affected by this command.
+     * @see Layer#invalidate()
+     */
+    public void invalidateAffectedLayers() {
+        OsmDataLayer layer = getLayer();
+        if (layer != null) {
+            layer.invalidate();
+        }
+    }
 }

trunk/src/org/openstreetmap/josm/command/SequenceCommand.java

@@ -126 +126 @@
 
     @Override
+    public void invalidateAffectedLayers() {
+        super.invalidateAffectedLayers();
+        for (Command c : sequence) {
+            c.invalidateAffectedLayers();
+        }
+    }
+
+    @Override
     public int hashCode() {
         return Objects.hash(super.hashCode(), Arrays.hashCode(sequence), sequenceComplete, name, continueOnError);

trunk/src/org/openstreetmap/josm/data/UndoRedoHandler.java

@@ -15 +15 @@
 import org.openstreetmap.josm.gui.layer.LayerManager.LayerOrderChangeEvent;
 import org.openstreetmap.josm.gui.layer.LayerManager.LayerRemoveEvent;
+import org.openstreetmap.josm.gui.layer.OsmDataLayer;
 import org.openstreetmap.josm.gui.layer.OsmDataLayer.CommandQueueListener;
 import org.openstreetmap.josm.tools.CheckParameterUtil;
 
+/**
+ * This is the global undo/redo handler for all {@link OsmDataLayer}s.
+ * <p>
+ * If you want to change a data layer, you can use {@link #add(Command)} to execute a command on it and make that command undoable.
+ */
 public class UndoRedoHandler implements LayerChangeListener {
 
@@ -45 +51 @@
         CheckParameterUtil.ensureParameterNotNull(c, "c");
         c.executeCommand();
+        c.invalidateAffectedLayers();
         commands.add(c);
         // Limit the number of commands in the undo list.
@@ -55 +62 @@
     }
 
+    /**
+     * Fires a commands change event after adding a command.
+     */
     public void afterAdd() {
         fireCommandsChanged();
-
-        // the command may have changed the selection so tell the listeners about the current situation
-        DataSet ds = Main.getLayerManager().getEditDataSet();
-        if (ds != null) {
-            ds.fireSelectionChanged();
-        }
     }
 
@@ -70 +74 @@
      */
     public synchronized void add(final Command c) {
+        DataSet ds = Main.getLayerManager().getEditDataSet();
+        Collection<? extends OsmPrimitive> oldSelection = ds.getSelected();
         addNoRedraw(c);
         afterAdd();
+
+        // the command may have changed the selection so tell the listeners about the current situation
+        fireIfSelectionChanged(ds, oldSelection);
     }
 
@@ -88 +97 @@
         if (commands.isEmpty())
             return;
-        Collection<? extends OsmPrimitive> oldSelection = Main.getLayerManager().getEditDataSet().getSelected();
-        Main.getLayerManager().getEditDataSet().beginUpdate();
+        DataSet ds = Main.getLayerManager().getEditDataSet();
+        Collection<? extends OsmPrimitive> oldSelection = ds.getSelected();
+        ds.beginUpdate();
         try {
             for (int i = 1; i <= num; ++i) {
                 final Command c = commands.removeLast();
                 c.undoCommand();
+                c.invalidateAffectedLayers();
                 redoCommands.addFirst(c);
                 if (commands.isEmpty()) {
@@ -100 +111 @@
             }
         } finally {
-            Main.getLayerManager().getEditDataSet().endUpdate();
-        }
-        fireCommandsChanged();
-        Collection<? extends OsmPrimitive> newSelection = Main.getLayerManager().getEditDataSet().getSelected();
-        if (!oldSelection.equals(newSelection)) {
-            Main.getLayerManager().getEditDataSet().fireSelectionChanged();
-        }
+            ds.endUpdate();
+        }
+        fireCommandsChanged();
+        fireIfSelectionChanged(ds, oldSelection);
     }
 
@@ -123 +131 @@
         if (redoCommands.isEmpty())
             return;
-        Collection<? extends OsmPrimitive> oldSelection = Main.getLayerManager().getEditDataSet().getSelected();
+        DataSet ds = Main.getLayerManager().getEditDataSet();
+        Collection<? extends OsmPrimitive> oldSelection = ds.getSelected();
         for (int i = 0; i < num; ++i) {
             final Command c = redoCommands.removeFirst();
             c.executeCommand();
+            c.invalidateAffectedLayers();
             commands.add(c);
             if (redoCommands.isEmpty()) {
@@ -133 +143 @@
         }
         fireCommandsChanged();
-        Collection<? extends OsmPrimitive> newSelection = Main.getLayerManager().getEditDataSet().getSelected();
+        fireIfSelectionChanged(ds, oldSelection);
+    }
+
+    private static void fireIfSelectionChanged(DataSet ds, Collection<? extends OsmPrimitive> oldSelection) {
+        Collection<? extends OsmPrimitive> newSelection = ds.getSelected();
         if (!oldSelection.equals(newSelection)) {
-            Main.getLayerManager().getEditDataSet().fireSelectionChanged();
-        }
-    }
-
-    public void fireCommandsChanged() {
+            ds.fireSelectionChanged();
+        }
+    }
+
+    /**
+     * Fires a command change to all listeners.
+     */
+    private void fireCommandsChanged() {
         for (final CommandQueueListener l : listenerCommands) {
             l.commandChanged(commands.size(), redoCommands.size());
@@ -145 +162 @@
     }
 
+    /**
+     * Resets the undo/redo list.
+     */
     public void clean() {
         redoCommands.clear();
@@ -151 +171 @@
     }
 
+    /**
+     * Resets all commands that affect the given layer.
+     * @param layer The layer that was affected.
+     */
     public void clean(Layer layer) {
         if (layer == null)

trunk/src/org/openstreetmap/josm/gui/dialogs/ValidatorDialog.java

@@ -608 +608 @@
 
         @Override
-        protected void realRun() throws SAXException, IOException,
-        OsmTransferException {
+        protected void realRun() throws SAXException, IOException, OsmTransferException {
             ProgressMonitor monitor = getProgressMonitor();
             try {
                 monitor.setTicksCount(testErrors.size());
+                final DataSet ds = Main.getLayerManager().getEditDataSet();
                 int i = 0;
                 SwingUtilities.invokeAndWait(new Runnable() {
                     @Override
                     public void run() {
-                        Main.getLayerManager().getEditDataSet().beginUpdate();
+                        ds.beginUpdate();
                     }
                 });
@@ -633 +633 @@
                         @Override
                         public void run() {
-                            Main.getLayerManager().getEditDataSet().endUpdate();
+                            ds.endUpdate();
                         }
                     });
@@ -644 +644 @@
                         Main.map.repaint();
                         tree.resetErrors();
-                        Main.getLayerManager().getEditDataSet().fireSelectionChanged();
+                        ds.fireSelectionChanged();
                     }
                 });

trunk/test/unit/org/openstreetmap/josm/actions/mapmode/DrawActionTest.java

@@ -53 +53 @@
         DataSet dataSet = new DataSet();
         OsmDataLayer layer = new OsmDataLayer(dataSet, OsmDataLayer.createNewName(), null);
+        Main.getLayerManager().addLayer(layer);
 
         Field mapView = MapFrame.class.getDeclaredField("mapView");
@@ -68 +69 @@
         dataSet.addPrimitive(w);
 
-        Main.getLayerManager().addLayer(layer);
         try {
             assertTrue(Main.map.selectDrawTool(false));