stellarlib 0.1.0
Loading...
Searching...
No Matches
filesystem.hpp
1/* clang-format off */
2
3/*
4 stellarlib
5 Copyright (C) 2025-2026 Domán Zana
6
7 This software is provided 'as-is', without any express or implied
8 warranty. In no event will the authors be held liable for any damages
9 arising from the use of this software.
10
11 Permission is granted to anyone to use this software for any purpose,
12 including commercial applications, and to alter it and redistribute it
13 freely, subject to the following restrictions:
14
15 1. The origin of this software must not be misrepresented; you must not
16 claim that you wrote the original software. If you use this software
17 in a product, an acknowledgment in the product documentation would be
18 appreciated but is not required.
19 2. Altered source versions must be plainly marked as such, and must not be
20 misrepresented as being the original software.
21 3. This notice may not be removed or altered from any source distribution.
22*/
23
24#ifndef STELLARLIB_EXT_FILESYSTEM_HPP
25#define STELLARLIB_EXT_FILESYSTEM_HPP
26
27#include <filesystem>
28#include <string>
29
30/**
31 * @brief Standard library extensions
32 */
34{
35/**
36 * @brief Returns the base directory of the application
37 * @return Base directory of the application
38 */
39[[nodiscard]]
41 -> const std::filesystem::path &;
42
43/**
44 * @brief Returns the data directory of the application
45 * @param organization Name of the organization
46 * @param application Name of the application
47 * @return Data directory of the application
48 */
49[[nodiscard]]
50auto data_directory_path(const std::string &organization, const std::string &application)
51 -> std::filesystem::path;
52}
53
54#endif
Standard library extensions.
Definition filesystem.hpp:34
auto base_directory_path() -> const std::filesystem::path &
Returns the base directory of the application.
auto data_directory_path(const std::string &organization, const std::string &application) -> std::filesystem::path
Returns the data directory of the application.