Changeset 69215 in vbox for trunk/src

Timestamp:

Oct 24, 2017 2:38:50 PM (7 years ago)

Author:

vboxsync

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

118528

Message:

scm: Check for 'Contributed by' preceeding the copyright statement.

Location:

trunk/src/bldprogs

Files:

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

trunk/src/bldprogs/scm.cpp

@@ -79 +79 @@
     SCMOPT_UPDATE_COPYRIGHT_YEAR,
     SCMOPT_NO_UPDATE_COPYRIGHT_YEAR,
+    SCMOPT_EXTERNAL_COPYRIGHT,
+    SCMOPT_NO_EXTERNAL_COPYRIGHT,
     SCMOPT_NO_UPDATE_LICENSE,
     SCMOPT_LICENSE_OSE_GPL,
@@ -161 +163 @@
     /* .fFixTodos = */                              true,
     /* .fUpdateCopyrightYear = */                   false,
+    /* .fExternalCopyright = */                     false,
     /* .enmUpdateLicense = */                       kScmLicense_OseGpl,
     /* .fOnlySvnFiles = */                          false,
@@ -196 +199 @@
     { "--update-copyright-year",            SCMOPT_UPDATE_COPYRIGHT_YEAR,           RTGETOPT_REQ_NOTHING },
     { "--no-update-copyright-year",         SCMOPT_NO_UPDATE_COPYRIGHT_YEAR,        RTGETOPT_REQ_NOTHING },
+    { "--external-copyright",               SCMOPT_EXTERNAL_COPYRIGHT,              RTGETOPT_REQ_NOTHING },
+    { "--no-external-copyright",            SCMOPT_NO_EXTERNAL_COPYRIGHT,           RTGETOPT_REQ_NOTHING },
     { "--no-update-license",                SCMOPT_NO_UPDATE_LICENSE,               RTGETOPT_REQ_NOTHING },
     { "--license-ose-gpl",                  SCMOPT_LICENSE_OSE_GPL,                 RTGETOPT_REQ_NOTHING },
@@ -511 +516 @@
         case SCMOPT_NO_UPDATE_COPYRIGHT_YEAR:
             pSettings->fUpdateCopyrightYear = false;
+            return VINF_SUCCESS;
+
+        case SCMOPT_EXTERNAL_COPYRIGHT:
+            pSettings->fExternalCopyright = true;
+            return VINF_SUCCESS;
+        case SCMOPT_NO_EXTERNAL_COPYRIGHT:
+            pSettings->fExternalCopyright = false;
             return VINF_SUCCESS;
 
@@ -1854 +1866 @@
                 RTPrintf("      Update the copyright year.  Default: %RTbool\n", g_Defaults.fUpdateCopyrightYear);
                 break;
+            case SCMOPT_EXTERNAL_COPYRIGHT:
+                RTPrintf("      Only external copyright holders.  Default: %RTbool\n", g_Defaults.fExternalCopyright);
+                break;
             case SCMOPT_NO_UPDATE_LICENSE:
                 RTPrintf("      License selection.  Default: --license-ose-gpl\n");

trunk/src/bldprogs/scm.h

@@ -258 +258 @@
     /** Update the copyright year. */
     bool            fUpdateCopyrightYear;
+    /** Only external copyright holders. */
+    bool            fExternalCopyright;
     /** How to update the license. */
     SCMLICENSE      enmUpdateLicense;

trunk/src/bldprogs/scmrw.cpp

@@ -77 +77 @@
     /** The comment style (neede for C/C++). */
     SCMCOMMENTSTYLE     enmCommentStyle;        /**< input */
+
+    /** Copy of the contributed-by line if present. */
+    char               *pszContributedBy;
 
     /** @name Common info
@@ -900 +903 @@
 
     /*
-     * Since the license statement is typically prefaced by a copyright line.
+     * Look for a 'contributed by' line, this comes first.
+     */
+    const char *pchContributedBy = NULL;
+    size_t      cchContributedBy = 0;
+    size_t      cBlankLinesAfterContributedBy = 0;
+    if (    pState->pszContributedBy == NULL
+        && (   pState->iLineCopyright == UINT32_MAX
+            || pState->iLineLicense == UINT32_MAX)
+        && cchBody > sizeof("Contributed by")
+        && RTStrNICmp(pszBody, RT_STR_TUPLE("contributed by")) == 0)
+    {
+        const char *pszNextLine = (const char *)memchr(pszBody, '\n', cchBody);
+        if (pszNextLine)
+        {
+            pchContributedBy = pszBody;
+            cchContributedBy = pszNextLine - pszBody;
+
+            /* Skip the copyright line and any blank lines following it. */
+            cchBody -= cchContributedBy + 1;
+            pszBody  = pszNextLine + 1;
+            iLine   += 1;
+            while (*pszBody == '\n')
+            {
+                pszBody++;
+                cchBody--;
+                iLine++;
+                cBlankLinesAfterContributedBy++;
+            }
+        }
+    }
+
+    /*
+     * Look for the copyright line.
      */
     bool     fFoundCopyright = false;
@@ -1037 +1072 @@
             }
 
+            if (pchContributedBy)
+            {
+                pState->pszContributedBy = RTStrDupN(pchContributedBy, cchContributedBy);
+                if (cBlankLinesAfterContributedBy != 1)
+                {
+                    ScmVerbose(pState->pState, 1, "* %u blank lines between contributed by and copyright, should be 1\n",
+                               cBlankLinesAfterContributedBy);
+                    pState->fWellFormedCopyright = false;
+                }
+            }
+
             fFoundCopyright = true;
             ScmVerbose(pState->pState, 2, "oracle copyright %u-%u: up-to-date=%RTbool well-formed=%RTbool\n",
@@ -1061 +1107 @@
 
     /*
-     * Now try match against the license texts if we haven't already found it.
+     * Look for the license text.
      */
     if (pState->iLineLicense == UINT32_MAX)
@@ -1181 +1227 @@
         /*.enmCommentStyle = */         enmCommentStyle,
 
+        /*.pszContributedBy = */        NULL,
+
         /*.iLineComment = */            UINT32_MAX,
         /*.cLinesComment = */           0,
@@ -1228 +1276 @@
         && RT_SUCCESS(pState->rc))
     {
-        if (Info.iLineCopyright == UINT32_MAX)
+        if (pSettings->fExternalCopyright)
+        {
+            if (Info.iLineCopyright != UINT32_MAX)
+                ScmError(pState, VERR_NOT_FOUND,
+                         "Marked as external copyright only, but found non-external copyright statement at line %u!\n",
+                         Info.iLineCopyright + 1);
+        }
+        else if (Info.iLineCopyright == UINT32_MAX)
             ScmError(pState, VERR_NOT_FOUND, "Missing copyright!\n");
         else if (Info.iLineLicense == UINT32_MAX)
@@ -1266 +1321 @@
                         ScmStreamPutLine(pOut, g_aCopyrightCommentStart[enmCommentStyle].psz,
                                          g_aCopyrightCommentStart[enmCommentStyle].cch, enmEol);
+
+                        /* Contributed by someone? */
+                        if (Info.pszContributedBy)
+                        {
+                            ScmStreamWrite(pOut, g_aCopyrightCommentPrefix[enmCommentStyle].psz,
+                                           g_aCopyrightCommentPrefix[enmCommentStyle].cch);
+                            ScmStreamWrite(pOut, Info.pszContributedBy, strlen(Info.pszContributedBy));
+                            ScmStreamPutEol(pOut, enmEol);
+
+                            ScmStreamPutLine(pOut, g_aCopyrightCommentEmpty[enmCommentStyle].psz,
+                                             g_aCopyrightCommentEmpty[enmCommentStyle].cch, enmEol);
+                        }
 
                         /* Write the copyright comment line. */
@@ -1327 +1394 @@
                     }
                     if (RT_FAILURE(rc))
+                    {
+                        RTStrFree(Info.pszContributedBy);
                         return false;
-                }
+                    }
+                } /* for each source line */
+
+                RTStrFree(Info.pszContributedBy);
                 return true;
             }
@@ -1336 +1408 @@
         ScmError(pState, rc,  "ScmEnumerateComments: %Rrc\n", rc);
     NOREF(pState); NOREF(pOut);
+    RTStrFree(Info.pszContributedBy);
     return false;
 }