command_registry.hpp

Go to the documentation of this file.

#pragma once

 
#include <pulp/view/input_events.hpp>
 
#include <cstdint>
#include <functional>
#include <optional>
#include <string>
#include <string_view>
#include <unordered_map>
#include <vector>
 
namespace pulp::state { class PropertiesFile; }
 
namespace pulp::view {
 
class View;

using CommandID = std::uint32_t;
 
inline constexpr CommandID kInvalidCommandID = 0;

inline constexpr KeyCode kKeyComma = static_cast<KeyCode>(',');

inline constexpr CommandID kCommandOpenSettings = 0x504C5354;  // 'PLST'

#ifdef __APPLE__
inline constexpr std::uint16_t kOpenSettingsModifiers = kModCmd;
#else
inline constexpr std::uint16_t kOpenSettingsModifiers = kModCtrl;
#endif

struct CommandInfo {
    CommandID id = kInvalidCommandID;
    std::string name;          
    std::string category;      
    KeyCode default_key = KeyCode::unknown;
    std::uint16_t default_modifiers = 0;
    bool enabled = true;       
};

inline CommandInfo make_open_settings_command_info() {
    CommandInfo info;
    info.id = kCommandOpenSettings;
    info.name = "Settings…";
    info.category = "App";
    info.default_key = kKeyComma;
    info.default_modifiers = kOpenSettingsModifiers;
    return info;
}

class CommandHandler {
public:
    virtual ~CommandHandler() = default;

    virtual std::vector<CommandID> commands() const = 0;

    virtual bool perform_command(CommandID id) = 0;
};

class ShortcutMap {
public:
    void bind(KeyCode key, std::uint16_t modifiers, CommandID id);

    void unbind(KeyCode key, std::uint16_t modifiers);

    void unbind_command(CommandID id);

    CommandID find(KeyCode key, std::uint16_t modifiers) const;

    struct Chord {
        KeyCode key = KeyCode::unknown;
        std::uint16_t modifiers = 0;
    };
    std::vector<Chord> chords_for(CommandID id) const;

    std::size_t size() const { return bindings_.size(); }

    void clear() { bindings_.clear(); }

    void save_to(pulp::state::PropertiesFile& props,
                 std::string_view key_prefix = "shortcuts") const;
    bool load_from(const pulp::state::PropertiesFile& props,
                   std::string_view key_prefix = "shortcuts");
 
private:
    // Composite key: key code in low 32 bits, modifiers in high 16 bits.
    using ChordKey = std::uint64_t;
    static ChordKey make_key(KeyCode k, std::uint16_t m) {
        return (static_cast<ChordKey>(m) << 32) |
               static_cast<ChordKey>(static_cast<std::uint32_t>(k));
    }
    std::unordered_map<ChordKey, CommandID> bindings_;
};

class CommandRegistry {
public:
    CommandRegistry() = default;
    ~CommandRegistry() = default;
 
    // Non-copyable, non-movable — handlers register by raw pointer.
    CommandRegistry(const CommandRegistry&) = delete;
    CommandRegistry& operator=(const CommandRegistry&) = delete;
 
    // ── Command metadata ────────────────────────────────────────────

    void register_command(const CommandInfo& info);

    std::optional<CommandInfo> command_info(CommandID id) const;

    const std::vector<CommandInfo>& commands() const { return commands_; }

    void set_enabled(CommandID id, bool enabled);
 
    // ── Handler chain ───────────────────────────────────────────────

    void add_handler(CommandHandler* handler);

    void remove_handler(CommandHandler* handler);

    std::size_t handler_count() const { return handlers_.size(); }
 
    // ── Dispatch ────────────────────────────────────────────────────

    bool dispatch(CommandID id);

    bool dispatch_key_event(const KeyEvent& event);
 
    // ── ShortcutMap access ──────────────────────────────────────────
 
    ShortcutMap& shortcuts() { return shortcuts_; }
    const ShortcutMap& shortcuts() const { return shortcuts_; }
 
private:
    std::vector<CommandInfo> commands_;
    std::unordered_map<CommandID, std::size_t> command_index_;
    std::vector<CommandHandler*> handlers_;
    ShortcutMap shortcuts_;
};

void route_global_keys(View& root, CommandRegistry& registry);
 
} // namespace pulp::view