path.h

Go to the documentation of this file.

#ifndef _DLR_PATH_H_
#define _DLR_PATH_H_

#include <string>
#include <vector>

namespace dlr {

  namespace utilities {

    bool
    isDirectory(const std::string& path);
  
  
    bool
    isExistingPath(const std::string& path);
  
  
    bool
    isRegularFile(const std::string& path);
    
    
    std::string
    joinPath(const std::string& part0, const std::string& part1);

  
    std::vector<std::string>
    listDirectory(const std::string& directoryName, bool fullPath=false);


    std::vector<std::string>
    recursiveListDirectory(const std::string& directoryName,
                           bool fullPath=false,
                           bool includeDirectoryNames=false);


    template <class IterType>
    bool
    searchForFile(const std::string& fileName,
                  IterType pathBegin, IterType pathEnd,
                  std::string& fullPath,
                  bool discardInputDir = false);
    
  
    std::pair<std::string, std::string>
    splitExtension(const std::string& fileName);


    std::pair<std::string, std::string>
    splitPath(const std::string& path);

  } // namespace utilities
    
} // namespace dlr


/* ======= Declarations to maintain compatibility with legacy code. ======= */

namespace dlr {

  using utilities::isDirectory;
  using utilities::isExistingPath;
  using utilities::isRegularFile;
  using utilities::joinPath;
  using utilities::listDirectory;
  using utilities::recursiveListDirectory;
  using utilities::splitExtension;
  using utilities::splitPath;
  
} // namespace dlr


/* ======= Declarations of inline and template functions. ======= */

namespace dlr {

  namespace utilities {
    
    // This function searches a sequence of directories looking for
    // the specified file.
    template <class IterType>
    bool
    searchForFile(const std::string& fileName,
                  IterType pathBegin, IterType pathEnd,
                  std::string& fullPath,
                  bool discardInputDir)
    {
      std::string baseName;
      if(discardInputDir) {
        baseName = splitPath(fileName).second;
      } else {
        baseName = fileName;
      }
      while(pathBegin != pathEnd) {
        std::string candidateName = joinPath(*pathBegin, baseName);
        if(isRegularFile(candidateName)) {
          fullPath = candidateName;
          return true;
        }
        ++pathBegin;
      }
      return false;
    }

  } // namespace utilities
  
} // namespace dlr

#endif // #ifndef _DLR_PATH_H_