Codechange: Split GetGroup into GetGroup/GetOrCreateGroup.

This follows the pattern used for GetItem/GetOrCreateItem, and allows use
of references where we know the group must exist.
This commit is contained in:
Peter Nelson 2023-10-10 19:25:58 +01:00 committed by Peter Nelson
parent 54b1a067eb
commit 6ce7195ef1
4 changed files with 36 additions and 26 deletions

View File

@ -292,9 +292,9 @@ void HotkeyList::Load(IniFile &ini)
*/ */
void HotkeyList::Save(IniFile &ini) const void HotkeyList::Save(IniFile &ini) const
{ {
IniGroup *group = ini.GetGroup(this->ini_group); IniGroup &group = ini.GetOrCreateGroup(this->ini_group);
for (const Hotkey &hotkey : this->items) { for (const Hotkey &hotkey : this->items) {
IniItem &item = group->GetOrCreateItem(hotkey.name); IniItem &item = group.GetOrCreateItem(hotkey.name);
item.SetValue(SaveKeycodes(hotkey)); item.SetValue(SaveKeycodes(hotkey));
} }
} }

View File

@ -193,6 +193,21 @@ IniGroup *IniLoadFile::GetGroup(const std::string &name, bool create_new)
return &this->CreateGroup(name); return &this->CreateGroup(name);
} }
/**
* Get the group with the given name, and if it doesn't exist create a new group.
* @param name name of the group to find.
* @return the requested group.
*/
IniGroup &IniLoadFile::GetOrCreateGroup(const std::string &name)
{
for (IniGroup *group = this->group; group != nullptr; group = group->next) {
if (group->name == name) return *group;
}
/* Group doesn't exist, make a new one. */
return this->CreateGroup(name);
}
/** /**
* Create an group with the given name. This does not reuse an existing group of the same name. * Create an group with the given name. This does not reuse an existing group of the same name.
* @param name name of the group to create. * @param name name of the group to create.

View File

@ -63,6 +63,7 @@ struct IniLoadFile {
virtual ~IniLoadFile(); virtual ~IniLoadFile();
IniGroup *GetGroup(const std::string &name, bool create_new = true); IniGroup *GetGroup(const std::string &name, bool create_new = true);
IniGroup &GetOrCreateGroup(const std::string &name);
IniGroup &CreateGroup(const std::string &name); IniGroup &CreateGroup(const std::string &name);
void RemoveGroup(const std::string &name); void RemoveGroup(const std::string &name);

View File

@ -676,10 +676,10 @@ static void IniSaveSettings(IniFile &ini, const SettingTable &settings_table, co
std::string s{ sd->GetName() }; std::string s{ sd->GetName() };
auto sc = s.find('.'); auto sc = s.find('.');
if (sc != std::string::npos) { if (sc != std::string::npos) {
group = ini.GetGroup(s.substr(0, sc)); group = &ini.GetOrCreateGroup(s.substr(0, sc));
s = s.substr(sc + 1); s = s.substr(sc + 1);
} else { } else {
if (group_def == nullptr) group_def = ini.GetGroup(grpname); if (group_def == nullptr) group_def = &ini.GetOrCreateGroup(grpname);
group = group_def; group = group_def;
} }
@ -799,13 +799,11 @@ static void IniLoadSettingList(IniFile &ini, const char *grpname, StringList &li
*/ */
static void IniSaveSettingList(IniFile &ini, const char *grpname, StringList &list) static void IniSaveSettingList(IniFile &ini, const char *grpname, StringList &list)
{ {
IniGroup *group = ini.GetGroup(grpname); IniGroup &group = ini.GetOrCreateGroup(grpname);
group.Clear();
if (group == nullptr) return;
group->Clear();
for (const auto &iter : list) { for (const auto &iter : list) {
group->GetOrCreateItem(iter).SetValue(""); group.GetOrCreateItem(iter).SetValue("");
} }
} }
@ -1105,10 +1103,8 @@ static IniFileVersion LoadVersionFromConfig(IniFile &ini)
static void AISaveConfig(IniFile &ini, const char *grpname) static void AISaveConfig(IniFile &ini, const char *grpname)
{ {
IniGroup *group = ini.GetGroup(grpname); IniGroup &group = ini.GetOrCreateGroup(grpname);
group.Clear();
if (group == nullptr) return;
group->Clear();
for (CompanyID c = COMPANY_FIRST; c < MAX_COMPANIES; c++) { for (CompanyID c = COMPANY_FIRST; c < MAX_COMPANIES; c++) {
AIConfig *config = AIConfig::GetConfig(c, AIConfig::SSS_FORCE_NEWGAME); AIConfig *config = AIConfig::GetConfig(c, AIConfig::SSS_FORCE_NEWGAME);
@ -1121,16 +1117,14 @@ static void AISaveConfig(IniFile &ini, const char *grpname)
name = "none"; name = "none";
} }
group->CreateItem(name).SetValue(value); group.CreateItem(name).SetValue(value);
} }
} }
static void GameSaveConfig(IniFile &ini, const char *grpname) static void GameSaveConfig(IniFile &ini, const char *grpname)
{ {
IniGroup *group = ini.GetGroup(grpname); IniGroup &group = ini.GetOrCreateGroup(grpname);
group.Clear();
if (group == nullptr) return;
group->Clear();
GameConfig *config = GameConfig::GetConfig(AIConfig::SSS_FORCE_NEWGAME); GameConfig *config = GameConfig::GetConfig(AIConfig::SSS_FORCE_NEWGAME);
std::string name; std::string name;
@ -1142,7 +1136,7 @@ static void GameSaveConfig(IniFile &ini, const char *grpname)
name = "none"; name = "none";
} }
group->CreateItem(name).SetValue(value); group.CreateItem(name).SetValue(value);
} }
/** /**
@ -1151,23 +1145,23 @@ static void GameSaveConfig(IniFile &ini, const char *grpname)
*/ */
static void SaveVersionInConfig(IniFile &ini) static void SaveVersionInConfig(IniFile &ini)
{ {
IniGroup *group = ini.GetGroup("version"); IniGroup &group = ini.GetOrCreateGroup("version");
group->GetOrCreateItem("version_string").SetValue(_openttd_revision); group.GetOrCreateItem("version_string").SetValue(_openttd_revision);
group->GetOrCreateItem("version_number").SetValue(fmt::format("{:08X}", _openttd_newgrf_version)); group.GetOrCreateItem("version_number").SetValue(fmt::format("{:08X}", _openttd_newgrf_version));
group->GetOrCreateItem("ini_version").SetValue(std::to_string(INIFILE_VERSION)); group.GetOrCreateItem("ini_version").SetValue(std::to_string(INIFILE_VERSION));
} }
/* Save a GRF configuration to the given group name */ /* Save a GRF configuration to the given group name */
static void GRFSaveConfig(IniFile &ini, const char *grpname, const GRFConfig *list) static void GRFSaveConfig(IniFile &ini, const char *grpname, const GRFConfig *list)
{ {
ini.RemoveGroup(grpname); IniGroup &group = ini.GetOrCreateGroup(grpname);
IniGroup *group = ini.GetGroup(grpname); group.Clear();
const GRFConfig *c; const GRFConfig *c;
for (c = list; c != nullptr; c = c->next) { for (c = list; c != nullptr; c = c->next) {
std::string key = fmt::format("{:08X}|{}|{}", BSWAP32(c->ident.grfid), std::string key = fmt::format("{:08X}|{}|{}", BSWAP32(c->ident.grfid),
FormatArrayAsHex(c->ident.md5sum), c->filename); FormatArrayAsHex(c->ident.md5sum), c->filename);
group->GetOrCreateItem(key).SetValue(GRFBuildParamList(c)); group.GetOrCreateItem(key).SetValue(GRFBuildParamList(c));
} }
} }