cleanup

Author: mbaetgen-wup

src/api/include/projectM-4/core.h

@@ -38,7 +38,7 @@ extern "C" {
  * If this function returns NULL, in most cases the OpenGL context is not initialized, not made
  * current or insufficient to render projectM visuals.
  *
- * Note: The OpenGL resolver is initialized on the first call to either projectm_create() or projectm_create_with_opengl_load_proc().
+ * The OpenGL resolver is initialized on the first call to either projectm_create() or projectm_create_with_opengl_load_proc().
  * All projectM instances share the same resolver.
  *
  * @return A projectM handle for the newly created instance that must be used in subsequent API calls.
@@ -54,7 +54,7 @@ PROJECTM_EXPORT projectm_handle projectm_create();
  * If this function returns NULL, in most cases the OpenGL context is not initialized, not made
  * current or insufficient to render projectM visuals.
  *
- * Note: The OpenGL resolver is initialized on the first call to either projectm_create() or projectm_create_with_opengl_load_proc().
+ * The OpenGL resolver is initialized on the first call to either projectm_create() or projectm_create_with_opengl_load_proc().
  * All projectM instances share the same resolver, and subsequent calls ignore the provided load_proc.
  *
  * @return A projectM handle for the newly created instance that must be used in subsequent API calls.

src/libprojectM/Renderer/Platform/DynamicLibrary.cpp

@@ -258,8 +258,8 @@ DynamicLibrary::~DynamicLibrary()
                 }
 
                 // Absolute path heuristics for Win32:
-                //  - "C:\\..."  (drive)
-                //  - "\\\\server\\share..." (UNC)
+                //  - "C:\\path\\to\\library.dll"  (drive)
+                //  - "\\\\server\\share\\library.dll" (UNC)
                 const bool isDriveAbs = (std::strlen(dllPath) > 2u) && (dllPath[1] == ':') &&
                                         (dllPath[2] == '\\' || dllPath[2] == '/');
                 const bool isUncAbs = (dllPath[0] == '\\' && dllPath[1] == '\\');
@@ -380,9 +380,10 @@ DynamicLibrary::~DynamicLibrary()
             if (m_handle == nullptr)
             {
                 const char* const extraDir = std::getenv("GLRESOLVER_DYLIB_DIR");
-                if (extraDir != nullptr && extraDir[0] != '\00')
+                if (extraDir != nullptr && extraDir[0] != '\0')
                 {
                     std::string full(extraDir);
+                    LOG_DEBUG(std::string("[DynamicLibrary] using ") + extraDirVar + " to locate: " + name);
                     if (!full.empty() && full.back() != '/')
                     {
                         full.push_back('/');

src/libprojectM/Renderer/Platform/DynamicLibrary.hpp

@@ -378,7 +378,7 @@ class DynamicLibrary
 
 private:
     LibHandle m_handle{};           //!< Library handle used to access the system library.
-    std::string m_loadedName;       //< Successfully opened library name.
+    std::string m_loadedName;       //!< Successfully opened library name.
     bool m_closeOnDestruct{false};  //!< If true, Close() is called from the destructor.
 };
 

src/libprojectM/Renderer/Platform/GLResolver.cpp

@@ -318,7 +318,7 @@ auto GLResolver::Initialize(UserResolver resolver, void* userData) -> bool
 
         diag += std::string(" glx_get_proc=\"") + (state.m_glxGetProcAddress != nullptr ? "yes" : "no") + "\"";
 
-#if PLATFORM_GLX_ALLOW_CORE_GETPROCADDRESS_FALLBACK
+#if GLRESOLVER_GLX_ALLOW_CORE_GETPROCADDRESS_FALLBACK
 
         diag += " glx_policy=\"ext+fallback\"";
 
@@ -341,7 +341,7 @@ auto GLResolver::Initialize(UserResolver resolver, void* userData) -> bool
         m_loaded = false;
 
         // Provide a concrete diagnostic to help debug "no backend" cases.
-        LOG_ERROR(std::string("[GLResolver] No current GL backend detected. ")
+        LOG_ERROR(std::string("[GLResolver] No current GL backend detected: ")
                               + "egl_current=\"" + (currentContext.eglCurrent ? "yes" : "no") + "\"" 
                               + " wgl_current=\"" + (currentContext.wglCurrent ? "yes" : "no") + "\"" 
                               + " glx_current=\"" + (currentContext.glxCurrent ? "yes" : "no") + "\"" 
@@ -351,7 +351,7 @@ auto GLResolver::Initialize(UserResolver resolver, void* userData) -> bool
         m_initializing = false;
         m_initCv.notify_all();
         lock.unlock();
-        LOG_ERROR("[GLResolver] Failed to detect an active GL backend for the current context.");
+        LOG_ERROR("[GLResolver] Failed to detect an active GL backend for the current context");
         return false;
     }
 
@@ -436,13 +436,13 @@ auto GLResolver::GetProcAddress(const char* name) const -> void*
 
     if (m_initializing)
     {
-        LOG_DEBUG(std::string("[GLResolver] GetProcAddress called while initialization is in-flight; waiting."));
+        LOG_DEBUG(std::string("[GLResolver] GetProcAddress called while initialization is in-flight; waiting"));
         m_initCv.wait(lock, [this]() { return !m_initializing; });
     }
 
     if (!m_loaded)
     {
-        LOG_ERROR(std::string("[GLResolver] GetProcAddress called without initialization."));
+        LOG_ERROR(std::string("[GLResolver] GetProcAddress called without initialization"));
         return nullptr;
     }
 
@@ -842,7 +842,7 @@ void GLResolver::ResolveProviderFunctions(ResolverState& state)
             }
         }
 
-        LOG_DEBUG(std::string("[GLResolver] EGL get_all_proc_addresses=") + (state.m_eglGetAllProcAddresses ? "yes" : "no"));
+        LOG_DEBUG(std::string("[GLResolver] EGL  get_all_proc_addresses=") + (state.m_eglGetAllProcAddresses ? "yes" : "no"));
     }
 
 #ifdef _WIN32

src/libprojectM/Renderer/Platform/GLResolver.hpp

@@ -8,16 +8,16 @@
 #include <mutex>
 #include <string>
 
-// Optional GLX fallback for resolving non-extension gl* names via glXGetProcAddress*.
+// GLX fallback for resolving non-extension gl* names via glXGetProcAddress*.
 //
 // Default behavior is conservative: only extension-style names are resolved via
 // glXGetProcAddress*, because some implementations return non-null for unknown
 // symbols which may crash when called.
 //
 // If support for legacy/non-GLVND stacks is required where some core entry points are not
 // exported from libGL/libOpenGL, you may enable this as a last-resort fallback.
-#ifndef PLATFORM_GLX_ALLOW_CORE_GETPROCADDRESS_FALLBACK
-#define PLATFORM_GLX_ALLOW_CORE_GETPROCADDRESS_FALLBACK 0
+#ifndef GLRESOLVER_GLX_ALLOW_CORE_GETPROCADDRESS_FALLBACK
+#define GLRESOLVER_GLX_ALLOW_CORE_GETPROCADDRESS_FALLBACK 0
 #endif
 
 namespace libprojectM
@@ -111,9 +111,6 @@ using UserResolver = void* (*)(const char* name, void* userData);
  *
  * Compile-time switches:
  *
- * - GLRESOLVER_LOADER_DIAGNOSTICS=1
- *     When enabled, the loader prints diagnostics for unusual ABI situations. Default is disabled.
- *
  * - GLRESOLVER_ALLOW_UNSAFE_DLL_SEARCH=1 (legacy Windows only)
  *     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
@@ -122,6 +119,13 @@ using UserResolver = void* (*)(const char* name, void* userData);
  *     (which can consult legacy search paths such as the process current working directory).
  *     This is disabled by default for security hardening.
  *
+ * - GLRESOLVER_GLX_ALLOW_CORE_GETPROCADDRESS_FALLBACK=1
+ *     Enable GLX fallback for resolving non-extension gl* names via glXGetProcAddress*.
+ *     Disabled by default.
+ *
+ * - GLRESOLVER_LOADER_DIAGNOSTICS=1
+ *     When enabled, the loader prints diagnostics for unusual ABI situations. Default is disabled.
+ *
  * - USE_GLES
  *   Switch for compile-time API selection:
  *
@@ -154,7 +158,7 @@ using UserResolver = void* (*)(const char* name, void* userData);
  *     - EGL: Try to resolve function via eglGetProcAddress as fallback.
  *            Always enabled.
  *     - GLX: Try to resolve function via glXGetProcAddress as fallback.
- *            Optional, enabled via PLATFORM_GLX_ALLOW_CORE_GETPROCADDRESS_FALLBACK.
+ *            Optional, enabled via GLRESOLVER_GLX_ALLOW_CORE_GETPROCADDRESS_FALLBACK.
  *
  * Resolution order (Emscripten/WebGL):
  *
@@ -345,24 +349,24 @@ class GLResolver
      */
     struct CurrentContextProbe
     {
-        bool eglLibOpened{false};
-        bool eglAvailable{false};
-        bool eglCurrent{false};
+        bool eglLibOpened{false};  //!< True if an EGL library was opened.
+        bool eglAvailable{false};  //!< True if EGL entry points were resolved.
+        bool eglCurrent{false};    //!< True if an EGL context appears current.
 
-        bool glxLibOpened{false};
-        bool glxAvailable{false};
-        bool glxCurrent{false};
+        bool glxLibOpened{false};  //!< True if a GLX library was opened.
+        bool glxAvailable{false};  //!< True if GLX entry points were resolved.
+        bool glxCurrent{false};    //!< True if a GLX context appears current.
 
-        bool wglLibOpened{false};
-        bool wglAvailable{false};
-        bool wglCurrent{false};
+        bool wglLibOpened{false};  //!< True if a WGL library was opened.
+        bool wglAvailable{false};  //!< True if WGL entry points were resolved.
+        bool wglCurrent{false};    //!< True if a WGL context appears current.
 
         bool cglLibOpened{false};
-        bool cglAvailable{false};
-        bool cglCurrent{false};
+        bool cglAvailable{false};  //!< True if CGL entry points were resolved.
+        bool cglCurrent{false};    //!< True if a CGL context appears current.
 
-        bool webglAvailable{false};
-        bool webglCurrent{false};
+        bool webglAvailable{false};  //!< True if WebGL entry points were resolved.
+        bool webglCurrent{false};    //!< True if a WebGL context appears current.
     };
 
     /**

src/libprojectM/Renderer/Platform/GladLoader.cpp

@@ -93,7 +93,7 @@ auto GladLoader::LoadGlad() -> bool
 
     if (!GLResolver::Instance().IsLoaded())
     {
-        LOG_ERROR(std::string("[GladLoader] Cannot load GLAD, GLResolver is not initialized"));
+        LOG_ERROR(std::string("[GladLoader] Cannot load GLAD: GLResolver is not initialized"));
         return false;
     }
 

src/libprojectM/Renderer/Platform/GladLoader.hpp

@@ -7,7 +7,7 @@ namespace Renderer {
 namespace Platform {
 
 /**
- * @brief Helper for GLAD loading and GL projectM specific GL requirements checks.
+ * @brief Helper for GLAD loading and projectM-specific GL requirements checks.
  *
  * @note This loader is a process-singleton.
  * @note The GLResolver needs to be initialized first, before using this loader.
@@ -44,7 +44,7 @@ class GladLoader
     auto CheckGLRequirements() -> bool;
 
 
-    bool m_isLoaded{false};                 //!< Flag to indicate is GLAD has been loaded.
+    bool m_isLoaded{false};                 //!< Flag indicating whether GLAD has been loaded.
     mutable std::mutex m_mutex;             //!< Mutex to synchronize initialization.
 };