DtVrvFilesystem.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/


#pragma once
#include <vrvUtil/DtUnicode.h>
#include <boost/filesystem.hpp>
#include <string>
#include <set>

namespace makVrv
{
   class DT_DLL_VRVUTIL DtVrvFilesystem
   {

   public:

      static bool createAllDirectories(const std::string& dirPath);

      static std::string absolutePath(const std::string& path);

      static DtUnicode absolutePath(const DtUnicode& path);

      static std::string cleanPath(const std::string& path);

      static DtUnicode cleanPath(const DtUnicode& path);

      static bool getFilePathsWithExtension(const std::string& rootDir,
         const std::string& ext, std::vector<std::string>& ret);

      static bool getFilePathsWithExtension(const std::vector<std::string>& fileOrDirVec,
         const std::string& ext, std::vector<std::string>& ret);

      static bool getFilePathsInDir(const std::string& rootDir, 
         std::vector<std::string>& ret);

      static bool dirExistsNotEmpty(const std::string& rootDir);

      static bool isAbsolutePath(const std::string& path);

      static bool exists(const std::string& path);

      static std::string fileName(const std::string& path);

      static bool exists(const boost::filesystem::path& path);

      static bool equivalent(const std::string& path1, const std::string& path2);

      static std::string makeRelative(const std::string& root, const std::string& path);

      static std::string setExtension(std::string file, std::string ext);

      static std::string addExtension(std::string file, std::string ext);

      static std::string extension(const std::string& file, bool withDot=false);

      static std::string extensionCaseSensitive(std::string file, bool withDot=false);

      static std::string baseName(const std::string& file);

      static std::string directoryOfFile(const std::string& file);

      static std::string directoryOfPath(const std::string& file);

      static std::string rootDirectoryOfPath(const std::string& file);

      static std::string nativePath(const std::string& path);

      static DtUnicode nativePath(const DtUnicode& path);

      static std::string canonicalPath( const std::string& path );
      static DtUnicode canonicalPath( const DtUnicode& path );
      
      static bool is_directory(const std::string& path);

      static bool is_directory(const boost::filesystem::path& path);

      static bool deleteFile(const std::string& file);

      static bool deleteDirectory(const std::string& dir);
      
      static bool deleteDirectoryContents(const boost::filesystem::path& dir);
      
      static bool deleteDirectoryContentsWithIgnoreFilter(const boost::filesystem::path& dir, const std::set<std::string>& ignoreFilter);

      template <typename PathCollection>
      static bool findFile(const std::string& filePathIn, 
         const PathCollection& paths, std::string& actualFilePathOut)
      {
         //Does the file exist.
         if(DtVrvFilesystem::exists(filePathIn))
         {
            actualFilePathOut = filePathIn;         
            return true;
         }

         //Else look for file in supplied paths.
         typename PathCollection::const_iterator i = paths.begin();
         typename PathCollection::const_iterator e = paths.end();
         for(; i != e; ++i)
         {
           if(findFileInPath(filePathIn, *i, actualFilePathOut))
           {
              return true;
           }
         }
         return false;
      }

      static bool findFileInPath(const std::string& filePathIn, 
         const std::string& path, std::string& actualFilePathOut);

      static unsigned int makeAndXorHash(const std::string& filePath);

      static size_t ts_fileSize(const std::string& strFileName);

      static bool ts_fileExists(const std::string& strFileName);

      static void ts_readFileIntoBuffer(const std::string& strFileName, unsigned char*& pData, size_t& size);
   };
}