[Shader Graph Gen.] Introduce QShaderNodePort

The ports will be used to connect nodes from our shader graphs.

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

4 files changed, 203 insertions, 2 deletions

diff --git a/src/gui/util/qshadernodeport.cpp b/src/gui/util/qshadernodeport.cpp
new file mode 100644
index 0000000000..03646a9467
--- /dev/null
+++ b/src/gui/util/qshadernodeport.cpp
@@ -0,0 +1,55 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 Klaralvdalens Datakonsult AB (KDAB).
+** 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 "qshadernodeport_p.h"
+
+QT_BEGIN_NAMESPACE
+
+QShaderNodePort::QShaderNodePort() Q_DECL_NOTHROW
+    : direction(Output)
+{
+}
+
+bool operator==(const QShaderNodePort &lhs, const QShaderNodePort &rhs) Q_DECL_NOTHROW
+{
+    return lhs.direction == rhs.direction
+        && lhs.name == rhs.name;
+}
+
+QT_END_NAMESPACE
diff --git a/src/gui/util/qshadernodeport_p.h b/src/gui/util/qshadernodeport_p.h
new file mode 100644
index 0000000000..cfdaf05017
--- /dev/null
+++ b/src/gui/util/qshadernodeport_p.h
@@ -0,0 +1,88 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 Klaralvdalens Datakonsult AB (KDAB).
+** 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 QSHADERNODEPORT_P_H
+#define QSHADERNODEPORT_P_H
+
+//
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the Qt API.  It exists purely as an
+// implementation detail.  This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+//
+
+#include <QtGui/private/qtguiglobal_p.h>
+
+#include <QtCore/qstring.h>
+#include <QtCore/qvariant.h>
+
+QT_BEGIN_NAMESPACE
+
+class QShaderNodePort
+{
+public:
+    enum Direction : char {
+        Input,
+        Output
+    };
+
+    Q_GUI_EXPORT QShaderNodePort() Q_DECL_NOTHROW;
+
+    QShaderNodePort::Direction direction;
+    QString name;
+};
+
+Q_GUI_EXPORT bool operator==(const QShaderNodePort &lhs, const QShaderNodePort &rhs) Q_DECL_NOTHROW;
+
+inline bool operator!=(const QShaderNodePort &lhs, const QShaderNodePort &rhs) Q_DECL_NOTHROW
+{
+    return !(lhs == rhs);
+}
+
+Q_DECLARE_TYPEINFO(QShaderNodePort, Q_MOVABLE_TYPE);
+
+QT_END_NAMESPACE
+
+Q_DECLARE_METATYPE(QShaderNodePort)
+
+#endif // QSHADERNODEPORT_P_H
diff --git a/src/gui/util/util.pri b/src/gui/util/util.pri
index 2073a0a825..6258bcbe86 100644
--- a/src/gui/util/util.pri
+++ b/src/gui/util/util.pri
@@ -7,7 +7,8 @@ HEADERS += \
         util/qgridlayoutengine_p.h \
         util/qabstractlayoutstyleinfo_p.h \
         util/qlayoutpolicy_p.h \
-        util/qshaderformat_p.h
+        util/qshaderformat_p.h \
+        util/qshadernodeport_p.h
 
 SOURCES += \
         util/qdesktopservices.cpp \
@@ -15,4 +16,5 @@ SOURCES += \
         util/qgridlayoutengine.cpp \
         util/qabstractlayoutstyleinfo.cpp \
         util/qlayoutpolicy.cpp \
-        util/qshaderformat.cpp
+        util/qshaderformat.cpp \
+        util/qshadernodeport.cpp
diff --git a/tests/auto/gui/util/qshadernodes/tst_qshadernodes.cpp b/tests/auto/gui/util/qshadernodes/tst_qshadernodes.cpp
index 1d0facfbd4..590f2ececd 100644
--- a/tests/auto/gui/util/qshadernodes/tst_qshadernodes.cpp
+++ b/tests/auto/gui/util/qshadernodes/tst_qshadernodes.cpp
@@ -30,6 +30,7 @@
 #include <QtTest/QtTest>
 
 #include <QtGui/private/qshaderformat_p.h>
+#include <QtGui/private/qshadernodeport_p.h>
 
 namespace
 {
@@ -44,6 +45,14 @@ namespace
         format.setVendor(vendor);
         return format;
     }
+
+    QShaderNodePort createPort(QShaderNodePort::Direction direction, const QString &name)
+    {
+        auto port = QShaderNodePort();
+        port.direction = direction;
+        port.name = name;
+        return port;
+    }
 }
 
 class tst_QShaderNodes : public QObject
@@ -55,6 +64,10 @@ private slots:
     void shouldVerifyFormatsEquality();
     void shouldVerifyFormatsCompatibilities_data();
     void shouldVerifyFormatsCompatibilities();
+
+    void shouldHaveDefaultPortState();
+    void shouldVerifyPortsEquality_data();
+    void shouldVerifyPortsEquality();
 };
 
 void tst_QShaderNodes::shouldManipulateFormatMembers()
@@ -276,6 +289,49 @@ void tst_QShaderNodes::shouldVerifyFormatsCompatibilities()
     QCOMPARE(supported, expected);
 }
 
+void tst_QShaderNodes::shouldHaveDefaultPortState()
+{
+    // GIVEN
+    auto port = QShaderNodePort();
+
+    // THEN
+    QCOMPARE(port.direction, QShaderNodePort::Output);
+    QVERIFY(port.name.isEmpty());
+}
+
+void tst_QShaderNodes::shouldVerifyPortsEquality_data()
+{
+    QTest::addColumn<QShaderNodePort>("left");
+    QTest::addColumn<QShaderNodePort>("right");
+    QTest::addColumn<bool>("expected");
+
+    QTest::newRow("Equals") << createPort(QShaderNodePort::Input, "foo")
+                            << createPort(QShaderNodePort::Input, "foo")
+                            << true;
+    QTest::newRow("Direction") << createPort(QShaderNodePort::Input, "foo")
+                               << createPort(QShaderNodePort::Output, "foo")
+                               << false;
+    QTest::newRow("Name") << createPort(QShaderNodePort::Input, "foo")
+                          << createPort(QShaderNodePort::Input, "bar")
+                          << false;
+}
+
+void tst_QShaderNodes::shouldVerifyPortsEquality()
+{
+    // GIVEN
+    QFETCH(QShaderNodePort, left);
+    QFETCH(QShaderNodePort, right);
+
+    // WHEN
+    const auto equal = (left == right);
+    const auto notEqual = (left != right);
+
+    // THEN
+    QFETCH(bool, expected);
+    QCOMPARE(equal, expected);
+    QCOMPARE(notEqual, !expected);
+}
+
 QTEST_MAIN(tst_QShaderNodes)
 
 #include "tst_qshadernodes.moc"