PickmapChooserControl.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.panel.pickmapchooser;
 
import java.awt.Component;
import java.io.File;
import java.io.IOException;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import javax.swing.Action;
import javax.swing.JOptionPane;
import javax.swing.JPopupMenu;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import net.sf.gridarta.gui.dialog.newmap.NewMapDialogFactory;
import net.sf.gridarta.gui.map.mapview.MapView;
import net.sf.gridarta.gui.map.mapview.MapViewsManager;
import net.sf.gridarta.gui.mapfiles.MapFolderTree;
import net.sf.gridarta.gui.mapfiles.PickmapState;
import net.sf.gridarta.gui.panel.objectchooser.ObjectChooserTab;
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.mapcontrol.MapControlListener;
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.pickmapsettings.PickmapSettings;
import net.sf.gridarta.model.pickmapsettings.PickmapSettingsListener;
import net.sf.gridarta.model.validation.ErrorCollector;
import net.sf.gridarta.utils.ActionBuilderUtils;
import net.sf.gridarta.utils.EditorAction;
import net.sf.gridarta.utils.Size2D;
import net.sf.japi.swing.action.ActionBuilder;
import net.sf.japi.swing.action.ActionBuilderFactory;
import net.sf.japi.swing.action.ActionMethod;
import org.apache.log4j.Category;
import org.apache.log4j.Logger;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class PickmapChooserControl<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> implements EditorAction, ObjectChooserTab<G, A, R> {
 
    @NotNull
    private static final Category LOG = Logger.getLogger(PickmapChooserControl.class);
 
    @NotNull
    private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");
 
    @NotNull
    private final PickmapChooserModel<G, A, R> pickmapChooserModel;
 
    @NotNull
    private final PickmapSettings pickmapSettings;
 
    @NotNull
    private final PickmapChooserView<G, A, R> view;
 
    @NotNull
    private final MapFolderTree<G, A, R> mapFolderTree;
 
    @NotNull
    private final NewMapDialogFactory<G, A, R> newMapDialogFactory;
 
    @NotNull
    private final MapViewsManager<G, A, R> mapViewsManager;
 
    @NotNull
    private final FileControl<G, A, R> fileControl;
 
    @Nullable
    private Action aAddNewPickmap;
 
    @Nullable
    private Action aOpenPickmapMap;
 
    @Nullable
    private Action aDeletePickmap;
 
    @Nullable
    private Action aSavePickmap;
 
    @Nullable
    private Action aRevertPickmap;
 
    @NotNull
    private final Component parent;
 
    @Nullable
    private PickmapState<G, A, R> currentPickmapState;
 
    @Nullable
    private MapControl<G, A, R> currentPickmapControl;
 
    private boolean active;
 
    @NotNull
    private final MapControlListener<G, A, R> mapControlListener = mapControl -> {
        /*
         * If we open a pickmap in the editor, is handled as normal map.
         * to find out its original a pickmap we check the file name.
         */
        reloadPickmap(mapControl.getMapModel().getMapFile().getFile());
    };
 
    @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() {
            refresh();
        }
 
    };
 
    @NotNull
    private final PickmapChooserModelListener<G, A, R> pickmapChooserModelListener = new PickmapChooserModelListener<G, A, R>() {
 
        @Override
        public void activePickmapChanged(@Nullable final PickmapState<G, A, R> pickmapState) {
            setCurrentPickmap(pickmapState);
        }
 
        @Override
        public void pickmapReverted(@NotNull final PickmapState<G, A, R> pickmapState) {
            setCurrentPickmap(pickmapState);
        }
 
        @Override
        public void pickmapModifiedChanged(final int index, @NotNull final PickmapState<G, A, R> pickmapState) {
            // ignore
        }
 
    };
 
    @NotNull
    private final ChangeListener changeListener = new ChangeListener() {
 
        @Override
        public void stateChanged(final ChangeEvent e) {
            final PickmapState<G, A, R> pickmapState = getSelectedPickmap();
            final MapControl<G, A, R> mapControl = pickmapState == null ? null : pickmapState.getPickmap();
            if (mapControl != null) {
                mapViewsManager.getMapViewFrame(mapControl).getMapCursor().deactivate();
            }
            pickmapChooserModel.fireActivePickmapChanged(pickmapState);
        }
 
    };
 
    @NotNull
    private final MapManagerListener<G, A, R> mapManagerListener = new MapManagerListener<G, A, R>() {
 
        @Override
        public void currentMapChanged(@Nullable final MapControl<G, A, R> mapControl) {
            // ignore
        }
 
        @Override
        public void mapCreated(@NotNull final MapControl<G, A, R> mapControl, final boolean interactive) {
            if (!mapControl.isPickmap()) {
                mapControl.addMapControlListener(mapControlListener);
            }
        }
 
        @Override
        public void mapClosing(@NotNull final MapControl<G, A, R> mapControl) {
            // ignore
        }
 
        @Override
        public void mapClosed(@NotNull final MapControl<G, A, R> mapControl) {
            if (!mapControl.isPickmap()) {
                mapControl.removeMapControlListener(mapControlListener);
            }
        }
 
    };
 
    @NotNull
    private final PickmapSettingsListener pickmapSettingsListener = locked -> refresh();
 
    public PickmapChooserControl(@NotNull final PickmapChooserModel<G, A, R> pickmapChooserModel, @NotNull final PickmapSettings pickmapSettings, @NotNull final NewMapDialogFactory<G, A, R> newMapDialogFactory, @NotNull final MapFolderTree<G, A, R> mapFolderTree, @NotNull final MapManager<G, A, R> mapManager, @NotNull final Component parent, @NotNull final MapViewsManager<G, A, R> mapViewsManager, @NotNull final FileControl<G, A, R> fileControl, @NotNull final PickmapChooserView<G, A, R> pickmapChooserView) {
        this.pickmapChooserModel = pickmapChooserModel;
        this.pickmapSettings = pickmapSettings;
        this.mapFolderTree = mapFolderTree;
        this.parent = parent;
        this.newMapDialogFactory = newMapDialogFactory;
        this.mapViewsManager = mapViewsManager;
        this.fileControl = fileControl;
        ACTION_BUILDER.createToggles(true, this, "lockAllPickmaps");
        pickmapChooserModel.addPickmapChooserListener(pickmapChooserModelListener);
        view = pickmapChooserView;
        view.addChangeListener(changeListener);
        mapManager.addMapManagerListener(mapManagerListener);
        pickmapSettings.addPickmapSettingsListener(pickmapSettingsListener);
    }
 
    public void setPopupMenu(@NotNull final JPopupMenu popupMenu) {
        view.setPopupMenu(popupMenu);
    }
 
    private void reloadPickmap(@NotNull final File file) {
        final PickmapState<G, A, R> pickmapState = pickmapChooserModel.getPickmap(file);
        if (pickmapState != null) {
            try {
                pickmapState.revert();
            } catch (final IOException ex) {
                LOG.warn("cannot reload pickmap " + pickmapState.getFile() + ": " + ex.getMessage());
            }
        }
    }
 
    @ActionMethod
    public boolean isLockAllPickmaps() {
        return pickmapSettings.isLocked();
    }
 
    @Nullable
    @Override
    public G getSelection() {
        final MapControl<G, A, R> pickmap = currentPickmapControl;
        if (pickmap == null) {
            return null;
        }
 
        final MapView<G, A, R> mapView = mapViewsManager.getMapViewFrame(pickmap);
        return mapView == null ? null : mapView.getSelectedGameObject();
    }
 
    public boolean canExit() {
        final Collection<MapControl<G, A, R>> unsavedPickmaps = new HashSet<>();
        mapFolderTree.getUnsavedPickmaps(unsavedPickmaps);
        for (final MapControl<G, A, R> pickmap : unsavedPickmaps) {
            final int result = ACTION_BUILDER.showConfirmDialog(parent, JOptionPane.YES_NO_CANCEL_OPTION, JOptionPane.WARNING_MESSAGE, "pickmapConfirmSaveChanges", pickmap.getMapModel().getMapArchObject().getMapName());
            if (result == JOptionPane.YES_OPTION) {
                try {
                    pickmap.save();
                } catch (final IOException e) {
                    ACTION_BUILDER.showMessageDialog(parent, "encodeMapFile", pickmap.getMapModel().getMapFile(), e.getMessage());
                    return false;
                }
                if (pickmap.getMapModel().isModified()) {
                    return false;
                }
            } else if (result == JOptionPane.CANCEL_OPTION || result == JOptionPane.CLOSED_OPTION) {
                return false;
            }
        }
        return true;
    }
 
    @Nullable
    private PickmapState<G, A, R> getSelectedPickmap() {
        final int selectedIndex = view.getSelectedIndex();
        if (selectedIndex == -1) {
            return null;
        }
        try {
            return pickmapChooserModel.get(selectedIndex);
        } catch (final IndexOutOfBoundsException ignored) {
            return null;
        }
    }
 
    @NotNull
    @Override
    public Component getComponent() {
        return view.getPickmapPanel();
    }
 
    @Override
    public void setActive(final boolean active) {
        if (this.active == active) {
            return;
        }
 
        this.active = active;
        refresh();
    }
 
    @Override
    public boolean isMatching(@NotNull final G gameObject) {
        for (final G selection : getSelections()) {
            if (gameObject.isEqual(selection)) {
                return true;
            }
        }
        return false;
    }
 
    @NotNull
    @Override
    public List<G> getSelections() {
        final MapControl<G, A, R> pickmap = currentPickmapControl;
        if (pickmap == null) {
            return Collections.emptyList();
        }
 
        final MapView<G, A, R> mapView = mapViewsManager.getMapViewFrame(pickmap);
        return mapView == null ? Collections.emptyList() : mapView.getSelectedGameObjects();
    }
 
    @NotNull
    @Override
    public String getTitle() {
        return ActionBuilderUtils.getString(ACTION_BUILDER, "objectChooser.pickmapsTabTitle");
    }
 
    @ActionMethod
    public void addNewPickmap() {
        doAddNewPickmap(true);
    }
 
    @ActionMethod
    public void openPickmapMap() {
        doOpenPickmapMap(true);
    }
 
    @ActionMethod
    public void deletePickmap() {
        doDeletePickmap(true);
    }
 
    @ActionMethod
    public void savePickmap() {
        doSavePickmap(true);
    }
 
    @ActionMethod
    public void revertPickmap() {
        doRevertPickmap(true);
    }
 
    @Nullable
    private PickmapState<G, A, R> getOpenPickmapMap() {
        return active && !pickmapSettings.isLocked() ? currentPickmapState : null;
    }
 
    private void setCurrentPickmap(@Nullable final PickmapState<G, A, R> currentPickmapState) {
        final MapControl<G, A, R> pickmapControl = currentPickmapState == null ? null : currentPickmapState.getPickmap();
        if (this.currentPickmapState == currentPickmapState && currentPickmapControl == pickmapControl) {
            return;
        }
 
        if (currentPickmapControl != null) {
            currentPickmapControl.removeMapControlListener(mapControlListener);
            currentPickmapControl.getMapModel().removeMapModelListener(mapModelListener);
        }
 
        this.currentPickmapState = currentPickmapState;
        currentPickmapControl = pickmapControl;
 
        if (currentPickmapControl != null) {
            currentPickmapControl.addMapControlListener(mapControlListener);
            currentPickmapControl.getMapModel().addMapModelListener(mapModelListener);
        }
 
        refresh();
    }
 
    @ActionMethod
    public void setLockAllPickmaps(final boolean lockAllPickmaps) {
        pickmapSettings.setLocked(lockAllPickmaps);
    }
 
    private void refresh() {
        if (aAddNewPickmap != null) {
            aAddNewPickmap.setEnabled(doAddNewPickmap(false));
        }
        if (aOpenPickmapMap != null) {
            aOpenPickmapMap.setEnabled(doOpenPickmapMap(false));
        }
        if (aDeletePickmap != null) {
            aDeletePickmap.setEnabled(doDeletePickmap(false));
        }
        if (aSavePickmap != null) {
            aSavePickmap.setEnabled(doSavePickmap(false));
        }
        if (aRevertPickmap != null) {
            aRevertPickmap.setEnabled(doRevertPickmap(false));
        }
    }
 
    private boolean doAddNewPickmap(final boolean performAction) {
        if (pickmapSettings.isLocked()) {
            return false;
        }
 
        if (performAction) {
            newMapDialogFactory.showNewPickmapDialog();
        }
 
        return true;
    }
 
    private boolean doOpenPickmapMap(final boolean performAction) {
        final PickmapState<G, A, R> pickmapState = getOpenPickmapMap();
        if (pickmapState == null) {
            return false;
        }
 
        if (performAction) {
            final File file = pickmapState.getFile();
            try {
                mapViewsManager.openMapFileWithView(file, null, null);
            } catch (final IOException ex) {
                fileControl.reportLoadError(file, ex.getMessage());
                return false;
            }
        }
 
        return true;
    }
 
    private boolean doDeletePickmap(final boolean performAction) {
        if (pickmapSettings.isLocked() || !active) {
            return false;
        }
 
        final PickmapState<G, A, R> pickmapState = currentPickmapState;
        if (pickmapState == null) {
            return false;
        }
 
        if (performAction) {
            if (!ACTION_BUILDER.showQuestionDialog(parent, "confirmDeletePickmap", pickmapState.getFile().getName())) {
                return false;
            }
 
            pickmapState.remove(true);
        }
 
        return true;
    }
 
    private boolean doSavePickmap(final boolean performAction) {
        if (pickmapSettings.isLocked() || !active) {
            return false;
        }
 
        if (currentPickmapState == null || currentPickmapControl == null || !currentPickmapControl.getMapModel().isModified()) {
            return false;
        }
 
        final PickmapState<G, A, R> pickmapState = currentPickmapState;
        if (pickmapState == null) {
            return false;
        }
 
        if (performAction) {
            try {
                pickmapState.save();
            } catch (final IOException e) {
                ACTION_BUILDER.showMessageDialog(parent, "encodeMapFile", pickmapState, e.getMessage());
                return false;
            }
        }
 
        return true;
    }
 
    private boolean doRevertPickmap(final boolean performAction) {
        if (pickmapSettings.isLocked() || !active) {
            return false;
        }
 
        final PickmapState<G, A, R> pickmapState = currentPickmapState;
        if (pickmapState == null) {
            return false;
        }
 
        final File mapFileFile = pickmapState.getFile();
        if (currentPickmapControl == null || !currentPickmapControl.getMapModel().isModified() || !mapFileFile.exists()) {
            return false;
        }
 
        final MapControl<G, A, R> mapControl = pickmapState.getPickmap();
        if (mapControl == null) {
            return false;
        }
 
        final MapModel<G, A, R> mapModel = mapControl.getMapModel();
        final MapFile mapControlMapFile = mapModel.getMapFile();
        if (mapControlMapFile == null) {
            return false;
        }
 
        if (performAction) {
            if (!mapControlMapFile.getFile().exists()) {
                ACTION_BUILDER.showMessageDialog(parent, "revertPickmapGone", mapControlMapFile);
                return false;
            }
 
            if (mapModel.isModified() && !ACTION_BUILDER.showQuestionDialog(parent, "confirmRevertPickmap", mapFileFile.getName())) {
                return false;
            }
 
            try {
                pickmapState.revert();
            } catch (final IOException ex) {
                ACTION_BUILDER.showMessageDialog(null/*XXX:parent*/, "pickmapIOError", mapFileFile.getName(), ex.getMessage());
                return false;
            }
        }
 
        return true;
    }
 
    @Override
    public void setAction(@NotNull final Action action, @NotNull final String name) {
        switch (name) {
        case "addNewPickmap":
            aAddNewPickmap = action;
            break;
 
        case "openPickmapMap":
            aOpenPickmapMap = action;
            break;
 
        case "deletePickmap":
            aDeletePickmap = action;
            break;
 
        case "savePickmap":
            aSavePickmap = action;
            break;
 
        case "revertPickmap":
            aRevertPickmap = action;
            break;
 
        default:
            throw new IllegalArgumentException("unsupported action name: " + name);
        }
        refresh();
    }
 
}