FileSystemInfo.hpp

//
//  Copyright PHOENIX CONTACT Electronics GmbH
//
#pragma once
#include "Arp/System/Core/Arp.h"
#include <list>

namespace Arp { namespace System { namespace Commons { namespace Io
{

class FileSystemInfo
{
public: // typedefs
    enum class Traits
    {
        None = 0,
        Permissions   = (1 << 0),
        LastWriteTime = (1 << 1),
        Length        = (1 << 2),
        Crc32         = (1 << 3),
    };

    enum class Permissions
    {
        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
    };

    typedef std::list<String> RootDirectoriesList;

public: // construction/destruction
    FileSystemInfo(void) = delete;
    FileSystemInfo(const FileSystemInfo& arg) = delete;
    FileSystemInfo& operator=(const FileSystemInfo& arg) = delete;
    ~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 boolean IsDirectory(const String& path);
    static boolean IsFile(const String& path);

    static RootDirectoriesList GetRootDirectories(void);
};

// inline methods of class FileSystemInfo

inline constexpr FileSystemInfo::Traits operator&(FileSystemInfo::Traits lhs, FileSystemInfo::Traits rhs)
{
    return static_cast<FileSystemInfo::Traits>(static_cast<int32>(lhs) & static_cast<int32>(rhs));
}

inline constexpr FileSystemInfo::Traits operator|(FileSystemInfo::Traits lhs, FileSystemInfo::Traits rhs)
{
    return static_cast<FileSystemInfo::Traits>(static_cast<int32>(lhs) | static_cast<int32>(rhs));
}

inline constexpr FileSystemInfo::Permissions operator&(FileSystemInfo::Permissions lhs, FileSystemInfo::Permissions rhs)
{
    return static_cast<FileSystemInfo::Permissions>(static_cast<int32>(lhs) & static_cast<int32>(rhs));
}

inline constexpr FileSystemInfo::Permissions operator|(FileSystemInfo::Permissions lhs, FileSystemInfo::Permissions rhs)
{
    return static_cast<FileSystemInfo::Permissions>(static_cast<int32>(lhs) | static_cast<int32>(rhs));
}

}}}} // end of namespace Arp::System::Commons::Io