xml_tag.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef QDENGINE_PARSER_XML_TAG_H
#define QDENGINE_PARSER_XML_TAG_H

#include "qdengine/qdengine.h"

namespace QDEngine {

namespace xml {

class tag {
public:
    typedef Std::list<tag> subtags_t;
    typedef subtags_t::const_iterator subtag_iterator;

    enum tag_data_format {
        TAG_DATA_VOID,
        TAG_DATA_SHORT,
        TAG_DATA_UNSIGNED_SHORT,
        TAG_DATA_INT,
        TAG_DATA_UNSIGNED_INT,
        TAG_DATA_FLOAT,
        TAG_DATA_STRING
    };

    tag(int id = 0, tag_data_format data_fmt = TAG_DATA_VOID, int data_sz = 0, int data_offs = 0) : _ID(id), _data_format(data_fmt), _data_size(data_sz), _data_offset(data_offs), _data(NULL) { }
    tag(const tag &tg) : _ID(tg._ID), _data_format(tg._data_format), _data_size(tg._data_size), _data_offset(tg._data_offset), _data(tg._data), _subtags(tg._subtags) { }
    ~tag() { }
    bool readTag(Common::SeekableReadStream *ff, tag &tg);

    tag &operator = (const tag &tg) {
        if (this == &tg) return *this;

        _ID = tg._ID;
        _data_format = tg._data_format;
        _data_size = tg._data_size;
        _data_offset = tg._data_offset;

        _subtags = tg._subtags;

        return *this;
    }

    int ID() const {
        return g_engine->_tagMap[_ID - 1];
    }

    int origID() const {
        return _ID;
    }

    tag_data_format data_format() const {
        return _data_format;
    }


    int data_size() const {
        return _data_size;
    }
    int data_element_size() const {
        switch (_data_format) {
        case TAG_DATA_VOID:
            return 0;
        case TAG_DATA_SHORT:
        case TAG_DATA_UNSIGNED_SHORT:
            return sizeof(uint16);
        case TAG_DATA_INT:
            return sizeof(int32);
        case TAG_DATA_UNSIGNED_INT:
            return sizeof(uint32);
        case TAG_DATA_FLOAT:
            return sizeof(float);
        case TAG_DATA_STRING:
            return sizeof(byte);
        }
        return 0;
    }

    void set_data_size(int sz) {
        _data_size = sz;
    }

    int data_offset() const {
        return _data_offset;
    }
    void set_data_offset(int off) {
        _data_offset = off;
    }

    const char *data() const {
        return &*(_data->begin() + _data_offset);
    }

    void set_data(const Std::vector<char> *p) {
        _data = p;

        for (subtags_t::iterator it = _subtags.begin(); it != _subtags.end(); ++it)
            it->set_data(p);
    }

    void clear() {
        _subtags.clear();
    }

    tag &add_subtag(const tag &tg) {
        _subtags.push_back(tg);
        return _subtags.back();
    }
    bool has_subtags() const {
        return !_subtags.empty();
    }
    int num_subtags() const {
        return _subtags.size();
    }
    subtag_iterator subtags_begin() const {
        return _subtags.begin();
    }
    subtag_iterator subtags_end() const {
        return _subtags.end();
    }
    const tag *search_subtag(int subtag_id) const {
        for (subtag_iterator it = subtags_begin(); it != subtags_end(); ++it)
            if (it->ID() == subtag_id) return &*it;

        return NULL;
    }

private:

    int _ID;
    tag_data_format _data_format;
    int _data_size;
    int _data_offset;
    const Std::vector<char> *_data;

    subtags_t _subtags;
};

} /* namespace xml */

} // namespace QDEngine

#endif // QDENGINE_PARSER_XML_TAG_H