KeywordValidator.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 java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Locale;
import java.util.Map;
import java.util.Map.Entry;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
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;
 
public class KeywordValidator<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> {
 
    @NotNull
    private static final Category LOG = Logger.getLogger(KeywordValidator.class);
 
    @NotNull
    private static final Pattern PATTERN_UPPER_CASE_LETTER = Pattern.compile("[A-Z]");
 
    @NotNull
    private final Collection<String> keywords = new HashSet<>();
 
    @NotNull
    private final Map<String, String> replyKeywords = new HashMap<>();
 
    private boolean matchAllKeyword;
 
    public KeywordValidator() {
        if (LOG.isDebugEnabled()) {
            LOG.debug("init");
        }
    }
 
    public void reset() {
        if (LOG.isDebugEnabled()) {
            LOG.debug("reset");
        }
 
        keywords.clear();
        replyKeywords.clear();
        matchAllKeyword = false;
    }
 
    public void match(@NotNull final ErrorGenerator<G, A, R> generator, @NotNull final Iterable<String> matchKeywords) {
        if (LOG.isDebugEnabled()) {
            LOG.debug("event: match");
        }
 
        for (final String matchKeyword : matchKeywords) {
            if (matchKeyword.isEmpty()) {
                generator.errorKeywordError("empty keyword in '@match'");
            } else if (matchKeyword.equals("*")) {
                if (matchAllKeyword) {
                    generator.errorKeywordError("duplicate '@match *'. The second one will never match");
                }
                matchAllKeyword = true;
            } else {
                if (matchAllKeyword && !matchKeyword.equals("note")) { // allow "@match note" after "@match *": some maps use this for notes to developers
                    generator.errorKeywordError("keyword '" + matchKeyword + "' in '@match' after '@match *'. The keyword will never match");
                }
                if (!keywords.add(matchKeyword.toLowerCase(Locale.ROOT))) {
                    generator.errorKeywordError("duplicate keyword '" + matchKeyword + "' in '@match'. The second one will never match");
                }
            }
        }
    }
 
    public void reply(@NotNull final ErrorGenerator<G, A, R> generator, @NotNull final String command, @NotNull final String keyword) {
        if (!command.equals("@reply") && !command.equals("@question")) {
            throw new IllegalArgumentException("invalid command: " + command);
        }
        if (LOG.isDebugEnabled()) {
            LOG.debug("event: reply " + command + " " + keyword);
        }
 
        final Matcher matcher = PATTERN_UPPER_CASE_LETTER.matcher(keyword);
        if (matcher.find()) {
            generator.errorKeywordError("the word '" + keyword + "' uses upper-case letters. Matches are case-insensitive, therefore replies and questions should be specified in lower-case letters only");
        }
 
        replyKeywords.put(keyword.toLowerCase(Locale.ROOT), command);
    }
 
    public void eof(@NotNull final ErrorGenerator<G, A, R> generator) {
        if (LOG.isDebugEnabled()) {
            LOG.debug("event: eof");
        }
 
        for (final Entry<String, String> e : replyKeywords.entrySet()) {
            final String keyword = e.getKey();
            if (!keywords.contains(keyword)) {
                final String command = e.getValue();
                generator.errorKeywordError("keyword '" + keyword + "' in '" + command + "' does not appear in any @match line");
            }
        }
 
        keywords.clear();
        replyKeywords.clear();
        matchAllKeyword = false;
    }
 
}