ExitConnectorActions.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.actions;
 
import java.awt.Point;
import java.io.IOException;
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.archetype.UndefinedArchetypeException;
import net.sf.gridarta.model.archetypeset.ArchetypeSet;
import net.sf.gridarta.model.baseobject.BaseObject;
import net.sf.gridarta.model.exitconnector.ExitConnectorModel;
import net.sf.gridarta.model.exitconnector.ExitLocation;
import net.sf.gridarta.model.exitconnector.ExitMatcher;
import net.sf.gridarta.model.gameobject.GameObject;
import net.sf.gridarta.model.maparchobject.MapArchObject;
import net.sf.gridarta.model.mapcontrol.MapControl;
import net.sf.gridarta.model.mapmanager.FileControl;
import net.sf.gridarta.model.mapmanager.MapManager;
import net.sf.gridarta.model.mapmodel.InsertionModeSet;
import net.sf.gridarta.model.mapmodel.MapFile;
import net.sf.gridarta.model.mapmodel.MapModel;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class ExitConnectorActions<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> {
 
    @NotNull
    private final ExitConnectorModel exitConnectorModel;
 
    @NotNull
    private final ExitMatcher<G, A, R> exitMatcher;
 
    @NotNull
    private final ArchetypeSet<G, A, R> archetypeSet;
 
    @NotNull
    private final MapManager<G, A, R> mapManager;
 
    @NotNull
    private final FileControl<G, A, R> fileControl;
 
    @NotNull
    private final InsertionModeSet<G, A, R> insertionModeSet;
 
    public ExitConnectorActions(@NotNull final ExitConnectorModel exitConnectorModel, @NotNull final ExitMatcher<G, A, R> exitMatcher, @NotNull final ArchetypeSet<G, A, R> archetypeSet, @NotNull final MapManager<G, A, R> mapManager, @NotNull final FileControl<G, A, R> fileControl, @NotNull final InsertionModeSet<G, A, R> insertionModeSet) {
        this.exitConnectorModel = exitConnectorModel;
        this.exitMatcher = exitMatcher;
        this.archetypeSet = archetypeSet;
        this.mapManager = mapManager;
        this.fileControl = fileControl;
        this.insertionModeSet = insertionModeSet;
    }
 
    public boolean doExitCopy(final boolean performAction, @NotNull final MapControl<G, A, R> mapControl, @NotNull final Point location) {
        final MapModel<G, A, R> mapModel = mapControl.getMapModel();
        final MapFile mapFile = mapModel.getMapFile();
        if (mapFile == null) {
            // unsaved maps do not have a map path ==> no location to remember
            return false;
        }
 
        if (performAction) {
            final ExitLocation exitLocation = new ExitLocation(mapFile, location, mapModel.getMapArchObject().getMapName());
            exitConnectorModel.setExitLocation(exitLocation);
        }
 
        return true;
    }
 
    public boolean doExitPaste(final boolean performAction, @NotNull final MapControl<G, A, R> mapControl, @NotNull final Point targetLocation) {
        final ExitLocation sourceExitLocation = exitConnectorModel.getExitLocation();
        if (sourceExitLocation == null) {
            return false;
        }
 
        final MapModel<G, A, R> targetMapModel = mapControl.getMapModel();
        @Nullable final BaseObject<G, A, R, ?> targetExit;
        //XXX   final G selectedExit = exitMatcher.getValidExit(selectedSquareModel.getSelectedGameObject());
        //XXX   if (selectedExit != null) {
        //XXX       targetExit = selectedExit;
        //XXX   } else {
        final BaseObject<G, A, R, ?> cursorExit = exitMatcher.getExit(targetMapModel, targetLocation);
        if (cursorExit != null) {
            targetExit = cursorExit;
        } else if (exitConnectorModel.isAutoCreateExit()) {
            targetExit = null;
        } else {
            return false;
        }
 
        final MapFile targetMapFile = targetMapModel.getMapFile();
 
        if (targetExit == null) {
            // paste into newly created exit game object
 
            final BaseObject<G, A, R, ?> targetArchetype;
            try {
                targetArchetype = archetypeSet.getArchetype(exitConnectorModel.getExitArchetypeName());
            } catch (final UndefinedArchetypeException ignored) {
                return false;
            }
 
            if (performAction) {
                if (!pasteExit(targetLocation, targetMapModel, targetArchetype, sourceExitLocation, targetMapFile)) {
                    return false;
                }
            }
        } else {
            // paste into existing exit
 
            if (performAction) {
                pasteExit(targetExit, targetMapModel, sourceExitLocation, targetMapFile);
            }
        }
 
        return true;
    }
 
    public boolean doExitConnect(final boolean performAction, @NotNull final MapControl<G, A, R> mapControl, @NotNull final Point targetLocation) {
        final ExitLocation sourceExitLocation = exitConnectorModel.getExitLocation();
        if (sourceExitLocation == null) {
            return false;
        }
 
        final MapModel<G, A, R> targetMapModel = mapControl.getMapModel();
        final MapFile targetMapFile = targetMapModel.getMapFile();
        if (targetMapFile == null) {
            // target map file is unsaved ==> no location to connect
            return false;
        }
 
        @Nullable final BaseObject<G, A, R, ?> targetExit;
        @Nullable final BaseObject<G, A, R, ?> targetArchetype;
        //XXX   final G selectedExit = exitMatcher.getValidExit(selectedSquareModel.getSelectedGameObject());
        //XXX   if (selectedExit != null) {
        //XXX       targetExit = selectedExit;
        //XXX       targetArchetype = null;
        //XXX   } else {
        final BaseObject<G, A, R, ?> cursorExit = exitMatcher.getExit(targetMapModel, targetLocation);
        if (cursorExit != null) {
            targetExit = cursorExit;
            targetArchetype = null;
        } else if (exitConnectorModel.isAutoCreateExit()) {
            targetExit = null;
            try {
                targetArchetype = archetypeSet.getArchetype(exitConnectorModel.getExitArchetypeName());
            } catch (final UndefinedArchetypeException ignored) {
                return false;
            }
        } else {
            return false;
        }
 
        final MapControl<G, A, R> sourceMapControl;
        try {
            sourceMapControl = mapManager.openMapFile(sourceExitLocation.getMapFile(), false);
        } catch (final IOException ex) {
            fileControl.reportLoadError(sourceExitLocation.getMapFile().getFile(), ex.getMessage());
            return false;
        }
        try {
            return doExitConnect(performAction, targetExit, targetArchetype, targetMapModel, targetLocation, targetMapFile, sourceMapControl.getMapModel(), sourceExitLocation);
        } finally {
            try {
                // XXX: remove hack when MapManager automatically saves released maps
                if (sourceMapControl.getMapModel().isModified() && sourceMapControl.getUseCounter() <= 1) {
                    try {
                        sourceMapControl.save();
                    } catch (final IOException ex) {
                        fileControl.reportSaveError(sourceMapControl, ex.getMessage());
                    }
                }
            } finally {
                mapManager.release(sourceMapControl);
            }
        }
    }
 
    private boolean doExitConnect(final boolean performAction, @Nullable final BaseObject<?, ?, ?, ?> targetExit, @Nullable final BaseObject<G, A, R, ?> targetArchetype, @NotNull final MapModel<G, A, R> targetMapModel, @NotNull final Point targetLocation, @NotNull final MapFile targetMapFile, @NotNull final MapModel<G, A, R> sourceMapModel, @NotNull final ExitLocation sourceExitLocation) {
        final MapFile sourceMapFile = sourceMapModel.getMapFile();
        if (sourceMapFile == null) {
            // source map is unsaved ==> cannot connect
            return false;
        }
 
        final Point sourceLocation = sourceExitLocation.getMapCoordinate();
 
        @Nullable final BaseObject<G, A, R, ?> sourceExit;
        @Nullable final BaseObject<G, A, R, ?> sourceArchetype;
        final BaseObject<G, A, R, ?> exit = exitMatcher.getExit(sourceMapModel, sourceLocation);
        if (exit != null) {
            sourceExit = exit;
            sourceArchetype = null;
        } else if (exitConnectorModel.isAutoCreateExit()) {
            sourceExit = null;
            try {
                sourceArchetype = archetypeSet.getArchetype(exitConnectorModel.getExitArchetypeName());
            } catch (final UndefinedArchetypeException ignored) {
                return false;
            }
        } else {
            return false;
        }
 
        if (performAction) {
            final ExitLocation targetExitLocation = new ExitLocation(targetMapFile, targetLocation, targetMapModel.getMapArchObject().getMapName());
            if (sourceExit == null) {
                if (!pasteExit(sourceLocation, sourceMapModel, sourceArchetype, targetExitLocation, sourceMapFile)) {
                    return false;
                }
            } else {
                pasteExit(sourceExit, sourceMapModel, targetExitLocation, sourceMapFile);
            }
 
            if (targetExit == null) {
                assert targetArchetype != null;
                if (!pasteExit(targetLocation, targetMapModel, targetArchetype, sourceExitLocation, targetMapFile)) {
                    return false;
                }
            } else {
                pasteExit(targetExit, targetMapModel, sourceExitLocation, targetMapFile);
            }
        }
 
        return true;
    }
 
    private void pasteExit(@NotNull final BaseObject<?, ?, ?, ?> gameObject, @NotNull final MapModel<G, A, R> mapModel, @NotNull final ExitLocation exitLocation, @Nullable final MapFile gameObjectMapFile) {
        mapModel.beginTransaction("paste exit");
        try {
            exitLocation.updateExitObject(gameObject, exitConnectorModel.isPasteExitName(), gameObjectMapFile);
        } finally {
            mapModel.endTransaction();
        }
    }
 
    private boolean pasteExit(@NotNull final Point location, @NotNull final MapModel<G, A, R> mapModel, @NotNull final BaseObject<G, A, R, ?> archetype, @NotNull final ExitLocation exitLocation, @Nullable final MapFile mapFile) {
        mapModel.beginTransaction("paste exit");
        try {
            final BaseObject<G, A, R, ?> newExit = mapModel.insertBaseObject(archetype, location, true, false, insertionModeSet.getTopmostInsertionMode());
            if (newExit == null) {
                return false;
            }
 
            exitLocation.updateExitObject(newExit, exitConnectorModel.isPasteExitName(), mapFile);
        } finally {
            mapModel.endTransaction();
        }
 
        return true;
    }
 
}