Ticket #1540: disableAtlasButtonIfNotAvailable.patch

binaries/data/mods/public/gui/pregame/mainmenu.xml

@@ -281 +281 @@
                 >
                     Scenario Editor
                     <action on="Press">
-                        closeMenu();
                         <![CDATA[
-                            // Start Atlas
-                            if (Engine.AtlasIsAvailable())
+                        closeMenu();
+                        if (Engine.AtlasIsAvailable())
                             Engine.RestartInAtlas();
-                            else
-                            messageBox(400, 200, "The scenario editor is not available or failed to load.", "Error", 2);
+                        else
+                            messageBox(400, 200, "The scenario editor is not available or failed to load. See the game logs for additional information.", "Error", 2);
                         ]]>
                     </action>
                 </object>

source/ps/DllLoader.cpp

@@ -22 +22 @@
 #include "lib/timer.h"
 #include "lib/posix/posix_dlfcn.h"
 #include "ps/CStr.h"
-#include "ps/CLogger.h"
 
 #if OS_MACOSX
 # include "lib/sysdep/os/osx/osx_bundle.h"
@@ -133 +132 @@
 }
 
 
-DllLoader::DllLoader(const char* name)
-    : m_Name(name), m_Handle(0)
+DllLoader::DllLoader(const char* name, CLogger::ELogMethod loadErrorLogMethod)
+    : m_Name(name), m_Handle(0), m_loadErrorLogMethod(loadErrorLogMethod)
 {
 }
 
@@ -161 +160 @@
         m_Handle = LoadAnyVariant(m_Name, errors);
         if(!m_Handle)   // (only report errors if nothing worked)
         {
-            LOGERROR(L"DllLoader: %hs", errors.str().c_str());
+            logLoadError(errors.str().c_str());
             m_Handle = HANDLE_UNAVAILABLE;
         }
     }
@@ -192 +191 @@
         throw PSERROR_DllLoader_SymbolNotFound();
 }
 
+void DllLoader::logLoadError(const char* errors)
+{
+    if (m_loadErrorLogMethod == CLogger::Normal)
+    {
+        LOGMESSAGE(L"DllLoader: %hs", errors);
+    }
+    else if (m_loadErrorLogMethod == CLogger::Warning)
+    {
+        LOGWARNING(L"DllLoader: %hs", errors);
+    }
+    else /*(m_loadErrorLogMethod == CLogger::Error)*/
+    {
+        LOGERROR(L"DllLoader: %hs", errors);
+    }
+}
+
 void DllLoader::OverrideLibdir(const char* libdir)
 {
     g_Libdir = libdir;

source/ps/DllLoader.h

@@ -19 +19 @@
 #define INCLUDED_DLLLOADER
 
 #include "ps/Errors.h"
+#include "ps/CLogger.h"
 
 ERROR_GROUP(DllLoader);
 ERROR_TYPE(DllLoader, DllNotLoaded);
@@ -33 +34 @@
      * @param name base name of the library (from which we'll derive
      *  "name.dll", "libname_dbg.so", etc). Pointer must remain valid for
      *  this object's lifetime (which is fine if you just use a string literal).
+     * @param loadErrorLogMethod Allows to customize how the DllLoader reports loading errors. For example, thanks to
+     * this parameter it is possible to handle a failed Atlas load gracefully on the UI side, without printing an error
+     * or warning, but still logging the message, just in case.
      */
-    DllLoader(const char* name);
+    DllLoader(const char* name, CLogger::ELogMethod loadErrorLogMethod = CLogger::Error);
 
     ~DllLoader();
 
@@ -78 +82 @@
     // casting from users.
     void LoadSymbolInternal(const char* name, void** fptr) const;
 
+    void logLoadError(const char* errors);
+
     const char* m_Name;
     void* m_Handle;
+    CLogger::ELogMethod m_loadErrorLogMethod;
 };
 
 template <typename T>

source/ps/GameSetup/Atlas.cpp

@@ -26 +26 @@
 // Atlas (map editor) integration
 //----------------------------------------------------------------------------
 
-DllLoader atlas_dll("AtlasUI");
+DllLoader atlas_dll("AtlasUI", CLogger::Normal);
 
 enum AtlasRunFlags
 {