GL: port Debug{Output,Group,Message} away from std::string.

Most of these are just inputs, so a compatibility StringStl.h include
will do, the only exception is the callback for which there needs to
stay a deprecated overload (which is internally delegated from the
StringView one).

Also explicitly testing with non-null-terminated strings -- the APIs
take an explicit size so it shouldn't be a problem, but it's always good
to have this verified independently. Drivers are crap, you know.

One consequence of no longer using an impossible-to-forward-declare
std::string is that I had to deinline the DebugGroup constructor because
it no longer worked with just a forward-declared StringView.

Author: mosra

Diff for: doc/changelog.dox

@@ -863,6 +863,10 @@ See also:
     particular, if `BUILD_DEPRECATED` is set but `MAGNUM_BUILD_DEPRECATED` not,
     the unprefixed options are also recognized. See also
     [mosra/corrade#139](https://github.com/mosra/corrade/issues/139).
+-   @ref GL::DebugOutput::setCallback() taking a @ref std::string in the
+    callback function pointer is deprecated in favor of a version taking a
+    @ref Containers::StringView. See also [mosra/magnum#499](https://github.com/mosra/magnum/pull/499)
+    and [mosra/magnum#596](https://github.com/mosra/magnum/pull/596).
 -   The @cpp Array @ce, @cpp Array1D @ce, @cpp Array2D @ce and
     @cpp Array3D @ce types that were used exclusively for specifying
     @ref SamplerWrapping in various texture APIs are deprecated in favor of

Diff for: src/Magnum/GL/CMakeLists.txt

@@ -150,7 +150,8 @@ if(NOT MAGNUM_TARGET_WEBGL)
     list(APPEND MagnumGL_SRCS
         DebugOutput.cpp
 
-        Implementation/DebugState.cpp)
+        Implementation/DebugState.cpp
+        Implementation/defaultDebugCallback.h)
 
     list(APPEND MagnumGL_HEADERS
         DebugOutput.h)

Diff for: src/Magnum/GL/DebugOutput.cpp

@@ -26,20 +26,25 @@
 #include "DebugOutput.h"
 
 #ifndef MAGNUM_TARGET_WEBGL
+#include <Corrade/Containers/StringView.h>
 #include <Corrade/Utility/Assert.h>
 #include <Corrade/Utility/Debug.h>
-#include <Corrade/Utility/DebugStl.h>
 
 #include "Magnum/GL/Context.h"
 #include "Magnum/GL/Extensions.h"
 #include "Magnum/GL/Implementation/State.h"
 #include "Magnum/GL/Implementation/DebugState.h"
+#include "Magnum/GL/Implementation/defaultDebugCallback.h"
+
+#ifdef MAGNUM_BUILD_DEPRECATED
+#include <string>
+#endif
 
 namespace Magnum { namespace GL {
 
 namespace Implementation {
 
-void defaultDebugCallback(const DebugOutput::Source source, const DebugOutput::Type type, const UnsignedInt id, const DebugOutput::Severity severity, const std::string& string, std::ostream* out) {
+void defaultDebugCallback(const DebugOutput::Source source, const DebugOutput::Type type, const UnsignedInt id, const DebugOutput::Severity severity, const Containers::StringView string, std::ostream* out) {
     Debug output{out};
     output << "Debug output:";
 
@@ -105,7 +110,7 @@ APIENTRY
 #endif
 callbackWrapper(GLenum source, GLenum type, GLuint id, GLenum severity, GLsizei length, const GLchar* message, const void* userParam) {
     const auto& callback = *static_cast<const Implementation::DebugState::MessageCallback*>(userParam);
-    callback.callback(DebugOutput::Source(source), DebugOutput::Type(type), id, DebugOutput::Severity(severity), std::string{message, std::size_t(length)}, callback.userParam);
+    callback.callback(DebugOutput::Source(source), DebugOutput::Type(type), id, DebugOutput::Severity(severity), {message, std::size_t(length)}, callback.userParam);
 }
 
 }
@@ -149,8 +154,25 @@ void DebugOutput::setCallback(const Callback callback, const void* userParam) {
     Context::current().state().debug.callbackImplementation(callback);
 }
 
+#ifdef MAGNUM_BUILD_DEPRECATED
+void DebugOutput::setCallback(void(*const callback)(Source, Type, UnsignedInt, Severity, const std::string&, const void*), const void* userParam) {
+    /* This is a second delegation step after the callbackWrapper() which
+       converts from raw GL types. Alternatively there could be a deprecated
+       version of all callbackImplementation*() variants, but this is less
+       code in total -- just two extra members in the MessageCallback
+       struct. */
+    Context::current().state().debug.messageCallback.userParam = &Context::current().state().debug.messageCallback;
+    Context::current().state().debug.messageCallback.callbackStlString = callback;
+    Context::current().state().debug.messageCallback.userParamStlString = userParam;
+    Context::current().state().debug.callbackImplementation([](DebugOutput::Source source, DebugOutput::Type type, UnsignedInt id, DebugOutput::Severity severity, const Containers::StringView string, const void* userParam) {
+        const auto& messageCallback = *static_cast<const Implementation::DebugState::MessageCallback*>(userParam);
+        messageCallback.callbackStlString(source, type, id, severity, string, messageCallback.userParamStlString);
+    });
+}
+#endif
+
 void DebugOutput::setDefaultCallback() {
-    setCallback([](DebugOutput::Source source, DebugOutput::Type type, UnsignedInt id, DebugOutput::Severity severity, const std::string& string, const void*) {
+    setCallback([](DebugOutput::Source source, DebugOutput::Type type, UnsignedInt id, DebugOutput::Severity severity, const Containers::StringView string, const void*) {
         Implementation::defaultDebugCallback(source, type, id, severity, string, Debug::output());
     });
 }
@@ -267,30 +289,30 @@ Debug& operator<<(Debug& debug, const DebugOutput::Severity value) {
 }
 #endif
 
-void DebugMessage::insertInternal(const Source source, const Type type, const UnsignedInt id, const DebugOutput::Severity severity, const Containers::ArrayView<const char> string) {
+void DebugMessage::insert(const Source source, const Type type, const UnsignedInt id, const DebugOutput::Severity severity, const Containers::StringView string) {
     Context::current().state().debug.messageInsertImplementation(source, type, id, severity, string);
 }
 
-void DebugMessage::insertImplementationNoOp(Source, Type, UnsignedInt, DebugOutput::Severity, const Containers::ArrayView<const char>) {}
+void DebugMessage::insertImplementationNoOp(Source, Type, UnsignedInt, DebugOutput::Severity, const Containers::StringView) {}
 
 #ifndef MAGNUM_TARGET_GLES2
-void DebugMessage::insertImplementationKhrDesktopES32(const Source source, const Type type, const UnsignedInt id, const DebugOutput::Severity severity, const Containers::ArrayView<const char> string) {
+void DebugMessage::insertImplementationKhrDesktopES32(const Source source, const Type type, const UnsignedInt id, const DebugOutput::Severity severity, const Containers::StringView string) {
     glDebugMessageInsert(GLenum(source), GLenum(type), id, GLenum(severity), string.size(), string.data());
 }
 #endif
 
 #ifdef MAGNUM_TARGET_GLES
-void DebugMessage::insertImplementationKhrES(const Source source, const Type type, const UnsignedInt id, const DebugOutput::Severity severity, const Containers::ArrayView<const char> string) {
+void DebugMessage::insertImplementationKhrES(const Source source, const Type type, const UnsignedInt id, const DebugOutput::Severity severity, const Containers::StringView string) {
     glDebugMessageInsertKHR(GLenum(source), GLenum(type), id, GLenum(severity), string.size(), string.data());
 }
 #endif
 
-void DebugMessage::insertImplementationExt(Source, Type, UnsignedInt, DebugOutput::Severity, const Containers::ArrayView<const char> string) {
+void DebugMessage::insertImplementationExt(Source, Type, UnsignedInt, DebugOutput::Severity, const Containers::StringView string) {
     glInsertEventMarkerEXT(string.size(), string.data());
 }
 
 #ifndef MAGNUM_TARGET_GLES
-void DebugMessage::insertImplementationGremedy(Source, Type, UnsignedInt, DebugOutput::Severity, const Containers::ArrayView<const char> string) {
+void DebugMessage::insertImplementationGremedy(Source, Type, UnsignedInt, DebugOutput::Severity, const Containers::StringView string) {
     glStringMarkerGREMEDY(string.size(), string.data());
 }
 #endif
@@ -347,7 +369,11 @@ Int DebugGroup::maxStackDepth() {
     return value;
 }
 
-void DebugGroup::pushInternal(const Source source, const UnsignedInt id, const Containers::ArrayView<const char> message) {
+DebugGroup::DebugGroup(const Source source, const UnsignedInt id, const Containers::StringView message): DebugGroup{} {
+    push(source, id, message);
+}
+
+void DebugGroup::push(const Source source, const UnsignedInt id, const Containers::StringView message) {
     CORRADE_ASSERT(!_active, "GL::DebugGroup::push(): group is already active", );
     Context::current().state().debug.pushGroupImplementation(source, id, message);
     _active = true;
@@ -359,21 +385,21 @@ void DebugGroup::pop() {
     _active = false;
 }
 
-void DebugGroup::pushImplementationNoOp(Source, UnsignedInt, Containers::ArrayView<const char>) {}
+void DebugGroup::pushImplementationNoOp(Source, UnsignedInt, Containers::StringView) {}
 
 #ifndef MAGNUM_TARGET_GLES2
-void DebugGroup::pushImplementationKhrDesktopES32(const Source source, const UnsignedInt id, const Containers::ArrayView<const char> message) {
+void DebugGroup::pushImplementationKhrDesktopES32(const Source source, const UnsignedInt id, const Containers::StringView message) {
     glPushDebugGroup(GLenum(source), id, message.size(), message.data());
 }
 #endif
 
 #ifdef MAGNUM_TARGET_GLES
-void DebugGroup::pushImplementationKhrES(const Source source, const UnsignedInt id, const Containers::ArrayView<const char> message) {
+void DebugGroup::pushImplementationKhrES(const Source source, const UnsignedInt id, const Containers::StringView message) {
     glPushDebugGroupKHR(GLenum(source), id, message.size(), message.data());
 }
 #endif
 
-void DebugGroup::pushImplementationExt(Source, UnsignedInt, const Containers::ArrayView<const char> message) {
+void DebugGroup::pushImplementationExt(Source, UnsignedInt, const Containers::StringView message) {
     glPushGroupMarkerEXT(message.size(), message.data());
 }
 

Diff for: src/Magnum/GL/DebugOutput.h

@@ -31,13 +31,20 @@
  */
 #endif
 
-#include <string>
-#include <Corrade/Containers/ArrayView.h>
+#include <initializer_list>
+#include <Corrade/Containers/Containers.h>
 
 #include "Magnum/Magnum.h"
 #include "Magnum/GL/OpenGL.h"
 #include "Magnum/GL/visibility.h"
 
+#ifdef MAGNUM_BUILD_DEPRECATED
+/* For all stuff that took std::string before */
+#include <Corrade/Containers/StringStl.h>
+/* For the deprecated std::string callback */
+#include <Corrade/Utility/StlForwardString.h>
+#endif
+
 #ifndef MAGNUM_TARGET_WEBGL
 namespace Magnum { namespace GL {
 
@@ -287,7 +294,7 @@ class MAGNUM_GL_EXPORT DebugOutput {
          *
          * @see @ref setCallback()
          */
-        typedef void(*Callback)(Source, Type, UnsignedInt, Severity, const std::string&, const void*);
+        typedef void(*Callback)(Source, Type, UnsignedInt, Severity, Containers::StringView, const void*);
 
         /**
          * @brief Max count of debug messages in log
@@ -394,6 +401,22 @@ class MAGNUM_GL_EXPORT DebugOutput {
          */
         static void setCallback(Callback callback, const void* userParam = nullptr);
 
+        #ifdef MAGNUM_BUILD_DEPRECATED
+        /**
+         * @brief Set debug message callback
+         * @m_deprecated_since_latest Use a @ref Callback taking a
+         *      @ref Containers::StringView instead.
+         */
+        CORRADE_DEPRECATED("use a callback taking a Containers::StringView instead") static void setCallback(void(*callback)(Source, Type, UnsignedInt, Severity, const std::string&, const void*), const void* userParam = nullptr);
+        #ifndef DOXYGEN_GENERATING_OUTPUT
+        /* Because otherwise the call is ambiguous with nullptr due to the
+           deprecated overload */
+        static void setCallback(std::nullptr_t, const void* userParam = nullptr) {
+            setCallback(static_cast<Callback>(nullptr), userParam);
+        }
+        #endif
+        #endif
+
         /**
          * @brief Set default debug message callback
          *
@@ -587,30 +610,22 @@ class MAGNUM_GL_EXPORT DebugMessage {
          *      @fn_gl_extension_keyword{InsertEventMarker,EXT,debug_marker} or
          *      @fn_gl_extension_keyword{StringMarker,GREMEDY,string_marker}
          */
-        static void insert(Source source, Type type, UnsignedInt id, DebugOutput::Severity severity, const std::string& string) {
-            insertInternal(source, type, id, severity, {string.data(), string.size()});
-        }
-
-        /** @overload */
-        template<std::size_t size> static void insert(Source source, Type type, UnsignedInt id, DebugOutput::Severity severity, const char(&string)[size]) {
-            insertInternal(source, type, id, severity, {string, size - 1});
-        }
+        static void insert(Source source, Type type, UnsignedInt id, DebugOutput::Severity severity, Containers::StringView string);
 
         /** @brief There's no point in having an instance of this class */
         DebugMessage() = delete;
 
     private:
-        static void insertInternal(Source source, Type type, UnsignedInt id, DebugOutput::Severity severity, Containers::ArrayView<const char> string);
-        static MAGNUM_GL_LOCAL void insertImplementationNoOp(Source, Type, UnsignedInt, DebugOutput::Severity, Containers::ArrayView<const char>);
+        static MAGNUM_GL_LOCAL void insertImplementationNoOp(Source, Type, UnsignedInt, DebugOutput::Severity, Containers::StringView);
         #ifndef MAGNUM_TARGET_GLES2
-        static MAGNUM_GL_LOCAL void insertImplementationKhrDesktopES32(Source source, Type type, UnsignedInt id, DebugOutput::Severity severity, Containers::ArrayView<const char> string);
+        static MAGNUM_GL_LOCAL void insertImplementationKhrDesktopES32(Source source, Type type, UnsignedInt id, DebugOutput::Severity severity, Containers::StringView string);
         #endif
         #ifdef MAGNUM_TARGET_GLES
-        static MAGNUM_GL_LOCAL void insertImplementationKhrES(Source source, Type type, UnsignedInt id, DebugOutput::Severity severity, Containers::ArrayView<const char> string);
+        static MAGNUM_GL_LOCAL void insertImplementationKhrES(Source source, Type type, UnsignedInt id, DebugOutput::Severity severity, Containers::StringView string);
         #endif
-        static MAGNUM_GL_LOCAL void insertImplementationExt(Source, Type, UnsignedInt, DebugOutput::Severity, Containers::ArrayView<const char> string);
+        static MAGNUM_GL_LOCAL void insertImplementationExt(Source, Type, UnsignedInt, DebugOutput::Severity, Containers::StringView string);
         #ifndef MAGNUM_TARGET_GLES
-        static MAGNUM_GL_LOCAL void insertImplementationGremedy(Source, Type, UnsignedInt, DebugOutput::Severity, Containers::ArrayView<const char> string);
+        static MAGNUM_GL_LOCAL void insertImplementationGremedy(Source, Type, UnsignedInt, DebugOutput::Severity, Containers::StringView string);
         #endif
 };
 
@@ -734,14 +749,7 @@ class MAGNUM_GL_EXPORT DebugGroup {
          * Calls @ref push().
          * @see @link ~DebugGroup() @endlink, @ref pop()
          */
-        explicit DebugGroup(Source source, UnsignedInt id, const std::string& message): DebugGroup{} {
-            push(source, id, message);
-        }
-
-        /** @overload */
-        template<std::size_t size> explicit DebugGroup(Source source, UnsignedInt id, const char(&message)[size]): DebugGroup{} {
-            push(source, id, message);
-        }
+        explicit DebugGroup(Source source, UnsignedInt id, Containers::StringView message);
 
         /**
          * @brief Destructor
@@ -768,14 +776,7 @@ class MAGNUM_GL_EXPORT DebugGroup {
          *      @ref Renderer::Error::StackOverflow, @fn_gl_keyword{PushDebugGroup}
          *      or @fn_gl_extension_keyword{PushGroupMarker,EXT,debug_marker}
          */
-        void push(Source source, UnsignedInt id, const std::string& message) {
-            pushInternal(source, id, {message.data(), message.size()});
-        }
-
-        /** @overload */
-        template<std::size_t size> void push(Source source, UnsignedInt id, const char(&message)[size]) {
-            pushInternal(source, id, {message, size - 1});
-        }
+        void push(Source source, UnsignedInt id, Containers::StringView message);
 
         /**
          * @brief Pop debug group from the stack
@@ -798,16 +799,14 @@ class MAGNUM_GL_EXPORT DebugGroup {
         void pop();
 
     private:
-        void pushInternal(Source source, UnsignedInt id, Containers::ArrayView<const char> message);
-
-        static MAGNUM_GL_LOCAL void pushImplementationNoOp(Source source, UnsignedInt id, Containers::ArrayView<const char> message);
+        static MAGNUM_GL_LOCAL void pushImplementationNoOp(Source source, UnsignedInt id, Containers::StringView message);
         #ifndef MAGNUM_TARGET_GLES2
-        static MAGNUM_GL_LOCAL void pushImplementationKhrDesktopES32(Source source, UnsignedInt id, Containers::ArrayView<const char> message);
+        static MAGNUM_GL_LOCAL void pushImplementationKhrDesktopES32(Source source, UnsignedInt id, Containers::StringView message);
         #endif
         #ifdef MAGNUM_TARGET_GLES
-        static MAGNUM_GL_LOCAL void pushImplementationKhrES(Source source, UnsignedInt id, Containers::ArrayView<const char> message);
+        static MAGNUM_GL_LOCAL void pushImplementationKhrES(Source source, UnsignedInt id, Containers::StringView message);
         #endif
-        static MAGNUM_GL_LOCAL void pushImplementationExt(Source source, UnsignedInt id, Containers::ArrayView<const char> message);
+        static MAGNUM_GL_LOCAL void pushImplementationExt(Source source, UnsignedInt id, Containers::StringView message);
 
         static MAGNUM_GL_LOCAL void popImplementationNoOp();
         #ifndef MAGNUM_TARGET_GLES2
@@ -824,11 +823,6 @@ class MAGNUM_GL_EXPORT DebugGroup {
 /** @debugoperatorclassenum{DebugGroup,DebugGroup::Source} */
 MAGNUM_GL_EXPORT Debug& operator<<(Debug& debug, DebugGroup::Source value);
 
-/* Exposed for testing */
-namespace Implementation {
-    MAGNUM_GL_EXPORT void defaultDebugCallback(DebugOutput::Source source, DebugOutput::Type type, UnsignedInt id, DebugOutput::Severity severity, const std::string& string, std::ostream* output);
-}
-
 }}
 #else
 #error this header is not available in WebGL build

Diff for: src/Magnum/GL/Implementation/DebugState.h

@@ -40,16 +40,20 @@ struct DebugState {
     Containers::String(*getLabelImplementation)(GLenum, GLuint);
     void(*labelImplementation)(GLenum, GLuint, Containers::StringView);
 
-    void(*messageInsertImplementation)(DebugMessage::Source, DebugMessage::Type, UnsignedInt, DebugOutput::Severity, Containers::ArrayView<const char>);
+    void(*messageInsertImplementation)(DebugMessage::Source, DebugMessage::Type, UnsignedInt, DebugOutput::Severity, Containers::StringView);
     void(*controlImplementation)(GLenum, GLenum, GLenum, std::initializer_list<UnsignedInt>, bool);
     void(*callbackImplementation)(DebugOutput::Callback);
-    void(*pushGroupImplementation)(DebugGroup::Source, UnsignedInt, Containers::ArrayView<const char>);
+    void(*pushGroupImplementation)(DebugGroup::Source, UnsignedInt, Containers::StringView);
     void(*popGroupImplementation)();
 
     GLint maxLabelLength, maxLoggedMessages, maxMessageLength, maxStackDepth;
     struct MessageCallback {
         DebugOutput::Callback callback{};
         const void* userParam{};
+        #ifdef MAGNUM_BUILD_DEPRECATED
+        void(*callbackStlString)(DebugOutput::Source, DebugOutput::Type, UnsignedInt, DebugOutput::Severity, const std::string&, const void*);
+        const void* userParamStlString{};
+        #endif
     } messageCallback;
 };