File: plugin.cpp

package info (click to toggle)
sight 25.2.0-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 42,184 kB
  • sloc: cpp: 289,476; xml: 17,257; ansic: 9,878; python: 1,379; sh: 144; makefile: 33
file content (300 lines) | stat: -rw-r--r-- 9,922 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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
/************************************************************************
 *
 * Copyright (C) 2009-2025 IRCAD France
 * Copyright (C) 2012-2020 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/>.
 *
 ***********************************************************************/

#include "module/ui/qt/plugin.hpp"

#include <core/base.hpp>
#include <core/runtime/path.hpp>
#include <core/runtime/profile/profile.hpp>

#include <service/macros.hpp>

#include <ui/__/macros.hpp>
#include <ui/qt/app.hpp>
#include <ui/qt/dialog/input.hpp>
#include <ui/qt/dialog/location.hpp>
#include <ui/qt/dialog/logger.hpp>
#include <ui/qt/dialog/message.hpp>
#include <ui/qt/dialog/notification.hpp>
#include <ui/qt/dialog/progress.hpp>
#include <ui/qt/dialog/pulse_progress.hpp>
#include <ui/qt/dialog/selector.hpp>
#include <ui/qt/worker_qt.hpp>

#include <QFile>
#include <QPainter>
#include <QProxyStyle>
#include <QResource>
#include <QString>
#include <QStyleFactory>
#include <QTextStream>

#include <functional>

// Register all dialog implementation when we do use qt
namespace base_dialog = sight::ui::dialog;

SIGHT_REGISTER_GUI(sight::ui::qt::dialog::input, base_dialog::input_base::REGISTRY_KEY);
SIGHT_REGISTER_GUI(sight::ui::qt::dialog::location, base_dialog::location_base::REGISTRY_KEY);
SIGHT_REGISTER_GUI(sight::ui::qt::dialog::logger, base_dialog::logger_base::REGISTRY_KEY);
SIGHT_REGISTER_GUI(sight::ui::qt::dialog::message, base_dialog::message_base::REGISTRY_KEY);
SIGHT_REGISTER_GUI(sight::ui::qt::dialog::notification, base_dialog::notification_base::REGISTRY_KEY);
SIGHT_REGISTER_GUI(sight::ui::qt::dialog::progress, base_dialog::progress_base::REGISTRY_KEY);
SIGHT_REGISTER_GUI(sight::ui::qt::dialog::pulse_progress, base_dialog::pulse_progress_base::REGISTRY_KEY);
SIGHT_REGISTER_GUI(sight::ui::qt::dialog::selector, base_dialog::selector_base::REGISTRY_KEY);

namespace sight::module::ui::qt
{

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

SIGHT_REGISTER_PLUGIN("sight::module::ui::qt::plugin");

/// This class is used to provide a proper disabled icon, especially when the icon is full white.
class proxy_style final : public QProxyStyle
{
public:

    using QProxyStyle::QProxyStyle;

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

    QPixmap generatedIconPixmap(QIcon::Mode _icon_mode, const QPixmap& _pixmap, const QStyleOption* _option) const final
    {
        if(_icon_mode == QIcon::Disabled)
        {
            // Copy the original pixmap
            QPixmap disabled_pixmap = _pixmap;

            // Create a QPainter and fill the pixmap with a semi-transparent white
            QPainter painter(&disabled_pixmap);
            painter.setCompositionMode(QPainter::CompositionMode_SourceIn);
            painter.fillRect(disabled_pixmap.rect(), QColor(255, 255, 255, 25));
            painter.end();

            return disabled_pixmap;
        }

        return QProxyStyle::generatedIconPixmap(_icon_mode, _pixmap, _option);
    }
};

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

inline static QString get_application_style_sheet()
{
    QString app_style;

    // Get the current profile and root directory
    const auto profile = sight::core::runtime::get_current_profile();

    if(!profile)
    {
        return app_style;
    }

    const auto& profile_path = profile->file_path();

    if(profile_path.empty())
    {
        // This could happen in unit tests
        SIGHT_WARN("Profile path is empty");
        return app_style;
    }

    const auto& root = profile_path.parent_path();

    std::set<std::filesystem::path> qss_files;

    // Look for all .qss files and order them in a set
    for(const auto& entry : std::filesystem::recursive_directory_iterator(root))
    {
        if(!entry.is_regular_file())
        {
            continue;
        }

        const auto& qss_path = entry.path();

        if(qss_path.extension() != ".qss")
        {
            continue;
        }

        qss_files.insert(std::filesystem::canonical(qss_path));
    }

    // ...and read their contents
    for(const auto& qss_path : qss_files)
    {
        QFile qss_file(QString::fromStdString(qss_path.string()));

        if(!qss_file.open(QFile::ReadOnly))
        {
            SIGHT_ASSERT("Could not open QSS file: " << qss_path.string(), false);
            continue;
        }

        SIGHT_INFO("Reading QSS file: " << qss_path.string());
        const auto qss_content = QTextStream(&qss_file).readAll().trimmed();

        if(!qss_content.isEmpty())
        {
            app_style.append("\n");
            app_style.append(qss_content);
        }
    }

    return app_style;
}

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

void plugin::start()
{
    core::runtime::profile::sptr profile = core::runtime::get_current_profile();
    SIGHT_ASSERT("Profile is not initialized", profile);
    int& argc   = profile->get_raw_arg_count();
    char** argv = profile->get_raw_params();

    std::function<QSharedPointer<QCoreApplication>(int&, char**)> callback =
        [this](int& _argc, char** _argv)
        {
            auto application = QSharedPointer<QApplication>(new sight::ui::qt::app(_argc, _argv, true));

            // Load the style sheet now, before executing the Qt event loop
            // Otherwise, some unit tests may fail because of the qApp assert
            load_style_sheet();

            return application;
        };

    auto worker_qt = sight::ui::qt::get_qt_worker(argc, argv, callback, profile->name(), profile->version());
    core::thread::set_default_worker(worker_qt);

    core::runtime::get_current_profile()->set_run_callback(run);
}

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

void plugin::stop() noexcept
{
    core::thread::reset_default_worker();
}

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

int plugin::run() noexcept
{
    auto worker_qt = core::thread::get_default_worker();
    worker_qt->get_future().wait(); // This is required to start worker_qt loop

    int result = std::any_cast<int>(worker_qt->get_future().get());

    return result;
}

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

void plugin::load_style_sheet()
{
    SIGHT_ASSERT("QApplication is not initialized", qApp);

    if(this->get_module()->has_parameter("resource"))
    {
        const std::string resource_file = this->get_module()->get_parameter_value("resource");
        const auto path                 = core::runtime::get_module_resource_file_path(resource_file);

        [[maybe_unused]] const bool resource_loaded = QResource::registerResource(path.string().c_str());
        SIGHT_ASSERT("Cannot load resources '" << resource_file << "'.", resource_loaded);
    }

    // Also apply our proxy style to override default disabled icon look
    if(this->get_module()->has_parameter("style"))
    {
        const std::string style = this->get_module()->get_parameter_value("style");
        qApp->setStyle(new proxy_style(QStyleFactory::create(QString::fromStdString(style))));
    }
    else
    {
        qApp->setStyle(new proxy_style);
    }

    // Load the stylesheet from the parameters
    QString style_sheet;

    if(this->get_module()->has_parameter("stylesheet"))
    {
        const auto stylesheet_value = this->get_module()->get_parameter_value("stylesheet");
        const auto path             = core::runtime::get_module_resource_file_path(stylesheet_value);

        QFile data(QString::fromStdString(path.string()));
        const bool qss_opened = data.open(QFile::ReadOnly);
        SIGHT_ASSERT("Cannot open QSS file: " << path.string(), qss_opened);

        if(qss_opened)
        {
            SIGHT_INFO("Reading QSS file: " << path.string());
            style_sheet = QTextStream(&data).readAll().trimmed();
        }
    }

    // Allow overriding with the touch-friendly style
    if(this->get_module()->get_parameter_value("touch_friendly") == "true")
    {
        const auto path = core::runtime::get_module_resource_file_path(
            "sight::module::ui::qt/touch-friendly.qss"
        );

        QFile data(QString::fromStdString(path.string()));
        const bool qss_opened = data.open(QFile::ReadOnly);
        SIGHT_ASSERT("Cannot open QSS file: " << path.string(), qss_opened);

        if(qss_opened)
        {
            SIGHT_INFO("Reading QSS file: " << path.string());
            const auto touch_style = QTextStream(&data).readAll().trimmed();

            if(!touch_style.isEmpty())
            {
                style_sheet.append("\n");
                style_sheet.append(touch_style);
            }
        }
    }

    // Style located in the application directory override everything
    if(const auto application_style = get_application_style_sheet(); !application_style.isEmpty())
    {
        style_sheet.append("\n");
        style_sheet.append(application_style);
    }

    if(!style_sheet.isEmpty())
    {
        qApp->setStyleSheet(style_sheet);
    }
}

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

} // namespace sight::module::ui::qt