ArchetypeTypeSetParser.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 net.sf.gridarta.model.errorview.ErrorViewCategory;
import net.sf.gridarta.model.errorview.ErrorViewCollector;
import net.sf.gridarta.utils.StringUtils;
import net.sf.gridarta.utils.SyntaxErrorException;
import net.sf.gridarta.utils.XmlUtils;
import net.sf.gridarta.utils.xml.ElementsIterable;
import nu.xom.Attribute;
import nu.xom.Document;
import nu.xom.Element;
import nu.xom.Elements;
import nu.xom.Node;
import org.apache.log4j.Category;
import org.apache.log4j.Logger;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public class ArchetypeTypeSetParser {

    @NotNull
    private static final Category LOG = Logger.getLogger(ArchetypeTypeSetParser.class);

    @NotNull
    private final ArchetypeTypeParser archetypeTypeParser;

    public ArchetypeTypeSetParser(@NotNull final ArchetypeTypeParser archetypeTypeParser) {
        this.archetypeTypeParser = archetypeTypeParser;
    }

    @NotNull
    public ArchetypeTypeSet loadTypesFromXML(@NotNull final ErrorViewCollector errorViewCollector, @NotNull final Document document) {
        final ArchetypeTypeSet archetypeTypeSet = new ArchetypeTypeSet();
        final Element rootElement = document.getRootElement();
        parseBitmasks(archetypeTypeSet, XmlUtils.getChild(rootElement, Constants.XML_ELEMENT_BITMASKS), errorViewCollector);
        parseLists(archetypeTypeSet, XmlUtils.getChild(rootElement, Constants.XML_ELEMENT_LISTS), errorViewCollector);
        final IgnorelistsDefinition ignorelistsDefinition = parseIgnoreLists(XmlUtils.getChild(rootElement, Constants.XML_ELEMENT_IGNORELISTS), errorViewCollector);
        final Elements attributeOrderElements = rootElement.getChildElements(Constants.XML_ELEMENT_ATTRIBUTE_ORDER);
        if (attributeOrderElements.size() > 0) {
            parseAttributeOrder(archetypeTypeSet, attributeOrderElements.get(0), errorViewCollector);
        }
        final ArchetypeType defaultArchetypeType = parseDefaultType(archetypeTypeSet, XmlUtils.getChild(rootElement, Constants.XML_ELEMENT_DEFAULT_TYPE), errorViewCollector, ignorelistsDefinition);

        for (final Element element : new ElementsIterable(rootElement.getChildElements(Constants.XML_ELEMENT_TYPE))) {
            parseTypes(archetypeTypeSet, element, errorViewCollector, defaultArchetypeType, ignorelistsDefinition);
        }

        if (LOG.isInfoEnabled()) {
            LOG.info("Loaded " + archetypeTypeSet.getArchetypeTypeCount() + " types.");
        }
        return archetypeTypeSet;
    }

    private static void parseBitmasks(@NotNull final ArchetypeTypeSet archetypeTypeSet, @NotNull final Element bitmasksElement, @NotNull final ErrorViewCollector errorViewCollector) {
        for (final Element bitmaskElement : new ElementsIterable(bitmasksElement.getChildElements(Constants.XML_ELEMENT_BITMASK))) {
            final String name = bitmaskElement.getAttribute(Constants.XML_BITMASK_NAME).getValue();
            final AttributeBitmask attributeBitmask = parseBitmask(bitmaskElement, name, errorViewCollector);
            if (attributeBitmask != null) {
                archetypeTypeSet.addBitmask(name, attributeBitmask);
            }
        }
    }

    @Nullable
    private static AttributeBitmask parseBitmask(@NotNull final Element bitmaskElement, @NotNull final String name, @NotNull final ErrorViewCollector errorViewCollector) {
        final boolean isNamed = bitmaskElement.getAttribute(Constants.XML_BITMASK_IS_NAMED).getValue().equals("yes");
        final AttributeBitmask attributeBitmask = new AttributeBitmask(isNamed);

        for (final Element element : new ElementsIterable(bitmaskElement.getChildElements(Constants.XML_ELEMENT_BMENTRY))) {
            parseBmentry(element, errorViewCollector, name, isNamed, attributeBitmask);
        }
        if (attributeBitmask.getNumber() <= 0) {
            errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, name + ": no '" + Constants.XML_BMENTRY_BIT + "' entries");
            return null;
        }

        if (isNamed && !attributeBitmask.containsEncoding(0)) {
            errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, name + ": missing name for value 0");
            return null;
        }
        if (isNamed && !attributeBitmask.containsEncoding(attributeBitmask.getMaxValue())) {
            errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, name + ": missing name for value " + attributeBitmask.getMaxValue());
            return null;
        }

        return attributeBitmask;
    }

    private static void parseBmentry(@NotNull final Element bmentryElement, @NotNull final ErrorViewCollector errorViewCollector, @NotNull final String bitmaskName, final boolean isNamed, @NotNull final AttributeBitmask attributeBitmask) {
        final Attribute tmpBitAttribute = bmentryElement.getAttribute(Constants.XML_BMENTRY_BIT);
        final String bitAttribute = tmpBitAttribute == null ? "" : tmpBitAttribute.getValue();

        final Attribute tmpValueAttribute = bmentryElement.getAttribute(Constants.XML_BMENTRY_VALUE);
        final String valueAttribute = tmpValueAttribute == null ? "" : tmpValueAttribute.getValue();
        if (!bitAttribute.isEmpty() && !valueAttribute.isEmpty()) {
            errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, bitmaskName + ": element contains both '" + Constants.XML_BMENTRY_BIT + "' and '" + Constants.XML_BMENTRY_VALUE + "' attributes");
            return;
        }

        final String name = bmentryElement.getAttribute(Constants.XML_BMENTRY_NAME).getValue();

        final int value;
        if (bitAttribute.isEmpty()) {
            if (!isNamed) {
                errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, bitmaskName + ": '" + Constants.XML_BMENTRY_VALUE + "' attribute allowed only in named bitmasks");
                return;
            }
            try {
                value = Integer.parseInt(valueAttribute);
            } catch (final NumberFormatException ignored) {
                errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, bitmaskName + ": invalid '" + Constants.XML_BMENTRY_VALUE + "' value: " + valueAttribute);
                return;
            }
        } else {
            final int bitValue;
            try {
                bitValue = Integer.parseInt(bitAttribute);
            } catch (final NumberFormatException ignored) {
                errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, bitmaskName + ": invalid '" + Constants.XML_BMENTRY_BIT + "' value: " + bitAttribute);
                return;
            }
            if (bitValue < 0 || bitValue >= 32) {
                errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, bitmaskName + ": invalid '" + Constants.XML_BMENTRY_BIT + "' value: " + bitValue);
                return;
            }
            if (!attributeBitmask.addBitName(bitValue, name)) {
                errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, bitmaskName + ": duplicate '" + Constants.XML_BMENTRY_BIT + "' value: " + bitValue);
                return;
            }
            value = 1 << bitValue;
        }

        attributeBitmask.addName(name, value);

        final Attribute tmpEncodingAttribute = bmentryElement.getAttribute(Constants.XML_BMENTRY_ENCODING);
        final String encoding = tmpEncodingAttribute == null ? "" : tmpEncodingAttribute.getValue();
        if (isNamed) {
            if (encoding.isEmpty()) {
                errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, bitmaskName + ": missing '" + Constants.XML_BMENTRY_ENCODING + "' attribute");
                return;
            }
            attributeBitmask.addNamedValue(encoding, value);
        } else {
            if (!encoding.isEmpty()) {
                errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, bitmaskName + ": unused '" + Constants.XML_BMENTRY_ENCODING + "' attribute");
                //noinspection UnnecessaryReturnStatement
                return;
            }
        }
    }

    private static void parseLists(@NotNull final ArchetypeTypeSet archetypeTypeSet, @NotNull final Element listsElement, @NotNull final ErrorViewCollector errorViewCollector) {
        for (final Element element : new ElementsIterable(listsElement.getChildElements(Constants.XML_ELEMENT_LIST))) {
            parseList(archetypeTypeSet, element, errorViewCollector);
        }
    }

    private static void parseList(@NotNull final ArchetypeTypeSet archetypeTypeSet, @NotNull final Element listElement, @NotNull final ErrorViewCollector errorViewCollector) {
        final ArchetypeTypeList list = new ArchetypeTypeList();
        for (final Element element : new ElementsIterable(listElement.getChildElements(Constants.XML_ELEMENT_LISTENTRY))) {
            parseListEntry(element, errorViewCollector, list);
        }
        final String name = listElement.getAttribute(Constants.XML_LIST_NAME).getValue();
        archetypeTypeSet.addList(name, list);
    }

    private static void parseListEntry(@NotNull final Element listentryElement, @NotNull final ErrorViewCollector errorViewCollector, @NotNull final ArchetypeTypeList list) {
        final String name = listentryElement.getAttribute(Constants.XML_LISTENTRY_NAME).getValue();
        final String valueString = listentryElement.getAttribute(Constants.XML_LISTENTRY_VALUE).getValue();
        final int value;
        try {
            value = Integer.valueOf(valueString);
        } catch (final NumberFormatException ignore) {
            errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, name + ": value '" + valueString + "' is not an integer.");
            return;
        }
        try {
            list.add(value, name);
        } catch (final IllegalArgumentException ex) {
            errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, ex.getMessage() + ".");
        }
    }

    @NotNull
    private static IgnorelistsDefinition parseIgnoreLists(@NotNull final Element ignorelistsElement, @NotNull final ErrorViewCollector errorViewCollector) {
        final IgnorelistsDefinition ignorelistsDefinition = new IgnorelistsDefinition();
        for (final Element element : new ElementsIterable(ignorelistsElement.getChildElements(Constants.XML_ELEMENT_IGNORE_LIST))) {
            parseIgnoreList(element, errorViewCollector, ignorelistsDefinition);
        }
        return ignorelistsDefinition;
    }

    private static void parseAttributeOrder(@NotNull final ArchetypeTypeSet archetypeTypeSet, @NotNull final Node attributeOrderElement, @NotNull final ErrorViewCollector errorViewCollector) {
        for (final String value : StringUtils.PATTERN_WHITESPACE_NEWLINE.split(attributeOrderElement.getValue())) {
            if (!value.isEmpty()) {
                if (archetypeTypeSet.addAttributeOrder(value)) {
                    errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, value + ": duplicate attribute name");
                }
            }
        }
    }

    private static void parseIgnoreList(@NotNull final Element ignoreListElement, @NotNull final ErrorViewCollector errorViewCollector, @NotNull final IgnorelistsDefinition ignorelistsDefinition) {
        final String name = ignoreListElement.getAttribute(Constants.XML_IGNORE_LIST_NAME).getValue();
        if (ignorelistsDefinition.containsKey(name)) {
            errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, name + ": duplicate name");
        }

        for (final Element attributeElement : new ElementsIterable(ignoreListElement.getChildElements(Constants.XML_ELEMENT_ATTRIBUTE))) {
            final Attribute archAttribute = attributeElement.getAttribute(Constants.XML_ATTRIBUTE_ARCH);
            if (archAttribute != null) {
                try {
                    ignorelistsDefinition.put(name, archAttribute.getValue());
                } catch (final IllegalArgumentException ex) {
                    errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, name + ": " + ex.getMessage() + ".");
                }
            } else {
                errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, name + ": attribute missing '" + Constants.XML_ATTRIBUTE_ARCH + "'.");
            }

            try {
                rejectAttributes(attributeElement, Constants.XML_ATTRIBUTE_TYPE, Constants.XML_ATTRIBUTE_ARCH_BEGIN, Constants.XML_ATTRIBUTE_ARCH_END, Constants.XML_ATTRIBUTE_EDITOR, Constants.XML_ATTRIBUTE_VALUE, Constants.XML_ATTRIBUTE_MIN, Constants.XML_ATTRIBUTE_MAX, Constants.XML_ATTRIBUTE_CHECK_MIN, Constants.XML_ATTRIBUTE_CHECK_MAX, Constants.XML_ATTRIBUTE_LENGTH, Constants.XML_ATTRIBUTE_TRUE, Constants.XML_ATTRIBUTE_FALSE, Constants.XML_ATTRIBUTE_MARKER);
            } catch (final SyntaxErrorException ex) {
                errorViewCollector.addWarning(ErrorViewCategory.TYPES_ENTRY_INVALID, name + ": " + ex.getMessage() + ".");
            }
        }
    }

    @NotNull
    private ArchetypeType parseDefaultType(@NotNull final ArchetypeTypeSet archetypeTypeSet, @NotNull final Element defaultTypeElement, @NotNull final ErrorViewCollector errorViewCollector, @NotNull final IgnorelistsDefinition ignorelistsDefinition) {
        return archetypeTypeParser.loadAttributeList(defaultTypeElement, errorViewCollector, null, archetypeTypeSet, ignorelistsDefinition, true);
    }

    private void parseTypes(@NotNull final ArchetypeTypeSet archetypeTypeSet, @NotNull final Element typeElement, @NotNull final ErrorViewCollector errorViewCollector, @NotNull final ArchetypeType defaultArchetypeType, @NotNull final IgnorelistsDefinition ignorelistsDefinition) {
        if (!typeElement.getAttribute(Constants.XML_TYPE_AVAILABLE).getValue().equals("no")) {
            archetypeTypeSet.addArchetypeType(archetypeTypeParser.loadAttributeList(typeElement, errorViewCollector, defaultArchetypeType, archetypeTypeSet, ignorelistsDefinition, false));
        }
    }

    private static void rejectAttributes(@NotNull final Element element, @NotNull final String... attributes) throws SyntaxErrorException {
        for (final String attribute : attributes) {
            if (element.getAttribute(attribute) != null) {
                throw new SyntaxErrorException("unexpected attribute '" + attribute + "'");
            }
        }
    }

}