ArchetypeAttributeParser.java

Go to the documentation of this file.

/*
 * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
 * Copyright (C) 2000-2015 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.archetypetype;

import java.util.regex.Pattern;
import net.sf.gridarta.model.errorview.ErrorViewCategory;
import net.sf.gridarta.model.errorview.ErrorViewCollector;
import nu.xom.Attribute;
import nu.xom.Element;
import nu.xom.Node;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public class ArchetypeAttributeParser {

    @NotNull
    private static final Pattern LINE_BREAK = Pattern.compile("\\s*\n\\s*");

    @NotNull
    private static final Pattern UNDERSCORE = Pattern.compile("_");

    @NotNull
    private final ArchetypeAttributeFactory archetypeAttributeFactory;

    public ArchetypeAttributeParser(@NotNull final ArchetypeAttributeFactory archetypeAttributeFactory) {
        this.archetypeAttributeFactory = archetypeAttributeFactory;
    }

    @Nullable
    @SuppressWarnings("FeatureEnvy")
    public ArchetypeAttribute load(@NotNull final Element attributeElement, @NotNull final ErrorViewCollector errorViewCollector, @NotNull final ArchetypeTypeSet archetypeTypeSet, @NotNull final String typeName) throws MissingAttributeException {
        final String description = parseText(attributeElement);
        final int inputLength = getAttributeIntValue(attributeElement, Constants.XML_ATTRIBUTE_LENGTH, 0, typeName, errorViewCollector);
        final String attributeType = getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_TYPE);
        if (attributeType.equals("bool")) {
            return archetypeAttributeFactory.newArchetypeAttributeBool(getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_ARCH), getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_EDITOR), description, inputLength);
        } else if (attributeType.equals("bool_special")) {
            return archetypeAttributeFactory.newArchetypeAttributeBoolSpec(getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_ARCH), getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_EDITOR), description, inputLength, getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_TRUE), getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_FALSE));
        } else if (attributeType.equals("int")) {
            final int minValue = getAttributeIntValue(attributeElement, Constants.XML_ATTRIBUTE_MIN, Integer.MIN_VALUE, typeName, errorViewCollector);
            final int maxValue = getAttributeIntValue(attributeElement, Constants.XML_ATTRIBUTE_MAX, Integer.MAX_VALUE, typeName, errorViewCollector);
            final int minCheckValue = getAttributeIntValue(attributeElement, Constants.XML_ATTRIBUTE_CHECK_MIN, minValue, typeName, errorViewCollector);
            final int maxCheckValue = getAttributeIntValue(attributeElement, Constants.XML_ATTRIBUTE_CHECK_MAX, maxValue, typeName, errorViewCollector);

            if (minValue > maxValue) {
                errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, "type " + typeName + " has invalid " + Constants.XML_ATTRIBUTE_MIN + ".." + Constants.XML_ATTRIBUTE_MAX + " range: " + minValue + ".." + maxValue + ".");
                return null;
            }

            if (minCheckValue > maxCheckValue) {
                errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, "type " + typeName + " has invalid " + Constants.XML_ATTRIBUTE_CHECK_MIN + ".." + Constants.XML_ATTRIBUTE_CHECK_MAX + " range: " + minCheckValue + ".." + maxCheckValue + ".");
                return null;
            }

            if (minCheckValue < minValue) {
                errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, "type " + typeName + " has invalid " + Constants.XML_ATTRIBUTE_CHECK_MIN + " value: " + minCheckValue + " < " + Constants.XML_ATTRIBUTE_MIN + " = " + minValue + ".");
                return null;
            }

            if (maxCheckValue > maxValue) {
                errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, "type " + typeName + " has invalid " + Constants.XML_ATTRIBUTE_CHECK_MAX + " value: " + maxCheckValue + " > " + Constants.XML_ATTRIBUTE_MAX + " = " + maxValue + ".");
                return null;
            }

            return archetypeAttributeFactory.newArchetypeAttributeInt(getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_ARCH), getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_EDITOR), description, inputLength, minValue, maxValue, minCheckValue, maxCheckValue);
        } else if (attributeType.equals("long")) {
            return archetypeAttributeFactory.newArchetypeAttributeLong(getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_ARCH), getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_EDITOR), description, inputLength);
        } else if (attributeType.equals("float")) {
            return archetypeAttributeFactory.newArchetypeAttributeFloat(getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_ARCH), getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_EDITOR), description, inputLength);
        } else if (attributeType.equals("string")) {
            return archetypeAttributeFactory.newArchetypeAttributeString(getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_ARCH), getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_EDITOR), description, inputLength);
        } else if (attributeType.equals("map_path")) {
            return archetypeAttributeFactory.newArchetypeAttributeMapPath(getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_ARCH), getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_EDITOR), description, inputLength);
        } else if (attributeType.equals("script_file")) {
            return archetypeAttributeFactory.newArchetypeAttributeScriptFile(getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_ARCH), getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_EDITOR), description, inputLength);
        } else if (attributeType.equals("facename")) {
            return archetypeAttributeFactory.newArchetypeAttributeFacename(getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_ARCH), getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_EDITOR), description, inputLength);
        } else if (attributeType.equals("animname")) {
            return archetypeAttributeFactory.newArchetypeAttributeAnimname(getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_ARCH), getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_EDITOR), description, inputLength);
        } else if (attributeType.equals("text")) {
            return archetypeAttributeFactory.newArchetypeAttributeText(getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_ARCH_BEGIN), getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_ARCH_END), getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_EDITOR), description, inputLength, getAttributeValueOptional(attributeElement, Constants.XML_ATTRIBUTE_MARKER));
        } else if (attributeType.equals("fixed")) {
            return archetypeAttributeFactory.newArchetypeAttributeFixed(getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_ARCH), getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_VALUE), description, inputLength);
        } else if (attributeType.equals("spell")) {
            return archetypeAttributeFactory.newArchetypeAttributeSpell(getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_ARCH), getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_EDITOR), description, inputLength);
        } else if (attributeType.equals("nz_spell")) {
            return archetypeAttributeFactory.newArchetypeAttributeZSpell(getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_ARCH), getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_EDITOR), description, inputLength);
        } else if (attributeType.equals("inv_spell")) {
            return archetypeAttributeFactory.newArchetypeAttributeInvSpell(getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_ARCH), getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_EDITOR), description, inputLength);
        } else if (attributeType.equals("inv_spell_optional")) {
            return archetypeAttributeFactory.newArchetypeAttributeInvSpellOptional(getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_ARCH), getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_EDITOR), description, inputLength);
        } else if (attributeType.startsWith("bitmask")) {
            // got a bitmask attribute
            final String bitmaskName = attributeType.substring(8).trim();
            if (archetypeTypeSet.getBitmask(bitmaskName) == null) {
                errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, "type " + typeName + ": Bitmask \"" + bitmaskName + "\" is undefined.");
                return null;
            }
            return archetypeAttributeFactory.newArchetypeAttributeBitmask(getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_ARCH), getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_EDITOR), description, inputLength, bitmaskName);
        } else if (attributeType.startsWith("list_")) {
            // got a bitmask attribute
            final String listName = attributeType.substring(5).trim();
            if (archetypeTypeSet.getList(listName) == null) {
                errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, "type " + typeName + ": List \"" + listName + "\" is undefined.");
                return null;
            }
            return archetypeAttributeFactory.newArchetypeAttributeList(getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_ARCH), getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_EDITOR), description, inputLength, listName);
        } else if (attributeType.startsWith("list2_")) {
            // got a bitmask attribute
            final String listNames = attributeType.substring(6).trim();
            final String[] tmp = UNDERSCORE.split(listNames, 2);
            if (tmp.length != 2) {
                errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, "type " + typeName + ": Lists \"" + listNames + "\" are undefined.");
                return null;
            }
            final String listName1 = tmp[0];
            final String listName2 = tmp[1];
            if (archetypeTypeSet.getList(listName1) == null) {
                errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, "type " + typeName + ": List \"" + listName1 + "\" is undefined.");
                return null;
            }
            if (archetypeTypeSet.getList(listName2) == null) {
                errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, "type " + typeName + ": List \"" + listName2 + "\" is undefined.");
                return null;
            }
            return archetypeAttributeFactory.newArchetypeAttributeList2(getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_ARCH), getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_EDITOR), description, inputLength, listName1, listName2);
        } else if (attributeType.equals("treasurelist")) {
            return archetypeAttributeFactory.newArchetypeAttributeTreasure(getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_ARCH), getAttributeValue(attributeElement, Constants.XML_ATTRIBUTE_EDITOR), description, inputLength);
        } else {
            // unknown type
            errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, "type " + typeName + " has an attribute with unknown type: '" + attributeType + "'.");
            return null;
        }
    }

    @NotNull
    private static String parseText(@NotNull final Node attributeElement) {
        final String tmp = attributeElement.getValue().trim();
        return LINE_BREAK.matcher(tmp).replaceAll(tmp.startsWith("<html>") ? " " : "\n");
    }

    @NotNull
    private static String getAttributeValue(@NotNull final Element element, @NotNull final String attributeKey) throws MissingAttributeException {
        final Attribute attr = element.getAttribute(attributeKey);
        if (attr == null) {
            throw new MissingAttributeException(element.getLocalName(), attributeKey);
        }

        return attr.getValue().trim();
    }

    @Nullable
    private static String getAttributeValueOptional(@NotNull final Element element, @NotNull final String attributeKey) {
        final Attribute attr = element.getAttribute(attributeKey);
        return attr == null ? null : attr.getValue().trim();
    }

    private static int getAttributeIntValue(@NotNull final Element element, @NotNull final String attributeKey, final int defaultValue, @NotNull final String typeName, @NotNull final ErrorViewCollector errorViewCollector) {
        final String value = getAttributeValueOptional(element, attributeKey);
        if (value == null) {
            return defaultValue;
        }

        try {
            return Integer.parseInt(value);
        } catch (final NumberFormatException ignored) {
            errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, "type " + typeName + " has attribute '" + attributeKey + "' with invalid value '" + value + "' (must be a number).");
        }

        return defaultValue;
    }

}