yuzu-fork/src/yuzu/compatdb.cpp

211 lines
8.3 KiB
C++
Raw Normal View History

chore: make yuzu REUSE compliant [REUSE] is a specification that aims at making file copyright information consistent, so that it can be both human and machine readable. It basically requires that all files have a header containing copyright and licensing information. When this isn't possible, like when dealing with binary assets, generated files or embedded third-party dependencies, it is permitted to insert copyright information in the `.reuse/dep5` file. Oh, and it also requires that all the licenses used in the project are present in the `LICENSES` folder, that's why the diff is so huge. This can be done automatically with `reuse download --all`. The `reuse` tool also contains a handy subcommand that analyzes the project and tells whether or not the project is (still) compliant, `reuse lint`. Following REUSE has a few advantages over the current approach: - Copyright information is easy to access for users / downstream - Files like `dist/license.md` do not need to exist anymore, as `.reuse/dep5` is used instead - `reuse lint` makes it easy to ensure that copyright information of files like binary assets / images is always accurate and up to date To add copyright information of files that didn't have it I looked up who committed what and when, for each file. As yuzu contributors do not have to sign a CLA or similar I couldn't assume that copyright ownership was of the "yuzu Emulator Project", so I used the name and/or email of the commit author instead. [REUSE]: https://reuse.software Follow-up to 01cf05bc75b1e47beb08937439f3ed9339e7b254
2022-05-15 01:06:02 +01:00
// SPDX-FileCopyrightText: 2017 Citra Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
2018-09-16 19:05:51 +01:00
#include <QButtonGroup>
#include <QMessageBox>
#include <QPushButton>
#include <QtConcurrent/qtconcurrentrun.h>
2018-09-16 19:05:51 +01:00
#include "common/logging/log.h"
#include "common/telemetry.h"
#include "core/telemetry_session.h"
#include "ui_compatdb.h"
#include "yuzu/compatdb.h"
CompatDB::CompatDB(Core::TelemetrySession& telemetry_session_, QWidget* parent)
2018-09-16 19:05:51 +01:00
: QWizard(parent, Qt::WindowTitleHint | Qt::WindowCloseButtonHint | Qt::WindowSystemMenuHint),
ui{std::make_unique<Ui::CompatDB>()}, telemetry_session{telemetry_session_} {
2018-09-16 19:05:51 +01:00
ui->setupUi(this);
connect(ui->radioButton_GameBoot_Yes, &QRadioButton::clicked, this, &CompatDB::EnableNext);
connect(ui->radioButton_GameBoot_No, &QRadioButton::clicked, this, &CompatDB::EnableNext);
connect(ui->radioButton_Gameplay_Yes, &QRadioButton::clicked, this, &CompatDB::EnableNext);
connect(ui->radioButton_Gameplay_No, &QRadioButton::clicked, this, &CompatDB::EnableNext);
connect(ui->radioButton_NoFreeze_Yes, &QRadioButton::clicked, this, &CompatDB::EnableNext);
connect(ui->radioButton_NoFreeze_No, &QRadioButton::clicked, this, &CompatDB::EnableNext);
connect(ui->radioButton_Complete_Yes, &QRadioButton::clicked, this, &CompatDB::EnableNext);
connect(ui->radioButton_Complete_No, &QRadioButton::clicked, this, &CompatDB::EnableNext);
connect(ui->radioButton_Graphical_Major, &QRadioButton::clicked, this, &CompatDB::EnableNext);
connect(ui->radioButton_Graphical_Minor, &QRadioButton::clicked, this, &CompatDB::EnableNext);
connect(ui->radioButton_Graphical_No, &QRadioButton::clicked, this, &CompatDB::EnableNext);
connect(ui->radioButton_Audio_Major, &QRadioButton::clicked, this, &CompatDB::EnableNext);
connect(ui->radioButton_Audio_Minor, &QRadioButton::clicked, this, &CompatDB::EnableNext);
connect(ui->radioButton_Audio_No, &QRadioButton::clicked, this, &CompatDB::EnableNext);
2018-09-16 19:05:51 +01:00
connect(button(NextButton), &QPushButton::clicked, this, &CompatDB::Submit);
connect(&testcase_watcher, &QFutureWatcher<bool>::finished, this,
&CompatDB::OnTestcaseSubmitted);
2018-09-16 19:05:51 +01:00
}
CompatDB::~CompatDB() = default;
2018-09-17 16:16:01 +01:00
enum class CompatDBPage {
Intro = 0,
GameBoot = 1,
GamePlay = 2,
Freeze = 3,
Completion = 4,
Graphical = 5,
Audio = 6,
Final = 7,
2018-09-17 16:16:01 +01:00
};
2018-09-16 19:05:51 +01:00
void CompatDB::Submit() {
QButtonGroup* compatibility_GameBoot = new QButtonGroup(this);
compatibility_GameBoot->addButton(ui->radioButton_GameBoot_Yes, 0);
compatibility_GameBoot->addButton(ui->radioButton_GameBoot_No, 1);
QButtonGroup* compatibility_Gameplay = new QButtonGroup(this);
compatibility_Gameplay->addButton(ui->radioButton_Gameplay_Yes, 0);
compatibility_Gameplay->addButton(ui->radioButton_Gameplay_No, 1);
QButtonGroup* compatibility_NoFreeze = new QButtonGroup(this);
compatibility_NoFreeze->addButton(ui->radioButton_NoFreeze_Yes, 0);
compatibility_NoFreeze->addButton(ui->radioButton_NoFreeze_No, 1);
QButtonGroup* compatibility_Complete = new QButtonGroup(this);
compatibility_Complete->addButton(ui->radioButton_Complete_Yes, 0);
compatibility_Complete->addButton(ui->radioButton_Complete_No, 1);
QButtonGroup* compatibility_Graphical = new QButtonGroup(this);
compatibility_Graphical->addButton(ui->radioButton_Graphical_Major, 0);
compatibility_Graphical->addButton(ui->radioButton_Graphical_Minor, 1);
compatibility_Graphical->addButton(ui->radioButton_Graphical_No, 2);
QButtonGroup* compatibility_Audio = new QButtonGroup(this);
compatibility_Audio->addButton(ui->radioButton_Audio_Major, 0);
compatibility_Graphical->addButton(ui->radioButton_Audio_Minor, 1);
compatibility_Audio->addButton(ui->radioButton_Audio_No, 2);
2023-03-12 03:10:38 +00:00
const int compatibility = static_cast<int>(CalculateCompatibility());
2018-09-16 19:05:51 +01:00
switch ((static_cast<CompatDBPage>(currentId()))) {
case CompatDBPage::Intro:
break;
case CompatDBPage::GameBoot:
if (compatibility_GameBoot->checkedId() == -1) {
button(NextButton)->setEnabled(false);
}
break;
case CompatDBPage::GamePlay:
if (compatibility_Gameplay->checkedId() == -1) {
button(NextButton)->setEnabled(false);
}
break;
case CompatDBPage::Freeze:
if (compatibility_NoFreeze->checkedId() == -1) {
button(NextButton)->setEnabled(false);
}
break;
case CompatDBPage::Completion:
if (compatibility_Complete->checkedId() == -1) {
button(NextButton)->setEnabled(false);
}
break;
case CompatDBPage::Graphical:
if (compatibility_Graphical->checkedId() == -1) {
button(NextButton)->setEnabled(false);
}
break;
case CompatDBPage::Audio:
if (compatibility_Audio->checkedId() == -1) {
2018-09-16 19:05:51 +01:00
button(NextButton)->setEnabled(false);
}
break;
case CompatDBPage::Final:
back();
2023-03-12 03:10:38 +00:00
LOG_INFO(Frontend, "Compatibility Rating: {}", compatibility);
telemetry_session.AddField(Common::Telemetry::FieldType::UserFeedback, "Compatibility",
2023-03-12 03:10:38 +00:00
compatibility);
button(NextButton)->setEnabled(false);
button(NextButton)->setText(tr("Submitting"));
button(CancelButton)->setVisible(false);
testcase_watcher.setFuture(
QtConcurrent::run([this] { return telemetry_session.SubmitTestcase(); }));
2018-09-16 19:05:51 +01:00
break;
default:
LOG_ERROR(Frontend, "Unexpected page: {}", currentId());
break;
2018-09-16 19:05:51 +01:00
}
}
int CompatDB::nextId() const {
switch ((static_cast<CompatDBPage>(currentId()))) {
case CompatDBPage::Intro:
return static_cast<int>(CompatDBPage::GameBoot);
case CompatDBPage::GameBoot:
if (ui->radioButton_GameBoot_No->isChecked()) {
return static_cast<int>(CompatDBPage::Final);
}
return static_cast<int>(CompatDBPage::GamePlay);
case CompatDBPage::GamePlay:
if (ui->radioButton_Gameplay_No->isChecked()) {
return static_cast<int>(CompatDBPage::Final);
}
return static_cast<int>(CompatDBPage::Freeze);
case CompatDBPage::Freeze:
if (ui->radioButton_NoFreeze_No->isChecked()) {
return static_cast<int>(CompatDBPage::Final);
}
return static_cast<int>(CompatDBPage::Completion);
case CompatDBPage::Completion:
if (ui->radioButton_Complete_No->isChecked()) {
return static_cast<int>(CompatDBPage::Final);
}
return static_cast<int>(CompatDBPage::Graphical);
case CompatDBPage::Graphical:
return static_cast<int>(CompatDBPage::Audio);
case CompatDBPage::Audio:
return static_cast<int>(CompatDBPage::Final);
case CompatDBPage::Final:
return -1;
default:
LOG_ERROR(Frontend, "Unexpected page: {}", currentId());
return static_cast<int>(CompatDBPage::Intro);
}
}
CompatibilityStatus CompatDB::CalculateCompatibility() const {
if (ui->radioButton_GameBoot_No->isChecked()) {
return CompatibilityStatus::WontBoot;
}
if (ui->radioButton_Gameplay_No->isChecked()) {
return CompatibilityStatus::IntroMenu;
}
if (ui->radioButton_NoFreeze_No->isChecked() || ui->radioButton_Complete_No->isChecked()) {
return CompatibilityStatus::Ingame;
}
if (ui->radioButton_Graphical_Major->isChecked() || ui->radioButton_Audio_Major->isChecked()) {
return CompatibilityStatus::Ingame;
}
if (ui->radioButton_Graphical_Minor->isChecked() || ui->radioButton_Audio_Minor->isChecked()) {
return CompatibilityStatus::Playable;
}
return CompatibilityStatus::Perfect;
}
void CompatDB::OnTestcaseSubmitted() {
if (!testcase_watcher.result()) {
QMessageBox::critical(this, tr("Communication error"),
2021-01-02 14:00:05 +00:00
tr("An error occurred while sending the Testcase"));
button(NextButton)->setEnabled(true);
button(NextButton)->setText(tr("Next"));
button(CancelButton)->setVisible(true);
} else {
next();
// older versions of QT don't support the "NoCancelButtonOnLastPage" option, this is a
// workaround
button(CancelButton)->setVisible(false);
}
}
2018-09-16 19:05:51 +01:00
void CompatDB::EnableNext() {
button(NextButton)->setEnabled(true);
}