[Shader Graph Gen.] Introduce QShaderFormat

This is the first building block toward a node based generator for
shader programs.

QShaderFormat will be used by the other classes to qualify in which
format the code snippets and includes used are.

Change-Id: I11aefc6bb359832a853ed1b6bec302dc3516cfc4
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>

3 files changed, 287 insertions, 0 deletions

diff --git a/tests/auto/gui/util/qshadernodes/qshadernodes.pro b/tests/auto/gui/util/qshadernodes/qshadernodes.pro
new file mode 100644
index 0000000000..5ab8b73a51
--- /dev/null
+++ b/tests/auto/gui/util/qshadernodes/qshadernodes.pro
@@ -0,0 +1,5 @@
+CONFIG += testcase
+QT += testlib gui-private
+
+SOURCES += tst_qshadernodes.cpp
+TARGET = tst_qshadernodes
diff --git a/tests/auto/gui/util/qshadernodes/tst_qshadernodes.cpp b/tests/auto/gui/util/qshadernodes/tst_qshadernodes.cpp
new file mode 100644
index 0000000000..1d0facfbd4
--- /dev/null
+++ b/tests/auto/gui/util/qshadernodes/tst_qshadernodes.cpp
@@ -0,0 +1,281 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 Klaralvdalens Datakonsult AB (KDAB).
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the test suite of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:GPL-EXCEPT$
+** 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 General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3 as published by the Free Software
+** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
+** 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-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+
+#include <QtTest/QtTest>
+
+#include <QtGui/private/qshaderformat_p.h>
+
+namespace
+{
+    QShaderFormat createFormat(QShaderFormat::Api api, int majorVersion, int minorVersion,
+                               const QStringList &extensions = QStringList(),
+                               const QString &vendor = QString())
+    {
+        auto format = QShaderFormat();
+        format.setApi(api);
+        format.setVersion(QVersionNumber(majorVersion, minorVersion));
+        format.setExtensions(extensions);
+        format.setVendor(vendor);
+        return format;
+    }
+}
+
+class tst_QShaderNodes : public QObject
+{
+    Q_OBJECT
+private slots:
+    void shouldManipulateFormatMembers();
+    void shouldVerifyFormatsEquality_data();
+    void shouldVerifyFormatsEquality();
+    void shouldVerifyFormatsCompatibilities_data();
+    void shouldVerifyFormatsCompatibilities();
+};
+
+void tst_QShaderNodes::shouldManipulateFormatMembers()
+{
+    // GIVEN
+    auto format = QShaderFormat();
+
+    // THEN (default state)
+    QCOMPARE(format.api(), QShaderFormat::NoApi);
+    QCOMPARE(format.version().majorVersion(), 0);
+    QCOMPARE(format.version().minorVersion(), 0);
+    QCOMPARE(format.extensions(), QStringList());
+    QCOMPARE(format.vendor(), QString());
+    QVERIFY(!format.isValid());
+
+    // WHEN
+    format.setApi(QShaderFormat::OpenGLES);
+
+    // THEN
+    QCOMPARE(format.api(), QShaderFormat::OpenGLES);
+    QCOMPARE(format.version().majorVersion(), 0);
+    QCOMPARE(format.version().minorVersion(), 0);
+    QCOMPARE(format.extensions(), QStringList());
+    QCOMPARE(format.vendor(), QString());
+    QVERIFY(!format.isValid());
+
+    // WHEN
+    format.setVersion(QVersionNumber(3));
+
+    // THEN
+    QCOMPARE(format.api(), QShaderFormat::OpenGLES);
+    QCOMPARE(format.version().majorVersion(), 3);
+    QCOMPARE(format.version().minorVersion(), 0);
+    QCOMPARE(format.extensions(), QStringList());
+    QCOMPARE(format.vendor(), QString());
+    QVERIFY(format.isValid());
+
+    // WHEN
+    format.setVersion(QVersionNumber(3, 2));
+
+    // THEN
+    QCOMPARE(format.api(), QShaderFormat::OpenGLES);
+    QCOMPARE(format.version().majorVersion(), 3);
+    QCOMPARE(format.version().minorVersion(), 2);
+    QCOMPARE(format.extensions(), QStringList());
+    QCOMPARE(format.vendor(), QString());
+    QVERIFY(format.isValid());
+
+    // WHEN
+    format.setExtensions({"foo", "bar"});
+
+    // THEN
+    QCOMPARE(format.api(), QShaderFormat::OpenGLES);
+    QCOMPARE(format.version().majorVersion(), 3);
+    QCOMPARE(format.version().minorVersion(), 2);
+    QCOMPARE(format.extensions(), QStringList({"bar", "foo"}));
+    QCOMPARE(format.vendor(), QString());
+    QVERIFY(format.isValid());
+
+    // WHEN
+    format.setVendor(QStringLiteral("KDAB"));
+
+    // THEN
+    QCOMPARE(format.api(), QShaderFormat::OpenGLES);
+    QCOMPARE(format.version().majorVersion(), 3);
+    QCOMPARE(format.version().minorVersion(), 2);
+    QCOMPARE(format.extensions(), QStringList({"bar", "foo"}));
+    QCOMPARE(format.vendor(), QStringLiteral("KDAB"));
+    QVERIFY(format.isValid());
+}
+
+void tst_QShaderNodes::shouldVerifyFormatsEquality_data()
+{
+    QTest::addColumn<QShaderFormat>("left");
+    QTest::addColumn<QShaderFormat>("right");
+    QTest::addColumn<bool>("expected");
+
+    QTest::newRow("Equals") << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 0, {"foo", "bar"}, "KDAB")
+                            << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 0, {"foo", "bar"}, "KDAB")
+                            << true;
+    QTest::newRow("Apis") << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 0, {"foo", "bar"}, "KDAB")
+                          << createFormat(QShaderFormat::OpenGLNoProfile, 3, 0, {"foo", "bar"}, "KDAB")
+                          << false;
+    QTest::newRow("Major") << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 0, {"foo", "bar"}, "KDAB")
+                           << createFormat(QShaderFormat::OpenGLCoreProfile, 2, 0, {"foo", "bar"}, "KDAB")
+                           << false;
+    QTest::newRow("Minor") << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 0, {"foo", "bar"}, "KDAB")
+                           << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 1, {"foo", "bar"}, "KDAB")
+                           << false;
+    QTest::newRow("Extensions") << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 0, {"foo", "bar"}, "KDAB")
+                                << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 0, {"foo"}, "KDAB")
+                                << false;
+    QTest::newRow("Vendor") << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 0, {"foo", "bar"}, "KDAB")
+                            << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 0, {"foo", "bar"})
+                            << false;
+}
+
+void tst_QShaderNodes::shouldVerifyFormatsEquality()
+{
+    // GIVEN
+    QFETCH(QShaderFormat, left);
+    QFETCH(QShaderFormat, right);
+
+    // WHEN
+    const auto equal = (left == right);
+    const auto notEqual = (left != right);
+
+    // THEN
+    QFETCH(bool, expected);
+    QCOMPARE(equal, expected);
+    QCOMPARE(notEqual, !expected);
+}
+
+void tst_QShaderNodes::shouldVerifyFormatsCompatibilities_data()
+{
+    QTest::addColumn<QShaderFormat>("reference");
+    QTest::addColumn<QShaderFormat>("tested");
+    QTest::addColumn<bool>("expected");
+
+    QTest::newRow("NoProfileVsES") << createFormat(QShaderFormat::OpenGLNoProfile, 2, 0)
+                                   << createFormat(QShaderFormat::OpenGLES, 2, 0)
+                                   << true;
+    QTest::newRow("CoreProfileVsES") << createFormat(QShaderFormat::OpenGLCoreProfile, 2, 0)
+                                     << createFormat(QShaderFormat::OpenGLES, 2, 0)
+                                     << false;
+    QTest::newRow("CompatProfileVsES") << createFormat(QShaderFormat::OpenGLCompatibilityProfile, 2, 0)
+                                       << createFormat(QShaderFormat::OpenGLES, 2, 0)
+                                       << true;
+
+    QTest::newRow("ESVsNoProfile") << createFormat(QShaderFormat::OpenGLES, 2, 0)
+                                   << createFormat(QShaderFormat::OpenGLNoProfile, 2, 0)
+                                   << false;
+    QTest::newRow("ESVsCoreProfile") << createFormat(QShaderFormat::OpenGLES, 2, 0)
+                                     << createFormat(QShaderFormat::OpenGLCoreProfile, 2, 0)
+                                     << false;
+    QTest::newRow("ESVsCompatProfile") << createFormat(QShaderFormat::OpenGLES, 2, 0)
+                                       << createFormat(QShaderFormat::OpenGLCompatibilityProfile, 2, 0)
+                                       << false;
+
+    QTest::newRow("CoreVsNoProfile") << createFormat(QShaderFormat::OpenGLCoreProfile, 2, 0)
+                                     << createFormat(QShaderFormat::OpenGLNoProfile, 2, 0)
+                                     << false;
+    QTest::newRow("CoreVsCompat") << createFormat(QShaderFormat::OpenGLCoreProfile, 2, 0)
+                                  << createFormat(QShaderFormat::OpenGLCompatibilityProfile, 2, 0)
+                                  << false;
+    QTest::newRow("CoreVsCore") << createFormat(QShaderFormat::OpenGLCoreProfile, 2, 0)
+                                << createFormat(QShaderFormat::OpenGLCoreProfile, 2, 0)
+                                << true;
+
+    QTest::newRow("NoProfileVsCore") << createFormat(QShaderFormat::OpenGLNoProfile, 2, 0)
+                                     << createFormat(QShaderFormat::OpenGLCoreProfile, 2, 0)
+                                     << true;
+    QTest::newRow("NoProvileVsCompat") << createFormat(QShaderFormat::OpenGLNoProfile, 2, 0)
+                                       << createFormat(QShaderFormat::OpenGLCompatibilityProfile, 2, 0)
+                                       << true;
+    QTest::newRow("NoProfileVsNoProfile") << createFormat(QShaderFormat::OpenGLNoProfile, 2, 0)
+                                          << createFormat(QShaderFormat::OpenGLNoProfile, 2, 0)
+                                          << true;
+
+    QTest::newRow("CompatVsCore") << createFormat(QShaderFormat::OpenGLCompatibilityProfile, 2, 0)
+                                  << createFormat(QShaderFormat::OpenGLCoreProfile, 2, 0)
+                                  << true;
+    QTest::newRow("CompatVsCompat") << createFormat(QShaderFormat::OpenGLCompatibilityProfile, 2, 0)
+                                    << createFormat(QShaderFormat::OpenGLCompatibilityProfile, 2, 0)
+                                    << true;
+    QTest::newRow("CompatVsNoProfile") << createFormat(QShaderFormat::OpenGLCompatibilityProfile, 2, 0)
+                                       << createFormat(QShaderFormat::OpenGLNoProfile, 2, 0)
+                                       << true;
+
+    QTest::newRow("MajorForwardCompat_1") << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 0)
+                                          << createFormat(QShaderFormat::OpenGLCoreProfile, 2, 0)
+                                          << true;
+    QTest::newRow("MajorForwardCompat_2") << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 0)
+                                          << createFormat(QShaderFormat::OpenGLCoreProfile, 2, 4)
+                                          << true;
+    QTest::newRow("MajorForwardCompat_3") << createFormat(QShaderFormat::OpenGLCoreProfile, 2, 0)
+                                          << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 0)
+                                          << false;
+    QTest::newRow("MajorForwardCompat_4") << createFormat(QShaderFormat::OpenGLCoreProfile, 2, 4)
+                                          << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 0)
+                                          << false;
+
+    QTest::newRow("MinorForwardCompat_1") << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 1)
+                                          << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 0)
+                                          << true;
+    QTest::newRow("MinorForwardCompat_2") << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 0)
+                                          << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 1)
+                                          << false;
+
+    QTest::newRow("Extensions_1") << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 0, {"foo", "bar"})
+                                  << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 0, {"foo"})
+                                  << true;
+    QTest::newRow("Extensions_2") << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 0, {"foo"})
+                                  << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 0, {"foo", "bar"})
+                                  << false;
+
+    QTest::newRow("Vendor_1") << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 0, {}, "KDAB")
+                              << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 0, {})
+                              << true;
+    QTest::newRow("Vendor_2") << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 0, {})
+                              << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 0, {}, "KDAB")
+                              << false;
+    QTest::newRow("Vendor_2") << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 0, {}, "KDAB")
+                              << createFormat(QShaderFormat::OpenGLCoreProfile, 3, 0, {}, "KDAB")
+                              << true;
+}
+
+void tst_QShaderNodes::shouldVerifyFormatsCompatibilities()
+{
+    // GIVEN
+    QFETCH(QShaderFormat, reference);
+    QFETCH(QShaderFormat, tested);
+
+    // WHEN
+    const auto supported = reference.supports(tested);
+
+    // THEN
+    QFETCH(bool, expected);
+    QCOMPARE(supported, expected);
+}
+
+QTEST_MAIN(tst_QShaderNodes)
+
+#include "tst_qshadernodes.moc"
diff --git a/tests/auto/gui/util/util.pro b/tests/auto/gui/util/util.pro
index f2c4515dc2..729a342992 100644
--- a/tests/auto/gui/util/util.pro
+++ b/tests/auto/gui/util/util.pro
@@ -5,4 +5,5 @@ SUBDIRS= \
     qintvalidator \
     qregexpvalidator \
     qregularexpressionvalidator \
+    qshadernodes \