MagicEarValidator.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.var.crossfire.model.validation.checks;
 
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.gameobject.GameObject;
import net.sf.gridarta.model.maparchobject.MapArchObject;
import org.apache.log4j.Category;
import org.apache.log4j.Logger;
import org.jetbrains.annotations.NotNull;
 
@SuppressWarnings("DuplicateBranchesInSwitch")
public class MagicEarValidator<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> {
 
    @NotNull
    private static final Category LOG = Logger.getLogger(MagicEarValidator.class);
 
    @NotNull
    private State state = State.N;
 
    public MagicEarValidator() {
        if (LOG.isDebugEnabled()) {
            LOG.debug("init: state=" + state);
        }
    }
 
    public void reset() {
        state = State.N;
        if (LOG.isDebugEnabled()) {
            LOG.debug("reset: state=" + state);
        }
    }
 
    public void text(@NotNull final ErrorGenerator<G, A, R> generator) {
        if (LOG.isDebugEnabled()) {
            LOG.debug("event: text");
        }
 
        switch (state) {
        case N:
            generator.errorSyntaxError("text before @match");
            setState(State.N2);
            return;
 
        case N2:
            return;
 
        case M:
            setState(State.T);
            return;
 
        case T:
            return;
 
        case TE:
        case TEE:
            setState(State.T);
            return;
        }
 
        throw new AssertionError("state=" + state);
    }
 
    public void empty(@NotNull final ErrorGenerator<G, A, R> generator) {
        if (LOG.isDebugEnabled()) {
            LOG.debug("event: empty");
        }
 
        switch (state) {
        case N:
            generator.errorSyntaxError("text before @match");
            setState(State.N2);
            return;
 
        case N2:
            return;
 
        case M:
            generator.errorSyntaxError("the text starts with an empty line");
            setState(State.T);
            return;
 
        case T:
            setState(State.TE);
            return;
 
        case TE:
            generator.errorSyntaxError("the text contains more than one consecutive empty line");
            setState(State.TEE);
            return;
 
        case TEE:
            return;
        }
 
        throw new AssertionError("state=" + state);
    }
 
    public void match(@NotNull final ErrorGenerator<G, A, R> generator) {
        if (LOG.isDebugEnabled()) {
            LOG.debug("event: match");
        }
 
        switch (state) {
        case N:
        case N2:
            setState(State.M);
            return;
 
        case M:
            return;
 
        case T:
            setState(State.M);
            return;
 
        case TE:
            generator.errorSyntaxError("the text ends with an empty line");
            setState(State.M);
            return;
 
        case TEE:
            setState(State.M);
            return;
        }
 
        throw new AssertionError("state=" + state);
    }
 
    public void reply(@NotNull final ErrorGenerator<G, A, R> generator) {
        if (LOG.isDebugEnabled()) {
            LOG.debug("event: reply");
        }
 
        generator.errorSyntaxError("@reply or @question should not be used for a magic ear");
    }
 
    public void eof(@NotNull final ErrorGenerator<G, A, R> generator) {
        if (LOG.isDebugEnabled()) {
            LOG.debug("event: eof");
        }
 
        switch (state) {
        case N:
        case N2:
        case M:
        case T:
            return;
 
        case TE:
            generator.errorSyntaxError("the text ends with an empty line");
            return;
 
        case TEE:
            return;
        }
 
        throw new AssertionError("state=" + state);
    }
 
    private void setState(@NotNull final State state) {
        if (this.state == state) {
            return;
        }
 
        if (LOG.isDebugEnabled()) {
            LOG.debug("state=" + state);
        }
        this.state = state;
    }
 
    private enum State {
 
        N,
 
        N2,
 
        M,
 
        T,
 
        TE,
 
        TEE
 
    }
 
}