NOISSUE reorganize and document libraries

api/logic/minecraft/MinecraftVersion.h

@@ -0,0 +1,119 @@
+/* Copyright 2013-2015 MultiMC Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#include <QStringList>
+#include <QSet>
+#include <QDateTime>
+
+#include "BaseVersion.h"
+#include "ProfilePatch.h"
+#include "VersionFile.h"
+
+#include "multimc_logic_export.h"
+
+class MinecraftProfile;
+class MinecraftVersion;
+typedef std::shared_ptr<MinecraftVersion> MinecraftVersionPtr;
+
+class MULTIMC_LOGIC_EXPORT MinecraftVersion : public BaseVersion, public ProfilePatch
+{
+friend class MinecraftVersionList;
+
+public: /* methods */
+	// FIXME: nuke this.
+	bool usesLegacyLauncher();
+
+	virtual QString descriptor() override;
+	virtual QString name() override;
+	virtual QString typeString() const override;
+	virtual bool hasJarMods() override;
+	virtual bool isMinecraftVersion() override;
+	virtual void applyTo(MinecraftProfile *profile) override;
+	virtual int getOrder() override;
+	virtual void setOrder(int order) override;
+	virtual QList<JarmodPtr> getJarMods() override;
+	virtual QString getID() override;
+	virtual QString getVersion() override;
+	virtual QString getName() override;
+	virtual QString getFilename() override;
+	QDateTime getReleaseDateTime() override;
+	VersionSource getVersionSource() override;
+
+	bool needsUpdate();
+	bool hasUpdate();
+	virtual bool isCustom() override;
+	virtual bool isMoveable() override
+	{
+		return false;
+	}
+	virtual bool isCustomizable() override;
+	virtual bool isRemovable() override
+	{
+		return false;
+	}
+	virtual bool isRevertible() override
+	{
+		return false;
+	}
+	virtual bool isEditable() override
+	{
+		return false;
+	}
+	virtual bool isVersionChangeable() override
+	{
+		return true;
+	}
+
+	virtual VersionFilePtr getVersionFile() override;
+
+	// virtual QJsonDocument toJson(bool saveOrder) override;
+
+	QString getUrl() const;
+
+	virtual const QList<PatchProblem> &getProblems() override;
+	virtual ProblemSeverity getProblemSeverity() override;
+
+private: /* methods */
+	void applyFileTo(MinecraftProfile *profile);
+
+protected: /* data */
+	VersionSource m_versionSource = Remote;
+
+	/// The URL that this version will be downloaded from.
+	QString m_versionFileURL;
+
+	/// the human readable version name
+	QString m_version;
+
+	/// The type of this release
+	QString m_type;
+
+	/// the time this version was actually released by Mojang
+	QDateTime m_releaseTime;
+
+	/// the time this version was last updated by Mojang
+	QDateTime m_updateTime;
+
+	/// order of this file... default = -2
+	int order = -2;
+
+	/// an update available from Mojang
+	MinecraftVersionPtr upstreamUpdate;
+
+	QDateTime m_loadedVersionFileTimestamp;
+	mutable VersionFilePtr m_loadedVersionFile;
+};