MapImageCache.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.mapimagecache;
 
import java.awt.Image;
import java.io.File;
import java.io.IOException;
import java.lang.ref.SoftReference;
import java.util.Collection;
import java.util.EnumMap;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.CopyOnWriteArrayList;
import net.sf.gridarta.gui.map.renderer.MapRenderer;
import net.sf.gridarta.gui.map.renderer.RendererFactory;
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.gameobject.GameObject;
import net.sf.gridarta.model.io.CacheFiles;
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.MapManager;
import net.sf.gridarta.model.mapmanager.MapManagerListener;
import net.sf.gridarta.model.mapmodel.MapFile;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class MapImageCache<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> {
 
    private static final int ICON_WIDTH = 48;
 
    private static final int ICON_HEIGHT = 23;
 
    private static final int PREVIEW_SCALE = 8;
 
    @NotNull
    private final MapManager<G, A, R> mapManager;
 
    @NotNull
    private final RendererFactory<G, A, R> rendererFactory;
 
    @NotNull
    private final Collection<MapImageCacheListener<G, A, R>> listenerList = new CopyOnWriteArrayList<>();
 
    @NotNull
    private final Map<ImageType, MapImageCacheEntry> entries = new EnumMap<>(ImageType.class);
 
    @NotNull
    private final Map<MapControl<G, A, R>, SoftReference<MapRenderer>> mapRendererReferences = new HashMap<>();
 
    private final MapControlListener<G, A, R> mapControlListener = mapControl -> {
        final MapFile mapFile = mapControl.getMapModel().getMapFile();
        assert mapFile != null;
        final File file = mapFile.getFile();
        updateCaches(file, mapControl, ImageType.ICON);
        updateCaches(file, mapControl, ImageType.PREVIEW);
    };
 
    public MapImageCache(@NotNull final MapManager<G, A, R> mapManager, @NotNull final Image defaultIcon, @NotNull final Image defaultPreview, @NotNull final RendererFactory<G, A, R> rendererFactory, @NotNull final CacheFiles cacheFiles) {
        this.mapManager = mapManager;
        this.rendererFactory = rendererFactory;
        entries.put(ImageType.ICON, new MapImageCacheEntry(cacheFiles, defaultIcon, ImageType.ICON.toString()));
        entries.put(ImageType.PREVIEW, new MapImageCacheEntry(cacheFiles, defaultPreview, ImageType.PREVIEW.toString()));
 
        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) {
                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) {
                mapControl.addMapControlListener(mapControlListener);
                mapRendererReferences.remove(mapControl);
            }
 
        };
        mapManager.addMapManagerListener(mapManagerListener);
    }
 
    public void flush(@NotNull final File mapFile) {
        for (final ImageType imageType : ImageType.values()) {
            entries.get(imageType).flush(mapFile);
        }
    }
 
    @Nullable
    public Image getIcon(@NotNull final File mapFile) {
        return entries.get(ImageType.ICON).lookupCache(mapFile);
    }
 
    @Nullable
    public Image getOrCreateIcon(@NotNull final File mapFile) {
        return getOrCreate(mapFile, ImageType.ICON);
    }
 
    @NotNull
    public Image getOrCreateIcon(@NotNull final MapControl<G, A, R> mapControl) {
        return getOrCreate(mapControl, ImageType.ICON);
    }
 
    @Nullable
    public Image getPreview(@NotNull final File mapFile) {
        return entries.get(ImageType.PREVIEW).lookupCache(mapFile);
    }
 
    @Nullable
    public Image getOrCreatePreview(@NotNull final File mapFile) {
        return getOrCreate(mapFile, ImageType.PREVIEW);
    }
 
    @NotNull
    public Image getOrCreatePreview(@NotNull final MapControl<G, A, R> mapControl) {
        return getOrCreate(mapControl, ImageType.PREVIEW);
    }
 
    @Nullable
    private Image updateCaches(@NotNull final File mapFile, final ImageType imageType) {
        try {
            final MapControl<G, A, R> mapControl = mapManager.openMapFile(mapFile, false);
            try {
                return updateCaches(mapFile, mapControl, imageType);
            } finally {
                mapManager.release(mapControl);
            }
        } catch (final IOException ignored) {
            // ignore: do not update cached images
        }
 
        return entries.get(imageType).getDefaultImage();
    }
 
    @NotNull
    private Image updateCaches(@Nullable final File mapFile, @NotNull final MapControl<G, A, R> mapControl, final ImageType imageType) {
        final Image image;
        //noinspection ErrorNotRethrown
        try {
            image = getRenderer(mapControl).getFullImage();
        } catch (final OutOfMemoryError ignored) {
            return entries.get(imageType).getDefaultImage();
        }
        final Image[] images = new Image[2];
        images[0] = entries.get(ImageType.ICON).scaleImage(mapFile, image, ICON_WIDTH, ICON_HEIGHT);
        images[1] = entries.get(ImageType.PREVIEW).scaleImage(mapFile, image, (image.getWidth(null) + PREVIEW_SCALE - 1) / PREVIEW_SCALE, (image.getHeight(null) + PREVIEW_SCALE - 1) / PREVIEW_SCALE);
 
        if (mapFile != null) {
            for (final MapImageCacheListener<G, A, R> listener : listenerList) {
                listener.iconChanged(mapControl);
            }
        }
 
        return images[imageType == ImageType.ICON ? 0 : 1];
    }
 
    @NotNull
    private MapRenderer getRenderer(@NotNull final MapControl<G, A, R> mapControl) {
        final SoftReference<MapRenderer> mapRendererReference = mapRendererReferences.get(mapControl);
        final MapRenderer tmpMapRenderer = mapRendererReference == null ? null : mapRendererReference.get();
        final MapRenderer mapRenderer;
        if (tmpMapRenderer == null) {
            mapRenderer = rendererFactory.newSimpleMapRenderer(mapControl.getMapModel());
            mapRendererReferences.put(mapControl, new SoftReference<>(mapRenderer));
        } else {
            mapRenderer = tmpMapRenderer;
        }
        return mapRenderer;
    }
 
    public void addMapImageCacheListener(@NotNull final MapImageCacheListener<G, A, R> listener) {
        listenerList.add(listener);
    }
 
    public void removeMapImageCacheListener(@NotNull final MapImageCacheListener<G, A, R> listener) {
        listenerList.remove(listener);
    }
 
    @NotNull
    private Image getOrCreate(@NotNull final MapControl<G, A, R> mapControl, @NotNull final ImageType imageType) {
        final MapFile mapFile = mapControl.getMapModel().getMapFile();
        if (mapFile != null) {
            final Image image = entries.get(imageType).lookupCache(mapFile.getFile());
            if (image != null) {
                return image;
            }
        }
 
        return updateCaches(mapFile == null ? null : mapFile.getFile(), mapControl, imageType);
    }
 
    @Nullable
    private Image getOrCreate(@NotNull final File mapFile, @NotNull final ImageType imageType) {
        if (mapFile.isDirectory()) {
            return null;
        }
 
        final Image image = entries.get(imageType).lookupCache(mapFile);
        return image == null ? updateCaches(mapFile, imageType) : image;
    }
 
}