directory.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
 *
 * This file is part of StormByte-System.
 *
 * StormByte-System original source is dual-licensed:
 *
 * 1. GNU Lesser General Public License v3.0 (or later)
 *    You may redistribute and/or modify this file under the terms of the
 *    GNU Lesser General Public License as published by the Free Software
 *    Foundation, either version 3 of the License, or (at your option)
 *    any later version.
 *
 * 2. Commercial license
 *    Alternatively, this file may be used under the terms of a commercial
 *    license agreement with the copyright holder
 *    (David C. Manuelda <StormByte@gmail.com>).
 *
 * Both licenses apply only to original StormByte-System source in this
 * repository. They do not cover other StormByte modules or any third-party
 * material shipped with this repository (including everything under
 * thirdparty/, and in particular the bundled StormByte Base tree), which
 * remains under its own license.
 *
 * Neither license grants any patent rights. Any patent licenses required
 * to use this software or third-party components must be obtained separately
 * from the patent holders.
 *
 * StormByte-System is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with StormByte-System. If not, see
 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
 */
 
#pragma once
 
#include <StormByte/error.hxx>
#include <StormByte/string/string.hxx>
#include <StormByte/system/visibility.h>
 
#include <string>
#include <system_error>
 
namespace StormByte::System {
    namespace Directory {
        enum class Error {
            Success = 0,    
            Permission,     
            NotFound,       
            Failed          
        };
 
        STORMBYTE_SYSTEM_PUBLIC StormByte::Error::Fault LastError() noexcept;
 
        STORMBYTE_SYSTEM_PUBLIC bool Current(StormByte::String::String& path);
 
        STORMBYTE_SYSTEM_PUBLIC bool Home(StormByte::String::String& path);
 
        STORMBYTE_SYSTEM_PUBLIC bool Temporary(StormByte::String::String& path);
 
        STORMBYTE_SYSTEM_PUBLIC bool CurrentExecutable(StormByte::String::String& path);
    }
}
 
template<>
struct StormByte::Error::Domain<StormByte::System::Directory::Error> {
    static constexpr const char* Name = "StormByte.System.Directory";   
 
    static std::string Message(StormByte::System::Directory::Error e) {
        switch (e) {
            case StormByte::System::Directory::Error::Success:
                return "Success";
            case StormByte::System::Directory::Error::Permission:
                return "Directory permission denied";
            case StormByte::System::Directory::Error::NotFound:
                return "Directory not found";
            case StormByte::System::Directory::Error::Failed:
                return "Directory resolution failed";
        }
        return "Unknown Directory error";
    }
};
 
namespace StormByte::System {
    STORMBYTE_SYSTEM_PUBLIC const StormByte::Error::Category<Directory::Error>& directory_category() noexcept;
 
    STORMBYTE_SYSTEM_PUBLIC std::error_code make_error_code(Directory::Error e) noexcept;
}
 
namespace std {
    template<>
    struct is_error_code_enum<StormByte::System::Directory::Error>: true_type {};
}