Add CapsLock, NumLock and ScrollLock support for Events

include/SFML/Window/Event.hpp

@@ -100,6 +100,9 @@ public:
         bool               control{};    //!< Is the Control key pressed?
         bool               shift{};      //!< Is the Shift key pressed?
         bool               system{};     //!< Is the System key pressed?
+        bool               capsLock{};   //!< Is the CapsLock key toggled?
+        bool               numLock{};    //!< Is the NumLock key toggled? (Not supported on macOS)
+        bool               scrollLock{}; //!< Is the ScrollLock key toggled?
     };
 
     ////////////////////////////////////////////////////////////
@@ -114,6 +117,9 @@ public:
         bool               control{};    //!< Is the Control key pressed?
         bool               shift{};      //!< Is the Shift key pressed?
         bool               system{};     //!< Is the System key pressed?
+        bool               capsLock{};   //!< Is the CapsLock key toggled?
+        bool               numLock{};    //!< Is the NumLock key toggled? (Not supported on macOS)
+        bool               scrollLock{}; //!< Is the ScrollLock key toggled?
     };
 
     ////////////////////////////////////////////////////////////

src/SFML/Window/Android/WindowImplAndroid.cpp

@@ -419,6 +419,10 @@ int WindowImplAndroid::processKeyEvent(AInputEvent* inputEvent, ActivityStates&
         keyEvent.code       = androidKeyToSF(key);
         keyEvent.alt        = metakey & AMETA_ALT_ON;
         keyEvent.shift      = metakey & AMETA_SHIFT_ON;
+        keyEvent.system     = metakey & AMETA_SYM_ON;
+        keyEvent.capsLock   = metakey & AMETA_CAPS_LOCK_ON;
+        keyEvent.numLock    = metakey & AMETA_NUM_LOCK_ON;
+        keyEvent.scrollLock = metakey & AMETA_SCROLL_LOCK_ON;
         forwardEvent(keyEvent);
     };
 

src/SFML/Window/DRM/InputImpl.cpp

@@ -90,6 +90,18 @@ bool systemDown()
 {
     return keyMap[sf::Keyboard::Key::LSystem] || keyMap[sf::Keyboard::Key::RSystem];
 }
+bool capsLockDown()
+{
+    return false; // TODO: To be implemented, potentially with scancode support
+}
+bool numLockDown()
+{
+    return false; // TODO: To be implemented, potentially with scancode support
+}
+bool scrollLockDown()
+{
+    return false; // TODO: To be implemented, potentially with scancode support
+}
 
 void uninitFileDescriptors()
 {
@@ -413,6 +425,9 @@ std::optional<sf::Event> eventProcess()
                         keyEvent.control    = controlDown();
                         keyEvent.shift      = shiftDown();
                         keyEvent.system     = systemDown();
+                        keyEvent.capsLock   = capsLockDown();
+                        keyEvent.numLock    = numLockDown();
+                        keyEvent.scrollLock = scrollLockDown();
                         return keyEvent;
                     };
 

src/SFML/Window/Unix/WindowImplX11.cpp

@@ -1814,6 +1814,9 @@ bool WindowImplX11::processEvent(XEvent& windowEvent)
             event.control    = windowEvent.xkey.state & ControlMask;
             event.shift      = windowEvent.xkey.state & ShiftMask;
             event.system     = windowEvent.xkey.state & Mod4Mask;
+            event.capsLock   = windowEvent.xkey.state & LockMask;
+            event.numLock    = windowEvent.xkey.state & Mod2Mask;
+            event.scrollLock = windowEvent.xkey.state & Mod3Mask;
 
             const bool filtered = XFilterEvent(&windowEvent, None);
 
@@ -1895,6 +1898,9 @@ bool WindowImplX11::processEvent(XEvent& windowEvent)
             event.control    = windowEvent.xkey.state & ControlMask;
             event.shift      = windowEvent.xkey.state & ShiftMask;
             event.system     = windowEvent.xkey.state & Mod4Mask;
+            event.capsLock   = windowEvent.xkey.state & LockMask;
+            event.numLock    = windowEvent.xkey.state & Mod2Mask;
+            event.scrollLock = windowEvent.xkey.state & Mod3Mask;
             pushEvent(event);
 
             break;

src/SFML/Window/Win32/WindowImplWin32.cpp

@@ -886,10 +886,13 @@ void WindowImplWin32::processEvent(UINT message, WPARAM wParam, LPARAM lParam)
             if (m_keyRepeatEnabled || ((HIWORD(lParam) & KF_REPEAT) == 0))
             {
                 Event::KeyPressed event;
-                event.alt      = HIWORD(GetKeyState(VK_MENU)) != 0;
+                event.alt        = GetKeyState(VK_MENU) & 0x8000;
-                event.control  = HIWORD(GetKeyState(VK_CONTROL)) != 0;
+                event.control    = GetKeyState(VK_CONTROL) & 0x8000;
-                event.shift    = HIWORD(GetKeyState(VK_SHIFT)) != 0;
+                event.shift      = GetKeyState(VK_SHIFT) & 0x8000;
-                event.system   = HIWORD(GetKeyState(VK_LWIN)) || HIWORD(GetKeyState(VK_RWIN));
+                event.system     = GetKeyState(VK_LWIN) & 0x8000 || GetKeyState(VK_RWIN) & 0x8000;
+                event.capsLock   = GetKeyState(VK_CAPITAL) & 0x0001;
+                event.numLock    = GetKeyState(VK_NUMLOCK) & 0x0001;
+                event.scrollLock = GetKeyState(VK_SCROLL) & 0x0001;
                 event.code       = virtualKeyCodeToSF(wParam, lParam);
                 event.scancode   = toScancode(wParam, lParam);
                 pushEvent(event);
@@ -902,10 +905,13 @@ void WindowImplWin32::processEvent(UINT message, WPARAM wParam, LPARAM lParam)
         case WM_SYSKEYUP:
         {
             Event::KeyReleased event;
-            event.alt      = HIWORD(GetKeyState(VK_MENU)) != 0;
+            event.alt        = GetKeyState(VK_MENU) & 0x8000;
-            event.control  = HIWORD(GetKeyState(VK_CONTROL)) != 0;
+            event.control    = GetKeyState(VK_CONTROL) & 0x8000;
-            event.shift    = HIWORD(GetKeyState(VK_SHIFT)) != 0;
+            event.shift      = GetKeyState(VK_SHIFT) & 0x8000;
-            event.system   = HIWORD(GetKeyState(VK_LWIN)) || HIWORD(GetKeyState(VK_RWIN));
+            event.system     = GetKeyState(VK_LWIN) & 0x8000 || GetKeyState(VK_RWIN) & 0x8000;
+            event.capsLock   = GetKeyState(VK_CAPITAL) & 0x0001;
+            event.numLock    = GetKeyState(VK_NUMLOCK) & 0x0001;
+            event.scrollLock = GetKeyState(VK_SCROLL) & 0x0001;
             event.code       = virtualKeyCodeToSF(wParam, lParam);
             event.scancode   = toScancode(wParam, lParam);
             pushEvent(event);

src/SFML/Window/macOS/SFKeyboardModifiersHelper.mm

@@ -63,6 +63,7 @@ struct ModifiersState
     BOOL leftControlWasDown{};
     BOOL rightControlWasDown{};
     BOOL capsLockWasOn{};
+    BOOL numLockWasOn{};
 };
 
 
@@ -151,7 +152,8 @@ void initialiseKeyboardHelper()
     state.rightAlternateWasDown = isKeyMaskActive(modifiers, NSRightAlternateKeyMask);
     state.leftControlWasDown    = isKeyMaskActive(modifiers, NSLeftControlKeyMask);
     state.rightControlWasDown   = isKeyMaskActive(modifiers, NSRightControlKeyMask);
-    state.capsLockWasOn         = isKeyMaskActive(modifiers, NSEventModifierFlagCapsLock);
+    state.capsLockWasOn         = isKeyMaskActive(modifiers, NSAlphaShiftKeyMask);
+    state.numLockWasOn          = isKeyMaskActive(modifiers, NSNumericPadKeyMask);
 
     isStateInitialized = YES;
 }
@@ -167,6 +169,9 @@ sf::Event::KeyPressed keyPressedEventWithModifiers(NSUInteger modifiers, sf::Key
     event.control    = modifiers & NSControlKeyMask;
     event.shift      = modifiers & NSShiftKeyMask;
     event.system     = modifiers & NSCommandKeyMask;
+    event.capsLock   = modifiers & NSAlphaShiftKeyMask;
+    event.numLock    = modifiers & NSNumericPadKeyMask;
+    event.scrollLock = false; // Doesn't exist on macOS
     return event;
 }
 
@@ -181,6 +186,9 @@ sf::Event::KeyReleased keyReleasedEventWithModifiers(NSUInteger modifiers, sf::K
     event.control    = modifiers & NSControlKeyMask;
     event.shift      = modifiers & NSShiftKeyMask;
     event.system     = modifiers & NSCommandKeyMask;
+    event.capsLock   = modifiers & NSAlphaShiftKeyMask;
+    event.numLock    = modifiers & NSNumericPadKeyMask;
+    event.scrollLock = false; // Doesn't exist on macOS
     return event;
 }
 
@@ -243,4 +251,12 @@ void handleModifiersChanged(NSUInteger modifiers, sf::priv::WindowImplCocoa& req
                        sf::Keyboard::Key::Unknown,
                        sf::Keyboard::Scan::CapsLock,
                        requester);
+
+    // Handle num lock
+    processOneModifier(modifiers,
+                       NSEventModifierFlagNumericPad,
+                       state.numLockWasOn,
+                       sf::Keyboard::Key::Unknown,
+                       sf::Keyboard::Scan::NumLock,
+                       requester);
 }