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-14 19:06:02 -05:00
|
|
|
// SPDX-FileCopyrightText: 2015 Citra Emulator Project
|
|
|
|
// SPDX-License-Identifier: GPL-2.0-or-later
|
2015-08-31 23:35:33 -05:00
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
2017-02-23 15:29:00 -06:00
|
|
|
#include <QFileSystemWatcher>
|
2017-04-29 21:04:39 -05:00
|
|
|
#include <QLabel>
|
|
|
|
#include <QLineEdit>
|
2019-05-04 18:52:17 -05:00
|
|
|
#include <QList>
|
2015-08-31 23:35:33 -05:00
|
|
|
#include <QStandardItemModel>
|
|
|
|
#include <QString>
|
|
|
|
#include <QTreeView>
|
2017-04-29 21:04:39 -05:00
|
|
|
#include <QVBoxLayout>
|
2019-06-07 17:51:58 -05:00
|
|
|
#include <QVector>
|
2015-08-31 23:35:33 -05:00
|
|
|
#include <QWidget>
|
|
|
|
|
2018-09-02 09:53:06 -05:00
|
|
|
#include "common/common_types.h"
|
2021-12-25 13:27:52 -06:00
|
|
|
#include "core/core.h"
|
2019-08-22 07:37:31 -05:00
|
|
|
#include "uisettings.h"
|
2018-09-09 18:09:37 -05:00
|
|
|
#include "yuzu/compatibility_list.h"
|
2018-09-02 09:53:06 -05:00
|
|
|
|
2021-12-25 13:27:52 -06:00
|
|
|
namespace Core {
|
|
|
|
class System;
|
|
|
|
}
|
|
|
|
|
2021-11-27 23:26:51 -06:00
|
|
|
class ControllerNavigation;
|
2015-08-31 23:35:33 -05:00
|
|
|
class GameListWorker;
|
2018-07-23 05:43:34 -05:00
|
|
|
class GameListSearchField;
|
2019-05-01 16:21:04 -05:00
|
|
|
class GameListDir;
|
2018-08-31 11:21:34 -05:00
|
|
|
class GMainWindow;
|
2021-06-07 19:22:39 -05:00
|
|
|
enum class StartGameType;
|
2018-08-31 11:21:34 -05:00
|
|
|
|
|
|
|
namespace FileSys {
|
2019-03-04 11:40:53 -06:00
|
|
|
class ManualContentProvider;
|
2018-08-31 11:21:34 -05:00
|
|
|
class VfsFilesystem;
|
2019-03-04 11:40:53 -06:00
|
|
|
} // namespace FileSys
|
2015-08-31 23:35:33 -05:00
|
|
|
|
2018-09-19 21:09:23 -05:00
|
|
|
enum class GameListOpenTarget {
|
|
|
|
SaveData,
|
|
|
|
ModData,
|
|
|
|
};
|
2018-08-20 23:46:40 -05:00
|
|
|
|
2020-07-17 04:20:27 -05:00
|
|
|
enum class GameListRemoveTarget {
|
2021-07-11 13:39:13 -05:00
|
|
|
GlShaderCache,
|
|
|
|
VkShaderCache,
|
|
|
|
AllShaderCache,
|
2020-07-17 04:20:27 -05:00
|
|
|
CustomConfiguration,
|
2023-05-26 22:21:18 -05:00
|
|
|
CacheStorage,
|
2020-07-17 04:20:27 -05:00
|
|
|
};
|
|
|
|
|
2021-06-14 16:13:08 -05:00
|
|
|
enum class DumpRomFSTarget {
|
|
|
|
Normal,
|
|
|
|
SDMC,
|
|
|
|
};
|
|
|
|
|
2021-07-28 22:02:29 -05:00
|
|
|
enum class GameListShortcutTarget {
|
|
|
|
Desktop,
|
|
|
|
Applications,
|
|
|
|
};
|
|
|
|
|
2020-07-17 04:20:27 -05:00
|
|
|
enum class InstalledEntryType {
|
|
|
|
Game,
|
|
|
|
Update,
|
|
|
|
AddOnContent,
|
|
|
|
};
|
|
|
|
|
2015-08-31 23:35:33 -05:00
|
|
|
class GameList : public QWidget {
|
|
|
|
Q_OBJECT
|
|
|
|
|
|
|
|
public:
|
|
|
|
enum {
|
|
|
|
COLUMN_NAME,
|
2018-08-29 08:42:53 -05:00
|
|
|
COLUMN_COMPATIBILITY,
|
2018-08-25 18:06:16 -05:00
|
|
|
COLUMN_ADD_ONS,
|
2016-04-13 16:04:05 -05:00
|
|
|
COLUMN_FILE_TYPE,
|
2015-08-31 23:35:33 -05:00
|
|
|
COLUMN_SIZE,
|
|
|
|
COLUMN_COUNT, // Number of columns
|
|
|
|
};
|
|
|
|
|
2022-06-13 15:52:19 -05:00
|
|
|
explicit GameList(std::shared_ptr<FileSys::VfsFilesystem> vfs_,
|
|
|
|
FileSys::ManualContentProvider* provider_, Core::System& system_,
|
2021-07-30 08:32:26 -05:00
|
|
|
GMainWindow* parent = nullptr);
|
2015-08-31 23:35:33 -05:00
|
|
|
~GameList() override;
|
|
|
|
|
2020-09-23 10:28:08 -05:00
|
|
|
QString GetLastFilterResultItem() const;
|
|
|
|
void ClearFilter();
|
|
|
|
void SetFilterFocus();
|
|
|
|
void SetFilterVisible(bool visibility);
|
|
|
|
bool IsEmpty() const;
|
2017-04-29 21:04:39 -05:00
|
|
|
|
2018-08-29 08:42:53 -05:00
|
|
|
void LoadCompatibilityList();
|
2019-06-07 17:51:58 -05:00
|
|
|
void PopulateAsync(QVector<UISettings::GameDir>& game_dirs);
|
2015-08-31 23:35:33 -05:00
|
|
|
|
2016-01-24 14:23:55 -06:00
|
|
|
void SaveInterfaceLayout();
|
|
|
|
void LoadInterfaceLayout();
|
2015-09-07 01:51:57 -05:00
|
|
|
|
2021-12-25 13:27:52 -06:00
|
|
|
QStandardItemModel* GetModel() const;
|
|
|
|
|
2021-11-27 23:26:51 -06:00
|
|
|
/// Disables events from the emulated controller
|
|
|
|
void UnloadController();
|
|
|
|
|
2017-02-12 14:28:56 -06:00
|
|
|
static const QStringList supported_file_extensions;
|
|
|
|
|
2015-08-31 23:35:33 -05:00
|
|
|
signals:
|
2021-07-20 00:10:05 -05:00
|
|
|
void BootGame(const QString& game_path, u64 program_id, std::size_t program_index,
|
|
|
|
StartGameType type);
|
|
|
|
void GameChosen(const QString& game_path, const u64 title_id = 0);
|
2015-08-31 23:35:33 -05:00
|
|
|
void ShouldCancelWorker();
|
2020-07-19 06:14:46 -05:00
|
|
|
void OpenFolderRequested(u64 program_id, GameListOpenTarget target,
|
|
|
|
const std::string& game_path);
|
2019-02-08 02:05:51 -06:00
|
|
|
void OpenTransferableShaderCacheRequested(u64 program_id);
|
2020-07-17 04:20:27 -05:00
|
|
|
void RemoveInstalledEntryRequested(u64 program_id, InstalledEntryType type);
|
2021-05-25 19:06:06 -05:00
|
|
|
void RemoveFileRequested(u64 program_id, GameListRemoveTarget target,
|
2021-06-02 14:05:45 -05:00
|
|
|
const std::string& game_path);
|
2021-06-14 16:13:08 -05:00
|
|
|
void DumpRomFSRequested(u64 program_id, const std::string& game_path, DumpRomFSTarget target);
|
2018-09-19 21:09:23 -05:00
|
|
|
void CopyTIDRequested(u64 program_id);
|
2021-07-28 22:02:29 -05:00
|
|
|
void CreateShortcut(u64 program_id, const std::string& game_path,
|
|
|
|
GameListShortcutTarget target);
|
2018-09-09 18:35:05 -05:00
|
|
|
void NavigateToGamedbEntryRequested(u64 program_id,
|
|
|
|
const CompatibilityList& compatibility_list);
|
2018-12-04 12:34:46 -06:00
|
|
|
void OpenPerGameGeneralRequested(const std::string& file);
|
2019-05-03 12:21:57 -05:00
|
|
|
void OpenDirectory(const QString& directory);
|
2019-05-01 16:21:04 -05:00
|
|
|
void AddDirectory();
|
|
|
|
void ShowList(bool show);
|
2021-12-25 13:27:52 -06:00
|
|
|
void PopulatingCompleted();
|
2023-02-16 10:53:42 -06:00
|
|
|
void SaveConfig();
|
2015-08-31 23:35:33 -05:00
|
|
|
|
2017-04-29 21:04:39 -05:00
|
|
|
private slots:
|
2020-09-23 10:28:08 -05:00
|
|
|
void OnItemExpanded(const QModelIndex& item);
|
|
|
|
void OnTextChanged(const QString& new_text);
|
|
|
|
void OnFilterCloseClicked();
|
|
|
|
void OnUpdateThemedIcons();
|
2017-04-29 21:04:39 -05:00
|
|
|
|
2015-08-31 23:35:33 -05:00
|
|
|
private:
|
2019-05-01 16:21:04 -05:00
|
|
|
void AddDirEntry(GameListDir* entry_items);
|
|
|
|
void AddEntry(const QList<QStandardItem*>& entry_items, GameListDir* parent);
|
2016-12-11 05:17:09 -06:00
|
|
|
void ValidateEntry(const QModelIndex& item);
|
2020-09-23 10:20:10 -05:00
|
|
|
void DonePopulating(const QStringList& watch_list);
|
2016-12-11 05:17:09 -06:00
|
|
|
|
2017-02-23 15:29:00 -06:00
|
|
|
void RefreshGameDirectory();
|
2016-12-15 03:55:03 -06:00
|
|
|
|
2021-04-10 04:09:01 -05:00
|
|
|
void ToggleFavorite(u64 program_id);
|
|
|
|
void AddFavorite(u64 program_id);
|
|
|
|
void RemoveFavorite(u64 program_id);
|
|
|
|
|
2019-05-01 16:21:04 -05:00
|
|
|
void PopupContextMenu(const QPoint& menu_location);
|
2020-09-23 10:20:10 -05:00
|
|
|
void AddGamePopup(QMenu& context_menu, u64 program_id, const std::string& path);
|
2019-05-01 16:21:04 -05:00
|
|
|
void AddCustomDirPopup(QMenu& context_menu, QModelIndex selected);
|
|
|
|
void AddPermDirPopup(QMenu& context_menu, QModelIndex selected);
|
2021-04-10 04:09:01 -05:00
|
|
|
void AddFavoritesPopup(QMenu& context_menu);
|
2019-05-01 16:21:04 -05:00
|
|
|
|
2022-08-20 09:49:29 -05:00
|
|
|
void changeEvent(QEvent*) override;
|
|
|
|
void RetranslateUI();
|
|
|
|
|
2018-08-31 11:21:34 -05:00
|
|
|
std::shared_ptr<FileSys::VfsFilesystem> vfs;
|
2019-03-04 11:40:53 -06:00
|
|
|
FileSys::ManualContentProvider* provider;
|
2018-07-23 05:43:34 -05:00
|
|
|
GameListSearchField* search_field;
|
2017-04-29 21:04:39 -05:00
|
|
|
GMainWindow* main_window = nullptr;
|
|
|
|
QVBoxLayout* layout = nullptr;
|
2015-08-31 23:35:33 -05:00
|
|
|
QTreeView* tree_view = nullptr;
|
|
|
|
QStandardItemModel* item_model = nullptr;
|
|
|
|
GameListWorker* current_worker = nullptr;
|
2017-04-17 21:53:40 -05:00
|
|
|
QFileSystemWatcher* watcher = nullptr;
|
2021-11-27 23:26:51 -06:00
|
|
|
ControllerNavigation* controller_navigation = nullptr;
|
2018-09-09 18:09:37 -05:00
|
|
|
CompatibilityList compatibility_list;
|
2018-07-23 05:43:34 -05:00
|
|
|
|
|
|
|
friend class GameListSearchField;
|
2021-07-30 08:32:26 -05:00
|
|
|
|
|
|
|
Core::System& system;
|
2015-08-31 23:35:33 -05:00
|
|
|
};
|
2018-08-20 23:46:40 -05:00
|
|
|
|
2019-05-01 16:21:04 -05:00
|
|
|
class GameListPlaceholder : public QWidget {
|
|
|
|
Q_OBJECT
|
|
|
|
public:
|
|
|
|
explicit GameListPlaceholder(GMainWindow* parent = nullptr);
|
|
|
|
~GameListPlaceholder();
|
|
|
|
|
|
|
|
signals:
|
|
|
|
void AddDirectory();
|
|
|
|
|
|
|
|
private slots:
|
|
|
|
void onUpdateThemedIcons();
|
|
|
|
|
|
|
|
protected:
|
|
|
|
void mouseDoubleClickEvent(QMouseEvent* event) override;
|
|
|
|
|
|
|
|
private:
|
2022-06-10 21:17:18 -05:00
|
|
|
void changeEvent(QEvent* event) override;
|
|
|
|
void RetranslateUI();
|
|
|
|
|
2019-05-01 16:21:04 -05:00
|
|
|
QVBoxLayout* layout = nullptr;
|
|
|
|
QLabel* image = nullptr;
|
|
|
|
QLabel* text = nullptr;
|
|
|
|
};
|