move to platform directory, use separate GladLoader class

Author: mbaetgen-wup

src/libprojectM/ProjectMCWrapper.cpp

@@ -1,11 +1,13 @@
 #include "ProjectMCWrapper.hpp"
 
+#include "Renderer/Platform/GladLoader.hpp"
+
 #include <projectM-4/projectM.h>
 
 #include <Logging.hpp>
 
 #include <Audio/AudioConstants.hpp>
-#include <Renderer/PlatformGLResolver.hpp>
+#include <Renderer/Platform/GLResolver.hpp>
 
 #include <projectM-4/parameters.h>
 #include <projectM-4/render_opengl.h>
@@ -76,13 +78,15 @@ projectm_handle projectm_create_with_opengl_load_proc(void* (*load_proc)(const c
 {
     try
     {
-        // obtain shared resolver instance
-        auto& glResolver = libprojectM::Renderer::Platform::GLResolver::Instance();
+        // Init resolver to discover gl function pointers (guarded internally, valid to call multiple times)
+        // Note: only the initial load_proc will be used, parameters on subsequent calls are ignored
+        if (!libprojectM::Renderer::Platform::GLResolver::Instance().Initialize(load_proc, user_data))
+        {
+            return nullptr;
+        }
 
-        // init resolver to discover gl function pointers and init GLAD
-        // Initialize() is guarded internally, may be called multiple times
-        auto success = glResolver.Initialize(load_proc, user_data);
-        if (!success)
+        // Check GL requirements and init GLAD (guarded internally, valid to call multiple times)
+        if (!libprojectM::Renderer::Platform::GladLoader::Instance().LoadGlad())
         {
             return nullptr;
         }

src/libprojectM/Renderer/CMakeLists.txt

@@ -32,12 +32,14 @@ add_library(Renderer OBJECT
         MilkdropNoise.cpp
         MilkdropNoise.hpp
         OpenGL.h
-        PlatformGLContextCheck.cpp
-        PlatformGLContextCheck.hpp
-        PlatformGLResolver.cpp
-        PlatformGLResolver.hpp
-        PlatformLoader.cpp
-        PlatformLoader.hpp
+        Platform/DynamicLibrary.cpp
+        Platform/DynamicLibrary.hpp
+        Platform/GladLoader.cpp
+        Platform/GladLoader.hpp
+        Platform/GLProbe.cpp
+        Platform/GLProbe.hpp
+        Platform/GLResolver.cpp
+        Platform/GLResolver.hpp
         Point.hpp
         PresetTransition.cpp
         PresetTransition.hpp

…/libprojectM/Renderer/PlatformLoader.cpp …ctM/Renderer/Platform/DynamicLibrary.cppsrc/libprojectM/Renderer/PlatformLoader.cpp renamed to src/libprojectM/Renderer/Platform/DynamicLibrary.cpp src/libprojectM/Renderer/PlatformLoader.cpp renamed to src/libprojectM/Renderer/Platform/DynamicLibrary.cpp

@@ -1,5 +1,9 @@
 
-#include "PlatformLoader.hpp"
+#include "DynamicLibrary.hpp"
+
+#include "Logging.hpp"
+
+#include <cstdio>
 
 #ifndef __EMSCRIPTEN__
 
@@ -31,7 +35,7 @@
 #endif
 
 // -------------------------------------------------------------------------
-// Optional legacy DLL search fallback
+// Legacy DLL search fallback
 // -------------------------------------------------------------------------
 //
 // If the OS loader does not support LOAD_LIBRARY_SEARCH_* flags (ERROR_INVALID_PARAMETER),
@@ -42,10 +46,10 @@
 // (which can consult legacy search paths such as the process current working directory).
 // This is disabled by default for security hardening.
 //
-// Define PLATFORM_ALLOW_UNSAFE_DLL_SEARCH=1 to re-enable the legacy fallback.
-#ifndef PLATFORM_ALLOW_UNSAFE_DLL_SEARCH
+// Define GLRESOLVER_ALLOW_UNSAFE_DLL_SEARCH=1 to re-enable the legacy fallback.
+#ifndef GLRESOLVER_ALLOW_UNSAFE_DLL_SEARCH
 
-#define PLATFORM_ALLOW_UNSAFE_DLL_SEARCH 0
+#define GLRESOLVER_ALLOW_UNSAFE_DLL_SEARCH 0
 
 #endif
 
@@ -89,9 +93,49 @@ auto TrimTrailingWhitespace(std::string& str) -> void
 
 } // namespace
 
+auto EnvFlagEnabled(const char* name, bool defaultValue) -> bool
+{
+    if (name == nullptr)
+    {
+        return defaultValue;
+    }
+    const char* v = std::getenv(name);
+    if (v == nullptr || v[0] == '\0')
+    {
+        return defaultValue;
+    }
+
+    // Lowercase first char is enough for common values.
+    const char c0 = (v[0] >= 'A' && v[0] <= 'Z') ? static_cast<char>(v[0] - 'A' + 'a') : v[0];
+    if (c0 == '1' || c0 == 'y' || c0 == 't')
+    {
+        return true;
+    }
+    if (c0 == '0' || c0 == 'n' || c0 == 'f')
+    {
+        return false;
+    }
+
+    // Accept "on"/"off".
+    if ((c0 == 'o') && (v[1] != '\0'))
+    {
+        const char c1 = (v[1] >= 'A' && v[1] <= 'Z') ? static_cast<char>(v[1] - 'A' + 'a') : v[1];
+        if (c1 == 'n')
+        {
+            return true;
+        }
+        if (c1 == 'f')
+        {
+            return false;
+        }
+    }
+
+    return defaultValue;
+}
+
 #ifndef __EMSCRIPTEN__
 
-    DynamicLibrary::~DynamicLibrary()
+DynamicLibrary::~DynamicLibrary()
     {
         if (m_closeOnDestruct)
         {
@@ -142,14 +186,16 @@ auto TrimTrailingWhitespace(std::string& str) -> void
                 continue;
             }
 
+            LOG_DEBUG(std::string("[DynamicLibrary] open attempt: ") + name);
+
 #ifdef _WIN32
 
             // DLL loading policy:
             //  - Prefer LoadLibraryExA with LOAD_LIBRARY_SEARCH_* flags to avoid CWD/PATH hijacking.
             //  - If the OS loader doesn't support the flags (ERROR_INVALID_PARAMETER), fall back to:
             //      * application directory (explicit full path based on the running module)
             //      * System32 (for known system DLLs like opengl32.dll)
-            //      * optionally, legacy LoadLibraryA(name) (disabled by default; see PLATFORM_ALLOW_UNSAFE_DLL_SEARCH).
+            //      * optionally, legacy LoadLibraryA(name) (disabled by default; see GLRESOLVER_ALLOW_UNSAFE_DLL_SEARCH).
             //
             // NOTE: We intentionally do not call SetDefaultDllDirectories() here. It changes
             // the process-wide DLL search behavior and can surprise a host application.
@@ -202,7 +248,7 @@ auto TrimTrailingWhitespace(std::string& str) -> void
                 return ::LoadLibraryA(dllName);
             };
 
-            // Best-effort legacy fallback when LOAD_LIBRARY_SEARCH_* flags are unavailable.
+            // legacy fallback when LOAD_LIBRARY_SEARCH_* flags are unavailable.
             // Prefer LOAD_WITH_ALTERED_SEARCH_PATH for absolute paths so dependent DLLs are
             // resolved relative to the loaded module directory.
             auto tryLoadExplicitPathFallback = [&](const char* dllPath) -> HMODULE {
@@ -285,7 +331,7 @@ auto TrimTrailingWhitespace(std::string& str) -> void
 
                 if (handle == nullptr && ::GetLastError() == ERROR_INVALID_PARAMETER)
                 {
-                    // Flags unsupported: best-effort manual safe search.
+                    // Flags unsupported: manual safe search.
                     // 1) Application directory
                     if (handle == nullptr && !appFull.empty())
                     {
@@ -307,7 +353,7 @@ auto TrimTrailingWhitespace(std::string& str) -> void
                     // NOTE: LoadLibrary(name) without LOAD_LIBRARY_SEARCH_* flags can consult legacy
                     // search paths (including the current working directory) depending on process
                     // configuration. See Microsoft guidance on DLL search order hardening.
-                    if (handle == nullptr && PLATFORM_ALLOW_UNSAFE_DLL_SEARCH != 0)
+                    if (handle == nullptr && GLRESOLVER_ALLOW_UNSAFE_DLL_SEARCH != 0)
                     {
                         handle = tryLoad(name);
                     }
@@ -326,11 +372,43 @@ auto TrimTrailingWhitespace(std::string& str) -> void
             ::dlerror(); // clear any prior error
             m_handle = ::dlopen(name, RTLD_NOW | RTLD_LOCAL);
 
+#if defined(__APPLE__)
+            // Allow callers to specify an explicit search directory for bundled dylibs
+            // (e.g., ANGLE's libEGL.dylib / libGLESv2.dylib inside a macOS app bundle).
+            // This is an optional override for deployments where @rpath-based discovery is not sufficient.
+            // It is intentionally scoped to macOS to avoid changing loader semantics elsewhere.
+            if (m_handle == nullptr)
+            {
+                const char* const extraDir = std::getenv("GLRESOLVER_DYLIB_DIR");
+                if (extraDir != nullptr && extraDir[0] != '\00')
+                {
+                    std::string full(extraDir);
+                    if (!full.empty() && full.back() != '/')
+                    {
+                        full.push_back('/');
+                    }
+                    full += name;
+                    ::dlerror();
+
+                    m_handle = ::dlopen(full.c_str(), RTLD_NOW | RTLD_LOCAL);
+
+                    if (m_handle != nullptr)
+                    {
+                        m_loadedName = full;
+                        LOG_DEBUG(std::string("[DynamicLibrary] opened: ") + m_loadedName);
+                        return true;
+                    }
+                }
+            }
+
+#endif
+
 #endif
 
             if (m_handle != nullptr)
             {
                 m_loadedName = name;
+                LOG_DEBUG(std::string("[DynamicLibrary] opened: ") + m_loadedName);
                 return true;
             }
 
@@ -382,6 +460,10 @@ auto TrimTrailingWhitespace(std::string& str) -> void
 
         } // for loop
 
+        if (!reason.empty())
+        {
+            LOG_DEBUG(std::string("[DynamicLibrary] open failed: ") + reason);
+        }
         return false;
     }
 
@@ -467,7 +549,7 @@ auto TrimTrailingWhitespace(std::string& str) -> void
         }
 
         // If the host has already loaded EGL/GLES provider DLLs (e.g., ANGLE), probe those modules as well.
-        // This is a best-effort enhancement for applications embedding this library where we may not have
+        // This is a enhancement for applications embedding this library where we may not have
         // opened the provider libraries ourselves.
         {
             static constexpr std::array<const char*, 6> moduleNames =

…/libprojectM/Renderer/PlatformLoader.hpp …ctM/Renderer/Platform/DynamicLibrary.hppsrc/libprojectM/Renderer/PlatformLoader.hpp renamed to src/libprojectM/Renderer/Platform/DynamicLibrary.hpp src/libprojectM/Renderer/PlatformLoader.hpp renamed to src/libprojectM/Renderer/Platform/DynamicLibrary.hpp

@@ -11,25 +11,6 @@
 
 #include <windows.h>
 
-// -------------------------------------------------------------------------
-// Optional legacy DLL search fallback
-// -------------------------------------------------------------------------
-//
-// If the OS loader does not support LOAD_LIBRARY_SEARCH_* flags (ERROR_INVALID_PARAMETER),
-// this loader tries to load from explicit safe locations (application directory and
-// System32 for known system DLLs).
-//
-// As a last resort, some applications may still want to fall back to LoadLibrary(name)
-// (which can consult legacy search paths such as the process current working directory).
-// This is disabled by default for security hardening.
-//
-// Define PLATFORM_ALLOW_UNSAFE_DLL_SEARCH=1 to re-enable the legacy fallback.
-#ifndef PLATFORM_ALLOW_UNSAFE_DLL_SEARCH
-
-#define PLATFORM_ALLOW_UNSAFE_DLL_SEARCH 0
-
-#endif
-
 #else // #ifdef _WIN32
 
 #include <dlfcn.h>
@@ -62,11 +43,11 @@
 // Optional loader diagnostics
 // -------------------------------------------------------------------------
 //
-// When enabled, the loader prints best-effort diagnostics for unusual ABI
+// When enabled, the loader prints diagnostics for unusual ABI
 // situations (e.g., platforms where data pointers and function pointers have
 // different representations/sizes). Disabled by default to avoid noisy output.
-#ifndef PLATFORM_LOADER_DIAGNOSTICS
-#define PLATFORM_LOADER_DIAGNOSTICS 0
+#ifndef GLRESOLVER_LOADER_DIAGNOSTICS
+#define GLRESOLVER_LOADER_DIAGNOSTICS 0
 #endif
 
 namespace libprojectM {
@@ -86,7 +67,7 @@ using LibHandle = void*;
 
 #endif
 
-#if PLATFORM_LOADER_DIAGNOSTICS
+#if GLRESOLVER_LOADER_DIAGNOSTICS
 
 inline auto ReportFnPtrSizeMismatch(const char* where, std::size_t fnSize, std::size_t ptrSize) -> void
 {
@@ -99,7 +80,7 @@ inline auto ReportFnPtrSizeMismatch(const char* where, std::size_t fnSize, std::
 #endif
 
 /**
- * @brief Converts a symbol pointer (void*) into a function pointer type (best-effort).
+ * @brief Converts a symbol pointer (void*) into a function pointer type .
  *
  * dlsym/GetProcAddress return untyped procedure addresses (void* on POSIX, FARPROC on Windows). Converting those to function
  * pointers via reinterpret_cast is not guaranteed to be portable in ISO C++.
@@ -129,7 +110,7 @@ auto SymbolToFunction(void* symbol) -> Fn
     if (sizeof(Fn) != sizeof(void*))
     {
 
-#if PLATFORM_LOADER_DIAGNOSTICS
+#if GLRESOLVER_LOADER_DIAGNOSTICS
 
         ReportFnPtrSizeMismatch("SymbolToFunction", sizeof(Fn), sizeof(void*));
 
@@ -144,7 +125,7 @@ auto SymbolToFunction(void* symbol) -> Fn
 }
 
 /**
- * @brief Converts a function pointer into a symbol pointer representation (best-effort).
+ * @brief Converts a function pointer into a symbol pointer representation .
  *
  * The inverse of SymbolToFunction(). This is used at API boundaries where legacy
  * interfaces represent procedure addresses as void*.
@@ -168,7 +149,7 @@ auto FunctionToSymbol(Fn func) -> void*
     if (sizeof(Fn) != sizeof(void*))
     {
 
-#if PLATFORM_LOADER_DIAGNOSTICS
+#if GLRESOLVER_LOADER_DIAGNOSTICS
 
         ReportFnPtrSizeMismatch("FunctionToSymbol", sizeof(Fn), sizeof(void*));
 
@@ -183,7 +164,7 @@ auto FunctionToSymbol(Fn func) -> void*
 }
 
 /**
- * @brief Converts a function pointer into an integer representation (best-effort).
+ * @brief Converts a function pointer into an integer representation .
  *
  * Useful for validating platform-specific sentinel values (e.g. Windows WGL).
  * Returns 0 if the conversion is not representable.
@@ -203,7 +184,7 @@ auto FunctionToInteger(Fn func) -> std::uintptr_t
     if (sizeof(Fn) != sizeof(void*))
     {
 
-#if PLATFORM_LOADER_DIAGNOSTICS
+#if GLRESOLVER_LOADER_DIAGNOSTICS
 
         ReportFnPtrSizeMismatch("FunctionToInteger", sizeof(Fn), sizeof(void*));
 
@@ -222,10 +203,15 @@ auto FunctionToInteger(Fn func) -> std::uintptr_t
     return value;
 }
 
+/**
+ * @brief Parses a bool-ish env var. Truthy: 1, y, yes, t, true, on (case-insensitive). Falsy: 0, n, no, f, false, off.
+ */
+auto EnvFlagEnabled(const char* name, bool defaultValue) -> bool;
+
 #ifdef _WIN32
 
 /**
- * @brief Converts a Windows FARPROC into the generic symbol representation (void*) (best-effort).
+ * @brief Converts a Windows FARPROC into the generic symbol representation (void*) .
  *
  * Windows GetProcAddress returns a function pointer type (FARPROC). To avoid relying on a direct
  * reinterpret_cast between function pointers and object pointers, this helper copies the bit pattern