MapFolder.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.mapfiles;
 
import java.io.File;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.regex.Pattern;
import net.sf.gridarta.gui.map.mapview.MapViewsManager;
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.gameobject.GameObject;
import net.sf.gridarta.model.io.MapReaderFactory;
import net.sf.gridarta.model.maparchobject.MapArchObject;
import net.sf.gridarta.model.mapcontrol.MapControl;
import net.sf.gridarta.model.mapmanager.MapManager;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class MapFolder<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> implements Iterable<PickmapState<G, A, R>> {
 
    @NotNull
    private static final Pattern PATTERN_VALID_MAP_FOLDER_NAME = Pattern.compile("[-a-zA-Z_+ 0-9,]+");
 
    private final Collection<MapFolderListener<G, A, R>> listeners = new CopyOnWriteArrayList<>();
 
    @Nullable
    private final MapFolder<G, A, R> parent;
 
    @NotNull
    private final Object sync = new Object();
 
    @NotNull
    private final String name;
 
    @NotNull
    private final File baseDir;
 
    @NotNull
    private final MapViewsManager<G, A, R> mapViewsManager;
 
    private final List<PickmapState<G, A, R>> pickmapStates = new ArrayList<>();
 
    public MapFolder(@Nullable final MapFolder<G, A, R> parent, @NotNull final String name, @NotNull final File baseDir, @NotNull final MapViewsManager<G, A, R> mapViewsManager) throws InvalidNameException {
        this.baseDir = baseDir;
        this.mapViewsManager = mapViewsManager;
        if (parent == null ? !name.isEmpty() : !PATTERN_VALID_MAP_FOLDER_NAME.matcher(name).matches()) {
            throw new InvalidNameException(name);
        }
 
        this.parent = parent;
        this.name = name;
    }
 
    @Nullable
    public MapFolder<G, A, R> getParent() {
        return parent;
    }
 
    @NotNull
    public String getName() {
        if (parent == null) {
            return "*default*";
        }
 
        return parent.parent == null ? name : parent.getName() + "/" + name;
    }
 
    @NotNull
    public File getDir() {
        return parent == null ? baseDir : new File(parent.getDir(), name);
    }
 
    public PickmapState<G, A, R> addPickmap(@NotNull final String name, @NotNull final MapReaderFactory<G, A> mapReaderFactory, @NotNull final MapManager<G, A, R> pickmapManager) throws InvalidNameException {
        final PickmapState<G, A, R> pickmapState;
        synchronized (sync) {
            pickmapState = new PickmapState<>(this, name, mapReaderFactory, pickmapManager, mapViewsManager);
            pickmapStates.add(pickmapState);
        }
        for (final MapFolderListener<G, A, R> listenerMap : listeners) {
            listenerMap.pickmapAdded(pickmapState);
        }
        return pickmapState;
    }
 
    public void removePickmap(@NotNull final PickmapState<G, A, R> pickmapState, final boolean deleteFile) {
        synchronized (sync) {
            final int index = pickmapStates.indexOf(pickmapState);
            if (index == -1) {
                throw new IllegalArgumentException("pickmap is not part of this folder: " + pickmapState.getFile());
            }
            if (deleteFile) {
                final File file = pickmapState.getFile();
                file.delete();
            }
            pickmapStates.remove(index);
        }
        for (final MapFolderListener<G, A, R> listenerMap : listeners) {
            listenerMap.pickmapRemoved(pickmapState);
        }
        pickmapState.freePickmap();
    }
 
    public void removeAllPickmaps(final boolean deleteFile) {
        while (true) {
            final PickmapState<G, A, R> pickmapState;
            synchronized (sync) {
                if (pickmapStates.isEmpty()) {
                    break;
                }
                pickmapState = pickmapStates.get(pickmapStates.size() - 1);
            }
            removePickmap(pickmapState, deleteFile);
        }
    }
 
    @Override
    public Iterator<PickmapState<G, A, R>> iterator() {
        return Collections.unmodifiableList(pickmapStates).iterator();
    }
 
    public int getPickmaps() {
        return pickmapStates.size();
    }
 
    public void addFolderListener(@NotNull final MapFolderListener<G, A, R> listenerMap) {
        listeners.add(listenerMap);
    }
 
    public void removeFolderListener(@NotNull final MapFolderListener<G, A, R> listenerMap) {
        listeners.remove(listenerMap);
    }
 
    public void getUnsavedPickmaps(@NotNull final Collection<MapControl<G, A, R>> unsavedPickmaps) {
        for (final PickmapState<G, A, R> pickmapState : pickmapStates) {
            pickmapState.getUnsavedPickmaps(unsavedPickmaps);
        }
    }
 
    public void firePickmapReverted(@NotNull final PickmapState<G, A, R> pickmapState, @NotNull final MapControl<G, A, R> oldPickmap) {
        for (final MapFolderListener<G, A, R> listenerMap : listeners) {
            listenerMap.pickmapReverted(pickmapState, oldPickmap);
        }
    }
 
}