qd_named_object_reference.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_QDCORE_QD_NAMED_OBJECT_REFERENCE_H
#define QDENGINE_QDCORE_QD_NAMED_OBJECT_REFERENCE_H

#include "qdengine/qd_fwd.h"
#include "qdengine/parser/xml_fwd.h"
#include "qdengine/qdcore/qd_named_object.h"

namespace Common {
class WriteStream;
}

namespace QDEngine {

class qdNamedObjectReference {
public:
    qdNamedObjectReference();
    explicit qdNamedObjectReference(const qdNamedObject *p);
    qdNamedObjectReference(int levels, const int *types, const char *const *names);
    qdNamedObjectReference(const qdNamedObjectReference &ref);
    ~qdNamedObjectReference();

    qdNamedObjectReference &operator = (const qdNamedObjectReference &ref);

    int num_levels()            const {
        return _object_types.size();
    }
    int object_type(int level = 0)      const {
        return _object_types[level];
    }
    const char *object_name(int level = 0)  const {
        return _object_names[level].c_str();
    }
    bool is_empty()             const {
        return _object_types.empty();
    }

    bool init(const qdNamedObject *p);

    void clear() {
        _object_types.clear();
        _object_names.clear();
    }

    void load_script(const xml::tag *p);
    bool save_script(Common::WriteStream &fh, int indent = 0) const;

    bool load_data(Common::SeekableReadStream &fh, int save_version);
    bool save_data(Common::WriteStream &fh) const;

    qdNamedObject *object() const;

    Common::String toString() const;

private:

    Std::vector<int> _object_types;
    Std::vector<Common::String> _object_names;
    static int _objects_counter;
};

} // namespace QDEngine

#endif // QDENGINE_QDCORE_QD_NAMED_OBJECT_REFERENCE_H