lfilesystem_Permissions.h

Go to the documentation of this file.

/*
 * ======================================================================================
 *  __    ____  __  __  ____  ___
 * (  )  (_  _)(  \/  )( ___)/ __)
 *  )(__  _)(_  )    (  )__) \__ \
 * (____)(____)(_/\/\_)(____)(___/
 *
 *  This file is part of the Limes open source library and is licensed under the terms of the GNU Public License.
 *
 *  Commercial licenses are available; contact the maintainers at ben.the.vining@gmail.com to inquire for details.
 *
 * ======================================================================================
 */
 
#pragma once
 
#include <filesystem>
#include <string>
#include <string_view>
#include <ostream>
#include "lfilesystem/lfilesystem_Export.h"
 
namespace limes::files
{
 
using FSPerms = std::filesystem::perms;
 
class LFILE_EXPORT Permissions final
{
public:
 
    Permissions() = default;
 
    Permissions (FSPerms p) noexcept; // cppcheck-suppress noExplicitConstructor
 
 
 
    operator FSPerms() const noexcept;
 
    [[nodiscard]] FSPerms getStdPerms() const noexcept;
 
 
    Permissions (const Permissions&) = default;
    Permissions& operator= (const Permissions&) = default;
 
    Permissions (Permissions&&) = default;
    Permissions& operator= (Permissions&&) = default;
 
    Permissions& operator= (FSPerms p) noexcept;
 
 
    bool operator== (const Permissions& other) const noexcept;
    bool operator== (FSPerms p) const noexcept;  
 
 
    enum class LFILE_EXPORT Scope
    {
        Owner,   
        Group,   
        Others,  
        All      
    };
 
 
    bool isUnknownOrEmpty() const noexcept;
 
    bool hasRead (Scope s = Scope::All) const noexcept;
 
    bool hasWrite (Scope s = Scope::All) const noexcept;
 
    bool hasExecute (Scope s = Scope::All) const noexcept;
 
    bool hasAll (Scope s = Scope::All) const noexcept;
 
    bool hasStickyBit() const noexcept;
 
 
 
    [[nodiscard]] Permissions withRead (Scope s = Scope::All) const noexcept;
 
    [[nodiscard]] Permissions withWrite (Scope s = Scope::All) const noexcept;
 
    [[nodiscard]] Permissions withExecute (Scope s = Scope::All) const noexcept;
 
    [[nodiscard]] Permissions withAll (Scope s = Scope::All) const noexcept;
 
    [[nodiscard]] Permissions withStickyBit() const noexcept;
 
 
    [[nodiscard]] std::string toString() const;
 
    [[nodiscard]] static Permissions fromString (const std::string_view& string) noexcept;
 
    [[nodiscard]] static Permissions ownerAll() noexcept;
 
    [[nodiscard]] static Permissions groupAll() noexcept;
 
    [[nodiscard]] static Permissions othersAll() noexcept;
 
    [[nodiscard]] static Permissions all() noexcept;
 
private:
    FSPerms perms { FSPerms::none };
};
 
std::ostream& operator<< (std::ostream& os, const Permissions& value);
 
}  // namespace limes::files