NOISSUE reorganize and document libraries

1 files changed, 36 insertions, 0 deletions

diff --git a/api/logic/resources/ResourceHandler.h b/api/logic/resources/ResourceHandler.h
new file mode 100644
index 00000000..f09d8904
--- /dev/null
+++ b/api/logic/resources/ResourceHandler.h
@@ -0,0 +1,36 @@
+#pragma once
+
+#include <QVariant>
+#include <memory>
+
+#include "multimc_logic_export.h"
+
+class Resource;
+
+/** Base class for things that can retrieve a resource.
+ *
+ * Subclass, provide a constructor that takes a single QString as argument, and
+ * call Resource::registerHandler<MyResourceHandler>("<id>"), where <id> is the
+ * prefix of the resource ("web", "icon", etc.)
+ */
+class MULTIMC_LOGIC_EXPORT ResourceHandler
+{
+public:
+	virtual ~ResourceHandler() {}
+
+	void setResource(Resource *resource) { m_resource = resource; }
+	/// reimplement this if you need to do something after you have been put in a shared pointer
+	// we do this instead of inheriting from std::enable_shared_from_this
+	virtual void init(std::shared_ptr<ResourceHandler>&) {}
+
+	QVariant result() const { return m_result; }
+
+protected: // use these methods to notify the resource of changes
+	void setResult(const QVariant &result);
+	void setFailure(const QString &reason);
+	void setProgress(const int progress);
+
+private:
+	QVariant m_result;
+	Resource *m_resource = nullptr;
+};