Remove unused PluginCleanliness enum

CMakeLists.txt

@@ -165,7 +165,6 @@ set (LOOT_API_HEADERS "${CMAKE_SOURCE_DIR}/include/loot/api.h"
                       "${CMAKE_SOURCE_DIR}/include/loot/enum/game_type.h"
                       "${CMAKE_SOURCE_DIR}/include/loot/enum/log_verbosity.h"
                       "${CMAKE_SOURCE_DIR}/include/loot/enum/message_type.h"
-                      "${CMAKE_SOURCE_DIR}/include/loot/enum/plugin_cleanliness.h"
                       "${CMAKE_SOURCE_DIR}/include/loot/game_interface.h"
                       "${CMAKE_SOURCE_DIR}/include/loot/loot_version.h"
                       "${CMAKE_SOURCE_DIR}/include/loot/metadata/conditional_metadata.h"

docs/api/changelog.rst

@@ -69,6 +69,11 @@ Removed
 - The ``PluginTags`` struct, as it is no longer used.
 - The ``LanguageCode`` enum, as the API now uses ISO language codes directly
   instead.
+- The ``PluginCleanliness`` enum. as it's no longer used. Plugin cleanliness
+  should now be checked by getting a plugin's evaluated metadata and checking
+  if any dirty info is present. If none is present, the cleanliness is unknown.
+  If dirty info is present, check if any of the English info strings contain the
+  text "Do not clean": if not, the plugin is dirty.
 - The LOOT API no longer caches the load order, as this is already done more
   accurately by libloadorder (which is used internally).
 

docs/api/reference.rst

@@ -13,8 +13,6 @@ Enumerations
 
 .. doxygenenum:: loot::MessageType
 
-.. doxygenenum:: loot::PluginCleanliness
-
 Public-Field Data Structures
 ============================
 

include/loot/database_interface.h

@@ -27,7 +27,6 @@
 #include <string>
 #include <vector>
 
-#include "loot/enum/plugin_cleanliness.h"
 #include "loot/metadata/message.h"
 #include "loot/metadata/plugin_metadata.h"
 #include "loot/struct/masterlist_info.h"

include/loot/enum/plugin_cleanliness.h

@@ -1,52 +0,0 @@
-/*  LOOT
-
-    A load order optimisation tool for Oblivion, Skyrim, Fallout 3 and
-    Fallout: New Vegas.
-
-    Copyright (C) 2012-2016    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_PLUGIN_CLEANLINESS
-#define LOOT_PLUGIN_CLEANLINESS
-
-/**
- * The namespace used by the LOOT API.
- */
-namespace loot {
-/**
- * @brief Codes used to indicate the cleanliness of a plugin according to the
- *        information contained within the loaded masterlist/userlist.
- */
-enum struct PluginCleanliness : unsigned int {
-  /** Indicates that the plugin is clean. */
-  clean,
-  /** Indicates that the plugin is dirty. */
-  dirty,
-  /**
-   * Indicates that the plugin contains dirty edits, but that they are
-   * part of the plugin's intended functionality and should not be removed.
-   */
-  do_not_clean,
-  /**
-   * Indicates that no data is available on whether the plugin is dirty or not.
-   */
-  unknown,
-};
-}
-
-#endif