BlockTypeRegistry.h

Go to the documentation of this file.

#pragma once
 
 
 
 
 
#include <map>
#include <functional>
 
 
 
 
 
// fwd:
class cBlockHandler;
class BlockState;
 
 
 
 
 
class BlockInfo
{
public:
 
    using HintCallback = std::function<AString(const AString & aTypeName, const BlockState & aBlockState)>;
 
 
    BlockInfo(
        const AString & aPluginName,
        const AString & aBlockTypeName,
        std::shared_ptr<cBlockHandler> aHandler,
        const std::map<AString, AString> & aHints = std::map<AString, AString>(),
        const std::map<AString, HintCallback> & aHintCallbacks = std::map<AString, HintCallback>()
    );
 
 
    AString hintValue(
        const AString & aHintName,
        const BlockState & aBlockState
    );
 
    // Simple getters:
    const AString & pluginName() const { return m_PluginName; }
    const AString & blockTypeName() const { return m_BlockTypeName; }
    std::shared_ptr<cBlockHandler> handler() const { return m_Handler; }
 
    void setHint(const AString & aHintKey, const AString & aHintValue);
 
    void removeHint(const AString & aHintKey);
 
 
private:
 
    AString m_PluginName;
 
    AString m_BlockTypeName;
 
    std::shared_ptr<cBlockHandler> m_Handler;
 
    std::map<AString, AString> m_Hints;
 
    std::map<AString, HintCallback> m_HintCallbacks;
};
 
 
 
 
 
class BlockTypeRegistry
{
public:
    // fwd:
    class AlreadyRegisteredException;
    class NotRegisteredException;
 
 
    BlockTypeRegistry() = default;
 
    void registerBlockType(
        const AString & aPluginName,
        const AString & aBlockTypeName,
        std::shared_ptr<cBlockHandler> aHandler,
        const std::map<AString, AString> & aHints = std::map<AString, AString>(),
        const std::map<AString, BlockInfo::HintCallback> & aHintCallbacks = std::map<AString, BlockInfo::HintCallback>()
    );
 
    std::shared_ptr<BlockInfo> blockInfo(const AString & aBlockTypeName);
 
    void removeAllByPlugin(const AString & aPluginName);
 
    void setBlockTypeHint(
        const AString & aBlockTypeName,
        const AString & aHintKey,
        const AString & aHintValue
    );
 
    void removeBlockTypeHint(
        const AString & aBlockTypeName,
        const AString & aHintKey
    );
 
 
private:
 
    std::map<AString, std::shared_ptr<BlockInfo>> m_Registry;
 
    cCriticalSection m_CSRegistry;
};
 
 
 
 
 
class BlockTypeRegistry::AlreadyRegisteredException: public std::runtime_error
{
    using Super = std::runtime_error;
 
public:
 
    AlreadyRegisteredException(
        const std::shared_ptr<BlockInfo> & aPreviousRegistration,
        const std::shared_ptr<BlockInfo> & aNewRegistration
    );
 
    // Simple getters:
    std::shared_ptr<BlockInfo> previousRegistration() const { return m_PreviousRegistration; }
    std::shared_ptr<BlockInfo> newRegistration()      const { return m_NewRegistration; }
 
 
private:
 
    std::shared_ptr<BlockInfo> m_PreviousRegistration;
    std::shared_ptr<BlockInfo> m_NewRegistration;
 
 
    static AString message(
        const std::shared_ptr<BlockInfo> & aPreviousRegistration,
        const std::shared_ptr<BlockInfo> & aNewRegistration
    );
};
 
 
 
 
 
class BlockTypeRegistry::NotRegisteredException: public std::runtime_error
{
    using Super = std::runtime_error;
 
public:
 
    NotRegisteredException(
        const AString & aBlockTypeName,
        const AString & aHintKey,
        const AString & aHintValue
    );
 
    // Simple getters:
    const AString & blockTypeName() const { return m_BlockTypeName; }
 
 
private:
 
    const AString m_BlockTypeName;
};