Changeset 58096 in vbox for trunk/include/VBox/com

Timestamp:

Oct 7, 2015 2:05:32 PM (10 years ago)

Author:

vboxsync

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

103170

Message:

com/assert.h: Cleanups.

File:

• trunk/include/VBox/com/assert.h (modified) (6 diffs)

trunk/include/VBox/com/assert.h

@@ -33 +33 @@
  *  In non-strict builds the result code will be NOREF'ed to kill compiler warnings.
  *
- *  @param rc   COM result code
+ *  @param hrc      The COM result code
  */
-#define AssertComRC(rc)      \
-    do { AssertMsg (SUCCEEDED (rc), ("COM RC = %Rhrc (0x%08X)\n", rc, rc)); NOREF (rc); } while (0)
+#define AssertComRC(hrc) \
+    do { AssertMsg(SUCCEEDED(hrc), ("COM RC = %Rhrc (0x%08X)\n", hrc, hrc)); NOREF(hrc); } while (0)
+
+/**
+ *  Same as AssertComRC, except the caller already knows we failed.
+ *
+ *  @param hrc      The COM result code
+ */
+#define AssertComRCFailed(hrc) \
+    do { AssertMsgFailed(("COM RC = %Rhrc (0x%08X)\n", hrc, hrc)); NOREF(hrc); } while (0)
 
 /**
@@ -42 +50 @@
  *  if the result code is failed.
  *
- *  @param rc   COM result code
- *  @param ret  the expression to return
+ *  @param hrc      The COM result code
+ *  @param RetExpr  The expression to return
  */
-#define AssertComRCReturn(rc, ret)      \
-    AssertMsgReturn (SUCCEEDED (rc), ("COM RC = %Rhrc (0x%08X)\n", rc, rc), ret)
+#define AssertComRCReturn(hrc, RetExpr) \
+    AssertMsgReturn(SUCCEEDED(hrc), ("COM RC = %Rhrc (0x%08X)\n", hrc, hrc), RetExpr)
 
 /**
@@ -52 +60 @@
  *  if it is failed.
  *
- *  @param rc   COM result code
- *  @param ret  the expression to return
+ *  @param hrc      The COM result code
  */
-#define AssertComRCReturnRC(rc)         \
-    AssertMsgReturn (SUCCEEDED (rc), ("COM RC = %Rhrc (0x%08X)\n", rc, rc), rc)
+#define AssertComRCReturnRC(hrc) \
+    AssertMsgReturn(SUCCEEDED(hrc), ("COM RC = %Rhrc (0x%08X)\n", hrc, hrc), hrc)
 
 /**
  *  A special version of AssertComRC that returns if the result code is failed.
  *
- *  @param rc   COM result code
- *  @param ret  the expression to return
+ *  @param hrc      The COM result code
  */
-#define AssertComRCReturnVoid(rc)      \
-    AssertMsgReturnVoid (SUCCEEDED (rc), ("COM RC = %Rhrc (0x%08X)\n", rc, rc))
+#define AssertComRCReturnVoid(hrc) \
+    AssertMsgReturnVoid(SUCCEEDED(hrc), ("COM RC = %Rhrc (0x%08X)\n", hrc, hrc))
 
 /**
@@ -71 +77 @@
  *  breaks if the result code is failed.
  *
- *  @param rc   COM result code
- *  @param eval the expression to evaluate
+ *  @param hrc          The COM result code
+ *  @param PreBreakExpr The expression to evaluate on failure.
  */
-#define AssertComRCBreak(rc, eval)      \
-    if (!SUCCEEDED (rc)) { AssertComRC (rc); eval; break; } else do {} while (0)
+#define AssertComRCBreak(hrc, PreBreakExpr) \
+    if (!SUCCEEDED(hrc)) { AssertMsgFailed(hrc); PreBreakExpr; break; } else do {} while (0)
 
 /**
@@ -81 +87 @@
  *  throws it if the result code is failed.
  *
- *  @param rc   COM result code
- *  @param eval the expression to throw
+ *  @param hrc          The COM result code
+ *  @param ThrowMeExpr  The expression which result to be thrown on failure.
  */
-#define AssertComRCThrow(rc, eval)      \
-    if (!SUCCEEDED (rc)) { AssertComRC (rc); throw (eval); } else do {} while (0)
+#define AssertComRCThrow(hrc, ThrowObjExpr) \
+    do { if (SUCCEEDED(hrc)) { /*likely*/} else { AssertMsgFailed(hrc); throw (ThrowMeExpr); } } while (0)
 
 /**
@@ -91 +97 @@
  *  failed.
  *
- *  @param rc   COM result code
+ *  @param hrc      The COM result code
  */
-#define AssertComRCBreakRC(rc)          \
-    if (!SUCCEEDED (rc)) { AssertComRC (rc); break; } else do {} while (0)
+#define AssertComRCBreakRC(hrc) \
+    if (!SUCCEEDED(hrc)) { AssertMsgFailed(hrc); break; } else do {} while (0)
 
 /**
- *  A special version of AssertComRC that just throws @a rc if the result code is
- *  failed.
+ *  A special version of AssertComRC that just throws @a hrc if the result code
+ *  is failed.
  *
- *  @param rc   COM result code
+ *  @param hrc      The COM result code
  */
-#define AssertComRCThrowRC(rc)          \
-    if (!SUCCEEDED (rc)) { AssertComRC (rc); throw rc; } else do {} while (0)
+#define AssertComRCThrowRC(hrc) \
+    do { if (SUCCEEDED(hrc)) { /*likely*/ } else { AssertMsgFailed(hrc); throw hrc; } } while (0)
 
 #endif // !___VBox_com_assert_h