dolphin/Source/Core/DolphinQt/Settings.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

208 lines
5.8 KiB
C
Raw Normal View History

// Copyright 2015 Dolphin Emulator Project
// Licensed under GPLv2+
// Refer to the license.txt file included.
#pragma once
2017-08-01 12:55:21 +02:00
#include <memory>
2018-02-14 23:25:01 +01:00
#include <QFont>
#include <QObject>
#include <QSettings>
#include "DiscIO/Enums.h"
namespace Core
{
enum class State;
}
namespace DiscIO
{
enum class Language;
}
namespace NetPlay
{
class NetPlayClient;
class NetPlayServer;
} // namespace NetPlay
2017-05-20 17:53:17 +02:00
class InputConfig;
// UI settings to be stored in the config directory.
Remove NonCopyable The class NonCopyable is, like the name says, supposed to disallow copying. But should it allow moving? For a long time, NonCopyable used to not allow moving. (It declared a deleted copy constructor and assigment operator without declaring a move constructor and assignment operator, making the compiler implicitly delete the move constructor and assignment operator.) That's fine if the classes that inherit from NonCopyable don't need to be movable or if writing the move constructor and assignment operator by hand is fine, but that's not the case for all classes, as I discovered when I was working on the DirectoryBlob PR. Because of that, I decided to make NonCopyable movable in c7602cc, allowing me to use NonCopyable in DirectoryBlob.h. That was however an unfortunate decision, because some of the classes that inherit from NonCopyable have incorrect behavior when moved by default- generated move constructors and assignment operators, and do not explicitly delete the move constructors and assignment operators, relying on NonCopyable being non-movable. So what can we do about this? There are four solutions that I can think of: 1. Make NonCopyable non-movable and tell DirectoryBlob to suck it. 2. Keep allowing moving NonCopyable, and expect that classes that don't support moving will delete the move constructor and assignment operator manually. Not only is this inconsistent (having classes disallow copying one way and disallow moving another way), but deleting the move constructor and assignment operator manually is too easy to forget compared to how tricky the resulting problems are. 3. Have one "MovableNonCopyable" and one "NonMovableNonCopyable". It works, but it feels rather silly... 4. Don't have a NonCopyable class at all. Considering that deleting the copy constructor and assignment operator only takes two lines of code, I don't see much of a reason to keep NonCopyable. I suppose that there was more of a point in having NonCopyable back in the pre-C++11 days, when it wasn't possible to use "= delete". I decided to go with the fourth one (like the commit title says). The implementation of the commit is fairly straight-forward, though I would like to point out that I skipped adding "= delete" lines for classes whose only reason for being uncopyable is that they contain uncopyable classes like File::IOFile and std::unique_ptr, because the compiler makes such classes uncopyable automatically.
2017-08-04 23:57:12 +02:00
class Settings final : public QObject
{
Q_OBJECT
public:
Remove NonCopyable The class NonCopyable is, like the name says, supposed to disallow copying. But should it allow moving? For a long time, NonCopyable used to not allow moving. (It declared a deleted copy constructor and assigment operator without declaring a move constructor and assignment operator, making the compiler implicitly delete the move constructor and assignment operator.) That's fine if the classes that inherit from NonCopyable don't need to be movable or if writing the move constructor and assignment operator by hand is fine, but that's not the case for all classes, as I discovered when I was working on the DirectoryBlob PR. Because of that, I decided to make NonCopyable movable in c7602cc, allowing me to use NonCopyable in DirectoryBlob.h. That was however an unfortunate decision, because some of the classes that inherit from NonCopyable have incorrect behavior when moved by default- generated move constructors and assignment operators, and do not explicitly delete the move constructors and assignment operators, relying on NonCopyable being non-movable. So what can we do about this? There are four solutions that I can think of: 1. Make NonCopyable non-movable and tell DirectoryBlob to suck it. 2. Keep allowing moving NonCopyable, and expect that classes that don't support moving will delete the move constructor and assignment operator manually. Not only is this inconsistent (having classes disallow copying one way and disallow moving another way), but deleting the move constructor and assignment operator manually is too easy to forget compared to how tricky the resulting problems are. 3. Have one "MovableNonCopyable" and one "NonMovableNonCopyable". It works, but it feels rather silly... 4. Don't have a NonCopyable class at all. Considering that deleting the copy constructor and assignment operator only takes two lines of code, I don't see much of a reason to keep NonCopyable. I suppose that there was more of a point in having NonCopyable back in the pre-C++11 days, when it wasn't possible to use "= delete". I decided to go with the fourth one (like the commit title says). The implementation of the commit is fairly straight-forward, though I would like to point out that I skipped adding "= delete" lines for classes whose only reason for being uncopyable is that they contain uncopyable classes like File::IOFile and std::unique_ptr, because the compiler makes such classes uncopyable automatically.
2017-08-04 23:57:12 +02:00
Settings(const Settings&) = delete;
Settings& operator=(const Settings&) = delete;
Settings(Settings&&) = delete;
Settings& operator=(Settings&&) = delete;
~Settings();
static Settings& Instance();
static QSettings& GetQSettings();
// UI
void SetThemeName(const QString& theme_name);
void SetCurrentUserStyle(const QString& stylesheet_name);
2018-05-06 18:25:37 +02:00
QString GetCurrentUserStyle() const;
void SetUserStylesEnabled(bool enabled);
bool AreUserStylesEnabled() const;
void GetToolTipStyle(QColor& window_color, QColor& text_color, QColor& emphasis_text_color,
QColor& border_color, const QPalette& palette,
const QPalette& high_contrast_palette) const;
bool IsLogVisible() const;
void SetLogVisible(bool visible);
bool IsLogConfigVisible() const;
void SetLogConfigVisible(bool visible);
2018-04-19 11:32:00 +02:00
void SetToolBarVisible(bool visible);
bool IsToolBarVisible() const;
void SetWidgetsLocked(bool visible);
bool AreWidgetsLocked() const;
void RefreshWidgetVisibility();
// GameList
QStringList GetPaths() const;
void AddPath(const QString& path);
void RemovePath(const QString& path);
bool GetPreferredView() const;
void SetPreferredView(bool list);
QString GetDefaultGame() const;
void SetDefaultGame(QString path);
2018-07-06 20:27:07 +02:00
void RefreshGameList();
void NotifyRefreshGameListStarted();
void NotifyRefreshGameListComplete();
void RefreshMetadata();
void NotifyMetadataRefreshComplete();
2018-06-04 21:44:46 +02:00
void ReloadTitleDB();
2018-06-06 10:52:27 +02:00
bool IsAutoRefreshEnabled() const;
void SetAutoRefreshEnabled(bool enabled);
// Emulation
int GetStateSlot() const;
void SetStateSlot(int);
2018-04-29 19:13:40 +02:00
bool IsBatchModeEnabled() const;
void SetBatchModeEnabled(bool batch);
bool IsSDCardInserted() const;
void SetSDCardInserted(bool inserted);
bool IsUSBKeyboardConnected() const;
void SetUSBKeyboardConnected(bool connected);
// Graphics
2017-06-01 08:49:06 +02:00
void SetHideCursor(bool hide_cursor);
bool GetHideCursor() const;
void SetLockCursor(bool lock_cursor);
bool GetLockCursor() const;
2018-04-22 10:56:15 +02:00
void SetKeepWindowOnTop(bool top);
bool IsKeepWindowOnTopEnabled() const;
2017-05-08 19:03:59 +02:00
2017-06-21 10:26:06 +02:00
// Audio
int GetVolume() const;
void SetVolume(int volume);
void IncreaseVolume(int volume);
void DecreaseVolume(int volume);
2017-08-01 12:55:21 +02:00
// NetPlay
std::shared_ptr<NetPlay::NetPlayClient> GetNetPlayClient();
void ResetNetPlayClient(NetPlay::NetPlayClient* client = nullptr);
std::shared_ptr<NetPlay::NetPlayServer> GetNetPlayServer();
void ResetNetPlayServer(NetPlay::NetPlayServer* server = nullptr);
2017-08-01 12:55:21 +02:00
2017-08-30 21:00:59 +02:00
// Cheats
bool GetCheatsEnabled() const;
void SetCheatsEnabled(bool enabled);
2017-09-19 14:14:45 +02:00
// Debug
void SetDebugModeEnabled(bool enabled);
bool IsDebugModeEnabled() const;
void SetRegistersVisible(bool enabled);
bool IsRegistersVisible() const;
void SetThreadsVisible(bool enabled);
bool IsThreadsVisible() const;
2017-09-27 08:53:05 +02:00
void SetWatchVisible(bool enabled);
bool IsWatchVisible() const;
void SetBreakpointsVisible(bool enabled);
bool IsBreakpointsVisible() const;
2018-02-14 23:25:01 +01:00
void SetCodeVisible(bool enabled);
bool IsCodeVisible() const;
2018-03-16 12:39:53 +01:00
void SetMemoryVisible(bool enabled);
bool IsMemoryVisible() const;
void SetNetworkVisible(bool enabled);
bool IsNetworkVisible() const;
2018-04-09 15:31:20 +02:00
void SetJITVisible(bool enabled);
bool IsJITVisible() const;
2018-02-14 23:25:01 +01:00
QFont GetDebugFont() const;
void SetDebugFont(QFont font);
2017-09-19 14:14:45 +02:00
2018-03-22 12:20:15 +01:00
// Auto-Update
QString GetAutoUpdateTrack() const;
void SetAutoUpdateTrack(const QString& mode);
// Fallback Region
DiscIO::Region GetFallbackRegion() const;
void SetFallbackRegion(const DiscIO::Region& region);
// Analytics
bool IsAnalyticsEnabled() const;
void SetAnalyticsEnabled(bool enabled);
signals:
void ConfigChanged();
void EmulationStateChanged(Core::State new_state);
void ThemeChanged();
void PathAdded(const QString&);
void PathRemoved(const QString&);
void DefaultGameChanged(const QString&);
2018-07-06 20:27:07 +02:00
void GameListRefreshRequested();
void GameListRefreshStarted();
void GameListRefreshCompleted();
2018-06-04 21:44:46 +02:00
void TitleDBReloadRequested();
void MetadataRefreshRequested();
void MetadataRefreshCompleted();
2018-06-06 10:52:27 +02:00
void AutoRefreshToggled(bool enabled);
2017-06-01 08:49:06 +02:00
void HideCursorChanged();
void LockCursorChanged();
2018-04-22 10:56:15 +02:00
void KeepWindowOnTopChanged(bool top);
2017-06-21 10:26:06 +02:00
void VolumeChanged(int volume);
2017-07-06 11:01:32 +02:00
void NANDRefresh();
void RegistersVisibilityChanged(bool visible);
void ThreadsVisibilityChanged(bool visible);
void LogVisibilityChanged(bool visible);
void LogConfigVisibilityChanged(bool visible);
2018-04-19 11:32:00 +02:00
void ToolBarVisibilityChanged(bool visible);
void WidgetLockChanged(bool locked);
2017-08-30 21:00:59 +02:00
void EnableCheatsChanged(bool enabled);
2017-09-27 08:53:05 +02:00
void WatchVisibilityChanged(bool visible);
void BreakpointsVisibilityChanged(bool visible);
2018-02-14 23:25:01 +01:00
void CodeVisibilityChanged(bool visible);
2018-03-16 12:39:53 +01:00
void MemoryVisibilityChanged(bool visible);
void NetworkVisibilityChanged(bool visible);
2018-04-09 15:31:20 +02:00
void JITVisibilityChanged(bool visible);
2017-09-19 14:14:45 +02:00
void DebugModeToggled(bool enabled);
2018-02-14 23:25:01 +01:00
void DebugFontChanged(QFont font);
2018-03-22 12:20:15 +01:00
void AutoUpdateTrackChanged(const QString& mode);
void FallbackRegionChanged(const DiscIO::Region& region);
void AnalyticsToggled(bool enabled);
void ReleaseDevices();
void DevicesChanged();
void SDCardInsertionChanged(bool inserted);
void USBKeyboardConnectionChanged(bool connected);
private:
2018-04-29 19:13:40 +02:00
bool m_batch = false;
std::shared_ptr<NetPlay::NetPlayClient> m_client;
std::shared_ptr<NetPlay::NetPlayServer> m_server;
Settings();
};
Q_DECLARE_METATYPE(Core::State);