Changeset 38509 in vbox

Timestamp:

Aug 23, 2011 3:07:55 PM (13 years ago)

Author:

vboxsync

Message:

Main/glue/ErrorInfo: print _all_ error messages, not only the last one; add glue code for printing errors from a IProgress object

Location:

trunk

Files:

• include/VBox/com/errorprint.h (modified) (2 diffs)
• src/VBox/Main/glue/errorprint.cpp (modified) (4 diffs)

trunk/include/VBox/com/errorprint.h

@@ -36 +36 @@
 // shared prototypes; these are defined in shared glue code and are
 // compiled only once for all front-ends
-void GluePrintErrorInfo(com::ErrorInfo &info);
+void GluePrintErrorInfo(const com::ErrorInfo &info);
 void GluePrintErrorContext(const char *pcszContext, const char *pcszSourceFile, uint32_t ulLine);
 void GluePrintRCMessage(HRESULT rc);
-void GlueHandleComError(ComPtr<IUnknown> iface, const char *pcszContext, HRESULT rc, const char *pcszSourceFile, uint32_t ulLine);
+void GlueHandleComError(ComPtr<IUnknown> iface,
+                        const char *pcszContext,
+                        HRESULT rc,
+                        const char *pcszSourceFile,
+                        uint32_t ulLine);
+void GlueHandleComErrorProgress(ComPtr<IProgress> progress,
+                                const char *pcszContext,
+                                HRESULT rc,
+                                const char *pcszSourceFile,
+                                uint32_t ulLine);
 
 /**
@@ -153 +162 @@
     } while (0)
 
+
+/**
+ * Check the progress object for an error and if there is one print out the
+ * extended error information.
+ */
+#define CHECK_PROGRESS_ERROR(progress) \
+    do { \
+        LONG iRc; \
+        rc = progress->COMGETTER(ResultCode)(&iRc); \
+        if (FAILED(iRc)) \
+            com::GlueHandleComErrorProgress(progress, __PRETTY_FUNCTION__, iRc, __FILE__, __LINE__); \
+    } while (0)
+
+/**
+ *  Does the same as CHECK_PROGRESS_ERROR(), but executes the |return ret| statement on
+ *  failure.
+ */
+#define CHECK_PROGRESS_ERROR_RET(progress, ret) \
+    do { \
+        LONG iRc; \
+        rc = progress->COMGETTER(ResultCode)(&iRc); \
+        if (FAILED(iRc)) \
+        { \
+            com::GlueHandleComErrorProgress(progress, __PRETTY_FUNCTION__, iRc, __FILE__, __LINE__); \
+            return (ret); \
+        } \
+    } while (0)
+
 /**
  *  Asserts the given expression is true. When the expression is false, prints

trunk/src/VBox/Main/glue/errorprint.cpp

@@ -30 +30 @@
 {
 
-void GluePrintErrorInfo(com::ErrorInfo &info)
+void GluePrintErrorInfo(const com::ErrorInfo &info)
 {
-    Utf8Str str = Utf8StrFmt("%ls\n"
-                             "Details: code %Rhrc (0x%RX32), component %ls, interface %ls, callee %ls\n"
-                             ,
-                             info.getText().raw(),
-                             info.getResultCode(),
-                             info.getResultCode(),
-                             info.getComponent().raw(),
-                             info.getInterfaceName().raw(),
-                             info.getCalleeName().raw());
+    bool haveResultCode = false;
+#if defined (RT_OS_WIN)
+    haveResultCode = info.isFullAvailable();
+    bool haveComponent = true;
+    bool haveInterfaceID = true;
+#else /* defined (RT_OS_WIN) */
+    haveResultCode = true;
+    bool haveComponent = info.isFullAvailable();
+    bool haveInterfaceID = info.isFullAvailable();
+#endif
+
+    Utf8Str str;
+    RTCList<Utf8Str> comp;
+
+    Bstr bstrDetailsText = info.getText();
+    if (!bstrDetailsText.isEmpty())
+        str = Utf8StrFmt("%ls\n",
+                         bstrDetailsText.raw());
+    if (haveResultCode)
+        comp.append(Utf8StrFmt("code %Rhrc (0x%RX32)",
+                               info.getResultCode(),
+                               info.getResultCode()));
+    if (haveComponent)
+        comp.append(Utf8StrFmt("component %ls",
+                               info.getComponent().raw()));
+    if (haveInterfaceID)
+        comp.append(Utf8StrFmt("interface %ls",
+                               info.getInterfaceName().raw()));
+    if (!info.getCalleeName().isEmpty())
+        comp.append(Utf8StrFmt("callee %ls",
+                               info.getCalleeName().raw()));
+
+    if (comp.size() > 0)
+    {
+        str += "Details: ";
+        for (size_t i = 0; i < comp.size() - 1; ++i)
+            str += comp.at(i) + ", ";
+        str += comp.last();
+        str += "\n";
+    }
+
     // print and log
     RTMsgError("%s", str.c_str());
@@ -52 +84 @@
     Utf8Str strFilename(RTPathFilename(pcszSourceFile));
     Utf8Str str = Utf8StrFmt("Context: \"%s\" at line %d of file %s\n",
-                                pcszContext,
-                                ulLine,
-                                strFilename.c_str());
+                             pcszContext,
+                             ulLine,
+                             strFilename.c_str());
     // print and log
-    RTStrmPrintf(g_pStdErr, "%s", str.c_str());
+    RTMsgError("%s", str.c_str());
     Log(("%s", str.c_str()));
 }
@@ -68 +100 @@
 }
 
+static void glueHandleComErrorInternal(com::ErrorInfo &info,
+                                       const char *pcszContext,
+                                       HRESULT rc,
+                                       const char *pcszSourceFile,
+                                       uint32_t ulLine)
+{
+    const com::ErrorInfo *pInfo = &info;
+    do
+    {
+        if (pInfo->isFullAvailable() || pInfo->isBasicAvailable())
+            GluePrintErrorInfo(*pInfo);
+        else
+#if defined (RT_OS_WIN)
+            GluePrintRCMessage(rc);
+#else /* defined (RT_OS_WIN) */
+            GluePrintRCMessage(pInfo->getResultCode());
+#endif
+        pInfo = pInfo->getNext();
+        /* If there is more than one error, separate them visually. */
+        if (pInfo)
+            RTMsgError("--------\n");
+    }
+    while(pInfo);
+
+    GluePrintErrorContext(pcszContext, pcszSourceFile, ulLine);
+}
+
 void GlueHandleComError(ComPtr<IUnknown> iface,
                         const char *pcszContext,
@@ -74 +133 @@
                         uint32_t ulLine)
 {
-    // if we have full error info, print something nice, and start with the actual error message
+    /* If we have full error info, print something nice, and start with the
+     * actual error message. */
     com::ErrorInfo info(iface, COM_IIDOF(IUnknown));
-    if (info.isFullAvailable() || info.isBasicAvailable())
-        GluePrintErrorInfo(info);
-    else
-        GluePrintRCMessage(rc);
-    GluePrintErrorContext(pcszContext, pcszSourceFile, ulLine);
+
+    glueHandleComErrorInternal(info,
+                               pcszContext,
+                               rc,
+                               pcszSourceFile,
+                               ulLine);
+
 }
 
+void GlueHandleComErrorProgress(ComPtr<IProgress> progress,
+                                const char *pcszContext,
+                                HRESULT rc,
+                                const char *pcszSourceFile,
+                                uint32_t ulLine)
+{
+    /* Get the error info out of the progress object. */
+    ProgressErrorInfo ei(progress);
+
+    glueHandleComErrorInternal(ei,
+                               pcszContext,
+                               rc,
+                               pcszSourceFile,
+                               ulLine);
+}
 
 } /* namespace com */