/*
 * object.h
 * Copyright 2010, Thorbjørn Lindeijer <thorbjorn@lindeijer.nl>
 *
 * This file is part of libtiled.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *    1. Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 *
 *    2. Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
 * EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#pragma once

#include "properties.h"
#include "propertytype.h"

#include <QPointer>

namespace Tiled {

/**
 * The base class for anything that can hold properties.
 */
class TILEDSHARED_EXPORT Object
{
public:
    // Keep values synchronized with ClassPropertyType::ClassUsageFlag
    enum TypeId {
        LayerType           = 0x002,
        MapObjectType       = 0x004,
        MapType             = 0x008,
        TilesetType         = 0x010,
        TileType            = 0x020,
        WangSetType         = 0x040,
        WangColorType       = 0x080,
        ProjectType         = 0x100,
        WorldType           = 0x200,
    };

    explicit Object(TypeId typeId, const QString &className = QString())
        : mTypeId(typeId)
        , mClassName(className)
    {}

    /**
     * Virtual destructor.
     */
    virtual ~Object();

    /**
     * Returns the type of this object.
     */
    TypeId typeId() const { return mTypeId; }

    const QString &className() const;
    void setClassName(const QString &className);

    const ClassPropertyType *classType() const;

    /**
     * Returns the properties of this object.
     */
    const Properties &properties() const { return mProperties; }

    /**
     * Returns the properties of this object.
     */
    Properties &properties() { return mProperties; }

    /**
     * Replaces all existing properties with a new set of properties.
     */
    void setProperties(const Properties &properties)
    { mProperties = properties; }

    /**
     * Clears all existing properties
     */
    void clearProperties ()
    { mProperties.clear(); }

    /**
     * Merges \a properties with the existing properties. Properties with the
     * same name will be overridden.
     *
     * \sa Tiled::mergeProperties
     */
    void mergeProperties(const Properties &properties)
    { Tiled::mergeProperties(mProperties, properties); }

    /**
     * Returns the value of the object's \a name property.
     */
    QVariant property(const QString &name) const
    { return mProperties.value(name); }

    QVariant resolvedProperty(const QString &name) const;
    QVariantMap resolvedProperties() const;
    QVariantMap inheritedProperties() const;

    /**
     * Returns the value of the object's \a name property, as a string.
     *
     * This is a workaround for the Python plugin, because I do not know how
     * to pass a QVariant back to Python.
     */
    QString propertyAsString(const QString &name) const
    { return mProperties.value(name).toString(); }

    /**
     * Returns the type of the object's \a name property, as a string.
     *
     * This function exists only for the Python plugin.
     */
    QString propertyType(const QString &name) const
    { return typeName(mProperties.value(name)); }

    /**
     * Returns whether this object has a property with the given \a name.
     */
    bool hasProperty(const QString &name) const
    { return mProperties.contains(name); }

    /**
     * Sets the value of the object's \a name property to \a value.
     */
    void setProperty(const QString &name, const QVariant &value)
    { mProperties.insert(name, value); }

    /**
     * Sets the value of an object's property identified the given \a path
     * to \a value.
     *
     * The \a path is a list of property names, where each name identifies
     * a member of the previous member's value. The last name in the list
     * identifies the property to set.
     *
     * Returns whether the property was set.
     */
    bool setProperty(const PropertyPath &path, const QVariant &value);

    /**
     * Removes the property with the given \a name.
     */
    void removeProperty(const QString &name)
    { mProperties.remove(name); }

    bool isPartOfTileset() const;

    static void setPropertyTypes(const SharedPropertyTypes &propertyTypes);
    static const PropertyTypes &propertyTypes();

private:
    const TypeId mTypeId;
    QString mClassName;
    Properties mProperties;

    /**
     * The editable wrapper created for this object.
     */
    QPointer<QObject> mEditable;
    friend class EditableObject;

    static SharedPropertyTypes mPropertyTypes;
};


/**
 * Returns the class of this object. The class usually says something about
 * how the object is meant to be interpreted by the engine.
 *
 * Tile objects that do not have a class explicitly set on them are assumed to
 * be of the class set on their tile (see MapObject::effectiveClassName).
 */
inline const QString &Object::className() const
{ return mClassName; }

/**
 * Sets the class of this object.
 */
inline void Object::setClassName(const QString &className)
{ mClassName = className; }

/**
 * Returns whether this object is stored as part of a tileset.
 */
inline bool Object::isPartOfTileset() const
{
    switch (mTypeId) {
    case Object::TilesetType:
    case Object::TileType:
    case Object::WangSetType:
    case Object::WangColorType:
        return true;
    default:
        return false;
    }
}

} // namespace Tiled
