QSM: Reintroduce guard argument evaluation

Implements the suggestion from Simon Hausmann (codereview 89716
from 08-05 14:46) to use QQmlScriptString rather then the previous
used MetaObject-manipulation.

This also introduces comparison operators for QQmlScriptString
to be able to determinate if a QQmlScriptString changed what
is needed cause there is otherwise no way to access (all) the
needed details within QQmlScriptStringPrivate.

Change-Id: I198479eac8fd37cbdd98a99aacdd8eebf7b75d21
Reviewed-by: Simon Hausmann <simon.hausmann@digia.com>

2 files changed, 191 insertions, 0 deletions

diff --git a/tests/auto/qml/qqmllanguage/tst_qqmllanguage.cpp b/tests/auto/qml/qqmllanguage/tst_qqmllanguage.cpp
index d6d1cef36b..05cdccfb51 100644
--- a/tests/auto/qml/qqmllanguage/tst_qqmllanguage.cpp
+++ b/tests/auto/qml/qqmllanguage/tst_qqmllanguage.cpp
@@ -140,6 +140,7 @@ private slots:
     void scriptString();
     void scriptStringJs();
     void scriptStringWithoutSourceCode();
+    void scriptStringComparison();
     void defaultPropertyListOrder();
     void declaredPropertyValues();
     void dontDoubleCallClassBegin();
@@ -2065,6 +2066,87 @@ void tst_qqmllanguage::scriptStringWithoutSourceCode()
     }
 }
 
+// Test the QQmlScriptString comparison operators. The script strings are considered
+// equal if there evaluation would produce the same result.
+void tst_qqmllanguage::scriptStringComparison()
+{
+    QQmlComponent component1(&engine, testFileUrl("scriptString.qml"));
+    QVERIFY(!component1.isError() && component1.errors().isEmpty());
+    MyTypeObject *object1 = qobject_cast<MyTypeObject*>(component1.create());
+    QVERIFY(object1 != 0);
+
+    QQmlComponent component2(&engine, testFileUrl("scriptString2.qml"));
+    QVERIFY(!component2.isError() && component2.errors().isEmpty());
+    MyTypeObject *object2 = qobject_cast<MyTypeObject*>(component2.create());
+    QVERIFY(object2 != 0);
+
+    QQmlComponent component3(&engine, testFileUrl("scriptString3.qml"));
+    QVERIFY(!component3.isError() && component3.errors().isEmpty());
+    MyTypeObject *object3 = qobject_cast<MyTypeObject*>(component3.create());
+    QVERIFY(object3 != 0);
+
+    //QJSValue inst1 = engine.newQObject(object1);
+    QJSValue inst2 = engine.newQObject(object2);
+    QJSValue inst3 = engine.newQObject(object3);
+    QJSValue func = engine.evaluate("function(value) { this.scriptProperty = value }");
+
+    const QString s = "hello\\n\\\"world\\\"";
+    const qreal n = 12.345;
+    bool ok;
+
+    QVERIFY(object2->scriptProperty().stringLiteral() == s);
+    QVERIFY(object3->scriptProperty().numberLiteral(&ok) == n && ok);
+    QVERIFY(object1->scriptProperty() == object1->scriptProperty());
+    QVERIFY(object2->scriptProperty() == object2->scriptProperty());
+    QVERIFY(object3->scriptProperty() == object3->scriptProperty());
+    QVERIFY(object2->scriptProperty() != object3->scriptProperty());
+    QVERIFY(object1->scriptProperty() != object2->scriptProperty());
+    QVERIFY(object1->scriptProperty() != object3->scriptProperty());
+
+    func.callWithInstance(inst2, QJSValueList() << n);
+    QVERIFY(object2->scriptProperty() == object3->scriptProperty());
+
+    func.callWithInstance(inst2, QJSValueList() << s);
+    QVERIFY(object2->scriptProperty() != object3->scriptProperty());
+    func.callWithInstance(inst3, QJSValueList() << s);
+    QVERIFY(object2->scriptProperty() == object3->scriptProperty());
+
+    func.callWithInstance(inst2, QJSValueList() << QJSValue::UndefinedValue);
+    QVERIFY(object2->scriptProperty() != object3->scriptProperty());
+    func.callWithInstance(inst3, QJSValueList() << QJSValue::UndefinedValue);
+    QVERIFY(object2->scriptProperty() == object3->scriptProperty());
+
+    func.callWithInstance(inst2, QJSValueList() << QJSValue::NullValue);
+    QVERIFY(object2->scriptProperty() != object3->scriptProperty());
+    func.callWithInstance(inst3, QJSValueList() << QJSValue::NullValue);
+    QVERIFY(object2->scriptProperty() == object3->scriptProperty());
+
+    func.callWithInstance(inst2, QJSValueList() << false);
+    QVERIFY(object2->scriptProperty() != object3->scriptProperty());
+    func.callWithInstance(inst3, QJSValueList() << false);
+    QVERIFY(object2->scriptProperty() == object3->scriptProperty());
+
+    func.callWithInstance(inst2, QJSValueList() << true);
+    QVERIFY(object2->scriptProperty() != object3->scriptProperty());
+    func.callWithInstance(inst3, QJSValueList() << true);
+    QVERIFY(object2->scriptProperty() == object3->scriptProperty());
+
+    QVERIFY(object1->scriptProperty() != object2->scriptProperty());
+    object2->setScriptProperty(object1->scriptProperty());
+    QVERIFY(object1->scriptProperty() == object2->scriptProperty());
+
+    QVERIFY(object1->scriptProperty() != object3->scriptProperty());
+    func.callWithInstance(inst3, QJSValueList() << engine.toScriptValue(object1->scriptProperty()));
+    QVERIFY(object1->scriptProperty() == object3->scriptProperty());
+
+    // While this are two instances of the same object they are still considered different
+    // because the (none literal) script string may access variables which have different
+    // values in both instances and hence evaluated to different results.
+    MyTypeObject *object1_2 = qobject_cast<MyTypeObject*>(component1.create());
+    QVERIFY(object1_2 != 0);
+    QVERIFY(object1->scriptProperty() != object1_2->scriptProperty());
+}
+
 // Check that default property assignments are correctly spliced into explicit
 // property assignments
 void tst_qqmllanguage::defaultPropertyListOrder()
diff --git a/tests/auto/qmltest/statemachine/tst_guardcondition.qml b/tests/auto/qmltest/statemachine/tst_guardcondition.qml
new file mode 100644
index 0000000000..71171b2079
--- /dev/null
+++ b/tests/auto/qmltest/statemachine/tst_guardcondition.qml
@@ -0,0 +1,109 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 Ford Motor Company
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the test suite 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 Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+import QtQml.StateMachine 1.0
+import QtTest 1.0
+
+TestCase {
+    id: testCase
+    StateMachine {
+        id: machine
+        initialState: startState
+        StateBase {
+            id: startState
+            SignalTransition {
+                id: signalTrans
+                signal: testCase.mysignal
+                guard: mystr == "test1"
+                targetState: finalState
+            }
+        }
+        FinalState {
+            id: finalState
+        }
+    }
+
+    SignalSpy {
+        id: finalStateActive
+        target: finalState
+        signalName: "activeChanged"
+    }
+
+    signal mysignal(string mystr, bool mybool, int myint)
+
+    name: "testGuardCondition"
+    function test_guardCondition()
+    {
+        // Start statemachine, should not have reached finalState yet.
+        machine.start()
+        tryCompare(finalStateActive, "count", 0)
+        tryCompare(machine, "running", true)
+
+        // Emit the signalTrans.signal which will evaluate the guard. The
+        // guard should return true, finalState be reached and the
+        // statemachine be stopped.
+        testCase.mysignal("test1", true, 2)
+        tryCompare(finalStateActive, "count", 1)
+        tryCompare(machine, "running", false)
+
+        // Restart machine.
+        machine.start()
+        tryCompare(machine, "running", true)
+        tryCompare(finalStateActive, "count", 2)
+
+        // Emit signal that makes the signalTrans.guard return false. The
+        // finalState should not have been triggered.
+        testCase.mysignal("test2", true, 2)
+        tryCompare(finalStateActive, "count", 2)
+        tryCompare(machine, "running", true)
+
+        // Change the guard in javascript to test that boolean true/false
+        // works as expected.
+        signalTrans.guard = false;
+        testCase.mysignal("test1", true, 2)
+        tryCompare(finalStateActive, "count", 2)
+        tryCompare(machine, "running", true)
+        signalTrans.guard = true;
+        testCase.mysignal("test1", true, 2)
+        tryCompare(finalStateActive, "count", 3)
+        tryCompare(machine, "running", false)
+    }
+}