[SUTK] Added support for modifiers in on keyboard event

ravi688 · Aug 9, 2024 · fdba7bc · fdba7bc
1 parent dbdb0cc
commit fdba7bc
Show file tree

Hide file tree

Showing 6 changed files with 106 additions and 6 deletions.
diff --git a/dependencies/Common b/dependencies/Common
diff --git a/sutk/include/sutk/IInputDriver.hpp b/sutk/include/sutk/IInputDriver.hpp
@@ -7,6 +7,33 @@
 
 namespace SUTK
 {
+	enum class ModifierKeyBits : u32
+	{
+		ShiftBit = BIT32(0),
+		CtrlBit = BIT32(1),
+		AltBit = BIT32(2),
+		WinBit = BIT32(3),
+		CapsLockBit = BIT32(4),
+		NumLockBit = BIT32(5)
+	};
+
+	struct ModifierKeys
+	{
+		ModifierKeyBits bits;
+
+		constexpr ModifierKeys(ModifierKeyBits _bits) noexcept : bits(_bits) { }
+
+		bool shift() const noexcept { return HAS_FLAG(bits, ModifierKeyBits::ShiftBit); }
+		bool ctrl() const noexcept { return HAS_FLAG(bits, ModifierKeyBits::CtrlBit); }
+		bool alt() const noexcept { return HAS_FLAG(bits, ModifierKeyBits::AltBit); }
+		bool win() const noexcept { return HAS_FLAG(bits, ModifierKeyBits::WinBit); }
+		bool capsLock() const noexcept { return HAS_FLAG(bits, ModifierKeyBits::CapsLockBit); }
+		bool numLock() const noexcept { return HAS_FLAG(bits, ModifierKeyBits::NumLockBit); }
+	};
+
+	std::ostream& operator <<(std::ostream& stream, ModifierKeys v);
+	std::ostream&& operator <<(std::ostream&& stream, ModifierKeys v);
+
 	enum class KeyCode
 	{
 		Undefined,
@@ -181,7 +208,7 @@ namespace SUTK
 		typedef com::Event<IInputDriver, Vec2Df> OnMouseMoveEvent;
 		typedef com::Event<IInputDriver, MouseButton, KeyEvent> OnMouseButtonEvent;
 		typedef com::Event<IInputDriver, Vec2Df> OnMouseScrollEvent;
-		typedef com::Event<IInputDriver, KeyCode, KeyEvent> OnKeyboardEvent;
+		typedef com::Event<IInputDriver, KeyCode, KeyEvent, ModifierKeys> OnKeyboardEvent;
 		typedef com::Event<IInputDriver, bool> OnMouseEnterExitEvent;
 	private:
 		OnMouseMoveEvent m_onCursorMoveEvent;

diff --git a/sutk/include/sutk/InputEventHandlerObject.hpp b/sutk/include/sutk/InputEventHandlerObject.hpp
@@ -132,7 +132,7 @@ namespace SUTK
 	class KeyboardHandlerObject : public TInputEventHandlerObject<IInputDriver::OnKeyboardEvent>
 	{
 	protected:
-		virtual void onKey(KeyCode keycode, KeyEvent action) = 0;
+		virtual void onKey(KeyCode keycode, KeyEvent action, ModifierKeys modifiers) = 0;
 
 		KeyboardHandlerObject(UIDriver& driver) noexcept;
 

diff --git a/sutk/source/IInputDriver.cpp b/sutk/source/IInputDriver.cpp
@@ -2,6 +2,61 @@
 
 namespace SUTK
 {
+
+	std::ostream&& operator <<(std::ostream&& stream, ModifierKeys v)
+	{
+		auto& _stream = operator <<(stream, v);
+		return std::move(_stream);		
+	}
+
+	std::ostream& operator <<(std::ostream& stream, ModifierKeys v)
+	{
+		bool isPrev = false;
+		if(v.shift())
+		{
+			stream << "Shift";
+			isPrev = true;
+		}
+		if(v.ctrl())
+		{
+			if(isPrev)
+				stream << " | ";
+			stream <<  "Ctrl";
+			isPrev = true;
+		}
+		if(v.alt())
+		{
+			if(isPrev)
+				stream << " | ";
+			stream <<  "Atl";
+			isPrev = true;
+		}
+		if(v.win())
+		{
+			if(isPrev)
+				stream << " | ";
+			stream <<  "Win";
+			isPrev = true;
+		}
+		if(v.capsLock())
+		{
+			if(isPrev)
+				stream << " | ";
+			stream <<  "CapsLock";
+			isPrev = true;
+		}
+		if(v.numLock())
+		{
+			if(isPrev)
+				stream << " | ";
+			stream <<  "NumLock";
+			isPrev = true;
+		}
+		if(!isPrev)
+			stream << "<No Modifiers>";
+		return stream;
+	}
+
 	std::ostream&& operator <<(std::ostream&& stream, KeyCode v)
 	{
 		auto& _stream = operator <<(stream, v);

diff --git a/sutk/source/InputEventHandlerObject.cpp b/sutk/source/InputEventHandlerObject.cpp
@@ -69,9 +69,9 @@ namespace SUTK
 
 	KeyboardHandlerObject::KeyboardHandlerObject(UIDriver& driver) noexcept : TInputEventHandlerObject<IInputDriver::OnKeyboardEvent>(driver.getInputDriver().getOnKeyEvent())
 	{
-		IInputDriver::OnKeyboardEvent::SubscriptionID id = getEvent().subscribe([this](IInputDriver* inputDriver, KeyCode keycode, KeyEvent action)
+		IInputDriver::OnKeyboardEvent::SubscriptionID id = getEvent().subscribe([this](IInputDriver* inputDriver, KeyCode keycode, KeyEvent action, ModifierKeys modifiers)
 		{
-			onKey(keycode, action);
+			onKey(keycode, action, modifiers);
 		});
 		setSubscriptionID(id);
 	}	

diff --git a/sutk/source/SGEInputDriver.cpp b/sutk/source/SGEInputDriver.cpp
@@ -26,6 +26,24 @@ namespace SUTK
 		}
 	}
 
+	static ModifierKeys getModifierKeys(modifier_key_bits_t bits)
+	{
+		ModifierKeyBits _bits = com::ForceIntToEnumClass<ModifierKeyBits>(0);
+		if(HAS_FLAG(bits, MODIFIER_KEY_SHIFT_BIT))
+			_bits |= ModifierKeyBits::ShiftBit;;
+		if(HAS_FLAG(bits, MODIFIER_KEY_CONTROL_BIT))
+			_bits |= ModifierKeyBits::CtrlBit;
+		if(HAS_FLAG(bits, MODIFIER_KEY_ALT_BIT))
+			_bits |= ModifierKeyBits::AltBit;
+		if(HAS_FLAG(bits, MODIFIER_KEY_WINDOWS_BIT))
+			_bits |= ModifierKeyBits::WinBit;
+		if(HAS_FLAG(bits, MODIFIER_KEY_CAPSLOCK_BIT))
+			_bits |= ModifierKeyBits::CapsLockBit;
+		if(HAS_FLAG(bits, MODIFIER_KEY_NUMLOCK_BIT))
+			_bits |= ModifierKeyBits::NumLockBit;
+		return { _bits };
+	}
+
 	static KeyCode getKeyCode(key_code_t keycode)
 	{
 		switch(keycode)
@@ -210,7 +228,7 @@ namespace SUTK
 			auto* inputDriver = reinterpret_cast<SGEInputDriver*>(handlerData);
 			auto data = reinterpret_cast<event_publisher_arg_data_t*>(publisherData);
 			auto keyData = reinterpret_cast<key_event_data_t*>(data->arg);
-			inputDriver->getOnKeyEvent().publish(getKeyCode(keyData->keycode), SUTK::getKeyEventType(keyData->event_type));
+			inputDriver->getOnKeyEvent().publish(getKeyCode(keyData->keycode), SUTK::getKeyEventType(keyData->event_type), getModifierKeys(keyData->modifiers));
 		}, reinterpret_cast<void*>(this));
 	}