Changeset 90234 in vbox for trunk/src/VBox/Frontends/VBoxManage

Timestamp:

Jul 16, 2021 10:28:08 PM (4 years ago)

Author:

vboxsync

Message:

VBoxManage: Give showProgress() a flags argument so that it can poll
the progress quietly. While here, teach it to print the progress
description (alone, or before the running progress count). No
existing callers should be affected, though the couple of callers that
use g_fDetailedProgress should be converted to the the flags instead.

Location:

trunk/src/VBox/Frontends/VBoxManage

Files:

• VBoxManage.cpp (modified) (8 diffs)
• VBoxManage.h (modified) (1 diff)

trunk/src/VBox/Frontends/VBoxManage/VBoxManage.cpp

@@ -202 +202 @@
  * react a little slower than in the ideal case).
  */
-HRESULT showProgress(ComPtr<IProgress> progress)
+HRESULT showProgress(ComPtr<IProgress> progress, unsigned int fFlags)
 {
     using namespace com;
+    HRESULT hrc;
 
     AssertReturn(progress.isNotNull(), E_FAIL);
+
+    /* grandfather the old callers */
+    if (g_fDetailedProgress)
+        fFlags = SHOW_PROGRESS_DETAILS;
+
+    const bool fDetailed = RT_BOOL(fFlags & SHOW_PROGRESS_DETAILS);
+    const bool fQuiet = !RT_BOOL(fFlags & (SHOW_PROGRESS | SHOW_PROGRESS_DETAILS));
+
 
     BOOL fCompleted = FALSE;
@@ -220 +229 @@
 
     ULONG cOperations = 1;
-    HRESULT hrc = progress->COMGETTER(OperationCount)(&cOperations);
+    hrc = progress->COMGETTER(OperationCount)(&cOperations);
     if (FAILED(hrc))
     {
@@ -226 +235 @@
         RTStrmFlush(g_pStdErr);
         return hrc;
+    }
+
+    if (fFlags & SHOW_PROGRESS_DESC)
+    {
+        com::Bstr bstrDescription;
+        hrc = progress->COMGETTER(Description(bstrDescription.asOutParam()));
+        if (FAILED(hrc))
+        {
+            RTStrmPrintf(g_pStdErr, "Failed to get progress description: %Rhrc\n", hrc);
+            return hrc;
+        }
+
+        const char *pcszDescSep;
+        if (fFlags & SHOW_PROGRESS_DETAILS)
+            pcszDescSep = "\n";
+        else
+            pcszDescSep = ": ";
+
+        RTStrmPrintf(g_pStdErr, "%ls%s", bstrDescription.raw(), pcszDescSep);
+        RTStrmFlush(g_pStdErr);
     }
 
@@ -234 +263 @@
      */
 
-    if (!g_fDetailedProgress)
+    if (!fQuiet && !fDetailed)
     {
         RTStrmPrintf(g_pStdErr, "0%%...");
@@ -260 +289 @@
         progress->COMGETTER(Percent(&ulCurrentPercent));
 
-        if (g_fDetailedProgress)
+        if (fDetailed)
         {
             ULONG ulOperation = 1;
@@ -293 +322 @@
             }
         }
-        else
+        else if (!fQuiet)
         {
             /* did we cross a 10% mark? */
@@ -345 +374 @@
     if (SUCCEEDED(hrc))
     {
+        /* async operation completed successfully */
         if (SUCCEEDED(iRc))
-            RTStrmPrintf(g_pStdErr, "100%%\n");
+        {
+            if (!fDetailed)
+            {
+                if (fFlags == SHOW_PROGRESS_DESC)
+                    RTStrmPrintf(g_pStdErr, "ok\n");
+                else if (!fQuiet)
+                    RTStrmPrintf(g_pStdErr, "100%%\n");
+            }
+        }
         else if (g_fCanceled)
             RTStrmPrintf(g_pStdErr, "CANCELED\n");
         else
         {
-            if (!g_fDetailedProgress)
+            if (!fDetailed)
                 RTStrmPrintf(g_pStdErr, "\n");
             RTStrmPrintf(g_pStdErr, "Progress state: %Rhrc\n", iRc);
@@ -359 +397 @@
     else
     {
-        if (!g_fDetailedProgress)
+        if (!fDetailed)
             RTStrmPrintf(g_pStdErr, "\n");
         RTStrmPrintf(g_pStdErr, "Progress object failure: %Rhrc\n", hrc);

trunk/src/VBox/Frontends/VBoxManage/VBoxManage.h

@@ -209 +209 @@
 RTEXITCODE  errorSyntax(const char *pszFormat, ...);
 
-HRESULT showProgress(ComPtr<IProgress> progress);
+
+#define SHOW_PROGRESS_NONE      0
+#define SHOW_PROGRESS_DESC      (1u << 0)
+#define SHOW_PROGRESS           (1u << 1)
+#define SHOW_PROGRESS_DETAILS   (1u << 2)
+HRESULT showProgress(ComPtr<IProgress> progress, unsigned int fFlags = SHOW_PROGRESS);
 #endif