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
116
117
118
119
120
121
122
123
124
125
126
127
|
/************************************************************************
*
* Copyright (C) 2022-2024 IRCAD France
*
* 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/runtime/module.hpp"
#include <filesystem>
#include <memory>
#include <string>
namespace sight::core::runtime
{
/**
* @brief Get the path where libraries, modules and share folders are located.
* Sight must have been initialized first through sight::runtime::init()
*
* @return a system valid path
*/
SIGHT_CORE_API std::filesystem::path working_path() noexcept;
/**
* @brief Retrieve the filesystem valid path of resources of a module.
*
* @param _module_identifier a string containing a module identifier
*
* @return a system valid path
*/
SIGHT_CORE_API std::filesystem::path get_module_resource_path(const std::string& _module_identifier) noexcept;
/**
* @brief Retrieve a filesystem valid path for a path relative to the module having the specified identifier.
*
* @param _module_identifier a string containing a module identifier
* @param _path a module relative path
*
* @return a system valid path
*/
SIGHT_CORE_API std::filesystem::path get_module_resource_file_path(
const std::string& _module_identifier,
const std::filesystem::path& _path
) noexcept;
/**
* @brief Retrieve a filesystem valid path for a resource path whose first element is a module identifier.
* For instance for "module/dir/file.txt", the function returns
* "/home/login/sight/build/share/module/dir/file.txt"
*
* @param _path relative path whose first element is a module identifier
*
* @return a system valid path
*/
SIGHT_CORE_API std::filesystem::path get_module_resource_file_path(const std::filesystem::path& _path) noexcept;
/**
* @brief Retrieve a filesystem valid path for a resource path whose first element is a library identifier.
* For instance for "fwLib/dir/file.txt", the function returns
* "/home/login/sight/build/share/fwLib/dir/file.txt"
*
* @param _path relative path whose first element is a library identifier
*
* @return a system valid path
*/
SIGHT_CORE_API std::filesystem::path get_library_resource_file_path(const std::filesystem::path& _path) noexcept;
/**
* @brief Retrieve a filesystem valid path for a resource path
* whose first element is a library or a module identifier.
*
* For instance for a library:
* - "fwLib/dir/file.txt"
* the function returns:
* - "/home/login/sight/build/share/fwLib/dir/file.txt"
*
* For instance for a module:
* - "module/dir/file.txt"
* the function returns:
* - "/home/login/sight/build/share/module/dir/file.txt"
*
* @param _path relative path whose first element is a module or library identifier
*
* @return a system valid path or an empty path if nothing is found
*/
SIGHT_CORE_API std::filesystem::path get_resource_file_path(const std::filesystem::path& _path) noexcept;
/**
* @brief Retrieve a filesystem valid path for a path relative to the specified module.
*
* @param _module a pointer to a module instance
* @param _path a path relative to the module
*
* @return a system valid path
*/
SIGHT_CORE_API std::filesystem::path get_module_resource_path(
std::shared_ptr<module> _module,
const std::filesystem::path& _path
) noexcept;
/**
* @brief Retrieve all valid filesystem binaries paths. These paths contain binaries like sightrun.
*
* @return set of valid system paths
*/
SIGHT_CORE_API std::set<std::filesystem::path> get_binaries_paths() noexcept;
} // namespace sight::core::runtime
|
