Changeset 98620 in vbox for trunk/src/VBox/Frontends

Timestamp:

Feb 17, 2023 3:12:34 PM (2 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

155916

Message:

FE/Qt: bugref:10322: Runtime UI: Reworking CConsole wrapper usage step-by-step; This one is about USB devices stuff.

Location:

trunk/src/VBox/Frontends/VirtualBox/src/runtime

Files:

• UIMachine.cpp (modified) (1 diff)
• UIMachine.h (modified) (1 diff)
• UIMachineDefs.h (modified) (2 diffs)
• UIMachineLogic.cpp (modified) (3 diffs)
• UISession.cpp (modified) (3 diffs)
• UISession.h (modified) (2 diffs)

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

@@ -544 +544 @@
 {
     return uisession()->putEventMultiTouch(iCount, contacts, fIsTouchScreen, uScanTime);
+}
+
+bool UIMachine::usbDevices(QList<USBDeviceInfo> &guiUSBDevices)
+{
+    return uisession()->usbDevices(guiUSBDevices);
+}
+
+bool UIMachine::attachUSBDevice(const QUuid &uId)
+{
+    return uisession()->attachUSBDevice(uId);
+}
+
+bool UIMachine::detachUSBDevice(const QUuid &uId)
+{
+    return uisession()->detachUSBDevice(uId);
 }
 

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

@@ -409 +409 @@
     /** @} */
 
+    /** @name USB stuff.
+     ** @{ */
+        /** Returns a list of USB devices. */
+        bool usbDevices(QList<USBDeviceInfo> &guiUSBDevices);
+        /** Attaches USB device with passed @a uId. */
+        bool attachUSBDevice(const QUuid &uId);
+        /** Detaches USB device with passed @a uId. */
+        bool detachUSBDevice(const QUuid &uId);
+    /** @} */
+
     /** @name Virtualization stuff.
      ** @{ */

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

@@ -31 +31 @@
 # pragma once
 #endif
+
+/* Qt includes: */
+#include <QString>
+#include <QUuid>
 
 /* Other VBox includes: */
@@ -74 +78 @@
 };
 
+/** Robust struct to bring USB device info to machine-logic. */
+struct USBDeviceInfo
+{
+    QUuid    m_uId;
+    QString  m_strName;
+    QString  m_strToolTip;
+    bool     m_fIsChecked;
+    bool     m_fIsEnabled;
+};
+
 #endif /* !FEQT_INCLUDED_SRC_runtime_UIMachineDefs_h */

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

@@ -2274 +2274 @@
     /* Attach USB device: */
     if (target.attach)
-    {
-        /* Try to attach corresponding device: */
-        console().AttachUSBDevice(target.id, QString(""));
-        /* Check if console is OK: */
-        if (!console().isOk())
-        {
-            /* Get current host: */
-            CHost host = uiCommon().host();
-            /* Search the host for the corresponding USB device: */
-            CHostUSBDevice hostDevice = host.FindUSBDeviceById(target.id);
-            /* Get USB device from host USB device: */
-            CUSBDevice device(hostDevice);
-            /* Show a message about procedure failure: */
-            UINotificationMessage::cannotAttachUSBDevice(console(), uiCommon().usbDetails(device));
-        }
-    }
+        uimachine()->attachUSBDevice(target.id);
     /* Detach USB device: */
     else
-    {
-        /* Search the console for the corresponding USB device: */
-        CUSBDevice device = console().FindUSBDeviceById(target.id);
-        /* Try to detach corresponding device: */
-        console().DetachUSBDevice(target.id);
-        /* Check if console is OK: */
-        if (!console().isOk())
-        {
-            /* Show a message about procedure failure: */
-            UINotificationMessage::cannotDetachUSBDevice(console(), uiCommon().usbDetails(device));
-        }
-    }
+        uimachine()->detachUSBDevice(target.id);
 }
 
@@ -2811 +2785 @@
 void UIMachineLogic::updateMenuDevicesUSB(QMenu *pMenu)
 {
-    /* Get current host: */
-    const CHost host = uiCommon().host();
-    /* Get host USB device list: */
-    const CHostUSBDeviceVector devices = host.GetUSBDevices();
+    /* Acquire device list: */
+    QList<USBDeviceInfo> guiUSBDevices;
+    const bool fSuccess = uimachine()->usbDevices(guiUSBDevices);
 
     /* If device list is empty: */
-    if (devices.isEmpty())
+    if (!fSuccess || guiUSBDevices.isEmpty())
     {
         /* Add only one - "empty" action: */
@@ -2830 +2803 @@
     {
         /* Populate menu with host USB devices: */
-        foreach (const CHostUSBDevice& hostDevice, devices)
+        foreach (const USBDeviceInfo &guiUSBDevice, guiUSBDevices)
         {
-            /* Get USB device from current host USB device: */
-            const CUSBDevice device(hostDevice);
-
             /* Create USB device action: */
-            QAction *pAttachUSBAction = pMenu->addAction(uiCommon().usbDetails(device),
+            QAction *pAttachUSBAction = pMenu->addAction(guiUSBDevice.m_strName,
                                                          this, SLOT(sltAttachUSBDevice()));
-            pAttachUSBAction->setToolTip(uiCommon().usbToolTip(device));
+            pAttachUSBAction->setToolTip(guiUSBDevice.m_strToolTip);
             pAttachUSBAction->setCheckable(true);
-
-            /* Check if that USB device was already attached to this session: */
-            const CUSBDevice attachedDevice = console().FindUSBDeviceById(device.GetId());
-            pAttachUSBAction->setChecked(!attachedDevice.isNull());
-            pAttachUSBAction->setEnabled(hostDevice.GetState() != KUSBDeviceState_Unavailable);
-
-            /* Set USB attach data: */
-            pAttachUSBAction->setData(QVariant::fromValue(USBTarget(!pAttachUSBAction->isChecked(), device.GetId())));
+            pAttachUSBAction->setChecked(guiUSBDevice.m_fIsChecked);
+            pAttachUSBAction->setEnabled(guiUSBDevice.m_fIsEnabled);
+            pAttachUSBAction->setData(QVariant::fromValue(USBTarget(!pAttachUSBAction->isChecked(),
+                                                                    guiUSBDevice.m_uId)));
         }
     }

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

@@ -66 +66 @@
 #include "CSystemProperties.h"
 #include "CUSBController.h"
+#include "CUSBDevice.h"
 #include "CUSBDeviceFilter.h"
 #include "CUSBDeviceFilters.h"
@@ -77 +78 @@
 # include <iprt/ldr.h>
 #endif
+
+/* VirtualBox interface declarations: */
+#include <VBox/com/VirtualBox.h>
 
 /* External includes: */
@@ -373 +377 @@
     if (!fSuccess)
         UINotificationMessage::cannotChangeMouseParameter(comMouse);
+    return fSuccess;
+}
+
+bool UISession::usbDevices(QList<USBDeviceInfo> &guiUSBDevices)
+{
+    const CHost comHost = uiCommon().host();
+    const CHostUSBDeviceVector comHostUSBDevices = comHost.GetUSBDevices();
+    bool fSuccess = comHost.isOk();
+    if (!fSuccess)
+        UINotificationMessage::cannotAcquireHostParameter(comHost);
+    else
+    {
+        foreach (const CHostUSBDevice &comHostUSBDevice, comHostUSBDevices)
+        {
+            /* Get USB device from current host USB device,
+             * this stuff requires #include <VBox/com/VirtualBox.h> */
+            const CUSBDevice comUSBDevice(comHostUSBDevice);
+
+            /* Fill structure fields: */
+            USBDeviceInfo guiUSBDevice;
+            if (fSuccess)
+            {
+                guiUSBDevice.m_uId = comUSBDevice.GetId();
+                fSuccess = comUSBDevice.isOk();
+            }
+            if (fSuccess)
+            {
+                /// @todo make sure UICommon::usbDetails is checked for errors as well
+                guiUSBDevice.m_strName = uiCommon().usbDetails(comUSBDevice);
+                fSuccess = comUSBDevice.isOk();
+            }
+            if (fSuccess)
+            {
+                /// @todo make sure UICommon::usbToolTip is checked for errors as well
+                guiUSBDevice.m_strToolTip = uiCommon().usbToolTip(comUSBDevice);
+                fSuccess = comUSBDevice.isOk();
+            }
+            if (fSuccess)
+            {
+                /* Check if that USB device was already attached to this session;
+                 * Nothing to check for errors here because error is valid case as well. */
+                const CUSBDevice comAttachedDevice = console().FindUSBDeviceById(guiUSBDevice.m_uId);
+                guiUSBDevice.m_fIsChecked = !comAttachedDevice.isNull();
+            }
+            if (fSuccess)
+            {
+                guiUSBDevice.m_fIsEnabled = comHostUSBDevice.GetState() != KUSBDeviceState_Unavailable;
+                fSuccess = comHostUSBDevice.isOk();
+            }
+
+            /* Append or break if necessary: */
+            if (fSuccess)
+                guiUSBDevices << guiUSBDevice;
+            else
+                break;
+        }
+    }
+    return fSuccess;
+}
+
+bool UISession::attachUSBDevice(const QUuid &uId)
+{
+    CConsole comConsole = console();
+    comConsole.AttachUSBDevice(uId, QString(""));
+    const bool fSuccess = comConsole.isOk();
+    if (!fSuccess)
+    {
+        CHost comHost = uiCommon().host();
+        /* Nothing to check for errors here because error is valid case as well. */
+        CHostUSBDevice comHostUSBDevice = comHost.FindUSBDeviceById(uId);
+        /* Get USB device from current host USB device,
+         * this stuff requires #include <VBox/com/VirtualBox.h> */
+        CUSBDevice comUSBDevice(comHostUSBDevice);
+        UINotificationMessage::cannotAttachUSBDevice(comConsole, uiCommon().usbDetails(comUSBDevice));
+        /// @todo make sure UICommon::usbDetails is checked for errors as well
+    }
+    return fSuccess;
+}
+
+bool UISession::detachUSBDevice(const QUuid &uId)
+{
+    CConsole comConsole = console();
+    comConsole.DetachUSBDevice(uId);
+    const bool fSuccess = comConsole.isOk();
+    if (!fSuccess)
+    {
+        CUSBDevice comUSBDevice = CConsole(comConsole).FindUSBDeviceById(uId);
+        UINotificationMessage::cannotDetachUSBDevice(comConsole, uiCommon().usbDetails(comUSBDevice));
+        /// @todo make sure UICommon::usbDetails is checked for errors as well
+    }
     return fSuccess;
 }

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

@@ -40 +40 @@
 /* GUI includes: */
 #include "UIExtraDataDefs.h"
+#include "UIMachineDefs.h"
 #include "UIMediumDefs.h"
 #include "UIMousePointerShapeData.h"
@@ -273 +274 @@
     /** @} */
 
+    /** @name USB stuff.
+     ** @{ */
+        /** Returns a list of USB devices. */
+        bool usbDevices(QList<USBDeviceInfo> &guiUSBDevices);
+        /** Attaches USB device with passed @a uId. */
+        bool attachUSBDevice(const QUuid &uId);
+        /** Detaches USB device with passed @a uId. */
+        bool detachUSBDevice(const QUuid &uId);
+    /** @} */
+
     /** @name Guest additions stuff.
      ** @{ */