File: path.cpp

package info (click to toggle)
sight 25.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 43,252 kB
  • sloc: cpp: 310,629; xml: 17,622; ansic: 9,960; python: 1,379; sh: 144; makefile: 33
file content (199 lines) | stat: -rw-r--r-- 6,504 bytes parent folder | download | duplicates (2)
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
/************************************************************************
 *
 * Copyright (C) 2022-2023 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/>.
 *
 ***********************************************************************/

#include "core/runtime/path.hpp"

#include "core/runtime/detail/module.hpp"
#include "core/runtime/detail/runtime.hpp"

#include <core/spy_log.hpp>

#include <algorithm>
#include <ranges>
#include <regex>
#include <utility>
#include <vector>

namespace sight::core::runtime
{

//------------------------------------------------------------------------------

std::filesystem::path working_path() noexcept
{
    const auto& runtime = detail::runtime::get();
    return runtime.working_path();
}

//------------------------------------------------------------------------------

std::filesystem::path get_module_resource_path(const std::string& _module_identifier) noexcept
{
    const auto& runtime            = detail::runtime::get();
    std::shared_ptr<module> module = runtime.find_module(_module_identifier);

    if(module == nullptr)
    {
        SIGHT_ERROR("Could not find module " + _module_identifier + "'");
        return {};
    }

    return module->get_resources_location();
}

//------------------------------------------------------------------------------

std::filesystem::path get_module_resource_file_path(
    const std::string& _module_identifier,
    const std::filesystem::path& _path
) noexcept
{
    const auto& runtime            = detail::runtime::get();
    std::shared_ptr<module> module = runtime.find_module(_module_identifier);

    if(module == nullptr)
    {
        SIGHT_ERROR("Could not find module '" + _module_identifier + "'");
        return {};
    }

    return get_module_resource_path(module, _path);
}

//------------------------------------------------------------------------------

std::filesystem::path get_module_resource_file_path(const std::filesystem::path& _path) noexcept
{
    SIGHT_ASSERT("Path should not be empty", !_path.empty());
    SIGHT_ASSERT("Path should be relative", _path.is_relative());

    const std::string module_folder = _path.begin()->string();

    // Strip the module name
    std::filesystem::path path_without_module;
    for(const auto& it_path : std::views::drop(_path, 1))
    {
        path_without_module /= it_path;
    }

    try
    {
        const auto& runtime            = detail::runtime::get();
        std::shared_ptr<module> module = runtime.find_module(module_folder);

        if(module == nullptr)
        {
            SIGHT_DEBUG("Could not find module '" + module_folder + "'");
            return {};
        }

        return get_module_resource_path(module, path_without_module);
    }
    catch(...)
    {
        SIGHT_ERROR("Error looking for module '" + module_folder + "'");
        return {};
    }
}

//------------------------------------------------------------------------------

std::filesystem::path get_library_resource_file_path(const std::filesystem::path& _path) noexcept
{
    // The path argument can be a filesystem path or a module identifier followed by a system paths, i.e.
    // - viz_scene3d/media
    // - sight::viz::scene3d/media
    // The module identifier is the more robust choice since it can not be ambiguous
    const auto& runtime = core::runtime::detail::runtime::get();

    // Extract the namespace
    std::smatch match;
    std::string path_str = _path.string();
    std::string lib_namespace;

    // If we have sight::viz::scene3d/media
    if(std::regex_match(path_str, match, std::regex("(?:^:*)(\\w*)::(.*)")))
    {
        lib_namespace = match[1].str(); // equals sight
        path_str      = match[2].str(); // equals viz::scene3d/media
    }

    path_str = std::regex_replace(path_str, std::regex("::"), "_"); // equals viz_scene3d/media

    // The library resources are at the same location than modules
    // Find a repo that matches the library namespace
    const auto repositories = runtime.get_repositories_path();
    for(const auto& repo : repositories)
    {
        std::filesystem::path last_path = *(--repo.second.end());
        if(last_path.string() == lib_namespace)
        {
            return repo.second / path_str;
        }
    }

    // Fallback, if we did not find anything. Especially useful at start for the default module path.
    return std::filesystem::weakly_canonical(core::runtime::working_path() / MODULE_RC_PREFIX / path_str);
}

//------------------------------------------------------------------------------

std::filesystem::path get_resource_file_path(const std::filesystem::path& _path) noexcept
{
    auto file = core::runtime::get_module_resource_file_path(_path);
    if(file.empty())
    {
        // If not found in a module, look into libraries
        file = core::runtime::get_library_resource_file_path(_path);
        SIGHT_ERROR_IF("Resource '" + _path.string() + "' has not been found in any module or library", file.empty());
    }

    return file;
}

//------------------------------------------------------------------------------

std::filesystem::path get_module_resource_path(
    std::shared_ptr<module> _module,
    const std::filesystem::path& _path
) noexcept
{
    return _module->get_resources_location() / _path;
}

//------------------------------------------------------------------------------

std::set<std::filesystem::path> get_binaries_paths() noexcept
{
    std::set<std::filesystem::path> binaries_paths;

    const auto& runtime = core::runtime::detail::runtime::get();
    for(const auto& [lib, module] : runtime.get_repositories_path())
    {
        binaries_paths.emplace(std::filesystem::weakly_canonical(lib / ".." / "bin"));
    }

    return binaries_paths;
}

//------------------------------------------------------------------------------

} // namespace sight::core::runtime