[wpilib] Deprecate Resource

wpilibsuite · Aug 12, 2024 · 6e7836a · 6e7836a
1 parent b057044
commit 6e7836a
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/wpilibc/src/main/native/cpp/Resource.cpp b/wpilibc/src/main/native/cpp/Resource.cpp
@@ -4,8 +4,11 @@
 
 #include "frc/Resource.h"
 
+#include <wpi/deprecated.h>
+
 #include "frc/Errors.h"
 
+WPI_IGNORE_DEPRECATED
 using namespace frc;
 
 wpi::mutex Resource::m_createMutex;
@@ -17,6 +20,7 @@ void Resource::CreateResourceObject(std::unique_ptr<Resource>& r,
     r = std::make_unique<Resource>(elements);
   }
 }
+WPI_UNIGNORE_DEPRECATED
 
 Resource::Resource(uint32_t elements) {
   m_isAllocated = std::vector<bool>(elements, false);

diff --git a/wpilibc/src/main/native/include/frc/Resource.h b/wpilibc/src/main/native/include/frc/Resource.h
@@ -23,8 +23,9 @@ namespace frc {
  * The Resource class does not allocate the hardware channels or other
  * resources; it just tracks which indices were marked in use by Allocate and
  * not yet freed by Free.
+ * @deprecated Use the HandleResource classes instead
  */
-class Resource {
+class [[deprecated("Use the HandleResource classes instead")]] Resource {
  public:
   virtual ~Resource() = default;
 

diff --git a/wpilibj/src/main/java/edu/wpi/first/wpilibj/Resource.java b/wpilibj/src/main/java/edu/wpi/first/wpilibj/Resource.java
@@ -19,7 +19,10 @@
  * created. Then, when the program actually starts - in the Robot constructor, all resources are
  * initialized. This ensures that the program is restartable in memory without having to
  * unload/reload.
+ *
+ * @deprecated Will be removed with no replacement.
  */
+@Deprecated(forRemoval = true, since = "2025")
 public final class Resource {
   private static Resource resourceList;
   private final boolean[] m_numAllocated;