Changeset 83994 in vbox

Timestamp:

Apr 27, 2020 11:01:30 AM (5 years ago)

Author:

vboxsync

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

137561

Message:

IPRT/string.h: Document status code formatting in IN_RT_STATIC builds and adjusted the formatter to make the best of it.

Location:

trunk

Files:

• include/iprt/string.h (modified) (2 diffs)
• src/VBox/Runtime/common/string/strformatrt.cpp (modified) (3 diffs)

trunk/include/iprt/string.h

@@ -1540 +1540 @@
  *      - \%Rrf             - Takes an integer iprt status code as argument. Will insert the
  *                            full description of the specified status code.
+ *                            Note! Works like \%Rrs when IN_RT_STATIC is defined (so please avoid).
  *      - \%Rra             - Takes an integer iprt status code as argument. Will insert the
  *                            status code define + full description.
+ *                            Note! Reduced output when IN_RT_STATIC is defined (so please avoid).
  *      - \%Rwc             - Takes a long Windows error code as argument. Will insert the status
  *                            code define corresponding to the Windows error code.
  *      - \%Rwf             - Takes a long Windows error code as argument. Will insert the
  *                            full description of the specified status code.
+ *                            Note! Works like \%Rwc when IN_RT_STATIC is defined.
  *      - \%Rwa             - Takes a long Windows error code as argument. Will insert the
  *                            error code define + full description.
+ *                            Note! Reduced output when IN_RT_STATIC is defined (so please avoid).
  *
  *      - \%Rhrc            - Takes a COM/XPCOM status code as argument. Will insert the status
@@ -1553 +1557 @@
  *      - \%Rhrf            - Takes a COM/XPCOM status code as argument. Will insert the
  *                            full description of the specified status code.
+ *                            Note! Works like \%Rhrc when IN_RT_STATIC is
+ *                                  defined on Windows (so please avoid).
  *      - \%Rhra            - Takes a COM/XPCOM error code as argument. Will insert the
  *                            error code define + full description.
+ *                            Note! Reduced output when IN_RT_STATIC is defined on Windows (so please avoid).
  *
  *      - \%Rfn             - Pretty printing of a function or method. It drops the

trunk/src/VBox/Runtime/common/string/strformatrt.cpp

@@ -1031 +1031 @@
                                 return pfnOutput(pvArgOutput, pMsg->pszDefine, strlen(pMsg->pszDefine));
                             case 'f':
-                                return pfnOutput(pvArgOutput, pMsg->pszMsgFull,strlen(pMsg->pszMsgFull));
+# if !defined(RT_OS_WINDOWS) || (!defined(RT_IN_STATIC) && !defined(IPRT_ERRMSG_DEFINES_ONLY))
+                                return pfnOutput(pvArgOutput, pMsg->pszMsgFull, strlen(pMsg->pszMsgFull));
+# else
+                                AssertFailed();
+                                return pfnOutput(pvArgOutput, pMsg->pszDefine, strlen(pMsg->pszDefine));
+# endif
                             case 'a':
+# if !defined(RT_OS_WINDOWS) || (!defined(RT_IN_STATIC) && !defined(IPRT_ERRMSG_DEFINES_ONLY))
                                 return RTStrFormat(pfnOutput, pvArgOutput, NULL, 0, "%s (0x%08X) - %s", pMsg->pszDefine, hrc, pMsg->pszMsgFull);
+# else
+                                AssertFailed();
+                                return RTStrFormat(pfnOutput, pvArgOutput, NULL, 0, "%s (0x%08X)", pMsg->pszDefine, hrc);
+# endif
                             default:
                                 AssertMsgFailed(("Invalid status code format type '%.10s'!\n", pszFormatOrg));
@@ -1184 +1194 @@
                         return pfnOutput(pvArgOutput, pMsg->pszDefine,    strlen(pMsg->pszDefine));
                     case 's':
+# if !defined(IPRT_ERRMSG_DEFINES_ONLY)
                         return pfnOutput(pvArgOutput, pMsg->pszMsgShort,  strlen(pMsg->pszMsgShort));
+# else
+                        return pfnOutput(pvArgOutput, pMsg->pszDefine,    strlen(pMsg->pszDefine));
+# endif
                     case 'f':
+# if !defined(RT_IN_STATIC) && !defined(IPRT_ERRMSG_DEFINES_ONLY)
                         return pfnOutput(pvArgOutput, pMsg->pszMsgFull,   strlen(pMsg->pszMsgFull));
+# else
+                        return pfnOutput(pvArgOutput, pMsg->pszDefine,    strlen(pMsg->pszDefine));
+# endif
                     case 'a':
+# if !defined(RT_IN_STATIC) && !defined(IPRT_ERRMSG_DEFINES_ONLY)
                         return RTStrFormat(pfnOutput, pvArgOutput, NULL, 0, "%s (%d) - %s", pMsg->pszDefine, rc, pMsg->pszMsgFull);
+# elif !defined(IPRT_ERRMSG_DEFINES_ONLY)
+                        return RTStrFormat(pfnOutput, pvArgOutput, NULL, 0, "%s (%d) - %s", pMsg->pszDefine, rc, pMsg->pszMsgShort);
+# else
+                        return RTStrFormat(pfnOutput, pvArgOutput, NULL, 0, "%s (%d)", pMsg->pszDefine, rc);
+# endif
+
                     default:
                         AssertMsgFailed(("Invalid status code format type '%.10s'!\n", pszFormatOrg));
@@ -1225 +1250 @@
                         return pfnOutput(pvArgOutput, pMsg->pszDefine, strlen(pMsg->pszDefine));
                     case 'f':
-                        return pfnOutput(pvArgOutput, pMsg->pszMsgFull,strlen(pMsg->pszMsgFull));
+#  if !defined(RT_IN_STATIC) && !defined(IPRT_ERRMSG_DEFINES_ONLY)
+                        return pfnOutput(pvArgOutput, pMsg->pszMsgFull, strlen(pMsg->pszMsgFull));
+#  else
+                        AssertFailed();
+                        return pfnOutput(pvArgOutput, pMsg->pszDefine, strlen(pMsg->pszDefine));
+#  endif
                     case 'a':
+#  if !defined(RT_IN_STATIC) && !defined(IPRT_ERRMSG_DEFINES_ONLY)
                         return RTStrFormat(pfnOutput, pvArgOutput, NULL, 0, "%s (0x%08X) - %s", pMsg->pszDefine, rc, pMsg->pszMsgFull);
-# else
+#  else
+                        AssertFailed();
+                        return RTStrFormat(pfnOutput, pvArgOutput, NULL, 0, "%s (0x%08X)", pMsg->pszDefine, rc);
+#  endif
+# else  /* !RT_OS_WINDOWS */
                     case 'c':
                     case 'f':
                     case 'a':
                         return RTStrFormat(pfnOutput, pvArgOutput, NULL, 0, "0x%08X", rc);
-# endif
+# endif /* !RT_OS_WINDOWS */
                     default:
                         AssertMsgFailed(("Invalid status code format type '%.10s'!\n", pszFormatOrg));