Rework block-batching, create draft of chunk batching

worldedit-core/src/main/java/com/sk89q/worldedit/Vector2D.java

@@ -19,12 +19,37 @@
 
 package com.sk89q.worldedit;
 
+import com.google.common.collect.ComparisonChain;
 import com.sk89q.worldedit.math.transform.AffineTransform;
 
+import java.util.Comparator;
+
 /**
  * An immutable 2-dimensional vector.
  */
 public class Vector2D {
+
+    /**
+     * A comparator for Vector2Ds that orders the vectors by rows, with x as the
+     * column and z as the row.
+     *
+     * For example, if x is the horizontal axis and z is the vertical axis, it
+     * sorts like so:
+     *
+     * <pre>
+     * 0123
+     * 4567
+     * 90ab
+     * cdef
+     * </pre>
+     */
+    public static final Comparator<Vector2D> COMPARING_GRID_ARRANGEMENT = (a, b) -> {
+        return ComparisonChain.start()
+                .compare(a.getBlockZ(), b.getBlockZ())
+                .compare(a.getBlockX(), b.getBlockX())
+                .result();
+    };
+
     public static final Vector2D ZERO = new Vector2D(0, 0);
     public static final Vector2D UNIT_X = new Vector2D(1, 0);
     public static final Vector2D UNIT_Z = new Vector2D(0, 1);

worldedit-core/src/main/java/com/sk89q/worldedit/extent/reorder/ChunkBatchingExtent.java

@@ -0,0 +1,93 @@
+/*
+ * WorldEdit, a Minecraft world manipulation toolkit
+ * Copyright (C) sk89q <http://www.sk89q.com>
+ * Copyright (C) WorldEdit team and contributors
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by the
+ * Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
+ * for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+package com.sk89q.worldedit.extent.reorder;
+
+import com.sk89q.worldedit.BlockVector2D;
+import com.sk89q.worldedit.Vector;
+import com.sk89q.worldedit.Vector2D;
+import com.sk89q.worldedit.WorldEditException;
+import com.sk89q.worldedit.extent.AbstractDelegateExtent;
+import com.sk89q.worldedit.extent.Extent;
+import com.sk89q.worldedit.function.operation.Operation;
+import com.sk89q.worldedit.function.operation.RunContext;
+import com.sk89q.worldedit.function.operation.SetLocatedBlocks;
+import com.sk89q.worldedit.util.collection.LocatedBlockList;
+import com.sk89q.worldedit.world.block.BlockStateHolder;
+
+import java.util.Comparator;
+import java.util.Iterator;
+import java.util.List;
+import java.util.SortedMap;
+import java.util.TreeMap;
+
+/**
+ * A special extent that batches changes into Minecraft chunks. This helps
+ * improve the speed of setting the blocks, since chunks do not need to be
+ * loaded repeatedly, however it does take more memory due to caching the
+ * blocks.
+ */
+public class ChunkBatchingExtent extends AbstractDelegateExtent {
+
+    /**
+     * Comparator optimized for sorting chunks by the region file they reside
+     * in. This allows for file caches to be used while loading the chunk.
+     */
+    private static final Comparator<Vector2D> REGION_OPTIMIZED_SORT =
+            Comparator.<Vector2D, Vector2D>comparing(vec -> vec.divide(32).floor(), Vector2D.COMPARING_GRID_ARRANGEMENT)
+                    .thenComparing(Vector2D.COMPARING_GRID_ARRANGEMENT);
+
+    private final SortedMap<BlockVector2D, LocatedBlockList> batches = new TreeMap<>(REGION_OPTIMIZED_SORT);
+
+    protected ChunkBatchingExtent(Extent extent) {
+        super(extent);
+    }
+
+    @Override
+    public boolean setBlock(Vector location, BlockStateHolder block) throws WorldEditException {
+        BlockVector2D chunkPos = new BlockVector2D(location.getBlockX() >> 4, location.getBlockZ() >> 4);
+        batches.computeIfAbsent(chunkPos, k -> new LocatedBlockList()).add(location, block);
+        return true;
+    }
+
+    @Override
+    protected Operation commitBefore() {
+        return new Operation() {
+
+            private final Iterator<LocatedBlockList> batchIterator = batches.values().iterator();
+
+            @Override
+            public Operation resume(RunContext run) throws WorldEditException {
+                if (!batchIterator.hasNext()) {
+                    return null;
+                }
+                new SetLocatedBlocks(getExtent(), batchIterator.next()).resume(run);
+                return this;
+            }
+
+            @Override
+            public void cancel() {
+            }
+
+            @Override
+            public void addStatusMessages(List<String> messages) {
+            }
+        };
+    }
+
+}

worldedit-core/src/main/java/com/sk89q/worldedit/extent/reorder/MultiStageReorder.java

@@ -19,19 +19,20 @@
 
 package com.sk89q.worldedit.extent.reorder;
 
-import com.google.common.collect.Iterators;
+import com.google.common.collect.Iterables;
 import com.sk89q.worldedit.BlockVector;
 import com.sk89q.worldedit.Vector;
 import com.sk89q.worldedit.WorldEditException;
 import com.sk89q.worldedit.blocks.Blocks;
 import com.sk89q.worldedit.extent.AbstractDelegateExtent;
 import com.sk89q.worldedit.extent.Extent;
-import com.sk89q.worldedit.function.operation.BlockMapEntryPlacer;
 import com.sk89q.worldedit.function.operation.Operation;
 import com.sk89q.worldedit.function.operation.OperationQueue;
 import com.sk89q.worldedit.function.operation.RunContext;
+import com.sk89q.worldedit.function.operation.SetLocatedBlocks;
 import com.sk89q.worldedit.registry.state.Property;
-import com.sk89q.worldedit.util.collection.TupleArrayList;
+import com.sk89q.worldedit.util.LocatedBlock;
+import com.sk89q.worldedit.util.collection.LocatedBlockList;
 import com.sk89q.worldedit.world.block.BlockCategories;
 import com.sk89q.worldedit.world.block.BlockState;
 import com.sk89q.worldedit.world.block.BlockStateHolder;
@@ -50,9 +51,9 @@
  */
 public class MultiStageReorder extends AbstractDelegateExtent implements ReorderingExtent {
 
-    private TupleArrayList<BlockVector, BlockStateHolder> stage1 = new TupleArrayList<>();
-    private TupleArrayList<BlockVector, BlockStateHolder> stage2 = new TupleArrayList<>();
-    private TupleArrayList<BlockVector, BlockStateHolder> stage3 = new TupleArrayList<>();
+    private LocatedBlockList stage1 = new LocatedBlockList();
+    private LocatedBlockList stage2 = new LocatedBlockList();
+    private LocatedBlockList stage3 = new LocatedBlockList();
     private boolean enabled;
 
     /**
@@ -103,28 +104,28 @@ public boolean setBlock(Vector location, BlockStateHolder block) throws WorldEdi
 
         if (Blocks.shouldPlaceLast(block.getBlockType())) {
             // Place torches, etc. last
-            stage2.put(location.toBlockVector(), block);
+            stage2.add(location.toBlockVector(), block);
             return !existing.equalsFuzzy(block);
         } else if (Blocks.shouldPlaceFinal(block.getBlockType())) {
             // Place signs, reed, etc even later
-            stage3.put(location.toBlockVector(), block);
+            stage3.add(location.toBlockVector(), block);
             return !existing.equalsFuzzy(block);
         } else if (Blocks.shouldPlaceLast(existing.getBlockType())) {
             // Destroy torches, etc. first
             super.setBlock(location, BlockTypes.AIR.getDefaultState());
             return super.setBlock(location, block);
         } else {
-            stage1.put(location.toBlockVector(), block);
+            stage1.add(location.toBlockVector(), block);
             return !existing.equalsFuzzy(block);
         }
     }
 
     @Override
     public Operation commitBefore() {
         return new OperationQueue(
-                new BlockMapEntryPlacer(
+                new SetLocatedBlocks(
                         getExtent(),
-                        Iterators.concat(stage1.iterator(), stage2.iterator())),
+                        Iterables.concat(stage1, stage2)),
                 new Stage3Committer());
     }
 
@@ -136,10 +137,10 @@ public Operation resume(RunContext run) throws WorldEditException {
 
             final Set<BlockVector> blocks = new HashSet<>();
             final Map<BlockVector, BlockStateHolder> blockTypes = new HashMap<>();
-            for (Map.Entry<BlockVector, BlockStateHolder> entry : stage3) {
-                final BlockVector pt = entry.getKey();
+            for (LocatedBlock entry : stage3) {
+                final BlockVector pt = entry.getLocation().toBlockVector();
                 blocks.add(pt);
-                blockTypes.put(pt, entry.getValue());
+                blockTypes.put(pt, entry.getBlock());
             }
 
             while (!blocks.isEmpty()) {

worldedit-core/src/main/java/com/sk89q/worldedit/function/operation/BlockMapEntryPlacer.java → worldedit-core/src/main/java/com/sk89q/worldedit/function/operation/SetLocatedBlocks.java

@@ -16,50 +16,31 @@
  * You should have received a copy of the GNU Lesser General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-
 package com.sk89q.worldedit.function.operation;
 
 import static com.google.common.base.Preconditions.checkNotNull;
 
-import com.sk89q.worldedit.BlockVector;
 import com.sk89q.worldedit.WorldEditException;
-import com.sk89q.worldedit.world.block.BaseBlock;
 import com.sk89q.worldedit.extent.Extent;
-import com.sk89q.worldedit.world.block.BlockStateHolder;
+import com.sk89q.worldedit.util.LocatedBlock;
 
-import java.util.Iterator;
 import java.util.List;
-import java.util.Map;
 
-/**
- * Sets block from an iterator of {@link Map.Entry} containing a
- * {@link BlockVector} as the key and a {@link BaseBlock} as the value.
- */
-public class BlockMapEntryPlacer implements Operation {
+public class SetLocatedBlocks implements Operation {
 
     private final Extent extent;
-    private final Iterator<Map.Entry<BlockVector, BlockStateHolder>> iterator;
+    private final Iterable<LocatedBlock> blocks;
 
-    /**
-     * Create a new instance.
-     *
-     * @param extent the extent to set the blocks on
-     * @param iterator the iterator
-     */
-    public BlockMapEntryPlacer(Extent extent, Iterator<Map.Entry<BlockVector, BlockStateHolder>> iterator) {
-        checkNotNull(extent);
-        checkNotNull(iterator);
-        this.extent = extent;
-        this.iterator = iterator;
+    public SetLocatedBlocks(Extent extent, Iterable<LocatedBlock> blocks) {
+        this.extent = checkNotNull(extent);
+        this.blocks = checkNotNull(blocks);
     }
 
     @Override
     public Operation resume(RunContext run) throws WorldEditException {
-        while (iterator.hasNext()) {
-            Map.Entry<BlockVector, BlockStateHolder> entry = iterator.next();
-            extent.setBlock(entry.getKey(), entry.getValue());
+        for (LocatedBlock block : blocks) {
+            extent.setBlock(block.getLocation(), block.getBlock());
         }
-
         return null;
     }
 

worldedit-core/src/main/java/com/sk89q/worldedit/history/changeset/BlockOptimizedHistory.java

@@ -20,15 +20,13 @@
 package com.sk89q.worldedit.history.changeset;
 
 import static com.google.common.base.Preconditions.checkNotNull;
-import static java.util.Map.Entry;
 
-import com.google.common.base.Function;
 import com.google.common.collect.Iterators;
 import com.sk89q.worldedit.BlockVector;
 import com.sk89q.worldedit.history.change.BlockChange;
 import com.sk89q.worldedit.history.change.Change;
-import com.sk89q.worldedit.util.collection.TupleArrayList;
-import com.sk89q.worldedit.world.block.BlockStateHolder;
+import com.sk89q.worldedit.util.LocatedBlock;
+import com.sk89q.worldedit.util.collection.LocatedBlockList;
 
 import java.util.ArrayList;
 import java.util.Iterator;
@@ -43,8 +41,12 @@
  */
 public class BlockOptimizedHistory extends ArrayListHistory {
 
-    private final TupleArrayList<BlockVector, BlockStateHolder> previous = new TupleArrayList<>();
-    private final TupleArrayList<BlockVector, BlockStateHolder> current = new TupleArrayList<>();
+    private static Change createChange(LocatedBlock block) {
+        return new BlockChange(block.getLocation().toBlockPoint(), block.getBlock(), block.getBlock());
+    }
+
+    private final LocatedBlockList previous = new LocatedBlockList();
+    private final LocatedBlockList current = new LocatedBlockList();
 
     @Override
     public void add(Change change) {
@@ -53,8 +55,8 @@ public void add(Change change) {
         if (change instanceof BlockChange) {
             BlockChange blockChange = (BlockChange) change;
             BlockVector position = blockChange.getPosition();
-            previous.put(position, blockChange.getPrevious());
-            current.put(position, blockChange.getCurrent());
+            previous.add(position, blockChange.getPrevious());
+            current.add(position, blockChange.getCurrent());
         } else {
             super.add(change);
         }
@@ -64,29 +66,19 @@ public void add(Change change) {
     public Iterator<Change> forwardIterator() {
         return Iterators.concat(
                 super.forwardIterator(),
-                Iterators.transform(current.iterator(), createTransform()));
+                Iterators.transform(current.iterator(), BlockOptimizedHistory::createChange));
     }
 
     @Override
     public Iterator<Change> backwardIterator() {
         return Iterators.concat(
                 super.backwardIterator(),
-                Iterators.transform(previous.iterator(true), createTransform()));
+                Iterators.transform(previous.reverseIterator(), BlockOptimizedHistory::createChange));
     }
 
     @Override
     public int size() {
         return super.size() + previous.size();
     }
 
-    /**
-     * Create a function that transforms each entry from the double array lists' iterator
-     * into an {@link Change}.
-     *
-     * @return a function
-     */
-    private Function<Entry<BlockVector, BlockStateHolder>, Change> createTransform() {
-        return entry -> new BlockChange(entry.getKey(), entry.getValue(), entry.getValue());
-    }
-
 }