STYLE: tabs and line length in files, very dubious NULL in ensight reader.

- disable automatically upgrading copyrights in files since changes to
  not automatically imply a change in copyright. Eg, fixing a typo in
  comments, or changing a variable from 'loopI' to 'loopi' etc.

applications/utilities/mesh/advanced/snappyRefineMesh/snappyRefineMesh.C

@@ -651,7 +651,7 @@ int main(int argc, char *argv[])
     );
 
     // corrector for mesh motion
-    twoDPointCorrector* correct2DPtr = NULL;
+    twoDPointCorrector* correct2DPtr = nullptr;
 
     if (motionObj.typeHeaderOk<IOdictionary>(true))
     {

applications/utilities/postProcessing/graphics/ensightFoamReader/USERD_set_filenames.H

@@ -28,7 +28,7 @@ int USERD_set_filenames
         // remove the last '/' from rootDir
         if (the_path[lRoot-1] == '/')
         {
-            the_path[lRoot-1] = char(NULL);
+            the_path[lRoot-1] = '\0';
         }
         else
         {

bin/tools/pre-commit-hook

@@ -62,6 +62,14 @@ die()
     exit 1
 }
 
+# Automatically upgrade copyrights in files.
+# Disabled by default since some changes (eg, spelling) do not automatically
+# imply an update copyright.
+optCopyright=false
+
+# Run all tests (do not exit on first failure)
+optAll=false
+
 #-----------------------------------------------------------------------------
 # Check content that will be added by this commit.
 
@@ -76,11 +84,27 @@ fi
 # called manually with arguments for the files/directories to be tested?
 if [ "$#" -gt 0 ]
 then
+    while [ "$#" -gt 0 ]
+    do
         case "$1" in
         -h | -help)
             die "interactive usage: supply list of files/directories to check"
             ;;
+        -copy)
+            echo "$hookName: adjust copyright enabled" 1>&2
+            optCopyright=true
+            shift
+            ;;
+        -all)
+            echo "$hookName: do all tests (no premature exit)" 1>&2
+            optAll=true
+            shift
+            ;;
+        *)
+            break
+            ;;
         esac
+    done
 
     # obtain list of all specified files/directories
     fileList=$(git ls-files -- $@ 2>/dev/null)
@@ -100,6 +124,8 @@ unset badFiles
 # join list of files with this amount of space
 Indent="    "
 
+exitCode=0
+
 #
 # report bad files and die if there are any
 #
@@ -114,7 +140,14 @@ dieOnBadFiles()
         echo "File(s):" 1>&2
         echo "$badFiles" 1>&2
         echo ''  1>&2
-        exit 1
+
+        exitCode=1
+        if [ "$optAll" = true ]
+        then
+            return 0   # Continue to the next test
+        else
+            exit $exitCode
+        fi
     fi
 }
 
@@ -314,7 +347,7 @@ MESSAGE
 
 
 #
-# check that OpenFOAM Foundation copyright is current
+# check that copyright date is current
 #
 checkCopyright()
 {
@@ -327,9 +360,9 @@ checkCopyright()
         startYear=`grep "Copyright.*OpenCFD" $f | sed 's/[^0-9]*\([0-9]*\).*/\1/g'`
         endYear=`grep "Copyright.*-.*OpenCFD" $f | sed 's/[^-]*-\([0-9]*\).*/\1/g'`
         #echo "startYear=$startYear endYear=$endYear"
-        if [ "$startYear" != "" ]
+        if [ -n "$startYear" ]
         then
-            if [ "$endYear" != "" ]
+            if [ -n "$endYear" ]
             then
                 # Date is of type 2011-2012 OpenCFD Ltd.
                 if [ "$year" != "$endYear" ]
@@ -371,7 +404,11 @@ checkLineLengthNonDirective
 # check for non-standard code patterns
 checkNonStandardCodePatterns
 
-checkCopyright
+# Stop now if there were any errors
+[ "$exitCode" = 0 ] || exit $exitCode
+
+# check copyright date (normally disabled)
+[ "$optCopyright" = true ] && checkCopyright
 
 exit 0
 #------------------------------------------------------------------------------

src/OSspecific/POSIX/POSIX.C

@@ -1284,7 +1284,7 @@ int Foam::system(const Foam::UList<Foam::string>& command)
     {
         // in child:
         // Need command and arguments separately.
-        // args is a NULL-terminated list of c-strings
+        // args is a nullptr-terminated list of c-strings
 
         CStringList args(SubList<string>(command, 0));
         if (argc > 1)

src/OSspecific/POSIX/endianI.H

@@ -97,10 +97,11 @@ inline uint64_t Foam::endian::swap64(uint64_t u)
     );
 
     // alternative formulation
-    //
+    /*
-    // u = ((u<< 8) & 0xFF00FF00FF00FF00ull) | ((u>> 8) & 0x00FF00FF00FF00FFull);
+     u = ((u<< 8) & 0xFF00FF00FF00FF00ull) | ((u>> 8) & 0x00FF00FF00FF00FFull);
-    // u = ((u<<16) & 0xFFFF0000FFFF0000ull) | ((u>>16) & 0x0000FFFF0000FFFFull);
+     u = ((u<<16) & 0xFFFF0000FFFF0000ull) | ((u>>16) & 0x0000FFFF0000FFFFull);
-    // return (u >> 32) | (u << 32);
+     return (u >> 32) | (u << 32);
+    */
 #endif
 }
 

src/OpenFOAM/primitives/strings/lists/CStringList.H

@@ -73,7 +73,7 @@ class CStringList
         //  Does not include the final nul-character
         size_t len_;
 
-        //- List of strings, including trailing NULL pointer
+        //- List of strings, including trailing nullptr
         char** argv_;
 
         //- Flattened content with interspersed nul-characters
@@ -109,8 +109,8 @@ public:
 
     // Public Members
 
-        //- Count the number of parameters until the first NULL pointer.
+        //- Count the number of parameters until the first nullptr
-        //  Return 0 if argv is NULL.
+        //  Return 0 if argv is nullptr.
         static inline int count(const char * const argv[]);
 
 
@@ -120,7 +120,7 @@ public:
         inline int size() const;
 
         //- Return the list of C-strings (ie, argv)
-        //  The position at argc is a NULL pointer
+        //  The position at argc is a nullptr
         inline char** strings() const;
 
 
@@ -148,8 +148,8 @@ public:
         template<class StringType>
         static List<StringType> asList(int argc, const char * const argv[]);
 
-        //- Create a list from a NULL-terminated list of argv parameters.
+        //- Create a list from a nullptr-terminated list of argv parameters.
-        //  A null pointer for argv is permissible.
+        //  Using a nullptr for argv is permissible.
         template<class StringType>
         static inline List<StringType> asList(const char * const argv[]);
 

src/conversion/ccm/common/ccmBase.C

@@ -85,10 +85,10 @@ bool Foam::ccm::base::close()
     {
         if (CCMIOIsValidEntity(globalState_->root))
         {
-            CCMIOCloseFile(NULL, globalState_->root);
+            CCMIOCloseFile(nullptr, globalState_->root);
         }
         delete globalState_;
-        globalState_ = 0;
+        globalState_ = nullptr;
 
         return true;
     }

src/conversion/ccm/reader/ccmReaderSolution.C

@@ -52,7 +52,7 @@ void Foam::ccm::reader::determineFieldInfo
     (
         CCMIONextEntity
         (
-            NULL,
+            nullptr,
             fieldSetNode,
             kCCMIOFieldPhase,
             &phaseI,
@@ -74,7 +74,7 @@ void Foam::ccm::reader::determineFieldInfo
         (
             CCMIONextEntity
             (
-                NULL,
+                nullptr,
                 phaseNode,
                 kCCMIOField,
                 &fieldI,
@@ -84,12 +84,12 @@ void Foam::ccm::reader::determineFieldInfo
 
          && CCMIOReadField
             (
-                NULL,
+                nullptr,
                 fieldNode,
                 fullName,
                 shortName,
                 &dims,
-                NULL
+                nullptr
             )
          == kCCMIONoErr
         )
@@ -139,7 +139,7 @@ void Foam::ccm::reader::determineFieldInfo
                 (
                     CCMIONextEntity
                     (
-                        NULL,
+                        nullptr,
                         fieldNode,
                         kCCMIOFieldData,
                         &dataI,
@@ -149,20 +149,20 @@ void Foam::ccm::reader::determineFieldInfo
 
                  && CCMIOEntitySize
                     (
-                        NULL,
+                        nullptr,
                         dataNode,
-                        NULL,
+                        nullptr,
                         &maxId
                     )
                  == kCCMIONoErr
 
                  && CCMIOReadFieldDatad
                     (
-                        NULL,
+                        nullptr,
                         dataNode,
-                        NULL,
+                        nullptr,
                         &dataLocation,
-                        NULL,
+                        nullptr,
                         kCCMIOStart,
                         kCCMIOEnd
                     )
@@ -212,7 +212,7 @@ bool Foam::ccm::reader::detectSolution()
     (
         CCMIONextEntity
         (
-            NULL,
+            nullptr,
             (globalState_->root),
             kCCMIOState,
             &stateI,
@@ -230,7 +230,7 @@ bool Foam::ccm::reader::detectSolution()
         (
             CCMIONextEntity
             (
-                NULL,
+                nullptr,
                 stateNode,
                 kCCMIOProcessor,
                 &procI,
@@ -240,11 +240,11 @@ bool Foam::ccm::reader::detectSolution()
 
          && CCMIOReadProcessor
             (
-                NULL,
+                nullptr,
                 processorNode,
-                NULL,           // Ignore verticesNode
+                nullptr,        // Ignore verticesNode
-                NULL,           // Ignore topologyNode
+                nullptr,        // Ignore topologyNode
-                NULL,           // Ignore initialField
+                nullptr,        // Ignore initialField
                 &solutionNode
             )
          == kCCMIONoErr
@@ -263,7 +263,7 @@ bool Foam::ccm::reader::detectSolution()
             (
                 CCMIONextEntity
                 (
-                    NULL,
+                    nullptr,
                     solutionNode,
                     kCCMIORestart,
                     &restartI,
@@ -273,7 +273,7 @@ bool Foam::ccm::reader::detectSolution()
 
              && CCMIOEntityName
                 (
-                    NULL,
+                    nullptr,
                     stateNode,
                     solutionName
                 )
@@ -281,13 +281,13 @@ bool Foam::ccm::reader::detectSolution()
 
              && CCMIOReadRestartInfo
                 (
-                    NULL,
+                    nullptr,
                     restartNode,
-                    NULL,          // Ignore solverName
+                    nullptr,       // Ignore solverName
                     &iteration,
                     &timeValue,
-                    NULL,          // Ignore timeUnits
+                    nullptr,       // Ignore timeUnits
-                    NULL           // Ignore startAngle
+                    nullptr        // Ignore startAngle
                 )
              == kCCMIONoErr
             )
@@ -310,7 +310,7 @@ bool Foam::ccm::reader::detectSolution()
             (
                 CCMIONextEntity
                 (
-                    NULL,
+                    nullptr,
                     processorNode,
                     kCCMIOLagrangianData,
                     &lagrangianI,
@@ -320,9 +320,9 @@ bool Foam::ccm::reader::detectSolution()
 
              && CCMIOReadLagrangianData
                 (
-                    NULL,
+                    nullptr,
                     lagrangianNode,
-                    NULL,
+                    nullptr,
                     &lagrangianSolutions
                 )
              == kCCMIONoErr
@@ -366,10 +366,10 @@ Foam::ccm::reader::readField
     (
         CCMIOGetState
         (
-            NULL,
+            nullptr,
             (globalState_->root),
             solutionName.c_str(),
-            NULL,
+            nullptr,
             &stateNode
         )
      != kCCMIONoErr
@@ -420,7 +420,7 @@ Foam::ccm::reader::readField
     (
         CCMIONextEntity
         (
-            NULL,
+            nullptr,
             stateNode,
             kCCMIOProcessor,
             &procI,
@@ -430,11 +430,11 @@ Foam::ccm::reader::readField
 
     && CCMIOReadProcessor
         (
-            NULL,
+            nullptr,
             processorNode,
-            NULL,           // Ignore verticesNode
+            nullptr,        // Ignore verticesNode
-            NULL,           // Ignore topologyNode
+            nullptr,        // Ignore topologyNode
-            NULL,           // Ignore initialField
+            nullptr,        // Ignore initialField
             &solutionNode
         )
      == kCCMIONoErr
@@ -448,7 +448,7 @@ Foam::ccm::reader::readField
         (
             CCMIONextEntity
             (
-                NULL,
+                nullptr,
                 solutionNode,
                 kCCMIOFieldPhase,
                 &phaseI,
@@ -465,7 +465,7 @@ Foam::ccm::reader::readField
             (
                 CCMIONextEntity
                 (
-                    NULL,
+                    nullptr,
                     phaseNode,
                     kCCMIOField,
                     &fieldI,
@@ -480,10 +480,10 @@ Foam::ccm::reader::readField
                 (
                     &(globalState_->error),
                     fieldNode,
-                    NULL,
+                    nullptr,
                     shortName,
                     &dims,
-                    NULL
+                    nullptr
                 );
                 assertNoError
                 (
@@ -501,7 +501,7 @@ Foam::ccm::reader::readField
                     (
                         CCMIONextEntity
                         (
-                            NULL,
+                            nullptr,
                             fieldNode,
                             kCCMIOFieldData,
                             &dataI,
@@ -518,20 +518,20 @@ Foam::ccm::reader::readField
                         (
                             CCMIOEntitySize
                             (
-                                NULL,
+                                nullptr,
                                 dataNode,
                                 &n,
-                                NULL
+                                nullptr
                             )
                          == kCCMIONoErr
 
                          && CCMIOReadFieldDatad
                             (
-                                NULL,
+                                nullptr,
                                 dataNode,
                                 &mapId,
                                 &dataLocation,
-                                NULL,
+                                nullptr,
                                 kCCMIOStart,
                                 kCCMIOEnd
                             )
@@ -549,10 +549,10 @@ Foam::ccm::reader::readField
                             (
                                 CCMIOEntityDescription
                                 (
-                                    NULL,
+                                    nullptr,
                                     dataNode,
                                     &len,
-                                    NULL
+                                    nullptr
                                 )
                              == kCCMIONoErr
                             )
@@ -563,7 +563,7 @@ Foam::ccm::reader::readField
                                 (
                                     CCMIOEntityDescription
                                     (
-                                        NULL,
+                                        nullptr,
                                         dataNode,
                                         &len,
                                         dataLabel
@@ -577,7 +577,7 @@ Foam::ccm::reader::readField
                                             strstr(fieldName.c_str(), "SIG")
                                          || strstr(fieldName.c_str(), "EPS")
                                         )
-                                     && strstr(dataLabel,  "So") == NULL
+                                     && strstr(dataLabel,  "So") == nullptr
                                     )
                                     {
                                         okayCombination = false;
@@ -607,8 +607,8 @@ Foam::ccm::reader::readField
                             (
                                 &(globalState_->error),
                                 dataNode,
-                                NULL,
+                                nullptr,
-                                NULL,
+                                nullptr,
                                 rawData.begin(),
                                 kCCMIOStart,
                                 kCCMIOEnd

src/functionObjects/utilities/ensightWrite/ensightWrite.H

@@ -72,6 +72,11 @@ Description
     patches and suppress writing the internalMesh.
     Consecutive output numbering can be used in conjunction with \c overwrite.
 
+See also
+    Foam::functionObjects::vtkWrite
+    Foam::functionObjects::fvMeshFunctionObject
+    Foam::functionObjects::timeControl
+
 SourceFiles
     ensightWrite.C
     ensightWriteTemplates.C

src/functionObjects/utilities/vtkWrite/vtkWrite.H

@@ -62,6 +62,7 @@ Usage
     \endtable
 
 See also
+    Foam::functionObjects::ensightWrite
     Foam::functionObjects::fvMeshFunctionObject
     Foam::functionObjects::timeControl
 

src/waveModels/waveGenerationModels/derived/Grimshaw/GrimshawWaveModel.C

@@ -72,7 +72,8 @@ Foam::scalar Foam::waveModels::Grimshaw::eta
     const scalar eps2 = eps*eps;
     const scalar eps3 = eps*eps2;
 
-    const scalar C = sqrt(mag(g_)*h)*sqrt(1.0 + eps - 0.05*eps2 - (3.0/70.0)*eps3);
+    const scalar C =
+        sqrt(mag(g_)*h)*sqrt(1.0 + eps - 0.05*eps2 - (3.0/70.0)*eps3);
 
     const scalar ts = 3.5*h/sqrt(H/h);
     const scalar xa = -C*t + ts - X0 + x*cos(theta) + y*sin(theta);
@@ -109,7 +110,8 @@ Foam::vector Foam::waveModels::Grimshaw::Uf
     const scalar eps2 = eps*eps;
     const scalar eps3 = eps*eps2;
 
-    const scalar C = sqrt(mag(g_)*h)*sqrt(1.0 + eps - 0.05*eps2 - (3.0/70.0)*eps3);
+    const scalar C =
+        sqrt(mag(g_)*h)*sqrt(1.0 + eps - 0.05*eps2 - (3.0/70.0)*eps3);
 
     const scalar ts = 3.5*h/sqrt(eps);
     const scalar xa = -C*t + ts - X0 + x*cos(theta) + y*sin(theta);

src/waveModels/waveGenerationModels/derived/StokesV/StokesVWaveModel.C

@@ -615,7 +615,11 @@ void Foam::waveModels::StokesV::initialise
 
         f1 = pi*H/d - 2*pi/(k*d)*(lambda + l3*b33 + l5*(b35 + b55));
 
-        f2 = (2*pi*d)/(mag(g_)*sqr(T)) - k*d/(2*pi)*tanh(k*d)*(1 + l2*c1 + l4*c2);
+        f2 =
+        (
+            (2*pi*d)/(mag(g_)*sqr(T))
+          - k*d/(2*pi)*tanh(k*d)*(1 + l2*c1 + l4*c2)
+        );
 
         const scalar lambdaPr =
             (f1*Bmat21 - f2*Bmat11)/(Bmat11*Bmat22 - Bmat12*Bmat21);