citra/src/yuzu/game_list.h

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