Changeset 98500 in vbox for trunk/src/VBox/Frontends/VirtualBox

Timestamp:

Feb 8, 2023 12:59:38 PM (2 years ago)

Author:

vboxsync

Message:

FE/Qt: bugref:10322: Runtime UI: Rework CKeyboard wrapper usage the way it's fully encapsulated inside UISession.

Location:

trunk/src/VBox/Frontends/VirtualBox/src

Files:

• notificationcenter/UINotificationObjects.cpp (modified) (2 diffs)
• notificationcenter/UINotificationObjects.h (modified) (2 diffs)
• runtime/UIKeyboardHandler.cpp (modified) (12 diffs)
• runtime/UIKeyboardHandler.h (modified) (3 diffs)
• runtime/UIMachine.cpp (modified) (1 diff)
• runtime/UIMachine.h (modified) (1 diff)
• runtime/UIMachineLogic.cpp (modified) (9 diffs)
• runtime/UIMachineLogic.h (modified) (2 diffs)
• runtime/UISession.cpp (modified) (1 diff)
• runtime/UISession.h (modified) (1 diff)
• softkeyboard/UISoftKeyboard.cpp (modified) (9 diffs)
• softkeyboard/UISoftKeyboard.h (modified) (4 diffs)

trunk/src/VBox/Frontends/VirtualBox/src/notificationcenter/UINotificationObjects.cpp

@@ -61 +61 @@
 #include "CHostNetworkInterface.h"
 #include "CHostOnlyNetwork.h"
+#include "CKeyboard.h"
 #include "CMediumAttachment.h"
 #include "CNATNetwork.h"
@@ -922 +923 @@
         QApplication::translate("UIMessageCenter", "Failed to assign update agent parameter.") +
         UIErrorString::formatErrorInfo(comAgent));
+}
+
+/* static */
+void UINotificationMessage::cannotChangeKeyboardParameter(const CKeyboard &comKeyboard)
+{
+    createMessage(
+        QApplication::translate("UIMessageCenter", "Keyboard failure ..."),
+        QApplication::translate("UIMessageCenter", "Failed to assign keyboard parameter.") +
+        UIErrorString::formatErrorInfo(comKeyboard));
 }
 

trunk/src/VBox/Frontends/VirtualBox/src/notificationcenter/UINotificationObjects.h

@@ -72 +72 @@
 class CCloudProfile;
 class CEmulatedUSB;
+class CKeyboard;
 class CNetworkAdapter;
 class CVirtualBox;
@@ -381 +382 @@
           * @param  comAgent  Brings the object parameter being changed for. */
         static void cannotChangeUpdateAgentParameter(const CUpdateAgent &comAgent);
+        /** Notifies about inability to change IKeyboard parameter.
+          * @param  comKeyboard  Brings the object parameter being changed for. */
+        static void cannotChangeKeyboardParameter(const CKeyboard &comKeyboard);
         /** Notifies about inability to change IVirtualSystemDescription parameter.
           * @param  comVsd  Brings the object parameter being changed for. */

trunk/src/VBox/Frontends/VirtualBox/src/runtime/UIKeyboardHandler.cpp

@@ -61 +61 @@
 #include "UIMouseHandler.h"
 #include "UINotificationCenter.h"
-#include "UISession.h"
 #ifdef VBOX_WS_MAC
 # include "UICocoaApplication.h"
@@ -74 +73 @@
 # include "VBoxUtils-x11.h"
 #endif
-
-/* COM includes: */
-#include "CKeyboard.h"
 
 /* Other VBox includes: */
@@ -440 +436 @@
                     codes << ((idxCode & 0x7F) | 0x80);
                 }
-                keyboard().PutScancodes(codes);
+                uimachine()->putScancodes(codes);
                 fSentRESEND = true;
             }
             if (m_pressedKeys[i] & IsKeyPressed)
-                keyboard().PutScancode(i | 0x80);
+                uimachine()->putScancode(i | 0x80);
             else
             {
@@ -450 +446 @@
                 codes[0] = 0xE0;
                 codes[1] = i | 0x80;
-                keyboard().PutScancodes(codes);
+                uimachine()->putScancodes(codes);
             }
         }
@@ -723 +719 @@
                 /* And release left Ctrl key early (if required): */
                 if (m_pAltGrMonitor->isLeftControlReleaseNeeded())
-                    keyboard().PutScancode(0x1D | 0x80);
+                    uimachine()->putScancode(0x1D | 0x80);
             }
 
@@ -1090 +1086 @@
 }
 
-CKeyboard &UIKeyboardHandler::keyboard() const
-{
-    return machineLogic()->uisession()->keyboard();
-}
-
 /* Event handler for prepared listener(s): */
 bool UIKeyboardHandler::eventFilter(QObject *pWatchedObject, QEvent *pEvent)
@@ -1241 +1232 @@
                             combo[3] = 0xd7 + (pKeyEvent->key() - Qt::Key_F11); /* F11-F12 up   */
                         }
-                        keyboard().PutScancodes(combo);
+                        uimachine()->putScancodes(combo);
                     }
                     /* Process hot keys not processed in keyEvent() (as in case of non-alphanumeric keys): */
@@ -1593 +1584 @@
 }
 
-void UIKeyboardHandler::keyEventReleaseHostComboKeys(const CKeyboard &constKeyboard)
-{
-    /* Get keyboard: */
-    CKeyboard keyboard(constKeyboard);
-    /* We have to make guest to release pressed keys from the host-combination: */
-    QList<uint8_t> hostComboScans = m_pressedHostComboKeys.values();
-    for (int i = 0 ; i < hostComboScans.size(); ++i)
-    {
-        uint8_t uScan = hostComboScans[i];
-        if (m_pressedKeys[uScan] & IsKeyPressed)
-        {
-            keyboard.PutScancode(uScan | 0x80);
-        }
-        else if (m_pressedKeys[uScan] & IsExtKeyPressed)
-        {
-            QVector<LONG> scancodes(2);
-            scancodes[0] = 0xE0;
-            scancodes[1] = uScan | 0x80;
-            keyboard.PutScancodes(scancodes);
-        }
-        m_pressedKeys[uScan] = 0;
-    }
-}
-
 bool UIKeyboardHandler::keyEvent(int iKey, uint8_t uScan, int fFlags, ulong uScreenId, wchar_t *pUniKey /* = 0 */)
 {
@@ -1749 +1716 @@
             for (uint i = 0; i < uCodesCount; ++i)
                 scancodes.append(pCodes[i]);
-            keyboard().PutScancodes(scancodes);
+            uimachine()->putScancodes(scancodes);
         }
 
@@ -1755 +1722 @@
         if (isHostComboStateChanged && m_bIsHostComboPressed)
         {
-            keyEventReleaseHostComboKeys(keyboard());
+            /* We have to make guest to release pressed keys from the host-combination: */
+            foreach (const uint8_t &uScan, m_pressedHostComboKeys.values())
+            {
+                if (m_pressedKeys[uScan] & IsKeyPressed)
+                {
+                    uimachine()->putScancode(uScan | 0x80);
+                }
+                else if (m_pressedKeys[uScan] & IsExtKeyPressed)
+                {
+                    QVector<LONG> scancodes(2);
+                    scancodes[0] = 0xE0;
+                    scancodes[1] = uScan | 0x80;
+                    uimachine()->putScancodes(scancodes);
+                }
+                m_pressedKeys[uScan] = 0;
+            }
         }
     }
@@ -1931 +1913 @@
             if (!(ns & IsKeyPressed))
                 codes[0] |= 0x80;
-            keyboard().PutScancode(codes[0]);
+            uimachine()->putScancode(codes[0]);
         }
         else if ((os & IsExtKeyPressed) != (ns & IsExtKeyPressed))
@@ -1939 +1921 @@
             if (!(ns & IsExtKeyPressed))
                 codes[1] |= 0x80;
-            keyboard().PutScancodes(codes);
+            uimachine()->putScancodes(codes);
         }
     }

trunk/src/VBox/Frontends/VirtualBox/src/runtime/UIKeyboardHandler.h

@@ -55 +55 @@
 class UIMachineView;
 class UIMachineWindow;
-class CKeyboard;
 #ifdef VBOX_WS_WIN
 class WinAltGrMonitor;
@@ -148 +147 @@
     UIActionPool *actionPool() const;
     UIMachine *uimachine() const;
-
-    /** Returns the console's keyboard reference. */
-    CKeyboard &keyboard() const;
 
     /* Event handler for registered machine-view(s): */
@@ -171 +167 @@
     bool keyEventHostComboHandled(int iKey, wchar_t *pUniKey, bool isHostComboStateChanged, bool *pfResult);
     void keyEventHandleHostComboRelease(ulong uScreenId);
-    void keyEventReleaseHostComboKeys(const CKeyboard &keyboard);
     /* Separate function to handle most of existing keyboard-events: */
     bool keyEvent(int iKey, uint8_t uScan, int fFlags, ulong uScreenId, wchar_t *pUniKey = 0);

trunk/src/VBox/Frontends/VirtualBox/src/runtime/UIMachine.cpp

@@ -441 +441 @@
 {
     return uisession()->isGuestSupportsSeamless();
+}
+
+void UIMachine::putScancode(LONG iCode)
+{
+    uisession()->putScancode(iCode);
+}
+
+void UIMachine::putScancodes(const QVector<LONG> &codes)
+{
+    uisession()->putScancodes(codes);
+}
+
+void UIMachine::putCad()
+{
+    uisession()->putCad();
+}
+
+void UIMachine::releaseKeys()
+{
+    uisession()->releaseKeys();
+}
+
+void UIMachine::putUsageCode(LONG iUsageCode, LONG iUsagePage, BOOL fKeyRelease)
+{
+    uisession()->putUsageCode(iUsageCode, iUsagePage, fKeyRelease);
 }
 

trunk/src/VBox/Frontends/VirtualBox/src/runtime/UIMachine.h

@@ -314 +314 @@
         /** Returns the keyboard-state. */
         int keyboardState() const { return m_iKeyboardState; }
+
+        /** Sends a scan @a iCode to VM's keyboard. */
+        void putScancode(LONG iCode);
+        /** Sends a list of scan @a codes to VM's keyboard. */
+        void putScancodes(const QVector<LONG> &codes);
+        /** Sends the CAD sequence to VM's keyboard. */
+        void putCad();
+        /** Releases all keys. */
+        void releaseKeys();
+        /** Sends a USB HID @a iUsageCode and @a iUsagePage to VM's keyboard.
+          * The @a fKeyRelease flag is set when the key is being released. */
+        void putUsageCode(LONG iUsageCode, LONG iUsagePage, BOOL fKeyRelease);
     /** @} */
 

trunk/src/VBox/Frontends/VirtualBox/src/runtime/UIMachineLogic.cpp

@@ -312 +312 @@
 {
     return uisession()->mouse();
-}
-
-CKeyboard& UIMachineLogic::keyboard() const
-{
-    return uisession()->keyboard();
 }
 
@@ -2040 +2035 @@
     {
         QWidget *pCenterWidget = windowManager().realParentWindow(activeMachineWindow());
-        m_pSoftKeyboardDialog = new UISoftKeyboard(0, uimachine(), uisession(),
-                                                   pCenterWidget, machine().GetName());
+        m_pSoftKeyboardDialog = new UISoftKeyboard(0, uimachine(), pCenterWidget, machine().GetName());
         connect(m_pSoftKeyboardDialog, &UISoftKeyboard::sigClose, this, &UIMachineLogic::sltCloseSoftKeyboardDefault);
     }
@@ -2067 +2061 @@
 void UIMachineLogic::sltTypeCAD()
 {
-    keyboard().PutCAD();
-    AssertWrapperOk(keyboard());
+    uimachine()->putCad();
 }
 
@@ -2081 +2074 @@
     sequence[4] = 0x38 | 0x80; /* Alt up */
     sequence[5] = 0x1d | 0x80; /* Ctrl up */
-    keyboard().PutScancodes(sequence);
-    AssertWrapperOk(keyboard());
+    uimachine()->putScancodes(sequence);
 }
 #endif /* VBOX_WS_X11 */
@@ -2095 +2087 @@
     sequence[4] = 0x46 | 0x80; /* Break up */
     sequence[5] = 0x1d | 0x80; /* Ctrl up */
-    keyboard().PutScancodes(sequence);
-    AssertWrapperOk(keyboard());
+    uimachine()->putScancodes(sequence);
 }
 
@@ -2106 +2097 @@
     sequence[2] = 0xE0;        /* Extended flag */
     sequence[3] = 0x52 | 0x80; /* Insert up */
-    keyboard().PutScancodes(sequence);
-    AssertWrapperOk(keyboard());
+    uimachine()->putScancodes(sequence);
 }
 
@@ -2121 +2111 @@
     sequence[6] = 0xE0;        /* Extended flag */
     sequence[7] = 0x2A | 0x80; /* Print.. up */
-    keyboard().PutScancodes(sequence);
-    AssertWrapperOk(keyboard());
+    uimachine()->putScancodes(sequence);
 }
 
@@ -2138 +2127 @@
     sequence[8] = 0x2A | 0x80; /* Print.. up */
     sequence[9] = 0x38 | 0x80; /* Alt up */
-    keyboard().PutScancodes(sequence);
-    AssertWrapperOk(keyboard());
+    uimachine()->putScancodes(sequence);
 }
 
@@ -2165 +2153 @@
     }
 
-    keyboard().PutScancodes(codes);
-    AssertWrapperOk(keyboard());
+    uimachine()->putScancodes(codes);
 }
 

trunk/src/VBox/Frontends/VirtualBox/src/runtime/UIMachineLogic.h

@@ -60 +60 @@
 class CGuest;
 class CMouse;
-class CKeyboard;
 class CMachineDebugger;
 class CSnapshot;
@@ -131 +130 @@
     /** Returns the console's mouse reference. */
     CMouse& mouse() const;
-    /** Returns the console's keyboard reference. */
-    CKeyboard& keyboard() const;
     /** Returns the console's debugger reference. */
     CMachineDebugger& debugger() const;

trunk/src/VBox/Frontends/VirtualBox/src/runtime/UISession.cpp

@@ -264 +264 @@
 
     return fOk;
+}
+
+void UISession::putScancode(LONG iCode)
+{
+    CKeyboard comKeyboard = keyboard();
+    comKeyboard.PutScancode(iCode);
+    if (!comKeyboard.isOk())
+        UINotificationMessage::cannotChangeKeyboardParameter(comKeyboard);
+}
+
+void UISession::putScancodes(const QVector<LONG> &codes)
+{
+    CKeyboard comKeyboard = keyboard();
+    comKeyboard.PutScancodes(codes);
+    if (!comKeyboard.isOk())
+        UINotificationMessage::cannotChangeKeyboardParameter(comKeyboard);
+}
+
+void UISession::putCad()
+{
+    CKeyboard comKeyboard = keyboard();
+    comKeyboard.PutCAD();
+    if (!comKeyboard.isOk())
+        UINotificationMessage::cannotChangeKeyboardParameter(comKeyboard);
+}
+
+void UISession::releaseKeys()
+{
+    CKeyboard comKeyboard = keyboard();
+    comKeyboard.ReleaseKeys();
+    if (!comKeyboard.isOk())
+        UINotificationMessage::cannotChangeKeyboardParameter(comKeyboard);
+}
+
+void UISession::putUsageCode(LONG iUsageCode, LONG iUsagePage, BOOL fKeyRelease)
+{
+    CKeyboard comKeyboard = keyboard();
+    comKeyboard.PutUsageCode(iUsageCode, iUsagePage, fKeyRelease);
+    if (!comKeyboard.isOk())
+        UINotificationMessage::cannotChangeKeyboardParameter(comKeyboard);
 }
 

trunk/src/VBox/Frontends/VirtualBox/src/runtime/UISession.h

@@ -232 +232 @@
     /** @} */
 
+    /** @name Keyboard stuff.
+     ** @{ */
+        /** Sends a scan @a iCode to VM's keyboard. */
+        void putScancode(LONG iCode);
+        /** Sends a list of scan @a codes to VM's keyboard. */
+        void putScancodes(const QVector<LONG> &codes);
+        /** Sends the CAD sequence to VM's keyboard. */
+        void putCad();
+        /** Releases all keys. */
+        void releaseKeys();
+        /** Sends a USB HID @a iUsageCode and @a iUsagePage to VM's keyboard.
+          * The @a fKeyRelease flag is set when the key is being released. */
+        void putUsageCode(LONG iUsageCode, LONG iUsagePage, BOOL fKeyRelease);
+    /** @} */
+
     /** @name Guest additions stuff.
      ** @{ */

trunk/src/VBox/Frontends/VirtualBox/src/softkeyboard/UISoftKeyboard.cpp

@@ -57 +57 @@
 #include "UIMessageCenter.h"
 #include "UIModalWindowManager.h"
-#include "UISession.h"
 #include "UISoftKeyboard.h"
 #include "UICommon.h"
@@ -3924 +3923 @@
 *********************************************************************************************************************************/
 
-UISoftKeyboard::UISoftKeyboard(QWidget *pParent, UIMachine *pMachine, UISession *pSession,
+UISoftKeyboard::UISoftKeyboard(QWidget *pParent, UIMachine *pMachine,
                                QWidget *pCenterWidget, QString strMachineName /* = QString() */)
     : QMainWindowWithRestorableGeometryAndRetranslateUi(pParent)
     , m_pMachine(pMachine)
-    , m_pSession(pSession)
     , m_pCenterWidget(pCenterWidget)
     , m_pMainLayout(0)
@@ -3988 +3986 @@
         }
     }
-    keyboard().ReleaseKeys();
+    m_pMachine->releaseKeys();
     emit sigClose();
     event->ignore();
@@ -4041 +4039 @@
 void UISoftKeyboard::sltPutKeyboardSequence(QVector<LONG> sequence)
 {
-    keyboard().PutScancodes(sequence);
+    m_pMachine->putScancodes(sequence);
 }
 
@@ -4047 +4045 @@
 {
     for (int i = 0; i < sequence.size(); ++i)
-        keyboard().PutUsageCode(sequence[i].first, sequence[i].second, false);
+        m_pMachine->putUsageCode(sequence[i].first, sequence[i].second, false);
 }
 
@@ -4053 +4051 @@
 {
     for (int i = 0; i < sequence.size(); ++i)
-        keyboard().PutUsageCode(sequence[i].first, sequence[i].second, true);
+        m_pMachine->putUsageCode(sequence[i].first, sequence[i].second, true);
 }
 
@@ -4239 +4237 @@
     if (m_pLayoutEditor)
         m_pLayoutEditor->reset();
-    keyboard().ReleaseKeys();
+    m_pMachine->releaseKeys();
     update();
 }
@@ -4377 +4375 @@
 void UISoftKeyboard::sltReleaseKeys()
 {
-    keyboard().ReleaseKeys();
+    m_pMachine->releaseKeys();
 }
 
@@ -4472 +4470 @@
 }
 
-CKeyboard& UISoftKeyboard::keyboard() const
-{
-    return m_pSession->keyboard();
-}
-
 #include "UISoftKeyboard.moc"

trunk/src/VBox/Frontends/VirtualBox/src/softkeyboard/UISoftKeyboard.h

@@ -43 +43 @@
 
 /* Forward declarations: */
-class CKeyboard;
 class QHBoxLayout;
 class QToolButton;
@@ -49 +48 @@
 class UILayoutSelector;
 class UIMachine;
-class UISession;
 class UISoftKeyboardKey;
 class UISoftKeyboardSettingsWidget;
@@ -72 +70 @@
 public:
 
-    UISoftKeyboard(QWidget *pParent, UIMachine *pMachine, UISession *pSession,
+    UISoftKeyboard(QWidget *pParent, UIMachine *pMachine,
                    QWidget *pCenterWidget, QString strMachineName = QString());
     ~UISoftKeyboard();
@@ -130 +128 @@
     void updateStatusBarMessage(const QString &strLayoutName);
     void updateLayoutSelectorList();
-    CKeyboard& keyboard() const;
 
     UIMachine     *m_pMachine;
-    UISession     *m_pSession;
     QWidget       *m_pCenterWidget;
     QHBoxLayout   *m_pMainLayout;