ConnectionChecker.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.model.validation.checks;
 
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.connectionview.Connections;
import net.sf.gridarta.model.gameobject.GameObject;
import net.sf.gridarta.model.maparchobject.MapArchObject;
import net.sf.gridarta.model.mapmodel.MapModel;
import net.sf.gridarta.model.match.GameObjectMatcher;
import net.sf.gridarta.model.validation.AbstractValidator;
import net.sf.gridarta.model.validation.ErrorCollector;
import net.sf.gridarta.model.validation.MapValidator;
import net.sf.gridarta.model.validation.ValidatorPreferences;
import net.sf.gridarta.model.validation.errors.ConnectionUnknownError;
import net.sf.gridarta.model.validation.errors.ConnectionWithoutSinksError;
import net.sf.gridarta.model.validation.errors.ConnectionWithoutSourcesError;
import org.jetbrains.annotations.NotNull;
 
public class ConnectionChecker<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends AbstractValidator<G, A, R> implements MapValidator<G, A, R> {
 
    @NotNull
    private final GameObjectMatcher sourceGameObjectMatcher;
 
    @NotNull
    private final GameObjectMatcher sinkGameObjectMatcher;
 
    @NotNull
    private final GameObjectMatcher sink2GameObjectMatcher;
 
    public ConnectionChecker(@NotNull final ValidatorPreferences validatorPreferences, @NotNull final GameObjectMatcher sourceGameObjectMatcher, @NotNull final GameObjectMatcher sinkGameObjectMatcher, @NotNull final GameObjectMatcher sink2GameObjectMatcher) {
        super(validatorPreferences);
        this.sourceGameObjectMatcher = sourceGameObjectMatcher;
        this.sinkGameObjectMatcher = sinkGameObjectMatcher;
        this.sink2GameObjectMatcher = sink2GameObjectMatcher;
    }
 
    @Override
    public void validateMap(@NotNull final MapModel<G, A, R> mapModel, @NotNull final ErrorCollector<G, A, R> errorCollector) {
        final Map<Integer, Rec> info = new HashMap<>();
        for (final Iterable<G> mapSquare : mapModel) {
            for (final G gameObject : mapSquare) {
                check(gameObject, info);
                for (final G invObject : gameObject.recursive()) {
                    check(invObject, info);
                }
            }
        }
 
        for (final Map.Entry<Integer, Rec> e : info.entrySet()) {
            e.getValue().addErrors(e.getKey(), mapModel, errorCollector);
        }
    }
 
    private void check(@NotNull final G gameObject, @NotNull final Map<Integer, Rec> info) {
        final int[] values = Connections.parseConnections(gameObject);
        if (values == null) {
            return;
        }
 
        for (final int value : values) {
            getRec(value, info).add(gameObject);
        }
    }
 
    private Rec getRec(final int value, @NotNull final Map<Integer, Rec> info) {
        final Rec existingRec = info.get(value);
        if (existingRec != null) {
            return existingRec;
        }
 
        final Rec rec = new Rec();
        info.put(value, rec);
        return rec;
    }
 
    private boolean isSource(@NotNull final GameObject<?, ?, ?> gameObject) {
        return sourceGameObjectMatcher.isMatching(gameObject);
    }
 
    private boolean isSink(@NotNull final GameObject<G, A, R> gameObject) {
        return sinkGameObjectMatcher.isMatching(gameObject) || sink2GameObjectMatcher.isMatching(gameObject);
    }
 
    private class Rec {
 
        @NotNull
        private final Set<G> sourceGameObjects = new HashSet<>();
 
        @NotNull
        private final Set<G> sinkGameObjects = new HashSet<>();
 
        @NotNull
        private final Collection<G> unknowns = new HashSet<>();
 
        protected void add(@NotNull final G gameObject) {
            boolean isUnknown = true;
            if (isSource(gameObject)) {
                sourceGameObjects.add(gameObject);
                isUnknown = false;
            }
            if (isSink(gameObject)) {
                sinkGameObjects.add(gameObject);
                isUnknown = false;
            }
            if (isUnknown) {
                unknowns.add(gameObject);
            }
        }
 
        protected void addErrors(final int connection, @NotNull final MapModel<G, A, R> mapModel, @NotNull final ErrorCollector<G, A, R> errorCollector) {
            if (!unknowns.isEmpty()) {
                for (final G gameObject : unknowns) {
                    errorCollector.collect(new ConnectionUnknownError<>(gameObject));
                }
                return;
            }
            if (sourceGameObjects.isEmpty()) {
                errorCollector.collect(new ConnectionWithoutSourcesError<>(mapModel, connection, sinkGameObjects));
            }
            if (sinkGameObjects.isEmpty()) {
                errorCollector.collect(new ConnectionWithoutSinksError<>(mapModel, connection, sourceGameObjects));
            }
        }
 
    }
 
}