Changeset 5806 in vbox for trunk/src/VBox

Timestamp:

Nov 20, 2007 6:20:00 PM (17 years ago)

Author:

vboxsync

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

26217

Message:

Main: Fixed: Always save values of unused attributes of serial ports to preserve user's settings for later use.

Location:

trunk/src/VBox/Main

Files:

• ParallelPortImpl.cpp (modified) (5 diffs)
• SerialPortImpl.cpp (modified) (9 diffs)
• include/SerialPortImpl.h (modified) (1 diff)

trunk/src/VBox/Main/ParallelPortImpl.cpp

@@ -275 +275 @@
 }
 
+/** 
+ *  Saves the port settings to the given <Port> node.
+ *
+ *  Note that the given node is always empty so it is not necessary to delete
+ *  old values.
+ * 
+ *  @param aNode Node to save the settings to.
+ * 
+ *  @return 
+ */
 HRESULT ParallelPort::saveSettings (CFGNODE aNode)
 {
@@ -292 +302 @@
     CFGLDRSetUInt32Ex (portNode, "IOBase",  mData->mIOBase, 16);
     CFGLDRSetUInt32   (portNode, "IRQ",     mData->mIRQ);
-    CFGLDRSetBSTR     (portNode, "path",    mData->mPath);
+
+    /* 'path' is optional in XML */
+    if (!mData->mPath.isEmpty())
+        CFGLDRSetBSTR (portNode, "path", mData->mPath);
 
     return S_OK;
@@ -378 +391 @@
     if (aIRQ > 255)
         return setError (E_INVALIDARG,
-            tr ("Invalid IRQ number: %lu (must be in range [0, %lu])"),
-                aIRQ, 255);
+            tr ("Invalid IRQ number of the parallel port %d: "
+                "%lu (must be in range [0, %lu])"),
+            mData->mSlot, aIRQ, 255);
 
     AutoCaller autoCaller (this);
@@ -432 +446 @@
     if (aIOBase > 0xFFFF)
         return setError (E_INVALIDARG,
-            tr ("Invalid I/O port base address: %lu (must be in range [0, 0x%X])"),
-                aIOBase, 0, 0xFFFF);
+            tr ("Invalid I/O port base address of the parallel port %d: "
+                "%lu (must be in range [0, 0x%X])"),
+            mData->mSlot, aIOBase, 0, 0xFFFF);
 
     AutoCaller autoCaller (this);
@@ -487 +502 @@
     if (!*aPath)
         return setError (E_INVALIDARG,
-            tr ("Parallel port path cannot be empty"));
+            tr ("Path of the parallel port %d may not be empty"),
+            mData->mSlot);
 
     AutoCaller autoCaller (this);

trunk/src/VBox/Main/SerialPortImpl.cpp

@@ -245 +245 @@
 
     AutoLock alock (this);
+
+    HRESULT rc = S_OK;
 
     CFGNODE portNode = NULL;
@@ -273 +275 @@
     /* pipe/device path */
     Bstr path;
-    CFGLDRQueryBSTR(portNode, "path", path.asOutParam());
+    CFGLDRQueryBSTR (portNode, "path", path.asOutParam());
     /* server mode */
     bool fServer = true;
@@ -282 +284 @@
     mData->mIOBase   = uIOBase;
     mData->mIRQ      = uIRQ;
+
+    rc = checkSetPath (path);
+    CheckComRCReturnRC (rc);
+
     mData->mPath     = path;
     mData->mServer   = fServer;
 
-    return S_OK;
-}
-
+    return rc;
+}
+
+/** 
+ *  Saves the port settings to the given <Port> node.
+ *
+ *  Note that the given node is always empty so it is not necessary to delete
+ *  old values.
+ * 
+ *  @param aNode Node to save the settings to.
+ * 
+ *  @return 
+ */
 HRESULT SerialPort::saveSettings (CFGNODE aNode)
 {
@@ -320 +336 @@
     CFGLDRSetUInt32   (portNode, "IRQ",      mData->mIRQ);
     CFGLDRSetString   (portNode, "hostMode", mode);
-    if (mData->mHostMode != PortMode_DisconnectedPort)
-    {
-        CFGLDRSetBSTR (portNode, "path",    mData->mPath);
-        if (mData->mHostMode == PortMode_HostPipePort)
-            CFGLDRSetBool (portNode, "server",  !!mData->mServer);
-    }
+
+    /* Always save non-null mPath and mServer to preserve the user values for
+     * later use. Note that 'server' is false by default in XML so we don't
+     * save it when it's false. */
+    if (!mData->mPath.isEmpty())
+        CFGLDRSetBSTR (portNode, "path", mData->mPath);
+    if (mData->mServer)
+        CFGLDRSetBool (portNode, "server", !!mData->mServer);
 
     return S_OK;
@@ -406 +424 @@
     if (mData->mHostMode != aHostMode)
     {
+        switch (aHostMode)
+        {
+            case PortMode_HostPipePort:
+                if (mData->mPath.isEmpty())
+                    return setError (E_INVALIDARG,
+                        tr ("Cannot set the host pipe mode of the serial port %d "
+                            "because the pipe path is empty or null"),
+                        mData->mSlot);
+                break;
+            case PortMode_HostDevicePort:
+                if (mData->mPath.isEmpty())
+                    return setError (E_INVALIDARG,
+                        tr ("Cannot set the host device mode of the serial port %d "
+                            "because the device path is empty or null"),
+                        mData->mSlot);
+                break;
+            case PortMode_DisconnectedPort:
+                break;
+        }
+
         mData.backup();
         mData->mHostMode = aHostMode;
-        if (aHostMode == PortMode_DisconnectedPort)
-        {
-            mData->mPath.setNull();
-            mData->mServer = false;
-        }
+
         emitChangeEvent = true;
     }
@@ -463 +497 @@
     if (aIRQ > 255)
         return setError (E_INVALIDARG,
-            tr ("Invalid IRQ number: %lu (must be in range [0, %lu])"),
-                aIRQ, 255);
+            tr ("Invalid IRQ number of the serial port %d: "
+                "%lu (must be in range [0, %lu])"),
+            mData->mSlot, aIRQ, 255);
 
     AutoCaller autoCaller (this);
@@ -517 +552 @@
     if (aIOBase > 0xFFFF)
         return setError (E_INVALIDARG,
-            tr ("Invalid I/O port base address: %lu (must be in range [0, 0x%X])"),
-                aIOBase, 0, 0xFFFF);
+            tr ("Invalid I/O port base address of the serial port %d: "
+                "%lu (must be in range [0, 0x%X])"),
+            mData->mSlot, aIOBase, 0, 0xFFFF);
 
     AutoCaller autoCaller (this);
@@ -565 +601 @@
 }
 
+/** 
+ *  Validates COMSETTER(Path) arguments.
+ */
+HRESULT SerialPort::checkSetPath (BSTR aPath)
+{
+    AssertReturn (isLockedOnCurrentThread(), E_FAIL);
+
+    if ((mData->mHostMode == PortMode_HostDevicePort ||
+         mData->mHostMode == PortMode_HostPipePort) &&
+        (aPath == NULL || *aPath == '\0'))
+        return setError (E_INVALIDARG,
+            tr ("Path of the serial port %d may not be empty or null in "
+                "host pipe or host device mode"),
+            mData->mSlot);
+
+    return S_OK;
+}
+
 STDMETHODIMP SerialPort::COMSETTER(Path) (INPTR BSTR aPath)
 {
     if (!aPath)
         return E_POINTER;
-
-    if (!*aPath)
-        return setError (E_INVALIDARG,
-            tr ("Serial port path cannot be empty"));
-
 
     AutoCaller autoCaller (this);
@@ -586 +635 @@
     if (mData->mPath != aPath)
     {
+        HRESULT rc = checkSetPath (aPath);
+        CheckComRCReturnRC (rc);
+
         mData.backup();
         mData->mPath = aPath;

trunk/src/VBox/Main/include/SerialPortImpl.h

@@ -122 +122 @@
 private:
 
+    HRESULT checkSetPath (BSTR aPath);
+
     const ComObjPtr <Machine, ComWeakRef> mParent;
     const ComObjPtr <SerialPort> mPeer;