MapFileActions.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.gui.map;
 
import java.awt.Component;
import java.io.IOException;
import java.util.Set;
import javax.swing.Action;
import net.sf.gridarta.gui.map.mapview.MapView;
import net.sf.gridarta.gui.map.mapview.MapViewManager;
import net.sf.gridarta.gui.map.mapview.MapViewManagerListener;
import net.sf.gridarta.gui.map.mapview.MapViewsManager;
import net.sf.gridarta.gui.map.renderer.ImageCreator2;
import net.sf.gridarta.model.archetype.Archetype;
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.mapmanager.MapManagerListener;
import net.sf.gridarta.model.mapmodel.MapFile;
import net.sf.gridarta.model.mapmodel.MapModel;
import net.sf.gridarta.model.mapmodel.MapModelListener;
import net.sf.gridarta.model.mapmodel.MapSquare;
import net.sf.gridarta.model.validation.ErrorCollector;
import net.sf.gridarta.utils.EditorAction;
import net.sf.gridarta.utils.Size2D;
import net.sf.japi.swing.action.ActionMethod;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class MapFileActions<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> implements EditorAction {
 
    @NotNull
    private final ImageCreator2<G, A, R> imageCreator2;
 
    @NotNull
    private final FileControl<G, A, R> fileControl;
 
    @NotNull
    private final Component mainView;
 
    @NotNull
    private final MapManager<G, A, R> mapManager;
 
    @NotNull
    private final MapViewsManager<G, A, R> mapViewsManager;
 
    @Nullable
    private Action aSaveMap;
 
    @Nullable
    private Action aSaveMapAs;
 
    @Nullable
    private Action aCreateImage;
 
    @Nullable
    private Action aReloadMap;
 
    @Nullable
    private Action aCloseMap;
 
    @Nullable
    private MapControl<G, A, R> currentMapControl;
 
    @Nullable
    private MapView<G, A, R> currentMapView;
 
    @NotNull
    private final MapModelListener<G, A, R> mapModelListener = new MapModelListener<G, A, R>() {
 
        @Override
        public void mapSizeChanged(@NotNull final Size2D newSize) {
            // ignore
        }
 
        @Override
        public void mapSquaresChanged(@NotNull final Set<MapSquare<G, A, R>> mapSquares) {
            // ignore
        }
 
        @Override
        public void mapObjectsChanged(@NotNull final Set<G> gameObjects, @NotNull final Set<G> transientGameObjects) {
            // ignore
        }
 
        @Override
        public void errorsChanged(@NotNull final ErrorCollector<G, A, R> errors) {
            // ignore
        }
 
        @Override
        public void mapFileChanged(@Nullable final MapFile oldMapFile) {
            // ignore
        }
 
        @Override
        public void modifiedChanged() {
            updateActions();
        }
 
    };
 
    @NotNull
    private final MapManagerListener<G, A, R> mapManagerListener = new MapManagerListener<G, A, R>() {
 
        @Override
        public void currentMapChanged(@Nullable final MapControl<G, A, R> mapControl) {
            if (currentMapControl != null) {
                currentMapControl.getMapModel().removeMapModelListener(mapModelListener);
            }
            currentMapControl = mapControl;
            if (currentMapControl != null) {
                currentMapControl.getMapModel().addMapModelListener(mapModelListener);
            }
            updateActions();
        }
 
        @Override
        public void mapCreated(@NotNull final MapControl<G, A, R> mapControl, final boolean interactive) {
            // ignore
        }
 
        @Override
        public void mapClosing(@NotNull final MapControl<G, A, R> mapControl) {
            // ignore
        }
 
        @Override
        public void mapClosed(@NotNull final MapControl<G, A, R> mapControl) {
            // ignore
        }
 
    };
 
    public MapFileActions(@NotNull final ImageCreator2<G, A, R> imageCreator2, @NotNull final MapManager<G, A, R> mapManager, @NotNull final MapViewsManager<G, A, R> mapViewsManager, @NotNull final MapViewManager<G, A, R> mapViewManager, @NotNull final FileControl<G, A, R> fileControl, @NotNull final Component mainView) {
        this.imageCreator2 = imageCreator2;
        this.mapManager = mapManager;
        this.mapViewsManager = mapViewsManager;
        this.fileControl = fileControl;
        this.mainView = mainView;
        mapManager.addMapManagerListener(mapManagerListener);
        currentMapControl = mapManager.getCurrentMap();
        if (currentMapControl != null) {
            currentMapControl.getMapModel().addMapModelListener(mapModelListener);
        }
        final MapViewManagerListener<G, A, R> mapViewManagerListener = new MapViewManagerListener<G, A, R>() {
 
            @Override
            public void activeMapViewChanged(@Nullable final MapView<G, A, R> mapView) {
                currentMapView = mapView;
                updateActions();
            }
 
            @Override
            public void mapViewCreated(@NotNull final MapView<G, A, R> mapView) {
                // ignore
            }
 
            @Override
            public void mapViewClosing(@NotNull final MapView<G, A, R> mapView) {
                // ignore
            }
 
        };
        mapViewManager.addMapViewManagerListener(mapViewManagerListener);
        currentMapView = mapViewManager.getActiveMapView();
    }
 
    public void closeNotify() {
        mapManager.removeMapManagerListener(mapManagerListener);
        if (currentMapControl != null) {
            currentMapControl.getMapModel().removeMapModelListener(mapModelListener);
        }
    }
 
    private void updateActions() {
        if (aSaveMap != null) {
            aSaveMap.setEnabled(doSaveMap(false));
        }
        if (aSaveMapAs != null) {
            aSaveMapAs.setEnabled(doSaveMapAs(false));
        }
        if (aCreateImage != null) {
            aCreateImage.setEnabled(doCreateImage(false));
        }
        if (aReloadMap != null) {
            aReloadMap.setEnabled(doReloadMap(false));
        }
        if (aCloseMap != null) {
            aCloseMap.setEnabled(doCloseMap(false));
        }
    }
 
    @ActionMethod
    public void saveMap() {
        doSaveMap(true);
    }
 
    @ActionMethod
    public void saveMapAs() {
        doSaveMapAs(true);
    }
 
    @ActionMethod
    public void createImage() {
        doCreateImage(true);
    }
 
    @ActionMethod
    public void reloadMap() {
        doReloadMap(true);
    }
 
    @ActionMethod
    public void closeMap() {
        doCloseMap(true);
    }
 
    private boolean doSaveMap(final boolean performAction) {
        final MapControl<G, A, R> mapControl = currentMapControl;
        if (mapControl == null || !mapControl.getMapModel().isModified()) {
            return false;
        }
 
        if (performAction) {
            if (!fileControl.save(mapControl)) {
                return false;
            }
        }
 
        return true;
    }
 
    private boolean doSaveMapAs(final boolean performAction) {
        final MapControl<G, A, R> mapControl = currentMapControl;
        if (mapControl == null) {
            return false;
        }
 
        if (performAction) {
            if (!fileControl.saveAs(mapControl)) {
                return false;
            }
        }
 
        return true;
    }
 
    private boolean doCreateImage(final boolean performAction) {
        final MapView<G, A, R> mapView = currentMapView;
        if (mapView == null) {
            return false;
        }
 
        if (performAction) {
            final MapModel<G, A, R> mapModel = mapView.getMapControl().getMapModel();
            imageCreator2.createImage(mapModel, mainView);
        }
 
        return true;
    }
 
    private boolean doReloadMap(final boolean performAction) {
        final MapControl<G, A, R> mapControl = currentMapControl;
        if (mapControl == null) {
            return false;
        }
 
        final MapFile mapFile = mapControl.getMapModel().getMapFile();
        if (mapFile == null) {
            return false;
        }
 
        if (performAction) {
            try {
                mapManager.revert(mapControl);
            } catch (final IOException ex) {
                fileControl.reportLoadError(mapFile.getFile(), ex.getMessage());
                return false;
            }
        }
 
        return true;
    }
 
    private boolean doCloseMap(final boolean performAction) {
        final MapView<G, A, R> mapView = currentMapView;
        if (mapView == null) {
            return false;
        }
 
        if (performAction) {
            mapViewsManager.closeMapView(mapView);
        }
 
        return true;
    }
 
    @Override
    public void setAction(@NotNull final Action action, @NotNull final String name) {
        switch (name) {
        case "saveMap":
            aSaveMap = action;
            break;
 
        case "saveMapAs":
            aSaveMapAs = action;
            break;
 
        case "createImage":
            aCreateImage = action;
            break;
 
        case "reloadMap":
            aReloadMap = action;
            break;
 
        case "closeMap":
            aCloseMap = action;
            break;
 
        default:
            throw new IllegalArgumentException("unsupported action name: " + name);
        }
        updateActions();
    }
 
}