Skip to content

Commit

Permalink
Refactor|Profiles|Client|libcore: ConfigProfiles uses de::Profiles fo…
Browse files Browse the repository at this point in the history 
…r serialization

de::Profiles handles the file I/O and Info parsing. The parsed elements
are given to the subclass for processing.
  • Loading branch information
@skyjake
skyjake committed Mar 4, 2016
1 parent 799110e commit c584801
Show file tree
Hide file tree
Showing 4 changed files with 272 additions and 27 deletions.
4 changes: 4 additions & 0 deletions doomsday/apps/client/include/configprofiles.h
View file
Expand Up @@ -125,6 +125,10 @@ class ConfigProfiles : public de::Profiles
*/
void deleteProfile(de::String const &name);

protected:
AbstractProfile *profileFromInfoBlock(
de::Info::BlockElement const &block) override;

private:
DENG2_PRIVATE(d)
};
Expand Down
116 changes: 91 additions & 25 deletions doomsday/apps/client/src/configprofiles.cpp
View file
Expand Up @@ -93,16 +93,15 @@ DENG2_PIMPL(ConfigProfiles)
{
typedef QMap<String, QVariant> Values;
Values values;
bool readOnly = false; ///< Profile has been loaded from a read-only file, won't be serialized.

ConfigProfiles &owner()
{
return static_cast<ConfigProfiles &>(AbstractProfile::owner());
}

bool isReadOnly() const override
ConfigProfiles const &owner() const
{
return readOnly;
return static_cast<ConfigProfiles const &>(AbstractProfile::owner());
}

bool resetToDefaults() override
Expand All @@ -114,6 +113,64 @@ DENG2_PIMPL(ConfigProfiles)
}
return false;
}

String toInfoSource() const
{
auto const &settings = owner().d->settings;

String info;
QTextStream os(&info);
os.setCodec("UTF-8");

DENG2_FOR_EACH_CONST(Values, val, values)
{
DENG2_ASSERT(settings.contains(val.key()));

Setting const &st = settings[val.key()];

String valueText;
switch(st.type)
{
case IntCVar:
case FloatCVar:
case StringCVar:
case ConfigVariable:
// QVariant can handle this.
valueText = val.value().toString();
break;
}

os << "setting \"" << st.name << "\" {\n"
<< " value: " << valueText << "\n"
<< "}";
}

return info;
}

void initializeFromInfoBlock(ConfigProfiles const &profs,
de::Info::BlockElement const &block)
{
// Use the default settings for anything not defined in the file.
values = profs.d->defaults.values;

// Read all the setting values from the profile block.
foreach(auto const *element, block.contentsInOrder())
{
if(!element->isBlock()) continue;

de::Info::BlockElement const &setBlock = element->as<de::Info::BlockElement>();

// Only process known settings.
if(setBlock.blockType() == "setting" &&
profs.d->settings.contains(setBlock.name()))
{
values[setBlock.name()] =
profs.d->textToSettingValue(setBlock.keyValue("value").text,
setBlock.name());
}
}
}
};

Profile defaults;
Expand Down Expand Up @@ -193,7 +250,7 @@ DENG2_PIMPL(ConfigProfiles)
void fetch(String const &profileName)
{
Profile &prof = self.find(profileName).as<Profile>();
if(prof.readOnly) return;
if(prof.isReadOnly()) return;

foreach(Setting const &st, settings.values())
{
Expand Down Expand Up @@ -302,16 +359,6 @@ DENG2_PIMPL(ConfigProfiles)
return self.persistentName().concatenateMember("profile");
}

/**
* For a persistent register, determines the file name of the Info file
* where all the profile values are written to and read from.
*/
String fileName() const
{
if(self.persistentName().isEmpty()) return "";
return String("/home/configs/%1.dei").arg(self.persistentName());
}

QVariant textToSettingValue(String const &text, String const &settingName) const
{
DENG2_ASSERT(settings.contains(settingName));
Expand All @@ -337,6 +384,7 @@ DENG2_PIMPL(ConfigProfiles)
return QVariant();
}

#if 0
void loadProfilesFromInfo(File const &file, bool markReadOnly)
{
try
Expand Down Expand Up @@ -365,7 +413,7 @@ DENG2_PIMPL(ConfigProfiles)
LOG_VERBOSE("Reading profile '%s'") << profileName;

Profile *prof = addProfile(profileName);
if(markReadOnly) prof->readOnly = true;
if(markReadOnly) prof->setReadOnly(true);

// Use the default settings for anything not defined in the file.
prof->values = defaults.values;
Expand All @@ -391,6 +439,7 @@ DENG2_PIMPL(ConfigProfiles)
<< file.description() << er.asText();
}
}
#endif

bool addCustomProfileIfMissing()
{
Expand All @@ -413,11 +462,14 @@ DENG2_PIMPL(ConfigProfiles)
*/
void currentGameChanged(Game const &newGame)
{
if(self.persistentName().isEmpty() || newGame.isNull()) return;
if(!self.isPersistent() || newGame.isNull()) return;

LOG_AS("ConfigProfiles");
LOG_DEBUG("Game has been loaded, deserializing %s profiles") << self.persistentName();

self.deserialize();

#if 0
self.clear();

// Read all fixed profiles from */profiles/(persistentName)/
Expand Down Expand Up @@ -445,15 +497,18 @@ DENG2_PIMPL(ConfigProfiles)
loadProfilesFromInfo(*file, false /* modifiable */);
}
else
#endif
//{

// Settings haven't previously been created -- make sure we at least
// have the Custom profile.
if(addCustomProfileIfMissing())
{
// Settings haven't previously been created -- make sure we at least
// have the Custom profile.
if(addCustomProfileIfMissing())
{
current = CUSTOM_PROFILE;
}
current = CUSTOM_PROFILE;
}

//}

// Still nothing?
addCustomProfileIfMissing();

Expand Down Expand Up @@ -492,7 +547,7 @@ DENG2_PIMPL(ConfigProfiles)
*/
void aboutToUnloadGame(Game const &gameBeingUnloaded)
{
if(self.persistentName().isEmpty() || gameBeingUnloaded.isNull()) return;
if(!self.isPersistent() || gameBeingUnloaded.isNull()) return;

LOG_AS("ConfigProfiles");
LOG_DEBUG("Game being unloaded, serializing %s profiles") << self.persistentName();
Expand All @@ -503,8 +558,10 @@ DENG2_PIMPL(ConfigProfiles)
// Remember which profile is the current one.
App::config().set(confName(), current);

self.serialize();

// We will write one Info file with all the profiles.
String info;
/*String info;
QTextStream os(&info);
os.setCodec("UTF-8");
Expand All @@ -515,7 +572,7 @@ DENG2_PIMPL(ConfigProfiles)
self.forAll([this, &os, &count] (AbstractProfile &prof)
{
Profile &profile = prof.as<Profile>();
if(profile.readOnly) return LoopContinue;
if(profile.isReadOnly()) return LoopContinue;
++count;
Expand Down Expand Up @@ -554,6 +611,7 @@ DENG2_PIMPL(ConfigProfiles)
outFile.flush(); // we're done
LOG_VERBOSE("Wrote \"%s\" with %i profile%s") << fileName() << count << (count != 1? "s" : "");
*/
}
};

Expand Down Expand Up @@ -642,3 +700,11 @@ void ConfigProfiles::deleteProfile(String const &name)
delete prof;
}
}

Profiles::AbstractProfile *
ConfigProfiles::profileFromInfoBlock(de::Info::BlockElement const &block)
{
std::unique_ptr<Instance::Profile> prof(new Instance::Profile);
prof->initializeFromInfoBlock(*this, block);
return prof.release();
}
31 changes: 30 additions & 1 deletion doomsday/sdk/libcore/include/de/data/profiles.h
View file
Expand Up @@ -20,6 +20,7 @@
#define DENG2_PROFILES_H

#include <de/String>
#include <de/Info>

namespace de {

Expand Down Expand Up @@ -76,10 +77,18 @@ class DENG2_PUBLIC Profiles
*
* @return @c true, if the profile is read-only.
*/
virtual bool isReadOnly() const = 0;
bool isReadOnly() const;

void setReadOnly(bool readOnly);

virtual bool resetToDefaults() = 0;

/**
* Serializes the contents of the profile to a text string using Info
* source syntax.
*/
virtual String toInfoSource() const = 0;

DENG2_AS_IS_METHODS()

private:
Expand All @@ -106,6 +115,8 @@ class DENG2_PUBLIC Profiles

String persistentName() const;

bool isPersistent() const;

/**
* Lists the names of all the existing profiles.
*/
Expand Down Expand Up @@ -142,6 +153,24 @@ class DENG2_PUBLIC Profiles
*/
void remove(AbstractProfile &profile);

/**
* Serializes all the profiles to /home/configs/(persistentName).dei. Only
* non-readonly profiles are written. Nothing happens
*/
void serialize() const;

/**
* Deserializes all the profiles from /profiles/(persistentName).dei and
* /home/configs/(persistentName).dei.
*
* All existing profiles in the collection are deleted beforehand.
*/
void deserialize();

protected:
virtual AbstractProfile *profileFromInfoBlock(
de::Info::BlockElement const &block) = 0;

private:
DENG2_PRIVATE(d)
};
Expand Down

0 comments on commit c584801

Please sign in to comment.