cyphesis/server/Ruleset.h

// Cyphesis Online RPG Server and AI Engine
// Copyright (C) 2009 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 SERVER_RULESET_H
#define SERVER_RULESET_H

#include "common/TypeNode.h"
#include "common/Singleton.h"

#include <Atlas/Objects/Root.h>
#include <Atlas/Objects/SmartPtr.h>

#include <boost/filesystem/path.hpp>

#include <memory>
#include <boost/asio/io_service.hpp>

class EntityBuilder;
class EntityKit;
class RuleHandler;
class EntityRuleHandler;
class TaskRuleHandler;
class OpRuleHandler;
class PropertyRuleHandler;
class ArchetypeRuleHandler;
class TaskKit;

/// \brief Class to handle rules that cannot yet be installed, and the reason
class RuleWaiting {
  public:
    /// Name of the rule.
    std::string name;
    /// Complete description of the rule.
    Atlas::Objects::Root desc;
    /// Message giving a description of why this rule has not been installed.
    std::string reason;
};

typedef std::multimap<std::string, RuleWaiting> RuleWaitList;

/// \brief Builder to handle the creation of all entities for the world.
///
/// Uses PersistantThingFactory to store information about entity types, and
/// create them. Handles connecting entities to their persistor as required.
class Ruleset : public Singleton<Ruleset>{
  protected:
    std::unique_ptr<TaskRuleHandler>m_taskHandler;
    std::unique_ptr<EntityRuleHandler> m_entityHandler;
    std::unique_ptr<OpRuleHandler> m_opHandler;
    std::unique_ptr<PropertyRuleHandler> m_propertyHandler;
    std::unique_ptr<ArchetypeRuleHandler> m_archetypeHandler;

    RuleWaitList m_waitingRules;

    std::set<boost::filesystem::path> m_changedRules;

    boost::asio::io_service& m_io_service;

    void installItem(const std::string & class_name,
                     const Atlas::Objects::Root & class_desc,
                     std::map<const TypeNode*, TypeNode::PropertiesUpdate>& changes);
    int installRuleInner(const std::string & class_name,
                         const Atlas::Objects::Root & class_desc,
                         std::string & dependent,
                         std::string & reason,
                         std::map<const TypeNode*, TypeNode::PropertiesUpdate>& changes);
    int modifyRuleInner(const std::string &class_name,
                        const Atlas::Objects::Root &class_desc,
                        std::map<const TypeNode *, TypeNode::PropertiesUpdate> &changes);

    void getRulesFromFiles(const std::string &,
                           std::map<std::string, Atlas::Objects::Root> &);
    void waitForRule(const std::string & class_name,
                     const Atlas::Objects::Root & class_desc,
                     const std::string & dependent,
                     const std::string & reason);

    void processChangedRules();
  public:
    explicit Ruleset(EntityBuilder * eb, boost::asio::io_service& io_service);
    ~Ruleset();

    void loadRules(const std::string &);

    int installRule(const std::string & class_name,
                    const std::string & section,
                    const Atlas::Objects::Root & class_desc);
    int modifyRule(const std::string & class_name,
                   const Atlas::Objects::Root & class_desc);

    friend class Rulesetintegration;

};

#endif // SERVER_RULESET_H