Merge pull request #1383 from TheKodeToad/rename-groups

Rename groups

launcher/InstanceList.cpp

@@ -2,6 +2,7 @@
 /*
  *  Prism Launcher - Minecraft Launcher
  *  Copyright (C) 2022 Sefa Eyeoglu <contact@scrumplex.net>
+ *  Copyright (C) 2023 TheKodeToad <TheKodeToad@proton.me>
  *
  *  This program is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
@@ -237,8 +238,11 @@ GroupId InstanceList::getInstanceGroup(const InstanceId& id) const
     return GroupId();
 }
 
-void InstanceList::setInstanceGroup(const InstanceId& id, const GroupId& name)
+void InstanceList::setInstanceGroup(const InstanceId& id, GroupId name)
 {
+    if (name.isEmpty() && !name.isNull())
+        name = QString();
+
     auto inst = getInstanceById(id);
     if (!inst) {
         qDebug() << "Attempt to set a null instance's group";
@@ -249,6 +253,7 @@ void InstanceList::setInstanceGroup(const InstanceId& id, const GroupId& name)
     auto iter = m_instanceGroupIndex.find(inst->id());
     if (iter != m_instanceGroupIndex.end()) {
         if (*iter != name) {
+            decreaseGroupCount(*iter);
             *iter = name;
             changed = true;
         }
@@ -258,7 +263,7 @@ void InstanceList::setInstanceGroup(const InstanceId& id, const GroupId& name)
     }
 
     if (changed) {
-        m_groupNameCache.insert(name);
+        increaseGroupCount(name);
         auto idx = getInstIndex(inst.get());
         emit dataChanged(index(idx), index(idx), { GroupRole });
         saveGroupList();
@@ -267,29 +272,55 @@ void InstanceList::setInstanceGroup(const InstanceId& id, const GroupId& name)
 
 QStringList InstanceList::getGroups()
 {
-    return m_groupNameCache.values();
+    return m_groupNameCache.keys();
 }
 
-void InstanceList::deleteGroup(const QString& name)
+void InstanceList::deleteGroup(const GroupId& name)
 {
+    m_groupNameCache.remove(name);
+    m_collapsedGroups.remove(name);
+
     bool removed = false;
     qDebug() << "Delete group" << name;
     for (auto& instance : m_instances) {
-        const auto& instID = instance->id();
+        const QString& instID = instance->id();
-        auto instGroupName = getInstanceGroup(instID);
+        const QString instGroupName = getInstanceGroup(instID);
         if (instGroupName == name) {
             m_instanceGroupIndex.remove(instID);
             qDebug() << "Remove" << instID << "from group" << name;
             removed = true;
             auto idx = getInstIndex(instance.get());
-            if (idx > 0) {
+            if (idx > 0)
                 emit dataChanged(index(idx), index(idx), { GroupRole });
         }
     }
-    }
+    if (removed)
-    if (removed) {
         saveGroupList();
 }
+
+void InstanceList::renameGroup(const QString& src, const QString& dst)
+{
+    m_groupNameCache.remove(src);
+    if (m_collapsedGroups.remove(src))
+        m_collapsedGroups.insert(dst);
+
+    bool modified = false;
+    qDebug() << "Rename group" << src << "to" << dst;
+    for (auto& instance : m_instances) {
+        const QString& instID = instance->id();
+        const QString instGroupName = getInstanceGroup(instID);
+        if (instGroupName == src) {
+            m_instanceGroupIndex[instID] = dst;
+            increaseGroupCount(dst);
+            qDebug() << "Set" << instID << "group to" << dst;
+            modified = true;
+            auto idx = getInstIndex(instance.get());
+            if (idx > 0)
+                emit dataChanged(index(idx), index(idx), { GroupRole });
+        }
+    }
+    if (modified)
+        saveGroupList();
 }
 
 bool InstanceList::isGroupCollapsed(const QString& group)
@@ -305,12 +336,13 @@ bool InstanceList::trashInstance(const InstanceId& id)
         return false;
     }
 
-    auto cachedGroupId = m_instanceGroupIndex[id];
+    QString cachedGroupId = m_instanceGroupIndex[id];
 
     qDebug() << "Will trash instance" << id;
     QString trashedLoc;
 
     if (m_instanceGroupIndex.remove(id)) {
+        decreaseGroupCount(cachedGroupId);
         saveGroupList();
     }
 
@@ -348,7 +380,7 @@ void InstanceList::undoTrashInstance()
     QFile(top.trashPath).rename(top.polyPath);
 
     m_instanceGroupIndex[top.id] = top.groupName;
-    m_groupNameCache.insert(top.groupName);
+    increaseGroupCount(top.groupName);
 
     saveGroupList();
     emit instancesChanged();
@@ -362,7 +394,10 @@ void InstanceList::deleteInstance(const InstanceId& id)
         return;
     }
 
+    QString cachedGroupId = m_instanceGroupIndex[id];
+
     if (m_instanceGroupIndex.remove(id)) {
+        decreaseGroupCount(cachedGroupId);
         saveGroupList();
     }
 
@@ -610,6 +645,25 @@ InstancePtr InstanceList::loadInstance(const InstanceId& id)
     return inst;
 }
 
+void InstanceList::increaseGroupCount(const QString& group)
+{
+    if (group.isEmpty())
+        return;
+
+    ++m_groupNameCache[group];
+}
+
+void InstanceList::decreaseGroupCount(const QString& group)
+{
+    if (group.isEmpty())
+        return;
+
+    if (--m_groupNameCache[group] < 1) {
+        m_groupNameCache.remove(group);
+        m_collapsedGroups.remove(group);
+    }
+}
+
 void InstanceList::saveGroupList()
 {
     qDebug() << "Will save group list now.";
@@ -621,7 +675,7 @@ void InstanceList::saveGroupList()
     QString groupFileName = m_instDir + "/instgroups.json";
     QMap<QString, QSet<QString>> reverseGroupMap;
     for (auto iter = m_instanceGroupIndex.begin(); iter != m_instanceGroupIndex.end(); iter++) {
-        QString id = iter.key();
+        const QString& id = iter.key();
         QString group = iter.value();
         if (group.isEmpty())
             continue;
@@ -711,17 +765,22 @@ void InstanceList::loadGroupList()
         return;
     }
 
-    QSet<QString> groupSet;
     m_instanceGroupIndex.clear();
+    m_groupNameCache.clear();
 
     // Iterate through all the groups.
     QJsonObject groupMapping = rootObj.value("groups").toObject();
     for (QJsonObject::iterator iter = groupMapping.begin(); iter != groupMapping.end(); iter++) {
         QString groupName = iter.key();
 
+        if (iter.key().isEmpty()) {
+            qWarning() << "Redundant empty group found";
+            continue;
+        }
+
         // If not an object, complain and skip to the next one.
         if (!iter.value().isObject()) {
-            qWarning() << QString("Group '%1' in the group list should be an object.").arg(groupName).toUtf8();
+            qWarning() << QString("Group '%1' in the group list should be an object").arg(groupName).toUtf8();
             continue;
         }
 
@@ -733,23 +792,19 @@ void InstanceList::loadGroupList()
             continue;
         }
 
-        // keep a list/set of groups for choosing
-        groupSet.insert(groupName);
-
         auto hidden = groupObj.value("hidden").toBool(false);
-        if (hidden) {
+        if (hidden)
             m_collapsedGroups.insert(groupName);
-        }
 
         // Iterate through the list of instances in the group.
         QJsonArray instancesArray = groupObj.value("instances").toArray();
 
-        for (QJsonArray::iterator iter2 = instancesArray.begin(); iter2 != instancesArray.end(); iter2++) {
+        for (auto value : instancesArray) {
-            m_instanceGroupIndex[(*iter2).toString()] = groupName;
+            m_instanceGroupIndex[value.toString()] = groupName;
+            increaseGroupCount(groupName);
         }
     }
     m_groupsLoaded = true;
-    m_groupNameCache.unite(groupSet);
     qDebug() << "Group list loaded.";
 }
 
@@ -925,7 +980,7 @@ bool InstanceList::commitStagedInstance(const QString& path,
             }
 
             m_instanceGroupIndex[instID] = groupName;
-            m_groupNameCache.insert(groupName);
+            increaseGroupCount(groupName);
         }
 
         instanceSet.insert(instID);

launcher/InstanceList.h

@@ -1,4 +1,24 @@
-/* Copyright 2013-2021 MultiMC Contributors
+// SPDX-License-Identifier: GPL-3.0-only
+/*
+ *  Prism Launcher - Minecraft Launcher
+ *  Copyright (C) 2023 TheKodeToad <TheKodeToad@proton.me>
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, version 3.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * This file incorporates work covered by the following copyright and
+ * permission notice:
+ *
+ *      Copyright 2013-2021 MultiMC Contributors
  *
  *      Licensed under the Apache License, Version 2.0 (the "License");
  *      you may not use this file except in compliance with the License.
@@ -86,9 +106,10 @@ class InstanceList : public QAbstractListModel {
     bool isGroupCollapsed(const QString& groupName);
 
     GroupId getInstanceGroup(const InstanceId& id) const;
-    void setInstanceGroup(const InstanceId& id, const GroupId& name);
+    void setInstanceGroup(const InstanceId& id, GroupId name);
 
     void deleteGroup(const GroupId& name);
+    void renameGroup(const GroupId& src, const GroupId& dst);
     bool trashInstance(const InstanceId& id);
     bool trashedSomething();
     void undoTrashInstance();
@@ -158,12 +179,16 @@ class InstanceList : public QAbstractListModel {
     QList<InstanceId> discoverInstances();
     InstancePtr loadInstance(const InstanceId& id);
 
+    void increaseGroupCount(const QString& group);
+    void decreaseGroupCount(const QString& group);
+
    private:
     int m_watchLevel = 0;
     int totalPlayTime = 0;
     bool m_dirty = false;
     QList<InstancePtr> m_instances;
-    QSet<QString> m_groupNameCache;
+    // id -> refs
+    QMap<QString, int> m_groupNameCache;
 
     SettingsObjectPtr m_globalSettings;
     QString m_instDir;

launcher/ui/MainWindow.cpp

@@ -514,10 +514,10 @@ void MainWindow::showInstanceContextMenu(const QPoint& pos)
     } else {
         auto group = view->groupNameAt(pos);
 
-        QAction* actionVoid = new QAction(BuildConfig.LAUNCHER_DISPLAYNAME, this);
+        QAction* actionVoid = new QAction(group.isNull() ? BuildConfig.LAUNCHER_DISPLAYNAME : group, this);
         actionVoid->setEnabled(false);
 
-        QAction* actionCreateInstance = new QAction(tr("Create instance"), this);
+        QAction* actionCreateInstance = new QAction(tr("&Create instance"), this);
         actionCreateInstance->setToolTip(ui->actionAddInstance->toolTip());
         if (!group.isNull()) {
             QVariantMap instance_action_data;
@@ -531,12 +531,13 @@ void MainWindow::showInstanceContextMenu(const QPoint& pos)
         actions.prepend(actionVoid);
         actions.append(actionCreateInstance);
         if (!group.isNull()) {
-            QAction* actionDeleteGroup = new QAction(tr("Delete group '%1'").arg(group), this);
+            QAction* actionDeleteGroup = new QAction(tr("&Delete group"), this);
-            QVariantMap delete_group_action_data;
+            connect(actionDeleteGroup, &QAction::triggered, this, [this, group] { deleteGroup(group); });
-            delete_group_action_data["group"] = group;
-            actionDeleteGroup->setData(delete_group_action_data);
-            connect(actionDeleteGroup, SIGNAL(triggered(bool)), SLOT(deleteGroup()));
             actions.append(actionDeleteGroup);
+
+            QAction* actionRenameGroup = new QAction(tr("&Rename group"), this);
+            connect(actionRenameGroup, &QAction::triggered, this, [this, group] { renameGroup(group); });
+            actions.append(actionRenameGroup);
         }
     }
     QMenu myMenu;
@@ -1128,40 +1129,49 @@ void MainWindow::on_actionChangeInstGroup_triggered()
     if (!m_selectedInstance)
         return;
 
-    bool ok = false;
     InstanceId instId = m_selectedInstance->id();
-    QString name(APPLICATION->instances()->getInstanceGroup(instId));
+    QString src(APPLICATION->instances()->getInstanceGroup(instId));
-    auto groups = APPLICATION->instances()->getGroups();
+
-    groups.insert(0, "");
+    QStringList groups = APPLICATION->instances()->getGroups();
-    groups.sort(Qt::CaseInsensitive);
+    groups.prepend("");
-    int foo = groups.indexOf(name);
+    int index = groups.indexOf(src);
+    bool ok = false;
+    QString dst = QInputDialog::getItem(this, tr("Group name"), tr("Enter a new group name."), groups, index, true, &ok);
+    dst = dst.simplified();
 
-    name = QInputDialog::getItem(this, tr("Group name"), tr("Enter a new group name."), groups, foo, true, &ok);
-    name = name.simplified();
     if (ok) {
-        APPLICATION->instances()->setInstanceGroup(instId, name);
+        APPLICATION->instances()->setInstanceGroup(instId, dst);
     }
 }
 
-void MainWindow::deleteGroup()
+void MainWindow::deleteGroup(QString group)
 {
-    QObject* obj = sender();
+    Q_ASSERT(!group.isEmpty());
-    if (!obj)
+
-        return;
+    const int reply = QMessageBox::question(this, tr("Delete group"), tr("Are you sure you want to delete the group '%1'?").arg(group),
-    QAction* action = qobject_cast<QAction*>(obj);
-    if (!action)
-        return;
-    auto map = action->data().toMap();
-    if (!map.contains("group"))
-        return;
-    QString groupName = map["group"].toString();
-    if (!groupName.isEmpty()) {
-        auto reply = QMessageBox::question(this, tr("Delete group"), tr("Are you sure you want to delete the group %1?").arg(groupName),
                                             QMessageBox::Yes | QMessageBox::No);
-        if (reply == QMessageBox::Yes) {
+    if (reply == QMessageBox::Yes)
-            APPLICATION->instances()->deleteGroup(groupName);
+        APPLICATION->instances()->deleteGroup(group);
 }
+
+void MainWindow::renameGroup(QString group)
+{
+    Q_ASSERT(!group.isEmpty());
+
+    QString name = QInputDialog::getText(this, tr("Rename group"), tr("Enter a new group name."), QLineEdit::Normal, group);
+    name = name.simplified();
+    if (name.isNull() || name == group)
+        return;
+
+    const bool empty = name.isEmpty();
+    const bool duplicate = APPLICATION->instances()->getGroups().contains(name, Qt::CaseInsensitive) && group.toLower() != name.toLower();
+
+    if (empty || duplicate) {
+        QMessageBox::warning(this, tr("Cannot rename group"), empty ? tr("Cannot set empty name.") : tr("Group already exists. :/"));
+        return;
     }
+
+    APPLICATION->instances()->renameGroup(group, name);
 }
 
 void MainWindow::undoTrashInstance()

launcher/ui/MainWindow.h

@@ -148,7 +148,8 @@ class MainWindow : public QMainWindow {
 
     void on_actionDeleteInstance_triggered();
 
-    void deleteGroup();
+    void deleteGroup(QString group);
+    void renameGroup(QString group);
     void undoTrashInstance();
 
     inline void on_actionExportInstance_triggered() { on_actionExportInstanceZip_triggered(); }

launcher/ui/dialogs/CopyInstanceDialog.cpp

@@ -2,6 +2,7 @@
 /*
  *  Prism Launcher - Minecraft Launcher
  *  Copyright (C) 2022 Sefa Eyeoglu <contact@scrumplex.net>
+ *  Copyright (C) 2023 TheKodeToad <TheKodeToad@proton.me>
  *
  *  This program is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
@@ -61,22 +62,14 @@ CopyInstanceDialog::CopyInstanceDialog(InstancePtr original, QWidget* parent)
     ui->iconButton->setIcon(APPLICATION->icons()->getIcon(InstIconKey));
     ui->instNameTextBox->setText(original->name());
     ui->instNameTextBox->setFocus();
-#if QT_VERSION >= QT_VERSION_CHECK(5, 14, 0)
+
-    auto groupList = APPLICATION->instances()->getGroups();
+    QStringList groups = APPLICATION->instances()->getGroups();
-    QSet<QString> groups(groupList.begin(), groupList.end());
+    groups.prepend("");
-    groupList = QStringList(groups.values());
+    ui->groupBox->addItems(groups);
-#else
+    int index = groups.indexOf(APPLICATION->instances()->getInstanceGroup(m_original->id()));
-    auto groups = APPLICATION->instances()->getGroups().toSet();
+    if (index == -1)
-    auto groupList = QStringList(groups.toList());
-#endif
-    groupList.sort(Qt::CaseInsensitive);
-    groupList.removeOne("");
-    groupList.push_front("");
-    ui->groupBox->addItems(groupList);
-    int index = groupList.indexOf(APPLICATION->instances()->getInstanceGroup(m_original->id()));
-    if (index == -1) {
         index = 0;
-    }
+
     ui->groupBox->setCurrentIndex(index);
     ui->groupBox->lineEdit()->setPlaceholderText(tr("No group"));
     ui->copySavesCheckbox->setChecked(m_selectedOptions.isCopySavesEnabled());

launcher/ui/dialogs/NewInstanceDialog.cpp

@@ -2,6 +2,7 @@
 /*
  *  Prism Launcher - Minecraft Launcher
  *  Copyright (C) 2022 Sefa Eyeoglu <contact@scrumplex.net>
+ *  Copyright (C) 2023 TheKodeToad <TheKodeToad@proton.me>
  *
  *  This program is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
@@ -75,23 +76,14 @@ NewInstanceDialog::NewInstanceDialog(const QString& initialGroup,
     InstIconKey = "default";
     ui->iconButton->setIcon(APPLICATION->icons()->getIcon(InstIconKey));
 
-#if QT_VERSION >= QT_VERSION_CHECK(5, 14, 0)
+    QStringList groups = APPLICATION->instances()->getGroups();
-    auto groupList = APPLICATION->instances()->getGroups();
+    groups.prepend("");
-    auto groups = QSet<QString>(groupList.begin(), groupList.end());
+    int index = groups.indexOf(initialGroup);
-    groupList = groups.values();
-#else
-    auto groups = APPLICATION->instances()->getGroups().toSet();
-    auto groupList = QStringList(groups.toList());
-#endif
-    groupList.sort(Qt::CaseInsensitive);
-    groupList.removeOne("");
-    groupList.push_front(initialGroup);
-    groupList.push_front("");
-    ui->groupBox->addItems(groupList);
-    int index = groupList.indexOf(initialGroup);
     if (index == -1) {
-        index = 0;
+        index = 1;
+        groups.insert(index, initialGroup);
     }
+    ui->groupBox->addItems(groups);
     ui->groupBox->setCurrentIndex(index);
     ui->groupBox->lineEdit()->setPlaceholderText(tr("No group"));