moved instance setup/selection to instancemanager.cpp

comments

5 files changed, 214 insertions, 179 deletions

diff --git a/src/instancemanager.cpp b/src/instancemanager.cpp
index fbafc6e8..b68d715b 100644
--- a/src/instancemanager.cpp
+++ b/src/instancemanager.cpp
@@ -21,9 +21,14 @@ along with Mod Organizer.  If not, see <http://www.gnu.org/licenses/>.
 #include "instancemanager.h"
 #include "selectiondialog.h"
 #include "settings.h"
-#include "shared/appconfig.h"
 #include "plugincontainer.h"
+#include "nexusinterface.h"
+#include "createinstancedialog.h"
+#include "instancemanagerdialog.h"
+#include "createinstancedialogpages.h"
+#include "shared/appconfig.h"
 #include "shared/util.h"
+#include "shared/error_report.h"
 #include <report.h>
 #include <iplugingame.h>
 #include <utility.h>
@@ -751,3 +756,153 @@ bool InstanceManager::validInstanceName(const QString& instanceName) const
 
   return (instanceName == sanitizeInstanceName(instanceName));
 }
+
+
+
+std::optional<Instance> selectInstance()
+{
+  auto& m = InstanceManager::singleton();
+
+  NexusInterface ni(nullptr);
+  PluginContainer pc(nullptr);
+  pc.loadPlugins();
+
+  if (!m.hasAnyInstances()) {
+    // no instances configured
+    CreateInstanceDialog dlg(pc, nullptr);
+    if (dlg.exec() != QDialog::Accepted) {
+      return {};
+    }
+
+    return m.currentInstance();
+  }
+
+
+  InstanceManagerDialog dlg(pc);
+  dlg.setRestartOnSelect(false);
+
+  dlg.show();
+  dlg.activateWindow();
+  dlg.raise();
+
+  if (dlg.exec() != QDialog::Accepted) {
+    return {};
+  }
+
+  return m.currentInstance();
+}
+
+SetupInstanceResults setupInstance(Instance& instance, PluginContainer& pc)
+{
+  const auto setupResult = instance.setup(pc);
+
+  switch (setupResult)
+  {
+    case Instance::SetupResults::Ok:
+    {
+      return SetupInstanceResults::Ok;
+    }
+
+    case Instance::SetupResults::BadIni:
+    {
+      MOShared::criticalOnTop(
+        QObject::tr("Cannot open instance '%1', failed to read INI file %2.")
+        .arg(instance.name()).arg(instance.iniPath()));
+
+      return SetupInstanceResults::SelectAnother;
+    }
+
+    case Instance::SetupResults::IniMissingGame:
+    {
+      MOShared::criticalOnTop(
+        QObject::tr(
+          "Cannot open instance '%1', the managed game was not found in the INI "
+          "file %2. Select the game managed by this instance.")
+        .arg(instance.name()).arg(instance.iniPath()));
+
+      CreateInstanceDialog dlg(pc, nullptr);
+      dlg.setSinglePage<cid::GamePage>(instance.name());
+
+      dlg.show();
+      dlg.activateWindow();
+      dlg.raise();
+
+      if (dlg.exec() != QDialog::Accepted) {
+        return SetupInstanceResults::Exit;
+      }
+
+      instance.setGame(
+        dlg.creationInfo().game->gameName(),
+        dlg.creationInfo().gameLocation);
+
+      return SetupInstanceResults::TryAgain;
+    }
+
+    case Instance::SetupResults::PluginGone:
+    {
+      MOShared::criticalOnTop(
+        QObject::tr(
+          "Cannot open instance '%1', the game plugin '%2' doesn't exist. It "
+          "may have been deleted by an antivirus. Select another instance.")
+        .arg(instance.name()).arg(instance.gameName()));
+
+      return SetupInstanceResults::SelectAnother;
+    }
+
+    case Instance::SetupResults::GameGone:
+    {
+      MOShared::criticalOnTop(
+        QObject::tr(
+          "Cannot open instance '%1', the game directory '%2' doesn't exist or "
+          "the game plugin '%3' doesn't recognize it. Select the game managed "
+          "by this instance.")
+        .arg(instance.name())
+        .arg(instance.gameDirectory())
+        .arg(instance.gameName()));
+
+      CreateInstanceDialog dlg(pc, nullptr);
+      dlg.setSinglePage<cid::GamePage>(instance.name());
+
+      dlg.show();
+      dlg.activateWindow();
+      dlg.raise();
+
+      if (dlg.exec() != QDialog::Accepted) {
+        return SetupInstanceResults::Exit;
+      }
+
+      instance.setGame(
+        dlg.creationInfo().game->gameName(),
+        dlg.creationInfo().gameLocation);
+
+      return SetupInstanceResults::TryAgain;
+    }
+
+    case Instance::SetupResults::MissingVariant:
+    {
+      CreateInstanceDialog dlg(pc, nullptr);
+
+      dlg.getPage<cid::GamePage>()->select(
+        instance.gamePlugin(), instance.gameDirectory());
+
+      dlg.setSinglePage<cid::VariantsPage>(instance.name());
+
+      dlg.show();
+      dlg.activateWindow();
+      dlg.raise();
+
+      if (dlg.exec() != QDialog::Accepted) {
+        return SetupInstanceResults::Exit;
+      }
+
+      instance.setVariant(dlg.creationInfo().gameVariant);
+
+      return SetupInstanceResults::TryAgain;
+    }
+
+    default:
+    {
+      return SetupInstanceResults::Exit;
+    }
+  }
+}
diff --git a/src/instancemanager.h b/src/instancemanager.h
index 161df739..d75a46f4 100644
--- a/src/instancemanager.h
+++ b/src/instancemanager.h
@@ -332,4 +332,41 @@ private:
   std::optional<QString> m_overrideProfileName;
 };
 
+
+// see setupInstance()
+//
+enum class SetupInstanceResults
+{
+  Ok,
+  TryAgain,
+  SelectAnother,
+  Exit
+};
+
+// if there are no instances configured, global or portable, shows the
+// create instance dialog and returns the new instance or empty if the user
+// cancelled
+//
+// if there is at least one instance available, unconditionally show the
+// instance manager dialog and returns the selected instnace or empty if the
+// user cancelled
+//
+std::optional<Instance> selectInstance();
+
+// calls instance.setup() tries to handle problems by itself:
+//
+//  - if the ini is missing some information, will show dialogs and ask the user
+//    to fill in what's required (such as the game directory, variant, etc.);
+//    if successful, returns TryAgain and setupInstance() can be called again
+//    with the same instance
+//
+//  - if the instance cannot be used (no game plugin found for it, ini can't
+//    be read, etc.), returns SelectAnother
+//
+//  - if the user cancels at any point, returns Exit
+//
+//  - if the instance has been set up correctly, returns Ok
+//
+SetupInstanceResults setupInstance(Instance& instance, PluginContainer& pc);
+
 #endif  // MODORGANIZER_INSTANCEMANAGER_INCLUDED
diff --git a/src/main.cpp b/src/main.cpp
index a8ea2601..fdd09872 100644
--- a/src/main.cpp
+++ b/src/main.cpp
@@ -34,20 +34,13 @@ along with Mod Organizer.  If not, see <http://www.gnu.org/licenses/>.
 #include "commandline.h"
 #include "shared/util.h"
 #include "shared/appconfig.h"
-
+#include "shared/error_report.h"
 #include <imoinfo.h>
 #include <report.h>
 #include <usvfs.h>
 #include <log.h>
 #include <utility.h>
 
-// see addDllsToPath() below
-#pragma comment(linker, "/manifestDependency:\"" \
-    "name='dlls' " \
-    "processorArchitecture='x86' " \
-    "version='1.0.0.0' " \
-    "type='win32' \"")
-
 
 using namespace MOBase;
 using namespace MOShared;
@@ -171,174 +164,6 @@ std::optional<int> handleCommandLine(
   return {};
 }
 
-std::optional<Instance> selectInstance()
-{
-  auto& m = InstanceManager::singleton();
-
-  NexusInterface ni(nullptr);
-  PluginContainer pc(nullptr);
-  pc.loadPlugins();
-
-  if (!m.hasAnyInstances()) {
-    // no instances configured
-    CreateInstanceDialog dlg(pc, nullptr);
-    if (dlg.exec() != QDialog::Accepted) {
-      return {};
-    }
-
-    return m.currentInstance();
-  }
-
-
-  InstanceManagerDialog dlg(pc);
-  dlg.setRestartOnSelect(false);
-
-  dlg.show();
-  dlg.activateWindow();
-  dlg.raise();
-
-  if (dlg.exec() != QDialog::Accepted) {
-    return {};
-  }
-
-  return m.currentInstance();
-}
-
-enum class SetupInstanceResults
-{
-  Ok,
-  TryAgain,
-  SelectAnother,
-  Exit
-};
-
-
-void criticalOnTop(const QString& message)
-{
-  QMessageBox mb(QMessageBox::Critical, QObject::tr("Mod Organizer"), message);
-
-  mb.show();
-  mb.activateWindow();
-  mb.raise();
-  mb.exec();
-}
-
-
-SetupInstanceResults setupInstance(Instance& instance, PluginContainer& pc)
-{
-  const auto setupResult = instance.setup(pc);
-
-  switch (setupResult)
-  {
-    case Instance::SetupResults::Ok:
-    {
-      return SetupInstanceResults::Ok;
-    }
-
-    case Instance::SetupResults::BadIni:
-    {
-      criticalOnTop(
-        QObject::tr("Cannot open instance '%1', failed to read INI file %2.")
-          .arg(instance.name()).arg(instance.iniPath()));
-
-      return SetupInstanceResults::SelectAnother;
-    }
-
-    case Instance::SetupResults::IniMissingGame:
-    {
-      criticalOnTop(
-        QObject::tr(
-          "Cannot open instance '%1', the managed game was not found in the INI "
-          "file %2. Select the game managed by this instance.")
-            .arg(instance.name()).arg(instance.iniPath()));
-
-      CreateInstanceDialog dlg(pc, nullptr);
-      dlg.setSinglePage<cid::GamePage>(instance.name());
-
-      dlg.show();
-      dlg.activateWindow();
-      dlg.raise();
-
-      if (dlg.exec() != QDialog::Accepted) {
-        return SetupInstanceResults::Exit;
-      }
-
-      instance.setGame(
-        dlg.creationInfo().game->gameName(),
-        dlg.creationInfo().gameLocation);
-
-      return SetupInstanceResults::TryAgain;
-    }
-
-    case Instance::SetupResults::PluginGone:
-    {
-      criticalOnTop(
-        QObject::tr(
-          "Cannot open instance '%1', the game plugin '%2' doesn't exist. It "
-          "may have been deleted by an antivirus. Select another instance.")
-            .arg(instance.name()).arg(instance.gameName()));
-
-      return SetupInstanceResults::SelectAnother;
-    }
-
-    case Instance::SetupResults::GameGone:
-    {
-      criticalOnTop(
-        QObject::tr(
-          "Cannot open instance '%1', the game directory '%2' doesn't exist or "
-          "the game plugin '%3' doesn't recognize it. Select the game managed "
-          "by this instance.")
-            .arg(instance.name())
-            .arg(instance.gameDirectory())
-            .arg(instance.gameName()));
-
-      CreateInstanceDialog dlg(pc, nullptr);
-      dlg.setSinglePage<cid::GamePage>(instance.name());
-
-      dlg.show();
-      dlg.activateWindow();
-      dlg.raise();
-
-      if (dlg.exec() != QDialog::Accepted) {
-        return SetupInstanceResults::Exit;
-      }
-
-      instance.setGame(
-        dlg.creationInfo().game->gameName(),
-        dlg.creationInfo().gameLocation);
-
-      return SetupInstanceResults::TryAgain;
-    }
-
-    case Instance::SetupResults::MissingVariant:
-    {
-      CreateInstanceDialog dlg(pc, nullptr);
-
-      dlg.getPage<cid::GamePage>()->select(
-        instance.gamePlugin(), instance.gameDirectory());
-
-      dlg.setSinglePage<cid::VariantsPage>(instance.name());
-
-      dlg.show();
-      dlg.activateWindow();
-      dlg.raise();
-
-      if (dlg.exec() != QDialog::Accepted) {
-        return SetupInstanceResults::Exit;
-      }
-
-      instance.setVariant(dlg.creationInfo().gameVariant);
-
-      return SetupInstanceResults::TryAgain;
-    }
-
-    default:
-    {
-      return SetupInstanceResults::Exit;
-    }
-  }
-}
-
 int runApplication(
   MOApplication &application, const cl::CommandLine& cl,
   SingleInstance &instance, const QString &dataPath,
@@ -561,11 +386,11 @@ int doOneRun(
       // the previously used instance doesn't exist anymore
 
       if (m.hasAnyInstances()) {
-        criticalOnTop(QObject::tr(
+        MOShared::criticalOnTop(QObject::tr(
           "Instance at '%1' not found. Select another instance.")
           .arg(currentInstance->directory()));
       } else {
-        criticalOnTop(QObject::tr(
+        MOShared::criticalOnTop(QObject::tr(
           "Instance at '%1' not found. You must create a new instance")
             .arg(currentInstance->directory()));
       }
diff --git a/src/shared/error_report.cpp b/src/shared/error_report.cpp
index 4185b544..09fdcb49 100644
--- a/src/shared/error_report.cpp
+++ b/src/shared/error_report.cpp
@@ -51,4 +51,14 @@ void reportError(LPCWSTR format, ...)
   MessageBoxW(nullptr, buffer, L"Error", MB_OK | MB_ICONERROR);

 }

 

+void criticalOnTop(const QString& message)

+{

+  QMessageBox mb(QMessageBox::Critical, QObject::tr("Mod Organizer"), message);

+

+  mb.show();

+  mb.activateWindow();

+  mb.raise();

+  mb.exec();

+}

+

 } // namespace MOShared

diff --git a/src/shared/error_report.h b/src/shared/error_report.h
index da07c728..9343d3da 100644
--- a/src/shared/error_report.h
+++ b/src/shared/error_report.h
@@ -31,6 +31,14 @@ namespace MOShared
 void reportError(LPCSTR format, ...);

 void reportError(LPCWSTR format, ...);

 

+// shows a critical message box that's raised to the top of the zorder, useful

+// for messages without a main window, which sometimes makes them pop up behind

+// all other windows

+//

+// the dialog is not topmost, it's just raised once when shown

+//

+void criticalOnTop(const QString& message);

+

 } // namespace MOShared

 

 #endif  // MODORGANIZER_SHARED_ERROR_REPORT_INCLUDED