o3de/Gems/BarrierInput/Code/Source/BarrierInputKeyboard.h

/*
 * Copyright (c) Contributors to the Open 3D Engine Project.
 * For complete copyright and license terms please see the LICENSE at the root of this distribution.
 * 
 * SPDX-License-Identifier: Apache-2.0 OR MIT
 *
 */

#pragma once

#include <BarrierInput/RawInputNotificationBus_Barrier.h>

#include <AzFramework/Input/Devices/Keyboard/InputDeviceKeyboard.h>

#include <AzCore/std/parallel/mutex.h>

////////////////////////////////////////////////////////////////////////////////////////////////////
namespace BarrierInput
{
    ////////////////////////////////////////////////////////////////////////////////////////////////
    //! Barrier specific implementation for keyboard input devices.
    class InputDeviceKeyboardBarrier : public AzFramework::InputDeviceKeyboard::Implementation
                                     , public RawInputNotificationBusBarrier::Handler
    {
    public:
        ////////////////////////////////////////////////////////////////////////////////////////////
        // Allocator
        AZ_CLASS_ALLOCATOR(InputDeviceKeyboardBarrier, AZ::SystemAllocator);

        ////////////////////////////////////////////////////////////////////////////////////////////
        //! Custom factory create function
        //! \param[in] inputDevice Reference to the input device being implemented
        static Implementation* Create(AzFramework::InputDeviceKeyboard& inputDevice);

        ////////////////////////////////////////////////////////////////////////////////////////////
        //! Constructor
        //! \param[in] inputDevice Reference to the input device being implemented
        InputDeviceKeyboardBarrier(AzFramework::InputDeviceKeyboard& inputDevice);

        ////////////////////////////////////////////////////////////////////////////////////////////
        //! Destructor
        ~InputDeviceKeyboardBarrier() override;

    private:
        ////////////////////////////////////////////////////////////////////////////////////////////
        //! \ref AzFramework::InputDeviceKeyboard::Implementation::IsConnected
        bool IsConnected() const override;

        ////////////////////////////////////////////////////////////////////////////////////////////
        //! \ref AzFramework::InputDeviceKeyboard::Implementation::HasTextEntryStarted
        bool HasTextEntryStarted() const override;

        ////////////////////////////////////////////////////////////////////////////////////////////
        //! \ref AzFramework::InputDeviceKeyboard::Implementation::TextEntryStart
        void TextEntryStart(const AzFramework::InputTextEntryRequests::VirtualKeyboardOptions& options) override;

        ////////////////////////////////////////////////////////////////////////////////////////////
        //! \ref AzFramework::InputDeviceKeyboard::Implementation::TextEntryStop
        void TextEntryStop() override;

        ////////////////////////////////////////////////////////////////////////////////////////////
        //! \ref AzFramework::InputDeviceKeyboard::Implementation::TickInputDevice
        void TickInputDevice() override;

        ////////////////////////////////////////////////////////////////////////////////////////////
        //! \ref RawInputNotificationsBarrier::OnRawKeyboardKeyDownEvent
        void OnRawKeyboardKeyDownEvent(uint32_t scanCode, ModifierMask activeModifiers) override;

        ////////////////////////////////////////////////////////////////////////////////////////////
        //! \ref RawInputNotificationsBarrier::OnRawKeyboardKeyUpEvent
        void OnRawKeyboardKeyUpEvent(uint32_t scanCode, ModifierMask activeModifiers) override;

        ////////////////////////////////////////////////////////////////////////////////////////////
        //! \ref RawInputNotificationsBarrier::OnRawKeyboardKeyRepeatEvent
        void OnRawKeyboardKeyRepeatEvent(uint32_t scanCode, ModifierMask activeModifiers) override;

        ////////////////////////////////////////////////////////////////////////////////////////////
        //! Thread safe method to queue raw key events to be processed in the main thread update
        //! \param[in] scanCode The scan code of the key
        //! \param[in] rawKeyState The raw key state
        void ThreadSafeQueueRawKeyEvent(uint32_t scanCode, bool rawKeyState);

        ////////////////////////////////////////////////////////////////////////////////////////////
        //! Thread safe method to queue raw text events to be processed in the main thread update
        //! \param[in] textUTF8 The text to queue (encoded using UTF-8)
        void ThreadSafeQueueRawTextEvent(const AZStd::string& textUTF8);

        ////////////////////////////////////////////////////////////////////////////////////////////
        //! Translate a key event to an ASCII character. This is required because Barrier only sends
        //! raw key events, not translated text input. While we would ideally support the full range
        //! of UTF-8 text input, that is beyond the scope of this debug/development only class. Note
        //! that this function assumes an ANSI mechanical keyboard layout with a standard QWERTY key
        //! mapping, and will not produce correct results if used with other key layouts or mappings.
        //! \param[in] scanCode The scan code of the key
        //! \param[in] activeModifiers The bit mask of currently active modifier keys
        //! \return If the scan code and active modifiers produce a valid ASCII character
        char TranslateRawKeyEventToASCIIChar(uint32_t scanCode, ModifierMask activeModifiers);

        ////////////////////////////////////////////////////////////////////////////////////////////
        // Variables
        RawKeyEventQueueByIdMap      m_threadAwareRawKeyEventQueuesById;
        AZStd::mutex                 m_threadAwareRawKeyEventQueuesByIdMutex;

        AZStd::vector<AZStd::string> m_threadAwareRawTextEventQueue;
        AZStd::mutex                 m_threadAwareRawTextEventQueueMutex;

        bool                         m_hasTextEntryStarted;
    };
} // namespace BarrierInput