Changeset 94905 in vbox

Timestamp:

May 7, 2022 4:10:49 PM (3 years ago)

Author:

vboxsync

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

151312

Message:

scm: Introduce a check to force the use of either hrc for COM status codes or vrc for IPRT ones instead of using rc for both causing confusion when to use which, bugref:10223

Location:

trunk/src/bldprogs

Files:

• scm.cpp (modified) (9 diffs)
• scm.h (modified) (2 diffs)
• scmrw.cpp (modified) (1 diff)

trunk/src/bldprogs/scm.cpp

@@ -93 +93 @@
     SCMOPT_UNRESTRICTED_ASM_MEM_PAGE_USE,
     SCMOPT_NO_PAGE_RESTRICTIONS,
+    SCMOPT_NO_RC_USE,
+    SCMOPT_UNRESTRICTED_RC_USE,
     SCMOPT_UPDATE_COPYRIGHT_YEAR,
     SCMOPT_NO_UPDATE_COPYRIGHT_YEAR,
@@ -202 +204 @@
     /* .fOnlyGuestHostPage = */                     false,
     /* .fNoASMMemPageUse = */                       false,
+    /* .fOnlyHrcVrcInsteadOfRc */                   false,
     /* .fUpdateCopyrightYear = */                   false,
     /* .fExternalCopyright = */                     false,
@@ -259 +262 @@
     { "--no-ASMMemPage-use",                SCMOPT_NO_ASM_MEM_PAGE_USE,             RTGETOPT_REQ_NOTHING },
     { "--unrestricted-ASMMemPage-use",      SCMOPT_UNRESTRICTED_ASM_MEM_PAGE_USE,   RTGETOPT_REQ_NOTHING },
+    { "--no-rc-use",                        SCMOPT_NO_RC_USE,                       RTGETOPT_REQ_NOTHING },
+    { "--unrestricted-rc-use",              SCMOPT_UNRESTRICTED_RC_USE,             RTGETOPT_REQ_NOTHING },
     { "--update-copyright-year",            SCMOPT_UPDATE_COPYRIGHT_YEAR,           RTGETOPT_REQ_NOTHING },
     { "--no-update-copyright-year",         SCMOPT_NO_UPDATE_COPYRIGHT_YEAR,        RTGETOPT_REQ_NOTHING },
@@ -323 +328 @@
 SCM_REWRITER_CFG(g_UnicodeChecks,                   "unicode-checks",               rewrite_UnicodeChecks);
 SCM_REWRITER_CFG(g_PageChecks,                      "page-checks",                  rewrite_PageChecks);
+SCM_REWRITER_CFG(g_ForceHrcVrcInsteadOfRc,          "force-hrc-vrc-no-rc",          rewrite_ForceHrcVrcInsteadOfRc);
 SCM_REWRITER_CFG(g_Copyright_CstyleComment,         "copyright-c-style",            rewrite_Copyright_CstyleComment);
 SCM_REWRITER_CFG(g_Copyright_HashComment,           "copyright-hash-style",         rewrite_Copyright_HashComment);
@@ -368 +374 @@
     &g_UnicodeChecks,
     &g_PageChecks,
+    &g_ForceHrcVrcInsteadOfRc,
     &g_C_and_CPP,
 };
@@ -416 +423 @@
     &g_UnicodeChecks,
     &g_PageChecks,
+    &g_ForceHrcVrcInsteadOfRc,
     &g_Copyright_CstyleComment,
     &g_FixFlowerBoxMarkers,
@@ -434 +442 @@
     &g_UnicodeChecks,
     &g_PageChecks,
+    &g_ForceHrcVrcInsteadOfRc,
     &g_Copyright_CstyleComment,
     /// @todo &g_FixFlowerBoxMarkers,
@@ -1196 +1205 @@
         case SCMOPT_UNRESTRICTED_ASM_MEM_PAGE_USE:
             pSettings->fNoASMMemPageUse = false;
+            return VINF_SUCCESS;
+
+        case SCMOPT_NO_RC_USE:
+            pSettings->fOnlyHrcVrcInsteadOfRc = true;
+            return VINF_SUCCESS;
+        case SCMOPT_UNRESTRICTED_RC_USE:
+            pSettings->fOnlyHrcVrcInsteadOfRc = false;
             return VINF_SUCCESS;
 
@@ -2928 +2944 @@
                          g_Defaults.fNoASMMemPageUse);
                 break;
+            case SCMOPT_NO_RC_USE:
+                RTPrintf("      No rc declaration allowed, must instead use\n"
+                         "      vrc for IPRT status codes and hrc for COM status codes.  Default: %RTbool\n",
+                         g_Defaults.fOnlyHrcVrcInsteadOfRc);
+                break;
             case SCMOPT_UPDATE_COPYRIGHT_YEAR:
                 RTPrintf("      Update the copyright year.  Default: %RTbool\n", g_Defaults.fUpdateCopyrightYear);

trunk/src/bldprogs/scm.h

@@ -254 +254 @@
 FNSCMREWRITER rewrite_UnicodeChecks;
 FNSCMREWRITER rewrite_PageChecks;
+FNSCMREWRITER rewrite_ForceHrcVrcInsteadOfRc;
 FNSCMREWRITER rewrite_Copyright_CstyleComment;
 FNSCMREWRITER rewrite_Copyright_HashComment;
@@ -361 +362 @@
     /** No ASMMemIsZeroPage or ASMMemZeroPage calls allowed (C/C++). */
     bool            fNoASMMemPageUse;
+    /** No rc declarations allowed, only hrc or vrc depending on the result type. */
+    bool            fOnlyHrcVrcInsteadOfRc;
 
     /** Update the copyright year. */

trunk/src/bldprogs/scmrw.cpp

@@ -3334 +3334 @@
 
 /**
+ * Checks for usage of rc in code instead of vrc for IPRT status codes (int) and hrc for COM
+ * status codes (HRESULT).
+ *
+ * @returns true if modifications were made, false if not.
+ * @param   pIn                 The input stream.
+ * @param   pOut                The output stream.
+ * @param   pSettings           The settings.
+ *
+ * @note Used in Main to avoid ambiguity when just using rc.
+ */
+bool rewrite_ForceHrcVrcInsteadOfRc(PSCMRWSTATE pState, PSCMSTREAM pIn, PSCMSTREAM pOut, PCSCMSETTINGSBASE pSettings)
+{
+    RT_NOREF(pOut);
+    if (!pSettings->fOnlyHrcVrcInsteadOfRc)
+        return false;
+
+    static const SCMMATCHWORD s_aHresultVrc[] =
+    {
+        { RT_STR_TUPLE("HRESULT"),                  0, true, false },
+        { RT_STR_TUPLE("vrc"),                      1, true, false }
+    };
+
+    static const SCMMATCHWORD s_aIntHrc[] =
+    {
+        { RT_STR_TUPLE("int"),                      0, true, false },
+        { RT_STR_TUPLE("hrc"),                      1, true, false }
+    };
+
+    uint32_t        iLine = 0;
+    SCMEOL          enmEol;
+    size_t          cchLine;
+    const char      *pchLine;
+    RTERRINFOSTATIC ErrInfo;
+    while ((pchLine = ScmStreamGetLine(pIn, &cchLine, &enmEol)) != NULL)
+    {
+        iLine++;
+
+        /* Look for forbidden declarations first. */
+        size_t offNext = 0;
+        int rc = ScmMatchWords(pchLine, cchLine, s_aHresultVrc, RT_ELEMENTS(s_aHresultVrc),
+                               &offNext, NULL /*paIdentifiers*/, RTErrInfoInitStatic(&ErrInfo));
+        if (RT_SUCCESS(rc))
+        {
+            ScmFixManually(pState, "%u:%zu: 'HRESULT vrc' is not allowed! Use 'HRESULT hrc' instead.\n",
+                           iLine, offNext);
+            continue;
+        }
+
+        rc = ScmMatchWords(pchLine, cchLine, s_aIntHrc, RT_ELEMENTS(s_aIntHrc),
+                           &offNext, NULL /*paIdentifiers*/, RTErrInfoInitStatic(&ErrInfo));
+        if (RT_SUCCESS(rc))
+        {
+            ScmFixManually(pState, "%u:%zu: 'int hrc' is not allowed! Use 'int vrc' instead.\n",
+                           iLine, offNext);
+            continue;
+        }
+
+        const RTSTRTUPLE RcTuple = { RT_STR_TUPLE("rc") };
+        size_t const cchWord = RcTuple.cch;
+        if (cchLine >= cchWord)
+        {
+            const char        *pchHit  = (const char *)memchr(pchLine, *RcTuple.psz, cchLine);
+            while (pchHit)
+            {
+                size_t cchLeft = (uintptr_t)&pchLine[cchLine] - (uintptr_t)pchHit;
+                if (   cchLeft >= cchWord
+                    && memcmp(pchHit, RcTuple.psz, cchWord) == 0
+                    && (   pchHit == pchLine
+                        || !ScmIsCIdentifierChar(pchHit[-1]))
+                    && (   cchLeft == cchWord
+                        || !ScmIsCIdentifierChar(pchHit[cchWord])) )
+                    ScmFixManually(pState, "%u:%zu: %s is not allowed! Use hrc or vrc instead.\n",
+                                   iLine, pchHit - pchLine + 1, RcTuple.psz);
+
+                /* next */
+                cchLeft -= 1;
+                if (cchLeft < cchWord)
+                    break;
+                pchHit = (const char *)memchr(pchHit + 1, *RcTuple.psz, cchLeft);
+            }
+        }
+    }
+
+    return false;
+}
+
+
+/**
  * Rewrite a C/C++ source or header file.
  *