shortcut.hpp

// SPDX-License-Identifier: LGPL-2.1-or-later OR BSD-3-Clause
// SPDX-FileCopyrightText: 2026 Fifengine contributors
 
#ifndef INCLUDE_FIFECHAN_SHORTCUT_HPP_
#define INCLUDE_FIFECHAN_SHORTCUT_HPP_
 
// Standard library includes
#include <cstdint>
#include <string>
 
// Platform config include
#include "fifechan/platform.hpp"
 
// Project headers (subdirs before local)
#include "fifechan/key.hpp"
 
namespace fcn
{
    class KeyEvent;

    class FIFEGUI_API Shortcut
    {
        public:
            enum Modifier : uint16_t
            {
                None    = 0,
                Shift   = 1 << 0,
                Control = 1 << 1,
                Alt     = 1 << 2,
                Meta    = 1 << 3
            };

            Shortcut() = default;

            explicit Shortcut(Key key, uint16_t modMask = Modifier::None);

            static Shortcut fromKeycode(uint32_t keycode, uint16_t sdlMods = 0);

            bool matches(KeyEvent const & event) const;

            bool conflicts(Shortcut const & other) const;

            std::string to_string() const;

            Key getKey() const;

            uint16_t getModMask() const;

            bool operator==(Shortcut const & other) const;

            bool operator!=(Shortcut const & other) const;
 
        protected:
            Key mKey;

            uint16_t mModMask{Modifier::None};
    };
} // namespace fcn
 
#endif // INCLUDE_FIFECHAN_SHORTCUT_HPP_