sneedmc/logic/minecraft/OneSixLibrary.h

131 lines
3.2 KiB
C
Raw Normal View History

/* Copyright 2013 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.
*/
2013-09-11 21:43:17 +00:00
#pragma once
2013-09-11 21:43:17 +00:00
#include <QString>
#include <QStringList>
#include <QMap>
#include <QJsonObject>
2014-05-03 13:40:46 +00:00
#include <QDir>
#include <memory>
#include "logic/net/URLConstants.h"
2014-05-08 19:20:10 +00:00
#include "logic/minecraft/OpSys.h"
#include "logic/minecraft/RawLibrary.h"
2013-09-11 21:43:17 +00:00
class Rule;
2014-03-05 00:50:05 +00:00
class OneSixLibrary;
typedef std::shared_ptr<OneSixLibrary> OneSixLibraryPtr;
class OneSixLibrary : public RawLibrary
2013-09-11 21:43:17 +00:00
{
private:
/// a decent name fit for display
QString m_decentname;
/// a decent version fit for display
QString m_decentversion;
/// a decent type fit for display
QString m_decenttype;
2013-09-11 21:43:17 +00:00
/// where to store the lib locally
QString m_storage_path;
/// where to download the lib from
QString m_download_url;
2013-09-11 21:43:17 +00:00
/// is this lib actually active on the current OS?
bool m_is_active = false;
2013-09-11 21:43:17 +00:00
public:
QString minVersion;
enum DependType
{
Soft,
Hard
};
DependType dependType;
2013-09-11 21:43:17 +00:00
public:
/// Constructor
OneSixLibrary(const QString &name, const DependType type = Soft)
2013-09-11 21:43:17 +00:00
{
m_name = name;
dependType = type;
2013-09-11 21:43:17 +00:00
}
/// Constructor
OneSixLibrary(RawLibraryPtr base);
static OneSixLibraryPtr fromRawLibrary(RawLibraryPtr lib);
2013-12-28 13:22:36 +00:00
/// Returns the raw name field
QString rawName() const
{
return m_name;
}
2013-09-11 21:43:17 +00:00
/**
* finalize the library, processing the input values into derived values and state
*
2013-09-11 21:43:17 +00:00
* This SHALL be called after all the values are parsed or after any further change.
*/
void finalize();
2013-09-11 21:43:17 +00:00
/// Set the library composite name
void setName(const QString &name);
/// get a decent-looking name
QString name() const
{
return m_decentname;
}
/// get a decent-looking version
QString version() const
{
return m_decentversion;
}
/// what kind of library is it? (for display)
QString type() const
{
return m_decenttype;
}
2013-09-11 21:43:17 +00:00
/// Set the url base for downloads
void setBaseUrl(const QString &base_url);
2013-09-11 21:43:17 +00:00
/// Attach a name suffix to the specified OS native
void addNative(OpSys os, const QString &suffix);
/// Clears all suffixes
void clearSuffixes();
2013-09-11 21:43:17 +00:00
/// Set the load rules
void setRules(QList<std::shared_ptr<Rule>> rules);
2013-09-11 21:43:17 +00:00
/// Returns true if the library should be loaded (or extracted, in case of natives)
bool isActive() const;
2013-09-11 21:43:17 +00:00
/// Get the URL to download the library from
QString downloadUrl() const;
2013-09-11 21:43:17 +00:00
/// Get the relative path where the library should be saved
QString storagePath() const;
/// set an absolute URL for the library. This is an MMC extension.
void setAbsoluteUrl(const QString &absolute_url);
QString absoluteUrl() const;
/// set a hint about how to treat the library. This is an MMC extension.
void setHint(const QString &hint);
QString hint() const;
bool extractTo(QString target_dir);
2014-05-03 13:40:46 +00:00
bool filesExist(const QDir &base);
QStringList files();
2013-09-11 21:43:17 +00:00
};