MRShortcutManager.h

Go to the documentation of this file.

#pragma once
#include "MRShortcutKey.h"
#include "MRMesh/MRphmap.h"
#include "MRViewer/MRViewerEventsListener.h"
#include <string>
#include <string_view>
#include <functional>
#include <optional>
 
namespace MR
{
 

class MRVIEWER_CLASS ShortcutManager : public MultiListener<KeyDownListener, KeyRepeatListener>
{
public:
    virtual ~ShortcutManager() = default;
 
    using ShortcutKey = MR::ShortcutKey;
    using Category = MR::ShortcutCategory;

    struct ShortcutAction
    {
        std::string name; 
        std::function<void()> func;
        bool repeatable = true; 
    };

    struct ShortcutCommand
    {
        Category category;
        std::string name; 
        std::function<void()> action;
        bool repeatable = true; 
    };
 
    inline static const std::string categoryNames[6] = { "Info", "Edit", "View", "Scene", "Objects", "Selection " };

    MRVIEWER_API virtual void setShortcut( const Shortcut& shortcut, const ShortcutAction& action );

    MRVIEWER_API void resetShortcut( const std::string& name );

    [[deprecated( "use setShortcut( Shortcut, ShortcutAction )" )]]
    void setShortcut( const ShortcutKey& key, const ShortcutCommand& command )
        { setShortcut( { key, command.category }, { command.name, command.action, command.repeatable } ); }

    using ShortcutList = std::vector<std::pair<Shortcut, std::string>>;

    MRVIEWER_API const ShortcutList& getShortcutList() const;
 
    enum class Reason 
    {
        KeyDown,  
        KeyRepeat 
    };
    
    bool isEnabled() const { return enabled_; }
    void enable( bool on ) { enabled_ = on; }

    MRVIEWER_API virtual bool processShortcut( const ShortcutKey& key, Reason = Reason::KeyDown ) const;
 
    MRVIEWER_API bool onKeyDown_( int key, int modifier ) override;
    MRVIEWER_API bool onKeyRepeat_( int key, int modifier ) override;

    MRVIEWER_API static const char* getModifierString( int mod );
    MRVIEWER_API static std::string getKeyString( int key );
    MRVIEWER_API static std::string getKeyFullString( const ShortcutKey& key, bool respectKey = true );
    MRVIEWER_API static std::string getKeysFullString( const std::vector<ShortcutKey>& keys );

    MRVIEWER_API static std::optional<int> parseKey( std::string_view name );

    MRVIEWER_API static std::optional<int> parseModifier( std::string_view name );

    MRVIEWER_API static std::optional<Category> parseCategory( std::string_view name );

    MRVIEWER_API static std::optional<ShortcutKey> parseShortcutKey( std::string_view keys );

    MRVIEWER_API std::optional<ShortcutKey> findShortcutByName( const std::string& name ) const;

    MRVIEWER_API std::vector<ShortcutKey> findShortcutsByName( const std::string& name ) const;

    MRVIEWER_API void clear();
protected:
    MRVIEWER_API static int mapKeyFromKeyAndMod( const ShortcutKey& key, bool respectKeyboard );
    static ShortcutKey kayAndModFromMapKey( int mapKey )
        { return { ( mapKey >> cModBits ) % ( 1 << cKeyBits ), mapKey % ( 1 << cModBits ), mapKey >> ( cModBits + cKeyBits ) }; }

    static constexpr int cModBits = 6;
    static constexpr int cKeyBits = 9;

    int findHeldKey_( int key, int mod ) const;
 
    using ShourtcutsMap = HashMap<int, ShortcutCommand>;
    using ShourtcutsBackMap = HashMap<std::string, std::vector<int>>; 
 
    bool enabled_{ true };
 
    ShourtcutsMap map_;
    ShourtcutsBackMap backMap_;
 
    mutable std::optional<ShortcutList> listCache_;
};
 
}