| 1 | /**************************************************************************** |
| 2 | ** |
| 3 | ** Copyright (C) 2016 The Qt Company Ltd. |
| 4 | ** Contact: https://www.qt.io/licensing/ |
| 5 | ** |
| 6 | ** This file is part of the QtScxml module of the Qt Toolkit. |
| 7 | ** |
| 8 | ** $QT_BEGIN_LICENSE:LGPL$ |
| 9 | ** Commercial License Usage |
| 10 | ** Licensees holding valid commercial Qt licenses may use this file in |
| 11 | ** accordance with the commercial license agreement provided with the |
| 12 | ** Software or, alternatively, in accordance with the terms contained in |
| 13 | ** a written agreement between you and The Qt Company. For licensing terms |
| 14 | ** and conditions see https://www.qt.io/terms-conditions. For further |
| 15 | ** information use the contact form at https://www.qt.io/contact-us. |
| 16 | ** |
| 17 | ** GNU Lesser General Public License Usage |
| 18 | ** Alternatively, this file may be used under the terms of the GNU Lesser |
| 19 | ** General Public License version 3 as published by the Free Software |
| 20 | ** Foundation and appearing in the file LICENSE.LGPL3 included in the |
| 21 | ** packaging of this file. Please review the following information to |
| 22 | ** ensure the GNU Lesser General Public License version 3 requirements |
| 23 | ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. |
| 24 | ** |
| 25 | ** GNU General Public License Usage |
| 26 | ** Alternatively, this file may be used under the terms of the GNU |
| 27 | ** General Public License version 2.0 or (at your option) the GNU General |
| 28 | ** Public license version 3 or any later version approved by the KDE Free |
| 29 | ** Qt Foundation. The licenses are as published by the Free Software |
| 30 | ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 |
| 31 | ** included in the packaging of this file. Please review the following |
| 32 | ** information to ensure the GNU General Public License requirements will |
| 33 | ** be met: https://www.gnu.org/licenses/gpl-2.0.html and |
| 34 | ** https://www.gnu.org/licenses/gpl-3.0.html. |
| 35 | ** |
| 36 | ** $QT_END_LICENSE$ |
| 37 | ** |
| 38 | ****************************************************************************/ |
| 39 | |
| 40 | #ifndef QSCXMLDATAMODEL_H |
| 41 | #define QSCXMLDATAMODEL_H |
| 42 | |
| 43 | #include <QtScxml/qscxmlexecutablecontent.h> |
| 44 | |
| 45 | #include <QtCore/qvariant.h> |
| 46 | #include <QtCore/qvector.h> |
| 47 | |
| 48 | QT_BEGIN_NAMESPACE |
| 49 | |
| 50 | class QScxmlEvent; |
| 51 | |
| 52 | class QScxmlStateMachine; |
| 53 | class QScxmlTableData; |
| 54 | |
| 55 | class QScxmlDataModelPrivate; |
| 56 | class Q_SCXML_EXPORT QScxmlDataModel : public QObject |
| 57 | { |
| 58 | Q_OBJECT |
| 59 | Q_DECLARE_PRIVATE(QScxmlDataModel) |
| 60 | Q_PROPERTY(QScxmlStateMachine *stateMachine READ stateMachine WRITE setStateMachine NOTIFY stateMachineChanged) |
| 61 | |
| 62 | public: |
| 63 | class Q_SCXML_EXPORT ForeachLoopBody |
| 64 | { |
| 65 | Q_DISABLE_COPY(ForeachLoopBody) |
| 66 | public: |
| 67 | ForeachLoopBody(); |
| 68 | virtual ~ForeachLoopBody(); |
| 69 | virtual void run(bool *ok) = 0; |
| 70 | }; |
| 71 | |
| 72 | public: |
| 73 | explicit QScxmlDataModel(QObject *parent = nullptr); |
| 74 | |
| 75 | void setStateMachine(QScxmlStateMachine *stateMachine); |
| 76 | QScxmlStateMachine *stateMachine() const; |
| 77 | |
| 78 | Q_INVOKABLE virtual bool setup(const QVariantMap &initialDataValues) = 0; |
| 79 | |
| 80 | virtual QString evaluateToString(QScxmlExecutableContent::EvaluatorId id, bool *ok) = 0; |
| 81 | virtual bool evaluateToBool(QScxmlExecutableContent::EvaluatorId id, bool *ok) = 0; |
| 82 | virtual QVariant evaluateToVariant(QScxmlExecutableContent::EvaluatorId id, bool *ok) = 0; |
| 83 | virtual void evaluateToVoid(QScxmlExecutableContent::EvaluatorId id, bool *ok) = 0; |
| 84 | virtual void evaluateAssignment(QScxmlExecutableContent::EvaluatorId id, bool *ok) = 0; |
| 85 | virtual void evaluateInitialization(QScxmlExecutableContent::EvaluatorId id, bool *ok) = 0; |
| 86 | virtual void evaluateForeach(QScxmlExecutableContent::EvaluatorId id, bool *ok, ForeachLoopBody *body) = 0; |
| 87 | |
| 88 | virtual void setScxmlEvent(const QScxmlEvent &event) = 0; |
| 89 | |
| 90 | virtual QVariant scxmlProperty(const QString &name) const = 0; |
| 91 | virtual bool hasScxmlProperty(const QString &name) const = 0; |
| 92 | virtual bool setScxmlProperty(const QString &name, const QVariant &value, const QString &context) = 0; |
| 93 | |
| 94 | Q_SIGNALS: |
| 95 | void stateMachineChanged(QScxmlStateMachine *stateMachine); |
| 96 | |
| 97 | protected: |
| 98 | explicit QScxmlDataModel(QScxmlDataModelPrivate &dd, QObject *parent = nullptr); |
| 99 | }; |
| 100 | |
| 101 | QT_END_NAMESPACE |
| 102 | |
| 103 | Q_DECLARE_METATYPE(QScxmlDataModel *) |
| 104 | |
| 105 | #endif // QSCXMLDATAMODEL_H |
| 106 | |