teamnwah
/
openmw-tes3coop
forked from mirror/openmw-tes3mp
2
0
Fork 1
Code Issues Pull Requests 1 Releases Wiki Activity

Substantial rewrite of code to save settings.cfg file, allowing

Browse Source 
comments to persist, ordering of settings to be retained, additional
reporting of changed settings, preservation of the settings.cfg
timestamp when no changes are made, and foundational changes for
possible future features.  Due to poor interaction with the
openmw-launcher settings code, the launcher will still discard all of
these benefits.
openmw-38
cfcohen 9 years ago
parent da856eed95
commit 9a975a2e68
1 changed files with 229 additions and 12 deletions
Show Stats Download Patch File Download Diff File

241
components/settings/settings.cpp
Unescape Escape View File

@ -2,6 +2,7 @@
#include <stdexcept> #include <stdexcept>
#include <sstream> #include <sstream>
#include <iostream>
#include <components/misc/stringops.hpp> #include <components/misc/stringops.hpp>
@ -58,6 +59,7 @@ CategorySettingValueMap Manager::mDefaultSettings = CategorySettingValueMap();
CategorySettingValueMap Manager::mUserSettings = CategorySettingValueMap(); CategorySettingValueMap Manager::mUserSettings = CategorySettingValueMap();
CategorySettingVector Manager::mChangedSettings = CategorySettingVector(); CategorySettingVector Manager::mChangedSettings = CategorySettingVector();
typedef std::map< CategorySetting, bool > CategorySettingStatusMap;
class SettingsFileParser class SettingsFileParser
{ {
@ -69,6 +71,7 @@ public:
mFile = file; mFile = file;
boost::filesystem::ifstream stream; boost::filesystem::ifstream stream;
stream.open(boost::filesystem::path(file)); stream.open(boost::filesystem::path(file));
std::cout << "Loading settings file: " << file << std::endl;
std::string currentCategory; std::string currentCategory;
mLine = 0; mLine = 0;
while (!stream.eof() && !stream.fail()) while (!stream.eof() && !stream.fail())
@ -117,6 +120,230 @@ public:
} }
} }
void saveSettingsFile (const std::string& file, CategorySettingValueMap& settings)
{
// No options have been written to the file yet.
CategorySettingStatusMap written;
for (CategorySettingValueMap::iterator it = settings.begin(); it != settings.end(); ++it) {
written[it->first] = false;
}
// Have we substantively changed the settings file?
bool changed = false;
// Was there anything in the existing file? This is intended to permit the deletion of
// the settings.cfg file and it's automatic recreation -- a feature not currently
// supported elsewhere in the code.
bool existing = false;
// The category/section we're currently in.
std::string currentCategory;
// Open the existing settings.cfg file to copy comments. This might not be the same file
// as the output file if we're copying the setting from the default settings.cfg for the
// first time. A minor change in API to pass the source file might be in order here.
boost::filesystem::ifstream istream;
boost::filesystem::path ipath(file);
istream.open(ipath);
//std::cout << "Reading previous settings file: " << ipath << std::endl;
// Create a new string stream to write the current settings to. It's likely that the
// input file and the output file are the same, so this stream serves as a temporary file
// of sorts. The setting files aren't very large so there's no performance issue.
std::stringstream ostream;
// For every line in the input file...
while (!istream.eof() && !istream.fail()) {
std::string line;
std::getline(istream, line);
// The current character position in the line.
size_t i = 0;
// Don't add additional newlines at the end of the file.
if (istream.eof()) continue;
// Copy entirely blank lines.
if (!skipWhiteSpace(i, line)) {
ostream << line << std::endl;
continue;
}
// There were at least some comments in the input file.
existing = true;
// Copy comments.
if (line[i] == '#') {
ostream << line << std::endl;
continue;
}
// Category heading.
if (line[i] == '[') {
size_t end = line.find(']', i);
// This should never happen unless the player edited the file while playing.
if (end == std::string::npos) {
ostream << "# unterminated category: " << line << std::endl;
changed = true;
continue;
}
// Ensure that all options in the current category have been written.
for (CategorySettingStatusMap::iterator mit = written.begin(); mit != written.end(); ++mit) {
bool missed = false;
if (mit->second == false && mit->first.first == currentCategory) {
std::cout << "Added new setting: [" << currentCategory << "] "
<< mit->first.second << " = " << settings[mit->first] << std::endl;
// With some further code changes, this comment could be more descriptive.
ostream << "# Automatically added setting." << std::endl;
ostream << mit->first.second << " = " << settings[mit->first] << std::endl;
mit->second = true;
missed = true;
changed = true;
}
// Ensure that there's a newline before the next section if we added settings.
if (missed) ostream << std::endl;
}
// Update the current category.
currentCategory = line.substr(i+1, end - (i+1));
boost::algorithm::trim(currentCategory);
// Write the (new) current category to the file.
ostream << "[" << currentCategory << "]" << std::endl;
//std::cout << "Wrote category: " << currentCategory << std::endl;
// A setting can apparently follow the category on an input line. That's rather
// inconvenient, since it makes it more likely to have duplicative sections,
// which our algorithm doesn't like. Do the best we can.
i = end+1;
}
// Truncate trailing whitespace, since we're changing the file anayway.
if (!skipWhiteSpace(i, line))
continue;
// If we'cve found settings befor ethe first category, something's wrong. This
// should never happen unless the player edited the file while playing, since
// the loadSettingsFile() logic rejects it.
if (currentCategory.empty()) {
ostream << "# empty category name: " << line << std::endl;
changed = true;
continue;
}
// Which setting was at this location in the input file?
size_t settingEnd = line.find('=', i);
// This should never happen unless the player edited the file while playing.
if (settingEnd == std::string::npos) {
ostream << "# unterminated setting name: " << line << std::endl;
changed = true;
continue;
}
std::string setting = line.substr(i, (settingEnd-i));
boost::algorithm::trim(setting);
// Get the existing value so we can see if we've changed it.
size_t valueBegin = settingEnd+1;
std::string value = line.substr(valueBegin);
boost::algorithm::trim(value);
// Construct the setting map key to determine whether the setting has already been
// written to the file.
CategorySetting key = std::make_pair(currentCategory, setting);
CategorySettingStatusMap::iterator finder = written.find(key);
// Settings not in the written map are definitely invalid. Currently, this can only
// happen if the player edited the file while playing, because loadSettingsFile()
// will accept anything and pass it along in the map, but in the future, we might
// want to handle invalid settings more gracefully here.
if (finder == written.end()) {
ostream << "# invalid setting: " << line << std::endl;
changed = true;
continue;
}
// Write the current value of the setting to the file. The key must exist in the
// settings map because of how written was initialized and finder != end().
ostream << setting << " = " << settings[key] << std::endl;
// Mark that setting as written.
finder->second = true;
// Did we really change it?
if (value != settings[key]) {
std::cout << "Changed setting: [" << currentCategory << "] "
<< setting << " = " << settings[key] << std::endl;
changed = true;
}
// No need to write the current line, because we just emitted a replacement.
// Curiously, it appears that comments at the ends of lines with settings are not
// allowed, and the comment becomes part of the value. Was that intended?
}
// We're done with the input stream file.
istream.close();
// Ensure that all options in the current category have been written. We must complete
// the current category at the end of the file before moving on to any new categories.
for (CategorySettingStatusMap::iterator mit = written.begin(); mit != written.end(); ++mit) {
bool missed = false;
if (mit->second == false && mit->first.first == currentCategory) {
std::cout << "Added new setting: [" << mit->first.first << "] "
<< mit->first.second << " = " << settings[mit->first] << std::endl;
// With some further code changes, this comment could be more descriptive.
ostream << std::endl << "# Automatically added setting." << std::endl;
ostream << mit->first.second << " = " << settings[mit->first] << std::endl;
mit->second = true;
missed = true;
changed = true;
}
// Ensure that there's a newline before the next section if we added settings.
if (missed) ostream << std::endl;
}
// This logic triggers when the input file was effectively empty. It could be extended
// to doing something more intelligent instead, like make a copy of the default settings
// file (complete with comments) before continuing. Other code prevents OpenMW from
// executing to this point with a missing config file.
if (!existing) {
ostream << "# This file was automatically generated." << std::endl << std::endl;
}
// We still have one more thing to do before we're completely done writing the file.
// It's possible that there are entirely new categories, or that the input file had
// disappeared completely, so we need ensure that all settings are written to the file
// regardless of those issues.
for (CategorySettingStatusMap::iterator mit = written.begin(); mit != written.end(); ++mit) {
// If the setting hasn't been written yet.
if (mit->second == false) {
// If the catgory has changed, write a new category header.
if (mit->first.first != currentCategory) {
currentCategory = mit->first.first;
std::cout << "Created new setting section: " << mit->first.first << std::endl;
ostream << std::endl;
// Add new category comments only if we're amending an existing file.
if (existing) ostream << "# Automatically added category." << std::endl;
ostream << "[" << currentCategory << "]" << std::endl;
}
std::cout << "Added new setting: [" << mit->first.first << "] "
<< mit->first.second << " = " << settings[mit->first] << std::endl;
// Then write the setting. No need to mark it as written because we're done.
ostream << std::endl;
ostream << mit->first.second << " = " << settings[mit->first] << std::endl;
changed = true;
}
}
// Now install the newly written file in the requested place.
if (changed) {
std::cout << "Updating settings file: " << ipath << std::endl;
boost::filesystem::ofstream ofstream;
ofstream.open(ipath);
ofstream << ostream.rdbuf();
ofstream.close();
}
}
private: private:
/// Increment i until it longer points to a whitespace character /// Increment i until it longer points to a whitespace character
/// in the string or has reached the end of the string. /// in the string or has reached the end of the string.
@ -155,18 +382,8 @@ void Manager::loadUser(const std::string &file)
void Manager::saveUser(const std::string &file) void Manager::saveUser(const std::string &file)
{ {
boost::filesystem::ofstream stream; SettingsFileParser parser;
stream.open(boost::filesystem::path(file)); parser.saveSettingsFile(file, mUserSettings);
std::string currentCategory;
for (CategorySettingValueMap::iterator it = mUserSettings.begin(); it != mUserSettings.end(); ++it)
{
if (it->first.first != currentCategory)
{
currentCategory = it->first.first;
stream << "\n[" << currentCategory << "]\n";
}
stream << it->first.second << " = " << it->second << "\n";
}
} }
std::string Manager::getString(const std::string &setting, const std::string &category) std::string Manager::getString(const std::string &setting, const std::string &category)

Write Preview
Loading…
Cancel
Save