// Cyphesis Online RPG Server and AI Engine
// Copyright (C) 2006 Alistair Riddoch
//
// 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


#ifndef RULESETS_OUTFIT_PROPERTY_H
#define RULESETS_OUTFIT_PROPERTY_H

#include "common/Property.h"

#include "modules/EntityRef.h"

#include <sigc++/trackable.h>
#include <sigc++/connection.h>

typedef std::map<std::string, EntityRef> EntityRefMap;

/// \brief Class to handle Character outfit property
///
/// OUTFIT is the property used to describe how entities in the CONTAINS
/// list of the entity are attached to it. Primarily intended for describing
/// the clothes and equipment attached to a Character, it could be potentially
/// used for all sorts of things.
/// \ingroup PropertyClasses
class OutfitProperty : public PropertyBase, virtual public sigc::trackable {
  protected:
    EntityRefMap m_data;

    /**
     * \brief A struct used for keeping track of sigc connections.
     * So that they can be properly removed when an item id removed.
     */
    struct ConnectionsWrapper {
            sigc::connection containered;
            sigc::connection destroyed;
    };
    /**
     * \brief Keeps track of sigc connections.
     * When an item is removed, the connections will be severed.
     */
    std::map<LocatedEntity*, ConnectionsWrapper> m_connections;

    void itemRemoved(LocatedEntity * garment, LocatedEntity * wearer);
  public:
    static constexpr const char* property_name = "outfit";
    static constexpr const char* property_atlastype = "map";

    explicit OutfitProperty() = default;
    ~OutfitProperty() override = default;

    int get(Atlas::Message::Element & val) const override;
    void set(const Atlas::Message::Element & val) override;
    void add(const std::string & key, Atlas::Message::MapType & map) const override;
    void add(const std::string & key, const Atlas::Objects::Entity::RootEntity & ent) const override;
    OutfitProperty * copy() const override;

    //\brief Get a pointer to the entity at a given key of outfit
    //null pointer is returned if there is no entity at a given key
    LocatedEntity* getEntity(const std::string& key) const;
    void cleanUp();
    void wear(LocatedEntity * wearer, const std::string & location, LocatedEntity * garment);

    /**
     * \brief Gets a map of all outfitted entities.
     * @return A map of the outfitted entities.
     */
    const EntityRefMap& data() const;
};

#endif // RULESETS_OUTFIT_PROPERTY_H