paths_8hpp_source.html

// SPDX-FileCopyrightText: Copyright (c) 2025 Sensui Yagi. All rights reserved.

// SPDX-License-Identifier: Apache-2.0


#pragma once


#include "retinify/attributes.hpp"

#include "retinify/status.hpp"


#include <filesystem>


namespace retinify

{

RETINIFY_API [[nodiscard]] auto HomeDirectoryPath(std::filesystem::path &path) noexcept -> Status;


RETINIFY_API [[nodiscard]] auto ConfigDirectoryPath(std::filesystem::path &path) noexcept -> Status;


RETINIFY_API [[nodiscard]] auto CacheDirectoryPath(std::filesystem::path &path) noexcept -> Status;


RETINIFY_API [[nodiscard]] auto DataDirectoryPath(std::filesystem::path &path) noexcept -> Status;


RETINIFY_API [[nodiscard]] auto StateDirectoryPath(std::filesystem::path &path) noexcept -> Status;

} // namespace retinify

attributes.hpp

RETINIFY_API
#define RETINIFY_API
Defines a macro for setting API visibility to "default" for the retinify library.
Definition attributes.hpp:8

retinify::Status
This class represents the status of an operation in the retinify library.
Definition status.hpp:51

retinify
Definition colormap.hpp:13

retinify::StateDirectoryPath
RETINIFY_API auto StateDirectoryPath(std::filesystem::path &path) noexcept -> Status
Returns the state directory path for retinify.

retinify::CacheDirectoryPath
RETINIFY_API auto CacheDirectoryPath(std::filesystem::path &path) noexcept -> Status
Returns the cache directory path for retinify.

retinify::ConfigDirectoryPath
RETINIFY_API auto ConfigDirectoryPath(std::filesystem::path &path) noexcept -> Status
Returns the configuration directory path for retinify.

retinify::DataDirectoryPath
RETINIFY_API auto DataDirectoryPath(std::filesystem::path &path) noexcept -> Status
Returns the data directory path for retinify.

retinify::HomeDirectoryPath
RETINIFY_API auto HomeDirectoryPath(std::filesystem::path &path) noexcept -> Status
Returns the current user’s home directory path.

status.hpp