1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
/************************************************************************
*
* Copyright (C) 2009-2024 IRCAD France
* Copyright (C) 2012-2021 IHU Strasbourg
*
* This file is part of Sight.
*
* Sight is free software: you can redistribute it and/or modify it 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.
*
* Sight 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 along with Sight. If not, see <https://www.gnu.org/licenses/>.
*
***********************************************************************/
#pragma once
#include <sight/core/config.hpp>
#include "core/exception.hpp"
#include <filesystem>
#include <string>
namespace sight::core::tools::os
{
/**
* @brief Returns a environment variable value
*
* @param _name environment variable 'name'
* @param[out] _ok boolean set to true if variable exists
*
* @return The environment variable content if it exists, else an empty string
*/
SIGHT_CORE_API std::string get_env(const std::string& _name, bool* _ok = nullptr);
/**
* @brief Returns a environment variable value
*
* @param _name environment variable 'name'
* @param _default_value Value returned if variable 'name' doesn't exist
*/
SIGHT_CORE_API std::string get_env(const std::string& _name, const std::string& _default_value);
/**
* @brief Return the users's application config directory
*
* @param _app_name The application name
* @param _create_directory if true, create the returned directory if it don't exist
* @param _company The company name
*
* Return the application config directory. If company or appName is not empty, append them to
* the path. Under unix, XDG conventions are respected.
* For example, the UserConfigDir under linux will be "~/.local/share/company/appName"
*/
SIGHT_CORE_API std::filesystem::path get_user_data_dir(
const std::string& _app_name = "",
bool _create_directory = true,
const std::string& _company = "sight"
);
/**
* @brief Return the users's application config directory
*
* @param _app_name The application name
* @param _create_directory if true, create the returned directory if it don't exist
* @param _company The company name
*
* Return the application config directory. If company or appName is not empty, append them to
* the path. Under unix, XDG conventions are respected.
* For example, the UserConfigDir under linux will be "~/.config/company/appName"
*/
SIGHT_CORE_API std::filesystem::path get_user_config_dir(
const std::string& _app_name = "",
bool _create_directory = true,
const std::string& _company = "sight"
);
/**
* @brief Return the users's application cache directory
*
* @param _app_name The application name
* @param _create_directory if true, create the returned directory if it don't exist
* @param _company The company name
*
* Return the application data directory. If company or appName is not empty, append them to
* the path. Under unix, XDG conventions are respected.
* For example, the UserCacheDir under linux will be "~/.cache/company/appName"
*/
SIGHT_CORE_API std::filesystem::path get_user_cache_dir(
const std::string& _app_name = "",
bool _create_directory = true,
const std::string& _company = "sight"
);
/**
* @brief Return the path to a shared library name
* The library should have already been loaded before.
* @param _lib_name The name of the shared library, without any 'lib' prefix, 'd' suffix or extension,
* i.e. 'jpeg' or 'boost_filesystem'. The function will try to use the appropriate combination according to
* the platform and the build type.
* @return path to the library on the filesystem
* @throw core::exception if the library could not be found (not loaded for instance)
*/
SIGHT_CORE_API std::filesystem::path get_shared_library_path(const std::string& _lib_name);
} // namespace sight::core::tools::os
|
