UndoModel.java

Go to the documentation of this file.

/*
 * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
 * Copyright (C) 2000-2023 The Gridarta Developers.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
package net.sf.gridarta.model.undo;
 
import java.util.ArrayList;
import java.util.List;
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.gameobject.GameObject;
import net.sf.gridarta.model.gameobject.GameObjectFactory;
import net.sf.gridarta.model.maparchobject.MapArchObject;
import net.sf.gridarta.model.mapmodel.MapTransactionListener;
import net.sf.gridarta.model.mapmodel.SavedSquares;
import net.sf.gridarta.model.match.GameObjectMatchers;
import org.jetbrains.annotations.NotNull;
 
public class UndoModel<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> {
 
    @NotNull
    private final GameObjectFactory<G, A, R> gameObjectFactory;
 
    @NotNull
    private final GameObjectMatchers gameObjectMatchers;
 
    @NotNull
    private final MapTransactionListener<G, A, R> mapTransactionListener;
 
    @NotNull
    private final List<UndoState<G, A, R>> undoStack = new ArrayList<>();
 
    private int undoStackIndex;
 
    private UndoType type = UndoType.NORMAL;
 
    public UndoModel(@NotNull final GameObjectFactory<G, A, R> gameObjectFactory, @NotNull final GameObjectMatchers gameObjectMatchers, @NotNull final MapTransactionListener<G, A, R> mapTransactionListener) {
        this.gameObjectFactory = gameObjectFactory;
        this.gameObjectMatchers = gameObjectMatchers;
        this.mapTransactionListener = mapTransactionListener;
    }
 
    @NotNull
    public MapTransactionListener<G, A, R> getMapTransactionListener() {
        return mapTransactionListener;
    }
 
    private void addUndoState(@NotNull final UndoState<G, A, R> undoState) {
        discardAllRedo();
 
        assert undoStackIndex == undoStack.size();
        undoStack.add(undoState);
        undoStackIndex = undoStack.size();
    }
 
    public void trimToSize(final int maxUndoStates) {
        while (undoStack.size() > maxUndoStates) {
            if (canRedo()) { // prefer discarding redo over undo information
                discardRedo();
            } else {
                discardUndo();
            }
        }
    }
 
    public boolean canUndo() {
        return undoStackIndex > 0;
    }
 
    public boolean canRedo() {
        return undoStackIndex < undoStack.size();
    }
 
    public String undoName() {
        if (undoStackIndex <= 0) {
            throw new IllegalStateException("undo stack is empty");
        }
 
        return undoStack.get(undoStackIndex - 1).getName();
    }
 
    public String redoName() {
        if (undoStackIndex >= undoStack.size()) {
            throw new IllegalStateException("redo stack is empty");
        }
 
        return undoStack.get(undoStackIndex).getName();
    }
 
    @NotNull
    public UndoState<G, A, R> undo() {
        if (undoStackIndex <= 0) {
            throw new IllegalStateException("undo stack is empty");
        }
 
        undoStackIndex--;
        final UndoState<G, A, R> result = undoStack.get(undoStackIndex);
        type = UndoType.UNDO;
        return result;
    }
 
    @NotNull
    public UndoState<G, A, R> redo() {
        if (undoStackIndex >= undoStack.size()) {
            throw new IllegalStateException("redo stack is empty");
        }
 
        final UndoState<G, A, R> result = undoStack.get(undoStackIndex);
        undoStackIndex++;
        type = UndoType.REDO;
        return result;
    }
 
    public void finish(@NotNull final UndoState<G, A, R> undoState) {
        switch (type) {
        case NORMAL:
            addUndoState(undoState);
            break;
 
        case UNDO:
            undoStack.set(undoStackIndex, undoState);
            type = UndoType.NORMAL;
            break;
 
        case REDO:
            undoStack.set(undoStackIndex - 1, undoState);
            type = UndoType.NORMAL;
            break;
        }
    }
 
    public void finish() {
        final int index;
        switch (type) {
        default:
        case NORMAL:
            return;
 
        case UNDO:
            index = undoStackIndex;
            break;
 
        case REDO:
            index = undoStackIndex - 1;
            break;
        }
 
        final UndoState<G, A, R> prevUndoState = undoStack.get(index);
        final String name = prevUndoState.getName();
        final A mapArchObject = prevUndoState.getMapArchObject();
        final UndoState<G, A, R> undoState = new UndoState<>(name, mapArchObject);
        undoState.setSavedSquares(new SavedSquares<>(gameObjectFactory, gameObjectMatchers));
        undoStack.set(index, undoState);
        type = UndoType.NORMAL;
    }
 
    private void discardAllRedo() {
        while (undoStackIndex < undoStack.size()) {
            discardRedo();
        }
    }
 
    private void discardRedo() {
        assert !undoStack.isEmpty();
        assert undoStackIndex < undoStack.size();
        undoStack.remove(undoStack.size() - 1);
    }
 
    private void discardUndo() {
        assert !undoStack.isEmpty();
        assert undoStackIndex > 0;
        undoStack.remove(0);
        undoStackIndex--;
    }
 
}