Changeset 630 in josm for trunk/src

Timestamp:

2008-05-11T01:59:46+02:00 (17 years ago)

Author:

framm

Message:

• make commands able to fail (patch by DH)
• add Command.getOrig() (patch by DH)
• add RemoveRelationMemberCommand (patch by DH)

Location:

trunk/src/org/openstreetmap/josm/command

Files:

• AddCommand.java (modified) (1 diff)
• ChangeCommand.java (modified) (1 diff)
• ChangePropertyCommand.java (modified) (2 diffs)
• Command.java (modified) (2 diffs)
• ConflictResolveCommand.java (modified) (2 diffs)
• DeleteCommand.java (modified) (2 diffs)
• MoveCommand.java (modified) (2 diffs)
• RemoveRelationMemberCommand.java (added)
• RotateCommand.java (modified) (1 diff)
• SequenceCommand.java (modified) (3 diffs)

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

@@ -44 +44 @@
         }
 
-        @Override public void executeCommand() {
+        @Override public boolean executeCommand() {
                 osm.visit(new AddVisitor(ds));
+                return true;
         }
 

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

@@ -29 +29 @@
     }
 
-        @Override public void executeCommand() {
+        @Override public boolean executeCommand() {
             super.executeCommand();
             osm.cloneFrom(newOsm);
             osm.modified = true;
+                return true;
     }
 

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

@@ -52 +52 @@
         }
         
-        @Override public void executeCommand() {
+        @Override public boolean executeCommand() {
                 super.executeCommand(); // save old
                 if (value == null) {
@@ -65 +65 @@
                         }
                 }
+                return true;
         }
 

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

@@ -10 +10 @@
 import javax.swing.tree.MutableTreeNode;
 
+import org.openstreetmap.josm.Main;
+import org.openstreetmap.josm.data.osm.DataSet;
 import org.openstreetmap.josm.data.osm.Relation;
 import org.openstreetmap.josm.data.osm.Node;
@@ -31 +33 @@
 abstract public class Command {
 
-        private static final class CloneVisitor implements Visitor {
-                public Map<OsmPrimitive, OsmPrimitive> orig = new HashMap<OsmPrimitive, OsmPrimitive>();
+   private static final class CloneVisitor implements Visitor {
+      public Map<OsmPrimitive, OsmPrimitive> orig = new HashMap<OsmPrimitive, OsmPrimitive>();
 
-                public void visit(Node n) {
-                        orig.put(n, new Node(n));
-                }
-                public void visit(Way w) {
-                        orig.put(w, new Way(w));
-                }
-                public void visit(Relation e) {
-                        orig.put(e, new Relation(e));
-                }
-        }
+      public void visit(Node n) {
+         orig.put(n, new Node(n));
+      }
+      public void visit(Way w) {
+         orig.put(w, new Way(w));
+      }
+      public void visit(Relation e) {
+         orig.put(e, new Relation(e));
+      }
+   }
 
-        private CloneVisitor orig; 
+   private CloneVisitor orig; 
 
-        /**
-         * Executes the command on the dataset. This implementation will remember all
-         * primitives returned by fillModifiedData for restoring them on undo.
-         */
-        public void executeCommand() {
-                orig = new CloneVisitor();
-                Collection<OsmPrimitive> all = new HashSet<OsmPrimitive>();
-                fillModifiedData(all, all, all);
-                for (OsmPrimitive osm : all)
-                        osm.visit(orig);
-        }
+   protected DataSet ds;
 
-        /**
-         * Undoes the command. 
-         * It can be assumed, that all objects are in the same state they were before.
-         * It can also be assumed that executeCommand was called exactly once before.
-         * 
-         * This implementation undoes all objects stored by a former call to executeCommand.
-         */
-        public void undoCommand() {
-                for (Entry<OsmPrimitive, OsmPrimitive> e : orig.orig.entrySet())
-                        e.getKey().cloneFrom(e.getValue());
-        }
+   public Command() {
+      this.ds = Main.main.editLayer().data;
+   }
+   /**
+    * Executes the command on the dataset. This implementation will remember all
+    * primitives returned by fillModifiedData for restoring them on undo.
+    */
+   public boolean did_execute = false;
+   public boolean executeCommand() {
+      did_execute = true;
+      orig = new CloneVisitor();
+      Collection<OsmPrimitive> all = new HashSet<OsmPrimitive>();
+      fillModifiedData(all, all, all);
+      for (OsmPrimitive osm : all)
+         osm.visit(orig);
+      return true;
+   }
 
+   /**
+    * Undoes the command. 
+    * It can be assumed, that all objects are in the same state they were before.
+    * It can also be assumed that executeCommand was called exactly once before.
+    * 
+    * This implementation undoes all objects stored by a former call to executeCommand.
+    */
+   public void undoCommand() {
+      for (Entry<OsmPrimitive, OsmPrimitive> e : orig.orig.entrySet())
+         e.getKey().cloneFrom(e.getValue());
+   }
 
-        /**
-         * Called, when a layer has been removed to have the command remove itself from
-         * any buffer if it is not longer applicable to the dataset (e.g. it was part of
-         * the removed layer)
-         */
-        public boolean invalidBecauselayerRemoved(Layer oldLayer) {
-                if (!(oldLayer instanceof OsmDataLayer))
-                        return false;
-                HashSet<OsmPrimitive> modified = new HashSet<OsmPrimitive>();
-                fillModifiedData(modified, modified, modified);
-                if (modified.isEmpty())
-                        return false;
+   /**
+    * Called, when a layer has been removed to have the command remove itself from
+    * any buffer if it is not longer applicable to the dataset (e.g. it was part of
+    * the removed layer)
+    */
+   public boolean invalidBecauselayerRemoved(Layer oldLayer) {
+      if (!(oldLayer instanceof OsmDataLayer))
+         return false;
+      HashSet<OsmPrimitive> modified = new HashSet<OsmPrimitive>();
+      fillModifiedData(modified, modified, modified);
+      if (modified.isEmpty())
+         return false;
 
-                HashSet<OsmPrimitive> all = new HashSet<OsmPrimitive>(((OsmDataLayer)oldLayer).data.allPrimitives());
-                for (OsmPrimitive osm : all)
-                        if (all.contains(osm))
-                                return true;
+      HashSet<OsmPrimitive> all = new HashSet<OsmPrimitive>(((OsmDataLayer)oldLayer).data.allPrimitives());
+      for (OsmPrimitive osm : all)
+         if (all.contains(osm))
+                 return true;
 
-                return false;
-        }
+      return false;
+   }
 
-        /**
-         * Fill in the changed data this command operates on.
-         * Add to the lists, don't clear them.
-         * 
-         * @param modified  The modified primitives
-         * @param deleted   The deleted primitives
-         * @param added         The added primitives
-         */
-        abstract public void fillModifiedData(Collection<OsmPrimitive> modified,
-                        Collection<OsmPrimitive> deleted,
-                        Collection<OsmPrimitive> added);
+    /**
+     * Lets other commands access the original version
+     * of the object. Usually for undoing.
+     */
+    public OsmPrimitive getOrig(OsmPrimitive osm) {
+        OsmPrimitive o = orig.orig.get(osm);
+        if (o != null)
+             return o;
+        Main.debug("unable to find osm with id: " + osm.id + " hashCode: " + osm.hashCode());
+        for (OsmPrimitive t : orig.orig.keySet()) {
+             OsmPrimitive to = orig.orig.get(t);
+             Main.debug("now: " + t.id + " hashCode: " + t.hashCode());
+             Main.debug("orig: " + to.id + " hashCode: " + to.hashCode());
+        }
+        return o;
+    }
 
-        abstract public MutableTreeNode description();
+   /**
+    * Fill in the changed data this command operates on.
+    * Add to the lists, don't clear them.
+    * 
+    * @param modified  The modified primitives
+    * @param deleted   The deleted primitives
+    * @param added      The added primitives
+    */
+   abstract public void fillModifiedData(Collection<OsmPrimitive> modified,
+         Collection<OsmPrimitive> deleted,
+         Collection<OsmPrimitive> added);
+
+   abstract public MutableTreeNode description();
 }

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

@@ -36 +36 @@
         }
 
-        @Override public void executeCommand() {
+        @Override public boolean executeCommand() {
                 super.executeCommand();
 
@@ -57 +57 @@
                         conflictDialog.rebuildList();
                 }
+                return true;
         }
 

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

@@ -6 +6 @@
 
 import java.util.Collection;
+import java.util.Collections;
 
 import javax.swing.JLabel;
@@ -26 +27 @@
         private final Collection<? extends OsmPrimitive> data;
 
+    /** 
+     * Constructor for a collection of data
+     */
         public DeleteCommand(Collection<? extends OsmPrimitive> data) {
                 this.data = data;
         }
+    /** 
+     * Constructor for a single data item. Use the collection 
+     * constructor to delete multiple objects.
+     */
+    public DeleteCommand(OsmPrimitive data) {
+        this.data = Collections.singleton(data);
+    }
 
-        @Override public void executeCommand() {
+        @Override public boolean executeCommand() {
                 super.executeCommand();
                 for (OsmPrimitive osm : data) {
                         osm.delete(true);
                 }
+                return true;
         }
         

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

@@ -95 +95 @@
         }
         
-        @Override public void executeCommand() {
+        @Override public boolean executeCommand() {
                 for (Node n : objects) {
                         n.eastNorth = new EastNorth(n.eastNorth.east()+x, n.eastNorth.north()+y);
@@ -101 +101 @@
                         n.modified = true;
                 }
+                return true;
         }
 

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

@@ -113 +113 @@
         }
         
-        @Override public void executeCommand() {
+        @Override public boolean executeCommand() {
                 rotateNodes(true);
+                return true;
         }
 

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

@@ -10 +10 @@
 import javax.swing.tree.MutableTreeNode;
 
+import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.data.osm.OsmPrimitive;
 
@@ -23 +24 @@
          */
         private Command[] sequence;
+        private boolean sequence_complete;
         private final String name;
+        public boolean continueOnError = false;
 
         /**
@@ -42 +45 @@
         }
         
-        @Override public void executeCommand() {
-                for (Command c : sequence)
-                        c.executeCommand();
+        public int executed_commands = 0;
+        @Override public boolean executeCommand() {
+                for (int i=0; i < sequence.length; i++) {
+                        Command c = sequence[i];
+                        boolean result = c.executeCommand();
+                        if (!result)
+                                Main.debug("SequenceCommand, executing command[" + i + "] " +  c + " result: " + result);
+                        if (!result && !continueOnError) {
+                                this.undoCommands(i-1);
+                                return false;
+                        }
+                }
+                sequence_complete = true;
+                return true;
+        }
+
+        private void undoCommands(int start) {
+                // We probably aborted this halfway though the
+                // execution sequence because of a sub-command
+                // error.  We already undid the sub-commands.
+                if (!sequence_complete)
+                        return;
+                for (int i = start; i >= 0; --i)
+                        sequence[i].undoCommand();
         }
 
         @Override public void undoCommand() {
-                for (int i = sequence.length-1; i >= 0; --i)
-                        sequence[i].undoCommand();
+                this.undoCommands(sequence.length-1);
         }