Addons: Separate code and fix IDE error

This fixes an IDE error in Eclipse CDT by switching from `typedef` to `using`. Error was: Type 'ADDON::AddonInfoPtr' could not be resolved
garbear · Oct 10, 2021 · 9c7ba3e · 9c7ba3e
1 parent d16dd92
commit 9c7ba3e
Show file tree

Hide file tree

Showing 14 changed files with 120 additions and 90 deletions.
diff --git a/xbmc/addons/Addon.h b/xbmc/addons/Addon.h
@@ -9,6 +9,7 @@
 #pragma once
 
 #include "addons/IAddon.h"
+#include "addons/addoninfo/AddonInfo.h"
 #include "utils/XBMCTinyXML.h"
 
 class TiXmlElement;

diff --git a/xbmc/addons/IAddon.h b/xbmc/addons/IAddon.h
@@ -8,7 +8,9 @@
 
 #pragma once
 
-#include "addons/addoninfo/AddonInfo.h"
+#include "XBDateTime.h"
+#include "addons/addoninfo/AddonInfoTypes.h"
+#include "addons/addoninfo/AddonType.h"
 
 #include <memory>
 #include <set>

diff --git a/xbmc/addons/addoninfo/AddonInfo.h b/xbmc/addons/addoninfo/AddonInfo.h
@@ -10,101 +10,17 @@
 
 #include "XBDateTime.h"
 #include "addons/AddonVersion.h"
+#include "addons/addoninfo/AddonInfoTypes.h"
 #include "addons/addoninfo/AddonType.h"
 
-#include <map>
 #include <memory>
 #include <string>
 #include <unordered_map>
-#include <utility>
 #include <vector>
 
 namespace ADDON
 {
 
-class CAddonBuilder;
-class CAddonInfo;
-typedef std::shared_ptr<CAddonInfo> AddonInfoPtr;
-typedef std::vector<AddonInfoPtr> AddonInfos;
-
-enum class AddonDisabledReason
-{
-  /// @brief Special reason for returning all disabled addons.
-  ///
-  /// Only used as an actual value when an addon is enabled.
-  NONE = 0,
-  USER = 1,
-  INCOMPATIBLE = 2,
-  PERMANENT_FAILURE = 3
-};
-
-enum class AddonOriginType
-{
-  /// @brief The type of the origin of an addon.
-  ///
-  /// Represents where an addon was installed from.
-  SYSTEM = 0, /// The addon is a system addon
-  REPOSITORY = 1, /// The addon origin is a repository
-  MANUAL = 2 /// The addon origin is a zip file, package or development build
-};
-
-//! @brief Reasons why an addon is not updateable
-enum class AddonUpdateRule
-{
-  ANY = 0, //!< used internally, not to be explicitly set
-  USER_DISABLED_AUTO_UPDATE = 1, //!< automatic updates disabled via AddonInfo dialog
-  PIN_OLD_VERSION = 2 //!< user downgraded to an older version
-};
-
-/*!
- * @brief Add-on state defined within addon.xml to report about the current addon
- * lifecycle state.
- *
- * E.g. the add-on is broken and can no longer be used.
- *
- * XML examples:
- * ~~~~~~~~~~~~~{.xml}
- * <lifecyclestate type="broken" lang="en_GB">SOME TEXT</lifecyclestate>
- * ~~~~~~~~~~~~~
- */
-enum class AddonLifecycleState
-{
-  NORMAL = 0, //!< Used if an add-on has no special lifecycle state which is the default state
-  DEPRECATED = 1, //!< the add-on should be marked as deprecated but is still usable
-  BROKEN = 2, //!< the add-on should marked as broken in the repository
-};
-
-struct DependencyInfo
-{
-  std::string id;
-  AddonVersion versionMin, version;
-  bool optional;
-  DependencyInfo(std::string id,
-                 const AddonVersion& versionMin,
-                 const AddonVersion& version,
-                 bool optional)
-    : id(std::move(id)),
-      versionMin(versionMin.empty() ? version : versionMin),
-      version(version),
-      optional(optional)
-  {
-  }
-
-  bool operator==(const DependencyInfo& rhs) const
-  {
-    return id == rhs.id && versionMin == rhs.versionMin && version == rhs.version &&
-           optional == rhs.optional;
-  }
-
-  bool operator!=(const DependencyInfo& rhs) const
-  {
-    return !(rhs == *this);
-  }
-};
-
-typedef std::map<std::string, std::string> InfoMap;
-typedef std::map<std::string, std::string> ArtMap;
-
 class CAddonInfoBuilder;
 
 class CAddonInfo

diff --git a/xbmc/addons/addoninfo/AddonInfoBuilder.cpp b/xbmc/addons/addoninfo/AddonInfoBuilder.cpp
@@ -10,6 +10,7 @@
 
 #include "CompileInfo.h"
 #include "LangInfo.h"
+#include "addons/addoninfo/AddonInfo.h"
 #include "addons/addoninfo/AddonType.h"
 #include "filesystem/File.h"
 #include "filesystem/SpecialProtocol.h"

diff --git a/xbmc/addons/addoninfo/AddonInfoBuilder.h b/xbmc/addons/addoninfo/AddonInfoBuilder.h
@@ -9,7 +9,7 @@
 #pragma once
 
 #include "addons/Repository.h"
-#include "addons/addoninfo/AddonInfo.h"
+#include "addons/addoninfo/AddonInfoTypes.h"
 
 #include <utility>
 

diff --git a/xbmc/addons/addoninfo/AddonInfoTypes.h b/xbmc/addons/addoninfo/AddonInfoTypes.h
@@ -0,0 +1,104 @@
+/*
+ *  Copyright (C) 2021 Team Kodi
+ *  This file is part of Kodi - https://kodi.tv
+ *
+ *  SPDX-License-Identifier: GPL-2.0-or-later
+ *  See LICENSES/README.md for more information.
+ */
+
+#pragma once
+
+#include "addons/AddonVersion.h"
+
+#include <map>
+#include <memory>
+#include <string>
+#include <utility>
+#include <vector>
+
+namespace ADDON
+{
+
+class CAddonInfo;
+using AddonInfoPtr = std::shared_ptr<CAddonInfo>;
+using AddonInfos = std::vector<AddonInfoPtr>;
+
+enum class AddonDisabledReason
+{
+  /// @brief Special reason for returning all disabled addons.
+  ///
+  /// Only used as an actual value when an addon is enabled.
+  NONE = 0,
+  USER = 1,
+  INCOMPATIBLE = 2,
+  PERMANENT_FAILURE = 3
+};
+
+enum class AddonOriginType
+{
+  /// @brief The type of the origin of an addon.
+  ///
+  /// Represents where an addon was installed from.
+  SYSTEM = 0, /// The addon is a system addon
+  REPOSITORY = 1, /// The addon origin is a repository
+  MANUAL = 2 /// The addon origin is a zip file, package or development build
+};
+
+//! @brief Reasons why an addon is not updateable
+enum class AddonUpdateRule
+{
+  ANY = 0, //!< used internally, not to be explicitly set
+  USER_DISABLED_AUTO_UPDATE = 1, //!< automatic updates disabled via AddonInfo dialog
+  PIN_OLD_VERSION = 2 //!< user downgraded to an older version
+};
+
+/*!
+ * @brief Add-on state defined within addon.xml to report about the current addon
+ * lifecycle state.
+ *
+ * E.g. the add-on is broken and can no longer be used.
+ *
+ * XML examples:
+ * ~~~~~~~~~~~~~{.xml}
+ * <lifecyclestate type="broken" lang="en_GB">SOME TEXT</lifecyclestate>
+ * ~~~~~~~~~~~~~
+ */
+enum class AddonLifecycleState
+{
+  NORMAL = 0, //!< Used if an add-on has no special lifecycle state which is the default state
+  DEPRECATED = 1, //!< the add-on should be marked as deprecated but is still usable
+  BROKEN = 2, //!< the add-on should marked as broken in the repository
+};
+
+struct DependencyInfo
+{
+  std::string id;
+  AddonVersion versionMin, version;
+  bool optional;
+  DependencyInfo(std::string id,
+                 const AddonVersion& versionMin,
+                 const AddonVersion& version,
+                 bool optional)
+    : id(std::move(id)),
+      versionMin(versionMin.empty() ? version : versionMin),
+      version(version),
+      optional(optional)
+  {
+  }
+
+  bool operator==(const DependencyInfo& rhs) const
+  {
+    return id == rhs.id && versionMin == rhs.versionMin && version == rhs.version &&
+           optional == rhs.optional;
+  }
+
+  bool operator!=(const DependencyInfo& rhs) const
+  {
+    return !(rhs == *this);
+  }
+};
+
+using InfoMap = std::map<std::string, std::string>;
+using ArtMap = std::map<std::string, std::string>;
+
+} /* namespace ADDON */
diff --git a/xbmc/addons/addoninfo/CMakeLists.txt b/xbmc/addons/addoninfo/CMakeLists.txt
@@ -6,6 +6,7 @@ set(SOURCES AddonInfoBuilder.cpp
 set(HEADERS AddonInfoBuilder.h
             AddonExtensions.h
             AddonInfo.h
+            AddonInfoTypes.h
             AddonType.h)
 
 core_add_library(addons_addoninfo)
diff --git a/xbmc/addons/binary-addons/BinaryAddonBase.cpp b/xbmc/addons/binary-addons/BinaryAddonBase.cpp
@@ -8,6 +8,8 @@
 
 #include "BinaryAddonBase.h"
 
+#include "addons/addoninfo/AddonInfo.h"
+
 #include "threads/SingleLock.h"
 #include "utils/log.h"
 

diff --git a/xbmc/addons/binary-addons/BinaryAddonBase.h b/xbmc/addons/binary-addons/BinaryAddonBase.h
@@ -9,7 +9,7 @@
 #pragma once
 
 #include "AddonInstanceHandler.h"
-#include "addons/addoninfo/AddonInfo.h"
+#include "addons/addoninfo/AddonInfoTypes.h"
 #include "threads/CriticalSection.h"
 
 #include <memory>

diff --git a/xbmc/addons/settings/AddonSettings.cpp b/xbmc/addons/settings/AddonSettings.cpp
@@ -12,6 +12,7 @@
 #include "GUIInfoManager.h"
 #include "LangInfo.h"
 #include "ServiceBroker.h"
+#include "addons/addoninfo/AddonInfo.h"
 #include "addons/gui/GUIDialogAddonSettings.h"
 #include "addons/settings/SettingUrlEncodedString.h"
 #include "filesystem/Directory.h"

diff --git a/xbmc/games/addons/GameClient.h b/xbmc/games/addons/GameClient.h
@@ -9,6 +9,7 @@
 #pragma once
 
 #include "GameClientSubsystem.h"
+#include "addons/addoninfo/AddonInfoTypes.h"
 #include "addons/binary-addons/AddonDll.h"
 #include "addons/kodi-dev-kit/include/kodi/addon-instance/Game.h"
 #include "threads/CriticalSection.h"

diff --git a/xbmc/platform/win32/pch.h b/xbmc/platform/win32/pch.h
@@ -57,4 +57,4 @@ WINRT_WARNING_PUSH
 /* empty */
 
 #include "FileItem.h" //63 seconds
-#include "addons/addoninfo/AddonInfo.h" // 62 seconds
+#include "addons/addoninfo/AddonInfoTypes.h" // 62 seconds
diff --git a/xbmc/utils/FileExtensionProvider.cpp b/xbmc/utils/FileExtensionProvider.cpp
@@ -10,6 +10,7 @@
 
 #include "ServiceBroker.h"
 #include "addons/AddonManager.h"
+#include "addons/addoninfo/AddonInfo.h"
 #include "settings/AdvancedSettings.h"
 #include "settings/SettingsComponent.h"
 

diff --git a/xbmc/utils/FileExtensionProvider.h b/xbmc/utils/FileExtensionProvider.h
@@ -9,7 +9,7 @@
 #pragma once
 
 #include "addons/AddonEvents.h"
-#include "addons/addoninfo/AddonInfo.h"
+#include "addons/addoninfo/AddonType.h"
 #include "settings/AdvancedSettings.h"
 
 namespace ADDON