Add Group class to API

2026-07-27 14:16:01 -07:00 · 2018-03-17 18:26:36 +00:00
parent fdb4e46542
commit f2a63cb3eb
6 changed files with 396 additions and 0 deletions
@@ -0,0 +1,105 @@
+/*  LOOT
+
+    A load order optimisation tool for Oblivion, Skyrim, Fallout 3 and
+    Fallout: New Vegas.
+
+    Copyright (C) 2018    WrinklyNinja
+
+    This file is part of LOOT.
+
+    LOOT is free software: you can redistribute
+    it and/or modify it under the terms of the GNU General Public License
+    as published by the Free Software Foundation, either version 3 of
+    the License, or (at your option) any later version.
+
+    LOOT is distributed in the hope that it will
+    be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with LOOT.  If not, see
+    <https://www.gnu.org/licenses/>.
+    */
+#ifndef LOOT_METADATA_GROUP
+#define LOOT_METADATA_GROUP
+
+#include <unordered_set>
+#include <string>
+
+#include "loot/api_decorator.h"
+
+namespace loot {
+/**
+ * Represents a group to which plugin metadata objects can belong.
+ */
+class Group {
+public:
+  /**
+   * Construct a Group with the name "default" and an empty set of groups to
+   * load after.
+   * @return A Group object.
+   */
+  LOOT_API Group();
+
+  /**
+   * Construct a File with the given name and an empty set of groups to load
+   * after.
+   * @param  name
+   *         The group name.
+   * @return A Group object.
+   */
+  LOOT_API Group(const std::string& name);
+
+  /**
+   * Construct a File with the given name and set of groups to load after.
+   * @param  name
+   *         The group name.
+   * @param  afterGroups
+   *         The names of groups this group loads after.
+   * @return A Group object.
+   */
+  LOOT_API Group(const std::string& name,
+                 const std::unordered_set<std::string>& afterGroups);
+
+  /**
+   * Check if two Group objects are equal by comparing their names.
+   * @returns True if the names are case-sensitively equal, false otherwise.
+   */
+  LOOT_API bool operator==(const Group& rhs) const;
+
+  /**
+   * Get the name of the group.
+   * @return The group's name.
+   */
+  LOOT_API std::string GetName() const;
+
+  /**
+   * Get the set of groups this group loads after.
+   * @return A set of group names.
+   */
+  LOOT_API std::unordered_set<std::string> GetAfterGroups() const;
+
+private:
+  std::string name_;
+  std::unordered_set<std::string> afterGroups_;
+};
+}
+
+namespace std {
+/**
+ * A specialisation of std::hash for loot::Group.
+ */
+template<>
+struct hash<loot::Group> {
+  /**
+   * Calculate a hash value for a loot::Group object.
+   * @return The hash generated from the group's name.
+   */
+  size_t operator()(const loot::Group& group) const {
+    return hash<string>()(group.GetName());
+  }
+};
+}
+
+#endif