FileSystemInfo.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#include "Arp/System/Core/Arp.h"
#include <list>
 
namespace Arp { namespace System { namespace Commons { namespace Io
{
 
class FileSystemInfo
{
public: // usings
    enum class Traits : int32
    {
        None = 0,
        Permissions   = (1 << 0),
        LastWriteTime = (1 << 1),
        Length        = (1 << 2),
        Crc32         = (1 << 3),
    };
 
    enum class Permissions : int32
    {
        NoPerms     = 0, // 0
 
        OthersExe   = 1, // 01
        OthersWrite = 2, // 02
        OthersRead  = 4, // 04
        OtherAll    = 7, // 07
 
        GroupExe    = 8, // 010
        GroupWrite  = 16, // 020
        GroupRead   = 32, // 040
        GroupAll    = 56, // 070
 
        OwnerExe    = 64, // 0100
        OwnerWrite  = 128, // 0200
        OwnerRead   = 256, // 0400
        OwnerAll    = 448, // 0700
 
        AllAll      = 511, // 0777
    };
 
    struct SpaceInfo
    {
        uint64 Capacity;
        uint64 Free;      // <= capacity
        uint64 Available; // <= free
    };
 
    using RootDirectoriesList = std::list<String>;
 
public: // construction/destruction
    FileSystemInfo(void) = delete;
 
public: // static operations
    static Traits GetSupportedTraits(void);
    static uint64 GetSize(const String& path);
    static uint32 CalculateCrc32(const String& path);
    static DateTime GetLastWriteTime(const String& path);
    static void SetLastWriteTime(const String& path, const DateTime& newLastWriteTime);
    static SpaceInfo GetSpaceInfo(const String& path);
 
    static Permissions GetPermissions(const String& path);
    static void AddPermissions(const String& path, Permissions permissions);
    static void RemovePermissions(const String& path, Permissions permissions);
    static void RemoveAllPermissions(const String& path);
    static void SetPermissions(const String& path, Permissions permissions);
    static boolean IsDirectory(const String& path);
    static boolean IsFile(const String& path);
 
    static RootDirectoriesList GetRootDirectories(void);
 
    static String GetOwner(const String& path);
    static String GetGroup(const String& path);
};
 
// global stream operators of enum FileSystemInfo::Permissions for logging and parsing
ARP_CXX_SYMBOL_EXPORT std::ostream& operator<<(std::ostream& os, FileSystemInfo::Permissions value);
ARP_CXX_SYMBOL_EXPORT std::istream& operator>>(std::istream& is, FileSystemInfo::Permissions& value);
 
// inline methods of class FileSystemInfo
 
constexpr FileSystemInfo::Traits operator&(FileSystemInfo::Traits lhs, FileSystemInfo::Traits rhs)
{
    using U = std::underlying_type<FileSystemInfo::Traits>::type;
    return static_cast<FileSystemInfo::Traits>(static_cast<U>(lhs) & static_cast<U>(rhs));
}
 
constexpr FileSystemInfo::Traits operator|(FileSystemInfo::Traits lhs, FileSystemInfo::Traits rhs)
{
    using U = std::underlying_type<FileSystemInfo::Traits>::type;
    return static_cast<FileSystemInfo::Traits>(static_cast<U>(lhs) | static_cast<U>(rhs));
}
 
constexpr FileSystemInfo::Permissions operator&(FileSystemInfo::Permissions lhs, FileSystemInfo::Permissions rhs)
{
    using U = std::underlying_type<FileSystemInfo::Permissions>::type;
    return static_cast<FileSystemInfo::Permissions>(static_cast<U>(lhs) & static_cast<U>(rhs));
}
 
constexpr FileSystemInfo::Permissions operator|(FileSystemInfo::Permissions lhs, FileSystemInfo::Permissions rhs)
{
    using U = std::underlying_type<FileSystemInfo::Permissions>::type;
    return static_cast<FileSystemInfo::Permissions>(static_cast<U>(lhs) | static_cast<U>(rhs));
}
 
constexpr FileSystemInfo::Permissions& operator&=(FileSystemInfo::Permissions& lhs, FileSystemInfo::Permissions rhs)
{
    lhs = lhs & rhs;
    return lhs;
}
 
constexpr FileSystemInfo::Permissions& operator|=(FileSystemInfo::Permissions& lhs, FileSystemInfo::Permissions rhs)
{
    lhs = lhs | rhs;
    return lhs;
}
 
constexpr FileSystemInfo::Permissions operator~(FileSystemInfo::Permissions arg)
{
    using U = std::underlying_type<FileSystemInfo::Permissions>::type;
    return static_cast<FileSystemInfo::Permissions>(~static_cast<U>(arg));
}
 
 
}}}} // end of namespace Arp::System::Commons::Io
 
// template specialization of FileSystemInfo::Permissions formatter
template<> struct fmt::formatter<Arp::System::Commons::Io::FileSystemInfo::Permissions> : public fmt::ostream_formatter {};