Changeset 6168 in vbox for trunk/src/VBox/Main

Timestamp:

Dec 21, 2007 2:38:19 PM (17 years ago)

Author:

vboxsync

Message:

Main: Return errors when the parallel port is enabled but the path is null.

Location:

trunk/src/VBox/Main

Files:

• ParallelPortImpl.cpp (modified) (4 diffs)
• SerialPortImpl.cpp (modified) (1 diff)
• idl/VirtualBox.xidl (modified) (3 diffs)
• include/ParallelPortImpl.h (modified) (2 diffs)

trunk/src/VBox/Main/ParallelPortImpl.cpp

@@ -196 +196 @@
     /* IRQ (required) */
     mData->mIRQ = aPortNode.value <ULONG> ("IRQ");
-    /* device path (may be null) */
-    /// @todo report an error if enabled is true and path is empty or null!
-    //  The same applies to COMSETTER(Path).
-    mData->mPath = aPortNode.stringValue ("path");
+    /* device path (optional, defaults to null) */
+    Bstr path = aPortNode.stringValue ("path");
+
+    HRESULT rc = checkSetPath (path);
+    CheckComRCReturnRC (rc);
+    mData->mPath = path;
 
     return S_OK;
@@ -343 +345 @@
     if (mData->mEnabled != aEnabled)
     {
+        if (aEnabled &&
+            mData->mPath.isEmpty())
+            return setError (E_INVALIDARG,
+                        tr ("Cannot enable the parallel port %d "
+                            "because the port path is empty or null"),
+                        mData->mSlot);
+
         mData.backup();
         mData->mEnabled = aEnabled;
@@ -495 +504 @@
 }
 
+/** 
+ *  Validates COMSETTER(Path) arguments.
+ */
+HRESULT ParallelPort::checkSetPath (const BSTR aPath)
+{
+    AssertReturn (isLockedOnCurrentThread(), E_FAIL);
+
+    if (mData->mEnabled &&
+        (aPath == NULL || *aPath == '\0'))
+        return setError (E_INVALIDARG,
+            tr ("Path of the parallel port %d may not be empty or null "
+                "when the port is enabled"),
+            mData->mSlot);
+
+    return S_OK;
+}
+
 STDMETHODIMP ParallelPort::COMSETTER(Path) (INPTR BSTR aPath)
 {
-    if (!aPath)
-        return E_POINTER;
-
-    if (!*aPath)
-        return setError (E_INVALIDARG,
-            tr ("Path of the parallel port %d may not be empty"),
-            mData->mSlot);
-
     AutoCaller autoCaller (this);
     CheckComRCReturnRC (autoCaller.rc());
@@ -516 +534 @@
     if (mData->mPath != aPath)
     {
+        HRESULT rc = checkSetPath (aPath);
+        CheckComRCReturnRC (rc);
+
         mData.backup();
         mData->mPath = aPath;

trunk/src/VBox/Main/SerialPortImpl.cpp

@@ -621 +621 @@
 STDMETHODIMP SerialPort::COMSETTER(Path) (INPTR BSTR aPath)
 {
-    if (!aPath)
-        return E_POINTER;
-
     AutoCaller autoCaller (this);
     CheckComRCReturnRC (autoCaller.rc());

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -7774 +7774 @@
       and all port read operations will return no data.
 
-      <see>IMachine::getSerial</see>
+      <see>IMachine::getSerialPort</see>
     </desc>
 
@@ -7818 +7818 @@
         is PortMode::HostDevicePort. In either of the above cases, setting a
         @c null or an empty string as the attribute's value will result into
-        an error.
+        an error. Otherwise, the value of this property is ignored.
       </desc>
     </attribute>
@@ -7875 +7875 @@
     <attribute name="path" type="wstring">
       <desc>
-        Host parallel device name. Setting a null or an empty string as this
-        attribute's value will result into an error.
+        Host parallel device name. If this parallel port is enabled, setting a
+        @c null or an empty string as this attribute's value will result into
+        an error.
       </desc>
     </attribute>

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

@@ -36 +36 @@
         Data()
             : mSlot (0)
-            , mEnabled(FALSE)
+            , mEnabled (FALSE)
             , mIRQ (4)
             , mIOBase (0x378)
@@ -112 +112 @@
 private:
 
+    HRESULT checkSetPath (const BSTR aPath);
+
     const ComObjPtr <Machine, ComWeakRef> mParent;
     const ComObjPtr <ParallelPort> mPeer;