pollymc/api/logic/InstanceList.h

176 lines
5.0 KiB
C
Raw Normal View History

2021-01-18 12:58:54 +05:30
/* Copyright 2013-2021 MultiMC Contributors
2013-01-15 05:12:38 +05:30
*
* 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-15 05:12:38 +05:30
* 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-15 05:12:38 +05:30
2013-02-15 10:10:00 +05:30
#include <QObject>
#include <QAbstractListModel>
#include <QSet>
2016-10-03 04:25:54 +05:30
#include <QList>
2013-02-15 10:10:00 +05:30
2015-02-09 06:21:14 +05:30
#include "BaseInstance.h"
2013-02-15 10:10:00 +05:30
#include "multimc_logic_export.h"
2016-10-03 04:25:54 +05:30
#include "QObjectPtr.h"
2018-07-24 04:54:06 +05:30
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 04:54:06 +05:30
class MULTIMC_LOGIC_EXPORT InstanceList : public QAbstractListModel
2013-01-15 05:12:38 +05:30
{
2018-07-15 18:21:05 +05:30
Q_OBJECT
2013-01-15 05:12:38 +05:30
public:
2018-07-24 04:54:06 +05:30
explicit InstanceList(SettingsObjectPtr settings, const QString & instDir, QObject *parent = 0);
2018-07-15 18:21:05 +05:30
virtual ~InstanceList();
public:
2018-11-22 06:20:32 +05:30
QModelIndex index(int row, int column = 0, const QModelIndex &parent = QModelIndex()) const override;
int rowCount(const QModelIndex &parent = QModelIndex()) const override;
QVariant data(const QModelIndex &index, int role) const override;
Qt::ItemFlags flags(const QModelIndex &index) const override;
bool setData(const QModelIndex & index, const QVariant & value, int role) override;
2018-07-15 18:21:05 +05:30
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-24 03:41:24 +05:30
InstListError loadList();
2018-07-15 18:21:05 +05:30
void saveNow();
InstancePtr getInstanceById(QString id) const;
QModelIndex getInstanceIndexById(const QString &id) const;
QStringList getGroups();
bool isGroupCollapsed(const QString &groupName);
GroupId getInstanceGroup(const InstanceId & id) const;
void setInstanceGroup(const InstanceId & id, const GroupId& name);
2018-07-15 18:21:05 +05:30
void deleteGroup(const GroupId & name);
void deleteInstance(const InstanceId & id);
2018-07-24 04:54:06 +05:30
// 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);
2019-07-10 07:53:24 +05:30
int getTotalPlayTime();
2013-03-19 03:30:46 +05:30
signals:
2018-07-15 18:21:05 +05:30
void dataIsInvalid();
2018-07-24 04:54:06 +05:30
void instancesChanged();
void instanceSelectRequest(QString instanceId);
2018-07-24 04:54:06 +05:30
void groupsChanged(QSet<QString> groups);
public slots:
void on_InstFolderChanged(const Setting &setting, QVariant value);
void on_GroupStateChanged(const QString &group, bool collapsed);
private slots:
2018-07-15 18:21:05 +05:30
void propertiesChanged(BaseInstance *inst);
void providerUpdated();
2018-07-24 04:54:06 +05:30
void instanceDirContentsChanged(const QString &path);
private:
2018-07-15 18:21:05 +05:30
int getInstIndex(BaseInstance *inst) const;
2019-07-10 07:53:24 +05:30
void updateTotalPlayTime();
2018-07-15 18:21:05 +05:30
void suspendWatch();
void resumeWatch();
void add(const QList<InstancePtr> &list);
2018-07-24 04:54:06 +05:30
void loadGroupList();
void saveGroupList();
QList<InstanceId> discoverInstances();
InstancePtr loadInstance(const InstanceId& id);
2018-07-24 04:54:06 +05:30
private:
2018-07-15 18:21:05 +05:30
int m_watchLevel = 0;
2019-07-10 07:53:24 +05:30
int totalPlayTime = 0;
2018-07-24 03:41:24 +05:30
bool m_dirty = false;
2018-07-15 18:21:05 +05:30
QList<InstancePtr> m_instances;
QSet<QString> m_groupNameCache;
2018-07-24 04:54:06 +05:30
SettingsObjectPtr m_globalSettings;
QString m_instDir;
QFileSystemWatcher * m_watcher;
// FIXME: this is so inefficient that looking at it is almost painful.
QSet<QString> m_collapsedGroups;
QMap<InstanceId, GroupId> m_instanceGroupIndex;
2018-07-24 04:54:06 +05:30
QSet<InstanceId> instanceSet;
bool m_groupsLoaded = false;
bool m_instancesProbed = false;
2013-01-15 05:12:38 +05:30
};