fileSystem.hpp

Go to the documentation of this file.

/*------------------------------- phasicFlow ---------------------------------
      O        C enter of
     O O       E ngineering and
    O   O      M ultiscale modeling of
   OOOOOOO     F luid flow       
------------------------------------------------------------------------------
  Copyright (C): www.cemf.ir
  email: hamid.r.norouzi AT gmail.com
------------------------------------------------------------------------------  
Licence:
  This file is part of phasicFlow code. It is a free software for simulating 
  granular and multiphase flows. You can redistribute it and/or modify it under
  the terms of GNU General Public License v3 or any other later versions. 
 
  phasicFlow is distributed to help others in their research in the field of 
  granular and multiphase flows, but WITHOUT ANY WARRANTY; without even the
  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 
-----------------------------------------------------------------------------*/
 
#ifndef __fileSystem_hpp__
#define __fileSystem_hpp__
 
#include <filesystem>
#include "bTypes.hpp"
#include "List.hpp"
 
 
namespace pFlow
{
 
// - Forward 
class iOstream;
class fileSystem;
 
iOstream& operator <<
(
    iOstream& os,
    const fileSystem& fs
);
 
std::ostream& operator <<
(
    std::ostream& os,
    const fileSystem& fs
);
 
 
fileSystem operator /
(
    const fileSystem& fs1,
    const fileSystem& fs2
);
 
fileSystem operator /
(
    const fileSystem& fs1,
    const word& dir2
);
 
fileSystem operator +
(
    const fileSystem& fs1,
    const word fName
);
 
class fileSystem
{
public:
    
    using   pathType = std::filesystem::path;
 
protected:
    
    pathType    path_;
    
    bool        isDir_;
 
 
    inline static word notPermittedCharsFile = word(" ") + word("&\t\n;:?*/<>\"?\'");
    
    bool static validFileName(const word& name)
    {
        return name.find_first_of(notPermittedCharsFile)==word::npos;
    }
 
    bool static checkFileName(const word& name);
 
public:
 
    inline static fileSystem CWD() 
    {
        return fileSystem(std::filesystem::current_path().c_str());
    }
    
public:
 
 
        fileSystem():
            path_(),
            isDir_(true)
        {}
 
        explicit
        fileSystem(const word & wPath);
 
        fileSystem( const word& dir, const word& file);
        
        fileSystem( const char* dir, const char* file="");
 
        explicit
        fileSystem( const pathType& path );
 
        fileSystem(const fileSystem&) = default;
        
        fileSystem(fileSystem&&) = default;
 
        fileSystem& operator = (const fileSystem&) = default;
 
        fileSystem& operator = (fileSystem&&) = default;
 
        ~fileSystem() = default;
    
        
        bool isDir() const
        {
            return isDir_;
        }
        
        const pathType& path()const
        {
            return path_;
        }
 
        word wordPath()const
        {
            return word(path_.c_str());
        }
 
        fileSystem dirPath() const;
 
        word fileName() const;
 
        fileSystem absolute()const;
 
 
        fileSystem canonical()const;
 
        fileSystem relative(const fileSystem& base)const;
 
        bool dirExist()const;   
 
        bool exist()const;
 
        fileSystem createDirs()const;
 
 
        void operator += (const word& fileName);
 
        void operator /=(const fileSystem& fs );
 
        friend fileSystem operator /(const fileSystem& fs1, const fileSystem& fs2 );
 
 
        fileSystem operator()(bool retDir = true) const;
    
    friend iOstream& operator << (iOstream& os, const fileSystem& fs);
 
    friend std::ostream& operator << (std::ostream& os, const fileSystem& fs);
    
};
 
 
using fileSystemList = List<fileSystem>;
 
 
inline fileSystem CWD()
{
    return fileSystem::CWD();
}
 
bool isDirectory(const fileSystem& path);
 
bool isRegularFile(const fileSystem& path);
 
fileSystemList subDirectories(const fileSystem& path);
 
fileSystemList containingFiles(const fileSystem& path);
 
} // pFlow
 
#endif