PrismLauncher/api/logic/InstanceList.h

164 lines
4.5 KiB
C
Raw Normal View History

2018-02-10 23:40:01 +00:00
/* Copyright 2013-2018 MultiMC Contributors
2013-01-14 23:42:38 +00:00
*
* 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
*
2013-01-14 23:42:38 +00:00
* 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
2013-01-14 23:42:38 +00:00
2013-02-15 04:40:00 +00:00
#include <QObject>
#include <QAbstractListModel>
#include <QSet>
2016-10-02 23:55:54 +01:00
#include <QList>
2013-02-15 04:40:00 +00:00
2015-02-09 00:51:14 +00:00
#include "BaseInstance.h"
2013-02-15 04:40:00 +00:00
#include "multimc_logic_export.h"
2016-10-02 23:55:54 +01:00
#include "QObjectPtr.h"
2018-07-24 00:24:06 +01:00
class QFileSystemWatcher;
class InstanceTask;
using InstanceId = QString;
using GroupId = QString;
using InstanceLocator = std::pair<InstancePtr, int>;
enum class InstCreateError
{
NoCreateError = 0,
NoSuchVersion,
UnknownCreateError,
InstExists,
CantCreateDir
};
enum class GroupsState
{
NotLoaded,
Steady,
Dirty
};
2018-07-24 00:24:06 +01:00
class MULTIMC_LOGIC_EXPORT InstanceList : public QAbstractListModel
2013-01-14 23:42:38 +00:00
{
2018-07-15 13:51:05 +01:00
Q_OBJECT
2013-01-14 23:42:38 +00:00
public:
2018-07-24 00:24:06 +01:00
explicit InstanceList(SettingsObjectPtr settings, const QString & instDir, QObject *parent = 0);
2018-07-15 13:51:05 +01:00
virtual ~InstanceList();
public:
2018-07-15 13:51:05 +01:00
QModelIndex index(int row, int column = 0, const QModelIndex &parent = QModelIndex()) const;
int rowCount(const QModelIndex &parent = QModelIndex()) const;
QVariant data(const QModelIndex &index, int role) const;
Qt::ItemFlags flags(const QModelIndex &index) const;
enum AdditionalRoles
{
GroupRole = Qt::UserRole,
InstancePointerRole = 0x34B1CB48, ///< Return pointer to real instance
InstanceIDRole = 0x34B1CB49 ///< Return id if the instance
};
/*!
* \brief Error codes returned by functions in the InstanceList class.
* NoError Indicates that no error occurred.
* UnknownError indicates that an unspecified error occurred.
*/
enum InstListError
{
NoError = 0,
UnknownError
};
InstancePtr at(int i) const
{
return m_instances.at(i);
}
int count() const
{
return m_instances.count();
}
2018-07-23 23:11:24 +01:00
InstListError loadList();
2018-07-15 13:51:05 +01:00
void saveNow();
InstancePtr getInstanceById(QString id) const;
QModelIndex getInstanceIndexById(const QString &id) const;
QStringList getGroups();
GroupId getInstanceGroup(const InstanceId & id) const;
void setInstanceGroup(const InstanceId & id, const GroupId& name);
2018-07-15 13:51:05 +01:00
void deleteGroup(const GroupId & name);
void deleteInstance(const InstanceId & id);
2018-07-24 00:24:06 +01:00
// Wrap an instance creation task in some more task machinery and make it ready to be used
Task * wrapInstanceTask(InstanceTask * task);
/**
* Create a new empty staging area for instance creation and @return a path/key top commit it later.
* Used by instance manipulation tasks.
*/
QString getStagedInstancePath();
/**
* Commit the staging area given by @keyPath to the provider - used when creation succeeds.
* Used by instance manipulation tasks.
*/
bool commitStagedInstance(const QString & keyPath, const QString& instanceName, const QString & groupName);
/**
* Destroy a previously created staging area given by @keyPath - used when creation fails.
* Used by instance manipulation tasks.
*/
bool destroyStagingPath(const QString & keyPath);
2013-03-18 22:00:46 +00:00
signals:
2018-07-15 13:51:05 +01:00
void dataIsInvalid();
2018-07-24 00:24:06 +01:00
void instancesChanged();
void groupsChanged(QSet<QString> groups);
public slots:
void on_InstFolderChanged(const Setting &setting, QVariant value);
private slots:
2018-07-15 13:51:05 +01:00
void propertiesChanged(BaseInstance *inst);
void providerUpdated();
2018-07-24 00:24:06 +01:00
void instanceDirContentsChanged(const QString &path);
private:
2018-07-15 13:51:05 +01:00
int getInstIndex(BaseInstance *inst) const;
void suspendWatch();
void resumeWatch();
void add(const QList<InstancePtr> &list);
2018-07-24 00:24:06 +01:00
void loadGroupList();
void saveGroupList();
QList<InstanceId> discoverInstances();
InstancePtr loadInstance(const InstanceId& id);
2018-07-24 00:24:06 +01:00
private:
2018-07-15 13:51:05 +01:00
int m_watchLevel = 0;
2018-07-23 23:11:24 +01:00
bool m_dirty = false;
2018-07-15 13:51:05 +01:00
QList<InstancePtr> m_instances;
QSet<QString> m_groups;
2018-07-24 00:24:06 +01:00
SettingsObjectPtr m_globalSettings;
QString m_instDir;
QFileSystemWatcher * m_watcher;
QMap<InstanceId, GroupId> m_groupMap;
2018-07-24 00:24:06 +01:00
QSet<InstanceId> instanceSet;
bool m_groupsLoaded = false;
bool m_instancesProbed = false;
2013-01-14 23:42:38 +00:00
};