Changeset 85251 in vbox

Timestamp:

Jul 11, 2020 11:17:17 PM (4 years ago)

Author:

vboxsync

Message:

Main/ProgressImpl: Better solution to the LONG aResultCode issue of notifyComplete(). bugref:9790

Location:

trunk/src/VBox/Main

Files:

• include/ProgressImpl.h (modified) (1 diff)
• src-all/ProgressImpl.cpp (modified) (6 diffs)

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

@@ -235 +235 @@
 
     // internal helper methods
+    HRESULT i_notifyCompleteWorker(HRESULT aResultCode, const ComPtr<IVirtualBoxErrorInfo> &aErrorInfo);
     double i_calcTotalPercent();
     void i_checkForAutomaticTimeout(void);

trunk/src/VBox/Main/src-all/ProgressImpl.cpp

@@ -369 +369 @@
     }
 
-    return notifyComplete((LONG)aResultCode, errorInfo);
+    return i_notifyCompleteWorker(aResultCode, errorInfo);
 }
 
@@ -413 +413 @@
     errorInfo->init(aResultCode, aIID, pcszComponent, text);
 
-    return notifyComplete((LONG)aResultCode, errorInfo);
+    return i_notifyCompleteWorker(aResultCode, errorInfo);
 }
 
@@ -460 +460 @@
     errorInfo->initEx(aResultCode, vrc, aIID, pszComponent, text);
 
-    return notifyComplete((LONG)aResultCode, errorInfo);
+    return i_notifyCompleteWorker(aResultCode, errorInfo);
 }
 
@@ -1112 +1112 @@
 HRESULT Progress::notifyComplete(LONG aResultCode, const ComPtr<IVirtualBoxErrorInfo> &aErrorInfo)
 {
-    HRESULT hrcOperation = (HRESULT)aResultCode; /* XPCOM has an unsigned HRESULT, upsetting Clang 11 wrt sign conv. */
-    LogThisFunc(("hrcOperation=%Rhrc\n", hrcOperation));
+    return i_notifyCompleteWorker((HRESULT)aResultCode, aErrorInfo);
+}
+
+
+// private internal helpers
+/////////////////////////////////////////////////////////////////////////////
+
+/**
+ * Marks the operation as complete and attaches full error info.
+ *
+ * This is where the actual work is done, the related methods all end up here.
+ *
+ * @param aResultCode       Operation result (error) code, must not be S_OK.
+ * @param aErrorInfo        List of arguments for the format string.
+ *
+ * @note This is just notifyComplete with the correct aResultCode type.
+ */
+HRESULT Progress::i_notifyCompleteWorker(HRESULT aResultCode, const ComPtr<IVirtualBoxErrorInfo> &aErrorInfo)
+{
+    LogThisFunc(("aResultCode=%Rhrc\n", aResultCode));
     /* on failure we expect error info, on success there must be none */
-    AssertMsg(FAILED(hrcOperation) ^ aErrorInfo.isNull(),
-              ("No error info but trying to set a failed result (%08X)!\n",
-               hrcOperation));
+    AssertMsg(FAILED(aResultCode) ^ aErrorInfo.isNull(),
+              ("No error info but trying to set a failed result (%08X/%Rhrc)!\n", aResultCode, aResultCode));
 
     AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
@@ -1123 +1140 @@
     AssertReturn(mCompleted == FALSE, E_FAIL);
 
-    if (mCanceled && SUCCEEDED(hrcOperation))
-        hrcOperation = E_FAIL;
+    if (mCanceled && SUCCEEDED(aResultCode))
+        aResultCode = E_FAIL;
 
     mCompleted = TRUE;
-    mResultCode = hrcOperation;
-    if (SUCCEEDED(hrcOperation))
+    mResultCode = aResultCode;
+    if (SUCCEEDED(aResultCode))
     {
         m_ulCurrentOperation = m_cOperations - 1; /* last operation */
@@ -1150 +1167 @@
 }
 
-
-// private internal helpers
-/////////////////////////////////////////////////////////////////////////////
-
 /**
  * Internal helper to compute the total percent value based on the member values and