Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

keep window positions #1432

Merged
merged 11 commits into from
Sep 2, 2021
Merged

keep window positions #1432

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
bb56cec
keep window positions
JonathanSteinbuch Dec 28, 2020
d00ae02
Make clang-tidy happier
JonathanSteinbuch Aug 21, 2021
f6f4397
Some changes as suggested by @Flow86 and @Flamefire
JonathanSteinbuch Aug 23, 2021
ad1d8f9
Changed window persistent settings access to using an iterator and using
JonathanSteinbuch Aug 23, 2021
c4155b2
Add try-catch blocks so destructors don't pass through exceptions
JonathanSteinbuch Aug 23, 2021
34c7642
removed unreferenced variable
JonathanSteinbuch Aug 23, 2021
9db12c1
moved econhandler creation back to Game::Start()
JonathanSteinbuch Aug 24, 2021
49e0339
formatting
JonathanSteinbuch Aug 24, 2021
40ff690
removed settings calls from destructors
JonathanSteinbuch Aug 25, 2021
478cb65
make new functions const
JonathanSteinbuch Aug 25, 2021
96bbe0a
mygettext
JonathanSteinbuch Sep 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions libs/rttrConfig/src/files.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ namespace resources {
constexpr auto boot_z = "<RTTR_GAME>/DATA/BOOT_Z.LST";
constexpr auto carrier = "<RTTR_GAME>/DATA/BOBS/CARRIER.BOB";
constexpr auto config = "<RTTR_CONFIG>/CONFIG.INI"; // main config file
constexpr auto ingameOptions = "<RTTR_CONFIG>/IngameOptions.ini";
constexpr auto io = "<RTTR_GAME>/DATA/IO/IO.DAT";
constexpr auto jobs = "<RTTR_GAME>/DATA/BOBS/JOBS.BOB";
constexpr auto mis0bobs = "<RTTR_GAME>/DATA/MIS0BOBS.LST";
Expand Down
1 change: 1 addition & 0 deletions libs/s25main/Game.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
// SPDX-License-Identifier: GPL-2.0-or-later

#include "Game.h"
#include "EconomyModeHandler.h"
#include "EventManager.h"
#include "GameInterface.h"
#include "GamePlayer.h"
Expand Down
148 changes: 127 additions & 21 deletions libs/s25main/Settings.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,15 @@
// SPDX-License-Identifier: GPL-2.0-or-later

#include "Settings.h"
#include "DrawPoint.h"
#include "RTTR_Version.h"
#include "RttrConfig.h"
#include "drivers/AudioDriverWrapper.h"
#include "drivers/VideoDriverWrapper.h"
#include "files.h"
#include "helpers/strUtils.h"
#include "languages.h"
#include "gameData/const_gui_ids.h"
#include "libsiedler2/ArchivItem_Ini.h"
#include "libsiedler2/ArchivItem_Text.h"
#include "libsiedler2/libsiedler2.h"
Expand All @@ -19,12 +21,30 @@
#include <boost/filesystem/operations.hpp>

const int Settings::VERSION = 13;
const std::array<std::string, 11> Settings::SECTION_NAMES = {
{"global", "video", "language", "driver", "sound", "lobby", "server", "proxy", "interface", "ingame", "addons"}};
const std::array<std::string, 10> Settings::SECTION_NAMES = {
{"global", "video", "language", "driver", "sound", "lobby", "server", "proxy", "interface", "addons"}};

const std::array<short, 13> Settings::SCREEN_REFRESH_RATES = {
{-1, 25, 30, 50, 60, 75, 80, 100, 120, 150, 180, 200, 240}};

const std::map<GUI_ID, std::string> persistentWindows = {{CGI_CHAT, "wnd_chat"},
{CGI_POSTOFFICE, "wnd_postoffice"},
{CGI_DISTRIBUTION, "wnd_distribution"},
{CGI_BUILDORDER, "wnd_buildorder"},
{CGI_TRANSPORT, "wnd_transport"},
{CGI_MILITARY, "wnd_military"},
{CGI_TOOLS, "wnd_tools"},
{CGI_INVENTORY, "wnd_inventory"},
{CGI_MINIMAP, "wnd_minimap"},
{CGI_BUILDINGS, "wnd_buildings"},
{CGI_BUILDINGSPRODUCTIVITY, "wnd_buildingsproductivity"},
{CGI_MUSICPLAYER, "wnd_musicplayer"},
{CGI_STATISTICS, "wnd_statistics"},
{CGI_ECONOMICPROGRESS, "wnd_economicprogress"},
{CGI_DIPLOMACY, "wnd_diplomacy"},
{CGI_SHIP, "wnd_ship"},
{CGI_MERCHANDISE_STATISTICS, "wnd_merchandise_statistics"}};

namespace validate {
boost::optional<uint16_t> checkPort(const std::string& port)
{
Expand Down Expand Up @@ -120,14 +140,29 @@ void Settings::LoadDefaults()
interface.revert_mouse = false;
// }

// addons
// {
addons.configuration.clear();
// }

LoadIngameDefaults();
}

void Settings::LoadIngameDefaults()
{
// ingame
// {
ingame.scale_statistics = false;
ingame.showBQ = false;
ingame.showNames = false;
ingame.showProductivity = false;
ingame.minimapExtended = false;
// }

// addons
// windows
// {
addons.configuration.clear();
for(const auto& window : persistentWindows)
windows.persistentSettings[window.first] = PersistentWindowSettings();
// }
}

Expand All @@ -139,7 +174,7 @@ void Settings::Load()
const auto settingsPath = RTTRCONFIG.ExpandPath(s25::resources::config);
try
{
if(libsiedler2::Load(settingsPath, settings) != 0 || settings.size() != SECTION_NAMES.size())
if(libsiedler2::Load(settingsPath, settings) != 0 || settings.size() < SECTION_NAMES.size())
throw std::runtime_error("File missing or invalid");

const libsiedler2::ArchivItem_Ini* iniGlobal =
Expand All @@ -156,14 +191,12 @@ void Settings::Load()
const libsiedler2::ArchivItem_Ini* iniProxy = static_cast<libsiedler2::ArchivItem_Ini*>(settings.find("proxy"));
const libsiedler2::ArchivItem_Ini* iniInterface =
static_cast<libsiedler2::ArchivItem_Ini*>(settings.find("interface"));
const libsiedler2::ArchivItem_Ini* iniIngame =
static_cast<libsiedler2::ArchivItem_Ini*>(settings.find("ingame"));
const libsiedler2::ArchivItem_Ini* iniAddons =
static_cast<libsiedler2::ArchivItem_Ini*>(settings.find("addons"));

// ist eine der Kategorien nicht vorhanden?
if(!iniGlobal || !iniVideo || !iniLanguage || !iniDriver || !iniSound || !iniLobby || !iniServer || !iniProxy
|| !iniInterface || !iniIngame || !iniAddons)
|| !iniInterface || !iniAddons)
{
throw std::runtime_error("Missing section");
}
Expand Down Expand Up @@ -267,11 +300,6 @@ void Settings::Load()
interface.revert_mouse = (iniInterface->getValueI("revert_mouse") != 0);
// }

// ingame
// {
ingame.scale_statistics = (iniIngame->getValueI("scale_statistics") != 0);
// }

// addons
// {
for(unsigned addon = 0; addon < iniAddons->size(); ++addon)
Expand All @@ -282,8 +310,9 @@ void Settings::Load()
addons.configuration.insert(std::make_pair(s25util::fromStringClassic<unsigned>(item->getName()),
s25util::fromStringClassic<unsigned>(item->getText())));
}
// }

LoadIngame();
// }
} catch(std::runtime_error& e)
{
s25util::warning(std::string("Could not use settings from \"") + settingsPath.string()
Expand All @@ -293,6 +322,46 @@ void Settings::Load()
}
}

void Settings::LoadIngame()
{
libsiedler2::Archiv settingsIngame;
const auto settingsPathIngame = RTTRCONFIG.ExpandPath(s25::resources::ingameOptions);
try
{
if(libsiedler2::Load(settingsPathIngame, settingsIngame) != 0)
throw std::runtime_error("File missing");

const libsiedler2::ArchivItem_Ini* iniIngame =
static_cast<libsiedler2::ArchivItem_Ini*>(settingsIngame.find("ingame"));
if(!iniIngame)
throw std::runtime_error("Missing section");
// ingame
// {
ingame.scale_statistics = (iniIngame->getValueI("scale_statistics") != 0);
ingame.showBQ = (iniIngame->getValueI("show_building_quality") != 0);
ingame.showNames = (iniIngame->getValueI("show_names") != 0);
ingame.showProductivity = (iniIngame->getValueI("show_productivity") != 0);
ingame.minimapExtended = (iniIngame->getValueI("minimap_extended") != 0);
// }
// ingame windows
for(const auto& window : persistentWindows)
{
const auto* iniWindow = static_cast<const libsiedler2::ArchivItem_Ini*>(settingsIngame.find(window.second));
if(!iniWindow)
continue;
windows.persistentSettings[window.first].lastPos.x = iniWindow->getValueI("pos_x");
windows.persistentSettings[window.first].lastPos.y = iniWindow->getValueI("pos_y");
windows.persistentSettings[window.first].isOpen = iniWindow->getValueI("is_open");
}
} catch(std::runtime_error& e)
{
s25util::warning(std::string("Could not use ingame settings from \"") + settingsPathIngame.string()
+ "\", using default values. Reason: " + e.what());
LoadIngameDefaults();
SaveIngame();
}
}

///////////////////////////////////////////////////////////////////////////////
// Routine zum Speichern der Konfiguration
void Settings::Save()
Expand All @@ -311,12 +380,11 @@ void Settings::Save()
libsiedler2::ArchivItem_Ini* iniServer = static_cast<libsiedler2::ArchivItem_Ini*>(settings.find("server"));
libsiedler2::ArchivItem_Ini* iniProxy = static_cast<libsiedler2::ArchivItem_Ini*>(settings.find("proxy"));
libsiedler2::ArchivItem_Ini* iniInterface = static_cast<libsiedler2::ArchivItem_Ini*>(settings.find("interface"));
libsiedler2::ArchivItem_Ini* iniIngame = static_cast<libsiedler2::ArchivItem_Ini*>(settings.find("ingame"));
libsiedler2::ArchivItem_Ini* iniAddons = static_cast<libsiedler2::ArchivItem_Ini*>(settings.find("addons"));

// ist eine der Kategorien nicht vorhanden?
RTTR_Assert(iniGlobal && iniVideo && iniLanguage && iniDriver && iniSound && iniLobby && iniServer && iniProxy
&& iniInterface && iniIngame && iniAddons);
&& iniInterface && iniAddons);

// global
// {
Expand Down Expand Up @@ -387,11 +455,6 @@ void Settings::Save()
iniInterface->setValue("revert_mouse", (interface.revert_mouse ? 1 : 0));
// }

// ingame
// {
iniIngame->setValue("scale_statistics", (ingame.scale_statistics ? 1 : 0));
// }

// addons
// {
iniAddons->clear();
Expand All @@ -402,4 +465,47 @@ void Settings::Save()
bfs::path settingsPath = RTTRCONFIG.ExpandPath(s25::resources::config);
if(libsiedler2::Write(settingsPath, settings) == 0)
bfs::permissions(settingsPath, bfs::owner_read | bfs::owner_write);

SaveIngame();
}

void Settings::SaveIngame()
{
libsiedler2::Archiv settingsIngame;
settingsIngame.alloc(1 + persistentWindows.size());
settingsIngame.set(0, std::make_unique<libsiedler2::ArchivItem_Ini>("ingame"));
unsigned i = 1;
for(const auto& window : persistentWindows)
{
settingsIngame.set(i, std::make_unique<libsiedler2::ArchivItem_Ini>(window.second));
i++;
}

auto* iniIngame = static_cast<libsiedler2::ArchivItem_Ini*>(settingsIngame.find("ingame"));

RTTR_Assert(iniIngame);

// ingame
// {
iniIngame->setValue("scale_statistics", (ingame.scale_statistics ? 1 : 0));
iniIngame->setValue("show_building_quality", (ingame.showBQ ? 1 : 0));
iniIngame->setValue("show_names", (ingame.showNames ? 1 : 0));
iniIngame->setValue("show_productivity", (ingame.showProductivity ? 1 : 0));
iniIngame->setValue("minimap_extended", (ingame.minimapExtended ? 1 : 0));
// }

// ingame windows
for(const auto& window : persistentWindows)
{
auto* iniWindow = static_cast<libsiedler2::ArchivItem_Ini*>(settingsIngame.find(window.second));
if(!iniWindow)
continue;
iniWindow->setValue("pos_x", windows.persistentSettings[window.first].lastPos.x);
iniWindow->setValue("pos_y", windows.persistentSettings[window.first].lastPos.y);
iniWindow->setValue("is_open", windows.persistentSettings[window.first].isOpen);
}

bfs::path settingsPathIngame = RTTRCONFIG.ExpandPath(s25::resources::ingameOptions);
if(libsiedler2::Write(settingsPathIngame, settingsIngame) == 0)
bfs::permissions(settingsPathIngame, bfs::owner_read | bfs::owner_write);
}
26 changes: 25 additions & 1 deletion libs/s25main/Settings.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@

#pragma once

#include "DrawPoint.h"
#include "driver/VideoMode.h"
#include "s25util/ProxySettings.h"
#include "s25util/Singleton.h"
#include <boost/optional.hpp>
#include <array>
#include <gameData/const_gui_ids.h>
#include <map>
#include <string>

Expand All @@ -19,6 +21,15 @@ boost::optional<uint16_t> checkPort(const std::string& port);
bool checkPort(int port);
} // namespace validate

struct PersistentWindowSettings
{
DrawPoint lastPos;
bool isOpen;

PersistentWindowSettings(DrawPoint lastPos, bool isOpen) : lastPos(lastPos), isOpen(isOpen) {}
PersistentWindowSettings() : lastPos(DrawPoint::Invalid()), isOpen(false) {}
};

/// Configuration class
class Settings : public Singleton<Settings, SingletonPolicies::WithLongevity>
{
Expand All @@ -32,6 +43,10 @@ class Settings : public Singleton<Settings, SingletonPolicies::WithLongevity>

protected:
void LoadDefaults();
void LoadIngameDefaults();

void LoadIngame();
void SaveIngame();

public:
struct
Expand Down Expand Up @@ -96,8 +111,17 @@ class Settings : public Singleton<Settings, SingletonPolicies::WithLongevity>
struct
{
bool scale_statistics;
bool showNames;
bool showProductivity;
bool showBQ;
bool minimapExtended;
} ingame;

struct
{
std::map<GUI_ID, PersistentWindowSettings> persistentSettings;
} windows;

struct
{
std::map<unsigned, unsigned> configuration;
Expand All @@ -107,7 +131,7 @@ class Settings : public Singleton<Settings, SingletonPolicies::WithLongevity>

private:
static const int VERSION;
static const std::array<std::string, 11> SECTION_NAMES;
static const std::array<std::string, 10> SECTION_NAMES;
};

#define SETTINGS Settings::inst()
Loading