ENH: Add RecurseThroughSymlinks data member to kwsys::Glob. Allows recursive...

ENH: Add RecurseThroughSymlinks data member to kwsys::Glob. Allows recursive globs to skip symlinks when necessary. Default to true for backwards compatible behavior. Used from the ctest coverage handler to avoid recursing through the '/Applications' directory on the Mac looking for *.da files... Should fix the hangs reported recently by Mac CMake dashboard submitters.

Glob.cxx

@@ -63,6 +63,10 @@ Glob::Glob()
   this->Internals = new GlobInternals;
   this->Recurse = false;
   this->Relative = "";
+
+  this->RecurseThroughSymlinks = true;
+    // RecurseThroughSymlinks is true by default for backwards compatibility,
+    // not because it's a good idea...
 }
 
 //----------------------------------------------------------------------------
@@ -262,7 +266,11 @@ void Glob::RecurseDirectory(kwsys_stl::string::size_type start,
       }
     if ( kwsys::SystemTools::FileIsDirectory(realname.c_str()) )
       {
-      this->RecurseDirectory(start+1, realname, dir_only);
+      if (!kwsys::SystemTools::FileIsSymlink(realname.c_str()) ||
+        this->RecurseThroughSymlinks)
+        {
+        this->RecurseDirectory(start+1, realname, dir_only);
+        }
       }
     }
 }

Glob.hxx.in

@@ -57,6 +57,13 @@ public:
   void SetRecurse(bool i) { this->Recurse = i; }
   bool GetRecurse() { return this->Recurse; }
 
+  //! Set recurse through symlinks to true if recursion should traverse the
+  // linked-to directories
+  void RecurseThroughSymlinksOn() { this->SetRecurseThroughSymlinks(true); }
+  void RecurseThroughSymlinksOff() { this->SetRecurseThroughSymlinks(false); }
+  void SetRecurseThroughSymlinks(bool i) { this->RecurseThroughSymlinks = i; }
+  bool GetRecurseThroughSymlinks() { return this->RecurseThroughSymlinks; }
+
   //! Set relative to true to only show relative path to files.
   void SetRelative(const char* dir);
   const char* GetRelative();
@@ -90,6 +97,7 @@ protected:
   GlobInternals* Internals;
   bool Recurse;
   kwsys_stl::string Relative;
+  bool RecurseThroughSymlinks;
 
 private:
   Glob(const Glob&);  // Not implemented.