Encapsulate search path manipulation functions into a seperate class.

The functions for adding the various different types of paths have been
factored out into a new class, cmSearchPath.  It is to be used as a helper
container class for the various find_* commands.

1 files changed, 243 insertions, 0 deletions

diff --git a/Source/cmSearchPath.cxx b/Source/cmSearchPath.cxx
new file mode 100644
index 0000000..19f2c3f
--- /dev/null
+++ b/Source/cmSearchPath.cxx
@@ -0,0 +1,243 @@
+/*============================================================================
+  CMake - Cross Platform Makefile Generator
+  Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
+
+  Distributed under the OSI-approved BSD License (the "License");
+  see accompanying file Copyright.txt for details.
+
+  This software is distributed WITHOUT ANY WARRANTY; without even the
+  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+  See the License for more information.
+============================================================================*/
+
+#include "cmSearchPath.h"
+#include "cmFindCommon.h"
+
+//----------------------------------------------------------------------------
+cmSearchPath::cmSearchPath(cmFindCommon* findCmd,
+                           const std::string& groupLabel)
+: FindName(findCmd->CMakePathName), Makefile(findCmd->Makefile),
+  Emitted(findCmd->SearchPathsEmitted), Label(groupLabel)
+{
+}
+
+//----------------------------------------------------------------------------
+cmSearchPath::~cmSearchPath()
+{
+}
+
+//----------------------------------------------------------------------------
+
+void cmSearchPath::ExtractWithout(const std::set<std::string>& ignore,
+                                  std::vector<std::string>& outPaths,
+                                  bool clear) const
+{
+  if(clear)
+    {
+    outPaths.clear();
+    }
+  for(std::vector<std::string>::const_iterator p = this->Paths.begin();
+      p != this->Paths.end(); ++p)
+    {
+    if(ignore.count(*p) == 0)
+      {
+      outPaths.push_back(*p);
+      }
+    }
+}
+
+//----------------------------------------------------------------------------
+void cmSearchPath::AddPath(const std::string& path)
+{
+  this->AddPathInternal(path);
+}
+
+//----------------------------------------------------------------------------
+void cmSearchPath::AddUserPath(const std::string& path)
+{
+  std::vector<std::string> outPaths;
+
+  // We should view the registry as the target application would view
+  // it.
+  cmSystemTools::KeyWOW64 view = cmSystemTools::KeyWOW64_32;
+  cmSystemTools::KeyWOW64 other_view = cmSystemTools::KeyWOW64_64;
+  if(this->Makefile->PlatformIs64Bit())
+    {
+    view = cmSystemTools::KeyWOW64_64;
+    other_view = cmSystemTools::KeyWOW64_32;
+    }
+
+  // Expand using the view of the target application.
+  std::string expanded = path;
+  cmSystemTools::ExpandRegistryValues(expanded, view);
+  cmSystemTools::GlobDirs(expanded, outPaths);
+
+  // Executables can be either 32-bit or 64-bit, so expand using the
+  // alternative view.
+  if(expanded != path && this->FindName == "PROGRAM")
+    {
+    expanded = path;
+    cmSystemTools::ExpandRegistryValues(expanded, other_view);
+    cmSystemTools::GlobDirs(expanded, outPaths);
+    }
+
+  // Process them all from the current directory
+  for(std::vector<std::string>::const_iterator p = outPaths.begin();
+      p != outPaths.end(); ++p)
+    {
+    this->AddPathInternal(*p, this->Makefile->GetCurrentDirectory());
+    }
+}
+
+//----------------------------------------------------------------------------
+void cmSearchPath::AddCMakePath(const std::string& variable)
+{
+  // Get a path from a CMake variable.
+  if(const char* value = this->Makefile->GetDefinition(variable))
+    {
+    std::vector<std::string> expanded;
+    cmSystemTools::ExpandListArgument(value, expanded);
+
+    for(std::vector<std::string>::const_iterator p = expanded.begin();
+        p!= expanded.end(); ++p)
+      {
+      this->AddPathInternal(*p, this->Makefile->GetCurrentDirectory());
+      }
+    }
+}
+
+//----------------------------------------------------------------------------
+void cmSearchPath::AddEnvPath(const std::string& variable)
+{
+  std::vector<std::string> expanded;
+  cmSystemTools::GetPath(expanded, variable.c_str());
+  for(std::vector<std::string>::const_iterator p = expanded.begin();
+      p!= expanded.end(); ++p)
+    {
+    this->AddPathInternal(*p);
+    }
+}
+
+//----------------------------------------------------------------------------
+void cmSearchPath::AddCMakePrefixPath(const std::string& variable)
+{
+  // Get a path from a CMake variable.
+  if(const char* value = this->Makefile->GetDefinition(variable))
+    {
+    std::vector<std::string> expanded;
+    cmSystemTools::ExpandListArgument(value, expanded);
+
+    this->AddPrefixPaths(expanded, this->Makefile->GetCurrentDirectory());
+    }
+}
+
+//----------------------------------------------------------------------------
+void cmSearchPath::AddEnvPrefixPath(const std::string& variable)
+{
+  std::vector<std::string> expanded;
+  cmSystemTools::GetPath(expanded, variable.c_str());
+  this->AddPrefixPaths(expanded);
+}
+
+//----------------------------------------------------------------------------
+void cmSearchPath::AddSuffixes(const std::vector<std::string>& suffixes)
+{
+  std::vector<std::string> inPaths;
+  inPaths.swap(this->Paths);
+  this->Paths.reserve(inPaths.size()*(suffixes.size()+1));
+
+  for(std::vector<std::string>::iterator ip = inPaths.begin();
+      ip != inPaths.end(); ++ip)
+    {
+    cmSystemTools::ConvertToUnixSlashes(*ip);
+
+    // if *i is only / then do not add a //
+    // this will get incorrectly considered a network
+    // path on windows and cause huge delays.
+    std::string p = *ip;
+    if(!p.empty() && *p.rbegin() != '/')
+      {
+      p += "/";
+      }
+
+    // Combine with all the suffixes
+    for(std::vector<std::string>::const_iterator s = suffixes.begin();
+        s != suffixes.end(); ++s)
+      {
+      this->Paths.push_back(p+*s);
+      }
+
+    // And now the original w/o any suffix
+    this->Paths.push_back(*ip);
+    }
+}
+
+//----------------------------------------------------------------------------
+void cmSearchPath::AddPrefixPaths(const std::vector<std::string>& paths,
+                                  const char *base)
+{
+  // default for programs
+  std::string subdir = "bin";
+
+  if (this->FindName == "INCLUDE")
+    {
+    subdir = "include";
+    }
+  else if (this->FindName == "LIBRARY")
+    {
+    subdir = "lib";
+    }
+  else if (this->FindName == "FRAMEWORK")
+    {
+    subdir = "";  // ? what to do for frameworks ?
+    }
+
+  for(std::vector<std::string>::const_iterator p = paths.begin();
+      p != paths.end(); ++p)
+    {
+    std::string dir = *p;
+    if(!subdir.empty() && !dir.empty() && *dir.rbegin() != '/')
+      {
+      dir += "/";
+      }
+    if(subdir == "include" || subdir == "lib")
+      {
+      const char* arch =
+        this->Makefile->GetDefinition("CMAKE_LIBRARY_ARCHITECTURE");
+      if(arch && *arch)
+        {
+        this->AddPathInternal(dir+subdir+"/"+arch, base);
+        }
+      }
+    std::string add = dir + subdir;
+    if(add != "/")
+      {
+      this->AddPathInternal(add, base);
+      }
+    if (subdir == "bin")
+      {
+      this->AddPathInternal(dir+"sbin", base);
+      }
+    if(!subdir.empty() && *p != "/")
+      {
+      this->AddPathInternal(*p, base);
+      }
+    }
+}
+
+//----------------------------------------------------------------------------
+void cmSearchPath::AddPathInternal(const std::string& path, const char *base)
+{
+  std::string collapsed = cmSystemTools::CollapseFullPath(path, base);
+
+   if(collapsed.empty())
+    {
+    return;
+    }
+
+  // Insert the path if has not already been emitted.
+  if(this->Emitted.insert(collapsed).second)
+    {
+    this->Paths.push_back(collapsed);
+    }
+}