loot/libloot
0
0
Fork 0
mirror of https://github.com/loot/libloot.git synced 2026-07-27 14:16:01 -07:00
Code Issues Packages Projects Releases Wiki Activity

Use PluginMetadata when not dealing with files

Browse Source 
Plugin objects should represent actual files, and PluginMetadata
should be used for metadata that hasn't been linked to an
installed plugin.

As part of this, remove the unnecessary comparison operators on
Plugin and add string comparison operators for PluginMetadata.
This commit is contained in:
Oliver Hamlet
2015-12-05 10:17:46 +00:00
parent 13060bb0cf
commit 41b32b2011
7 changed files with 94 additions and 101 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/api/api.cpp
+6 -6
View File
@@ -767,8 +767,8 @@ LOOT_API unsigned int loot_get_dirty_info(loot_db db, const char * const plugin,
*needsCleaning = loot_needs_cleaning_unknown;
// Is there any dirty info? Testing for applicability happens in loot_eval_lists().
if (!db->masterlist.FindPlugin(loot::Plugin(plugin)).DirtyInfo().empty()
|| !db->userlist.FindPlugin(loot::Plugin(plugin)).DirtyInfo().empty()) {
if (!db->masterlist.FindPlugin(loot::PluginMetadata(plugin)).DirtyInfo().empty()
|| !db->userlist.FindPlugin(loot::PluginMetadata(plugin)).DirtyInfo().empty()) {
*needsCleaning = loot_needs_cleaning_yes;
}
@@ -776,9 +776,9 @@ LOOT_API unsigned int loot_get_dirty_info(loot_db db, const char * const plugin,
// This isn't a very reliable system, because if the lists have been evaluated in some language
// other than English, the strings will be in different languages (and the API can't tell what they'd be)
// and the strings may be non-standard and begin with something other than "Do not clean." anyway.
std::list<loot::Message> messages(db->masterlist.FindPlugin(loot::Plugin(plugin)).Messages());
std::list<loot::Message> messages(db->masterlist.FindPlugin(loot::PluginMetadata(plugin)).Messages());
std::list<loot::Message> temp(db->userlist.FindPlugin(loot::Plugin(plugin)).Messages());
std::list<loot::Message> temp(db->userlist.FindPlugin(loot::PluginMetadata(plugin)).Messages());
messages.insert(messages.end(), temp.begin(), temp.end());
for (const auto& message : messages) {
@@ -806,9 +806,9 @@ LOOT_API unsigned int loot_write_minimal_list(loot_db db, const char * const out
return c_error(loot_error_file_write_fail, "Output file exists but overwrite is not set to true.");
loot::Masterlist temp = db->masterlist;
std::unordered_set<loot::Plugin> minimalPlugins;
std::unordered_set<loot::PluginMetadata> minimalPlugins;
for (const auto &plugin : temp.Plugins()) {
loot::Plugin p(plugin.Name());
loot::PluginMetadata p(plugin.Name());
p.Tags(plugin.Tags());
p.DirtyInfo(plugin.DirtyInfo());
minimalPlugins.insert(p);
src/backend/metadata/plugin_metadata.cpp
+11
View File
@@ -360,6 +360,17 @@ namespace loot {
bool PluginMetadata::operator != (const PluginMetadata& rhs) const {
return !(*this == rhs);
}
bool PluginMetadata::operator == (const std::string& rhs) const {
if (IsRegexPlugin())
return regex_match(PluginMetadata(rhs).Name(), regex(name, regex::ECMAScript | regex::icase));
else
return boost::iequals(name, PluginMetadata(rhs).Name());
}
bool PluginMetadata::operator != (const std::string& rhs) const {
return !(*this == rhs);
}
}
namespace YAML {
src/backend/metadata/plugin_metadata.h
+4
View File
@@ -96,6 +96,10 @@ namespace loot {
//Compare name strings.
bool operator == (const PluginMetadata& rhs) const;
bool operator != (const PluginMetadata& rhs) const;
//Compare name string.
bool operator == (const std::string& rhs) const;
bool operator != (const std::string& rhs) const;
protected:
std::string name;
bool enabled; //Default to true.
src/backend/plugin/plugin.cpp
-8
View File
@@ -166,14 +166,6 @@ namespace loot {
BOOST_LOG_TRIVIAL(trace) << name << ": " << "Plugin loading complete.";
}
bool Plugin::operator == (const Plugin& rhs) const {
return PluginMetadata(name) == PluginMetadata(rhs.Name());
}
bool Plugin::operator != (const Plugin& rhs) const {
return !(*this == rhs);
}
const std::set<libespm::FormId>& Plugin::FormIDs() const {
return formIDs;
}
src/backend/plugin/plugin.h
-4
View File
@@ -56,10 +56,6 @@ namespace loot {
bool LoadsBSA(const Game& game) const;
bool IsActive(const Game& game) const;
//Compare name strings.
bool operator == (const Plugin& rhs) const;
bool operator != (const Plugin& rhs) const;
//Load ordering functions.
bool DoFormIDsOverlap(const Plugin& plugin) const;
std::set<libespm::FormId> OverlapFormIDs(const Plugin& plugin) const;
src/gui/handler.cpp
+1 -1
View File
@@ -464,7 +464,7 @@ namespace loot {
std::string Handler::ClearPluginMetadata(const std::string& pluginName) {
BOOST_LOG_TRIVIAL(debug) << "Clearing user metadata for plugin " << pluginName;
_lootState.CurrentGame().userlist.ErasePlugin(Plugin(pluginName));
_lootState.CurrentGame().userlist.ErasePlugin(PluginMetadata(pluginName));
// Save userlist edits.
_lootState.CurrentGame().userlist.Save(_lootState.CurrentGame().UserlistPath());
src/tests/backend/test_plugin_sorter.h
+72 -82
View File
@@ -40,6 +40,22 @@ protected:
callback = [](const std::string&) {};
}
inline std::list<std::string> GetExpectedSortedOrder() const {
return std::list<std::string>({
"Skyrim.esm",
"Blank.esm",
"Blank - Different.esm",
"Blank - Master Dependent.esm",
"Blank - Different Master Dependent.esm",
"Blank.esp",
"Blank - Different.esp",
"Blank - Master Dependent.esp",
"Blank - Different Master Dependent.esp",
"Blank - Plugin Dependent.esp",
"Blank - Different Plugin Dependent.esp",
});
}
loot::Game game;
std::function<void(const std::string&)> callback;
};
@@ -54,84 +70,54 @@ TEST_F(PluginSorter, Sort) {
ASSERT_NO_THROW(game.LoadPlugins(false));
loot::PluginSorter ps;
std::list<std::string> expectedSortedOrder = GetExpectedSortedOrder();
std::list<loot::Plugin> sorted = ps.Sort(game, loot::Language::english, callback);
EXPECT_EQ(std::list<loot::Plugin>({
loot::Plugin("Skyrim.esm"),
loot::Plugin("Blank.esm"),
loot::Plugin("Blank - Different.esm"),
loot::Plugin("Blank - Master Dependent.esm"),
loot::Plugin("Blank - Different Master Dependent.esm"),
loot::Plugin("Blank.esp"),
loot::Plugin("Blank - Different.esp"),
loot::Plugin("Blank - Master Dependent.esp"),
loot::Plugin("Blank - Different Master Dependent.esp"),
loot::Plugin("Blank - Plugin Dependent.esp"),
loot::Plugin("Blank - Different Plugin Dependent.esp"),
}), sorted);
EXPECT_TRUE(std::equal(begin(sorted), end(sorted), begin(expectedSortedOrder)));
// Check stability.
sorted = ps.Sort(game, loot::Language::english, callback);
EXPECT_EQ(std::list<loot::Plugin>({
loot::Plugin("Skyrim.esm"),
loot::Plugin("Blank.esm"),
loot::Plugin("Blank - Different.esm"),
loot::Plugin("Blank - Master Dependent.esm"),
loot::Plugin("Blank - Different Master Dependent.esm"),
loot::Plugin("Blank.esp"),
loot::Plugin("Blank - Different.esp"),
loot::Plugin("Blank - Master Dependent.esp"),
loot::Plugin("Blank - Different Master Dependent.esp"),
loot::Plugin("Blank - Plugin Dependent.esp"),
loot::Plugin("Blank - Different Plugin Dependent.esp"),
}), sorted);
EXPECT_TRUE(std::equal(begin(sorted), end(sorted), begin(expectedSortedOrder)));
}
TEST_F(PluginSorter, Sort_HeadersOnly) {
ASSERT_NO_THROW(game.LoadPlugins(true));
loot::PluginSorter ps;
std::list<std::string> expectedSortedOrder = GetExpectedSortedOrder();
std::list<loot::Plugin> sorted = ps.Sort(game, loot::Language::english, callback);
EXPECT_EQ(std::list<loot::Plugin>({
loot::Plugin("Skyrim.esm"),
loot::Plugin("Blank.esm"),
loot::Plugin("Blank - Different.esm"),
loot::Plugin("Blank - Master Dependent.esm"),
loot::Plugin("Blank - Different Master Dependent.esm"),
loot::Plugin("Blank.esp"),
loot::Plugin("Blank - Different.esp"),
loot::Plugin("Blank - Master Dependent.esp"),
loot::Plugin("Blank - Different Master Dependent.esp"),
loot::Plugin("Blank - Plugin Dependent.esp"),
loot::Plugin("Blank - Different Plugin Dependent.esp"),
}), sorted);
EXPECT_TRUE(std::equal(begin(sorted), end(sorted), begin(expectedSortedOrder)));
}
TEST_F(PluginSorter, Sort_WithPriority) {
ASSERT_NO_THROW(game.LoadPlugins(false));
loot::Plugin plugin("Blank - Different Master Dependent.esp");
loot::PluginMetadata plugin("Blank - Different Master Dependent.esp");
plugin.Priority(-1100000);
game.userlist.AddPlugin(plugin);
loot::PluginSorter ps;
std::list<std::string> expectedSortedOrder({
"Skyrim.esm",
"Blank.esm",
"Blank - Different.esm",
"Blank - Master Dependent.esm",
"Blank - Different Master Dependent.esm",
"Blank - Different Master Dependent.esp",
"Blank.esp",
"Blank - Different.esp",
"Blank - Master Dependent.esp",
"Blank - Plugin Dependent.esp",
"Blank - Different Plugin Dependent.esp",
});
std::list<loot::Plugin> sorted = ps.Sort(game, loot::Language::english, callback);
EXPECT_EQ(std::list<loot::Plugin>({
loot::Plugin("Skyrim.esm"),
loot::Plugin("Blank.esm"),
loot::Plugin("Blank - Different.esm"),
loot::Plugin("Blank - Master Dependent.esm"),
loot::Plugin("Blank - Different Master Dependent.esm"),
loot::Plugin("Blank - Different Master Dependent.esp"),
loot::Plugin("Blank.esp"),
loot::Plugin("Blank - Different.esp"),
loot::Plugin("Blank - Master Dependent.esp"),
loot::Plugin("Blank - Plugin Dependent.esp"),
loot::Plugin("Blank - Different Plugin Dependent.esp"),
}), sorted);
EXPECT_TRUE(std::equal(begin(sorted), end(sorted), begin(expectedSortedOrder)));
}
TEST_F(PluginSorter, Sort_WithLoadAfter) {
ASSERT_NO_THROW(game.LoadPlugins(false));
loot::Plugin plugin("Blank.esp");
loot::PluginMetadata plugin("Blank.esp");
plugin.LoadAfter({
loot::File("Blank - Different.esp"),
loot::File("Blank - Different Plugin Dependent.esp"),
@@ -139,25 +125,27 @@ TEST_F(PluginSorter, Sort_WithLoadAfter) {
game.userlist.AddPlugin(plugin);
loot::PluginSorter ps;
std::list<std::string> expectedSortedOrder({
"Skyrim.esm",
"Blank.esm",
"Blank - Different.esm",
"Blank - Master Dependent.esm",
"Blank - Different Master Dependent.esm",
"Blank - Different.esp",
"Blank - Master Dependent.esp",
"Blank - Different Master Dependent.esp",
"Blank - Different Plugin Dependent.esp",
"Blank.esp",
"Blank - Plugin Dependent.esp",
});
std::list<loot::Plugin> sorted = ps.Sort(game, loot::Language::english, callback);
EXPECT_EQ(std::list<loot::Plugin>({
loot::Plugin("Skyrim.esm"),
loot::Plugin("Blank.esm"),
loot::Plugin("Blank - Different.esm"),
loot::Plugin("Blank - Master Dependent.esm"),
loot::Plugin("Blank - Different Master Dependent.esm"),
loot::Plugin("Blank - Different.esp"),
loot::Plugin("Blank - Master Dependent.esp"),
loot::Plugin("Blank - Different Master Dependent.esp"),
loot::Plugin("Blank - Different Plugin Dependent.esp"),
loot::Plugin("Blank.esp"),
loot::Plugin("Blank - Plugin Dependent.esp"),
}), sorted);
EXPECT_TRUE(std::equal(begin(sorted), end(sorted), begin(expectedSortedOrder)));
}
TEST_F(PluginSorter, Sort_WithRequirements) {
ASSERT_NO_THROW(game.LoadPlugins(false));
loot::Plugin plugin("Blank.esp");
loot::PluginMetadata plugin("Blank.esp");
plugin.Reqs({
loot::File("Blank - Different.esp"),
loot::File("Blank - Different Plugin Dependent.esp"),
@@ -165,25 +153,27 @@ TEST_F(PluginSorter, Sort_WithRequirements) {
game.userlist.AddPlugin(plugin);
loot::PluginSorter ps;
std::list<std::string> expectedSortedOrder({
"Skyrim.esm",
"Blank.esm",
"Blank - Different.esm",
"Blank - Master Dependent.esm",
"Blank - Different Master Dependent.esm",
"Blank - Different.esp",
"Blank - Master Dependent.esp",
"Blank - Different Master Dependent.esp",
"Blank - Different Plugin Dependent.esp",
"Blank.esp",
"Blank - Plugin Dependent.esp",
});
std::list<loot::Plugin> sorted = ps.Sort(game, loot::Language::english, callback);
EXPECT_EQ(std::list<loot::Plugin>({
loot::Plugin("Skyrim.esm"),
loot::Plugin("Blank.esm"),
loot::Plugin("Blank - Different.esm"),
loot::Plugin("Blank - Master Dependent.esm"),
loot::Plugin("Blank - Different Master Dependent.esm"),
loot::Plugin("Blank - Different.esp"),
loot::Plugin("Blank - Master Dependent.esp"),
loot::Plugin("Blank - Different Master Dependent.esp"),
loot::Plugin("Blank - Different Plugin Dependent.esp"),
loot::Plugin("Blank.esp"),
loot::Plugin("Blank - Plugin Dependent.esp"),
}), sorted);
EXPECT_TRUE(std::equal(begin(sorted), end(sorted), begin(expectedSortedOrder)));
}
TEST_F(PluginSorter, Sort_HasCycle) {
ASSERT_NO_THROW(game.LoadPlugins(false));
loot::Plugin plugin("Blank.esm");
loot::PluginMetadata plugin("Blank.esm");
plugin.LoadAfter({loot::File("Blank - Master Dependent.esm")});
game.userlist.AddPlugin(plugin);