Move QOpenGLVersionProfile to its own files

Prepare to move it out of QtGui

Task-number: QTBUG-74409
Change-Id: Iefde4945ede27cf3c2f6f50e5a693c03625cadf6
Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>

src/gui/.prev_CMakeLists.txt

@@ -261,6 +261,7 @@ qt_extend_target(Gui CONDITION QT_FEATURE_opengl
         opengl/qopenglprogrambinarycache.cpp opengl/qopenglprogrambinarycache_p.h
         opengl/qopenglversionfunctions.cpp opengl/qopenglversionfunctions.h
         opengl/qopenglversionfunctionsfactory.cpp opengl/qopenglversionfunctionsfactory_p.h
+        opengl/qopenglversionprofile.cpp opengl/qopenglversionprofile.h
         rhi/qrhigles2.cpp rhi/qrhigles2_p.h
         rhi/qrhigles2_p_p.h
 )

src/gui/CMakeLists.txt

@@ -343,6 +343,7 @@ qt_extend_target(Gui CONDITION QT_FEATURE_opengl
         opengl/qopenglprogrambinarycache.cpp opengl/qopenglprogrambinarycache_p.h
         opengl/qopenglversionfunctions.cpp opengl/qopenglversionfunctions.h
         opengl/qopenglversionfunctionsfactory.cpp opengl/qopenglversionfunctionsfactory_p.h
+        opengl/qopenglversionprofile.cpp opengl/qopenglversionprofile.h
         rhi/qrhigles2.cpp rhi/qrhigles2_p.h
         rhi/qrhigles2_p_p.h
 )

src/gui/kernel/qopenglcontext.cpp

@@ -65,158 +65,6 @@
 
 QT_BEGIN_NAMESPACE
 
-class QOpenGLVersionProfilePrivate
-{
-public:
-    QOpenGLVersionProfilePrivate()
-        : majorVersion(0),
-          minorVersion(0),
-          profile(QSurfaceFormat::NoProfile)
-    {}
-
-    int majorVersion;
-    int minorVersion;
-    QSurfaceFormat::OpenGLContextProfile profile;
-};
-
-
-/*!
-    \class QOpenGLVersionProfile
-    \inmodule QtGui
-    \since 5.1
-    \brief The QOpenGLVersionProfile class represents the version and if applicable
-           the profile of an OpenGL context.
-
-    An object of this class can be passed to QOpenGLContext::versionFunctions() to
-    request a functions object for a specific version and profile of OpenGL.
-
-    It also contains some helper functions to check if a version supports profiles
-    or is a legacy version.
-*/
-
-/*!
-    Creates a default invalid QOpenGLVersionProfile object.
-*/
-QOpenGLVersionProfile::QOpenGLVersionProfile()
-    : d(new QOpenGLVersionProfilePrivate)
-{
-}
-
-/*!
-    Creates a QOpenGLVersionProfile object initialised with the version and profile
-    from \a format.
-*/
-QOpenGLVersionProfile::QOpenGLVersionProfile(const QSurfaceFormat &format)
-    : d(new QOpenGLVersionProfilePrivate)
-{
-    d->majorVersion = format.majorVersion();
-    d->minorVersion = format.minorVersion();
-    d->profile = format.profile();
-}
-
-/*!
-    Constructs a copy of \a other.
-*/
-QOpenGLVersionProfile::QOpenGLVersionProfile(const QOpenGLVersionProfile &other)
-    : d(new QOpenGLVersionProfilePrivate)
-{
-    *d = *(other.d);
-}
-
-/*!
-    Destroys the QOpenGLVersionProfile object.
-*/
-QOpenGLVersionProfile::~QOpenGLVersionProfile()
-{
-    delete d;
-}
-
-/*!
-    Assigns the version and profile of \a rhs to this QOpenGLVersionProfile object.
-*/
-QOpenGLVersionProfile &QOpenGLVersionProfile::operator=(const QOpenGLVersionProfile &rhs)
-{
-    if (this == &rhs)
-        return *this;
-    *d = *(rhs.d);
-    return *this;
-}
-
-/*!
-    Returns a QPair<int,int> where the components represent the major and minor OpenGL
-    version numbers respectively.
-
-    \sa setVersion()
-*/
-QPair<int, int> QOpenGLVersionProfile::version() const
-{
-    return qMakePair( d->majorVersion, d->minorVersion);
-}
-
-/*!
-    Sets the major and minor version numbers to \a majorVersion and \a minorVersion respectively.
-
-    \sa version()
-*/
-void QOpenGLVersionProfile::setVersion(int majorVersion, int minorVersion)
-{
-    d->majorVersion = majorVersion;
-    d->minorVersion = minorVersion;
-}
-
-/*!
-    Returns the OpenGL profile. Only makes sense if profiles are supported by this version.
-
-    \sa setProfile()
-*/
-QSurfaceFormat::OpenGLContextProfile QOpenGLVersionProfile::profile() const
-{
-    return d->profile;
-}
-
-/*!
-    Sets the OpenGL profile \a profile. Only makes sense if profiles are supported by
-    this version.
-
-    \sa profile()
-*/
-void QOpenGLVersionProfile::setProfile(QSurfaceFormat::OpenGLContextProfile profile)
-{
-    d->profile = profile;
-}
-
-/*!
-    Returns \c true if profiles are supported by the OpenGL version returned by version(). Only
-    OpenGL versions >= 3.2 support profiles.
-
-    \sa profile(), version()
-*/
-bool QOpenGLVersionProfile::hasProfiles() const
-{
-    return ( d->majorVersion > 3
-             || (d->majorVersion == 3 && d->minorVersion > 1));
-}
-
-/*!
-    Returns \c true is the OpenGL version returned by version() contains deprecated functions
-    and does not support profiles i.e. if the OpenGL version is <= 3.1.
-*/
-bool QOpenGLVersionProfile::isLegacyVersion() const
-{
-    return (d->majorVersion < 3 || (d->majorVersion == 3 && d->minorVersion == 0));
-}
-
-/*!
-    Returns \c true if the version number is valid. Note that for a default constructed
-    QOpenGLVersionProfile object this function will return \c false.
-
-    \sa setVersion(), version()
-*/
-bool QOpenGLVersionProfile::isValid() const
-{
-    return d->majorVersion > 0 && d->minorVersion >= 0;
-}
-
 class QGuiGLThreadContext
 {
 public:
@@ -1629,21 +1477,6 @@ void QOpenGLMultiGroupSharedResource::cleanup(QOpenGLContextGroup *group, QOpenG
 }
 
 #ifndef QT_NO_DEBUG_STREAM
-QDebug operator<<(QDebug debug, const QOpenGLVersionProfile &vp)
-{
-    QDebugStateSaver saver(debug);
-    debug.nospace();
-    debug << "QOpenGLVersionProfile(";
-    if (vp.isValid()) {
-        debug << vp.version().first << '.' << vp.version().second
-            << ", profile=" << vp.profile();
-    } else {
-        debug << "invalid";
-    }
-    debug << ')';
-    return debug;
-}
-
 QDebug operator<<(QDebug debug, const QOpenGLContext *ctx)
 {
     QDebugStateSaver saver(debug);

src/gui/kernel/qopenglcontext.h

@@ -59,12 +59,9 @@
 
 #include <QtGui/qopengl.h>
 #include <QtGui/qopenglversionfunctions.h>
+// TODO: ideally get rid of this include
+#include <QtGui/qopenglversionprofile.h>
 
-#if QT_DEPRECATED_SINCE(5, 6)
-#include <QtCore/qhash.h>
-#endif
-#include <QtCore/qhashfunctions.h>
-#include <QtCore/qpair.h>
 #include <QtCore/qvariant.h>
 
 QT_BEGIN_NAMESPACE
@@ -79,50 +76,6 @@ class QPlatformOpenGLContext;
 class QScreen;
 class QSurface;
 
-class QOpenGLVersionProfilePrivate;
-
-class Q_GUI_EXPORT QOpenGLVersionProfile
-{
-public:
-    QOpenGLVersionProfile();
-    explicit QOpenGLVersionProfile(const QSurfaceFormat &format);
-    QOpenGLVersionProfile(const QOpenGLVersionProfile &other);
-    ~QOpenGLVersionProfile();
-
-    QOpenGLVersionProfile &operator=(const QOpenGLVersionProfile &rhs);
-
-    QPair<int, int> version() const;
-    void setVersion(int majorVersion, int minorVersion);
-
-    QSurfaceFormat::OpenGLContextProfile profile() const;
-    void setProfile(QSurfaceFormat::OpenGLContextProfile profile);
-
-    bool hasProfiles() const;
-    bool isLegacyVersion() const;
-    bool isValid() const;
-
-private:
-    QOpenGLVersionProfilePrivate* d;
-};
-
-inline uint qHash(const QOpenGLVersionProfile &v, uint seed = 0)
-{
-    return qHash(static_cast<int>(v.profile() * 1000)
-               + v.version().first * 100 + v.version().second * 10, seed);
-}
-
-inline bool operator==(const QOpenGLVersionProfile &lhs, const QOpenGLVersionProfile &rhs)
-{
-    if (lhs.profile() != rhs.profile())
-        return false;
-    return lhs.version() == rhs.version();
-}
-
-inline bool operator!=(const QOpenGLVersionProfile &lhs, const QOpenGLVersionProfile &rhs)
-{
-    return !operator==(lhs, rhs);
-}
-
 class Q_GUI_EXPORT QOpenGLContextGroup : public QObject
 {
     Q_OBJECT
@@ -245,7 +198,6 @@ private:
 };
 
 #ifndef QT_NO_DEBUG_STREAM
-Q_GUI_EXPORT QDebug operator<<(QDebug debug, const QOpenGLVersionProfile &vp);
 Q_GUI_EXPORT QDebug operator<<(QDebug debug, const QOpenGLContext *ctx);
 Q_GUI_EXPORT QDebug operator<<(QDebug debug, const QOpenGLContextGroup *cg);
 #endif // !QT_NO_DEBUG_STREAM

src/gui/opengl/opengl.pri

@@ -11,6 +11,7 @@ qtConfig(opengl) {
                opengl/qopenglextensions_p.h \
                opengl/qopenglversionfunctions.h \
                opengl/qopenglversionfunctionsfactory_p.h \
+               opengl/qopenglversionprofile.h \
                opengl/qopenglextrafunctions.h \
                opengl/qopenglprogrambinarycache_p.h
 
@@ -18,6 +19,7 @@ qtConfig(opengl) {
                opengl/qopenglfunctions.cpp \
                opengl/qopenglversionfunctions.cpp \
                opengl/qopenglversionfunctionsfactory.cpp \
+               opengl/qopenglversionprofile.cpp \
                opengl/qopenglprogrambinarycache.cpp
 
     !qtConfig(opengles2) {

src/gui/opengl/qopenglversionprofile.cpp

@@ -0,0 +1,214 @@
+/****************************************************************************
+**
+** Copyright (C) 2020 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the QtGui module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qopenglversionprofile.h"
+
+#include <QtCore/QDebug>
+
+QT_BEGIN_NAMESPACE
+
+class QOpenGLVersionProfilePrivate
+{
+public:
+    QOpenGLVersionProfilePrivate()
+        : majorVersion(0),
+          minorVersion(0),
+          profile(QSurfaceFormat::NoProfile)
+    {}
+
+    int majorVersion;
+    int minorVersion;
+    QSurfaceFormat::OpenGLContextProfile profile;
+};
+
+/*!
+    \class QOpenGLVersionProfile
+    \inmodule QtGui
+    \since 5.1
+    \brief The QOpenGLVersionProfile class represents the version and if applicable
+           the profile of an OpenGL context.
+
+    An object of this class can be passed to QOpenGLContext::versionFunctions() to
+    request a functions object for a specific version and profile of OpenGL.
+
+    It also contains some helper functions to check if a version supports profiles
+    or is a legacy version.
+*/
+
+/*!
+    Creates a default invalid QOpenGLVersionProfile object.
+*/
+QOpenGLVersionProfile::QOpenGLVersionProfile()
+    : d(new QOpenGLVersionProfilePrivate)
+{
+}
+
+/*!
+    Creates a QOpenGLVersionProfile object initialised with the version and profile
+    from \a format.
+*/
+QOpenGLVersionProfile::QOpenGLVersionProfile(const QSurfaceFormat &format)
+    : d(new QOpenGLVersionProfilePrivate)
+{
+    d->majorVersion = format.majorVersion();
+    d->minorVersion = format.minorVersion();
+    d->profile = format.profile();
+}
+
+/*!
+    Constructs a copy of \a other.
+*/
+QOpenGLVersionProfile::QOpenGLVersionProfile(const QOpenGLVersionProfile &other)
+    : d(new QOpenGLVersionProfilePrivate)
+{
+    *d = *(other.d);
+}
+
+/*!
+    Destroys the QOpenGLVersionProfile object.
+*/
+QOpenGLVersionProfile::~QOpenGLVersionProfile()
+{
+    delete d;
+}
+
+/*!
+    Assigns the version and profile of \a rhs to this QOpenGLVersionProfile object.
+*/
+QOpenGLVersionProfile &QOpenGLVersionProfile::operator=(const QOpenGLVersionProfile &rhs)
+{
+    if (this == &rhs)
+        return *this;
+    *d = *(rhs.d);
+    return *this;
+}
+
+/*!
+    Returns a QPair<int,int> where the components represent the major and minor OpenGL
+    version numbers respectively.
+
+    \sa setVersion()
+*/
+QPair<int, int> QOpenGLVersionProfile::version() const
+{
+    return qMakePair( d->majorVersion, d->minorVersion);
+}
+
+/*!
+    Sets the major and minor version numbers to \a majorVersion and \a minorVersion respectively.
+
+    \sa version()
+*/
+void QOpenGLVersionProfile::setVersion(int majorVersion, int minorVersion)
+{
+    d->majorVersion = majorVersion;
+    d->minorVersion = minorVersion;
+}
+
+/*!
+    Returns the OpenGL profile. Only makes sense if profiles are supported by this version.
+
+    \sa setProfile()
+*/
+QSurfaceFormat::OpenGLContextProfile QOpenGLVersionProfile::profile() const
+{
+    return d->profile;
+}
+
+/*!
+    Sets the OpenGL profile \a profile. Only makes sense if profiles are supported by
+    this version.
+
+    \sa profile()
+*/
+void QOpenGLVersionProfile::setProfile(QSurfaceFormat::OpenGLContextProfile profile)
+{
+    d->profile = profile;
+}
+
+/*!
+    Returns \c true if profiles are supported by the OpenGL version returned by version(). Only
+    OpenGL versions >= 3.2 support profiles.
+
+    \sa profile(), version()
+*/
+bool QOpenGLVersionProfile::hasProfiles() const
+{
+    return ( d->majorVersion > 3
+             || (d->majorVersion == 3 && d->minorVersion > 1));
+}
+
+/*!
+    Returns \c true is the OpenGL version returned by version() contains deprecated functions
+    and does not support profiles i.e. if the OpenGL version is <= 3.1.
+*/
+bool QOpenGLVersionProfile::isLegacyVersion() const
+{
+    return (d->majorVersion < 3 || (d->majorVersion == 3 && d->minorVersion == 0));
+}
+
+/*!
+    Returns \c true if the version number is valid. Note that for a default constructed
+    QOpenGLVersionProfile object this function will return \c false.
+
+    \sa setVersion(), version()
+*/
+bool QOpenGLVersionProfile::isValid() const
+{
+    return d->majorVersion > 0 && d->minorVersion >= 0;
+}
+
+#ifndef QT_NO_DEBUG_STREAM
+QDebug operator<<(QDebug debug, const QOpenGLVersionProfile &vp)
+{
+    QDebugStateSaver saver(debug);
+    debug.nospace();
+    debug << "QOpenGLVersionProfile(";
+    if (vp.isValid()) {
+        debug << vp.version().first << '.' << vp.version().second
+            << ", profile=" << vp.profile();
+    } else {
+        debug << "invalid";
+    }
+    debug << ')';
+    return debug;
+}
+
+#endif // QT_NO_DEBUG_STREAM
+QT_END_NAMESPACE

src/gui/opengl/qopenglversionprofile.h

@@ -0,0 +1,110 @@
+/****************************************************************************
+**
+** Copyright (C) 2020 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the QtGui module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QOPENGLVERSIONPROFILE_H
+#define QOPENGLVERSIONPROFILE_H
+
+#include <QtGui/qtguiglobal.h>
+
+#include <QtGui/QSurfaceFormat>
+
+#include <QtCore/QPair>
+#if QT_DEPRECATED_SINCE(5, 6)
+#include <QtCore/qhash.h>
+#endif
+#include <QtCore/qhashfunctions.h>
+
+#ifndef QT_NO_OPENGL
+
+QT_BEGIN_NAMESPACE
+
+class QOpenGLVersionProfilePrivate;
+class QDebug;
+
+class Q_GUI_EXPORT QOpenGLVersionProfile
+{
+public:
+    QOpenGLVersionProfile();
+    explicit QOpenGLVersionProfile(const QSurfaceFormat &format);
+    QOpenGLVersionProfile(const QOpenGLVersionProfile &other);
+    ~QOpenGLVersionProfile();
+
+    QOpenGLVersionProfile &operator=(const QOpenGLVersionProfile &rhs);
+
+    QPair<int, int> version() const;
+    void setVersion(int majorVersion, int minorVersion);
+
+    QSurfaceFormat::OpenGLContextProfile profile() const;
+    void setProfile(QSurfaceFormat::OpenGLContextProfile profile);
+
+    bool hasProfiles() const;
+    bool isLegacyVersion() const;
+    bool isValid() const;
+
+private:
+    QOpenGLVersionProfilePrivate* d;
+};
+
+inline uint qHash(const QOpenGLVersionProfile &v, uint seed = 0)
+{
+    return qHash(static_cast<int>(v.profile() * 1000)
+               + v.version().first * 100 + v.version().second * 10, seed);
+}
+
+inline bool operator==(const QOpenGLVersionProfile &lhs, const QOpenGLVersionProfile &rhs)
+{
+    if (lhs.profile() != rhs.profile())
+        return false;
+    return lhs.version() == rhs.version();
+}
+
+inline bool operator!=(const QOpenGLVersionProfile &lhs, const QOpenGLVersionProfile &rhs)
+{
+    return !operator==(lhs, rhs);
+}
+
+#ifndef QT_NO_DEBUG_STREAM
+Q_GUI_EXPORT QDebug operator<<(QDebug debug, const QOpenGLVersionProfile &vp);
+#endif // !QT_NO_DEBUG_STREAM
+
+QT_END_NAMESPACE
+
+#endif // QT_NO_OPENGL
+
+#endif // QOPENGLVERSIONPROFILE_H